Mosaic products documentation: Concepts, API Reference, Technical articles, How-to, Downloads and tools


Table of Contents

This package contains modules that help to set up your GraphQL API.


The @axinom/mosaic-graphql-common library provides functionality to set up the GraphQL API from a PostgreSQL database. The PostgraphileOptionsBuilder encapsulates common functionality and best-practices to initialize the GraphQL API.

GraphQL subscriptions (web-socket based GraphQL push notifications) can be enabled by using the SubscriptionsPluginFactory. This will notify subscribers if an entity or its related tables were modified.

The ValidationDirectivesPlugin adds annotations to the GraphQL schema about validation rules that were added on table columns. And the AnnotateTypesWithPermissionsPlugin adds annotations which describe the required permissions to access or modify an entity.