@cratis/scene.engine 4.27.0 → 4.28.0

package/dist/esm/toolbar/SliceDialogSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SliceDialogSource.d.ts","sourceRoot":"","sources":["../../../toolbar/SliceDialogSource.ts"],"names":[],"mappings":"AAMA,oBAAY,iBAAiB;IAEzB,KAAK,UAAU;IAGf,OAAO,YAAY;CACtB"}

package/dist/esm/toolbar/SliceDialogSource.js

@@ -0,0 +1,12 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Where a slice's dialog template comes from.
+ */ var SliceDialogSource = /*#__PURE__*/ function(SliceDialogSource) {
+    /** The slice names its own dialog template. */ SliceDialogSource["Slice"] = "slice";
+    /** The slice names none, so the default form dialog is used. */ SliceDialogSource["Default"] = "default";
+    return SliceDialogSource;
+}({});
+
+export { SliceDialogSource };
+//# sourceMappingURL=SliceDialogSource.js.map

package/dist/esm/toolbar/SliceDialogSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SliceDialogSource.js","sources":["../../../toolbar/SliceDialogSource.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\n/**\n * Where a slice's dialog template comes from.\n */\nexport enum SliceDialogSource {\n    /** The slice names its own dialog template. */\n    Slice = 'slice',\n\n    /** The slice names none, so the default form dialog is used. */\n    Default = 'default',\n}\n"],"names":["SliceDialogSource"],"mappings":"AAAA;AACA;AAEA;;IAGO,IAAKA,iBAAAA,iBAAAA,SAAAA,iBAAAA,EAAAA;oDACqC,iBAAA,CAAA,OAAA,CAAA,GAAA,OAAA;qEAGiB,iBAAA,CAAA,SAAA,CAAA,GAAA,SAAA;AAJtDA,IAAAA,OAAAA,iBAAAA;AAMX,CAAA,CAAA,EAAA;;"}

package/dist/esm/toolbar/ToolbarDiagnostic.d.ts

@@ -0,0 +1,9 @@
+import { ToolbarDiagnosticCode } from './ToolbarDiagnosticCode';
+import { ToolbarDiagnosticSeverity } from './ToolbarDiagnosticSeverity';
+export interface ToolbarDiagnostic {
+    code: ToolbarDiagnosticCode;
+    severity: ToolbarDiagnosticSeverity;
+    message: string;
+    button: string;
+}
+//# sourceMappingURL=ToolbarDiagnostic.d.ts.map

package/dist/esm/toolbar/ToolbarDiagnostic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarDiagnostic.d.ts","sourceRoot":"","sources":["../../../toolbar/ToolbarDiagnostic.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAKxE,MAAM,WAAW,iBAAiB;IAE9B,IAAI,EAAE,qBAAqB,CAAC;IAG5B,QAAQ,EAAE,yBAAyB,CAAC;IAGpC,OAAO,EAAE,MAAM,CAAC;IAGhB,MAAM,EAAE,MAAM,CAAC;CAClB"}

package/dist/esm/toolbar/ToolbarDiagnostic.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ToolbarDiagnostic.js.map

package/dist/esm/toolbar/ToolbarDiagnostic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarDiagnostic.js","sourceRoot":"","sources":["../../../toolbar/ToolbarDiagnostic.ts"],"names":[],"mappings":""}

package/dist/esm/toolbar/ToolbarDiagnosticCode.d.ts

@@ -0,0 +1,6 @@
+export declare enum ToolbarDiagnosticCode {
+    ToolbarButtonSliceNotFound = "toolbarButtonSliceNotFound",
+    ToolbarButtonSliceNotStateChange = "toolbarButtonSliceNotStateChange",
+    ToolbarButtonSliceEmpty = "toolbarButtonSliceEmpty"
+}
+//# sourceMappingURL=ToolbarDiagnosticCode.d.ts.map

package/dist/esm/toolbar/ToolbarDiagnosticCode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarDiagnosticCode.d.ts","sourceRoot":"","sources":["../../../toolbar/ToolbarDiagnosticCode.ts"],"names":[],"mappings":"AAOA,oBAAY,qBAAqB;IAE7B,0BAA0B,+BAA+B;IAGzD,gCAAgC,qCAAqC;IAGrE,uBAAuB,4BAA4B;CACtD"}

package/dist/esm/toolbar/ToolbarDiagnosticCode.js

@@ -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.
+/**
+ * What is wrong with a toolbar button. The values are shared with the C# engine so both report the same code for
+ * the same toolbar.
+ */ var ToolbarDiagnosticCode = /*#__PURE__*/ function(ToolbarDiagnosticCode) {
+    /** A button invokes a slice the application structure does not have. */ ToolbarDiagnosticCode["ToolbarButtonSliceNotFound"] = "toolbarButtonSliceNotFound";
+    /** A button invokes a slice that is not a state change; state views and automations never take user input. */ ToolbarDiagnosticCode["ToolbarButtonSliceNotStateChange"] = "toolbarButtonSliceNotStateChange";
+    /** A button has no slice yet. It is allowed while designing, and flagged. */ ToolbarDiagnosticCode["ToolbarButtonSliceEmpty"] = "toolbarButtonSliceEmpty";
+    return ToolbarDiagnosticCode;
+}({});
+
+export { ToolbarDiagnosticCode };
+//# sourceMappingURL=ToolbarDiagnosticCode.js.map

package/dist/esm/toolbar/ToolbarDiagnosticCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarDiagnosticCode.js","sources":["../../../toolbar/ToolbarDiagnosticCode.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\n/**\n * What is wrong with a toolbar button. The values are shared with the C# engine so both report the same code for\n * the same toolbar.\n */\nexport enum ToolbarDiagnosticCode {\n    /** A button invokes a slice the application structure does not have. */\n    ToolbarButtonSliceNotFound = 'toolbarButtonSliceNotFound',\n\n    /** A button invokes a slice that is not a state change; state views and automations never take user input. */\n    ToolbarButtonSliceNotStateChange = 'toolbarButtonSliceNotStateChange',\n\n    /** A button has no slice yet. It is allowed while designing, and flagged. */\n    ToolbarButtonSliceEmpty = 'toolbarButtonSliceEmpty',\n}\n"],"names":["ToolbarDiagnosticCode"],"mappings":"AAAA;AACA;AAEA;;;IAIO,IAAKA,qBAAAA,iBAAAA,SAAAA,qBAAAA,EAAAA;6EAC8D,qBAAA,CAAA,4BAAA,CAAA,GAAA,4BAAA;mHAGsC,qBAAA,CAAA,kCAAA,CAAA,GAAA,kCAAA;kFAGjC,qBAAA,CAAA,yBAAA,CAAA,GAAA,yBAAA;AAPnEA,IAAAA,OAAAA,qBAAAA;AASX,CAAA,CAAA,EAAA;;"}

package/dist/esm/toolbar/ToolbarDiagnosticSeverity.d.ts

@@ -0,0 +1,5 @@
+export declare enum ToolbarDiagnosticSeverity {
+    Error = "error",
+    Warning = "warning"
+}
+//# sourceMappingURL=ToolbarDiagnosticSeverity.d.ts.map

package/dist/esm/toolbar/ToolbarDiagnosticSeverity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarDiagnosticSeverity.d.ts","sourceRoot":"","sources":["../../../toolbar/ToolbarDiagnosticSeverity.ts"],"names":[],"mappings":"AAMA,oBAAY,yBAAyB;IAEjC,KAAK,UAAU;IAGf,OAAO,YAAY;CACtB"}

package/dist/esm/toolbar/ToolbarDiagnosticSeverity.js

@@ -0,0 +1,12 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * How serious a toolbar diagnostic is.
+ */ var ToolbarDiagnosticSeverity = /*#__PURE__*/ function(ToolbarDiagnosticSeverity) {
+    /** The button cannot work. */ ToolbarDiagnosticSeverity["Error"] = "error";
+    /** The button is allowed but incomplete. */ ToolbarDiagnosticSeverity["Warning"] = "warning";
+    return ToolbarDiagnosticSeverity;
+}({});
+
+export { ToolbarDiagnosticSeverity };
+//# sourceMappingURL=ToolbarDiagnosticSeverity.js.map

package/dist/esm/toolbar/ToolbarDiagnosticSeverity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarDiagnosticSeverity.js","sources":["../../../toolbar/ToolbarDiagnosticSeverity.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\n/**\n * How serious a toolbar diagnostic is.\n */\nexport enum ToolbarDiagnosticSeverity {\n    /** The button cannot work. */\n    Error = 'error',\n\n    /** The button is allowed but incomplete. */\n    Warning = 'warning',\n}\n"],"names":["ToolbarDiagnosticSeverity"],"mappings":"AAAA;AACA;AAEA;;IAGO,IAAKA,yBAAAA,iBAAAA,SAAAA,yBAAAA,EAAAA;mCACoB,yBAAA,CAAA,OAAA,CAAA,GAAA,OAAA;iDAGc,yBAAA,CAAA,SAAA,CAAA,GAAA,SAAA;AAJlCA,IAAAA,OAAAA,yBAAAA;AAMX,CAAA,CAAA,EAAA;;"}

package/dist/esm/toolbar/index.d.ts

@@ -0,0 +1,10 @@
+export * from './ToolbarDiagnosticCode';
+export * from './ToolbarDiagnosticSeverity';
+export * from './ToolbarDiagnostic';
+export * from './SliceDialogSource';
+export * from './SliceDialog';
+export * from './ResolvedToolbarButton';
+export * from './sliceDialogFor';
+export * from './toolbarButtons';
+export * from './validateToolbarButtons';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/toolbar/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../toolbar/index.ts"],"names":[],"mappings":"AAGA,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC"}

package/dist/esm/toolbar/index.js

@@ -0,0 +1,10 @@
+export * from './ToolbarDiagnosticCode';
+export * from './ToolbarDiagnosticSeverity';
+export * from './ToolbarDiagnostic';
+export * from './SliceDialogSource';
+export * from './SliceDialog';
+export * from './ResolvedToolbarButton';
+export * from './sliceDialogFor';
+export * from './toolbarButtons';
+export * from './validateToolbarButtons';
+//# sourceMappingURL=index.js.map

package/dist/esm/toolbar/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../toolbar/index.ts"],"names":[],"mappings":"AAGA,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC"}

package/dist/esm/toolbar/sliceDialogFor.d.ts

@@ -0,0 +1,5 @@
+import { ApplicationStructureIndex } from '../structure';
+import { SliceDialog } from './SliceDialog';
+export declare const defaultSliceDialogTemplate = "FormDialog";
+export declare function sliceDialogFor(index: ApplicationStructureIndex, sliceId: string, defaultTemplate?: string): SliceDialog | undefined;
+//# sourceMappingURL=sliceDialogFor.d.ts.map

package/dist/esm/toolbar/sliceDialogFor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sliceDialogFor.d.ts","sourceRoot":"","sources":["../../../toolbar/sliceDialogFor.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAI5C,eAAO,MAAM,0BAA0B,eAAe,CAAC;AAavD,wBAAgB,cAAc,CAAC,KAAK,EAAE,yBAAyB,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAQnI"}

package/dist/esm/toolbar/sliceDialogFor.js

@@ -0,0 +1,35 @@
+import { SliceKind } from '@cratis/scene.model';
+import { SliceDialogSource } from './SliceDialogSource.js';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** The dialog template used when a slice names none. */ const defaultSliceDialogTemplate = 'FormDialog';
+/**
+ * Works out the task dialog a state change slice opens, once, so no host decides it again (TB4): the slice's own
+ * dialog template when it names one, else the default form dialog.
+ *
+ * The C# engine (`SliceDialogs.For`) resolves the same dialog; both are asserted against `toolbar-slice-fixtures.json`.
+ *
+ * @param index The modules, features and slices of the application.
+ * @param sliceId The slice's qualified id.
+ * @param defaultTemplate The template used when the slice names none; {@link defaultSliceDialogTemplate} when absent.
+ * @returns The dialog, or undefined when there is no such slice or it is not a state change.
+ */ function sliceDialogFor(index, sliceId, defaultTemplate) {
+    const slice = index.findSlice(sliceId);
+    if (slice?.kind !== SliceKind.StateChange) return undefined;
+    const command = slice.command ?? slice.id;
+    return slice.dialogTemplate ? {
+        slice: sliceId,
+        command,
+        template: slice.dialogTemplate,
+        source: SliceDialogSource.Slice
+    } : {
+        slice: sliceId,
+        command,
+        template: defaultTemplate ?? defaultSliceDialogTemplate,
+        source: SliceDialogSource.Default
+    };
+}
+
+export { defaultSliceDialogTemplate, sliceDialogFor };
+//# sourceMappingURL=sliceDialogFor.js.map

package/dist/esm/toolbar/sliceDialogFor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sliceDialogFor.js","sources":["../../../toolbar/sliceDialogFor.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { SliceKind } from '@cratis/scene.model';\nimport { ApplicationStructureIndex } from '../structure';\nimport { SliceDialog } from './SliceDialog';\nimport { SliceDialogSource } from './SliceDialogSource';\n\n/** The dialog template used when a slice names none. */\nexport const defaultSliceDialogTemplate = 'FormDialog';\n\n/**\n * Works out the task dialog a state change slice opens, once, so no host decides it again (TB4): the slice's own\n * dialog template when it names one, else the default form dialog.\n *\n * The C# engine (`SliceDialogs.For`) resolves the same dialog; both are asserted against `toolbar-slice-fixtures.json`.\n *\n * @param index The modules, features and slices of the application.\n * @param sliceId The slice's qualified id.\n * @param defaultTemplate The template used when the slice names none; {@link defaultSliceDialogTemplate} when absent.\n * @returns The dialog, or undefined when there is no such slice or it is not a state change.\n */\nexport function sliceDialogFor(index: ApplicationStructureIndex, sliceId: string, defaultTemplate?: string): SliceDialog | undefined {\n    const slice = index.findSlice(sliceId);\n    if (slice?.kind !== SliceKind.StateChange) return undefined;\n\n    const command = slice.command ?? slice.id;\n    return slice.dialogTemplate\n        ? { slice: sliceId, command, template: slice.dialogTemplate, source: SliceDialogSource.Slice }\n        : { slice: sliceId, command, template: defaultTemplate ?? defaultSliceDialogTemplate, source: SliceDialogSource.Default };\n}\n"],"names":["defaultSliceDialogTemplate","sliceDialogFor","index","sliceId","defaultTemplate","slice","findSlice","kind","SliceKind","StateChange","undefined","command","id","dialogTemplate","template","source","SliceDialogSource","Slice","Default"],"mappings":";;;AAAA;AACA;AAOA,yDACO,MAAMA,0BAAAA,GAA6B;AAE1C;;;;;;;;;;AAUC,IACM,SAASC,cAAAA,CAAeC,KAAgC,EAAEC,OAAe,EAAEC,eAAwB,EAAA;IACtG,MAAMC,KAAAA,GAAQH,KAAAA,CAAMI,SAAS,CAACH,OAAAA,CAAAA;AAC9B,IAAA,IAAIE,KAAAA,EAAOE,IAAAA,KAASC,SAAAA,CAAUC,WAAW,EAAE,OAAOC,SAAAA;AAElD,IAAA,MAAMC,OAAAA,GAAUN,KAAAA,CAAMM,OAAO,IAAIN,MAAMO,EAAE;IACzC,OAAOP,KAAAA,CAAMQ,cAAc,GACrB;QAAER,KAAAA,EAAOF,OAAAA;AAASQ,QAAAA,OAAAA;AAASG,QAAAA,QAAAA,EAAUT,MAAMQ,cAAc;AAAEE,QAAAA,MAAAA,EAAQC,kBAAkBC;KAAM,GAC3F;QAAEZ,KAAAA,EAAOF,OAAAA;AAASQ,QAAAA,OAAAA;AAASG,QAAAA,QAAAA,EAAUV,eAAAA,IAAmBJ,0BAAAA;AAA4Be,QAAAA,MAAAA,EAAQC,kBAAkBE;AAAQ,KAAA;AAChI;;"}

package/dist/esm/toolbar/toolbarButtons.d.ts

@@ -0,0 +1,10 @@
+import { ToolbarButton } from '@cratis/scene.model';
+import { ApplicationStructureIndex } from '../structure';
+import { ResolvedToolbarButton } from './ResolvedToolbarButton';
+export declare function toolbarButtonFromItem(id: string, properties: Record<string, unknown>): ToolbarButton | undefined;
+export declare function normalizeToolbarButton(index: ApplicationStructureIndex, button: ToolbarButton): {
+    button: ToolbarButton;
+    converted: boolean;
+};
+export declare function resolveToolbarButton(index: ApplicationStructureIndex, button: ToolbarButton, defaultDialogTemplate?: string): ResolvedToolbarButton;
+//# sourceMappingURL=toolbarButtons.d.ts.map

package/dist/esm/toolbar/toolbarButtons.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toolbarButtons.d.ts","sourceRoot":"","sources":["../../../toolbar/toolbarButtons.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAmB,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAkBhE,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa,GAAG,SAAS,CAiBhH;AASD,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,aAAa,GAAG;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAE,CAS7I;AAYD,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,aAAa,EAAE,qBAAqB,CAAC,EAAE,MAAM,GAAG,qBAAqB,CAYnJ"}

package/dist/esm/toolbar/toolbarButtons.js

@@ -0,0 +1,89 @@
+import { ToolbarEmphasis } from '@cratis/scene.model';
+import { sliceDialogFor } from './sliceDialogFor.js';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+function text(properties, name) {
+    const value = properties[name];
+    return typeof value === 'string' && value.length > 0 ? value : undefined;
+}
+/**
+ * Reads a button from the properties of a `core:toolbarItem` element: `label` (or `name`), `kind`, `slice`,
+ * `emphasis`, `icon` and `target`.
+ *
+ * The C# engine (`ToolbarButtons.FromItem`) reads the same; both are asserted against `toolbar-slice-fixtures.json`.
+ *
+ * @param id The element id.
+ * @param properties The element properties.
+ * @returns The button, or undefined when the item does not invoke a command or slice - a navigate or dialog item.
+ */ function toolbarButtonFromItem(id, properties) {
+    const slice = text(properties, 'slice');
+    const action = text(properties, 'kind')?.toLowerCase() === 'action';
+    if (slice === undefined && !action) return undefined;
+    const button = {
+        id,
+        title: text(properties, 'label') ?? text(properties, 'name') ?? id
+    };
+    if (slice !== undefined) button.slice = slice;
+    const emphasis = text(properties, 'emphasis')?.toLowerCase();
+    if (emphasis === ToolbarEmphasis.Primary || emphasis === ToolbarEmphasis.Secondary || emphasis === ToolbarEmphasis.Quiet) button.emphasis = emphasis;
+    const icon = text(properties, 'icon');
+    if (icon !== undefined) button.icon = icon;
+    const target = text(properties, 'target');
+    if (target !== undefined) button.target = target;
+    return button;
+}
+/**
+ * Converts a hand-authored button to a slice-backed one: a button with no slice whose command is accepted by exactly
+ * one state change slice names that slice instead.
+ * @param index The modules, features and slices of the application.
+ * @param button The button.
+ * @returns The button to use, and whether it was converted. A button that cannot be converted is returned as it is.
+ */ function normalizeToolbarButton(index, button) {
+    if (button.slice || !button.target) return {
+        button,
+        converted: false
+    };
+    const matches = index.findSlicesByCommand(button.target);
+    if (matches.length !== 1) return {
+        button,
+        converted: false
+    };
+    const { target, ...rest } = button;
+    return {
+        button: {
+            ...rest,
+            slice: matches[0]
+        },
+        converted: true
+    };
+}
+/**
+ * Resolves a button: its slice, command and task dialog, without any rendering. This is what a renderer, Stage and the
+ * Studio preview call.
+ *
+ * The C# engine (`ToolbarButtons.Resolve`) resolves the same; both are asserted against `toolbar-slice-fixtures.json`.
+ *
+ * @param index The modules, features and slices of the application.
+ * @param button The button.
+ * @param defaultDialogTemplate The dialog template used when a slice names none.
+ */ function resolveToolbarButton(index, button, defaultDialogTemplate) {
+    const { button: normalized, converted } = normalizeToolbarButton(index, button);
+    const dialog = normalized.slice ? sliceDialogFor(index, normalized.slice, defaultDialogTemplate) : undefined;
+    const resolved = {
+        id: normalized.id,
+        title: normalized.title,
+        emphasis: normalized.emphasis ?? ToolbarEmphasis.Secondary,
+        converted
+    };
+    if (normalized.icon !== undefined) resolved.icon = normalized.icon;
+    if (normalized.slice) resolved.slice = normalized.slice;
+    if (dialog) {
+        resolved.command = dialog.command;
+        resolved.dialog = dialog;
+    }
+    return resolved;
+}
+
+export { normalizeToolbarButton, resolveToolbarButton, toolbarButtonFromItem };
+//# sourceMappingURL=toolbarButtons.js.map

package/dist/esm/toolbar/toolbarButtons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toolbarButtons.js","sources":["../../../toolbar/toolbarButtons.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { ToolbarButton, ToolbarEmphasis } from '@cratis/scene.model';\nimport { ApplicationStructureIndex } from '../structure';\nimport { ResolvedToolbarButton } from './ResolvedToolbarButton';\nimport { sliceDialogFor } from './sliceDialogFor';\n\nfunction text(properties: Record<string, unknown>, name: string): string | undefined {\n    const value = properties[name];\n    return typeof value === 'string' && value.length > 0 ? value : undefined;\n}\n\n/**\n * Reads a button from the properties of a `core:toolbarItem` element: `label` (or `name`), `kind`, `slice`,\n * `emphasis`, `icon` and `target`.\n *\n * The C# engine (`ToolbarButtons.FromItem`) reads the same; both are asserted against `toolbar-slice-fixtures.json`.\n *\n * @param id The element id.\n * @param properties The element properties.\n * @returns The button, or undefined when the item does not invoke a command or slice - a navigate or dialog item.\n */\nexport function toolbarButtonFromItem(id: string, properties: Record<string, unknown>): ToolbarButton | undefined {\n    const slice = text(properties, 'slice');\n    const action = text(properties, 'kind')?.toLowerCase() === 'action';\n    if (slice === undefined && !action) return undefined;\n\n    const button: ToolbarButton = { id, title: text(properties, 'label') ?? text(properties, 'name') ?? id };\n    if (slice !== undefined) button.slice = slice;\n\n    const emphasis = text(properties, 'emphasis')?.toLowerCase();\n    if (emphasis === ToolbarEmphasis.Primary || emphasis === ToolbarEmphasis.Secondary || emphasis === ToolbarEmphasis.Quiet) button.emphasis = emphasis;\n\n    const icon = text(properties, 'icon');\n    if (icon !== undefined) button.icon = icon;\n\n    const target = text(properties, 'target');\n    if (target !== undefined) button.target = target;\n    return button;\n}\n\n/**\n * Converts a hand-authored button to a slice-backed one: a button with no slice whose command is accepted by exactly\n * one state change slice names that slice instead.\n * @param index The modules, features and slices of the application.\n * @param button The button.\n * @returns The button to use, and whether it was converted. A button that cannot be converted is returned as it is.\n */\nexport function normalizeToolbarButton(index: ApplicationStructureIndex, button: ToolbarButton): { button: ToolbarButton; converted: boolean } {\n    if (button.slice || !button.target) return { button, converted: false };\n\n    const matches = index.findSlicesByCommand(button.target);\n    if (matches.length !== 1) return { button, converted: false };\n\n    const { target, ...rest } = button;\n    void target;\n    return { button: { ...rest, slice: matches[0] }, converted: true };\n}\n\n/**\n * Resolves a button: its slice, command and task dialog, without any rendering. This is what a renderer, Stage and the\n * Studio preview call.\n *\n * The C# engine (`ToolbarButtons.Resolve`) resolves the same; both are asserted against `toolbar-slice-fixtures.json`.\n *\n * @param index The modules, features and slices of the application.\n * @param button The button.\n * @param defaultDialogTemplate The dialog template used when a slice names none.\n */\nexport function resolveToolbarButton(index: ApplicationStructureIndex, button: ToolbarButton, defaultDialogTemplate?: string): ResolvedToolbarButton {\n    const { button: normalized, converted } = normalizeToolbarButton(index, button);\n    const dialog = normalized.slice ? sliceDialogFor(index, normalized.slice, defaultDialogTemplate) : undefined;\n    const resolved: ResolvedToolbarButton = { id: normalized.id, title: normalized.title, emphasis: normalized.emphasis ?? ToolbarEmphasis.Secondary, converted };\n    if (normalized.icon !== undefined) resolved.icon = normalized.icon;\n    if (normalized.slice) resolved.slice = normalized.slice;\n    if (dialog) {\n        resolved.command = dialog.command;\n        resolved.dialog = dialog;\n    }\n\n    return resolved;\n}\n"],"names":["text","properties","name","value","length","undefined","toolbarButtonFromItem","id","slice","action","toLowerCase","button","title","emphasis","ToolbarEmphasis","Primary","Secondary","Quiet","icon","target","normalizeToolbarButton","index","converted","matches","findSlicesByCommand","rest","resolveToolbarButton","defaultDialogTemplate","normalized","dialog","sliceDialogFor","resolved","command"],"mappings":";;;AAAA;AACA;AAOA,SAASA,IAAAA,CAAKC,UAAmC,EAAEC,IAAY,EAAA;IAC3D,MAAMC,KAAAA,GAAQF,UAAU,CAACC,IAAAA,CAAK;AAC9B,IAAA,OAAO,OAAOC,KAAAA,KAAU,QAAA,IAAYA,MAAMC,MAAM,GAAG,IAAID,KAAAA,GAAQE,SAAAA;AACnE;AAEA;;;;;;;;;AASC,IACM,SAASC,qBAAAA,CAAsBC,EAAU,EAAEN,UAAmC,EAAA;IACjF,MAAMO,KAAAA,GAAQR,KAAKC,UAAAA,EAAY,OAAA,CAAA;AAC/B,IAAA,MAAMQ,MAAAA,GAAST,IAAAA,CAAKC,UAAAA,EAAY,MAAA,CAAA,EAASS,WAAAA,EAAAA,KAAkB,QAAA;AAC3D,IAAA,IAAIF,KAAAA,KAAUH,SAAAA,IAAa,CAACI,MAAAA,EAAQ,OAAOJ,SAAAA;AAE3C,IAAA,MAAMM,MAAAA,GAAwB;AAAEJ,QAAAA,EAAAA;AAAIK,QAAAA,KAAAA,EAAOZ,IAAAA,CAAKC,UAAAA,EAAY,OAAA,CAAA,IAAYD,IAAAA,CAAKC,YAAY,MAAA,CAAA,IAAWM;AAAG,KAAA;AACvG,IAAA,IAAIC,KAAAA,KAAUH,SAAAA,EAAWM,MAAAA,CAAOH,KAAK,GAAGA,KAAAA;IAExC,MAAMK,QAAAA,GAAWb,IAAAA,CAAKC,UAAAA,EAAY,UAAA,CAAA,EAAaS,WAAAA,EAAAA;AAC/C,IAAA,IAAIG,QAAAA,KAAaC,eAAAA,CAAgBC,OAAO,IAAIF,aAAaC,eAAAA,CAAgBE,SAAS,IAAIH,QAAAA,KAAaC,eAAAA,CAAgBG,KAAK,EAAEN,MAAAA,CAAOE,QAAQ,GAAGA,QAAAA;IAE5I,MAAMK,IAAAA,GAAOlB,KAAKC,UAAAA,EAAY,MAAA,CAAA;AAC9B,IAAA,IAAIiB,IAAAA,KAASb,SAAAA,EAAWM,MAAAA,CAAOO,IAAI,GAAGA,IAAAA;IAEtC,MAAMC,MAAAA,GAASnB,KAAKC,UAAAA,EAAY,QAAA,CAAA;AAChC,IAAA,IAAIkB,MAAAA,KAAWd,SAAAA,EAAWM,MAAAA,CAAOQ,MAAM,GAAGA,MAAAA;IAC1C,OAAOR,MAAAA;AACX;AAEA;;;;;;AAMC,IACM,SAASS,sBAAAA,CAAuBC,KAAgC,EAAEV,MAAqB,EAAA;AAC1F,IAAA,IAAIA,OAAOH,KAAK,IAAI,CAACG,MAAAA,CAAOQ,MAAM,EAAE,OAAO;AAAER,QAAAA,MAAAA;QAAQW,SAAAA,EAAW;AAAM,KAAA;AAEtE,IAAA,MAAMC,OAAAA,GAAUF,KAAAA,CAAMG,mBAAmB,CAACb,OAAOQ,MAAM,CAAA;AACvD,IAAA,IAAII,OAAAA,CAAQnB,MAAM,KAAK,CAAA,EAAG,OAAO;AAAEO,QAAAA,MAAAA;QAAQW,SAAAA,EAAW;AAAM,KAAA;AAE5D,IAAA,MAAM,EAAEH,MAAM,EAAE,GAAGM,MAAM,GAAGd,MAAAA;IAE5B,OAAO;QAAEA,MAAAA,EAAQ;AAAE,YAAA,GAAGc,IAAI;YAAEjB,KAAAA,EAAOe,OAAO,CAAC,CAAA;AAAG,SAAA;QAAGD,SAAAA,EAAW;AAAK,KAAA;AACrE;AAEA;;;;;;;;;AASC,IACM,SAASI,oBAAAA,CAAqBL,KAAgC,EAAEV,MAAqB,EAAEgB,qBAA8B,EAAA;IACxH,MAAM,EAAEhB,QAAQiB,UAAU,EAAEN,SAAS,EAAE,GAAGF,uBAAuBC,KAAAA,EAAOV,MAAAA,CAAAA;IACxE,MAAMkB,MAAAA,GAASD,WAAWpB,KAAK,GAAGsB,eAAeT,KAAAA,EAAOO,UAAAA,CAAWpB,KAAK,EAAEmB,qBAAAA,CAAAA,GAAyBtB,SAAAA;AACnG,IAAA,MAAM0B,QAAAA,GAAkC;AAAExB,QAAAA,EAAAA,EAAIqB,WAAWrB,EAAE;AAAEK,QAAAA,KAAAA,EAAOgB,WAAWhB,KAAK;AAAEC,QAAAA,QAAAA,EAAUe,UAAAA,CAAWf,QAAQ,IAAIC,eAAAA,CAAgBE,SAAS;AAAEM,QAAAA;AAAU,KAAA;IAC5J,IAAIM,UAAAA,CAAWV,IAAI,KAAKb,SAAAA,EAAW0B,SAASb,IAAI,GAAGU,WAAWV,IAAI;AAClE,IAAA,IAAIU,WAAWpB,KAAK,EAAEuB,SAASvB,KAAK,GAAGoB,WAAWpB,KAAK;AACvD,IAAA,IAAIqB,MAAAA,EAAQ;QACRE,QAAAA,CAASC,OAAO,GAAGH,MAAAA,CAAOG,OAAO;AACjCD,QAAAA,QAAAA,CAASF,MAAM,GAAGA,MAAAA;AACtB,IAAA;IAEA,OAAOE,QAAAA;AACX;;"}

package/dist/esm/toolbar/validateToolbarButtons.d.ts

@@ -0,0 +1,5 @@
+import { ApplicationStructure, Toolbar } from '@cratis/scene.model';
+import { ApplicationStructureIndex } from '../structure';
+import { ToolbarDiagnostic } from './ToolbarDiagnostic';
+export declare function validateToolbarButtons(structure: ApplicationStructure | ApplicationStructureIndex, toolbar: Toolbar): ToolbarDiagnostic[];
+//# sourceMappingURL=validateToolbarButtons.d.ts.map

package/dist/esm/toolbar/validateToolbarButtons.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateToolbarButtons.d.ts","sourceRoot":"","sources":["../../../toolbar/validateToolbarButtons.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAa,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAiBxD,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,oBAAoB,GAAG,yBAAyB,EAAE,OAAO,EAAE,OAAO,GAAG,iBAAiB,EAAE,CAsCzI"}

package/dist/esm/toolbar/validateToolbarButtons.js

@@ -0,0 +1,57 @@
+import { SliceKind } from '@cratis/scene.model';
+import { ApplicationStructureIndex } from '../structure/ApplicationStructureIndex.js';
+import { ToolbarDiagnosticCode } from './ToolbarDiagnosticCode.js';
+import { ToolbarDiagnosticSeverity } from './ToolbarDiagnosticSeverity.js';
+import { normalizeToolbarButton } from './toolbarButtons.js';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Validates the buttons of a toolbar against the application structure: a button must invoke a state change slice
+ * (TB3), and a button without a slice is allowed but flagged (TB5). A hand-authored button that names a command is
+ * converted first, and a button whose command no single slice accepts is a legacy button that still validates.
+ *
+ * The C# engine (`ToolbarButtonValidation.Validate`) reports the same codes, severities and messages in the same
+ * order; both are asserted against `toolbar-slice-fixtures.json`.
+ *
+ * @param structure The modules, features and slices of the application.
+ * @param toolbar The toolbar.
+ * @returns The problems found, in button order.
+ */ function validateToolbarButtons(structure, toolbar) {
+    const index = structure instanceof ApplicationStructureIndex ? structure : new ApplicationStructureIndex(structure);
+    const diagnostics = [];
+    for (const authored of toolbar.buttons){
+        const { button } = normalizeToolbarButton(index, authored);
+        if (!button.slice) {
+            if (!button.target) {
+                diagnostics.push({
+                    code: ToolbarDiagnosticCode.ToolbarButtonSliceEmpty,
+                    severity: ToolbarDiagnosticSeverity.Warning,
+                    message: `Toolbar button '${button.id}' has no slice to invoke.`,
+                    button: button.id
+                });
+            }
+            continue;
+        }
+        const slice = index.findSlice(button.slice);
+        if (!slice) {
+            diagnostics.push({
+                code: ToolbarDiagnosticCode.ToolbarButtonSliceNotFound,
+                severity: ToolbarDiagnosticSeverity.Error,
+                message: `Toolbar button '${button.id}' invokes slice '${button.slice}', which does not exist.`,
+                button: button.id
+            });
+        } else if (slice.kind !== SliceKind.StateChange) {
+            diagnostics.push({
+                code: ToolbarDiagnosticCode.ToolbarButtonSliceNotStateChange,
+                severity: ToolbarDiagnosticSeverity.Error,
+                message: `Toolbar button '${button.id}' invokes slice '${button.slice}', which is ${slice.kind === SliceKind.StateView ? 'a state view' : 'an automation'}; only a state change can be invoked from a toolbar.`,
+                button: button.id
+            });
+        }
+    }
+    return diagnostics;
+}
+
+export { validateToolbarButtons };
+//# sourceMappingURL=validateToolbarButtons.js.map

package/dist/esm/toolbar/validateToolbarButtons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateToolbarButtons.js","sources":["../../../toolbar/validateToolbarButtons.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { ApplicationStructure, SliceKind, Toolbar } from '@cratis/scene.model';\nimport { ApplicationStructureIndex } from '../structure';\nimport { ToolbarDiagnostic } from './ToolbarDiagnostic';\nimport { ToolbarDiagnosticCode } from './ToolbarDiagnosticCode';\nimport { ToolbarDiagnosticSeverity } from './ToolbarDiagnosticSeverity';\nimport { normalizeToolbarButton } from './toolbarButtons';\n\n/**\n * Validates the buttons of a toolbar against the application structure: a button must invoke a state change slice\n * (TB3), and a button without a slice is allowed but flagged (TB5). A hand-authored button that names a command is\n * converted first, and a button whose command no single slice accepts is a legacy button that still validates.\n *\n * The C# engine (`ToolbarButtonValidation.Validate`) reports the same codes, severities and messages in the same\n * order; both are asserted against `toolbar-slice-fixtures.json`.\n *\n * @param structure The modules, features and slices of the application.\n * @param toolbar The toolbar.\n * @returns The problems found, in button order.\n */\nexport function validateToolbarButtons(structure: ApplicationStructure | ApplicationStructureIndex, toolbar: Toolbar): ToolbarDiagnostic[] {\n    const index = structure instanceof ApplicationStructureIndex ? structure : new ApplicationStructureIndex(structure);\n    const diagnostics: ToolbarDiagnostic[] = [];\n\n    for (const authored of toolbar.buttons) {\n        const { button } = normalizeToolbarButton(index, authored);\n        if (!button.slice) {\n            if (!button.target) {\n                diagnostics.push({\n                    code: ToolbarDiagnosticCode.ToolbarButtonSliceEmpty,\n                    severity: ToolbarDiagnosticSeverity.Warning,\n                    message: `Toolbar button '${button.id}' has no slice to invoke.`,\n                    button: button.id,\n                });\n            }\n\n            continue;\n        }\n\n        const slice = index.findSlice(button.slice);\n        if (!slice) {\n            diagnostics.push({\n                code: ToolbarDiagnosticCode.ToolbarButtonSliceNotFound,\n                severity: ToolbarDiagnosticSeverity.Error,\n                message: `Toolbar button '${button.id}' invokes slice '${button.slice}', which does not exist.`,\n                button: button.id,\n            });\n        } else if (slice.kind !== SliceKind.StateChange) {\n            diagnostics.push({\n                code: ToolbarDiagnosticCode.ToolbarButtonSliceNotStateChange,\n                severity: ToolbarDiagnosticSeverity.Error,\n                message: `Toolbar button '${button.id}' invokes slice '${button.slice}', which is ${slice.kind === SliceKind.StateView ? 'a state view' : 'an automation'}; only a state change can be invoked from a toolbar.`,\n                button: button.id,\n            });\n        }\n    }\n\n    return diagnostics;\n}\n"],"names":["validateToolbarButtons","structure","toolbar","index","ApplicationStructureIndex","diagnostics","authored","buttons","button","normalizeToolbarButton","slice","target","push","code","ToolbarDiagnosticCode","ToolbarButtonSliceEmpty","severity","ToolbarDiagnosticSeverity","Warning","message","id","findSlice","ToolbarButtonSliceNotFound","Error","kind","SliceKind","StateChange","ToolbarButtonSliceNotStateChange","StateView"],"mappings":";;;;;;AAAA;AACA;AASA;;;;;;;;;;;AAWC,IACM,SAASA,sBAAAA,CAAuBC,SAA2D,EAAEC,OAAgB,EAAA;AAChH,IAAA,MAAMC,KAAAA,GAAQF,SAAAA,YAAqBG,yBAAAA,GAA4BH,SAAAA,GAAY,IAAIG,yBAAAA,CAA0BH,SAAAA,CAAAA;AACzG,IAAA,MAAMI,cAAmC,EAAE;AAE3C,IAAA,KAAK,MAAMC,QAAAA,IAAYJ,OAAAA,CAAQK,OAAO,CAAE;AACpC,QAAA,MAAM,EAAEC,MAAM,EAAE,GAAGC,uBAAuBN,KAAAA,EAAOG,QAAAA,CAAAA;QACjD,IAAI,CAACE,MAAAA,CAAOE,KAAK,EAAE;YACf,IAAI,CAACF,MAAAA,CAAOG,MAAM,EAAE;AAChBN,gBAAAA,WAAAA,CAAYO,IAAI,CAAC;AACbC,oBAAAA,IAAAA,EAAMC,sBAAsBC,uBAAuB;AACnDC,oBAAAA,QAAAA,EAAUC,0BAA0BC,OAAO;AAC3CC,oBAAAA,OAAAA,EAAS,CAAC,gBAAgB,EAAEX,OAAOY,EAAE,CAAC,yBAAyB,CAAC;AAChEZ,oBAAAA,MAAAA,EAAQA,OAAOY;AACnB,iBAAA,CAAA;AACJ,YAAA;AAEA,YAAA;AACJ,QAAA;AAEA,QAAA,MAAMV,KAAAA,GAAQP,KAAAA,CAAMkB,SAAS,CAACb,OAAOE,KAAK,CAAA;AAC1C,QAAA,IAAI,CAACA,KAAAA,EAAO;AACRL,YAAAA,WAAAA,CAAYO,IAAI,CAAC;AACbC,gBAAAA,IAAAA,EAAMC,sBAAsBQ,0BAA0B;AACtDN,gBAAAA,QAAAA,EAAUC,0BAA0BM,KAAK;AACzCJ,gBAAAA,OAAAA,EAAS,CAAC,gBAAgB,EAAEX,MAAAA,CAAOY,EAAE,CAAC,iBAAiB,EAAEZ,MAAAA,CAAOE,KAAK,CAAC,wBAAwB,CAAC;AAC/FF,gBAAAA,MAAAA,EAAQA,OAAOY;AACnB,aAAA,CAAA;AACJ,QAAA,CAAA,MAAO,IAAIV,KAAAA,CAAMc,IAAI,KAAKC,SAAAA,CAAUC,WAAW,EAAE;AAC7CrB,YAAAA,WAAAA,CAAYO,IAAI,CAAC;AACbC,gBAAAA,IAAAA,EAAMC,sBAAsBa,gCAAgC;AAC5DX,gBAAAA,QAAAA,EAAUC,0BAA0BM,KAAK;gBACzCJ,OAAAA,EAAS,CAAC,gBAAgB,EAAEX,MAAAA,CAAOY,EAAE,CAAC,iBAAiB,EAAEZ,MAAAA,CAAOE,KAAK,CAAC,YAAY,EAAEA,KAAAA,CAAMc,IAAI,KAAKC,SAAAA,CAAUG,SAAS,GAAG,cAAA,GAAiB,eAAA,CAAgB,oDAAoD,CAAC;AAC/MpB,gBAAAA,MAAAA,EAAQA,OAAOY;AACnB,aAAA,CAAA;AACJ,QAAA;AACJ,IAAA;IAEA,OAAOf,WAAAA;AACX;;"}