@clipboard-health/contract-core 0.1.0

package/README.md

@@ -0,0 +1,21 @@
+# @clipboard-health/contract-core <!-- omit from toc -->
+
+Core schemas for Clipboard Health's API contracts.
+
+## Table of contents <!-- omit from toc -->
+
+- [Install](#install)
+- [Usage](#usage)
+- [Local development commands](#local-development-commands)
+
+## Install
+
+```bash
+npm install @clipboard-health/contract-core
+```
+
+## Usage
+
+## Local development commands
+
+See [`package.json`](./package.json) `scripts` for a list of commands.

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@clipboard-health/contract-core",
+  "description": "Core schemas for Clipboard Health's API contracts.",
+  "version": "0.1.0",
+  "dependencies": {
+    "tslib": "2.8.0",
+    "zod": "3.23.8"
+  },
+  "devDependencies": {
+    "@clipboard-health/testing-core": "0.1.0"
+  },
+  "keywords": [],
+  "license": "MIT",
+  "main": "./src/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "typings": "./src/index.d.ts",
+  "types": "./src/index.d.ts"
+}

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./lib/schemas";

package/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/schemas"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/contract-core/src/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B"}

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

@@ -0,0 +1,68 @@
+import { z } from "zod";
+/**
+ * @see {@link https://jsonapi.org/format/#error-objects Error Objects}
+ */
+declare const apiError: z.ZodObject<{
+    code: z.ZodString;
+    detail: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    status: z.ZodString;
+    title: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    code: string;
+    id: string;
+    status: string;
+    title: string;
+    detail?: string | undefined;
+}, {
+    code: string;
+    id: string;
+    status: string;
+    title: string;
+    detail?: string | undefined;
+}>;
+/**
+ * @see {@link https://jsonapi.org/format/#errors Errors}
+ */
+export declare const apiErrors: z.ZodObject<{
+    errors: z.ZodArray<z.ZodObject<{
+        code: z.ZodString;
+        detail: z.ZodOptional<z.ZodString>;
+        id: z.ZodString;
+        status: z.ZodString;
+        title: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        id: string;
+        status: string;
+        title: string;
+        detail?: string | undefined;
+    }, {
+        code: string;
+        id: string;
+        status: string;
+        title: string;
+        detail?: string | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    errors: {
+        code: string;
+        id: string;
+        status: string;
+        title: string;
+        detail?: string | undefined;
+    }[];
+}, {
+    errors: {
+        code: string;
+        id: string;
+        status: string;
+        title: string;
+        detail?: string | undefined;
+    }[];
+}>;
+/**
+ * @see {@link https://jsonapi.org/format/#error-objects Error Objects}
+ */
+export type ApiError = z.infer<typeof apiError>;
+export {};

package/src/lib/schemas/apiError.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiErrors = 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({
+    code: nonEmptyString_1.nonEmptyString,
+    detail: zod_1.z.string().optional(),
+    id: nonEmptyString_1.nonEmptyString,
+    status: nonEmptyString_1.nonEmptyString,
+    title: nonEmptyString_1.nonEmptyString,
+});
+/**
+ * @see {@link https://jsonapi.org/format/#errors Errors}
+ */
+exports.apiErrors = zod_1.z.object({
+    errors: apiError.array().min(0).max(100),
+});
+//# sourceMappingURL=apiError.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,10 @@
+import { z } from "zod";
+/**
+ * A Zod schema for use with boolean query parameters since `z.coerce.boolean()` treats any truthy
+ * value as `true`.
+ *
+ * `.transform((value) => value === "true")` causes inference issues in controllers.
+ */
+export declare const booleanString: z.ZodEnum<["true", "false"]>;
+export type BooleanString = z.infer<typeof booleanString>;
+export declare function toBoolean(value: BooleanString): boolean;

package/src/lib/schemas/booleanString.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.booleanString = void 0;
+exports.toBoolean = toBoolean;
+const zod_1 = require("zod");
+/**
+ * A Zod schema for use with boolean query parameters since `z.coerce.boolean()` treats any truthy
+ * value as `true`.
+ *
+ * `.transform((value) => value === "true")` causes inference issues in controllers.
+ */
+exports.booleanString = zod_1.z.enum(["true", "false"]);
+function toBoolean(value) {
+    return value === "true";
+}
+//# sourceMappingURL=booleanString.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"booleanString.js","sourceRoot":"","sources":["../../../../../../packages/contract-core/src/lib/schemas/booleanString.ts"],"names":[],"mappings":";;;AAYA,8BAEC;AAdD,6BAAwB;AAExB;;;;;GAKG;AACU,QAAA,aAAa,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAIvD,SAAgB,SAAS,CAAC,KAAoB;IAC5C,OAAO,KAAK,KAAK,MAAM,CAAC;AAC1B,CAAC"}

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

@@ -0,0 +1,4 @@
+export * from "./apiError";
+export * from "./booleanString";
+export * from "./nonEmptyString";
+export * from "./uuid";

package/src/lib/schemas/index.js

@@ -0,0 +1,8 @@
+"use strict";
+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("./nonEmptyString"), exports);
+tslib_1.__exportStar(require("./uuid"), exports);
+//# sourceMappingURL=index.js.map

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

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

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

@@ -0,0 +1,5 @@
+import { z } from "zod";
+/**
+ * A non-empty string Zod schema.
+ */
+export declare const nonEmptyString: z.ZodString;

package/src/lib/schemas/nonEmptyString.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nonEmptyString = void 0;
+const zod_1 = require("zod");
+/**
+ * A non-empty string Zod schema.
+ */
+exports.nonEmptyString = zod_1.z.string().min(1);
+//# sourceMappingURL=nonEmptyString.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"nonEmptyString.js","sourceRoot":"","sources":["../../../../../../packages/contract-core/src/lib/schemas/nonEmptyString.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB;;GAEG;AACU,QAAA,cAAc,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC"}

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

@@ -0,0 +1,6 @@
+import { z } from "zod";
+/**
+ * Regular expressions from
+ * {@link https://github.com/nestjs/nest/blob/master/packages/common/pipes/parse-uuid.pipe.ts}.
+ */
+export declare const uuid: z.ZodString;

package/src/lib/schemas/uuid.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uuid = void 0;
+const zod_1 = require("zod");
+/**
+ * Regular expressions from
+ * {@link https://github.com/nestjs/nest/blob/master/packages/common/pipes/parse-uuid.pipe.ts}.
+ */
+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);
+//# sourceMappingURL=uuid.js.map

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

@@ -0,0 +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"}