@dxos/client-protocol 0.8.4-main.f9ba587 → 0.8.4-main.fffef41

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/client-protocol",
-  "version": "0.8.4-main.f9ba587",
+  "version": "0.8.4-main.fffef41",
   "description": "Core DXOS Client API.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -11,14 +11,25 @@
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "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",
@@ -26,19 +37,18 @@
   ],
   "dependencies": {
     "base-x": "~3.0.9",
-    "effect": "3.16.13",
-    "@dxos/async": "0.8.4-main.f9ba587",
-    "@dxos/config": "0.8.4-main.f9ba587",
-    "@dxos/context": "0.8.4-main.f9ba587",
-    "@dxos/credentials": "0.8.4-main.f9ba587",
-    "@dxos/echo": "0.8.4-main.f9ba587",
-    "@dxos/echo-db": "0.8.4-main.f9ba587",
-    "@dxos/echo-schema": "0.8.4-main.f9ba587",
-    "@dxos/invariant": "0.8.4-main.f9ba587",
-    "@dxos/keys": "0.8.4-main.f9ba587",
-    "@dxos/node-std": "0.8.4-main.f9ba587",
-    "@dxos/protocols": "0.8.4-main.f9ba587",
-    "@dxos/rpc": "0.8.4-main.f9ba587"
+    "effect": "3.18.3",
+    "@dxos/async": "0.8.4-main.fffef41",
+    "@dxos/config": "0.8.4-main.fffef41",
+    "@dxos/context": "0.8.4-main.fffef41",
+    "@dxos/credentials": "0.8.4-main.fffef41",
+    "@dxos/echo-db": "0.8.4-main.fffef41",
+    "@dxos/echo": "0.8.4-main.fffef41",
+    "@dxos/keys": "0.8.4-main.fffef41",
+    "@dxos/node-std": "0.8.4-main.fffef41",
+    "@dxos/invariant": "0.8.4-main.fffef41",
+    "@dxos/protocols": "0.8.4-main.fffef41",
+    "@dxos/rpc": "0.8.4-main.fffef41"
   },
   "peerDependencies": {
     "effect": "^3.13.3"

package/src/config.ts

@@ -18,7 +18,7 @@ export const EXPECTED_CONFIG_VERSION = 1;
 export const defaultConfig: ConfigProto = { version: 1 };
 
 // TODO(burdon): Allow override via env? Generalize since currently NodeJS only.
-const HOME = typeof process !== 'undefined' ? process?.env?.HOME ?? '' : '';
+const HOME = typeof process !== 'undefined' ? (process?.env?.HOME ?? '') : '';
 
 // Base directories.
 // TODO(burdon): Consider Windows, Linux, OSX.

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/halo.ts

@@ -6,8 +6,8 @@ import { type MulticastObservable } from '@dxos/async';
 import { type PublicKey } from '@dxos/keys';
 import { type Contact, type Device, type Identity, type Invitation } from '@dxos/protocols/proto/dxos/client/services';
 import {
-  type DeviceProfileDocument,
   type Credential,
+  type DeviceProfileDocument,
   type Presentation,
   type ProfileDocument,
 } from '@dxos/protocols/proto/dxos/halo/credentials';

package/src/index.ts

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

package/src/{service-definitions.ts → service.ts}

@@ -4,17 +4,16 @@
 
 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,
+  EdgeAgentService,
   IdentityService,
   InvitationsService,
   LoggingService,
   NetworkService,
   SpacesService,
   SystemService,
-  ContactsService,
-  EdgeAgentService,
 } from '@dxos/protocols/proto/dxos/client/services';
 import type { DevtoolsHost } from '@dxos/protocols/proto/dxos/devtools/host';
 import type { QueryService } from '@dxos/protocols/proto/dxos/echo/query';
@@ -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/shell.ts

@@ -5,8 +5,8 @@
 import { type Event } from '@dxos/async';
 import { type PublicKey } from '@dxos/keys';
 import {
-  type InvitationUrlRequest,
   type AppContextRequest,
+  type InvitationUrlRequest,
   type LayoutRequest,
   type ShellLayout,
 } from '@dxos/protocols/proto/dxos/iframe';

package/src/space.ts

@@ -2,16 +2,18 @@
 // Copyright 2021 DXOS.org
 //
 
-import { type MulticastObservable, type CleanupFn } from '@dxos/async';
+import * as Schema from 'effect/Schema';
+
+import { type CleanupFn, type MulticastObservable } from '@dxos/async';
 import { type SpecificCredential } from '@dxos/credentials';
-import { type QueueFactory, type EchoDatabase, type AnyLiveObject } 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,
   type CreateEpochRequest,
   type Invitation,
-  type Space as SpaceData,
   type SpaceArchive,
+  type Space as SpaceData,
   type SpaceMember,
   type SpaceState,
   type UpdateMemberRoleRequest,
@@ -31,15 +33,18 @@ export type CreateEpochOptions = {
 export interface SpaceInternal {
   get data(): SpaceData;
 
-  // TODO(dmaretskyi): Return epoch info.
-  createEpoch(options?: CreateEpochOptions): Promise<void>;
-
   getCredentials(): Promise<Credential[]>;
 
   getEpochs(): Promise<SpecificCredential<Epoch>[]>;
 
+  // TODO(dmaretskyi): Return epoch info.
+  createEpoch(options?: CreateEpochOptions): Promise<void>;
+
+  // TOOD(burdon): Start to factor out credentials.
   removeMember(memberKey: PublicKey): Promise<void>;
 
+  export(): Promise<SpaceArchive>;
+
   /**
    * Migrate space data to the latest version.
    */
@@ -47,21 +52,31 @@ export interface SpaceInternal {
 
   setEdgeReplicationPreference(setting: EdgeReplicationSetting): Promise<void>;
 
-  export(): Promise<SpaceArchive>;
+  /**
+   * 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>;
 }
 
-// TODO(burdon): Separate public API form implementation (move comments here).
+export const SPACE_TAG = Symbol('dxos.client.protocol.Space');
+
 export interface Space {
-  /**
-   * Unique space identifier.
-   */
-  get id(): SpaceId;
+  readonly [SPACE_TAG]: true;
 
   /**
    * @deprecated Use `id`.
    */
   get key(): PublicKey;
 
+  /**
+   * Unique space identifier.
+   */
+  get id(): SpaceId;
+
   /**
    * Echo database.
    */
@@ -72,13 +87,9 @@ export interface Space {
    */
   get queues(): QueueFactory;
 
+  // TODO(burdon): Replace with state?
   get isOpen(): boolean;
 
-  /**
-   * Properties object.
-   */
-  get properties(): AnyLiveObject<any>;
-
   /**
    * Current state of the space.
    * The database is ready to be used in `SpaceState.SPACE_READY` state.
@@ -86,6 +97,11 @@ export interface Space {
    */
   get state(): MulticastObservable<SpaceState>;
 
+  /**
+   * Properties object.
+   */
+  get properties(): AnyLiveObject<any>;
+
   /**
    * Current state of space pipeline.
    */
@@ -101,11 +117,11 @@ export interface Space {
   // TODO(wittjosiah): Remove. This should not be exposed.
   get internal(): SpaceInternal;
 
-  // TODO(wittjosiah): Rename activate/deactivate?
   /**
    * Activates the space enabling the use of the database and starts replication with peers.
    * The setting is persisted on the local device.
    */
+  // TODO(wittjosiah): Rename activate/deactivate?
   open(): Promise<void>;
 
   /**
@@ -123,13 +139,21 @@ export interface Space {
   createSnapshot(): Promise<SpaceSnapshot>;
 
   // TODO(burdon): Create invitation?
+  // TODO(burdon): Factor out membership, etc.
   share(options?: Partial<Invitation>): CancellableInvitation;
-
   admitContact(contact: Contact): Promise<void>;
-
   updateMemberRole(request: Omit<UpdateMemberRoleRequest, 'spaceKey'>): Promise<void>;
 
   // TODO(wittjosiah): Gather into messaging abstraction?
   postMessage: (channel: string, message: any) => Promise<void>;
   listen: (channel: string, callback: (message: GossipMessage) => void) => CleanupFn;
 }
+
+export const isSpace = (object: unknown): object is Space =>
+  typeof object === 'object' && object != null && (object as Space)[SPACE_TAG] === true;
+
+// TODO(burdon): Create lower-level definition (HasId, db, etc.) and move to @dxos/echo.
+export const SpaceSchema: Schema.Schema<Space> = Schema.Any.pipe(
+  Schema.filter((space) => isSpace(space)),
+  Schema.annotations({ title: 'Space' }),
+);

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,10 +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-schema';
+import { TypedObject } from '@dxos/echo/internal';
+import { Queue } from '@dxos/echo-db';
 
 export const TYPE_PROPERTIES = 'dxos.org/type/Properties';
 
@@ -19,7 +20,7 @@ export class PropertiesType extends TypedObject({
     // TODO(wittjosiah): Make generic?
     hue: Schema.optional(Schema.String),
     icon: Schema.optional(Schema.String),
-    invocationTraceQueue: Schema.optional(Type.Ref(Type.Expando)),
+    invocationTraceQueue: Schema.optional(Type.Ref(Queue)),
   },
   { record: true },
 ) {}

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;AAGlC,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"}

package/dist/types/src/service-definitions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"service-definitions.d.ts","sourceRoot":"","sources":["../../../src/service-definitions.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAC;AAC1F,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,cAAc,EACd,aAAa,EACb,aAAa,EACb,eAAe,EACf,gBAAgB,EACjB,MAAM,4CAA4C,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AAC3E,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AACjG,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,KAAK,aAAa,EAAuB,MAAM,WAAW,CAAC;AAMpE,MAAM,MAAM,cAAc,GAAG;IAC3B,aAAa,EAAE,aAAa,CAAC;IAC7B,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IAE/B,eAAe,EAAE,eAAe,CAAC;IACjC,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,YAAY,EAAE,YAAY,CAAC;IAC3B,cAAc,EAAE,cAAc,CAAC;IAC/B,aAAa,EAAE,aAAa,CAAC;IAC7B,WAAW,EAAE,WAAW,CAAC;IACzB,eAAe,EAAE,eAAe,CAAC;IACjC,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,uBAAuB,EAAE,uBAAuB,CAAC;IAGjD,YAAY,EAAE,YAAY,CAAC;IAE3B,cAAc,EAAE,cAAc,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;IACjC,WAAW,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAC3C,QAAQ,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAGlC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,+BAqB9B,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG;IAChC,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,aAAa,CAAC,mBAAmB,CAElE,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,aAAa,CAAC,mBAAmB,CAElE,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,aAAa,CAAC,gBAAgB,CAE5D,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,aAAa,CAAC,kBAAkB,CAEhE,CAAC"}