@dxos/react-client 0.8.0 → 0.8.1-main.013e445

package/dist/types/src/echo/useQueue.d.ts

@@ -0,0 +1,11 @@
+import type { Queue } from '@dxos/client/echo';
+import type { BaseEchoObject } from '@dxos/echo-schema';
+import { type DXN } from '@dxos/keys';
+export type UseQueueOptions = {
+    pollInterval?: number;
+};
+/**
+ * Polls the given Edge queue.
+ */
+export declare const useQueue: <T extends BaseEchoObject>(queueDxn?: DXN, options?: UseQueueOptions) => Queue<T> | undefined;
+//# sourceMappingURL=useQueue.d.ts.map

package/dist/types/src/echo/useQueue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useQueue.d.ts","sourceRoot":"","sources":["../../../../src/echo/useQueue.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AAMtC,MAAM,MAAM,eAAe,GAAG;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;GAEG;AAIH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,cAAc,aACpC,GAAG,YACL,eAAe,KACvB,KAAK,CAAC,CAAC,CAAC,GAAG,SAgCb,CAAC"}

package/dist/types/src/halo/Passkey.stories.d.ts

@@ -1,7 +1,8 @@
 import '@dxos-theme';
+import React from 'react';
 declare const _default: {
     title: string;
-    render: () => import("react/jsx-runtime").JSX.Element;
+    render: () => React.JSX.Element;
 };
 export default _default;
 export declare const Default: {

package/dist/types/src/halo/Passkey.stories.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Passkey.stories.d.ts","sourceRoot":"","sources":["../../../../src/halo/Passkey.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;;;;;AA2HrB,wBAGE;AAsBF,eAAO,MAAM,OAAO;;CAEnB,CAAC"}
+{"version":3,"file":"Passkey.stories.d.ts","sourceRoot":"","sources":["../../../../src/halo/Passkey.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;AAErB,OAAO,KAAsB,MAAM,OAAO,CAAC;;;;;AAyH3C,wBAGE;AAsBF,eAAO,MAAM,OAAO;;CAEnB,CAAC"}

package/dist/types/src/testing/ClientRepeater.d.ts

@@ -1,4 +1,4 @@
-import { type FC } from 'react';
+import React, { type FC } from 'react';
 import { Client, type PublicKey } from '@dxos/client';
 import { type TypedObject } from '@dxos/echo-schema';
 import { type WithClientProviderProps } from './withClientProvider';
@@ -24,5 +24,5 @@ export type ClientRepeaterProps<P extends ClientRepeatedComponentProps> = {
  * The `Component` property is rendered n times, once for each peer.
  * @deprecated use `withClientProvider`.
  */
-export declare const ClientRepeater: <P extends ClientRepeatedComponentProps>(props: ClientRepeaterProps<P>) => import("react/jsx-runtime").JSX.Element | null;
+export declare const ClientRepeater: <P extends ClientRepeatedComponentProps>(props: ClientRepeaterProps<P>) => React.JSX.Element | null;
 //# sourceMappingURL=ClientRepeater.d.ts.map

package/dist/types/src/testing/ClientRepeater.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClientRepeater.d.ts","sourceRoot":"","sources":["../../../../src/testing/ClientRepeater.tsx"],"names":[],"mappings":"AAIA,OAAc,EAAY,KAAK,EAAE,EAAqB,MAAM,OAAO,CAAC;AAEpE,OAAO,EAAE,MAAM,EAAE,KAAK,SAAS,EAAE,MAAM,cAAc,CAAC;AAEtD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAIrD,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAGpE,MAAM,MAAM,4BAA4B,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAE/F,MAAM,MAAM,2BAA2B,GAAG;IAAE,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAGhE,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,4BAA4B,IAAI;IACxE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,EAAE,CAAC,4BAA4B,CAAC,CAAC;IAC5C,QAAQ,CAAC,EAAE,EAAE,CAAC,2BAA2B,CAAC,CAAC;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE,WAAW,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC;CAChC,GAAG,IAAI,CAAC,uBAAuB,EAAE,gBAAgB,GAAG,aAAa,GAAG,gBAAgB,CAAC,CAAC;AAEvF;;;;GAIG;AAMH,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,4BAA4B,SAAS,mBAAmB,CAAC,CAAC,CAAC,mDA2DnG,CAAC"}
+{"version":3,"file":"ClientRepeater.d.ts","sourceRoot":"","sources":["../../../../src/testing/ClientRepeater.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,EAAY,KAAK,EAAE,EAAqB,MAAM,OAAO,CAAC;AAEpE,OAAO,EAAE,MAAM,EAAE,KAAK,SAAS,EAAE,MAAM,cAAc,CAAC;AAEtD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAIrD,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAGpE,MAAM,MAAM,4BAA4B,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAE/F,MAAM,MAAM,2BAA2B,GAAG;IAAE,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAGhE,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,4BAA4B,IAAI;IACxE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,EAAE,CAAC,4BAA4B,CAAC,CAAC;IAC5C,QAAQ,CAAC,EAAE,EAAE,CAAC,2BAA2B,CAAC,CAAC;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE,WAAW,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC;CAChC,GAAG,IAAI,CAAC,uBAAuB,EAAE,gBAAgB,GAAG,aAAa,GAAG,gBAAgB,CAAC,CAAC;AAEvF;;;;GAIG;AAMH,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,4BAA4B,SAAS,mBAAmB,CAAC,CAAC,CAAC,6BA2DnG,CAAC"}

package/dist/types/src/testing/ClientRepeater.stories.d.ts

@@ -1,13 +1,14 @@
 import '@dxos-theme';
+import React from 'react';
 declare const _default: {
     title: string;
     decorators: import("@storybook/react").Decorator[];
 };
 export default _default;
 export declare const Default: {
-    render: () => import("react/jsx-runtime").JSX.Element;
+    render: () => React.JSX.Element;
 };
 export declare const Space: {
-    render: () => import("react/jsx-runtime").JSX.Element;
+    render: () => React.JSX.Element;
 };
 //# sourceMappingURL=ClientRepeater.stories.d.ts.map

package/dist/types/src/testing/ClientRepeater.stories.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClientRepeater.stories.d.ts","sourceRoot":"","sources":["../../../../src/testing/ClientRepeater.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;;;;;AAYrB,wBAGE;AAgCF,eAAO,MAAM,OAAO;;CAEnB,CAAC;AAEF,eAAO,MAAM,KAAK;;CAEjB,CAAC"}
+{"version":3,"file":"ClientRepeater.stories.d.ts","sourceRoot":"","sources":["../../../../src/testing/ClientRepeater.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;AAErB,OAAO,KAAK,MAAM,OAAO,CAAC;;;;;AAU1B,wBAGE;AAgCF,eAAO,MAAM,OAAO;;CAEnB,CAAC;AAEF,eAAO,MAAM,KAAK;;CAEjB,CAAC"}

package/dist/types/src/testing/util.d.ts

@@ -1,3 +1,4 @@
+import React from 'react';
 import { Client, type Config } from '@dxos/client';
 import { type Space } from '@dxos/client/echo';
 export declare const createClient: ({ config, createIdentity, createSpace, }?: {
@@ -8,6 +9,6 @@ export declare const createClient: ({ config, createIdentity, createSpace, }?: {
     client: Client;
     space: Space | undefined;
 }>;
-export declare const createClientContextProvider: (client: Client) => Promise<({ children }: any) => import("react/jsx-runtime").JSX.Element>;
-export declare const createClientProvider: (client: Client) => Promise<({ children }: any) => import("react/jsx-runtime").JSX.Element>;
+export declare const createClientContextProvider: (client: Client) => Promise<({ children }: any) => React.JSX.Element>;
+export declare const createClientProvider: (client: Client) => Promise<({ children }: any) => React.JSX.Element>;
 //# sourceMappingURL=util.d.ts.map

package/dist/types/src/testing/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../../src/testing/util.tsx"],"names":[],"mappings":"AAMA,OAAO,EAAE,MAAM,EAAE,KAAK,MAAM,EAAY,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAK/C,eAAO,MAAM,YAAY,8CAItB;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CAAE;;;EActE,CAAC;AAEF,eAAO,MAAM,2BAA2B,WAAkB,MAAM,4BACxC,GAAG,6CAC1B,CAAC;AAEF,eAAO,MAAM,oBAAoB,WAAkB,MAAM,4BACjC,GAAG,6CAC1B,CAAC"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../../src/testing/util.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,MAAM,EAAE,KAAK,MAAM,EAAY,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAK/C,eAAO,MAAM,YAAY,8CAItB;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CAAE;;;EActE,CAAC;AAEF,eAAO,MAAM,2BAA2B,WAAkB,MAAM,4BACxC,GAAG,uBAC1B,CAAC;AAEF,eAAO,MAAM,oBAAoB,WAAkB,MAAM,4BACjC,GAAG,uBAC1B,CAAC"}

package/dist/types/src/testing/withClientProvider.stories.d.ts

@@ -1,7 +1,8 @@
 import '@dxos-theme';
+import React from 'react';
 declare const _default: {
     title: string;
-    render: () => import("react/jsx-runtime").JSX.Element | null;
+    render: () => React.JSX.Element | null;
 };
 export default _default;
 export declare const Default: {

package/dist/types/src/testing/withClientProvider.stories.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"withClientProvider.stories.d.ts","sourceRoot":"","sources":["../../../../src/testing/withClientProvider.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;;;;;AAkCrB,wBAGE;AAaF,eAAO,MAAM,OAAO;;CAEnB,CAAC;AAEF,eAAO,MAAM,QAAQ;;CAMpB,CAAC"}
+{"version":3,"file":"withClientProvider.stories.d.ts","sourceRoot":"","sources":["../../../../src/testing/withClientProvider.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;AAErB,OAAO,KAAK,MAAM,OAAO,CAAC;;;;;AAgC1B,wBAGE;AAaF,eAAO,MAAM,OAAO;;CAEnB,CAAC;AAEF,eAAO,MAAM,QAAQ;;CAMpB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-client",
-  "version": "0.8.0",
+  "version": "0.8.1-main.013e445",
   "description": "React client API",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -78,40 +78,40 @@
   },
   "dependencies": {
     "react-error-boundary": "^4.0.13",
-    "@dxos/async": "0.8.0",
-    "@dxos/codec-protobuf": "0.8.0",
-    "@dxos/config": "0.8.0",
-    "@dxos/client": "0.8.0",
-    "@dxos/debug": "0.8.0",
-    "@dxos/echo-schema": "0.8.0",
-    "@dxos/echo-signals": "0.8.0",
-    "@dxos/invariant": "0.8.0",
-    "@dxos/log": "0.8.0",
-    "@dxos/node-std": "0.8.0",
-    "@dxos/react-hooks": "0.8.0",
-    "@dxos/util": "0.8.0",
-    "@dxos/protocols": "0.8.0"
+    "@dxos/async": "0.8.1-main.013e445",
+    "@dxos/codec-protobuf": "0.8.1-main.013e445",
+    "@dxos/config": "0.8.1-main.013e445",
+    "@dxos/client": "0.8.1-main.013e445",
+    "@dxos/debug": "0.8.1-main.013e445",
+    "@dxos/echo-schema": "0.8.1-main.013e445",
+    "@dxos/echo-signals": "0.8.1-main.013e445",
+    "@dxos/invariant": "0.8.1-main.013e445",
+    "@dxos/log": "0.8.1-main.013e445",
+    "@dxos/node-std": "0.8.1-main.013e445",
+    "@dxos/protocols": "0.8.1-main.013e445",
+    "@dxos/react-hooks": "0.8.1-main.013e445",
+    "@dxos/util": "0.8.1-main.013e445"
   },
   "devDependencies": {
     "@types/react": "~18.2.0",
     "@types/react-dom": "~18.2.0",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.0",
-    "@dxos/react-ui-syntax-highlighter": "0.8.0",
-    "@dxos/random": "0.8.0",
-    "@dxos/react-ui-theme": "0.8.0",
-    "@dxos/storybook-utils": "0.8.0",
-    "@dxos/test-utils": "0.8.0"
+    "@dxos/random": "0.8.1-main.013e445",
+    "@dxos/react-ui": "0.8.1-main.013e445",
+    "@dxos/react-ui-syntax-highlighter": "0.8.1-main.013e445",
+    "@dxos/react-ui-theme": "0.8.1-main.013e445",
+    "@dxos/storybook-utils": "0.8.1-main.013e445",
+    "@dxos/test-utils": "0.8.1-main.013e445"
   },
   "peerDependencies": {
     "react": "~18.2.0",
     "react-dom": "~18.2.0"
   },
   "optionalDependencies": {
-    "@dxos/random": "0.8.0",
-    "@dxos/react-ui": "0.8.0",
-    "@dxos/react-ui-theme": "0.8.0"
+    "@dxos/random": "0.8.1-main.013e445",
+    "@dxos/react-ui": "0.8.1-main.013e445",
+    "@dxos/react-ui-theme": "0.8.1-main.013e445"
   },
   "publishConfig": {
     "access": "public"

package/src/echo/index.ts

@@ -10,3 +10,4 @@ export * from './useSchema';
 export * from './useSpaces';
 export * from './useSpaceInvitations';
 export * from './useSubscription';
+export * from './useQueue';

package/src/echo/useQueue.ts

@@ -0,0 +1,61 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useEffect, useMemo } from 'react';
+
+import type { Queue } from '@dxos/client/echo';
+import { raise } from '@dxos/debug';
+import type { BaseEchoObject } from '@dxos/echo-schema';
+import { type DXN } from '@dxos/keys';
+
+import { useClient } from '../client';
+
+const MIN_POLL_INTERVAL = 1_000;
+
+export type UseQueueOptions = {
+  pollInterval?: number;
+};
+
+/**
+ * Polls the given Edge queue.
+ */
+// TODO(burdon): Replace polling with socket?
+// TODO(dmaretskyi): Move into client package.
+// TODO(dmaretskyi): Consider passing the space into the hook to support queue DXNs without space id.
+export const useQueue = <T extends BaseEchoObject>(
+  queueDxn?: DXN,
+  options: UseQueueOptions = {},
+): Queue<T> | undefined => {
+  const client = useClient();
+  const queue = useMemo<Queue<T> | undefined>(() => {
+    if (!queueDxn) {
+      return undefined;
+    }
+
+    const { spaceId } = queueDxn.asQueueDXN() ?? raise(new TypeError('Invalid queue DXN'));
+
+    return client.spaces.get(spaceId)?.queues.get<T>(queueDxn);
+  }, [client, queueDxn?.toString()]);
+
+  useEffect(() => {
+    void queue?.refresh();
+  }, [queue]);
+
+  useEffect(() => {
+    let timeout: NodeJS.Timeout;
+    if (options.pollInterval) {
+      const poll = () => {
+        void queue?.refresh().finally(() => {
+          timeout = setTimeout(poll, Math.max(options.pollInterval ?? 0, MIN_POLL_INTERVAL));
+        });
+      };
+
+      poll();
+    }
+
+    return () => clearTimeout(timeout);
+  }, [queue, options.pollInterval]);
+
+  return queue;
+};