@dxos/protocols 0.8.4-main.2e9d522 → 0.8.4-main.3c1ae3b

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

@@ -2,26 +2,110 @@
  * 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): {
+        code: "API";
+        context: Record<string, unknown>;
+        readonly name: "API";
+        readonly message: string;
+        readonly _tag: "API";
+        stack?: string;
+        cause?: unknown;
+    };
+    code: "API";
+    is(error: unknown): error is BaseError;
+    wrap(options?: Omit<import("@dxos/errors").BaseErrorOptions, "cause"> & {
+        ifTypeDiffers?: boolean;
+    }): (error: unknown) => {
+        code: "API";
+        context: Record<string, unknown>;
+        readonly name: "API";
+        readonly message: string;
+        readonly _tag: "API";
+        stack?: string;
+        cause?: unknown;
+    };
+    extend<Code extends string = string>(code: Code, 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): {
+        code: "SYSTEM";
+        context: Record<string, unknown>;
+        readonly name: "SYSTEM";
+        readonly message: string;
+        readonly _tag: "SYSTEM";
+        stack?: string;
+        cause?: unknown;
+    };
+    code: "SYSTEM";
+    is(error: unknown): error is BaseError;
+    wrap(options?: Omit<import("@dxos/errors").BaseErrorOptions, "cause"> & {
+        ifTypeDiffers?: boolean;
+    }): (error: unknown) => {
+        code: "SYSTEM";
+        context: Record<string, unknown>;
+        readonly name: "SYSTEM";
+        readonly message: string;
+        readonly _tag: "SYSTEM";
+        stack?: string;
+        cause?: unknown;
+    };
+    extend<Code extends string = string>(code: Code, 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): {
+        code: "DATABASE";
+        context: Record<string, unknown>;
+        readonly name: "DATABASE";
+        readonly message: string;
+        readonly _tag: "DATABASE";
+        stack?: string;
+        cause?: unknown;
+    };
+    code: "DATABASE";
+    is(error: unknown): error is BaseError;
+    wrap(options?: Omit<import("@dxos/errors").BaseErrorOptions, "cause"> & {
+        ifTypeDiffers?: boolean;
+    }): (error: unknown) => {
+        code: "DATABASE";
+        context: Record<string, unknown>;
+        readonly name: "DATABASE";
+        readonly message: string;
+        readonly _tag: "DATABASE";
+        stack?: string;
+        cause?: unknown;
+    };
+    extend<Code extends string = string>(code: Code, 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":"AAIA;;;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;;;;;;;;;;;;;;qBAkB0f,CAAC;;;;;;;;;;;;;;;;AAhBpiB;;;GAGG;AACH,qBAAa,QAAS,SAAQ,aAAuB;CAAG;;;;;;;;;;;;;;qBAY2e,CAAC;;;;;;;;;;;;;;;;AAVpiB;;;GAGG;AACH,qBAAa,WAAY,SAAQ,gBAA0B;CAAG;;;;;;;;;;;;;;qBAMqe,CAAC;;;;;;;;;;;;;;;;AAJpiB;;GAEG;AACH,qBAAa,aAAc,SAAQ,kBAA4B;CAAG"}

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

@@ -5,37 +5,22 @@
  * 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('API') {
 }
 /**
  * Internal system errors.
  * E.g., unexpected/unrecoverable runtime error.
  */
-export class SystemError extends BaseError {
+export class SystemError extends BaseError.extend('SYSTEM') {
 }
 /**
  * Database errors.
  */
-// TODO(wittjosiah): Same as ApiError?
-export class DatabaseError extends BaseError {
+export class DatabaseError extends BaseError.extend('DATABASE') {
 }
 //# 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;;;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,KAAK,CAAC;CAAG;AAExD;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC;CAAG;AAE9D;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS,CAAC,MAAM,CAAC,UAAU,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":"AAKA,OAAO,EAAE,KAAK,KAAK,IAAI,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAEhF,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"}

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

@@ -1 +1 @@
-{"version":3,"file":"encoding.js","sourceRoot":"","sources":["../../../src/errors/encoding.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAGhD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,GAAQ,EAAwB,EAAE;IAC5D,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,EAAE,OAAO,EAAE,CAAC;QAC5C,OAAO;YACL,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,KAAK,EAAE,GAAG,CAAC,KAAK;SACjB,CAAC;IACJ,CAAC;SAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACnC,OAAO;YACL,OAAO,EAAE,GAAG;SACb,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SAC7B,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAMF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,GAAyB,EAAE,EAAE,WAAW,KAAoB,EAAE,EAAE,EAAE;IAC5F,MAAM,KAAK,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,WAAW,EAAE,CAAC;QAChB,KAAK,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,OAAO,IAAI,CAAC,GAAG,WAAW,CAAC;IAClE,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAC1B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}
+{"version":3,"file":"encoding.js","sourceRoot":"","sources":["../../../src/errors/encoding.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAIF,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,GAAQ,EAAwB,EAAE;IAC5D,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,EAAE,OAAO,EAAE,CAAC;QAC5C,OAAO;YACL,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,KAAK,EAAE,GAAG,CAAC,KAAK;SACjB,CAAC;IACJ,CAAC;SAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACnC,OAAO;YACL,OAAO,EAAE,GAAG;SACb,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SAC7B,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAMF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,GAAyB,EAAE,EAAE,WAAW,KAAoB,EAAE,EAAE,EAAE;IAC5F,MAAM,KAAK,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,WAAW,EAAE,CAAC;QAChB,KAAK,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,OAAO,IAAI,CAAC,GAAG,WAAW,CAAC;IAClE,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAC1B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}