@dxos/protocols 0.8.4-main.f9ba587 → 0.8.4-main.fcc0d83b33

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

@@ -0,0 +1,81 @@
+syntax = "proto3";
+
+package dxos.client.services;
+
+import "google/protobuf/empty.proto";
+
+
+message QueueQuery {
+  string space_id = 1;
+
+  optional string queues_namespace = 2;
+
+  /// Queries the whole space if missing.
+  repeated string queue_ids = 3;
+
+  /// Filter items after this cursor. Exclusive.
+  optional string after = 4;
+
+  /// Filter items before this cursor. Exclusive.
+  optional string before = 5;
+
+  /// Filter items after this position. Inclusive.
+  optional int64 begin_position = 6;
+
+  /// Filter items before this position. Exclusive.
+  optional int64 end_position = 7;
+
+  optional int32 limit = 8;
+  optional bool reverse = 9;
+
+  // TODO(dmaretskyi): Remove this field -- raw queues dont index object IDs anymore.
+  repeated string object_ids = 100;
+}
+
+message QueueQueryResult {
+  /// JSON-encoded object payloads. Each entry is a serialized ObjectJSON.
+  /// We use JSON strings instead of google.protobuf.Struct because Struct
+  /// coerces `undefined` to `null`, corrupting optional fields.
+  repeated string objects = 1;
+
+  /// Cursor to query the next items. Can be passed to `after` in query to keep querying.
+  string next_cursor = 2;
+
+  string prev_cursor = 3;
+}
+
+message QueryQueueRequest {
+  QueueQuery query = 1;
+}
+
+message InsertIntoQueueRequest {
+  string subspace_tag = 1;
+  string space_id = 2;
+  string queue_id = 3;
+  /// JSON-encoded object payloads. Each entry is a serialized ObjectJSON.
+  repeated string objects = 4;
+}
+
+message DeleteFromQueueRequest {
+  string subspace_tag = 1;
+  string space_id = 2;
+  string queue_id = 3;
+  repeated string object_ids = 4;
+}
+
+message SyncQueueRequest {
+  string subspace_tag = 1;
+  string space_id = 2;
+  string queue_id = 3;
+  /// Whether to push local changes to the server. Defaults to true.
+  optional bool should_push = 4;
+  /// Whether to pull remote changes from the server. Defaults to true.
+  optional bool should_pull = 5;
+}
+
+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);
+}

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

@@ -72,6 +72,7 @@ message Platform {
     BROWSER = 0;
     SHARED_WORKER = 1;
     NODE = 2;
+    DEDICATED_WORKER = 3;
   }
 
   PLATFORM_TYPE type = 1;
@@ -331,6 +332,8 @@ message Space {
   optional PipelineState pipeline = 3;
   optional dxos.error.Error error = 4;
   optional dxos.echo.metadata.EdgeReplicationSetting edge_replication = 6;
+  repeated string tags = 7;
+  dxos.halo.credentials.MembershipPolicy membership_policy = 8;
 
   repeated SpaceMember members = 10;
   optional dxos.keys.PublicKey creator = 11;
@@ -341,6 +344,11 @@ message Space {
 
 // TODO(burdon): Create type for epoch?
 
+message CreateSpaceRequest {
+  repeated string tags = 1;
+  dxos.halo.credentials.MembershipPolicy membership_policy = 2;
+}
+
 message UpdateSpaceRequest {
   dxos.keys.PublicKey space_key = 1;
 
@@ -435,12 +443,22 @@ message JoinBySpaceKeyRequest {
 }
 
 message SpaceArchive {
+  enum Format {
+    // Tar-based binary archive (default).
+    BINARY = 0;
+    // JSON encoding of {@link dxos.echo.db.SerializedSpace}.
+    JSON = 1;
+  }
+
   string filename = 1;
   bytes contents = 2;
+  optional Format format = 3;
 }
 
 message ExportSpaceRequest {
   string space_id = 1;
+  // Archive format to produce. Defaults to BINARY.
+  optional SpaceArchive.Format format = 2;
 }
 
 message ExportSpaceResponse {
@@ -457,7 +475,7 @@ message ImportSpaceResponse {
 }
 
 service SpacesService {
-  rpc CreateSpace(google.protobuf.Empty) returns (Space);
+  rpc CreateSpace(CreateSpaceRequest) returns (Space);
   rpc UpdateSpace(UpdateSpaceRequest) returns (google.protobuf.Empty);
   rpc QuerySpaces(google.protobuf.Empty) returns (stream QuerySpacesResponse);
 
@@ -596,9 +614,26 @@ service EdgeAgentService {
   rpc QueryAgentStatus(google.protobuf.Empty) returns (stream QueryAgentStatusResponse);
 }
 
-enum EdgeStatus {
-  NOT_CONNECTED = 0;
-  CONNECTED = 1;
+message EdgeStatus {
+  enum ConnectionState {
+    NOT_CONNECTED = 0;
+    CONNECTED = 1;
+  }
+
+  ConnectionState state = 1;
+  /** Latency in ms */
+  int32 rtt = 2;
+
+  /** How long the connection has been up */
+  int32 uptime = 3;
+
+  /** Upload rate in bytes per second */
+  int32 rate_bytes_up = 4;
+  /** Download rate in bytes per second */
+  int32 rate_bytes_down = 5;
+
+  int32 messages_sent = 6;
+  int32 messages_received = 7;
 }
 
 message QueryEdgeStatusResponse {

package/src/proto/dxos/config.proto

@@ -12,9 +12,7 @@ package dxos.config;
 
 option go_package = "github.com/dxos/dxos/proto/def/dxos/config";
 
-extend google.protobuf.FieldOptions {
-  optional string env_var = 1000;
-}
+extend google.protobuf.FieldOptions { optional string env_var = 1000; }
 
 message Config {
   optional int32 version = 1;
@@ -58,9 +56,10 @@ message Module {
     optional google.protobuf.Struct env = 10;
   }
 
-  optional string id = 8;     // TODO(burdon): Ensured FQ (e.g., 'dxos.app.xxx')
-  optional string name = 1;   // TODO(burdon): Replace with id (or key?)
-  optional string type = 2;   // TODO(burdon): Define namespace (e.g., 'dxos.org/type/frame' vs. 'dxos.type.frame')
+  optional string id = 8;   // TODO(burdon): Ensured FQ (e.g., 'dxos.app.xxx')
+  optional string name = 1; // TODO(burdon): Replace with id (or key?)
+  optional string type = 2; // TODO(burdon): Define namespace (e.g.,
+                            // 'org.dxos.type.frame')
 
   // TODO(burdon): Developer info message.
 
@@ -74,7 +73,7 @@ message Module {
   optional bool tunnel = 7;
 
   // TODO(burdon): Start at 100.
-  repeated Module deps = 10;  // TODO(burdon): E.g., types.
+  repeated Module deps = 10; // TODO(burdon): E.g., types.
   optional Build build = 100;
   repeated Repo repos = 101;
 
@@ -85,6 +84,17 @@ message Module {
 
 message Runtime {
   message Client {
+    /// Where client services run. Drives `createClientServices` routing.
+    enum ServicesMode {
+      UNSPECIFIED_SERVICES_MODE = 0;
+      /// Run services in the same thread as the client.
+      HOST = 1;
+      /// Run services in a SharedWorker (single instance shared across tabs).
+      SHARED_WORKER = 2;
+      /// Run services in a dedicated Worker elected via a lock (leader/follower).
+      DEDICATED_WORKER = 3;
+    }
+
     message Storage {
       enum StorageDriver {
         RAM = 0;
@@ -99,6 +109,20 @@ message Runtime {
         JSONDOWN = 12;
       }
 
+      /// Storage backing for SQLite (indexes & persistent state). The caller must supply the
+      /// matching worker factory / path — `createClientServices` does not pick a mode from the
+      /// presence of options.
+      enum SqliteMode {
+        UNSPECIFIED_SQLITE_MODE = 0;
+        /// Ephemeral in-memory SQLite. Indexes are rebuilt on each start.
+        MEMORY = 1;
+        /// OPFS-backed SQLite running in a dedicated worker (browser).
+        /// Requires `createOpfsWorker` to be passed to `createClientServices`.
+        OPFS = 2;
+        /// File-backed SQLite (Node/Bun). Uses `data_root` to locate the database file.
+        FILE = 3;
+      }
+
       optional bool persistent = 1;
       optional StorageDriver key_store = 2;
       optional StorageDriver data_store = 3;
@@ -108,11 +132,14 @@ message Runtime {
        * @deprecated
        */
       optional bool space_fragmentation = 5;
+
+      /// Backing store for SQLite runtimes. Defaults to MEMORY when unset.
+      optional SqliteMode sqlite_mode = 6;
     }
 
     message Log {
-      optional string filter = 1 [(env_var) = "LOG_FILTER"];
-      optional string prefix = 2 [(env_var) = "LOG_PREFIX"];
+      optional string filter = 1 [ (env_var) = "LOG_FILTER" ];
+      optional string prefix = 2 [ (env_var) = "LOG_PREFIX" ];
     }
 
     message EdgeFeatures {
@@ -136,7 +163,8 @@ message Runtime {
     optional int32 invitation_expiration = 5;
 
     /// Location of the remote client host.
-    // TODO(burdon): Rename vault_endpoint (generalize http/ws; drop vault.html).
+    // TODO(burdon): Rename vault_endpoint (generalize http/ws; drop
+    // vault.html).
     optional string remote_source = 6;
 
     // Authenticate via `Sec-WebSocket-Protocol` header hack.
@@ -145,7 +173,8 @@ message Runtime {
     /// Connect to and serve client services to a remote proxy.
     optional string devtools_proxy = 7;
 
-    /// Spaces will stay in SpaceState.CLOSED until explicitly opened. Speeds up client-services initialization.
+    /// Spaces will stay in SpaceState.CLOSED until explicitly opened. Speeds up
+    /// client-services initialization.
     optional bool lazy_space_open = 9;
 
     /// Disabled automerge & hypercore replication through P2P connections.
@@ -154,6 +183,25 @@ message Runtime {
     optional bool enable_vector_indexing = 12;
 
     optional EdgeFeatures edge_features = 11;
+
+    /// Observability group attached as metadata to signaling requests.
+    /// NOTE: When running through a shared worker, subsequent client connections can refresh this
+    /// value (last-writer-wins); the first client still determines the worker's other config.
+    optional string observability_group = 13;
+
+    /// Enable telemetry metadata attached to signaling requests.
+    /// NOTE: When running through a shared worker, subsequent client connections can refresh this
+    /// value (last-writer-wins); the first client still determines the worker's other config.
+    optional bool signal_telemetry_enabled = 14;
+
+    /// Use in-process (single-client) coordinator for dedicated-worker mode.
+    /// Bypasses SharedWorker; used for WKWebView where the coordinator SharedWorker port is unreliable.
+    optional bool single_client_mode = 15;
+
+    /// Deployment mode for client services. Read by `createClientServices` to select between
+    /// in-process (HOST), SharedWorker, and dedicated Worker runtimes. Required when no
+    /// `remote_source` is configured.
+    optional ServicesMode services_mode = 16;
   }
 
   message App {
@@ -169,7 +217,7 @@ message Runtime {
     optional string org = 1;
     optional string theme = 2;
     optional string website = 3;
-    optional string public_url = 4 [(env_var) = "PUBLIC_URL"];
+    optional string public_url = 4 [ (env_var) = "PUBLIC_URL" ];
 
     optional BuildInfo build = 100;
     optional google.protobuf.Struct env = 101;
@@ -214,13 +262,9 @@ message Runtime {
     optional string channel = 7;
   }
 
-  message Props {
-    optional string title = 1;
-  }
+  message Props { optional string title = 1; }
 
-  message System {
-    optional string debug = 1;
-  }
+  message System { optional string debug = 1; }
 
   //
   // KUBE
@@ -255,9 +299,7 @@ message Runtime {
       int32 interval = 3;
     }
 
-    message Trace {
-      bool disabled = 1;
-    }
+    message Trace { bool disabled = 1; }
 
     message Telemetry {
       bool disabled = 1;
@@ -285,10 +327,10 @@ message Runtime {
 
     /// https://github.com/ipfs/kubo/blob/master/docs/config.md#apiauthorizations
     message KuboApiAuthorization {
-        /// Just for organizational purposes.
-        string name = 1;
-        string auth_secret = 2;
-        repeated string allowed_paths = 3;
+      /// Just for organizational purposes.
+      string name = 1;
+      string auth_secret = 2;
+      repeated string allowed_paths = 3;
     }
 
     // TODO(burdon): Needs documentation/
@@ -359,8 +401,9 @@ message Runtime {
     message Ipfs {
       optional string server = 1;
       optional string gateway = 2;
-      /// Used for IPFS API authentication, regardless if server is direct KUBO API (e.g. path of '/api/v0') or a reverse proxy
-      /// Same secret format as https://github.com/ipfs/kubo/blob/master/docs/config.md#apiauthorizations
+      /// Used for IPFS API authentication, regardless if server is direct KUBO
+      /// API (e.g. path of '/api/v0') or a reverse proxy Same secret format as
+      /// https://github.com/ipfs/kubo/blob/master/docs/config.md#apiauthorizations
       optional string server_auth_secret = 3;
     }
 
@@ -376,9 +419,7 @@ message Runtime {
       optional string credential = 3;
     }
 
-    message IceProvider {
-      string urls = 1;
-    }
+    message IceProvider { string urls = 1; }
 
     message Machine {
       optional string do_access_token = 1;
@@ -396,9 +437,7 @@ message Runtime {
       optional string server = 1;
     }
 
-    message Tunneling {
-      optional string server = 1;
-    }
+    message Tunneling { optional string server = 1; }
 
     message Supervisor { // TODO(burdon): Is this a service?
       optional string server = 1;
@@ -416,14 +455,13 @@ message Runtime {
       optional string type = 2;
     }
 
-    message Edge {
-      optional string url = 1;
-    }
+    message Edge { optional string url = 1; }
 
-    message Ai {
-      optional string server = 1;
-    }
+    message Ai { optional string server = 1; }
+
+    message Hub { optional string url = 1; }
 
+    /** Deprecated */
     optional Kube kube = 1;
     optional AppServer app = 2;
     optional Dxns dxns = 3;
@@ -434,12 +472,17 @@ message Runtime {
     optional Machine machine = 7;
     optional BotHost bot = 8;
     optional Publisher publisher = 9;
-    optional Supervisor supervisor = 10; // TODO(burdon): Promote to 1; start others at 10.
+    /** Deprecated */
+    optional Supervisor supervisor = 10;
+    /** Deprecated */
     optional Tunneling tunneling = 11;
+    /** Deprecated */
     optional Faasd faasd = 12;
+    /** Deprecated */
     optional AgentHosting agent_hosting = 13;
     optional Edge edge = 15;
     optional Ai ai = 16;
+    optional Hub hub = 17;
   }
 
   message Keys {

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

@@ -54,6 +54,9 @@ message SpaceMetadata {
   /// Space key.
   dxos.keys.PublicKey key = 1;
 
+  /// Immutable tags assigned at space creation time.
+  repeated string tags = 12;
+
   /// ACTIVE, INACTIVE, etc.
   optional dxos.client.services.SpaceState state = 10;
 

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;
 
@@ -61,12 +62,6 @@ message DocumentUpdate {
    * Value returned by `Automerge.saveSince()`.
    */
   bytes mutation = 2;
-
-  /**
-   * Set to true for init mutation of document.
-   * default: undefined.
-   */
-   optional bool is_new = 3;
 }
 
 message DocHeadsList {
@@ -94,6 +89,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 +143,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 +172,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;
 
@@ -163,6 +175,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 +202,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/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);
-}