@dxos/protocols 0.4.7 → 0.4.8-main.00e6f19

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;AA8DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA4hB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,mtqGAAmtqG,CAAC,CAAC,CAAC;AAC5wqG,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.00e6f19",
   "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/codec-protobuf": "0.4.8-main.00e6f19",
+    "@dxos/invariant": "0.4.8-main.00e6f19",
+    "@dxos/keys": "0.4.8-main.00e6f19",
+    "@dxos/timeframe": "0.4.8-main.00e6f19"
   },
   "devDependencies": {
     "glob": "~7.1.6"

package/src/indexing.ts

@@ -2,9 +2,14 @@
 // Copyright 2024 DXOS.org
 //
 
+export type IdDecoded = {
+  documentId: string;
+  objectId: string;
+};
+
 export const idCodec = {
-  encode: ({ documentId, objectId }: { documentId: string; objectId: string }) => `${documentId}|${objectId}`,
-  decode: (id: string) => {
+  encode: ({ documentId, objectId }: IdDecoded) => `${documentId}|${objectId}`,
+  decode: (id: string): IdDecoded => {
     const [documentId, objectId] = id.split('|');
     return { documentId, objectId };
   },

package/src/proto/dxos/agent/query.proto

@@ -26,4 +26,3 @@ message QueryResponse {
   repeated QueryResult results = 2;
   repeated object.EchoObject objects = 3;
 }
-

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

@@ -10,6 +10,8 @@ import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
 
 import "dxos/config.proto";
+import "dxos/agent/query.proto";
+import "dxos/echo/indexing.proto";
 import "dxos/echo/metadata.proto";
 import "dxos/echo/timeframe.proto";
 import "dxos/error.proto";
@@ -351,6 +353,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;
@@ -376,6 +381,15 @@ service SpacesService {
   rpc CreateEpoch(CreateEpochRequest) returns (google.protobuf.Empty);
 }
 
+//
+// Indexing
+//
+
+service IndexService {
+  rpc SetConfig(dxos.echo.indexing.IndexConfig) returns (google.protobuf.Empty);
+  rpc Find(dxos.agent.query.QueryRequest) returns (dxos.agent.query.QueryResponse);
+}
+
 //
 // Invitations (Halo and Data Spaces).
 //
@@ -416,6 +430,7 @@ message Invitation {
     CANCELLED = 6;
     TIMEOUT = 7;
     ERROR = 8;
+    EXPIRED = 9;
   }
 
   /// Local identifier (random).
@@ -436,7 +451,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 +465,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 +503,8 @@ message QueryInvitationsResponse {
   enum Action {
     ADDED = 0;
     REMOVED = 1;
+    SAVED = 2;
+    LOAD_COMPLETE = 3;
   }
 
   enum Type {
@@ -487,6 +515,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 +530,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/indexing.proto

@@ -0,0 +1,22 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+syntax = "proto3";
+
+package dxos.echo.indexing;
+
+message IndexKind {
+  enum Kind {
+    SCHEMA_MATCH = 0;
+    FIELD_MATCH = 1;
+    FULL_TEXT = 2;
+  }
+  
+  Kind kind = 1;
+  optional string field = 2;
+}
+
+message IndexConfig {
+  repeated IndexKind indexes = 1;
+}

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/agent/dashboard.ts

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "../devtools/swarm";
 import * as dxos_echo_blob from "../echo/blob";
 import * as dxos_echo_feed from "../echo/feed";
 import * as dxos_echo_filter from "../echo/filter";
+import * as dxos_echo_indexing from "../echo/indexing";
 import * as dxos_echo_metadata from "../echo/metadata";
 import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";

package/src/proto/gen/dxos/agent/echoproxy.ts

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "../devtools/swarm";
 import * as dxos_echo_blob from "../echo/blob";
 import * as dxos_echo_feed from "../echo/feed";
 import * as dxos_echo_filter from "../echo/filter";
+import * as dxos_echo_indexing from "../echo/indexing";
 import * as dxos_echo_metadata from "../echo/metadata";
 import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";

package/src/proto/gen/dxos/agent/epoch.ts

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "../devtools/swarm";
 import * as dxos_echo_blob from "../echo/blob";
 import * as dxos_echo_feed from "../echo/feed";
 import * as dxos_echo_filter from "../echo/filter";
+import * as dxos_echo_indexing from "../echo/indexing";
 import * as dxos_echo_metadata from "../echo/metadata";
 import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";

package/src/proto/gen/dxos/agent/functions.ts

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "../devtools/swarm";
 import * as dxos_echo_blob from "../echo/blob";
 import * as dxos_echo_feed from "../echo/feed";
 import * as dxos_echo_filter from "../echo/filter";
+import * as dxos_echo_indexing from "../echo/indexing";
 import * as dxos_echo_metadata from "../echo/metadata";
 import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";

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

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "../devtools/swarm";
 import * as dxos_echo_blob from "../echo/blob";
 import * as dxos_echo_feed from "../echo/feed";
 import * as dxos_echo_filter from "../echo/filter";
+import * as dxos_echo_indexing from "../echo/indexing";
 import * as dxos_echo_metadata from "../echo/metadata";
 import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";

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

@@ -12,6 +12,7 @@ import * as dxos_devtools_swarm from "./devtools/swarm";
 import * as dxos_echo_blob from "./echo/blob";
 import * as dxos_echo_feed from "./echo/feed";
 import * as dxos_echo_filter from "./echo/filter";
+import * as dxos_echo_indexing from "./echo/indexing";
 import * as dxos_echo_metadata from "./echo/metadata";
 import * as dxos_echo_model_document from "./echo/model/document";
 import * as dxos_echo_model_messenger from "./echo/model/messenger";