@dxos/protocols 0.6.12-main.78ddbdf → 0.6.12-main.89e9959

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;AAiEhE,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAokBhD,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,i7iHAAi7iH,CAAC,CAAC,CAAC;AAC1+iH,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;AAiEhE,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAokBhD,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,shjHAAshjH,CAAC,CAAC,CAAC;AAC/kjH,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.6.12-main.78ddbdf",
+  "version": "0.6.12-main.89e9959",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -71,12 +71,12 @@
   ],
   "dependencies": {
     "@bufbuild/protobuf": "^2.1.0",
-    "@effect/schema": "^0.67.16",
-    "@dxos/codec-protobuf": "0.6.12-main.78ddbdf",
-    "@dxos/keys": "0.6.12-main.78ddbdf",
-    "@dxos/timeframe": "0.6.12-main.78ddbdf",
-    "@dxos/invariant": "0.6.12-main.78ddbdf",
-    "@dxos/util": "0.6.12-main.78ddbdf"
+    "@dxos/effect": "0.6.12-main.89e9959",
+    "@dxos/invariant": "0.6.12-main.89e9959",
+    "@dxos/codec-protobuf": "0.6.12-main.89e9959",
+    "@dxos/keys": "0.6.12-main.89e9959",
+    "@dxos/timeframe": "0.6.12-main.89e9959",
+    "@dxos/util": "0.6.12-main.89e9959"
   },
   "devDependencies": {
     "@bufbuild/buf": "^1.43.0",

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

@@ -83,7 +83,8 @@ export type Message = Message$1<"dxos.edge.messenger.Message"> & {
   target: Peer[];
 
   /**
-   * 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.
    *
    * @generated from field: optional string service_id = 20;
    */

package/src/edge.ts

@@ -8,3 +8,57 @@ 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 class EdgeCallFailedError extends Error {
+  public static fromProcessingFailureCause(cause: Error) {
+    return new EdgeCallFailedError('Error processing request.', undefined, cause);
+  }
+
+  public static fromFailureResponse(response: { status: number; statusText: string }) {
+    return new EdgeCallFailedError(`HTTP code ${response.status}: ${response.statusText}.`);
+  }
+
+  constructor(
+    readonly reason: string,
+    readonly errorData?: EdgeErrorData,
+    cause?: Error,
+  ) {
+    super(reason, { cause });
+  }
+}

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/edge/messenger.proto

@@ -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;

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

@@ -97,6 +97,8 @@ export interface Message {
     source?: Peer;
     target?: Peer[];
     /**
+     * Maybe be used to address a service at EDGE, but also to address components inside the client.
+     *
      * Options:
      *   - proto3_optional = true
      */