@dxos/protocols 0.6.11 → 0.6.12-main.2d19bf1

package/src/buf/proto/gen/dxos/service/supervisor_pb.ts

@@ -2,7 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.1.0 with parameter "target=ts,import_extension=js"
 // @generated from file dxos/service/supervisor.proto (package dxos.service.supervisor, syntax proto3)
 /* eslint-disable */
 
@@ -10,12 +10,12 @@ import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobu
 import { enumDesc, fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv1";
 import type { EmptySchema } from "@bufbuild/protobuf/wkt";
 import { file_google_protobuf_empty } from "@bufbuild/protobuf/wkt";
-import type { Config } from "../config_pb";
-import { file_dxos_config } from "../config_pb";
-import type { Credential, Presentation } from "../halo/credentials_pb";
-import { file_dxos_halo_credentials } from "../halo/credentials_pb";
-import type { PublicKey } from "../keys_pb";
-import { file_dxos_keys } from "../keys_pb";
+import type { Config } from "../config_pb.js";
+import { file_dxos_config } from "../config_pb.js";
+import type { Credential, Presentation } from "../halo/credentials_pb.js";
+import { file_dxos_halo_credentials } from "../halo/credentials_pb.js";
+import type { PublicKey } from "../keys_pb.js";
+import { file_dxos_keys } from "../keys_pb.js";
 import type { Message } from "@bufbuild/protobuf";
 
 /**

package/src/buf/proto/gen/dxos/service/tunnel_pb.ts

@@ -2,7 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.1.0 with parameter "target=ts,import_extension=js"
 // @generated from file dxos/service/tunnel.proto (package dxos.service.tunnel, syntax proto3)
 /* eslint-disable */
 

package/src/buf/proto/gen/dxos/tracing_pb.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.1.0 with parameter "target=ts,import_extension=js"
 // @generated from file dxos/tracing.proto (package dxos.tracing, syntax proto3)
 /* eslint-disable */
 
@@ -6,10 +6,10 @@ import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobu
 import { enumDesc, fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv1";
 import type { EmptySchema } from "@bufbuild/protobuf/wkt";
 import { file_google_protobuf_empty, file_google_protobuf_struct } from "@bufbuild/protobuf/wkt";
-import type { Error } from "./error_pb";
-import { file_dxos_error } from "./error_pb";
-import type { LogEntry } from "./client/logging_pb";
-import { file_dxos_client_logging } from "./client/logging_pb";
+import type { Error } from "./error_pb.js";
+import { file_dxos_error } from "./error_pb.js";
+import type { LogEntry } from "./client/logging_pb.js";
+import { file_dxos_client_logging } from "./client/logging_pb.js";
 import type { JsonObject, Message } from "@bufbuild/protobuf";
 
 /**

package/src/buf/proto/gen/dxos/type_pb.ts

@@ -2,7 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.1.0 with parameter "target=ts,import_extension=js"
 // @generated from file dxos/type.proto (package dxos.type, syntax proto3)
 /* eslint-disable */
 
@@ -11,8 +11,8 @@
 import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv1";
 import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv1";
 import { file_google_protobuf_struct } from "@bufbuild/protobuf/wkt";
-import type { Record_Extension } from "./registry_pb";
-import { file_dxos_registry } from "./registry_pb";
+import type { Record_Extension } from "./registry_pb.js";
+import { file_dxos_registry } from "./registry_pb.js";
 import type { JsonObject, Message } from "@bufbuild/protobuf";
 
 /**

package/src/buf/proto/gen/dxos/value_pb.ts

@@ -2,7 +2,7 @@
 // Copyright 2021 DXOS.org
 //
 
-// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.1.0 with parameter "target=ts,import_extension=js"
 // @generated from file dxos/value.proto (package dxos.value, syntax proto3)
 /* eslint-disable */
 

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

@@ -2,7 +2,7 @@
 // Copyright 2020 DXOS.org
 //
 
-// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.1.0 with parameter "target=ts,import_extension=js"
 // @generated from file example/testing/data.proto (package example.testing.data, syntax proto3)
 /* eslint-disable */
 

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

@@ -2,7 +2,7 @@
 // Copyright 2020 DXOS.org
 //
 
-// @generated by protoc-gen-es v2.0.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.1.0 with parameter "target=ts,import_extension=js"
 // @generated from file example/testing/rpc.proto (package example.testing.rpc, syntax proto3)
 /* eslint-disable */
 

package/src/codec.test.ts

@@ -2,11 +2,9 @@
 // Copyright 2022 DXOS.org
 //
 
-import { expect } from 'chai';
+import { describe, expect, test } from 'vitest';
 
-import { describe, test } from '@dxos/test';
-
-import { schema } from './proto';
+import { schema } from './proto/index.js';
 
 describe('Codec', () => {
   test('encodes and decodes messages', async () => {

package/src/edge.ts

@@ -8,3 +8,134 @@ export enum EdgeService {
   SWARM_SERVICE_ID = 'swarm',
   SIGNAL_SERVICE_ID = 'signal',
 }
+
+export type EdgeHttpSuccess<T> = {
+  success: true;
+  data: T;
+};
+
+export type EdgeErrorData = { type: string } & Record<string, any>;
+
+export type EdgeHttpFailure = {
+  success: false;
+  /**
+   * An explanation of why the call failed. Used mostly for logging and monitoring.
+   */
+  reason: string;
+  /**
+   * Information that can be used to retry the request such that it will succeed, for example:
+   * 1. { type: 'auth_required', challenge: string }
+   *    Requires retrying the request with challenge signature included.
+   * 2. { type: 'user_confirmation_required', dialog: { title: string, message: string, confirmation_payload: string } }
+   *    Requires showing a confirmation dialog to a user and retrying the request with confirmation_payload included
+   *    if the user confirms.
+   * When errorData is returned simply retrying the request won't have any effect.
+   * EdgeHttpClient should parse well-known errorData into Error types and throw.
+   */
+  errorData?: EdgeErrorData;
+};
+
+export type EdgeHttpResponse<T> = EdgeHttpSuccess<T> | EdgeHttpFailure;
+
+export type GetNotarizationResponseBody = {
+  awaitingNotarization: { credentials: string[] };
+};
+
+export type PostNotarizationRequestBody = {
+  credentials: string[];
+};
+
+export type JoinSpaceRequest = {
+  invitationId: string;
+  identityKey: string;
+  /**
+   * Base64 encoded signed challenge.
+   * Used to verify the IdentityKey in case of `invitation.authMethod === Invitation.AuthMethod.KNOWN_PUBLIC_KEY`
+   */
+  signature?: string;
+};
+
+export type JoinSpaceResponseBody = {
+  spaceMemberCredential: string;
+  spaceGenesisFeedKey: string;
+};
+
+export class EdgeCallFailedError extends Error {
+  public static fromProcessingFailureCause(cause: Error) {
+    return new EdgeCallFailedError({
+      reason: 'Error processing request.',
+      isRetryable: true,
+      cause,
+    });
+  }
+
+  public static fromHttpFailure(response: Response) {
+    return new EdgeCallFailedError({
+      reason: `HTTP code ${response.status}: ${response.statusText}.`,
+      isRetryable: isRetryableCode(response.status),
+      retryAfterMs: getRetryAfterMillis(response),
+    });
+  }
+
+  public static fromUnsuccessfulResponse(response: Response, body: EdgeHttpFailure) {
+    return new EdgeCallFailedError({
+      reason: body.reason,
+      errorData: body.errorData,
+      isRetryable: body.errorData == null && response.headers.has('Retry-After'),
+      retryAfterMs: getRetryAfterMillis(response),
+    });
+  }
+
+  readonly reason: string;
+  readonly errorData?: EdgeErrorData;
+  readonly isRetryable?: boolean;
+  readonly retryAfterMs?: number;
+
+  constructor(args: {
+    reason: string;
+    isRetryable?: boolean;
+    errorData?: EdgeErrorData;
+    retryAfterMs?: number;
+    cause?: Error;
+  }) {
+    super(args.reason, { cause: args.cause });
+    this.reason = args.reason;
+    this.errorData = args.errorData;
+    this.retryAfterMs = args.retryAfterMs;
+    this.isRetryable = Boolean(args.isRetryable);
+  }
+}
+
+export class EdgeAuthChallengeError extends EdgeCallFailedError {
+  constructor(
+    public readonly challenge: string,
+    errorData: EdgeErrorData,
+  ) {
+    super({ reason: 'Auth challenge.', errorData });
+  }
+}
+
+export type EdgeAuthChallenge = {
+  type: 'auth_challenge';
+  challenge: string;
+};
+
+const getRetryAfterMillis = (response: Response) => {
+  const retryAfter = Number(response.headers.get('Retry-After'));
+  return Number.isNaN(retryAfter) ? undefined : retryAfter * 1000;
+};
+
+export const createRetryableHttpFailure = (args: { reason: any; retryAfterSeconds: number }) => {
+  return new Response(JSON.stringify({ success: false, reason: args.reason }), {
+    headers: { 'Retry-After': String(args.retryAfterSeconds) },
+  });
+};
+
+const isRetryableCode = (status: number) => {
+  if (status === 501) {
+    // Not Implemented
+    return false;
+  }
+  // TODO: handle 401 Not Authorized
+  return !(status >= 400 && status < 500);
+};

package/src/errors/encoding.ts

@@ -2,8 +2,8 @@
 // Copyright 2023 DXOS.org
 //
 
-import { reconstructError } from './helpers';
-import { type Error as SerializedErrorProto } from '../proto/gen/dxos/error';
+import { reconstructError } from './helpers.js';
+import { type Error as SerializedErrorProto } from '../proto/gen/dxos/error.js';
 
 export const encodeError = (err: any): SerializedErrorProto => {
   if (typeof err === 'object' && err?.message) {

package/src/errors/errors.test.ts

@@ -2,14 +2,9 @@
 // Copyright 2022 DXOS.org
 //
 
-import chai, { expect } from 'chai';
-import chaiAsPromised from 'chai-as-promised';
+import { describe, expect, test } from 'vitest';
 
-import { describe, test } from '@dxos/test';
-
-import { ApiError } from './base-errors';
-
-chai.use(chaiAsPromised);
+import { ApiError } from './base-errors.js';
 
 describe('Errors', () => {
   test('test', async () => {
@@ -17,6 +12,6 @@ describe('Errors', () => {
       throw new ApiError('Test error');
     };
 
-    await expect(runTest()).to.be.rejectedWith('Test error');
+    await expect(runTest()).rejects.toThrowError('Test error');
   });
 });

package/src/errors/errors.ts

@@ -4,9 +4,9 @@
 
 import { PublicKey } from '@dxos/keys';
 
-import { ApiError, BaseError, DatabaseError, SystemError } from './base-errors';
-import { registerError, registerErrorMessageContext, registerErrorNoArgs } from './helpers';
-import type { ObjectId } from '../types';
+import { ApiError, BaseError, DatabaseError, SystemError } from './base-errors.js';
+import { registerError, registerErrorMessageContext, registerErrorNoArgs } from './helpers.js';
+import type { ObjectId } from '../types.js';
 
 /**
  * Thrown when request was terminated because the RPC endpoint has been closed.

package/src/errors/helpers.ts

@@ -4,8 +4,8 @@
 
 import { invariant } from '@dxos/invariant';
 
-import { SystemError } from './base-errors';
-import { type Error as SerializedErrorProto } from '../proto/gen/dxos/error';
+import { SystemError } from './base-errors.js';
+import { type Error as SerializedErrorProto } from '../proto/gen/dxos/error.js';
 
 export const reconstructError = (error: SerializedErrorProto) => {
   const { name, message, context } = error;

package/src/errors/index.ts

@@ -2,7 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-export * from './encoding';
-export * from './errors';
-export * from './helpers';
-export * from './base-errors';
+export * from './encoding.js';
+export * from './errors.js';
+export * from './helpers.js';
+export * from './base-errors.js';

package/src/index.ts

@@ -2,12 +2,12 @@
 // Copyright 2021 DXOS.org
 //
 
-export * from './errors';
-export * from './indexing';
-export * from './storage';
-export * from './tracing';
-export * from './types';
-export * from './query';
-export * from './profile-archive';
-export * from './collection-sync';
-export * from './edge';
+export * from './errors/index.js';
+export * from './indexing.js';
+export * from './storage.js';
+export * from './tracing.js';
+export * from './types.js';
+export * from './query.js';
+export * from './profile-archive.js';
+export * from './automerge.js';
+export * from './edge.js';

package/src/indexing.test.ts

@@ -2,11 +2,9 @@
 // Copyright 2022 DXOS.org
 //
 
-import { expect } from 'chai';
+import { describe, expect, test } from 'vitest';
 
-import { describe, test } from '@dxos/test';
-
-import { ObjectPointerVersion, objectPointerCodec } from './indexing';
+import { ObjectPointerVersion, objectPointerCodec } from './indexing.js';
 
 describe('Indexing object pointer codec', () => {
   test('getVersion', async () => {

package/src/invitation.ts

@@ -0,0 +1,12 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { ParamKeyAnnotation, S } 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' })),
+});

package/src/proto/dxos/client/invitation.proto

@@ -168,4 +168,7 @@ message Invitation {
 
   /// Role of the admitted member, defaults to ADMIN.
   optional dxos.halo.credentials.SpaceMember.Role role = 18;
+
+  /// Id of a the space to join (only present if kind is SPACE).
+  optional string space_id = 19;
 }

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

@@ -219,6 +219,7 @@ message SpaceMember {
   dxos.halo.credentials.SpaceMember.Role role = 4;
 }
 
+
 // TODO(burdon): Rename SpaceInfo?
 message Space {
   message Metrics {
@@ -283,6 +284,7 @@ message Space {
   SpaceState state = 2;
   optional PipelineState pipeline = 3;
   optional dxos.error.Error error = 4;
+  optional dxos.echo.metadata.EdgeReplicationSetting edge_replication = 6;
 
   repeated SpaceMember members = 10;
   optional dxos.keys.PublicKey creator = 11;
@@ -298,6 +300,8 @@ message UpdateSpaceRequest {
 
   /// Allowed values: ACTIVE, INACTIVE.
   optional SpaceState state = 2;
+
+  optional dxos.echo.metadata.EdgeReplicationSetting edge_replication = 3;
 }
 
 message QuerySpacesResponse {

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

@@ -44,6 +44,9 @@ message QueryOptions {
     */
   optional DataLocation data_location = 4;
 
+  /// References to inline when querying.
+  optional google.protobuf.Struct include = 3;
+
   //
   // Deprecated
   //
@@ -52,7 +55,7 @@ message QueryOptions {
    * Query only in specific spaces.
    * @deprecated Use `spaceIds` instead.
    */
-  repeated dxos.keys.PublicKey spaces = 3;
+  repeated dxos.keys.PublicKey spaces = 6;
 
   /**
    * Filter by model.

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

@@ -75,6 +75,13 @@ message SpaceMetadata {
   optional timeframe.TimeframeVector data_timeframe = 5;
 
   optional SpaceCache cache = 9;
+
+  optional EdgeReplicationSetting edge_replication = 11;
+}
+
+enum EdgeReplicationSetting {
+  DISABLED = 0;
+  ENABLED = 1;
 }
 
 message ControlPipelineSnapshot {

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

@@ -101,7 +101,33 @@ message GetSpaceSyncStateRequest {
 message SpaceSyncState {
   message PeerState {
     string peer_id = 1;
-    int32 documents_to_reconcile = 2;
+
+    // TODO(burdon): Standardize: have_local, want:local, have_remote, want_remote.
+
+    /**
+     * Documents that are present locally but not on the remote peer.
+     */
+    int32 missing_on_remote = 10;
+
+    /**
+     * Documents that are present on the remote peer but not locally.
+     */
+    int32 missing_on_local = 11;
+    
+    /**
+     * Documents that are present on both peers but have different heads.
+     */
+    int32 different_documents = 12;
+
+    /**
+     * Total number of documents locally.
+     */
+    int32 local_document_count = 13;
+
+    /**
+     * Total number of documents on the remote peer.
+     */
+    int32 remote_document_count = 14;
   }
 
   repeated PeerState peers = 1;
@@ -109,7 +135,7 @@ message SpaceSyncState {
 
 service DataService {
   /**
-   * Subscribe to incremental updates of multiple automerge socuments. 
+   * Subscribe to incremental updates of multiple automerge socuments.
    * Which documents are subscribed to is defined in the `UpdateSubscription`.
    * Used to propagate changes from services to client.
    */
@@ -126,7 +152,7 @@ service DataService {
    */
   rpc Update(UpdateRequest) returns (google.protobuf.Empty);
   rpc Flush(FlushRequest) returns (google.protobuf.Empty);
-  
+
   rpc GetDocumentHeads(GetDocumentHeadsRequest) returns (GetDocumentHeadsResponse);
 
   /// Wait until the we have the specified changes on the worker locally. Does not take into account the index or client.
@@ -139,5 +165,5 @@ service DataService {
   rpc UpdateIndexes(google.protobuf.Empty) returns (google.protobuf.Empty);
 
   // TODO(dmaretskyi): Stream subscription.
-  rpc GetSpaceSyncState(GetSpaceSyncStateRequest) returns (SpaceSyncState);
+  rpc SubscribeSpaceSyncState(GetSpaceSyncStateRequest) returns (stream SpaceSyncState);
 }

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

@@ -2,7 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-//syntax = "proto3";
+syntax = "proto3";
 
 import "google/protobuf/any.proto";
 
@@ -28,7 +28,7 @@ message Peer {
   // TODO(burdon): Rename topic?
   optional string swarmKey = 1;
   optional string identityKey = 2;
-  required string peerKey = 3;
+  string peerKey = 3;
 }
 
 //
@@ -41,7 +41,8 @@ message Message {
   optional Peer source = 10;
   repeated Peer target = 11;
 
-  // TODO(burdon): Routing info.
+  /// List of valid services is defined in the `EdgeService` enum. 
+  /// Maybe be used to address a service at EDGE, but also to address components inside the client.
   optional string service_id = 20;
 
   optional google.protobuf.Any payload = 100;
@@ -62,7 +63,7 @@ message SwarmRequest {
 }
 
 message SwarmResponse {
-  required string swarmKey = 1;
+  string swarmKey = 1;
   /**
    * The list of peers in the swarm.
    */

package/src/proto/dxos/mesh/bridge.proto

@@ -65,8 +65,12 @@ message BridgeEvent {
 }
 
 message ConnectionRequest {
-  dxos.keys.PublicKey  proxy_id = 1;
+  dxos.keys.PublicKey proxy_id = 1;
   bool initiator = 2;
+  string remote_peer_key = 3;
+  string own_peer_key = 4;
+  string topic = 5;
+
 }
 
 message SignalRequest {