@clipboard-health/contract-core 1.5.11 → 1.5.12

package/README.md

@@ -22,8 +22,15 @@ npm install @clipboard-health/contract-core
 <embedex source="packages/contract-core/examples/schemas.ts">
 
 ```ts
-import { apiErrors, booleanString, nonEmptyString, uuid } from "@clipboard-health/contract-core";
-import { type ZodError } from "zod";
+import {
+  apiErrors,
+  booleanString,
+  nonEmptyString,
+  optionalEnumWithFallback,
+  requiredEnumWithFallback,
+  uuid,
+} from "@clipboard-health/contract-core";
+import { type z, type ZodError } from "zod";
 
 function logError(error: unknown) {
   console.error((error as ZodError).issues[0]!.message);
@@ -66,6 +73,52 @@ try {
   logError(error);
   // => Invalid UUID format
 }
+
+// Enum with fallback examples
+/* -- required -- */
+const requiredStatusEnumSchema = requiredEnumWithFallback(
+  ["unspecified", "pending", "completed", "failed"],
+  "unspecified",
+);
+// type RequiredStatusEnum = "unspecified" | "pending" | "completed" | "failed"
+type RequiredStatusEnum = z.infer<typeof requiredStatusEnumSchema>;
+
+const completedStatus: RequiredStatusEnum = requiredStatusEnumSchema.parse("completed");
+// => "completed"
+console.log(completedStatus);
+
+const additionalStatus = requiredStatusEnumSchema.parse("additional");
+// => "unspecified"
+console.log(additionalStatus);
+
+try {
+  // eslint-disable-next-line unicorn/no-useless-undefined
+  requiredStatusEnumSchema.parse(undefined);
+} catch (error) {
+  logError(error);
+  // => Validation error
+}
+
+/* -- optional -- */
+const optionalStatusEnumSchema = optionalEnumWithFallback(
+  ["unspecified", "pending", "completed", "failed"],
+  "unspecified",
+);
+// type OptionalStatusEnum = "unspecified" | "pending" | "completed" | "failed" | undefined
+type OptionalStatusEnum = z.infer<typeof optionalStatusEnumSchema>;
+
+const failedStatus: OptionalStatusEnum = optionalStatusEnumSchema.parse("failed");
+// => "failed"
+console.log(failedStatus);
+
+const extraStatus = optionalStatusEnumSchema.parse("extra");
+// => "unspecified"
+console.log(extraStatus);
+
+// eslint-disable-next-line unicorn/no-useless-undefined
+const undefinedStatus = optionalStatusEnumSchema.parse(undefined);
+// => undefined
+console.log(undefinedStatus);
 ```
 
 </embedex>

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@clipboard-health/contract-core",
   "description": "Shared Zod schemas for Clipboard's contracts.",
-  "version": "1.5.11",
+  "version": "1.5.12",
   "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
   "dependencies": {
     "tslib": "2.8.1"
   },
   "devDependencies": {
-    "@clipboard-health/testing-core": "1.5.11",
+    "@clipboard-health/testing-core": "1.5.12",
     "zod": "3.25.76"
   },
   "keywords": [

package/src/lib/schemas/enum.d.ts

@@ -0,0 +1,8 @@
+import { z } from "zod";
+type EnumValues = [string, ...string[]];
+export declare function enumWithFallback<const V extends EnumValues, const F extends V[number]>(values: V, fallback: F, options: {
+    optional: true;
+}): z.ZodEffects<z.ZodOptional<z.ZodEnum<V>>, V[number] | undefined, unknown>;
+export declare const optionalEnumWithFallback: <const V extends EnumValues, const F extends V[number]>(values: V, fallback: F) => z.ZodEffects<z.ZodOptional<z.ZodEnum<V>>, V[number] | undefined, unknown>;
+export declare const requiredEnumWithFallback: <const V extends EnumValues, const F extends V[number]>(values: V, fallback: F) => z.ZodEffects<z.ZodEnum<V>, V[number], unknown>;
+export {};

package/src/lib/schemas/enum.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requiredEnumWithFallback = exports.optionalEnumWithFallback = void 0;
+exports.enumWithFallback = enumWithFallback;
+const zod_1 = require("zod");
+function enumWithFallback(values, fallback, options = {}) {
+    const Enum = zod_1.z.enum(values);
+    const optional = options.optional ?? false;
+    const schema = optional ? Enum.optional() : Enum;
+    return zod_1.z.preprocess((value) => {
+        if (value === undefined) {
+            return optional ? undefined : value;
+        }
+        return Enum.safeParse(value).success ? value : fallback;
+    }, schema);
+}
+const optionalEnumWithFallback = (values, fallback) => enumWithFallback(values, fallback, { optional: true });
+exports.optionalEnumWithFallback = optionalEnumWithFallback;
+const requiredEnumWithFallback = (values, fallback) => enumWithFallback(values, fallback, { optional: false });
+exports.requiredEnumWithFallback = requiredEnumWithFallback;
+//# sourceMappingURL=enum.js.map

package/src/lib/schemas/enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../../../../../packages/contract-core/src/lib/schemas/enum.ts"],"names":[],"mappings":";;;AAwBA,4CAeC;AAvCD,6BAAwB;AAwBxB,SAAgB,gBAAgB,CAC9B,MAAS,EACT,QAAW,EACX,UAAkC,EAAE;IAEpC,MAAM,IAAI,GAAG,OAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAC;IAC3C,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAEjD,OAAO,OAAC,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;QACtC,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC1D,CAAC,EAAE,MAAM,CAAC,CAAC;AACb,CAAC;AAEM,MAAM,wBAAwB,GAAG,CACtC,MAAS,EACT,QAAW,EACX,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;AAH/C,QAAA,wBAAwB,4BAGuB;AAErD,MAAM,wBAAwB,GAAG,CACtC,MAAS,EACT,QAAW,EACX,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;AAHhD,QAAA,wBAAwB,4BAGwB"}

package/src/lib/schemas/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./apiError";
 export * from "./booleanString";
+export * from "./enum";
 export * from "./money";
 export * from "./nonEmptyString";
 export * from "./objectId";

package/src/lib/schemas/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./apiError"), exports);
 tslib_1.__exportStar(require("./booleanString"), exports);
+tslib_1.__exportStar(require("./enum"), exports);
 tslib_1.__exportStar(require("./money"), exports);
 tslib_1.__exportStar(require("./nonEmptyString"), exports);
 tslib_1.__exportStar(require("./objectId"), exports);

package/src/lib/schemas/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/contract-core/src/lib/schemas/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,0DAAgC;AAChC,kDAAwB;AACxB,2DAAiC;AACjC,qDAA2B;AAC3B,iDAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/contract-core/src/lib/schemas/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,0DAAgC;AAChC,iDAAuB;AACvB,kDAAwB;AACxB,2DAAiC;AACjC,qDAA2B;AAC3B,iDAAuB"}