@centricare/contract 0.1.2 → 0.2.1

package/README.md

@@ -14,12 +14,9 @@ pnpm add @centricare/contract
 
 ## Usage
 
-Import from the package root (all schemas):
-
 ```ts
 import { userSchema, User } from "@centricare/contract";
 
-// Validate incoming data
 const result = userSchema.safeParse(req.body);
 
 if (!result.success) {
@@ -29,50 +26,41 @@ if (!result.success) {
 const user: User = result.data;
 ```
 
-Import from a specific model subpath:
+## Registry
+
+Registry helpers are exposed from a dedicated subpath:
 
 ```ts
-import { departmentSchema, Department } from "@centricare/contract/department";
+import { validateCode, getCode, getOptions, getSystems } from "@centricare/contract/registry";
+
+validateCode("crn:status:system", "active"); // true
+getOptions("crn:contact"); // [{ value: "mobile", label: "Mobile" }, ...]
 ```
 
-## Folder structure
+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/
-├── index.ts              # Package root barrel export (@centricare/contract)
-├── commons/              # Shared/primitive schemas (one file per schema)
-│   ├── index.ts
-│   ├── timestamp.ts
-│   ├── api-response.ts
-│   ├── setting-option.ts
-│   ├── coded-concept.ts
-│   ├── address.ts
-│   └── demographic.ts
-└── models/               # Data entity schemas (one folder per model)
-    ├── index.ts
-    ├── user/
-    │   ├── index.ts
-    │   ├── user.schema.ts          # Full schema + User type
-    │   ├── user-minimal.schema.ts  # Omit server-generated fields + UserMinimal type
-    │   ├── user-partial.schema.ts  # Based on minimal, all optional + UserPartial type
-    │   ├── user-settings.schema.ts # Settings schema (if model has settings)
-    │   └── ... (other schemas as needed)
-    ├── settings/
-    │   ├── index.ts
-    │   ├── settings.schema.ts
-    │   ├── settings-minimal.schema.ts
-    │   ├── settings-partial.schema.ts
-    │   └── ...
-    └── ... (one folder per model)
+├── 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 models under `src/models/<model>/`. Each model folder contains an `index.ts` barrel and the following schema files:
-- `<model>.schema.ts` — Full schema definition
-- `<model>-minimal.schema.ts` — Omits server-generated fields
-- `<model>-partial.schema.ts` — Based on minimal, all fields optional
-- `<model>-settings.schema.ts` — Settings schema (only if model has settings)
+## Documentation
 
-Re-export model folders from `src/models/index.ts`.
+- **[CHANGELOG.md](./CHANGELOG.md)** — Release history
+- **[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
 
@@ -87,34 +75,8 @@ npm run build
 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.
+## Publishing
 
-### Without an AI agent
-
-1. **Create a new model folder**
-   - Shared/primitive schema → `src/commons/<name>.ts` (one file per schema, kebab-case)
-   - Data entity model → `src/models/<model>/` with the following files:
-     - `<model>.schema.ts` — Full schema definition
-     - `<model>-minimal.schema.ts` — Omits server-generated fields
-     - `<model>-partial.schema.ts` — Based on minimal, all fields optional
-     - `<model>-settings.schema.ts` — Settings schema (if model has settings)
-     - `index.ts` — Barrel export
-
-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 minimal 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 "./<model>";` to `src/models/index.ts`
-   - The root `src/index.ts` re-exports `./commons` and `./models`, so no change is needed there
-
-4. **Build and verify**
-   - Run `npm run build` to compile TypeScript to `dist/`
-   - Add validation examples to `EXAMPLES.md` for new schemas
+```bash
+npm publish --access public
+```