@dxos/protocols 0.6.2-main.c33bf0c → 0.6.2-main.d41f0d2

package/dist/esm/src/proto/gen/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAgEhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA2jB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,wk6GAAwk6G,CAAC,CAAC,CAAC;AACjo6G,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAgEhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA2jB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,ww7GAAww7G,CAAC,CAAC,CAAC;AACj07G,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/protocols",
-  "version": "0.6.2-main.c33bf0c",
+  "version": "0.6.2-main.d41f0d2",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -34,11 +34,11 @@
   ],
   "dependencies": {
     "@effect/schema": "^0.67.16",
-    "@dxos/codec-protobuf": "0.6.2-main.c33bf0c",
-    "@dxos/keys": "0.6.2-main.c33bf0c",
-    "@dxos/timeframe": "0.6.2-main.c33bf0c",
-    "@dxos/invariant": "0.6.2-main.c33bf0c",
-    "@dxos/util": "0.6.2-main.c33bf0c"
+    "@dxos/codec-protobuf": "0.6.2-main.d41f0d2",
+    "@dxos/invariant": "0.6.2-main.d41f0d2",
+    "@dxos/keys": "0.6.2-main.d41f0d2",
+    "@dxos/timeframe": "0.6.2-main.d41f0d2",
+    "@dxos/util": "0.6.2-main.d41f0d2"
   },
   "devDependencies": {
     "glob": "~7.1.6"

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

@@ -4,46 +4,42 @@
 
 syntax = "proto3";
 
-import "dxos/echo/object.proto";
-import "dxos/echo/snapshot.proto";
-import "dxos/echo/timeframe.proto";
 import "dxos/keys.proto";
+import "google/protobuf/empty.proto";
 
 package dxos.echo.service;
 
 message SubscribeRequest {
-  dxos.keys.PublicKey space_key = 1;
+  string subscription_id = 1;
 }
 
-message EchoEvent {
-  /// If this event comes as a response to this client wirting the mutation, this field will be set to the tag in the mutation.
-  optional string client_tag = 1;
-
-  /// For mutations read from the feed store those fields will be set to the position of the mutation in the feed.
-  optional dxos.keys.PublicKey feed_key = 2;
-  optional int32 seq = 3;
-
-  enum DatabaseAction {
-    RESET = 0;
-  }
-
-  optional DatabaseAction action = 4;
-
-  dxos.echo.object.EchoObjectBatch batch = 10;
+message BatchedDocumentUpdates {
+  repeated DocumentUpdate updates = 1;
 }
 
 message WriteRequest {
-  dxos.keys.PublicKey space_key = 1;
-  
-  /// Ephermal tag to correlate events in the subscription.
-  optional string client_tag = 2;
-
-  dxos.echo.object.EchoObjectBatch batch = 10;
+  string subscription_id = 1;
+  repeated DocumentUpdate updates = 2;
 }
 
-message MutationReceipt {
-  dxos.keys.PublicKey feed_key = 1;
-  int32 seq = 2;
+message UpdateSubscriptionRequest {
+  /**
+   * Id of the subscription to update.
+   * Subscription id is returned by `Subscribe` rpc.
+   */
+  string subscription_id = 1;
+
+  /**
+   * Automerge document ids to subscribe for updates.
+   * Used for already existing documents.
+   * To add new document use `write` rpc.
+   */
+  repeated string add_ids = 3;
+
+  /**
+   * Automerge document ids to unsubscribe from.
+   */
+  repeated string remove_ids = 4;
 }
 
 message FlushRequest {
@@ -60,6 +56,25 @@ message FlushRequest {
   repeated DocState states = 2;
 }
 
+message DocumentUpdate {
+  /**
+   * Automerge document id.
+   */
+  string document_id = 1;
+
+  /**
+   * Automerge document incremental update.
+   * Value returned by `Automerge.saveSince()`.
+   */
+  bytes mutation = 2;
+
+  /**
+   * Set to true for init mutation of document.
+   * default: undefined.
+   */
+   optional bool is_new = 3;
+}
+
 // Automerge specific.
 message HostInfo {
   string peer_id = 1;
@@ -101,8 +116,23 @@ message ReIndexHeadsRequest {
 }
 
 service DataService {
-  rpc Subscribe(SubscribeRequest) returns (stream EchoEvent);
-  rpc Write(WriteRequest) returns (MutationReceipt); // TODO(burdon): Rename SubmitMutation.
+  /**
+   * Subscribe to incremental updates of multiple automerge socuments. 
+   * Which documents are subscribed to is defined in the `UpdateSubscription`.
+   * Used to propagate changes from services to client.
+   */
+  rpc Subscribe(SubscribeRequest) returns (stream BatchedDocumentUpdates);
+
+  /**
+   * Change which documents are subscribed to for specific subscription.
+   */
+  rpc UpdateSubscription(UpdateSubscriptionRequest) returns (google.protobuf.Empty);
+
+  /**
+   * Write incremental updates to multiple automerge documents.
+   * Used to propagate changes from client to services.
+   */
+  rpc Write(WriteRequest) returns (google.protobuf.Empty);
   rpc Flush(FlushRequest) returns (google.protobuf.Empty);
 
   // Automerge specific.

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

@@ -62,181 +62,6 @@ import * as dxos_value from "../value";
 import * as example_testing_data from "../../example/testing/data";
 import * as example_testing_rpc from "../../example/testing/rpc";
 import * as google_protobuf from "../../google/protobuf";
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface Metrics {
-    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
-    values?: Metrics.KeyPair[];
-}
-export namespace Metrics {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export interface KeyPair {
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        key?: string;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        value?: dxos_value.Value;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        stats?: dxos_value.Stats;
-    }
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface ControlMetricsRequest {
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    reset?: boolean;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    record?: boolean;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface ControlMetricsResponse {
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    recording?: boolean;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface QueryMetricsRequest {
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    interval?: number;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface QueryMetricsResponse {
-    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
-    metrics: Metrics;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export enum LogLevel {
-    TRACE = 5,
-    DEBUG = 10,
-    INFO = 11,
-    WARN = 12,
-    ERROR = 13
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface QueryLogsRequest {
-    filters?: QueryLogsRequest.Filter[];
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    options?: QueryLogsRequest.MatchingOptions;
-}
-export namespace QueryLogsRequest {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export enum MatchingOptions {
-        INCLUSIVE = 1,
-        EXPLICIT = 2
-    }
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export interface Filter {
-        level: LogLevel;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        pattern?: string;
-    }
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface LogEntry {
-    level: LogLevel;
-    message: string;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    meta?: LogEntry.Meta;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    error?: dxos_error.Error;
-    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
-}
-export namespace LogEntry {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export interface Meta {
-        file: string;
-        line: number;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        scope?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        resourceId?: number;
-    }
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface LoggingService {
-    controlMetrics: (request: ControlMetricsRequest, options?: RequestOptions) => Promise<ControlMetricsResponse>;
-    queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
-    queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
-}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -1219,3 +1044,178 @@ export interface NetworkService {
     updateConfig: (request: UpdateConfigRequest, options?: RequestOptions) => Promise<void>;
     queryStatus: (request: void, options?: RequestOptions) => Stream<NetworkStatus>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface Metrics {
+    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    values?: Metrics.KeyPair[];
+}
+export namespace Metrics {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export interface KeyPair {
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        key?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        value?: dxos_value.Value;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        stats?: dxos_value.Stats;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface ControlMetricsRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    reset?: boolean;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    record?: boolean;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface ControlMetricsResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    recording?: boolean;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface QueryMetricsRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    interval?: number;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface QueryMetricsResponse {
+    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    metrics: Metrics;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export enum LogLevel {
+    TRACE = 5,
+    DEBUG = 10,
+    INFO = 11,
+    WARN = 12,
+    ERROR = 13
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface QueryLogsRequest {
+    filters?: QueryLogsRequest.Filter[];
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    options?: QueryLogsRequest.MatchingOptions;
+}
+export namespace QueryLogsRequest {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export enum MatchingOptions {
+        INCLUSIVE = 1,
+        EXPLICIT = 2
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export interface Filter {
+        level: LogLevel;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        pattern?: string;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface LogEntry {
+    level: LogLevel;
+    message: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    meta?: LogEntry.Meta;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    error?: dxos_error.Error;
+    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+}
+export namespace LogEntry {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export interface Meta {
+        file: string;
+        line: number;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        scope?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        resourceId?: number;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface LoggingService {
+    controlMetrics: (request: ControlMetricsRequest, options?: RequestOptions) => Promise<ControlMetricsResponse>;
+    queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
+    queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
+}

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

@@ -67,70 +67,43 @@ import * as google_protobuf from "../../google/protobuf";
  *   {@link file://./../../../dxos/echo/service.proto}
  */
 export interface SubscribeRequest {
-    spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    subscriptionId: string;
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/echo/service.proto}
  */
-export interface EchoEvent {
-    /**
-     * If this event comes as a response to this client wirting the mutation, this field will be set to the tag in the mutation.
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    clientTag?: string;
-    /**
-     * For mutations read from the feed store those fields will be set to the position of the mutation in the feed.
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    feedKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    seq?: number;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    action?: EchoEvent.DatabaseAction;
-    batch: dxos_echo_object.EchoObjectBatch;
-}
-export namespace EchoEvent {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/echo/service.proto}
-     */
-    export enum DatabaseAction {
-        RESET = 0
-    }
+export interface BatchedDocumentUpdates {
+    updates?: DocumentUpdate[];
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/echo/service.proto}
  */
 export interface WriteRequest {
-    spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    /**
-     * Ephermal tag to correlate events in the subscription.
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    clientTag?: string;
-    batch: dxos_echo_object.EchoObjectBatch;
+    subscriptionId: string;
+    updates?: DocumentUpdate[];
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/echo/service.proto}
  */
-export interface MutationReceipt {
-    feedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    seq: number;
+export interface UpdateSubscriptionRequest {
+    /**
+     * Id of the subscription to update.
+     * Subscription id is returned by `Subscribe` rpc.
+     */
+    subscriptionId: string;
+    /**
+     * Automerge document ids to subscribe for updates.
+     * Used for already existing documents.
+     * To add new document use `write` rpc.
+     */
+    addIds?: string[];
+    /**
+     * Automerge document ids to unsubscribe from.
+     */
+    removeIds?: string[];
 }
 /**
  * Defined in:
@@ -157,6 +130,29 @@ export namespace FlushRequest {
         heads?: string[];
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/echo/service.proto}
+ */
+export interface DocumentUpdate {
+    /**
+     * Automerge document id.
+     */
+    documentId: string;
+    /**
+     * Automerge document incremental update.
+     * 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:
  *   {@link file://./../../../dxos/echo/service.proto}
@@ -237,8 +233,21 @@ export interface ReIndexHeadsRequest {
  *   {@link file://./../../../dxos/echo/service.proto}
  */
 export interface DataService {
-    subscribe: (request: SubscribeRequest, options?: RequestOptions) => Stream<EchoEvent>;
-    write: (request: WriteRequest, options?: RequestOptions) => Promise<MutationReceipt>;
+    /**
+     * Subscribe to incremental updates of multiple automerge socuments.
+     * Which documents are subscribed to is defined in the `UpdateSubscription`.
+     * Used to propagate changes from services to client.
+     */
+    subscribe: (request: SubscribeRequest, options?: RequestOptions) => Stream<BatchedDocumentUpdates>;
+    /**
+     * Change which documents are subscribed to for specific subscription.
+     */
+    updateSubscription: (request: UpdateSubscriptionRequest, options?: RequestOptions) => Promise<void>;
+    /**
+     * Write incremental updates to multiple automerge documents.
+     * Used to propagate changes from client to services.
+     */
+    write: (request: WriteRequest, options?: RequestOptions) => Promise<void>;
     flush: (request: FlushRequest, options?: RequestOptions) => Promise<void>;
     getHostInfo: (request: void, options?: RequestOptions) => Promise<HostInfo>;
     syncRepo: (request: SyncRepoRequest, options?: RequestOptions) => Stream<SyncRepoResponse>;

package/src/proto/gen/google/protobuf.ts

@@ -81,14 +81,14 @@ export enum NullValue {
 export interface ListValue {
     values?: Value[];
 }
-export interface Any {
-    type_url: string;
-    value: Uint8Array;
-}
 export interface Timestamp {
     seconds: string;
     nanos: number;
 }
+export interface Any {
+    type_url: string;
+    value: Uint8Array;
+}
 export interface FileDescriptorSet {
     file?: FileDescriptorProto[];
 }