@dxos/protocols 0.8.4-main.e8ec1fe → 0.8.4-main.ef1bc66f44

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

@@ -2,7 +2,7 @@
 // Copyright 2020 DXOS.org
 //
 
-// @generated by protoc-gen-es v2.9.0 with parameter "target=ts,import_extension=js"
+// @generated by protoc-gen-es v2.11.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

@@ -4,7 +4,7 @@
 
 import { describe, expect, test } from 'vitest';
 
-import { schema } from './proto/index.js';
+import { schema } from './proto/index.ts';
 
 describe('Codec', () => {
   test('encodes and decodes messages', async () => {

package/src/edge/EdgeFunctionEnv.ts

@@ -0,0 +1,193 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type SpaceId } from '@dxos/keys';
+
+import { type QueryResult, type QueueQuery } from '../FeedProtocol';
+import { type CreateDocumentRequest, type CreateDocumentResponse } from '../proto/gen/dxos/echo/service';
+
+/*
+
+API for the edge functions service.
+A function module should be a valid cloudflare worker module.
+
+# Fetching metadata (done on deploy)
+
+GET http://functions.dxos.internal/
+X-DXOS-Function-Route: meta
+
+Expected to return `FunctionMetadata` in JSON:
+
+{
+  key: string;
+  name?: string;
+  description?: string;
+  inputSchema?: JsonSchemaType;
+  outputSchema?: JsonSchemaType;
+}
+
+# Invoking the function
+
+POST http://functions.dxos.internal/
+Content-Type: application/json
+X-Trace-Queue-Dxn: dxn:queue:trace:AAAAAA:BBBBBB
+X-Invocation-Id: XXXXXXX
+X-Edge-Env: production
+
+{input_data}
+
+Expected to return `EdgeEnvelope` with the output data:
+
+{
+  success: true,
+  data: unknown
+}
+
+On Error returns `EdgeEnvelope` with error:
+
+{
+  success: false,
+  message: string
+  error: EncodedError
+}
+
+*/
+
+/**
+ * Environment available to the function running on Cloudflare.
+ */
+export interface Env {
+  QUEUE_SERVICE: QueueService;
+  DATA_SERVICE: DataService;
+  FUNCTIONS_AI_SERVICE: FunctionsAiService;
+}
+
+/**
+ * Use to trace the execution across multiple services.
+ *
+ * NOTE: Currently unused in functions.
+ */
+export interface ExecutionContext {}
+
+/**
+ * Database API for other CF services like functions.
+ */
+export interface DataService {
+  getSpaceMeta(ctx: ExecutionContext, spaceId: SpaceId): Promise<RpcResult<SpaceMeta | undefined>>;
+  getDocument(ctx: ExecutionContext, spaceId: SpaceId, documentId: string): Promise<RpcResult<RawDocument | undefined>>;
+
+  query(ctx: ExecutionContext, request: QueryRequest): Promise<RpcResult<QueryResponse>>;
+  queryDocuments(ctx: ExecutionContext, request: QueryRequest): Promise<RpcResult<QueryDocumentsResponse>>;
+  queryReferences(ctx: ExecutionContext, request: QueryReferencesRequest): Promise<RpcResult<QueryReferencesResponse>>;
+
+  createDocument(ctx: ExecutionContext, request: CreateDocumentRequest): Promise<RpcResult<CreateDocumentResponse>>;
+
+  // TODO(burdon): Update? Return DocumentEntry?
+  changeDocument(ctx: ExecutionContext, spaceId: SpaceId, documentId: string, changes: Uint8Array): Promise<void>;
+}
+
+export interface QueueService {
+  query(ctx: ExecutionContext, queueDXN: string, query: Omit<QueueQuery, 'queueId'>): Promise<RpcResult<QueryResult>>;
+  append(ctx: ExecutionContext, queueDXN: string, objects: unknown[]): Promise<void>;
+}
+
+/**
+ * FunctionsAiService API for other CF services like functions.
+ */
+export interface FunctionsAiService {
+  /**
+   * Enables proxying HTTP requests to the AI service from other workers.
+   */
+  fetch(request: Request): Promise<RpcResult<Response>>;
+}
+
+export type ObjectDocumentJson = {
+  type?: string;
+  objectId: string;
+  documentId: string;
+  /** Base64 encoding of a document. */
+  document: string;
+};
+
+export type SpaceMeta = {
+  spaceKey: string;
+  rootDocumentId: string;
+};
+
+export type QueryRequest = {
+  spaceId: string;
+  type?: string;
+  where?: Record<string, any>;
+  objectIds?: string[];
+  cursor?: string;
+  limit?: number;
+};
+
+export type QueryResponse = {
+  results: ObjectSnapshot[];
+  cursor?: string;
+};
+
+/**
+ * TODO(yaroslav): make Indexer return EchoObject after create() can properly reconstruct an object
+ *   from this structure (meta, id and type aren't handled properly)
+ */
+export type ObjectSnapshot = {
+  type?: string;
+  documentId: string;
+  objectId: string;
+  // TODO(mykola): Use ObjectStructure from @dxos/echo-protocol.
+  object: unknown;
+};
+
+export type ObjectReference = {
+  fromId: string;
+  toId: string;
+  fieldName: string;
+};
+
+export type QueryDocumentsResponse = {
+  results: RawObject[];
+  cursor?: string;
+};
+
+export type RawDocument = {
+  documentId: string;
+  data: Uint8Array;
+};
+
+export type RawObject = {
+  type?: string;
+  objectId: string;
+  document: RawDocument;
+};
+
+export type QueryReferencesRequest = {
+  spaceId: string;
+  objectId: string;
+  referenceType: 'from' | 'to';
+};
+
+export type QueryReferencesResponse = {
+  references: ObjectReference[];
+};
+
+/**
+ * Cloudflare Workers RPC returns objects/arrays/stubs that may need to be explicitly disposed.
+ *
+ * See: https://developers.cloudflare.com/workers/runtime-apis/rpc/lifecycle/
+ */
+export interface RpcDisposable {
+  /**
+   * Disposes the RPC stub / returned value and releases any server-side resources it references.
+   */
+  [Symbol.dispose](): void;
+}
+
+/**
+ * Wraps a return type so that any non-primitive value is marked as disposable.
+ *
+ * This models Workers RPC behavior where any returned object (including arrays) gets a disposer added.
+ */
+export type RpcResult<T> = T extends object ? T & RpcDisposable : T;

package/src/{edge.ts → edge/edge.ts}

@@ -12,7 +12,16 @@ import { SpaceId } from '@dxos/keys';
 // If we would rename it, we need to be careful to not break composer production.
 export enum EdgeService {
   AUTOMERGE_REPLICATOR = 'automerge-replicator',
+  /**
+   * Control feed replicator (hypercore append only logs) for the space.
+   */
+  // TODO(mykola): Remove once we migrate to keyhive for access control.
   FEED_REPLICATOR = 'feed-replicator',
+  /**
+   * Feed replicator (ordered data list) for the space.
+   */
+  // TODO(mykola): Rename to FEED_REPLICATOR when we migrate to keyhive for access control.
+  QUEUE_REPLICATOR = 'queue-replicator',
   SWARM = 'swarm',
   SIGNAL = 'signal',
   STATUS = 'status',
@@ -23,13 +32,15 @@ export type EdgeSuccess<T> = {
   data: T;
 };
 
-export type SerializedError = {
-  code?: string;
-  message?: string;
-  context?: Record<string, unknown>;
-  stack?: string;
-  cause?: SerializedError;
-};
+const _SerializedError = Schema.Struct({
+  name: Schema.optional(Schema.String),
+  message: Schema.optional(Schema.String),
+  context: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Any })),
+  stack: Schema.optional(Schema.String),
+  cause: Schema.optional(Schema.suspend(() => SerializedError)),
+});
+export interface SerializedError extends Schema.Schema.Type<typeof _SerializedError> {}
+export const SerializedError: Schema.Schema<SerializedError, SerializedError, never> = _SerializedError;
 
 export type EdgeErrorData = { type: string } & Record<string, any>;
 
@@ -37,11 +48,6 @@ export type EdgeErrorData = { type: string } & Record<string, any>;
  * This is the shape of the error response from the Edge service,
  * when the error is gracefully handled, the Response will be an object with this shape and have status code 200.
  */
-// TODO(dmaretskyi): Refactor this type to just be { success: false, error: SerializedError }
-// reason -> error.message
-// cause -> error.cause
-// errorData.type -> error.code
-// ...errorData -> error.context
 export type EdgeFailure = {
   /**
    * Branded Type.
@@ -50,11 +56,11 @@ export type EdgeFailure = {
   /**
    * An explanation of why the call failed. Used mostly for logging and monitoring.
    */
-  reason: string;
+  message: string;
   /**
    * Cause Error captured on the EDGE service to aid debugging on the client.
    */
-  cause?: SerializedError;
+  error?: SerializedError;
   /**
    * Information that can be used to retry the request such that it will succeed, for example:
    * 1. { type: 'auth_required', challenge: string }
@@ -62,16 +68,16 @@ export type EdgeFailure = {
    * 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.
+   * When data is returned simply retrying the request won't have any effect.
+   * EdgeHttpClient should parse well-known data into Error types and throw.
    */
-  errorData?: EdgeErrorData;
+  data?: EdgeErrorData;
 };
 
 /**
  * Represents a body response from the Edge service.
  */
-export type EdgeBody<T> = EdgeSuccess<T> | EdgeFailure;
+export type EdgeEnvelope<T> = EdgeSuccess<T> | EdgeFailure;
 
 /**
  * Use this to create a response from the Edge service.
@@ -92,21 +98,32 @@ export const EdgeResponse = Object.freeze({
     );
   },
   failure: ({
-    reason,
-    cause,
-    errorData,
+    message,
+    error,
+    errorEncoded,
+    data,
     shouldRetryAfter,
     status = 500,
   }: {
     /**
      * An explanation of why the call failed. Used mostly for logging and monitoring.
      */
-    reason: string;
+    message: string;
     /**
      * Error that caused the failure.
      * Useful for debugging.
+     *
+     * Use only one of the fields `error` or `errorEncoded`.s
      */
-    cause?: Error;
+    error?: Error;
+    /**
+     * Encoded Error that caused the failure.
+     * Useful for debugging.
+     *
+     * Use only one of the fields `error` or `errorEncoded`.
+     */
+    errorEncoded?: SerializedError;
+
     /**
      * Information that can be used to retry the request such that it will succeed, for example:
      * 1. { type: 'auth_required', challenge: string }
@@ -114,10 +131,10 @@ export const EdgeResponse = Object.freeze({
      * 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.
+     * When data is returned simply retrying the request won't have any effect.
+     * EdgeHttpClient should parse well-known data into Error types and throw.
      */
-    errorData?: EdgeErrorData;
+    data?: EdgeErrorData;
     /**
      * If provided, this request will be marked as retryable and the client will wait for the specified number of milliseconds before retrying.
      * If not provided, the client will not retry the request.
@@ -138,9 +155,9 @@ export const EdgeResponse = Object.freeze({
     return new Response(
       JSON.stringify({
         success: false,
-        reason,
-        errorData,
-        cause: cause ? ErrorCodec.encode(cause) : undefined,
+        message,
+        data,
+        error: error ? ErrorCodec.encode(error) : errorEncoded,
       } satisfies EdgeFailure),
       {
         status,
@@ -232,20 +249,19 @@ export type UploadFunctionRequest = {
    * Runtime cannot be changed once the function was deployed.
    * @default Runtime.WORKERS_FOR_PLATFORMS
    */
-  runtime?: Runtime;
+  runtime?: FunctionRuntimeKind;
 };
 
 /**
  * Note: Do not change the values of these enums, this values are stored in the FunctionVersions database.
  */
-export enum Runtime {
+export const FunctionRuntimeKind = Schema.Enums({
   // https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
-  WORKERS_FOR_PLATFORMS = 'WORKERS_FOR_PLATFORMS',
+  WORKERS_FOR_PLATFORMS: 'WORKERS_FOR_PLATFORMS',
   // https://developers.cloudflare.com/workers/runtime-apis/bindings/worker-loader/
-  WORKER_LOADER = 'WORKER_LOADER',
-  // Local worker dispatcher for testing.
-  TEST = 'TEST',
-}
+  WORKER_LOADER: 'WORKER_LOADER',
+});
+export type FunctionRuntimeKind = Schema.Schema.Type<typeof FunctionRuntimeKind>;
 
 export type UploadFunctionResponseBody = {
   functionId: string;
@@ -408,15 +424,15 @@ const MAX_ERROR_DEPTH = 3;
  */
 export const ErrorCodec = Object.freeze({
   encode: (err: Error, depth: number = 0): SerializedError => ({
-    code: 'code' in err ? (err as any).code : undefined,
+    name: 'name' in err ? err.name : (err as any).code || 'Error',
     message: err.message,
     stack: err.stack,
     cause: err.cause instanceof Error && depth < MAX_ERROR_DEPTH ? ErrorCodec.encode(err.cause, depth + 1) : undefined,
   }),
   decode: (serializedError: SerializedError, depth: number = 0): Error => {
     let err: Error;
-    if (typeof serializedError.code === 'string') {
-      err = new BaseError(serializedError.code, {
+    if (typeof serializedError.name === 'string') {
+      err = new BaseError(serializedError.name, {
         message: serializedError.message ?? 'Unknown error',
         cause:
           serializedError.cause && depth < MAX_ERROR_DEPTH

package/src/{edge-error.ts → edge/errors.ts}

@@ -2,7 +2,7 @@
 // Copyright 2025 DXOS.org
 //
 
-import { type EdgeErrorData, type EdgeFailure, EdgeHttpErrorCodec, ErrorCodec } from './edge.js';
+import { type EdgeErrorData, type EdgeFailure, EdgeHttpErrorCodec, ErrorCodec } from './edge.ts';
 
 // TODO(burdon): Reconcile with @dxos/errors.
 /**
@@ -16,11 +16,11 @@ import { type EdgeErrorData, type EdgeFailure, EdgeHttpErrorCodec, ErrorCodec }
 export class EdgeCallFailedError extends Error {
   public static fromUnsuccessfulResponse(response: Response, body: EdgeFailure): EdgeCallFailedError {
     const error = new EdgeCallFailedError({
-      reason: body.reason,
-      errorData: body.errorData,
-      isRetryable: body.errorData == null && response.headers.has('Retry-After'),
+      message: body.message,
+      data: body.data,
+      isRetryable: body.data == null && response.headers.has('Retry-After'),
       retryAfterMs: getRetryAfterMillis(response),
-      cause: body.cause ? ErrorCodec.decode(body.cause) : undefined,
+      cause: body.error ? ErrorCodec.decode(body.error) : undefined,
     });
 
     return error;
@@ -28,7 +28,7 @@ export class EdgeCallFailedError extends Error {
 
   public static async fromHttpFailure(response: Response): Promise<EdgeCallFailedError> {
     return new EdgeCallFailedError({
-      reason: `HTTP code ${response.status}: ${response.statusText}.`,
+      message: `HTTP code ${response.status}: ${response.statusText}.`,
       isRetryable: isRetryableCode(response.status),
       retryAfterMs: getRetryAfterMillis(response),
       cause: await EdgeHttpErrorCodec.decode(response),
@@ -37,27 +37,26 @@ export class EdgeCallFailedError extends Error {
 
   public static fromProcessingFailureCause(cause: Error): EdgeCallFailedError {
     return new EdgeCallFailedError({
-      reason: 'Error processing request.',
+      message: 'Error processing request.',
       isRetryable: true,
       cause,
     });
   }
 
-  readonly reason: string;
-  readonly errorData?: EdgeErrorData;
+  readonly data?: EdgeErrorData;
   readonly isRetryable?: boolean;
   readonly retryAfterMs?: number;
 
   constructor(args: {
-    reason: string;
+    message: string;
     isRetryable?: boolean;
-    errorData?: EdgeErrorData;
+    data?: EdgeErrorData;
     retryAfterMs?: number;
     cause?: Error;
   }) {
-    super(args.reason, { cause: args.cause });
-    this.reason = args.reason;
-    this.errorData = args.errorData;
+    super(args.message, { cause: args.cause });
+    this.message = args.message;
+    this.data = args.data;
     this.retryAfterMs = args.retryAfterMs;
     this.isRetryable = Boolean(args.isRetryable);
   }
@@ -66,9 +65,9 @@ export class EdgeCallFailedError extends Error {
 export class EdgeAuthChallengeError extends EdgeCallFailedError {
   constructor(
     public readonly challenge: string,
-    errorData: EdgeErrorData,
+    data: EdgeErrorData,
   ) {
-    super({ reason: 'Auth challenge.', errorData, isRetryable: false });
+    super({ message: 'Auth challenge.', data, isRetryable: false });
   }
 }
 

package/src/edge/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './edge.ts';
+export * as EdgeFunctionEnv from './EdgeFunctionEnv.ts';
+export * from './errors.ts';

package/src/errors/base-errors.ts

@@ -2,43 +2,25 @@
 // Copyright 2021 DXOS.org
 //
 
-// TODO(dmaretskyi): Reconcile with @dxos/errors
-
 /**
  * NOTE: Messages should be sentences (Start with a capital letter and end with a period).
  * Errors can optionally include a JSON context object.
  */
-export class BaseError extends Error {
-  constructor(
-    readonly code: string,
-    message?: string,
-    readonly context?: Record<string, any>,
-  ) {
-    // TODO(dmaretskyi): Error.cause.
-    super(message ?? code);
-    this.name = code;
-    // NOTE: Restores prototype chain (https://stackoverflow.com/a/48342359).
-    Object.setPrototypeOf(this, new.target.prototype);
-  }
-}
-
-// TODO(dmaretskyi): Consider common error classes with error codes:
-// throw new SystemError(ERROR_CODE_OUT_OF_MEMORY, 'Out of memory', { a: 1, b: 2 });
+import { BaseError } from '@dxos/errors';
 
 /**
  * User facing API Errors.
  * E.g., something was misconfigured.
  */
-export class ApiError extends BaseError {}
+export class ApiError extends BaseError.extend('ApiError') {}
 
 /**
  * Internal system errors.
  * E.g., unexpected/unrecoverable runtime error.
  */
-export class SystemError extends BaseError {}
+export class SystemError extends BaseError.extend('SystemError') {}
 
 /**
  * Database errors.
  */
-// TODO(wittjosiah): Same as ApiError?
-export class DatabaseError extends BaseError {}
+export class DatabaseError extends BaseError.extend('DatabaseError') {}

package/src/errors/encoding.ts

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

package/src/errors/errors.test.ts

@@ -4,12 +4,12 @@
 
 import { describe, expect, test } from 'vitest';
 
-import { ApiError } from './base-errors.js';
+import { ApiError } from './base-errors.ts';
 
 describe('Errors', () => {
   test('test', async () => {
     const runTest = async () => {
-      throw new ApiError('Test error');
+      throw new ApiError({ message: 'Test error' });
     };
 
     await expect(runTest()).rejects.toThrowError('Test error');