@dxos/client-protocol 0.8.4-main.d05673bc65 → 0.8.4-main.d9fc60f731

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/client-protocol",
-  "version": "0.8.4-main.d05673bc65",
+  "version": "0.8.4-main.d9fc60f731",
   "description": "Core DXOS Client API.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -8,7 +8,7 @@
     "type": "git",
     "url": "https://github.com/dxos/dxos"
   },
-  "license": "MIT",
+  "license": "FSL-1.1-Apache-2.0",
   "author": "DXOS.org",
   "sideEffects": false,
   "type": "module",
@@ -27,33 +27,25 @@
     }
   },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "./types": [
-        "./dist/types/src/types/index.d.ts"
-      ]
-    }
-  },
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
     "base-x": "~3.0.11",
-    "effect": "3.19.16",
-    "@dxos/context": "0.8.4-main.d05673bc65",
-    "@dxos/credentials": "0.8.4-main.d05673bc65",
-    "@dxos/echo": "0.8.4-main.d05673bc65",
-    "@dxos/echo-db": "0.8.4-main.d05673bc65",
-    "@dxos/invariant": "0.8.4-main.d05673bc65",
-    "@dxos/keys": "0.8.4-main.d05673bc65",
-    "@dxos/node-std": "0.8.4-main.d05673bc65",
-    "@dxos/protocols": "0.8.4-main.d05673bc65",
-    "@dxos/rpc": "0.8.4-main.d05673bc65",
-    "@dxos/async": "0.8.4-main.d05673bc65"
+    "effect": "3.21.2",
+    "@dxos/credentials": "0.8.4-main.d9fc60f731",
+    "@dxos/async": "0.8.4-main.d9fc60f731",
+    "@dxos/echo": "0.8.4-main.d9fc60f731",
+    "@dxos/echo-db": "0.8.4-main.d9fc60f731",
+    "@dxos/keys": "0.8.4-main.d9fc60f731",
+    "@dxos/invariant": "0.8.4-main.d9fc60f731",
+    "@dxos/node-std": "0.8.4-main.d9fc60f731",
+    "@dxos/protocols": "0.8.4-main.d9fc60f731",
+    "@dxos/rpc": "0.8.4-main.d9fc60f731"
   },
   "peerDependencies": {
-    "effect": "3.19.16"
+    "effect": "3.21.2"
   },
   "publishConfig": {
     "access": "public"

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,25 +33,18 @@ 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' | 'invocationTraceFeed'>,
+    options?: { tags?: string[]; membershipPolicy?: MembershipPolicy },
+  ): Promise<Space>;
 
   /**
    * Creates a space from the given archive.
    */
-  import(archive: SpaceArchive): Promise<Space>;
+  import(archive: SpaceArchive, options?: { tags?: string[] }): Promise<Space>;
 
   /**
    * Joins an existing space using the given invitation.

package/src/invitations/encoder.test.ts

@@ -58,4 +58,20 @@ describe('Invitation utils', () => {
     expect(decoded.identityKey).to.not.exist;
     expect(decoded).to.deep.eq(invitation);
   });
+
+  test('encodes and decodes a device invitation', () => {
+    const invitation: Invitation = {
+      invitationId: PublicKey.random().toHex(),
+      type: Invitation.Type.INTERACTIVE,
+      kind: Invitation.Kind.DEVICE,
+      authMethod: Invitation.AuthMethod.NONE,
+      state: Invitation.State.INIT,
+      swarmKey: PublicKey.random(),
+      created: CREATED,
+      lifetime: 86400,
+    };
+    const encoded = InvitationEncoder.encode(invitation);
+    const decoded = InvitationEncoder.decode(encoded);
+    expect(decoded).to.deep.eq(invitation);
+  });
 });

package/src/service.ts

@@ -21,7 +21,6 @@ import type { QueryService } from '@dxos/protocols/proto/dxos/echo/query';
 import type { DataService } from '@dxos/protocols/proto/dxos/echo/service';
 import type { AppService, ShellService, WorkerService } from '@dxos/protocols/proto/dxos/iframe';
 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';
@@ -49,8 +48,6 @@ export type ClientServices = {
 
   // TODO(burdon): Deprecated.
   DevtoolsHost: DevtoolsHost;
-
-  TracingService: TracingService;
 };
 
 /**
@@ -104,7 +101,6 @@ export const clientServiceBundle = createServiceBundle<ClientServices>({
 
   // TODO(burdon): Deprecated.
   DevtoolsHost: schema.getService('dxos.devtools.host.DevtoolsHost'),
-  TracingService: schema.getService('dxos.tracing.TracingService'),
 });
 
 export type IframeServiceBundle = {

package/src/space.ts

@@ -14,7 +14,7 @@ import {
   type Contact,
   type CreateEpochRequest,
   type Invitation,
-  type SpaceArchive,
+  SpaceArchive,
   type Space as SpaceData,
   type SpaceMember,
   type SpaceState,
@@ -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';
@@ -32,6 +32,14 @@ export type CreateEpochOptions = {
   automergeRootUrl?: string;
 };
 
+export type ExportSpaceOptions = {
+  /**
+   * Archive format.
+   * @default SpaceArchive.Format.BINARY
+   */
+  format?: SpaceArchive.Format;
+};
+
 export interface SpaceInternal {
   get db(): EchoDatabase;
   get data(): SpaceData;
@@ -46,7 +54,7 @@ export interface SpaceInternal {
   // TOOD(burdon): Start to factor out credentials.
   removeMember(memberKey: PublicKey): Promise<void>;
 
-  export(): Promise<SpaceArchive>;
+  export(options?: ExportSpaceOptions): Promise<SpaceArchive>;
 
   /**
    * Migrate space data to the latest version.
@@ -93,6 +101,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.
@@ -134,6 +154,13 @@ export interface Space extends Messenger {
    */
   close(): Promise<void>;
 
+  /**
+   * Tombstones (soft-deletes) the space and replicates the deletion to the user's other devices.
+   * Every device stops replicating and unloads the space. Underlying data is not removed until
+   * garbage collection (future work). This is terminal: the space cannot be re-opened via {@link open}.
+   */
+  delete(): Promise<void>;
+
   /**
    * Waits until the space is in the ready state, with database initialized.
    */

package/src/types/SpaceProperties.ts

@@ -4,45 +4,54 @@
 
 import * as Schema from 'effect/Schema';
 
-import { Annotation, Ref, Type } from '@dxos/echo';
-import { Queue } from '@dxos/echo-db';
-
-export const SpacePropertiesSchema = Schema.Struct(
-  {
-    //
-    // System properties.
-    //
-
-    archived: Schema.optional(Schema.Boolean.annotations({ title: 'Archive Space' })),
-    // 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.
-    //
-
-    name: Schema.optional(Schema.String),
-    icon: Schema.optional(Schema.String),
-    hue: Schema.optional(Schema.String),
-  },
-  {
-    key: Schema.String,
-    value: Schema.Any,
-  },
-);
+import { Annotation, DXN, Feed, Ref, Type } from '@dxos/echo';
+
+/**
+ * Where do triggers get executed.
+ */
+export const ComputeEnvironment = Schema.Literal('disabled', 'local', 'edge');
+export type ComputeEnvironment = Schema.Schema.Type<typeof ComputeEnvironment>;
+
+export const SpacePropertiesSchema = Schema.Struct({
+  //
+  // System properties.
+  //
+
+  // TODO(burdon): Change to mode (no booleans?)
+  // TODO(wittjosiah): Make optional with default value.
+  edgeReplication: Schema.optional(Schema.Boolean),
+
+  /**
+   * @deprecated
+   */
+  invocationTraceFeed: Schema.optional(Ref.Ref(Feed.Feed)),
+
+  /**
+   * Preference for trigger execution.
+   * *disabled* - triggers do not run locally or on EDGE.
+   * *local* - triggers are executed locally on the client, edge is not running triggers.
+   * *edge* - triggers are executed on the edge, triggers are not run locally.
+   */
+  computeEnvironment: Schema.optional(ComputeEnvironment),
+
+  //
+  // User properties.
+  //
+
+  name: Schema.optional(Schema.String),
+  description: Schema.optional(Schema.String),
+  icon: Schema.optional(Schema.String),
+  iconHue: Schema.optional(Schema.String),
+  hue: Schema.optional(Schema.String),
+});
 
 export type SpacePropertiesSchema = Schema.Schema.Type<typeof SpacePropertiesSchema>;
 
 // 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.object({
-    typename: 'org.dxos.type.space-properties',
-    version: '0.1.0',
-  }),
-  Annotation.SystemTypeAnnotation.set(true),
+  Annotation.HiddenAnnotation.set(true),
+  Type.makeObject(DXN.make('org.dxos.type.spaceProperties', '0.1.0')),
 );
 
-export interface SpaceProperties extends Schema.Schema.Type<typeof SpaceProperties> {}
+export type SpaceProperties = Type.InstanceType<typeof SpaceProperties>;

package/dist/lib/browser/chunk-HQBTSFTW.mjs

@@ -1,35 +0,0 @@
-// src/types/SpaceProperties.ts
-import * as Schema from "effect/Schema";
-import { Annotation, Ref, Type } from "@dxos/echo";
-import { Queue } from "@dxos/echo-db";
-var SpacePropertiesSchema = Schema.Struct({
-  //
-  // System properties.
-  //
-  archived: Schema.optional(Schema.Boolean.annotations({
-    title: "Archive Space"
-  })),
-  // 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.
-  //
-  name: Schema.optional(Schema.String),
-  icon: Schema.optional(Schema.String),
-  hue: Schema.optional(Schema.String)
-}, {
-  key: Schema.String,
-  value: Schema.Any
-});
-var SpaceProperties = SpacePropertiesSchema.pipe(Type.object({
-  typename: "org.dxos.type.space-properties",
-  version: "0.1.0"
-}), Annotation.SystemTypeAnnotation.set(true));
-
-export {
-  SpacePropertiesSchema,
-  SpaceProperties
-};
-//# sourceMappingURL=chunk-HQBTSFTW.mjs.map

package/dist/lib/browser/chunk-HQBTSFTW.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, Ref, 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    // TODO(burdon): Change to mode (no booleans?)\n    // TODO(wittjosiah): Make optional with default value.\n    edgeReplication: Schema.optional(Schema.Boolean),\n    invocationTraceQueue: Schema.optional(Ref.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.object({\n    typename: 'org.dxos.type.space-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,KAAKC,YAAY;AACtC,SAASC,aAAa;AAEf,IAAMC,wBAA+BC,cAC1C;;;;EAKEC,UAAiBC,gBAAgBC,eAAQC,YAAY;IAAEC,OAAO;EAAgB,CAAA,CAAA;;;EAG9EC,iBAAwBJ,gBAAgBC,cAAO;EAC/CI,sBAA6BL,gBAASM,IAAIA,IAAIC,KAAAA,CAAAA;;;;EAM9CC,MAAaR,gBAAgBS,aAAM;EACnCC,MAAaV,gBAAgBS,aAAM;EACnCE,KAAYX,gBAAgBS,aAAM;AACpC,GACA;EACEG,KAAYH;EACZI,OAAcC;AAChB,CAAA;AAOK,IAAMC,kBAAkBlB,sBAAsBmB,KACnDC,KAAKC,OAAO;EACVC,UAAU;EACVC,SAAS;AACX,CAAA,GACAC,WAAWC,qBAAqBC,IAAI,IAAA,CAAA;",
-  "names": ["Schema", "Annotation", "Ref", "Type", "Queue", "SpacePropertiesSchema", "Struct", "archived", "optional", "Boolean", "annotations", "title", "edgeReplication", "invocationTraceQueue", "Ref", "Queue", "name", "String", "icon", "hue", "key", "value", "Any", "SpaceProperties", "pipe", "Type", "object", "typename", "version", "Annotation", "SystemTypeAnnotation", "set"]
-}

package/dist/lib/node-esm/chunk-URWCZ2QB.mjs

@@ -1,37 +0,0 @@
-import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
-
-// src/types/SpaceProperties.ts
-import * as Schema from "effect/Schema";
-import { Annotation, Ref, Type } from "@dxos/echo";
-import { Queue } from "@dxos/echo-db";
-var SpacePropertiesSchema = Schema.Struct({
-  //
-  // System properties.
-  //
-  archived: Schema.optional(Schema.Boolean.annotations({
-    title: "Archive Space"
-  })),
-  // 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.
-  //
-  name: Schema.optional(Schema.String),
-  icon: Schema.optional(Schema.String),
-  hue: Schema.optional(Schema.String)
-}, {
-  key: Schema.String,
-  value: Schema.Any
-});
-var SpaceProperties = SpacePropertiesSchema.pipe(Type.object({
-  typename: "org.dxos.type.space-properties",
-  version: "0.1.0"
-}), Annotation.SystemTypeAnnotation.set(true));
-
-export {
-  SpacePropertiesSchema,
-  SpaceProperties
-};
-//# sourceMappingURL=chunk-URWCZ2QB.mjs.map

package/dist/lib/node-esm/chunk-URWCZ2QB.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, Ref, 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    // TODO(burdon): Change to mode (no booleans?)\n    // TODO(wittjosiah): Make optional with default value.\n    edgeReplication: Schema.optional(Schema.Boolean),\n    invocationTraceQueue: Schema.optional(Ref.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.object({\n    typename: 'org.dxos.type.space-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,KAAKC,YAAY;AACtC,SAASC,aAAa;AAEf,IAAMC,wBAA+BC,cAC1C;;;;EAKEC,UAAiBC,gBAAgBC,eAAQC,YAAY;IAAEC,OAAO;EAAgB,CAAA,CAAA;;;EAG9EC,iBAAwBJ,gBAAgBC,cAAO;EAC/CI,sBAA6BL,gBAASM,IAAIA,IAAIC,KAAAA,CAAAA;;;;EAM9CC,MAAaR,gBAAgBS,aAAM;EACnCC,MAAaV,gBAAgBS,aAAM;EACnCE,KAAYX,gBAAgBS,aAAM;AACpC,GACA;EACEG,KAAYH;EACZI,OAAcC;AAChB,CAAA;AAOK,IAAMC,kBAAkBlB,sBAAsBmB,KACnDC,KAAKC,OAAO;EACVC,UAAU;EACVC,SAAS;AACX,CAAA,GACAC,WAAWC,qBAAqBC,IAAI,IAAA,CAAA;",
-  "names": ["Schema", "Annotation", "Ref", "Type", "Queue", "SpacePropertiesSchema", "Struct", "archived", "optional", "Boolean", "annotations", "title", "edgeReplication", "invocationTraceQueue", "Ref", "Queue", "name", "String", "icon", "hue", "key", "value", "Any", "SpaceProperties", "pipe", "Type", "object", "typename", "version", "Annotation", "SystemTypeAnnotation", "set"]
-}