@dxos/client-protocol 0.8.4-main.e098934 → 0.8.4-main.e8ec1fe

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/client-protocol",
-  "version": "0.8.4-main.e098934",
+  "version": "0.8.4-main.e8ec1fe",
   "description": "Core DXOS Client API.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -15,11 +15,21 @@
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
+    },
+    "./types": {
+      "source": "./src/types/index.ts",
+      "types": "./dist/types/src/types/index.d.ts",
+      "browser": "./dist/lib/browser/types/index.mjs",
+      "node": "./dist/lib/node-esm/types/index.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
   "typesVersions": {
-    "*": {}
+    "*": {
+      "./types": [
+        "./dist/types/src/types/index.d.ts"
+      ]
+    }
   },
   "files": [
     "dist",
@@ -27,19 +37,18 @@
   ],
   "dependencies": {
     "base-x": "~3.0.9",
-    "effect": "3.17.7",
-    "@dxos/async": "0.8.4-main.e098934",
-    "@dxos/config": "0.8.4-main.e098934",
-    "@dxos/echo": "0.8.4-main.e098934",
-    "@dxos/context": "0.8.4-main.e098934",
-    "@dxos/credentials": "0.8.4-main.e098934",
-    "@dxos/echo-db": "0.8.4-main.e098934",
-    "@dxos/echo-schema": "0.8.4-main.e098934",
-    "@dxos/invariant": "0.8.4-main.e098934",
-    "@dxos/node-std": "0.8.4-main.e098934",
-    "@dxos/protocols": "0.8.4-main.e098934",
-    "@dxos/rpc": "0.8.4-main.e098934",
-    "@dxos/keys": "0.8.4-main.e098934"
+    "effect": "3.18.3",
+    "@dxos/async": "0.8.4-main.e8ec1fe",
+    "@dxos/config": "0.8.4-main.e8ec1fe",
+    "@dxos/credentials": "0.8.4-main.e8ec1fe",
+    "@dxos/echo": "0.8.4-main.e8ec1fe",
+    "@dxos/context": "0.8.4-main.e8ec1fe",
+    "@dxos/echo-db": "0.8.4-main.e8ec1fe",
+    "@dxos/invariant": "0.8.4-main.e8ec1fe",
+    "@dxos/keys": "0.8.4-main.e8ec1fe",
+    "@dxos/node-std": "0.8.4-main.e8ec1fe",
+    "@dxos/protocols": "0.8.4-main.e8ec1fe",
+    "@dxos/rpc": "0.8.4-main.e8ec1fe"
   },
   "peerDependencies": {
     "effect": "^3.13.3"

package/src/echo.ts

@@ -3,26 +3,19 @@
 //
 
 import type { MulticastObservable } from '@dxos/async';
-import type { QueryFn } from '@dxos/echo-db';
+import type { Queryable } from '@dxos/echo-db';
 import type { PublicKey, SpaceId } from '@dxos/keys';
 import type { Invitation, SpaceArchive } from '@dxos/protocols/proto/dxos/client/services';
 
 import type { AuthenticatingInvitation } from './invitations';
-import type { PropertiesTypeProps } from './schema';
 import type { Space } from './space';
+import type { PropertiesTypeProps } from './types';
 
 /**
- * TODO(burdon): Public API (move comments here).
+ * Public database API.
  */
-// TODO(wittjosiah): Rename?
-//   https://ts.dev/style/#naming-style
-//   ClientApi? ClientProtocol?
-export interface Echo extends MulticastObservable<Space[]> {
-  /**
-   * Resolves when the default space is available.
-   */
-  waitUntilReady(): Promise<void>;
-
+// TODO(wittjosiah): Rename Database (not product name).
+export interface Echo extends MulticastObservable<Space[]>, Queryable {
   /**
    * Observable which indicates when the default space is available.
    */
@@ -50,6 +43,11 @@ export interface Echo extends MulticastObservable<Space[]> {
    */
   get default(): Space;
 
+  /**
+   * Resolves when the default space is available.
+   */
+  waitUntilReady(): Promise<void>;
+
   /**
    * Creates a new space.
    */
@@ -66,11 +64,4 @@ export interface Echo extends MulticastObservable<Space[]> {
   join(invitation: Invitation | string): AuthenticatingInvitation;
 
   joinBySpaceKey(spaceKey: PublicKey): Promise<Space>;
-
-  /**
-   * Query all spaces.
-   * @param filter
-   * @param options
-   */
-  query: QueryFn;
 }

package/src/index.ts

@@ -11,4 +11,4 @@ export * from './service-definitions';
 export type * from './shell';
 export type * from './space';
 export * from './timeouts';
-export * from './schema';
+export * from './types';

package/src/service-definitions.ts

@@ -4,7 +4,6 @@
 
 import { type Event } from '@dxos/async';
 import { schema } from '@dxos/protocols/proto';
-import type { FunctionRegistryService } from '@dxos/protocols/proto/dxos/agent/functions';
 import type {
   ContactsService,
   DevicesService,
@@ -42,8 +41,6 @@ export type ClientServices = {
   ContactsService: ContactsService;
   EdgeAgentService: EdgeAgentService;
 
-  FunctionRegistryService: FunctionRegistryService;
-
   // TODO(burdon): Deprecated.
   DevtoolsHost: DevtoolsHost;
 
@@ -84,12 +81,8 @@ export const clientServiceBundle = createServiceBundle<ClientServices>({
   ContactsService: schema.getService('dxos.client.services.ContactsService'),
   EdgeAgentService: schema.getService('dxos.client.services.EdgeAgentService'),
 
-  // Agent-only.
-  FunctionRegistryService: schema.getService('dxos.agent.functions.FunctionRegistryService'),
-
   // TODO(burdon): Deprecated.
   DevtoolsHost: schema.getService('dxos.devtools.host.DevtoolsHost'),
-
   TracingService: schema.getService('dxos.tracing.TracingService'),
 });
 

package/src/space.ts

@@ -4,7 +4,7 @@
 
 import { type CleanupFn, type MulticastObservable } from '@dxos/async';
 import { type SpecificCredential } from '@dxos/credentials';
-import { type AnyLiveObject, type EchoDatabase, type QueueFactory } from '@dxos/echo-db';
+import { type AnyLiveObject, type EchoDatabase, type QueueFactory, type SpaceSyncState } from '@dxos/echo-db';
 import { type PublicKey, type SpaceId } from '@dxos/keys';
 import {
   type Contact,
@@ -47,6 +47,15 @@ export interface SpaceInternal {
 
   setEdgeReplicationPreference(setting: EdgeReplicationSetting): Promise<void>;
 
+  /**
+   * Waits until the space is fully synced with EDGE.
+   * @throws If the EDGE sync is disabled.
+   */
+  syncToEdge(opts?: {
+    onProgress: (state: SpaceSyncState.PeerState | undefined) => void;
+    timeout?: number;
+  }): Promise<void>;
+
   export(): Promise<SpaceArchive>;
 }
 

package/src/timeouts.ts

@@ -33,6 +33,11 @@ export const LOAD_PROPERTIES_TIMEOUT = 3_000;
  */
 export const CREATE_SPACE_TIMEOUT = 5_000;
 
+/**
+ * Timeout for creating new spaces.
+ */
+export const IMPORT_SPACE_TIMEOUT = 30_000;
+
 /**
  * Timeout for loading of control feeds.
  */

package/src/{schema.ts → types/Properties.ts}

@@ -2,11 +2,11 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 
 import { Type } from '@dxos/echo';
+import { TypedObject } from '@dxos/echo/internal';
 import { Queue } from '@dxos/echo-db';
-import { TypedObject } from '@dxos/echo-schema';
 
 export const TYPE_PROPERTIES = 'dxos.org/type/Properties';
 

package/src/types/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './Properties';

package/dist/types/src/schema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../src/schema.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAGtC,eAAO,MAAM,eAAe,6BAA6B,CAAC;;;;;;;;;;;;;;AAG1D,qBAAa,cAAe,SAAQ,mBAYnC;CAAG;AAGJ,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,cAAc,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,sBAAsB,CAAC,CAAC"}