@dxos/react-client 0.8.1-main.ba2dec9 → 0.8.1-staging.5be625a

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/echo/index.ts"],"names":[],"mappings":"AAIA,cAAc,mBAAmB,CAAC;AAElC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/echo/index.ts"],"names":[],"mappings":"AAIA,cAAc,mBAAmB,CAAC;AAElC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC"}

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/echo/useSchema.d.ts

@@ -1,7 +1,8 @@
+import { type Client } from '@dxos/client';
 import { type Space } from '@dxos/client/echo';
-import { type EchoSchema } from '@dxos/echo-schema';
+import { type BaseSchema } from '@dxos/echo-schema';
 /**
  * Subscribe to and retrieve schema changes from a space's schema registry.
  */
-export declare const useSchema: (space: Space | undefined, typename: string | undefined) => EchoSchema | undefined;
+export declare const useSchema: (client: Client, space: Space | undefined, typename: string | undefined) => BaseSchema | undefined;
 //# sourceMappingURL=useSchema.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"useSchema.d.ts","sourceRoot":"","sources":["../../../../src/echo/useSchema.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;GAEG;AACH,eAAO,MAAM,SAAS,UAAW,KAAK,GAAG,SAAS,YAAY,MAAM,GAAG,SAAS,KAAG,UAAU,GAAG,SA0B/F,CAAC"}
+{"version":3,"file":"useSchema.d.ts","sourceRoot":"","sources":["../../../../src/echo/useSchema.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAmB,KAAK,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,SAAS,WACZ,MAAM,SACP,KAAK,GAAG,SAAS,YACd,MAAM,GAAG,SAAS,KAC3B,UAAU,GAAG,SAqCf,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-client",
-  "version": "0.8.1-main.ba2dec9",
+  "version": "0.8.1-staging.5be625a",
   "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/codec-protobuf": "0.8.1-main.ba2dec9",
-    "@dxos/async": "0.8.1-main.ba2dec9",
-    "@dxos/client": "0.8.1-main.ba2dec9",
-    "@dxos/config": "0.8.1-main.ba2dec9",
-    "@dxos/debug": "0.8.1-main.ba2dec9",
-    "@dxos/echo-signals": "0.8.1-main.ba2dec9",
-    "@dxos/echo-schema": "0.8.1-main.ba2dec9",
-    "@dxos/invariant": "0.8.1-main.ba2dec9",
-    "@dxos/log": "0.8.1-main.ba2dec9",
-    "@dxos/node-std": "0.8.1-main.ba2dec9",
-    "@dxos/protocols": "0.8.1-main.ba2dec9",
-    "@dxos/react-hooks": "0.8.1-main.ba2dec9",
-    "@dxos/util": "0.8.1-main.ba2dec9"
+    "@dxos/async": "0.8.1-staging.5be625a",
+    "@dxos/codec-protobuf": "0.8.1-staging.5be625a",
+    "@dxos/client": "0.8.1-staging.5be625a",
+    "@dxos/config": "0.8.1-staging.5be625a",
+    "@dxos/echo-schema": "0.8.1-staging.5be625a",
+    "@dxos/echo-signals": "0.8.1-staging.5be625a",
+    "@dxos/log": "0.8.1-staging.5be625a",
+    "@dxos/node-std": "0.8.1-staging.5be625a",
+    "@dxos/debug": "0.8.1-staging.5be625a",
+    "@dxos/invariant": "0.8.1-staging.5be625a",
+    "@dxos/protocols": "0.8.1-staging.5be625a",
+    "@dxos/react-hooks": "0.8.1-staging.5be625a",
+    "@dxos/util": "0.8.1-staging.5be625a"
   },
   "devDependencies": {
     "@types/react": "~18.2.0",
     "@types/react-dom": "~18.2.0",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "@dxos/random": "0.8.1-main.ba2dec9",
-    "@dxos/react-ui": "0.8.1-main.ba2dec9",
-    "@dxos/react-ui-syntax-highlighter": "0.8.1-main.ba2dec9",
-    "@dxos/react-ui-theme": "0.8.1-main.ba2dec9",
-    "@dxos/storybook-utils": "0.8.1-main.ba2dec9",
-    "@dxos/test-utils": "0.8.1-main.ba2dec9"
+    "@dxos/random": "0.8.1-staging.5be625a",
+    "@dxos/react-ui-theme": "0.8.1-staging.5be625a",
+    "@dxos/react-ui-syntax-highlighter": "0.8.1-staging.5be625a",
+    "@dxos/storybook-utils": "0.8.1-staging.5be625a",
+    "@dxos/react-ui": "0.8.1-staging.5be625a",
+    "@dxos/test-utils": "0.8.1-staging.5be625a"
   },
   "peerDependencies": {
     "react": "~18.2.0",
     "react-dom": "~18.2.0"
   },
   "optionalDependencies": {
-    "@dxos/react-ui": "0.8.1-main.ba2dec9",
-    "@dxos/react-ui-theme": "0.8.1-main.ba2dec9",
-    "@dxos/random": "0.8.1-main.ba2dec9"
+    "@dxos/random": "0.8.1-staging.5be625a",
+    "@dxos/react-ui": "0.8.1-staging.5be625a",
+    "@dxos/react-ui-theme": "0.8.1-staging.5be625a"
   },
   "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;
+};

package/src/echo/useSchema.ts

@@ -4,13 +4,18 @@
 
 import { useMemo, useSyncExternalStore } from 'react';
 
+import { type Client } from '@dxos/client';
 import { type Space } from '@dxos/client/echo';
-import { type EchoSchema } from '@dxos/echo-schema';
+import { ImmutableSchema, type BaseSchema } from '@dxos/echo-schema';
 
 /**
  * Subscribe to and retrieve schema changes from a space's schema registry.
  */
-export const useSchema = (space: Space | undefined, typename: string | undefined): EchoSchema | undefined => {
+export const useSchema = (
+  client: Client,
+  space: Space | undefined,
+  typename: string | undefined,
+): BaseSchema | undefined => {
   const { subscribe, getSchema } = useMemo(() => {
     if (!typename || !space) {
       return {
@@ -19,8 +24,18 @@ export const useSchema = (space: Space | undefined, typename: string | undefined
       };
     }
 
+    const staticSchema = client.graph.schemaRegistry.getSchema(typename);
+    if (staticSchema) {
+      // Don't inline into getSchema, need a stable reference.
+      const immutableSchema = new ImmutableSchema(staticSchema);
+      return {
+        subscribe: () => () => {},
+        getSchema: () => immutableSchema,
+      };
+    }
+
     const query = space.db.schemaRegistry.query({ typename });
-    const initialResult = query.runSync()[0];
+    const initialResult: BaseSchema = query.runSync()[0];
     let currentSchema = initialResult;
 
     return {
@@ -29,6 +44,7 @@ export const useSchema = (space: Space | undefined, typename: string | undefined
           currentSchema = query.results[0];
           onStoreChange();
         });
+
         return unsubscribe;
       },
       getSchema: () => currentSchema,