@twin.org/core 0.0.2-next.4 → 0.0.2-next.5

package/dist/cjs/index.cjs

@@ -631,31 +631,33 @@ class BaseError extends Error {
      */
     properties;
     /**
-     * The inner error if there was one.
+     * The cause of the error.
      */
-    inner;
+    cause;
     /**
      * Create a new instance of BaseError.
      * @param name The name of the error.
      * @param source The source of the error.
      * @param message The message as a code.
      * @param properties Any additional information for the error.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of error if we have wrapped another error.
      */
-    constructor(name, source, message, properties, inner) {
+    constructor(name, source, message, properties, cause) {
         super(message);
         this.name = name;
         this.source = source;
+        this.cause = Is.notEmpty(cause) ? BaseError.fromError(cause).toJsonObject(true) : undefined;
+        this.properties = properties;
         // If the message is camel case but has no namespace then prefix it
-        // with the source name in camel case
+        // with the source name in camel case.
         if (Is.stringValue(source) &&
             Is.stringValue(message) &&
             !message.includes(".") &&
+            // This comparison checks that it is most likely a camel case name
+            // and not a free text error with a dot in it
             StringHelper.camelCase(message) === message) {
             this.message = `${StringHelper.camelCase(source)}.${message}`;
         }
-        this.properties = properties;
-        this.inner = inner ? BaseError.fromError(inner).toJsonObject() : undefined;
     }
     /**
      * Construct an error from an existing one.
@@ -667,7 +669,7 @@ class BaseError extends Error {
         let message;
         let source;
         let properties;
-        let inner;
+        let cause;
         let stack;
         if (Is.object(err) && Is.stringValue(err.error)) {
             message = err.error;
@@ -685,8 +687,12 @@ class BaseError extends Error {
             if (Is.notEmpty(err.properties)) {
                 properties = err.properties;
             }
-            if (Is.notEmpty(err.inner)) {
-                inner = err.inner;
+            if (BaseError.isAggregateError(err)) {
+                properties ??= {};
+                properties.errors = err.errors;
+            }
+            if (Is.notEmpty(err.cause)) {
+                cause = err.cause;
             }
             if (Is.notEmpty(err.stack)) {
                 stack = err.stack;
@@ -698,7 +704,7 @@ class BaseError extends Error {
         else {
             message = JSON.stringify(err);
         }
-        const baseError = new BaseError(name, source ?? "", message ?? "", properties, inner);
+        const baseError = new BaseError(name, source ?? "", message ?? "", properties, cause);
         baseError.stack = stack;
         return baseError;
     }
@@ -711,10 +717,10 @@ class BaseError extends Error {
         const flattened = [];
         let e = BaseError.fromError(err).toJsonObject(true);
         while (e) {
-            const inner = e.inner;
-            e.inner = undefined;
+            const cause = e.cause;
+            e.cause = undefined;
             flattened.push(e);
-            e = inner;
+            e = cause;
         }
         return flattened;
     }
@@ -729,8 +735,8 @@ class BaseError extends Error {
             first = errors[0];
             let current = first;
             for (let i = 1; i < errors.length; i++) {
-                current.inner = errors[i];
-                current = current.inner;
+                current.cause = errors[i];
+                current = current.cause;
             }
         }
         return first;
@@ -804,7 +810,7 @@ class BaseError extends Error {
         return BaseError.flatten(error).some(e => BaseError.isErrorCode(e, code));
     }
     /**
-     * Is the error empty.
+     * Is the error empty, i.e. does it have no message, source, properties, or cause?
      * @param err The error to check for being empty.
      * @returns True if the error is empty.
      */
@@ -812,7 +818,27 @@ class BaseError extends Error {
         return (!Is.stringValue(err.message) &&
             !Is.stringValue(err.source) &&
             !Is.objectValue(err.properties) &&
-            Is.empty(err.inner));
+            Is.empty(err.cause));
+    }
+    /**
+     * Is the error an aggregate error.
+     * @param err The error to check for being an aggregate error.
+     * @returns True if the error is an aggregate error.
+     */
+    static isAggregateError(err) {
+        return err instanceof AggregateError;
+    }
+    /**
+     * Convert the aggregate error to an array of errors.
+     * @param err The error to convert.
+     * @param includeStackTrace Whether to include the error stack in the model, defaults to false.
+     * @returns The array of errors.
+     */
+    static fromAggregate(err, includeStackTrace) {
+        if (BaseError.isAggregateError(err)) {
+            return err.errors.map(e => BaseError.fromError(e).toJsonObject(includeStackTrace));
+        }
+        return [BaseError.fromError(err).toJsonObject(includeStackTrace)];
     }
     /**
      * Serialize the error to the error model.
@@ -836,8 +862,8 @@ class BaseError extends Error {
         if ((includeStackTrace ?? false) && Is.stringValue(this.stack)) {
             err.stack = this.stack;
         }
-        if (Is.notEmpty(this.inner)) {
-            err.inner = BaseError.fromError(this.inner).toJsonObject(includeStackTrace);
+        if (Is.notEmpty(this.cause)) {
+            err.cause = BaseError.fromError(this.cause).toJsonObject(includeStackTrace);
         }
         return err;
     }
@@ -856,10 +882,10 @@ class GeneralError extends BaseError {
      * @param source The source of the error.
      * @param message The message as a code.
      * @param properties Any additional information for the error.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of the error if we have wrapped another error.
      */
-    constructor(source, message, properties, inner) {
-        super(GeneralError.CLASS_NAME, source, message, properties, inner);
+    constructor(source, message, properties, cause) {
+        super(GeneralError.CLASS_NAME, source, message, properties, cause);
     }
 }
 
@@ -1778,10 +1804,10 @@ class AlreadyExistsError extends BaseError {
      * @param source The source of the error.
      * @param message The message as a code.
      * @param existingId The id for the item.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of the error if we have wrapped another error.
      */
-    constructor(source, message, existingId, inner) {
-        super(AlreadyExistsError.CLASS_NAME, source, message, { existingId }, inner);
+    constructor(source, message, existingId, cause) {
+        super(AlreadyExistsError.CLASS_NAME, source, message, { existingId });
     }
 }
 
@@ -1799,10 +1825,10 @@ class ConflictError extends BaseError {
      * @param message The message as a code.
      * @param conflictId The id that has conflicts.
      * @param conflicts The conflicts that occurred.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause or the error if we have wrapped another error.
      */
-    constructor(source, message, conflictId, conflicts, inner) {
-        super(ConflictError.CLASS_NAME, source, message, { conflictId, conflicts }, inner);
+    constructor(source, message, conflictId, conflicts, cause) {
+        super(ConflictError.CLASS_NAME, source, message, { conflictId, conflicts }, cause);
     }
 }
 
@@ -1819,10 +1845,10 @@ class NotFoundError extends BaseError {
      * @param source The source of the error.
      * @param message The message as a code.
      * @param notFoundId The id for the item.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of the error if we have wrapped another error.
      */
-    constructor(source, message, notFoundId, inner) {
-        super(NotFoundError.CLASS_NAME, source, message, { notFoundId }, inner);
+    constructor(source, message, notFoundId, cause) {
+        super(NotFoundError.CLASS_NAME, source, message, { notFoundId }, cause);
     }
 }
 
@@ -1858,10 +1884,10 @@ class NotSupportedError extends BaseError {
      * Create a new instance of NotSupportedError.
      * @param source The source of the error.
      * @param message The message as a code.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of the error if we have wrapped another error.
      */
-    constructor(source, message, inner) {
-        super(NotSupportedError.CLASS_NAME, source, message, undefined, inner);
+    constructor(source, message, cause) {
+        super(NotSupportedError.CLASS_NAME, source, message, undefined, cause);
     }
 }
 
@@ -1877,10 +1903,10 @@ class UnauthorizedError extends BaseError {
      * Create a new instance of UnauthorizedError.
      * @param source The source of the error.
      * @param message The message as a code.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of the error if we have wrapped another error.
      */
-    constructor(source, message, inner) {
-        super(UnauthorizedError.CLASS_NAME, source, message, undefined, inner);
+    constructor(source, message, cause) {
+        super(UnauthorizedError.CLASS_NAME, source, message, undefined, cause);
     }
 }
 
@@ -1897,10 +1923,10 @@ class UnprocessableError extends BaseError {
      * @param source The source of the error.
      * @param message The message as a code.
      * @param properties Any additional information for the error.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of the error if we have wrapped another error.
      */
-    constructor(source, message, properties, inner) {
-        super(UnprocessableError.CLASS_NAME, source, message, properties, inner);
+    constructor(source, message, properties, cause) {
+        super(UnprocessableError.CLASS_NAME, source, message, properties, cause);
     }
 }
 
@@ -2115,6 +2141,7 @@ class Factory {
      * @throws GeneralError if no item exists to get.
      */
     get(name) {
+        Guards.stringValue(Factory._CLASS_NAME, "name", name);
         const instance = this.getIfExists(name);
         if (!instance) {
             throw new GeneralError(Factory._CLASS_NAME, "noGet", {
@@ -2130,6 +2157,9 @@ class Factory {
      * @returns An instance of the item or undefined if it does not exist.
      */
     getIfExists(name) {
+        if (Is.empty(name)) {
+            return;
+        }
         Guards.stringValue(Factory._CLASS_NAME, "name", name);
         const matchName = this._matcher(Object.keys(this._generators), name);
         if (Is.stringValue(matchName) && this._generators[matchName]) {
@@ -3158,7 +3188,7 @@ class ErrorHelper {
      * Format Errors and returns just their messages.
      * @param error The error to format.
      * @param includeDetails Whether to include error details, defaults to false.
-     * @returns The error formatted including any inner errors.
+     * @returns The error formatted including any causes errors.
      */
     static formatErrors(error, includeDetails) {
         const localizedErrors = ErrorHelper.localizeErrors(error);
@@ -3176,7 +3206,7 @@ class ErrorHelper {
         return localizedErrors.map(e => e.message);
     }
     /**
-     * Localize the content of an error and any inner errors.
+     * Localize the content of an error and any causes.
      * @param error The error to format.
      * @returns The localized version of the errors flattened.
      */
@@ -3217,7 +3247,7 @@ class ErrorHelper {
         return formattedErrors;
     }
     /**
-     * Localize the content of an error and any inner errors.
+     * Localize the content of an error and any causes.
      * @param error The error to format.
      * @returns The localized version of the errors flattened.
      */
@@ -4285,7 +4315,7 @@ class Compression {
     static async compress(bytes, type) {
         Guards.uint8Array(Compression._CLASS_NAME, "bytes", bytes);
         Guards.arrayOneOf(Compression._CLASS_NAME, "type", type, Object.values(CompressionType));
-        const blob = new Blob([bytes]);
+        const blob = new Blob([new Uint8Array(bytes)]);
         const compressionStream = new CompressionStream(type);
         const compressionPipe = blob.stream().pipeThrough(compressionStream);
         const compressedBlob = await new Response(compressionPipe).blob();
@@ -4307,7 +4337,7 @@ class Compression {
     static async decompress(compressedBytes, type) {
         Guards.uint8Array(Compression._CLASS_NAME, "compressedBytes", compressedBytes);
         Guards.arrayOneOf(Compression._CLASS_NAME, "type", type, Object.values(CompressionType));
-        const blob = new Blob([compressedBytes]);
+        const blob = new Blob([new Uint8Array(compressedBytes)]);
         const decompressionStream = new DecompressionStream(type);
         const decompressionPipe = blob.stream().pipeThrough(decompressionStream);
         const decompressedBlob = await new Response(decompressionPipe).blob();

package/dist/esm/index.mjs

@@ -629,31 +629,33 @@ class BaseError extends Error {
      */
     properties;
     /**
-     * The inner error if there was one.
+     * The cause of the error.
      */
-    inner;
+    cause;
     /**
      * Create a new instance of BaseError.
      * @param name The name of the error.
      * @param source The source of the error.
      * @param message The message as a code.
      * @param properties Any additional information for the error.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of error if we have wrapped another error.
      */
-    constructor(name, source, message, properties, inner) {
+    constructor(name, source, message, properties, cause) {
         super(message);
         this.name = name;
         this.source = source;
+        this.cause = Is.notEmpty(cause) ? BaseError.fromError(cause).toJsonObject(true) : undefined;
+        this.properties = properties;
         // If the message is camel case but has no namespace then prefix it
-        // with the source name in camel case
+        // with the source name in camel case.
         if (Is.stringValue(source) &&
             Is.stringValue(message) &&
             !message.includes(".") &&
+            // This comparison checks that it is most likely a camel case name
+            // and not a free text error with a dot in it
             StringHelper.camelCase(message) === message) {
             this.message = `${StringHelper.camelCase(source)}.${message}`;
         }
-        this.properties = properties;
-        this.inner = inner ? BaseError.fromError(inner).toJsonObject() : undefined;
     }
     /**
      * Construct an error from an existing one.
@@ -665,7 +667,7 @@ class BaseError extends Error {
         let message;
         let source;
         let properties;
-        let inner;
+        let cause;
         let stack;
         if (Is.object(err) && Is.stringValue(err.error)) {
             message = err.error;
@@ -683,8 +685,12 @@ class BaseError extends Error {
             if (Is.notEmpty(err.properties)) {
                 properties = err.properties;
             }
-            if (Is.notEmpty(err.inner)) {
-                inner = err.inner;
+            if (BaseError.isAggregateError(err)) {
+                properties ??= {};
+                properties.errors = err.errors;
+            }
+            if (Is.notEmpty(err.cause)) {
+                cause = err.cause;
             }
             if (Is.notEmpty(err.stack)) {
                 stack = err.stack;
@@ -696,7 +702,7 @@ class BaseError extends Error {
         else {
             message = JSON.stringify(err);
         }
-        const baseError = new BaseError(name, source ?? "", message ?? "", properties, inner);
+        const baseError = new BaseError(name, source ?? "", message ?? "", properties, cause);
         baseError.stack = stack;
         return baseError;
     }
@@ -709,10 +715,10 @@ class BaseError extends Error {
         const flattened = [];
         let e = BaseError.fromError(err).toJsonObject(true);
         while (e) {
-            const inner = e.inner;
-            e.inner = undefined;
+            const cause = e.cause;
+            e.cause = undefined;
             flattened.push(e);
-            e = inner;
+            e = cause;
         }
         return flattened;
     }
@@ -727,8 +733,8 @@ class BaseError extends Error {
             first = errors[0];
             let current = first;
             for (let i = 1; i < errors.length; i++) {
-                current.inner = errors[i];
-                current = current.inner;
+                current.cause = errors[i];
+                current = current.cause;
             }
         }
         return first;
@@ -802,7 +808,7 @@ class BaseError extends Error {
         return BaseError.flatten(error).some(e => BaseError.isErrorCode(e, code));
     }
     /**
-     * Is the error empty.
+     * Is the error empty, i.e. does it have no message, source, properties, or cause?
      * @param err The error to check for being empty.
      * @returns True if the error is empty.
      */
@@ -810,7 +816,27 @@ class BaseError extends Error {
         return (!Is.stringValue(err.message) &&
             !Is.stringValue(err.source) &&
             !Is.objectValue(err.properties) &&
-            Is.empty(err.inner));
+            Is.empty(err.cause));
+    }
+    /**
+     * Is the error an aggregate error.
+     * @param err The error to check for being an aggregate error.
+     * @returns True if the error is an aggregate error.
+     */
+    static isAggregateError(err) {
+        return err instanceof AggregateError;
+    }
+    /**
+     * Convert the aggregate error to an array of errors.
+     * @param err The error to convert.
+     * @param includeStackTrace Whether to include the error stack in the model, defaults to false.
+     * @returns The array of errors.
+     */
+    static fromAggregate(err, includeStackTrace) {
+        if (BaseError.isAggregateError(err)) {
+            return err.errors.map(e => BaseError.fromError(e).toJsonObject(includeStackTrace));
+        }
+        return [BaseError.fromError(err).toJsonObject(includeStackTrace)];
     }
     /**
      * Serialize the error to the error model.
@@ -834,8 +860,8 @@ class BaseError extends Error {
         if ((includeStackTrace ?? false) && Is.stringValue(this.stack)) {
             err.stack = this.stack;
         }
-        if (Is.notEmpty(this.inner)) {
-            err.inner = BaseError.fromError(this.inner).toJsonObject(includeStackTrace);
+        if (Is.notEmpty(this.cause)) {
+            err.cause = BaseError.fromError(this.cause).toJsonObject(includeStackTrace);
         }
         return err;
     }
@@ -854,10 +880,10 @@ class GeneralError extends BaseError {
      * @param source The source of the error.
      * @param message The message as a code.
      * @param properties Any additional information for the error.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of the error if we have wrapped another error.
      */
-    constructor(source, message, properties, inner) {
-        super(GeneralError.CLASS_NAME, source, message, properties, inner);
+    constructor(source, message, properties, cause) {
+        super(GeneralError.CLASS_NAME, source, message, properties, cause);
     }
 }
 
@@ -1776,10 +1802,10 @@ class AlreadyExistsError extends BaseError {
      * @param source The source of the error.
      * @param message The message as a code.
      * @param existingId The id for the item.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of the error if we have wrapped another error.
      */
-    constructor(source, message, existingId, inner) {
-        super(AlreadyExistsError.CLASS_NAME, source, message, { existingId }, inner);
+    constructor(source, message, existingId, cause) {
+        super(AlreadyExistsError.CLASS_NAME, source, message, { existingId });
     }
 }
 
@@ -1797,10 +1823,10 @@ class ConflictError extends BaseError {
      * @param message The message as a code.
      * @param conflictId The id that has conflicts.
      * @param conflicts The conflicts that occurred.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause or the error if we have wrapped another error.
      */
-    constructor(source, message, conflictId, conflicts, inner) {
-        super(ConflictError.CLASS_NAME, source, message, { conflictId, conflicts }, inner);
+    constructor(source, message, conflictId, conflicts, cause) {
+        super(ConflictError.CLASS_NAME, source, message, { conflictId, conflicts }, cause);
     }
 }
 
@@ -1817,10 +1843,10 @@ class NotFoundError extends BaseError {
      * @param source The source of the error.
      * @param message The message as a code.
      * @param notFoundId The id for the item.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of the error if we have wrapped another error.
      */
-    constructor(source, message, notFoundId, inner) {
-        super(NotFoundError.CLASS_NAME, source, message, { notFoundId }, inner);
+    constructor(source, message, notFoundId, cause) {
+        super(NotFoundError.CLASS_NAME, source, message, { notFoundId }, cause);
     }
 }
 
@@ -1856,10 +1882,10 @@ class NotSupportedError extends BaseError {
      * Create a new instance of NotSupportedError.
      * @param source The source of the error.
      * @param message The message as a code.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of the error if we have wrapped another error.
      */
-    constructor(source, message, inner) {
-        super(NotSupportedError.CLASS_NAME, source, message, undefined, inner);
+    constructor(source, message, cause) {
+        super(NotSupportedError.CLASS_NAME, source, message, undefined, cause);
     }
 }
 
@@ -1875,10 +1901,10 @@ class UnauthorizedError extends BaseError {
      * Create a new instance of UnauthorizedError.
      * @param source The source of the error.
      * @param message The message as a code.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of the error if we have wrapped another error.
      */
-    constructor(source, message, inner) {
-        super(UnauthorizedError.CLASS_NAME, source, message, undefined, inner);
+    constructor(source, message, cause) {
+        super(UnauthorizedError.CLASS_NAME, source, message, undefined, cause);
     }
 }
 
@@ -1895,10 +1921,10 @@ class UnprocessableError extends BaseError {
      * @param source The source of the error.
      * @param message The message as a code.
      * @param properties Any additional information for the error.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of the error if we have wrapped another error.
      */
-    constructor(source, message, properties, inner) {
-        super(UnprocessableError.CLASS_NAME, source, message, properties, inner);
+    constructor(source, message, properties, cause) {
+        super(UnprocessableError.CLASS_NAME, source, message, properties, cause);
     }
 }
 
@@ -2113,6 +2139,7 @@ class Factory {
      * @throws GeneralError if no item exists to get.
      */
     get(name) {
+        Guards.stringValue(Factory._CLASS_NAME, "name", name);
         const instance = this.getIfExists(name);
         if (!instance) {
             throw new GeneralError(Factory._CLASS_NAME, "noGet", {
@@ -2128,6 +2155,9 @@ class Factory {
      * @returns An instance of the item or undefined if it does not exist.
      */
     getIfExists(name) {
+        if (Is.empty(name)) {
+            return;
+        }
         Guards.stringValue(Factory._CLASS_NAME, "name", name);
         const matchName = this._matcher(Object.keys(this._generators), name);
         if (Is.stringValue(matchName) && this._generators[matchName]) {
@@ -3156,7 +3186,7 @@ class ErrorHelper {
      * Format Errors and returns just their messages.
      * @param error The error to format.
      * @param includeDetails Whether to include error details, defaults to false.
-     * @returns The error formatted including any inner errors.
+     * @returns The error formatted including any causes errors.
      */
     static formatErrors(error, includeDetails) {
         const localizedErrors = ErrorHelper.localizeErrors(error);
@@ -3174,7 +3204,7 @@ class ErrorHelper {
         return localizedErrors.map(e => e.message);
     }
     /**
-     * Localize the content of an error and any inner errors.
+     * Localize the content of an error and any causes.
      * @param error The error to format.
      * @returns The localized version of the errors flattened.
      */
@@ -3215,7 +3245,7 @@ class ErrorHelper {
         return formattedErrors;
     }
     /**
-     * Localize the content of an error and any inner errors.
+     * Localize the content of an error and any causes.
      * @param error The error to format.
      * @returns The localized version of the errors flattened.
      */
@@ -4283,7 +4313,7 @@ class Compression {
     static async compress(bytes, type) {
         Guards.uint8Array(Compression._CLASS_NAME, "bytes", bytes);
         Guards.arrayOneOf(Compression._CLASS_NAME, "type", type, Object.values(CompressionType));
-        const blob = new Blob([bytes]);
+        const blob = new Blob([new Uint8Array(bytes)]);
         const compressionStream = new CompressionStream(type);
         const compressionPipe = blob.stream().pipeThrough(compressionStream);
         const compressedBlob = await new Response(compressionPipe).blob();
@@ -4305,7 +4335,7 @@ class Compression {
     static async decompress(compressedBytes, type) {
         Guards.uint8Array(Compression._CLASS_NAME, "compressedBytes", compressedBytes);
         Guards.arrayOneOf(Compression._CLASS_NAME, "type", type, Object.values(CompressionType));
-        const blob = new Blob([compressedBytes]);
+        const blob = new Blob([new Uint8Array(compressedBytes)]);
         const decompressionStream = new DecompressionStream(type);
         const decompressionPipe = blob.stream().pipeThrough(decompressionStream);
         const decompressedBlob = await new Response(decompressionPipe).blob();

package/dist/types/errors/alreadyExistsError.d.ts

@@ -12,7 +12,7 @@ export declare class AlreadyExistsError extends BaseError {
      * @param source The source of the error.
      * @param message The message as a code.
      * @param existingId The id for the item.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of the error if we have wrapped another error.
      */
-    constructor(source: string, message: string, existingId?: string, inner?: unknown);
+    constructor(source: string, message: string, existingId?: string, cause?: unknown);
 }

package/dist/types/errors/baseError.d.ts

@@ -14,20 +14,20 @@ export declare class BaseError extends Error implements IError {
         [id: string]: unknown;
     };
     /**
-     * The inner error if there was one.
+     * The cause of the error.
      */
-    inner?: IError;
+    cause?: IError;
     /**
      * Create a new instance of BaseError.
      * @param name The name of the error.
      * @param source The source of the error.
      * @param message The message as a code.
      * @param properties Any additional information for the error.
-     * @param inner The inner error if we have wrapped another error.
+     * @param cause The cause of error if we have wrapped another error.
      */
     constructor(name: string, source: string, message: string, properties?: {
         [id: string]: unknown;
-    }, inner?: unknown);
+    }, cause?: unknown);
     /**
      * Construct an error from an existing one.
      * @param err The existing error.
@@ -96,11 +96,24 @@ export declare class BaseError extends Error implements IError {
      */
     static someErrorCode(error: unknown, code: string | RegExp): error is BaseError;
     /**
-     * Is the error empty.
+     * Is the error empty, i.e. does it have no message, source, properties, or cause?
      * @param err The error to check for being empty.
      * @returns True if the error is empty.
      */
     static isEmpty(err: IError): boolean;
+    /**
+     * Is the error an aggregate error.
+     * @param err The error to check for being an aggregate error.
+     * @returns True if the error is an aggregate error.
+     */
+    static isAggregateError(err: unknown): err is AggregateError;
+    /**
+     * Convert the aggregate error to an array of errors.
+     * @param err The error to convert.
+     * @param includeStackTrace Whether to include the error stack in the model, defaults to false.
+     * @returns The array of errors.
+     */
+    static fromAggregate(err: unknown, includeStackTrace?: boolean): IError[];
     /**
      * Serialize the error to the error model.
      * @param includeStackTrace Whether to include the error stack in the model, defaults to false.