@dxos/protocols 0.8.4-main.1da679c → 0.8.4-main.21d9917

package/dist/src/edge/errors.js

@@ -0,0 +1,69 @@
+//
+// Copyright 2025 DXOS.org
+//
+import { EdgeHttpErrorCodec, ErrorCodec } from './edge.js';
+// TODO(burdon): Reconcile with @dxos/errors.
+/**
+ * Error thrown when a call to the Edge service fails.
+ * There 3 possible sources of failure:
+ * 1. EdgeFailure (JSON body with { success: false }) -> Processing the request failed and was gracefully handled by EDGE service.
+ * 2. Http failure (non-ok code) -> The HTTP request failed (e.g. timeout, network error).
+ *                               -> Unhandled exception on EDGE side, EDGE would provide serialized error in the response body.
+ * 3. Processing failure -> Unhandled exception on client side while processing the response.
+ */
+export class EdgeCallFailedError extends Error {
+    static fromUnsuccessfulResponse(response, body) {
+        const error = new EdgeCallFailedError({
+            message: body.message,
+            data: body.data,
+            isRetryable: body.data == null && response.headers.has('Retry-After'),
+            retryAfterMs: getRetryAfterMillis(response),
+            cause: body.error ? ErrorCodec.decode(body.error) : undefined,
+        });
+        return error;
+    }
+    static async fromHttpFailure(response) {
+        return new EdgeCallFailedError({
+            message: `HTTP code ${response.status}: ${response.statusText}.`,
+            isRetryable: isRetryableCode(response.status),
+            retryAfterMs: getRetryAfterMillis(response),
+            cause: await EdgeHttpErrorCodec.decode(response),
+        });
+    }
+    static fromProcessingFailureCause(cause) {
+        return new EdgeCallFailedError({
+            message: 'Error processing request.',
+            isRetryable: true,
+            cause,
+        });
+    }
+    data;
+    isRetryable;
+    retryAfterMs;
+    constructor(args) {
+        super(args.message, { cause: args.cause });
+        this.message = args.message;
+        this.data = args.data;
+        this.retryAfterMs = args.retryAfterMs;
+        this.isRetryable = Boolean(args.isRetryable);
+    }
+}
+export class EdgeAuthChallengeError extends EdgeCallFailedError {
+    challenge;
+    constructor(challenge, data) {
+        super({ message: 'Auth challenge.', data, isRetryable: false });
+        this.challenge = challenge;
+    }
+}
+const getRetryAfterMillis = (response) => {
+    const retryAfter = Number(response.headers.get('Retry-After'));
+    return Number.isNaN(retryAfter) || retryAfter === 0 ? undefined : retryAfter * 1000;
+};
+const isRetryableCode = (status) => {
+    if (status === 501) {
+        // Not Implemented
+        return false;
+    }
+    return !(status >= 400 && status < 500);
+};
+//# sourceMappingURL=errors.js.map

package/dist/src/edge/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/edge/errors.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF,OAAO,EAAwC,kBAAkB,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEjG,6CAA6C;AAC7C;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IACrC,MAAM,CAAC,wBAAwB,CAAC,QAAkB,EAAE,IAAiB;QAC1E,MAAM,KAAK,GAAG,IAAI,mBAAmB,CAAC;YACpC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;YACrE,YAAY,EAAE,mBAAmB,CAAC,QAAQ,CAAC;YAC3C,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;SAC9D,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAkB;QACpD,OAAO,IAAI,mBAAmB,CAAC;YAC7B,OAAO,EAAE,aAAa,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,GAAG;YAChE,WAAW,EAAE,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC7C,YAAY,EAAE,mBAAmB,CAAC,QAAQ,CAAC;YAC3C,KAAK,EAAE,MAAM,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC;SACjD,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,0BAA0B,CAAC,KAAY;QACnD,OAAO,IAAI,mBAAmB,CAAC;YAC7B,OAAO,EAAE,2BAA2B;YACpC,WAAW,EAAE,IAAI;YACjB,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAEQ,IAAI,CAAiB;IACrB,WAAW,CAAW;IACtB,YAAY,CAAU;IAE/B,YAAY,IAMX;QACC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,mBAAmB;IAE3C;IADlB,YACkB,SAAiB,EACjC,IAAmB;QAEnB,KAAK,CAAC,EAAE,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;QAHhD,cAAS,GAAT,SAAS,CAAQ;IAInC,CAAC;CACF;AAED,MAAM,mBAAmB,GAAG,CAAC,QAAkB,EAAE,EAAE;IACjD,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;IAC/D,OAAO,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,GAAG,IAAI,CAAC;AACtF,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,EAAE;IACzC,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACnB,kBAAkB;QAClB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CAAC,CAAC,MAAM,IAAI,GAAG,IAAI,MAAM,GAAG,GAAG,CAAC,CAAC;AAC1C,CAAC,CAAC"}

package/dist/src/edge/index.d.ts

@@ -0,0 +1,4 @@
+export * from './edge.js';
+export * as EdgeFunctionEnv from './EdgeFunctionEnv.js';
+export * from './errors.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/edge/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/edge/index.ts"],"names":[],"mappings":"AAIA,cAAc,WAAW,CAAC;AAC1B,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAC;AACxD,cAAc,aAAa,CAAC"}

package/dist/src/edge/index.js

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+export * from './edge.js';
+export * as EdgeFunctionEnv from './EdgeFunctionEnv.js';
+export * from './errors.js';
+//# sourceMappingURL=index.js.map

package/dist/src/edge/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/edge/index.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF,cAAc,WAAW,CAAC;AAC1B,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAC;AACxD,cAAc,aAAa,CAAC"}

package/dist/src/errors/base-errors.d.ts

@@ -2,26 +2,104 @@
  * NOTE: Messages should be sentences (Start with a capital letter and end with a period).
  * Errors can optionally include a JSON context object.
  */
-export declare class BaseError extends Error {
-    readonly code: string;
-    readonly context?: Record<string, any> | undefined;
-    constructor(code: string, message?: string, context?: Record<string, any> | undefined);
-}
+import { BaseError } from '@dxos/errors';
+declare const ApiError_base: {
+    new (options?: import("@dxos/errors").BaseErrorOptions): {
+        name: "ApiError";
+        context: Record<string, unknown>;
+        readonly message: string;
+        readonly _tag: "ApiError";
+        stack?: string;
+        cause?: unknown;
+    };
+    name: "ApiError";
+    is(error: unknown): error is BaseError;
+    wrap(options?: Omit<import("@dxos/errors").BaseErrorOptions, "cause"> & {
+        ifTypeDiffers?: boolean;
+    }): (error: unknown) => {
+        name: "ApiError";
+        context: Record<string, unknown>;
+        readonly message: string;
+        readonly _tag: "ApiError";
+        stack?: string;
+        cause?: unknown;
+    };
+    extend<Name extends string = string>(name: Name, message?: string): any;
+    isError(error: unknown): error is Error;
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};
 /**
  * User facing API Errors.
  * E.g., something was misconfigured.
  */
-export declare class ApiError extends BaseError {
+export declare class ApiError extends ApiError_base {
 }
+declare const SystemError_base: {
+    new (options?: import("@dxos/errors").BaseErrorOptions): {
+        name: "SystemError";
+        context: Record<string, unknown>;
+        readonly message: string;
+        readonly _tag: "SystemError";
+        stack?: string;
+        cause?: unknown;
+    };
+    name: "SystemError";
+    is(error: unknown): error is BaseError;
+    wrap(options?: Omit<import("@dxos/errors").BaseErrorOptions, "cause"> & {
+        ifTypeDiffers?: boolean;
+    }): (error: unknown) => {
+        name: "SystemError";
+        context: Record<string, unknown>;
+        readonly message: string;
+        readonly _tag: "SystemError";
+        stack?: string;
+        cause?: unknown;
+    };
+    extend<Name extends string = string>(name: Name, message?: string): any;
+    isError(error: unknown): error is Error;
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};
 /**
  * Internal system errors.
  * E.g., unexpected/unrecoverable runtime error.
  */
-export declare class SystemError extends BaseError {
+export declare class SystemError extends SystemError_base {
 }
+declare const DatabaseError_base: {
+    new (options?: import("@dxos/errors").BaseErrorOptions): {
+        name: "DatabaseError";
+        context: Record<string, unknown>;
+        readonly message: string;
+        readonly _tag: "DatabaseError";
+        stack?: string;
+        cause?: unknown;
+    };
+    name: "DatabaseError";
+    is(error: unknown): error is BaseError;
+    wrap(options?: Omit<import("@dxos/errors").BaseErrorOptions, "cause"> & {
+        ifTypeDiffers?: boolean;
+    }): (error: unknown) => {
+        name: "DatabaseError";
+        context: Record<string, unknown>;
+        readonly message: string;
+        readonly _tag: "DatabaseError";
+        stack?: string;
+        cause?: unknown;
+    };
+    extend<Name extends string = string>(name: Name, message?: string): any;
+    isError(error: unknown): error is Error;
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};
 /**
  * Database errors.
  */
-export declare class DatabaseError extends BaseError {
+export declare class DatabaseError extends DatabaseError_base {
 }
+export {};
 //# sourceMappingURL=base-errors.d.ts.map

package/dist/src/errors/base-errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-errors.d.ts","sourceRoot":"","sources":["../../../src/errors/base-errors.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAEhC,QAAQ,CAAC,IAAI,EAAE,MAAM;IAErB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;gBAF7B,IAAI,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,MAAM,EACP,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YAAA;CAQzC;AAKD;;;GAGG;AACH,qBAAa,QAAS,SAAQ,SAAS;CAAG;AAE1C;;;GAGG;AACH,qBAAa,WAAY,SAAQ,SAAS;CAAG;AAE7C;;GAEG;AAEH,qBAAa,aAAc,SAAQ,SAAS;CAAG"}
+{"version":3,"file":"base-errors.d.ts","sourceRoot":"","sources":["../../../src/errors/base-errors.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;;;;;;;;;;;;;qBAkB6c,CAAC;;;;;;;;;;;;;;;AAhBvf;;;GAGG;AACH,qBAAa,QAAS,SAAQ,aAA4B;CAAG;;;;;;;;;;;;;qBAYyb,CAAC;;;;;;;;;;;;;;;AAVvf;;;GAGG;AACH,qBAAa,WAAY,SAAQ,gBAA+B;CAAG;;;;;;;;;;;;;qBAMmb,CAAC;;;;;;;;;;;;;;;AAJvf;;GAEG;AACH,qBAAa,aAAc,SAAQ,kBAAiC;CAAG"}

package/dist/src/errors/base-errors.js

@@ -1,42 +1,26 @@
 //
 // 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 {
-    code;
-    context;
-    constructor(code, message, context) {
-        // TODO(dmaretskyi): Error.cause.
-        super(message ?? code);
-        this.code = code;
-        this.context = context;
-        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') {
 }
 //# sourceMappingURL=base-errors.js.map

package/dist/src/errors/base-errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-errors.js","sourceRoot":"","sources":["../../../src/errors/base-errors.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF,gDAAgD;AAEhD;;;GAGG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAEvB;IAEA;IAHX,YACW,IAAY,EACrB,OAAgB,EACP,OAA6B;QAEtC,iCAAiC;QACjC,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC;QALd,SAAI,GAAJ,IAAI,CAAQ;QAEZ,YAAO,GAAP,OAAO,CAAsB;QAItC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,yEAAyE;QACzE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;CACF;AAED,oEAAoE;AACpE,oFAAoF;AAEpF;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,SAAS;CAAG;AAE1C;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,SAAS;CAAG;AAE7C;;GAEG;AACH,sCAAsC;AACtC,MAAM,OAAO,aAAc,SAAQ,SAAS;CAAG"}
+{"version":3,"file":"base-errors.js","sourceRoot":"","sources":["../../../src/errors/base-errors.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF;;;GAGG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC;CAAG;AAE7D;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC;CAAG;AAEnE;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC;CAAG"}

package/dist/src/errors/encoding.d.ts

@@ -3,5 +3,5 @@ export declare const encodeError: (err: any) => SerializedErrorProto;
 export type DecodeOptions = {
     appendStack?: string;
 };
-export declare const decodeError: (err: SerializedErrorProto, { appendStack }?: DecodeOptions) => Error;
+export declare const decodeError: (err: SerializedErrorProto, { appendStack }?: DecodeOptions) => Error | import("@dxos/errors").BaseError<string>;
 //# sourceMappingURL=encoding.d.ts.map

package/dist/src/errors/encoding.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"encoding.d.ts","sourceRoot":"","sources":["../../../src/errors/encoding.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,KAAK,IAAI,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAIhF,eAAO,MAAM,WAAW,GAAI,KAAK,GAAG,KAAG,oBAiBtC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,WAAW,GAAI,KAAK,oBAAoB,EAAE,kBAAiB,aAAkB,UASzF,CAAC"}
+{"version":3,"file":"encoding.d.ts","sourceRoot":"","sources":["../../../src/errors/encoding.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,KAAK,IAAI,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAIhF,eAAO,MAAM,WAAW,GAAI,KAAK,GAAG,KAAG,oBAiBtC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,WAAW,GAAI,KAAK,oBAAoB,EAAE,kBAAiB,aAAkB,qDASzF,CAAC"}