@dxos/protocols 0.8.1 → 0.8.2-main.10c050d

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';
 
@@ -117,6 +117,7 @@ export type UploadFunctionRequest = {
   name?: string;
   script: string;
   version: string;
+  ownerPublicKey: string;
 };
 
 export type UploadFunctionResponseBody = {
@@ -141,7 +142,7 @@ export type CreateSpaceRequest = {
 
 export type CreateSpaceResponseBody = {
   spaceKey: string;
-  spaceId: string;
+  spaceId: string; // TODO(burdon): Use SpaceId.
   automergeRoot: string;
 };
 
@@ -160,13 +161,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)), // TODO(burdon): Use SpaceId.
+  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 +176,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/indexing.ts

@@ -2,6 +2,8 @@
 // Copyright 2024 DXOS.org
 //
 
+import { Schema } from 'effect';
+
 export type ObjectPointerDecoded = {
   spaceKey: string | undefined;
   documentId: string;
@@ -16,6 +18,8 @@ export type ObjectPointerDecoded = {
  */
 export type ObjectPointerEncoded = string;
 
+export const ObjectPointerEncoded = Schema.String.annotations({ title: 'ObjectPointerEncoded' });
+
 const V1_PREFIX = '#01';
 
 export enum ObjectPointerVersion {

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/client/services.proto

@@ -596,12 +596,12 @@ service EdgeAgentService {
   rpc QueryAgentStatus(google.protobuf.Empty) returns (stream QueryAgentStatusResponse);
 }
 
-message QueryEdgeStatusResponse {
-  enum EdgeStatus {
-    NOT_CONNECTED = 0;
-    CONNECTED = 1;
-  }
+enum EdgeStatus {
+  NOT_CONNECTED = 0;
+  CONNECTED = 1;
+}
 
+message QueryEdgeStatusResponse {
   EdgeStatus status = 1;
 }
 

package/src/proto/dxos/config.proto

@@ -151,6 +151,8 @@ message Runtime {
     /// Disabled automerge & hypercore replication through P2P connections.
     optional bool disable_p2p_replication = 10;
 
+    optional bool enable_vector_indexing = 12;
+
     optional EdgeFeatures edge_features = 11;
   }
 

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

@@ -8,9 +8,16 @@ package dxos.echo.indexing;
 
 message IndexKind {
   enum Kind {
+    /// Match by typename.
     SCHEMA_MATCH = 0;
+    /// Match by field value.
     FIELD_MATCH = 1;
+    /// Match by full text.
     FULL_TEXT = 2;
+    /// Match by vector.
+    VECTOR = 3;
+    /// Match by graph relationships.
+    GRAPH = 4;
   }
   
   Kind kind = 1;

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

@@ -15,8 +15,13 @@ package dxos.echo.query;
 
 message QueryRequest {
   optional string queryId = 1;
-  dxos.echo.filter.Filter filter = 2;
   QueryReactivity reactivity = 3;
+
+  /// JSON-encoded `QueryAST.Query`.
+  string query = 5;
+
+  /// @deprecated Use `query` instead.
+  optional dxos.echo.filter.Filter filter = 2;
 }
 
 /**
@@ -38,7 +43,7 @@ message QueryResult {
   optional bytes document_automerge = 11;
   
   /// @deprecated Use spaceId.
-  dxos.keys.PublicKey spaceKey = 2;
+  optional dxos.keys.PublicKey spaceKey = 2;
 }
 
 enum QueryReactivity {

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

@@ -4,7 +4,7 @@
 
 syntax = "proto3";
 
-import "google/protobuf/any.proto";
+import "google/protobuf/struct.proto";
 
 import "dxos/keys.proto";
 
@@ -37,17 +37,18 @@ message UserState {
 message Activity {
   LamportTimestamp lamport_timestamp = 1;
 
-  google.protobuf.Any payload = 10;
+  google.protobuf.Struct payload = 10;
 }
 
 /**
- * Transcription state.
+ * Meeting state.
  *
- * Used to encode/decode the Any payload of a call activity for the transcription plugin.
+ * Used to encode/decode the Any payload of a call activity for the meeting plugin.
  */
- message TranscriptionPayload {
-  bool enabled = 1;
-  string queue_dxn = 2;
+message MeetingPayload {
+  string meeting_id = 1;
+  string transcript_dxn = 2;
+  bool transcription_enabled = 3;
 }
 
 /**

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/client/services.ts

@@ -1399,18 +1399,16 @@ export interface EdgeAgentService {
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export interface QueryEdgeStatusResponse {
-    status: QueryEdgeStatusResponse.EdgeStatus;
+export enum EdgeStatus {
+    NOT_CONNECTED = 0,
+    CONNECTED = 1
 }
-export namespace QueryEdgeStatusResponse {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/services.proto}
-     */
-    export enum EdgeStatus {
-        NOT_CONNECTED = 0,
-        CONNECTED = 1
-    }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface QueryEdgeStatusResponse {
+    status: EdgeStatus;
 }
 /**
  * Defined in:

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

@@ -322,6 +322,11 @@ export namespace Runtime {
          *   - proto3_optional = true
          */
         disableP2pReplication?: boolean;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        enableVectorIndexing?: boolean;
         /**
          * Options:
          *   - proto3_optional = true

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

@@ -85,7 +85,9 @@ export namespace IndexKind {
     export enum Kind {
         SCHEMA_MATCH = 0,
         FIELD_MATCH = 1,
-        FULL_TEXT = 2
+        FULL_TEXT = 2,
+        VECTOR = 3,
+        GRAPH = 4
     }
 }
 /**

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

@@ -75,8 +75,18 @@ export interface QueryRequest {
      *   - proto3_optional = true
      */
     queryId?: string;
-    filter: dxos_echo_filter.Filter;
     reactivity: QueryReactivity;
+    /**
+     * JSON-encoded `QueryAST.Query`.
+     */
+    query: string;
+    /**
+     * @deprecated Use `query` instead.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    filter?: dxos_echo_filter.Filter;
 }
 /**
  * Automerge heads.
@@ -110,8 +120,11 @@ export interface QueryResult {
     documentAutomerge?: Uint8Array;
     /**
      * @deprecated Use spaceId.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
-    spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
 /**
  * Defined in:

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

@@ -128,19 +128,20 @@ export interface UserState {
  */
 export interface Activity {
     lamportTimestamp: LamportTimestamp;
-    payload: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
+    payload: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
 }
 /**
- * Transcription state.
+ * Meeting state.
  *
- * Used to encode/decode the Any payload of a call activity for the transcription plugin.
+ * Used to encode/decode the Any payload of a call activity for the meeting plugin.
  *
  * Defined in:
  *   {@link file://./../../../dxos/edge/calls.proto}
  */
-export interface TranscriptionPayload {
-    enabled: boolean;
-    queueDxn: string;
+export interface MeetingPayload {
+    meetingId: string;
+    transcriptDxn: string;
+    transcriptionEnabled: boolean;
 }
 /**
  * Lamport Timestamp.

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: