@junejuly-lockstep/model 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 JuneJuly Health
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,38 @@
-# Temporary Holding Version
+# @junejuly-lockstep/model
 
-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.
+The zod schemas and TypeScript types every Lockstep package shares: the journey model (XState v5
+machine plus per-state `meta`), `lockstep.config.ts` (`LockstepConfig`), the run payload the
+reconciler posts, verdicts, cards, and every API request and response shape. This is the only place
+payload shapes live; the platform API and the `@junejuly-lockstep/reconciler` CLI both import it, so a
+payload change is one PR touching both sides.
+
+ESM only, Node 20.18 or newer. The package has no side effects.
+
+## Install
+
+```bash
+pnpm add @junejuly-lockstep/model
+```
+
+## Usage
+
+```ts
+import { readFileSync } from 'node:fs';
+import { LockstepConfig, RunPayload } from '@junejuly-lockstep/model';
+
+// Validate a client config the way the reconciler does (defaults are filled in).
+const config = LockstepConfig.parse({
+  projectKey: 'FERN',
+  apiBaseUrl: 'https://api.lockstep.example',
+  seams: ['Client app', 'Edge', 'API layer', 'Service', 'Data', 'Notifications'],
+  bootCommand: 'pnpm start',
+  port: 3100,
+});
+
+// Every schema is also a type (`RunPayload` the schema, `RunPayload` the inferred type).
+const parsed = RunPayload.safeParse(JSON.parse(readFileSync('.lockstep/run-payload.json', 'utf8')));
+if (!parsed.success) console.error(parsed.error.flatten());
+```
+
+Published from the [Lockstep monorepo](https://github.com/JuneJulyHealth/lockstep)
+(`packages/model`). Versioned in lockstep with `@junejuly-lockstep/sdk` and `@junejuly-lockstep/reconciler`.