@zenstackhq/runtime 1.0.0-beta.9 → 1.0.0

package/browser/index.js

@@ -36,6 +36,7 @@ __export(browser_exports, {
 module.exports = __toCommonJS(browser_exports);
 
 // src/browser/serialization.ts
+var import_buffer = require("buffer");
 var import_decimal = __toESM(require("decimal.js"));
 var import_superjson = __toESM(require("superjson"));
 import_superjson.default.registerCustom(
@@ -48,9 +49,9 @@ import_superjson.default.registerCustom(
 );
 import_superjson.default.registerCustom(
   {
-    isApplicable: (v) => Buffer.isBuffer(v),
+    isApplicable: (v) => import_buffer.Buffer.isBuffer(v),
     serialize: (v) => v.toString("base64"),
-    deserialize: (v) => Buffer.from(v, "base64")
+    deserialize: (v) => import_buffer.Buffer.from(v, "base64")
   },
   "Bytes"
 );

package/browser/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/browser/index.ts","../../src/browser/serialization.ts"],"sourcesContent":["export * from './serialization';\n","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport Decimal from 'decimal.js';\nimport SuperJSON from 'superjson';\n\nSuperJSON.registerCustom<Decimal, string>(\n    {\n        isApplicable: (v): v is Decimal => Decimal.isDecimal(v),\n        serialize: (v) => v.toJSON(),\n        deserialize: (v) => new Decimal(v),\n    },\n    'Decimal'\n);\n\nSuperJSON.registerCustom<Buffer, string>(\n    {\n        isApplicable: (v): v is Buffer => Buffer.isBuffer(v),\n        serialize: (v) => v.toString('base64'),\n        deserialize: (v) => Buffer.from(v, 'base64'),\n    },\n    'Bytes'\n);\n\n/**\n * Serialize the given value with superjson\n */\nexport function serialize(value: unknown): { data: unknown; meta: unknown } {\n    const { json, meta } = SuperJSON.serialize(value);\n    return { data: json, meta };\n}\n\n/**\n * Deserialize the given value with superjson using the given metadata\n */\nexport function deserialize(value: unknown, meta: any): unknown {\n    return SuperJSON.deserialize({ json: value as any, meta });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACCA,qBAAoB;AACpB,uBAAsB;AAEtB,iBAAAA,QAAU;AAAA,EACN;AAAA,IACI,cAAc,CAAC,MAAoB,eAAAC,QAAQ,UAAU,CAAC;AAAA,IACtD,WAAW,CAAC,MAAM,EAAE,OAAO;AAAA,IAC3B,aAAa,CAAC,MAAM,IAAI,eAAAA,QAAQ,CAAC;AAAA,EACrC;AAAA,EACA;AACJ;AAEA,iBAAAD,QAAU;AAAA,EACN;AAAA,IACI,cAAc,CAAC,MAAmB,OAAO,SAAS,CAAC;AAAA,IACnD,WAAW,CAAC,MAAM,EAAE,SAAS,QAAQ;AAAA,IACrC,aAAa,CAAC,MAAM,OAAO,KAAK,GAAG,QAAQ;AAAA,EAC/C;AAAA,EACA;AACJ;AAKO,SAAS,UAAU,OAAkD;AACxE,QAAM,EAAE,MAAM,KAAK,IAAI,iBAAAA,QAAU,UAAU,KAAK;AAChD,SAAO,EAAE,MAAM,MAAM,KAAK;AAC9B;AAKO,SAAS,YAAY,OAAgB,MAAoB;AAC5D,SAAO,iBAAAA,QAAU,YAAY,EAAE,MAAM,OAAc,KAAK,CAAC;AAC7D;","names":["SuperJSON","Decimal"]}
+{"version":3,"sources":["../../src/browser/index.ts","../../src/browser/serialization.ts"],"sourcesContent":["export * from './serialization';\n","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { Buffer } from 'buffer';\nimport Decimal from 'decimal.js';\nimport SuperJSON from 'superjson';\n\nSuperJSON.registerCustom<Decimal, string>(\n    {\n        isApplicable: (v): v is Decimal => Decimal.isDecimal(v),\n        serialize: (v) => v.toJSON(),\n        deserialize: (v) => new Decimal(v),\n    },\n    'Decimal'\n);\n\nSuperJSON.registerCustom<Buffer, string>(\n    {\n        isApplicable: (v): v is Buffer => Buffer.isBuffer(v),\n        serialize: (v) => v.toString('base64'),\n        deserialize: (v) => Buffer.from(v, 'base64'),\n    },\n    'Bytes'\n);\n\n/**\n * Serialize the given value with superjson\n */\nexport function serialize(value: unknown): { data: unknown; meta: unknown } {\n    const { json, meta } = SuperJSON.serialize(value);\n    return { data: json, meta };\n}\n\n/**\n * Deserialize the given value with superjson using the given metadata\n */\nexport function deserialize(value: unknown, meta: any): unknown {\n    return SuperJSON.deserialize({ json: value as any, meta });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACCA,oBAAuB;AACvB,qBAAoB;AACpB,uBAAsB;AAEtB,iBAAAA,QAAU;AAAA,EACN;AAAA,IACI,cAAc,CAAC,MAAoB,eAAAC,QAAQ,UAAU,CAAC;AAAA,IACtD,WAAW,CAAC,MAAM,EAAE,OAAO;AAAA,IAC3B,aAAa,CAAC,MAAM,IAAI,eAAAA,QAAQ,CAAC;AAAA,EACrC;AAAA,EACA;AACJ;AAEA,iBAAAD,QAAU;AAAA,EACN;AAAA,IACI,cAAc,CAAC,MAAmB,qBAAO,SAAS,CAAC;AAAA,IACnD,WAAW,CAAC,MAAM,EAAE,SAAS,QAAQ;AAAA,IACrC,aAAa,CAAC,MAAM,qBAAO,KAAK,GAAG,QAAQ;AAAA,EAC/C;AAAA,EACA;AACJ;AAKO,SAAS,UAAU,OAAkD;AACxE,QAAM,EAAE,MAAM,KAAK,IAAI,iBAAAA,QAAU,UAAU,KAAK;AAChD,SAAO,EAAE,MAAM,MAAM,KAAK;AAC9B;AAKO,SAAS,YAAY,OAAgB,MAAoB;AAC5D,SAAO,iBAAAA,QAAU,YAAY,EAAE,MAAM,OAAc,KAAK,CAAC;AAC7D;","names":["SuperJSON","Decimal"]}

package/browser/index.mjs

@@ -1,4 +1,5 @@
 // src/browser/serialization.ts
+import { Buffer } from "buffer";
 import Decimal from "decimal.js";
 import SuperJSON from "superjson";
 SuperJSON.registerCustom(

package/browser/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/browser/serialization.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport Decimal from 'decimal.js';\nimport SuperJSON from 'superjson';\n\nSuperJSON.registerCustom<Decimal, string>(\n    {\n        isApplicable: (v): v is Decimal => Decimal.isDecimal(v),\n        serialize: (v) => v.toJSON(),\n        deserialize: (v) => new Decimal(v),\n    },\n    'Decimal'\n);\n\nSuperJSON.registerCustom<Buffer, string>(\n    {\n        isApplicable: (v): v is Buffer => Buffer.isBuffer(v),\n        serialize: (v) => v.toString('base64'),\n        deserialize: (v) => Buffer.from(v, 'base64'),\n    },\n    'Bytes'\n);\n\n/**\n * Serialize the given value with superjson\n */\nexport function serialize(value: unknown): { data: unknown; meta: unknown } {\n    const { json, meta } = SuperJSON.serialize(value);\n    return { data: json, meta };\n}\n\n/**\n * Deserialize the given value with superjson using the given metadata\n */\nexport function deserialize(value: unknown, meta: any): unknown {\n    return SuperJSON.deserialize({ json: value as any, meta });\n}\n"],"mappings":";AACA,OAAO,aAAa;AACpB,OAAO,eAAe;AAEtB,UAAU;AAAA,EACN;AAAA,IACI,cAAc,CAAC,MAAoB,QAAQ,UAAU,CAAC;AAAA,IACtD,WAAW,CAAC,MAAM,EAAE,OAAO;AAAA,IAC3B,aAAa,CAAC,MAAM,IAAI,QAAQ,CAAC;AAAA,EACrC;AAAA,EACA;AACJ;AAEA,UAAU;AAAA,EACN;AAAA,IACI,cAAc,CAAC,MAAmB,OAAO,SAAS,CAAC;AAAA,IACnD,WAAW,CAAC,MAAM,EAAE,SAAS,QAAQ;AAAA,IACrC,aAAa,CAAC,MAAM,OAAO,KAAK,GAAG,QAAQ;AAAA,EAC/C;AAAA,EACA;AACJ;AAKO,SAAS,UAAU,OAAkD;AACxE,QAAM,EAAE,MAAM,KAAK,IAAI,UAAU,UAAU,KAAK;AAChD,SAAO,EAAE,MAAM,MAAM,KAAK;AAC9B;AAKO,SAAS,YAAY,OAAgB,MAAoB;AAC5D,SAAO,UAAU,YAAY,EAAE,MAAM,OAAc,KAAK,CAAC;AAC7D;","names":[]}
+{"version":3,"sources":["../../src/browser/serialization.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { Buffer } from 'buffer';\nimport Decimal from 'decimal.js';\nimport SuperJSON from 'superjson';\n\nSuperJSON.registerCustom<Decimal, string>(\n    {\n        isApplicable: (v): v is Decimal => Decimal.isDecimal(v),\n        serialize: (v) => v.toJSON(),\n        deserialize: (v) => new Decimal(v),\n    },\n    'Decimal'\n);\n\nSuperJSON.registerCustom<Buffer, string>(\n    {\n        isApplicable: (v): v is Buffer => Buffer.isBuffer(v),\n        serialize: (v) => v.toString('base64'),\n        deserialize: (v) => Buffer.from(v, 'base64'),\n    },\n    'Bytes'\n);\n\n/**\n * Serialize the given value with superjson\n */\nexport function serialize(value: unknown): { data: unknown; meta: unknown } {\n    const { json, meta } = SuperJSON.serialize(value);\n    return { data: json, meta };\n}\n\n/**\n * Deserialize the given value with superjson using the given metadata\n */\nexport function deserialize(value: unknown, meta: any): unknown {\n    return SuperJSON.deserialize({ json: value as any, meta });\n}\n"],"mappings":";AACA,SAAS,cAAc;AACvB,OAAO,aAAa;AACpB,OAAO,eAAe;AAEtB,UAAU;AAAA,EACN;AAAA,IACI,cAAc,CAAC,MAAoB,QAAQ,UAAU,CAAC;AAAA,IACtD,WAAW,CAAC,MAAM,EAAE,OAAO;AAAA,IAC3B,aAAa,CAAC,MAAM,IAAI,QAAQ,CAAC;AAAA,EACrC;AAAA,EACA;AACJ;AAEA,UAAU;AAAA,EACN;AAAA,IACI,cAAc,CAAC,MAAmB,OAAO,SAAS,CAAC;AAAA,IACnD,WAAW,CAAC,MAAM,EAAE,SAAS,QAAQ;AAAA,IACrC,aAAa,CAAC,MAAM,OAAO,KAAK,GAAG,QAAQ;AAAA,EAC/C;AAAA,EACA;AACJ;AAKO,SAAS,UAAU,OAAkD;AACxE,QAAM,EAAE,MAAM,KAAK,IAAI,UAAU,UAAU,KAAK;AAChD,SAAO,EAAE,MAAM,MAAM,KAAK;AAC9B;AAKO,SAAS,YAAY,OAAgB,MAAoB;AAC5D,SAAO,UAAU,YAAY,EAAE,MAAM,OAAc,KAAK,CAAC;AAC7D;","names":[]}

package/constants.d.ts

@@ -1,25 +1,21 @@
 /**
- * Default length of password hash salt (used by bcryptjs to hash password)
+ * Default path for loading CLI-generated code
  */
-export declare const DEFAULT_PASSWORD_SALT_LENGTH = 12;
+export declare const DEFAULT_RUNTIME_LOAD_PATH = ".zenstack";
 /**
- * Auxiliary database field for supporting policy check for nested writes
- */
-export declare const TRANSACTION_FIELD_NAME = "zenstack_transaction";
-/**
- * Auxiliary database field for building up policy check queries
- */
-export declare const GUARD_FIELD_NAME = "zenstack_guard";
-/**
- * All Auxiliary fields.
+ * Default length of password hash salt (used by bcryptjs to hash password)
  */
-export declare const AUXILIARY_FIELDS: string[];
+export declare const DEFAULT_PASSWORD_SALT_LENGTH = 12;
 /**
  * Reasons for a CRUD operation to fail
  */
 export declare enum CrudFailureReason {
     /**
-     * CRUD suceeded but the result was not readable.
+     * CRUD failed because of access policy violation.
+     */
+    ACCESS_POLICY_VIOLATION = "ACCESS_POLICY_VIOLATION",
+    /**
+     * CRUD succeeded but the result was not readable.
      */
     RESULT_NOT_READABLE = "RESULT_NOT_READABLE",
     /**
@@ -31,5 +27,52 @@ export declare enum CrudFailureReason {
  * Prisma error codes used
  */
 export declare enum PrismaErrorCode {
-    CONSTRAINED_FAILED = "P2004"
+    /**
+     * Unique constraint failed
+     */
+    UNIQUE_CONSTRAINT_FAILED = "P2002",
+    /**
+     * A constraint failed on the database
+     */
+    CONSTRAINED_FAILED = "P2004",
+    /**
+     * The required connected records were not found
+     */
+    REQUIRED_CONNECTED_RECORD_NOT_FOUND = "P2018",
+    /**
+     * An operation failed because it depends on one or more records that were required but not found
+     */
+    DEPEND_ON_RECORD_NOT_FOUND = "P2025"
 }
+/**
+ * Field name for storing in-transaction flag
+ */
+export declare const PRISMA_TX_FLAG = "$__zenstack_tx";
+/**
+ * Field name for getting current enhancer
+ */
+export declare const PRISMA_PROXY_ENHANCER = "$__zenstack_enhancer";
+/**
+ * Minimum Prisma version supported
+ */
+export declare const PRISMA_MINIMUM_VERSION = "4.8.0";
+/**
+ * Selector function name for fetching pre-update entity values.
+ */
+export declare const PRE_UPDATE_VALUE_SELECTOR = "preValueSelect";
+/**
+ * Prefix for field-level read checker function name
+ */
+export declare const FIELD_LEVEL_READ_CHECKER_PREFIX = "readFieldCheck$";
+/**
+ * Field-level access control evaluation selector function name
+ */
+export declare const FIELD_LEVEL_READ_CHECKER_SELECTOR = "readFieldSelect";
+/**
+ * Prefix for field-level update guard function name
+ */
+export declare const FIELD_LEVEL_UPDATE_GUARD_PREFIX = "updateFieldCheck$";
+/**
+ * Flag that indicates if the model has field-level access control
+ */
+export declare const HAS_FIELD_LEVEL_POLICY_FLAG = "hasFieldLevelPolicy";

package/constants.js

@@ -1,29 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrismaErrorCode = exports.CrudFailureReason = exports.AUXILIARY_FIELDS = exports.GUARD_FIELD_NAME = exports.TRANSACTION_FIELD_NAME = exports.DEFAULT_PASSWORD_SALT_LENGTH = void 0;
+exports.HAS_FIELD_LEVEL_POLICY_FLAG = exports.FIELD_LEVEL_UPDATE_GUARD_PREFIX = exports.FIELD_LEVEL_READ_CHECKER_SELECTOR = exports.FIELD_LEVEL_READ_CHECKER_PREFIX = exports.PRE_UPDATE_VALUE_SELECTOR = exports.PRISMA_MINIMUM_VERSION = exports.PRISMA_PROXY_ENHANCER = exports.PRISMA_TX_FLAG = exports.PrismaErrorCode = exports.CrudFailureReason = exports.DEFAULT_PASSWORD_SALT_LENGTH = exports.DEFAULT_RUNTIME_LOAD_PATH = void 0;
 /**
- * Default length of password hash salt (used by bcryptjs to hash password)
+ * Default path for loading CLI-generated code
  */
-exports.DEFAULT_PASSWORD_SALT_LENGTH = 12;
+exports.DEFAULT_RUNTIME_LOAD_PATH = '.zenstack';
 /**
- * Auxiliary database field for supporting policy check for nested writes
- */
-exports.TRANSACTION_FIELD_NAME = 'zenstack_transaction';
-/**
- * Auxiliary database field for building up policy check queries
- */
-exports.GUARD_FIELD_NAME = 'zenstack_guard';
-/**
- * All Auxiliary fields.
+ * Default length of password hash salt (used by bcryptjs to hash password)
  */
-exports.AUXILIARY_FIELDS = [exports.TRANSACTION_FIELD_NAME, exports.GUARD_FIELD_NAME];
+exports.DEFAULT_PASSWORD_SALT_LENGTH = 12;
 /**
  * Reasons for a CRUD operation to fail
  */
 var CrudFailureReason;
 (function (CrudFailureReason) {
     /**
-     * CRUD suceeded but the result was not readable.
+     * CRUD failed because of access policy violation.
+     */
+    CrudFailureReason["ACCESS_POLICY_VIOLATION"] = "ACCESS_POLICY_VIOLATION";
+    /**
+     * CRUD succeeded but the result was not readable.
      */
     CrudFailureReason["RESULT_NOT_READABLE"] = "RESULT_NOT_READABLE";
     /**
@@ -36,6 +32,53 @@ var CrudFailureReason;
  */
 var PrismaErrorCode;
 (function (PrismaErrorCode) {
+    /**
+     * Unique constraint failed
+     */
+    PrismaErrorCode["UNIQUE_CONSTRAINT_FAILED"] = "P2002";
+    /**
+     * A constraint failed on the database
+     */
     PrismaErrorCode["CONSTRAINED_FAILED"] = "P2004";
+    /**
+     * The required connected records were not found
+     */
+    PrismaErrorCode["REQUIRED_CONNECTED_RECORD_NOT_FOUND"] = "P2018";
+    /**
+     * An operation failed because it depends on one or more records that were required but not found
+     */
+    PrismaErrorCode["DEPEND_ON_RECORD_NOT_FOUND"] = "P2025";
 })(PrismaErrorCode = exports.PrismaErrorCode || (exports.PrismaErrorCode = {}));
+/**
+ * Field name for storing in-transaction flag
+ */
+exports.PRISMA_TX_FLAG = '$__zenstack_tx';
+/**
+ * Field name for getting current enhancer
+ */
+exports.PRISMA_PROXY_ENHANCER = '$__zenstack_enhancer';
+/**
+ * Minimum Prisma version supported
+ */
+exports.PRISMA_MINIMUM_VERSION = '4.8.0';
+/**
+ * Selector function name for fetching pre-update entity values.
+ */
+exports.PRE_UPDATE_VALUE_SELECTOR = 'preValueSelect';
+/**
+ * Prefix for field-level read checker function name
+ */
+exports.FIELD_LEVEL_READ_CHECKER_PREFIX = 'readFieldCheck$';
+/**
+ * Field-level access control evaluation selector function name
+ */
+exports.FIELD_LEVEL_READ_CHECKER_SELECTOR = 'readFieldSelect';
+/**
+ * Prefix for field-level update guard function name
+ */
+exports.FIELD_LEVEL_UPDATE_GUARD_PREFIX = 'updateFieldCheck$';
+/**
+ * Flag that indicates if the model has field-level access control
+ */
+exports.HAS_FIELD_LEVEL_POLICY_FLAG = 'hasFieldLevelPolicy';
 //# sourceMappingURL=constants.js.map

package/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,4BAA4B,GAAG,EAAE,CAAC;AAE/C;;GAEG;AACU,QAAA,sBAAsB,GAAG,sBAAsB,CAAC;AAE7D;;GAEG;AACU,QAAA,gBAAgB,GAAG,gBAAgB,CAAC;AAEjD;;GAEG;AACU,QAAA,gBAAgB,GAAG,CAAC,8BAAsB,EAAE,wBAAgB,CAAC,CAAC;AAE3E;;GAEG;AACH,IAAY,iBAUX;AAVD,WAAY,iBAAiB;IACzB;;OAEG;IACH,gEAA2C,CAAA;IAE3C;;OAEG;IACH,4EAAuD,CAAA;AAC3D,CAAC,EAVW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAU5B;AAED;;GAEG;AACH,IAAY,eAEX;AAFD,WAAY,eAAe;IACvB,+CAA4B,CAAA;AAChC,CAAC,EAFW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAE1B"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,yBAAyB,GAAG,WAAW,CAAC;AAErD;;GAEG;AACU,QAAA,4BAA4B,GAAG,EAAE,CAAC;AAE/C;;GAEG;AACH,IAAY,iBAeX;AAfD,WAAY,iBAAiB;IACzB;;OAEG;IACH,wEAAmD,CAAA;IAEnD;;OAEG;IACH,gEAA2C,CAAA;IAE3C;;OAEG;IACH,4EAAuD,CAAA;AAC3D,CAAC,EAfW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAe5B;AAED;;GAEG;AACH,IAAY,eAoBX;AApBD,WAAY,eAAe;IACvB;;OAEG;IACH,qDAAkC,CAAA;IAElC;;OAEG;IACH,+CAA4B,CAAA;IAE5B;;OAEG;IACH,gEAA6C,CAAA;IAE7C;;OAEG;IACH,uDAAoC,CAAA;AACxC,CAAC,EApBW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAoB1B;AAED;;GAEG;AACU,QAAA,cAAc,GAAG,gBAAgB,CAAC;AAE/C;;GAEG;AACU,QAAA,qBAAqB,GAAG,sBAAsB,CAAC;AAE5D;;GAEG;AACU,QAAA,sBAAsB,GAAG,OAAO,CAAC;AAE9C;;GAEG;AACU,QAAA,yBAAyB,GAAG,gBAAgB,CAAC;AAE1D;;GAEG;AACU,QAAA,+BAA+B,GAAG,iBAAiB,CAAC;AAEjE;;GAEG;AACU,QAAA,iCAAiC,GAAG,iBAAiB,CAAC;AAEnE;;GAEG;AACU,QAAA,+BAA+B,GAAG,mBAAmB,CAAC;AAEnE;;GAEG;AACU,QAAA,2BAA2B,GAAG,qBAAqB,CAAC"}

package/enhancements/enhance.d.ts

@@ -0,0 +1,18 @@
+import { WithOmitOptions } from './omit';
+import { WithPasswordOptions } from './password';
+import { WithPolicyContext, WithPolicyOptions } from './policy';
+/**
+ * Options @see enhance
+ */
+export type EnhancementOptions = WithPolicyOptions & WithPasswordOptions & WithOmitOptions;
+/**
+ * Gets a Prisma client enhanced with all essential behaviors, including access
+ * policy, field validation, field omission and password hashing.
+ *
+ * It's a shortcut for calling withOmit(withPassword(withPolicy(prisma, options))).
+ *
+ * @param prisma The Prisma client to enhance.
+ * @param context The context to for evaluating access policies.
+ * @param options Options.
+ */
+export declare function enhance<DbClient extends object>(prisma: DbClient, context?: WithPolicyContext, options?: EnhancementOptions): DbClient;

package/enhancements/enhance.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enhance = void 0;
+const loader_1 = require("../loader");
+const omit_1 = require("./omit");
+const password_1 = require("./password");
+const policy_1 = require("./policy");
+let hasPassword = undefined;
+let hasOmit = undefined;
+/**
+ * Gets a Prisma client enhanced with all essential behaviors, including access
+ * policy, field validation, field omission and password hashing.
+ *
+ * It's a shortcut for calling withOmit(withPassword(withPolicy(prisma, options))).
+ *
+ * @param prisma The Prisma client to enhance.
+ * @param context The context to for evaluating access policies.
+ * @param options Options.
+ */
+function enhance(prisma, context, options) {
+    var _a;
+    let result = prisma;
+    if (hasPassword === undefined || hasOmit === undefined) {
+        const modelMeta = (_a = options === null || options === void 0 ? void 0 : options.modelMeta) !== null && _a !== void 0 ? _a : (0, loader_1.getDefaultModelMeta)(options === null || options === void 0 ? void 0 : options.loadPath);
+        const allFields = Object.values(modelMeta.fields).flatMap((modelInfo) => Object.values(modelInfo));
+        hasPassword = allFields.some((field) => { var _a; return (_a = field.attributes) === null || _a === void 0 ? void 0 : _a.some((attr) => attr.name === '@password'); });
+        hasOmit = allFields.some((field) => { var _a; return (_a = field.attributes) === null || _a === void 0 ? void 0 : _a.some((attr) => attr.name === '@omit'); });
+    }
+    if (hasPassword) {
+        // @password proxy
+        result = (0, password_1.withPassword)(result, options);
+    }
+    if (hasOmit) {
+        // @omit proxy
+        result = (0, omit_1.withOmit)(result, options);
+    }
+    // policy proxy
+    result = (0, policy_1.withPolicy)(result, context, options);
+    return result;
+}
+exports.enhance = enhance;
+//# sourceMappingURL=enhance.js.map

package/enhancements/enhance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enhance.js","sourceRoot":"","sources":["../../src/enhancements/enhance.ts"],"names":[],"mappings":";;;AAAA,sCAAgD;AAChD,iCAAmD;AACnD,yCAA+D;AAC/D,qCAA4E;AAO5E,IAAI,WAAW,GAAwB,SAAS,CAAC;AACjD,IAAI,OAAO,GAAwB,SAAS,CAAC;AAE7C;;;;;;;;;GASG;AACH,SAAgB,OAAO,CACnB,MAAgB,EAChB,OAA2B,EAC3B,OAA4B;;IAE5B,IAAI,MAAM,GAAG,MAAM,CAAC;IAEpB,IAAI,WAAW,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS,EAAE;QACpD,MAAM,SAAS,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,mCAAI,IAAA,4BAAmB,EAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,CAAC,CAAC;QAC/E,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QACnG,WAAW,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,WAAC,OAAA,MAAA,KAAK,CAAC,UAAU,0CAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,CAAA,EAAA,CAAC,CAAC;QACrG,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,WAAC,OAAA,MAAA,KAAK,CAAC,UAAU,0CAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,CAAA,EAAA,CAAC,CAAC;KAChG;IAED,IAAI,WAAW,EAAE;QACb,kBAAkB;QAClB,MAAM,GAAG,IAAA,uBAAY,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAC1C;IAED,IAAI,OAAO,EAAE;QACT,cAAc;QACd,MAAM,GAAG,IAAA,eAAQ,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACtC;IAED,eAAe;IACf,MAAM,GAAG,IAAA,mBAAU,EAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAE9C,OAAO,MAAM,CAAC;AAClB,CAAC;AA5BD,0BA4BC"}

package/enhancements/index.d.ts

@@ -1,9 +1,10 @@
 export * from './model-meta';
-export * from './nested-write-vistor';
+export * from './nested-write-visitor';
 export * from './omit';
 export * from './password';
 export * from './policy';
 export * from './preset';
+export * from './enhance';
 export * from './types';
 export * from './utils';
 export * from './where-visitor';

package/enhancements/index.js

@@ -15,11 +15,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./model-meta"), exports);
-__exportStar(require("./nested-write-vistor"), exports);
+__exportStar(require("./nested-write-visitor"), exports);
 __exportStar(require("./omit"), exports);
 __exportStar(require("./password"), exports);
 __exportStar(require("./policy"), exports);
 __exportStar(require("./preset"), exports);
+__exportStar(require("./enhance"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./where-visitor"), exports);

package/enhancements/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/enhancements/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,wDAAsC;AACtC,yCAAuB;AACvB,6CAA2B;AAC3B,2CAAyB;AACzB,2CAAyB;AACzB,0CAAwB;AACxB,0CAAwB;AACxB,kDAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/enhancements/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,yDAAuC;AACvC,yCAAuB;AACvB,6CAA2B;AAC3B,2CAAyB;AACzB,2CAAyB;AACzB,4CAA0B;AAC1B,0CAAwB;AACxB,0CAAwB;AACxB,kDAAgC"}

package/enhancements/model-data-visitor.d.ts

@@ -0,0 +1,16 @@
+import { ModelMeta } from './types';
+/**
+ * Callback for @see ModelDataVisitor.
+ */
+export type ModelDataVisitorCallback = (model: string, data: any, scalarData: any) => void;
+/**
+ * Visitor that traverses data returned by a Prisma query.
+ */
+export declare class ModelDataVisitor {
+    private modelMeta;
+    constructor(modelMeta: ModelMeta);
+    /**
+     * Visits the given model data.
+     */
+    visit(model: string, data: any, callback: ModelDataVisitorCallback): void;
+}

package/enhancements/model-data-visitor.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelDataVisitor = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const model_meta_1 = require("./model-meta");
+/**
+ * Visitor that traverses data returned by a Prisma query.
+ */
+class ModelDataVisitor {
+    constructor(modelMeta) {
+        this.modelMeta = modelMeta;
+    }
+    /**
+     * Visits the given model data.
+     */
+    visit(model, data, callback) {
+        if (!data || typeof data !== 'object') {
+            return;
+        }
+        const scalarData = {};
+        const subTasks = [];
+        for (const [k, v] of Object.entries(data)) {
+            const field = (0, model_meta_1.resolveField)(this.modelMeta, model, k);
+            if (field && field.isDataModel) {
+                if (field.isArray && Array.isArray(v)) {
+                    subTasks.push(...v.map((item) => ({ model: field.type, data: item })));
+                }
+                else {
+                    subTasks.push({ model: field.type, data: v });
+                }
+            }
+            else {
+                scalarData[k] = v;
+            }
+        }
+        callback(model, data, scalarData);
+        subTasks.forEach(({ model, data }) => this.visit(model, data, callback));
+    }
+}
+exports.ModelDataVisitor = ModelDataVisitor;
+//# sourceMappingURL=model-data-visitor.js.map

package/enhancements/model-data-visitor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-data-visitor.js","sourceRoot":"","sources":["../../src/enhancements/model-data-visitor.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,6CAA4C;AAQ5C;;GAEG;AACH,MAAa,gBAAgB;IACzB,YAAoB,SAAoB;QAApB,cAAS,GAAT,SAAS,CAAW;IAAG,CAAC;IAE5C;;OAEG;IACH,KAAK,CAAC,KAAa,EAAE,IAAS,EAAE,QAAkC;QAC9D,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YACnC,OAAO;SACV;QAED,MAAM,UAAU,GAA4B,EAAE,CAAC;QAC/C,MAAM,QAAQ,GAAwC,EAAE,CAAC;QAEzD,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvC,MAAM,KAAK,GAAG,IAAA,yBAAY,EAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;YACrD,IAAI,KAAK,IAAI,KAAK,CAAC,WAAW,EAAE;gBAC5B,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;oBACnC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;iBAC1E;qBAAM;oBACH,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;iBACjD;aACJ;iBAAM;gBACH,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;aACrB;SACJ;QAED,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QAClC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC7E,CAAC;CACJ;AA9BD,4CA8BC"}

package/enhancements/model-meta.d.ts

@@ -1,13 +1,10 @@
+import { FieldInfo } from '../types';
 import { ModelMeta } from './types';
-/**
- * Load model meta from standard location.
- */
-export declare function getDefaultModelMeta(): ModelMeta;
 /**
  * Resolves a model field to its metadata. Returns undefined if not found.
  */
-export declare function resolveField(modelMeta: ModelMeta, model: string, field: string): import("..").FieldInfo;
+export declare function resolveField(modelMeta: ModelMeta, model: string, field: string): FieldInfo | undefined;
 /**
  * Gets all fields of a model.
  */
-export declare function getFields(modelMeta: ModelMeta, model: string): Record<string, import("..").FieldInfo>;
+export declare function getFields(modelMeta: ModelMeta, model: string): Record<string, FieldInfo>;

package/enhancements/model-meta.js

@@ -1,39 +1,14 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFields = exports.resolveField = exports.getDefaultModelMeta = void 0;
+exports.getFields = exports.resolveField = void 0;
 /* eslint-disable @typescript-eslint/no-var-requires */
 const lower_case_first_1 = require("lower-case-first");
-const path_1 = __importDefault(require("path"));
-/**
- * Load model meta from standard location.
- */
-function getDefaultModelMeta() {
-    try {
-        // normal load
-        return require('.zenstack/model-meta').default;
-    }
-    catch (_a) {
-        if (process.env.ZENSTACK_TEST === '1') {
-            try {
-                // special handling for running as tests, try resolving relative to CWD
-                return require(path_1.default.join(process.cwd(), 'node_modules', '.zenstack', 'model-meta')).default;
-            }
-            catch (_b) {
-                throw new Error('Model meta cannot be loaded. Please make sure "zenstack generate" has been run.');
-            }
-        }
-        throw new Error('Model meta cannot be loaded. Please make sure "zenstack generate" has been run.');
-    }
-}
-exports.getDefaultModelMeta = getDefaultModelMeta;
 /**
  * Resolves a model field to its metadata. Returns undefined if not found.
  */
 function resolveField(modelMeta, model, field) {
-    return modelMeta.fields[(0, lower_case_first_1.lowerCaseFirst)(model)][field];
+    var _a;
+    return (_a = modelMeta.fields[(0, lower_case_first_1.lowerCaseFirst)(model)]) === null || _a === void 0 ? void 0 : _a[field];
 }
 exports.resolveField = resolveField;
 /**

package/enhancements/model-meta.js.map

@@ -1 +1 @@
-{"version":3,"file":"model-meta.js","sourceRoot":"","sources":["../../src/enhancements/model-meta.ts"],"names":[],"mappings":";;;;;;AAAA,uDAAuD;AACvD,uDAAkD;AAClD,gDAAwB;AAGxB;;GAEG;AACH,SAAgB,mBAAmB;IAC/B,IAAI;QACA,cAAc;QACd,OAAO,OAAO,CAAC,sBAAsB,CAAC,CAAC,OAAO,CAAC;KAClD;IAAC,WAAM;QACJ,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,GAAG,EAAE;YACnC,IAAI;gBACA,uEAAuE;gBACvE,OAAO,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC;aAC/F;YAAC,WAAM;gBACJ,MAAM,IAAI,KAAK,CAAC,iFAAiF,CAAC,CAAC;aACtG;SACJ;QACD,MAAM,IAAI,KAAK,CAAC,iFAAiF,CAAC,CAAC;KACtG;AACL,CAAC;AAfD,kDAeC;AAED;;GAEG;AACH,SAAgB,YAAY,CAAC,SAAoB,EAAE,KAAa,EAAE,KAAa;IAC3E,OAAO,SAAS,CAAC,MAAM,CAAC,IAAA,iCAAc,EAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAC1D,CAAC;AAFD,oCAEC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,SAAoB,EAAE,KAAa;IACzD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAA,iCAAc,EAAC,KAAK,CAAC,CAAC,CAAC;AACnD,CAAC;AAFD,8BAEC"}
+{"version":3,"file":"model-meta.js","sourceRoot":"","sources":["../../src/enhancements/model-meta.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,uDAAkD;AAIlD;;GAEG;AACH,SAAgB,YAAY,CAAC,SAAoB,EAAE,KAAa,EAAE,KAAa;;IAC3E,OAAO,MAAA,SAAS,CAAC,MAAM,CAAC,IAAA,iCAAc,EAAC,KAAK,CAAC,CAAC,0CAAG,KAAK,CAAC,CAAC;AAC5D,CAAC;AAFD,oCAEC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,SAAoB,EAAE,KAAa;IACzD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAA,iCAAc,EAAC,KAAK,CAAC,CAAC,CAAC;AACnD,CAAC;AAFD,8BAEC"}

package/enhancements/{nested-write-vistor.d.ts → nested-write-visitor.d.ts}

@@ -24,35 +24,39 @@ export type NestedWriteVisitorContext = {
     nestingPath: NestingPathItem[];
 };
 /**
- * NestedWriteVisitor's callback actions
+ * NestedWriteVisitor's callback actions. A call back function should return true or void to indicate
+ * that the visitor should continue traversing its children, or false to stop. It can also return an object
+ * to let the visitor traverse it instead of its original children.
  */
 export type NestedWriterVisitorCallback = {
-    create?: (model: string, args: any[], context: NestedWriteVisitorContext) => Promise<void>;
+    create?: (model: string, args: any[], context: NestedWriteVisitorContext) => Promise<boolean | void>;
+    createMany?: (model: string, args: {
+        data: any;
+        skipDuplicates?: boolean;
+    }, context: NestedWriteVisitorContext) => Promise<boolean | object | void>;
     connectOrCreate?: (model: string, args: {
         where: object;
         create: any;
-    }, context: NestedWriteVisitorContext) => Promise<void>;
-    connect?: (model: string, args: object, context: NestedWriteVisitorContext) => Promise<void>;
-    disconnect?: (model: string, args: object, context: NestedWriteVisitorContext) => Promise<void>;
-    update?: (model: string, args: {
-        where: object;
-        data: any;
-    }, context: NestedWriteVisitorContext) => Promise<void>;
+    }, context: NestedWriteVisitorContext) => Promise<boolean | object | void>;
+    connect?: (model: string, args: object, context: NestedWriteVisitorContext) => Promise<boolean | object | void>;
+    disconnect?: (model: string, args: object, context: NestedWriteVisitorContext) => Promise<boolean | object | void>;
+    set?: (model: string, args: object, context: NestedWriteVisitorContext) => Promise<boolean | object | void>;
+    update?: (model: string, args: object, context: NestedWriteVisitorContext) => Promise<boolean | object | void>;
     updateMany?: (model: string, args: {
         where?: object;
         data: any;
-    }, context: NestedWriteVisitorContext) => Promise<void>;
+    }, context: NestedWriteVisitorContext) => Promise<boolean | object | void>;
     upsert?: (model: string, args: {
         where: object;
         create: any;
         update: any;
-    }, context: NestedWriteVisitorContext) => Promise<void>;
-    delete?: (model: string, args: object | boolean, context: NestedWriteVisitorContext) => Promise<void>;
-    deleteMany?: (model: string, args: any | object, context: NestedWriteVisitorContext) => Promise<void>;
+    }, context: NestedWriteVisitorContext) => Promise<boolean | object | void>;
+    delete?: (model: string, args: object | boolean, context: NestedWriteVisitorContext) => Promise<boolean | object | void>;
+    deleteMany?: (model: string, args: any | object, context: NestedWriteVisitorContext) => Promise<boolean | object | void>;
     field?: (field: FieldInfo, action: PrismaWriteActionType, data: any, context: NestedWriteVisitorContext) => Promise<void>;
 };
 /**
- * Recursive visitor for nested write (create/update) payload
+ * Recursive visitor for nested write (create/update) payload.
  */
 export declare class NestedWriteVisitor {
     private readonly modelMeta;