@dxos/protocols 0.8.4-main.c4373fc → 0.8.4-main.cb12b3f963

package/dist/src/tracing.d.ts

@@ -1,40 +0,0 @@
-export type Command = 'begin' | 'end' | 'update';
-export type TraceStatus = 'ok' | 'error';
-export type DataType = Record<string, any>;
-export type TracingContext = {
-    span?: {
-        id: string;
-        command?: Command;
-        parent?: string;
-        status?: TraceStatus;
-        data?: DataType;
-    };
-};
-export type Trace = {
-    begin: (opts: {
-        id: string;
-        parentId?: string;
-        data?: DataType;
-    }) => TracingContext;
-    end: (opts: {
-        id: string;
-        status?: 'ok' | 'error';
-        data?: DataType;
-    }) => TracingContext;
-    update: (opts: {
-        id: string;
-        data: DataType;
-    }) => TracingContext;
-    error: (opts: {
-        id: string;
-        error: Error;
-        data?: DataType;
-    }) => TracingContext;
-};
-export declare const trace: Trace;
-export type DataPipelineProcessed = {
-    spaceKey: string;
-    feedKey: string;
-    seq: number;
-};
-//# sourceMappingURL=tracing.d.ts.map

package/dist/src/tracing.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tracing.d.ts","sourceRoot":"","sources":["../../src/tracing.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,OAAO,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;AAEjD,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG,OAAO,CAAC;AAEzC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE3C,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,CAAC,EAAE;QACL,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,KAAK,EAAE,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,QAAQ,CAAA;KAAE,KAAK,cAAc,CAAC;IACpF,GAAG,EAAE,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,QAAQ,CAAA;KAAE,KAAK,cAAc,CAAC;IACxF,MAAM,EAAE,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAA;KAAE,KAAK,cAAc,CAAC;IACjE,KAAK,EAAE,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,KAAK,CAAC;QAAC,IAAI,CAAC,EAAE,QAAQ,CAAA;KAAE,KAAK,cAAc,CAAC;CAChF,CAAC;AAEF,eAAO,MAAM,KAAK,EAAE,KAgDnB,CAAC;AAMF,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC"}

package/dist/src/tracing.js

@@ -1,50 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-export const trace = {
-    begin: ({ id, parentId, data }) => {
-        return {
-            span: {
-                command: 'begin',
-                id,
-                parent: parentId,
-                data,
-            },
-        };
-    },
-    end: ({ id, status, data }) => {
-        return {
-            span: {
-                command: 'end',
-                id,
-                status: status ?? 'ok',
-                data,
-            },
-        };
-    },
-    update: ({ id, data }) => {
-        return {
-            span: {
-                command: 'update',
-                id,
-                data,
-            },
-        };
-    },
-    error: ({ id, error, data }) => {
-        return {
-            span: {
-                command: 'end',
-                id,
-                status: 'error',
-                data: {
-                    errorMessage: error.message,
-                    errorName: error.name,
-                    errorStack: error.stack,
-                    ...data,
-                },
-            },
-        };
-    },
-};
-//# sourceMappingURL=tracing.js.map

package/dist/src/tracing.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tracing.js","sourceRoot":"","sources":["../../src/tracing.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAyBF,MAAM,CAAC,MAAM,KAAK,GAAU;IAC1B,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE;QAChC,OAAO;YACL,IAAI,EAAE;gBACJ,OAAO,EAAE,OAAO;gBAChB,EAAE;gBACF,MAAM,EAAE,QAAQ;gBAChB,IAAI;aACL;SACF,CAAC;IACJ,CAAC;IAED,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE;QAC5B,OAAO;YACL,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;gBACd,EAAE;gBACF,MAAM,EAAE,MAAM,IAAI,IAAI;gBACtB,IAAI;aACL;SACF,CAAC;IACJ,CAAC;IAED,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;QACvB,OAAO;YACL,IAAI,EAAE;gBACJ,OAAO,EAAE,QAAQ;gBACjB,EAAE;gBACF,IAAI;aACL;SACF,CAAC;IACJ,CAAC;IAED,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE;QAC7B,OAAO;YACL,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;gBACd,EAAE;gBACF,MAAM,EAAE,OAAO;gBACf,IAAI,EAAE;oBACJ,YAAY,EAAE,KAAK,CAAC,OAAO;oBAC3B,SAAS,EAAE,KAAK,CAAC,IAAI;oBACrB,UAAU,EAAE,KAAK,CAAC,KAAK;oBACvB,GAAG,IAAI;iBACR;aACF;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}

package/src/edge-error.ts

@@ -1,134 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { BaseError } from '@dxos/errors';
-
-import { type EdgeErrorData, type EdgeHttpFailure } from './edge';
-
-// TODO(burdon): Reconcile with @dxos/errors.
-export class EdgeCallFailedError extends Error {
-  public static fromProcessingFailureCause(cause: Error): EdgeCallFailedError {
-    return new EdgeCallFailedError({
-      reason: 'Error processing request.',
-      isRetryable: true,
-      cause,
-    });
-  }
-
-  public static async fromHttpFailure(response: Response): Promise<EdgeCallFailedError> {
-    return new EdgeCallFailedError({
-      reason: `HTTP code ${response.status}: ${response.statusText}.`,
-      isRetryable: isRetryableCode(response.status),
-      retryAfterMs: getRetryAfterMillis(response),
-      cause: await parseErrorBody(response),
-    });
-  }
-
-  public static fromUnsuccessfulResponse(response: Response, body: EdgeHttpFailure): EdgeCallFailedError {
-    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 });
-  }
-}
-
-const getRetryAfterMillis = (response: Response) => {
-  const retryAfter = Number(response.headers.get('Retry-After'));
-  return Number.isNaN(retryAfter) || retryAfter === 0 ? 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;
-  }
-  return !(status >= 400 && status < 500);
-};
-
-const parseErrorBody = async (response: Response): Promise<Error | undefined> => {
-  if (response.headers.get('Content-Type') !== 'application/json') {
-    const body = await response.text();
-    return new Error(body.slice(0, 256));
-  }
-
-  const body = await response.json();
-  if (!('error' in body)) {
-    return undefined;
-  }
-
-  return parseSerializedError(body.error);
-};
-
-type SerializedError = {
-  code?: string;
-  message?: string;
-  context?: Record<string, unknown>;
-  stack?: string;
-  cause?: SerializedError;
-};
-
-const parseSerializedError = (serializedError: SerializedError): Error => {
-  let err: Error;
-  if (typeof serializedError.code === 'string') {
-    err = new BaseError(serializedError.code, {
-      message: serializedError.message ?? 'Unknown error',
-      cause: serializedError.cause ? parseSerializedError(serializedError.cause) : undefined,
-      context: serializedError.context,
-    });
-
-    if (serializedError.stack) {
-      Object.defineProperty(err, 'stack', {
-        value: serializedError.stack,
-      });
-    }
-  } else {
-    err = new Error(serializedError.message ?? 'Unknown error', {
-      cause: serializedError.cause ? parseSerializedError(serializedError.cause) : undefined,
-    });
-
-    if (serializedError.stack) {
-      Object.defineProperty(err, 'stack', {
-        value: serializedError.stack,
-      });
-    }
-  }
-
-  return err;
-};

package/src/edge.ts

@@ -1,279 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import * as Schema from 'effect/Schema';
-
-import { SpaceId } from '@dxos/keys';
-
-// TODO(burdon): Rename EdgerRouterEndpoint.
-// If we would rename it, we need to be careful to not break composer production.
-export enum EdgeService {
-  AUTOMERGE_REPLICATOR = 'automerge-replicator',
-  FEED_REPLICATOR = 'feed-replicator',
-  SWARM = 'swarm',
-  SIGNAL = 'signal',
-  STATUS = 'status',
-}
-
-export type EdgeHttpSuccess<T> = {
-  success: true;
-  data: T;
-};
-
-export type EdgeErrorData = { type: string } & Record<string, any>;
-
-export type EdgeHttpFailure = {
-  // TODO(burdon): Why is this required?
-  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 ExecuteWorkflowResponseBody = {
-  success: boolean;
-  reason?: string;
-  output?: any;
-};
-
-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 type RecoverIdentitySignature =
-  | string
-  // This is the format of the signature from the WebAuthn authenticator.
-  | {
-      signature: string;
-      clientDataJson: string;
-      authenticatorData: string;
-    };
-
-export type RecoverIdentityRequest = {
-  deviceKey: string;
-  controlFeedKey: string;
-  lookupKey?: string;
-  signature?: RecoverIdentitySignature;
-  token?: string;
-};
-
-export type RecoverIdentityResponseBody = {
-  identityKey: string;
-  haloSpaceKey: string;
-  genesisFeedKey: string;
-  deviceAuthCredential: string;
-};
-
-export type CreateAgentRequestBody = {
-  identityKey: string;
-  haloSpaceId: SpaceId;
-  haloSpaceKey: string;
-};
-
-export type CreateAgentResponseBody = {
-  deviceKey: string;
-  feedKey: string;
-};
-
-export type GetAgentStatusResponseBody = {
-  agent: {
-    deviceKey?: string;
-    status: EdgeAgentStatus;
-  };
-};
-
-export type UploadFunctionRequest = {
-  name?: string;
-  version: string;
-  ownerPublicKey: string;
-  entryPoint: string;
-  assets: Record<string, Uint8Array>;
-};
-
-export type UploadFunctionResponseBody = {
-  functionId: string;
-  version: string;
-  meta: {
-    key?: string;
-    name?: string;
-    description?: string;
-    /**
-     * JSON Schema for the input of the function.
-     */
-    inputSchema?: object;
-    /**
-     * JSON Schema for the output of the function.
-     */
-    outputSchema?: object;
-  };
-};
-
-export type CreateSpaceRequest = {
-  /**
-   * HEX encoded public key of the agent.
-   */
-  agentKey: string;
-};
-
-export type CreateSpaceResponseBody = {
-  /**
-   * HEX encoded public key of the space.
-   */
-  spaceKey: string;
-  spaceId: SpaceId;
-  automergeRoot: string;
-};
-
-export enum EdgeAgentStatus {
-  ACTIVE = 'active',
-  INACTIVE = 'inactive',
-  NOT_FOUND = 'not_found',
-}
-
-export type EdgeAuthChallenge = {
-  type: 'auth_challenge';
-  challenge: string;
-};
-
-export enum OAuthProvider {
-  GOOGLE = 'google',
-  BLUESKY = 'bluesky',
-}
-
-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)),
-  // Set to true if we don't want periodic token refreshes in background, for cases like account connect
-  noRefresh: Schema.optional(Schema.Boolean),
-  // Provider-specific (user handle or did for bluesky) hint for auth server resolution
-  loginHint: Schema.optional(Schema.String),
-});
-export type InitiateOAuthFlowRequest = Schema.Schema.Type<typeof InitiateOAuthFlowRequestSchema>;
-
-export type InitiateOAuthFlowResponse = {
-  authUrl: string;
-};
-
-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',
-}
-
-// TODO(mykola): Reconcile with type in EDGE repo.
-export type EdgeStatus = {
-  problems: string[];
-  agent: {
-    agentStatus?: string;
-    agentKey?: string;
-    haloSpaceId?: SpaceId;
-    fetchError?: string;
-  };
-  router: {
-    connectedDevices?: {
-      peerKey: string;
-      topics: string[];
-    }[];
-    metrics?: {
-      sentMessages: number;
-      receivedMessages: number;
-      sentBytes: number;
-      receivedBytes: number;
-      failedMessages: number;
-      failedBytes: number;
-    };
-    fetchError?: string;
-  };
-  spaces: {
-    data: Record<SpaceId, { diagnostics?: any & { redFlags: string[] }; fetchError?: string }>;
-    fetchError?: string;
-  };
-};
-
-//
-// Space import/export.
-//
-
-export type ImportBundleRequest = {
-  bundle: {
-    /**
-     * DocumentId.
-     */
-    documentId: string;
-    /**
-     * Encoded mutation.
-     */
-    mutation: string;
-    /**
-     * Heads of the document.
-     */
-    heads: string[];
-  }[];
-};
-
-export type ExportBundleRequest = {
-  /**
-   * DocumentId -> Heads (decoded heads since which we want to export).
-   */
-  docHeads: Record<string, string[]>;
-};
-
-export type ExportBundleResponse = {
-  bundle: {
-    /**
-     * DocumentId.
-     */
-    documentId: string;
-    /**
-     * Encoded mutation.
-     */
-    mutation: string;
-  }[];
-};
-
-export const DocumentCodec = {
-  encode: (doc: Uint8Array) => Buffer.from(doc).toString('base64'),
-  decode: (doc: string) => new Uint8Array(Buffer.from(doc, 'base64')),
-};

package/src/query.ts

@@ -1,8 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-/**
- * Channel name that will be used to query spaces from agent.
- */
-export const QUERY_CHANNEL = 'dxos.org/agent/plugin/query';

package/src/queue.ts

@@ -1,38 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import type { ObjectId } from './types.js';
-
-export type QueueCursor = string & { __QueueCursor: never };
-
-export type QueueQuery = {
-  queueId: ObjectId;
-
-  after?: QueueCursor;
-  before?: QueueCursor;
-  limit?: number;
-  reverse?: boolean;
-  objectIds?: ObjectId[];
-};
-
-// TODO(dmaretskyi): Rename QueueQueryResult.
-export type QueryResult = {
-  // TODO(dmaretskyi): HasId & HasTypename.
-
-  objects: unknown[];
-
-  /**
-   * Cursor at the end of the range.
-   */
-  nextCursor: QueueCursor | null;
-  /**
-   * Cursor at the start of the range.
-   */
-  prevCursor: QueueCursor | null;
-};
-
-/**
- * Position of an object in the queue that it is in.
- */
-export const KEY_QUEUE_POSITION = 'dxos.org/key/queue-position';

package/src/tracing.ts

@@ -1,86 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-export type Command = 'begin' | 'end' | 'update';
-
-export type TraceStatus = 'ok' | 'error';
-
-export type DataType = Record<string, any>;
-
-export type TracingContext = {
-  span?: {
-    id: string;
-    command?: Command;
-    parent?: string;
-    status?: TraceStatus;
-    data?: DataType;
-  };
-};
-
-export type Trace = {
-  begin: (opts: { id: string; parentId?: string; data?: DataType }) => TracingContext;
-  end: (opts: { id: string; status?: 'ok' | 'error'; data?: DataType }) => TracingContext;
-  update: (opts: { id: string; data: DataType }) => TracingContext;
-  error: (opts: { id: string; error: Error; data?: DataType }) => TracingContext;
-};
-
-export const trace: Trace = {
-  begin: ({ id, parentId, data }) => {
-    return {
-      span: {
-        command: 'begin',
-        id,
-        parent: parentId,
-        data,
-      },
-    };
-  },
-
-  end: ({ id, status, data }) => {
-    return {
-      span: {
-        command: 'end',
-        id,
-        status: status ?? 'ok',
-        data,
-      },
-    };
-  },
-
-  update: ({ id, data }) => {
-    return {
-      span: {
-        command: 'update',
-        id,
-        data,
-      },
-    };
-  },
-
-  error: ({ id, error, data }) => {
-    return {
-      span: {
-        command: 'end',
-        id,
-        status: 'error',
-        data: {
-          errorMessage: error.message,
-          errorName: error.name,
-          errorStack: error.stack,
-          ...data,
-        },
-      },
-    };
-  },
-};
-
-//
-// Domain-specific tracing
-//
-
-export type DataPipelineProcessed = {
-  spaceKey: string;
-  feedKey: string;
-  seq: number;
-};