@dxos/protocols 0.8.0 → 0.8.1-main.81238a8

package/src/edge.ts

@@ -2,7 +2,9 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type SpaceId } from '@dxos/keys';
+import { Schema as S } from 'effect';
+
+import { SpaceId } from '@dxos/keys';
 
 // TODO(burdon): Rename EdgerRouterEndpoint?
 export enum EdgeService {
@@ -138,81 +140,27 @@ export enum EdgeAgentStatus {
   NOT_FOUND = 'not_found',
 }
 
-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, isRetryable: false });
-  }
-}
-
 export type EdgeAuthChallenge = {
   type: 'auth_challenge';
   challenge: string;
 };
 
-const getRetryAfterMillis = (response: Response) => {
-  const retryAfter = Number(response.headers.get('Retry-After'));
-  return Number.isNaN(retryAfter) || retryAfter === 0 ? undefined : retryAfter * 1000;
-};
+export enum OAuthProvider {
+  GOOGLE = 'google',
+}
 
-export const createRetryableHttpFailure = (args: { reason: any; retryAfterSeconds: number }) => {
-  return new Response(JSON.stringify({ success: false, reason: args.reason }), {
-    headers: { 'Retry-After': String(args.retryAfterSeconds) },
-  });
-};
+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 type InitiateOAuthFlowRequest = S.Schema.Type<typeof InitiateOAuthFlowRequestSchema>;
 
-const isRetryableCode = (status: number) => {
-  if (status === 501) {
-    // Not Implemented
-    return false;
-  }
-  return !(status >= 400 && status < 500);
+export type InitiateOAuthFlowResponse = {
+  authUrl: string;
 };
+
+export type OAuthFlowResult =
+  | { success: true; accessToken: string; accessTokenId: string }
+  | { success: false; reason: string };

package/src/index.ts

@@ -12,3 +12,5 @@ export * from './profile-archive.js';
 export * from './automerge.js';
 export * from './edge.js';
 export * from './queue.js';
+export * from './space-archive.js';
+export * from './edge-error.js';

package/src/invitation.ts

@@ -2,7 +2,9 @@
 // Copyright 2024 DXOS.org
 //
 
-import { ParamKeyAnnotation, S } from '@dxos/effect';
+import { Schema as S } from 'effect';
+
+import { ParamKeyAnnotation } from '@dxos/effect';
 
 // TODO(burdon): Use uniformly for processing HTTP params.
 export const InvitationUrl = S.Struct({

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

@@ -433,6 +433,28 @@ message JoinBySpaceKeyRequest {
   dxos.keys.PublicKey space_key = 1;
 }
 
+message SpaceArchive {
+  string filename = 1;
+  bytes contents = 2;
+}
+
+message ExportSpaceRequest {
+  string space_id = 1;
+}
+
+message ExportSpaceResponse {
+  SpaceArchive archive = 1;
+}
+
+message ImportSpaceRequest {
+  SpaceArchive archive = 1;
+}
+
+message ImportSpaceResponse {
+  /// the ID of the new space.
+  string new_space_id = 1;
+}
+
 service SpacesService {
   rpc CreateSpace(google.protobuf.Empty) returns (Space);
   rpc UpdateSpace(UpdateSpaceRequest) returns (google.protobuf.Empty);
@@ -454,6 +476,9 @@ service SpacesService {
   rpc QueryCredentials(QueryCredentialsRequest) returns (stream dxos.halo.credentials.Credential);
 
   rpc CreateEpoch(CreateEpochRequest) returns (CreateEpochResponse);
+
+  rpc ExportSpace(ExportSpaceRequest) returns (ExportSpaceResponse);
+  rpc ImportSpace(ImportSpaceRequest) returns (ImportSpaceResponse);
 }
 
 //
@@ -555,6 +580,10 @@ service NetworkService {
   rpc QueryStatus(google.protobuf.Empty) returns (stream NetworkStatus);
   rpc JoinSwarm(dxos.edge.signal.JoinRequest) returns (google.protobuf.Empty);
   rpc LeaveSwarm(dxos.edge.signal.LeaveRequest) returns (google.protobuf.Empty);
+  /**
+   * Query the swarm state without joining it.
+   */ 
+  rpc QuerySwarm(dxos.edge.signal.QueryRequest) returns (dxos.edge.messenger.SwarmResponse);
   rpc SubscribeSwarmState(SubscribeSwarmStateRequest) returns (stream dxos.edge.messenger.SwarmResponse);
   rpc SendMessage(dxos.edge.signal.Message) returns (google.protobuf.Empty);
   rpc SubscribeMessages(dxos.edge.messenger.Peer) returns (stream dxos.edge.signal.Message);

package/src/proto/dxos/edge/signal.proto

@@ -22,6 +22,10 @@ message LeaveRequest {
   dxos.edge.messenger.Peer peer = 2;
 }
 
+message QueryRequest {
+  dxos.keys.PublicKey topic = 1;
+}
+
 message Message {
   dxos.edge.messenger.Peer author = 1;
   dxos.edge.messenger.Peer recipient = 2;

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

@@ -1170,6 +1170,45 @@ export interface JoinSpaceResponse {
 export interface JoinBySpaceKeyRequest {
     spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface SpaceArchive {
+    filename: string;
+    contents: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface ExportSpaceRequest {
+    spaceId: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface ExportSpaceResponse {
+    archive: SpaceArchive;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface ImportSpaceRequest {
+    archive: SpaceArchive;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface ImportSpaceResponse {
+    /**
+     * the ID of the new space.
+     */
+    newSpaceId: string;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -1198,6 +1237,8 @@ export interface SpacesService {
      */
     queryCredentials: (request: QueryCredentialsRequest, options?: RequestOptions) => Stream<dxos_halo_credentials.Credential>;
     createEpoch: (request: CreateEpochRequest, options?: RequestOptions) => Promise<CreateEpochResponse>;
+    exportSpace: (request: ExportSpaceRequest, options?: RequestOptions) => Promise<ExportSpaceResponse>;
+    importSpace: (request: ImportSpaceRequest, options?: RequestOptions) => Promise<ImportSpaceResponse>;
 }
 /**
  * Defined in:
@@ -1336,6 +1377,10 @@ export interface NetworkService {
     queryStatus: (request: void, options?: RequestOptions) => Stream<NetworkStatus>;
     joinSwarm: (request: dxos_edge_signal.JoinRequest, options?: RequestOptions) => Promise<void>;
     leaveSwarm: (request: dxos_edge_signal.LeaveRequest, options?: RequestOptions) => Promise<void>;
+    /**
+     * Query the swarm state without joining it.
+     */
+    querySwarm: (request: dxos_edge_signal.QueryRequest, options?: RequestOptions) => Promise<dxos_edge_messenger.SwarmResponse>;
     subscribeSwarmState: (request: SubscribeSwarmStateRequest, options?: RequestOptions) => Stream<dxos_edge_messenger.SwarmResponse>;
     sendMessage: (request: dxos_edge_signal.Message, options?: RequestOptions) => Promise<void>;
     subscribeMessages: (request: dxos_edge_messenger.Peer, options?: RequestOptions) => Stream<dxos_edge_signal.Message>;

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

@@ -81,6 +81,13 @@ export interface LeaveRequest {
     topic: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     peer: dxos_edge_messenger.Peer;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/edge/signal.proto}
+ */
+export interface QueryRequest {
+    topic: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/edge/signal.proto}