@dxos/protocols 0.6.1 → 0.6.2-main.8a232a5

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;AAujB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,416GAA416G,CAAC,CAAC,CAAC;AACr56G,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.1",
+  "version": "0.6.2-main.8a232a5",
   "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.1",
-    "@dxos/keys": "0.6.1",
-    "@dxos/timeframe": "0.6.1",
-    "@dxos/util": "0.6.1",
-    "@dxos/invariant": "0.6.1"
+    "@dxos/codec-protobuf": "0.6.2-main.8a232a5",
+    "@dxos/keys": "0.6.2-main.8a232a5",
+    "@dxos/timeframe": "0.6.2-main.8a232a5",
+    "@dxos/util": "0.6.2-main.8a232a5",
+    "@dxos/invariant": "0.6.2-main.8a232a5"
   },
   "devDependencies": {
     "glob": "~7.1.6"

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

@@ -4,75 +4,68 @@
 
 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;
+message BatchedDocumentUpdates {
+  repeated DocumentUpdate updates = 1;
+}
 
-  dxos.echo.object.EchoObjectBatch batch = 10;
+message UpdateRequest {
+  string subscription_id = 1;
+  repeated DocumentUpdate updates = 2;
 }
 
-message WriteRequest {
-  dxos.keys.PublicKey space_key = 1;
-  
-  /// Ephermal tag to correlate events in the subscription.
-  optional string client_tag = 2;
+message UpdateSubscriptionRequest {
+  /**
+   * Id of the subscription to update.
+   * Subscription id is returned by `Subscribe` rpc.
+   */
+  string subscription_id = 1;
 
-  dxos.echo.object.EchoObjectBatch batch = 10;
-}
+  /**
+   * Automerge document ids to subscribe for updates.
+   * Used for already existing documents.
+   * To add new document use `write` rpc.
+   */
+  repeated string add_ids = 3;
 
-message MutationReceipt {
-  dxos.keys.PublicKey feed_key = 1;
-  int32 seq = 2;
+  /**
+   * Automerge document ids to unsubscribe from.
+   */
+  repeated string remove_ids = 4;
 }
 
 message FlushRequest {
-  message DocState {
-    string document_id = 1;
-    repeated string heads = 2;
-  }
-
-  // TODO(dmaretskyi): Does not appear to be used.
-  optional dxos.keys.PublicKey space_key = 1;
   /**
    * Automerge specific document ids to wait to flush.
    */
-  repeated DocState states = 2;
-}
-
-// Automerge specific.
-message HostInfo {
-  string peer_id = 1;
+  repeated string document_ids = 1;
 }
 
-message SyncRepoRequest {
-  string id = 1;
+message DocumentUpdate {
+  /**
+   * Automerge document id.
+   */
+  string document_id = 1;
 
-  optional bytes sync_message = 2;
-}
+  /**
+   * Automerge document incremental update.
+   * Value returned by `Automerge.saveSince()`.
+   */
+  bytes mutation = 2;
 
-message SyncRepoResponse {
-  optional bytes sync_message = 1;
+  /**
+   * Set to true for init mutation of document.
+   * default: undefined.
+   */
+   optional bool is_new = 3;
 }
 
 message DocHeadsList {
@@ -101,15 +94,25 @@ message ReIndexHeadsRequest {
 }
 
 service DataService {
-  rpc Subscribe(SubscribeRequest) returns (stream EchoEvent);
-  rpc Write(WriteRequest) returns (MutationReceipt); // TODO(burdon): Rename SubmitMutation.
-  rpc Flush(FlushRequest) returns (google.protobuf.Empty);
+  /**
+   * 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);
 
-  // Automerge specific.
+  /**
+   * Change which documents are subscribed to for specific subscription.
+   */
+  rpc UpdateSubscription(UpdateSubscriptionRequest) returns (google.protobuf.Empty);
 
-  rpc GetHostInfo(google.protobuf.Empty) returns (HostInfo);
-  rpc SyncRepo(SyncRepoRequest) returns (stream SyncRepoResponse);
-  rpc SendSyncMessage(SyncRepoRequest) returns (google.protobuf.Empty); // TODO(dmaretskyi): Bidirectional streams.
+  /**
+   * Write incremental updates to multiple automerge documents.
+   * Used to propagate changes from client to services.
+   */
+  rpc Update(UpdateRequest) returns (google.protobuf.Empty);
+  rpc Flush(FlushRequest) returns (google.protobuf.Empty);
+  
   rpc GetDocumentHeads(GetDocumentHeadsRequest) returns (GetDocumentHeadsResponse);
 
   /// Wait until the we have the specified changes on the worker locally. Does not take into account the index or client.

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

@@ -67,125 +67,76 @@ 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;
+export interface UpdateRequest {
+    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;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
- */
-export interface FlushRequest {
+export interface UpdateSubscriptionRequest {
     /**
-     * Options:
-     *   - proto3_optional = true
+     * Id of the subscription to update.
+     * Subscription id is returned by `Subscribe` rpc.
      */
-    spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    subscriptionId: string;
     /**
-     * Automerge specific document ids to wait to flush.
+     * Automerge document ids to subscribe for updates.
+     * Used for already existing documents.
+     * To add new document use `write` rpc.
      */
-    states?: FlushRequest.DocState[];
-}
-export namespace FlushRequest {
+    addIds?: string[];
     /**
-     * Defined in:
-     *   {@link file://./../../../dxos/echo/service.proto}
+     * Automerge document ids to unsubscribe from.
      */
-    export interface DocState {
-        documentId: string;
-        heads?: string[];
-    }
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/echo/service.proto}
- */
-export interface HostInfo {
-    peerId: string;
+    removeIds?: string[];
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/echo/service.proto}
  */
-export interface SyncRepoRequest {
-    id: string;
+export interface FlushRequest {
     /**
-     * Options:
-     *   - proto3_optional = true
+     * Automerge specific document ids to wait to flush.
      */
-    syncMessage?: Uint8Array;
+    documentIds?: string[];
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/echo/service.proto}
  */
-export interface SyncRepoResponse {
+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
      */
-    syncMessage?: Uint8Array;
+    isNew?: boolean;
 }
 /**
  * Defined in:
@@ -237,12 +188,22 @@ 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.
+     */
+    update: (request: UpdateRequest, 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>;
-    sendSyncMessage: (request: SyncRepoRequest, options?: RequestOptions) => Promise<void>;
     getDocumentHeads: (request: GetDocumentHeadsRequest, options?: RequestOptions) => Promise<GetDocumentHeadsResponse>;
     /**
      * Wait until the we have the specified changes on the worker locally. Does not take into account the index or client.

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

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