@cratis/stage.runtime 4.207.1 → 4.209.0

package/dist/src/stageActionSubject.d.ts

@@ -0,0 +1,35 @@
+import type { ExternalComponent } from '@cratis/scene.model';
+import { type SchemaProperty } from './stageFormSchema';
+/**
+ * The explicit subject of an action (Screenplay decision 0110, Cratis/Stage#855): `for item` acts on the one selected row, `for screen` on the
+ * screen itself. Stage carries it as the scene properties `actionSubject` and `subjectInputs` until Scene ships a typed `ActionSubject`. An
+ * omitted subject is `undefined` and keeps every existing behavior.
+ */
+export type ActionSubject = 'item' | 'screen';
+/** The rows a screen offers for selecting and the ones that are selected. */
+export interface ScreenRows {
+    selectableRows: Record<string, unknown>[];
+    selectedRows: Record<string, unknown>[];
+}
+/** What a command form reads of its action's subject: the rows it may use, whether it is a row action and the values bound from the row. */
+export interface SubjectForm extends ScreenRows {
+    rowAction: boolean;
+    subjectValues: Record<string, unknown>;
+}
+/** The explicit subject an action element names, or nothing when the subject was omitted. */
+export declare function actionSubjectOf(element: ExternalComponent): ActionSubject | undefined;
+/** The one selected row an `item` subject acts on; no subject, a `screen` subject and two or more selected rows name none. */
+export declare function subjectRowOf(subject: ActionSubject | undefined, selectedRows: Record<string, unknown>[]): Record<string, unknown> | undefined;
+/** Whether an action waits, visible and disabled: a `for item` action without its one selected row. */
+export declare function awaitsSubjectRow(subject: ActionSubject | undefined, row: Record<string, unknown> | undefined): boolean;
+/** What a command form reads: a `screen` subject never reads a selection, and values bound from a row arrive with the opened action. */
+export declare function subjectFormOf(element: ExternalComponent, rows: ScreenRows): SubjectForm;
+/** The properties a toolbar item hands the action it becomes: its subject and inputs, and a row action unless the screen is the subject. */
+export declare function subjectActionProperties(element: ExternalComponent, subject: ActionSubject | undefined): Record<string, unknown>;
+/** The command inputs an action binds from the selected row (`with <input> from item.<path>`), by input name. Empty values are dropped. */
+export declare function subjectInputValues(element: ExternalComponent, row: Record<string, unknown>): Record<string, unknown>;
+/**
+ * The action an `item` subject opens: a row action whose bound inputs come from the selected row, and whose form asks for neither those inputs
+ * nor a required identifier the row carries. A form with no fields of its own starts from every property of the command, so what remains is asked.
+ */
+export declare function itemSubjectElement(element: ExternalComponent, schema: SchemaProperty[], row: Record<string, unknown>): ExternalComponent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cratis/stage.runtime",
-  "version": "4.207.1",
+  "version": "4.209.0",
   "description": "The Cratis Stage application runtime for Arc and Scene",
   "author": "Cratis",
   "type": "module",
@@ -41,8 +41,8 @@
     "test": "vitest run"
   },
   "peerDependencies": {
-    "@cratis/arc": "22.131.0",
-    "@cratis/arc.react": "22.131.0",
+    "@cratis/arc": "22.143.0",
+    "@cratis/arc.react": "22.143.0",
     "@cratis/components": "4.34.0",
     "@cratis/fundamentals": "7.26.0",
     "@cratis/scene.blueprint.default": "4.80.2",