@deephaven/jsapi-bootstrap 0.61.1 → 0.61.2-beta.0

package/dist/DeferredApiBootstrap.d.ts

@@ -1,14 +1,17 @@
 import React from 'react';
+import { VariableDescriptor } from '@deephaven/jsapi-types';
 type DeferredApiBootstrapProps = React.PropsWithChildren<{
     onError?: (error: unknown) => void;
     /**
-     * Options to use when fetching the deferred API.
+     * Descriptor for the widget to load. Passed into an `ObjectFetcher` to load the widget.
+     * The descriptor may be extended to include session information or other data required to identify the widget.
+     * The surrounding `ObjectFetcherContext` will then be able to use that information to correctly load the widget.
      */
-    options?: Record<string, unknown>;
+    widget: VariableDescriptor;
 }>;
 /**
  * Does not render children until the deferred API is resolved.
  */
-export declare const DeferredApiBootstrap: React.MemoExoticComponent<({ children, onError, options, }: DeferredApiBootstrapProps) => JSX.Element | null>;
+export declare const DeferredApiBootstrap: React.MemoExoticComponent<({ children, onError, widget, }: DeferredApiBootstrapProps) => JSX.Element | null>;
 export default DeferredApiBootstrap;
 //# sourceMappingURL=DeferredApiBootstrap.d.ts.map

package/dist/DeferredApiBootstrap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DeferredApiBootstrap.d.ts","sourceRoot":"","sources":["../src/DeferredApiBootstrap.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAI1B,KAAK,yBAAyB,GAAG,KAAK,CAAC,iBAAiB,CAAC;IACvD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,oBAAoB,8DAK5B,yBAAyB,KAAG,WAAW,GAAG,IAAI,CAYlD,CAAC;AAIF,eAAe,oBAAoB,CAAC"}
+{"version":3,"file":"DeferredApiBootstrap.d.ts","sourceRoot":"","sources":["../src/DeferredApiBootstrap.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAI5D,KAAK,yBAAyB,GAAG,KAAK,CAAC,iBAAiB,CAAC;IACvD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IACnC;;;;OAIG;IACH,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,oBAAoB,6DAK5B,yBAAyB,KAAG,WAAW,GAAG,IAAI,CAYlD,CAAC;AAIF,eAAe,oBAAoB,CAAC"}

package/dist/DeferredApiBootstrap.js

@@ -9,9 +9,9 @@ export var DeferredApiBootstrap = /*#__PURE__*/React.memo(_ref => {
   var {
     children,
     onError,
-    options
+    widget
   } = _ref;
-  var [api, apiError] = useDeferredApi(options);
+  var [api, apiError] = useDeferredApi(widget);
   if (apiError != null) {
     onError === null || onError === void 0 ? void 0 : onError(apiError);
     return null;

package/dist/DeferredApiBootstrap.js.map

@@ -1 +1 @@
-{"version":3,"file":"DeferredApiBootstrap.js","names":["React","useDeferredApi","ApiContext","jsx","_jsx","DeferredApiBootstrap","memo","_ref","children","onError","options","api","apiError","Provider","value","displayName"],"sources":["../src/DeferredApiBootstrap.tsx"],"sourcesContent":["import React from 'react';\nimport useDeferredApi from './useDeferredApi';\nimport { ApiContext } from './ApiBootstrap';\n\ntype DeferredApiBootstrapProps = React.PropsWithChildren<{\n  onError?: (error: unknown) => void;\n  /**\n   * Options to use when fetching the deferred API.\n   */\n  options?: Record<string, unknown>;\n}>;\n\n/**\n * Does not render children until the deferred API is resolved.\n */\nexport const DeferredApiBootstrap = React.memo(\n  ({\n    children,\n    onError,\n    options,\n  }: DeferredApiBootstrapProps): JSX.Element | null => {\n    const [api, apiError] = useDeferredApi(options);\n    if (apiError != null) {\n      onError?.(apiError);\n      return null;\n    }\n    if (api == null) {\n      // Still waiting for the API to load\n      return null;\n    }\n    return <ApiContext.Provider value={api}>{children}</ApiContext.Provider>;\n  }\n);\n\nDeferredApiBootstrap.displayName = 'DeferredApiBootstrap';\n\nexport default DeferredApiBootstrap;\n"],"mappings":"AAAA,OAAOA,KAAK,MAAM,OAAO;AAAC,OACnBC,cAAc;AAAA,SACZC,UAAU;AAAA,SAAAC,GAAA,IAAAC,IAAA;AAUnB;AACA;AACA;AACA,OAAO,IAAMC,oBAAoB,gBAAGL,KAAK,CAACM,IAAI,CAC5CC,IAAA,IAIqD;EAAA,IAJpD;IACCC,QAAQ;IACRC,OAAO;IACPC;EACyB,CAAC,GAAAH,IAAA;EAC1B,IAAM,CAACI,GAAG,EAAEC,QAAQ,CAAC,GAAGX,cAAc,CAACS,OAAO,CAAC;EAC/C,IAAIE,QAAQ,IAAI,IAAI,EAAE;IACpBH,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAGG,QAAQ,CAAC;IACnB,OAAO,IAAI;EACb;EACA,IAAID,GAAG,IAAI,IAAI,EAAE;IACf;IACA,OAAO,IAAI;EACb;EACA,oBAAOP,IAAA,CAACF,UAAU,CAACW,QAAQ;IAACC,KAAK,EAAEH,GAAI;IAAAH,QAAA,EAAEA;EAAQ,CAAsB,CAAC;AAC1E,CACF,CAAC;AAEDH,oBAAoB,CAACU,WAAW,GAAG,sBAAsB;AAEzD,eAAeV,oBAAoB"}
+{"version":3,"file":"DeferredApiBootstrap.js","names":["React","useDeferredApi","ApiContext","jsx","_jsx","DeferredApiBootstrap","memo","_ref","children","onError","widget","api","apiError","Provider","value","displayName"],"sources":["../src/DeferredApiBootstrap.tsx"],"sourcesContent":["import React from 'react';\nimport { VariableDescriptor } from '@deephaven/jsapi-types';\nimport useDeferredApi from './useDeferredApi';\nimport { ApiContext } from './ApiBootstrap';\n\ntype DeferredApiBootstrapProps = React.PropsWithChildren<{\n  onError?: (error: unknown) => void;\n  /**\n   * Descriptor for the widget to load. Passed into an `ObjectFetcher` to load the widget.\n   * The descriptor may be extended to include session information or other data required to identify the widget.\n   * The surrounding `ObjectFetcherContext` will then be able to use that information to correctly load the widget.\n   */\n  widget: VariableDescriptor;\n}>;\n\n/**\n * Does not render children until the deferred API is resolved.\n */\nexport const DeferredApiBootstrap = React.memo(\n  ({\n    children,\n    onError,\n    widget,\n  }: DeferredApiBootstrapProps): JSX.Element | null => {\n    const [api, apiError] = useDeferredApi(widget);\n    if (apiError != null) {\n      onError?.(apiError);\n      return null;\n    }\n    if (api == null) {\n      // Still waiting for the API to load\n      return null;\n    }\n    return <ApiContext.Provider value={api}>{children}</ApiContext.Provider>;\n  }\n);\n\nDeferredApiBootstrap.displayName = 'DeferredApiBootstrap';\n\nexport default DeferredApiBootstrap;\n"],"mappings":"AAAA,OAAOA,KAAK,MAAM,OAAO;AAAC,OAEnBC,cAAc;AAAA,SACZC,UAAU;AAAA,SAAAC,GAAA,IAAAC,IAAA;AAYnB;AACA;AACA;AACA,OAAO,IAAMC,oBAAoB,gBAAGL,KAAK,CAACM,IAAI,CAC5CC,IAAA,IAIqD;EAAA,IAJpD;IACCC,QAAQ;IACRC,OAAO;IACPC;EACyB,CAAC,GAAAH,IAAA;EAC1B,IAAM,CAACI,GAAG,EAAEC,QAAQ,CAAC,GAAGX,cAAc,CAACS,MAAM,CAAC;EAC9C,IAAIE,QAAQ,IAAI,IAAI,EAAE;IACpBH,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAGG,QAAQ,CAAC;IACnB,OAAO,IAAI;EACb;EACA,IAAID,GAAG,IAAI,IAAI,EAAE;IACf;IACA,OAAO,IAAI;EACb;EACA,oBAAOP,IAAA,CAACF,UAAU,CAACW,QAAQ;IAACC,KAAK,EAAEH,GAAI;IAAAH,QAAA,EAAEA;EAAQ,CAAsB,CAAC;AAC1E,CACF,CAAC;AAEDH,oBAAoB,CAACU,WAAW,GAAG,sBAAsB;AAEzD,eAAeV,oBAAoB"}

package/dist/index.d.ts

@@ -4,4 +4,5 @@ export * from './DeferredApiBootstrap';
 export * from './useApi';
 export * from './useClient';
 export * from './useDeferredApi';
+export * from './useObjectFetcher';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC"}

package/dist/index.js

@@ -4,4 +4,5 @@ export * from "./DeferredApiBootstrap.js";
 export * from "./useApi.js";
 export * from "./useClient.js";
 export * from "./useDeferredApi.js";
+export * from "./useObjectFetcher.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["export * from './ApiBootstrap';\nexport * from './ClientBootstrap';\nexport * from './DeferredApiBootstrap';\nexport * from './useApi';\nexport * from './useClient';\nexport * from './useDeferredApi';\n"],"mappings":""}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["export * from './ApiBootstrap';\nexport * from './ClientBootstrap';\nexport * from './DeferredApiBootstrap';\nexport * from './useApi';\nexport * from './useClient';\nexport * from './useDeferredApi';\nexport * from './useObjectFetcher';\n"],"mappings":""}

package/dist/useDeferredApi.d.ts

@@ -1,14 +1,20 @@
 /// <reference types="react" />
-import type { dh as DhType } from '@deephaven/jsapi-types';
-/** Options for retrieving the deferred */
-export type DeferredApiOptions = Record<string, unknown>;
-export type DeferredApiFetcher = (options?: DeferredApiOptions) => Promise<DhType>;
+import type { dh as DhType, VariableDescriptor } from '@deephaven/jsapi-types';
+/**
+ * Function to fetch an API based on a provided descriptor object.
+ * Depending on the context there may be more properties on the descriptor,
+ * providing more information about the object, such as a session ID.
+ * @param descriptor Descriptor object to fetch the API from.
+ * @returns A promise that resolves to the API instance for the provided variable descriptor.
+ */
+export type DeferredApiFetcher = (descriptor: VariableDescriptor) => Promise<DhType>;
 export declare const DeferredApiContext: import("react").Context<DhType | DeferredApiFetcher | null>;
 /**
- * Retrieve the API for the current context, given the metadata provided.
+ * Retrieve the API for the current context, given the widget provided.
  * The API may need to be loaded, and will return `null` until it is ready.
+ * @param widget The widget descriptor to use to fetch the API
  * @returns A tuple with the API instance, and an error if one occurred.
  */
-export declare function useDeferredApi(options?: Record<string, unknown>): [DhType | null, unknown | null];
+export declare function useDeferredApi(widget: VariableDescriptor): [DhType | null, unknown | null];
 export default useDeferredApi;
 //# sourceMappingURL=useDeferredApi.d.ts.map

package/dist/useDeferredApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useDeferredApi.d.ts","sourceRoot":"","sources":["../src/useDeferredApi.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAG3D,0CAA0C;AAC1C,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEzD,MAAM,MAAM,kBAAkB,GAAG,CAC/B,OAAO,CAAC,EAAE,kBAAkB,KACzB,OAAO,CAAC,MAAM,CAAC,CAAC;AAErB,eAAO,MAAM,kBAAkB,6DAExB,CAAC;AAER;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,CAAC,MAAM,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC,CAkDjC;AAED,eAAe,cAAc,CAAC"}
+{"version":3,"file":"useDeferredApi.d.ts","sourceRoot":"","sources":["../src/useDeferredApi.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EAAE,EAAE,IAAI,MAAM,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAG/E;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAC/B,UAAU,EAAE,kBAAkB,KAC3B,OAAO,CAAC,MAAM,CAAC,CAAC;AAErB,eAAO,MAAM,kBAAkB,6DAExB,CAAC;AAER;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,kBAAkB,GACzB,CAAC,MAAM,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC,CAkDjC;AAED,eAAe,cAAc,CAAC"}

package/dist/useDeferredApi.js

@@ -2,15 +2,22 @@ function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try
 function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
 import { createContext, useContext, useEffect, useState } from 'react';
 import { ApiContext } from "./ApiBootstrap.js";
-/** Options for retrieving the deferred */
+/**
+ * Function to fetch an API based on a provided descriptor object.
+ * Depending on the context there may be more properties on the descriptor,
+ * providing more information about the object, such as a session ID.
+ * @param descriptor Descriptor object to fetch the API from.
+ * @returns A promise that resolves to the API instance for the provided variable descriptor.
+ */
 export var DeferredApiContext = /*#__PURE__*/createContext(null);
 
 /**
- * Retrieve the API for the current context, given the metadata provided.
+ * Retrieve the API for the current context, given the widget provided.
  * The API may need to be loaded, and will return `null` until it is ready.
+ * @param widget The widget descriptor to use to fetch the API
  * @returns A tuple with the API instance, and an error if one occurred.
  */
-export function useDeferredApi(options) {
+export function useDeferredApi(widget) {
   var [api, setApi] = useState(null);
   var [error, setError] = useState(null);
   var deferredApi = useContext(DeferredApiContext);
@@ -34,7 +41,7 @@ export function useDeferredApi(options) {
       _loadApi = _asyncToGenerator(function* () {
         if (typeof deferredApi === 'function') {
           try {
-            var newApi = yield deferredApi(options);
+            var newApi = yield deferredApi(widget);
             if (!isCancelled) {
               setApi(newApi);
               setError(null);
@@ -55,7 +62,7 @@ export function useDeferredApi(options) {
     return () => {
       isCancelled = true;
     };
-  }, [contextApi, deferredApi, options]);
+  }, [contextApi, deferredApi, widget]);
   return [api, error];
 }
 export default useDeferredApi;

package/dist/useDeferredApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"useDeferredApi.js","names":["createContext","useContext","useEffect","useState","ApiContext","DeferredApiContext","useDeferredApi","options","api","setApi","error","setError","deferredApi","contextApi","Error","isCancelled","loadApi","_loadApi","apply","arguments","_asyncToGenerator","newApi","e"],"sources":["../src/useDeferredApi.ts"],"sourcesContent":["import { createContext, useContext, useEffect, useState } from 'react';\nimport type { dh as DhType } from '@deephaven/jsapi-types';\nimport { ApiContext } from './ApiBootstrap';\n\n/** Options for retrieving the deferred */\nexport type DeferredApiOptions = Record<string, unknown>;\n\nexport type DeferredApiFetcher = (\n  options?: DeferredApiOptions\n) => Promise<DhType>;\n\nexport const DeferredApiContext = createContext<\n  DhType | DeferredApiFetcher | null\n>(null);\n\n/**\n * Retrieve the API for the current context, given the metadata provided.\n * The API may need to be loaded, and will return `null` until it is ready.\n * @returns A tuple with the API instance, and an error if one occurred.\n */\nexport function useDeferredApi(\n  options?: Record<string, unknown>\n): [DhType | null, unknown | null] {\n  const [api, setApi] = useState<DhType | null>(null);\n  const [error, setError] = useState<unknown | null>(null);\n  const deferredApi = useContext(DeferredApiContext);\n  const contextApi = useContext(ApiContext);\n\n  useEffect(() => {\n    if (deferredApi == null) {\n      if (contextApi != null) {\n        setApi(contextApi);\n        setError(null);\n        return;\n      }\n      setApi(null);\n      setError(\n        new Error(\n          'No API available in useDeferredApi. Was code wrapped in ApiBootstrap or DeferredApiContext.Provider?'\n        )\n      );\n      return;\n    }\n    let isCancelled = false;\n\n    async function loadApi() {\n      if (typeof deferredApi === 'function') {\n        try {\n          const newApi = await deferredApi(options);\n          if (!isCancelled) {\n            setApi(newApi);\n            setError(null);\n          }\n        } catch (e) {\n          if (!isCancelled) {\n            setApi(null);\n            setError(e);\n          }\n        }\n      } else {\n        setApi(deferredApi);\n      }\n    }\n\n    loadApi();\n\n    return () => {\n      isCancelled = true;\n    };\n  }, [contextApi, deferredApi, options]);\n\n  return [api, error];\n}\n\nexport default useDeferredApi;\n"],"mappings":";;AAAA,SAASA,aAAa,EAAEC,UAAU,EAAEC,SAAS,EAAEC,QAAQ,QAAQ,OAAO;AAAC,SAE9DC,UAAU;AAEnB;AAOA,OAAO,IAAMC,kBAAkB,gBAAGL,aAAa,CAE7C,IAAI,CAAC;;AAEP;AACA;AACA;AACA;AACA;AACA,OAAO,SAASM,cAAcA,CAC5BC,OAAiC,EACA;EACjC,IAAM,CAACC,GAAG,EAAEC,MAAM,CAAC,GAAGN,QAAQ,CAAgB,IAAI,CAAC;EACnD,IAAM,CAACO,KAAK,EAAEC,QAAQ,CAAC,GAAGR,QAAQ,CAAiB,IAAI,CAAC;EACxD,IAAMS,WAAW,GAAGX,UAAU,CAACI,kBAAkB,CAAC;EAClD,IAAMQ,UAAU,GAAGZ,UAAU,CAACG,UAAU,CAAC;EAEzCF,SAAS,CAAC,MAAM;IACd,IAAIU,WAAW,IAAI,IAAI,EAAE;MACvB,IAAIC,UAAU,IAAI,IAAI,EAAE;QACtBJ,MAAM,CAACI,UAAU,CAAC;QAClBF,QAAQ,CAAC,IAAI,CAAC;QACd;MACF;MACAF,MAAM,CAAC,IAAI,CAAC;MACZE,QAAQ,CACN,IAAIG,KAAK,CACP,sGACF,CACF,CAAC;MACD;IACF;IACA,IAAIC,WAAW,GAAG,KAAK;IAAC,SAETC,OAAOA,CAAA;MAAA,OAAAC,QAAA,CAAAC,KAAA,OAAAC,SAAA;IAAA;IAAA,SAAAF,SAAA;MAAAA,QAAA,GAAAG,iBAAA,CAAtB,aAAyB;QACvB,IAAI,OAAOR,WAAW,KAAK,UAAU,EAAE;UACrC,IAAI;YACF,IAAMS,MAAM,SAAST,WAAW,CAACL,OAAO,CAAC;YACzC,IAAI,CAACQ,WAAW,EAAE;cAChBN,MAAM,CAACY,MAAM,CAAC;cACdV,QAAQ,CAAC,IAAI,CAAC;YAChB;UACF,CAAC,CAAC,OAAOW,CAAC,EAAE;YACV,IAAI,CAACP,WAAW,EAAE;cAChBN,MAAM,CAAC,IAAI,CAAC;cACZE,QAAQ,CAACW,CAAC,CAAC;YACb;UACF;QACF,CAAC,MAAM;UACLb,MAAM,CAACG,WAAW,CAAC;QACrB;MACF,CAAC;MAAA,OAAAK,QAAA,CAAAC,KAAA,OAAAC,SAAA;IAAA;IAEDH,OAAO,CAAC,CAAC;IAET,OAAO,MAAM;MACXD,WAAW,GAAG,IAAI;IACpB,CAAC;EACH,CAAC,EAAE,CAACF,UAAU,EAAED,WAAW,EAAEL,OAAO,CAAC,CAAC;EAEtC,OAAO,CAACC,GAAG,EAAEE,KAAK,CAAC;AACrB;AAEA,eAAeJ,cAAc"}
+{"version":3,"file":"useDeferredApi.js","names":["createContext","useContext","useEffect","useState","ApiContext","DeferredApiContext","useDeferredApi","widget","api","setApi","error","setError","deferredApi","contextApi","Error","isCancelled","loadApi","_loadApi","apply","arguments","_asyncToGenerator","newApi","e"],"sources":["../src/useDeferredApi.ts"],"sourcesContent":["import { createContext, useContext, useEffect, useState } from 'react';\nimport type { dh as DhType, VariableDescriptor } from '@deephaven/jsapi-types';\nimport { ApiContext } from './ApiBootstrap';\n\n/**\n * Function to fetch an API based on a provided descriptor object.\n * Depending on the context there may be more properties on the descriptor,\n * providing more information about the object, such as a session ID.\n * @param descriptor Descriptor object to fetch the API from.\n * @returns A promise that resolves to the API instance for the provided variable descriptor.\n */\nexport type DeferredApiFetcher = (\n  descriptor: VariableDescriptor\n) => Promise<DhType>;\n\nexport const DeferredApiContext = createContext<\n  DhType | DeferredApiFetcher | null\n>(null);\n\n/**\n * Retrieve the API for the current context, given the widget provided.\n * The API may need to be loaded, and will return `null` until it is ready.\n * @param widget The widget descriptor to use to fetch the API\n * @returns A tuple with the API instance, and an error if one occurred.\n */\nexport function useDeferredApi(\n  widget: VariableDescriptor\n): [DhType | null, unknown | null] {\n  const [api, setApi] = useState<DhType | null>(null);\n  const [error, setError] = useState<unknown | null>(null);\n  const deferredApi = useContext(DeferredApiContext);\n  const contextApi = useContext(ApiContext);\n\n  useEffect(() => {\n    if (deferredApi == null) {\n      if (contextApi != null) {\n        setApi(contextApi);\n        setError(null);\n        return;\n      }\n      setApi(null);\n      setError(\n        new Error(\n          'No API available in useDeferredApi. Was code wrapped in ApiBootstrap or DeferredApiContext.Provider?'\n        )\n      );\n      return;\n    }\n    let isCancelled = false;\n\n    async function loadApi() {\n      if (typeof deferredApi === 'function') {\n        try {\n          const newApi = await deferredApi(widget);\n          if (!isCancelled) {\n            setApi(newApi);\n            setError(null);\n          }\n        } catch (e) {\n          if (!isCancelled) {\n            setApi(null);\n            setError(e);\n          }\n        }\n      } else {\n        setApi(deferredApi);\n      }\n    }\n\n    loadApi();\n\n    return () => {\n      isCancelled = true;\n    };\n  }, [contextApi, deferredApi, widget]);\n\n  return [api, error];\n}\n\nexport default useDeferredApi;\n"],"mappings":";;AAAA,SAASA,aAAa,EAAEC,UAAU,EAAEC,SAAS,EAAEC,QAAQ,QAAQ,OAAO;AAAC,SAE9DC,UAAU;AAEnB;AACA;AACA;AACA;AACA;AACA;AACA;AAKA,OAAO,IAAMC,kBAAkB,gBAAGL,aAAa,CAE7C,IAAI,CAAC;;AAEP;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASM,cAAcA,CAC5BC,MAA0B,EACO;EACjC,IAAM,CAACC,GAAG,EAAEC,MAAM,CAAC,GAAGN,QAAQ,CAAgB,IAAI,CAAC;EACnD,IAAM,CAACO,KAAK,EAAEC,QAAQ,CAAC,GAAGR,QAAQ,CAAiB,IAAI,CAAC;EACxD,IAAMS,WAAW,GAAGX,UAAU,CAACI,kBAAkB,CAAC;EAClD,IAAMQ,UAAU,GAAGZ,UAAU,CAACG,UAAU,CAAC;EAEzCF,SAAS,CAAC,MAAM;IACd,IAAIU,WAAW,IAAI,IAAI,EAAE;MACvB,IAAIC,UAAU,IAAI,IAAI,EAAE;QACtBJ,MAAM,CAACI,UAAU,CAAC;QAClBF,QAAQ,CAAC,IAAI,CAAC;QACd;MACF;MACAF,MAAM,CAAC,IAAI,CAAC;MACZE,QAAQ,CACN,IAAIG,KAAK,CACP,sGACF,CACF,CAAC;MACD;IACF;IACA,IAAIC,WAAW,GAAG,KAAK;IAAC,SAETC,OAAOA,CAAA;MAAA,OAAAC,QAAA,CAAAC,KAAA,OAAAC,SAAA;IAAA;IAAA,SAAAF,SAAA;MAAAA,QAAA,GAAAG,iBAAA,CAAtB,aAAyB;QACvB,IAAI,OAAOR,WAAW,KAAK,UAAU,EAAE;UACrC,IAAI;YACF,IAAMS,MAAM,SAAST,WAAW,CAACL,MAAM,CAAC;YACxC,IAAI,CAACQ,WAAW,EAAE;cAChBN,MAAM,CAACY,MAAM,CAAC;cACdV,QAAQ,CAAC,IAAI,CAAC;YAChB;UACF,CAAC,CAAC,OAAOW,CAAC,EAAE;YACV,IAAI,CAACP,WAAW,EAAE;cAChBN,MAAM,CAAC,IAAI,CAAC;cACZE,QAAQ,CAACW,CAAC,CAAC;YACb;UACF;QACF,CAAC,MAAM;UACLb,MAAM,CAACG,WAAW,CAAC;QACrB;MACF,CAAC;MAAA,OAAAK,QAAA,CAAAC,KAAA,OAAAC,SAAA;IAAA;IAEDH,OAAO,CAAC,CAAC;IAET,OAAO,MAAM;MACXD,WAAW,GAAG,IAAI;IACpB,CAAC;EACH,CAAC,EAAE,CAACF,UAAU,EAAED,WAAW,EAAEL,MAAM,CAAC,CAAC;EAErC,OAAO,CAACC,GAAG,EAAEE,KAAK,CAAC;AACrB;AAEA,eAAeJ,cAAc"}

package/dist/useObjectFetcher.d.ts

@@ -0,0 +1,49 @@
+/// <reference types="react" />
+import { VariableDescriptor, VariableDefinition } from '@deephaven/jsapi-types';
+/**
+ * Descriptor for a variable by name. Used when needed to fetch an object.
+ */
+export type NameVariableDescriptor = {
+    /** Type of the variable */
+    type: string;
+    /** Name of the variable */
+    name: string;
+};
+/**
+ * Descriptor for a variable by id. Used when needed to fetch an object.
+ */
+export type IdVariableDescriptor = {
+    /** Type of the variable */
+    type: string;
+    /** Id of the variable */
+    id: string;
+};
+export declare function isNameVariableDescriptor(value: unknown): value is NameVariableDescriptor;
+export declare function isIdVariableDescriptor(value: unknown): value is IdVariableDescriptor;
+export declare function isVariableDescriptor(value: unknown): value is VariableDescriptor;
+/**
+ * Function to fetch an object based on a provided descriptor object.
+ * @param descriptor Descriptor object to fetch the object from. Can be extended by a specific implementation to
+ *                    include additional fields (such as a session ID) to uniquely identify an object.
+ */
+export type ObjectFetcher = <T = unknown>(descriptor: VariableDescriptor) => Promise<T>;
+export declare const ObjectFetcherContext: import("react").Context<ObjectFetcher | null>;
+/**
+ * Gets a descriptor that only has the ID or name set, but not both.
+ * API will throw an error if both are set when fetching from the connection.
+ * @param descriptor Variable descriptor to sanitize
+ * @returns Descriptor object that has either the ID or name set, but not both.
+ */
+export declare function sanitizeVariableDescriptor(descriptor: Partial<VariableDescriptor>): NameVariableDescriptor | IdVariableDescriptor;
+/**
+ * Get the variable descriptor for a definition.
+ * @param definition Definition to get the variable descriptor from
+ * @returns Serializable VariableDescriptor object
+ */
+export declare function getVariableDescriptor(definition: VariableDefinition): VariableDescriptor;
+/**
+ * Use a function to fetch an object based on provided metadata
+ * @returns Function to asynchronously fetch an object based on provided metadata
+ */
+export declare function useObjectFetcher(): ObjectFetcher;
+//# sourceMappingURL=useObjectFetcher.d.ts.map

package/dist/useObjectFetcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useObjectFetcher.d.ts","sourceRoot":"","sources":["../src/useObjectFetcher.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAIhF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB;IACzB,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,wBAAgB,wBAAwB,CACtC,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,sBAAsB,CAOjC;AAED,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,oBAAoB,CAO/B;AAED,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,kBAAkB,CAE7B;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,GAAG,OAAO,EACtC,UAAU,EAAE,kBAAkB,KAC3B,OAAO,CAAC,CAAC,CAAC,CAAC;AAEhB,eAAO,MAAM,oBAAoB,+CAA4C,CAAC;AAE9E;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,OAAO,CAAC,kBAAkB,CAAC,GACtC,sBAAsB,GAAG,oBAAoB,CAe/C;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,kBAAkB,GAC7B,kBAAkB,CAMpB;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,aAAa,CAKhD"}

package/dist/useObjectFetcher.js

@@ -0,0 +1,75 @@
+import { useContextOrThrow } from '@deephaven/react-hooks';
+import { createContext } from 'react';
+
+/**
+ * Descriptor for a variable by name. Used when needed to fetch an object.
+ */
+
+/**
+ * Descriptor for a variable by id. Used when needed to fetch an object.
+ */
+
+export function isNameVariableDescriptor(value) {
+  return typeof value === 'object' && value != null && typeof value.type === 'string' && value.name != null;
+}
+export function isIdVariableDescriptor(value) {
+  return typeof value === 'object' && value != null && typeof value.type === 'string' && value.id != null;
+}
+export function isVariableDescriptor(value) {
+  return isNameVariableDescriptor(value) || isIdVariableDescriptor(value);
+}
+
+/**
+ * Function to fetch an object based on a provided descriptor object.
+ * @param descriptor Descriptor object to fetch the object from. Can be extended by a specific implementation to
+ *                    include additional fields (such as a session ID) to uniquely identify an object.
+ */
+
+export var ObjectFetcherContext = /*#__PURE__*/createContext(null);
+
+/**
+ * Gets a descriptor that only has the ID or name set, but not both.
+ * API will throw an error if both are set when fetching from the connection.
+ * @param descriptor Variable descriptor to sanitize
+ * @returns Descriptor object that has either the ID or name set, but not both.
+ */
+export function sanitizeVariableDescriptor(descriptor) {
+  // Can't use a spread operator because of how the GWT compiled code defines properties on the object: https://github.com/gwtproject/gwt/issues/9913
+  if (isIdVariableDescriptor(descriptor)) {
+    return {
+      id: descriptor.id,
+      type: descriptor.type
+    };
+  }
+  if (isNameVariableDescriptor(descriptor)) {
+    var _descriptor$name;
+    return {
+      name: (_descriptor$name = descriptor.name) !== null && _descriptor$name !== void 0 ? _descriptor$name : '',
+      type: descriptor.type
+    };
+  }
+  throw new Error("Invalid descriptor: ".concat(descriptor));
+}
+
+/**
+ * Get the variable descriptor for a definition.
+ * @param definition Definition to get the variable descriptor from
+ * @returns Serializable VariableDescriptor object
+ */
+export function getVariableDescriptor(definition) {
+  var _definition$type, _definition$title;
+  return {
+    type: (_definition$type = definition.type) !== null && _definition$type !== void 0 ? _definition$type : '',
+    name: (_definition$title = definition.title) !== null && _definition$title !== void 0 ? _definition$title : definition.name,
+    id: definition.id
+  };
+}
+
+/**
+ * Use a function to fetch an object based on provided metadata
+ * @returns Function to asynchronously fetch an object based on provided metadata
+ */
+export function useObjectFetcher() {
+  return useContextOrThrow(ObjectFetcherContext, 'No ObjectFetcher available in useObjectFetcher. Was code wrapped in ObjectFetcherContext.Provider?');
+}
+//# sourceMappingURL=useObjectFetcher.js.map

package/dist/useObjectFetcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useObjectFetcher.js","names":["useContextOrThrow","createContext","isNameVariableDescriptor","value","type","name","isIdVariableDescriptor","id","isVariableDescriptor","ObjectFetcherContext","sanitizeVariableDescriptor","descriptor","_descriptor$name","Error","concat","getVariableDescriptor","definition","_definition$type","_definition$title","title","useObjectFetcher"],"sources":["../src/useObjectFetcher.ts"],"sourcesContent":["import { VariableDescriptor, VariableDefinition } from '@deephaven/jsapi-types';\nimport { useContextOrThrow } from '@deephaven/react-hooks';\nimport { createContext } from 'react';\n\n/**\n * Descriptor for a variable by name. Used when needed to fetch an object.\n */\nexport type NameVariableDescriptor = {\n  /** Type of the variable */\n  type: string;\n  /** Name of the variable */\n  name: string;\n};\n\n/**\n * Descriptor for a variable by id. Used when needed to fetch an object.\n */\nexport type IdVariableDescriptor = {\n  /** Type of the variable */\n  type: string;\n  /** Id of the variable */\n  id: string;\n};\n\nexport function isNameVariableDescriptor(\n  value: unknown\n): value is NameVariableDescriptor {\n  return (\n    typeof value === 'object' &&\n    value != null &&\n    typeof (value as NameVariableDescriptor).type === 'string' &&\n    (value as NameVariableDescriptor).name != null\n  );\n}\n\nexport function isIdVariableDescriptor(\n  value: unknown\n): value is IdVariableDescriptor {\n  return (\n    typeof value === 'object' &&\n    value != null &&\n    typeof (value as IdVariableDescriptor).type === 'string' &&\n    (value as IdVariableDescriptor).id != null\n  );\n}\n\nexport function isVariableDescriptor(\n  value: unknown\n): value is VariableDescriptor {\n  return isNameVariableDescriptor(value) || isIdVariableDescriptor(value);\n}\n\n/**\n * Function to fetch an object based on a provided descriptor object.\n * @param descriptor Descriptor object to fetch the object from. Can be extended by a specific implementation to\n *                    include additional fields (such as a session ID) to uniquely identify an object.\n */\nexport type ObjectFetcher = <T = unknown>(\n  descriptor: VariableDescriptor\n) => Promise<T>;\n\nexport const ObjectFetcherContext = createContext<ObjectFetcher | null>(null);\n\n/**\n * Gets a descriptor that only has the ID or name set, but not both.\n * API will throw an error if both are set when fetching from the connection.\n * @param descriptor Variable descriptor to sanitize\n * @returns Descriptor object that has either the ID or name set, but not both.\n */\nexport function sanitizeVariableDescriptor(\n  descriptor: Partial<VariableDescriptor>\n): NameVariableDescriptor | IdVariableDescriptor {\n  // Can't use a spread operator because of how the GWT compiled code defines properties on the object: https://github.com/gwtproject/gwt/issues/9913\n  if (isIdVariableDescriptor(descriptor)) {\n    return {\n      id: descriptor.id,\n      type: descriptor.type,\n    };\n  }\n  if (isNameVariableDescriptor(descriptor)) {\n    return {\n      name: descriptor.name ?? '',\n      type: descriptor.type,\n    };\n  }\n  throw new Error(`Invalid descriptor: ${descriptor}`);\n}\n\n/**\n * Get the variable descriptor for a definition.\n * @param definition Definition to get the variable descriptor from\n * @returns Serializable VariableDescriptor object\n */\nexport function getVariableDescriptor(\n  definition: VariableDefinition\n): VariableDescriptor {\n  return {\n    type: definition.type ?? '',\n    name: definition.title ?? definition.name,\n    id: definition.id,\n  };\n}\n\n/**\n * Use a function to fetch an object based on provided metadata\n * @returns Function to asynchronously fetch an object based on provided metadata\n */\nexport function useObjectFetcher(): ObjectFetcher {\n  return useContextOrThrow(\n    ObjectFetcherContext,\n    'No ObjectFetcher available in useObjectFetcher. Was code wrapped in ObjectFetcherContext.Provider?'\n  );\n}\n"],"mappings":"AACA,SAASA,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,aAAa,QAAQ,OAAO;;AAErC;AACA;AACA;;AAQA;AACA;AACA;;AAQA,OAAO,SAASC,wBAAwBA,CACtCC,KAAc,EACmB;EACjC,OACE,OAAOA,KAAK,KAAK,QAAQ,IACzBA,KAAK,IAAI,IAAI,IACb,OAAQA,KAAK,CAA4BC,IAAI,KAAK,QAAQ,IACzDD,KAAK,CAA4BE,IAAI,IAAI,IAAI;AAElD;AAEA,OAAO,SAASC,sBAAsBA,CACpCH,KAAc,EACiB;EAC/B,OACE,OAAOA,KAAK,KAAK,QAAQ,IACzBA,KAAK,IAAI,IAAI,IACb,OAAQA,KAAK,CAA0BC,IAAI,KAAK,QAAQ,IACvDD,KAAK,CAA0BI,EAAE,IAAI,IAAI;AAE9C;AAEA,OAAO,SAASC,oBAAoBA,CAClCL,KAAc,EACe;EAC7B,OAAOD,wBAAwB,CAACC,KAAK,CAAC,IAAIG,sBAAsB,CAACH,KAAK,CAAC;AACzE;;AAEA;AACA;AACA;AACA;AACA;;AAKA,OAAO,IAAMM,oBAAoB,gBAAGR,aAAa,CAAuB,IAAI,CAAC;;AAE7E;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASS,0BAA0BA,CACxCC,UAAuC,EACQ;EAC/C;EACA,IAAIL,sBAAsB,CAACK,UAAU,CAAC,EAAE;IACtC,OAAO;MACLJ,EAAE,EAAEI,UAAU,CAACJ,EAAE;MACjBH,IAAI,EAAEO,UAAU,CAACP;IACnB,CAAC;EACH;EACA,IAAIF,wBAAwB,CAACS,UAAU,CAAC,EAAE;IAAA,IAAAC,gBAAA;IACxC,OAAO;MACLP,IAAI,GAAAO,gBAAA,GAAED,UAAU,CAACN,IAAI,cAAAO,gBAAA,cAAAA,gBAAA,GAAI,EAAE;MAC3BR,IAAI,EAAEO,UAAU,CAACP;IACnB,CAAC;EACH;EACA,MAAM,IAAIS,KAAK,wBAAAC,MAAA,CAAwBH,UAAU,CAAE,CAAC;AACtD;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,qBAAqBA,CACnCC,UAA8B,EACV;EAAA,IAAAC,gBAAA,EAAAC,iBAAA;EACpB,OAAO;IACLd,IAAI,GAAAa,gBAAA,GAAED,UAAU,CAACZ,IAAI,cAAAa,gBAAA,cAAAA,gBAAA,GAAI,EAAE;IAC3BZ,IAAI,GAAAa,iBAAA,GAAEF,UAAU,CAACG,KAAK,cAAAD,iBAAA,cAAAA,iBAAA,GAAIF,UAAU,CAACX,IAAI;IACzCE,EAAE,EAAES,UAAU,CAACT;EACjB,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASa,gBAAgBA,CAAA,EAAkB;EAChD,OAAOpB,iBAAiB,CACtBS,oBAAoB,EACpB,oGACF,CAAC;AACH"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven/jsapi-bootstrap",
-  "version": "0.61.1",
+  "version": "0.61.2-beta.0+2cd46ce2",
   "description": "Deephaven JSAPI Bootstrap",
   "author": "Deephaven Data Labs LLC",
   "license": "Apache-2.0",
@@ -22,10 +22,10 @@
     "build:sass": "sass --embed-sources --load-path=../../node_modules ./src:./dist"
   },
   "dependencies": {
-    "@deephaven/components": "^0.61.1",
-    "@deephaven/jsapi-types": "^0.61.0",
-    "@deephaven/log": "^0.61.0",
-    "@deephaven/react-hooks": "^0.61.0"
+    "@deephaven/components": "^0.61.2-beta.0+2cd46ce2",
+    "@deephaven/jsapi-types": "^0.61.2-beta.0+2cd46ce2",
+    "@deephaven/log": "^0.61.2-beta.0+2cd46ce2",
+    "@deephaven/react-hooks": "^0.61.2-beta.0+2cd46ce2"
   },
   "devDependencies": {
     "react": "^17.x"
@@ -40,5 +40,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9f1bff354f2f8ba76c35c4fed15c8dbb1805197c"
+  "gitHead": "2cd46ce2d5107553d3f91933294638a5fb183245"
 }