@cratis/showrunner.boxoffice 0.0.0-stage → 1.9.0

package/Entitlements/EntitlementSummary.ts

@@ -0,0 +1,97 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.BoxOffice.Entitlements.EntitlementSummary, Cratis.Showrunner.BoxOffice.Entitlements.EntitlementSummary. Time: 2026-10-31T13:17:43.2153370Z. Hash: ECB663150DECD739E0E5AC4A29386C0D52C6614A2ADFD4A2D7A89C540FBF3F8D
+import { QueryFor, QueryResultWithState } from '@cratis/arc/queries';
+import { PerformQuery, QueryWhen, SetSorting, useQuery, useSuspenseQuery } from '@cratis/arc.react/queries';
+import { SliceLocation as ArcSliceLocation, ParameterDescriptor } from '@cratis/arc/reflection';
+import { DateOnly, field } from '@cratis/fundamentals';
+import { ModuleStanding } from './ModuleStanding';
+import { ReadOnlyReason } from './ReadOnlyReason';
+
+/**
+ * Gets what the tenant may do today.
+ */
+export class CurrentEntitlements extends QueryFor<EntitlementSummary> {
+    static readonly sliceLocation: ArcSliceLocation = new ArcSliceLocation('', '', 'Entitlements');
+    readonly route: string = '/api/entitlements/current-entitlements';
+    readonly queryName: string = 'Cratis.Showrunner.BoxOffice.Entitlements.EntitlementSummary.CurrentEntitlements';
+    readonly treatWarningsAsErrors: boolean = false;
+    readonly roles: string[] = [];
+    readonly defaultValue: EntitlementSummary = {} as EntitlementSummary;
+
+    constructor() {
+        super(EntitlementSummary, false);
+    }
+
+    get requiredRequestParameters(): string[] {
+        return [
+        ];
+    }
+
+    readonly parameterDescriptors: ParameterDescriptor[] = [
+    ];
+
+
+
+    static use(): [QueryResultWithState<EntitlementSummary>, PerformQuery, SetSorting] {
+        return useQuery<EntitlementSummary, CurrentEntitlements>(CurrentEntitlements);
+    }
+
+    static useSuspense(): [QueryResultWithState<EntitlementSummary>, PerformQuery, SetSorting] {
+        return useSuspenseQuery<EntitlementSummary, CurrentEntitlements>(CurrentEntitlements);
+    }
+
+    static when(condition: boolean): QueryWhen<CurrentEntitlements, EntitlementSummary> {
+        return new QueryWhen<CurrentEntitlements, EntitlementSummary>(CurrentEntitlements, condition);
+    }
+}
+
+/**
+ * What the signed-in user's tenant may do today, in one answer for the product's frontend: whether it is read-only and why, whether it is on a trial, how many seats it has and which modules it may use.
+ */
+export class EntitlementSummary {
+
+    /**
+     * Why the tenant is read-only; none when it is not.
+     */
+    @field(Number)
+    readOnlyReason!: ReadOnlyReason;
+
+    /**
+     * Whether the tenant's seats come from a trial, closed or not.
+     */
+    @field(Boolean)
+    isTrial!: boolean;
+
+    /**
+     * The last day of the trial; nothing when the tenant has no trial.
+     */
+    @field(DateOnly)
+    trialEnds?: DateOnly;
+
+    /**
+     * How many seats the tenant has today.
+     */
+    @field(Number)
+    seats!: number;
+
+    /**
+     * The last day of the seats; nothing when they do not end, or the tenant has none.
+     */
+    @field(DateOnly)
+    seatsUntil?: DateOnly;
+
+    /**
+     * Every module the product declares, and what the tenant may do with it.
+     */
+    @field(ModuleStanding, true)
+    modules!: ModuleStanding[];
+
+    /**
+     * Whether the product has a customer portal to buy, try or change a plan in.
+     */
+    @field(Boolean)
+    canOpenPortal!: boolean;
+}

package/Entitlements/ModuleAccess.ts

@@ -0,0 +1,14 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.BoxOffice.Entitlements.ModuleAccess. Time: 2026-10-31T13:15:32.0616230Z. Hash: 7AC29B38D5DB79BF0A96644F28667E173A5E5F29474D3956D58397874D058DAB
+/**
+ * What a tenant may do with a module.
+ */
+export enum ModuleAccess {
+    none = 0,
+    preview = 1,
+    trial = 2,
+    full = 3,
+}

package/Entitlements/ModuleStanding.ts

@@ -0,0 +1,38 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.BoxOffice.Entitlements.ModuleStanding. Time: 2026-10-31T13:15:32.0616230Z. Hash: AC82AA9D30DD5B3F9F50F57386FAD3049F9E833C9081B68BC24240402F1182EB
+import { field } from '@cratis/fundamentals';
+import { DateOnly } from '@cratis/fundamentals';
+import { ModuleAccess } from './ModuleAccess';
+
+/**
+ * What the tenant may do with one of the product's modules today.
+ */
+export class ModuleStanding {
+
+    /**
+     * The module.
+     */
+    @field(String)
+    module!: string;
+
+    /**
+     * What the module is called.
+     */
+    @field(String)
+    name!: string;
+
+    /**
+     * The access the tenant has today.
+     */
+    @field(Number)
+    access!: ModuleAccess;
+
+    /**
+     * The last day of the access; nothing when the access does not end or the tenant has none.
+     */
+    @field(DateOnly)
+    until?: DateOnly;
+}

package/Entitlements/ReadOnlyReason.ts

@@ -0,0 +1,13 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.BoxOffice.Entitlements.ReadOnlyReason. Time: 2026-10-31T09:02:25.7507330Z. Hash: 545AD208A4AD0B46C09AC8C3CE544537E721921BD400CB82EE8B2253561C8E9D
+/**
+ * Why a tenant can read but not change anything.
+ */
+export enum ReadOnlyReason {
+    none = 0,
+    tenantSuspended = 1,
+    trialClosed = 2,
+}

package/Entitlements/TenantStanding.ts

@@ -0,0 +1,85 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.BoxOffice.Entitlements.TenantStanding, Cratis.Showrunner.BoxOffice.Entitlements.TenantStanding. Time: 2026-10-31T09:02:25.7507330Z. Hash: 9F7FF02F16AC433A673F260D47C431082557136B3BEB973B6ED7B81A178AD861
+import { QueryFor, QueryResultWithState } from '@cratis/arc/queries';
+import { PerformQuery, QueryWhen, SetSorting, useQuery, useSuspenseQuery } from '@cratis/arc.react/queries';
+import { SliceLocation as ArcSliceLocation, ParameterDescriptor } from '@cratis/arc/reflection';
+import { field } from '@cratis/fundamentals';
+import { ReadOnlyReason } from './ReadOnlyReason';
+import { SuspensionCause } from '../Contracts/Tenants/SuspensionCause';
+
+/**
+ * Gets why the tenant can not change anything, so the frontend can show a banner.
+ */
+export class CurrentStanding extends QueryFor<TenantStanding> {
+    static readonly sliceLocation: ArcSliceLocation = new ArcSliceLocation('', '', 'Entitlements');
+    readonly route: string = '/api/entitlements/current-standing';
+    readonly queryName: string = 'Cratis.Showrunner.BoxOffice.Entitlements.TenantStanding.CurrentStanding';
+    readonly treatWarningsAsErrors: boolean = false;
+    readonly roles: string[] = [];
+    readonly defaultValue: TenantStanding = {} as TenantStanding;
+
+    constructor() {
+        super(TenantStanding, false);
+    }
+
+    get requiredRequestParameters(): string[] {
+        return [
+        ];
+    }
+
+    readonly parameterDescriptors: ParameterDescriptor[] = [
+    ];
+
+
+
+    static use(): [QueryResultWithState<TenantStanding>, PerformQuery, SetSorting] {
+        return useQuery<TenantStanding, CurrentStanding>(CurrentStanding);
+    }
+
+    static useSuspense(): [QueryResultWithState<TenantStanding>, PerformQuery, SetSorting] {
+        return useSuspenseQuery<TenantStanding, CurrentStanding>(CurrentStanding);
+    }
+
+    static when(condition: boolean): QueryWhen<CurrentStanding, TenantStanding> {
+        return new QueryWhen<CurrentStanding, TenantStanding>(CurrentStanding, condition);
+    }
+}
+
+/**
+ * Whether the operator suspended a tenant, and the reason the tenant is read-only when it is, for the frontend to show.
+ */
+export class TenantStanding {
+
+    /**
+     * The id of the tenant's stream.
+     */
+    @field(String)
+    id!: string;
+
+    /**
+     * Whether the operator has the tenant suspended.
+     */
+    @field(Boolean)
+    suspended!: boolean;
+
+    /**
+     * Why the operator suspended the tenant, while it does.
+     */
+    @field(Number)
+    cause!: SuspensionCause;
+
+    /**
+     * When the operator made the decision that stands. A decision that arrives after a newer one is ignored.
+     */
+    @field(Date)
+    decidedAt!: Date;
+
+    /**
+     * Why the tenant can read but not change anything, evaluated when it is read; none when it can.
+     */
+    @field(Number)
+    readOnlyReason!: ReadOnlyReason;
+}

package/Entitlements/index.ts

@@ -0,0 +1,7 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+export * from './EntitlementSummary';
+export * from './ModuleAccess';
+export * from './ModuleStanding';
+export * from './ReadOnlyReason';
+export * from './TenantStanding';

package/Offers/Offer.ts

@@ -0,0 +1,174 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.BoxOffice.Offers.Offer, Cratis.Showrunner.BoxOffice.Offers.Offer. Time: 2026-10-31T09:00:17.5207780Z. Hash: 7673DE0FEE8F93BA649B9A59208C8F68E85A8D9E65582D8B2439BDF2A8952D2C
+import { Paging, QueryFor, QueryResultWithState, Sorting, SortingActions, SortingActionsForQuery } from '@cratis/arc/queries';
+import { PerformQuery, QueryWhen, SetPage, SetPageSize, SetSorting, useQuery, useQueryWithPaging, useSuspenseQuery, useSuspenseQueryWithPaging } from '@cratis/arc.react/queries';
+import { SliceLocation as ArcSliceLocation, ParameterDescriptor } from '@cratis/arc/reflection';
+import { Guid, field } from '@cratis/fundamentals';
+import { OfferPrice } from '../Contracts/Offers/OfferPrice';
+
+class OnSaleSortBy {
+    private _id: SortingActionsForQuery<Offer[]>;
+    private _includedSeats: SortingActionsForQuery<Offer[]>;
+    private _modules: SortingActionsForQuery<Offer[]>;
+    private _name: SortingActionsForQuery<Offer[]>;
+    private _prices: SortingActionsForQuery<Offer[]>;
+    private _withdrawn: SortingActionsForQuery<Offer[]>;
+
+    constructor(readonly query: OnSale) {
+        this._id = new SortingActionsForQuery<Offer[]>('id', query);
+        this._includedSeats = new SortingActionsForQuery<Offer[]>('includedSeats', query);
+        this._modules = new SortingActionsForQuery<Offer[]>('modules', query);
+        this._name = new SortingActionsForQuery<Offer[]>('name', query);
+        this._prices = new SortingActionsForQuery<Offer[]>('prices', query);
+        this._withdrawn = new SortingActionsForQuery<Offer[]>('withdrawn', query);
+    }
+
+    get id(): SortingActionsForQuery<Offer[]> {
+        return this._id;
+    }
+    get includedSeats(): SortingActionsForQuery<Offer[]> {
+        return this._includedSeats;
+    }
+    get modules(): SortingActionsForQuery<Offer[]> {
+        return this._modules;
+    }
+    get name(): SortingActionsForQuery<Offer[]> {
+        return this._name;
+    }
+    get prices(): SortingActionsForQuery<Offer[]> {
+        return this._prices;
+    }
+    get withdrawn(): SortingActionsForQuery<Offer[]> {
+        return this._withdrawn;
+    }
+}
+
+class OnSaleSortByWithoutQuery {
+    private _id: SortingActions  = new SortingActions('id');
+    private _includedSeats: SortingActions  = new SortingActions('includedSeats');
+    private _modules: SortingActions  = new SortingActions('modules');
+    private _name: SortingActions  = new SortingActions('name');
+    private _prices: SortingActions  = new SortingActions('prices');
+    private _withdrawn: SortingActions  = new SortingActions('withdrawn');
+
+    get id(): SortingActions {
+        return this._id;
+    }
+    get includedSeats(): SortingActions {
+        return this._includedSeats;
+    }
+    get modules(): SortingActions {
+        return this._modules;
+    }
+    get name(): SortingActions {
+        return this._name;
+    }
+    get prices(): SortingActions {
+        return this._prices;
+    }
+    get withdrawn(): SortingActions {
+        return this._withdrawn;
+    }
+}
+
+
+/**
+ * Gets the offers on sale.
+ */
+export class OnSale extends QueryFor<Offer[]> {
+    static readonly sliceLocation: ArcSliceLocation = new ArcSliceLocation('', '', 'Offers');
+    readonly route: string = '/api/offers/on-sale';
+    readonly queryName: string = 'Cratis.Showrunner.BoxOffice.Offers.Offer.OnSale';
+    readonly treatWarningsAsErrors: boolean = false;
+    readonly roles: string[] = [];
+    readonly defaultValue: Offer[] = [];
+    private readonly _sortBy: OnSaleSortBy;
+    private static readonly _sortBy: OnSaleSortByWithoutQuery = new OnSaleSortByWithoutQuery();
+
+    constructor() {
+        super(Offer, true);
+        this._sortBy = new OnSaleSortBy(this);
+    }
+
+    get requiredRequestParameters(): string[] {
+        return [
+        ];
+    }
+
+    readonly parameterDescriptors: ParameterDescriptor[] = [
+    ];
+
+
+    get sortBy(): OnSaleSortBy {
+        return this._sortBy;
+    }
+
+    static get sortBy(): OnSaleSortByWithoutQuery {
+        return this._sortBy;
+    }
+
+    static use(sorting?: Sorting): [QueryResultWithState<Offer[]>, PerformQuery, SetSorting] {
+        return useQuery<Offer[], OnSale>(OnSale, undefined, sorting);
+    }
+
+    static useWithPaging(pageSize: number, sorting?: Sorting): [QueryResultWithState<Offer[]>, PerformQuery, SetSorting, SetPage, SetPageSize] {
+        return useQueryWithPaging<Offer[], OnSale>(OnSale, new Paging(0, pageSize), undefined, sorting);
+    }
+
+    static useSuspense(sorting?: Sorting): [QueryResultWithState<Offer[]>, PerformQuery, SetSorting] {
+        return useSuspenseQuery<Offer[], OnSale>(OnSale, undefined, sorting);
+    }
+
+    static useSuspenseWithPaging(pageSize: number, sorting?: Sorting): [QueryResultWithState<Offer[]>, PerformQuery, SetSorting, SetPage, SetPageSize] {
+        return useSuspenseQueryWithPaging<Offer[], OnSale>(OnSale, new Paging(0, pageSize), undefined, sorting);
+    }
+
+    static when(condition: boolean): QueryWhen<OnSale, Offer[]> {
+        return new QueryWhen<OnSale, Offer[]>(OnSale, condition);
+    }
+}
+
+/**
+ * An offer the operator sells the product under, kept for the plan page. A withdrawn offer stays as it was, marked withdrawn: tenants that have it keep it.
+ */
+export class Offer {
+
+    /**
+     * The id of the offer.
+     */
+    @field(Guid)
+    id!: Guid;
+
+    /**
+     * The name of the offer.
+     */
+    @field(String)
+    name!: string;
+
+    /**
+     * The modules the offer includes.
+     */
+    @field(String, true)
+    modules!: string[];
+
+    /**
+     * The seats the offer includes.
+     */
+    @field(Number)
+    includedSeats!: number;
+
+    /**
+     * What the offer costs.
+     */
+    @field(OfferPrice, true)
+    prices!: OfferPrice[];
+
+    /**
+     * Whether the operator stopped selling it.
+     */
+    @field(Boolean)
+    withdrawn!: boolean;
+}

package/Offers/index.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './Offer';

package/Portal/PortalIntent.ts

@@ -0,0 +1,13 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.BoxOffice.Portal.PortalIntent. Time: 2026-10-31T13:15:32.0616230Z. Hash: 616F82552664EF3E6D08A4152B310A3449F6700AC19EC6E8AB0F54CE9740F76C
+/**
+ * What the person who opens the customer portal wants to do there.
+ */
+export enum PortalIntent {
+    buy = 0,
+    try = 1,
+    changePlan = 2,
+}

package/Portal/PortalLink.ts

@@ -0,0 +1,82 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// **DO NOT EDIT** - This file is an automatically generated file.
+// @generated by Cratis. Source: Cratis.Showrunner.BoxOffice.Portal.PortalLink, Cratis.Showrunner.BoxOffice.Portal.PortalLink. Time: 2026-10-31T13:17:43.2153370Z. Hash: F030CA3919A960F9398AE19085D9D6EBEAE801ADF3AC85195CCE96248C737744
+import { QueryFor, QueryResultWithState } from '@cratis/arc/queries';
+import { PerformQuery, QueryWhen, SetSorting, useQuery, useSuspenseQuery } from '@cratis/arc.react/queries';
+import { SliceLocation as ArcSliceLocation, ParameterDescriptor } from '@cratis/arc/reflection';
+import { Guid, field } from '@cratis/fundamentals';
+import { PortalIntent } from './PortalIntent';
+
+/**
+ * Gets a link to the customer portal for what the signed-in user wants to do there.
+ */
+export interface LinkToPortalParameters {
+
+    /**
+     * What the user wants to do.
+    */
+    intent: PortalIntent;
+
+    /**
+     * The offer the user looked at, when they did.
+    */
+    offer?: Guid;
+}
+
+
+/**
+ * Gets a link to the customer portal for what the signed-in user wants to do there.
+ */
+export class LinkToPortal extends QueryFor<PortalLink, LinkToPortalParameters> {
+    static readonly sliceLocation: ArcSliceLocation = new ArcSliceLocation('', '', 'Portal');
+    readonly route: string = '/api/portal/link-to-portal';
+    readonly queryName: string = 'Cratis.Showrunner.BoxOffice.Portal.PortalLink.LinkToPortal';
+    readonly treatWarningsAsErrors: boolean = false;
+    readonly roles: string[] = [];
+    readonly defaultValue: PortalLink = {} as PortalLink;
+
+    constructor() {
+        super(PortalLink, false);
+    }
+
+    get requiredRequestParameters(): string[] {
+        return [
+            'intent',
+        ];
+    }
+
+    readonly parameterDescriptors: ParameterDescriptor[] = [
+        new ParameterDescriptor('intent', Number, false),
+        new ParameterDescriptor('offer', Guid, false),
+    ];
+
+    intent!: PortalIntent;
+    offer!: Guid;
+
+
+    static use(args?: LinkToPortalParameters): [QueryResultWithState<PortalLink>, PerformQuery<LinkToPortalParameters>, SetSorting] {
+        return useQuery<PortalLink, LinkToPortal, LinkToPortalParameters>(LinkToPortal, args);
+    }
+
+    static useSuspense(args?: LinkToPortalParameters): [QueryResultWithState<PortalLink>, PerformQuery<LinkToPortalParameters>, SetSorting] {
+        return useSuspenseQuery<PortalLink, LinkToPortal, LinkToPortalParameters>(LinkToPortal, args);
+    }
+
+    static when(condition: boolean): QueryWhen<LinkToPortal, PortalLink, LinkToPortalParameters> {
+        return new QueryWhen<LinkToPortal, PortalLink, LinkToPortalParameters>(LinkToPortal, condition);
+    }
+}
+
+/**
+ * A link that opens the operator's customer portal for the signed-in user's tenant.
+ */
+export class PortalLink {
+
+    /**
+     * The link, which stops working after a while.
+     */
+    @field(String)
+    url!: string;
+}

package/Portal/index.ts

@@ -0,0 +1,5 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './PortalIntent';
+export * from './PortalLink';

package/README.md

@@ -1,3 +1,72 @@
-# Temporary Holding Version
+# Showrunner
 
-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.
+> Showrunner is a set of ready-made product parts for applications built on [Cratis](https://www.cratis.io) — drop-in backend and frontend packages, built as Arc and Chronicle vertical slices.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Build](https://github.com/Cratis/Showrunner/actions/workflows/build.yml/badge.svg)](https://github.com/Cratis/Showrunner/actions/workflows/build.yml)
+[![Publish](https://github.com/Cratis/Showrunner/actions/workflows/publish.yml/badge.svg)](https://github.com/Cratis/Showrunner/actions/workflows/publish.yml)
+[![Discord](https://img.shields.io/discord/1182595891576717413?label=Discord&logo=discord&logoColor=white)](https://discord.gg/kt4AMpV8WV)
+
+## 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](./Documentation/index.md).
+
+**Box Office** is the licensing part: trials, seats, modules, compute allowances and suspension, decided by the operator of a managed product and honored by the product. Its event contracts, its catalog of offers and prices, and a product's offering declaration and compute metering are in place; see [Documentation](./Documentation/BoxOffice/index.md).
+
+**Marquee** is the announcements part: the people running a product write an announcement with an audience, a display and an exact window, and the product shows it to the people it reaches, as a banner or a dialog. Drop `<Marquee />` into the application shell and it brings its own queries and commands; see [Documentation](./Documentation/Marquee/index.md).
+
+## Packages
+
+| Package | Registry | What it is |
+| --- | --- | --- |
+| `Cratis.Showrunner.BoxOffice.Catalog` | NuGet | Box Office's catalog — offers (seat plans, modules, compute packs), prices and the pricing arithmetic, published to products |
+| `Cratis.Showrunner.BoxOffice.Offering` | NuGet | Box Office for a product — declares what the product sells (modules, meters, seat licensing) and measures its compute per tenant and day |
+| `Cratis.Showrunner.BoxOffice.Contracts` | NuGet | Box Office's event contracts: what an operator decides about a tenant and what a product reports back |
+| `Cratis.Showrunner.Usher.Contracts` | NuGet | Usher's event contracts, for hosts that react to what Usher records |
+| `Cratis.Showrunner.Marquee.Contracts` | NuGet | Marquee's event contracts: the public events a product receives announcements through |
+| `Cratis.Showrunner.Marquee.Authoring` | NuGet | Marquee's authoring backend — commands, query and outbox for writing announcements, built on Arc and Chronicle |
+| `Cratis.Showrunner.Marquee` | NuGet | Marquee's backend for products — receives announcements once, shows each tenant what its audience matches and records acknowledgements |
+| `Cratis.Showrunner.Usher` | NuGet | Usher's backend — Arc commands and queries over Chronicle |
+| `@cratis/showrunner.marquee` | npm | The generated TypeScript proxies for Marquee's receiving commands and queries; no UI framework dependency |
+| `@cratis/showrunner.marquee.authoring` | npm | The generated TypeScript proxies for Marquee's authoring commands and query; no UI framework dependency |
+| `@cratis/showrunner.marquee.react` | npm | The Marquee drop-in React component: banners and dialogs for a product's announcements, built on `@cratis/arc.react` and `@cratis/components` |
+| `@cratis/showrunner.usher` | npm | The generated TypeScript proxies for Usher's commands and queries; no UI framework dependency |
+| `@cratis/showrunner.usher.react` | npm | React components for Usher, built on `@cratis/arc.react` and `@cratis/components` |
+
+## Building
+
+Prerequisites: the .NET SDK from [`global.json`](./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`.
+
+```shell
+# 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`](./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`](https://github.com/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](https://www.cratis.io) project, built on event sourcing with [Chronicle](https://github.com/Cratis/Chronicle) and CQRS with [Arc](https://github.com/Cratis/Arc), with frontends on [`@cratis/components`](https://github.com/Cratis/Components). Join the community on [Discord](https://discord.gg/kt4AMpV8WV).
+
+## License
+
+Showrunner is licensed under the [MIT License](LICENSE) and free to use.