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

package/dist/esm/common/checks.js

@@ -0,0 +1,16 @@
+/**
+ * Check if a variable is a string index based object
+ * @param value variable to check
+ */
+// must be a real function: https://github.com/microsoft/TypeScript/issues/36931
+export function assertDictionary(value) {
+    if (typeof value !== 'object' || value === null) {
+        throw Error('The value is no string indexed object.');
+    }
+}
+export const isNullOrWhitespace = (value) => {
+    return (value === null ||
+        value === undefined ||
+        (typeof value === 'string' && value.trim().length === 0));
+};
+//# sourceMappingURL=checks.js.map

package/dist/esm/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,MAAM,UAAU,gBAAgB,CAC9B,KAAc;IAGd,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,MAAM,KAAK,CAAC,wCAAwC,CAAC,CAAC;IACxD,CAAC;AACH,CAAC;AAED,MAAM,CAAC,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"}

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

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

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

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

package/dist/esm/common/index.js

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

package/dist/esm/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC"}

package/dist/esm/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/esm/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/esm/common/types.js

@@ -0,0 +1,11 @@
+/**
+ * Error to be thrown in a default block of an exhaustive switch-case block, if checked value has a finite amount of possible values (e.g enum).
+ * This error has a very low chance to actually be thrown.
+ * Instead, it is used by IDE to give an indication of which possible value is not covered by switch-case and will result in a failed build.
+ */
+export class UnreachableCaseError extends Error {
+    constructor(val) {
+        super(`Unreachable case: ${val}`);
+    }
+}
+//# sourceMappingURL=types.js.map

package/dist/esm/common/types.js.map

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

package/dist/esm/index.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,5 @@
+export * from './common/index.js';
+export * from './middleware/index.js';
+export * from './plugins/index.js';
+export * from './postgraphile/index.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC"}

package/dist/esm/middleware/forward-to-graphiql.d.ts

@@ -0,0 +1,8 @@
+import type { NextFunction, Request, Response } from 'express';
+/**
+ * Middleware that forwards requests that accept html to graphiql.
+ * @param graphQLUrl The url to forward from. (default: '/graphql')
+ * @param graphiQLUrl The url to forward to. (default: '/graphiql')
+ */
+export declare const forwardToGraphiQl: (graphQLUrl?: string, graphiQLUrl?: string) => (req: Request, res: Response, next: NextFunction) => void;
+//# sourceMappingURL=forward-to-graphiql.d.ts.map

package/dist/esm/middleware/forward-to-graphiql.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"forward-to-graphiql.d.ts","sourceRoot":"","sources":["../../../src/middleware/forward-to-graphiql.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAC3B,mBAAuB,EAAE,oBAAyB,MAClD,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,KAAG,IAYlD,CAAC"}

package/dist/esm/middleware/forward-to-graphiql.js

@@ -0,0 +1,17 @@
+/**
+ * Middleware that forwards requests that accept html to graphiql.
+ * @param graphQLUrl The url to forward from. (default: '/graphql')
+ * @param graphiQLUrl The url to forward to. (default: '/graphiql')
+ */
+export const forwardToGraphiQl = (graphQLUrl = '/graphql', graphiQLUrl = '/graphiql') => (req, res, next) => {
+    if (req.accepts('html') &&
+        // Get requests to / that accept html
+        ((req.path === '/' && req.method === 'GET' && req.accepts('html')) ||
+            // Get requests to /graphql that accept html and do not have a query
+            (req.path === graphQLUrl && req.method === 'GET' && !req.query.query))) {
+        // forward to graphiql
+        return res.redirect(graphiQLUrl);
+    }
+    return next();
+};
+//# sourceMappingURL=forward-to-graphiql.js.map

package/dist/esm/middleware/forward-to-graphiql.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"forward-to-graphiql.js","sourceRoot":"","sources":["../../../src/middleware/forward-to-graphiql.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAC5B,CAAC,UAAU,GAAG,UAAU,EAAE,WAAW,GAAG,WAAW,EAAE,EAAE,CACvD,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAQ,EAAE;IACxD,IACE,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC;QACnB,qCAAqC;QACrC,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,KAAK,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChE,oEAAoE;YACpE,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,IAAI,GAAG,CAAC,MAAM,KAAK,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EACxE,CAAC;QACD,sBAAsB;QACtB,OAAO,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,IAAI,EAAE,CAAC;AAChB,CAAC,CAAC"}

package/dist/esm/middleware/index.d.ts

@@ -0,0 +1,2 @@
+export * from './forward-to-graphiql.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/middleware/index.d.ts.map

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

package/dist/esm/middleware/index.js

@@ -0,0 +1,2 @@
+export * from './forward-to-graphiql.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/middleware/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/middleware/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC"}

package/dist/esm/package.json

@@ -0,0 +1 @@
+{"type":"module"}

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

@@ -0,0 +1,27 @@
+import type { Plugin } from 'postgraphile';
+import type { Dict } from '../common/index.js';
+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/esm/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,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAI/C,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/esm/plugins/add-error-codes-enum-plugin.js

@@ -0,0 +1,74 @@
+import { GraphQLEnumType } from '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;
+  });
+ * ```
+ */
+export 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(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;
+    });
+};
+//# sourceMappingURL=add-error-codes-enum-plugin.js.map

package/dist/esm/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,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAW1C;;;GAGG;AACH,MAAM,aAAa,GAAG,CACpB,cAA6C,EAC1B,EAAE;IACrB,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;QAC3C,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;YAChC,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,EAAE,CAAC;gBAC7D,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;gBACnC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACzB,MAAM,IAAI,KAAK,CACb,eAAe,OAAO,CAAC,IAAI,iEAAiE,CAC7F,CAAC;gBACJ,CAAC;gBAED,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG;oBACrB,KAAK,EAAE,OAAO,CAAC,IAAI;oBACnB,WAAW,EAAE,OAAO,CAAC,OAAO;iBAC7B,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,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,CAAC;YACjB,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,MAAM,MAAM,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,YAAY,CAC3B,eAAe,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,CAAC;YACV,OAAO,KAAK,CAAC,SAAS,EAAE,CAAC,cAAc,CAAC,CAAC;QAC3C,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

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

@@ -0,0 +1,22 @@
+import type { 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/esm/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,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAG3C,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/esm/plugins/annotate-types-with-permissions-plugin.js

@@ -0,0 +1,140 @@
+import { isNullOrWhitespace } from '../common/index.js';
+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) => !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 = isNullOrWhitespace(currentDescription)
+        ? ''
+        : currentDescription;
+    return permissions.length > 0
+        ? [
+            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 }`
+ */
+export 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) => {
+        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
+            context?.scope?.pgIntrospection?.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;
+    });
+};
+export const exportedForTestingAnnotatePlugin = { setPermissionsCommentText };
+//# sourceMappingURL=annotate-types-with-permissions-plugin.js.map

package/dist/esm/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,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAcxD,KAAK,UAAU,YAAY,CAAC,SAAe;IACzC,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;IACzC,IAAI,CAAC;QACH,uEAAuE;QACvE,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC;;;;;;;;;0BASjB,CAAC,CAAC;QACxB,OAAO,WAAW,CAAC,IAAI,CAAC;IAC1B,CAAC;YAAS,CAAC;QACT,MAAM,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC;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,CAAC;QAC3E,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CACxC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,KAAK,aAAa,CAChD,CAAC;IACJ,CAAC;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,kBAAkB,CAAC,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,kBAAkB,CAAC,kBAAkB,CAAC;QACxD,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,kBAAkB,CAAC;IACvB,OAAO,WAAW,CAAC,MAAM,GAAG,CAAC;QAC3B,CAAC,CAAC;YACE,kBAAkB,CAAC,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;AACH,MAAM,CAAC,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,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QAED,sDAAsD;QACtD,IAAI,KAAK,CAAC,eAAe,EAAE,CAAC;YAC1B,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,CAAC;gBACb,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;YACf,CAAC;YAED,GAAG,CAAC,WAAW,GAAG,yBAAyB,CACzC,GAAG,CAAC,WAAW,EACf,QAAQ,EACR,SAAS,CACV,CAAC;YACF,OAAO,GAAG,CAAC;QACb,CAAC;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,OAAO,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,KAAK,WAAW,EACrD,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QAED,8CAA8C;QAC9C,IAAI,KAAK,CAAC,eAAe,EAAE,CAAC;YAC1B,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;QACb,CAAC;QAED,2DAA2D;QAC3D,4CAA4C;QAC5C,oEAAoE;QACpE,oDAAoD;QACpD,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gCAAgC,GAAG,EAAE,yBAAyB,EAAE,CAAC"}

package/dist/esm/plugins/bulk-edit/bulk-edit-async-plugin-factory.d.ts

@@ -0,0 +1,61 @@
+import { type DbClient, type PgAuthenticatedManagementSubject } from '@axinom/mosaic-db-common';
+import type { BasicConfig, BasicDBConfig, BasicManagedServiceConfig } from '@axinom/mosaic-service-common';
+import type { StoreInboxMessage } from '@axinom/mosaic-transactional-inbox-outbox';
+import type { Plugin } from 'postgraphile';
+type MinimalConfig = Pick<BasicConfig, 'serviceId'> & (Pick<BasicDBConfig, 'dbOwner'> & Pick<BasicManagedServiceConfig, 'dbEnvOwner'>);
+/**
+ * This factory will generate a Postgraphile plugin that adds a mutation to the selected entities allowing the user to perform a bulk edit operation on the specified entity and its relations.
+ *
+ * @param tableName Name of the table to enable the BulkEdit mutation
+ * @param bulkEditMutationName Name of the BulkEdit mutation to be generated
+ * @param messageSettings The settings for the MultiTenantMessaging for the service that implements the ItemChangeCommand (e.g. ImageServiceMultiTenantMessagingSettings.ImageServicePerformItemChange)
+ * @param excludedForeignKeyRelations Optional array of FK table names to exclude from bulk edit operations
+ * @returns The Postgraphile plugin that enables the BulkEdit mutation.
+ */
+export declare const BulkEditAsyncPluginFactory: (tableName: string, bulkEditMutationName: string, getLongLivedToken: (originalToken: string, config: BasicDBConfig) => Promise<string>, excludedForeignKeyRelations?: string[]) => Plugin;
+interface MainResolverPayload {
+    mainTableName: string;
+    gqlFieldNameToColumnNameMap: {
+        [key: string]: string;
+    };
+    inputData?: {
+        [key: string]: any;
+    };
+}
+interface FkResolverPayload {
+    [fKTableName: string]: {
+        parentKeyColumnName: string;
+        fkGqlFieldNameToColumnNameMap: {
+            [key: string]: string;
+        };
+        inputData?: {
+            [key: string]: any;
+        }[];
+    };
+}
+/**
+ * Metadata for clearing all entities in a foreign key relation
+ */
+interface FkClearPayload {
+    [fKTableName: string]: {
+        parentKeyColumnName: string;
+        shouldClear: boolean;
+    };
+}
+/**
+ * Complete payload for bulk item change operations
+ * Contains metadata for all possible actions: set, clear, remove, and add
+ */
+interface BulkItemChangePayload {
+    set: MainResolverPayload;
+    clears: FkClearPayload;
+    removals: FkResolverPayload;
+    additions: FkResolverPayload;
+}
+/**
+ * Exported for testing purposes
+ * @internal
+ */
+export declare function asyncResolverImplementation(bulkItemChangePayload: BulkItemChangePayload, entityIds: string[], config: MinimalConfig, ownerPool: DbClient, envOwnerPool: DbClient, longLivedToken: string, subject: PgAuthenticatedManagementSubject, storeInboxMessage: StoreInboxMessage): Promise<void>;
+export {};
+//# sourceMappingURL=bulk-edit-async-plugin-factory.d.ts.map

package/dist/esm/plugins/bulk-edit/bulk-edit-async-plugin-factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk-edit-async-plugin-factory.d.ts","sourceRoot":"","sources":["../../../../src/plugins/bulk-edit/bulk-edit-async-plugin-factory.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,gCAAgC,EAGtC,MAAM,0BAA0B,CAAC;AAMlC,OAAO,KAAK,EACV,WAAW,EACX,aAAa,EACb,yBAAyB,EAC1B,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAC;AAgBnF,OAAO,KAAK,EAAqB,MAAM,EAAiB,MAAM,cAAc,CAAC;AAE7E,KAAK,aAAa,GAAG,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,GACjD,CAAC,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,GAC7B,IAAI,CAAC,yBAAyB,EAAE,YAAY,CAAC,CAAC,CAAC;AAEnD;;;;;;;;GAQG;AACH,eAAO,MAAM,0BAA0B,GACrC,WAAW,MAAM,EACjB,sBAAsB,MAAM,EAC5B,mBAAmB,CACjB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,aAAa,KAClB,OAAO,CAAC,MAAM,CAAC,EACpB,8BAA8B,MAAM,EAAE,KACrC,MAwNF,CAAC;AAgDF,UAAU,mBAAmB;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,2BAA2B,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACvD,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACpC;AAED,UAAU,iBAAiB;IACzB,CAAC,WAAW,EAAE,MAAM,GAAG;QACrB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,6BAA6B,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QACzD,SAAS,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE,EAAE,CAAC;KACtC,CAAC;CACH;AAED;;GAEG;AACH,UAAU,cAAc;IACtB,CAAC,WAAW,EAAE,MAAM,GAAG;QACrB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,WAAW,EAAE,OAAO,CAAC;KACtB,CAAC;CACH;AAED;;;GAGG;AACH,UAAU,qBAAqB;IAC7B,GAAG,EAAE,mBAAmB,CAAC;IACzB,MAAM,EAAE,cAAc,CAAC;IACvB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,SAAS,EAAE,iBAAiB,CAAC;CAC9B;AA8HD;;;GAGG;AACH,wBAAsB,2BAA2B,CAC/C,qBAAqB,EAAE,qBAAqB,EAC5C,SAAS,EAAE,MAAM,EAAE,EACnB,MAAM,EAAE,aAAa,EACrB,SAAS,EAAE,QAAQ,EACnB,YAAY,EAAE,QAAQ,EACtB,cAAc,EAAE,MAAM,EACtB,OAAO,EAAE,gCAAgC,EACzC,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAAC,IAAI,CAAC,CA0Jf"}