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

package/README.md

@@ -0,0 +1,16 @@
+# @axinom/mosaic-graphql-common
+
+## About the Package
+
+This package is part of the Axinom Mosaic development platform. More information
+can be found at https://portal.axinom.com/mosaic.
+
+## License
+
+This package can be licensed under the
+[Axinom Products Licensing Agreement](https://portal.axinom.com/mosaic/contracts/products-licensing-agreement)
+or evaluated under the
+[Axinom Products Evaluation Agreement](https://portal.axinom.com/mosaic/contracts/products-evaluation-agreement).  
+No part of Axinom's software may be copied, modified, propagated, or distributed
+except in accordance with the terms contained in the Axinom Products Licensing
+Agreement and Axinom Products Evaluation Agreement.

package/dist/common/checks.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Check if a variable is a string index based object
+ * @param value variable to check
+ */
+export declare function assertDictionary(value: unknown): asserts value is {
+    [key: string]: any;
+};
+export declare const isNullOrWhitespace: <T>(value: T | null | undefined) => value is null | undefined;
+//# sourceMappingURL=checks.d.ts.map

package/dist/common/checks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checks.d.ts","sourceRoot":"","sources":["../../src/common/checks.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,OAAO,GAEb,OAAO,CAAC,KAAK,IAAI;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAIzC;AAED,eAAO,MAAM,kBAAkB,+DAQ9B,CAAC"}

package/dist/common/checks.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNullOrWhitespace = exports.assertDictionary = void 0;
+/**
+ * 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
+function assertDictionary(value) {
+    if (typeof value !== 'object' || value === null) {
+        throw Error('The value is no string indexed object.');
+    }
+}
+exports.assertDictionary = assertDictionary;
+const isNullOrWhitespace = (value) => {
+    return (value === null ||
+        value === undefined ||
+        (typeof value === 'string' && value.trim().length === 0));
+};
+exports.isNullOrWhitespace = isNullOrWhitespace;
+//# sourceMappingURL=checks.js.map

package/dist/common/checks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checks.js","sourceRoot":"","sources":["../../src/common/checks.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,gFAAgF;AAChF,SAAgB,gBAAgB,CAC9B,KAAc;IAGd,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;QAC/C,MAAM,KAAK,CAAC,wCAAwC,CAAC,CAAC;KACvD;AACH,CAAC;AAPD,4CAOC;AAEM,MAAM,kBAAkB,GAAG,CAChC,KAA2B,EACA,EAAE;IAC7B,OAAO,CACL,KAAK,KAAK,IAAI;QACd,KAAK,KAAK,SAAS;QACnB,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC,CACzD,CAAC;AACJ,CAAC,CAAC;AARW,QAAA,kBAAkB,sBAQ7B"}

package/dist/common/index.d.ts

@@ -0,0 +1,3 @@
+export * from './checks';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC"}

package/dist/common/index.js

@@ -0,0 +1,19 @@
+"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("./checks"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,0CAAwB"}

package/dist/common/types.d.ts

@@ -0,0 +1,13 @@
+/** 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 declare class UnreachableCaseError extends Error {
+    constructor(val: never);
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/common/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,MAAM,WAAW,IAAI,CAAC,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC;CAClB;AAED;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,KAAK;gBACjC,GAAG,EAAE,KAAK;CAGvB"}

package/dist/common/types.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnreachableCaseError = void 0;
+/**
+ * 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.
+ */
+class UnreachableCaseError extends Error {
+    constructor(val) {
+        super(`Unreachable case: ${val}`);
+    }
+}
+exports.UnreachableCaseError = UnreachableCaseError;
+//# sourceMappingURL=types.js.map

package/dist/common/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":";;;AAKA;;;;GAIG;AACH,MAAa,oBAAqB,SAAQ,KAAK;IAC7C,YAAY,GAAU;QACpB,KAAK,CAAC,qBAAqB,GAAG,EAAE,CAAC,CAAC;IACpC,CAAC;CACF;AAJD,oDAIC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './common';
+export * from './plugins';
+export * from './postgraphile';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC"}

package/dist/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("./common"), exports);
+__exportStar(require("./plugins"), exports);
+__exportStar(require("./postgraphile"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,4CAA0B;AAC1B,iDAA+B"}

package/dist/plugins/add-error-codes-enum-plugin.d.ts

@@ -0,0 +1,27 @@
+import { Plugin } from 'postgraphile';
+import { Dict } from '../common';
+export interface MosaicErrorDefinition {
+    message: string;
+    code: string;
+}
+/**
+ * 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 declare const AddErrorCodesEnumPluginFactory: (errorCodeEnums: Dict<MosaicErrorDefinition>[]) => Plugin;
+//# sourceMappingURL=add-error-codes-enum-plugin.d.ts.map

package/dist/plugins/add-error-codes-enum-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-error-codes-enum-plugin.d.ts","sourceRoot":"","sources":["../../src/plugins/add-error-codes-enum-plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAIjC,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AA+BD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,8BAA8B,EAAE,CAC3C,cAAc,EAAE,IAAI,CAAC,qBAAqB,CAAC,EAAE,KAC1C,MAwCJ,CAAC"}

package/dist/plugins/add-error-codes-enum-plugin.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddErrorCodesEnumPluginFactory = void 0;
+const graphql_1 = require("graphql");
+/**
+ * Maps an array of error code enum objects to a single object, forming a
+ * unified ErrorCodes GraphQL Enum.
+ */
+const mapEnumValues = (errorCodeEnums) => {
+    const values = {};
+    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;
+  });
+ * ```
+ */
+const AddErrorCodesEnumPluginFactory = (errorCodeEnums) => (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(graphql_1.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;
+    });
+};
+exports.AddErrorCodesEnumPluginFactory = AddErrorCodesEnumPluginFactory;
+//# sourceMappingURL=add-error-codes-enum-plugin.js.map

package/dist/plugins/add-error-codes-enum-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-error-codes-enum-plugin.js","sourceRoot":"","sources":["../../src/plugins/add-error-codes-enum-plugin.ts"],"names":[],"mappings":";;;AAAA,qCAA0C;AAW1C;;;GAGG;AACH,MAAM,aAAa,GAAG,CACpB,cAA6C,EAC1B,EAAE;IACrB,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE;QAC1C,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE;YAC/B,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,EAAE;gBAC5D,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;gBACnC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBACxB,MAAM,IAAI,KAAK,CACb,eAAe,OAAO,CAAC,IAAI,iEAAiE,CAC7F,CAAC;iBACH;gBAED,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG;oBACrB,KAAK,EAAE,OAAO,CAAC,IAAI;oBACnB,WAAW,EAAE,OAAO,CAAC,OAAO;iBAC7B,CAAC;aACH;SACF;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACI,MAAM,8BAA8B,GAE7B,CAAC,cAA6C,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE;IAC3E,MAAM,cAAc,GAAG,sBAAsB,CAAC;IAE9C,mEAAmE;IACnE,wEAAwE;IACxE,4EAA4E;IAC5E,2EAA2E;IAC3E,OAAO,CAAC,IAAI,CACV,0BAA0B,EAC1B,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,EAAE;QAC/D,IAAI,CAAC,WAAW,EAAE;YAChB,OAAO,MAAM,CAAC;SACf;QACD,MAAM,MAAM,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,YAAY,CAC3B,yBAAe,EACf;YACE,IAAI,EAAE,gBAAgB;YACtB,WAAW,EAAE,4PAA4P;YACzQ,MAAM;SACP,EACD,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAC3B,CAAC;QAEF,OAAO,MAAM,CAAC,MAAM,EAAE;YACpB,CAAC,cAAc,CAAC,EAAE;gBAChB,IAAI,EAAE,QAAQ;aACf;SACF,CAAC,CAAC;IACL,CAAC,CACF,CAAC;IAEF,mEAAmE;IACnE,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,EAAE;QAClC,MAAM,KAAK,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC;QACpC,IAAI,KAAK,EAAE;YACT,OAAO,KAAK,CAAC,SAAS,EAAE,CAAC,cAAc,CAAC,CAAC;SAC1C;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AA1CW,QAAA,8BAA8B,kCA0CzC"}

package/dist/plugins/annotate-types-with-permissions-plugin.d.ts

@@ -0,0 +1,22 @@
+import { Plugin } from 'postgraphile';
+interface PolicyRow {
+    schemaname: string;
+    tablename: string;
+    permissive: 'PERMISSIVE' | 'RESTRICTIVE';
+    command: string;
+    using: string | null;
+    withcheck: string | null;
+}
+type SqlOperation = 'SELECT' | 'INSERT' | 'UPDATE' | 'DELETE';
+declare function setPermissionsCommentText(currentDescription: string | null | undefined, policies: PolicyRow[], type: SqlOperation): string;
+/**
+ * Plugin that adds permissions annotation to graphql schema descriptions.
+ *
+ * @param graphileBuildOptions should be of type `Partial<Options> & { ownerPool: Pool }`
+ */
+export declare const AnnotateTypesWithPermissionsPlugin: Plugin;
+export declare const exportedForTestingAnnotatePlugin: {
+    setPermissionsCommentText: typeof setPermissionsCommentText;
+};
+export {};
+//# sourceMappingURL=annotate-types-with-permissions-plugin.d.ts.map

package/dist/plugins/annotate-types-with-permissions-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotate-types-with-permissions-plugin.d.ts","sourceRoot":"","sources":["../../src/plugins/annotate-types-with-permissions-plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAGtC,UAAU,SAAS;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,YAAY,GAAG,aAAa,CAAC;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,KAAK,YAAY,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAsD9D,iBAAS,yBAAyB,CAChC,kBAAkB,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAC7C,QAAQ,EAAE,SAAS,EAAE,EACrB,IAAI,EAAE,YAAY,GACjB,MAAM,CAeR;AAID;;;;GAIG;AACH,eAAO,MAAM,kCAAkC,EAAE,MA2GhD,CAAC;AAEF,eAAO,MAAM,gCAAgC;;CAAgC,CAAC"}

package/dist/plugins/annotate-types-with-permissions-plugin.js

@@ -0,0 +1,145 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportedForTestingAnnotatePlugin = exports.AnnotateTypesWithPermissionsPlugin = void 0;
+const common_1 = require("../common");
+async function loadPolicies(ownerPool) {
+    const client = await ownerPool.connect();
+    try {
+        // get all policies, sort so "ALL" is last and custom ones come earlier
+        const queryResult = await client.query(`
+    select 
+      schemaname,
+      tablename,
+      permissive,
+      cmd as command,
+      qual as using,
+      with_check as withcheck
+    from pg_policies
+    order by command desc`);
+        return queryResult.rows;
+    }
+    finally {
+        client.release();
+    }
+}
+function parsePermissions(sqlPolicy) {
+    const matches = /(ax_utils\.)?user_has_permission\('([^']+)/.exec(sqlPolicy);
+    return matches && matches.length > 2 ? matches[2] : '';
+}
+function getPermissions(policies, commands, field) {
+    let matchingPolicies = policies.filter((p) => commands.find((cmd) => p.command === cmd) && p[field]);
+    // If RESTRICTIVE policies found, list only them and remove PERMISSIVE ones
+    if (matchingPolicies.some((policy) => policy.permissive === 'RESTRICTIVE')) {
+        matchingPolicies = matchingPolicies.filter((policy) => policy.permissive === 'RESTRICTIVE');
+    }
+    return [
+        ...new Set(// removes duplicates
+        matchingPolicies
+            .map((p) => parsePermissions(p[field]))
+            .filter((p) => !(0, common_1.isNullOrWhitespace)(p))
+            .sort()),
+    ];
+}
+function setPermissionsCommentText(currentDescription, policies, type) {
+    const field = type === 'SELECT' || type === 'DELETE' ? 'using' : 'withcheck';
+    const permissions = getPermissions(policies, ['ALL', type], field);
+    const description = (0, common_1.isNullOrWhitespace)(currentDescription)
+        ? ''
+        : currentDescription;
+    return permissions.length > 0
+        ? [
+            (0, common_1.isNullOrWhitespace)(description) ? description : `${description}\n`,
+            ...permissions
+                .map((permission) => `@permissions: ${permission}`)
+                .join('\n'),
+        ].join('')
+        : description;
+}
+// all available hooks are defined here:
+// https://www.graphile.org/graphile-build/all-hooks/
+/**
+ * Plugin that adds permissions annotation to graphql schema descriptions.
+ *
+ * @param graphileBuildOptions should be of type `Partial<Options> & { ownerPool: Pool }`
+ */
+const AnnotateTypesWithPermissionsPlugin = async (builder, { ownerPool }) => {
+    const allPolicies = await loadPolicies(ownerPool);
+    builder.hook('GraphQLInputObjectType', (obj, _build, context) => {
+        const scope = context.scope;
+        // PostGraphile input Types that do not correspond to a database table
+        if (scope.isPointInputType ||
+            scope.isIntervalInputType ||
+            scope.isPgConnectionFilterOperators ||
+            scope.isPgConnectionFilterMany ||
+            scope.isPgCondition ||
+            scope.isPgConnectionFilter) {
+            return obj;
+        }
+        // PostGraphile generated input types for DB mutations
+        if (scope.pgIntrospection) {
+            const policies = allPolicies.filter((value) => value.schemaname === scope.pgIntrospection.namespaceName &&
+                value.tablename === scope.pgIntrospection.name);
+            let operation;
+            switch (true) {
+                case scope.isPgCreateInputType:
+                    operation = 'INSERT';
+                    break;
+                case scope.isPgUpdateInputType:
+                    operation = 'UPDATE';
+                    break;
+                case scope.isPgDeleteInputType:
+                    operation = 'DELETE';
+                    break;
+                default:
+                    return obj;
+            }
+            obj.description = setPermissionsCommentText(obj.description, policies, operation);
+            return obj;
+        }
+        // The input objects that come to this code-path are custom input types
+        // and require custom logic to protect them!
+        // Only works if they have input >types< - if they have no input or scalar
+        // input values they cannot be found by this method.
+        // Example: PopulateInput from the populate endpoint
+        return obj;
+    });
+    builder.hook('GraphQLObjectType', (obj, _build, context) => {
+        var _a, _b;
+        const scope = context.scope;
+        if (
+        // PostGraphile Types that do not correspond to a database table
+        scope.isPointType ||
+            scope.isIntervalType ||
+            scope.isPgConnectionFilterOperators ||
+            scope.isPgConnectionFilterMany ||
+            scope.isPgCondition ||
+            scope.isPgConnectionFilter ||
+            scope.isPageInfo ||
+            scope.isEdgeType ||
+            scope.isRootQuery ||
+            scope.isRootMutation ||
+            scope.isRootSubscription ||
+            scope.isMutationPayload ||
+            scope.isPgDeletePayloadType ||
+            scope.isPgUpdatePayloadType ||
+            // TODO: Procedures have no row level security: secure them in another way
+            ((_b = (_a = context === null || context === void 0 ? void 0 : context.scope) === null || _a === void 0 ? void 0 : _a.pgIntrospection) === null || _b === void 0 ? void 0 : _b.kind) === 'procedure') {
+            return obj;
+        }
+        // PostGraphile generated types for DB queries
+        if (scope.pgIntrospection) {
+            const policies = allPolicies.filter((value) => value.schemaname === scope.pgIntrospection.namespaceName &&
+                value.tablename === scope.pgIntrospection.name);
+            obj.description = setPermissionsCommentText(obj.description, policies, 'SELECT');
+            return obj;
+        }
+        // The objects that come to this code-path are custom types
+        // and require custom logic to protect them!
+        // Only works if they have >types< - if they have no input or scalar
+        // input values they cannot be found by this method.
+        return obj;
+    });
+};
+exports.AnnotateTypesWithPermissionsPlugin = AnnotateTypesWithPermissionsPlugin;
+exports.exportedForTestingAnnotatePlugin = { setPermissionsCommentText };
+//# sourceMappingURL=annotate-types-with-permissions-plugin.js.map

package/dist/plugins/annotate-types-with-permissions-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotate-types-with-permissions-plugin.js","sourceRoot":"","sources":["../../src/plugins/annotate-types-with-permissions-plugin.ts"],"names":[],"mappings":";;;AAEA,sCAA+C;AAc/C,KAAK,UAAU,YAAY,CAAC,SAAe;IACzC,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;IACzC,IAAI;QACF,uEAAuE;QACvE,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC;;;;;;;;;0BASjB,CAAC,CAAC;QACxB,OAAO,WAAW,CAAC,IAAI,CAAC;KACzB;YAAS;QACR,MAAM,CAAC,OAAO,EAAE,CAAC;KAClB;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,SAAiB;IACzC,MAAM,OAAO,GAAG,4CAA4C,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC7E,OAAO,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACzD,CAAC;AAED,SAAS,cAAc,CACrB,QAAqB,EACrB,QAAyB,EACzB,KAA4B;IAE5B,IAAI,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CACpC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAC7D,CAAC;IAEF,2EAA2E;IAC3E,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,KAAK,aAAa,CAAC,EAAE;QAC1E,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CACxC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,KAAK,aAAa,CAChD,CAAC;KACH;IAED,OAAO;QACL,GAAG,IAAI,GAAG,CAAU,qBAAqB;QACvC,gBAAgB;aACb,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAW,CAAC,CAAC;aAChD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAA,2BAAkB,EAAC,CAAC,CAAC,CAAC;aACrC,IAAI,EAAE,CACV;KACF,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAChC,kBAA6C,EAC7C,QAAqB,EACrB,IAAkB;IAElB,MAAM,KAAK,GAAG,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC;IAE7E,MAAM,WAAW,GAAG,cAAc,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IACnE,MAAM,WAAW,GAAG,IAAA,2BAAkB,EAAC,kBAAkB,CAAC;QACxD,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,kBAAkB,CAAC;IACvB,OAAO,WAAW,CAAC,MAAM,GAAG,CAAC;QAC3B,CAAC,CAAC;YACE,IAAA,2BAAkB,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,IAAI;YAClE,GAAG,WAAW;iBACX,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,iBAAiB,UAAU,EAAE,CAAC;iBAClD,IAAI,CAAC,IAAI,CAAC;SACd,CAAC,IAAI,CAAC,EAAE,CAAC;QACZ,CAAC,CAAC,WAAW,CAAC;AAClB,CAAC;AAED,wCAAwC;AACxC,qDAAqD;AACrD;;;;GAIG;AACI,MAAM,kCAAkC,GAAW,KAAK,EAC7D,OAAO,EACP,EAAE,SAAS,EAAE,EACb,EAAE;IACF,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,CAAC;IAClD,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;QAC9D,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAE5B,sEAAsE;QACtE,IACE,KAAK,CAAC,gBAAgB;YACtB,KAAK,CAAC,mBAAmB;YACzB,KAAK,CAAC,6BAA6B;YACnC,KAAK,CAAC,wBAAwB;YAC9B,KAAK,CAAC,aAAa;YACnB,KAAK,CAAC,oBAAoB,EAC1B;YACA,OAAO,GAAG,CAAC;SACZ;QAED,sDAAsD;QACtD,IAAI,KAAK,CAAC,eAAe,EAAE;YACzB,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CACjC,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,UAAU,KAAK,KAAK,CAAC,eAAe,CAAC,aAAa;gBACxD,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,eAAe,CAAC,IAAI,CACjD,CAAC;YAEF,IAAI,SAAuB,CAAC;YAE5B,QAAQ,IAAI,EAAE;gBACZ,KAAK,KAAK,CAAC,mBAAmB;oBAC5B,SAAS,GAAG,QAAQ,CAAC;oBACrB,MAAM;gBACR,KAAK,KAAK,CAAC,mBAAmB;oBAC5B,SAAS,GAAG,QAAQ,CAAC;oBACrB,MAAM;gBACR,KAAK,KAAK,CAAC,mBAAmB;oBAC5B,SAAS,GAAG,QAAQ,CAAC;oBACrB,MAAM;gBACR;oBACE,OAAO,GAAG,CAAC;aACd;YAED,GAAG,CAAC,WAAW,GAAG,yBAAyB,CACzC,GAAG,CAAC,WAAW,EACf,QAAQ,EACR,SAAS,CACV,CAAC;YACF,OAAO,GAAG,CAAC;SACZ;QAED,uEAAuE;QACvE,4CAA4C;QAC5C,0EAA0E;QAC1E,oDAAoD;QACpD,oDAAoD;QACpD,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;;QACzD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAE5B;QACE,gEAAgE;QAChE,KAAK,CAAC,WAAW;YACjB,KAAK,CAAC,cAAc;YACpB,KAAK,CAAC,6BAA6B;YACnC,KAAK,CAAC,wBAAwB;YAC9B,KAAK,CAAC,aAAa;YACnB,KAAK,CAAC,oBAAoB;YAC1B,KAAK,CAAC,UAAU;YAChB,KAAK,CAAC,UAAU;YAChB,KAAK,CAAC,WAAW;YACjB,KAAK,CAAC,cAAc;YACpB,KAAK,CAAC,kBAAkB;YACxB,KAAK,CAAC,iBAAiB;YACvB,KAAK,CAAC,qBAAqB;YAC3B,KAAK,CAAC,qBAAqB;YAC3B,0EAA0E;YAC1E,CAAA,MAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,0CAAE,eAAe,0CAAE,IAAI,MAAK,WAAW,EACrD;YACA,OAAO,GAAG,CAAC;SACZ;QAED,8CAA8C;QAC9C,IAAI,KAAK,CAAC,eAAe,EAAE;YACzB,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CACjC,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,UAAU,KAAK,KAAK,CAAC,eAAe,CAAC,aAAa;gBACxD,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,eAAe,CAAC,IAAI,CACjD,CAAC;YAEF,GAAG,CAAC,WAAW,GAAG,yBAAyB,CACzC,GAAG,CAAC,WAAW,EACf,QAAQ,EACR,QAAQ,CACT,CAAC;YACF,OAAO,GAAG,CAAC;SACZ;QAED,2DAA2D;QAC3D,4CAA4C;QAC5C,oEAAoE;QACpE,oDAAoD;QACpD,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AA3GW,QAAA,kCAAkC,sCA2G7C;AAEW,QAAA,gCAAgC,GAAG,EAAE,yBAAyB,EAAE,CAAC"}

package/dist/plugins/deprecate-stray-node-id-fields-plugin.d.ts

@@ -0,0 +1,14 @@
+import { Plugin } from 'postgraphile';
+type DeprecateMode = 'DEPRECATE' | 'DROP';
+/**
+ * NodePlugin is excluded by default to remove all references of NodeId fields
+ * and byNodeId operations. A few such instances are not removed and handled
+ * explicitly by this plugin, e.g. deletedEntityNodeId in the
+ * DeleteEntityPayload types.
+ *
+ * By default, the plugin marks each field as deprecated. Pass an explicit
+ * `DROP` value to drop the fields instead.
+ */
+export declare const DeprecateStrayNodeIdFieldsPlugin: (mode?: DeprecateMode) => Plugin;
+export {};
+//# sourceMappingURL=deprecate-stray-node-id-fields-plugin.d.ts.map

package/dist/plugins/deprecate-stray-node-id-fields-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecate-stray-node-id-fields-plugin.d.ts","sourceRoot":"","sources":["../../src/plugins/deprecate-stray-node-id-fields-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAGtC,KAAK,aAAa,GAAG,WAAW,GAAG,MAAM,CAAC;AAE1C;;;;;;;;GAQG;AACH,eAAO,MAAM,gCAAgC,UACpC,aAAa,KAAiB,MAyBpC,CAAC"}

package/dist/plugins/deprecate-stray-node-id-fields-plugin.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeprecateStrayNodeIdFieldsPlugin = void 0;
+const common_1 = require("../common");
+/**
+ * NodePlugin is excluded by default to remove all references of NodeId fields
+ * and byNodeId operations. A few such instances are not removed and handled
+ * explicitly by this plugin, e.g. deletedEntityNodeId in the
+ * DeleteEntityPayload types.
+ *
+ * By default, the plugin marks each field as deprecated. Pass an explicit
+ * `DROP` value to drop the fields instead.
+ */
+const DeprecateStrayNodeIdFieldsPlugin = (mode = 'DEPRECATE') => (builder) => {
+    builder.hook('GraphQLObjectType:fields', (fields, _build, context) => {
+        const typeName = context.Self.name;
+        if (typeName.startsWith('Delete') && typeName.endsWith('Payload')) {
+            Object.keys(fields)
+                .filter((name) => name.startsWith('deleted') && name.endsWith('NodeId'))
+                .map((name) => {
+                switch (mode) {
+                    case 'DEPRECATE':
+                        fields[name].deprecationReason = 'The field is obsolete.';
+                        break;
+                    case 'DROP':
+                        delete fields[name];
+                        break;
+                    default:
+                        throw new common_1.UnreachableCaseError(mode);
+                }
+            });
+        }
+        return fields;
+    });
+};
+exports.DeprecateStrayNodeIdFieldsPlugin = DeprecateStrayNodeIdFieldsPlugin;
+//# sourceMappingURL=deprecate-stray-node-id-fields-plugin.js.map

package/dist/plugins/deprecate-stray-node-id-fields-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecate-stray-node-id-fields-plugin.js","sourceRoot":"","sources":["../../src/plugins/deprecate-stray-node-id-fields-plugin.ts"],"names":[],"mappings":";;;AACA,sCAAiD;AAIjD;;;;;;;;GAQG;AACI,MAAM,gCAAgC,GAC3C,CAAC,OAAsB,WAAW,EAAU,EAAE,CAC9C,CAAC,OAAO,EAAE,EAAE;IACV,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;QACnE,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,IAAc,CAAC;QAC7C,IAAI,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;YACjE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;iBAChB,MAAM,CACL,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAChE;iBACA,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBACZ,QAAQ,IAAI,EAAE;oBACZ,KAAK,WAAW;wBACd,MAAM,CAAC,IAAI,CAAC,CAAC,iBAAiB,GAAG,wBAAwB,CAAC;wBAC1D,MAAM;oBACR,KAAK,MAAM;wBACT,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;wBACpB,MAAM;oBAER;wBACE,MAAM,IAAI,6BAAoB,CAAC,IAAI,CAAC,CAAC;iBACxC;YACH,CAAC,CAAC,CAAC;SACN;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AA1BS,QAAA,gCAAgC,oCA0BzC"}

package/dist/plugins/generic-bulk-plugin-factory.d.ts

@@ -0,0 +1,49 @@
+import GraphQL from 'graphql';
+import { Plugin } from 'postgraphile';
+/**
+ * A collection of parameters to decide on which entities and by which criteria bulk operation should be performed.
+ */
+export interface BulkFilter {
+    tableName: string;
+    primaryKeyName: string;
+    primaryKeyType: string;
+    filterType: GraphQL.GraphQLInputType;
+    filterName: string;
+    queryName: string;
+    typeName: string;
+}
+/**
+ * Interface for specifying bulk action endpoint name
+ */
+export interface CustomBulkSettings {
+    graphQLEndpointName: string;
+}
+/**
+ * Callback that decides for which filters a bulk action is defined
+ */
+export interface DefinePlugin {
+    (filter: BulkFilter): CustomBulkSettings | undefined;
+}
+/**
+ * Parameters that GenericBulkPluginFactory will provide to the callback, so that the actual bulk operation can be performed.
+ */
+export interface BulkIdParameters {
+    entityIds: number[] | string[];
+    entityType: string;
+    primaryKeyName: string;
+    tableName: string;
+    graphQLAdditionalInput: unknown;
+    graphQLContext: {
+        [str: string]: unknown;
+    };
+}
+/**
+ * Plugin factory to create bulk mutations based on query filters
+ * @param callback The callback that shall perform the actual bulk operation. It
+ * receives different parameters from the base plugin to assist with the
+ * operation, e.g. a list of ids for which the bulk operation shall be performed.
+ * @param definePlugin The callback that decides for which filters a bulk action is defined.
+ * @param inputType Defines additional input parameters for the bulk action. The values are forwarded as part of the message payload.
+ */
+export declare const GenericBulkPluginFactory: (callback: (parameters: BulkIdParameters) => Promise<void>, definePlugin: DefinePlugin, inputType?: GraphQL.GraphQLInputObjectType) => Plugin;
+//# sourceMappingURL=generic-bulk-plugin-factory.d.ts.map

package/dist/plugins/generic-bulk-plugin-factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generic-bulk-plugin-factory.d.ts","sourceRoot":"","sources":["../../src/plugins/generic-bulk-plugin-factory.ts"],"names":[],"mappings":"AAEA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAS,MAAM,EAAE,MAAM,cAAc,CAAC;AAG7C;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,OAAO,CAAC,gBAAgB,CAAC;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,CAAC,MAAM,EAAE,UAAU,GAAG,kBAAkB,GAAG,SAAS,CAAC;CACtD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,sBAAsB,EAAE,OAAO,CAAC;IAChC,cAAc,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CAC5C;AAgHD;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,0BACV,gBAAgB,KAAG,QAAQ,IAAI,CAAC,gBAC3C,YAAY,cACd,QAAQ,sBAAsB,KACzC,MAiJF,CAAC"}