@cratis/scene.model 4.27.0 → 4.28.0

package/index.ts

@@ -20,3 +20,4 @@ export * from './exposure';
 export * from './editing';
 export * from './structure';
 export * from './navigation';
+export * from './toolbar';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cratis/scene.model",
-    "version": "4.27.0",
+    "version": "4.28.0",
     "description": "The TypeScript mirror of Cratis.Scene.Model — the platform-agnostic Screen object model.",
     "keywords": [
         "cratis",

package/structure/SliceNode.ts

@@ -15,6 +15,12 @@ export interface SliceNode {
 
     /** Whether the slice is a state change, a state view or an automation. */
     kind: SliceKind;
+
+    /** The command a state change slice accepts; the slice `id` when absent. */
+    command?: string;
+
+    /** The dialog template the slice opens as a task dialog; the host's default form dialog when absent. */
+    dialogTemplate?: string;
 }
 
-export const SliceNodePropertyNames: (keyof SliceNode)[] = ['id', 'name', 'kind'];
+export const SliceNodePropertyNames: (keyof SliceNode)[] = ['id', 'name', 'kind', 'command', 'dialogTemplate'];

package/toolbar/Toolbar.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.
+
+import { ToolbarButton } from './ToolbarButton';
+
+/**
+ * The buttons of a toolbar, in order.
+ */
+export interface Toolbar {
+    /** The buttons. */
+    buttons: ToolbarButton[];
+}
+
+export const ToolbarPropertyNames: (keyof Toolbar)[] = ['buttons'];

package/toolbar/ToolbarButton.ts

@@ -0,0 +1,36 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { ToolbarEmphasis } from './ToolbarEmphasis';
+
+/**
+ * A toolbar button that invokes a state change slice. It is a `core:toolbarItem` with `kind: Action`, a `slice`
+ * and an `emphasis`.
+ */
+export interface ToolbarButton {
+    /** The button identity. */
+    id: string;
+
+    /** The text shown on the button. */
+    title: string;
+
+    /**
+     * The qualified id of the state change slice the button invokes, for example `sales.orders.PlaceOrder`; absent
+     * for a button that has none yet.
+     */
+    slice?: string;
+
+    /** How prominent the button is; `secondary` when absent. */
+    emphasis?: ToolbarEmphasis;
+
+    /** Qualified icon reference, when the button has one. */
+    icon?: string;
+
+    /**
+     * The command a hand-authored button names instead of a slice. It is turned into the slice that accepts the command
+     * when exactly one does.
+     */
+    target?: string;
+}
+
+export const ToolbarButtonPropertyNames: (keyof ToolbarButton)[] = ['id', 'title', 'slice', 'emphasis', 'icon', 'target'];

package/toolbar/ToolbarEmphasis.ts

@@ -0,0 +1,16 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/**
+ * How prominent a toolbar button is.
+ */
+export enum ToolbarEmphasis {
+    /** The main action of the page: a solid, accented button. */
+    Primary = 'primary',
+
+    /** A regular action: an outlined button. The default. */
+    Secondary = 'secondary',
+
+    /** A minor action: a plain button without a frame. */
+    Quiet = 'quiet',
+}

package/toolbar/index.ts

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