@dxos/client-protocol 0.8.4-main.70d3990 → 0.8.4-main.74a063c4e0

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "@dxos/client-protocol",
-  "version": "0.8.4-main.70d3990",
+  "version": "0.8.4-main.74a063c4e0",
   "description": "Core DXOS Client API.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
-  "repository": "github:dxos/dxos",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
-  "sideEffects": true,
+  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
@@ -36,21 +39,21 @@
     "src"
   ],
   "dependencies": {
-    "base-x": "~3.0.9",
-    "effect": "3.18.3",
-    "@dxos/async": "0.8.4-main.70d3990",
-    "@dxos/credentials": "0.8.4-main.70d3990",
-    "@dxos/echo": "0.8.4-main.70d3990",
-    "@dxos/invariant": "0.8.4-main.70d3990",
-    "@dxos/echo-db": "0.8.4-main.70d3990",
-    "@dxos/context": "0.8.4-main.70d3990",
-    "@dxos/node-std": "0.8.4-main.70d3990",
-    "@dxos/rpc": "0.8.4-main.70d3990",
-    "@dxos/keys": "0.8.4-main.70d3990",
-    "@dxos/protocols": "0.8.4-main.70d3990"
+    "base-x": "~3.0.11",
+    "effect": "3.20.0",
+    "@dxos/context": "0.8.4-main.74a063c4e0",
+    "@dxos/credentials": "0.8.4-main.74a063c4e0",
+    "@dxos/echo": "0.8.4-main.74a063c4e0",
+    "@dxos/async": "0.8.4-main.74a063c4e0",
+    "@dxos/echo-db": "0.8.4-main.74a063c4e0",
+    "@dxos/keys": "0.8.4-main.74a063c4e0",
+    "@dxos/node-std": "0.8.4-main.74a063c4e0",
+    "@dxos/invariant": "0.8.4-main.74a063c4e0",
+    "@dxos/protocols": "0.8.4-main.74a063c4e0",
+    "@dxos/rpc": "0.8.4-main.74a063c4e0"
   },
   "peerDependencies": {
-    "effect": "^3.13.3"
+    "effect": "3.20.0"
   },
   "publishConfig": {
     "access": "public"

package/src/config.ts

@@ -4,8 +4,8 @@
 
 // TODO(wittjosiah): Factor out to @dxos/config.
 
-export const DEFAULT_INTERNAL_CHANNEL = 'dxos:vault';
 export const DEFAULT_CLIENT_CHANNEL = 'dxos:app';
+export const DEFAULT_INTERNAL_CHANNEL = 'dxos:vault';
 export const DEFAULT_SHELL_CHANNEL = 'dxos:shell';
 export const DEFAULT_WORKER_BROADCAST_CHANNEL = 'dxos:shared-worker';
 
@@ -14,19 +14,18 @@ export const DEFAULT_WORKER_BROADCAST_CHANNEL = 'dxos:shared-worker';
  */
 export const DEFAULT_VAULT_URL = 'https://halo.dxos.org/vault.html';
 
+/**
+ * @deprecated
+ */
+// TODO(burdon): Remove need (i.e., make undefined do the right thing).
+export const DEFAULT_PROFILE = 'default';
+
 export const EXPECTED_CONFIG_VERSION = 1;
 export const defaultConfig = { version: 1 };
 
 // TODO(burdon): Allow override via env? Generalize since currently NodeJS only.
 const HOME = typeof process !== 'undefined' ? (process?.env?.HOME ?? '') : '';
 
-// Base directories.
-// TODO(burdon): Consider Windows, Linux, OSX.
-// https://wiki.archlinux.org/title/XDG_Base_Directory
-// Each `/dx` directory should contain `/profile/<DX_PROFILE>` subdirectories.
-export const getProfilePath = (root: string, profile: string, file: string | undefined = undefined) =>
-  `${root}/profile/${profile}` + (file ? `/${file}` : '');
-
 // XDG_CONFIG_HOME (Analogous to /etc.)
 export const DX_CONFIG = `${HOME}/.config/dx`;
 
@@ -43,7 +42,27 @@ export const DX_STATE = `${HOME}/.local/state/dx`;
 // XDG_RUNTIME_DIR (Non-essential files, sockets, etc.)
 export const DX_RUNTIME = '/tmp/dx/run';
 
-export const ENV_DX_CONFIG = 'DX_CONFIG';
-export const ENV_DX_NO_AGENT = 'DX_NO_AGENT';
-export const ENV_DX_PROFILE = 'DX_PROFILE';
-export const ENV_DX_PROFILE_DEFAULT = 'default';
+export enum DXEnv {
+  CONFIG = 'DX_CONFIG',
+  DEBUG = 'DX_DEBUG',
+  NO_AGENT = 'DX_NO_AGENT',
+  PROFILE = 'DX_PROFILE',
+}
+
+export namespace DXEnv {
+  /**
+   * Helper to get the value from process.env
+   */
+  export function get(variable: DXEnv): string | undefined;
+  export function get(variable: DXEnv, defaultValue: string): string;
+  export function get(variable: DXEnv, defaultValue?: string): string | undefined {
+    return process.env[variable] ?? defaultValue;
+  }
+}
+
+// Profile layout: profile/<name> is the profile dir; profile/<name>.yml is the config file.
+export const getProfilePath = (root: string, profile: string, file?: string) =>
+  `${root}/profile/${profile}` + (file ? `/${file}` : '');
+
+/** Path to the profile config file (profile/<name>.yml). */
+export const getProfileConfigPath = (root: string, profile: string) => `${getProfilePath(root, profile)}.yml`;

package/src/echo.ts

@@ -6,6 +6,7 @@ import type { MulticastObservable } from '@dxos/async';
 import type { Database } from '@dxos/echo';
 import type { PublicKey, SpaceId } from '@dxos/keys';
 import type { Invitation, SpaceArchive } from '@dxos/protocols/proto/dxos/client/services';
+import type { MembershipPolicy } from '@dxos/protocols/proto/dxos/halo/credentials';
 
 import type { AuthenticatingInvitation } from './invitations';
 import type { Space } from './space';
@@ -16,12 +17,6 @@ import type { SpaceProperties } from './types';
  */
 // TODO(wittjosiah): Rename Database (not product name).
 export interface Echo extends MulticastObservable<Space[]>, Database.Queryable {
-  /**
-   * Observable which indicates when the default space is available.
-   */
-  // TODO(wittjosiah): Remove. Ensure default space is always available.
-  get isReady(): MulticastObservable<boolean>;
-
   /**
    * Returns the list of spaces.
    */
@@ -38,20 +33,13 @@ export interface Echo extends MulticastObservable<Space[]>, Database.Queryable {
    */
   get(spaceKey: PublicKey): Space | undefined;
 
-  /**
-   * Returns the default space.
-   */
-  get default(): Space;
-
-  /**
-   * Resolves when the default space is available.
-   */
-  waitUntilReady(): Promise<void>;
-
   /**
    * Creates a new space.
    */
-  create(props?: Pick<SpaceProperties, 'name' | 'hue' | 'icon' | 'invocationTraceQueue'>): Promise<Space>;
+  create(
+    props?: Pick<SpaceProperties, 'name' | 'hue' | 'icon' | 'invocationTraceQueue'>,
+    options?: { tags?: string[]; membershipPolicy?: MembershipPolicy },
+  ): Promise<Space>;
 
   /**
    * Creates a space from the given archive.

package/src/service.ts

@@ -12,6 +12,7 @@ import type {
   InvitationsService,
   LoggingService,
   NetworkService,
+  QueueService,
   SpacesService,
   SystemService,
 } from '@dxos/protocols/proto/dxos/client/services';
@@ -23,6 +24,8 @@ import type { BridgeService } from '@dxos/protocols/proto/dxos/mesh/bridge';
 import type { TracingService } from '@dxos/protocols/proto/dxos/tracing';
 import { type ServiceBundle, createServiceBundle } from '@dxos/rpc';
 
+export type { QueueService } from '@dxos/protocols/proto/dxos/client/services';
+
 //
 // NOTE: Should contain client/proxy dependencies only.
 //
@@ -34,10 +37,13 @@ export type ClientServices = {
 
   IdentityService: IdentityService;
   InvitationsService: InvitationsService;
-  QueryService: QueryService;
   DevicesService: DevicesService;
   SpacesService: SpacesService;
+
   DataService: DataService;
+  QueryService: QueryService;
+  QueueService: QueueService;
+
   ContactsService: ContactsService;
   EdgeAgentService: EdgeAgentService;
 
@@ -56,12 +62,26 @@ export interface ClientServicesProvider {
    * This should fire if the services disconnect unexpectedly or during a client reset.
    */
   closed: Event<Error | undefined>;
+
+  /**
+   * The underlying service connection was re-established.
+   * Fires after all reconnection callbacks have completed.
+   */
+  reconnected?: Event<void>;
+
+  /**
+   * Register a callback to be invoked when services reconnect.
+   * The callback should re-establish any RPC streams.
+   * Reconnection waits for all callbacks to complete before emitting `reconnected`.
+   */
+  onReconnect?: (callback: () => Promise<void>) => void;
+
   descriptors: ServiceBundle<ClientServices>;
   services: Partial<ClientServices>;
 
   // TODO(burdon): Should take context from parent?
-  open(): Promise<void>;
-  close(): Promise<void>;
+  open(): Promise<unknown>;
+  close(): Promise<unknown>;
 }
 
 /**
@@ -80,6 +100,7 @@ export const clientServiceBundle = createServiceBundle<ClientServices>({
   DataService: schema.getService('dxos.echo.service.DataService'),
   ContactsService: schema.getService('dxos.client.services.ContactsService'),
   EdgeAgentService: schema.getService('dxos.client.services.EdgeAgentService'),
+  QueueService: schema.getService('dxos.client.services.QueueService'),
 
   // TODO(burdon): Deprecated.
   DevtoolsHost: schema.getService('dxos.devtools.host.DevtoolsHost'),

package/src/space.ts

@@ -6,7 +6,7 @@ import * as Schema from 'effect/Schema';
 
 import { type MulticastObservable } from '@dxos/async';
 import { type SpecificCredential } from '@dxos/credentials';
-import { type Obj } from '@dxos/echo';
+import { type Database, type Obj } from '@dxos/echo';
 import { type EchoDatabase, type QueueFactory, type SpaceSyncState } from '@dxos/echo-db';
 import { type PublicKey, type SpaceId } from '@dxos/keys';
 import { type Messenger } from '@dxos/protocols';
@@ -22,7 +22,7 @@ import {
 } from '@dxos/protocols/proto/dxos/client/services';
 import { type EdgeReplicationSetting } from '@dxos/protocols/proto/dxos/echo/metadata';
 import { type SpaceSnapshot } from '@dxos/protocols/proto/dxos/echo/snapshot';
-import { type Credential, type Epoch } from '@dxos/protocols/proto/dxos/halo/credentials';
+import { type Credential, type Epoch, type MembershipPolicy } from '@dxos/protocols/proto/dxos/halo/credentials';
 
 import { type CancellableInvitation } from './invitations';
 import { type SpaceProperties } from './types';
@@ -33,6 +33,7 @@ export type CreateEpochOptions = {
 };
 
 export interface SpaceInternal {
+  get db(): EchoDatabase;
   get data(): SpaceData;
 
   getCredentials(): Promise<Credential[]>;
@@ -82,7 +83,7 @@ export interface Space extends Messenger {
   /**
    * Echo database.
    */
-  get db(): EchoDatabase;
+  get db(): Database.Database;
 
   /**
    * Access to queues.
@@ -92,6 +93,18 @@ export interface Space extends Messenger {
   // TODO(burdon): Replace with state?
   get isOpen(): boolean;
 
+  /**
+   * Immutable tags assigned at space creation time.
+   * Available on closed spaces.
+   */
+  get tags(): string[];
+
+  /**
+   * Immutable membership policy assigned at space creation time.
+   * Available on closed spaces.
+   */
+  get membershipPolicy(): MembershipPolicy;
+
   /**
    * Current state of the space.
    * The database is ready to be used in `SpaceState.SPACE_READY` state.
@@ -102,7 +115,7 @@ export interface Space extends Messenger {
   /**
    * Properties object.
    */
-  get properties(): Obj.Obj<SpaceProperties>;
+  get properties(): Obj.OfShape<SpaceProperties>;
 
   /**
    * Current state of space pipeline.
@@ -116,7 +129,7 @@ export interface Space extends Messenger {
   /**
    * @deprecated
    */
-  // TODO(wittjosiah): Remove. This should not be exposed.
+  // TODO(wittjosiah): Audit and remove. This should not be exposed (or marked as internal).
   get internal(): SpaceInternal;
 
   /**

package/src/types/SpaceProperties.ts

@@ -4,7 +4,7 @@
 
 import * as Schema from 'effect/Schema';
 
-import { Annotation, Type } from '@dxos/echo';
+import { Annotation, Ref, Type } from '@dxos/echo';
 import { Queue } from '@dxos/echo-db';
 
 export const SpacePropertiesSchema = Schema.Struct(
@@ -14,8 +14,10 @@ export const SpacePropertiesSchema = Schema.Struct(
     //
 
     archived: Schema.optional(Schema.Boolean.annotations({ title: 'Archive Space' })),
-    edgeReplication: Schema.optional(Schema.Boolean), // TODO(burdon): Change to mode (no booleans?)
-    invocationTraceQueue: Schema.optional(Type.Ref(Queue)),
+    // TODO(burdon): Change to mode (no booleans?)
+    // TODO(wittjosiah): Make optional with default value.
+    edgeReplication: Schema.optional(Schema.Boolean),
+    invocationTraceQueue: Schema.optional(Ref.Ref(Queue)),
 
     //
     // User properties.
@@ -33,12 +35,22 @@ export const SpacePropertiesSchema = Schema.Struct(
 
 export type SpacePropertiesSchema = Schema.Schema.Type<typeof SpacePropertiesSchema>;
 
+/** @deprecated Use SpaceProperties instead. */
+export const LegacySpaceProperties = SpacePropertiesSchema.pipe(
+  Type.object({
+    typename: 'org.dxos.type.space-properties',
+    version: '0.1.0',
+  }),
+  Annotation.SystemTypeAnnotation.set(true),
+);
+
+export interface LegacySpaceProperties extends Schema.Schema.Type<typeof LegacySpaceProperties> {}
+
 // TODO(burdon): Pipe Schem.optional, or partial to entire struct to make everything optional?
 // TODO(burdon): Is separate schema def required for forms? Can it be extracted from SpaceProperties?
 export const SpaceProperties = SpacePropertiesSchema.pipe(
-  Type.Obj({
-    // TODO(burdon): Rename SpaceProperties.
-    typename: 'dxos.org/type/Properties',
+  Type.object({
+    typename: 'org.dxos.type.spaceProperties',
     version: '0.1.0',
   }),
   Annotation.SystemTypeAnnotation.set(true),

package/dist/lib/browser/chunk-6IJFMEF3.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/types/SpaceProperties.ts"],
-  "sourcesContent": ["//\n// Copyright 2024 DXOS.org\n//\n\nimport * as Schema from 'effect/Schema';\n\nimport { Annotation, Type } from '@dxos/echo';\nimport { Queue } from '@dxos/echo-db';\n\nexport const SpacePropertiesSchema = Schema.Struct(\n  {\n    //\n    // System properties.\n    //\n\n    archived: Schema.optional(Schema.Boolean.annotations({ title: 'Archive Space' })),\n    edgeReplication: Schema.optional(Schema.Boolean), // TODO(burdon): Change to mode (no booleans?)\n    invocationTraceQueue: Schema.optional(Type.Ref(Queue)),\n\n    //\n    // User properties.\n    //\n\n    name: Schema.optional(Schema.String),\n    icon: Schema.optional(Schema.String),\n    hue: Schema.optional(Schema.String),\n  },\n  {\n    key: Schema.String,\n    value: Schema.Any,\n  },\n);\n\nexport type SpacePropertiesSchema = Schema.Schema.Type<typeof SpacePropertiesSchema>;\n\n// TODO(burdon): Pipe Schem.optional, or partial to entire struct to make everything optional?\n// TODO(burdon): Is separate schema def required for forms? Can it be extracted from SpaceProperties?\nexport const SpaceProperties = SpacePropertiesSchema.pipe(\n  Type.Obj({\n    // TODO(burdon): Rename SpaceProperties.\n    typename: 'dxos.org/type/Properties',\n    version: '0.1.0',\n  }),\n  Annotation.SystemTypeAnnotation.set(true),\n);\n\nexport interface SpaceProperties extends Schema.Schema.Type<typeof SpaceProperties> {}\n"],
-  "mappings": ";AAIA,YAAYA,YAAY;AAExB,SAASC,YAAYC,YAAY;AACjC,SAASC,aAAa;AAEf,IAAMC,wBAA+BC,cAC1C;;;;EAKEC,UAAiBC,gBAAgBC,eAAQC,YAAY;IAAEC,OAAO;EAAgB,CAAA,CAAA;EAC9EC,iBAAwBJ,gBAAgBC,cAAO;EAC/CI,sBAA6BL,gBAASM,KAAKC,IAAIC,KAAAA,CAAAA;;;;EAM/CC,MAAaT,gBAAgBU,aAAM;EACnCC,MAAaX,gBAAgBU,aAAM;EACnCE,KAAYZ,gBAAgBU,aAAM;AACpC,GACA;EACEG,KAAYH;EACZI,OAAcC;AAChB,CAAA;AAOK,IAAMC,kBAAkBnB,sBAAsBoB,KACnDX,KAAKY,IAAI;;EAEPC,UAAU;EACVC,SAAS;AACX,CAAA,GACAC,WAAWC,qBAAqBC,IAAI,IAAA,CAAA;",
-  "names": ["Schema", "Annotation", "Type", "Queue", "SpacePropertiesSchema", "Struct", "archived", "optional", "Boolean", "annotations", "title", "edgeReplication", "invocationTraceQueue", "Type", "Ref", "Queue", "name", "String", "icon", "hue", "key", "value", "Any", "SpaceProperties", "pipe", "Obj", "typename", "version", "Annotation", "SystemTypeAnnotation", "set"]
-}

package/dist/lib/node-esm/chunk-WLB2RPCH.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/types/SpaceProperties.ts"],
-  "sourcesContent": ["//\n// Copyright 2024 DXOS.org\n//\n\nimport * as Schema from 'effect/Schema';\n\nimport { Annotation, Type } from '@dxos/echo';\nimport { Queue } from '@dxos/echo-db';\n\nexport const SpacePropertiesSchema = Schema.Struct(\n  {\n    //\n    // System properties.\n    //\n\n    archived: Schema.optional(Schema.Boolean.annotations({ title: 'Archive Space' })),\n    edgeReplication: Schema.optional(Schema.Boolean), // TODO(burdon): Change to mode (no booleans?)\n    invocationTraceQueue: Schema.optional(Type.Ref(Queue)),\n\n    //\n    // User properties.\n    //\n\n    name: Schema.optional(Schema.String),\n    icon: Schema.optional(Schema.String),\n    hue: Schema.optional(Schema.String),\n  },\n  {\n    key: Schema.String,\n    value: Schema.Any,\n  },\n);\n\nexport type SpacePropertiesSchema = Schema.Schema.Type<typeof SpacePropertiesSchema>;\n\n// TODO(burdon): Pipe Schem.optional, or partial to entire struct to make everything optional?\n// TODO(burdon): Is separate schema def required for forms? Can it be extracted from SpaceProperties?\nexport const SpaceProperties = SpacePropertiesSchema.pipe(\n  Type.Obj({\n    // TODO(burdon): Rename SpaceProperties.\n    typename: 'dxos.org/type/Properties',\n    version: '0.1.0',\n  }),\n  Annotation.SystemTypeAnnotation.set(true),\n);\n\nexport interface SpaceProperties extends Schema.Schema.Type<typeof SpaceProperties> {}\n"],
-  "mappings": ";;;AAIA,YAAYA,YAAY;AAExB,SAASC,YAAYC,YAAY;AACjC,SAASC,aAAa;AAEf,IAAMC,wBAA+BC,cAC1C;;;;EAKEC,UAAiBC,gBAAgBC,eAAQC,YAAY;IAAEC,OAAO;EAAgB,CAAA,CAAA;EAC9EC,iBAAwBJ,gBAAgBC,cAAO;EAC/CI,sBAA6BL,gBAASM,KAAKC,IAAIC,KAAAA,CAAAA;;;;EAM/CC,MAAaT,gBAAgBU,aAAM;EACnCC,MAAaX,gBAAgBU,aAAM;EACnCE,KAAYZ,gBAAgBU,aAAM;AACpC,GACA;EACEG,KAAYH;EACZI,OAAcC;AAChB,CAAA;AAOK,IAAMC,kBAAkBnB,sBAAsBoB,KACnDX,KAAKY,IAAI;;EAEPC,UAAU;EACVC,SAAS;AACX,CAAA,GACAC,WAAWC,qBAAqBC,IAAI,IAAA,CAAA;",
-  "names": ["Schema", "Annotation", "Type", "Queue", "SpacePropertiesSchema", "Struct", "archived", "optional", "Boolean", "annotations", "title", "edgeReplication", "invocationTraceQueue", "Type", "Ref", "Queue", "name", "String", "icon", "hue", "key", "value", "Any", "SpaceProperties", "pipe", "Obj", "typename", "version", "Annotation", "SystemTypeAnnotation", "set"]
-}