@cratis/scene.react 4.28.0 → 4.30.0

package/dist/esm/slices/createAnnouncingInvoker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createAnnouncingInvoker.d.ts","sourceRoot":"","sources":["../../../slices/createAnnouncingInvoker.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAM9C,wBAAgB,uBAAuB,IAAI,YAAY,CAOtD"}

package/dist/esm/slices/createAnnouncingInvoker.js

@@ -0,0 +1,25 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * The invoker used when a host provides none: it announces the command with the host-neutral `cratis.scene.command` event,
+ * as a `core:toolbarItem` action always has, and reports success. A host that listens for the event runs the command.
+ */ function createAnnouncingInvoker() {
+    return {
+        async invoke (sliceId, payload, command) {
+            globalThis.dispatchEvent(new CustomEvent('cratis.scene.command', {
+                detail: {
+                    command: command ?? sliceId,
+                    slice: sliceId,
+                    arguments: payload
+                }
+            }));
+            return {
+                succeeded: true,
+                payload
+            };
+        }
+    };
+}
+
+export { createAnnouncingInvoker };
+//# sourceMappingURL=createAnnouncingInvoker.js.map

package/dist/esm/slices/createAnnouncingInvoker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createAnnouncingInvoker.js","sources":["../../../slices/createAnnouncingInvoker.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 { SliceInvoker } from './SliceInvoker';\n\n/**\n * The invoker used when a host provides none: it announces the command with the host-neutral `cratis.scene.command` event,\n * as a `core:toolbarItem` action always has, and reports success. A host that listens for the event runs the command.\n */\nexport function createAnnouncingInvoker(): SliceInvoker {\n    return {\n        async invoke(sliceId, payload, command) {\n            globalThis.dispatchEvent(new CustomEvent('cratis.scene.command', { detail: { command: command ?? sliceId, slice: sliceId, arguments: payload } }));\n            return { succeeded: true, payload };\n        },\n    };\n}\n"],"names":["createAnnouncingInvoker","invoke","sliceId","payload","command","globalThis","dispatchEvent","CustomEvent","detail","slice","arguments","succeeded"],"mappings":"AAAA;AACA;AAIA;;;AAGC,IACM,SAASA,uBAAAA,GAAAA;IACZ,OAAO;AACH,QAAA,MAAMC,MAAAA,CAAAA,CAAOC,OAAO,EAAEC,OAAO,EAAEC,OAAO,EAAA;AAClCC,YAAAA,UAAAA,CAAWC,aAAa,CAAC,IAAIC,WAAAA,CAAY,sBAAA,EAAwB;gBAAEC,MAAAA,EAAQ;AAAEJ,oBAAAA,OAAAA,EAASA,OAAAA,IAAWF,OAAAA;oBAASO,KAAAA,EAAOP,OAAAA;oBAASQ,SAAAA,EAAWP;AAAQ;AAAE,aAAA,CAAA,CAAA;YAC/I,OAAO;gBAAEQ,SAAAA,EAAW,IAAA;AAAMR,gBAAAA;AAAQ,aAAA;AACtC,QAAA;AACJ,KAAA;AACJ;;"}

package/dist/esm/slices/createDryRunInvoker.d.ts

@@ -0,0 +1,15 @@
+import { InvocationValidationError } from './InvocationValidationError';
+import { SliceInvoker } from './SliceInvoker';
+export interface DryRunInvocation {
+    sliceId: string;
+    command?: string;
+    payload: Record<string, unknown>;
+}
+export interface DryRunInvokerOptions {
+    onInvoked?(invocation: DryRunInvocation): void;
+    validate?(invocation: DryRunInvocation): InvocationValidationError[];
+}
+export declare function createDryRunInvoker(options?: DryRunInvokerOptions): SliceInvoker & {
+    readonly dryRun: true;
+};
+//# sourceMappingURL=createDryRunInvoker.d.ts.map

package/dist/esm/slices/createDryRunInvoker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createDryRunInvoker.d.ts","sourceRoot":"","sources":["../../../slices/createDryRunInvoker.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C,MAAM,WAAW,gBAAgB;IAE7B,OAAO,EAAE,MAAM,CAAC;IAGhB,OAAO,CAAC,EAAE,MAAM,CAAC;IAGjB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,oBAAoB;IAEjC,SAAS,CAAC,CAAC,UAAU,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAG/C,QAAQ,CAAC,CAAC,UAAU,EAAE,gBAAgB,GAAG,yBAAyB,EAAE,CAAC;CACxE;AAMD,wBAAgB,mBAAmB,CAAC,OAAO,GAAE,oBAAyB,GAAG,YAAY,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAA;CAAE,CAYhH"}

package/dist/esm/slices/createDryRunInvoker.js

@@ -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.
+/**
+ * An invoker that sends nothing (PRV5): it validates, reports what it would have sent and succeeds, so a preview can walk a
+ * toolbar button through its dialog without touching a backend.
+ */ function createDryRunInvoker(options = {}) {
+    return {
+        dryRun: true,
+        async invoke (sliceId, payload, command) {
+            const invocation = {
+                sliceId,
+                payload,
+                ...command === undefined ? {} : {
+                    command
+                }
+            };
+            const validationErrors = options.validate?.(invocation) ?? [];
+            if (validationErrors.length > 0) return {
+                succeeded: false,
+                validationErrors,
+                payload,
+                dryRun: true
+            };
+            options.onInvoked?.(invocation);
+            return {
+                succeeded: true,
+                payload,
+                dryRun: true,
+                message: `Dry run: ${command ?? sliceId} was not sent.`
+            };
+        }
+    };
+}
+
+export { createDryRunInvoker };
+//# sourceMappingURL=createDryRunInvoker.js.map

package/dist/esm/slices/createDryRunInvoker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createDryRunInvoker.js","sources":["../../../slices/createDryRunInvoker.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 { InvocationValidationError } from './InvocationValidationError';\nimport { SliceInvoker } from './SliceInvoker';\n\n/** What a dry run is told about each invocation. */\nexport interface DryRunInvocation {\n    /** The qualified id of the slice. */\n    sliceId: string;\n\n    /** The command the slice accepts, when known. */\n    command?: string;\n\n    /** The payload that would have been sent. */\n    payload: Record<string, unknown>;\n}\n\nexport interface DryRunInvokerOptions {\n    /** Called for every invocation that passes validation, with the would-be payload - the Studio preview shows it as a toast. */\n    onInvoked?(invocation: DryRunInvocation): void;\n\n    /** Extra validation of the payload; the problems it returns are reported like the real ones and nothing is invoked. */\n    validate?(invocation: DryRunInvocation): InvocationValidationError[];\n}\n\n/**\n * An invoker that sends nothing (PRV5): it validates, reports what it would have sent and succeeds, so a preview can walk a\n * toolbar button through its dialog without touching a backend.\n */\nexport function createDryRunInvoker(options: DryRunInvokerOptions = {}): SliceInvoker & { readonly dryRun: true } {\n    return {\n        dryRun: true,\n        async invoke(sliceId, payload, command) {\n            const invocation: DryRunInvocation = { sliceId, payload, ...(command === undefined ? {} : { command }) };\n            const validationErrors = options.validate?.(invocation) ?? [];\n            if (validationErrors.length > 0) return { succeeded: false, validationErrors, payload, dryRun: true };\n\n            options.onInvoked?.(invocation);\n            return { succeeded: true, payload, dryRun: true, message: `Dry run: ${command ?? sliceId} was not sent.` };\n        },\n    };\n}\n"],"names":["createDryRunInvoker","options","dryRun","invoke","sliceId","payload","command","invocation","undefined","validationErrors","validate","length","succeeded","onInvoked","message"],"mappings":"AAAA;AACA;AAyBA;;;AAGC,IACM,SAASA,mBAAAA,CAAoBC,OAAAA,GAAgC,EAAE,EAAA;IAClE,OAAO;QACHC,MAAAA,EAAQ,IAAA;AACR,QAAA,MAAMC,MAAAA,CAAAA,CAAOC,OAAO,EAAEC,OAAO,EAAEC,OAAO,EAAA;AAClC,YAAA,MAAMC,UAAAA,GAA+B;AAAEH,gBAAAA,OAAAA;AAASC,gBAAAA,OAAAA;gBAAS,GAAIC,OAAAA,KAAYE,SAAAA,GAAY,EAAC,GAAI;AAAEF,oBAAAA;;AAAW,aAAA;AACvG,YAAA,MAAMG,gBAAAA,GAAmBR,OAAAA,CAAQS,QAAQ,GAAGH,eAAe,EAAE;AAC7D,YAAA,IAAIE,gBAAAA,CAAiBE,MAAM,GAAG,CAAA,EAAG,OAAO;gBAAEC,SAAAA,EAAW,KAAA;AAAOH,gBAAAA,gBAAAA;AAAkBJ,gBAAAA,OAAAA;gBAASH,MAAAA,EAAQ;AAAK,aAAA;AAEpGD,YAAAA,OAAAA,CAAQY,SAAS,GAAGN,UAAAA,CAAAA;YACpB,OAAO;gBAAEK,SAAAA,EAAW,IAAA;AAAMP,gBAAAA,OAAAA;gBAASH,MAAAA,EAAQ,IAAA;AAAMY,gBAAAA,OAAAA,EAAS,CAAC,SAAS,EAAER,OAAAA,IAAWF,OAAAA,CAAQ,cAAc;AAAE,aAAA;AAC7G,QAAA;AACJ,KAAA;AACJ;;"}

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

@@ -0,0 +1,12 @@
+export * from './InvocationValidationError';
+export * from './InvocationResult';
+export * from './SliceInvoker';
+export * from './createAnnouncingInvoker';
+export * from './createDryRunInvoker';
+export * from './SliceInvokerContext';
+export * from './SliceCommandField';
+export * from './SliceCommandFieldsContext';
+export * from './sliceDialogDestination';
+export * from './SliceDialogView';
+export * from './CoreSliceDialog';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../slices/index.ts"],"names":[],"mappings":"AAGA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC"}

package/dist/esm/slices/index.js

@@ -0,0 +1,12 @@
+export * from './InvocationValidationError';
+export * from './InvocationResult';
+export * from './SliceInvoker';
+export * from './createAnnouncingInvoker';
+export * from './createDryRunInvoker';
+export * from './SliceInvokerContext';
+export * from './SliceCommandField';
+export * from './SliceCommandFieldsContext';
+export * from './sliceDialogDestination';
+export * from './SliceDialogView';
+export * from './CoreSliceDialog';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../slices/index.ts"],"names":[],"mappings":"AAGA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC"}

package/dist/esm/slices/sliceDialogDestination.d.ts

@@ -0,0 +1,10 @@
+import { DestinationReference } from '@cratis/scene.model';
+import { ResolvedToolbarButton } from '@cratis/scene.engine';
+export interface SliceDialogParameters {
+    slice: string;
+    command: string;
+    title: string;
+}
+export declare function sliceDialogDestination(button: ResolvedToolbarButton): DestinationReference | undefined;
+export declare function sliceDialogParameters(parameters: Record<string, string> | undefined): SliceDialogParameters | undefined;
+//# sourceMappingURL=sliceDialogDestination.d.ts.map

package/dist/esm/slices/sliceDialogDestination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sliceDialogDestination.d.ts","sourceRoot":"","sources":["../../../slices/sliceDialogDestination.ts"],"names":[],"mappings":"AAGA,OAAO,EAAyD,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAClH,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAK7D,MAAM,WAAW,qBAAqB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACjB;AAQD,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,qBAAqB,GAAG,oBAAoB,GAAG,SAAS,CAWtG;AAGD,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,GAAG,qBAAqB,GAAG,SAAS,CAIvH"}

package/dist/esm/slices/sliceDialogDestination.js

@@ -0,0 +1,38 @@
+import { DestinationKind, BindingSourceKind } from '@cratis/scene.model';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+const literal = (value)=>({
+        kind: BindingSourceKind.Literal,
+        path: '',
+        value
+    });
+/**
+ * The destination that opens a toolbar button's task dialog through the navigation host: the dialog template the slice
+ * resolves to (`sliceDialogFor`), with the slice, its command and the button's title as parameters.
+ * @param button The resolved button.
+ * @returns The destination, or undefined when the button has no state change slice to open.
+ */ function sliceDialogDestination(button) {
+    if (!button.dialog) return undefined;
+    return {
+        kind: DestinationKind.Dialog,
+        dialog: button.dialog.template,
+        routeParameterBindings: {
+            slice: literal(button.dialog.slice),
+            command: literal(button.dialog.command),
+            title: literal(button.title)
+        }
+    };
+}
+/** Reads the slice dialog parameters back from what the host carries; undefined when they are not those of a slice dialog. */ function sliceDialogParameters(parameters) {
+    const slice = parameters?.slice;
+    const command = parameters?.command;
+    return slice && command ? {
+        slice,
+        command,
+        title: parameters?.title || command
+    } : undefined;
+}
+
+export { sliceDialogDestination, sliceDialogParameters };
+//# sourceMappingURL=sliceDialogDestination.js.map

package/dist/esm/slices/sliceDialogDestination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sliceDialogDestination.js","sources":["../../../slices/sliceDialogDestination.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 { BindingExpression, BindingSourceKind, DestinationKind, DestinationReference } from '@cratis/scene.model';\nimport { ResolvedToolbarButton } from '@cratis/scene.engine';\n\nconst literal = (value: string): BindingExpression => ({ kind: BindingSourceKind.Literal, path: '', value }) as BindingExpression;\n\n/** The dialog parameters a slice dialog is opened with; the navigation host hands them back as `currentDialogParameters`. */\nexport interface SliceDialogParameters {\n    slice: string;\n    command: string;\n    title: string;\n}\n\n/**\n * The destination that opens a toolbar button's task dialog through the navigation host: the dialog template the slice\n * resolves to (`sliceDialogFor`), with the slice, its command and the button's title as parameters.\n * @param button The resolved button.\n * @returns The destination, or undefined when the button has no state change slice to open.\n */\nexport function sliceDialogDestination(button: ResolvedToolbarButton): DestinationReference | undefined {\n    if (!button.dialog) return undefined;\n    return {\n        kind: DestinationKind.Dialog,\n        dialog: button.dialog.template,\n        routeParameterBindings: {\n            slice: literal(button.dialog.slice),\n            command: literal(button.dialog.command),\n            title: literal(button.title),\n        },\n    };\n}\n\n/** Reads the slice dialog parameters back from what the host carries; undefined when they are not those of a slice dialog. */\nexport function sliceDialogParameters(parameters: Record<string, string> | undefined): SliceDialogParameters | undefined {\n    const slice = parameters?.slice;\n    const command = parameters?.command;\n    return slice && command ? { slice, command, title: parameters?.title || command } : undefined;\n}\n"],"names":["literal","value","kind","BindingSourceKind","Literal","path","sliceDialogDestination","button","dialog","undefined","DestinationKind","Dialog","template","routeParameterBindings","slice","command","title","sliceDialogParameters","parameters"],"mappings":";;AAAA;AACA;AAKA,MAAMA,OAAAA,GAAU,CAACC,KAAAA,IAAsC;AAAEC,QAAAA,IAAAA,EAAMC,kBAAkBC,OAAO;QAAEC,IAAAA,EAAM,EAAA;AAAIJ,QAAAA;KAAM,CAAA;AAS1G;;;;;IAMO,SAASK,sBAAAA,CAAuBC,MAA6B,EAAA;AAChE,IAAA,IAAI,CAACA,MAAAA,CAAOC,MAAM,EAAE,OAAOC,SAAAA;IAC3B,OAAO;AACHP,QAAAA,IAAAA,EAAMQ,gBAAgBC,MAAM;QAC5BH,MAAAA,EAAQD,MAAAA,CAAOC,MAAM,CAACI,QAAQ;QAC9BC,sBAAAA,EAAwB;AACpBC,YAAAA,KAAAA,EAAOd,OAAAA,CAAQO,MAAAA,CAAOC,MAAM,CAACM,KAAK,CAAA;AAClCC,YAAAA,OAAAA,EAASf,OAAAA,CAAQO,MAAAA,CAAOC,MAAM,CAACO,OAAO,CAAA;YACtCC,KAAAA,EAAOhB,OAAAA,CAAQO,OAAOS,KAAK;AAC/B;AACJ,KAAA;AACJ;AAEA,+HACO,SAASC,qBAAAA,CAAsBC,UAA8C,EAAA;AAChF,IAAA,MAAMJ,QAAQI,UAAAA,EAAYJ,KAAAA;AAC1B,IAAA,MAAMC,UAAUG,UAAAA,EAAYH,OAAAA;AAC5B,IAAA,OAAOD,SAASC,OAAAA,GAAU;AAAED,QAAAA,KAAAA;AAAOC,QAAAA,OAAAA;AAASC,QAAAA,KAAAA,EAAOE,YAAYF,KAAAA,IAASD;KAAQ,GAAIN,SAAAA;AACxF;;"}