@dxos/protocols 0.4.10-main.ef6fbc2 → 0.4.10-main.f15a546

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;AA8DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA4hB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,wksGAAwksG,CAAC,CAAC,CAAC;AACjosG,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;AA+hB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,4uvGAA4uvG,CAAC,CAAC,CAAC;AACryvG,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.10-main.ef6fbc2",
+  "version": "0.4.10-main.f15a546",
   "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.10-main.ef6fbc2",
-    "@dxos/keys": "0.4.10-main.ef6fbc2",
-    "@dxos/invariant": "0.4.10-main.ef6fbc2",
-    "@dxos/timeframe": "0.4.10-main.ef6fbc2"
+    "@dxos/codec-protobuf": "0.4.10-main.f15a546",
+    "@dxos/keys": "0.4.10-main.f15a546",
+    "@dxos/invariant": "0.4.10-main.f15a546",
+    "@dxos/timeframe": "0.4.10-main.f15a546"
   },
   "devDependencies": {
     "glob": "~7.1.6"

package/src/indexing.ts

@@ -2,15 +2,19 @@
 // Copyright 2024 DXOS.org
 //
 
-// TODO(dmaretskyi): Rename ObjectPointer{Decoded/Encoded}.
-export type IdDecoded = {
+export type ObjectPointerDecoded = {
   documentId: string;
   objectId: string;
 };
 
+/**
+ * Encoded object pointer: `${documentId}|${objectId}`.
+ */
+export type ObjectPointerEncoded = string;
+
 export const idCodec = {
-  encode: ({ documentId, objectId }: IdDecoded) => `${documentId}|${objectId}`,
-  decode: (id: string): IdDecoded => {
+  encode: ({ documentId, objectId }: ObjectPointerDecoded): ObjectPointerEncoded => `${documentId}|${objectId}`,
+  decode: (id: ObjectPointerEncoded): ObjectPointerDecoded => {
     const [documentId, objectId] = id.split('|');
     return { documentId, objectId };
   },

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

@@ -10,8 +10,6 @@ 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";
@@ -384,16 +382,6 @@ 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 (stream dxos.agent.query.QueryResponse);
-  
-}
-
 //
 // Invitations (Halo and Data Spaces).
 //
@@ -405,9 +393,12 @@ message Invitation {
   enum Type {
     /// Requires both to be online to complete key exchange.
     INTERACTIVE = 0;
-    /// Guest's identity key is known; invitation can be accepted by any valid peer.
-    OFFLINE = 1;
-    /// Multiple-use interactive invitation.
+    /// Invitation can be accepted by any valid peer.
+    DELEGATED = 1;
+    /**
+     * Multi-use interactive invitations.
+     * @deprecated use multiUse flag with type=interactive instead.
+     */
     MULTIUSE = 2;
   }
 
@@ -422,6 +413,9 @@ message Invitation {
 
     /// Guest should call `Authenticate` with the shared secret.
     SHARED_SECRET = 1;
+
+    /// Guest should prove they possess a private key corresponding to the known public key recorded in an invitation.
+    KNOWN_PUBLIC_KEY = 2;
   }
 
   enum State {
@@ -480,6 +474,20 @@ message Invitation {
   // 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;
+
+  /// Whether an invitation can be used multiple times.
+  optional bool multi_use = 15;
+
+  /// Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
+  optional AdmissionKeypair guest_keypair = 16;
+
+  /// Present on Type.DELEGATED invitations.
+  optional dxos.keys.PublicKey delegation_credential_id = 17;
+}
+
+message AdmissionKeypair {
+  dxos.keys.PublicKey public_key = 1;
+  optional dxos.keys.PrivateKey private_key = 2;
 }
 
 message AcceptInvitationRequest {
@@ -534,7 +542,6 @@ 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/config.proto

@@ -131,9 +131,13 @@ message Runtime {
     /// Location of the remote client host.
     // TODO(burdon): Rename vault_endpoint (generalize http/ws; drop vault.html).
     optional string remote_source = 6;
-    
+
+    // Authenticate via `Sec-WebSocket-Protocol` header hack.
+    optional string remote_source_authentication_token = 8;
+
     /// Connect to and serve client services to a remote proxy.
     optional string devtools_proxy = 7;
+
   }
 
   message App {

package/src/proto/dxos/echo/model/document.proto

@@ -32,9 +32,6 @@ message Value {
     Array array                       = 21;
 
     Reference reference               = 30;
-
-    // YJS state snapshot.
-    YJS yjs                           = 40;
   }
 }
 

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

@@ -0,0 +1,37 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/empty.proto";
+
+import "dxos/keys.proto";
+import "dxos/echo/filter.proto";
+import "dxos/echo/object.proto";
+import "dxos/echo/indexing.proto";
+
+package dxos.echo.query;
+
+message QueryRequest {
+  optional string queryId = 1;
+  dxos.echo.filter.Filter filter = 2;
+}
+
+message QueryResult {
+  string id = 1;
+  dxos.keys.PublicKey spaceKey = 2;
+  float rank = 3;
+}
+
+message QueryResponse {
+  optional string queryId = 1;
+  repeated QueryResult results = 2;
+  repeated dxos.echo.object.EchoObject objects = 3;
+}
+
+service QueryService {
+  rpc SetIndexConfig(dxos.echo.indexing.IndexConfig) returns (google.protobuf.Empty);
+  rpc Find(QueryRequest) returns (stream QueryResponse);
+  rpc ReIndex(google.protobuf.Empty) returns (google.protobuf.Empty);
+}

package/src/proto/dxos/halo/credentials.proto

@@ -9,6 +9,7 @@ package dxos.halo.credentials;
 option go_package = "github.com/dxos/kube/proto/def/dxos/halo/credentials";
 
 import "google/protobuf/any.proto";
+import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
 
 import "dxos/echo/timeframe.proto";
@@ -68,6 +69,9 @@ message SpaceMember {
   /// Genesis feed of the space.
   /// Needed so that the admitted member can start replicating the space based on this credential alone.
   dxos.keys.PublicKey genesis_feed_key = 4;
+
+  /// Present to associate SpaceMember admissions with delegated invitations.
+  optional dxos.keys.PublicKey invitation_credential_id = 5;
 }
 
 message MemberProfile {

package/src/proto/dxos/halo/invitations.proto

@@ -5,6 +5,7 @@
 syntax = "proto3";
 
 import "google/protobuf/empty.proto";
+import "google/protobuf/timestamp.proto";
 
 import "dxos/client/services.proto";
 import "dxos/echo/timeframe.proto";
@@ -33,12 +34,19 @@ message IntroductionRequest {
 message IntroductionResponse {
   dxos.client.services.Invitation.AuthMethod auth_method = 1;
 
+  /// Present when auth_method is KNOWN_PUBLIC_KEY.
+  optional bytes challenge = 2;
+
   /// Only present for testing invitation types.
   optional dxos.keys.PublicKey space_key = 100;
 }
 
 message AuthenticationRequest {
-  string auth_code = 1;
+  /// Present when auth_method is SHARED_SECRET.
+  optional string auth_code = 1;
+
+  /// Present when auth_method is KNOWN_PUBLIC_KEY.
+  optional bytes signed_challenge = 2;
 }
 
 message AuthenticationResponse {
@@ -47,6 +55,7 @@ message AuthenticationResponse {
     INVALID_OTP = 1;
     INVALID_OPT_ATTEMPTS = 2;
     INTERNAL_ERROR = 3;
+    INVALID_SIGNATURE = 4;
   }
 
   optional Status status = 1;
@@ -66,6 +75,21 @@ message SpaceAdmissionRequest {
   dxos.keys.PublicKey data_feed_key = 4;
 }
 
+message DelegateSpaceInvitation {
+  string invitation_id = 1;
+  dxos.client.services.Invitation.AuthMethod auth_method = 2;
+  dxos.keys.PublicKey swarm_key = 3;
+  dxos.halo.credentials.SpaceMember.Role role = 4;
+  /// Present for AuthMethod.KNOWN_PUBLIC_KEY, where guess needs to prove possession of a corresponding private key
+  optional dxos.keys.PublicKey guest_key = 5;
+  optional google.protobuf.Timestamp expires_on = 6;
+  bool multi_use = 7;
+}
+
+message CancelDelegatedInvitation {
+  dxos.keys.PublicKey credential_id = 1;
+}
+
 message AdmissionRequest {
   oneof kind {
     DeviceAdmissionRequest device = 1;

package/src/proto/dxos/mesh/swarm.proto

@@ -9,14 +9,19 @@ import "dxos/keys.proto";
 
 package dxos.mesh.swarm;
 
+/**
+ * Use for:
+ * - Initial peer discovery (initiate session id between two peers).
+ * - RTC negotiation (SDP offer/answer and ICE).
+ */
 message SwarmMessage {
-  /// Swarm identefier.
+  /// Swarm identifier.
   dxos.keys.PublicKey topic = 3;
   /// Unique connection identifier.
   dxos.keys.PublicKey session_id = 4;
   /// Message payload.
   MessageData data = 5;
-  /// Unique message identifier. Used for Acknolegment and matching Anwers to Offers.
+  /// Unique message identifier. Used for ACK and matching Answers to Offers.
   dxos.keys.PublicKey message_id = 6;
 }
 
@@ -29,7 +34,6 @@ message MessageData {
      * @deprecated Use SignalBatch instead.
      */
     Signal signal = 3;
-    
     SignalBatch signal_batch = 4;
   }
 }
@@ -43,6 +47,10 @@ message Answer {
   optional dxos.keys.PublicKey offer_message_id = 2;
 }
 
+//
+// RTC messages.
+//
+
 message Signal {
   google.protobuf.Struct payload = 1;
 }

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

@@ -3,7 +3,6 @@ import substitutions from "../../../substitutions";
 import * as dxos_agent_echoproxy from "./echoproxy";
 import * as dxos_agent_epoch from "./epoch";
 import * as dxos_agent_functions from "./functions";
-import * as dxos_agent_query from "./query";
 import * as dxos_bot from "../bot";
 import * as dxos_client_services from "../client/services";
 import * as dxos_config from "../config";
@@ -18,6 +17,7 @@ import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";
 import * as dxos_echo_model_text from "../echo/model/text";
 import * as dxos_echo_object from "../echo/object";
+import * as dxos_echo_query from "../echo/query";
 import * as dxos_echo_service from "../echo/service";
 import * as dxos_echo_snapshot from "../echo/snapshot";
 import * as dxos_echo_timeframe from "../echo/timeframe";

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

@@ -3,7 +3,6 @@ import substitutions from "../../../substitutions";
 import * as dxos_agent_dashboard from "./dashboard";
 import * as dxos_agent_epoch from "./epoch";
 import * as dxos_agent_functions from "./functions";
-import * as dxos_agent_query from "./query";
 import * as dxos_bot from "../bot";
 import * as dxos_client_services from "../client/services";
 import * as dxos_config from "../config";
@@ -18,6 +17,7 @@ import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";
 import * as dxos_echo_model_text from "../echo/model/text";
 import * as dxos_echo_object from "../echo/object";
+import * as dxos_echo_query from "../echo/query";
 import * as dxos_echo_service from "../echo/service";
 import * as dxos_echo_snapshot from "../echo/snapshot";
 import * as dxos_echo_timeframe from "../echo/timeframe";

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

@@ -3,7 +3,6 @@ import substitutions from "../../../substitutions";
 import * as dxos_agent_dashboard from "./dashboard";
 import * as dxos_agent_echoproxy from "./echoproxy";
 import * as dxos_agent_functions from "./functions";
-import * as dxos_agent_query from "./query";
 import * as dxos_bot from "../bot";
 import * as dxos_client_services from "../client/services";
 import * as dxos_config from "../config";
@@ -18,6 +17,7 @@ import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";
 import * as dxos_echo_model_text from "../echo/model/text";
 import * as dxos_echo_object from "../echo/object";
+import * as dxos_echo_query from "../echo/query";
 import * as dxos_echo_service from "../echo/service";
 import * as dxos_echo_snapshot from "../echo/snapshot";
 import * as dxos_echo_timeframe from "../echo/timeframe";

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

@@ -3,7 +3,6 @@ import substitutions from "../../../substitutions";
 import * as dxos_agent_dashboard from "./dashboard";
 import * as dxos_agent_echoproxy from "./echoproxy";
 import * as dxos_agent_epoch from "./epoch";
-import * as dxos_agent_query from "./query";
 import * as dxos_bot from "../bot";
 import * as dxos_client_services from "../client/services";
 import * as dxos_config from "../config";
@@ -18,6 +17,7 @@ import * as dxos_echo_model_document from "../echo/model/document";
 import * as dxos_echo_model_messenger from "../echo/model/messenger";
 import * as dxos_echo_model_text from "../echo/model/text";
 import * as dxos_echo_object from "../echo/object";
+import * as dxos_echo_query from "../echo/query";
 import * as dxos_echo_service from "../echo/service";
 import * as dxos_echo_snapshot from "../echo/snapshot";
 import * as dxos_echo_timeframe from "../echo/timeframe";

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

@@ -4,7 +4,6 @@ import * as dxos_agent_dashboard from "./agent/dashboard";
 import * as dxos_agent_echoproxy from "./agent/echoproxy";
 import * as dxos_agent_epoch from "./agent/epoch";
 import * as dxos_agent_functions from "./agent/functions";
-import * as dxos_agent_query from "./agent/query";
 import * as dxos_client_services from "./client/services";
 import * as dxos_config from "./config";
 import * as dxos_devtools_host from "./devtools/host";
@@ -18,6 +17,7 @@ import * as dxos_echo_model_document from "./echo/model/document";
 import * as dxos_echo_model_messenger from "./echo/model/messenger";
 import * as dxos_echo_model_text from "./echo/model/text";
 import * as dxos_echo_object from "./echo/object";
+import * as dxos_echo_query from "./echo/query";
 import * as dxos_echo_service from "./echo/service";
 import * as dxos_echo_snapshot from "./echo/snapshot";
 import * as dxos_echo_timeframe from "./echo/timeframe";