@clipboard-health/contract-core 0.1.1 → 0.2.0

package/README.md

@@ -1,11 +1,12 @@
 # @clipboard-health/contract-core <!-- omit from toc -->
 
-Core schemas for Clipboard Health's API contracts.
+Shared Zod schemas for Clipboard Health's contracts.
 
 ## Table of contents <!-- omit from toc -->
 
 - [Install](#install)
 - [Usage](#usage)
+  - [Zod schemas](#zod-schemas)
 - [Local development commands](#local-development-commands)
 
 ## Install
@@ -16,6 +17,59 @@ npm install @clipboard-health/contract-core
 
 ## Usage
 
+### Zod schemas
+
+<!-- prettier-ignore -->
+```ts
+// ./examples/schemas.ts
+
+import { apiErrors, booleanString, nonEmptyString, uuid } from "@clipboard-health/contract-core";
+import { type ZodError } from "zod";
+
+function logError(error: unknown) {
+  console.error((error as ZodError).issues[0]!.message);
+}
+
+apiErrors.parse({
+  errors: [
+    {
+      code: "NotFound",
+      detail: "Resource 'b146a790-9ed1-499f-966d-6c4905dc667f' not found",
+      id: "6191a8a0-96ff-4d4b-8e0f-746a5ab215f9",
+      status: "404",
+      title: "Not Found",
+    },
+  ],
+});
+
+booleanString.parse("true");
+
+try {
+  booleanString.parse("invalid");
+} catch (error) {
+  logError(error);
+  // => Invalid enum value. Expected 'true' | 'false', received 'invalid'
+}
+
+nonEmptyString.parse("hello");
+try {
+  nonEmptyString.parse("");
+} catch (error) {
+  logError(error);
+  // => String must contain at least 1 character(s)
+}
+
+// UUID validation examples
+uuid.parse("b8d617bb-edef-4262-a6e3-6cc807fa1b26");
+try {
+  uuid.parse("invalid");
+} catch (error) {
+  logError(error);
+  // => Invalid UUID format
+}
+
+```
+
 ## Local development commands
 
 See [`package.json`](./package.json) `scripts` for a list of commands.

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@clipboard-health/contract-core",
-  "description": "Core schemas for Clipboard Health's API contracts.",
-  "version": "0.1.1",
+  "description": "Shared Zod schemas for Clipboard Health's contracts.",
+  "version": "0.2.0",
   "dependencies": {
     "tslib": "2.8.0",
     "zod": "3.23.8"
   },
   "devDependencies": {
-    "@clipboard-health/testing-core": "0.1.1"
+    "@clipboard-health/testing-core": "0.2.0"
   },
   "keywords": [],
   "license": "MIT",
@@ -15,6 +15,9 @@
   "publishConfig": {
     "access": "public"
   },
+  "scripts": {
+    "embed": "embedme README.md"
+  },
   "type": "commonjs",
   "typings": "./src/index.d.ts",
   "types": "./src/index.d.ts"

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

@@ -2,7 +2,7 @@ import { z } from "zod";
 /**
  * @see {@link https://jsonapi.org/format/#error-objects Error Objects}
  */
-declare const apiError: z.ZodObject<{
+export declare const apiError: z.ZodObject<{
     code: z.ZodString;
     detail: z.ZodOptional<z.ZodString>;
     id: z.ZodString;
@@ -65,4 +65,3 @@ export declare const apiErrors: z.ZodObject<{
  * @see {@link https://jsonapi.org/format/#error-objects Error Objects}
  */
 export type ApiError = z.infer<typeof apiError>;
-export {};

package/src/lib/schemas/apiError.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.apiErrors = void 0;
+exports.apiErrors = exports.apiError = void 0;
 const zod_1 = require("zod");
 const nonEmptyString_1 = require("./nonEmptyString");
 /**
  * @see {@link https://jsonapi.org/format/#error-objects Error Objects}
  */
-const apiError = zod_1.z.object({
+exports.apiError = zod_1.z.object({
     code: nonEmptyString_1.nonEmptyString,
     detail: zod_1.z.string().optional(),
     id: nonEmptyString_1.nonEmptyString,
@@ -17,6 +17,6 @@ const apiError = zod_1.z.object({
  * @see {@link https://jsonapi.org/format/#errors Errors}
  */
 exports.apiErrors = zod_1.z.object({
-    errors: apiError.array().min(0).max(100),
+    errors: exports.apiError.array().min(0).max(100),
 });
 //# sourceMappingURL=apiError.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"apiError.js","sourceRoot":"","sources":["../../../../../../packages/contract-core/src/lib/schemas/apiError.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,qDAAkD;AAElD;;GAEG;AACH,MAAM,QAAQ,GAAG,OAAC,CAAC,MAAM,CAAC;IACxB,IAAI,EAAE,+BAAc;IACpB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,EAAE,EAAE,+BAAc;IAClB,MAAM,EAAE,+BAAc;IACtB,KAAK,EAAE,+BAAc;CACtB,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,SAAS,GAAG,OAAC,CAAC,MAAM,CAAC;IAChC,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;CACzC,CAAC,CAAC"}
+{"version":3,"file":"apiError.js","sourceRoot":"","sources":["../../../../../../packages/contract-core/src/lib/schemas/apiError.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,qDAAkD;AAElD;;GAEG;AACU,QAAA,QAAQ,GAAG,OAAC,CAAC,MAAM,CAAC;IAC/B,IAAI,EAAE,+BAAc;IACpB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,EAAE,EAAE,+BAAc;IAClB,MAAM,EAAE,+BAAc;IACtB,KAAK,EAAE,+BAAc;CACtB,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,SAAS,GAAG,OAAC,CAAC,MAAM,CAAC;IAChC,MAAM,EAAE,gBAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;CACzC,CAAC,CAAC"}

package/src/lib/schemas/uuid.js

@@ -10,5 +10,7 @@ exports.uuid = zod_1.z
     .string()
     .trim()
     // eslint-disable-next-line unicorn/better-regex
-    .regex(/^[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$/i);
+    .regex(/^[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$/i, {
+    message: "Invalid UUID format",
+});
 //# sourceMappingURL=uuid.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"uuid.js","sourceRoot":"","sources":["../../../../../../packages/contract-core/src/lib/schemas/uuid.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB;;;GAGG;AACU,QAAA,IAAI,GAAG,OAAC;KAClB,MAAM,EAAE;KACR,IAAI,EAAE;IACP,gDAAgD;KAC/C,KAAK,CAAC,iEAAiE,CAAC,CAAC"}
+{"version":3,"file":"uuid.js","sourceRoot":"","sources":["../../../../../../packages/contract-core/src/lib/schemas/uuid.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB;;;GAGG;AACU,QAAA,IAAI,GAAG,OAAC;KAClB,MAAM,EAAE;KACR,IAAI,EAAE;IACP,gDAAgD;KAC/C,KAAK,CAAC,iEAAiE,EAAE;IACxE,OAAO,EAAE,qBAAqB;CAC/B,CAAC,CAAC"}