@zenstackhq/runtime 1.2.1 → 1.3.0

package/cross/index.d.mts

@@ -1,3 +1,19 @@
+/**
+ * Callback for @see ModelDataVisitor.
+ */
+type ModelDataVisitorCallback = (model: string, data: any, scalarData: any) => void;
+/**
+ * Visitor that traverses data returned by a Prisma query.
+ */
+declare class ModelDataVisitor {
+    private modelMeta;
+    constructor(modelMeta: ModelMeta);
+    /**
+     * Visits the given model data.
+     */
+    visit(model: string, data: any, callback: ModelDataVisitorCallback): void;
+}
+
 /**
  * Runtime information of a data model or field attribute
  */
@@ -23,23 +39,23 @@ type FieldInfo = {
     /**
      * If the field is an ID field or part of a multi-field ID
      */
-    isId: boolean;
+    isId?: boolean;
     /**
      * If the field type is a data model (or an optional/array of data model)
      */
-    isDataModel: boolean;
+    isDataModel?: boolean;
     /**
      * If the field is an array
      */
-    isArray: boolean;
+    isArray?: boolean;
     /**
      * If the field is optional
      */
-    isOptional: boolean;
+    isOptional?: boolean;
     /**
      * Attributes on the field
      */
-    attributes: RuntimeAttribute[];
+    attributes?: RuntimeAttribute[];
     /**
      * If the field is a relation field, the field name of the reverse side of the relation
      */
@@ -47,11 +63,11 @@ type FieldInfo = {
     /**
      * If the field is the owner side of a relation
      */
-    isRelationOwner: boolean;
+    isRelationOwner?: boolean;
     /**
      * If the field is a foreign key field
      */
-    isForeignKey: boolean;
+    isForeignKey?: boolean;
     /**
      * Mapping from foreign key field names to relation field names
      */
@@ -95,6 +111,21 @@ declare function resolveField(modelMeta: ModelMeta, model: string, field: string
  */
 declare function getFields(modelMeta: ModelMeta, model: string): Record<string, FieldInfo>;
 
+/**
+ * Tries to apply a mutation to a query result.
+ *
+ * @param queryModel the model of the query
+ * @param queryOp the operation of the query
+ * @param queryData the result data of the query
+ * @param mutationModel the model of the mutation
+ * @param mutationOp the operation of the mutation
+ * @param mutationArgs the arguments of the mutation
+ * @param modelMeta the model metadata
+ * @param logging whether to log the mutation application
+ * @returns the updated query data if the mutation is applicable, otherwise undefined
+ */
+declare function applyMutation(queryModel: string, queryOp: string, queryData: any, mutationModel: string, mutationOp: PrismaWriteActionType, mutationArgs: any, modelMeta: ModelMeta, logging: boolean): Promise<any>;
+
 type NestedReadVisitorCallback = {
     field?: (model: string, field: FieldInfo | undefined, kind: 'include' | 'select' | undefined, args: unknown) => void | boolean;
 };
@@ -225,5 +256,6 @@ declare function enumerate<T>(x: Enumerable<T>): T[];
  * Zip two arrays or scalars.
  */
 declare function zip<T1, T2>(x: Enumerable<T1>, y: Enumerable<T2>): Array<[T1, T2]>;
+declare function getIdFields(modelMeta: ModelMeta, model: string, throwIfNotFound?: boolean): FieldInfo[];
 
-export { Enumerable, FieldInfo, MaybePromise, ModelMeta, NestedReadVisitor, NestedReadVisitorCallback, NestedWriteVisitor, NestedWriteVisitorContext, NestedWriterVisitorCallback, PrismaWriteActionType, PrismaWriteActions, RuntimeAttribute, UniqueConstraint, enumerate, getFields, getModelFields, getMutatedModels, getReadModels, resolveField, zip };
+export { Enumerable, FieldInfo, MaybePromise, ModelDataVisitor, ModelDataVisitorCallback, ModelMeta, NestedReadVisitor, NestedReadVisitorCallback, NestedWriteVisitor, NestedWriteVisitorContext, NestedWriterVisitorCallback, PrismaWriteActionType, PrismaWriteActions, RuntimeAttribute, UniqueConstraint, applyMutation, enumerate, getFields, getIdFields, getModelFields, getMutatedModels, getReadModels, resolveField, zip };

package/cross/index.d.ts

@@ -1,3 +1,19 @@
+/**
+ * Callback for @see ModelDataVisitor.
+ */
+type ModelDataVisitorCallback = (model: string, data: any, scalarData: any) => void;
+/**
+ * Visitor that traverses data returned by a Prisma query.
+ */
+declare class ModelDataVisitor {
+    private modelMeta;
+    constructor(modelMeta: ModelMeta);
+    /**
+     * Visits the given model data.
+     */
+    visit(model: string, data: any, callback: ModelDataVisitorCallback): void;
+}
+
 /**
  * Runtime information of a data model or field attribute
  */
@@ -23,23 +39,23 @@ type FieldInfo = {
     /**
      * If the field is an ID field or part of a multi-field ID
      */
-    isId: boolean;
+    isId?: boolean;
     /**
      * If the field type is a data model (or an optional/array of data model)
      */
-    isDataModel: boolean;
+    isDataModel?: boolean;
     /**
      * If the field is an array
      */
-    isArray: boolean;
+    isArray?: boolean;
     /**
      * If the field is optional
      */
-    isOptional: boolean;
+    isOptional?: boolean;
     /**
      * Attributes on the field
      */
-    attributes: RuntimeAttribute[];
+    attributes?: RuntimeAttribute[];
     /**
      * If the field is a relation field, the field name of the reverse side of the relation
      */
@@ -47,11 +63,11 @@ type FieldInfo = {
     /**
      * If the field is the owner side of a relation
      */
-    isRelationOwner: boolean;
+    isRelationOwner?: boolean;
     /**
      * If the field is a foreign key field
      */
-    isForeignKey: boolean;
+    isForeignKey?: boolean;
     /**
      * Mapping from foreign key field names to relation field names
      */
@@ -95,6 +111,21 @@ declare function resolveField(modelMeta: ModelMeta, model: string, field: string
  */
 declare function getFields(modelMeta: ModelMeta, model: string): Record<string, FieldInfo>;
 
+/**
+ * Tries to apply a mutation to a query result.
+ *
+ * @param queryModel the model of the query
+ * @param queryOp the operation of the query
+ * @param queryData the result data of the query
+ * @param mutationModel the model of the mutation
+ * @param mutationOp the operation of the mutation
+ * @param mutationArgs the arguments of the mutation
+ * @param modelMeta the model metadata
+ * @param logging whether to log the mutation application
+ * @returns the updated query data if the mutation is applicable, otherwise undefined
+ */
+declare function applyMutation(queryModel: string, queryOp: string, queryData: any, mutationModel: string, mutationOp: PrismaWriteActionType, mutationArgs: any, modelMeta: ModelMeta, logging: boolean): Promise<any>;
+
 type NestedReadVisitorCallback = {
     field?: (model: string, field: FieldInfo | undefined, kind: 'include' | 'select' | undefined, args: unknown) => void | boolean;
 };
@@ -225,5 +256,6 @@ declare function enumerate<T>(x: Enumerable<T>): T[];
  * Zip two arrays or scalars.
  */
 declare function zip<T1, T2>(x: Enumerable<T1>, y: Enumerable<T2>): Array<[T1, T2]>;
+declare function getIdFields(modelMeta: ModelMeta, model: string, throwIfNotFound?: boolean): FieldInfo[];
 
-export { Enumerable, FieldInfo, MaybePromise, ModelMeta, NestedReadVisitor, NestedReadVisitorCallback, NestedWriteVisitor, NestedWriteVisitorContext, NestedWriterVisitorCallback, PrismaWriteActionType, PrismaWriteActions, RuntimeAttribute, UniqueConstraint, enumerate, getFields, getModelFields, getMutatedModels, getReadModels, resolveField, zip };
+export { Enumerable, FieldInfo, MaybePromise, ModelDataVisitor, ModelDataVisitorCallback, ModelMeta, NestedReadVisitor, NestedReadVisitorCallback, NestedWriteVisitor, NestedWriteVisitorContext, NestedWriterVisitorCallback, PrismaWriteActionType, PrismaWriteActions, RuntimeAttribute, UniqueConstraint, applyMutation, enumerate, getFields, getIdFields, getModelFields, getMutatedModels, getReadModels, resolveField, zip };

package/cross/index.js

@@ -1,10 +1,12 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __defProps = Object.defineProperties;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __propIsEnum = Object.prototype.propertyIsEnumerable;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
@@ -32,6 +34,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var __async = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
@@ -57,11 +67,14 @@ var __async = (__this, __arguments, generator) => {
 // src/cross/index.ts
 var cross_exports = {};
 __export(cross_exports, {
+  ModelDataVisitor: () => ModelDataVisitor,
   NestedReadVisitor: () => NestedReadVisitor,
   NestedWriteVisitor: () => NestedWriteVisitor,
   PrismaWriteActions: () => PrismaWriteActions,
+  applyMutation: () => applyMutation,
   enumerate: () => enumerate,
   getFields: () => getFields,
+  getIdFields: () => getIdFields,
   getModelFields: () => getModelFields,
   getMutatedModels: () => getMutatedModels,
   getReadModels: () => getReadModels,
@@ -70,6 +83,37 @@ __export(cross_exports, {
 });
 module.exports = __toCommonJS(cross_exports);
 
+// src/cross/model-data-visitor.ts
+var ModelDataVisitor = class {
+  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 = 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: model2, data: data2 }) => this.visit(model2, data2, callback));
+  }
+};
+
 // src/cross/model-meta.ts
 var import_lower_case_first = require("lower-case-first");
 function resolveField(modelMeta, model, field) {
@@ -80,6 +124,177 @@ function getFields(modelMeta, model) {
   return modelMeta.fields[(0, import_lower_case_first.lowerCaseFirst)(model)];
 }
 
+// src/cross/mutator.ts
+var import_uuid = require("uuid");
+var import_deepcopy = __toESM(require("deepcopy"));
+function applyMutation(queryModel, queryOp, queryData, mutationModel, mutationOp, mutationArgs, modelMeta, logging) {
+  return __async(this, null, function* () {
+    if (["count", "aggregate", "groupBy"].includes(queryOp)) {
+      return void 0;
+    }
+    let resultData = queryData;
+    let updated = false;
+    const visitor = new NestedWriteVisitor(modelMeta, {
+      create: (model, args) => {
+        if (model === queryModel) {
+          const r = createMutate(queryModel, queryOp, resultData, args, modelMeta, logging);
+          if (r) {
+            resultData = r;
+            updated = true;
+          }
+        }
+      },
+      createMany: (model, args) => {
+        if (model === queryModel && (args == null ? void 0 : args.data)) {
+          for (const oneArg of enumerate(args.data)) {
+            const r = createMutate(queryModel, queryOp, resultData, oneArg, modelMeta, logging);
+            if (r) {
+              resultData = r;
+              updated = true;
+            }
+          }
+        }
+      },
+      update: (model, args) => {
+        const r = updateMutate(queryModel, resultData, model, args, modelMeta, logging);
+        if (r) {
+          resultData = r;
+          updated = true;
+        }
+      },
+      delete: (model, args) => {
+        const r = deleteMutate(queryModel, resultData, model, args, modelMeta, logging);
+        if (r) {
+          resultData = r;
+          updated = true;
+        }
+      }
+    });
+    yield visitor.visit(mutationModel, mutationOp, mutationArgs);
+    return updated ? resultData : void 0;
+  });
+}
+function createMutate(queryModel, queryOp, currentData, newData, modelMeta, logging) {
+  if (!newData) {
+    return void 0;
+  }
+  if (queryOp !== "findMany") {
+    return void 0;
+  }
+  const modelFields = getFields(modelMeta, queryModel);
+  if (!modelFields) {
+    return void 0;
+  }
+  const insert = {};
+  const newDataFields = Object.keys(newData);
+  Object.entries(modelFields).forEach(([name, field]) => {
+    var _a, _b, _c, _d;
+    if (field.isDataModel) {
+      return;
+    }
+    if (newDataFields.includes(name)) {
+      insert[name] = newData[name];
+    } else {
+      const defaultAttr = (_a = field.attributes) == null ? void 0 : _a.find((attr) => attr.name === "@default");
+      if (field.type === "DateTime") {
+        if (defaultAttr || ((_b = field.attributes) == null ? void 0 : _b.some((attr) => attr.name === "@updatedAt"))) {
+          insert[name] = /* @__PURE__ */ new Date();
+        }
+      } else if (((_d = (_c = defaultAttr == null ? void 0 : defaultAttr.args) == null ? void 0 : _c[0]) == null ? void 0 : _d.value) !== void 0) {
+        insert[name] = defaultAttr.args[0].value;
+      }
+    }
+  });
+  const idFields = getIdFields(modelMeta, queryModel, false);
+  idFields.forEach((f) => {
+    if (insert[f.name] === void 0) {
+      if (f.type === "Int" || f.type === "BigInt") {
+        const currMax = Math.max(
+          ...[...currentData].map((item) => {
+            const idv = parseInt(item[f.name]);
+            return isNaN(idv) ? 0 : idv;
+          })
+        );
+        insert[f.name] = currMax + 1;
+      } else {
+        insert[f.name] = (0, import_uuid.v4)();
+      }
+    }
+  });
+  insert.$optimistic = true;
+  if (logging) {
+    console.log(`Optimistic create for ${queryModel}:`, insert);
+  }
+  return [insert, ...currentData];
+}
+function updateMutate(queryModel, currentData, mutateModel, mutateArgs, modelMeta, logging) {
+  if (!currentData) {
+    return void 0;
+  }
+  if (!(mutateArgs == null ? void 0 : mutateArgs.where) || !(mutateArgs == null ? void 0 : mutateArgs.data)) {
+    return void 0;
+  }
+  let updated = false;
+  for (const item of enumerate(currentData)) {
+    const visitor = new ModelDataVisitor(modelMeta);
+    visitor.visit(queryModel, item, (model, _data, scalarData) => {
+      if (model === mutateModel && idFieldsMatch(model, scalarData, mutateArgs.where, modelMeta)) {
+        Object.keys(item).forEach((k) => {
+          if (mutateArgs.data[k] !== void 0) {
+            item[k] = mutateArgs.data[k];
+          }
+        });
+        item.$optimistic = true;
+        updated = true;
+        if (logging) {
+          console.log(`Optimistic update for ${queryModel}:`, item);
+        }
+      }
+    });
+  }
+  return updated ? (0, import_deepcopy.default)(currentData) : void 0;
+}
+function deleteMutate(queryModel, currentData, mutateModel, mutateArgs, modelMeta, logging) {
+  if (!currentData || !mutateArgs) {
+    return void 0;
+  }
+  if (queryModel !== mutateModel) {
+    return void 0;
+  }
+  let updated = false;
+  let result = currentData;
+  if (Array.isArray(currentData)) {
+    for (const item of currentData) {
+      if (idFieldsMatch(mutateModel, item, mutateArgs, modelMeta)) {
+        result = result.filter((x) => x !== item);
+        updated = true;
+        if (logging) {
+          console.log(`Optimistic delete for ${queryModel}:`, item);
+        }
+      }
+    }
+  } else {
+    if (idFieldsMatch(mutateModel, currentData, mutateArgs, modelMeta)) {
+      result = null;
+      updated = true;
+      if (logging) {
+        console.log(`Optimistic delete for ${queryModel}:`, currentData);
+      }
+    }
+  }
+  return updated ? result : void 0;
+}
+function idFieldsMatch(model, x, y, modelMeta) {
+  if (!x || !y || typeof x !== "object" || typeof y !== "object") {
+    return false;
+  }
+  const idFields = getIdFields(modelMeta, model, false);
+  if (idFields.length === 0) {
+    return false;
+  }
+  return idFields.every((f) => x[f.name] === y[f.name]);
+}
+
 // src/cross/nested-read-visitor.ts
 var NestedReadVisitor = class {
   constructor(modelMeta, callback) {
@@ -139,6 +354,7 @@ var PrismaWriteActions = [
 ];
 
 // src/cross/utils.ts
+var import_lower_case_first2 = require("lower-case-first");
 function getModelFields(data) {
   return data ? Object.keys(data) : [];
 }
@@ -167,6 +383,21 @@ function zip(x, y) {
     return [[x, y]];
   }
 }
+function getIdFields(modelMeta, model, throwIfNotFound = false) {
+  let fields = modelMeta.fields[(0, import_lower_case_first2.lowerCaseFirst)(model)];
+  if (!fields) {
+    if (throwIfNotFound) {
+      throw new Error(`Unable to load fields for ${model}`);
+    } else {
+      fields = {};
+    }
+  }
+  const result = Object.values(fields).filter((f) => f.isId);
+  if (result.length === 0 && throwIfNotFound) {
+    throw new Error(`model ${model} does not have an id field`);
+  }
+  return result;
+}
 
 // src/cross/nested-write-visitor.ts
 var NestedWriteVisitor = class {
@@ -385,7 +616,7 @@ var NestedWriteVisitor = class {
 };
 
 // src/cross/query-analyzer.ts
-var import_lower_case_first2 = require("lower-case-first");
+var import_lower_case_first3 = require("lower-case-first");
 function getReadModels(model, modelMeta, args) {
   const result = /* @__PURE__ */ new Set();
   result.add(model);
@@ -439,7 +670,7 @@ function collectDeleteCascades(model, modelMeta, result, visited) {
     return;
   }
   visited.add(model);
-  const cascades = modelMeta.deleteCascade[(0, import_lower_case_first2.lowerCaseFirst)(model)];
+  const cascades = modelMeta.deleteCascade[(0, import_lower_case_first3.lowerCaseFirst)(model)];
   if (!cascades) {
     return;
   }
@@ -450,11 +681,14 @@ function collectDeleteCascades(model, modelMeta, result, visited) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ModelDataVisitor,
   NestedReadVisitor,
   NestedWriteVisitor,
   PrismaWriteActions,
+  applyMutation,
   enumerate,
   getFields,
+  getIdFields,
   getModelFields,
   getMutatedModels,
   getReadModels,