@cratis/event-models 0.135.0 → 0.135.2

package/dist/screen-editor/FormDesigner/FieldMapping.d.ts

@@ -0,0 +1,9 @@
+import { FormField } from '@cratis/scene.model';
+import { FieldMappingKind } from './FieldMappingKind';
+/**
+ * A {@link FormField} together with the {@link FieldMappingKind} it classifies as - see `classifyFormFields`.
+ */
+export interface FieldMapping {
+    field: FormField;
+    kind: FieldMappingKind;
+}

package/dist/screen-editor/FormDesigner/FieldMappingKind.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The three population tiers a {@link FormField} can be in, plus the designer-only `Broken` state for a
+ * field whose source property no longer exists on the command - part of StudioIssues#157, surfacing the
+ * compiler's rename-breaks-the-build guarantee visually instead of only failing at build time.
+ */
+export declare enum FieldMappingKind {
+    /** `sourceProperty` and `composeUsing` are both unset - the field maps to a command property of the same name. */
+    AutoMapped = "autoMapped",
+    /** `sourceProperty` is set - the field maps to a differently-named command property. */
+    Renamed = "renamed",
+    /** `composeUsing` is set - the field's value is computed by a callback. */
+    Composed = "composed",
+    /** The field's source property (its own name, or `sourceProperty` when renamed) does not exist on the command. */
+    Broken = "broken"
+}

package/dist/screen-editor/FormDesigner/FormDesigner.d.ts

@@ -0,0 +1,16 @@
+import { Form } from '@cratis/scene.model';
+export interface FormDesignerProps {
+    form: Form;
+    /** The property names declared on the form's `forCommand` - see `classifyFormFields`. */
+    commandProperties: readonly string[];
+    /** Called with a field's name when its row is activated - the compose-using/rename affordances hand off to the caller rather than editing inline (see StudioIssues#157's open question). */
+    onFieldSelected?: (fieldName: string) => void;
+}
+/**
+ * The field mapping surface for a {@link Form} - StudioIssues#157. Shows the populate source and every
+ * field's mapping tier, with a `Broken` state for a field whose source property no longer exists on the
+ * command, surfacing the compiler's rename-breaks-the-build guarantee visually instead of only at build
+ * time. `Composed` fields hand off `onFieldSelected` to the caller rather than editing the callback
+ * inline - the callback is arbitrary C#, so this designer is not a code editor.
+ */
+export declare function FormDesigner({ form, commandProperties, onFieldSelected }: FormDesignerProps): import("react").JSX.Element;

package/dist/screen-editor/FormDesigner/PopulateSourceKind.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Which kind of `PopulateSource` a {@link Form} declares, or that it declares none - part of
+ * StudioIssues#157's populate-source picker.
+ */
+export declare enum PopulateSourceKind {
+    /** The form has no `populateSource` - its fields start empty. */
+    None = "none",
+    /** `populate via query <Query> [by <param>]`. */
+    ViaQuery = "viaQuery",
+    /** `populate from item`. */
+    FromItem = "fromItem"
+}

package/dist/screen-editor/FormDesigner/PopulateSourceSummary.d.ts

@@ -0,0 +1,21 @@
+import { PopulateSource } from '@cratis/scene.model';
+import { PopulateSourceKind } from './PopulateSourceKind';
+/**
+ * A display-ready summary of a {@link Form}'s `populateSource` - part of StudioIssues#157's
+ * populate-source picker.
+ */
+export interface PopulateSourceSummary {
+    kind: PopulateSourceKind;
+    queryName?: string;
+    parameterNames: string[];
+}
+/**
+ * Summarizes a {@link Form}'s `populateSource` for display. `PopulateSource` is a marker interface with no
+ * discriminant, so this narrows structurally on the property each variant actually declares
+ * (`queryName` for {@link PopulateViaQuery}, `itemBinding` for `PopulateFromItem`) - the same
+ * duck-typing approach `extractNavigationItem` (Cratis/Scene#2) uses for `Contribution.content.properties`.
+ *
+ * @param populateSource The form's `populateSource`, or `undefined` when it declares none.
+ * @returns The {@link PopulateSourceSummary}.
+ */
+export declare function summarizePopulateSource(populateSource: PopulateSource | undefined): PopulateSourceSummary;

package/dist/screen-editor/FormDesigner/classifyFormFields.d.ts

@@ -0,0 +1,13 @@
+import { Form } from '@cratis/scene.model';
+import { FieldMapping } from './FieldMapping';
+/**
+ * Classifies every field of a {@link Form} into its {@link FieldMappingKind} - part of StudioIssues#157's
+ * field mapping UI. `commandProperties` is the set of property names the form's `forCommand` actually
+ * declares (from the generated command proxy or the compiled Screenplay AST); this function does not fetch
+ * it, so the designer stays free to source that list however it has it in scope.
+ *
+ * @param form The {@link Form} whose fields to classify.
+ * @param commandProperties The property names declared on the form's target command.
+ * @returns One {@link FieldMapping} per field, in the form's own field order.
+ */
+export declare function classifyFormFields(form: Form, commandProperties: readonly string[]): FieldMapping[];

package/dist/screen-editor/ScreenEditor/Binding/bindingExpressionModel.d.ts

@@ -0,0 +1,8 @@
+import { BindingMode, BindingNullBehavior, BindingSourceKind, PropertyValueType, type BindingExpression, type InspectedProperty } from '@cratis/scene.model';
+export declare const allBindingSourceKinds: BindingSourceKind[];
+export declare const bindingModes: BindingMode[];
+export declare const bindingNullBehaviors: BindingNullBehavior[];
+export declare const expectedValueTypes: PropertyValueType[];
+export declare function isBindingExpression(value: unknown): value is BindingExpression;
+export declare function isBindingProperty(property: InspectedProperty): boolean;
+export declare function defaultBinding(property: InspectedProperty): BindingExpression;

package/dist/screen-editor/ScreenEditor/Binding/bindingSources.d.ts

@@ -0,0 +1,21 @@
+import { type EditingContext } from '@cratis/scene.engine';
+import type { QueryCandidate, SceneDocument, SceneElement } from '@cratis/scene.model';
+export interface ComponentOutputSource {
+    componentId: string;
+    label: string;
+    outputs: {
+        path: string;
+        label: string;
+        type: string;
+    }[];
+}
+export interface BindingSourceInventory {
+    dataContextPaths: string[];
+    queryResults: {
+        id: string;
+        name: string;
+        fields: string[];
+    }[];
+    componentOutputs: ComponentOutputSource[];
+}
+export declare function bindingSourceInventory(document: SceneDocument, roots: readonly SceneElement[], context: EditingContext, availableSources: Record<string, string>, candidates: readonly QueryCandidate[]): BindingSourceInventory;

package/dist/screen-editor/ScreenEditor/Inspector/BindingExpressionEditor.d.ts

@@ -0,0 +1,11 @@
+import { type BindingExpression, type InspectedProperty } from '@cratis/scene.model';
+import type { BindingSourceInventory } from '../Binding/bindingSources';
+import type { ScreenEditorStrings } from './ScreenEditorStrings';
+export interface BindingExpressionEditorProps {
+    property: InspectedProperty;
+    sources: BindingSourceInventory;
+    strings: ScreenEditorStrings;
+    disabled: boolean;
+    onChange: (binding: BindingExpression | undefined) => void;
+}
+export declare const BindingExpressionEditor: ({ property, sources, strings, disabled, onChange }: BindingExpressionEditorProps) => import("react").JSX.Element;

package/dist/screen-editor/ScreenEditor/Inspector/DesignTimeActionsSection.d.ts

@@ -0,0 +1,13 @@
+import type { ComponentDescriptor, ExternalComponent } from '@cratis/scene.model';
+import type { ScreenEditorController } from '../Host/ScreenEditorController';
+import type { ScreenEditorEnvironment } from '../Host/ScreenEditorHost';
+import type { ScreenEditorStrings } from './ScreenEditorStrings';
+export interface DesignTimeActionsSectionProps {
+    component: ExternalComponent;
+    descriptor: ComponentDescriptor;
+    controller: ScreenEditorController;
+    environment: ScreenEditorEnvironment;
+    strings: ScreenEditorStrings;
+    disabled: boolean;
+}
+export declare const DesignTimeActionsSection: ({ component, descriptor, controller, environment, strings, disabled }: DesignTimeActionsSectionProps) => import("react").JSX.Element | null;

package/dist/screen-editor/ScreenEditor/Inspector/FormAuthoringSection.d.ts

@@ -0,0 +1,10 @@
+import type { StateChangeSlice } from '../Actions/StateChangeSlice';
+import type { ScreenEditorController } from '../Host/ScreenEditorController';
+import type { ScreenEditorStrings } from './ScreenEditorStrings';
+export interface FormAuthoringSectionProps {
+    controller: ScreenEditorController;
+    slices: readonly StateChangeSlice[];
+    strings: ScreenEditorStrings;
+    disabled: boolean;
+}
+export declare const FormAuthoringSection: ({ controller, slices, strings, disabled }: FormAuthoringSectionProps) => import("react").JSX.Element | null;

package/dist/screen-editor/ScreenEditor/Inspector/ScreenEditorStrings.d.ts

@@ -45,6 +45,7 @@ export interface ScreenEditorStrings {
     properties: {
         diagnostics: string;
         noProperties: string;
+        designTimeActions: string;
         layoutType: string;
         changeLayout: string;
         confirmLayoutTitle: string;
@@ -59,6 +60,41 @@ export interface ScreenEditorStrings {
         icon: IconPropertyFieldStrings;
         iconPickerLabels?: IconPickerLabels;
         json?: JsonPropertyFieldStrings;
+        forms: {
+            label: string;
+            add: string;
+            chooseCommand: string;
+            mode: string;
+            auto: string;
+            manual: string;
+            fieldLabel: string;
+            sourceProperty: string;
+            remove: string;
+        };
+        binding: {
+            source: string;
+            sources: {
+                dataContext: string;
+                queryResult: string;
+                componentProperty: string;
+                literal: string;
+            };
+            path: string;
+            query: string;
+            component: string;
+            componentProperty: string;
+            literalValue: string;
+            mode: string;
+            inheritedMode: string;
+            nullBehavior: string;
+            defaultNullBehavior: string;
+            expectedType: string;
+            inferType: string;
+            noSource: string;
+            clear: string;
+            missingQuery: (query: string) => string;
+            missingComponent: (componentId: string) => string;
+        };
         query: {
             label: string;
             choose: string;

package/dist/screen-editor/ScreenEditor/Integration/BindingSourceChoice.d.ts

@@ -0,0 +1,6 @@
+import type { BindingSourceKind } from '@cratis/scene.model';
+export interface BindingSourceChoice {
+    kind: BindingSourceKind;
+    label: string;
+    disabled?: boolean;
+}

package/dist/screen-editor/ScreenEditor/Integration/BindingSourceChoiceInputs.d.ts

@@ -0,0 +1,4 @@
+export interface BindingSourceChoiceInputs {
+    queryResults: readonly string[];
+    componentOutputs: readonly string[];
+}

package/dist/screen-editor/ScreenEditor/Integration/CommandFormColumn.d.ts

@@ -0,0 +1,5 @@
+export interface CommandFormColumn {
+    property: string;
+    label: string;
+    width?: string;
+}

package/dist/screen-editor/ScreenEditor/Integration/CommandFormConfiguration.d.ts

@@ -0,0 +1,9 @@
+import type { CommandFormColumn } from './CommandFormColumn';
+import type { CommandFormInput } from './CommandFormInput';
+import { CommandFormMode } from './CommandFormMode';
+export interface CommandFormConfiguration {
+    command: string;
+    mode: CommandFormMode;
+    inputs: CommandFormInput[];
+    columns?: CommandFormColumn[];
+}

package/dist/screen-editor/ScreenEditor/Integration/CommandFormInput.d.ts

@@ -0,0 +1,9 @@
+import type { BindingExpression } from '@cratis/scene.model';
+export interface CommandFormInput {
+    property: string;
+    type: 'string' | 'guid';
+    label: string;
+    column?: number;
+    width?: string;
+    value?: BindingExpression;
+}

package/dist/screen-editor/ScreenEditor/Integration/CommandFormMode.d.ts

@@ -0,0 +1,4 @@
+export declare enum CommandFormMode {
+    Auto = "auto",
+    Manual = "manual"
+}

package/dist/screen-editor/ScreenEditor/Integration/DesignTimeActionExecutionContext.d.ts

@@ -0,0 +1,8 @@
+import type { EditingContext } from '@cratis/scene.engine';
+import type { SceneDocument } from '@cratis/scene.model';
+import type { DesignTimeActionContext } from '@cratis/scene.react';
+export interface DesignTimeActionExecutionContext {
+    document: SceneDocument;
+    editing: EditingContext;
+    actionContext: DesignTimeActionContext;
+}

package/dist/screen-editor/ScreenEditor/Integration/DesignTimeActionResult.d.ts

@@ -0,0 +1,7 @@
+import type { SceneDiagnostic, SceneDocument, SceneEdit } from '@cratis/scene.model';
+export interface DesignTimeActionResult {
+    document: SceneDocument;
+    diagnostics: (SceneDiagnostic | string)[];
+    edits: SceneEdit[];
+    applied: boolean;
+}

package/dist/screen-editor/ScreenEditor/Integration/bindingSourceChoices.d.ts

@@ -0,0 +1,3 @@
+import type { BindingSourceChoice } from './BindingSourceChoice';
+import type { BindingSourceChoiceInputs } from './BindingSourceChoiceInputs';
+export declare function bindingSourceChoices(inputs: BindingSourceChoiceInputs): BindingSourceChoice[];

package/dist/screen-editor/ScreenEditor/Integration/index.d.ts

@@ -0,0 +1,14 @@
+export type { BindingExpression, DestinationReference, DesignTimeActionDescriptor, SceneEdit } from '@cratis/scene.model';
+export { BindingMode, BindingNullBehavior, BindingSourceKind, DestinationKind } from '@cratis/scene.model';
+export type { DesignTimeAction, DesignTimeActionContext, PackageHostConfiguration } from '@cratis/scene.react';
+export type { EditingContext } from '@cratis/scene.engine';
+export * from './BindingSourceChoice';
+export * from './BindingSourceChoiceInputs';
+export * from './CommandFormColumn';
+export * from './CommandFormConfiguration';
+export * from './CommandFormInput';
+export * from './CommandFormMode';
+export * from './DesignTimeActionExecutionContext';
+export * from './DesignTimeActionResult';
+export * from './bindingSourceChoices';
+export * from './runDesignTimeAction';

package/dist/screen-editor/ScreenEditor/Integration/runDesignTimeAction.d.ts

@@ -0,0 +1,4 @@
+import type { DesignTimeAction } from '@cratis/scene.react';
+import type { DesignTimeActionExecutionContext } from './DesignTimeActionExecutionContext';
+import type { DesignTimeActionResult } from './DesignTimeActionResult';
+export declare function runDesignTimeAction(action: DesignTimeAction, context: DesignTimeActionExecutionContext): DesignTimeActionResult;

package/dist/screen-editor/ScreenEditor/index.d.ts

@@ -34,6 +34,7 @@ export * from './Layouts/toLayoutContainerDescriptors';
 export * from './Palette/buildPalette';
 export * from './Actions/StateChangeSlice';
 export * from './Binding/toSceneCandidates';
+export * from './Integration';
 export * from './Document/readSceneDocument';
 export * from './Structure/Ownership';
 export * from './Structure/StructureEditRejection';