@dxos/protocols 0.7.4 → 0.7.5-labs.35b4b42

package/src/proto/dxos/edge/calls.proto

@@ -0,0 +1,53 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+syntax = "proto3";
+
+import "dxos/keys.proto";
+
+package dxos.edge.calls;
+
+message Tracks {
+  optional string audio = 1;
+  optional bool audio_enabled = 2;
+  optional string video = 3;
+  optional bool video_enabled = 4;
+  optional string screenshare = 5;
+  optional bool screen_share_enabled = 6;
+}
+
+/**
+ * Transcription settings.
+ * It will be merged across all users in the room based on the Lamport timestamp (last one wins).
+ */
+message Transcription {
+  bool enabled = 1;
+  /**
+   * Lamport timestamp of when the state was set.
+   * @see https://en.wikipedia.org/wiki/Lamport_timestamp
+   */
+  int32 lamport_timestamp = 2;
+
+  /**
+   * Object ID of where the transcription should be stored.
+   */
+  string object_id = 3;
+}
+
+message UserState {
+  string id = 1;
+  string name = 2;
+  optional string transceiver_session_id = 3;
+  bool raised_hand = 4;
+  bool speaking = 5;
+  bool joined = 6;
+  Tracks tracks = 7;
+  optional Transcription transcription = 8;
+}
+
+message RoomState {
+  string meetingId = 1;
+  repeated UserState users = 2;
+  optional Transcription transcription = 3;
+}

package/src/proto/dxos/edge/messenger.proto

@@ -29,6 +29,11 @@ message Peer {
   optional string swarmKey = 1;
   optional string identityKey = 2;
   string peerKey = 3;
+  /**
+   * Optional opeage data that represents peer state is updated on `join` request and all peers in swarm are notified.
+   * Is not used for WebRTC protocol, but is useful for another purposes of Swarms, e. g. call room users states.
+   */
+  optional bytes state = 4;
 }
 
 //

package/src/proto/dxos/edge/signal.proto

@@ -0,0 +1,59 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/any.proto";
+import "google/protobuf/timestamp.proto";
+
+import "dxos/keys.proto";
+import "dxos/edge/messenger.proto";
+
+package dxos.edge.signal;
+
+message JoinRequest {
+  dxos.keys.PublicKey topic = 1;
+  dxos.edge.messenger.Peer peer = 2;
+}
+
+message LeaveRequest {
+  dxos.keys.PublicKey topic = 1;
+  dxos.edge.messenger.Peer peer = 2;
+}
+
+message Message {
+  dxos.edge.messenger.Peer author = 1;
+  dxos.edge.messenger.Peer recipient = 2;
+  google.protobuf.Any payload = 3;
+}
+
+/// Goes on Pub/Sub swarm topic and as a Join stream in RPC.
+message SwarmEvent {
+  dxos.keys.PublicKey topic = 1;
+
+  // Announce peer available on swarm.
+  message PeerAvailable {
+    dxos.edge.messenger.Peer peer = 1;
+
+    google.protobuf.Timestamp since = 2;
+
+    // When, if at all (handle the default value as not), this availability would expires were it not re-announced, like
+    // periodically in Pub/Sub with some margin such that Pub/Sub network partitions lead to offline statuses.
+    optional google.protobuf.Timestamp until = 3;
+
+    /// Only relevant in Pub/Sub. Optional, the host topic to eagerly send PeerAvailable messages back to.
+    optional bytes announce_back_to_host = 4;
+  }
+
+  message PeerLeft {
+    dxos.edge.messenger.Peer peer = 1;
+  }
+
+  oneof event {
+    /// The peer was announced as available on the swarm.
+    PeerAvailable peer_available = 2;
+    /// The peer left, or their announcement timed out.
+    PeerLeft peer_left = 3;
+  }
+}

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

@@ -139,6 +139,8 @@ message IdentityRecovery {
   dxos.keys.PublicKey identity_key = 1;
   /// Public key derived from the recovery seedphrase.
   dxos.keys.PublicKey recovery_key = 2;
+  /// Algorithm used to derive the recovery key.
+  int32 algorithm = 3;
 }
 
 message ProfileDocument {

package/src/proto/dxos/mesh/signal.proto

@@ -13,12 +13,14 @@ package dxos.mesh.signal;
 
 option go_package = "github.com/dxos/dxos/proto/def/dxos/mesh/signal";
 
+/// @deprecated
 message JoinRequest {
   bytes swarm = 1;
   bytes peer = 2;
   optional google.protobuf.Struct metadata = 3;
 }
 
+/// @deprecated
 message Message {
   // TODO(egor): Rename to `sender`.
   bytes author = 1;
@@ -27,11 +29,13 @@ message Message {
   optional google.protobuf.Struct metadata = 4;
 }
 
+/// @deprecated
 message ReceptionRequest {
   bytes peer = 1;
 }
 
 /// Goes on Pub/Sub swarm topic and as a Join stream in RPC.
+/// @deprecated
 message SwarmEvent {
   // Announce peer available on swarm.
   message PeerAvailable {
@@ -60,6 +64,7 @@ message SwarmEvent {
 }
 
 /// Goes on a Pub/Sub host topic.
+/// @deprecated
 message HostEvent {
   message AnnounceBack {
       bytes swarm = 1;
@@ -71,12 +76,14 @@ message HostEvent {
 }
 
 /// Goes on Pub/Sub peer topic.
+/// @deprecated
 message PeerEvent {
   oneof event {
     Message message = 1;
   }
 }
 
+/// @deprecated
 enum SignalState {
   /// Connection is being established.
   CONNECTING = 0;
@@ -93,6 +100,7 @@ enum SignalState {
 }
 
 // TOOD(burdon): Rename.
+/// @deprecated
 service Signal {
   rpc Join(JoinRequest) returns (stream SwarmEvent);
   rpc ReceiveMessages(ReceptionRequest) returns (stream Message);

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../echo/query.js";
 import * as dxos_echo_service from "../echo/service.js";
 import * as dxos_echo_snapshot from "../echo/snapshot.js";
 import * as dxos_echo_timeframe from "../echo/timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../echo/query.js";
 import * as dxos_echo_service from "../echo/service.js";
 import * as dxos_echo_snapshot from "../echo/snapshot.js";
 import * as dxos_echo_timeframe from "../echo/timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../echo/query.js";
 import * as dxos_echo_service from "../echo/service.js";
 import * as dxos_echo_snapshot from "../echo/snapshot.js";
 import * as dxos_echo_timeframe from "../echo/timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../echo/query.js";
 import * as dxos_echo_service from "../echo/service.js";
 import * as dxos_echo_snapshot from "../echo/snapshot.js";
 import * as dxos_echo_timeframe from "../echo/timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "./echo/query.js";
 import * as dxos_echo_service from "./echo/service.js";
 import * as dxos_echo_snapshot from "./echo/snapshot.js";
 import * as dxos_echo_timeframe from "./echo/timeframe.js";
+import * as dxos_edge_calls from "./edge/calls.js";
 import * as dxos_edge_messenger from "./edge/messenger.js";
+import * as dxos_edge_signal from "./edge/signal.js";
 import * as dxos_error from "./error.js";
 import * as dxos_gravity from "./gravity.js";
 import * as dxos_halo_credentials from "./halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../echo/query.js";
 import * as dxos_echo_service from "../echo/service.js";
 import * as dxos_echo_snapshot from "../echo/snapshot.js";
 import * as dxos_echo_timeframe from "../echo/timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";
@@ -591,6 +593,7 @@ export interface SystemService {
  *   {@link file://./../../../dxos/client/services.proto}
  */
 export interface Identity {
+    did: string;
     identityKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     /**
      * Options:
@@ -608,14 +611,38 @@ export interface Identity {
  *   {@link file://./../../../dxos/client/services.proto}
  */
 export interface RecoverIdentityRequest {
-    seedphrase: string;
+    recoveryCode: string;
 }
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface CreateRecoveryPhraseResponse {
-    seedphrase: string;
+export interface CreateRecoveryCredentialRequest {
+    /**
+     * Optional recovery key. If not provided, a new key will be generated.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    recoveryKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Algorithm used to generate the recovery key.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    algorithm?: number;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface CreateRecoveryCredentialResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    recoveryCode?: string;
 }
 /**
  * Defined in:
@@ -663,7 +690,7 @@ export interface CreateIdentityRequest {
 export interface IdentityService {
     createIdentity: (request: CreateIdentityRequest, options?: RequestOptions) => Promise<Identity>;
     recoverIdentity: (request: RecoverIdentityRequest, options?: RequestOptions) => Promise<Identity>;
-    createRecoveryPhrase: (request: void, options?: RequestOptions) => Promise<CreateRecoveryPhraseResponse>;
+    createRecoveryCredential: (request: CreateRecoveryCredentialRequest, options?: RequestOptions) => Promise<CreateRecoveryCredentialResponse>;
     queryIdentity: (request: void, options?: RequestOptions) => Stream<QueryIdentityResponse>;
     updateProfile: (request: dxos_halo_credentials.ProfileDocument, options?: RequestOptions) => Promise<Identity>;
     signPresentation: (request: SignPresentationRequest, options?: RequestOptions) => Promise<dxos_halo_credentials.Presentation>;
@@ -1249,6 +1276,13 @@ export namespace NetworkStatus {
 export interface UpdateConfigRequest {
     swarm: ConnectionState;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface SubscribeSwarmStateRequest {
+    topic: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -1256,6 +1290,11 @@ export interface UpdateConfigRequest {
 export interface NetworkService {
     updateConfig: (request: UpdateConfigRequest, options?: RequestOptions) => Promise<void>;
     queryStatus: (request: void, options?: RequestOptions) => Stream<NetworkStatus>;
+    joinSwarm: (request: dxos_edge_signal.JoinRequest, options?: RequestOptions) => Promise<void>;
+    leaveSwarm: (request: dxos_edge_signal.LeaveRequest, options?: RequestOptions) => Promise<void>;
+    subscribeSwarmState: (request: SubscribeSwarmStateRequest, options?: RequestOptions) => Stream<dxos_edge_messenger.SwarmResponse>;
+    sendMessage: (request: dxos_edge_signal.Message, options?: RequestOptions) => Promise<void>;
+    subscribeMessages: (request: dxos_edge_messenger.Peer, options?: RequestOptions) => Stream<dxos_edge_signal.Message>;
 }
 /**
  * Defined in:

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "./echo/query.js";
 import * as dxos_echo_service from "./echo/service.js";
 import * as dxos_echo_snapshot from "./echo/snapshot.js";
 import * as dxos_echo_timeframe from "./echo/timeframe.js";
+import * as dxos_edge_calls from "./edge/calls.js";
 import * as dxos_edge_messenger from "./edge/messenger.js";
+import * as dxos_edge_signal from "./edge/signal.js";
 import * as dxos_error from "./error.js";
 import * as dxos_gravity from "./gravity.js";
 import * as dxos_halo_credentials from "./halo/credentials.js";

package/src/proto/gen/dxos/devtools/host.ts

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../echo/query.js";
 import * as dxos_echo_service from "../echo/service.js";
 import * as dxos_echo_snapshot from "../echo/snapshot.js";
 import * as dxos_echo_timeframe from "../echo/timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

package/src/proto/gen/dxos/devtools/swarm.ts

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../echo/query.js";
 import * as dxos_echo_service from "../echo/service.js";
 import * as dxos_echo_snapshot from "../echo/snapshot.js";
 import * as dxos_echo_timeframe from "../echo/timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "./query.js";
 import * as dxos_echo_service from "./service.js";
 import * as dxos_echo_snapshot from "./snapshot.js";
 import * as dxos_echo_timeframe from "./timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "./query.js";
 import * as dxos_echo_service from "./service.js";
 import * as dxos_echo_snapshot from "./snapshot.js";
 import * as dxos_echo_timeframe from "./timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "./query.js";
 import * as dxos_echo_service from "./service.js";
 import * as dxos_echo_snapshot from "./snapshot.js";
 import * as dxos_echo_timeframe from "./timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "./query.js";
 import * as dxos_echo_service from "./service.js";
 import * as dxos_echo_snapshot from "./snapshot.js";
 import * as dxos_echo_timeframe from "./timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "./query.js";
 import * as dxos_echo_service from "./service.js";
 import * as dxos_echo_snapshot from "./snapshot.js";
 import * as dxos_echo_timeframe from "./timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../query.js";
 import * as dxos_echo_service from "../service.js";
 import * as dxos_echo_snapshot from "../snapshot.js";
 import * as dxos_echo_timeframe from "../timeframe.js";
+import * as dxos_edge_calls from "../../edge/calls.js";
 import * as dxos_edge_messenger from "../../edge/messenger.js";
+import * as dxos_edge_signal from "../../edge/signal.js";
 import * as dxos_error from "../../error.js";
 import * as dxos_gravity from "../../gravity.js";
 import * as dxos_halo_credentials from "../../halo/credentials.js";

package/src/proto/gen/dxos/echo/model/messenger.ts

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../query.js";
 import * as dxos_echo_service from "../service.js";
 import * as dxos_echo_snapshot from "../snapshot.js";
 import * as dxos_echo_timeframe from "../timeframe.js";
+import * as dxos_edge_calls from "../../edge/calls.js";
 import * as dxos_edge_messenger from "../../edge/messenger.js";
+import * as dxos_edge_signal from "../../edge/signal.js";
 import * as dxos_error from "../../error.js";
 import * as dxos_gravity from "../../gravity.js";
 import * as dxos_halo_credentials from "../../halo/credentials.js";

package/src/proto/gen/dxos/echo/model/text.ts

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "../query.js";
 import * as dxos_echo_service from "../service.js";
 import * as dxos_echo_snapshot from "../snapshot.js";
 import * as dxos_echo_timeframe from "../timeframe.js";
+import * as dxos_edge_calls from "../../edge/calls.js";
 import * as dxos_edge_messenger from "../../edge/messenger.js";
+import * as dxos_edge_signal from "../../edge/signal.js";
 import * as dxos_error from "../../error.js";
 import * as dxos_gravity from "../../gravity.js";
 import * as dxos_halo_credentials from "../../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_query from "./query.js";
 import * as dxos_echo_service from "./service.js";
 import * as dxos_echo_snapshot from "./snapshot.js";
 import * as dxos_echo_timeframe from "./timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_object from "./object.js";
 import * as dxos_echo_service from "./service.js";
 import * as dxos_echo_snapshot from "./snapshot.js";
 import * as dxos_echo_timeframe from "./timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_object from "./object.js";
 import * as dxos_echo_query from "./query.js";
 import * as dxos_echo_snapshot from "./snapshot.js";
 import * as dxos_echo_timeframe from "./timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_object from "./object.js";
 import * as dxos_echo_query from "./query.js";
 import * as dxos_echo_service from "./service.js";
 import * as dxos_echo_timeframe from "./timeframe.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";

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

@@ -21,7 +21,9 @@ import * as dxos_echo_object from "./object.js";
 import * as dxos_echo_query from "./query.js";
 import * as dxos_echo_service from "./service.js";
 import * as dxos_echo_snapshot from "./snapshot.js";
+import * as dxos_edge_calls from "../edge/calls.js";
 import * as dxos_edge_messenger from "../edge/messenger.js";
+import * as dxos_edge_signal from "../edge/signal.js";
 import * as dxos_error from "../error.js";
 import * as dxos_gravity from "../gravity.js";
 import * as dxos_halo_credentials from "../halo/credentials.js";