@sesionario/live-contracts

Shared types, Zod schemas, JSON Schema, and OpenAPI for the Sesionario live streaming platform.

Published to npm as @sesionario/live-contracts (public registry).

Install

pnpm add @sesionario/live-contracts

Local development (before first publish)

In live or live-svc, link the package from this repo:

pnpm add ../live-contracts
# or
pnpm add file:../live-contracts

Build

pnpm install
pnpm run build   # emits dist/ + regenerates schemas/*.json
pnpm run test

Releases

Releases are automated via semantic-release on push to main or dev. Use Conventional Commits to drive version bumps:

• feat: — minor bump
• fix: — patch bump
• feat!: or BREAKING CHANGE: — major bump

Channels

| Branch | npm dist-tag | Install | | ------ | ------------ | ---------------------------------------- | | dev | rc | pnpm add @sesionario/live-contracts@rc | | main | latest | pnpm add @sesionario/live-contracts |

RC versions look like 1.4.0-rc.1; stable versions like 1.4.0.

Git flow

1. Open feature PRs against dev.
2. Merging into dev publishes a release candidate to the rc dist-tag.
3. When ready, open a PR from dev → main to promote to a stable release on latest.

npm trusted publishing (one-time setup)

Publishing uses OIDC trusted publishing from GitHub Actions — no long-lived NPM_TOKEN is stored in the repo.

1. Create the package on npmjs (first publish) or ensure @sesionario/live-contracts exists under the @sesionario scope.
2. On npmjs.com → package → Settings → Trusted publishing, add:
   • Provider: GitHub Actions
   • Repository: docufacil/live-contracts
   • Workflow filename: release.yml (exact match, case-sensitive)
3. Ensure the dev branch exists on GitHub before the first RC release.

If branch protection blocks the release bot from pushing version bumps back, add the GitHub Actions bot to the branch bypass list, or drop @semantic-release/git from .releaserc.json.

Exports

• @sesionario/live-contracts — TypeScript types + Zod schemas
• @sesionario/live-contracts/schemas/* — JSON Schema files
• @sesionario/live-contracts/openapi.yaml — public API spec for live-svc

TypeScript ↔ Python correspondence (live-engine)

| TypeScript (@sesionario/live-contracts) | Python (live-engine) | | ----------------------------------------- | ----------------------------- | | StreamStatus | StreamStatus (Literal enum) | | Stream | Stream (Pydantic BaseModel) | | CreateStreamResponse | CreateStreamResponse | | GetStreamResponse | GetStreamResponse | | ListStreamsResponse | ListStreamsResponse | | SpawnRequest | SpawnRequest | | SpawnResponse | SpawnResponse | | StopRequest | StopRequest | | StopResponse | StopResponse | | IngestReadyWebhook | IngestReadyWebhook | | AuthorizeRequest | AuthorizeRequest | | AuthorizeResponse | AuthorizeResponse | | R2Credentials | R2Credentials |

Keep Python models in live-engine/src/models.py manually synchronized when contracts change.

License

MIT