@cratis/scene.react 4.9.0 → 4.11.0

package/dist/esm/renderer/RenderBindingScopeContext.js

@@ -0,0 +1,73 @@
+import { jsx, Fragment } from 'react/jsx-runtime';
+import { useContext, createContext, useRef, useMemo, useCallback } from 'react';
+import { resolveBindingExpression } from '@cratis/scene.engine';
+import { BindingNullBehavior } from '@cratis/scene.model';
+import { BindingOutputProvider, useBindingOutputScope } from './BindingOutputContext.js';
+
+const Context = /*#__PURE__*/ createContext(undefined);
+/**
+ * Provides the inherited reactive binding scope for a rendered Scene tree.
+ */ function RenderBindingScopeProvider(props) {
+    const current = useContext(Context);
+    if (current) return /*#__PURE__*/ jsx(Fragment, {
+        children: props.children
+    });
+    return /*#__PURE__*/ jsx(BindingOutputProvider, {
+        onOutputsChanged: props.onComponentOutputsChanged,
+        children: /*#__PURE__*/ jsx(RenderBindingScopeInner, {
+            ...props
+        })
+    });
+}
+function RenderBindingScopeInner({ children, dataContext, queryResults, componentOutputs, resolveBinding }) {
+    const outputs = useBindingOutputScope();
+    const previousValues = useRef(new Map());
+    const scope = useMemo(()=>({
+            dataContext,
+            queryResults,
+            componentOutputs: {
+                ...componentOutputs ?? {},
+                ...outputs
+            }
+        }), [
+        componentOutputs,
+        dataContext,
+        outputs,
+        queryResults
+    ]);
+    const resolver = useCallback((binding)=>{
+        if (!binding.kind && resolveBinding) return resolveBinding(binding);
+        const key = JSON.stringify(binding);
+        const value = resolveBindingExpression(binding, scope);
+        if (binding.nullBehavior === BindingNullBehavior.Preserve && value === undefined) {
+            return previousValues.current.get(key);
+        }
+        if (value !== undefined) previousValues.current.set(key, value);
+        return value;
+    }, [
+        resolveBinding,
+        scope
+    ]);
+    const value = useMemo(()=>({
+            resolveBinding: resolver,
+            scope
+        }), [
+        resolver,
+        scope
+    ]);
+    return /*#__PURE__*/ jsx(Context.Provider, {
+        value: value,
+        children: children
+    });
+}
+function useRenderBindingResolver() {
+    const context = useContext(Context);
+    if (!context) throw new Error('No Scene render binding scope is available.');
+    return context.resolveBinding;
+}
+function useRenderBindingScope() {
+    return useContext(Context)?.scope ?? {};
+}
+
+export { RenderBindingScopeProvider, useRenderBindingResolver, useRenderBindingScope };
+//# sourceMappingURL=RenderBindingScopeContext.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RenderBindingScopeContext.js","sources":["../../../renderer/RenderBindingScopeContext.tsx"],"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 { ReactNode, createContext, useCallback, useContext, useMemo, useRef } from 'react';\nimport { BindingResolver, BindingScope, resolveBindingExpression } from '@cratis/scene.engine';\nimport { BindingExpression, BindingNullBehavior } from '@cratis/scene.model';\nimport { BindingOutputProvider, useBindingOutputScope } from './BindingOutputContext';\n\ninterface RenderBindingScopeValue {\n    resolveBinding: BindingResolver;\n    scope: BindingScope;\n}\n\nconst Context = createContext<RenderBindingScopeValue | undefined>(undefined);\n\nexport interface RenderBindingScopeProviderProps {\n    children: ReactNode;\n    dataContext?: unknown;\n    queryResults?: Record<string, unknown>;\n    componentOutputs?: Record<string, Record<string, unknown>>;\n    resolveBinding?: BindingResolver;\n    onComponentOutputsChanged?: (outputs: Record<string, Record<string, unknown>>) => void;\n}\n\n/**\n * Provides the inherited reactive binding scope for a rendered Scene tree.\n */\nexport function RenderBindingScopeProvider(props: RenderBindingScopeProviderProps) {\n    const current = useContext(Context);\n    if (current) return <>{props.children}</>;\n\n    return (\n        <BindingOutputProvider onOutputsChanged={props.onComponentOutputsChanged}>\n            <RenderBindingScopeInner {...props} />\n        </BindingOutputProvider>\n    );\n}\n\nfunction RenderBindingScopeInner({ children, dataContext, queryResults, componentOutputs, resolveBinding }: RenderBindingScopeProviderProps) {\n    const outputs = useBindingOutputScope();\n    const previousValues = useRef(new Map<string, unknown>());\n    const scope = useMemo<BindingScope>(() => ({\n        dataContext,\n        queryResults,\n        componentOutputs: { ...(componentOutputs ?? {}), ...outputs },\n    }), [componentOutputs, dataContext, outputs, queryResults]);\n\n    const resolver = useCallback<BindingResolver>((binding: BindingExpression) => {\n        if (!binding.kind && resolveBinding) return resolveBinding(binding);\n\n        const key = JSON.stringify(binding);\n        const value = resolveBindingExpression(binding, scope);\n        if (binding.nullBehavior === BindingNullBehavior.Preserve && value === undefined) {\n            return previousValues.current.get(key);\n        }\n\n        if (value !== undefined) previousValues.current.set(key, value);\n        return value;\n    }, [resolveBinding, scope]);\n\n    const value = useMemo<RenderBindingScopeValue>(() => ({ resolveBinding: resolver, scope }), [resolver, scope]);\n    return <Context.Provider value={value}>{children}</Context.Provider>;\n}\n\nexport function useRenderBindingResolver(): BindingResolver {\n    const context = useContext(Context);\n    if (!context) throw new Error('No Scene render binding scope is available.');\n    return context.resolveBinding;\n}\n\nexport function useRenderBindingScope(): BindingScope {\n    return useContext(Context)?.scope ?? {};\n}\n"],"names":["Context","createContext","undefined","RenderBindingScopeProvider","props","current","useContext","_jsx","_Fragment","children","BindingOutputProvider","onOutputsChanged","onComponentOutputsChanged","RenderBindingScopeInner","dataContext","queryResults","componentOutputs","resolveBinding","outputs","useBindingOutputScope","previousValues","useRef","Map","scope","useMemo","resolver","useCallback","binding","kind","key","JSON","stringify","value","resolveBindingExpression","nullBehavior","BindingNullBehavior","Preserve","get","set","Provider","useRenderBindingResolver","context","Error","useRenderBindingScope"],"mappings":";;;;;;AAaA,MAAMA,wBAAUC,aAAAA,CAAmDC,SAAAA,CAAAA;AAWnE;;IAGO,SAASC,0BAAAA,CAA2BC,KAAsC,EAAA;AAC7E,IAAA,MAAMC,UAAUC,UAAAA,CAAWN,OAAAA,CAAAA;AAC3B,IAAA,IAAIK,SAAS,qBAAOE,GAAA,CAAAC,QAAA,EAAA;AAAGJ,QAAAA,QAAAA,EAAAA,KAAAA,CAAMK;;AAE7B,IAAA,qBACIF,GAAA,CAACG,qBAAAA,EAAAA;AAAsBC,QAAAA,gBAAAA,EAAkBP,MAAMQ,yBAAyB;AACpE,QAAA,QAAA,gBAAAL,GAAA,CAACM,uBAAAA,EAAAA;AAAyB,YAAA,GAAGT;;;AAGzC;AAEA,SAASS,uBAAAA,CAAwB,EAAEJ,QAAQ,EAAEK,WAAW,EAAEC,YAAY,EAAEC,gBAAgB,EAAEC,cAAc,EAAmC,EAAA;AACvI,IAAA,MAAMC,OAAAA,GAAUC,qBAAAA,EAAAA;IAChB,MAAMC,cAAAA,GAAiBC,OAAO,IAAIC,GAAAA,EAAAA,CAAAA;IAClC,MAAMC,KAAAA,GAAQC,OAAAA,CAAsB,KAAO;AACvCV,YAAAA,WAAAA;AACAC,YAAAA,YAAAA;YACAC,gBAAAA,EAAkB;gBAAE,GAAIA,gBAAAA,IAAoB,EAAE;AAAG,gBAAA,GAAGE;AAAQ;AAChE,SAAA,CAAA,EAAI;AAACF,QAAAA,gBAAAA;AAAkBF,QAAAA,WAAAA;AAAaI,QAAAA,OAAAA;AAASH,QAAAA;AAAa,KAAA,CAAA;IAE1D,MAAMU,QAAAA,GAAWC,YAA6B,CAACC,OAAAA,GAAAA;AAC3C,QAAA,IAAI,CAACA,OAAAA,CAAQC,IAAI,IAAIX,cAAAA,EAAgB,OAAOA,cAAAA,CAAeU,OAAAA,CAAAA;QAE3D,MAAME,GAAAA,GAAMC,IAAAA,CAAKC,SAAS,CAACJ,OAAAA,CAAAA;QAC3B,MAAMK,KAAAA,GAAQC,yBAAyBN,OAAAA,EAASJ,KAAAA,CAAAA;AAChD,QAAA,IAAII,QAAQO,YAAY,KAAKC,oBAAoBC,QAAQ,IAAIJ,UAAU9B,SAAAA,EAAW;AAC9E,YAAA,OAAOkB,cAAAA,CAAef,OAAO,CAACgC,GAAG,CAACR,GAAAA,CAAAA;AACtC,QAAA;AAEA,QAAA,IAAIG,UAAU9B,SAAAA,EAAWkB,cAAAA,CAAef,OAAO,CAACiC,GAAG,CAACT,GAAAA,EAAKG,KAAAA,CAAAA;QACzD,OAAOA,KAAAA;IACX,CAAA,EAAG;AAACf,QAAAA,cAAAA;AAAgBM,QAAAA;AAAM,KAAA,CAAA;IAE1B,MAAMS,KAAAA,GAAQR,OAAAA,CAAiC,KAAO;YAAEP,cAAAA,EAAgBQ,QAAAA;AAAUF,YAAAA;AAAM,SAAA,CAAA,EAAI;AAACE,QAAAA,QAAAA;AAAUF,QAAAA;AAAM,KAAA,CAAA;IAC7G,qBAAOhB,GAAA,CAACP,QAAQuC,QAAQ,EAAA;QAACP,KAAAA,EAAOA,KAAAA;AAAQvB,QAAAA,QAAAA,EAAAA;;AAC5C;AAEO,SAAS+B,wBAAAA,GAAAA;AACZ,IAAA,MAAMC,UAAUnC,UAAAA,CAAWN,OAAAA,CAAAA;AAC3B,IAAA,IAAI,CAACyC,OAAAA,EAAS,MAAM,IAAIC,KAAAA,CAAM,6CAAA,CAAA;AAC9B,IAAA,OAAOD,QAAQxB,cAAc;AACjC;AAEO,SAAS0B,qBAAAA,GAAAA;IACZ,OAAOrC,UAAAA,CAAWN,OAAAA,CAAAA,EAAUuB,KAAAA,IAAS,EAAC;AAC1C;;"}

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

@@ -1,5 +1,7 @@
+export * from './AbortableQueryRunner';
 export * from './BindingOutputContext';
 export * from './ComponentRegistry';
+export * from './RenderBindingScopeContext';
 export * from './UnresolvedComponent';
 export * from './createReactRenderer';
 export * from './InteractiveComponent';

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,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,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,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC"}

package/dist/esm/renderer/index.js

@@ -1,5 +1,7 @@
+export * from './AbortableQueryRunner';
 export * from './BindingOutputContext';
 export * from './ComponentRegistry';
+export * from './RenderBindingScopeContext';
 export * from './UnresolvedComponent';
 export * from './createReactRenderer';
 export * from './InteractiveComponent';

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,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,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,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC"}