@twin.org/core 0.0.2-next.9 → 0.0.3-next.2

package/dist/es/errors/baseError.js

@@ -0,0 +1,257 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { StringHelper } from "../helpers/stringHelper.js";
+import { Is } from "../utils/is.js";
+/**
+ * Class to handle errors.
+ */
+export class BaseError extends Error {
+    /**
+     * The source of the error.
+     */
+    source;
+    /**
+     * Any additional information for the error.
+     */
+    properties;
+    /**
+     * The cause of the error.
+     */
+    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 cause The cause of error if we have wrapped another error.
+     */
+    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.
+        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}`;
+        }
+    }
+    /**
+     * Construct an error from an existing one.
+     * @param err The existing error.
+     * @returns The new instance.
+     */
+    static fromError(err) {
+        let name = "Base";
+        let message;
+        let source;
+        let properties;
+        let cause;
+        let stack;
+        if (Is.object(err) && Is.stringValue(err.error)) {
+            message = err.error;
+        }
+        else if (Is.object(err)) {
+            if (Is.stringValue(err.name)) {
+                name = err.name;
+            }
+            if (Is.stringValue(err.source)) {
+                source = err.source;
+            }
+            if (Is.stringValue(err.message)) {
+                message = err.message;
+            }
+            if (Is.notEmpty(err.properties)) {
+                properties = err.properties;
+            }
+            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;
+            }
+        }
+        else if (Is.stringValue(err)) {
+            message = err;
+        }
+        else {
+            message = JSON.stringify(err);
+        }
+        const baseError = new BaseError(name, source ?? "", message ?? "", properties, cause);
+        baseError.stack = stack;
+        return baseError;
+    }
+    /**
+     * Flatten an error tree.
+     * @param err The starting error.
+     * @returns The list of all internal errors.
+     */
+    static flatten(err) {
+        const flattened = [];
+        let e = BaseError.fromError(err).toJsonObject(true);
+        while (e) {
+            const cause = e.cause;
+            e.cause = undefined;
+            flattened.push(e);
+            e = cause;
+        }
+        return flattened;
+    }
+    /**
+     * Expand an error tree.
+     * @param errors The list of errors to expand.
+     * @returns The first level error.
+     */
+    static expand(errors) {
+        let first;
+        if (Is.arrayValue(errors)) {
+            first = errors[0];
+            let current = first;
+            for (let i = 1; i < errors.length; i++) {
+                current.cause = errors[i];
+                current = current.cause;
+            }
+        }
+        return first;
+    }
+    /**
+     * Test to see if the error has the specified error name.
+     * @param error The error to test.
+     * @param name The name to check for.
+     * @returns True if the error has the name.
+     */
+    static isErrorName(error, name) {
+        return (Is.object(error) &&
+            (Is.string(name) ? error.name === name : name.test(error.name)));
+    }
+    /**
+     * Test to see if the error has the specified error message.
+     * @param error The error to test.
+     * @param message The message to check for.
+     * @returns True if the error has the name.
+     */
+    static isErrorMessage(error, message) {
+        return (Is.object(error) &&
+            (Is.string(message) ? error.message === message : message.test(error.message)));
+    }
+    /**
+     * Test to see if the error has the specified error code.
+     * @param error The error to test.
+     * @param code The code to check for.
+     * @returns True if the error has the code.
+     */
+    static isErrorCode(error, code) {
+        return (Is.object(error) &&
+            (Is.string(code) ? error.code === code : code.test(error.code)));
+    }
+    /**
+     * Test to see if any of the errors or children have the given error name.
+     * @param error The error to test.
+     * @param name The name to check for.
+     * @returns True if the error has the name.
+     */
+    static someErrorName(error, name) {
+        return BaseError.flatten(error).some(e => BaseError.isErrorName(e, name));
+    }
+    /**
+     * Test to see if any of the errors or children have the given error message.
+     * @param error The error to test.
+     * @param message The message to check for.
+     * @returns True if the error has the name.
+     */
+    static someErrorMessage(error, message) {
+        return BaseError.flatten(error).some(e => BaseError.isErrorMessage(e, message));
+    }
+    /**
+     * Test to see if any of the errors or children are from a specific class.
+     * @param error The error to test.
+     * @param cls The class to check for.
+     * @returns True if the error has the specific class.
+     */
+    static someErrorClass(error, cls) {
+        const errorClass = StringHelper.camelCase(cls);
+        const regExp = new RegExp(`^${errorClass}\\.`);
+        return BaseError.flatten(error).some(e => BaseError.isErrorMessage(e, regExp));
+    }
+    /**
+     * Test to see if any of the errors or children have the given error code.
+     * @param error The error to test.
+     * @param code The code to check for.
+     * @returns True if the error has the name.
+     */
+    static someErrorCode(error, code) {
+        return BaseError.flatten(error).some(e => BaseError.isErrorCode(e, code));
+    }
+    /**
+     * 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) {
+        return (!Is.stringValue(err.message) &&
+            !Is.stringValue(err.source) &&
+            !Is.objectValue(err.properties) &&
+            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) {
+        // This is the only way we can reliably check for AggregateError
+        // eslint-disable-next-line no-restricted-syntax
+        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.
+     * @param includeStackTrace Whether to include the error stack in the model, defaults to false.
+     * @returns The error model.
+     */
+    toJsonObject(includeStackTrace) {
+        const err = {};
+        if (Is.stringValue(this.name)) {
+            err.name = this.name;
+        }
+        if (Is.stringValue(this.source)) {
+            err.source = this.source;
+        }
+        if (Is.stringValue(this.message)) {
+            err.message = this.message;
+        }
+        if (Is.object(this.properties)) {
+            err.properties = this.properties;
+        }
+        if ((includeStackTrace ?? false) && Is.stringValue(this.stack)) {
+            err.stack = this.stack;
+        }
+        if (Is.notEmpty(this.cause)) {
+            err.cause = BaseError.fromError(this.cause).toJsonObject(includeStackTrace);
+        }
+        return err;
+    }
+}
+//# sourceMappingURL=baseError.js.map

package/dist/es/errors/baseError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseError.js","sourceRoot":"","sources":["../../../src/errors/baseError.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,OAAO,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAEpC;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IACnC;;OAEG;IACI,MAAM,CAAU;IAEvB;;OAEG;IACI,UAAU,CAA6B;IAE9C;;OAEG;IACI,KAAK,CAAU;IAEtB;;;;;;;OAOG;IACH,YACC,IAAY,EACZ,MAAc,EACd,OAAe,EACf,UAAsC,EACtC,KAAe;QAEf,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5F,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,mEAAmE;QACnE,sCAAsC;QACtC,IACC,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC;YACtB,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC;YACvB,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;YACtB,kEAAkE;YAClE,6CAA6C;YAC7C,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,OAAO,EAC1C,CAAC;YACF,IAAI,CAAC,OAAO,GAAG,GAAG,YAAY,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;QAC/D,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,GAAY;QACnC,IAAI,IAAI,GAAG,MAAM,CAAC;QAClB,IAAI,OAAO,CAAC;QACZ,IAAI,MAAM,CAAC;QACX,IAAI,UAAU,CAAC;QACf,IAAI,KAAK,CAAC;QACV,IAAI,KAAK,CAAC;QAEV,IAAI,EAAE,CAAC,MAAM,CAAoB,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACpE,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC;QACrB,CAAC;aAAM,IAAI,EAAE,CAAC,MAAM,CAAY,GAAG,CAAC,EAAE,CAAC;YACtC,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;YACjB,CAAC;YACD,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBAChC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;YACrB,CAAC;YACD,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBACjC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;YACvB,CAAC;YACD,IAAI,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBACjC,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;YAC7B,CAAC;YACD,IAAI,SAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC;gBACrC,UAAU,KAAK,EAAE,CAAC;gBAClB,UAAU,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;YAChC,CAAC;YACD,IAAI,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5B,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;YACnB,CAAC;YACD,IAAI,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5B,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;YACnB,CAAC;QACF,CAAC;aAAM,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;YAChC,OAAO,GAAG,GAAG,CAAC;QACf,CAAC;aAAM,CAAC;YACP,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC/B,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,IAAI,EAAE,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QAEtF,SAAS,CAAC,KAAK,GAAG,KAAK,CAAC;QAExB,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,GAAY;QACjC,MAAM,SAAS,GAAa,EAAE,CAAC;QAE/B,IAAI,CAAC,GAAuB,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAExE,OAAO,CAAC,EAAE,CAAC;YACV,MAAM,KAAK,GAAuB,CAAC,CAAC,KAAK,CAAC;YAC1C,CAAC,CAAC,KAAK,GAAG,SAAS,CAAC;YACpB,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC,GAAG,KAAK,CAAC;QACX,CAAC;QAED,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAM,CAAC,MAA4B;QAChD,IAAI,KAAyB,CAAC;QAE9B,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YAClB,IAAI,OAAO,GAAG,KAAK,CAAC;YACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACxC,OAAO,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;gBAC1B,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC;YACzB,CAAC;QACF,CAAC;QAED,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,KAAc,EAAE,IAAqB;QAC9D,OAAO,CACN,EAAE,CAAC,MAAM,CAAmB,KAAK,CAAC;YAClC,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAC/D,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,KAAc,EAAE,OAAwB;QACpE,OAAO,CACN,EAAE,CAAC,MAAM,CAAsB,KAAK,CAAC;YACrC,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAC9E,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,KAAc,EAAE,IAAqB;QAC9D,OAAO,CACN,EAAE,CAAC,MAAM,CAAmB,KAAK,CAAC;YAClC,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAC/D,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,KAAc,EAAE,IAAqB;QAChE,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAAC,KAAc,EAAE,OAAwB;QACtE,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IACjF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,KAAc,EAAE,GAAW;QACvD,MAAM,UAAU,GAAG,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,UAAU,KAAK,CAAC,CAAC;QAC/C,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAChF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,KAAc,EAAE,IAAqB;QAChE,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,GAAW;QAChC,OAAO,CACN,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC;YAC5B,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC;YAC3B,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC;YAC/B,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CACnB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,GAAY;QAC1C,gEAAgE;QAChE,gDAAgD;QAChD,OAAO,GAAG,YAAY,cAAc,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,GAAY,EAAE,iBAA2B;QACpE,IAAI,SAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC;YACrC,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACpF,CAAC;QACD,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,iBAA2B;QAC9C,MAAM,GAAG,GAAoB,EAAE,CAAC;QAChC,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/B,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,CAAC;QACD,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACjC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,CAAC;QACD,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAClC,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,CAAC;QACD,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAChC,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,CAAC;QACD,IAAI,CAAC,iBAAiB,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAChE,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,CAAC;QACD,IAAI,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,GAAG,CAAC,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;QAC7E,CAAC;QACD,OAAO,GAAa,CAAC;IACtB,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { StringHelper } from \"../helpers/stringHelper.js\";\nimport type { IError } from \"../models/IError.js\";\nimport { Is } from \"../utils/is.js\";\n\n/**\n * Class to handle errors.\n */\nexport class BaseError extends Error implements IError {\n\t/**\n\t * The source of the error.\n\t */\n\tpublic source?: string;\n\n\t/**\n\t * Any additional information for the error.\n\t */\n\tpublic properties?: { [id: string]: unknown };\n\n\t/**\n\t * The cause of the error.\n\t */\n\tpublic cause?: IError;\n\n\t/**\n\t * Create a new instance of BaseError.\n\t * @param name The name of the error.\n\t * @param source The source of the error.\n\t * @param message The message as a code.\n\t * @param properties Any additional information for the error.\n\t * @param cause The cause of error if we have wrapped another error.\n\t */\n\tconstructor(\n\t\tname: string,\n\t\tsource: string,\n\t\tmessage: string,\n\t\tproperties?: { [id: string]: unknown },\n\t\tcause?: unknown\n\t) {\n\t\tsuper(message);\n\t\tthis.name = name;\n\t\tthis.source = source;\n\t\tthis.cause = Is.notEmpty(cause) ? BaseError.fromError(cause).toJsonObject(true) : undefined;\n\t\tthis.properties = properties;\n\n\t\t// If the message is camel case but has no namespace then prefix it\n\t\t// with the source name in camel case.\n\t\tif (\n\t\t\tIs.stringValue(source) &&\n\t\t\tIs.stringValue(message) &&\n\t\t\t!message.includes(\".\") &&\n\t\t\t// This comparison checks that it is most likely a camel case name\n\t\t\t// and not a free text error with a dot in it\n\t\t\tStringHelper.camelCase(message) === message\n\t\t) {\n\t\t\tthis.message = `${StringHelper.camelCase(source)}.${message}`;\n\t\t}\n\t}\n\n\t/**\n\t * Construct an error from an existing one.\n\t * @param err The existing error.\n\t * @returns The new instance.\n\t */\n\tpublic static fromError(err: unknown): BaseError {\n\t\tlet name = \"Base\";\n\t\tlet message;\n\t\tlet source;\n\t\tlet properties;\n\t\tlet cause;\n\t\tlet stack;\n\n\t\tif (Is.object<{ error: string }>(err) && Is.stringValue(err.error)) {\n\t\t\tmessage = err.error;\n\t\t} else if (Is.object<BaseError>(err)) {\n\t\t\tif (Is.stringValue(err.name)) {\n\t\t\t\tname = err.name;\n\t\t\t}\n\t\t\tif (Is.stringValue(err.source)) {\n\t\t\t\tsource = err.source;\n\t\t\t}\n\t\t\tif (Is.stringValue(err.message)) {\n\t\t\t\tmessage = err.message;\n\t\t\t}\n\t\t\tif (Is.notEmpty(err.properties)) {\n\t\t\t\tproperties = err.properties;\n\t\t\t}\n\t\t\tif (BaseError.isAggregateError(err)) {\n\t\t\t\tproperties ??= {};\n\t\t\t\tproperties.errors = err.errors;\n\t\t\t}\n\t\t\tif (Is.notEmpty(err.cause)) {\n\t\t\t\tcause = err.cause;\n\t\t\t}\n\t\t\tif (Is.notEmpty(err.stack)) {\n\t\t\t\tstack = err.stack;\n\t\t\t}\n\t\t} else if (Is.stringValue(err)) {\n\t\t\tmessage = err;\n\t\t} else {\n\t\t\tmessage = JSON.stringify(err);\n\t\t}\n\n\t\tconst baseError = new BaseError(name, source ?? \"\", message ?? \"\", properties, cause);\n\n\t\tbaseError.stack = stack;\n\n\t\treturn baseError;\n\t}\n\n\t/**\n\t * Flatten an error tree.\n\t * @param err The starting error.\n\t * @returns The list of all internal errors.\n\t */\n\tpublic static flatten(err: unknown): IError[] {\n\t\tconst flattened: IError[] = [];\n\n\t\tlet e: IError | undefined = BaseError.fromError(err).toJsonObject(true);\n\n\t\twhile (e) {\n\t\t\tconst cause: IError | undefined = e.cause;\n\t\t\te.cause = undefined;\n\t\t\tflattened.push(e);\n\t\t\te = cause;\n\t\t}\n\n\t\treturn flattened;\n\t}\n\n\t/**\n\t * Expand an error tree.\n\t * @param errors The list of errors to expand.\n\t * @returns The first level error.\n\t */\n\tpublic static expand(errors: IError[] | undefined): IError | undefined {\n\t\tlet first: IError | undefined;\n\n\t\tif (Is.arrayValue(errors)) {\n\t\t\tfirst = errors[0];\n\t\t\tlet current = first;\n\t\t\tfor (let i = 1; i < errors.length; i++) {\n\t\t\t\tcurrent.cause = errors[i];\n\t\t\t\tcurrent = current.cause;\n\t\t\t}\n\t\t}\n\n\t\treturn first;\n\t}\n\n\t/**\n\t * Test to see if the error has the specified error name.\n\t * @param error The error to test.\n\t * @param name The name to check for.\n\t * @returns True if the error has the name.\n\t */\n\tpublic static isErrorName(error: unknown, name: string | RegExp): error is BaseError {\n\t\treturn (\n\t\t\tIs.object<{ name: string }>(error) &&\n\t\t\t(Is.string(name) ? error.name === name : name.test(error.name))\n\t\t);\n\t}\n\n\t/**\n\t * Test to see if the error has the specified error message.\n\t * @param error The error to test.\n\t * @param message The message to check for.\n\t * @returns True if the error has the name.\n\t */\n\tpublic static isErrorMessage(error: unknown, message: string | RegExp): error is BaseError {\n\t\treturn (\n\t\t\tIs.object<{ message: string }>(error) &&\n\t\t\t(Is.string(message) ? error.message === message : message.test(error.message))\n\t\t);\n\t}\n\n\t/**\n\t * Test to see if the error has the specified error code.\n\t * @param error The error to test.\n\t * @param code The code to check for.\n\t * @returns True if the error has the code.\n\t */\n\tpublic static isErrorCode(error: unknown, code: string | RegExp): boolean {\n\t\treturn (\n\t\t\tIs.object<{ code: string }>(error) &&\n\t\t\t(Is.string(code) ? error.code === code : code.test(error.code))\n\t\t);\n\t}\n\n\t/**\n\t * Test to see if any of the errors or children have the given error name.\n\t * @param error The error to test.\n\t * @param name The name to check for.\n\t * @returns True if the error has the name.\n\t */\n\tpublic static someErrorName(error: unknown, name: string | RegExp): error is BaseError {\n\t\treturn BaseError.flatten(error).some(e => BaseError.isErrorName(e, name));\n\t}\n\n\t/**\n\t * Test to see if any of the errors or children have the given error message.\n\t * @param error The error to test.\n\t * @param message The message to check for.\n\t * @returns True if the error has the name.\n\t */\n\tpublic static someErrorMessage(error: unknown, message: string | RegExp): error is BaseError {\n\t\treturn BaseError.flatten(error).some(e => BaseError.isErrorMessage(e, message));\n\t}\n\n\t/**\n\t * Test to see if any of the errors or children are from a specific class.\n\t * @param error The error to test.\n\t * @param cls The class to check for.\n\t * @returns True if the error has the specific class.\n\t */\n\tpublic static someErrorClass(error: unknown, cls: string): error is BaseError {\n\t\tconst errorClass = StringHelper.camelCase(cls);\n\t\tconst regExp = new RegExp(`^${errorClass}\\\\.`);\n\t\treturn BaseError.flatten(error).some(e => BaseError.isErrorMessage(e, regExp));\n\t}\n\n\t/**\n\t * Test to see if any of the errors or children have the given error code.\n\t * @param error The error to test.\n\t * @param code The code to check for.\n\t * @returns True if the error has the name.\n\t */\n\tpublic static someErrorCode(error: unknown, code: string | RegExp): error is BaseError {\n\t\treturn BaseError.flatten(error).some(e => BaseError.isErrorCode(e, code));\n\t}\n\n\t/**\n\t * Is the error empty, i.e. does it have no message, source, properties, or cause?\n\t * @param err The error to check for being empty.\n\t * @returns True if the error is empty.\n\t */\n\tpublic static isEmpty(err: IError): boolean {\n\t\treturn (\n\t\t\t!Is.stringValue(err.message) &&\n\t\t\t!Is.stringValue(err.source) &&\n\t\t\t!Is.objectValue(err.properties) &&\n\t\t\tIs.empty(err.cause)\n\t\t);\n\t}\n\n\t/**\n\t * Is the error an aggregate error.\n\t * @param err The error to check for being an aggregate error.\n\t * @returns True if the error is an aggregate error.\n\t */\n\tpublic static isAggregateError(err: unknown): err is AggregateError {\n\t\t// This is the only way we can reliably check for AggregateError\n\t\t// eslint-disable-next-line no-restricted-syntax\n\t\treturn err instanceof AggregateError;\n\t}\n\n\t/**\n\t * Convert the aggregate error to an array of errors.\n\t * @param err The error to convert.\n\t * @param includeStackTrace Whether to include the error stack in the model, defaults to false.\n\t * @returns The array of errors.\n\t */\n\tpublic static fromAggregate(err: unknown, includeStackTrace?: boolean): IError[] {\n\t\tif (BaseError.isAggregateError(err)) {\n\t\t\treturn err.errors.map(e => BaseError.fromError(e).toJsonObject(includeStackTrace));\n\t\t}\n\t\treturn [BaseError.fromError(err).toJsonObject(includeStackTrace)];\n\t}\n\n\t/**\n\t * Serialize the error to the error model.\n\t * @param includeStackTrace Whether to include the error stack in the model, defaults to false.\n\t * @returns The error model.\n\t */\n\tpublic toJsonObject(includeStackTrace?: boolean): IError {\n\t\tconst err: Partial<IError> = {};\n\t\tif (Is.stringValue(this.name)) {\n\t\t\terr.name = this.name;\n\t\t}\n\t\tif (Is.stringValue(this.source)) {\n\t\t\terr.source = this.source;\n\t\t}\n\t\tif (Is.stringValue(this.message)) {\n\t\t\terr.message = this.message;\n\t\t}\n\t\tif (Is.object(this.properties)) {\n\t\t\terr.properties = this.properties;\n\t\t}\n\t\tif ((includeStackTrace ?? false) && Is.stringValue(this.stack)) {\n\t\t\terr.stack = this.stack;\n\t\t}\n\t\tif (Is.notEmpty(this.cause)) {\n\t\t\terr.cause = BaseError.fromError(this.cause).toJsonObject(includeStackTrace);\n\t\t}\n\t\treturn err as IError;\n\t}\n}\n"]}

package/dist/es/errors/conflictError.js

@@ -0,0 +1,23 @@
+import { BaseError } from "./baseError.js";
+/**
+ * Class to handle errors which are triggered by conflicting data.
+ */
+export class ConflictError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "ConflictError";
+    /**
+     * Create a new instance of ConflictError.
+     * @param source The source of the error.
+     * @param message The message as a code.
+     * @param conflictId The id that has conflicts.
+     * @param conflicts The conflicts that occurred.
+     * @param properties Any additional information for the error.
+     * @param cause The cause or the error if we have wrapped another error.
+     */
+    constructor(source, message, conflictId, conflicts, properties, cause) {
+        super(ConflictError.CLASS_NAME, source, message, { conflictId, conflicts, ...properties }, cause);
+    }
+}
+//# sourceMappingURL=conflictError.js.map

package/dist/es/errors/conflictError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conflictError.js","sourceRoot":"","sources":["../../../src/errors/conflictError.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS;IAC3C;;OAEG;IACI,MAAM,CAAU,UAAU,mBAAmC;IAEpE;;;;;;;;OAQG;IACH,YACC,MAAc,EACd,OAAe,EACf,UAAmB,EACnB,SAAoB,EACpB,UAAsC,EACtC,KAAe;QAEf,KAAK,CACJ,aAAa,CAAC,UAAU,EACxB,MAAM,EACN,OAAO,EACP,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,UAAU,EAAE,EACxC,KAAK,CACL,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { nameof } from \"@twin.org/nameof\";\nimport { BaseError } from \"./baseError.js\";\n\n/**\n * Class to handle errors which are triggered by conflicting data.\n */\nexport class ConflictError extends BaseError {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ConflictError>();\n\n\t/**\n\t * Create a new instance of ConflictError.\n\t * @param source The source of the error.\n\t * @param message The message as a code.\n\t * @param conflictId The id that has conflicts.\n\t * @param conflicts The conflicts that occurred.\n\t * @param properties Any additional information for the error.\n\t * @param cause The cause or the error if we have wrapped another error.\n\t */\n\tconstructor(\n\t\tsource: string,\n\t\tmessage: string,\n\t\tconflictId?: string,\n\t\tconflicts?: string[],\n\t\tproperties?: { [id: string]: unknown },\n\t\tcause?: unknown\n\t) {\n\t\tsuper(\n\t\t\tConflictError.CLASS_NAME,\n\t\t\tsource,\n\t\t\tmessage,\n\t\t\t{ conflictId, conflicts, ...properties },\n\t\t\tcause\n\t\t);\n\t}\n}\n"]}

package/dist/es/errors/generalError.js

@@ -0,0 +1,21 @@
+import { BaseError } from "./baseError.js";
+/**
+ * Class to handle errors.
+ */
+export class GeneralError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "GeneralError";
+    /**
+     * Create a new instance of GeneralError.
+     * @param source The source of the error.
+     * @param message The message as a code.
+     * @param properties Any additional information for the error.
+     * @param cause The cause of the error if we have wrapped another error.
+     */
+    constructor(source, message, properties, cause) {
+        super(GeneralError.CLASS_NAME, source, message, properties, cause);
+    }
+}
+//# sourceMappingURL=generalError.js.map

package/dist/es/errors/generalError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generalError.js","sourceRoot":"","sources":["../../../src/errors/generalError.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,SAAS;IAC1C;;OAEG;IACI,MAAM,CAAU,UAAU,kBAAkC;IAEnE;;;;;;OAMG;IACH,YACC,MAAc,EACd,OAAe,EACf,UAAsC,EACtC,KAAe;QAEf,KAAK,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IACpE,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { nameof } from \"@twin.org/nameof\";\nimport { BaseError } from \"./baseError.js\";\n\n/**\n * Class to handle errors.\n */\nexport class GeneralError extends BaseError {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<GeneralError>();\n\n\t/**\n\t * Create a new instance of GeneralError.\n\t * @param source The source of the error.\n\t * @param message The message as a code.\n\t * @param properties Any additional information for the error.\n\t * @param cause The cause of the error if we have wrapped another error.\n\t */\n\tconstructor(\n\t\tsource: string,\n\t\tmessage: string,\n\t\tproperties?: { [id: string]: unknown },\n\t\tcause?: unknown\n\t) {\n\t\tsuper(GeneralError.CLASS_NAME, source, message, properties, cause);\n\t}\n}\n"]}

package/dist/es/errors/guardError.js

@@ -0,0 +1,27 @@
+import { BaseError } from "./baseError.js";
+import { Is } from "../utils/is.js";
+/**
+ * Class to handle errors which are triggered by data guards.
+ */
+export class GuardError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "GuardError";
+    /**
+     * Create a new instance of GuardError.
+     * @param source The source of the error.
+     * @param message The message as a code.
+     * @param propertyName The property which triggered the guard error for the item.
+     * @param propertyValue The property value which triggered the guard error for the item.
+     * @param propertyOptions The property options which might be allowed.
+     */
+    constructor(source, message, propertyName, propertyValue, propertyOptions) {
+        super(GuardError.CLASS_NAME, source, message, {
+            property: propertyName ?? "property",
+            value: Is.undefined(propertyValue) ? "undefined" : propertyValue,
+            options: propertyOptions
+        });
+    }
+}
+//# sourceMappingURL=guardError.js.map

package/dist/es/errors/guardError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guardError.js","sourceRoot":"","sources":["../../../src/errors/guardError.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAEpC;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,SAAS;IACxC;;OAEG;IACI,MAAM,CAAU,UAAU,gBAAgC;IAEjE;;;;;;;OAOG;IACH,YACC,MAAc,EACd,OAAe,EACf,YAAoB,EACpB,aAAsB,EACtB,eAAwB;QAExB,KAAK,CAAC,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE;YAC7C,QAAQ,EAAE,YAAY,IAAI,UAAU;YACpC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa;YAChE,OAAO,EAAE,eAAe;SACxB,CAAC,CAAC;IACJ,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { nameof } from \"@twin.org/nameof\";\nimport { BaseError } from \"./baseError.js\";\nimport { Is } from \"../utils/is.js\";\n\n/**\n * Class to handle errors which are triggered by data guards.\n */\nexport class GuardError extends BaseError {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<GuardError>();\n\n\t/**\n\t * Create a new instance of GuardError.\n\t * @param source The source of the error.\n\t * @param message The message as a code.\n\t * @param propertyName The property which triggered the guard error for the item.\n\t * @param propertyValue The property value which triggered the guard error for the item.\n\t * @param propertyOptions The property options which might be allowed.\n\t */\n\tconstructor(\n\t\tsource: string,\n\t\tmessage: string,\n\t\tpropertyName: string,\n\t\tpropertyValue: unknown,\n\t\tpropertyOptions?: string\n\t) {\n\t\tsuper(GuardError.CLASS_NAME, source, message, {\n\t\t\tproperty: propertyName ?? \"property\",\n\t\t\tvalue: Is.undefined(propertyValue) ? \"undefined\" : propertyValue,\n\t\t\toptions: propertyOptions\n\t\t});\n\t}\n}\n"]}

package/dist/es/errors/notFoundError.js

@@ -0,0 +1,22 @@
+import { BaseError } from "./baseError.js";
+/**
+ * Class to handle errors which are triggered by data not being found.
+ */
+export class NotFoundError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "NotFoundError";
+    /**
+     * Create a new instance of NotFoundError.
+     * @param source The source of the error.
+     * @param message The message as a code.
+     * @param notFoundId The id for the item.
+     * @param properties Any additional information for the error.
+     * @param cause The cause of the error if we have wrapped another error.
+     */
+    constructor(source, message, notFoundId, properties, cause) {
+        super(NotFoundError.CLASS_NAME, source, message, { notFoundId, ...properties }, cause);
+    }
+}
+//# sourceMappingURL=notFoundError.js.map

package/dist/es/errors/notFoundError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notFoundError.js","sourceRoot":"","sources":["../../../src/errors/notFoundError.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS;IAC3C;;OAEG;IACI,MAAM,CAAU,UAAU,mBAAmC;IAEpE;;;;;;;OAOG;IACH,YACC,MAAc,EACd,OAAe,EACf,UAAmB,EACnB,UAAsC,EACtC,KAAe;QAEf,KAAK,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,EAAE,KAAK,CAAC,CAAC;IACxF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { nameof } from \"@twin.org/nameof\";\nimport { BaseError } from \"./baseError.js\";\n\n/**\n * Class to handle errors which are triggered by data not being found.\n */\nexport class NotFoundError extends BaseError {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<NotFoundError>();\n\n\t/**\n\t * Create a new instance of NotFoundError.\n\t * @param source The source of the error.\n\t * @param message The message as a code.\n\t * @param notFoundId The id for the item.\n\t * @param properties Any additional information for the error.\n\t * @param cause The cause of the error if we have wrapped another error.\n\t */\n\tconstructor(\n\t\tsource: string,\n\t\tmessage: string,\n\t\tnotFoundId?: string,\n\t\tproperties?: { [id: string]: unknown },\n\t\tcause?: unknown\n\t) {\n\t\tsuper(NotFoundError.CLASS_NAME, source, message, { notFoundId, ...properties }, cause);\n\t}\n}\n"]}

package/dist/es/errors/notImplementedError.js

@@ -0,0 +1,24 @@
+import { BaseError } from "./baseError.js";
+/**
+ * Class to handle errors.
+ */
+export class NotImplementedError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "NotImplementedError";
+    /**
+     * Create a new instance of NotImplementedError.
+     * @param source The source of the error.
+     * @param method The method for the error.
+     * @param properties Any additional information for the error.
+     * @param cause The cause of the error if we have wrapped another error.
+     */
+    constructor(source, method, properties, cause) {
+        super(NotImplementedError.CLASS_NAME, source, "common.notImplementedMethod", {
+            method,
+            ...properties
+        }, cause);
+    }
+}
+//# sourceMappingURL=notImplementedError.js.map

package/dist/es/errors/notImplementedError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notImplementedError.js","sourceRoot":"","sources":["../../../src/errors/notImplementedError.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,SAAS;IACjD;;OAEG;IACI,MAAM,CAAU,UAAU,yBAAyC;IAE1E;;;;;;OAMG;IACH,YACC,MAAc,EACd,MAAc,EACd,UAAsC,EACtC,KAAe;QAEf,KAAK,CACJ,mBAAmB,CAAC,UAAU,EAC9B,MAAM,EACN,6BAA6B,EAC7B;YACC,MAAM;YACN,GAAG,UAAU;SACb,EACD,KAAK,CACL,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { nameof } from \"@twin.org/nameof\";\nimport { BaseError } from \"./baseError.js\";\n\n/**\n * Class to handle errors.\n */\nexport class NotImplementedError extends BaseError {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<NotImplementedError>();\n\n\t/**\n\t * Create a new instance of NotImplementedError.\n\t * @param source The source of the error.\n\t * @param method The method for the error.\n\t * @param properties Any additional information for the error.\n\t * @param cause The cause of the error if we have wrapped another error.\n\t */\n\tconstructor(\n\t\tsource: string,\n\t\tmethod: string,\n\t\tproperties?: { [id: string]: unknown },\n\t\tcause?: unknown\n\t) {\n\t\tsuper(\n\t\t\tNotImplementedError.CLASS_NAME,\n\t\t\tsource,\n\t\t\t\"common.notImplementedMethod\",\n\t\t\t{\n\t\t\t\tmethod,\n\t\t\t\t...properties\n\t\t\t},\n\t\t\tcause\n\t\t);\n\t}\n}\n"]}

package/dist/es/errors/notSupportedError.js

@@ -0,0 +1,21 @@
+import { BaseError } from "./baseError.js";
+/**
+ * Class to handle errors when a feature is unsupported.
+ */
+export class NotSupportedError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "NotSupportedError";
+    /**
+     * Create a new instance of NotSupportedError.
+     * @param source The source of the error.
+     * @param message The message as a code.
+     * @param properties Any additional information for the error.
+     * @param cause The cause of the error if we have wrapped another error.
+     */
+    constructor(source, message, properties, cause) {
+        super(NotSupportedError.CLASS_NAME, source, message, properties, cause);
+    }
+}
+//# sourceMappingURL=notSupportedError.js.map

package/dist/es/errors/notSupportedError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notSupportedError.js","sourceRoot":"","sources":["../../../src/errors/notSupportedError.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,SAAS;IAC/C;;OAEG;IACI,MAAM,CAAU,UAAU,uBAAuC;IAExE;;;;;;OAMG;IACH,YACC,MAAc,EACd,OAAe,EACf,UAAsC,EACtC,KAAe;QAEf,KAAK,CAAC,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IACzE,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { nameof } from \"@twin.org/nameof\";\nimport { BaseError } from \"./baseError.js\";\n\n/**\n * Class to handle errors when a feature is unsupported.\n */\nexport class NotSupportedError extends BaseError {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<NotSupportedError>();\n\n\t/**\n\t * Create a new instance of NotSupportedError.\n\t * @param source The source of the error.\n\t * @param message The message as a code.\n\t * @param properties Any additional information for the error.\n\t * @param cause The cause of the error if we have wrapped another error.\n\t */\n\tconstructor(\n\t\tsource: string,\n\t\tmessage: string,\n\t\tproperties?: { [id: string]: unknown },\n\t\tcause?: unknown\n\t) {\n\t\tsuper(NotSupportedError.CLASS_NAME, source, message, properties, cause);\n\t}\n}\n"]}

package/dist/es/errors/unauthorizedError.js

@@ -0,0 +1,21 @@
+import { BaseError } from "./baseError.js";
+/**
+ * Class to handle errors which are triggered by access not being unauthorized.
+ */
+export class UnauthorizedError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "UnauthorizedError";
+    /**
+     * Create a new instance of UnauthorizedError.
+     * @param source The source of the error.
+     * @param message The message as a code.
+     * @param properties Any additional information for the error.
+     * @param cause The cause of the error if we have wrapped another error.
+     */
+    constructor(source, message, properties, cause) {
+        super(UnauthorizedError.CLASS_NAME, source, message, properties, cause);
+    }
+}
+//# sourceMappingURL=unauthorizedError.js.map

package/dist/es/errors/unauthorizedError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unauthorizedError.js","sourceRoot":"","sources":["../../../src/errors/unauthorizedError.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,SAAS;IAC/C;;OAEG;IACI,MAAM,CAAU,UAAU,uBAAuC;IAExE;;;;;;OAMG;IACH,YACC,MAAc,EACd,OAAe,EACf,UAAsC,EACtC,KAAe;QAEf,KAAK,CAAC,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IACzE,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { nameof } from \"@twin.org/nameof\";\nimport { BaseError } from \"./baseError.js\";\n\n/**\n * Class to handle errors which are triggered by access not being unauthorized.\n */\nexport class UnauthorizedError extends BaseError {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<UnauthorizedError>();\n\n\t/**\n\t * Create a new instance of UnauthorizedError.\n\t * @param source The source of the error.\n\t * @param message The message as a code.\n\t * @param properties Any additional information for the error.\n\t * @param cause The cause of the error if we have wrapped another error.\n\t */\n\tconstructor(\n\t\tsource: string,\n\t\tmessage: string,\n\t\tproperties?: { [id: string]: unknown },\n\t\tcause?: unknown\n\t) {\n\t\tsuper(UnauthorizedError.CLASS_NAME, source, message, properties, cause);\n\t}\n}\n"]}

package/dist/es/errors/unprocessableError.js

@@ -0,0 +1,21 @@
+import { BaseError } from "./baseError.js";
+/**
+ * Class to handle errors when some data can not be processed.
+ */
+export class UnprocessableError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "UnprocessableError";
+    /**
+     * Create a new instance of UnprocessableError.
+     * @param source The source of the error.
+     * @param message The message as a code.
+     * @param properties Any additional information for the error.
+     * @param cause The cause of the error if we have wrapped another error.
+     */
+    constructor(source, message, properties, cause) {
+        super(UnprocessableError.CLASS_NAME, source, message, properties, cause);
+    }
+}
+//# sourceMappingURL=unprocessableError.js.map

package/dist/es/errors/unprocessableError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unprocessableError.js","sourceRoot":"","sources":["../../../src/errors/unprocessableError.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,SAAS;IAChD;;OAEG;IACI,MAAM,CAAU,UAAU,wBAAwC;IAEzE;;;;;;OAMG;IACH,YACC,MAAc,EACd,OAAe,EACf,UAAsC,EACtC,KAAe;QAEf,KAAK,CAAC,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IAC1E,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { nameof } from \"@twin.org/nameof\";\nimport { BaseError } from \"./baseError.js\";\n\n/**\n * Class to handle errors when some data can not be processed.\n */\nexport class UnprocessableError extends BaseError {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<UnprocessableError>();\n\n\t/**\n\t * Create a new instance of UnprocessableError.\n\t * @param source The source of the error.\n\t * @param message The message as a code.\n\t * @param properties Any additional information for the error.\n\t * @param cause The cause of the error if we have wrapped another error.\n\t */\n\tconstructor(\n\t\tsource: string,\n\t\tmessage: string,\n\t\tproperties?: { [id: string]: unknown },\n\t\tcause?: unknown\n\t) {\n\t\tsuper(UnprocessableError.CLASS_NAME, source, message, properties, cause);\n\t}\n}\n"]}

package/dist/es/errors/validationError.js

@@ -0,0 +1,23 @@
+import { BaseError } from "./baseError.js";
+/**
+ * Class to handle errors which are triggered by entity validation.
+ */
+export class ValidationError extends BaseError {
+    /**
+     * Runtime name for the class.s
+     */
+    static CLASS_NAME = "ValidationError";
+    /**
+     * Create a new instance of ValidationError.
+     * @param source The source of the error.
+     * @param validationObject The object that failed validation.
+     * @param validationFailures The validation failures.
+     */
+    constructor(source, validationObject, validationFailures) {
+        super(ValidationError.CLASS_NAME, source, "common.validation", {
+            validationObject,
+            validationFailures
+        });
+    }
+}
+//# sourceMappingURL=validationError.js.map

package/dist/es/errors/validationError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validationError.js","sourceRoot":"","sources":["../../../src/errors/validationError.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAG3C;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAC7C;;OAEG;IACI,MAAM,CAAU,UAAU,qBAAqC;IAEtE;;;;;OAKG;IACH,YAAY,MAAc,EAAE,gBAAwB,EAAE,kBAAwC;QAC7F,KAAK,CAAC,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,mBAAmB,EAAE;YAC9D,gBAAgB;YAChB,kBAAkB;SAClB,CAAC,CAAC;IACJ,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { nameof } from \"@twin.org/nameof\";\nimport { BaseError } from \"./baseError.js\";\nimport type { IValidationFailure } from \"../models/IValidationFailure.js\";\n\n/**\n * Class to handle errors which are triggered by entity validation.\n */\nexport class ValidationError extends BaseError {\n\t/**\n\t * Runtime name for the class.s\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ValidationError>();\n\n\t/**\n\t * Create a new instance of ValidationError.\n\t * @param source The source of the error.\n\t * @param validationObject The object that failed validation.\n\t * @param validationFailures The validation failures.\n\t */\n\tconstructor(source: string, validationObject: string, validationFailures: IValidationFailure[]) {\n\t\tsuper(ValidationError.CLASS_NAME, source, \"common.validation\", {\n\t\t\tvalidationObject,\n\t\t\tvalidationFailures\n\t\t});\n\t}\n}\n"]}

package/dist/es/factories/componentFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "./factory.js";
+/**
+ * Factory for creating implementation of component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const ComponentFactory = Factory.createFactory("component");
+//# sourceMappingURL=componentFactory.js.map

package/dist/es/factories/componentFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"componentFactory.js","sourceRoot":"","sources":["../../../src/factories/componentFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAa,WAAW,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"./factory.js\";\nimport type { IComponent } from \"../models/IComponent.js\";\n\n/**\n * Factory for creating implementation of component types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ComponentFactory = Factory.createFactory<IComponent>(\"component\");\n"]}