@centricare/contract 0.0.0-stage → 0.1.1

package/README.md

@@ -1,3 +1,100 @@
-# Temporary Holding Version
+# @centricare/contract
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Standardized Zod schemas used across CentriCare projects. This package provides shared validation schemas and inferred TypeScript types for data entities (e.g. User, Settings) and common primitives (e.g. CodedConcept, timestamp, API response envelope), ensuring consistent data shapes and validation rules across all CentriCare services.
+
+## Installation
+
+```bash
+npm install @centricare/contract
+# or
+yarn add @centricare/contract
+# or
+pnpm add @centricare/contract
+```
+
+## Usage
+
+```ts
+import { userSchema, User } from "@centricare/contract";
+
+// Validate incoming data
+const result = userSchema.safeParse(req.body);
+
+if (!result.success) {
+  return res.status(400).json({ errors: result.error.flatten() });
+}
+
+const user: User = result.data;
+```
+
+## Schemas
+
+| Schema                | File                            | Description                                                              |
+| --------------------- | ------------------------------- | ------------------------------------------------------------------------ |
+| `timestampSchema`     | `src/commons/timestamp.ts`      | ISO date string                                                          |
+| `apiResponseSchema`   | `src/commons/api-response.ts`   | Standardized API response envelope                                       |
+| `metadataSchema`      | `src/commons/api-response.ts`   | Pagination metadata (total, offset, limit, next, previous)               |
+| `codedConceptSchema`  | `src/commons/coded-concept.ts`  | Coded system value (system, value, display, valid, tags)                 |
+| `settingOptionSchema` | `src/commons/setting-option.ts` | Single setting option item                                               |
+| `userSchema`          | `src/models/user.ts`            | User record (full_name, email, statuses, identifiers, demographic, etc.) |
+| `settingsSchema`      | `src/models/settings.ts`        | Settings / preferences record                                            |
+
+### Folder structure
+
+```
+src/
+├── commons/          # Shared/primitive schemas (one file per schema)
+│   ├── timestamp.ts
+│   ├── api-response.ts
+│   ├── setting-option.ts
+│   ├── coded-concept.ts
+│   └── index.ts
+├── models/           # Data entity schemas
+│   ├── user.ts
+│   ├── settings.ts
+│   └── index.ts
+├── index.ts          # Package root export
+└── example.test.ts
+```
+
+Add new shared schemas under `src/commons/` (one file each) and new entity schemas under `src/models/`. Re-export both from `src/index.ts`.
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build to dist/
+npm run build
+
+# Watch for changes during development
+npm run dev
+```
+
+## Contributing
+
+### Using an AI agent
+
+If you are an AI agent contributing to this package, read [`AGENTS.md`](./AGENTS.md) first. It defines the project structure, code conventions, folder layout, Zod error message rules (`message` not `error`), schema/type pairing, create/update patterns, and import guidelines. Follow those conventions strictly so all schemas remain consistent.
+
+### Without an AI agent
+
+1. **Create a new schema file**
+   - Shared/primitive schema → `src/commons/<name>.ts` (one file per schema, kebab-case)
+   - Data entity schema → `src/models/<name>.ts`
+
+2. **Follow the code conventions**
+   - Every Zod schema must export an inferred TypeScript type: `export type X = z.infer<typeof xSchema>;`
+   - Use `message` (not `error`) for custom Zod error messages
+   - Use `z.coerce.number()` for query-string parameters
+   - Omit auto-generated fields (`_id`, `id`, `created_at`, `updated_at`, `updated_by`, `schema_version`) from `create` and `update` schemas
+   - Use `.nullable()` for fields that can be `null` but must be present; use `.optional()` for fields that may be absent
+
+3. **Register the schema**
+   - Add `export * from "./<name>";` to the appropriate barrel file (`src/commons/index.ts` or `src/models/index.ts`)
+   - The root `src/index.ts` re-exports both, so no change is needed there unless you add a new top-level folder
+
+4. **Build and verify**
+   - Run `npm run build` to compile TypeScript to `dist/`
+   - Add validation examples to `src/example.test.ts` for new schemas

package/dist/commons/api-response.d.ts

@@ -0,0 +1,178 @@
+import { z } from "zod";
+/**
+ * Pagination metadata included in every standardized API response.
+ */
+export declare const metadataSchema: z.ZodObject<{
+    total: z.ZodNumber;
+    offset: z.ZodNumber;
+    limit: z.ZodNumber;
+    next: z.ZodNullable<z.ZodString>;
+    previous: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    offset: number;
+    total: number;
+    limit: number;
+    next: string | null;
+    previous: string | null;
+}, {
+    offset: number;
+    total: number;
+    limit: number;
+    next: string | null;
+    previous: string | null;
+}>;
+export type Metadata = z.infer<typeof metadataSchema>;
+/**
+ * Standardized API response envelope used by CentriCare services.
+ * Based on /Docs/API/1. Standardized Response.md
+ *
+ * {
+ *   "success": true,
+ *   "message": "Successfully do something",
+ *   "status_code": "200",
+ *   "data": [],
+ *   "metadata": {
+ *     "total": 1,
+ *     "offset": 0,
+ *     "limit": 1,
+ *     "next": null,
+ *     "previous": null
+ *   }
+ * }
+ */
+export declare const apiResponseSchema: <T extends z.ZodTypeAny>(dataSchema: T) => z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodString;
+    status_code: z.ZodString;
+    data: z.ZodArray<T, "many">;
+    metadata: z.ZodObject<{
+        total: z.ZodNumber;
+        offset: z.ZodNumber;
+        limit: z.ZodNumber;
+        next: z.ZodNullable<z.ZodString>;
+        previous: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        offset: number;
+        total: number;
+        limit: number;
+        next: string | null;
+        previous: string | null;
+    }, {
+        offset: number;
+        total: number;
+        limit: number;
+        next: string | null;
+        previous: string | null;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    success: boolean;
+    status_code: string;
+    data: T["_output"][];
+    metadata: {
+        offset: number;
+        total: number;
+        limit: number;
+        next: string | null;
+        previous: string | null;
+    };
+}, {
+    message: string;
+    success: boolean;
+    status_code: string;
+    data: T["_input"][];
+    metadata: {
+        offset: number;
+        total: number;
+        limit: number;
+        next: string | null;
+        previous: string | null;
+    };
+}>;
+export type ApiResponse<T> = {
+    success: boolean;
+    message: string;
+    status_code: string;
+    data: T[];
+    metadata: Metadata;
+};
+/**
+ * Schema for a single-resource API response.
+ * For single-resource requests, metadata.total is always 1,
+ * offset and limit default to 0, and next/previous are null.
+ */
+export declare const singleResourceResponseSchema: <T extends z.ZodTypeAny>(dataSchema: T) => z.ZodEffects<z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodString;
+    status_code: z.ZodString;
+    data: z.ZodArray<T, "many">;
+    metadata: z.ZodObject<{
+        total: z.ZodNumber;
+        offset: z.ZodNumber;
+        limit: z.ZodNumber;
+        next: z.ZodNullable<z.ZodString>;
+        previous: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        offset: number;
+        total: number;
+        limit: number;
+        next: string | null;
+        previous: string | null;
+    }, {
+        offset: number;
+        total: number;
+        limit: number;
+        next: string | null;
+        previous: string | null;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    success: boolean;
+    status_code: string;
+    data: T["_output"][];
+    metadata: {
+        offset: number;
+        total: number;
+        limit: number;
+        next: string | null;
+        previous: string | null;
+    };
+}, {
+    message: string;
+    success: boolean;
+    status_code: string;
+    data: T["_input"][];
+    metadata: {
+        offset: number;
+        total: number;
+        limit: number;
+        next: string | null;
+        previous: string | null;
+    };
+}>, {
+    message: string;
+    success: boolean;
+    status_code: string;
+    data: T["_output"][];
+    metadata: {
+        offset: number;
+        total: number;
+        limit: number;
+        next: string | null;
+        previous: string | null;
+    };
+}, {
+    message: string;
+    success: boolean;
+    status_code: string;
+    data: T["_input"][];
+    metadata: {
+        offset: number;
+        total: number;
+        limit: number;
+        next: string | null;
+        previous: string | null;
+    };
+}>;
+export type SingleResourceResponse<T extends z.ZodTypeAny> = z.infer<ReturnType<typeof singleResourceResponseSchema<T>>>;
+//# sourceMappingURL=api-response.d.ts.map

package/dist/commons/api-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-response.d.ts","sourceRoot":"","sources":["../../src/commons/api-response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;EAMzB,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAOnE,CAAC;AAEL,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,GAAI,CAAC,SAAS,CAAC,CAAC,UAAU,EACjE,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAaZ,CAAC;AAEJ,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,KAAK,CAClE,UAAU,CAAC,OAAO,4BAA4B,CAAC,CAAC,CAAC,CAAC,CACnD,CAAC"}

package/dist/commons/api-response.js

@@ -0,0 +1,49 @@
+import { z } from "zod";
+/**
+ * Pagination metadata included in every standardized API response.
+ */
+export const metadataSchema = z.object({
+    total: z.number().int().nonnegative(),
+    offset: z.number().int().nonnegative(),
+    limit: z.number().int().nonnegative(),
+    next: z.string().nullable(),
+    previous: z.string().nullable(),
+});
+/**
+ * Standardized API response envelope used by CentriCare services.
+ * Based on /Docs/API/1. Standardized Response.md
+ *
+ * {
+ *   "success": true,
+ *   "message": "Successfully do something",
+ *   "status_code": "200",
+ *   "data": [],
+ *   "metadata": {
+ *     "total": 1,
+ *     "offset": 0,
+ *     "limit": 1,
+ *     "next": null,
+ *     "previous": null
+ *   }
+ * }
+ */
+export const apiResponseSchema = (dataSchema) => z.object({
+    success: z.boolean(),
+    message: z.string(),
+    status_code: z.string(),
+    data: z.array(dataSchema),
+    metadata: metadataSchema,
+});
+/**
+ * Schema for a single-resource API response.
+ * For single-resource requests, metadata.total is always 1,
+ * offset and limit default to 0, and next/previous are null.
+ */
+export const singleResourceResponseSchema = (dataSchema) => apiResponseSchema(dataSchema).refine((data) => data.metadata.total === 1 &&
+    data.metadata.offset === 0 &&
+    data.metadata.limit === 0 &&
+    data.metadata.next === null &&
+    data.metadata.previous === null, {
+    message: "Single resource response metadata must have total=1, offset=0, limit=0, next=null, previous=null",
+});
+//# sourceMappingURL=api-response.js.map

package/dist/commons/api-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-response.js","sourceRoot":"","sources":["../../src/commons/api-response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IACrC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IACtC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IACrC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAIH;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAyB,UAAa,EAAE,EAAE,CACzE,CAAC,CAAC,MAAM,CAAC;IACP,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;IACzB,QAAQ,EAAE,cAAc;CACzB,CAAC,CAAC;AAUL;;;;GAIG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,UAAa,EACb,EAAE,CACF,iBAAiB,CAAC,UAAU,CAAC,CAAC,MAAM,CAClC,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,QAAQ,CAAC,KAAK,KAAK,CAAC;IACzB,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC;IAC1B,IAAI,CAAC,QAAQ,CAAC,KAAK,KAAK,CAAC;IACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI;IAC3B,IAAI,CAAC,QAAQ,CAAC,QAAQ,KAAK,IAAI,EACjC;IACE,OAAO,EACL,kGAAkG;CACrG,CACF,CAAC"}

package/dist/commons/coded-concept.d.ts

@@ -0,0 +1,28 @@
+import { z } from "zod";
+/**
+ * CodedConcept - A data type for coded system values based on a defined code system.
+ * Used across CentriCare models for statuses, identifiers, contacts, demographic fields, etc.
+ *
+ * Accepts only codes and code systems registered in the CentriCare Registry.
+ */
+export declare const codedConceptSchema: z.ZodObject<{
+    system: z.ZodString;
+    value: z.ZodString;
+    display: z.ZodOptional<z.ZodString>;
+    valid: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, string | undefined>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    system: string;
+    valid?: string | undefined;
+    display?: string | undefined;
+    tags?: string[] | undefined;
+}, {
+    value: string;
+    system: string;
+    valid?: string | undefined;
+    display?: string | undefined;
+    tags?: string[] | undefined;
+}>;
+export type CodedConcept = z.infer<typeof codedConceptSchema>;
+//# sourceMappingURL=coded-concept.d.ts.map

package/dist/commons/coded-concept.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"coded-concept.d.ts","sourceRoot":"","sources":["../../src/commons/coded-concept.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;EAa7B,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC"}

package/dist/commons/coded-concept.js

@@ -0,0 +1,20 @@
+import { z } from "zod";
+import { timestampSchema } from "./timestamp";
+/**
+ * CodedConcept - A data type for coded system values based on a defined code system.
+ * Used across CentriCare models for statuses, identifiers, contacts, demographic fields, etc.
+ *
+ * Accepts only codes and code systems registered in the CentriCare Registry.
+ */
+export const codedConceptSchema = z.object({
+    system: z.string().min(1, { message: "system is required" }),
+    value: z.string().min(1, { message: "value is required" }),
+    display: z.string().optional(),
+    valid: z
+        .string()
+        .datetime({ offset: true })
+        .optional()
+        .refine((val) => !val || timestampSchema.safeParse(val).success, { message: "valid must be a valid ISO 8601 datetime if provided" }),
+    tags: z.array(z.string()).optional(),
+});
+//# sourceMappingURL=coded-concept.js.map

package/dist/commons/coded-concept.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coded-concept.js","sourceRoot":"","sources":["../../src/commons/coded-concept.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAC5D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC1D,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;SAC1B,QAAQ,EAAE;SACV,MAAM,CACL,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EACvD,EAAE,OAAO,EAAE,qDAAqD,EAAE,CACnE;IACH,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC"}

package/dist/commons/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Shared/primitive schemas used across CentriCare projects.
+ * Each schema lives in its own file.
+ */
+export * from "./timestamp";
+export * from "./api-response";
+export * from "./setting-option";
+export * from "./coded-concept";
+//# sourceMappingURL=index.d.ts.map

package/dist/commons/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/commons/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC"}

package/dist/commons/index.js

@@ -0,0 +1,9 @@
+/**
+ * Shared/primitive schemas used across CentriCare projects.
+ * Each schema lives in its own file.
+ */
+export * from "./timestamp";
+export * from "./api-response";
+export * from "./setting-option";
+export * from "./coded-concept";
+//# sourceMappingURL=index.js.map

package/dist/commons/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/commons/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC"}

package/dist/commons/setting-option.d.ts

@@ -0,0 +1,37 @@
+import { z } from "zod";
+/**
+ * The type of a setting option value.
+ *
+ * Accepts "string", "number", "boolean", "date", or an array of those
+ * for options with multiple choices. Also accepts any valid registry system
+ * path (e.g. "crn:status:system") for options whose input type is determined
+ * by a registry code system.
+ */
+export declare const settingOptionTypeSchema: z.ZodUnion<[z.ZodEnum<["string", "number", "boolean", "date"]>, z.ZodArray<z.ZodEnum<["string", "number", "boolean", "date"]>, "many">, z.ZodString]>;
+export type SettingOptionType = z.infer<typeof settingOptionTypeSchema>;
+/**
+ * A single setting option item.
+ *
+ * - `default` and `value` can be null but cannot be undefined or missing.
+ */
+export declare const settingOptionSchema: z.ZodObject<{
+    field: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    type: z.ZodUnion<[z.ZodEnum<["string", "number", "boolean", "date"]>, z.ZodArray<z.ZodEnum<["string", "number", "boolean", "date"]>, "many">, z.ZodString]>;
+    default: z.ZodNullable<z.ZodString>;
+    value: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNumber]>>;
+}, "strip", z.ZodTypeAny, {
+    value: string | number | boolean | null;
+    type: string | ("string" | "number" | "boolean" | "date")[];
+    field: string;
+    default: string | null;
+    label?: string | undefined;
+}, {
+    value: string | number | boolean | null;
+    type: string | ("string" | "number" | "boolean" | "date")[];
+    field: string;
+    default: string | null;
+    label?: string | undefined;
+}>;
+export type SettingOption = z.infer<typeof settingOptionSchema>;
+//# sourceMappingURL=setting-option.d.ts.map

package/dist/commons/setting-option.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setting-option.d.ts","sourceRoot":"","sources":["../../src/commons/setting-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,uJAIlC,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;EAM9B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC"}

package/dist/commons/setting-option.js

@@ -0,0 +1,27 @@
+import { z } from "zod";
+/**
+ * The type of a setting option value.
+ *
+ * Accepts "string", "number", "boolean", "date", or an array of those
+ * for options with multiple choices. Also accepts any valid registry system
+ * path (e.g. "crn:status:system") for options whose input type is determined
+ * by a registry code system.
+ */
+export const settingOptionTypeSchema = z.union([
+    z.enum(["string", "number", "boolean", "date"]),
+    z.array(z.enum(["string", "number", "boolean", "date"])),
+    z.string(),
+]);
+/**
+ * A single setting option item.
+ *
+ * - `default` and `value` can be null but cannot be undefined or missing.
+ */
+export const settingOptionSchema = z.object({
+    field: z.string().min(1, { message: "field is required" }),
+    label: z.string().optional(),
+    type: settingOptionTypeSchema,
+    default: z.string().nullable(),
+    value: z.union([z.string(), z.boolean(), z.number()]).nullable(),
+});
+//# sourceMappingURL=setting-option.js.map

package/dist/commons/setting-option.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setting-option.js","sourceRoot":"","sources":["../../src/commons/setting-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC;IAC7C,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IACxD,CAAC,CAAC,MAAM,EAAE;CACX,CAAC,CAAC;AAIH;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC1D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,IAAI,EAAE,uBAAuB;IAC7B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CACjE,CAAC,CAAC"}

package/dist/commons/timestamp.d.ts

@@ -0,0 +1,7 @@
+import { z } from "zod";
+/**
+ * ISO 8601 timestamp string.
+ */
+export declare const timestampSchema: z.ZodString;
+export type Timestamp = z.infer<typeof timestampSchema>;
+//# sourceMappingURL=timestamp.d.ts.map

package/dist/commons/timestamp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timestamp.d.ts","sourceRoot":"","sources":["../../src/commons/timestamp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,eAAe,aAG1B,CAAC;AAEH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/dist/commons/timestamp.js

@@ -0,0 +1,9 @@
+import { z } from "zod";
+/**
+ * ISO 8601 timestamp string.
+ */
+export const timestampSchema = z.string().datetime({
+    offset: true,
+    message: 'Invalid timestamp: must be an ISO 8601 datetime',
+});
+//# sourceMappingURL=timestamp.js.map

package/dist/commons/timestamp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timestamp.js","sourceRoot":"","sources":["../../src/commons/timestamp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC;IACjD,MAAM,EAAE,IAAI;IACZ,OAAO,EAAE,iDAAiD;CAC3D,CAAC,CAAC"}

package/dist/example.test.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Example usage and sanity checks for the standardized schemas.
+ * Run with: npx tsx src/example.test.ts  (requires tsx)
+ */
+export {};
+//# sourceMappingURL=example.test.d.ts.map

package/dist/example.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"example.test.d.ts","sourceRoot":"","sources":["../src/example.test.ts"],"names":[],"mappings":"AAAA;;;GAGG"}