@dxos/protocols 0.6.5 → 0.6.6-staging.23d123d

package/src/buf/proto/gen/example/testing/rpc_pb.ts

@@ -0,0 +1,265 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated from file example/testing/rpc.proto (package example.testing.rpc, syntax proto3)
+/* eslint-disable */
+
+import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv1";
+import { fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv1";
+import type { Any, EmptySchema } from "@bufbuild/protobuf/wkt";
+import { file_google_protobuf_any, file_google_protobuf_empty } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file example/testing/rpc.proto.
+ */
+export const file_example_testing_rpc: GenFile = /*@__PURE__*/
+  fileDesc("ChlleGFtcGxlL3Rlc3RpbmcvcnBjLnByb3RvEhNleGFtcGxlLnRlc3RpbmcucnBjIh4KDlRlc3RScGNSZXF1ZXN0EgwKBGRhdGEYASABKAkiHwoPVGVzdFJwY1Jlc3BvbnNlEgwKBGRhdGEYASABKAkiXQoUVGVzdFN0cmVhbVJwY1JlcXVlc3QSDAoEZGF0YRgBIAEoCRIaChJzdHJlYW1Mb2FkSW50ZXJ2YWwYAiABKA0SGwoTc3RyZWFtTG9hZENodW5rU2l6ZRgDIAEoDSKPAQoVVGVzdFN0cmVhbVJwY1Jlc3BvbnNlEgwKBGRhdGEYASABKAkSEQoJYnl0ZXNTZW50GAIgASgNEhUKDWJ5dGVzUmVjZWl2ZWQYAyABKA0SEgoKc2VuZEVycm9ycxgEIAEoDRIVCg1yZWNlaXZlRXJyb3JzGAUgASgNEhMKC3J1bm5pbmdUaW1lGAYgASgNIhwKC1BpbmdSZXF1ZXN0Eg0KBW5vbmNlGAEgASgFIhwKC1BpbmdSZXBvbnNlEg0KBW5vbmNlGAEgASgFIjcKDk1lc3NhZ2VXaXRoQW55EiUKB3BheWxvYWQYASABKAsyFC5nb29nbGUucHJvdG9idWYuQW55MqABCgtUZXN0U2VydmljZRJVCghUZXN0Q2FsbBIjLmV4YW1wbGUudGVzdGluZy5ycGMuVGVzdFJwY1JlcXVlc3QaJC5leGFtcGxlLnRlc3RpbmcucnBjLlRlc3RScGNSZXNwb25zZRI6CghWb2lkQ2FsbBIWLmdvb2dsZS5wcm90b2J1Zi5FbXB0eRoWLmdvb2dsZS5wcm90b2J1Zi5FbXB0eTJsChFUZXN0U3RyZWFtU2VydmljZRJXCghUZXN0Q2FsbBIjLmV4YW1wbGUudGVzdGluZy5ycGMuVGVzdFJwY1JlcXVlc3QaJC5leGFtcGxlLnRlc3RpbmcucnBjLlRlc3RScGNSZXNwb25zZTABMuIBChZUZXN0U2VydmljZVdpdGhTdHJlYW1zEmQKEVJlcXVlc3RUZXN0U3RyZWFtEikuZXhhbXBsZS50ZXN0aW5nLnJwYy5UZXN0U3RyZWFtUnBjUmVxdWVzdBokLmV4YW1wbGUudGVzdGluZy5ycGMuVGVzdFJwY1Jlc3BvbnNlEmIKD0Nsb3NlVGVzdFN0cmVhbRIjLmV4YW1wbGUudGVzdGluZy5ycGMuVGVzdFJwY1JlcXVlc3QaKi5leGFtcGxlLnRlc3RpbmcucnBjLlRlc3RTdHJlYW1ScGNSZXNwb25zZTJZCgtQaW5nU2VydmljZRJKCgRQaW5nEiAuZXhhbXBsZS50ZXN0aW5nLnJwYy5QaW5nUmVxdWVzdBogLmV4YW1wbGUudGVzdGluZy5ycGMuUGluZ1JlcG9uc2UyZgoOVGVzdEFueVNlcnZpY2USVAoIVGVzdENhbGwSIy5leGFtcGxlLnRlc3RpbmcucnBjLk1lc3NhZ2VXaXRoQW55GiMuZXhhbXBsZS50ZXN0aW5nLnJwYy5NZXNzYWdlV2l0aEFueUI0WjJnaXRodWIuY29tL2R4b3MvZHhvcy9wcm90by9kZWYvZXhhbXBsZS90ZXN0aW5nL3JwY2IGcHJvdG8z", [file_google_protobuf_any, file_google_protobuf_empty]);
+
+/**
+ * @generated from message example.testing.rpc.TestRpcRequest
+ */
+export type TestRpcRequest = Message<"example.testing.rpc.TestRpcRequest"> & {
+  /**
+   * @generated from field: string data = 1;
+   */
+  data: string;
+};
+
+/**
+ * Describes the message example.testing.rpc.TestRpcRequest.
+ * Use `create(TestRpcRequestSchema)` to create a new message.
+ */
+export const TestRpcRequestSchema: GenMessage<TestRpcRequest> = /*@__PURE__*/
+  messageDesc(file_example_testing_rpc, 0);
+
+/**
+ * @generated from message example.testing.rpc.TestRpcResponse
+ */
+export type TestRpcResponse = Message<"example.testing.rpc.TestRpcResponse"> & {
+  /**
+   * @generated from field: string data = 1;
+   */
+  data: string;
+};
+
+/**
+ * Describes the message example.testing.rpc.TestRpcResponse.
+ * Use `create(TestRpcResponseSchema)` to create a new message.
+ */
+export const TestRpcResponseSchema: GenMessage<TestRpcResponse> = /*@__PURE__*/
+  messageDesc(file_example_testing_rpc, 1);
+
+/**
+ * @generated from message example.testing.rpc.TestStreamRpcRequest
+ */
+export type TestStreamRpcRequest = Message<"example.testing.rpc.TestStreamRpcRequest"> & {
+  /**
+   * @generated from field: string data = 1;
+   */
+  data: string;
+
+  /**
+   * @generated from field: uint32 streamLoadInterval = 2;
+   */
+  streamLoadInterval: number;
+
+  /**
+   * @generated from field: uint32 streamLoadChunkSize = 3;
+   */
+  streamLoadChunkSize: number;
+};
+
+/**
+ * Describes the message example.testing.rpc.TestStreamRpcRequest.
+ * Use `create(TestStreamRpcRequestSchema)` to create a new message.
+ */
+export const TestStreamRpcRequestSchema: GenMessage<TestStreamRpcRequest> = /*@__PURE__*/
+  messageDesc(file_example_testing_rpc, 2);
+
+/**
+ * @generated from message example.testing.rpc.TestStreamRpcResponse
+ */
+export type TestStreamRpcResponse = Message<"example.testing.rpc.TestStreamRpcResponse"> & {
+  /**
+   * @generated from field: string data = 1;
+   */
+  data: string;
+
+  /**
+   * @generated from field: uint32 bytesSent = 2;
+   */
+  bytesSent: number;
+
+  /**
+   * @generated from field: uint32 bytesReceived = 3;
+   */
+  bytesReceived: number;
+
+  /**
+   * @generated from field: uint32 sendErrors = 4;
+   */
+  sendErrors: number;
+
+  /**
+   * @generated from field: uint32 receiveErrors = 5;
+   */
+  receiveErrors: number;
+
+  /**
+   * @generated from field: uint32 runningTime = 6;
+   */
+  runningTime: number;
+};
+
+/**
+ * Describes the message example.testing.rpc.TestStreamRpcResponse.
+ * Use `create(TestStreamRpcResponseSchema)` to create a new message.
+ */
+export const TestStreamRpcResponseSchema: GenMessage<TestStreamRpcResponse> = /*@__PURE__*/
+  messageDesc(file_example_testing_rpc, 3);
+
+/**
+ * @generated from message example.testing.rpc.PingRequest
+ */
+export type PingRequest = Message<"example.testing.rpc.PingRequest"> & {
+  /**
+   * @generated from field: int32 nonce = 1;
+   */
+  nonce: number;
+};
+
+/**
+ * Describes the message example.testing.rpc.PingRequest.
+ * Use `create(PingRequestSchema)` to create a new message.
+ */
+export const PingRequestSchema: GenMessage<PingRequest> = /*@__PURE__*/
+  messageDesc(file_example_testing_rpc, 4);
+
+/**
+ * @generated from message example.testing.rpc.PingReponse
+ */
+export type PingReponse = Message<"example.testing.rpc.PingReponse"> & {
+  /**
+   * @generated from field: int32 nonce = 1;
+   */
+  nonce: number;
+};
+
+/**
+ * Describes the message example.testing.rpc.PingReponse.
+ * Use `create(PingReponseSchema)` to create a new message.
+ */
+export const PingReponseSchema: GenMessage<PingReponse> = /*@__PURE__*/
+  messageDesc(file_example_testing_rpc, 5);
+
+/**
+ * @generated from message example.testing.rpc.MessageWithAny
+ */
+export type MessageWithAny = Message<"example.testing.rpc.MessageWithAny"> & {
+  /**
+   * @generated from field: google.protobuf.Any payload = 1;
+   */
+  payload?: Any;
+};
+
+/**
+ * Describes the message example.testing.rpc.MessageWithAny.
+ * Use `create(MessageWithAnySchema)` to create a new message.
+ */
+export const MessageWithAnySchema: GenMessage<MessageWithAny> = /*@__PURE__*/
+  messageDesc(file_example_testing_rpc, 6);
+
+/**
+ * @generated from service example.testing.rpc.TestService
+ */
+export const TestService: GenService<{
+  /**
+   * @generated from rpc example.testing.rpc.TestService.TestCall
+   */
+  testCall: {
+    methodKind: "unary";
+    input: typeof TestRpcRequestSchema;
+    output: typeof TestRpcResponseSchema;
+  },
+  /**
+   * @generated from rpc example.testing.rpc.TestService.VoidCall
+   */
+  voidCall: {
+    methodKind: "unary";
+    input: typeof EmptySchema;
+    output: typeof EmptySchema;
+  },
+}> = /*@__PURE__*/
+  serviceDesc(file_example_testing_rpc, 0);
+
+/**
+ * @generated from service example.testing.rpc.TestStreamService
+ */
+export const TestStreamService: GenService<{
+  /**
+   * @generated from rpc example.testing.rpc.TestStreamService.TestCall
+   */
+  testCall: {
+    methodKind: "server_streaming";
+    input: typeof TestRpcRequestSchema;
+    output: typeof TestRpcResponseSchema;
+  },
+}> = /*@__PURE__*/
+  serviceDesc(file_example_testing_rpc, 1);
+
+/**
+ * @generated from service example.testing.rpc.TestServiceWithStreams
+ */
+export const TestServiceWithStreams: GenService<{
+  /**
+   * @generated from rpc example.testing.rpc.TestServiceWithStreams.RequestTestStream
+   */
+  requestTestStream: {
+    methodKind: "unary";
+    input: typeof TestStreamRpcRequestSchema;
+    output: typeof TestRpcResponseSchema;
+  },
+  /**
+   * @generated from rpc example.testing.rpc.TestServiceWithStreams.CloseTestStream
+   */
+  closeTestStream: {
+    methodKind: "unary";
+    input: typeof TestRpcRequestSchema;
+    output: typeof TestStreamRpcResponseSchema;
+  },
+}> = /*@__PURE__*/
+  serviceDesc(file_example_testing_rpc, 2);
+
+/**
+ * @generated from service example.testing.rpc.PingService
+ */
+export const PingService: GenService<{
+  /**
+   * @generated from rpc example.testing.rpc.PingService.Ping
+   */
+  ping: {
+    methodKind: "unary";
+    input: typeof PingRequestSchema;
+    output: typeof PingReponseSchema;
+  },
+}> = /*@__PURE__*/
+  serviceDesc(file_example_testing_rpc, 3);
+
+/**
+ * @generated from service example.testing.rpc.TestAnyService
+ */
+export const TestAnyService: GenService<{
+  /**
+   * @generated from rpc example.testing.rpc.TestAnyService.TestCall
+   */
+  testCall: {
+    methodKind: "unary";
+    input: typeof MessageWithAnySchema;
+    output: typeof MessageWithAnySchema;
+  },
+}> = /*@__PURE__*/
+  serviceDesc(file_example_testing_rpc, 4);
+

package/src/collection-sync.ts

@@ -0,0 +1,39 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export type PeerId = string & { __peerId: true };
+
+export const MESSAGE_TYPE_COLLECTION_QUERY = 'collection-query';
+
+export type CollectionQueryMessage = {
+  type: typeof MESSAGE_TYPE_COLLECTION_QUERY;
+  senderId: PeerId;
+  targetId: PeerId;
+  collectionId: string;
+
+  /**
+   * Identifier of the current state.
+   * Remote peer will skip sending the state if it has the same tag.
+   */
+  stateTag?: string;
+};
+
+export const MESSAGE_TYPE_COLLECTION_STATE = 'collection-state';
+
+export type CollectionStateMessage = {
+  type: typeof MESSAGE_TYPE_COLLECTION_STATE;
+  senderId: PeerId;
+  targetId: PeerId;
+  collectionId: string;
+
+  /**
+   *  State representation is implementation-defined.
+   */
+  state?: unknown;
+
+  /**
+   * Identifier of the current state.
+   */
+  stateTag?: string;
+};

package/src/edge.ts

@@ -0,0 +1,8 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export enum EdgeService {
+  AUTOMERGE_REPLICATOR = 'automerge-replicator',
+  FEED_REPLICATOR = 'feed-replicator',
+}

package/src/feed-replication.ts

@@ -0,0 +1,42 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export type FeedBlock = {
+  index: number;
+  data: Uint8Array;
+  nodes: {
+    index: number;
+    hash: Uint8Array;
+    size: number;
+  }[];
+  signature: Uint8Array;
+};
+export type GetMetadataProtocolMessage = {
+  type: 'get-metadata';
+  feedKey: string;
+};
+
+export type MetadataProtocolMessage = {
+  type: 'metadata';
+  feedKey: string;
+  length: number;
+};
+
+export type RequestProtocolMessage = {
+  type: 'request';
+  feedKey: string;
+  range: { from: number; to: number };
+};
+
+export type DataProtocolMessage = {
+  type: 'data';
+  feedKey: string;
+  blocks: FeedBlock[];
+};
+
+export type ProtocolMessage =
+  | GetMetadataProtocolMessage
+  | MetadataProtocolMessage
+  | RequestProtocolMessage
+  | DataProtocolMessage;

package/src/index.ts

@@ -11,3 +11,5 @@ export * from './tracing';
 export * from './types';
 export * from './query';
 export * from './profile-archive';
+export * from './collection-sync';
+export * from './edge';

package/src/proto/dxos/config.proto

@@ -140,6 +140,9 @@ message Runtime {
 
     /// Spaces will stay in SpaceState.CLOSED until explicitly opened. Speeds up client-services initialization.
     optional bool lazy_space_open = 9;
+
+    /// Disabled automerge & hypercore replication through P2P connections.
+    optional bool disable_p2p_replication = 10;
   }
 
   message App {
@@ -357,11 +360,15 @@ message Runtime {
     }
 
     message Ice {
-      optional string urls = 1;
+      string urls = 1;
       optional string username = 2;
       optional string credential = 3;
     }
 
+    message IceProvider {
+      string urls = 1;
+    }
+
     message Machine {
       optional string do_access_token = 1;
       optional string github_access_token = 2;
@@ -398,12 +405,17 @@ message Runtime {
       optional string type = 2;
     }
 
+    message Edge {
+      optional string url = 1;
+    }
+
     optional Kube kube = 1;
     optional AppServer app = 2;
     optional Dxns dxns = 3;
     optional Ipfs ipfs = 4;
     repeated Signal signaling = 5;
     repeated Ice ice = 6;
+    repeated IceProvider ice_providers = 14;
     optional Machine machine = 7;
     optional BotHost bot = 8;
     optional Publisher publisher = 9;
@@ -411,6 +423,7 @@ message Runtime {
     optional Tunneling tunneling = 11;
     optional Faasd faasd = 12;
     optional AgentHosting agent_hosting = 13;
+    optional Edge edge = 15;
   }
 
   message Keys {

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

@@ -63,6 +63,7 @@ message QueryOptions {
 message Filter {
   optional google.protobuf.Struct properties = 1;
   optional dxos.echo.model.document.Reference type = 2;
+  repeated string object_ids = 8;
   optional string text = 3;
   optional bool not = 4;
   repeated Filter and = 5; 

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

@@ -0,0 +1,77 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+//syntax = "proto3";
+
+import "google/protobuf/any.proto";
+
+//
+// The messenger protocol supports routing messages between peers.
+//
+package dxos.edge.messenger;
+
+// TODO(burdon): Opaque peer address? To decouple; e.g., for connection muxing.
+
+// TODO(burdon): Design doc.
+//  - How are peers addressed on the network?
+//  - How is a peer identified when you send a point-to-point message to it?
+//  - 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?
+
+//
+// Network peer.
+//
+// TODO(burdon): Distinguish between point-to-point and broadcast messaging.
+// TODO(burdon): Rename PeerInfo?
+message Peer {
+  // TODO(burdon): Rename topic?
+  optional string swarmKey = 1;
+  optional string identityKey = 2;
+  required string peerKey = 3;
+}
+
+//
+// Message envelope.
+//
+message Message {
+  optional string timestamp = 1;
+
+  // Routing.
+  optional Peer source = 10;
+  repeated Peer target = 11;
+
+  // TODO(burdon): Routing info.
+  optional string service_id = 20;
+
+  optional google.protobuf.Any payload = 100;
+}
+
+//
+// Swarms are used to publish and subscribe to messages based on a topic.
+//
+message SwarmRequest {
+  enum Action {
+    INFO = 0;
+    JOIN = 1;
+    LEAVE = 2;
+  }
+
+  optional Action action = 1;
+  repeated string swarmKeys = 2; // TODO(burdon): Rename topic?
+}
+
+message SwarmResponse {
+  required string swarmKey = 1;
+  /**
+   * The list of peers in the swarm.
+   */
+  repeated Peer peers = 2;
+}
+
+//
+// Text message.
+//
+message TextMessage {
+  optional string message = 1;
+}

package/src/proto/dxos/iframe.proto

@@ -45,10 +45,10 @@ message AppContextRequest {
   /// Target to redirect to after a successful invitation.
   optional string target = 3;
 
-  /// Reload the app.
+  /// The client has been reset.
+  /// Used to Reload the app.
   /// Shell cannot reload the app from within an iframe.
-  /// Used after sign out/identity reset.
-  optional bool reload = 4;
+  optional bool reset = 4;
 }
 
 /// App RPCs for the shell.

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

@@ -21,6 +21,7 @@ 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";
+import * as dxos_edge_messenger from "../edge/messenger";
 import * as dxos_error from "../error";
 import * as dxos_gravity from "../gravity";
 import * as dxos_halo_credentials from "../halo/credentials";

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

@@ -21,6 +21,7 @@ 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";
+import * as dxos_edge_messenger from "../edge/messenger";
 import * as dxos_error from "../error";
 import * as dxos_gravity from "../gravity";
 import * as dxos_halo_credentials from "../halo/credentials";

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

@@ -21,6 +21,7 @@ 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";
+import * as dxos_edge_messenger from "../edge/messenger";
 import * as dxos_error from "../error";
 import * as dxos_gravity from "../gravity";
 import * as dxos_halo_credentials from "../halo/credentials";

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

@@ -21,6 +21,7 @@ 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";
+import * as dxos_edge_messenger from "../edge/messenger";
 import * as dxos_error from "../error";
 import * as dxos_gravity from "../gravity";
 import * as dxos_halo_credentials from "../halo/credentials";

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

@@ -21,6 +21,7 @@ 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";
+import * as dxos_edge_messenger from "./edge/messenger";
 import * as dxos_error from "./error";
 import * as dxos_gravity from "./gravity";
 import * as dxos_halo_credentials from "./halo/credentials";