@zenstackhq/runtime 2.6.1 → 2.6.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zenstackhq/runtime",
   "displayName": "ZenStack Runtime Library",
-  "version": "2.6.1",
+  "version": "2.6.2",
   "description": "Runtime of ZenStack for both client-side and server-side environments.",
   "repository": {
     "type": "git",
@@ -69,6 +69,10 @@
     "./models": {
       "types": "./models.d.ts"
     },
+    "./zod-utils": {
+      "types": "./zod-utils.d.ts",
+      "default": "./zod-utils.js"
+    },
     "./package.json": {
       "default": "./package.json"
     }
@@ -100,7 +104,7 @@
     "zod-validation-error": "^1.5.0"
   },
   "peerDependencies": {
-    "@prisma/client": "5.0.0 - 5.19.x"
+    "@prisma/client": "5.0.0 - 5.20.x"
   },
   "author": {
     "name": "ZenStack Team"

package/zod-utils.d.ts

@@ -0,0 +1,11 @@
+import { z as Z } from 'zod';
+/**
+ * A smarter version of `z.union` that decide which candidate to use based on how few unrecognized keys it has.
+ *
+ * The helper is used to deal with ambiguity in union generated for Prisma inputs when the zod schemas are configured
+ * to run in "strip" object parsing mode. Since "strip" automatically drops unrecognized keys, it may result in
+ * accidentally matching a less-ideal schema candidate.
+ *
+ * The helper uses a custom schema to find the candidate that results in the fewest unrecognized keys when parsing the data.
+ */
+export declare function smartUnion(z: typeof Z, candidates: Z.ZodSchema[]): Z.ZodUnion<any> | Z.ZodEffects<Z.ZodType<unknown, Z.ZodTypeDef, unknown>, any, unknown>;

package/zod-utils.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.smartUnion = smartUnion;
+/**
+ * A smarter version of `z.union` that decide which candidate to use based on how few unrecognized keys it has.
+ *
+ * The helper is used to deal with ambiguity in union generated for Prisma inputs when the zod schemas are configured
+ * to run in "strip" object parsing mode. Since "strip" automatically drops unrecognized keys, it may result in
+ * accidentally matching a less-ideal schema candidate.
+ *
+ * The helper uses a custom schema to find the candidate that results in the fewest unrecognized keys when parsing the data.
+ */
+function smartUnion(z, candidates) {
+    // strip `z.lazy`
+    const processedCandidates = candidates.map((candidate) => unwrapLazy(z, candidate));
+    if (processedCandidates.some((c) => !(c instanceof z.ZodObject || c instanceof z.ZodArray))) {
+        // fall back to plain union if not all candidates are objects or arrays
+        return z.union(candidates);
+    }
+    let resultData;
+    return z
+        .custom((data) => {
+        if (Array.isArray(data)) {
+            const { data: result, success } = smartArrayUnion(z, processedCandidates.filter((c) => c instanceof z.ZodArray), data);
+            if (success) {
+                resultData = result;
+            }
+            return success;
+        }
+        else {
+            const { data: result, success } = smartObjectUnion(z, processedCandidates.filter((c) => c instanceof z.ZodObject), data);
+            if (success) {
+                resultData = result;
+            }
+            return success;
+        }
+    })
+        .transform(() => {
+        // return the parsed data
+        return resultData;
+    });
+}
+function smartArrayUnion(z, candidates, data) {
+    if (candidates.length === 0) {
+        return { data: undefined, success: false };
+    }
+    if (!Array.isArray(data)) {
+        return { data: undefined, success: false };
+    }
+    if (data.length === 0) {
+        return { data, success: true };
+    }
+    // use the first element to identify the candidate schema to use
+    const item = data[0];
+    const itemSchema = identifyCandidate(z, candidates.map((candidate) => candidate.element), item);
+    // find the matching schema and re-parse the data
+    const schema = candidates.find((candidate) => candidate.element === itemSchema);
+    return schema.safeParse(data);
+}
+function smartObjectUnion(z, candidates, data) {
+    if (candidates.length === 0) {
+        return { data: undefined, success: false };
+    }
+    const schema = identifyCandidate(z, candidates, data);
+    return schema.safeParse(data);
+}
+function identifyCandidate(z, candidates, data) {
+    const strictResults = candidates.map((candidate) => {
+        // make sure to strip `z.lazy` before parsing
+        const unwrapped = unwrapLazy(z, candidate);
+        return {
+            schema: candidate,
+            // force object schema to run in strict mode to capture unrecognized keys
+            result: unwrapped.strict().safeParse(data),
+        };
+    });
+    // find the schema with the fewest unrecognized keys
+    const { schema } = strictResults.sort((a, b) => {
+        var _a, _b, _c, _d;
+        const aCount = countUnrecognizedKeys((_b = (_a = a.result.error) === null || _a === void 0 ? void 0 : _a.issues) !== null && _b !== void 0 ? _b : []);
+        const bCount = countUnrecognizedKeys((_d = (_c = b.result.error) === null || _c === void 0 ? void 0 : _c.issues) !== null && _d !== void 0 ? _d : []);
+        return aCount - bCount;
+    })[0];
+    return schema;
+}
+function countUnrecognizedKeys(issues) {
+    return issues
+        .filter((issue) => issue.code === 'unrecognized_keys')
+        .map((issue) => issue.keys.length)
+        .reduce((a, b) => a + b, 0);
+}
+function unwrapLazy(z, schema) {
+    return schema instanceof z.ZodLazy ? schema.schema : schema;
+}
+//# sourceMappingURL=zod-utils.js.map

package/zod-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zod-utils.js","sourceRoot":"","sources":["../src/zod-utils.ts"],"names":[],"mappings":";;AAYA,gCAuCC;AAhDD;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAC,CAAW,EAAE,UAAyB;IAC7D,iBAAiB;IACjB,MAAM,mBAAmB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;IAEpF,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,SAAS,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;QAC1F,uEAAuE;QACvE,OAAO,CAAC,CAAC,KAAK,CAAC,UAAiB,CAAC,CAAC;IACtC,CAAC;IAED,IAAI,UAAe,CAAC;IAEpB,OAAO,CAAC;SACH,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,CAC7C,CAAC,EACD,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,EAC1D,IAAI,CACP,CAAC;YACF,IAAI,OAAO,EAAE,CAAC;gBACV,UAAU,GAAG,MAAM,CAAC;YACxB,CAAC;YACD,OAAO,OAAO,CAAC;QACnB,CAAC;aAAM,CAAC;YACJ,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,gBAAgB,CAC9C,CAAC,EACD,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,EAC3D,IAAI,CACP,CAAC;YACF,IAAI,OAAO,EAAE,CAAC;gBACV,UAAU,GAAG,MAAM,CAAC;YACxB,CAAC;YACD,OAAO,OAAO,CAAC;QACnB,CAAC;IACL,CAAC,CAAC;SACD,SAAS,CAAC,GAAG,EAAE;QACZ,yBAAyB;QACzB,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC,CAAC;AACX,CAAC;AAED,SAAS,eAAe,CAAC,CAAW,EAAE,UAAyD,EAAE,IAAS;IACtG,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC/C,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC/C,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACnC,CAAC;IAED,gEAAgE;IAChE,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACrB,MAAM,UAAU,GAAG,iBAAiB,CAChC,CAAC,EACD,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,EAChD,IAAI,CACP,CAAC;IAEF,iDAAiD;IACjD,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC;IAChF,OAAO,MAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,gBAAgB,CAAC,CAAW,EAAE,UAAwC,EAAE,IAAS;IACtF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC/C,CAAC;IACD,MAAM,MAAM,GAAG,iBAAiB,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;IACtD,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,iBAAiB,CACtB,CAAW,EACX,UAAqF,EACrF,IAAS;IAET,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;QAC/C,6CAA6C;QAC7C,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QAC3C,OAAO;YACH,MAAM,EAAE,SAAS;YACjB,yEAAyE;YACzE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC;SAC7C,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,oDAAoD;IACpD,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;;QAC3C,MAAM,MAAM,GAAG,qBAAqB,CAAC,MAAA,MAAA,CAAC,CAAC,MAAM,CAAC,KAAK,0CAAE,MAAM,mCAAI,EAAE,CAAC,CAAC;QACnE,MAAM,MAAM,GAAG,qBAAqB,CAAC,MAAA,MAAA,CAAC,CAAC,MAAM,CAAC,KAAK,0CAAE,MAAM,mCAAI,EAAE,CAAC,CAAC;QACnE,OAAO,MAAM,GAAG,MAAM,CAAC;IAC3B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACN,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,SAAS,qBAAqB,CAAC,MAAoB;IAC/C,OAAO,MAAM;SACR,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,mBAAmB,CAAC;SACrD,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;SACjC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,UAAU,CAAwB,CAAW,EAAE,MAAwB;IAC5E,OAAO,MAAM,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;AAChE,CAAC"}