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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/client-protocol",
-  "version": "0.8.4-main.d05539e30a",
+  "version": "0.8.4-main.d9fc60f731",
   "description": "Core DXOS Client API.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -33,20 +33,19 @@
   ],
   "dependencies": {
     "base-x": "~3.0.11",
-    "effect": "3.20.0",
-    "@dxos/async": "0.8.4-main.d05539e30a",
-    "@dxos/context": "0.8.4-main.d05539e30a",
-    "@dxos/echo-db": "0.8.4-main.d05539e30a",
-    "@dxos/credentials": "0.8.4-main.d05539e30a",
-    "@dxos/invariant": "0.8.4-main.d05539e30a",
-    "@dxos/keys": "0.8.4-main.d05539e30a",
-    "@dxos/echo": "0.8.4-main.d05539e30a",
-    "@dxos/node-std": "0.8.4-main.d05539e30a",
-    "@dxos/rpc": "0.8.4-main.d05539e30a",
-    "@dxos/protocols": "0.8.4-main.d05539e30a"
+    "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.20.0"
+    "effect": "3.21.2"
   },
   "publishConfig": {
     "access": "public"

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

@@ -154,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,7 +4,7 @@
 
 import * as Schema from 'effect/Schema';
 
-import { Annotation, Feed, Ref, Type } from '@dxos/echo';
+import { Annotation, DXN, Feed, Ref, Type } from '@dxos/echo';
 
 /**
  * Where do triggers get executed.
@@ -12,65 +12,46 @@ import { Annotation, Feed, Ref, Type } from '@dxos/echo';
 export const ComputeEnvironment = Schema.Literal('disabled', 'local', 'edge');
 export type ComputeEnvironment = Schema.Schema.Type<typeof ComputeEnvironment>;
 
-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),
-
-    /**
-     * @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),
-    icon: Schema.optional(Schema.String),
-    hue: Schema.optional(Schema.String),
-  },
-  {
-    key: Schema.String,
-    value: Schema.Any,
-  },
-);
+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>;
 
-/** @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.object({
-    typename: 'org.dxos.type.spaceProperties',
-    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-GCBXMPTW.mjs

@@ -1,51 +0,0 @@
-// src/types/SpaceProperties.ts
-import * as Schema from "effect/Schema";
-import { Annotation, Feed, Ref, Type } from "@dxos/echo";
-var ComputeEnvironment = Schema.Literal("disabled", "local", "edge");
-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),
-  /**
-   * @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),
-  icon: Schema.optional(Schema.String),
-  hue: Schema.optional(Schema.String)
-}, {
-  key: Schema.String,
-  value: Schema.Any
-});
-var LegacySpaceProperties = SpacePropertiesSchema.pipe(Type.object({
-  typename: "org.dxos.type.space-properties",
-  version: "0.1.0"
-}), Annotation.SystemTypeAnnotation.set(true));
-var SpaceProperties = SpacePropertiesSchema.pipe(Type.object({
-  typename: "org.dxos.type.spaceProperties",
-  version: "0.1.0"
-}), Annotation.SystemTypeAnnotation.set(true));
-
-export {
-  ComputeEnvironment,
-  SpacePropertiesSchema,
-  LegacySpaceProperties,
-  SpaceProperties
-};
-//# sourceMappingURL=chunk-GCBXMPTW.mjs.map

package/dist/lib/browser/chunk-GCBXMPTW.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, Feed, Ref, Type } from '@dxos/echo';\n\n/**\n * Where do triggers get executed.\n */\nexport const ComputeEnvironment = Schema.Literal('disabled', 'local', 'edge');\nexport type ComputeEnvironment = Schema.Schema.Type<typeof ComputeEnvironment>;\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\n    /**\n     * @deprecated\n     */\n    invocationTraceFeed: Schema.optional(Ref.Ref(Feed.Feed)),\n\n    /**\n     * Preference for trigger execution.\n     * *disabled* - triggers do not run locally or on EDGE.\n     * *local* - triggers are executed locally on the client, edge is not running triggers.\n     * *edge* - triggers are executed on the edge, triggers are not run locally.\n     */\n    computeEnvironment: Schema.optional(ComputeEnvironment),\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/** @deprecated Use SpaceProperties instead. */\nexport const LegacySpaceProperties = 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 LegacySpaceProperties extends Schema.Schema.Type<typeof LegacySpaceProperties> {}\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.spaceProperties',\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,MAAMC,KAAKC,YAAY;AAKrC,IAAMC,qBAA4BC,eAAQ,YAAY,SAAS,MAAA;AAG/D,IAAMC,wBAA+BC,cAC1C;;;;EAKEC,UAAiBC,gBAAgBC,eAAQC,YAAY;IAAEC,OAAO;EAAgB,CAAA,CAAA;;;EAG9EC,iBAAwBJ,gBAAgBC,cAAO;;;;EAK/CI,qBAA4BL,gBAASP,IAAIA,IAAID,KAAKA,IAAI,CAAA;;;;;;;EAQtDc,oBAA2BN,gBAASL,kBAAAA;;;;EAMpCY,MAAaP,gBAAgBQ,aAAM;EACnCC,MAAaT,gBAAgBQ,aAAM;EACnCE,KAAYV,gBAAgBQ,aAAM;AACpC,GACA;EACEG,KAAYH;EACZI,OAAcC;AAChB,CAAA;AAMK,IAAMC,wBAAwBjB,sBAAsBkB,KACzDrB,KAAKsB,OAAO;EACVC,UAAU;EACVC,SAAS;AACX,CAAA,GACA3B,WAAW4B,qBAAqBC,IAAI,IAAA,CAAA;AAO/B,IAAMC,kBAAkBxB,sBAAsBkB,KACnDrB,KAAKsB,OAAO;EACVC,UAAU;EACVC,SAAS;AACX,CAAA,GACA3B,WAAW4B,qBAAqBC,IAAI,IAAA,CAAA;",
-  "names": ["Schema", "Annotation", "Feed", "Ref", "Type", "ComputeEnvironment", "Literal", "SpacePropertiesSchema", "Struct", "archived", "optional", "Boolean", "annotations", "title", "edgeReplication", "invocationTraceFeed", "computeEnvironment", "name", "String", "icon", "hue", "key", "value", "Any", "LegacySpaceProperties", "pipe", "object", "typename", "version", "SystemTypeAnnotation", "set", "SpaceProperties"]
-}

package/dist/lib/node-esm/chunk-2RN4CLEW.mjs

@@ -1,53 +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, Feed, Ref, Type } from "@dxos/echo";
-var ComputeEnvironment = Schema.Literal("disabled", "local", "edge");
-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),
-  /**
-   * @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),
-  icon: Schema.optional(Schema.String),
-  hue: Schema.optional(Schema.String)
-}, {
-  key: Schema.String,
-  value: Schema.Any
-});
-var LegacySpaceProperties = SpacePropertiesSchema.pipe(Type.object({
-  typename: "org.dxos.type.space-properties",
-  version: "0.1.0"
-}), Annotation.SystemTypeAnnotation.set(true));
-var SpaceProperties = SpacePropertiesSchema.pipe(Type.object({
-  typename: "org.dxos.type.spaceProperties",
-  version: "0.1.0"
-}), Annotation.SystemTypeAnnotation.set(true));
-
-export {
-  ComputeEnvironment,
-  SpacePropertiesSchema,
-  LegacySpaceProperties,
-  SpaceProperties
-};
-//# sourceMappingURL=chunk-2RN4CLEW.mjs.map

package/dist/lib/node-esm/chunk-2RN4CLEW.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, Feed, Ref, Type } from '@dxos/echo';\n\n/**\n * Where do triggers get executed.\n */\nexport const ComputeEnvironment = Schema.Literal('disabled', 'local', 'edge');\nexport type ComputeEnvironment = Schema.Schema.Type<typeof ComputeEnvironment>;\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\n    /**\n     * @deprecated\n     */\n    invocationTraceFeed: Schema.optional(Ref.Ref(Feed.Feed)),\n\n    /**\n     * Preference for trigger execution.\n     * *disabled* - triggers do not run locally or on EDGE.\n     * *local* - triggers are executed locally on the client, edge is not running triggers.\n     * *edge* - triggers are executed on the edge, triggers are not run locally.\n     */\n    computeEnvironment: Schema.optional(ComputeEnvironment),\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/** @deprecated Use SpaceProperties instead. */\nexport const LegacySpaceProperties = 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 LegacySpaceProperties extends Schema.Schema.Type<typeof LegacySpaceProperties> {}\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.spaceProperties',\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,MAAMC,KAAKC,YAAY;AAKrC,IAAMC,qBAA4BC,eAAQ,YAAY,SAAS,MAAA;AAG/D,IAAMC,wBAA+BC,cAC1C;;;;EAKEC,UAAiBC,gBAAgBC,eAAQC,YAAY;IAAEC,OAAO;EAAgB,CAAA,CAAA;;;EAG9EC,iBAAwBJ,gBAAgBC,cAAO;;;;EAK/CI,qBAA4BL,gBAASP,IAAIA,IAAID,KAAKA,IAAI,CAAA;;;;;;;EAQtDc,oBAA2BN,gBAASL,kBAAAA;;;;EAMpCY,MAAaP,gBAAgBQ,aAAM;EACnCC,MAAaT,gBAAgBQ,aAAM;EACnCE,KAAYV,gBAAgBQ,aAAM;AACpC,GACA;EACEG,KAAYH;EACZI,OAAcC;AAChB,CAAA;AAMK,IAAMC,wBAAwBjB,sBAAsBkB,KACzDrB,KAAKsB,OAAO;EACVC,UAAU;EACVC,SAAS;AACX,CAAA,GACA3B,WAAW4B,qBAAqBC,IAAI,IAAA,CAAA;AAO/B,IAAMC,kBAAkBxB,sBAAsBkB,KACnDrB,KAAKsB,OAAO;EACVC,UAAU;EACVC,SAAS;AACX,CAAA,GACA3B,WAAW4B,qBAAqBC,IAAI,IAAA,CAAA;",
-  "names": ["Schema", "Annotation", "Feed", "Ref", "Type", "ComputeEnvironment", "Literal", "SpacePropertiesSchema", "Struct", "archived", "optional", "Boolean", "annotations", "title", "edgeReplication", "invocationTraceFeed", "computeEnvironment", "name", "String", "icon", "hue", "key", "value", "Any", "LegacySpaceProperties", "pipe", "object", "typename", "version", "SystemTypeAnnotation", "set", "SpaceProperties"]
-}