@cratis/scene.react 4.15.0 → 4.16.0

package/dist/esm/navigation/index.js

@@ -6,6 +6,7 @@ export * from './SceneNavigationHost';
 export * from './SceneNavigationState';
 export * from './SceneRoute';
 export * from './createBrowserSceneHistory';
+export * from './createHashSceneHistory';
 export * from './createMemorySceneHistory';
 export * from './diagnoseRenderedNavigation';
 export * from './identityRoute';

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../navigation/index.ts"],"names":[],"mappings":"AAGA,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,cAAc,CAAC;AAC7B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../navigation/index.ts"],"names":[],"mappings":"AAGA,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,cAAc,CAAC;AAC7B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC"}

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

@@ -4,6 +4,8 @@ export * from './ComponentRegistry';
 export * from './RenderBindingScopeContext';
 export * from './UnresolvedComponent';
 export * from './useBoundQuery';
+export * from './useValueOutput';
+export * from './valueOutputProperty';
 export * from './createReactRenderer';
 export * from './InteractiveComponent';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../renderer/index.ts"],"names":[],"mappings":"AAGA,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../renderer/index.ts"],"names":[],"mappings":"AAGA,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC"}

package/dist/esm/renderer/index.js

@@ -4,6 +4,8 @@ export * from './ComponentRegistry';
 export * from './RenderBindingScopeContext';
 export * from './UnresolvedComponent';
 export * from './useBoundQuery';
+export * from './useValueOutput';
+export * from './valueOutputProperty';
 export * from './createReactRenderer';
 export * from './InteractiveComponent';
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../renderer/index.ts"],"names":[],"mappings":"AAGA,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../renderer/index.ts"],"names":[],"mappings":"AAGA,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC"}

package/dist/esm/renderer/useValueOutput.d.ts

@@ -0,0 +1,4 @@
+import { ComponentBindingOutputs } from './BindingOutputContext';
+export declare const valueOutputName = "value";
+export declare function useValueOutput(bindingOutputs: ComponentBindingOutputs | undefined, value: unknown): void;
+//# sourceMappingURL=useValueOutput.d.ts.map

package/dist/esm/renderer/useValueOutput.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useValueOutput.d.ts","sourceRoot":"","sources":["../../../renderer/useValueOutput.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAGjE,eAAO,MAAM,eAAe,UAAU,CAAC;AAUvC,wBAAgB,cAAc,CAAC,cAAc,EAAE,uBAAuB,GAAG,SAAS,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAUxG"}

package/dist/esm/renderer/useValueOutput.js

@@ -0,0 +1,28 @@
+import { useRef, useEffect } from 'react';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/** The output property an input widget publishes its current value under. */ const valueOutputName = 'value';
+/**
+ * Publishes an input widget's current value as its `value` output: once when it mounts, with the initial
+ * value, and again on every change. Other elements bind to it with a `componentProperty` binding, and a
+ * command action maps it as `component.<id>.value`. The renderer clears the output when the widget unmounts.
+ *
+ * Values are published as JSON-compatible data so both engines read the same thing: a `Date` is published
+ * as its ISO 8601 string, and `undefined` as `null`.
+ */ function useValueOutput(bindingOutputs, value) {
+    const published = value instanceof Date ? value.toISOString() : value ?? null;
+    const key = JSON.stringify(published);
+    const latest = useRef(published);
+    latest.current = published;
+    // Published by value through `key`: a new array or object with the same content is not a change.
+    useEffect(()=>{
+        bindingOutputs?.setOutput(valueOutputName, latest.current);
+    }, [
+        bindingOutputs,
+        key
+    ]);
+}
+
+export { useValueOutput, valueOutputName };
+//# sourceMappingURL=useValueOutput.js.map

package/dist/esm/renderer/useValueOutput.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useValueOutput.js","sources":["../../../renderer/useValueOutput.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 { useEffect, useRef } from 'react';\nimport { ComponentBindingOutputs } from './BindingOutputContext';\n\n/** The output property an input widget publishes its current value under. */\nexport const valueOutputName = 'value';\n\n/**\n * Publishes an input widget's current value as its `value` output: once when it mounts, with the initial\n * value, and again on every change. Other elements bind to it with a `componentProperty` binding, and a\n * command action maps it as `component.<id>.value`. The renderer clears the output when the widget unmounts.\n *\n * Values are published as JSON-compatible data so both engines read the same thing: a `Date` is published\n * as its ISO 8601 string, and `undefined` as `null`.\n */\nexport function useValueOutput(bindingOutputs: ComponentBindingOutputs | undefined, value: unknown): void {\n    const published = value instanceof Date ? value.toISOString() : value ?? null;\n    const key = JSON.stringify(published);\n    const latest = useRef(published);\n    latest.current = published;\n\n    // Published by value through `key`: a new array or object with the same content is not a change.\n    useEffect(() => {\n        bindingOutputs?.setOutput(valueOutputName, latest.current);\n    }, [bindingOutputs, key]);\n}\n"],"names":["valueOutputName","useValueOutput","bindingOutputs","value","published","Date","toISOString","key","JSON","stringify","latest","useRef","current","useEffect","setOutput"],"mappings":";;AAAA;AACA;AAKA,8EACO,MAAMA,eAAAA,GAAkB;AAE/B;;;;;;;AAOC,IACM,SAASC,cAAAA,CAAeC,cAAmD,EAAEC,KAAc,EAAA;AAC9F,IAAA,MAAMC,YAAYD,KAAAA,YAAiBE,IAAAA,GAAOF,KAAAA,CAAMG,WAAW,KAAKH,KAAAA,IAAS,IAAA;IACzE,MAAMI,GAAAA,GAAMC,IAAAA,CAAKC,SAAS,CAACL,SAAAA,CAAAA;AAC3B,IAAA,MAAMM,SAASC,MAAAA,CAAOP,SAAAA,CAAAA;AACtBM,IAAAA,MAAAA,CAAOE,OAAO,GAAGR,SAAAA;;IAGjBS,SAAAA,CAAU,IAAA;QACNX,cAAAA,EAAgBY,SAAAA,CAAUd,eAAAA,EAAiBU,MAAAA,CAAOE,OAAO,CAAA;IAC7D,CAAA,EAAG;AAACV,QAAAA,cAAAA;AAAgBK,QAAAA;AAAI,KAAA,CAAA;AAC5B;;"}

package/dist/esm/renderer/valueOutputProperty.d.ts

@@ -0,0 +1,3 @@
+import { PropertyDescriptor, PropertyValueType } from '@cratis/scene.model';
+export declare function valueOutputProperty(valueType: PropertyValueType, description?: string): PropertyDescriptor;
+//# sourceMappingURL=valueOutputProperty.d.ts.map

package/dist/esm/renderer/valueOutputProperty.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"valueOutputProperty.d.ts","sourceRoot":"","sources":["../../../renderer/valueOutputProperty.ts"],"names":[],"mappings":"AAGA,OAAO,EAAe,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAUzF,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,iBAAiB,EAAE,WAAW,SAA+D,GAAG,kBAAkB,CAWhK"}

package/dist/esm/renderer/valueOutputProperty.js

@@ -0,0 +1,26 @@
+import { BindingMode } from '@cratis/scene.model';
+import { valueOutputName } from './useValueOutput.js';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * The descriptor entry an input widget declares for the value it publishes with `useValueOutput`, so a
+ * designer can offer it as a binding source - for a detail component, a query argument or a command input.
+ *
+ * @param valueType The type of value the widget publishes.
+ * @param description What the value is, when the default sentence does not say enough.
+ */ function valueOutputProperty(valueType, description = 'What the user has entered, published as the input changes.') {
+    return {
+        path: valueOutputName,
+        label: 'Value',
+        group: 'Outputs',
+        valueType,
+        readOnly: true,
+        output: true,
+        bindingMode: BindingMode.OneWay,
+        description
+    };
+}
+
+export { valueOutputProperty };
+//# sourceMappingURL=valueOutputProperty.js.map

package/dist/esm/renderer/valueOutputProperty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"valueOutputProperty.js","sources":["../../../renderer/valueOutputProperty.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 { BindingMode, PropertyDescriptor, PropertyValueType } from '@cratis/scene.model';\nimport { valueOutputName } from './useValueOutput';\n\n/**\n * The descriptor entry an input widget declares for the value it publishes with `useValueOutput`, so a\n * designer can offer it as a binding source - for a detail component, a query argument or a command input.\n *\n * @param valueType The type of value the widget publishes.\n * @param description What the value is, when the default sentence does not say enough.\n */\nexport function valueOutputProperty(valueType: PropertyValueType, description = 'What the user has entered, published as the input changes.'): PropertyDescriptor {\n    return {\n        path: valueOutputName,\n        label: 'Value',\n        group: 'Outputs',\n        valueType,\n        readOnly: true,\n        output: true,\n        bindingMode: BindingMode.OneWay,\n        description,\n    };\n}\n"],"names":["valueOutputProperty","valueType","description","path","valueOutputName","label","group","readOnly","output","bindingMode","BindingMode","OneWay"],"mappings":";;;AAAA;AACA;AAKA;;;;;;AAMC,IACM,SAASA,mBAAAA,CAAoBC,SAA4B,EAAEC,cAAc,4DAA4D,EAAA;IACxI,OAAO;QACHC,IAAAA,EAAMC,eAAAA;QACNC,KAAAA,EAAO,OAAA;QACPC,KAAAA,EAAO,SAAA;AACPL,QAAAA,SAAAA;QACAM,QAAAA,EAAU,IAAA;QACVC,MAAAA,EAAQ,IAAA;AACRC,QAAAA,WAAAA,EAAaC,YAAYC,MAAM;AAC/BT,QAAAA;AACJ,KAAA;AACJ;;"}