@zenstackhq/runtime 1.10.0 → 2.0.0-alpha.2

package/constants.d.ts

@@ -51,7 +51,7 @@ export declare const PRISMA_PROXY_ENHANCER = "$__zenstack_enhancer";
 /**
  * Minimum Prisma version supported
  */
-export declare const PRISMA_MINIMUM_VERSION = "4.8.0";
+export declare const PRISMA_MINIMUM_VERSION = "5.0.0";
 /**
  * Selector function name for fetching pre-update entity values.
  */
@@ -80,3 +80,7 @@ export declare const FIELD_LEVEL_OVERRIDE_UPDATE_GUARD_PREFIX = "updateFieldGuar
  * Flag that indicates if the model has field-level access control
  */
 export declare const HAS_FIELD_LEVEL_POLICY_FLAG = "hasFieldLevelPolicy";
+/**
+ * Prefix for auxiliary relation field generated for delegated models
+ */
+export declare const DELEGATE_AUX_RELATION_PREFIX = "delegate_aux";

package/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HAS_FIELD_LEVEL_POLICY_FLAG = exports.FIELD_LEVEL_OVERRIDE_UPDATE_GUARD_PREFIX = exports.FIELD_LEVEL_UPDATE_GUARD_PREFIX = exports.FIELD_LEVEL_OVERRIDE_READ_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.PrismaErrorCode = exports.CrudFailureReason = exports.DEFAULT_PASSWORD_SALT_LENGTH = exports.DEFAULT_RUNTIME_LOAD_PATH = void 0;
+exports.DELEGATE_AUX_RELATION_PREFIX = exports.HAS_FIELD_LEVEL_POLICY_FLAG = exports.FIELD_LEVEL_OVERRIDE_UPDATE_GUARD_PREFIX = exports.FIELD_LEVEL_UPDATE_GUARD_PREFIX = exports.FIELD_LEVEL_OVERRIDE_READ_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.PrismaErrorCode = exports.CrudFailureReason = exports.DEFAULT_PASSWORD_SALT_LENGTH = exports.DEFAULT_RUNTIME_LOAD_PATH = void 0;
 /**
  * Default path for loading CLI-generated code
  */
@@ -56,7 +56,7 @@ exports.PRISMA_PROXY_ENHANCER = '$__zenstack_enhancer';
 /**
  * Minimum Prisma version supported
  */
-exports.PRISMA_MINIMUM_VERSION = '4.8.0';
+exports.PRISMA_MINIMUM_VERSION = '5.0.0';
 /**
  * Selector function name for fetching pre-update entity values.
  */
@@ -85,4 +85,8 @@ exports.FIELD_LEVEL_OVERRIDE_UPDATE_GUARD_PREFIX = 'updateFieldGuardOverride$';
  * Flag that indicates if the model has field-level access control
  */
 exports.HAS_FIELD_LEVEL_POLICY_FLAG = 'hasFieldLevelPolicy';
+/**
+ * Prefix for auxiliary relation field generated for delegated models
+ */
+exports.DELEGATE_AUX_RELATION_PREFIX = 'delegate_aux';
 //# 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,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,iCAAjB,iBAAiB,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,+BAAf,eAAe,QAoB1B;AAED;;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,sCAAsC,GAAG,yBAAyB,CAAC;AAEhF;;GAEG;AACU,QAAA,+BAA+B,GAAG,mBAAmB,CAAC;AAEnE;;GAEG;AACU,QAAA,wCAAwC,GAAG,2BAA2B,CAAC;AAEpF;;GAEG;AACU,QAAA,2BAA2B,GAAG,qBAAqB,CAAC"}
+{"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,iCAAjB,iBAAiB,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,+BAAf,eAAe,QAoB1B;AAED;;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,sCAAsC,GAAG,yBAAyB,CAAC;AAEhF;;GAEG;AACU,QAAA,+BAA+B,GAAG,mBAAmB,CAAC;AAEnE;;GAEG;AACU,QAAA,wCAAwC,GAAG,2BAA2B,CAAC;AAEpF;;GAEG;AACU,QAAA,2BAA2B,GAAG,qBAAqB,CAAC;AAEjE;;GAEG;AACU,QAAA,4BAA4B,GAAG,cAAc,CAAC"}

package/cross/index.d.mts

@@ -18,12 +18,22 @@ declare class ModelDataVisitor {
  * Runtime information of a data model or field attribute
  */
 type RuntimeAttribute = {
+    /**
+     * Attribute name
+     */
     name: string;
+    /**
+     * Attribute arguments
+     */
     args: Array<{
         name?: string;
         value: unknown;
     }>;
 };
+/**
+ * Function for computing default value for a field
+ */
+type FieldDefaultValueProvider = (userContext: unknown) => unknown;
 /**
  * Runtime information of a data model field
  */
@@ -69,9 +79,23 @@ type FieldInfo = {
      */
     isForeignKey?: boolean;
     /**
-     * Mapping from foreign key field names to relation field names
+     * If the field is a foreign key field, the field name of the corresponding relation field.
+     * Only available on foreign key fields.
+     */
+    relationField?: string;
+    /**
+     * Mapping from foreign key field names to relation field names.
+     * Only available on relation fields.
      */
     foreignKeyMapping?: Record<string, string>;
+    /**
+     * Model from which the field is inherited
+     */
+    inheritedFrom?: string;
+    /**
+     * A function that provides a default value for the field
+     */
+    defaultValueProvider?: FieldDefaultValueProvider;
     /**
      * If the field is an auto-increment field
      */
@@ -86,21 +110,46 @@ type UniqueConstraint = {
     fields: string[];
 };
 /**
- * ZModel data model metadata
+ * Metadata for a data model
  */
-type ModelMeta = {
+type ModelInfo = {
+    /**
+     * Model name
+     */
+    name: string;
     /**
-     * Model fields
+     * Base types
      */
-    fields: Record<string, Record<string, FieldInfo>>;
+    baseTypes?: string[];
     /**
-     * Model unique constraints
+     * Fields
      */
-    uniqueConstraints: Record<string, Record<string, UniqueConstraint>>;
+    fields: Record<string, FieldInfo>;
     /**
-     * Information for cascading delete
+     * Unique constraints
      */
-    deleteCascade: Record<string, string[]>;
+    uniqueConstraints?: Record<string, UniqueConstraint>;
+    /**
+     * Attributes on the model
+     */
+    attributes?: RuntimeAttribute[];
+    /**
+     * Discriminator field name
+     */
+    discriminator?: string;
+};
+/**
+ * ZModel data model metadata
+ */
+type ModelMeta = {
+    /**
+     * Data models
+     */
+    models: Record<string, ModelInfo>;
+    /**
+     * Mapping from model name to models that will be deleted because of it due to cascade delete
+     */
+    deleteCascade?: Record<string, string[]>;
     /**
      * Name of model that backs the `auth()` function
      */
@@ -109,7 +158,7 @@ type ModelMeta = {
 /**
  * Resolves a model field to its metadata. Returns undefined if not found.
  */
-declare function resolveField(modelMeta: ModelMeta, model: string, field: string): FieldInfo;
+declare function resolveField(modelMeta: ModelMeta, model: string, field: string): FieldInfo | undefined;
 /**
  * Resolves a model field to its metadata. Throws an error if not found.
  */
@@ -118,6 +167,10 @@ declare function requireField(modelMeta: ModelMeta, model: string, field: string
  * Gets all fields of a model.
  */
 declare function getFields(modelMeta: ModelMeta, model: string): Record<string, FieldInfo>;
+/**
+ * Gets unique constraints of a model.
+ */
+declare function getUniqueConstraints(modelMeta: ModelMeta, model: string): Record<string, UniqueConstraint> | undefined;
 
 /**
  * Tries to apply a mutation to a query result.
@@ -190,7 +243,7 @@ type NestedWriteVisitorContext = {
  * to let the visitor traverse it instead of its original children.
  */
 type NestedWriterVisitorCallback = {
-    create?: (model: string, args: any[], context: NestedWriteVisitorContext) => MaybePromise<boolean | object | void>;
+    create?: (model: string, data: any, context: NestedWriteVisitorContext) => MaybePromise<boolean | object | void>;
     createMany?: (model: string, args: {
         data: any;
         skipDuplicates?: boolean;
@@ -265,5 +318,7 @@ declare function enumerate<T>(x: Enumerable<T>): T[];
  */
 declare function zip<T1, T2>(x: Enumerable<T1>, y: Enumerable<T2>): Array<[T1, T2]>;
 declare function getIdFields(modelMeta: ModelMeta, model: string, throwIfNotFound?: boolean): FieldInfo[];
+declare function getModelInfo<Throw extends boolean = false>(modelMeta: ModelMeta, model: string, throwIfNotFound?: Throw): Throw extends true ? ModelInfo : ModelInfo | undefined;
+declare function isDelegateModel(modelMeta: ModelMeta, model: string): boolean;
 
-export { type Enumerable, type FieldInfo, type MaybePromise, ModelDataVisitor, type ModelDataVisitorCallback, type ModelMeta, NestedReadVisitor, type NestedReadVisitorCallback, NestedWriteVisitor, type NestedWriteVisitorContext, type NestedWriterVisitorCallback, type PrismaWriteActionType, PrismaWriteActions, type RuntimeAttribute, type UniqueConstraint, applyMutation, enumerate, getFields, getIdFields, getModelFields, getMutatedModels, getReadModels, requireField, resolveField, zip };
+export { type Enumerable, type FieldDefaultValueProvider, type FieldInfo, type MaybePromise, ModelDataVisitor, type ModelDataVisitorCallback, type ModelInfo, type ModelMeta, NestedReadVisitor, type NestedReadVisitorCallback, NestedWriteVisitor, type NestedWriteVisitorContext, type NestedWriterVisitorCallback, type PrismaWriteActionType, PrismaWriteActions, type RuntimeAttribute, type UniqueConstraint, applyMutation, enumerate, getFields, getIdFields, getModelFields, getModelInfo, getMutatedModels, getReadModels, getUniqueConstraints, isDelegateModel, requireField, resolveField, zip };

package/cross/index.d.ts

@@ -18,12 +18,22 @@ declare class ModelDataVisitor {
  * Runtime information of a data model or field attribute
  */
 type RuntimeAttribute = {
+    /**
+     * Attribute name
+     */
     name: string;
+    /**
+     * Attribute arguments
+     */
     args: Array<{
         name?: string;
         value: unknown;
     }>;
 };
+/**
+ * Function for computing default value for a field
+ */
+type FieldDefaultValueProvider = (userContext: unknown) => unknown;
 /**
  * Runtime information of a data model field
  */
@@ -69,9 +79,23 @@ type FieldInfo = {
      */
     isForeignKey?: boolean;
     /**
-     * Mapping from foreign key field names to relation field names
+     * If the field is a foreign key field, the field name of the corresponding relation field.
+     * Only available on foreign key fields.
+     */
+    relationField?: string;
+    /**
+     * Mapping from foreign key field names to relation field names.
+     * Only available on relation fields.
      */
     foreignKeyMapping?: Record<string, string>;
+    /**
+     * Model from which the field is inherited
+     */
+    inheritedFrom?: string;
+    /**
+     * A function that provides a default value for the field
+     */
+    defaultValueProvider?: FieldDefaultValueProvider;
     /**
      * If the field is an auto-increment field
      */
@@ -86,21 +110,46 @@ type UniqueConstraint = {
     fields: string[];
 };
 /**
- * ZModel data model metadata
+ * Metadata for a data model
  */
-type ModelMeta = {
+type ModelInfo = {
+    /**
+     * Model name
+     */
+    name: string;
     /**
-     * Model fields
+     * Base types
      */
-    fields: Record<string, Record<string, FieldInfo>>;
+    baseTypes?: string[];
     /**
-     * Model unique constraints
+     * Fields
      */
-    uniqueConstraints: Record<string, Record<string, UniqueConstraint>>;
+    fields: Record<string, FieldInfo>;
     /**
-     * Information for cascading delete
+     * Unique constraints
      */
-    deleteCascade: Record<string, string[]>;
+    uniqueConstraints?: Record<string, UniqueConstraint>;
+    /**
+     * Attributes on the model
+     */
+    attributes?: RuntimeAttribute[];
+    /**
+     * Discriminator field name
+     */
+    discriminator?: string;
+};
+/**
+ * ZModel data model metadata
+ */
+type ModelMeta = {
+    /**
+     * Data models
+     */
+    models: Record<string, ModelInfo>;
+    /**
+     * Mapping from model name to models that will be deleted because of it due to cascade delete
+     */
+    deleteCascade?: Record<string, string[]>;
     /**
      * Name of model that backs the `auth()` function
      */
@@ -109,7 +158,7 @@ type ModelMeta = {
 /**
  * Resolves a model field to its metadata. Returns undefined if not found.
  */
-declare function resolveField(modelMeta: ModelMeta, model: string, field: string): FieldInfo;
+declare function resolveField(modelMeta: ModelMeta, model: string, field: string): FieldInfo | undefined;
 /**
  * Resolves a model field to its metadata. Throws an error if not found.
  */
@@ -118,6 +167,10 @@ declare function requireField(modelMeta: ModelMeta, model: string, field: string
  * Gets all fields of a model.
  */
 declare function getFields(modelMeta: ModelMeta, model: string): Record<string, FieldInfo>;
+/**
+ * Gets unique constraints of a model.
+ */
+declare function getUniqueConstraints(modelMeta: ModelMeta, model: string): Record<string, UniqueConstraint> | undefined;
 
 /**
  * Tries to apply a mutation to a query result.
@@ -190,7 +243,7 @@ type NestedWriteVisitorContext = {
  * to let the visitor traverse it instead of its original children.
  */
 type NestedWriterVisitorCallback = {
-    create?: (model: string, args: any[], context: NestedWriteVisitorContext) => MaybePromise<boolean | object | void>;
+    create?: (model: string, data: any, context: NestedWriteVisitorContext) => MaybePromise<boolean | object | void>;
     createMany?: (model: string, args: {
         data: any;
         skipDuplicates?: boolean;
@@ -265,5 +318,7 @@ declare function enumerate<T>(x: Enumerable<T>): T[];
  */
 declare function zip<T1, T2>(x: Enumerable<T1>, y: Enumerable<T2>): Array<[T1, T2]>;
 declare function getIdFields(modelMeta: ModelMeta, model: string, throwIfNotFound?: boolean): FieldInfo[];
+declare function getModelInfo<Throw extends boolean = false>(modelMeta: ModelMeta, model: string, throwIfNotFound?: Throw): Throw extends true ? ModelInfo : ModelInfo | undefined;
+declare function isDelegateModel(modelMeta: ModelMeta, model: string): boolean;
 
-export { type Enumerable, type FieldInfo, type MaybePromise, ModelDataVisitor, type ModelDataVisitorCallback, type ModelMeta, NestedReadVisitor, type NestedReadVisitorCallback, NestedWriteVisitor, type NestedWriteVisitorContext, type NestedWriterVisitorCallback, type PrismaWriteActionType, PrismaWriteActions, type RuntimeAttribute, type UniqueConstraint, applyMutation, enumerate, getFields, getIdFields, getModelFields, getMutatedModels, getReadModels, requireField, resolveField, zip };
+export { type Enumerable, type FieldDefaultValueProvider, type FieldInfo, type MaybePromise, ModelDataVisitor, type ModelDataVisitorCallback, type ModelInfo, type ModelMeta, NestedReadVisitor, type NestedReadVisitorCallback, NestedWriteVisitor, type NestedWriteVisitorContext, type NestedWriterVisitorCallback, type PrismaWriteActionType, PrismaWriteActions, type RuntimeAttribute, type UniqueConstraint, applyMutation, enumerate, getFields, getIdFields, getModelFields, getModelInfo, getMutatedModels, getReadModels, getUniqueConstraints, isDelegateModel, requireField, resolveField, zip };

package/cross/index.js

@@ -76,8 +76,11 @@ __export(cross_exports, {
   getFields: () => getFields,
   getIdFields: () => getIdFields,
   getModelFields: () => getModelFields,
+  getModelInfo: () => getModelInfo,
   getMutatedModels: () => getMutatedModels,
   getReadModels: () => getReadModels,
+  getUniqueConstraints: () => getUniqueConstraints,
+  isDelegateModel: () => isDelegateModel,
   requireField: () => requireField,
   resolveField: () => resolveField,
   zip: () => zip
@@ -118,8 +121,8 @@ var ModelDataVisitor = class {
 // src/cross/model-meta.ts
 var import_lower_case_first = require("lower-case-first");
 function resolveField(modelMeta, model, field) {
-  var _a;
-  return (_a = modelMeta.fields[(0, import_lower_case_first.lowerCaseFirst)(model)]) == null ? void 0 : _a[field];
+  var _a, _b;
+  return (_b = (_a = modelMeta.models[(0, import_lower_case_first.lowerCaseFirst)(model)]) == null ? void 0 : _a.fields) == null ? void 0 : _b[field];
 }
 function requireField(modelMeta, model, field) {
   const f = resolveField(modelMeta, model, field);
@@ -129,7 +132,12 @@ function requireField(modelMeta, model, field) {
   return f;
 }
 function getFields(modelMeta, model) {
-  return modelMeta.fields[(0, import_lower_case_first.lowerCaseFirst)(model)];
+  var _a;
+  return (_a = modelMeta.models[(0, import_lower_case_first.lowerCaseFirst)(model)]) == null ? void 0 : _a.fields;
+}
+function getUniqueConstraints(modelMeta, model) {
+  var _a;
+  return (_a = modelMeta.models[(0, import_lower_case_first.lowerCaseFirst)(model)]) == null ? void 0 : _a.uniqueConstraints;
 }
 
 // src/cross/mutator.ts
@@ -396,7 +404,8 @@ function zip(x, y) {
   }
 }
 function getIdFields(modelMeta, model, throwIfNotFound = false) {
-  let fields = modelMeta.fields[(0, import_lower_case_first2.lowerCaseFirst)(model)];
+  var _a;
+  let fields = (_a = modelMeta.models[(0, import_lower_case_first2.lowerCaseFirst)(model)]) == null ? void 0 : _a.fields;
   if (!fields) {
     if (throwIfNotFound) {
       throw new Error(`Unable to load fields for ${model}`);
@@ -410,6 +419,17 @@ function getIdFields(modelMeta, model, throwIfNotFound = false) {
   }
   return result;
 }
+function getModelInfo(modelMeta, model, throwIfNotFound = false) {
+  const info = modelMeta.models[(0, import_lower_case_first2.lowerCaseFirst)(model)];
+  if (!info && throwIfNotFound) {
+    throw new Error(`Unable to load info for ${model}`);
+  }
+  return info;
+}
+function isDelegateModel(modelMeta, model) {
+  var _a, _b;
+  return !!((_b = (_a = getModelInfo(modelMeta, model)) == null ? void 0 : _a.attributes) == null ? void 0 : _b.some((attr) => attr.name === "@@delegate"));
+}
 
 // src/cross/nested-write-visitor.ts
 var NestedWriteVisitor = class {
@@ -511,8 +531,10 @@ var NestedWriteVisitor = class {
           break;
         case "set":
           if (this.callback.set) {
-            const newContext = pushNewContext(field, model, {});
-            yield this.callback.set(model, data, newContext);
+            for (const item of enumerate(data)) {
+              const newContext = pushNewContext(field, model, item, true);
+              yield this.callback.set(model, item, newContext);
+            }
           }
           break;
         case "update":
@@ -664,11 +686,12 @@ function getMutatedModels(model, operation, mutationArgs, modelMeta) {
   });
 }
 function collectDeleteCascades(model, modelMeta, result, visited) {
+  var _a;
   if (visited.has(model)) {
     return;
   }
   visited.add(model);
-  const cascades = modelMeta.deleteCascade[(0, import_lower_case_first3.lowerCaseFirst)(model)];
+  const cascades = (_a = modelMeta.deleteCascade) == null ? void 0 : _a[(0, import_lower_case_first3.lowerCaseFirst)(model)];
   if (!cascades) {
     return;
   }
@@ -688,8 +711,11 @@ function collectDeleteCascades(model, modelMeta, result, visited) {
   getFields,
   getIdFields,
   getModelFields,
+  getModelInfo,
   getMutatedModels,
   getReadModels,
+  getUniqueConstraints,
+  isDelegateModel,
   requireField,
   resolveField,
   zip