@zenstackhq/runtime 2.4.0 → 2.5.0

package/enhancements/node/query-utils.d.ts

@@ -0,0 +1,38 @@
+import { type FieldInfo, type NestedWriteVisitorContext } from '../../cross';
+import type { CrudContract, DbClientContract } from '../../types';
+import { InternalEnhancementOptions } from './create-enhancement';
+export declare class QueryUtils {
+    private readonly prisma;
+    protected readonly options: InternalEnhancementOptions;
+    constructor(prisma: DbClientContract, options: InternalEnhancementOptions);
+    getIdFields(model: string): FieldInfo[];
+    makeIdSelection(model: string): any;
+    getEntityIds(model: string, entityData: any): Record<string, unknown>;
+    /**
+     * Initiates a transaction.
+     */
+    transaction<T>(db: CrudContract, action: (tx: CrudContract) => Promise<T>): Promise<T>;
+    /**
+     * Builds a reversed query for the given nested path.
+     */
+    buildReversedQuery(context: NestedWriteVisitorContext, forMutationPayload?: boolean, unsafeOperation?: boolean): any;
+    /**
+     * Composes a compound unique field from multiple fields. E.g.:  { a: '1', b: '1' } => { a_b: { a: '1', b: '1' } }.
+     */
+    composeCompoundUniqueField(model: string, fieldData: any): any;
+    /**
+     * Flattens a generated unique field. E.g.: { a_b: { a: '1', b: '1' } } => { a: '1', b: '1' }.
+     */
+    flattenGeneratedUniqueField(model: string, args: any): void;
+    validationError(message: string): Error;
+    unknownError(message: string): Error;
+    getModelFields(model: string): Record<string, FieldInfo> | undefined;
+    /**
+     * Gets information for a specific model field.
+     */
+    getModelField(model: string, field: string): FieldInfo | undefined;
+    /**
+     * Clones an object and makes sure it's not empty.
+     */
+    safeClone(value: unknown): any;
+}

package/enhancements/node/query-utils.js

@@ -0,0 +1,185 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryUtils = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const cross_1 = require("../../cross");
+const version_1 = require("../../version");
+const utils_1 = require("./utils");
+class QueryUtils {
+    constructor(prisma, options) {
+        this.prisma = prisma;
+        this.options = options;
+    }
+    getIdFields(model) {
+        return (0, cross_1.getIdFields)(this.options.modelMeta, model, true);
+    }
+    makeIdSelection(model) {
+        const idFields = this.getIdFields(model);
+        return Object.assign({}, ...idFields.map((f) => ({ [f.name]: true })));
+    }
+    getEntityIds(model, entityData) {
+        const idFields = this.getIdFields(model);
+        const result = {};
+        for (const idField of idFields) {
+            result[idField.name] = entityData[idField.name];
+        }
+        return result;
+    }
+    /**
+     * Initiates a transaction.
+     */
+    transaction(db, action) {
+        const fullDb = db;
+        if (fullDb['$transaction']) {
+            return fullDb.$transaction((tx) => {
+                tx[Symbol.for('nodejs.util.inspect.custom')] = 'PrismaClient$tx';
+                return action(tx);
+            }, {
+                maxWait: this.options.transactionMaxWait,
+                timeout: this.options.transactionTimeout,
+                isolationLevel: this.options.transactionIsolationLevel,
+            });
+        }
+        else {
+            // already in transaction, don't nest
+            return action(db);
+        }
+    }
+    /**
+     * Builds a reversed query for the given nested path.
+     */
+    buildReversedQuery(context, forMutationPayload = false, unsafeOperation = false) {
+        let result, currQuery;
+        let currField;
+        for (let i = context.nestingPath.length - 1; i >= 0; i--) {
+            const { field, model, where } = context.nestingPath[i];
+            // never modify the original where because it's shared in the structure
+            const visitWhere = Object.assign({}, where);
+            if (model && where) {
+                // make sure composite unique condition is flattened
+                this.flattenGeneratedUniqueField(model, visitWhere);
+            }
+            if (!result) {
+                // first segment (bottom), just use its where clause
+                result = currQuery = Object.assign({}, visitWhere);
+                currField = field;
+            }
+            else {
+                if (!currField) {
+                    throw this.unknownError(`missing field in nested path`);
+                }
+                if (!currField.backLink) {
+                    throw this.unknownError(`field ${currField.type}.${currField.name} doesn't have a backLink`);
+                }
+                const backLinkField = this.getModelField(currField.type, currField.backLink);
+                if (!backLinkField) {
+                    throw this.unknownError(`missing backLink field ${currField.backLink} in ${currField.type}`);
+                }
+                if (backLinkField.isArray && !forMutationPayload) {
+                    // many-side of relationship, wrap with "some" query
+                    currQuery[currField.backLink] = { some: Object.assign({}, visitWhere) };
+                    currQuery = currQuery[currField.backLink].some;
+                }
+                else {
+                    const fkMapping = where && backLinkField.isRelationOwner && backLinkField.foreignKeyMapping;
+                    // calculate if we should preserve the relation condition (e.g., { user: { id: 1 } })
+                    const shouldPreserveRelationCondition = 
+                    // doing a mutation
+                    forMutationPayload &&
+                        // and it's a safe mutate
+                        !unsafeOperation &&
+                        // and the current segment is the direct parent (the last one is the mutate itself),
+                        // the relation condition should be preserved and will be converted to a "connect" later
+                        i === context.nestingPath.length - 2;
+                    if (fkMapping && !shouldPreserveRelationCondition) {
+                        // turn relation condition into foreign key condition, e.g.:
+                        //     { user: { id: 1 } } => { userId: 1 }
+                        for (const [r, fk] of Object.entries(fkMapping)) {
+                            currQuery[fk] = visitWhere[r];
+                        }
+                        if (i > 0) {
+                            // prepare for the next segment
+                            currQuery[currField.backLink] = {};
+                        }
+                    }
+                    else {
+                        // preserve the original structure
+                        currQuery[currField.backLink] = Object.assign({}, visitWhere);
+                    }
+                    if (forMutationPayload && currQuery[currField.backLink]) {
+                        // reconstruct compound unique field
+                        currQuery[currField.backLink] = this.composeCompoundUniqueField(backLinkField.type, currQuery[currField.backLink]);
+                    }
+                    currQuery = currQuery[currField.backLink];
+                }
+                currField = field;
+            }
+        }
+        return result;
+    }
+    /**
+     * Composes a compound unique field from multiple fields. E.g.:  { a: '1', b: '1' } => { a_b: { a: '1', b: '1' } }.
+     */
+    composeCompoundUniqueField(model, fieldData) {
+        const uniqueConstraints = (0, cross_1.getUniqueConstraints)(this.options.modelMeta, model);
+        if (!uniqueConstraints) {
+            return fieldData;
+        }
+        const result = this.safeClone(fieldData);
+        for (const [name, constraint] of Object.entries(uniqueConstraints)) {
+            if (constraint.fields.length > 1 && constraint.fields.every((f) => fieldData[f] !== undefined)) {
+                // multi-field unique constraint, compose it
+                result[name] = constraint.fields.reduce((prev, field) => (Object.assign(Object.assign({}, prev), { [field]: fieldData[field] })), {});
+                constraint.fields.forEach((f) => delete result[f]);
+            }
+        }
+        return result;
+    }
+    /**
+     * Flattens a generated unique field. E.g.: { a_b: { a: '1', b: '1' } } => { a: '1', b: '1' }.
+     */
+    flattenGeneratedUniqueField(model, args) {
+        const uniqueConstraints = (0, cross_1.getUniqueConstraints)(this.options.modelMeta, model);
+        if (uniqueConstraints && Object.keys(uniqueConstraints).length > 0) {
+            for (const [field, value] of Object.entries(args)) {
+                if (uniqueConstraints[field] &&
+                    uniqueConstraints[field].fields.length > 1 &&
+                    typeof value === 'object') {
+                    // multi-field unique constraint, flatten it
+                    delete args[field];
+                    if (value) {
+                        for (const [f, v] of Object.entries(value)) {
+                            args[f] = v;
+                        }
+                    }
+                }
+            }
+        }
+    }
+    validationError(message) {
+        return (0, utils_1.prismaClientValidationError)(this.prisma, this.options.prismaModule, message);
+    }
+    unknownError(message) {
+        return (0, utils_1.prismaClientUnknownRequestError)(this.prisma, this.options.prismaModule, message, {
+            clientVersion: (0, version_1.getVersion)(),
+        });
+    }
+    getModelFields(model) {
+        var _a;
+        return (_a = (0, cross_1.getModelInfo)(this.options.modelMeta, model)) === null || _a === void 0 ? void 0 : _a.fields;
+    }
+    /**
+     * Gets information for a specific model field.
+     */
+    getModelField(model, field) {
+        return (0, cross_1.resolveField)(this.options.modelMeta, model, field);
+    }
+    /**
+     * Clones an object and makes sure it's not empty.
+     */
+    safeClone(value) {
+        return value ? (0, cross_1.clone)(value) : value === undefined || value === null ? {} : value;
+    }
+}
+exports.QueryUtils = QueryUtils;
+//# sourceMappingURL=query-utils.js.map

package/enhancements/node/query-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-utils.js","sourceRoot":"","sources":["../../../src/enhancements/node/query-utils.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,uCAQqB;AAErB,2CAA2C;AAE3C,mCAAuF;AAEvF,MAAa,UAAU;IACnB,YAA6B,MAAwB,EAAqB,OAAmC;QAAhF,WAAM,GAAN,MAAM,CAAkB;QAAqB,YAAO,GAAP,OAAO,CAA4B;IAAG,CAAC;IAEjH,WAAW,CAAC,KAAa;QACrB,OAAO,IAAA,mBAAW,EAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED,eAAe,CAAC,KAAa;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzC,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED,YAAY,CAAC,KAAa,EAAE,UAAe;QACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC7B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,WAAW,CAAI,EAAgB,EAAE,MAAwC;QACrE,MAAM,MAAM,GAAG,EAAsB,CAAC;QACtC,IAAI,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC;YACzB,OAAO,MAAM,CAAC,YAAY,CACtB,CAAC,EAAE,EAAE,EAAE;gBACF,EAAU,CAAC,MAAM,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC,GAAG,iBAAiB,CAAC;gBAC1E,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC;YACtB,CAAC,EACD;gBACI,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,kBAAkB;gBACxC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,kBAAkB;gBACxC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,yBAAyB;aACzD,CACJ,CAAC;QACN,CAAC;aAAM,CAAC;YACJ,qCAAqC;YACrC,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC;QACtB,CAAC;IACL,CAAC;IAED;;OAEG;IACH,kBAAkB,CAAC,OAAkC,EAAE,kBAAkB,GAAG,KAAK,EAAE,eAAe,GAAG,KAAK;QACtG,IAAI,MAAM,EAAE,SAAc,CAAC;QAC3B,IAAI,SAAgC,CAAC;QAErC,KAAK,IAAI,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACvD,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAEvD,uEAAuE;YACvE,MAAM,UAAU,qBAAQ,KAAK,CAAE,CAAC;YAChC,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;gBACjB,oDAAoD;gBACpD,IAAI,CAAC,2BAA2B,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;YACxD,CAAC;YAED,IAAI,CAAC,MAAM,EAAE,CAAC;gBACV,oDAAoD;gBACpD,MAAM,GAAG,SAAS,qBAAQ,UAAU,CAAE,CAAC;gBACvC,SAAS,GAAG,KAAK,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,SAAS,EAAE,CAAC;oBACb,MAAM,IAAI,CAAC,YAAY,CAAC,8BAA8B,CAAC,CAAC;gBAC5D,CAAC;gBACD,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;oBACtB,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC,IAAI,0BAA0B,CAAC,CAAC;gBACjG,CAAC;gBAED,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;gBAC7E,IAAI,CAAC,aAAa,EAAE,CAAC;oBACjB,MAAM,IAAI,CAAC,YAAY,CAAC,0BAA0B,SAAS,CAAC,QAAQ,OAAO,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;gBACjG,CAAC;gBAED,IAAI,aAAa,CAAC,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC/C,oDAAoD;oBACpD,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,oBAAO,UAAU,CAAE,EAAE,CAAC;oBAC5D,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;gBACnD,CAAC;qBAAM,CAAC;oBACJ,MAAM,SAAS,GAAG,KAAK,IAAI,aAAa,CAAC,eAAe,IAAI,aAAa,CAAC,iBAAiB,CAAC;oBAE5F,qFAAqF;oBACrF,MAAM,+BAA+B;oBACjC,mBAAmB;oBACnB,kBAAkB;wBAClB,yBAAyB;wBACzB,CAAC,eAAe;wBAChB,oFAAoF;wBACpF,wFAAwF;wBACxF,CAAC,KAAK,OAAO,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;oBAEzC,IAAI,SAAS,IAAI,CAAC,+BAA+B,EAAE,CAAC;wBAChD,4DAA4D;wBAC5D,2CAA2C;wBAC3C,KAAK,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAS,SAAS,CAAC,EAAE,CAAC;4BACtD,SAAS,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;wBAClC,CAAC;wBAED,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;4BACR,+BAA+B;4BAC/B,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;wBACvC,CAAC;oBACL,CAAC;yBAAM,CAAC;wBACJ,kCAAkC;wBAClC,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,qBAAQ,UAAU,CAAE,CAAC;oBACtD,CAAC;oBAED,IAAI,kBAAkB,IAAI,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACtD,oCAAoC;wBACpC,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,0BAA0B,CAC3D,aAAa,CAAC,IAAI,EAClB,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,CAChC,CAAC;oBACN,CAAC;oBAED,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBAC9C,CAAC;gBACD,SAAS,GAAG,KAAK,CAAC;YACtB,CAAC;QACL,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,0BAA0B,CAAC,KAAa,EAAE,SAAc;QACpD,MAAM,iBAAiB,GAAG,IAAA,4BAAoB,EAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC9E,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACrB,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,MAAM,MAAM,GAAQ,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC9C,KAAK,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACjE,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,EAAE,CAAC;gBAC7F,4CAA4C;gBAC5C,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,CACnC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,iCAAM,IAAI,KAAE,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,IAAG,EACzD,EAAE,CACL,CAAC;gBACF,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YACvD,CAAC;QACL,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,2BAA2B,CAAC,KAAa,EAAE,IAAS;QAChD,MAAM,iBAAiB,GAAG,IAAA,4BAAoB,EAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC9E,IAAI,iBAAiB,IAAI,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjE,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAM,IAAI,CAAC,EAAE,CAAC;gBACrD,IACI,iBAAiB,CAAC,KAAK,CAAC;oBACxB,iBAAiB,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;oBAC1C,OAAO,KAAK,KAAK,QAAQ,EAC3B,CAAC;oBACC,4CAA4C;oBAC5C,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;oBACnB,IAAI,KAAK,EAAE,CAAC;wBACR,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;4BACzC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;wBAChB,CAAC;oBACL,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,eAAe,CAAC,OAAe;QAC3B,OAAO,IAAA,mCAA2B,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED,YAAY,CAAC,OAAe;QACxB,OAAO,IAAA,uCAA+B,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,EAAE;YACpF,aAAa,EAAE,IAAA,oBAAU,GAAE;SAC9B,CAAC,CAAC;IACP,CAAC;IAED,cAAc,CAAC,KAAa;;QACxB,OAAO,MAAA,IAAA,oBAAY,EAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,0CAAE,MAAM,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,KAAa,EAAE,KAAa;QACtC,OAAO,IAAA,oBAAY,EAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,KAAc;QACpB,OAAO,KAAK,CAAC,CAAC,CAAC,IAAA,aAAK,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IACrF,CAAC;CACJ;AAzMD,gCAyMC"}

package/enhancements/node/types.d.ts

@@ -0,0 +1,224 @@
+import type { CrudContract, PermissionCheckerContext, PolicyCrudKind, QueryContext } from '../../types';
+/**
+ * Common options for PrismaClient enhancements
+ */
+export interface CommonEnhancementOptions {
+    /**
+     * Path for loading CLI-generated code
+     */
+    loadPath?: string;
+    /**
+     * The `Prisma` module generated together with `PrismaClient`. You only need to
+     * pass it when you specified a custom `PrismaClient` output path. The module can
+     * be loaded like: `import { Prisma } from '<your PrismaClient output path>';`.
+     */
+    prismaModule?: any;
+}
+/**
+ * Function for getting policy guard with a given context
+ */
+export type PolicyFunc = (context: QueryContext, db: CrudContract) => object;
+/**
+ * Function for checking an entity's data for permission
+ */
+export type EntityCheckerFunc = (input: any, context: QueryContext) => boolean;
+/**
+ * Function for checking if an operation is possibly allowed.
+ */
+export type PermissionCheckerFunc = (context: PermissionCheckerContext) => PermissionCheckerConstraint;
+/**
+ * Supported checker constraint checking value types.
+ */
+export type ConstraintValueTypes = 'boolean' | 'number' | 'string';
+/**
+ * Free variable constraint
+ */
+export type VariableConstraint = {
+    kind: 'variable';
+    name: string;
+    type: ConstraintValueTypes;
+};
+/**
+ * Constant value constraint
+ */
+export type ValueConstraint = {
+    kind: 'value';
+    value: number | boolean | string;
+    type: ConstraintValueTypes;
+};
+/**
+ * Terms for comparison constraints
+ */
+export type ComparisonTerm = VariableConstraint | ValueConstraint;
+/**
+ * Comparison constraint
+ */
+export type ComparisonConstraint = {
+    kind: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte';
+    left: ComparisonTerm;
+    right: ComparisonTerm;
+};
+/**
+ * Logical constraint
+ */
+export type LogicalConstraint = {
+    kind: 'and' | 'or' | 'not';
+    children: PermissionCheckerConstraint[];
+};
+/**
+ * Operation allowability checking constraint
+ */
+export type PermissionCheckerConstraint = ValueConstraint | VariableConstraint | ComparisonConstraint | LogicalConstraint;
+/**
+ * Policy definition
+ */
+export type PolicyDef = {
+    policy: Record<ModelName, ModelPolicyDef>;
+    validation: Record<string, {
+        hasValidation: boolean;
+    }>;
+    authSelector?: object;
+};
+type ModelName = string;
+type FieldName = string;
+/**
+ * Policy definition for a model
+ */
+export type ModelPolicyDef = {
+    /**
+     * Model-level CRUD policies
+     */
+    modelLevel: ModelCrudDef;
+    /**
+     * Field-level CRUD policies
+     */
+    fieldLevel?: FieldCrudDef;
+};
+/**
+ * CRUD policy definitions for a model
+ */
+export type ModelCrudDef = {
+    read: ModelReadDef;
+    create: ModelCreateDef;
+    update: ModelUpdateDef;
+    delete: ModelDeleteDef;
+    postUpdate: ModelPostUpdateDef;
+};
+/**
+ * Information for checking entity data outside of Prisma
+ */
+export type EntityChecker = {
+    /**
+     * Checker function
+     */
+    func: EntityCheckerFunc;
+    /**
+     * Selector for fetching entity data
+     */
+    selector?: object;
+};
+/**
+ * Common policy definition for a CRUD operation
+ */
+type ModelCrudCommon = {
+    /**
+     * Prisma query guard or a constant condition
+     */
+    guard: PolicyFunc | boolean;
+    /**
+     * Additional checker function for checking policies outside of Prisma
+     */
+    /**
+     * Additional checker function for checking policies outside of Prisma
+     */
+    entityChecker?: EntityChecker;
+    /**
+     * Permission checker function or a constant condition
+     */
+    permissionChecker?: PermissionCheckerFunc | boolean;
+};
+/**
+ * Policy definition for reading a model
+ */
+type ModelReadDef = ModelCrudCommon;
+/**
+ * Policy definition for creating a model
+ */
+type ModelCreateDef = ModelCrudCommon & {
+    /**
+     * Create input validation function. Only generated when a create
+     * can be approved or denied based on input values.
+     */
+    inputChecker?: EntityCheckerFunc | boolean;
+};
+/**
+ * Policy definition for updating a model
+ */
+type ModelUpdateDef = ModelCrudCommon;
+/**
+ * Policy definition for deleting a model
+ */
+type ModelDeleteDef = ModelCrudCommon;
+/**
+ * Policy definition for post-update checking a model
+ */
+type ModelPostUpdateDef = Exclude<ModelCrudCommon, 'permissionChecker'> & {
+    preUpdateSelector?: object;
+};
+/**
+ * CRUD policy definitions for a field
+ */
+type FieldCrudDef = {
+    /**
+     * Field-level read policy
+     */
+    read: Record<FieldName, FieldReadDef>;
+    /**
+     * Field-level update policy
+     */
+    update: Record<FieldName, FieldUpdateDef>;
+};
+type FieldReadDef = {
+    /**
+     * Field-level Prisma query guard
+     */
+    guard?: PolicyFunc;
+    /**
+     * Entity checker
+     */
+    entityChecker?: EntityChecker;
+    /**
+     * Field-level read override Prisma query guard
+     */
+    overrideGuard?: PolicyFunc;
+    /**
+     * Entity checker for override policies
+     */
+    overrideEntityChecker?: EntityChecker;
+};
+type FieldUpdateDef = {
+    /**
+     * Field-level update Prisma query guard
+     */
+    guard?: PolicyFunc;
+    /**
+     * Additional entity checker
+     */
+    entityChecker?: EntityChecker;
+    /**
+     * Field-level update override Prisma query guard
+     */
+    overrideGuard?: PolicyFunc;
+    /**
+     * Additional entity checker for override policies
+     */
+    overrideEntityChecker?: EntityChecker;
+};
+/**
+ * Permission check API (`check()`) arguments
+ */
+export type PermissionCheckArgs = {
+    operation: PolicyCrudKind;
+    where?: Record<string, number | string | boolean>;
+};
+export {};

package/enhancements/node/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/enhancements/node/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/enhancements/node/types.ts"],"names":[],"mappings":""}

package/enhancements/node/utils.d.ts

@@ -0,0 +1,11 @@
+import { type FieldInfo, type ModelMeta } from '../../cross';
+import type { DbClientContract } from '../../types';
+/**
+ * Formats an object for pretty printing.
+ */
+export declare function formatObject(value: any, multiLine?: boolean): string;
+export declare function prismaClientValidationError(prisma: DbClientContract, prismaModule: any, message: string): Error;
+export declare function prismaClientKnownRequestError(prisma: DbClientContract, prismaModule: any, ...args: unknown[]): Error;
+export declare function prismaClientUnknownRequestError(prismaModule: any, ...args: unknown[]): Error;
+export declare function isUnsafeMutate(model: string, args: any, modelMeta: ModelMeta): boolean;
+export declare function isAutoIncrementIdField(field: FieldInfo): boolean | undefined;

package/enhancements/node/utils.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatObject = formatObject;
+exports.prismaClientValidationError = prismaClientValidationError;
+exports.prismaClientKnownRequestError = prismaClientKnownRequestError;
+exports.prismaClientUnknownRequestError = prismaClientUnknownRequestError;
+exports.isUnsafeMutate = isUnsafeMutate;
+exports.isAutoIncrementIdField = isAutoIncrementIdField;
+const safe_json_stringify_1 = __importDefault(require("safe-json-stringify"));
+const cross_1 = require("../../cross");
+/**
+ * Formats an object for pretty printing.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function formatObject(value, multiLine = true) {
+    return multiLine ? (0, safe_json_stringify_1.default)(value, undefined, 2) : (0, safe_json_stringify_1.default)(value);
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function prismaClientValidationError(prisma, prismaModule, message) {
+    throw new prismaModule.PrismaClientValidationError(message, { clientVersion: prisma._clientVersion });
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function prismaClientKnownRequestError(prisma, prismaModule, ...args) {
+    return new prismaModule.PrismaClientKnownRequestError(...args);
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function prismaClientUnknownRequestError(prismaModule, ...args) {
+    throw new prismaModule.PrismaClientUnknownRequestError(...args);
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function isUnsafeMutate(model, args, modelMeta) {
+    if (!args) {
+        return false;
+    }
+    for (const k of Object.keys(args)) {
+        const field = (0, cross_1.resolveField)(modelMeta, model, k);
+        if (field && (isAutoIncrementIdField(field) || field.isForeignKey)) {
+            return true;
+        }
+    }
+    return false;
+}
+function isAutoIncrementIdField(field) {
+    return field.isId && field.isAutoIncrement;
+}
+//# sourceMappingURL=utils.js.map

package/enhancements/node/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/enhancements/node/utils.ts"],"names":[],"mappings":";;;;;AAQA,oCAEC;AAGD,kEAEC;AAGD,sEAEC;AAGD,0EAEC;AAGD,wCAWC;AAED,wDAEC;AA3CD,8EAAoD;AACpD,uCAA2E;AAG3E;;GAEG;AACH,8DAA8D;AAC9D,SAAgB,YAAY,CAAC,KAAU,EAAE,SAAS,GAAG,IAAI;IACrD,OAAO,SAAS,CAAC,CAAC,CAAC,IAAA,6BAAiB,EAAC,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,6BAAiB,EAAC,KAAK,CAAC,CAAC;AACzF,CAAC;AAED,8DAA8D;AAC9D,SAAgB,2BAA2B,CAAC,MAAwB,EAAE,YAAiB,EAAE,OAAe;IACpG,MAAM,IAAI,YAAY,CAAC,2BAA2B,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC;AAC1G,CAAC;AAED,8DAA8D;AAC9D,SAAgB,6BAA6B,CAAC,MAAwB,EAAE,YAAiB,EAAE,GAAG,IAAe;IACzG,OAAO,IAAI,YAAY,CAAC,6BAA6B,CAAC,GAAG,IAAI,CAAC,CAAC;AACnE,CAAC;AAED,8DAA8D;AAC9D,SAAgB,+BAA+B,CAAC,YAAiB,EAAE,GAAG,IAAe;IACjF,MAAM,IAAI,YAAY,CAAC,+BAA+B,CAAC,GAAG,IAAI,CAAC,CAAC;AACpE,CAAC;AAED,8DAA8D;AAC9D,SAAgB,cAAc,CAAC,KAAa,EAAE,IAAS,EAAE,SAAoB;IACzE,IAAI,CAAC,IAAI,EAAE,CAAC;QACR,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAChC,MAAM,KAAK,GAAG,IAAA,oBAAY,EAAC,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAChD,IAAI,KAAK,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;YACjE,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,SAAgB,sBAAsB,CAAC,KAAgB;IACnD,OAAO,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,eAAe,CAAC;AAC/C,CAAC"}

package/enhancements/node/where-visitor.d.ts

@@ -0,0 +1,32 @@
+import { type FieldInfo, type ModelMeta } from '../../cross';
+/**
+ * Context for visiting
+ */
+export type WhereVisitorContext = {
+    /**
+     * Parent data, can be used to replace fields
+     */
+    parent: any;
+    /**
+     * Current field, undefined if toplevel
+     */
+    field?: FieldInfo;
+};
+/**
+ * WhereVisitor's callback actions
+ */
+export type WhereVisitorCallback = {
+    field?: (field: FieldInfo, data: any) => Promise<unknown>;
+};
+/**
+ * Recursive visitor for where payload
+ */
+export declare class WhereVisitor {
+    private readonly modelMeta;
+    private readonly callback;
+    constructor(modelMeta: ModelMeta, callback: WhereVisitorCallback);
+    /**
+     * Start visiting
+     */
+    visit(model: string, where: any): Promise<void>;
+}

package/enhancements/node/where-visitor.js

@@ -0,0 +1,86 @@
+"use strict";
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WhereVisitor = void 0;
+const cross_1 = require("../../cross");
+const FILTER_OPERATORS = [
+    'equals',
+    'not',
+    'in',
+    'notIn',
+    'lt',
+    'lte',
+    'gt',
+    'gte',
+    'contains',
+    'search',
+    'startsWith',
+    'endsWith',
+];
+const RELATION_FILTER_OPERATORS = ['is', 'isNot', 'some', 'every', 'none'];
+/**
+ * Recursive visitor for where payload
+ */
+class WhereVisitor {
+    constructor(modelMeta, callback) {
+        this.modelMeta = modelMeta;
+        this.callback = callback;
+    }
+    /**
+     * Start visiting
+     */
+    visit(model, where) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            if (!where) {
+                return;
+            }
+            for (const [k, v] of Object.entries(where)) {
+                if (['AND', 'OR', 'NOT'].includes(k)) {
+                    for (const item of (0, cross_1.enumerate)(v)) {
+                        yield this.visit(model, item);
+                    }
+                    continue;
+                }
+                if (RELATION_FILTER_OPERATORS.includes(k)) {
+                    // visit into filter body
+                    yield this.visit(model, v);
+                    continue;
+                }
+                const field = (0, cross_1.resolveField)(this.modelMeta, model, k);
+                if (!field) {
+                    continue;
+                }
+                if (typeof v === 'object') {
+                    const filterOp = Object.keys(v).find((f) => FILTER_OPERATORS.includes(f));
+                    if (filterOp) {
+                        // reach into filter value
+                        const newValue = yield ((_b = (_a = this.callback).field) === null || _b === void 0 ? void 0 : _b.call(_a, field, v[filterOp]));
+                        v[filterOp] = newValue;
+                        continue;
+                    }
+                    if (Object.keys(v).some((f) => RELATION_FILTER_OPERATORS.includes(f))) {
+                        // filter payload
+                        yield this.visit(field.type, v);
+                        continue;
+                    }
+                }
+                // scalar field
+                const newValue = yield ((_d = (_c = this.callback).field) === null || _d === void 0 ? void 0 : _d.call(_c, field, v));
+                where[k] = newValue;
+            }
+        });
+    }
+}
+exports.WhereVisitor = WhereVisitor;
+//# sourceMappingURL=where-visitor.js.map

package/enhancements/node/where-visitor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"where-visitor.js","sourceRoot":"","sources":["../../../src/enhancements/node/where-visitor.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,uDAAuD;;;;;;;;;;;;AAEvD,uCAAsF;AAwBtF,MAAM,gBAAgB,GAAG;IACrB,QAAQ;IACR,KAAK;IACL,IAAI;IACJ,OAAO;IACP,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,UAAU;IACV,QAAQ;IACR,YAAY;IACZ,UAAU;CACb,CAAC;AAEF,MAAM,yBAAyB,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAa,YAAY;IACrB,YAA6B,SAAoB,EAAmB,QAA8B;QAArE,cAAS,GAAT,SAAS,CAAW;QAAmB,aAAQ,GAAR,QAAQ,CAAsB;IAAG,CAAC;IAEtG;;OAEG;IACG,KAAK,CAAC,KAAa,EAAE,KAAU;;;YACjC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACT,OAAO;YACX,CAAC;YAED,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAM,KAAK,CAAC,EAAE,CAAC;gBAC9C,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;oBACnC,KAAK,MAAM,IAAI,IAAI,IAAA,iBAAS,EAAC,CAAC,CAAC,EAAE,CAAC;wBAC9B,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAClC,CAAC;oBACD,SAAS;gBACb,CAAC;gBAED,IAAI,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;oBACxC,yBAAyB;oBACzB,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;oBAC3B,SAAS;gBACb,CAAC;gBAED,MAAM,KAAK,GAAG,IAAA,oBAAY,EAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;gBACrD,IAAI,CAAC,KAAK,EAAE,CAAC;oBACT,SAAS;gBACb,CAAC;gBAED,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;oBACxB,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC1E,IAAI,QAAQ,EAAE,CAAC;wBACX,0BAA0B;wBAC1B,MAAM,QAAQ,GAAG,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,EAAC,KAAK,mDAAG,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA,CAAC;wBACjE,CAAC,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;wBACvB,SAAS;oBACb,CAAC;oBAED,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;wBACpE,iBAAiB;wBACjB,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;wBAChC,SAAS;oBACb,CAAC;gBACL,CAAC;gBAED,eAAe;gBACf,MAAM,QAAQ,GAAG,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,EAAC,KAAK,mDAAG,KAAK,EAAE,CAAC,CAAC,CAAA,CAAC;gBACvD,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC;YACxB,CAAC;QACL,CAAC;KAAA;CACJ;AAnDD,oCAmDC"}

package/index.d.ts

@@ -1,7 +1,7 @@
 export * from './constants';
-export * from './enhancements';
+export * from './cross';
+export * from './enhance';
 export * from './error';
 export * from './types';
 export * from './validation';
 export * from './version';
-export * from './enhance';