@deephaven/jsapi-bootstrap 0.50.1-beta.5 → 0.51.1-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/ApiBootstrap.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiBootstrap.js","names":["createContext","useEffect","useState","LoadingOverlay","Modal","ModalBody","ModalHeader","Log","log","module","ApiContext","ApiBootstrap","apiUrl","children","failureElement","setGlobally","isLoading","setIsLoading","api","setApi","loadApi","dh","default","info","debug","globalThis","e","error"],"sources":["../src/ApiBootstrap.tsx"],"sourcesContent":["import { createContext, ReactNode, useEffect, useState } from 'react';\nimport {\n LoadingOverlay,\n Modal,\n ModalBody,\n ModalHeader,\n} from '@deephaven/components';\nimport type { dh as DhType } from '@deephaven/jsapi-types';\nimport Log from '@deephaven/log';\n\nconst log = Log.module('@deephaven/jsapi-bootstrap.ApiBootstrap');\n\nexport const ApiContext = createContext<DhType | null>(null);\n\nexport type ApiBootstrapProps = {\n /** URL of the API to load */\n apiUrl: string;\n\n /** Children to render when the API has loaded */\n children: ReactNode;\n\n /** Element to display if there is a failure loading the API */\n failureElement?: JSX.Element;\n\n /** Whether to set the API globally on window.dh when it has loaded */\n setGlobally?: boolean;\n};\n\n/**\n * ApiBootstrap loads the API from the provided URL, rendering the children once loaded.\n */\nexport function ApiBootstrap({\n apiUrl,\n children,\n failureElement,\n setGlobally = false,\n}: ApiBootstrapProps): JSX.Element {\n const [isLoading, setIsLoading] = useState(true);\n const [api, setApi] = useState<DhType>();\n useEffect(() => {\n async function loadApi(): Promise<void> {\n try {\n const dh: DhType =\n // Ignore the warning about dynamic import in both Vite and Webpack.\n // We use Vite, but some clients may use Webpack.\n (await import(/* @vite-ignore */ /* webpackIgnore: true */ apiUrl))\n .default;\n log.info('API bootstrapped from', apiUrl);\n setApi(dh);\n if (setGlobally) {\n log.debug('API set globally');\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n (globalThis as any).dh = dh;\n }\n } catch (e) {\n log.error('Unable to bootstrap API', e);\n }\n setIsLoading(false);\n }\n loadApi();\n }, [apiUrl, setGlobally]);\n\n if (isLoading) {\n return <LoadingOverlay />;\n }\n if (api == null) {\n return (\n failureElement ?? (\n <Modal isOpen className=\"modal-dialog-centered theme-bg-light\">\n <ModalHeader closeButton={false}>\n Error: Unable to load API\n </ModalHeader>\n <ModalBody>\n <p className=\"text-break\">\n Ensure the server is running and you are able to reach {apiUrl},\n then refresh the page.\n </p>\n </ModalBody>\n </Modal>\n )\n );\n }\n return <ApiContext.Provider value={api}>{children}</ApiContext.Provider>;\n}\n\nexport default ApiBootstrap;\n"],"mappings":";;AAAA,SAASA,aAAa,EAAaC,SAAS,EAAEC,QAAQ,QAAQ,OAAO;AACrE,SACEC,cAAc,EACdC,KAAK,EACLC,SAAS,EACTC,WAAW,QACN,uBAAuB;AAE9B,OAAOC,GAAG,MAAM,gBAAgB;AAAC;AAAA;AAEjC,IAAMC,GAAG,
|
|
1
|
+
{"version":3,"file":"ApiBootstrap.js","names":["createContext","useEffect","useState","LoadingOverlay","Modal","ModalBody","ModalHeader","Log","jsx","_jsx","jsxs","_jsxs","log","module","ApiContext","ApiBootstrap","_ref","apiUrl","children","failureElement","setGlobally","isLoading","setIsLoading","api","setApi","loadApi","_loadApi","apply","arguments","_asyncToGenerator","dh","default","info","debug","globalThis","e","error","isOpen","className","closeButton","Provider","value"],"sources":["../src/ApiBootstrap.tsx"],"sourcesContent":["import { createContext, ReactNode, useEffect, useState } from 'react';\nimport {\n LoadingOverlay,\n Modal,\n ModalBody,\n ModalHeader,\n} from '@deephaven/components';\nimport type { dh as DhType } from '@deephaven/jsapi-types';\nimport Log from '@deephaven/log';\n\nconst log = Log.module('@deephaven/jsapi-bootstrap.ApiBootstrap');\n\nexport const ApiContext = createContext<DhType | null>(null);\n\nexport type ApiBootstrapProps = {\n /** URL of the API to load */\n apiUrl: string;\n\n /** Children to render when the API has loaded */\n children: ReactNode;\n\n /** Element to display if there is a failure loading the API */\n failureElement?: JSX.Element;\n\n /** Whether to set the API globally on window.dh when it has loaded */\n setGlobally?: boolean;\n};\n\n/**\n * ApiBootstrap loads the API from the provided URL, rendering the children once loaded.\n */\nexport function ApiBootstrap({\n apiUrl,\n children,\n failureElement,\n setGlobally = false,\n}: ApiBootstrapProps): JSX.Element {\n const [isLoading, setIsLoading] = useState(true);\n const [api, setApi] = useState<DhType>();\n useEffect(() => {\n async function loadApi(): Promise<void> {\n try {\n const dh: DhType =\n // Ignore the warning about dynamic import in both Vite and Webpack.\n // We use Vite, but some clients may use Webpack.\n (await import(/* @vite-ignore */ /* webpackIgnore: true */ apiUrl))\n .default;\n log.info('API bootstrapped from', apiUrl);\n setApi(dh);\n if (setGlobally) {\n log.debug('API set globally');\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n (globalThis as any).dh = dh;\n }\n } catch (e) {\n log.error('Unable to bootstrap API', e);\n }\n setIsLoading(false);\n }\n loadApi();\n }, [apiUrl, setGlobally]);\n\n if (isLoading) {\n return <LoadingOverlay />;\n }\n if (api == null) {\n return (\n failureElement ?? (\n <Modal isOpen className=\"modal-dialog-centered theme-bg-light\">\n <ModalHeader closeButton={false}>\n Error: Unable to load API\n </ModalHeader>\n <ModalBody>\n <p className=\"text-break\">\n Ensure the server is running and you are able to reach {apiUrl},\n then refresh the page.\n </p>\n </ModalBody>\n </Modal>\n )\n );\n }\n return <ApiContext.Provider value={api}>{children}</ApiContext.Provider>;\n}\n\nexport default ApiBootstrap;\n"],"mappings":";;AAAA,SAASA,aAAa,EAAaC,SAAS,EAAEC,QAAQ,QAAQ,OAAO;AACrE,SACEC,cAAc,EACdC,KAAK,EACLC,SAAS,EACTC,WAAW,QACN,uBAAuB;AAE9B,OAAOC,GAAG,MAAM,gBAAgB;AAAC,SAAAC,GAAA,IAAAC,IAAA;AAAA,SAAAC,IAAA,IAAAC,KAAA;AAEjC,IAAMC,GAAG,GAAGL,GAAG,CAACM,MAAM,CAAC,yCAAyC,CAAC;AAEjE,OAAO,IAAMC,UAAU,gBAAGd,aAAa,CAAgB,IAAI,CAAC;AAgB5D;AACA;AACA;AACA,OAAO,SAASe,YAAYA,CAAAC,IAAA,EAKO;EAAA,IALN;IAC3BC,MAAM;IACNC,QAAQ;IACRC,cAAc;IACdC,WAAW,GAAG;EACG,CAAC,GAAAJ,IAAA;EAClB,IAAM,CAACK,SAAS,EAAEC,YAAY,CAAC,GAAGpB,QAAQ,CAAC,IAAI,CAAC;EAChD,IAAM,CAACqB,GAAG,EAAEC,MAAM,CAAC,GAAGtB,QAAQ,CAAS,CAAC;EACxCD,SAAS,CAAC,MAAM;IAAA,SACCwB,OAAOA,CAAA;MAAA,OAAAC,QAAA,CAAAC,KAAA,OAAAC,SAAA;IAAA;IAAA,SAAAF,SAAA;MAAAA,QAAA,GAAAG,iBAAA,CAAtB,aAAwC;QACtC,IAAI;UACF,IAAMC,EAAU;UACd;UACA;UACA,OAAO,MAAM,EAAC,mBAAmB,yBAA0Bb,MAAM,CAAC,EAC/Dc,OAAO;UACZnB,GAAG,CAACoB,IAAI,CAAC,uBAAuB,EAAEf,MAAM,CAAC;UACzCO,MAAM,CAACM,EAAE,CAAC;UACV,IAAIV,WAAW,EAAE;YACfR,GAAG,CAACqB,KAAK,CAAC,kBAAkB,CAAC;YAC7B;YACCC,UAAU,CAASJ,EAAE,GAAGA,EAAE;UAC7B;QACF,CAAC,CAAC,OAAOK,CAAC,EAAE;UACVvB,GAAG,CAACwB,KAAK,CAAC,yBAAyB,EAAED,CAAC,CAAC;QACzC;QACAb,YAAY,CAAC,KAAK,CAAC;MACrB,CAAC;MAAA,OAAAI,QAAA,CAAAC,KAAA,OAAAC,SAAA;IAAA;IACDH,OAAO,CAAC,CAAC;EACX,CAAC,EAAE,CAACR,MAAM,EAAEG,WAAW,CAAC,CAAC;EAEzB,IAAIC,SAAS,EAAE;IACb,oBAAOZ,IAAA,CAACN,cAAc,IAAE,CAAC;EAC3B;EACA,IAAIoB,GAAG,IAAI,IAAI,EAAE;IACf,OACEJ,cAAc,aAAdA,cAAc,cAAdA,cAAc,gBACZR,KAAA,CAACP,KAAK;MAACiC,MAAM;MAACC,SAAS,EAAC,sCAAsC;MAAApB,QAAA,gBAC5DT,IAAA,CAACH,WAAW;QAACiC,WAAW,EAAE,KAAM;QAAArB,QAAA,EAAC;MAEjC,CAAa,CAAC,eACdT,IAAA,CAACJ,SAAS;QAAAa,QAAA,eACRP,KAAA;UAAG2B,SAAS,EAAC,YAAY;UAAApB,QAAA,GAAC,yDAC+B,EAACD,MAAM,EAAC,0BAEjE;QAAA,CAAG;MAAC,CACK,CAAC;IAAA,CACP,CAAC;EAGd;EACA,oBAAOR,IAAA,CAACK,UAAU,CAAC0B,QAAQ;IAACC,KAAK,EAAElB,GAAI;IAAAL,QAAA,EAAEA;EAAQ,CAAsB,CAAC;AAC1E;AAEA,eAAeH,YAAY"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ClientBootstrap.js","names":["React","createContext","useCreateClient","ClientContext","ClientBootstrap","serverUrl","options","children","client"],"sources":["../src/ClientBootstrap.tsx"],"sourcesContent":["import React, { createContext } from 'react';\nimport type { ConnectOptions, CoreClient } from '@deephaven/jsapi-types';\nimport useCreateClient from './useCreateClient';\n\nexport const ClientContext = createContext<CoreClient | null>(null);\n\nexport type ClientBootstrapProps = {\n /** URL of the server to connect to */\n serverUrl: string;\n\n /** Connection options to pass to CoreClient when connecting */\n options?: ConnectOptions;\n\n /**\n * The children to render wrapped with the ClientContext.\n * Will not render children until the client is created.\n */\n children: React.ReactNode;\n};\n\n/**\n * ClientBootstrap component. Handles creating the client.\n */\nexport function ClientBootstrap({\n serverUrl,\n options,\n children,\n}: ClientBootstrapProps): JSX.Element {\n const client = useCreateClient(serverUrl, options);\n return (\n <ClientContext.Provider value={client}>{children}</ClientContext.Provider>\n );\n}\n\nexport default ClientBootstrap;\n"],"mappings":"AAAA,OAAOA,KAAK,IAAIC,aAAa,QAAQ,OAAO;AAAC,OAEtCC,eAAe;AAAA;AAEtB,OAAO,IAAMC,aAAa,
|
|
1
|
+
{"version":3,"file":"ClientBootstrap.js","names":["React","createContext","useCreateClient","jsx","_jsx","ClientContext","ClientBootstrap","_ref","serverUrl","options","children","client","Provider","value"],"sources":["../src/ClientBootstrap.tsx"],"sourcesContent":["import React, { createContext } from 'react';\nimport type { ConnectOptions, CoreClient } from '@deephaven/jsapi-types';\nimport useCreateClient from './useCreateClient';\n\nexport const ClientContext = createContext<CoreClient | null>(null);\n\nexport type ClientBootstrapProps = {\n /** URL of the server to connect to */\n serverUrl: string;\n\n /** Connection options to pass to CoreClient when connecting */\n options?: ConnectOptions;\n\n /**\n * The children to render wrapped with the ClientContext.\n * Will not render children until the client is created.\n */\n children: React.ReactNode;\n};\n\n/**\n * ClientBootstrap component. Handles creating the client.\n */\nexport function ClientBootstrap({\n serverUrl,\n options,\n children,\n}: ClientBootstrapProps): JSX.Element {\n const client = useCreateClient(serverUrl, options);\n return (\n <ClientContext.Provider value={client}>{children}</ClientContext.Provider>\n );\n}\n\nexport default ClientBootstrap;\n"],"mappings":"AAAA,OAAOA,KAAK,IAAIC,aAAa,QAAQ,OAAO;AAAC,OAEtCC,eAAe;AAAA,SAAAC,GAAA,IAAAC,IAAA;AAEtB,OAAO,IAAMC,aAAa,gBAAGJ,aAAa,CAAoB,IAAI,CAAC;AAgBnE;AACA;AACA;AACA,OAAO,SAASK,eAAeA,CAAAC,IAAA,EAIO;EAAA,IAJN;IAC9BC,SAAS;IACTC,OAAO;IACPC;EACoB,CAAC,GAAAH,IAAA;EACrB,IAAMI,MAAM,GAAGT,eAAe,CAACM,SAAS,EAAEC,OAAO,CAAC;EAClD,oBACEL,IAAA,CAACC,aAAa,CAACO,QAAQ;IAACC,KAAK,EAAEF,MAAO;IAAAD,QAAA,EAAEA;EAAQ,CAAyB,CAAC;AAE9E;AAEA,eAAeJ,eAAe"}
|
package/dist/useApi.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useApi.js","names":["useContextOrThrow","ApiContext","useApi"],"sources":["../src/useApi.ts"],"sourcesContent":["import type { dh as DhType } from '@deephaven/jsapi-types';\nimport { useContextOrThrow } from '@deephaven/react-hooks';\nimport { ApiContext } from './ApiBootstrap';\n\nexport function useApi(): DhType {\n return useContextOrThrow(\n ApiContext,\n 'No API available in useApi. Was code wrapped in ApiBootstrap or ApiContext.Provider?'\n );\n}\n\nexport default useApi;\n"],"mappings":"AACA,SAASA,iBAAiB,QAAQ,wBAAwB;AAAC,SAClDC,UAAU;AAEnB,OAAO,SAASC,
|
|
1
|
+
{"version":3,"file":"useApi.js","names":["useContextOrThrow","ApiContext","useApi"],"sources":["../src/useApi.ts"],"sourcesContent":["import type { dh as DhType } from '@deephaven/jsapi-types';\nimport { useContextOrThrow } from '@deephaven/react-hooks';\nimport { ApiContext } from './ApiBootstrap';\n\nexport function useApi(): DhType {\n return useContextOrThrow(\n ApiContext,\n 'No API available in useApi. Was code wrapped in ApiBootstrap or ApiContext.Provider?'\n );\n}\n\nexport default useApi;\n"],"mappings":"AACA,SAASA,iBAAiB,QAAQ,wBAAwB;AAAC,SAClDC,UAAU;AAEnB,OAAO,SAASC,MAAMA,CAAA,EAAW;EAC/B,OAAOF,iBAAiB,CACtBC,UAAU,EACV,sFACF,CAAC;AACH;AAEA,eAAeC,MAAM"}
|
package/dist/useClient.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useClient.js","names":["useContextOrThrow","ClientContext","useClient"],"sources":["../src/useClient.ts"],"sourcesContent":["import type { CoreClient } from '@deephaven/jsapi-types';\nimport { useContextOrThrow } from '@deephaven/react-hooks';\nimport { ClientContext } from './ClientBootstrap';\n\nexport function useClient(): CoreClient {\n return useContextOrThrow(\n ClientContext,\n 'No Client available in useClient. Was code wrapped in ClientBootstrap or ClientContext.Provider?'\n );\n}\n\nexport default useClient;\n"],"mappings":"AACA,SAASA,iBAAiB,QAAQ,wBAAwB;AAAC,SAClDC,aAAa;AAEtB,OAAO,SAASC,
|
|
1
|
+
{"version":3,"file":"useClient.js","names":["useContextOrThrow","ClientContext","useClient"],"sources":["../src/useClient.ts"],"sourcesContent":["import type { CoreClient } from '@deephaven/jsapi-types';\nimport { useContextOrThrow } from '@deephaven/react-hooks';\nimport { ClientContext } from './ClientBootstrap';\n\nexport function useClient(): CoreClient {\n return useContextOrThrow(\n ClientContext,\n 'No Client available in useClient. Was code wrapped in ClientBootstrap or ClientContext.Provider?'\n );\n}\n\nexport default useClient;\n"],"mappings":"AACA,SAASA,iBAAiB,QAAQ,wBAAwB;AAAC,SAClDC,aAAa;AAEtB,OAAO,SAASC,SAASA,CAAA,EAAe;EACtC,OAAOF,iBAAiB,CACtBC,aAAa,EACb,kGACF,CAAC;AACH;AAEA,eAAeC,SAAS"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useCreateClient.js","names":["useEffect","useMemo","useApi","useCreateClient","serverUrl","options","api","client","CoreClient","disconnect"],"sources":["../src/useCreateClient.ts"],"sourcesContent":["import type { ConnectOptions, CoreClient } from '@deephaven/jsapi-types';\nimport { useEffect, useMemo } from 'react';\nimport useApi from './useApi';\n\nexport function useCreateClient(\n serverUrl: string,\n options?: ConnectOptions\n): CoreClient {\n const api = useApi();\n const client = useMemo(\n () => new api.CoreClient(serverUrl, options),\n [api, serverUrl, options]\n );\n useEffect(\n () => () => {\n client.disconnect();\n },\n [client]\n );\n return client;\n}\n\nexport default useCreateClient;\n"],"mappings":"AACA,SAASA,SAAS,EAAEC,OAAO,QAAQ,OAAO;AAAC,OACpCC,MAAM;AAEb,OAAO,SAASC,
|
|
1
|
+
{"version":3,"file":"useCreateClient.js","names":["useEffect","useMemo","useApi","useCreateClient","serverUrl","options","api","client","CoreClient","disconnect"],"sources":["../src/useCreateClient.ts"],"sourcesContent":["import type { ConnectOptions, CoreClient } from '@deephaven/jsapi-types';\nimport { useEffect, useMemo } from 'react';\nimport useApi from './useApi';\n\nexport function useCreateClient(\n serverUrl: string,\n options?: ConnectOptions\n): CoreClient {\n const api = useApi();\n const client = useMemo(\n () => new api.CoreClient(serverUrl, options),\n [api, serverUrl, options]\n );\n useEffect(\n () => () => {\n client.disconnect();\n },\n [client]\n );\n return client;\n}\n\nexport default useCreateClient;\n"],"mappings":"AACA,SAASA,SAAS,EAAEC,OAAO,QAAQ,OAAO;AAAC,OACpCC,MAAM;AAEb,OAAO,SAASC,eAAeA,CAC7BC,SAAiB,EACjBC,OAAwB,EACZ;EACZ,IAAMC,GAAG,GAAGJ,MAAM,CAAC,CAAC;EACpB,IAAMK,MAAM,GAAGN,OAAO,CACpB,MAAM,IAAIK,GAAG,CAACE,UAAU,CAACJ,SAAS,EAAEC,OAAO,CAAC,EAC5C,CAACC,GAAG,EAAEF,SAAS,EAAEC,OAAO,CAC1B,CAAC;EACDL,SAAS,CACP,MAAM,MAAM;IACVO,MAAM,CAACE,UAAU,CAAC,CAAC;EACrB,CAAC,EACD,CAACF,MAAM,CACT,CAAC;EACD,OAAOA,MAAM;AACf;AAEA,eAAeJ,eAAe"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@deephaven/jsapi-bootstrap",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.51.1-beta.0+54f7cc5d",
|
|
4
4
|
"description": "Deephaven JSAPI Bootstrap",
|
|
5
5
|
"author": "Deephaven Data Labs LLC",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -22,10 +22,10 @@
|
|
|
22
22
|
"build:sass": "sass --embed-sources --load-path=../../node_modules ./src:./dist"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@deephaven/components": "^0.
|
|
26
|
-
"@deephaven/jsapi-types": "^0.
|
|
27
|
-
"@deephaven/log": "^0.
|
|
28
|
-
"@deephaven/react-hooks": "^0.
|
|
25
|
+
"@deephaven/components": "^0.51.1-beta.0+54f7cc5d",
|
|
26
|
+
"@deephaven/jsapi-types": "^0.51.1-beta.0+54f7cc5d",
|
|
27
|
+
"@deephaven/log": "^0.51.1-beta.0+54f7cc5d",
|
|
28
|
+
"@deephaven/react-hooks": "^0.51.1-beta.0+54f7cc5d"
|
|
29
29
|
},
|
|
30
30
|
"devDependencies": {
|
|
31
31
|
"react": "^17.x"
|
|
@@ -40,5 +40,5 @@
|
|
|
40
40
|
"publishConfig": {
|
|
41
41
|
"access": "public"
|
|
42
42
|
},
|
|
43
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "54f7cc5d08a9c1a390b2e89a9fb84fe1018008eb"
|
|
44
44
|
}
|