@dxos/protocols 0.8.4-main.84f28bd → 0.8.4-main.9735255

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.,
+                            // 'dxos.org/type/frame' vs. '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;
 
@@ -111,8 +110,8 @@ message Runtime {
     }
 
     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 +135,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 +145,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 +155,8 @@ message Runtime {
     optional bool enable_vector_indexing = 12;
 
     optional EdgeFeatures edge_features = 11;
+
+    optional bool enable_local_queues = 13;
   }
 
   message App {
@@ -169,7 +172,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 +217,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 +254,7 @@ message Runtime {
       int32 interval = 3;
     }
 
-    message Trace {
-      bool disabled = 1;
-    }
+    message Trace { bool disabled = 1; }
 
     message Telemetry {
       bool disabled = 1;
@@ -285,10 +282,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 +356,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 +374,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 +392,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 +410,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 +427,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/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/iframe.proto

@@ -39,6 +39,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/gen/dxos/client/services.ts

@@ -1399,9 +1399,36 @@ export interface EdgeAgentService {
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export enum EdgeStatus {
-    NOT_CONNECTED = 0,
-    CONNECTED = 1
+export interface EdgeStatus {
+    state: EdgeStatus.ConnectionState;
+    /**
+     * Latency in ms
+     */
+    rtt: number;
+    /**
+     * How long the connection has been up
+     */
+    uptime: number;
+    /**
+     * Upload rate in bytes per second
+     */
+    rateBytesUp: number;
+    /**
+     * Download rate in bytes per second
+     */
+    rateBytesDown: number;
+    messagesSent: number;
+    messagesReceived: number;
+}
+export namespace EdgeStatus {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/services.proto}
+     */
+    export enum ConnectionState {
+        NOT_CONNECTED = 0,
+        CONNECTED = 1
+    }
 }
 /**
  * Defined in:
@@ -1429,3 +1456,106 @@ export namespace QueryAgentStatusResponse {
         NOT_FOUND = 3
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface QueueQuery {
+    spaceId: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    queuesNamespace?: string;
+    /**
+     * Queries the whole space if missing.
+     */
+    queueIds?: string[];
+    /**
+     * Filter items after this cursor. Exclusive.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    after?: string;
+    /**
+     * Filter items before this cursor. Exclusive.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    before?: string;
+    /**
+     * Filter items after this position. Inclusive.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    beginPosition?: string;
+    /**
+     * Filter items before this position. Exclusive.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    endPosition?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    limit?: number;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    reverse?: boolean;
+    objectIds?: string[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface QueueQueryResult {
+    objects?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>[];
+    /**
+     * Cursor to query the next items. Can be passed to `after` in query to keep querying.
+     */
+    nextCursor: string;
+    prevCursor: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface QueryQueueRequest {
+    query: QueueQuery;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface InsertIntoQueueRequest {
+    subspaceTag: string;
+    spaceId: string;
+    queueId: string;
+    objects?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface DeleteFromQueueRequest {
+    subspaceTag: string;
+    spaceId: string;
+    queueId: string;
+    objectIds?: string[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface QueueService {
+    queryQueue: (request: QueryQueueRequest, options?: RequestOptions) => Promise<QueueQueryResult>;
+    insertIntoQueue: (request: InsertIntoQueueRequest, options?: RequestOptions) => Promise<void>;
+    deleteFromQueue: (request: DeleteFromQueueRequest, options?: RequestOptions) => Promise<void>;
+}

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

@@ -309,7 +309,7 @@ export namespace Runtime {
          */
         devtoolsProxy?: string;
         /**
-         * Spaces will stay in SpaceState.CLOSED until explicitly opened. Speeds up client-services initialization.
+         * client-services initialization.
          *
          * Options:
          *   - proto3_optional = true
@@ -332,6 +332,11 @@ export namespace Runtime {
          *   - proto3_optional = true
          */
         edgeFeatures?: Runtime.Client.EdgeFeatures;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        enableLocalQueues?: boolean;
     }
     export namespace Client {
         /**
@@ -789,6 +794,8 @@ export namespace Runtime {
      */
     export interface Services {
         /**
+         * Deprecated
+         *
          * Options:
          *   - proto3_optional = true
          */
@@ -827,21 +834,29 @@ export namespace Runtime {
          */
         publisher?: Runtime.Services.Publisher;
         /**
+         * Deprecated
+         *
          * Options:
          *   - proto3_optional = true
          */
         supervisor?: Runtime.Services.Supervisor;
         /**
+         * Deprecated
+         *
          * Options:
          *   - proto3_optional = true
          */
         tunneling?: Runtime.Services.Tunneling;
         /**
+         * Deprecated
+         *
          * Options:
          *   - proto3_optional = true
          */
         faasd?: Runtime.Services.Faasd;
         /**
+         * Deprecated
+         *
          * Options:
          *   - proto3_optional = true
          */
@@ -856,6 +871,11 @@ export namespace Runtime {
          *   - proto3_optional = true
          */
         ai?: Runtime.Services.Ai;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        hub?: Runtime.Services.Hub;
     }
     export namespace Services {
         /**
@@ -971,7 +991,7 @@ export namespace Runtime {
              */
             gateway?: string;
             /**
-             * Same secret format as https://github.com/ipfs/kubo/blob/master/docs/config.md#apiauthorizations
+             * https://github.com/ipfs/kubo/blob/master/docs/config.md#apiauthorizations
              *
              * Options:
              *   - proto3_optional = true
@@ -1153,6 +1173,17 @@ export namespace Runtime {
              */
             server?: string;
         }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        export interface Hub {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            url?: string;
+        }
     }
     /**
      * Defined in:

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

@@ -106,9 +106,25 @@ export interface Heads {
 export interface QueryResult {
     id: string;
     spaceId: string;
-    documentId: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    documentId?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    queueId?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    queueNamespace?: string;
     rank: number;
     /**
+     * In the ECHO Json object format.
+     *
      * Options:
      *   - proto3_optional = true
      */

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

@@ -133,14 +133,6 @@ export interface DocumentUpdate {
      * Value returned by `Automerge.saveSince()`.
      */
     mutation: Uint8Array;
-    /**
-     * Set to true for init mutation of document.
-     * default: undefined.
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    isNew?: boolean;
 }
 /**
  * Defined in:
@@ -187,6 +179,34 @@ export interface WaitUntilHeadsReplicatedRequest {
 export interface ReIndexHeadsRequest {
     documentIds?: string[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/echo/service.proto}
+ */
+export interface CreateDocumentRequest {
+    /**
+     * Space id where the document will be created.
+     */
+    spaceId: string;
+    /**
+     * Automerge encoded initial document value.
+     * Optional - if not provided, an empty document will be created.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    initialValue?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/echo/service.proto}
+ */
+export interface CreateDocumentResponse {
+    /**
+     * The generated document id.
+     */
+    documentId: string;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/echo/service.proto}
@@ -228,6 +248,15 @@ export namespace SpaceSyncState {
          * Total number of documents on the remote peer.
          */
         remoteDocumentCount: number;
+        /**
+         * Total number of documents across this peer and the remote peer.
+         */
+        totalDocumentCount: number;
+        /**
+         * 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.
+         */
+        unsyncedDocumentCount: number;
     }
 }
 /**
@@ -245,6 +274,11 @@ export interface DataService {
      * Change which documents are subscribed to for specific subscription.
      */
     updateSubscription: (request: UpdateSubscriptionRequest, options?: RequestOptions) => Promise<void>;
+    /**
+     * Create a new automerge document.
+     * Returns the generated document id which is controlled by the host.
+     */
+    createDocument: (request: CreateDocumentRequest, options?: RequestOptions) => Promise<CreateDocumentResponse>;
     /**
      * Write incremental updates to multiple automerge documents.
      * Used to propagate changes from client to services.