@cratis/scene.react 4.14.0 → 4.15.0

package/dist/esm/renderer/RenderBindingScopeContext.js

@@ -1,16 +1,22 @@
-import { jsx, Fragment } from 'react/jsx-runtime';
+import { jsx } from 'react/jsx-runtime';
 import { useContext, createContext, useRef, useMemo, useCallback } from 'react';
-import { resolveBindingExpression } from '@cratis/scene.engine';
+import { nestBindingScope, 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.
+ *
+ * The outermost provider owns the component output scope. A provider rendered inside another - a nested
+ * template or region - nests its own data context, query results and component outputs over the inherited
+ * scope with `nestBindingScope`, so a detail region bound to the selected row reads that row while still
+ * seeing the screen's queries and every component's outputs.
  */ function RenderBindingScopeProvider(props) {
     const current = useContext(Context);
-    if (current) return /*#__PURE__*/ jsx(Fragment, {
-        children: props.children
+    if (current) return /*#__PURE__*/ jsx(RenderBindingScopeInner, {
+        ...props,
+        parent: current.scope
     });
     return /*#__PURE__*/ jsx(BindingOutputProvider, {
         onOutputsChanged: props.onComponentOutputsChanged,
@@ -19,20 +25,24 @@ const Context = /*#__PURE__*/ createContext(undefined);
         })
     });
 }
-function RenderBindingScopeInner({ children, dataContext, queryResults, componentOutputs, resolveBinding }) {
+function RenderBindingScopeInner({ children, dataContext, queryResults, componentOutputs, resolveBinding, parent }) {
     const outputs = useBindingOutputScope();
     const previousValues = useRef(new Map());
-    const scope = useMemo(()=>({
+    const scope = useMemo(()=>{
+        const own = {
             dataContext,
             queryResults,
             componentOutputs: {
                 ...componentOutputs ?? {},
                 ...outputs
             }
-        }), [
+        };
+        return parent ? nestBindingScope(parent, own) : own;
+    }, [
         componentOutputs,
         dataContext,
         outputs,
+        parent,
         queryResults
     ]);
     const resolver = useCallback((binding)=>{

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

@@ -1 +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;;"}
+{"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, nestBindingScope, 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 *\n * The outermost provider owns the component output scope. A provider rendered inside another - a nested\n * template or region - nests its own data context, query results and component outputs over the inherited\n * scope with `nestBindingScope`, so a detail region bound to the selected row reads that row while still\n * seeing the screen's queries and every component's outputs.\n */\nexport function RenderBindingScopeProvider(props: RenderBindingScopeProviderProps) {\n    const current = useContext(Context);\n    if (current) return <RenderBindingScopeInner {...props} parent={current.scope} />;\n\n    return (\n        <BindingOutputProvider onOutputsChanged={props.onComponentOutputsChanged}>\n            <RenderBindingScopeInner {...props} />\n        </BindingOutputProvider>\n    );\n}\n\nfunction RenderBindingScopeInner({ children, dataContext, queryResults, componentOutputs, resolveBinding, parent }: RenderBindingScopeProviderProps & { parent?: BindingScope }) {\n    const outputs = useBindingOutputScope();\n    const previousValues = useRef(new Map<string, unknown>());\n    const scope = useMemo<BindingScope>(() => {\n        const own = { dataContext, queryResults, componentOutputs: { ...(componentOutputs ?? {}), ...outputs } };\n        return parent ? nestBindingScope(parent, own) : own;\n    }, [componentOutputs, dataContext, outputs, parent, 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","RenderBindingScopeInner","parent","scope","BindingOutputProvider","onOutputsChanged","onComponentOutputsChanged","children","dataContext","queryResults","componentOutputs","resolveBinding","outputs","useBindingOutputScope","previousValues","useRef","Map","useMemo","own","nestBindingScope","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;;;;;;;IAQO,SAASC,0BAAAA,CAA2BC,KAAsC,EAAA;AAC7E,IAAA,MAAMC,UAAUC,UAAAA,CAAWN,OAAAA,CAAAA;IAC3B,IAAIK,OAAAA,EAAS,qBAAOE,GAAA,CAACC,uBAAAA,EAAAA;AAAyB,QAAA,GAAGJ,KAAK;AAAEK,QAAAA,MAAAA,EAAQJ,QAAQK;;AAExE,IAAA,qBACIH,GAAA,CAACI,qBAAAA,EAAAA;AAAsBC,QAAAA,gBAAAA,EAAkBR,MAAMS,yBAAyB;AACpE,QAAA,QAAA,gBAAAN,GAAA,CAACC,uBAAAA,EAAAA;AAAyB,YAAA,GAAGJ;;;AAGzC;AAEA,SAASI,uBAAAA,CAAwB,EAAEM,QAAQ,EAAEC,WAAW,EAAEC,YAAY,EAAEC,gBAAgB,EAAEC,cAAc,EAAET,MAAM,EAA+D,EAAA;AAC3K,IAAA,MAAMU,OAAAA,GAAUC,qBAAAA,EAAAA;IAChB,MAAMC,cAAAA,GAAiBC,OAAO,IAAIC,GAAAA,EAAAA,CAAAA;AAClC,IAAA,MAAMb,QAAQc,OAAAA,CAAsB,IAAA;AAChC,QAAA,MAAMC,GAAAA,GAAM;AAAEV,YAAAA,WAAAA;AAAaC,YAAAA,YAAAA;YAAcC,gBAAAA,EAAkB;gBAAE,GAAIA,gBAAAA,IAAoB,EAAE;AAAG,gBAAA,GAAGE;AAAQ;AAAE,SAAA;QACvG,OAAOV,MAAAA,GAASiB,gBAAAA,CAAiBjB,MAAAA,EAAQgB,GAAAA,CAAAA,GAAOA,GAAAA;IACpD,CAAA,EAAG;AAACR,QAAAA,gBAAAA;AAAkBF,QAAAA,WAAAA;AAAaI,QAAAA,OAAAA;AAASV,QAAAA,MAAAA;AAAQO,QAAAA;AAAa,KAAA,CAAA;IAEjE,MAAMW,QAAAA,GAAWC,YAA6B,CAACC,OAAAA,GAAAA;AAC3C,QAAA,IAAI,CAACA,OAAAA,CAAQC,IAAI,IAAIZ,cAAAA,EAAgB,OAAOA,cAAAA,CAAeW,OAAAA,CAAAA;QAE3D,MAAME,GAAAA,GAAMC,IAAAA,CAAKC,SAAS,CAACJ,OAAAA,CAAAA;QAC3B,MAAMK,KAAAA,GAAQC,yBAAyBN,OAAAA,EAASnB,KAAAA,CAAAA;AAChD,QAAA,IAAImB,QAAQO,YAAY,KAAKC,oBAAoBC,QAAQ,IAAIJ,UAAUhC,SAAAA,EAAW;AAC9E,YAAA,OAAOmB,cAAAA,CAAehB,OAAO,CAACkC,GAAG,CAACR,GAAAA,CAAAA;AACtC,QAAA;AAEA,QAAA,IAAIG,UAAUhC,SAAAA,EAAWmB,cAAAA,CAAehB,OAAO,CAACmC,GAAG,CAACT,GAAAA,EAAKG,KAAAA,CAAAA;QACzD,OAAOA,KAAAA;IACX,CAAA,EAAG;AAAChB,QAAAA,cAAAA;AAAgBR,QAAAA;AAAM,KAAA,CAAA;IAE1B,MAAMwB,KAAAA,GAAQV,OAAAA,CAAiC,KAAO;YAAEN,cAAAA,EAAgBS,QAAAA;AAAUjB,YAAAA;AAAM,SAAA,CAAA,EAAI;AAACiB,QAAAA,QAAAA;AAAUjB,QAAAA;AAAM,KAAA,CAAA;IAC7G,qBAAOH,GAAA,CAACP,QAAQyC,QAAQ,EAAA;QAACP,KAAAA,EAAOA,KAAAA;AAAQpB,QAAAA,QAAAA,EAAAA;;AAC5C;AAEO,SAAS4B,wBAAAA,GAAAA;AACZ,IAAA,MAAMC,UAAUrC,UAAAA,CAAWN,OAAAA,CAAAA;AAC3B,IAAA,IAAI,CAAC2C,OAAAA,EAAS,MAAM,IAAIC,KAAAA,CAAM,6CAAA,CAAA;AAC9B,IAAA,OAAOD,QAAQzB,cAAc;AACjC;AAEO,SAAS2B,qBAAAA,GAAAA;IACZ,OAAOvC,UAAAA,CAAWN,OAAAA,CAAAA,EAAUU,KAAAA,IAAS,EAAC;AAC1C;;"}

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

@@ -3,6 +3,7 @@ export * from './BindingOutputContext';
 export * from './ComponentRegistry';
 export * from './RenderBindingScopeContext';
 export * from './UnresolvedComponent';
+export * from './useBoundQuery';
 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,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,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC"}

package/dist/esm/renderer/index.js

@@ -3,6 +3,7 @@ export * from './BindingOutputContext';
 export * from './ComponentRegistry';
 export * from './RenderBindingScopeContext';
 export * from './UnresolvedComponent';
+export * from './useBoundQuery';
 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,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,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC"}

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

@@ -0,0 +1,3 @@
+import { QueryPerformer } from './AbortableQueryRunner';
+export declare function useBoundQuery(query: string, argumentsValue: unknown, perform: QueryPerformer): Record<string, unknown>;
+//# sourceMappingURL=useBoundQuery.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useBoundQuery.d.ts","sourceRoot":"","sources":["../../../renderer/useBoundQuery.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAWxD,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAiCtH"}

package/dist/esm/renderer/useBoundQuery.js

@@ -0,0 +1,48 @@
+import { useMemo, useState, useRef, useEffect } from 'react';
+import { QueryBindingState } from '@cratis/scene.engine';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Runs a bound query whenever its arguments change and returns the accepted query results.
+ *
+ * Each change of arguments rebinds the query: the previous run is aborted and, should its answer still
+ * arrive, discarded by `QueryBindingState` - a slow result for a previous selection never replaces the
+ * current one. Arguments of `undefined` mean the binding is cleared, as when a selection is cleared, so the
+ * result is removed, and so is it when the current run fails - a failed rebind must not leave the previous
+ * selection's data on screen. The results are keyed by `query`, ready to pass as a scope's `queryResults`.
+ */ function useBoundQuery(query, argumentsValue, perform) {
+    const state = useMemo(()=>new QueryBindingState(), []);
+    const [results, setResults] = useState({});
+    const key = argumentsValue === undefined ? undefined : JSON.stringify(argumentsValue);
+    const latestArguments = useRef(argumentsValue);
+    latestArguments.current = argumentsValue;
+    // The arguments are compared by value through `key`; the effect reads them from `latestArguments`.
+    useEffect(()=>{
+        const argumentsForRun = latestArguments.current;
+        if (argumentsForRun === undefined) {
+            state.clear(query);
+            setResults(state.queryResults);
+            return undefined;
+        }
+        const controller = new AbortController();
+        const ticket = state.begin(query);
+        perform(query, argumentsForRun, controller.signal).then((result)=>{
+            if (state.complete(ticket, result)) setResults(state.queryResults);
+        }, ()=>{
+            if (controller.signal.aborted || !state.complete(ticket, undefined)) return;
+            state.clear(query);
+            setResults(state.queryResults);
+        });
+        return ()=>controller.abort();
+    }, [
+        key,
+        perform,
+        query,
+        state
+    ]);
+    return results;
+}
+
+export { useBoundQuery };
+//# sourceMappingURL=useBoundQuery.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useBoundQuery.js","sources":["../../../renderer/useBoundQuery.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, useMemo, useRef, useState } from 'react';\nimport { QueryBindingState } from '@cratis/scene.engine';\nimport { QueryPerformer } from './AbortableQueryRunner';\n\n/**\n * Runs a bound query whenever its arguments change and returns the accepted query results.\n *\n * Each change of arguments rebinds the query: the previous run is aborted and, should its answer still\n * arrive, discarded by `QueryBindingState` - a slow result for a previous selection never replaces the\n * current one. Arguments of `undefined` mean the binding is cleared, as when a selection is cleared, so the\n * result is removed, and so is it when the current run fails - a failed rebind must not leave the previous\n * selection's data on screen. The results are keyed by `query`, ready to pass as a scope's `queryResults`.\n */\nexport function useBoundQuery(query: string, argumentsValue: unknown, perform: QueryPerformer): Record<string, unknown> {\n    const state = useMemo(() => new QueryBindingState(), []);\n    const [results, setResults] = useState<Record<string, unknown>>({});\n    const key = argumentsValue === undefined ? undefined : JSON.stringify(argumentsValue);\n    const latestArguments = useRef(argumentsValue);\n    latestArguments.current = argumentsValue;\n\n    // The arguments are compared by value through `key`; the effect reads them from `latestArguments`.\n    useEffect(() => {\n        const argumentsForRun = latestArguments.current;\n        if (argumentsForRun === undefined) {\n            state.clear(query);\n            setResults(state.queryResults);\n            return undefined;\n        }\n\n        const controller = new AbortController();\n        const ticket = state.begin(query);\n        perform(query, argumentsForRun, controller.signal).then(\n            result => {\n                if (state.complete(ticket, result)) setResults(state.queryResults);\n            },\n            () => {\n                if (controller.signal.aborted || !state.complete(ticket, undefined)) return;\n                state.clear(query);\n                setResults(state.queryResults);\n            },\n        );\n\n        return () => controller.abort();\n    }, [key, perform, query, state]);\n\n    return results;\n}\n"],"names":["useBoundQuery","query","argumentsValue","perform","state","useMemo","QueryBindingState","results","setResults","useState","key","undefined","JSON","stringify","latestArguments","useRef","current","useEffect","argumentsForRun","clear","queryResults","controller","AbortController","ticket","begin","signal","then","result","complete","aborted","abort"],"mappings":";;;AAAA;AACA;AAMA;;;;;;;;AAQC,IACM,SAASA,aAAAA,CAAcC,KAAa,EAAEC,cAAuB,EAAEC,OAAuB,EAAA;AACzF,IAAA,MAAMC,KAAAA,GAAQC,OAAAA,CAAQ,IAAM,IAAIC,qBAAqB,EAAE,CAAA;AACvD,IAAA,MAAM,CAACC,OAAAA,EAASC,UAAAA,CAAW,GAAGC,SAAkC,EAAC,CAAA;AACjE,IAAA,MAAMC,MAAMR,cAAAA,KAAmBS,SAAAA,GAAYA,SAAAA,GAAYC,IAAAA,CAAKC,SAAS,CAACX,cAAAA,CAAAA;AACtE,IAAA,MAAMY,kBAAkBC,MAAAA,CAAOb,cAAAA,CAAAA;AAC/BY,IAAAA,eAAAA,CAAgBE,OAAO,GAAGd,cAAAA;;IAG1Be,SAAAA,CAAU,IAAA;QACN,MAAMC,eAAAA,GAAkBJ,gBAAgBE,OAAO;AAC/C,QAAA,IAAIE,oBAAoBP,SAAAA,EAAW;AAC/BP,YAAAA,KAAAA,CAAMe,KAAK,CAAClB,KAAAA,CAAAA;AACZO,YAAAA,UAAAA,CAAWJ,MAAMgB,YAAY,CAAA;YAC7B,OAAOT,SAAAA;AACX,QAAA;AAEA,QAAA,MAAMU,aAAa,IAAIC,eAAAA,EAAAA;QACvB,MAAMC,MAAAA,GAASnB,KAAAA,CAAMoB,KAAK,CAACvB,KAAAA,CAAAA;AAC3BE,QAAAA,OAAAA,CAAQF,OAAOiB,eAAAA,EAAiBG,UAAAA,CAAWI,MAAM,CAAA,CAAEC,IAAI,CACnDC,CAAAA,MAAAA,GAAAA;AACI,YAAA,IAAIvB,MAAMwB,QAAQ,CAACL,QAAQI,MAAAA,CAAAA,EAASnB,UAAAA,CAAWJ,MAAMgB,YAAY,CAAA;QACrE,CAAA,EACA,IAAA;YACI,IAAIC,UAAAA,CAAWI,MAAM,CAACI,OAAO,IAAI,CAACzB,KAAAA,CAAMwB,QAAQ,CAACL,MAAAA,EAAQZ,SAAAA,CAAAA,EAAY;AACrEP,YAAAA,KAAAA,CAAMe,KAAK,CAAClB,KAAAA,CAAAA;AACZO,YAAAA,UAAAA,CAAWJ,MAAMgB,YAAY,CAAA;AACjC,QAAA,CAAA,CAAA;QAGJ,OAAO,IAAMC,WAAWS,KAAK,EAAA;IACjC,CAAA,EAAG;AAACpB,QAAAA,GAAAA;AAAKP,QAAAA,OAAAA;AAASF,QAAAA,KAAAA;AAAOG,QAAAA;AAAM,KAAA,CAAA;IAE/B,OAAOG,OAAAA;AACX;;"}