@axinom/mosaic-graphql-common 0.33.0 → 0.34.0-rc.3

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

@@ -0,0 +1,436 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import _PgPubsub from '@graphile/pg-pubsub';
+import { NodePlugin } from 'graphile-build';
+import { GraphQLError } from 'graphql';
+import { IncomingMessage } from 'http';
+import { makePluginHook, } from 'postgraphile';
+import { enhanceGraphqlErrors } from './enhance-graphql-errors.js';
+// @graphile/pg-pubsub is a TypeScript-compiled CJS package that emits
+// `module.exports = { __esModule: true, default: pluginObject }`.
+// Node.js native ESM does not honour the __esModule sentinel, so the default
+// import receives the whole module.exports wrapper object, not the plugin.
+// `createRequire` cannot be used here because `import.meta.url` does not
+// compile under `module: CommonJS` in the CJS build pass of this dual-publish
+// library. The long-term fix is upgrading to PostGraphile v5, which replaces
+// this plugin with a first-class ESM-compatible subscription API.
+const PgPubsub = (_PgPubsub.default ?? _PgPubsub);
+/**
+ * A builder class that allows construction of postgraphile options using multiple dedicated extension methods.
+ */
+export class PostgraphileOptionsBuilder {
+    transformers = [];
+    headers = {};
+    pluginHooks = new Set();
+    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 = 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, req.authContext?.subject, 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 { ...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 { ...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
+            subscriptionEventEmitterMaxListeners: 0, // unlimited
+        }
+     * ```
+     *
+     * 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
+     *
+     * To customize the maximum number of listeners use:
+     *
+     * ```ts
+     * import PgPubsub from '@graphile/pg-pubsub'; // must be imported to extend the PostGraphileOptions type with the pg-pubsub options.
+     * ...
+     * new PostgraphileOptionsBuilder()
+     *  .setProperties({
+     *    subscriptionEventEmitterMaxListeners: 42,
+     *   })
+     * ```
+     *
+     * @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) => {
+            options.subscriptions = true;
+            options.appendPlugins = [
+                ...new Set([...(options.appendPlugins ?? []), plugin]),
+            ];
+            options.subscriptionEventEmitterMaxListeners = 0;
+            // Add the pub/sub realtime provider
+            // This is for PostGraphile server plugins: https://www.graphile.org/postgraphile/plugins/
+            this.pluginHooks.add(PgPubsub);
+            if (websocketMiddlewares) {
+                options.websocketMiddlewares = [
+                    ...new Set([
+                        ...(options.websocketMiddlewares ?? []),
+                        ...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) => {
+            options.appendPlugins = [
+                ...new Set([...(options.appendPlugins ?? []), ...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) => {
+            options.skipPlugins = [
+                ...new Set([...(options.skipPlugins ?? []), ...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) => {
+            options.graphileBuildOptions = {
+                ...(options.graphileBuildOptions ?? {}),
+                ...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 {
+                ...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 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(NodePlugin);
+        return this;
+    }
+}
+//# sourceMappingURL=postgraphile-options-builder.js.map

package/dist/esm/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,OAAO,SAAS,MAAM,qBAAqB,CAAC;AAE5C,OAAO,EAAE,UAAU,EAAe,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AACvC,OAAO,EACL,cAAc,GAOf,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,sEAAsE;AACtE,kEAAkE;AAClE,6EAA6E;AAC7E,2EAA2E;AAC3E,yEAAyE;AACzE,8EAA8E;AAC9E,6EAA6E;AAC7E,kEAAkE;AAClE,MAAM,QAAQ,GAAG,CAAE,SAAiB,CAAC,OAAO,IAAI,SAAS,CAAqB,CAAC;AAoB/E;;GAEG;AACH,MAAM,OAAO,0BAA0B;IAC7B,YAAY,GAE6B,EAAE,CAAC;IAE5C,OAAO,GAAqC,EAAE,CAAC;IAC/C,WAAW,GAA4B,IAAI,GAAG,EAAsB,CAAC;IACrE,SAAS,GAA2B,IAAI,GAAG,EAAqB,CAAC;IAEzE;;OAEG;IACI,KAAK;QACV,IAAI,OAAO,GAA2C,EAAE,CAAC;QACzD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YAC1C,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC;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,CAAC;YAC9B,OAAO,CAAC,UAAU,GAAG,cAAc,CAAC,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAC7D,CAAC;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,CAAC;YACzC,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,CAAC;wBAC/B,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC;4BAC5D,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;wBACxC,CAAC;oBACH,CAAC;oBACD,OAAO,GAAG,CAAC;gBACb,CAAC;aACF,CAAC,CAAC;QACL,CAAC;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,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,UAAU,EAAE,CAAC;QACvC,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,wBAAwB,CAC7B,SAAkB,EAClB,UAAkD;QAElD,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;gBACjC,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,UAAU,EAAE,CAAC;YACvC,CAAC,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;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,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;aAC/D,CAAC;YACF,OAAO,CAAC,oCAAoC,GAAG,CAAC,CAAC;YAEjD,oCAAoC;YACpC,0FAA0F;YAC1F,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAE/B,IAAI,oBAAoB,EAAE,CAAC;gBACzB,OAAO,CAAC,oBAAoB,GAAG;oBAC7B,GAAG,IAAI,GAAG,CAAgC;wBACxC,GAAG,CAAC,OAAO,CAAC,oBAAoB,IAAI,EAAE,CAAC;wBACvC,GAAG,oBAAoB;qBACxB,CAAC;iBACH,CAAC;YACJ,CAAC;iBAAM,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC;gBACzC,OAAO,CAAC,oBAAoB,GAAG,EAAE,CAAC;YACpC,CAAC;YAED,IAAI,WAAW,EAAE,CAAC;gBAChB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAClC,CAAC;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,OAAO,CAAC,aAAa,IAAI,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,CAAC;YACd,IAAI,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,CAAC;QAC9B,CAAC;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,OAAO,CAAC,WAAW,IAAI,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,GAAG;gBAC7B,GAAG,CAAC,OAAO,CAAC,oBAAoB,IAAI,EAAE,CAAC;gBACvC,GAAG,oBAAoB;aACxB,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,OAAO;gBACL,GAAG,OAAO;gBACV,GAAG;oBACD,QAAQ,EAAE,SAAS;oBACnB,eAAe,EAAE,SAAS;oBAC1B,YAAY,EAAE,SAAS;iBACxB;aACF,CAAC;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,oBAAoB,CAAC,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,UAAU,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

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

@@ -0,0 +1,11 @@
+import type { Request } from 'express';
+import type { 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/esm/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,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,GAClC,KAAK,OAAO,KACX,SAAS,GAAG,SAMd,CAAC"}

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

@@ -0,0 +1,13 @@
+/**
+ * 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 const getWebsocketFromRequest = (req) => {
+    const websocketSymbol = Object.getOwnPropertySymbols(req.socket).filter((sym) => sym.description === 'websocket')[0];
+    const websocket = req.socket[websocketSymbol];
+    return websocket;
+};
+//# sourceMappingURL=websocket-utils.js.map

package/dist/esm/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;AACH,MAAM,CAAC,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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axinom/mosaic-graphql-common",
-  "version": "0.33.0",
+  "version": "0.34.0-rc.3",
   "description": "Common GraphQL and PostGraphile related functionality.",
   "author": "Axinom",
   "license": "PROPRIETARY",
@@ -13,31 +13,41 @@
     "dist",
     "src"
   ],
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/cjs/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/cjs/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "scripts": {
     "clean": "rimraf dist",
-    "build": "yarn clean && tsc --project tsconfig.build.json",
-    "ts:validate": "tsc",
+    "build": "yarn clean && tsc --project tsconfig.build.json && tsc --project tsconfig.build.esm.json && node ../../scripts/write-esm-markers.js",
+    "ts:validate": "tsc && yarn build && yarn check:esm-interop",
     "build:ci": "yarn workspaces focus && yarn build",
     "dev": "tsc -w --project tsconfig.build.json",
     "publish:latest": "npm run build && npm publish",
     "test": "vitest run --silent",
     "test:watch": "vitest watch",
     "test:cov": "vitest run --coverage --silent && yarn posttest:cov",
-    "posttest:cov": "ts-node ../../scripts/open-test-coverage.ts -- libs/graphql-common",
+    "posttest:cov": "tsx ../../scripts/open-test-coverage.ts -- libs/graphql-common",
+    "check:esm-interop": "node ./scripts/check-esm-interop.mjs",
     "test:debug": "vitest run --inspect-brk --no-file-parallelism",
     "test:ci": "vitest run --reporter=default --reporter=junit --coverage --coverage.reporter=cobertura --coverage.reporter=html",
     "test:ui": "vitest --ui",
     "lint": "eslint . --ext .ts,.tsx,.js --color --cache"
   },
   "dependencies": {
-    "@axinom/mosaic-db-common": "^0.57.0",
-    "@axinom/mosaic-message-bus": "^0.50.0",
-    "@axinom/mosaic-message-bus-abstractions": "^0.24.3",
-    "@axinom/mosaic-messages": "^0.67.0",
-    "@axinom/mosaic-service-common": "^0.69.0",
-    "@axinom/mosaic-transactional-inbox-outbox": "^0.29.0",
+    "@axinom/mosaic-db-common": "^0.58.0-rc.3",
+    "@axinom/mosaic-message-bus": "^0.51.0-rc.3",
+    "@axinom/mosaic-message-bus-abstractions": "^0.24.4-rc.3",
+    "@axinom/mosaic-messages": "^0.68.0-rc.3",
+    "@axinom/mosaic-service-common": "^0.70.0-rc.3",
+    "@axinom/mosaic-transactional-inbox-outbox": "^0.30.0-rc.3",
     "@graphile/pg-pubsub": "^4.12.3",
     "endent": "^2.1.0",
     "express": "^4.17.1",
@@ -51,7 +61,7 @@
     "postgraphile": "^4.13.0"
   },
   "devDependencies": {
-    "@axinom/mosaic-dev-be-common": "^0.18.0",
+    "@axinom/mosaic-dev-be-common": "^0.19.0-rc.3",
     "@types/express": "^4.17.17",
     "@types/inflection": "^1.5.28",
     "@types/node": "^22.0.0",
@@ -59,12 +69,11 @@
     "eslint": "^8.35.0",
     "jest-extended": "^7.0.0",
     "rimraf": "^3.0.2",
-    "ts-node": "^10.9.1",
     "typescript": "^5.9.3",
     "vitest": "^4.0.18"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "75dcfd9bf92de1ef72a28f073e43a7dfaa7b430b"
+  "gitHead": "9c7831acd6fcced9a09f97ffd4c9d67ee1b3b640"
 }

package/src/common/index.ts

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

package/src/index.ts

@@ -1,4 +1,4 @@
-export * from './common';
-export * from './middleware';
-export * from './plugins';
-export * from './postgraphile';
+export * from './common/index.js';
+export * from './middleware/index.js';
+export * from './plugins/index.js';
+export * from './postgraphile/index.js';

package/src/middleware/forward-to-graphiql.ts

@@ -1,4 +1,4 @@
-import { NextFunction, Request, Response } from 'express';
+import type { NextFunction, Request, Response } from 'express';
 
 /**
  * Middleware that forwards requests that accept html to graphiql.

package/src/middleware/index.ts

@@ -1 +1 @@
-export * from './forward-to-graphiql';
+export * from './forward-to-graphiql.js';

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

@@ -1,6 +1,6 @@
 import { GraphQLEnumType } from 'graphql';
-import { Plugin } from 'postgraphile';
-import { Dict } from '../common';
+import type { Plugin } from 'postgraphile';
+import type { Dict } from '../common/index.js';
 
 type GraphQLEnumValues = Dict<{ value: string; description: string }>;
 

package/src/plugins/annotate-types-with-permissions-plugin.spec.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { exportedForTestingAnnotatePlugin } from './annotate-types-with-permissions-plugin';
+import { exportedForTestingAnnotatePlugin } from './annotate-types-with-permissions-plugin.js';
 const getPolicy = (
   overrides: {
     permissive?: string;

package/src/plugins/annotate-types-with-permissions-plugin.ts

@@ -1,6 +1,6 @@
-import { Pool } from 'pg';
-import { Plugin } from 'postgraphile';
-import { isNullOrWhitespace } from '../common';
+import type { Pool } from 'pg';
+import type { Plugin } from 'postgraphile';
+import { isNullOrWhitespace } from '../common/index.js';
 
 interface PolicyRow {
   schemaname: string;

package/src/plugins/bulk-edit/bulk-edit-async-plugin-factory.spec.ts

@@ -21,10 +21,10 @@ vi.mock('@axinom/mosaic-db-common', async () => {
   };
 });
 
-import { PerformItemChangeCommand } from '@axinom/mosaic-messages';
-import { StoreInboxMessage } from '@axinom/mosaic-transactional-inbox-outbox';
-import { DatabaseClient } from 'pg-transactional-outbox';
-import { asyncResolverImplementation } from './bulk-edit-async-plugin-factory';
+import type { PerformItemChangeCommand } from '@axinom/mosaic-messages';
+import type { StoreInboxMessage } from '@axinom/mosaic-transactional-inbox-outbox';
+import type { DatabaseClient } from 'pg-transactional-outbox';
+import { asyncResolverImplementation } from './bulk-edit-async-plugin-factory.js';
 
 describe('bulk-edit-async-plugin-factory', () => {
   describe('asyncResolverImplementation', () => {