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

package/dist/plugins/validation-directives-plugin.js

@@ -0,0 +1,117 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationDirectivesPlugin = void 0;
+const graphile_build_1 = require("graphile-build");
+const inflection_1 = __importDefault(require("inflection"));
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+async function loadDbConstraints(builder) {
+    const constraintQuery = `
+    SELECT
+      oid, conname, conrelid, conkey, pg_get_constraintdef(oid) AS definition
+    FROM
+      pg_constraint
+    WHERE
+      contype = 'c' AND conrelid > 0;`;
+    // this pgConfig is not part of the public TS builder API so it may change
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const queryResult = await builder.options.pgConfig.query(constraintQuery);
+    return queryResult.rows;
+}
+async function getConstraints(builder) {
+    const constraints = {};
+    const rows = await loadDbConstraints(builder);
+    for (const row of rows) {
+        const key = `${row.conrelid}`;
+        constraints[key] = constraints[key] || [];
+        constraints[key].push({
+            id: row.oid,
+            name: row.conname,
+            tableId: row.conrelid,
+            definition: row.definition,
+            tableIndexes: row.conkey,
+        });
+    }
+    return constraints;
+}
+function mapCheckToValidation(constraint) {
+    const regex = /CHECK\s*\(\s*([a-zA-Z0-9_]+\.){0,1}([a-zA-Z0-9_]+)\s*\(\s*(['a-zA-Z0-9_]+)\s*,\s*(['a-zA-Z0-9_]+)/gm;
+    const result = regex.exec(constraint);
+    if ((result === null || result === void 0 ? void 0 : result.length) && result.length > 4) {
+        switch (result[2]) {
+            // custom handle when parameters are used - otherwise default is fine
+            case 'constraint_max_length':
+                return `@maxLength(${result[4]})`;
+            case 'constraint_min_length':
+                return `@minLength(${result[4]})`;
+            default:
+                // eslint-disable-next-line no-case-declarations
+                const constraintName = inflection_1.default.camelize(result[2].replace('constraint_', ''), true);
+                return `@${constraintName}()`;
+        }
+    }
+    return '';
+}
+/**
+ *  Plugin that adds validation directives to graphql schema descriptions.
+ */
+const ValidationDirectivesPlugin = async (builder) => {
+    const constraints = await getConstraints(builder);
+    builder.hook('GraphQLInputObjectType:fields', (fields, _build, context) => {
+        var _a, _b;
+        const tableConstraints = constraints[`${(_a = context.scope.pgIntrospection) === null || _a === void 0 ? void 0 : _a.id}`];
+        const columnMappings = {};
+        // check if there are any constraints in the DB
+        if (tableConstraints && Object.keys(fields).length) {
+            for (const constraint of tableConstraints) {
+                for (const tableIndex of constraint.tableIndexes) {
+                    // find the DB column by its index with 'pg_constraint.conkey'
+                    const column = context.scope.pgIntrospection.attributes.find((at) => at.num === tableIndex);
+                    const validation = mapCheckToValidation(constraint.definition);
+                    if (validation) {
+                        // Converting the column name to camelCase to follow the general GraphQL naming pattern when adding it to the description.
+                        const prop = (0, graphile_build_1.camelCase)(column.name);
+                        columnMappings[prop] = (_b = columnMappings[prop]) !== null && _b !== void 0 ? _b : { annotations: [] };
+                        columnMappings[prop].annotations.push(validation);
+                    }
+                }
+            }
+        }
+        for (const prop in columnMappings) {
+            const f = fields[prop];
+            if (f) {
+                const annotations = columnMappings[prop].annotations.sort().join('\n');
+                f.description = f.description
+                    ? `${f.description}\n${annotations}`
+                    : annotations;
+            }
+        }
+        return fields;
+    });
+    builder.hook('GraphQLSchema', (schemaConfig /*, build*/) => {
+        return schemaConfig;
+        // The following would allow to add custom directives.
+        // They can only be used on the server! They are not sent back to clients.
+        // return {
+        //   ...schemaConfig,
+        //   directives: [
+        //     ...(schemaConfig.directives || []),
+        //     build.newWithHooks(
+        //       build.graphql.GraphQLDirective,
+        //       {
+        //         name: 'upper',
+        //         locations: ['FIELD_DEFINITION', 'FIELD'],
+        //         args: {
+        //           name: { type: build.graphql.GraphQLString },
+        //         },
+        //       },
+        //       { isUpperDirective: true },
+        //     ),
+        //   ],
+        // };
+    });
+};
+exports.ValidationDirectivesPlugin = ValidationDirectivesPlugin;
+//# sourceMappingURL=validation-directives-plugin.js.map

package/dist/plugins/validation-directives-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation-directives-plugin.js","sourceRoot":"","sources":["../../src/plugins/validation-directives-plugin.ts"],"names":[],"mappings":";;;;;;AAAA,mDAAkE;AAClE,4DAAoC;AAepC,8DAA8D;AAC9D,KAAK,UAAU,iBAAiB,CAAC,OAAsB;IACrD,MAAM,eAAe,GAAG;;;;;;sCAMY,CAAC;IAErC,0EAA0E;IAC1E,8DAA8D;IAC9D,MAAM,WAAW,GAAG,MAAO,OAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAC/D,eAAe,CAChB,CAAC;IACF,OAAO,WAAW,CAAC,IAAI,CAAC;AAC1B,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,OAAsB;IAClD,MAAM,WAAW,GAAgB,EAAE,CAAC;IACpC,MAAM,IAAI,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAC9C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,MAAM,GAAG,GAAG,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC9B,WAAW,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAC1C,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YACpB,EAAE,EAAE,GAAG,CAAC,GAAG;YACX,IAAI,EAAE,GAAG,CAAC,OAAO;YACjB,OAAO,EAAE,GAAG,CAAC,QAAQ;YACrB,UAAU,EAAE,GAAG,CAAC,UAAU;YAC1B,YAAY,EAAE,GAAG,CAAC,MAAM;SACzB,CAAC,CAAC;KACJ;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,oBAAoB,CAAC,UAAkB;IAC9C,MAAM,KAAK,GACT,qGAAqG,CAAC;IAExG,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,IAAI,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,KAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACvC,QAAQ,MAAM,CAAC,CAAC,CAAC,EAAE;YACjB,qEAAqE;YACrE,KAAK,uBAAuB;gBAC1B,OAAO,cAAc,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC;YACpC,KAAK,uBAAuB;gBAC1B,OAAO,cAAc,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC;YACpC;gBACE,gDAAgD;gBAChD,MAAM,cAAc,GAAG,oBAAU,CAAC,QAAQ,CACxC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,EACpC,IAAI,CACL,CAAC;gBACF,OAAO,IAAI,cAAc,IAAI,CAAC;SACjC;KACF;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AACD;;GAEG;AACI,MAAM,0BAA0B,GAAW,KAAK,EAAE,OAAO,EAAE,EAAE;IAClE,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,CAAC;IAElD,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;;QACxE,MAAM,gBAAgB,GACpB,WAAW,CAAC,GAAG,MAAA,OAAO,CAAC,KAAK,CAAC,eAAe,0CAAE,EAAE,EAAE,CAAC,CAAC;QACtD,MAAM,cAAc,GAAoC,EAAE,CAAC;QAC3D,+CAA+C;QAC/C,IAAI,gBAAgB,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE;YAClD,KAAK,MAAM,UAAU,IAAI,gBAAgB,EAAE;gBACzC,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,YAAY,EAAE;oBAChD,8DAA8D;oBAC9D,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,CAC1D,CAAC,EAAmB,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,KAAK,UAAU,CAC/C,CAAC;oBAEF,MAAM,UAAU,GAAG,oBAAoB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;oBAC/D,IAAI,UAAU,EAAE;wBACd,0HAA0H;wBAC1H,MAAM,IAAI,GAAG,IAAA,0BAAS,EAAC,MAAM,CAAC,IAAI,CAAC,CAAC;wBACpC,cAAc,CAAC,IAAI,CAAC,GAAG,MAAA,cAAc,CAAC,IAAI,CAAC,mCAAI,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC;wBACnE,cAAc,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;qBACnD;iBACF;aACF;SACF;QAED,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE;YACjC,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;YACvB,IAAI,CAAC,EAAE;gBACL,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACvE,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC,WAAW;oBAC3B,CAAC,CAAC,GAAG,CAAC,CAAC,WAAW,KAAK,WAAW,EAAE;oBACpC,CAAC,CAAC,WAAW,CAAC;aACjB;SACF;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,EAAE;QACzD,OAAO,YAAY,CAAC;QACpB,sDAAsD;QACtD,0EAA0E;QAC1E,WAAW;QACX,qBAAqB;QACrB,kBAAkB;QAClB,0CAA0C;QAC1C,0BAA0B;QAC1B,wCAAwC;QACxC,UAAU;QACV,yBAAyB;QACzB,oDAAoD;QACpD,kBAAkB;QAClB,yDAAyD;QACzD,aAAa;QACb,WAAW;QACX,oCAAoC;QACpC,SAAS;QACT,OAAO;QACP,KAAK;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AA9DW,QAAA,0BAA0B,8BA8DrC"}

package/dist/postgraphile/enhance-graphql-errors.d.ts

@@ -0,0 +1,48 @@
+import { GraphQLError, OperationTypeNode } from 'graphql';
+import { GraphQLErrorExtended } from 'postgraphile';
+import { Dict } from '../common';
+/**
+ * A GraphQLErrorExtended object with additional properties.
+ * This error is thrown by the GraphQL API and returned to the original requester.
+ */
+export declare type GraphQLErrorEnhanced = GraphQLErrorExtended & {
+    extensions: {
+        /** The timestamp when the error was raised */
+        timestamp: string;
+    };
+    timestamp: string;
+    code: string;
+    details?: Dict<unknown>;
+};
+export declare const GeneralGraphQlErrorCode = "GENERAL_GRAPHQL_ERROR";
+/**
+ * Contains data about the failed GraphQL request without exposing passed variables, since they can contain sensitive values.
+ */
+export interface GraphQlOperation {
+    /**
+     * Type of operation, e.g. query, mutation or subscription.
+     */
+    operationType?: OperationTypeNode;
+    /**
+     * Name of operation, if defined.
+     */
+    operationName?: string;
+    /**
+     * List of root endpoints, since a single operation can perform multiple queries/mutations.
+     */
+    rootEndpoints?: string[];
+}
+/**
+ * Default graphql error handler. Extracts information to return as an error response (timestamp, message, code and path parameters) and logs error and response information using provided logger.
+ *
+ * @param errors - Array of original graphql errors
+ * @param operationName - The operation name that was executed in case the request contained more than one operation. Found in `req.body.operationName`.
+ * @param customizeFields - Override error fields message, exception code, and add extensions fields with your custom values. Extension fields are added to the extensions object and cannot use existing field names.
+ * @param log - allows you to log the error with parts of the GraphQL request data
+ */
+export declare const enhanceGraphqlErrors: (errors: readonly GraphQLError[], operationName?: string, customizeFields?: ((error: GraphQLError, originalError?: Error | null) => {
+    message?: string;
+    code?: string;
+    extensions?: Dict<unknown>;
+} | undefined) | undefined, log?: ((error: GraphQLErrorEnhanced, operations?: GraphQlOperation[]) => void) | undefined) => GraphQLErrorEnhanced[];
+//# sourceMappingURL=enhance-graphql-errors.d.ts.map

package/dist/postgraphile/enhance-graphql-errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enhance-graphql-errors.d.ts","sourceRoot":"","sources":["../../src/postgraphile/enhance-graphql-errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EAEZ,iBAAiB,EAGlB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,oBAAoB,GAAG,oBAAoB,GAAG;IAChE,UAAU,EAAE;QACV,8CAA8C;QAC9C,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IAEF,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,uBAAuB,0BAA0B,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AA2CD;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,WACvB,SAAS,YAAY,EAAE,kBACf,MAAM,6BAEb,YAAY,kBACH,KAAK,GAAG,IAAI,KAE1B;IACE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,KAAK,OAAO,CAAC,CAAC;CAC5B,GACD,SAAS,8BACC,oBAAoB,eAAe,gBAAgB,EAAE,KAAK,IAAI,kBAC3E,oBAAoB,EA4BtB,CAAC"}

package/dist/postgraphile/enhance-graphql-errors.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enhanceGraphqlErrors = exports.GeneralGraphQlErrorCode = void 0;
+const graphql_1 = require("graphql");
+exports.GeneralGraphQlErrorCode = 'GENERAL_GRAPHQL_ERROR';
+const basicErrorMapper = (error, operationName) => {
+    var _a;
+    return Object.assign(Object.assign({}, error), { message: (_a = error.message) !== null && _a !== void 0 ? _a : 'No error description was provided', extensions: {
+            timestamp: new Date().toISOString(),
+            operationName,
+            exception: {
+                code: exports.GeneralGraphQlErrorCode,
+            },
+        }, 
+        //TODO: remove backwards compatibility after 01-11-2023
+        timestamp: new Date().toISOString(), code: exports.GeneralGraphQlErrorCode, details: undefined });
+};
+const getGraphQlOperations = (requestBody) => {
+    try {
+        const parsedGqlRequest = (0, graphql_1.parse)(requestBody);
+        return parsedGqlRequest.definitions.map((op) => {
+            var _a, _b;
+            return ({
+                name: (_b = (_a = op.name) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : 'NO_OPERATION_NAME',
+                operation: op.operation,
+                rootEndpoints: op.selectionSet.selections.map((selection) => selection.name.value),
+            });
+        });
+    }
+    catch (_a) {
+        // Unable to parse the GraphQL request string.
+        return undefined;
+    }
+};
+/**
+ * Default graphql error handler. Extracts information to return as an error response (timestamp, message, code and path parameters) and logs error and response information using provided logger.
+ *
+ * @param errors - Array of original graphql errors
+ * @param operationName - The operation name that was executed in case the request contained more than one operation. Found in `req.body.operationName`.
+ * @param customizeFields - Override error fields message, exception code, and add extensions fields with your custom values. Extension fields are added to the extensions object and cannot use existing field names.
+ * @param log - allows you to log the error with parts of the GraphQL request data
+ */
+const enhanceGraphqlErrors = (errors, operationName, customizeFields, log) => {
+    return errors.map((error) => {
+        var _a, _b, _c, _d;
+        const enhancedError = basicErrorMapper(error, operationName);
+        if (customizeFields) {
+            const custom = customizeFields(error, error.originalError);
+            enhancedError.message = (_a = custom === null || custom === void 0 ? void 0 : custom.message) !== null && _a !== void 0 ? _a : enhancedError.message;
+            enhancedError.extensions = Object.assign(Object.assign({}, custom === null || custom === void 0 ? void 0 : custom.extensions), enhancedError.extensions);
+            enhancedError.extensions.exception.code =
+                (_b = custom === null || custom === void 0 ? void 0 : custom.code) !== null && _b !== void 0 ? _b : enhancedError.extensions.exception.code;
+            //TODO: remove backwards compatibility after 01-11-2023
+            enhancedError.code = enhancedError.extensions.exception.code;
+            enhancedError.details = custom === null || custom === void 0 ? void 0 : custom.extensions;
+        }
+        if (log) {
+            const originalError = error.originalError;
+            const request = ((_c = error.source) === null || _c === void 0 ? void 0 : _c.body) || ((_d = originalError === null || originalError === void 0 ? void 0 : originalError.source) === null || _d === void 0 ? void 0 : _d.body);
+            const graphQlOperations = getGraphQlOperations(request);
+            log(enhancedError, graphQlOperations);
+        }
+        return enhancedError;
+    });
+};
+exports.enhanceGraphqlErrors = enhanceGraphqlErrors;
+//# sourceMappingURL=enhance-graphql-errors.js.map

package/dist/postgraphile/enhance-graphql-errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enhance-graphql-errors.js","sourceRoot":"","sources":["../../src/postgraphile/enhance-graphql-errors.ts"],"names":[],"mappings":";;;AAAA,qCAOiB;AAmBJ,QAAA,uBAAuB,GAAG,uBAAuB,CAAC;AAoB/D,MAAM,gBAAgB,GAAG,CACvB,KAAmB,EACnB,aAAsB,EACA,EAAE;;IACxB,uCACK,KAAK,KACR,OAAO,EAAE,MAAA,KAAK,CAAC,OAAO,mCAAI,mCAAmC,EAC7D,UAAU,EAAE;YACV,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,aAAa;YACb,SAAS,EAAE;gBACT,IAAI,EAAE,+BAAuB;aAC9B;SACF;QACD,uDAAuD;QACvD,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EACnC,IAAI,EAAE,+BAAuB,EAC7B,OAAO,EAAE,SAAS,IAClB;AACJ,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAC3B,WAAmB,EACa,EAAE;IAClC,IAAI;QACF,MAAM,gBAAgB,GAAG,IAAA,eAAK,EAAC,WAAW,CAAC,CAAC;QAC5C,OAAQ,gBAAgB,CAAC,WAAyC,CAAC,GAAG,CACpE,CAAC,EAAE,EAAE,EAAE;;YAAC,OAAA,CAAC;gBACP,IAAI,EAAE,MAAA,MAAA,EAAE,CAAC,IAAI,0CAAE,KAAK,mCAAI,mBAAmB;gBAC3C,SAAS,EAAE,EAAE,CAAC,SAAS;gBACvB,aAAa,EAAE,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAC3C,CAAC,SAAS,EAAE,EAAE,CAAE,SAAuB,CAAC,IAAI,CAAC,KAAK,CACnD;aACF,CAAC,CAAA;SAAA,CACH,CAAC;KACH;IAAC,WAAM;QACN,8CAA8C;QAC9C,OAAO,SAAS,CAAC;KAClB;AACH,CAAC,CAAC;AAEF;;;;;;;GAOG;AACI,MAAM,oBAAoB,GAAG,CAClC,MAA+B,EAC/B,aAAsB,EACtB,eASa,EACb,GAA4E,EACpD,EAAE;IAC1B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;QAC1B,MAAM,aAAa,GAAG,gBAAgB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;QAE7D,IAAI,eAAe,EAAE;YACnB,MAAM,MAAM,GAAG,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;YAC3D,aAAa,CAAC,OAAO,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,mCAAI,aAAa,CAAC,OAAO,CAAC;YACjE,aAAa,CAAC,UAAU,mCACnB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,GAClB,aAAa,CAAC,UAAU,CAC5B,CAAC;YACF,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI;gBACrC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,mCAAI,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC;YAE1D,uDAAuD;YACvD,aAAa,CAAC,IAAI,GAAG,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC;YAC7D,aAAa,CAAC,OAAO,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,CAAC;SAC5C;QAED,IAAI,GAAG,EAAE;YACP,MAAM,aAAa,GAAG,KAAK,CAAC,aAA2C,CAAC;YACxE,MAAM,OAAO,GAAG,CAAA,MAAA,KAAK,CAAC,MAAM,0CAAE,IAAI,MAAI,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,MAAM,0CAAE,IAAI,CAAA,CAAC;YAClE,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;YACxD,GAAG,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;SACvC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AA1CW,QAAA,oBAAoB,wBA0C/B"}

package/dist/postgraphile/index.d.ts

@@ -0,0 +1,4 @@
+export * from './enhance-graphql-errors';
+export * from './postgraphile-options-builder';
+export * from './websocket-utils';
+//# sourceMappingURL=index.d.ts.map

package/dist/postgraphile/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/postgraphile/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC"}

package/dist/postgraphile/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./enhance-graphql-errors"), exports);
+__exportStar(require("./postgraphile-options-builder"), exports);
+__exportStar(require("./websocket-utils"), exports);
+//# sourceMappingURL=index.js.map

package/dist/postgraphile/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/postgraphile/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC;AACzC,iEAA+C;AAC/C,oDAAkC"}

package/dist/postgraphile/postgraphile-options-builder.d.ts

@@ -0,0 +1,273 @@
+import { Request, Response } from 'express';
+import { Plugin } from 'graphile-build';
+import { GraphQLError } from 'graphql';
+import { GraphQLErrorExtended, Middleware, Options, PostGraphileOptions, PostGraphilePlugin, mixed } from 'postgraphile';
+import { Dict } from '../common';
+/**
+ * This is the function type that must be used when developing Hook Plugin factory functions.
+ *
+ * @example
+ * ```ts
+    const subscriptionAuthorizationHookFactory = (
+      buildOptions: PostGraphileOptions<Request, Response> | undefined,
+    ): PostGraphilePlugin => {
+      return {
+        // returns a PostGraphilePlugin
+      }
+    }
+ * ```
+ */
+export type HookPluginFactory = (buildOptions: PostGraphileOptions<Request, Response> | undefined) => PostGraphilePlugin;
+/**
+ * A builder class that allows construction of postgraphile options using multiple dedicated extension methods.
+ */
+export declare class PostgraphileOptionsBuilder {
+    private transformers;
+    private headers;
+    private pluginHooks;
+    private hookFuncs;
+    /**
+     * Builds a postgraphile options object with previously used extension methods.
+     */
+    build(): PostGraphileOptions<Request, Response>;
+    /**
+     * Builds a hook plugin that adds custom headers to http responses.
+     */
+    private buildHeadersHookPlugin;
+    /**
+     * 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: HookPluginFactory): PostgraphileOptionsBuilder;
+    /**
+     * 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: PostGraphilePlugin): PostgraphileOptionsBuilder;
+    /**
+     * 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: (req: Request) => Promise<Dict<mixed>> | Dict<mixed>): PostgraphileOptionsBuilder;
+    /**
+     * 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: (errors: readonly GraphQLError[], req: Request, res: Response) => GraphQLErrorExtended[]): PostgraphileOptionsBuilder;
+    /**
+     * 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: PostGraphileOptions<Request, Response>): PostgraphileOptionsBuilder;
+    /**
+     * 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: boolean, properties: PostGraphileOptions<Request, Response>): PostgraphileOptionsBuilder;
+    /**
+     * 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, }: {
+        plugin: Plugin;
+        websocketMiddlewares?: Middleware<Request, Response>[];
+        hookFactory?: HookPluginFactory;
+    }): PostgraphileOptionsBuilder;
+    /**
+     * 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: Plugin[]): PostgraphileOptionsBuilder;
+    /**
+     * 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: boolean, ...plugins: Plugin[]): PostgraphileOptionsBuilder;
+    /**
+     * 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: Plugin[]): PostgraphileOptionsBuilder;
+    /**
+     * 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: Partial<Options>): PostgraphileOptionsBuilder;
+    /**
+     * 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: (req: Request, res: Response) => Promise<Record<string, any>>): PostgraphileOptionsBuilder;
+    /**
+     * 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: boolean): PostgraphileOptionsBuilder;
+    /**
+     * Sets a response header for each GraphQL request.
+     *
+     * @param name header name
+     * @param value header value
+     */
+    setHeader(name: string, value: string | number | string[]): PostgraphileOptionsBuilder;
+    /**
+     * 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: boolean, graphqlGuiEnabled: boolean): PostgraphileOptionsBuilder;
+}
+//# sourceMappingURL=postgraphile-options-builder.d.ts.map

package/dist/postgraphile/postgraphile-options-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgraphile-options-builder.d.ts","sourceRoot":"","sources":["../../src/postgraphile/postgraphile-options-builder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAc,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,OAAO,EACL,oBAAoB,EACpB,UAAU,EACV,OAAO,EACP,mBAAmB,EACnB,kBAAkB,EAElB,KAAK,EACN,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGjC;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAC9B,YAAY,EAAE,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,SAAS,KAC7D,kBAAkB,CAAC;AAExB;;GAEG;AACH,qBAAa,0BAA0B;IACrC,OAAO,CAAC,YAAY,CAEgC;IAEpD,OAAO,CAAC,OAAO,CAAwC;IACvD,OAAO,CAAC,WAAW,CAA0D;IAC7E,OAAO,CAAC,SAAS,CAAwD;IAEzE;;OAEG;IACI,KAAK,IAAI,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC;IAoBtD;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAkB9B;;;;;;;;;;;;;OAaG;IACI,oBAAoB,CACzB,YAAY,EAAE,iBAAiB,GAC9B,0BAA0B;IAK7B;;;;;;;;;;;OAWG;IACI,aAAa,CAClB,UAAU,EAAE,kBAAkB,GAC7B,0BAA0B;IAK7B;;;;;;;;;;;;;OAaG;IACI,aAAa,CAClB,UAAU,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAC/D,0BAA0B;IAQ7B;;;;;;;;;;;;;;;;;;OAkBG;IACI,gBAAgB,CACrB,YAAY,EAAE,CACZ,MAAM,EAAE,SAAS,YAAY,EAAE,EAC/B,GAAG,EAAE,OAAO,EACZ,GAAG,EAAE,QAAQ,KACV,oBAAoB,EAAE,GAC1B,0BAA0B;IAQ7B;;;;;;;;;;;;;;;OAeG;IACI,aAAa,CAClB,UAAU,EAAE,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC,GACjD,0BAA0B;IAO7B;;;;;;;;;;;;;;;;;OAiBG;IACI,wBAAwB,CAC7B,SAAS,EAAE,OAAO,EAClB,UAAU,EAAE,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC,GACjD,0BAA0B;IAS7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACI,mBAAmB,CAAC,EACzB,MAAM,EACN,oBAAoB,EACpB,WAAW,GACZ,EAAE;QACD,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB,CAAC,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;QACvD,WAAW,CAAC,EAAE,iBAAiB,CAAC;KACjC,GAAG,0BAA0B;IA8B9B;;;;;;;;;;;;;;OAcG;IACI,UAAU,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,0BAA0B;IAUnE;;;;;;;;;;;OAWG;IACI,qBAAqB,CAC1B,SAAS,EAAE,OAAO,EAClB,GAAG,OAAO,EAAE,MAAM,EAAE,GACnB,0BAA0B;IAO7B;;;;;;;;;OASG;IACI,WAAW,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,0BAA0B;IAUpE;;;;;;;;;OASG;IACI,uBAAuB,CAC5B,oBAAoB,EAAE,OAAO,CAAC,OAAO,CAAC,GACrC,0BAA0B;IAW7B;;;;;;;;;;;;OAYG;IACI,sCAAsC,CAC3C,QAAQ,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GACtE,0BAA0B;IAQ7B;;;;;;;;;OASG;IACI,WAAW,CAAC,SAAS,EAAE,OAAO,GAAG,0BAA0B;IAclE;;;;;OAKG;IACI,SAAS,CACd,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAChC,0BAA0B;IAK7B;;;;;OAKG;IACI,kBAAkB,CACvB,KAAK,EAAE,OAAO,EACd,iBAAiB,EAAE,OAAO,GACzB,0BAA0B;CA0B9B"}