@cratis/stage.runtime 4.215.0 → 4.216.0

package/dist/src/navigationTree.d.ts

@@ -72,6 +72,6 @@ export declare function opensElsewhere(destination: DestinationReference): boole
  * @param screens The scene's screens.
  * @param listed The names of the screens an authored entry opens.
  * @param fallback The group a screen with no recorded place goes under.
- * @returns One entry for every unlisted screen, labelled with its own name.
+ * @returns One entry for every unlisted screen, labelled with its title (see `screenTitle`).
  */
 export declare function unlistedNavigationEntries(screens: Screen[], listed: ReadonlySet<string>, fallback: string): NavigationEntry[];

package/dist/src/readableValue.d.ts

@@ -0,0 +1,10 @@
+/**
+ * A value of a table cell the way a person reads it, recognised by its runtime type or its ISO format.
+ *
+ * A boolean reads Yes or No; an ISO date or date-time reads in the user's locale. Anything else - or a text that only looks like a date
+ * but is not one - is left as it is.
+ *
+ * @param value The value the row carries.
+ * @returns The text to show, or undefined when the value is not one this reads.
+ */
+export declare function readableValue(value: unknown): string | undefined;

package/dist/src/screenTitle.d.ts

@@ -0,0 +1,11 @@
+import type { Screen } from '@cratis/scene.model';
+/**
+ * What a screen is called where the application lists it - in the navigation and the breadcrumb - when the model gave it no label.
+ *
+ * Only a title at the top of the screen's body names it; a title inside a section or another element names that part, not the screen.
+ *
+ * @param screen The screen.
+ * @returns The text of the first `core:title` among the elements at the top of the screen's body (the `content` or `main` slot first),
+ * otherwise the screen's name humanized, without a trailing Screen, Page or Dialog.
+ */
+export declare function screenTitle(screen: Pick<Screen, 'name' | 'slotContent'>): string;

package/dist/src/stageBoardSelection.d.ts

@@ -0,0 +1,5 @@
+import type { SceneElement } from '@cratis/scene.model';
+/** Whether a component is a blueprint board whose query rows can be selected. */
+export declare function isBoardComponent(name: string): boolean;
+/** Enables the board's native selectedItem output so toolbar actions can act on its original query row. */
+export declare function withBoardSelection(element: SceneElement): SceneElement;

package/dist/src/stageComponentOutputs.d.ts

@@ -7,4 +7,6 @@
  *
  * @returns The callback to hand the tree's `SceneElementView`.
  */
-export declare function useComponentOutputsPublisher(): (outputs: Record<string, Record<string, unknown>>) => void;
+export declare function useComponentOutputsPublisher(): ((outputs: Record<string, Record<string, unknown>>) => void) & {
+    readonly scope: string;
+};

package/dist/src/stageFormContinuation.d.ts

@@ -0,0 +1,12 @@
+import type { ExternalComponent } from '@cratis/scene.model';
+import type { InteractionScopeValue } from '@cratis/scene.react';
+type Completed = (messages: string[], navigated: boolean) => void;
+type Continuation = {
+    messages: string[];
+    complete: (response: unknown, completed: Completed) => Promise<void>;
+};
+/** Admits a form's successful-submit actions before the command can commit, then runs them in an invocation-local Scene response context. */
+export declare function formContinuation(element: ExternalComponent, form: {
+    command: string;
+} | undefined, scope: InteractionScopeValue | undefined): Continuation;
+export {};

package/dist/src/stageFormSchema.d.ts

@@ -1,3 +1,10 @@
+import { humanize } from './humanize';
+/** A modeled list query whose rows supply a reference key and display text; StageRoutes supplies its URL. */
+export interface SchemaReference {
+    query: string;
+    value: string;
+    label: string;
+}
 /**
  * What a command's presentation schema says about one property, in the terms a form needs: its scalar type, the
  * values an enumeration declares, the members of a record and the element of a collection.
@@ -6,6 +13,7 @@ export interface SchemaProperty {
     name: string;
     /** The identifier concept of a uuid property (`x-concept`) - `BasketId`; what a session holds one value of. */
     identifier?: string;
+    reference?: SchemaReference;
     /**
      * Whether this is the identifier the command acts on (`x-identity`) - the basket an add to basket appends to - rather than a reference to
      * another entity, such as the product it adds. Only the schema a task dialog is built from says so.
@@ -23,13 +31,15 @@ export interface SchemaProperty {
     /** Whether a date also carries a time of day. */
     withTime?: boolean;
 }
+/** Whether the command creates an entity whose identity the runtime allocates, rather than acting on a selected row. */
+export declare function createsEntity(schema: string): boolean;
 /**
  * The properties a command's JSON schema declares, with the type the native form gives each and whether it is required. A toolbar
  * slice's task dialog is built from the same reading, so a command is the same fields wherever it is presented.
  */
 export declare function schemaPropertiesOf(schema: string): SchemaProperty[];
 /** Humanizes a member name the way a field label reads: `postalCode` is “Postal code”. */
-export declare function humanize(name: string): string;
+export { humanize };
 /**
  * What is missing from a record or collection a form is about to submit: a member the schema requires that holds nothing.
  *

package/dist/src/stageResponseContracts.d.ts

@@ -0,0 +1,9 @@
+import type { ResponseContract, ResponseValidationContracts, ResponseValueType } from '@cratis/scene.engine';
+/** Typed transport metadata; absence is deliberately not an untyped successful response. */
+export interface StageResponseContracts {
+    commands: Record<string, ResponseContract | null>;
+    commandInputs: Record<string, Record<string, ResponseValueType | null>>;
+    screenInputs: Record<string, Record<string, ResponseValueType | null>>;
+}
+/** Adapts modeled contracts to Scene's validator without resolving or evaluating a response. */
+export declare function stageResponseContracts(metadata?: StageResponseContracts): ResponseValidationContracts;

package/dist/src/stageScreenTables.d.ts

@@ -1,15 +1,16 @@
 import type { ReactNode } from 'react';
 import type { SceneElement } from '@cratis/scene.model';
 /**
- * The table ids of one screen, including tables nested in its slots. An outlet belongs to another screen, so its children are not visited.
+ * The row-source scopes of one screen, including tables and board card queries nested in its slots. An outlet belongs to another screen, so its children are not visited.
  *
  * @param element The composed screen.
- * @returns The distinct table ids, in first-use order, matching the scopes under which tables publish their queries and selections.
+ * @returns The distinct source scopes, in first-use order, matching the queries and components that publish selectable rows.
  */
 export declare function screenTablesOf(element: SceneElement): string[];
-/** Limits action selection and hidden form identifiers to the tables of this screen, independently of other screens on the page. */
-export declare function StageScreenTables({ element, children }: {
+/** Limits action selection and hidden form identifiers to the tables and boards of this screen, independently of other screens on the page. */
+export declare function StageScreenTables({ element, outputScope, children }: {
     element: SceneElement;
+    outputScope?: string;
     children: ReactNode;
 }): import("react").JSX.Element;
 /** Preserves the page-wide selection of a confirmation decision and its form after leaving the list screen. */
@@ -17,8 +18,8 @@ export declare function StagePageRows({ children }: {
     children: ReactNode;
 }): import("react").JSX.Element;
 /**
- * The rows a person could select and has selected in this screen's tables, each carrying the entity keys the command form recognizes.
- * Queries published for `data:` declarations or `binding:` values and tables on other screens cannot gate an action or fill its identifier.
+ * The rows a person could select and has selected in this screen's tables and boards, each carrying the entity keys the command form recognizes.
+ * Only a board's card query admits a `binding:` source; unrelated bindings, `data:` declarations and other screens cannot gate an action or fill its identifier.
  * Without a screen provider, direct consumers retain the page-wide behavior.
  */
 export declare function useScreenRows(): {

package/dist/src/stageShell.d.ts

@@ -9,6 +9,8 @@ export interface StageShellSettings {
     menuTheme?: MenuTheme;
     /** Whether the shell draws its footer; the `showFooter` option, drawn unless it is `false`. */
     showFooter: boolean;
+    /** Whether the shell offers the theme switcher: the `showThemeSwitcher` option, unless the profile pins a colour scheme, which leaves nothing to switch. */
+    showThemeSwitcher: boolean;
     /** The theme the colour scheme selects, by name. */
     themeName?: string;
     /** The colour scheme the sidebar and the page follow. */
@@ -34,6 +36,8 @@ export declare const knownShellOptions: readonly string[];
  * @returns The settings, with every option or value that could not be applied.
  */
 export declare function stageShellSettings(profile: UiProfile | undefined, shell: EffectiveShell, prefersDark?: boolean): StageShellSettings;
+/** The chrome options the settings ask of the application's composition: whether it draws its footer and offers the theme switcher. Both default to on. */
+export declare function shellChromeOf(settings: StageShellSettings | undefined): Pick<StageShellSettings, 'showFooter' | 'showThemeSwitcher'>;
 /**
  * What stops an application starting with the root template its profile names: the template is unknown, its blueprint is not
  * installed, its version pin is not satisfied or it cannot be a shell. A page that cannot be drawn in the shell it asked for

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cratis/stage.runtime",
-  "version": "4.215.0",
+  "version": "4.216.0",
   "description": "The Cratis Stage application runtime for Arc and Scene",
   "author": "Cratis",
   "type": "module",
@@ -43,7 +43,7 @@
   "peerDependencies": {
     "@cratis/arc": "22.146.0",
     "@cratis/arc.react": "22.146.0",
-    "@cratis/components": "4.34.0",
+    "@cratis/components": "4.38.1",
     "@cratis/fundamentals": "7.27.0",
     "@cratis/scene.blueprint.default": "4.86.0",
     "@cratis/scene.components": "4.86.0",