@dxos/protocols 0.4.7 → 0.4.8-main.ac78619

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;AA6DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAuhB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,46nGAA46nG,CAAC,CAAC,CAAC;AACr+nG,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;AA6DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAwhB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,qnpGAAqnpG,CAAC,CAAC,CAAC;AAC9qpG,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.4.7",
+  "version": "0.4.8-main.ac78619",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -33,10 +33,10 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/codec-protobuf": "0.4.7",
-    "@dxos/invariant": "0.4.7",
-    "@dxos/keys": "0.4.7",
-    "@dxos/timeframe": "0.4.7"
+    "@dxos/invariant": "0.4.8-main.ac78619",
+    "@dxos/timeframe": "0.4.8-main.ac78619",
+    "@dxos/codec-protobuf": "0.4.8-main.ac78619",
+    "@dxos/keys": "0.4.8-main.ac78619"
   },
   "devDependencies": {
     "glob": "~7.1.6"

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

@@ -351,6 +351,9 @@ message CreateEpochRequest {
 
     /// Init empty automerge document as the space root. Disables legacy ECHO snapshot creation.
     INIT_AUTOMERGE = 1;
+
+    /// Init new automerge root by clonning the current space root. History is pruned.
+    PRUNE_AUTOMERGE_ROOT_HISTORY = 2;
   }
 
   dxos.keys.PublicKey space_key = 1;
@@ -416,6 +419,7 @@ message Invitation {
     CANCELLED = 6;
     TIMEOUT = 7;
     ERROR = 8;
+    EXPIRED = 9;
   }
 
   /// Local identifier (random).
@@ -436,7 +440,7 @@ message Invitation {
   /// Local state.
   State state = 6;
 
-  /// Timeout (ms).
+  /// Timeout for guest to complete invitation once connected (ms).
   optional int32 timeout = 7;
 
   /// Guest's identity.
@@ -450,6 +454,17 @@ message Invitation {
 
   /// Path or identifier to navigate to after successful authentication.
   optional string target = 11;
+
+  // TODO(nf): should these exist elsewhere since they only have meaning to the host?
+  /// Host should resume invitation on startup until timeout.
+  optional bool persistent = 12;
+
+  optional google.protobuf.Timestamp created = 13;
+
+  /// Number of seconds the host will honor the invitation. 0 means the invitation persists forever.
+  // TODO(nf): some feedback mechanism or GC for immortal invitations?
+  // TODO(nf): should the creator have a way to make an invitation last as long as the client? this was the previous behavior.
+  optional int32 lifetime = 14;
 }
 
 message AcceptInvitationRequest {
@@ -477,6 +492,8 @@ message QueryInvitationsResponse {
   enum Action {
     ADDED = 0;
     REMOVED = 1;
+    SAVED = 2;
+    LOAD_COMPLETE = 3;
   }
 
   enum Type {
@@ -487,6 +504,13 @@ message QueryInvitationsResponse {
   Action action = 1;
   Type type = 2;
   repeated Invitation invitations = 3;
+  // indicate to caller that invitations of this action/type were existing at time of initial response.
+  optional bool existing = 4;
+}
+
+// Informational, consumers must share invitations to receive CancellableInvitation
+message LoadPersistentInvitationsResponse {
+  repeated Invitation invitations = 1;
 }
 
 service InvitationsService {
@@ -495,6 +519,7 @@ service InvitationsService {
   rpc Authenticate(AuthenticationRequest) returns (google.protobuf.Empty);
   rpc CancelInvitation(CancelInvitationRequest) returns (google.protobuf.Empty);
   rpc QueryInvitations(google.protobuf.Empty) returns (stream QueryInvitationsResponse);
+  rpc LoadPersistentInvitations(google.protobuf.Empty) returns (LoadPersistentInvitationsResponse);
 }
 
 //

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

@@ -6,6 +6,7 @@ syntax = "proto3";
 
 import "google/protobuf/timestamp.proto";
 
+import "dxos/client/services.proto";
 import "dxos/echo/model/document.proto";
 import "dxos/echo/timeframe.proto";
 import "dxos/keys.proto";
@@ -29,6 +30,8 @@ message EchoMetadata {
 
   /// List of the data spaces.
   repeated SpaceMetadata spaces = 11;
+
+  repeated dxos.client.services.Invitation invitations = 12;
 }
 
 /// Per-space metadata. Frequent updates. Keep small.

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

@@ -802,7 +802,8 @@ export namespace CreateEpochRequest {
      */
     export enum Migration {
         NONE = 0,
-        INIT_AUTOMERGE = 1
+        INIT_AUTOMERGE = 1,
+        PRUNE_AUTOMERGE_ROOT_HISTORY = 2
     }
 }
 /**
@@ -863,7 +864,7 @@ export interface Invitation {
      */
     state: Invitation.State;
     /**
-     * Timeout (ms).
+     * Timeout for guest to complete invitation once connected (ms).
      *
      * Options:
      *   - proto3_optional = true
@@ -897,6 +898,23 @@ export interface Invitation {
      *   - proto3_optional = true
      */
     target?: string;
+    /**
+     * Host should resume invitation on startup until timeout.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    persistent?: boolean;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    created?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    lifetime?: number;
 }
 export namespace Invitation {
     /**
@@ -937,7 +955,8 @@ export namespace Invitation {
         SUCCESS = 5,
         CANCELLED = 6,
         TIMEOUT = 7,
-        ERROR = 8
+        ERROR = 8,
+        EXPIRED = 9
     }
 }
 /**
@@ -983,6 +1002,11 @@ export interface QueryInvitationsResponse {
     action: QueryInvitationsResponse.Action;
     type: QueryInvitationsResponse.Type;
     invitations?: Invitation[];
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    existing?: boolean;
 }
 export namespace QueryInvitationsResponse {
     /**
@@ -991,7 +1015,9 @@ export namespace QueryInvitationsResponse {
      */
     export enum Action {
         ADDED = 0,
-        REMOVED = 1
+        REMOVED = 1,
+        SAVED = 2,
+        LOAD_COMPLETE = 3
     }
     /**
      * Defined in:
@@ -1002,6 +1028,13 @@ export namespace QueryInvitationsResponse {
         ACCEPTED = 1
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface LoadPersistentInvitationsResponse {
+    invitations?: Invitation[];
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -1012,6 +1045,7 @@ export interface InvitationsService {
     authenticate: (request: AuthenticationRequest, options?: RequestOptions) => Promise<void>;
     cancelInvitation: (request: CancelInvitationRequest, options?: RequestOptions) => Promise<void>;
     queryInvitations: (request: void, options?: RequestOptions) => Stream<QueryInvitationsResponse>;
+    loadPersistentInvitations: (request: void, options?: RequestOptions) => Promise<LoadPersistentInvitationsResponse>;
 }
 /**
  * Defined in:

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

@@ -83,6 +83,7 @@ export interface EchoMetadata {
      * List of the data spaces.
      */
     spaces?: SpaceMetadata[];
+    invitations?: dxos_client_services.Invitation[];
 }
 /**
  * Per-space metadata. Frequent updates. Keep small.