@axinom/mosaic-graphql-common 0.1.0-rc.0

package/dist/postgraphile/postgraphile-options-builder.js

@@ -0,0 +1,419 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostgraphileOptionsBuilder = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const pg_pubsub_1 = __importDefault(require("@graphile/pg-pubsub"));
+const graphile_build_1 = require("graphile-build");
+const postgraphile_1 = require("postgraphile");
+const enhance_graphql_errors_1 = require("./enhance-graphql-errors");
+/**
+ * A builder class that allows construction of postgraphile options using multiple dedicated extension methods.
+ */
+class PostgraphileOptionsBuilder {
+    constructor() {
+        this.transformers = [];
+        this.headers = {};
+        this.pluginHooks = new Set();
+        this.hookFuncs = new Set();
+    }
+    /**
+     * Builds a postgraphile options object with previously used extension methods.
+     */
+    build() {
+        let options = {};
+        for (const transform of this.transformers) {
+            options = transform(options);
+        }
+        this.buildHeadersHookPlugin();
+        // Build plugin hooks from hook functions
+        [...this.hookFuncs].map((hookFunc) => {
+            this.pluginHooks.add(hookFunc(options));
+        });
+        if (this.pluginHooks.size > 0) {
+            options.pluginHook = (0, postgraphile_1.makePluginHook)([...this.pluginHooks]);
+        }
+        return options;
+    }
+    /**
+     * Builds a hook plugin that adds custom headers to http responses.
+     */
+    buildHeadersHookPlugin() {
+        if (Object.keys(this.headers).length > 0) {
+            this.pluginHooks.add({
+                'postgraphile:http:handler': (req, { res }) => {
+                    for (const key in this.headers) {
+                        if (Object.prototype.hasOwnProperty.call(this.headers, key)) {
+                            res.setHeader(key, this.headers[key]);
+                        }
+                    }
+                    return req;
+                },
+            });
+        }
+    }
+    /**
+     * This builder option must be used if the Hook Plugin requires PostGraphileOptions in the logic.
+     * A function which returns a PostGraphilePlugin should be passed into this method.
+     * That function will use PostGraphileOptions created in the build() method and attach the plugin returned from the function as a Postgraphile Hook.
+     * @example
+     *
+     * ```ts
+       new PostgraphileOptionsBuilder()
+        .addHookPluginFactory(customHookFactory)
+     * ```
+     *
+     * @param hookFunction This is a function which takes an argument of type PostGraphileOptions<Request, Response> and returns a PostGraphilePlugin object.
+     * @returns
+     */
+    addHookPluginFactory(hookFunction) {
+        this.hookFuncs.add(hookFunction);
+        return this;
+    }
+    /**
+     * This function takes a PostGraphilePlugin object and attaches it as a Postgraphile Hook when build() is called.
+     * @example
+     *
+     * ```ts
+       new PostgraphileOptionsBuilder()
+        .addHookPluginFunction(subscriptionAuthorizationHook)
+     * ```
+     *
+     * @param hookPlugin This is a PostGraphilePlugin object.
+     * @returns
+     */
+    addHookPlugin(hookPlugin) {
+        this.pluginHooks.add(hookPlugin);
+        return this;
+    }
+    /**
+     * Sets `pgSettings` property of postgraphile options object.
+     * Example:
+     *
+     * ```ts
+       new PostgraphileOptionsBuilder()
+        .setPgSettings(async req => {
+          const { subject } = await getManagementAuthenticationContext(req, idServiceParams);
+          return buildPgSettings(subject, config.dbGqlRole, config.serviceId);
+        })
+     * ```
+     *
+     * @param pgSettings A plain object specifying custom config values to set in the PostgreSQL transaction (accessed via current_setting('my.custom.setting')) or an (optionally asynchronous) function which will return the same (or a Promise to the same) based on the incoming web request (e.g. to extract session data).
+     */
+    setPgSettings(pgSettings) {
+        this.transformers.push((options) => {
+            options.pgSettings = pgSettings;
+            return options;
+        });
+        return this;
+    }
+    /**
+     * Sets `handleErrors` property of postgraphile options object.
+     * Example:
+     *
+     * ```ts
+       new PostgraphileOptionsBuilder()
+        .setErrorsHandler((errors, req) => {
+          return enhanceGraphqlErrors(
+            result.errors,
+            req.body.operationName,
+            customizeGraphQlErrorFields(defaultPgErrorMapper),
+            logGraphQlError(defaultWriteLogMapper, this.logger),
+          );
+        }
+      })
+     * ```
+     *
+     * @param handleErrors Enables ability to modify errors before sending them down to the client. Optionally can send down custom responses. If you use this then showErrorStack and extendedError may have no effect.
+     */
+    setErrorsHandler(handleErrors) {
+        this.transformers.push((options) => {
+            options.handleErrors = handleErrors;
+            return options;
+        });
+        return this;
+    }
+    /**
+     * Sets properties of postgraphile options object to be used in without any conditions. Additional calls will override and add properties.
+     * Example:
+     *
+     * ```ts
+       new PostgraphileOptionsBuilder()
+        .setProperties({
+          enableCors: true,
+          dynamicJson: true,
+          ignoreRBAC: false,
+          legacyRelations: 'omit',
+          setofFunctionsContainNulls: false,
+        })
+     * ```
+     * @param properties An object containing postgraphile options.
+     */
+    setProperties(properties) {
+        this.transformers.push((options) => {
+            return Object.assign(Object.assign({}, options), properties);
+        });
+        return this;
+    }
+    /**
+     * Sets properties of postgraphile options object to be used based on some
+     * condition (use if true, omit if false). Additional calls will override and
+     * add properties.
+     * Example:
+     *
+     * ```ts
+       new PostgraphileOptionsBuilder()
+        .setConditionalProperties(config.isDev, {
+          exportGqlSchemaPath: './src/generated/schema.graphql',
+          watchPg: true,
+          graphiql: true,
+          enhanceGraphiql: true,
+          allowExplain: true,
+        })
+     * ```
+     * @param properties An object containing postgraphile options.
+     */
+    setConditionalProperties(condition, properties) {
+        if (condition) {
+            this.transformers.push((options) => {
+                return Object.assign(Object.assign({}, options), properties);
+            });
+        }
+        return this;
+    }
+    /**
+     * Sets all necessary postgraphile properties to enable subscriptions.
+     * Example:
+     *
+     * ```ts
+       new PostgraphileOptionsBuilder()
+        .enableSubscriptions({
+          plugin: SubscriptionsPlugin,
+          websocketMiddlewares: middlewares,
+          hookFactory: subscriptionAuthorizationHookFactory
+        })
+     * ```
+     *
+     * Results in something like this:
+     *
+     * ```ts
+        import PgPubsub from '@graphile/pg-pubsub';
+        import { makePluginHook } from 'postgraphile';
+        //.........
+        {
+            appendPlugins: [SubscriptionsPlugin], // Other plugins will be included if they were added using other methods
+            pluginHook: makePluginHook([PgPubsub, subscriptionAuthorizationHook]),
+            subscriptions: true,
+            websocketMiddlewares, // Empty array if websocketMiddlewares are not specified
+        }
+     * ```
+     *
+     * To make sure that Postgraphile is able to correctly establish WebSockets
+     * connection, additional changes should be done by using
+     * `enhanceHttpServerWithSubscriptions`.
+     *
+     * See more here: https://www.graphile.org/postgraphile/subscriptions/#advanced-setup
+     *
+     * @param plugin Graphile engine plugin that adds one or multiple subscription
+     * endpoints. Can be added separately.
+     * @param websocketMiddlewares If you're using websockets (subscriptions ||
+     * live) then you may want to authenticate your users using sessions or
+     * similar. You can pass some simple middlewares here that will be executed
+     * against the websocket connection in order to perform authentication.
+     * @param hookFactory A factory function for a Postgraphile hook plugin.
+     */
+    enableSubscriptions({ plugin, websocketMiddlewares, hookFactory, }) {
+        this.transformers.push((options) => {
+            var _a, _b;
+            options.subscriptions = true;
+            options.appendPlugins = [
+                ...new Set([...((_a = options.appendPlugins) !== null && _a !== void 0 ? _a : []), plugin]),
+            ];
+            // Add the pub/sub realtime provider
+            // This is for PostGraphile server plugins: https://www.graphile.org/postgraphile/plugins/
+            this.pluginHooks.add(pg_pubsub_1.default);
+            if (websocketMiddlewares) {
+                options.websocketMiddlewares = [
+                    ...new Set([
+                        ...((_b = options.websocketMiddlewares) !== null && _b !== void 0 ? _b : []),
+                        ...websocketMiddlewares,
+                    ]),
+                ];
+            }
+            else if (!options.websocketMiddlewares) {
+                options.websocketMiddlewares = [];
+            }
+            if (hookFactory) {
+                this.hookFuncs.add(hookFactory);
+            }
+            return options;
+        });
+        return this;
+    }
+    /**
+     * Adds multiple graphile engine plugins to `appendPlugins` array of postgraphile options object. `setAdditionalGraphQLContextFromRequest` and `addGraphileBuildOptions` methods can be used to pass parameters to said plugins.
+     * Example:
+     *
+       ```ts
+       new PostgraphileOptionsBuilder()
+        .addPlugins(
+          PgSimplifyInflectorPlugin,
+          ScalarTypesPlugin,
+          SmartTagsPlugin,
+          ValidationDirectivesPlugin,
+        )
+       ```
+     * @param plugins Comma-separated list of Graphile Engine schema plugins to load after the default plugins.
+     */
+    addPlugins(...plugins) {
+        this.transformers.push((options) => {
+            var _a;
+            options.appendPlugins = [
+                ...new Set([...((_a = options.appendPlugins) !== null && _a !== void 0 ? _a : []), ...plugins]),
+            ];
+            return options;
+        });
+        return this;
+    }
+    /**
+     * Adds multiple graphile engine plugins to `appendPlugins` array of postgraphile options object.
+     * `setAdditionalGraphQLContextFromRequest` and `addGraphileBuildOptions` methods can be used to pass parameters to said plugins.
+     * Explicit condition parameter is used to make a decision if plugins should be used or not (use if true, omit if false).
+     * Example:
+     *
+       ```ts
+       new PostgraphileOptionsBuilder()
+        .addConditionalPlugins(config.isDev || config.enablePopulatePlugins, PopulateMoviesPlugin, PopulateTvshowsPlugin)
+       ```
+     * @param plugins Comma-separated list of Graphile Engine schema plugins to load after the default plugins.
+     */
+    addConditionalPlugins(condition, ...plugins) {
+        if (condition) {
+            this.addPlugins(...plugins);
+        }
+        return this;
+    }
+    /**
+     * Skips multiple default postgraphile plugins by adding them to `skipPlugins` array of postgraphile options object .
+     * Example:
+     *
+       ```ts
+       new PostgraphileOptionsBuilder()
+        .skipPlugins(NodePlugin, MutationPayloadQueryPlugin)
+       ```
+     * @param plugins Comma-separated list of Graphile Engine schema plugins to skip.
+     */
+    skipPlugins(...plugins) {
+        this.transformers.push((options) => {
+            var _a;
+            options.skipPlugins = [
+                ...new Set([...((_a = options.skipPlugins) !== null && _a !== void 0 ? _a : []), ...plugins]),
+            ];
+            return options;
+        });
+        return this;
+    }
+    /**
+     * Adds properties to resulting `graphileBuildOptions` property of postgraphile options object. Useful for modifying default postgraphile plugin settings.
+     * Example:
+     *
+       ```ts
+       new PostgraphileOptionsBuilder()
+        .addGraphileBuildOptions({ pgSkipInstallingWatchFixtures: true })
+       ```
+     * @param graphileBuildOptions Additional Options to pass through into the graphile schema building system (received via the second argument of a plugin).
+     */
+    addGraphileBuildOptions(graphileBuildOptions) {
+        this.transformers.push((options) => {
+            var _a;
+            options.graphileBuildOptions = Object.assign(Object.assign({}, ((_a = options.graphileBuildOptions) !== null && _a !== void 0 ? _a : {})), graphileBuildOptions);
+            return options;
+        });
+        return this;
+    }
+    /**
+     * Adds `additionalGraphQLContextFromRequest` property to postgraphile options object. Define only once. Multiple calls will not expand previous calls, but will override them.
+     *
+     * Example:
+       ```ts
+       new PostgraphileOptionsBuilder()
+        .setAdditionalGraphQLContextFromRequest(async req => {
+          const { subject } = await getManagementAuthenticationContext(req);
+          return { subject, serviceId: config.serviceId };
+        })
+       ```
+     * @param callback Some Graphile Engine schema plugins may need additional information available on the context argument to the resolver - you can use this function to provide such information based on the incoming request - you can even use this to change the response , e.g. setting cookies.
+     */
+    setAdditionalGraphQLContextFromRequest(callback) {
+        this.transformers.push((options) => {
+            options.additionalGraphQLContextFromRequest = callback;
+            return options;
+        });
+        return this;
+    }
+    /**
+     * Enables or disables graphiql GUI depending on a passed condition parameter. Enable if true, disable if false.
+     * Sets 3 postgraphile properties: `graphiql`, `enhanceGraphiql` and `allowExplain`.
+     * Example:
+     *
+     * ```ts
+       new PostgraphileOptionsBuilder()
+        .setGraphiql(config.graphqlGuiEnabled)
+     * ```
+     */
+    setGraphiql(condition) {
+        this.transformers.push((options) => {
+            return Object.assign(Object.assign({}, options), {
+                graphiql: condition,
+                enhanceGraphiql: condition,
+                allowExplain: condition,
+            });
+        });
+        return this;
+    }
+    /**
+     * Sets a response header for each GraphQL request.
+     *
+     * @param name header name
+     * @param value header value
+     */
+    setHeader(name, value) {
+        this.headers[name] = value;
+        return this;
+    }
+    /**
+     * Sets default values for properties that we see as best practices which most
+     * services should start from. This includes the default GraphQL errors handler,
+     * suggested default properties, development properties in dev-environments,
+     * and excludes the 'NodePlugin'.
+     */
+    setDefaultSettings(isDev, graphqlGuiEnabled) {
+        this.setErrorsHandler((errors) => {
+            return (0, enhance_graphql_errors_1.enhanceGraphqlErrors)(errors);
+        })
+            .setProperties({
+            enableCors: true,
+            dynamicJson: true,
+            ignoreRBAC: false,
+            legacyRelations: 'omit',
+            setofFunctionsContainNulls: false,
+            watchPg: false,
+            disableQueryLog: true,
+            retryOnInitFail: true,
+        })
+            .setConditionalProperties(isDev, {
+            exportGqlSchemaPath: './src/generated/graphql/schema.graphql',
+            watchPg: true,
+            disableQueryLog: false,
+            retryOnInitFail: false,
+        })
+            .setGraphiql(graphqlGuiEnabled)
+            // removes some nodeId and byNodeId endpoints, but still leaves support for cursor pagination
+            .skipPlugins(graphile_build_1.NodePlugin);
+        return this;
+    }
+}
+exports.PostgraphileOptionsBuilder = PostgraphileOptionsBuilder;
+//# sourceMappingURL=postgraphile-options-builder.js.map

package/dist/postgraphile/postgraphile-options-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgraphile-options-builder.js","sourceRoot":"","sources":["../../src/postgraphile/postgraphile-options-builder.ts"],"names":[],"mappings":";;;;;;AAAA,uDAAuD;AACvD,oEAA2C;AAE3C,mDAAoD;AAGpD,+CAQsB;AAEtB,qEAAgE;AAoBhE;;GAEG;AACH,MAAa,0BAA0B;IAAvC;QACU,iBAAY,GAE6B,EAAE,CAAC;QAE5C,YAAO,GAAqC,EAAE,CAAC;QAC/C,gBAAW,GAA4B,IAAI,GAAG,EAAsB,CAAC;QACrE,cAAS,GAA2B,IAAI,GAAG,EAAqB,CAAC;IA+c3E,CAAC;IA7cC;;OAEG;IACI,KAAK;QACV,IAAI,OAAO,GAA2C,EAAE,CAAC;QACzD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,YAAY,EAAE;YACzC,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;SAC9B;QAED,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAE9B,yCAAyC;QACzC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YACnC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,EAAE;YAC7B,OAAO,CAAC,UAAU,GAAG,IAAA,6BAAc,EAAC,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;SAC5D;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACK,sBAAsB;QAC5B,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YACxC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;gBACnB,2BAA2B,EAAE,CAC3B,GAAoB,EACpB,EAAE,GAAG,EAAqB,EAC1B,EAAE;oBACF,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,OAAO,EAAE;wBAC9B,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE;4BAC3D,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;yBACvC;qBACF;oBACD,OAAO,GAAG,CAAC;gBACb,CAAC;aACF,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,oBAAoB,CACzB,YAA+B;QAE/B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;OAWG;IACI,aAAa,CAClB,UAA8B;QAE9B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,aAAa,CAClB,UAAgE;QAEhE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;YACjC,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;YAChC,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,gBAAgB,CACrB,YAI2B;QAE3B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;YACjC,OAAO,CAAC,YAAY,GAAG,YAAY,CAAC;YACpC,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,aAAa,CAClB,UAAkD;QAElD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;YACjC,uCAAY,OAAO,GAAK,UAAU,EAAG;QACvC,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,wBAAwB,CAC7B,SAAkB,EAClB,UAAkD;QAElD,IAAI,SAAS,EAAE;YACb,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;gBACjC,uCAAY,OAAO,GAAK,UAAU,EAAG;YACvC,CAAC,CAAC,CAAC;SACJ;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACI,mBAAmB,CAAC,EACzB,MAAM,EACN,oBAAoB,EACpB,WAAW,GAKZ;QACC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;;YACjC,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;YAC7B,OAAO,CAAC,aAAa,GAAG;gBACtB,GAAG,IAAI,GAAG,CAAS,CAAC,GAAG,CAAC,MAAA,OAAO,CAAC,aAAa,mCAAI,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;aAC/D,CAAC;YAEF,oCAAoC;YACpC,0FAA0F;YAC1F,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,mBAAQ,CAAC,CAAC;YAE/B,IAAI,oBAAoB,EAAE;gBACxB,OAAO,CAAC,oBAAoB,GAAG;oBAC7B,GAAG,IAAI,GAAG,CAAgC;wBACxC,GAAG,CAAC,MAAA,OAAO,CAAC,oBAAoB,mCAAI,EAAE,CAAC;wBACvC,GAAG,oBAAoB;qBACxB,CAAC;iBACH,CAAC;aACH;iBAAM,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE;gBACxC,OAAO,CAAC,oBAAoB,GAAG,EAAE,CAAC;aACnC;YAED,IAAI,WAAW,EAAE;gBACf,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;aACjC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,UAAU,CAAC,GAAG,OAAiB;QACpC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;;YACjC,OAAO,CAAC,aAAa,GAAG;gBACtB,GAAG,IAAI,GAAG,CAAS,CAAC,GAAG,CAAC,MAAA,OAAO,CAAC,aAAa,mCAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC;aACnE,CAAC;YACF,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;OAWG;IACI,qBAAqB,CAC1B,SAAkB,EAClB,GAAG,OAAiB;QAEpB,IAAI,SAAS,EAAE;YACb,IAAI,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACI,WAAW,CAAC,GAAG,OAAiB;QACrC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;;YACjC,OAAO,CAAC,WAAW,GAAG;gBACpB,GAAG,IAAI,GAAG,CAAS,CAAC,GAAG,CAAC,MAAA,OAAO,CAAC,WAAW,mCAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC;aACjE,CAAC;YACF,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACI,uBAAuB,CAC5B,oBAAsC;QAEtC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;;YACjC,OAAO,CAAC,oBAAoB,mCACvB,CAAC,MAAA,OAAO,CAAC,oBAAoB,mCAAI,EAAE,CAAC,GACpC,oBAAoB,CACxB,CAAC;YACF,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,sCAAsC,CAC3C,QAAuE;QAEvE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;YACjC,OAAO,CAAC,mCAAmC,GAAG,QAAQ,CAAC;YACvD,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACI,WAAW,CAAC,SAAkB;QACnC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;YACjC,uCACK,OAAO,GACP;gBACD,QAAQ,EAAE,SAAS;gBACnB,eAAe,EAAE,SAAS;gBAC1B,YAAY,EAAE,SAAS;aACxB,EACD;QACJ,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,SAAS,CACd,IAAY,EACZ,KAAiC;QAEjC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CACvB,KAAc,EACd,iBAA0B;QAE1B,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,EAAE,EAAE;YAC/B,OAAO,IAAA,6CAAoB,EAAC,MAAM,CAAC,CAAC;QACtC,CAAC,CAAC;aACC,aAAa,CAAC;YACb,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,IAAI;YACjB,UAAU,EAAE,KAAK;YACjB,eAAe,EAAE,MAAM;YACvB,0BAA0B,EAAE,KAAK;YAEjC,OAAO,EAAE,KAAK;YACd,eAAe,EAAE,IAAI;YACrB,eAAe,EAAE,IAAI;SACtB,CAAC;aACD,wBAAwB,CAAC,KAAK,EAAE;YAC/B,mBAAmB,EAAE,wCAAwC;YAC7D,OAAO,EAAE,IAAI;YACb,eAAe,EAAE,KAAK;YACtB,eAAe,EAAE,KAAK;SACvB,CAAC;aACD,WAAW,CAAC,iBAAiB,CAAC;YAC/B,6FAA6F;aAC5F,WAAW,CAAC,2BAAU,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAtdD,gEAsdC"}

package/dist/postgraphile/websocket-utils.d.ts

@@ -0,0 +1,11 @@
+import { Request } from 'express';
+import { WebSocket } from 'graphql-ws';
+/**
+ * Extract the reference to web socket when given a request object that is coming
+ * from Postgraphile. The web socket reference is attached as a symbol.
+ *
+ * @param req A Postgraphile request.
+ * @returns
+ */
+export declare const getWebsocketFromRequest: (req: Request) => WebSocket | undefined;
+//# sourceMappingURL=websocket-utils.d.ts.map

package/dist/postgraphile/websocket-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-utils.d.ts","sourceRoot":"","sources":["../../src/postgraphile/websocket-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,QAC7B,OAAO,KACX,SAAS,GAAG,SAMd,CAAC"}

package/dist/postgraphile/websocket-utils.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWebsocketFromRequest = void 0;
+/**
+ * Extract the reference to web socket when given a request object that is coming
+ * from Postgraphile. The web socket reference is attached as a symbol.
+ *
+ * @param req A Postgraphile request.
+ * @returns
+ */
+const getWebsocketFromRequest = (req) => {
+    const websocketSymbol = Object.getOwnPropertySymbols(req.socket).filter((sym) => sym.description === 'websocket')[0];
+    const websocket = req.socket[websocketSymbol];
+    return websocket;
+};
+exports.getWebsocketFromRequest = getWebsocketFromRequest;
+//# sourceMappingURL=websocket-utils.js.map

package/dist/postgraphile/websocket-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-utils.js","sourceRoot":"","sources":["../../src/postgraphile/websocket-utils.ts"],"names":[],"mappings":";;;AAGA;;;;;;GAMG;AACI,MAAM,uBAAuB,GAAG,CACrC,GAAY,EACW,EAAE;IACzB,MAAM,eAAe,GAAG,MAAM,CAAC,qBAAqB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,CACrE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,KAAK,WAAW,CACzC,CAAC,CAAC,CAAC,CAAC;IACL,MAAM,SAAS,GAAI,GAAW,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IACvD,OAAO,SAAsB,CAAC;AAChC,CAAC,CAAC;AARW,QAAA,uBAAuB,2BAQlC"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@axinom/mosaic-graphql-common",
+  "version": "0.1.0-rc.0",
+  "description": "Common GraphQL and PostGraphile related functionality.",
+  "author": "Axinom",
+  "license": "PROPRIETARY",
+  "keywords": [
+    "axinom",
+    "mosaic",
+    "axinom mosaic"
+  ],
+  "files": [
+    "dist",
+    "src"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "yarn clean && tsc --project tsconfig.build.json",
+    "build:ci": "yarn workspaces focus && yarn build",
+    "dev": "tsc -w --project tsconfig.build.json",
+    "publish:latest": "npm run build && npm publish",
+    "test": "jest --silent",
+    "test:watch": "jest --watch --silent",
+    "test:cov": "jest --coverage --silent && yarn posttest:cov",
+    "posttest:cov": "ts-node ../../scripts/open-test-coverage.ts -- libs/graphql-common",
+    "test:debug": "node --inspect -r ts-node/register ../../node_modules/jest/bin/jest.js --runInBand --silent",
+    "test:ci": "jest --reporters=default --reporters=jest-junit --coverage --coverageReporters=cobertura --coverageReporters=html",
+    "lint": "eslint . --ext .ts,.tsx,.js --color --cache"
+  },
+  "dependencies": {
+    "@graphile/pg-pubsub": "^4.12.3",
+    "endent": "^2.1.0",
+    "express": "^4.17.1",
+    "graphile-build": "^4.13.0",
+    "graphile-build-pg": "^4.13.0",
+    "graphile-utils": "^4.13.0",
+    "graphql": "^15.4.0",
+    "inflection": "^1.12.0",
+    "jest": "^29",
+    "jest-expect-message": "^1.1.3",
+    "pg": "^8.5.1",
+    "postgraphile": "^4.13.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.17",
+    "@types/inflection": "^1.5.28",
+    "@types/jest": "^29",
+    "@types/jest-expect-message": "^1.1.0",
+    "@types/node": "^18.11.18",
+    "eslint": "^8.35.0",
+    "rimraf": "^3.0.2",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "294d6a683845640ef70dc4ed5e9f057dfaacc388"
+}

package/src/common/checks.ts

@@ -0,0 +1,23 @@
+/**
+ * Check if a variable is a string index based object
+ * @param value variable to check
+ */
+// must be a real function: https://github.com/microsoft/TypeScript/issues/36931
+export function assertDictionary(
+  value: unknown,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+): asserts value is { [key: string]: any } {
+  if (typeof value !== 'object' || value === null) {
+    throw Error('The value is no string indexed object.');
+  }
+}
+
+export const isNullOrWhitespace = <T>(
+  value: T | null | undefined,
+): value is null | undefined => {
+  return (
+    value === null ||
+    value === undefined ||
+    (typeof value === 'string' && value.trim().length === 0)
+  );
+};

package/src/common/index.ts

@@ -0,0 +1,2 @@
+export * from './checks';
+export * from './types';

package/src/common/types.ts

@@ -0,0 +1,15 @@
+/** TYpe definition of an object with field accessor. */
+export interface Dict<T> {
+  [key: string]: T;
+}
+
+/**
+ * Error to be thrown in a default block of an exhaustive switch-case block, if checked value has a finite amount of possible values (e.g enum).
+ * This error has a very low chance to actually be thrown.
+ * Instead, it is used by IDE to give an indication of which possible value is not covered by switch-case and will result in a failed build.
+ */
+export class UnreachableCaseError extends Error {
+  constructor(val: never) {
+    super(`Unreachable case: ${val}`);
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './common';
+export * from './plugins';
+export * from './postgraphile';

package/src/plugins/add-error-codes-enum-plugin.ts

@@ -0,0 +1,102 @@
+import { GraphQLEnumType } from 'graphql';
+import { Plugin } from 'postgraphile';
+import { Dict } from '../common';
+
+type GraphQLEnumValues = Dict<{ value: string; description: string }>;
+
+export interface MosaicErrorDefinition {
+  message: string;
+  code: string;
+}
+
+/**
+ * Maps an array of error code enum objects to a single object, forming a
+ * unified ErrorCodes GraphQL Enum.
+ */
+const mapEnumValues = (
+  errorCodeEnums: Dict<MosaicErrorDefinition>[],
+): GraphQLEnumValues => {
+  const values: GraphQLEnumValues = {};
+  for (const errorCodeEnum of errorCodeEnums) {
+    for (const key in errorCodeEnum) {
+      if (Object.prototype.hasOwnProperty.call(errorCodeEnum, key)) {
+        const element = errorCodeEnum[key];
+        if (values[element.code]) {
+          throw new Error(
+            `Error code '${element.code}' is used in multiple enum objects. Error codes must be unique.`,
+          );
+        }
+
+        values[element.code] = {
+          value: element.code,
+          description: element.message,
+        };
+      }
+    }
+  }
+
+  return values;
+};
+
+/**
+ * Adds a detached enum type to the GraphQL schema, listing all possible
+ * ErrorCode values and adding messages as a descriptions.
+ * 
+ * Make sure to add it after `EnforceStrictPermissionsPlugin` or any other
+ * plugin that might filter queries out of the resulting schema.
+ *
+ * If there is a need to adjust this enum - use `GraphQLEnumType` postgraphile
+ * hook and `isErrorCodesEnum` scope to find the generated enum. E.g.
+ * 
+ * ```ts
+  builder.hook('GraphQLEnumType', (enumField, _build, context) => {
+    if (context.scope.isErrorCodesEnum === true) {
+      // Modification logic
+    }
+    return enumField;
+  });
+ * ```
+ */
+export const AddErrorCodesEnumPluginFactory: (
+  errorCodeEnums: Dict<MosaicErrorDefinition>[],
+) => Plugin = (errorCodeEnums: Dict<MosaicErrorDefinition>[]) => (builder) => {
+  const dummyQueryName = '_dummyErrorCodesEnum';
+
+  // Attaches the enum type and a dummy query endpoint to the schema.
+  // Postgraphile removes all unused types, so we are first adding a dummy
+  // query endpoint (to emulate enum usage), and during the `finalize` phase -
+  // we delete it, so that the cleanup would not remove the enum type itself.
+  builder.hook(
+    'GraphQLObjectType:fields',
+    (fields, { extend, newWithHooks }, { scope: { isRootQuery } }) => {
+      if (!isRootQuery) {
+        return fields;
+      }
+      const values = mapEnumValues(errorCodeEnums);
+      const enumType = newWithHooks(
+        GraphQLEnumType,
+        {
+          name: 'ErrorCodesEnum',
+          description: `Exposes all error codes and messages for errors that a service requests can throw. In some cases, messages that are actually thrown can be different, since they can include more details or a single code can used for different errors of the same type.`,
+          values,
+        },
+        { isErrorCodesEnum: true },
+      );
+
+      return extend(fields, {
+        [dummyQueryName]: {
+          type: enumType,
+        },
+      });
+    },
+  );
+
+  // Removing the dummy type from schema, leaving only the enum type.
+  builder.hook('finalize', (schema) => {
+    const query = schema.getQueryType();
+    if (query) {
+      delete query.getFields()[dummyQueryName];
+    }
+    return schema;
+  });
+};