@dxos/react-client 0.8.4-main.fffef41 → 0.9.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/.storybook/main.mts +2 -4
- package/.storybook/preview.mts +2 -2
- package/LICENSE +102 -5
- package/README.md +1 -1
- package/dist/lib/browser/chunk-3LVU7RNK.mjs +16 -0
- package/dist/lib/browser/chunk-3LVU7RNK.mjs.map +7 -0
- package/dist/lib/browser/chunk-CZMIVAGI.mjs +8 -0
- package/dist/lib/browser/chunk-CZMIVAGI.mjs.map +7 -0
- package/dist/lib/browser/chunk-XT352YI6.mjs +134 -0
- package/dist/lib/browser/chunk-XT352YI6.mjs.map +7 -0
- package/dist/lib/browser/{chunk-LO3TU5CK.mjs → chunk-YHE6WD44.mjs} +3 -13
- package/dist/lib/browser/{chunk-LO3TU5CK.mjs.map → chunk-YHE6WD44.mjs.map} +2 -2
- package/dist/lib/browser/devtools/index.mjs +3 -7
- package/dist/lib/browser/devtools/index.mjs.map +2 -2
- package/dist/lib/browser/echo/index.mjs +125 -176
- package/dist/lib/browser/echo/index.mjs.map +4 -4
- package/dist/lib/browser/halo/index.mjs +3 -2
- package/dist/lib/browser/halo/index.mjs.map +2 -2
- package/dist/lib/browser/index.mjs +99 -12
- package/dist/lib/browser/index.mjs.map +4 -4
- package/dist/lib/browser/invitations/index.mjs +1 -1
- package/dist/lib/browser/mesh/index.mjs +2 -1
- package/dist/lib/browser/mesh/index.mjs.map +1 -1
- package/dist/lib/browser/meta.json +1 -1
- package/dist/lib/browser/testing/index.mjs +75 -119
- package/dist/lib/browser/testing/index.mjs.map +3 -3
- package/dist/lib/node-esm/chunk-CUDKNAMV.mjs +17 -0
- package/dist/lib/node-esm/chunk-CUDKNAMV.mjs.map +7 -0
- package/dist/lib/node-esm/{chunk-AQJH2UNZ.mjs → chunk-RQJPEHDY.mjs} +3 -13
- package/dist/lib/node-esm/{chunk-AQJH2UNZ.mjs.map → chunk-RQJPEHDY.mjs.map} +2 -2
- package/dist/lib/node-esm/chunk-WL3Z5HOH.mjs +135 -0
- package/dist/lib/node-esm/chunk-WL3Z5HOH.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-WUTK2IJF.mjs +10 -0
- package/dist/lib/node-esm/chunk-WUTK2IJF.mjs.map +7 -0
- package/dist/lib/node-esm/devtools/index.mjs +3 -7
- package/dist/lib/node-esm/devtools/index.mjs.map +2 -2
- package/dist/lib/node-esm/echo/index.mjs +125 -176
- package/dist/lib/node-esm/echo/index.mjs.map +4 -4
- package/dist/lib/node-esm/halo/index.mjs +3 -2
- package/dist/lib/node-esm/halo/index.mjs.map +2 -2
- package/dist/lib/node-esm/index.mjs +99 -12
- package/dist/lib/node-esm/index.mjs.map +4 -4
- package/dist/lib/node-esm/invitations/index.mjs +1 -1
- package/dist/lib/node-esm/mesh/index.mjs +2 -1
- package/dist/lib/node-esm/mesh/index.mjs.map +1 -1
- package/dist/lib/node-esm/meta.json +1 -1
- package/dist/lib/node-esm/testing/index.mjs +75 -119
- package/dist/lib/node-esm/testing/index.mjs.map +3 -3
- package/dist/types/src/banner.d.ts.map +1 -1
- package/dist/types/src/client/AgentHostingProvider.d.ts.map +1 -1
- package/dist/types/src/client/ClientProvider.d.ts +1 -11
- package/dist/types/src/client/ClientProvider.d.ts.map +1 -1
- package/dist/types/src/client/useClientStatus.d.ts.map +1 -1
- package/dist/types/src/devtools/useStream.d.ts.map +1 -1
- package/dist/types/src/echo/index.d.ts +4 -3
- package/dist/types/src/echo/index.d.ts.map +1 -1
- package/dist/types/src/echo/useFeedSyncState.d.ts +13 -0
- package/dist/types/src/echo/useFeedSyncState.d.ts.map +1 -0
- package/dist/types/src/echo/useMembers.d.ts +2 -2
- package/dist/types/src/echo/useMembers.d.ts.map +1 -1
- package/dist/types/src/echo/useRegistry.d.ts +6 -0
- package/dist/types/src/echo/useRegistry.d.ts.map +1 -0
- package/dist/types/src/echo/useSpaceInvitations.d.ts +3 -2
- package/dist/types/src/echo/useSpaceInvitations.d.ts.map +1 -1
- package/dist/types/src/echo/useSpaceProperties.d.ts +13 -0
- package/dist/types/src/echo/useSpaceProperties.d.ts.map +1 -0
- package/dist/types/src/echo/useSpaces.d.ts +19 -8
- package/dist/types/src/echo/useSpaces.d.ts.map +1 -1
- package/dist/types/src/echo/useSubscription.d.ts.map +1 -1
- package/dist/types/src/echo/useSyncState.d.ts.map +1 -1
- package/dist/types/src/halo/Passkey.stories.d.ts.map +1 -1
- package/dist/types/src/halo/useHaloInvitations.d.ts.map +1 -1
- package/dist/types/src/halo/useKeyStore.d.ts.map +1 -1
- package/dist/types/src/invitations/useInvitationStatus.d.ts.map +1 -1
- package/dist/types/src/testing/ClientRepeater.d.ts +5 -4
- package/dist/types/src/testing/ClientRepeater.d.ts.map +1 -1
- package/dist/types/src/testing/ClientRepeater.stories.d.ts.map +1 -1
- package/dist/types/src/testing/context.d.ts +4 -1
- package/dist/types/src/testing/context.d.ts.map +1 -1
- package/dist/types/src/testing/util.d.ts.map +1 -1
- package/dist/types/src/testing/withClientProvider.d.ts +0 -3
- package/dist/types/src/testing/withClientProvider.d.ts.map +1 -1
- package/dist/types/src/testing/withClientProvider.stories.d.ts +2 -1
- package/dist/types/src/testing/withClientProvider.stories.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/docs/README.md +38 -38
- package/moon.yml +2 -5
- package/package.json +37 -58
- package/src/client/ClientProvider.test.tsx +0 -1
- package/src/client/ClientProvider.tsx +12 -27
- package/src/client/useConfig.test.tsx +0 -1
- package/src/echo/index.ts +4 -3
- package/src/echo/useFeedSyncState.ts +78 -0
- package/src/echo/useMembers.ts +5 -3
- package/src/echo/useRegistry.ts +15 -0
- package/src/echo/useSpaceInvitations.ts +9 -5
- package/src/echo/useSpaceProperties.ts +28 -0
- package/src/echo/useSpaces.test.tsx +7 -14
- package/src/echo/useSpaces.ts +33 -26
- package/src/echo/useSyncState.ts +3 -7
- package/src/halo/Passkey.stories.tsx +5 -8
- package/src/halo/useDevices.test.tsx +0 -1
- package/src/testing/ClientRepeater.stories.tsx +11 -9
- package/src/testing/ClientRepeater.tsx +11 -15
- package/src/testing/context.tsx +4 -2
- package/src/testing/util.tsx +0 -1
- package/src/testing/withClientProvider.stories.tsx +15 -10
- package/src/testing/withClientProvider.tsx +62 -81
- package/tsconfig.json +7 -4
- package/typedoc.json +1 -1
- package/vitest.config.ts +1 -3
- package/.swc/plugins/linux_x86_64_19.0.0/727453fb3a62f7f1d952a41e051ca8a6f88cadc45cee43c6a4d1aa45f9b75665.wasmer-v7 +0 -0
- package/dist/lib/browser/chunk-TA2HGRAF.mjs +0 -309
- package/dist/lib/browser/chunk-TA2HGRAF.mjs.map +0 -7
- package/dist/lib/node-esm/chunk-ZJMNF7GC.mjs +0 -311
- package/dist/lib/node-esm/chunk-ZJMNF7GC.mjs.map +0 -7
- package/dist/types/src/echo/useQuery.d.ts +0 -11
- package/dist/types/src/echo/useQuery.d.ts.map +0 -1
- package/dist/types/src/echo/useQuery.test.d.ts +0 -2
- package/dist/types/src/echo/useQuery.test.d.ts.map +0 -1
- package/dist/types/src/echo/useQueue.d.ts +0 -11
- package/dist/types/src/echo/useQueue.d.ts.map +0 -1
- package/dist/types/src/echo/useSchema.d.ts +0 -8
- package/dist/types/src/echo/useSchema.d.ts.map +0 -1
- package/dist/types/src/playwright/playwright.config.d.ts +0 -3
- package/dist/types/src/playwright/playwright.config.d.ts.map +0 -1
- package/dist/types/src/playwright/smoke.spec.d.ts +0 -2
- package/dist/types/src/playwright/smoke.spec.d.ts.map +0 -1
- package/src/echo/useQuery.test.tsx +0 -129
- package/src/echo/useQuery.ts +0 -64
- package/src/echo/useQueue.ts +0 -74
- package/src/echo/useSchema.ts +0 -54
- package/src/playwright/playwright.config.ts +0 -17
- package/src/playwright/smoke.spec.ts +0 -24
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 3,
|
|
3
|
-
"sources": ["../../../src/client/AgentHostingProvider.tsx", "../../../src/client/ClientProvider.tsx", "../../../src/banner.ts", "../../../src/client/context.ts", "../../../src/client/useClient.ts", "../../../src/client/useClientStatus.ts", "../../../src/client/useConfig.ts", "../../../src/client/useShell.ts", "../../../src/client/useStatus.ts"],
|
|
4
|
-
"sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport React, { type PropsWithChildren, createContext, useContext, useState } from 'react';\n\nimport { type AgentHostingProviderClient, AgentManagerClient, FakeAgentHostingProvider } from '@dxos/client';\nimport { type Halo } from '@dxos/client/halo';\nimport { type Config } from '@dxos/config';\nimport { log } from '@dxos/log';\n\nimport { useClient } from '../client';\n\nexport type AgentHostingProviderProps = { config: Config; halo: Halo };\n\nexport const AgentHostingContext = createContext<AgentHostingProviderClient | null>(null);\n\n/**\n * Experimental agent hosting provider.\n * @param props\n * @constructor\n * @deprecated\n */\nexport const AgentHostingProvider = (props: PropsWithChildren) => {\n const client = useClient();\n const [agentHostingProviderClient] = useState(makeClient(client));\n return (\n <AgentHostingContext.Provider value={agentHostingProviderClient}> {props.children}</AgentHostingContext.Provider>\n );\n};\n\nexport const useAgentHostingClient = () => {\n return useContext(AgentHostingContext);\n};\n\nconst makeClient = ({ config, halo }: AgentHostingProviderProps) => {\n const agentHostingConfig = config.get('runtime.services.agentHosting');\n if (!agentHostingConfig) {\n log('no agent hosting configured');\n return null;\n }\n\n // TODO(nf): Dynamically discover based on runtime config.\n let agentHostingProviderClient: AgentHostingProviderClient | null = null;\n switch (agentHostingConfig.type) {\n case 'LOCAL_TESTING': {\n log('using FakeAgentHostingProvider');\n return new FakeAgentHostingProvider();\n }\n\n case 'AGENTHOSTING_API': {\n agentHostingProviderClient = new AgentManagerClient(config, halo);\n if (agentHostingProviderClient.init()) {\n return agentHostingProviderClient;\n } else {\n // Not authorized or error initializing.\n return null;\n }\n }\n\n default: {\n log.error('Unknown agent hosting provider type: ' + agentHostingConfig.type);\n return null;\n }\n }\n};\n", "//\n// Copyright 2020 DXOS.org\n//\n\nimport React, {\n type FunctionComponent,\n type PropsWithChildren,\n forwardRef,\n useEffect,\n useImperativeHandle,\n useState,\n} from 'react';\n\nimport { Client, type ClientOptions, type ClientServicesProvider, SystemStatus } from '@dxos/client';\nimport { type Config } from '@dxos/config';\nimport { registerSignalsRuntime } from '@dxos/echo-signals/react';\nimport { log } from '@dxos/log';\nimport { useAsyncEffect, useControlledState } from '@dxos/react-hooks';\nimport { type MaybePromise, type Provider, getAsyncProviderValue } from '@dxos/util';\n\nimport { printBanner } from '../banner';\n\nimport { ClientContext, type ClientContextProps } from './context';\n\n/**\n * Properties for the ClientProvider.\n */\nexport type ClientProviderProps = Omit<ClientOptions, 'config' | 'services'> &\n Pick<ClientContextProps, 'status'> &\n PropsWithChildren<{\n /**\n * Client object or async provider to enable to caller to do custom initialization.\n *\n * NOTE: For advanced use cases only.\n */\n client?: Client | Provider<Promise<Client>>;\n\n /**\n * Config object or async provider.\n *\n * NOTE: If a `client` is provided then `config` is ignored.\n */\n // TODO(burdon): Reconcile with ClientOptions.\n config?: Config | Provider<Promise<Config>>;\n\n /**\n * Callback to enable the caller to create a custom ClientServicesProvider.\n *\n * NOTE: If a `client` is provided then `services` is ignored.\n */\n // TODO(burdon): Reconcile with ClientOptions.\n services?: ClientServicesProvider | ((config?: Config) => MaybePromise<ClientServicesProvider>);\n\n /**\n * ReactNode to display until the client is available.\n */\n fallback?: FunctionComponent<Partial<ClientContextProps>>;\n\n /**\n * Enable (by default) registration of Preact signals runtime for reactive ECHO objects.\n * @see https://www.npmjs.com/package/@preact/signals-react\n */\n signalsRuntime?: boolean;\n\n /**\n * Skip the DXOS banner.\n */\n noBanner?: boolean;\n\n /**\n * Post initialization hook to enable to caller to do custom initialization.\n */\n onInitialized?: (client: Client) => MaybePromise<void>;\n }>;\n\n/**\n * Root component that provides the DXOS client instance to child components.\n * To be used with the `useClient` hook.\n */\nexport const ClientProvider = forwardRef<Client | undefined, ClientProviderProps>(\n (\n {\n children,\n config: configParam,\n client: clientParam,\n services: servicesParam,\n status: statusParam,\n fallback: Fallback = () => null,\n signalsRuntime = true,\n noBanner,\n onInitialized,\n ...options\n },\n forwardedRef,\n ) => {\n useEffect(() => {\n // TODO(wittjosiah): Ideally this should be imported asynchronously because it is optional.\n // Unfortunately, async import seemed to break signals React instrumentation.\n signalsRuntime && registerSignalsRuntime();\n }, []);\n\n // The client is initialized asynchronously.\n // If an error occurs during initialization, it is caught and the state is set.\n // This allows the error to be thrown in the render method.\n // The assumption is that a client initialization error is fatal to the app.\n // This error will be caught by the nearest error boundary.\n const [error, setError] = useState();\n if (error) {\n throw error;\n }\n\n const [client, setClient] = useState(clientParam instanceof Client ? clientParam : undefined);\n\n // Provide external access.\n useImperativeHandle(forwardedRef, () => client, [client]);\n\n // Client status subscription.\n const [status, setStatus] = useControlledState(statusParam);\n useEffect(() => {\n if (!client) {\n return;\n }\n\n const subscription = client.status.subscribe((status) => setStatus(status));\n return () => subscription.unsubscribe();\n }, [client]);\n\n // Create and/or initialize client.\n useAsyncEffect(async () => {\n let disposed = false;\n const initialize = async (client: Client) => {\n if (!client.initialized) {\n await client.initialize().catch((err) => {\n if (!disposed) {\n setError(err);\n }\n });\n log('client ready');\n await onInitialized?.(client);\n log('initialization complete');\n }\n\n setClient(client);\n if (!noBanner) {\n printBanner(client);\n }\n };\n\n let client: Client;\n try {\n if (clientParam) {\n // Asynchronously request client.\n client = await getAsyncProviderValue(clientParam);\n await initialize(client);\n } else {\n // Asynchronously construct client (config may be undefined).\n const config = await getAsyncProviderValue(configParam);\n log('resolved config', { config });\n const services = await getAsyncProviderValue(servicesParam, config);\n log('created services', { services });\n client = new Client({ config, services, ...options });\n log('created client');\n await initialize(client);\n }\n } catch (err) {\n if (!disposed) {\n log.catch(err);\n }\n }\n\n return () => {\n log('clean up');\n disposed = true;\n // Only destroy if the client is not provided by the parent.\n if (!clientParam) {\n void client\n ?.destroy()\n .then(() => {\n log('destroyed');\n })\n .catch((err) => log.catch(err));\n }\n };\n }, [configParam, clientParam, servicesParam, noBanner]);\n\n if (!client?.initialized || status !== SystemStatus.ACTIVE) {\n return <Fallback client={client} status={status} />;\n }\n\n return <ClientContext.Provider value={{ client, status }}>{children}</ClientContext.Provider>;\n },\n);\n", "//\n// Copyright 2021 DXOS.org\n//\n\nimport { type Client } from '@dxos/client';\n\n// http://patorjk.com/software/taag/#p=testall&f=Patorjk-HeX&t=DXOS\nconst BANNER = (client: Client) => {\n const commitHash = client.config.get('runtime.app.build.commitHash');\n const hash = commitHash ? ` App Commit ${commitHash} \\n` : '';\n\n return (\n '\\n' +\n '_/\\\\/\\\\/\\\\/\\\\/\\\\____/\\\\/\\\\____/\\\\/\\\\____/\\\\/\\\\/\\\\/\\\\______/\\\\/\\\\/\\\\/\\\\/\\\\_\\n' +\n '_/\\\\/\\\\____/\\\\/\\\\____/\\\\/\\\\/\\\\/\\\\____/\\\\/\\\\____/\\\\/\\\\__/\\\\/\\\\_________\\n' +\n '_/\\\\/\\\\____/\\\\/\\\\______/\\\\/\\\\______/\\\\/\\\\____/\\\\/\\\\____/\\\\/\\\\/\\\\/\\\\___\\n' +\n '_/\\\\/\\\\____/\\\\/\\\\____/\\\\/\\\\/\\\\/\\\\____/\\\\/\\\\____/\\\\/\\\\__________/\\\\/\\\\_\\n' +\n '_/\\\\/\\\\/\\\\/\\\\/\\\\____/\\\\/\\\\____/\\\\/\\\\____/\\\\/\\\\/\\\\/\\\\____/\\\\/\\\\/\\\\/\\\\/\\\\___\\n' +\n `\\n DXOS Client ${client.version} \\n${hash}`\n );\n};\n\nlet bannerPrinted = false;\n\nexport const printBanner = (client: Client) => {\n if (bannerPrinted || window.location.hostname === 'localhost') {\n return;\n }\n\n bannerPrinted = true;\n // eslint-disable-next-line no-console\n console.log(`%c${BANNER(client)}`, 'font-family: monospace;');\n};\n", "//\n// Copyright 2020 DXOS.org\n//\n\nimport { type Context, createContext } from 'react';\n\nimport { type Client, type SystemStatus } from '@dxos/client';\n\nexport type ClientContextProps = {\n client: Client;\n status?: SystemStatus | null;\n};\n\n/**\n * @internal Use ClientProvider to create or initialize the Client.\n */\nexport const ClientContext: Context<ClientContextProps | undefined> = createContext<ClientContextProps | undefined>(\n undefined,\n);\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport { useContext } from 'react';\n\nimport { raise } from '@dxos/debug';\n\nimport { ClientContext } from '../client/context';\n\n/**\n * Hook returning instance of DXOS client.\n * Requires ClientContext to be set via ClientProvider.\n */\nexport const useClient = () => {\n const { client } = useContext(ClientContext) ?? raise(new Error('Missing ClientContext.'));\n return client;\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport { useEffect, useState } from 'react';\n\nimport { type Client, type SystemStatus } from '@dxos/client';\n\nexport const useClientStatus = (client: Client) => {\n const [status, setStatus] = useState<SystemStatus | null>();\n useEffect(() => {\n if (!client) {\n return;\n }\n\n const subscription = client.status.subscribe((status) => setStatus(status));\n return () => subscription.unsubscribe();\n }, [client, setStatus]);\n\n return status;\n};\n", "//\n// Copyright 2020 DXOS.org\n//\n\nimport { useContext } from 'react';\n\nimport { raise } from '@dxos/debug';\n\nimport { ClientContext } from './context';\n\n/**\n * Hook returning config object used to initialize the DXOS client instance.\n * Requires ClientContext to be set via ClientProvider.\n */\nexport const useConfig = () => {\n const { client } = useContext(ClientContext) ?? raise(new Error('Missing ClientContext.'));\n return client.config;\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { useEffect, useState } from 'react';\n\nimport { type Shell, type ShellDisplay } from '@dxos/client';\n\nimport { useClient } from './useClient';\n\n/**\n * Helper hook to access the shell.\n */\nexport const useShell = (): Shell => {\n const client = useClient();\n return client.shell;\n};\n\n/**\n * Hook to access the shell’s display state.\n */\nexport const useShellDisplay = (): ShellDisplay => {\n const client = useClient();\n const [display, setDisplay] = useState(client.shell.display);\n useEffect(() => client.shell.onDisplayChange(setDisplay), [client]);\n return display;\n};\n", "//\n// Copyright 2022 DXOS.org\n//\n\nimport { useContext } from 'react';\n\nimport { type SystemStatus } from '@dxos/client';\nimport { raise } from '@dxos/debug';\n\nimport { ClientContext } from './context';\n\nexport const useStatus = (): SystemStatus | null | undefined => {\n const { status } = useContext(ClientContext) ?? raise(new Error('Missing ClientContext.'));\n return status;\n};\n"],
|
|
5
|
-
"mappings": ";;;AAIA,OAAOA,UAAiCC,iBAAAA,gBAAeC,cAAAA,aAAYC,YAAAA,iBAAgB;AAEnF,SAA0CC,oBAAoBC,gCAAgC;AAG9F,SAASC,OAAAA,YAAW;;;ACLpB,OAAOC,SAGLC,YACAC,WACAC,qBACAC,gBACK;AAEP,SAASC,QAAyDC,oBAAoB;AAEtF,SAASC,8BAA8B;AACvC,SAASC,WAAW;AACpB,SAASC,gBAAgBC,0BAA0B;AACnD,SAA2CC,6BAA6B;;;ACXxE,IAAMC,SAAS,CAACC,WAAAA;AACd,QAAMC,aAAaD,OAAOE,OAAOC,IAAI,8BAAA;AACrC,QAAMC,OAAOH,aAAa,eAAeA,UAAAA;IAAkB;AAE3D,SACE;;;;;;;eAMkBD,OAAOK,OAAO;EAAMD,IAAAA;AAE1C;AAEA,IAAIE,gBAAgB;AAEb,IAAMC,cAAc,CAACP,WAAAA;AAC1B,MAAIM,iBAAiBE,OAAOC,SAASC,aAAa,aAAa;AAC7D;EACF;AAEAJ,kBAAgB;AAEhBK,UAAQC,IAAI,KAAKb,OAAOC,MAAAA,CAAAA,IAAW,yBAAA;AACrC;;;AC5BA,SAAuBa,qBAAqB;AAYrC,IAAMC,gBAAyDC,cACpEC,MAAAA;;;;AF8DK,IAAMC,iBAAiBC,2BAC5B,CACE,EACEC,UACAC,QAAQC,aACRC,QAAQC,aACRC,UAAUC,eACVC,QAAQC,aACRC,UAAUC,WAAW,MAAM,MAC3BC,iBAAiB,MACjBC,UACAC,eACA,GAAGC,QAAAA,GAELC,iBAAAA;AAEAC,YAAU,MAAA;AAGRL,sBAAkBM,uBAAAA;EACpB,GAAG,CAAA,CAAE;AAOL,QAAM,CAACC,OAAOC,QAAAA,IAAYC,SAAAA;AAC1B,MAAIF,OAAO;AACT,UAAMA;EACR;AAEA,QAAM,CAACf,QAAQkB,SAAAA,IAAaD,SAAShB,uBAAuBkB,SAASlB,cAAcmB,MAAAA;AAGnFC,sBAAoBT,cAAc,MAAMZ,QAAQ;IAACA;GAAO;AAGxD,QAAM,CAACI,QAAQkB,SAAAA,IAAaC,mBAAmBlB,WAAAA;AAC/CQ,YAAU,MAAA;AACR,QAAI,CAACb,QAAQ;AACX;IACF;AAEA,UAAMwB,eAAexB,OAAOI,OAAOqB,UAAU,CAACrB,YAAWkB,UAAUlB,OAAAA,CAAAA;AACnE,WAAO,MAAMoB,aAAaE,YAAW;EACvC,GAAG;IAAC1B;GAAO;AAGX2B,iBAAe,YAAA;AACb,QAAIC,WAAW;AACf,UAAMC,aAAa,OAAO7B,YAAAA;AACxB,UAAI,CAACA,QAAO8B,aAAa;AACvB,cAAM9B,QAAO6B,WAAU,EAAGE,MAAM,CAACC,QAAAA;AAC/B,cAAI,CAACJ,UAAU;AACbZ,qBAASgB,GAAAA;UACX;QACF,CAAA;AACAC,YAAI,gBAAA,QAAA;;;;;;AACJ,cAAMvB,gBAAgBV,OAAAA;AACtBiC,YAAI,2BAAA,QAAA;;;;;;MACN;AAEAf,gBAAUlB,OAAAA;AACV,UAAI,CAACS,UAAU;AACbyB,oBAAYlC,OAAAA;MACd;IACF;AAEA,QAAIA;AACJ,QAAI;AACF,UAAIC,aAAa;AAEfD,QAAAA,UAAS,MAAMmC,sBAAsBlC,WAAAA;AACrC,cAAM4B,WAAW7B,OAAAA;MACnB,OAAO;AAEL,cAAMF,SAAS,MAAMqC,sBAAsBpC,WAAAA;AAC3CkC,YAAI,mBAAmB;UAAEnC;QAAO,GAAA;;;;;;AAChC,cAAMI,WAAW,MAAMiC,sBAAsBhC,eAAeL,MAAAA;AAC5DmC,YAAI,oBAAoB;UAAE/B;QAAS,GAAA;;;;;;AACnCF,QAAAA,UAAS,IAAImB,OAAO;UAAErB;UAAQI;UAAU,GAAGS;QAAQ,CAAA;AACnDsB,YAAI,kBAAA,QAAA;;;;;;AACJ,cAAMJ,WAAW7B,OAAAA;MACnB;IACF,SAASgC,KAAK;AACZ,UAAI,CAACJ,UAAU;AACbK,YAAIF,MAAMC,KAAAA,QAAAA;;;;;;MACZ;IACF;AAEA,WAAO,MAAA;AACLC,UAAI,YAAA,QAAA;;;;;;AACJL,iBAAW;AAEX,UAAI,CAAC3B,aAAa;AAChB,aAAKD,SACDoC,QAAAA,EACDC,KAAK,MAAA;AACJJ,cAAI,aAAA,QAAA;;;;;;QACN,CAAA,EACCF,MAAM,CAACC,QAAQC,IAAIF,MAAMC,KAAAA,QAAAA;;;;;;MAC9B;IACF;EACF,GAAG;IAACjC;IAAaE;IAAaE;IAAeM;GAAS;AAEtD,MAAI,CAACT,QAAQ8B,eAAe1B,WAAWkC,aAAaC,QAAQ;AAC1D,WAAO,sBAAA,cAAChC,UAAAA;MAASP;MAAgBI;;EACnC;AAEA,SAAO,sBAAA,cAACoC,cAAcC,UAAQ;IAACC,OAAO;MAAE1C;MAAQI;IAAO;KAAIP,QAAAA;AAC7D,CAAA;;;AG1LF,SAAS8C,kBAAkB;AAE3B,SAASC,aAAa;AAQf,IAAMC,YAAY,MAAA;AACvB,QAAM,EAAEC,OAAM,IAAKC,WAAWC,aAAAA,KAAkBC,MAAM,IAAIC,MAAM,wBAAA,CAAA;AAChE,SAAOJ;AACT;;;ACbA,SAASK,aAAAA,YAAWC,YAAAA,iBAAgB;AAI7B,IAAMC,kBAAkB,CAACC,WAAAA;AAC9B,QAAM,CAACC,QAAQC,SAAAA,IAAaC,UAAAA;AAC5BC,EAAAA,WAAU,MAAA;AACR,QAAI,CAACJ,QAAQ;AACX;IACF;AAEA,UAAMK,eAAeL,OAAOC,OAAOK,UAAU,CAACL,YAAWC,UAAUD,OAAAA,CAAAA;AACnE,WAAO,MAAMI,aAAaE,YAAW;EACvC,GAAG;IAACP;IAAQE;GAAU;AAEtB,SAAOD;AACT;;;AChBA,SAASO,cAAAA,mBAAkB;AAE3B,SAASC,SAAAA,cAAa;AAQf,IAAMC,YAAY,MAAA;AACvB,QAAM,EAAEC,OAAM,IAAKC,YAAWC,aAAAA,KAAkBC,OAAM,IAAIC,MAAM,wBAAA,CAAA;AAChE,SAAOJ,OAAOK;AAChB;;;ACbA,SAASC,aAAAA,YAAWC,YAAAA,iBAAgB;AAS7B,IAAMC,WAAW,MAAA;AACtB,QAAMC,SAASC,UAAAA;AACf,SAAOD,OAAOE;AAChB;AAKO,IAAMC,kBAAkB,MAAA;AAC7B,QAAMH,SAASC,UAAAA;AACf,QAAM,CAACG,SAASC,UAAAA,IAAcC,UAASN,OAAOE,MAAME,OAAO;AAC3DG,EAAAA,WAAU,MAAMP,OAAOE,MAAMM,gBAAgBH,UAAAA,GAAa;IAACL;GAAO;AAClE,SAAOI;AACT;;;ACtBA,SAASK,cAAAA,mBAAkB;AAG3B,SAASC,SAAAA,cAAa;AAIf,IAAMC,YAAY,MAAA;AACvB,QAAM,EAAEC,OAAM,IAAKC,YAAWC,aAAAA,KAAkBC,OAAM,IAAIC,MAAM,wBAAA,CAAA;AAChE,SAAOJ;AACT;;;;ARCO,IAAMK,sBAAsBC,gBAAAA,eAAiD,IAAA;AAQ7E,IAAMC,uBAAuB,CAACC,UAAAA;AACnC,QAAMC,SAASC,UAAAA;AACf,QAAM,CAACC,0BAAAA,IAA8BC,UAASC,WAAWJ,MAAAA,CAAAA;AACzD,SACE,gBAAAK,OAAA,cAACT,oBAAoBU,UAAQ;IAACC,OAAOL;KAA4B,KAAEH,MAAMS,QAAQ;AAErF;AAEO,IAAMC,wBAAwB,MAAA;AACnC,SAAOC,YAAWd,mBAAAA;AACpB;AAEA,IAAMQ,aAAa,CAAC,EAAEO,QAAQC,KAAI,MAA6B;AAC7D,QAAMC,qBAAqBF,OAAOG,IAAI,+BAAA;AACtC,MAAI,CAACD,oBAAoB;AACvBE,IAAAA,KAAI,+BAAA,QAAA;;;;;;AACJ,WAAO;EACT;AAGA,MAAIb,6BAAgE;AACpE,UAAQW,mBAAmBG,MAAI;IAC7B,KAAK,iBAAiB;AACpBD,MAAAA,KAAI,kCAAA,QAAA;;;;;;AACJ,aAAO,IAAIE,yBAAAA;IACb;IAEA,KAAK,oBAAoB;AACvBf,mCAA6B,IAAIgB,mBAAmBP,QAAQC,IAAAA;AAC5D,UAAIV,2BAA2BiB,KAAI,GAAI;AACrC,eAAOjB;MACT,OAAO;AAEL,eAAO;MACT;IACF;IAEA,SAAS;AACPa,MAAAA,KAAIK,MAAM,0CAA0CP,mBAAmBG,MAAI,QAAA;;;;;;AAC3E,aAAO;IACT;EACF;AACF;",
|
|
6
|
-
"names": ["React", "createContext", "useContext", "useState", "AgentManagerClient", "FakeAgentHostingProvider", "log", "React", "forwardRef", "useEffect", "useImperativeHandle", "useState", "Client", "SystemStatus", "registerSignalsRuntime", "log", "useAsyncEffect", "useControlledState", "getAsyncProviderValue", "BANNER", "client", "commitHash", "config", "get", "hash", "version", "bannerPrinted", "printBanner", "window", "location", "hostname", "console", "log", "createContext", "ClientContext", "createContext", "undefined", "ClientProvider", "forwardRef", "children", "config", "configParam", "client", "clientParam", "services", "servicesParam", "status", "statusParam", "fallback", "Fallback", "signalsRuntime", "noBanner", "onInitialized", "options", "forwardedRef", "useEffect", "registerSignalsRuntime", "error", "setError", "useState", "setClient", "Client", "undefined", "useImperativeHandle", "setStatus", "useControlledState", "subscription", "subscribe", "unsubscribe", "useAsyncEffect", "disposed", "initialize", "initialized", "catch", "err", "log", "printBanner", "getAsyncProviderValue", "destroy", "then", "SystemStatus", "ACTIVE", "ClientContext", "Provider", "value", "useContext", "raise", "useClient", "client", "useContext", "ClientContext", "raise", "Error", "useEffect", "useState", "useClientStatus", "client", "status", "setStatus", "useState", "useEffect", "subscription", "subscribe", "unsubscribe", "useContext", "raise", "useConfig", "client", "useContext", "ClientContext", "raise", "Error", "config", "useEffect", "useState", "useShell", "client", "useClient", "shell", "useShellDisplay", "display", "setDisplay", "useState", "useEffect", "onDisplayChange", "useContext", "raise", "useStatus", "status", "useContext", "ClientContext", "raise", "Error", "AgentHostingContext", "createContext", "AgentHostingProvider", "props", "client", "useClient", "agentHostingProviderClient", "useState", "makeClient", "React", "Provider", "value", "children", "useAgentHostingClient", "useContext", "config", "halo", "agentHostingConfig", "get", "log", "type", "FakeAgentHostingProvider", "AgentManagerClient", "init", "error"]
|
|
7
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { type Echo, Filter, type Live, Query, type Queryable, type Space } from '@dxos/client/echo';
|
|
2
|
-
interface UseQueryFn {
|
|
3
|
-
<Q extends Query.Any>(spaceOrEcho: Space | Echo | Queryable | undefined, query: Q, deps?: any[]): Live<Query.Type<Q>>[];
|
|
4
|
-
<F extends Filter.Any>(spaceOrEcho: Space | Echo | Queryable | undefined, filter: F, deps?: any[]): Live<Filter.Type<F>>[];
|
|
5
|
-
}
|
|
6
|
-
/**
|
|
7
|
-
* Create subscription.
|
|
8
|
-
*/
|
|
9
|
-
export declare const useQuery: UseQueryFn;
|
|
10
|
-
export {};
|
|
11
|
-
//# sourceMappingURL=useQuery.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"useQuery.d.ts","sourceRoot":"","sources":["../../../../src/echo/useQuery.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,EAAE,KAAK,IAAI,EAAE,KAAK,EAAE,KAAK,SAAS,EAAE,KAAK,KAAK,EAAW,MAAM,mBAAmB,CAAC;AAO7G,UAAU,UAAU;IAClB,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAClB,WAAW,EAAE,KAAK,GAAG,IAAI,GAAG,SAAS,GAAG,SAAS,EACjD,KAAK,EAAE,CAAC,EACR,IAAI,CAAC,EAAE,GAAG,EAAE,GACX,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAEzB,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EACnB,WAAW,EAAE,KAAK,GAAG,IAAI,GAAG,SAAS,GAAG,SAAS,EACjD,MAAM,EAAE,CAAC,EACT,IAAI,CAAC,EAAE,GAAG,EAAE,GACX,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;CAC3B;AAED;;GAEG;AAEH,eAAO,MAAM,QAAQ,EAAE,UAgCtB,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"useQuery.test.d.ts","sourceRoot":"","sources":["../../../../src/echo/useQuery.test.tsx"],"names":[],"mappings":""}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { type Queue } from '@dxos/client/echo';
|
|
2
|
-
import { type Obj, type Relation } from '@dxos/echo';
|
|
3
|
-
import { type DXN } from '@dxos/keys';
|
|
4
|
-
export type UseQueueOptions = {
|
|
5
|
-
pollInterval?: number;
|
|
6
|
-
};
|
|
7
|
-
/**
|
|
8
|
-
* Polls the given Edge queue.
|
|
9
|
-
*/
|
|
10
|
-
export declare const useQueue: <T extends Obj.Any | Relation.Any>(queueDxn?: DXN, options?: UseQueueOptions) => Queue<T> | undefined;
|
|
11
|
-
//# sourceMappingURL=useQueue.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"useQueue.d.ts","sourceRoot":"","sources":["../../../../src/echo/useQueue.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,EAAE,KAAK,GAAG,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AAMtC,MAAM,MAAM,eAAe,GAAG;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;GAEG;AAKH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,EACvD,WAAW,GAAG,EACd,UAAS,eAAoB,KAC5B,KAAK,CAAC,CAAC,CAAC,GAAG,SA4Cb,CAAC"}
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import type * as Schema from 'effect/Schema';
|
|
2
|
-
import { type Client } from '@dxos/client';
|
|
3
|
-
import { type Space } from '@dxos/client/echo';
|
|
4
|
-
/**
|
|
5
|
-
* Subscribe to and retrieve schema changes from a space's schema registry.
|
|
6
|
-
*/
|
|
7
|
-
export declare const useSchema: (client: Client, space: Space | undefined, typename: string | undefined) => Schema.Schema.AnyNoContext | undefined;
|
|
8
|
-
//# sourceMappingURL=useSchema.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"useSchema.d.ts","sourceRoot":"","sources":["../../../../src/echo/useSchema.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAG7C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAG/C;;GAEG;AACH,eAAO,MAAM,SAAS,GACpB,QAAQ,MAAM,EACd,OAAO,KAAK,GAAG,SAAS,EACxB,UAAU,MAAM,GAAG,SAAS,KAC3B,MAAM,CAAC,MAAM,CAAC,YAAY,GAAG,SAmC/B,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"playwright.config.d.ts","sourceRoot":"","sources":["../../../../src/playwright/playwright.config.ts"],"names":[],"mappings":";AAQA,wBAQG"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"smoke.spec.d.ts","sourceRoot":"","sources":["../../../../src/playwright/smoke.spec.ts"],"names":[],"mappings":""}
|
|
@@ -1,129 +0,0 @@
|
|
|
1
|
-
//
|
|
2
|
-
// Copyright 2022 DXOS.org
|
|
3
|
-
//
|
|
4
|
-
|
|
5
|
-
import { renderHook } from '@testing-library/react';
|
|
6
|
-
import { describe, expect, test } from 'vitest';
|
|
7
|
-
|
|
8
|
-
import { Expando, Filter } from '@dxos/client/echo';
|
|
9
|
-
import { Obj, Type } from '@dxos/echo';
|
|
10
|
-
|
|
11
|
-
import { createClient, createClientContextProvider } from '../testing/util';
|
|
12
|
-
|
|
13
|
-
import { useQuery } from './useQuery';
|
|
14
|
-
|
|
15
|
-
describe('useQuery', () => {
|
|
16
|
-
// TODO(dmaretskyi): Fix this test.
|
|
17
|
-
test.skip('deleting an element should result in correct render sequence', async () => {
|
|
18
|
-
// Setup: Create client and space.
|
|
19
|
-
const { client, space } = await createClient({ createIdentity: true, createSpace: true });
|
|
20
|
-
const wrapper = await createClientContextProvider(client);
|
|
21
|
-
|
|
22
|
-
// Create 3 test objects: Alice, Bob, Charlie.
|
|
23
|
-
const alice = Obj.make(Type.Expando, { name: 'Alice' });
|
|
24
|
-
const bob = Obj.make(Type.Expando, { name: 'Bob' });
|
|
25
|
-
const charlie = Obj.make(Type.Expando, { name: 'Charlie' });
|
|
26
|
-
|
|
27
|
-
space!.db.add(alice);
|
|
28
|
-
space!.db.add(bob);
|
|
29
|
-
space!.db.add(charlie);
|
|
30
|
-
await space!.db.flush();
|
|
31
|
-
|
|
32
|
-
// Track all renders to observe the bug.
|
|
33
|
-
const allRenders: string[][] = [];
|
|
34
|
-
|
|
35
|
-
// Setup useQuery hook that captures every render.
|
|
36
|
-
renderHook(
|
|
37
|
-
() => {
|
|
38
|
-
const objects = useQuery(space, Filter.type(Expando));
|
|
39
|
-
|
|
40
|
-
// Capture the names in this render.
|
|
41
|
-
const namesInThisRender = objects.map((obj) => obj.name);
|
|
42
|
-
allRenders.push([...namesInThisRender]);
|
|
43
|
-
|
|
44
|
-
return objects;
|
|
45
|
-
},
|
|
46
|
-
{ wrapper },
|
|
47
|
-
);
|
|
48
|
-
|
|
49
|
-
// Wait for initial renders to complete.
|
|
50
|
-
await new Promise((resolve) => setTimeout(resolve, 100));
|
|
51
|
-
|
|
52
|
-
// THE BUG REPRODUCTION: Delete Bob.
|
|
53
|
-
space!.db.remove(bob);
|
|
54
|
-
|
|
55
|
-
// Wait for all reactive updates to complete.
|
|
56
|
-
await new Promise((resolve) => setTimeout(resolve, 500));
|
|
57
|
-
|
|
58
|
-
// TODO(ZaymonFC): Remove this comment once the flash bug is resolved.
|
|
59
|
-
/*
|
|
60
|
-
* NOTE(ZaymonFC):
|
|
61
|
-
* Expected: 3 renders
|
|
62
|
-
* 1. [] (empty)
|
|
63
|
-
* 2. ['Alice', 'Bob', 'Charlie'] (all loaded)
|
|
64
|
-
* 3. ['Alice', 'Charlie'] (Bob removed, no flash)
|
|
65
|
-
*
|
|
66
|
-
* Actual: 4 renders
|
|
67
|
-
* 1. [] (empty)
|
|
68
|
-
* 2. ['Alice', 'Bob', 'Charlie'] (all loaded)
|
|
69
|
-
* 3. ['Alice', 'Charlie', 'Bob'] (FLASH BUG - Bob moves to end!)x
|
|
70
|
-
* 4. ['Alice', 'Charlie'] (Bob finally removed)
|
|
71
|
-
*/
|
|
72
|
-
|
|
73
|
-
expect(allRenders).toEqual([
|
|
74
|
-
[], // Initial loading state.
|
|
75
|
-
['Alice', 'Bob', 'Charlie'], // All objects loaded.
|
|
76
|
-
['Alice', 'Charlie'], // Bob removed (no flash).
|
|
77
|
-
]);
|
|
78
|
-
});
|
|
79
|
-
|
|
80
|
-
test('bulk deleting multiple items should remove them from query results', async () => {
|
|
81
|
-
// Setup: Create client and space.
|
|
82
|
-
const { client, space } = await createClient({ createIdentity: true, createSpace: true });
|
|
83
|
-
const wrapper = await createClientContextProvider(client);
|
|
84
|
-
|
|
85
|
-
// Create 10 test objects: 1, 2, 3, ..., 10.
|
|
86
|
-
const objects = Array.from({ length: 10 }, (_, i) => Obj.make(Type.Expando, { value: i + 1 }));
|
|
87
|
-
|
|
88
|
-
objects.forEach((obj) => space!.db.add(obj));
|
|
89
|
-
await space!.db.flush();
|
|
90
|
-
|
|
91
|
-
// Track all renders to observe the bug.
|
|
92
|
-
const allRenders: number[][] = [];
|
|
93
|
-
|
|
94
|
-
// Setup useQuery hook that captures every render.
|
|
95
|
-
renderHook(
|
|
96
|
-
() => {
|
|
97
|
-
const queryObjects = useQuery(space, Filter.type(Expando));
|
|
98
|
-
|
|
99
|
-
// Capture the values in this render.
|
|
100
|
-
const valuesInThisRender = queryObjects.map((obj) => obj.value);
|
|
101
|
-
allRenders.push([...valuesInThisRender]);
|
|
102
|
-
|
|
103
|
-
return queryObjects;
|
|
104
|
-
},
|
|
105
|
-
{ wrapper },
|
|
106
|
-
);
|
|
107
|
-
|
|
108
|
-
// Wait for initial renders to complete.
|
|
109
|
-
await new Promise((resolve) => setTimeout(resolve, 100));
|
|
110
|
-
|
|
111
|
-
// THE BUG REPRODUCTION: Delete all items in a loop.
|
|
112
|
-
for (const item of objects) {
|
|
113
|
-
space!.db.remove(item);
|
|
114
|
-
}
|
|
115
|
-
|
|
116
|
-
// Wait for all reactive updates to complete.
|
|
117
|
-
await new Promise((resolve) => setTimeout(resolve, 500));
|
|
118
|
-
|
|
119
|
-
// Convert to sets for order-independent comparison.
|
|
120
|
-
const renderSets = allRenders.map((render) => new Set(render));
|
|
121
|
-
|
|
122
|
-
expect(renderSets).toEqual([
|
|
123
|
-
new Set([]), // Initial loading state.
|
|
124
|
-
new Set([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]), // All objects loaded.
|
|
125
|
-
// TODO(dmaretskyi): Fix this with query ordering.
|
|
126
|
-
new Set([]), // All items deleted.
|
|
127
|
-
]);
|
|
128
|
-
});
|
|
129
|
-
});
|
package/src/echo/useQuery.ts
DELETED
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
//
|
|
2
|
-
// Copyright 2022 DXOS.org
|
|
3
|
-
//
|
|
4
|
-
|
|
5
|
-
import { useMemo, useSyncExternalStore } from 'react';
|
|
6
|
-
|
|
7
|
-
import { type Echo, Filter, type Live, Query, type Queryable, type Space, isSpace } from '@dxos/client/echo';
|
|
8
|
-
|
|
9
|
-
const EMPTY_ARRAY: never[] = [];
|
|
10
|
-
|
|
11
|
-
const noop = () => {};
|
|
12
|
-
|
|
13
|
-
// TODO(dmaretskyi): Queries are fully serializable, so we can remove `deps` argument.
|
|
14
|
-
interface UseQueryFn {
|
|
15
|
-
<Q extends Query.Any>(
|
|
16
|
-
spaceOrEcho: Space | Echo | Queryable | undefined,
|
|
17
|
-
query: Q,
|
|
18
|
-
deps?: any[],
|
|
19
|
-
): Live<Query.Type<Q>>[];
|
|
20
|
-
|
|
21
|
-
<F extends Filter.Any>(
|
|
22
|
-
spaceOrEcho: Space | Echo | Queryable | undefined,
|
|
23
|
-
filter: F,
|
|
24
|
-
deps?: any[],
|
|
25
|
-
): Live<Filter.Type<F>>[];
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* Create subscription.
|
|
30
|
-
*/
|
|
31
|
-
// TODO(burdon): Sort?
|
|
32
|
-
export const useQuery: UseQueryFn = (
|
|
33
|
-
// TODO(burdon): CRITICAL: Remove Space and just requre Queryable.
|
|
34
|
-
resource: Space | Echo | Queryable | undefined,
|
|
35
|
-
queryOrFilter: Query.Any | Filter.Any,
|
|
36
|
-
deps?: any[],
|
|
37
|
-
): Live<unknown>[] => {
|
|
38
|
-
const query = Filter.is(queryOrFilter) ? Query.select(queryOrFilter) : queryOrFilter;
|
|
39
|
-
|
|
40
|
-
const { getObjects, subscribe } = useMemo(() => {
|
|
41
|
-
let queryResult = undefined;
|
|
42
|
-
if (resource) {
|
|
43
|
-
queryResult = isSpace(resource) ? resource.db.query(query) : resource.query(query);
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
let subscribed = false;
|
|
47
|
-
return {
|
|
48
|
-
getObjects: () => (subscribed && queryResult ? queryResult.objects : EMPTY_ARRAY),
|
|
49
|
-
subscribe: (cb: () => void) => {
|
|
50
|
-
subscribed = true;
|
|
51
|
-
const unsubscribe = queryResult?.subscribe(cb) ?? noop;
|
|
52
|
-
return () => {
|
|
53
|
-
unsubscribe?.();
|
|
54
|
-
subscribed = false;
|
|
55
|
-
};
|
|
56
|
-
},
|
|
57
|
-
};
|
|
58
|
-
}, [resource, JSON.stringify(query.ast), ...(deps ?? [])]);
|
|
59
|
-
|
|
60
|
-
// https://beta.reactjs.org/reference/react/useSyncExternalStore
|
|
61
|
-
// NOTE: This hook will resubscribe whenever the callback passed to the first argument changes; make sure it is stable.
|
|
62
|
-
const objects = useSyncExternalStore<Live<unknown>[] | undefined>(subscribe, getObjects);
|
|
63
|
-
return objects ?? [];
|
|
64
|
-
};
|
package/src/echo/useQueue.ts
DELETED
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
//
|
|
2
|
-
// Copyright 2025 DXOS.org
|
|
3
|
-
//
|
|
4
|
-
|
|
5
|
-
import { useEffect, useMemo, useRef } from 'react';
|
|
6
|
-
|
|
7
|
-
import { type Queue } from '@dxos/client/echo';
|
|
8
|
-
import { raise } from '@dxos/debug';
|
|
9
|
-
import { type Obj, type Relation } from '@dxos/echo';
|
|
10
|
-
import { type DXN } from '@dxos/keys';
|
|
11
|
-
|
|
12
|
-
import { useClient } from '../client';
|
|
13
|
-
|
|
14
|
-
const MIN_POLL_INTERVAL = 1_000;
|
|
15
|
-
|
|
16
|
-
export type UseQueueOptions = {
|
|
17
|
-
pollInterval?: number;
|
|
18
|
-
};
|
|
19
|
-
|
|
20
|
-
/**
|
|
21
|
-
* Polls the given Edge queue.
|
|
22
|
-
*/
|
|
23
|
-
// TODO(burdon): Replace polling with socket?
|
|
24
|
-
// TODO(dmaretskyi): Move into client package.
|
|
25
|
-
// TODO(dmaretskyi): Consider passing the space into the hook to support queue DXNs without space id.
|
|
26
|
-
// TODO(ZaymonFC): If queue is unchanged returned object should be refferentially stable on poll.
|
|
27
|
-
export const useQueue = <T extends Obj.Any | Relation.Any>(
|
|
28
|
-
queueDxn?: DXN,
|
|
29
|
-
options: UseQueueOptions = {},
|
|
30
|
-
): Queue<T> | undefined => {
|
|
31
|
-
const client = useClient();
|
|
32
|
-
const mountedRef = useRef(true);
|
|
33
|
-
|
|
34
|
-
const queue = useMemo<Queue<T> | undefined>(() => {
|
|
35
|
-
if (!queueDxn) {
|
|
36
|
-
return undefined;
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
const { spaceId } = queueDxn.asQueueDXN() ?? raise(new TypeError('Invalid queue DXN'));
|
|
40
|
-
return client.spaces.get(spaceId)?.queues.get<T>(queueDxn);
|
|
41
|
-
}, [client, queueDxn?.toString()]);
|
|
42
|
-
|
|
43
|
-
useEffect(() => {
|
|
44
|
-
void queue?.refresh();
|
|
45
|
-
}, [queue]);
|
|
46
|
-
|
|
47
|
-
useEffect(() => {
|
|
48
|
-
let timeout: NodeJS.Timeout;
|
|
49
|
-
mountedRef.current = true;
|
|
50
|
-
|
|
51
|
-
const poll = () => {
|
|
52
|
-
if (!mountedRef.current) {
|
|
53
|
-
return;
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
void queue?.refresh().finally(() => {
|
|
57
|
-
if (mountedRef.current && options.pollInterval) {
|
|
58
|
-
timeout = setTimeout(poll, Math.max(options.pollInterval ?? 0, MIN_POLL_INTERVAL));
|
|
59
|
-
}
|
|
60
|
-
});
|
|
61
|
-
};
|
|
62
|
-
|
|
63
|
-
if (options.pollInterval) {
|
|
64
|
-
poll();
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
return () => {
|
|
68
|
-
mountedRef.current = false;
|
|
69
|
-
clearTimeout(timeout);
|
|
70
|
-
};
|
|
71
|
-
}, [queue, options.pollInterval]);
|
|
72
|
-
|
|
73
|
-
return queue;
|
|
74
|
-
};
|
package/src/echo/useSchema.ts
DELETED
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
//
|
|
2
|
-
// Copyright 2025 DXOS.org
|
|
3
|
-
//
|
|
4
|
-
|
|
5
|
-
import type * as Schema from 'effect/Schema';
|
|
6
|
-
import { useMemo, useSyncExternalStore } from 'react';
|
|
7
|
-
|
|
8
|
-
import { type Client } from '@dxos/client';
|
|
9
|
-
import { type Space } from '@dxos/client/echo';
|
|
10
|
-
import { type BaseSchema } from '@dxos/echo/internal';
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* Subscribe to and retrieve schema changes from a space's schema registry.
|
|
14
|
-
*/
|
|
15
|
-
export const useSchema = (
|
|
16
|
-
client: Client,
|
|
17
|
-
space: Space | undefined,
|
|
18
|
-
typename: string | undefined,
|
|
19
|
-
): Schema.Schema.AnyNoContext | undefined => {
|
|
20
|
-
const { subscribe, getSchema } = useMemo(() => {
|
|
21
|
-
if (!typename || !space) {
|
|
22
|
-
return {
|
|
23
|
-
subscribe: () => () => {},
|
|
24
|
-
getSchema: () => undefined,
|
|
25
|
-
};
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
const staticSchema = client.graph.schemaRegistry.getSchema(typename);
|
|
29
|
-
if (staticSchema) {
|
|
30
|
-
return {
|
|
31
|
-
subscribe: () => () => {},
|
|
32
|
-
getSchema: () => staticSchema,
|
|
33
|
-
};
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
const query = space.db.schemaRegistry.query({ typename });
|
|
37
|
-
const initialResult: BaseSchema = query.runSync()[0];
|
|
38
|
-
let currentSchema = initialResult;
|
|
39
|
-
|
|
40
|
-
return {
|
|
41
|
-
subscribe: (onStoreChange: () => void) => {
|
|
42
|
-
const unsubscribe = query.subscribe(() => {
|
|
43
|
-
currentSchema = query.results[0];
|
|
44
|
-
onStoreChange();
|
|
45
|
-
});
|
|
46
|
-
|
|
47
|
-
return unsubscribe;
|
|
48
|
-
},
|
|
49
|
-
getSchema: () => currentSchema,
|
|
50
|
-
};
|
|
51
|
-
}, [typename, space]);
|
|
52
|
-
|
|
53
|
-
return useSyncExternalStore(subscribe, getSchema);
|
|
54
|
-
};
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
//
|
|
2
|
-
// Copyright 2023 DXOS.org
|
|
3
|
-
//
|
|
4
|
-
|
|
5
|
-
import { defineConfig } from '@playwright/test';
|
|
6
|
-
|
|
7
|
-
import { e2ePreset } from '@dxos/test-utils/playwright';
|
|
8
|
-
|
|
9
|
-
export default defineConfig({
|
|
10
|
-
...e2ePreset(import.meta.dirname),
|
|
11
|
-
// TODO(wittjosiah): Avoid hard-coding ports.
|
|
12
|
-
webServer: {
|
|
13
|
-
command: 'moon run storybook:serve-e2e -- --port=9000',
|
|
14
|
-
port: 9000,
|
|
15
|
-
reuseExistingServer: false,
|
|
16
|
-
},
|
|
17
|
-
});
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
//
|
|
2
|
-
// Copyright 2021 DXOS.org
|
|
3
|
-
//
|
|
4
|
-
|
|
5
|
-
import { type Page, expect, test } from '@playwright/test';
|
|
6
|
-
|
|
7
|
-
import { setupPage, storybookUrl } from '@dxos/test-utils/playwright';
|
|
8
|
-
|
|
9
|
-
test.describe('Smoke test', () => {
|
|
10
|
-
let page: Page;
|
|
11
|
-
|
|
12
|
-
test.beforeAll(async ({ browser }) => {
|
|
13
|
-
const result = await setupPage(browser, {
|
|
14
|
-
url: storybookUrl('sdk-react-client-withclientprovider--default', 9000),
|
|
15
|
-
});
|
|
16
|
-
page = result.page;
|
|
17
|
-
await page.locator(':text("initialized")').waitFor({ state: 'visible' });
|
|
18
|
-
});
|
|
19
|
-
|
|
20
|
-
// NOTE: This test depends on connecting to the default production deployed HALO vault.
|
|
21
|
-
test('Renders remote client info', async () => {
|
|
22
|
-
await expect(page.locator(':text("initialized")')).toBeVisible();
|
|
23
|
-
});
|
|
24
|
-
});
|