@dxos/protocols 0.8.4-main.fd6878d → 0.8.4-staging.60fe92afc8

package/src/proto/dxos/echo/query.proto

@@ -36,9 +36,12 @@ message Heads {
 message QueryResult {
   string id = 1;
   string spaceId = 4;
-  string documentId = 5;
+  optional string documentId = 5;
+  optional string queueId = 6;
+  optional string queueNamespace = 7;
   float rank = 3;
 
+  /// In the ECHO Json object format.
   optional string document_json = 10;
   optional bytes document_automerge = 11;
   

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

@@ -6,6 +6,7 @@ syntax = "proto3";
 
 import "dxos/keys.proto";
 import "google/protobuf/empty.proto";
+import "google/protobuf/struct.proto";
 
 package dxos.echo.service;
 
@@ -59,14 +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 to true for init mutation of document.
-   * default: undefined.
+   * 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 is_new = 3;
+  optional bool requesting = 3;
 }
 
 message DocHeadsList {
@@ -94,6 +102,26 @@ message ReIndexHeadsRequest {
   repeated string document_ids = 1;
 }
 
+message CreateDocumentRequest {
+  /**
+   * Space id where the document will be created.
+   */
+  string space_id = 1;
+
+  /**
+   * Automerge encoded initial document value.
+   * Optional - if not provided, an empty document will be created.
+   */
+  optional google.protobuf.Struct initial_value = 2;
+}
+
+message CreateDocumentResponse {
+  /**
+   * The generated document id.
+   */
+  string document_id = 1;
+}
+
 message GetSpaceSyncStateRequest {
   string space_id = 1;
 }
@@ -128,6 +156,17 @@ message SpaceSyncState {
      * Total number of documents on the remote peer.
      */
     int32 remote_document_count = 14;
+
+    /**
+     * Total number of documents across this peer and the remote peer.
+     */
+    int32 total_document_count = 15;
+
+    /**
+    * Total number of documents that are not synced.
+    * Includes documents that are present only locally, only on the remote peer, or whether the peers have different versions.
+    */
+    int32 unsynced_document_count = 16;
   }
 
   repeated PeerState peers = 1;
@@ -146,6 +185,12 @@ service DataService {
    */
   rpc UpdateSubscription(UpdateSubscriptionRequest) returns (google.protobuf.Empty);
 
+  /**
+   * Create a new automerge document.
+   * Returns the generated document id which is controlled by the host.
+   */
+   rpc CreateDocument(CreateDocumentRequest) returns (CreateDocumentResponse);
+
   /**
    * Write incremental updates to multiple automerge documents.
    * Used to propagate changes from client to services.

package/src/proto/dxos/edge/messenger.proto

@@ -76,9 +76,19 @@ message Message {
   /// Maybe be used to address a service at EDGE, but also to address components inside the client.
   optional string service_id = 20;
 
+  optional TraceContext trace_context = 21;
+
   optional google.protobuf.Any payload = 100;
 }
 
+/// W3C Trace Context propagation (https://www.w3.org/TR/trace-context/).
+message TraceContext {
+  /// W3C `traceparent` header value (e.g. "00-<trace-id>-<parent-id>-<trace-flags>").
+  string traceparent = 1;
+  /// W3C `tracestate` header value; vendor-specific key-value pairs.
+  optional string tracestate = 2;
+}
+
 //
 // Swarms are used to publish and subscribe to messages based on a topic.
 //

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

@@ -28,9 +28,18 @@ import "dxos/keys.proto";
 // First message written to initial Feed in a new Space.
 //
 
+enum MembershipPolicy {
+  /// Members can be invited by admins/owners.
+  INVITE = 0;
+  /// No new members can be added after genesis.
+  LOCKED = 1;
+}
+
 // [ASSERTION]
 message SpaceGenesis {
   dxos.keys.PublicKey space_key = 1; // Feeds belong to Spaces.
+  repeated string tags = 2;
+  MembershipPolicy membership_policy = 3;
 }
 
 //
@@ -60,6 +69,9 @@ message SpaceMember {
   dxos.keys.PublicKey space_key = 1;
   Role role = 2;
 
+  /// Immutable tags assigned at space creation time.
+  repeated string tags = 6;
+
   // TODO(burdon): Identity key?
   optional ProfileDocument profile = 3;
 
@@ -75,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 {
@@ -163,6 +184,8 @@ enum DeviceType {
   UNKNOWN = 0;
   BROWSER = 1;
   NATIVE = 2;
+  // TODO(wittjosiah): Rename "agent" to avoid naming collision with AI agents.
+  // TODO(wittjosiah): Unknown, Browser, CLI, Desktop, Mobile, Custodian?
   AGENT = 3;
   AGENT_MANAGED = 4;
   MOBILE = 5;
@@ -188,6 +211,7 @@ message DeviceProfile {
 }
 
 /// [ASSERTION]: Sets default space for identity.
+/// @deprecated Default space is no longer managed by the SDK. Existing credentials are ignored.
 message DefaultSpace {
   string space_id = 1;
 }

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/dxos/iframe.proto

@@ -15,9 +15,6 @@ message StartRequest {
   string origin = 1;
   /// Key for the iframe resource lock used to determine when the service is closing.
   optional string lock_key = 2;
-  // TODO(nf): extract or remove?
-  optional string observabilityGroup = 3;
-  optional bool signalTelemetryEnabled = 4;
 }
 
 /// Iframe-to-worker RPCs.
@@ -39,6 +36,7 @@ message AppContextRequest {
   /// The key of the joined space.
   optional dxos.keys.PublicKey space_key = 2;
 
+  // TODO(wittjosiah): Make the generated type be `SpaceId`.
   /// The id of the joined space.
   optional string space_id = 5;
 

package/src/proto/dxos/rpc.proto

@@ -29,11 +29,18 @@ message RpcMessage {
   }
 }
 
+/// W3C trace context carried across RPC boundaries.
+message TraceContext {
+  string traceparent = 1;
+  optional string tracestate = 2;
+}
+
 message Request {
   int32 id = 1;
   string method = 2;
   google.protobuf.Any payload = 3;
   bool stream = 4;
+  optional TraceContext trace_context = 5;
 }
 
 message Response {

package/src/proto/dxos/tracing.proto

@@ -30,42 +30,6 @@ message ResourceLink {
   google.protobuf.Struct attributes = 4;
 }
 
-message Span {
-  int32 id = 1;
-  optional int32 parent_id = 2;
-  optional int32 resource_id = 3;
-  string method_name = 4;
-
-  // TODO(dmaretskyi): Figure out proper sub-millisecond timestamp type.
-  string start_ts = 5;
-  optional string end_ts = 6;
-
-  optional dxos.error.Error error = 11;
-}
-
-message StreamTraceEvent {
-  message ResourceAdded {
-    Resource resource = 1;
-  }
-
-  message ResourceRemoved {
-    int32 id = 1;
-  }
-
-  message SpanAdded {
-    Span span = 1;
-  }
-
-  message LogAdded {
-    dxos.client.services.LogEntry log = 1;
-  }
-
-  repeated ResourceAdded resource_added = 1;
-  repeated ResourceRemoved resource_removed = 2;
-  repeated SpanAdded span_added = 3;
-  repeated LogAdded log_added = 4;
-}
-
 message Metric {
   message Counter {
     double value = 1;
@@ -110,7 +74,3 @@ message Metric {
     Custom custom = 199;
   }
 }
-
-service TracingService {
-  rpc StreamTrace(google.protobuf.Empty) returns (stream StreamTraceEvent);
-}

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 {
     /**