@dxos/protocols 0.8.4-staging.ac66bdf99f → 0.9.1-main.c7dcc2e112

package/src/lexicons/org.dxos.experimental/package.profile.json

@@ -0,0 +1,87 @@
+{
+  "lexicon": 1,
+  "id": "org.dxos.experimental.package.profile",
+  "defs": {
+    "main": {
+      "type": "record",
+      "key": "literal:key",
+      "description": "Mutable metadata for a discoverable plugin/module published on the DXOS experimental registry. The rkey is the plugin key (reverse-domain NSID, e.g. org.dxos.plugin.excalidraw). Companion org.dxos.experimental.package.release records carry versioned artifacts.",
+      "record": {
+        "type": "object",
+        "required": ["key", "name", "createdAt"],
+        "properties": {
+          "key": {
+            "type": "string",
+            "description": "Reverse-domain NSID — the plugin's globally-unique key and the profile rkey (e.g. org.dxos.plugin.excalidraw).",
+            "maxLength": 63,
+            "minLength": 1
+          },
+          "name": {
+            "type": "string",
+            "description": "Human-readable display name.",
+            "maxLength": 128
+          },
+          "description": {
+            "type": "string",
+            "description": "Short description shown in registry listings.",
+            "maxLength": 512
+          },
+          "homePage": {
+            "type": "string",
+            "format": "uri",
+            "description": "Optional canonical homepage."
+          },
+          "source": {
+            "type": "string",
+            "format": "uri",
+            "description": "Optional public source repository URL."
+          },
+          "tags": {
+            "type": "array",
+            "description": "Optional discovery tags.",
+            "maxLength": 16,
+            "items": { "type": "string", "maxLength": 32 }
+          },
+          "screenshots": {
+            "type": "array",
+            "description": "Optional preview images. Each item has optional light/dark theme URLs.",
+            "maxLength": 8,
+            "items": {
+              "type": "object",
+              "properties": {
+                "light": { "type": "string", "format": "uri" },
+                "dark": { "type": "string", "format": "uri" }
+              }
+            }
+          },
+          "icon": {
+            "type": "object",
+            "description": "Optional icon reference: Phosphor icon key with an optional theme hue.",
+            "required": ["key"],
+            "properties": {
+              "key": {
+                "type": "string",
+                "description": "Phosphor icon name (e.g. ph--compass-tool--regular).",
+                "maxLength": 64
+              },
+              "hue": { "type": "string", "description": "Theme hue hint (e.g. blue, amber).", "maxLength": 32 }
+            }
+          },
+          "dependsOn": {
+            "type": "array",
+            "description": "Optional list of plugin NSIDs this plugin depends on at runtime.",
+            "items": { "type": "string" }
+          },
+          "spec": {
+            "type": "string",
+            "description": "Optional relative path inside the package to a bundled MDL spec."
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "datetime"
+          }
+        }
+      }
+    }
+  }
+}

package/src/lexicons/org.dxos.experimental/package.release.json

@@ -0,0 +1,45 @@
+{
+  "lexicon": 1,
+  "id": "org.dxos.experimental.package.release",
+  "defs": {
+    "main": {
+      "type": "record",
+      "key": "any",
+      "description": "Release record for a versioned artifact of an org.dxos.experimental.package.profile. Conventionally keyed as '<key>:<version>'. One record per version; conceptually single-write (a new version is a new record), though the author retains write access — integrity is anchored by manifestHash rather than enforced immutability.",
+      "record": {
+        "type": "object",
+        "required": ["package", "version", "moduleUrl", "createdAt"],
+        "properties": {
+          "package": {
+            "type": "string",
+            "description": "Key of the parent package.profile record authored by the same DID.",
+            "maxLength": 63
+          },
+          "version": {
+            "type": "string",
+            "description": "Semver subset without build metadata. Pre-release suffixes allowed (e.g. 1.2.3-rc.1).",
+            "maxLength": 32
+          },
+          "moduleUrl": {
+            "type": "string",
+            "format": "uri",
+            "description": "HTTPS URL of the module entrypoint (or manifest.json). v0 trusts the publisher; content addressing is a follow-on."
+          },
+          "manifestHash": {
+            "type": "string",
+            "description": "Multibase-encoded multihash of the module manifest. SHA2-256 with base58btc multibase prefix is preferred (e.g. 'zQm...' — 47 chars). The registry indexer MAY fetch the manifest and verify the hash at index time.",
+            "maxLength": 128
+          },
+          "dependencies": {
+            "type": "unknown",
+            "description": "Optional snapshot of the plugin's declared dependencies resolved to concrete installed versions at build time ({ name: version }). The app-view / Composer derive SDK compatibility from the shared (externalized @dxos/*) subset. Typed 'unknown' because Lexicon has no string-keyed map primitive; the canonical shape is a Record<string,string> enforced by the registry validator."
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "datetime"
+          }
+        }
+      }
+    }
+  }
+}

package/src/lexicons/org.dxos.experimental/publisher.profile.json

@@ -0,0 +1,37 @@
+{
+  "lexicon": 1,
+  "id": "org.dxos.experimental.publisher.profile",
+  "defs": {
+    "main": {
+      "type": "record",
+      "key": "literal:self",
+      "description": "Identity-level metadata about a registry publisher. One record per DID, rkey = 'self'.",
+      "record": {
+        "type": "object",
+        "required": ["displayName"],
+        "properties": {
+          "displayName": {
+            "type": "string",
+            "description": "Human-readable name shown alongside the publisher's packages.",
+            "maxLength": 128
+          },
+          "bio": {
+            "type": "string",
+            "description": "Optional short description.",
+            "maxLength": 512
+          },
+          "homepageUrl": {
+            "type": "string",
+            "format": "uri",
+            "description": "Optional canonical homepage."
+          },
+          "contact": {
+            "type": "string",
+            "description": "Optional contact channel (email, handle, etc.).",
+            "maxLength": 256
+          }
+        }
+      }
+    }
+  }
+}

package/src/lexicons/org.dxos.experimental/publisher.verification.json

@@ -0,0 +1,36 @@
+{
+  "lexicon": 1,
+  "id": "org.dxos.experimental.publisher.verification",
+  "defs": {
+    "main": {
+      "type": "record",
+      "key": "any",
+      "description": "Trust attestation issued by a curator DID about a verified publisher. The rkey MUST equal the verified publisher DID (enforced by the registry indexer — records where rkey ≠ subject are rejected). Records authored by anyone other than the configured curator DID are also ignored.",
+      "record": {
+        "type": "object",
+        "required": ["subject", "handle", "displayName", "createdAt"],
+        "properties": {
+          "subject": {
+            "type": "string",
+            "format": "did",
+            "description": "DID of the verified publisher. Must match the rkey for tamper resistance."
+          },
+          "handle": {
+            "type": "string",
+            "format": "handle",
+            "description": "Publisher's atproto handle at the time of verification. Re-issued on handle change."
+          },
+          "displayName": {
+            "type": "string",
+            "description": "Display name bound by this verification.",
+            "maxLength": 128
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "datetime"
+          }
+        }
+      }
+    }
+  }
+}

package/src/profile-archive.ts

@@ -8,17 +8,30 @@
 export type ProfileArchive = {
   meta: {
     timestamp: string;
+    /** Host (e.g. `main.composer.space`, `localhost:5173`) where the archive was exported. */
+    origin?: string;
   };
   storage: ProfileArchiveEntry[];
 };
 
 export type ProfileArchiveEntry = {
   type: ProfileArchiveEntryType;
+  /**
+   * FILE: filename in random-access storage.
+   * KEY_VALUE: binary LevelDB key.
+   * SQLITE_DATABASE: OPFS database filename (e.g. `DXOS`).
+   */
   key: string | Uint8Array;
+  /**
+   * FILE / KEY_VALUE / SQLITE_DATABASE: binary payload.
+   * SQLITE_DATABASE must be a valid SQLite file (magic `SQLite format 3`).
+   */
   value: string | Uint8Array;
 };
 
 export enum ProfileArchiveEntryType {
   FILE = 1,
   KEY_VALUE = 2,
+  /** OPFS-hosted SQLite database; `key` is the OPFS filename, `value` is raw SQLite bytes. */
+  SQLITE_DATABASE = 3,
 }

package/src/proto/dxos/client/invitation.proto

@@ -43,6 +43,9 @@ enum SpaceState {
   /// Space is active. Swarming and replication will be done.
   SPACE_ACTIVE = 6;
 
+  /// Space is tombstoned (soft-deleted). Replicated to other devices; never auto-opened.
+  SPACE_DELETED = 9;
+
   ///
   /// Runtime states:
   ///
@@ -85,8 +88,12 @@ message Invitation {
   }
 
   enum Kind {
-    DEVICE = 0;
-    SPACE = 1;
+    /// Unset / unknown. Must not be used for new invitations.
+    INVALID = 0;
+
+    DEVICE = 1;
+
+    SPACE = 2;
   }
 
   enum AuthMethod {

package/src/proto/dxos/client/queue.proto

@@ -73,9 +73,30 @@ message SyncQueueRequest {
   optional bool should_pull = 5;
 }
 
+message GetSyncStateRequest {
+  string space_id = 1;
+  /// If empty, returns state for all namespaces synced by the client.
+  repeated string namespaces = 2;
+}
+
+message QueueNamespaceSyncState {
+  string namespace = 1;
+  /// Blocks still to pull from remote. 0 when caught up.
+  int64 blocks_to_pull = 2;
+  /// Unpositioned blocks still to push to remote. 0 when caught up.
+  int64 blocks_to_push = 3;
+  /// Total blocks stored locally for this namespace in the space.
+  int64 total_blocks = 4;
+}
+
+message GetSyncStateResponse {
+  repeated QueueNamespaceSyncState namespaces = 1;
+}
+
 service QueueService {
   rpc QueryQueue(QueryQueueRequest) returns (QueueQueryResult);
   rpc InsertIntoQueue(InsertIntoQueueRequest) returns (google.protobuf.Empty);
   rpc DeleteFromQueue(DeleteFromQueueRequest) returns (google.protobuf.Empty);
   rpc SyncQueue(SyncQueueRequest) returns (google.protobuf.Empty);
+  rpc GetSyncState(GetSyncStateRequest) returns (GetSyncStateResponse);
 }

package/src/proto/dxos/client/services.proto

@@ -146,6 +146,8 @@ message RecoverIdentityRequest {
     string recovery_code = 1;
     ExternalSignature external = 2;
     string token = 3;
+    /// One-time proof minted by edge kms-service after a successful OAuth recovery flow.
+    string recovery_proof = 4;
   }
 }
 
@@ -467,6 +469,8 @@ message ExportSpaceResponse {
 
 message ImportSpaceRequest {
   SpaceArchive archive = 1;
+  /// Immutable tags to set on the imported space at creation time.
+  repeated string tags = 2;
 }
 
 message ImportSpaceResponse {

package/src/proto/dxos/config.proto

@@ -145,6 +145,8 @@ message Runtime {
     message EdgeFeatures {
       optional bool feed_replicator = 1;
       optional bool echo_replicator = 2;
+      /// Enables Subduction sedimentree transport for Automerge document replication.
+      optional bool subduction_replicator = 5;
       optional bool signaling = 3;
       optional bool agents = 4;
     }

package/src/proto/dxos/devtools/host.proto

@@ -78,6 +78,13 @@ service DevtoolsHost {
   rpc SubscribeToSignalStatus(google.protobuf.Empty) returns (stream SubscribeToSignalStatusResponse);
   rpc SubscribeToSignal(google.protobuf.Empty) returns (stream SignalResponse);
   rpc SubscribeToSwarmInfo(SubscribeToSwarmInfoRequest) returns (stream SubscribeToSwarmInfoResponse);
+
+  //
+  // SQLite
+  //
+
+  rpc ExportSqliteDatabase(google.protobuf.Empty) returns (ExportSqliteDatabaseResponse);
+  rpc RunSqliteQuery(RunSqliteQueryRequest) returns (RunSqliteQueryResponse);
 }
 
 message Event {
@@ -338,3 +345,23 @@ message SubscribeToSwarmInfoRequest {}
 message SubscribeToSwarmInfoResponse {
   repeated dxos.devtools.swarm.SwarmInfo data = 1;
 }
+
+//
+// SQLite
+//
+
+message ExportSqliteDatabaseResponse {
+  bytes data = 1;
+}
+
+message RunSqliteQueryRequest {
+  string query = 1;
+  // JSON-encoded array of query parameters.
+  optional string params = 2;
+}
+
+message RunSqliteQueryResponse {
+  // JSON-encoded array of row objects.
+  string rows = 1;
+  optional string error = 2;
+}

package/src/proto/dxos/echo/metadata.proto

@@ -34,6 +34,9 @@ message EchoMetadata {
 
   // TODO(burdon): Circular dep.
   repeated dxos.client.services.Invitation invitations = 12;
+
+  /// Keys of spaces that have been tombstoned (soft-deleted). Survives restart; prevents re-acceptance.
+  repeated dxos.keys.PublicKey deleted_spaces = 13;
 }
 
 /// Per-space metadata. Frequent updates. Keep small.

package/src/proto/dxos/echo/service.proto

@@ -60,8 +60,21 @@ message DocumentUpdate {
   /**
    * Automerge document incremental update.
    * Value returned by `Automerge.saveSince()`.
+   * Optional: if absent, the update only carries a transition signal (e.g.
+   * `requesting`) and not new bytes.
    */
-  bytes mutation = 2;
+  optional bytes mutation = 2;
+
+  /**
+   * Set by the worker when the disk probe for this document completes
+   * negative — i.e. the document is not on local storage, and the worker
+   * has started a network fetch. The client moves the corresponding
+   * `DocHandleProxy` from `'pending'` to `'requesting'`. Once the bytes
+   * eventually arrive, a normal `mutation` update follows and the handle
+   * transitions to `'ready'`. Used by query-driven (disk-only) callers to
+   * give up on a load without waiting on the network.
+   */
+  optional bool requesting = 3;
 }
 
 message DocHeadsList {

package/src/proto/dxos/halo/credentials.proto

@@ -87,6 +87,15 @@ message MemberProfile {
   optional ProfileDocument profile = 3;
 }
 
+// [ASSERTION]: Space has been tombstoned (soft-deleted) by its owner.
+// Written to the identity's HALO so the deletion replicates across the user's devices.
+// A tombstone stops replication and unloads the space; data is not removed until garbage collection.
+message SpaceDeleted {
+  dxos.keys.PublicKey space_key = 1;
+  google.protobuf.Timestamp deleted_at = 2;
+  optional string reason = 3;
+}
+
 // [ASSERTION]: Device is authorized to sign messages for a given Agent (Identity).
 // NOTE: Devices are Admitted to Identities.
 message AuthorizedDevice {

package/src/proto/dxos/halo/invitations.proto

@@ -16,8 +16,11 @@ package dxos.halo.invitations;
 
 message InvitationOptions {
   enum Role {
-    GUEST = 0;
-    HOST = 1;
+    // Sentinel so neither real role is the proto3 default (which is stripped on the wire,
+    // causing the receiver to see `role === undefined` and reject with InvalidInvitationExtensionRoleError).
+    INVALID = 0;
+    GUEST = 1;
+    HOST = 2;
   }
 
   /// Role of the peer.

package/src/proto/gen/dxos/agent/dashboard.ts

@@ -66,8 +66,7 @@ import * as example_testing_data from "../../example/testing/data.js";
 import * as example_testing_rpc from "../../example/testing/rpc.js";
 import * as google_protobuf from "../../google/protobuf.js";
 /**
- * Defined in:
- *   {@link file://./../../../dxos/agent/dashboard.proto}
+ * Defined in: `../../../dxos/agent/dashboard.proto`
  */
 export interface AgentStatus {
     status: AgentStatus.Status;
@@ -88,8 +87,7 @@ export namespace AgentStatus {
         OFF = 1
     }
     /**
-     * Defined in:
-     *   {@link file://./../../../dxos/agent/dashboard.proto}
+     * Defined in: `../../../dxos/agent/dashboard.proto`
      */
     export interface Memory {
         /**
@@ -104,8 +102,7 @@ export namespace AgentStatus {
     }
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/agent/dashboard.proto}
+ * Defined in: `../../../dxos/agent/dashboard.proto`
  */
 export interface PluginState {
     id: string;

package/src/proto/gen/dxos/agent/echoproxy.ts

@@ -66,8 +66,7 @@ import * as example_testing_data from "../../example/testing/data.js";
 import * as example_testing_rpc from "../../example/testing/rpc.js";
 import * as google_protobuf from "../../google/protobuf.js";
 /**
- * Defined in:
- *   {@link file://./../../../dxos/agent/echo-proxy.proto}
+ * Defined in: `../../../dxos/agent/echo-proxy.proto`
  */
 export interface Config {
     /**

package/src/proto/gen/dxos/agent/epoch.ts

@@ -66,8 +66,7 @@ import * as example_testing_data from "../../example/testing/data.js";
 import * as example_testing_rpc from "../../example/testing/rpc.js";
 import * as google_protobuf from "../../google/protobuf.js";
 /**
- * Defined in:
- *   {@link file://./../../../dxos/agent/epoch.proto}
+ * Defined in: `../../../dxos/agent/epoch.proto`
  */
 export interface EpochMonitorConfig {
     /**

package/src/proto/gen/dxos/agent/functions.ts

@@ -66,8 +66,7 @@ import * as example_testing_data from "../../example/testing/data.js";
 import * as example_testing_rpc from "../../example/testing/rpc.js";
 import * as google_protobuf from "../../google/protobuf.js";
 /**
- * Defined in:
- *   {@link file://./../../../dxos/agent/functions.proto}
+ * Defined in: `../../../dxos/agent/functions.proto`
  */
 export interface FunctionsConfig {
     /**
@@ -82,39 +81,34 @@ export interface FunctionsConfig {
     manifest?: string;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/agent/functions.proto}
+ * Defined in: `../../../dxos/agent/functions.proto`
  */
 export interface Function {
     id: string;
     route: string;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/agent/functions.proto}
+ * Defined in: `../../../dxos/agent/functions.proto`
  */
 export interface RegisterRequest {
     endpoint: string;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/agent/functions.proto}
+ * Defined in: `../../../dxos/agent/functions.proto`
  */
 export interface RegisterResponse {
     registrationId: string;
     endpoint: string;
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/agent/functions.proto}
+ * Defined in: `../../../dxos/agent/functions.proto`
  */
 export interface UpdateRegistrationRequest {
     registrationId: string;
     functions?: Function[];
 }
 /**
- * Defined in:
- *   {@link file://./../../../dxos/agent/functions.proto}
+ * Defined in: `../../../dxos/agent/functions.proto`
  */
 export interface UnregisterRequest {
     registrationId: string;

package/src/proto/gen/dxos/bot.ts

@@ -66,8 +66,7 @@ import * as example_testing_data from "../example/testing/data.js";
 import * as example_testing_rpc from "../example/testing/rpc.js";
 import * as google_protobuf from "../google/protobuf.js";
 /**
- * Defined in:
- *   {@link file://./../../dxos/bot.proto}
+ * Defined in: `../../dxos/bot.proto`
  */
 export interface BotPackageSpecifier {
     /**
@@ -78,8 +77,7 @@ export interface BotPackageSpecifier {
     localPath?: string;
 }
 /**
- * Defined in:
- *   {@link file://./../../dxos/bot.proto}
+ * Defined in: `../../dxos/bot.proto`
  */
 export interface Bot {
     id: string;
@@ -139,8 +137,7 @@ export namespace Bot {
         SPAWNING = 4
     }
     /**
-     * Defined in:
-     *   {@link file://./../../dxos/bot.proto}
+     * Defined in: `../../dxos/bot.proto`
      */
     export interface Runtime {
         /**
@@ -161,15 +158,13 @@ export namespace Bot {
     }
 }
 /**
- * Defined in:
- *   {@link file://./../../dxos/bot.proto}
+ * Defined in: `../../dxos/bot.proto`
  */
 export interface GetBotsResponse {
     bots?: Bot[];
 }
 /**
- * Defined in:
- *   {@link file://./../../dxos/bot.proto}
+ * Defined in: `../../dxos/bot.proto`
  */
 export interface SpawnBotRequest {
     /**
@@ -193,8 +188,7 @@ export interface SpawnBotRequest {
     spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
 /**
- * Defined in:
- *   {@link file://./../../dxos/bot.proto}
+ * Defined in: `../../dxos/bot.proto`
  */
 export interface SendCommandRequest {
     /**
@@ -209,8 +203,7 @@ export interface SendCommandRequest {
     command?: Uint8Array;
 }
 /**
- * Defined in:
- *   {@link file://./../../dxos/bot.proto}
+ * Defined in: `../../dxos/bot.proto`
  */
 export interface SendCommandResponse {
     /**
@@ -220,22 +213,19 @@ export interface SendCommandResponse {
     response?: Uint8Array;
 }
 /**
- * Defined in:
- *   {@link file://./../../dxos/bot.proto}
+ * Defined in: `../../dxos/bot.proto`
  */
 export interface GetLogsResponse {
     chunk: Uint8Array;
 }
 /**
- * Defined in:
- *   {@link file://./../../dxos/bot.proto}
+ * Defined in: `../../dxos/bot.proto`
  */
 export interface GetLogsRequest {
     botId: string;
 }
 /**
- * Defined in:
- *   {@link file://./../../dxos/bot.proto}
+ * Defined in: `../../dxos/bot.proto`
  */
 export interface BotReport {
     /**
@@ -263,8 +253,7 @@ export interface BotFactoryService {
     removeAll: (request: void, options?: RequestOptions) => Promise<void>;
 }
 /**
- * Defined in:
- *   {@link file://./../../dxos/bot.proto}
+ * Defined in: `../../dxos/bot.proto`
  */
 export interface InitializeRequest {
     /**
@@ -290,8 +279,7 @@ export interface InitializeRequest {
     id?: string;
 }
 /**
- * Defined in:
- *   {@link file://./../../dxos/bot.proto}
+ * Defined in: `../../dxos/bot.proto`
  */
 export interface StartRequest {
     /**