@dxos/protocols 0.8.2-main.12df754 → 0.8.2-main.2f9c567

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;AAmEhE,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAkmBhD,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,86uHAA86uH,CAAC,CAAC,CAAC;AACv+uH,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;AAmEhE,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAmmBhD,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,ghwHAAghwH,CAAC,CAAC,CAAC;AACzkwH,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.8.2-main.12df754",
+  "version": "0.8.2-main.2f9c567",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -72,17 +72,17 @@
   ],
   "dependencies": {
     "@bufbuild/protobuf": "^2.1.0",
-    "@dxos/effect": "0.8.2-main.12df754",
-    "@dxos/codec-protobuf": "0.8.2-main.12df754",
-    "@dxos/invariant": "0.8.2-main.12df754",
-    "@dxos/keys": "0.8.2-main.12df754",
-    "@dxos/timeframe": "0.8.2-main.12df754",
-    "@dxos/util": "0.8.2-main.12df754"
+    "@dxos/codec-protobuf": "0.8.2-main.2f9c567",
+    "@dxos/effect": "0.8.2-main.2f9c567",
+    "@dxos/invariant": "0.8.2-main.2f9c567",
+    "@dxos/keys": "0.8.2-main.2f9c567",
+    "@dxos/timeframe": "0.8.2-main.2f9c567",
+    "@dxos/util": "0.8.2-main.2f9c567"
   },
   "devDependencies": {
     "@bufbuild/buf": "^1.43.0",
     "@bufbuild/protoc-gen-es": "^2.1.0",
-    "effect": "3.13.3"
+    "effect": "3.14.21"
   },
   "peerDependencies": {
     "effect": "^3.13.3"

package/src/buf/proto/gen/dxos/edge/messenger_pb.ts

@@ -20,7 +20,7 @@ import type { Message as Message$1 } from "@bufbuild/protobuf";
  * Describes the file dxos/edge/messenger.proto.
  */
 export const file_dxos_edge_messenger: GenFile = /*@__PURE__*/
-  fileDesc("ChlkeG9zL2VkZ2UvbWVzc2VuZ2VyLnByb3RvEhNkeG9zLmVkZ2UubWVzc2VuZ2VyIoMBCgRQZWVyEhUKCHN3YXJtS2V5GAEgASgJSACIAQESGAoLaWRlbnRpdHlLZXkYAiABKAlIAYgBARIPCgdwZWVyS2V5GAMgASgJEhIKBXN0YXRlGAQgASgMSAKIAQFCCwoJX3N3YXJtS2V5Qg4KDF9pZGVudGl0eUtleUIICgZfc3RhdGUi9QEKB01lc3NhZ2USFgoJdGltZXN0YW1wGAEgASgJSACIAQESLgoGc291cmNlGAogASgLMhkuZHhvcy5lZGdlLm1lc3Nlbmdlci5QZWVySAGIAQESKQoGdGFyZ2V0GAsgAygLMhkuZHhvcy5lZGdlLm1lc3Nlbmdlci5QZWVyEhcKCnNlcnZpY2VfaWQYFCABKAlIAogBARIqCgdwYXlsb2FkGGQgASgLMhQuZ29vZ2xlLnByb3RvYnVmLkFueUgDiAEBQgwKCl90aW1lc3RhbXBCCQoHX3NvdXJjZUINCgtfc2VydmljZV9pZEIKCghfcGF5bG9hZCKUAQoMU3dhcm1SZXF1ZXN0Ej0KBmFjdGlvbhgBIAEoDjIoLmR4b3MuZWRnZS5tZXNzZW5nZXIuU3dhcm1SZXF1ZXN0LkFjdGlvbkgAiAEBEhEKCXN3YXJtS2V5cxgCIAMoCSInCgZBY3Rpb24SCAoESU5GTxAAEggKBEpPSU4QARIJCgVMRUFWRRACQgkKB19hY3Rpb24iSwoNU3dhcm1SZXNwb25zZRIQCghzd2FybUtleRgBIAEoCRIoCgVwZWVycxgCIAMoCzIZLmR4b3MuZWRnZS5tZXNzZW5nZXIuUGVlciIvCgtUZXh0TWVzc2FnZRIUCgdtZXNzYWdlGAEgASgJSACIAQFCCgoIX21lc3NhZ2ViBnByb3RvMw", [file_google_protobuf_any]);
+  fileDesc("ChlkeG9zL2VkZ2UvbWVzc2VuZ2VyLnByb3RvEhNkeG9zLmVkZ2UubWVzc2VuZ2VyIrQCCgRQZWVyEhYKCXN3YXJtX2tleRgBIAEoCUgAiAEBEhkKDGlkZW50aXR5X2tleRgCIAEoCUgBiAEBEhAKCHBlZXJfa2V5GAMgASgJEkMKEGNvbm5lY3Rpb25fc3RhdGUYBSABKA4yJC5keG9zLmVkZ2UubWVzc2VuZ2VyLkNvbm5lY3Rpb25TdGF0ZUgCiAEBEhYKCWNvbm5lY3RlZBgGIAEoAUgDiAEBEhkKDGRpc2Nvbm5lY3RlZBgHIAEoAUgEiAEBEhIKBXN0YXRlGAQgASgMSAWIAQFCDAoKX3N3YXJtX2tleUIPCg1faWRlbnRpdHlfa2V5QhMKEV9jb25uZWN0aW9uX3N0YXRlQgwKCl9jb25uZWN0ZWRCDwoNX2Rpc2Nvbm5lY3RlZEIICgZfc3RhdGUi9QEKB01lc3NhZ2USFgoJdGltZXN0YW1wGAEgASgJSACIAQESLgoGc291cmNlGAogASgLMhkuZHhvcy5lZGdlLm1lc3Nlbmdlci5QZWVySAGIAQESKQoGdGFyZ2V0GAsgAygLMhkuZHhvcy5lZGdlLm1lc3Nlbmdlci5QZWVyEhcKCnNlcnZpY2VfaWQYFCABKAlIAogBARIqCgdwYXlsb2FkGGQgASgLMhQuZ29vZ2xlLnByb3RvYnVmLkFueUgDiAEBQgwKCl90aW1lc3RhbXBCCQoHX3NvdXJjZUINCgtfc2VydmljZV9pZEIKCghfcGF5bG9hZCKUAQoMU3dhcm1SZXF1ZXN0Ej0KBmFjdGlvbhgBIAEoDjIoLmR4b3MuZWRnZS5tZXNzZW5nZXIuU3dhcm1SZXF1ZXN0LkFjdGlvbkgAiAEBEhEKCXN3YXJtS2V5cxgCIAMoCSInCgZBY3Rpb24SCAoESU5GTxAAEggKBEpPSU4QARIJCgVMRUFWRRACQgkKB19hY3Rpb24ifgoNU3dhcm1SZXNwb25zZRIQCghzd2FybUtleRgBIAEoCRIoCgVwZWVycxgCIAMoCzIZLmR4b3MuZWRnZS5tZXNzZW5nZXIuUGVlchIxCg5pbmFjdGl2ZV9wZWVycxgDIAMoCzIZLmR4b3MuZWRnZS5tZXNzZW5nZXIuUGVlciIvCgtUZXh0TWVzc2FnZRIUCgdtZXNzYWdlGAEgASgJSACIAQFCCgoIX21lc3NhZ2UqUgoPQ29ubmVjdGlvblN0YXRlEg0KCUNPTk5FQ1RFRBAAEhcKE0RJU0NPTk5FQ1RFRF9OT1JNQUwQARIXChNESVNDT05ORUNURURfQUJSVVBUEAJiBnByb3RvMw", [file_google_protobuf_any]);
 
 /**
  *
@@ -28,6 +28,7 @@ export const file_dxos_edge_messenger: GenFile = /*@__PURE__*/
  *
  * TODO(burdon): Distinguish between point-to-point and broadcast messaging.
  * TODO(burdon): Rename PeerInfo?
+ * TODO(mykola): Separate peer info and peer state into different messages.
  *
  * @generated from message dxos.edge.messenger.Peer
  */
@@ -35,20 +36,48 @@ export type Peer = Message$1<"dxos.edge.messenger.Peer"> & {
   /**
    * TODO(burdon): Rename topic?
    *
-   * @generated from field: optional string swarmKey = 1;
+   * @generated from field: optional string swarm_key = 1;
    */
   swarmKey?: string;
 
   /**
-   * @generated from field: optional string identityKey = 2;
+   * @generated from field: optional string identity_key = 2;
    */
   identityKey?: string;
 
   /**
-   * @generated from field: string peerKey = 3;
+   * @generated from field: string peer_key = 3;
    */
   peerKey: string;
 
+  /**
+   * *
+   * State of the connection to the swarm.
+   *
+   * *
+   * UNIX timestamp of the connection.
+   * @example 1715142000000
+   *
+   * @generated from field: optional dxos.edge.messenger.ConnectionState connection_state = 5;
+   */
+  connectionState?: ConnectionState;
+
+  /**
+   * Note: it is not `int64` because `int64` is compiled as a `string` in 'buf' and as a `number` in 'proto-js'.
+   *
+   * @generated from field: optional double connected = 6;
+   */
+  connected?: number;
+
+  /**
+   * *
+   * UNIX timestamp of the disconnection.
+   * @example 1715142000000
+   *
+   * @generated from field: optional double disconnected = 7;
+   */
+  disconnected?: number;
+
   /**
    * *
    * Optional opeage data that represents peer state is updated on `join` request and all peers in swarm are notified.
@@ -182,6 +211,14 @@ export type SwarmResponse = Message$1<"dxos.edge.messenger.SwarmResponse"> & {
    * @generated from field: repeated dxos.edge.messenger.Peer peers = 2;
    */
   peers: Peer[];
+
+  /**
+   * *
+   * The list of peers that recently left the swarm.
+   *
+   * @generated from field: repeated dxos.edge.messenger.Peer inactive_peers = 3;
+   */
+  inactivePeers: Peer[];
 };
 
 /**
@@ -212,3 +249,29 @@ export type TextMessage = Message$1<"dxos.edge.messenger.TextMessage"> & {
 export const TextMessageSchema: GenMessage<TextMessage> = /*@__PURE__*/
   messageDesc(file_dxos_edge_messenger, 4);
 
+/**
+ * @generated from enum dxos.edge.messenger.ConnectionState
+ */
+export enum ConnectionState {
+  /**
+   * @generated from enum value: CONNECTED = 0;
+   */
+  CONNECTED = 0,
+
+  /**
+   * @generated from enum value: DISCONNECTED_NORMAL = 1;
+   */
+  DISCONNECTED_NORMAL = 1,
+
+  /**
+   * @generated from enum value: DISCONNECTED_ABRUPT = 2;
+   */
+  DISCONNECTED_ABRUPT = 2,
+}
+
+/**
+ * Describes the enum dxos.edge.messenger.ConnectionState.
+ */
+export const ConnectionStateSchema: GenEnum<ConnectionState> = /*@__PURE__*/
+  enumDesc(file_dxos_edge_messenger, 0);
+

package/src/edge.ts

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Schema as S } from 'effect';
+import { Schema } from 'effect';
 
 import { SpaceId } from '@dxos/keys';
 
@@ -160,13 +160,13 @@ export enum OAuthProvider {
   GOOGLE = 'google',
 }
 
-export const InitiateOAuthFlowRequestSchema = S.Struct({
-  provider: S.Enums(OAuthProvider),
-  spaceId: S.String.pipe(S.filter(SpaceId.isValid)),
-  accessTokenId: S.String,
-  scopes: S.mutable(S.Array(S.String)),
+export const InitiateOAuthFlowRequestSchema = Schema.Struct({
+  provider: Schema.Enums(OAuthProvider),
+  spaceId: Schema.String.pipe(Schema.filter(SpaceId.isValid)),
+  accessTokenId: Schema.String,
+  scopes: Schema.mutable(Schema.Array(Schema.String)),
 });
-export type InitiateOAuthFlowRequest = S.Schema.Type<typeof InitiateOAuthFlowRequestSchema>;
+export type InitiateOAuthFlowRequest = Schema.Schema.Type<typeof InitiateOAuthFlowRequestSchema>;
 
 export type InitiateOAuthFlowResponse = {
   authUrl: string;
@@ -175,3 +175,11 @@ export type InitiateOAuthFlowResponse = {
 export type OAuthFlowResult =
   | { success: true; accessToken: string; accessTokenId: string }
   | { success: false; reason: string };
+
+export enum EdgeWebsocketProtocol {
+  V0 = 'edge-ws-v0',
+  /**
+   * Enables message framing and muxing by service-id.
+   */
+  V1 = 'edge-ws-v1',
+}

package/src/errors/parameter.ts

@@ -2,6 +2,10 @@
 // Copyright 2024 DXOS.org
 //
 
+/**
+ * @deprecated Use `invariant` instead?
+ */
+// TODO(burdon): Use consistently.
 export const assertParameter = (parameterName: string, condition: unknown, expected?: string): asserts condition => {
   if (!condition) {
     throw new TypeError(`Parameter \`${parameterName}\` is invalid. Expected ${expected}.`);

package/src/invitation.ts

@@ -2,13 +2,13 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Schema as S } from 'effect';
+import { Schema } from 'effect';
 
 import { ParamKeyAnnotation } from '@dxos/effect';
 
 // TODO(burdon): Use uniformly for processing HTTP params.
-export const InvitationUrl = S.Struct({
-  accessToken: S.String, // TODO(burdon): Remove.
-  deviceInvitationCode: S.String.pipe(ParamKeyAnnotation({ key: 'deviceInvitationCode' })),
-  spaceInvitationCode: S.String.pipe(ParamKeyAnnotation({ key: 'spaceInvitationCode' })),
+export const InvitationUrl = Schema.Struct({
+  accessToken: Schema.String, // TODO(burdon): Remove.
+  deviceInvitationCode: Schema.String.pipe(ParamKeyAnnotation({ key: 'deviceInvitationCode' })),
+  spaceInvitationCode: Schema.String.pipe(ParamKeyAnnotation({ key: 'spaceInvitationCode' })),
 });

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

@@ -19,16 +19,42 @@ package dxos.edge.messenger;
 //  - Do peers without a HALO (that are joining existing identity) have the indentity key missing? How are they identified.
 //  - Do point-to-point messages need to go through a swarm, or can routers communicate directly?
 
+
+enum ConnectionState {
+  CONNECTED = 0;
+  DISCONNECTED_NORMAL = 1;
+  DISCONNECTED_ABRUPT = 2; 
+}
+
 //
 // Network peer.
 //
 // TODO(burdon): Distinguish between point-to-point and broadcast messaging.
 // TODO(burdon): Rename PeerInfo?
+// TODO(mykola): Separate peer info and peer state into different messages.
 message Peer {
+  
   // TODO(burdon): Rename topic?
-  optional string swarmKey = 1;
-  optional string identityKey = 2;
-  string peerKey = 3;
+  optional string swarm_key = 1;
+  optional string identity_key = 2;
+  string peer_key = 3;
+
+  /**
+   * State of the connection to the swarm.
+   */
+  optional ConnectionState connection_state = 5;
+  /**
+   * UNIX timestamp of the connection.
+   * @example 1715142000000
+   */
+  // Note: it is not `int64` because `int64` is compiled as a `string` in 'buf' and as a `number` in 'proto-js'.
+  optional double connected = 6;
+  /**
+   * UNIX timestamp of the disconnection.
+   * @example 1715142000000
+   */
+  optional double disconnected = 7;
+
   /**
    * 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.
@@ -73,6 +99,11 @@ message SwarmResponse {
    * The list of peers in the swarm.
    */
   repeated Peer peers = 2;
+
+  /**
+   * The list of peers that recently left the swarm.
+   */
+  repeated Peer inactive_peers = 3;
 }
 
 //

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

@@ -65,6 +65,15 @@ import * as dxos_value from "../value.js";
 import * as example_testing_data from "../../example/testing/data.js";
 import * as example_testing_rpc from "../../example/testing/rpc.js";
 import * as google_protobuf from "../../google/protobuf.js";
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/edge/messenger.proto}
+ */
+export enum ConnectionState {
+    CONNECTED = 0,
+    DISCONNECTED_NORMAL = 1,
+    DISCONNECTED_ABRUPT = 2
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/edge/messenger.proto}
@@ -81,6 +90,26 @@ export interface Peer {
      */
     identityKey?: string;
     peerKey: string;
+    /**
+     * State of the connection to the swarm.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    connectionState?: ConnectionState;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    connected?: number;
+    /**
+     * UNIX timestamp of the disconnection.
+     * @example 1715142000000
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    disconnected?: number;
     /**
      * 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.
@@ -152,6 +181,10 @@ export interface SwarmResponse {
      * The list of peers in the swarm.
      */
     peers?: Peer[];
+    /**
+     * The list of peers that recently left the swarm.
+     */
+    inactivePeers?: Peer[];
 }
 /**
  * Defined in: