Cratis.Showrunner.Usher.Contracts 1.0.0

Showrunner

Showrunner is a set of ready-made product parts for applications built on Cratis — drop-in backend and frontend packages, built as Arc and Chronicle vertical slices.

Usher

Usher is the support part: it lets the users of an application report issues and hold support conversations with the people running it. It is a library an application hosts, not a service of its own — the backend package adds Usher's commands, queries and events to the host's Arc application and Chronicle event store, and the frontend packages give the host's React UI the generated proxies and components to drive them.

Usher is in its earliest stage: the packages are scaffolded and published, but carry no behavior yet. See Documentation.

Packages

Building

Prerequisites: the .NET SDK from global.json (10.0.400 or later) and Node.js 20 or later with Corepack enabled (corepack enable); Yarn itself is checked in under .yarn/releases.

# Backend: Debug builds compile the inline specs and regenerate the TypeScript proxies
dotnet build Showrunner.slnx --configuration Debug
dotnet test Showrunner.slnx --configuration Debug --no-build

# Release is warnings-as-errors; clearing CratisProxiesOutputPath skips proxy generation
dotnet build Showrunner.slnx --configuration Release -p:CratisProxiesOutputPath=

# Frontend
yarn install
yarn lint:ci
yarn compile
yarn test
yarn build

Specifications live beside the code they specify — for_*/when_*/ folders compiled into Debug builds only for .NET, and Vitest specs in the same layout for TypeScript.

The end-to-end specifications in Integration run Usher and a desk against a real Chronicle kernel in a container, so dotnet test Showrunner.slnx needs Docker. Set USHER_CHRONICLE_IMAGE to run them against another kernel image, and USHER_INTEGRATION_LOG to a file path to keep the application's log.

Releasing

Every pull request carries exactly one of the major, minor, patch or no-release labels. Merging a version-labelled pull request to main releases all four packages under one semantic version through cratis/release-action — NuGet packages through NuGet trusted publishing and npm packages through npm trusted publishing with provenance. The packages are built and packed in jobs without publishing rights; separate jobs that run no build or install script hold the short-lived OIDC token and only push what was packed.

Part of the Cratis ecosystem

Showrunner is a Cratis project, built on event sourcing with Chronicle and CQRS with Arc, with frontends on @cratis/components. Join the community on Discord.

License

Showrunner is licensed under the MIT License and free to use.