@centricare/contract 0.1.1 → 0.2.0

package/README.md

@@ -17,7 +17,6 @@ pnpm add @centricare/contract
 ```ts
 import { userSchema, User } from "@centricare/contract";
 
-// Validate incoming data
 const result = userSchema.safeParse(req.body);
 
 if (!result.success) {
@@ -27,37 +26,40 @@ if (!result.success) {
 const user: User = result.data;
 ```
 
-## Schemas
+## Registry
 
-| 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                                            |
+Registry helpers are exposed from a dedicated subpath:
 
-### Folder structure
+```ts
+import { validateCode, getCode, getOptions, getSystems } from "@centricare/contract/registry";
+
+validateCode("crn:status:system", "active"); // true
+getOptions("crn:contact"); // [{ value: "mobile", label: "Mobile" }, ...]
+```
+
+They are intentionally **not** exported from the package root. See
+[src/registry/README.md](./src/registry/README.md).
+
+The package ships both ESM (`*.mjs`) and CommonJS (`*.cjs`) builds, with matching
+type declarations.
+
+## 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
+├── commons/          # Shared/primitive schemas (see src/commons/README.md)
+├── models/           # Data entity schemas (see src/models/README.md)
+└── registry/         # CentriCare registry schemas (see src/registry/README.md)
 ```
 
-Add new shared schemas under `src/commons/` (one file each) and new entity schemas under `src/models/`. Re-export both from `src/index.ts`.
+## Documentation
+
+- **[AGENTS.md](./AGENTS.md)** — AI agent guidance and project conventions
+- **[CONVENTIONS.md](./CONVENTIONS.md)** — Code conventions and coding standards
+- **[EXAMPLES.md](./EXAMPLES.md)** — Usage examples
+- **[src/commons/README.md](./src/commons/README.md)** — Shared primitive schemas
+- **[src/models/README.md](./src/models/README.md)** — Data entity schemas
+- **[src/registry/README.md](./src/registry/README.md)** — CentriCare registry schemas
 
 ## Development
 
@@ -72,29 +74,8 @@ npm run build
 npm run dev
 ```
 
-## Contributing
-
-### Using an AI agent
+## Publishing
 
-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
+```bash
+npm publish --access public
+```