npm - @twin.org/core - Versions diffs - 0.0.3-next.32 → 0.0.3-next.34 - Mend

@twin.org/core 0.0.3-next.32 → 0.0.3-next.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (58) hide show

package/dist/es/errors/alreadyExistsError.js +1 -1
package/dist/es/errors/alreadyExistsError.js.map +1 -1
package/dist/es/errors/baseError.js +1 -1
package/dist/es/errors/baseError.js.map +1 -1
package/dist/es/errors/conflictError.js +1 -1
package/dist/es/errors/conflictError.js.map +1 -1
package/dist/es/errors/generalError.js +1 -1
package/dist/es/errors/generalError.js.map +1 -1
package/dist/es/errors/guardError.js +1 -1
package/dist/es/errors/guardError.js.map +1 -1
package/dist/es/errors/notFoundError.js +1 -1
package/dist/es/errors/notFoundError.js.map +1 -1
package/dist/es/errors/notSupportedError.js +1 -1
package/dist/es/errors/notSupportedError.js.map +1 -1
package/dist/es/errors/unauthorizedError.js +2 -2
package/dist/es/errors/unauthorizedError.js.map +1 -1
package/dist/es/errors/unprocessableError.js +1 -1
package/dist/es/errors/unprocessableError.js.map +1 -1
package/dist/es/index.js +2 -0
package/dist/es/index.js.map +1 -1
package/dist/es/models/IComponent.js +0 -2
package/dist/es/models/IComponent.js.map +1 -1
package/dist/es/models/IError.js.map +1 -1
package/dist/es/models/IHealth.js +2 -0
package/dist/es/models/IHealth.js.map +1 -0
package/dist/es/models/healthStatus.js +21 -0
package/dist/es/models/healthStatus.js.map +1 -0
package/dist/types/errors/alreadyExistsError.d.ts +1 -1
package/dist/types/errors/baseError.d.ts +1 -1
package/dist/types/errors/conflictError.d.ts +1 -1
package/dist/types/errors/generalError.d.ts +1 -1
package/dist/types/errors/guardError.d.ts +1 -1
package/dist/types/errors/notFoundError.d.ts +1 -1
package/dist/types/errors/notSupportedError.d.ts +1 -1
package/dist/types/errors/unauthorizedError.d.ts +2 -2
package/dist/types/errors/unprocessableError.d.ts +1 -1
package/dist/types/index.d.ts +2 -0
package/dist/types/models/IComponent.d.ts +6 -0
package/dist/types/models/IError.d.ts +1 -1
package/dist/types/models/IHealth.d.ts +32 -0
package/dist/types/models/healthStatus.d.ts +21 -0
package/docs/changelog.md +39 -0
package/docs/reference/classes/AlreadyExistsError.md +1 -1
package/docs/reference/classes/BaseError.md +1 -1
package/docs/reference/classes/ConflictError.md +1 -1
package/docs/reference/classes/GeneralError.md +1 -1
package/docs/reference/classes/GuardError.md +1 -1
package/docs/reference/classes/NotFoundError.md +1 -1
package/docs/reference/classes/NotSupportedError.md +1 -1
package/docs/reference/classes/UnauthorizedError.md +2 -2
package/docs/reference/classes/UnprocessableError.md +1 -1
package/docs/reference/index.md +3 -0
package/docs/reference/interfaces/IComponent.md +14 -0
package/docs/reference/interfaces/IError.md +1 -1
package/docs/reference/interfaces/IHealth.md +55 -0
package/docs/reference/type-aliases/HealthStatus.md +5 -0
package/docs/reference/variables/HealthStatus.md +25 -0
package/package.json +2 -2

package/dist/es/errors/alreadyExistsError.js CHANGED Viewed

@@ -10,7 +10,7 @@ export class AlreadyExistsError extends BaseError {
     /**
      * Create a new instance of AlreadyExistsError.
      * @param source The source of the error.
-     * @param message The message as a code.
+     * @param message The message as an i18n key.
      * @param existingId 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.

package/dist/es/errors/alreadyExistsError.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"alreadyExistsError.js","sourceRoot":"","sources":["../../../src/errors/alreadyExistsError.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;;;;;;;OAOG;IACH,YACC,MAAc,EACd,OAAe,EACf,UAAmB,EACnB,UAAsC,EACtC,KAAe;QAEf,KAAK,CAAC,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,EAAE,KAAK,CAAC,CAAC;IAC7F,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 already existing.\n /\nexport class AlreadyExistsError extends BaseError {\n\t/\n\t Runtime name for the class.\n\t /\n\tpublic static readonly CLASS_NAME: string = nameof<AlreadyExistsError>();\n\n\t/\n\t Create a new instance of AlreadyExistsError.\n\t * @param source The source of the error.\n\t * @param message The message as a ~~code~~.\n\t * @param existingId 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\texistingId?: string,\n\t\tproperties?: { [id: string]: unknown },\n\t\tcause?: unknown\n\t) {\n\t\tsuper(AlreadyExistsError.CLASS_NAME, source, message, { existingId, ...properties }, cause);\n\t}\n}\n"]}
1	+ {"version":3,"file":"alreadyExistsError.js","sourceRoot":"","sources":["../../../src/errors/alreadyExistsError.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;;;;;;;OAOG;IACH,YACC,MAAc,EACd,OAAe,EACf,UAAmB,EACnB,UAAsC,EACtC,KAAe;QAEf,KAAK,CAAC,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,EAAE,KAAK,CAAC,CAAC;IAC7F,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 already existing.\n /\nexport class AlreadyExistsError extends BaseError {\n\t/\n\t Runtime name for the class.\n\t /\n\tpublic static readonly CLASS_NAME: string = nameof<AlreadyExistsError>();\n\n\t/\n\t Create a new instance of AlreadyExistsError.\n\t * @param source The source of the error.\n\t * @param message The message as an i18n key.\n\t * @param existingId 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\texistingId?: string,\n\t\tproperties?: { [id: string]: unknown },\n\t\tcause?: unknown\n\t) {\n\t\tsuper(AlreadyExistsError.CLASS_NAME, source, message, { existingId, ...properties }, cause);\n\t}\n}\n"]}

package/dist/es/errors/baseError.js CHANGED Viewed

@@ -22,7 +22,7 @@ export class BaseError extends Error {
      * 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 message The message as an i18n key.
      * @param properties Any additional information for the error.
      * @param cause The cause of error if we have wrapped another error.
      */

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

	@@ -1 +1 @@
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"]}
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 an i18n key.\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 CHANGED Viewed

@@ -10,7 +10,7 @@ export class ConflictError extends BaseError {
     /**
      * Create a new instance of ConflictError.
      * @param source The source of the error.
-     * @param message The message as a code.
+     * @param message The message as an i18n key.
      * @param conflictId The id that has conflicts.
      * @param conflicts The conflicts that occurred.
      * @param properties Any additional information for the error.

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

	@@ -1 +1 @@
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"]}
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 an i18n key.\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 CHANGED Viewed

@@ -10,7 +10,7 @@ export class GeneralError extends BaseError {
     /**
      * Create a new instance of GeneralError.
      * @param source The source of the error.
-     * @param message The message as a code.
+     * @param message The message as an i18n key.
      * @param properties Any additional information for the error.
      * @param cause The cause of the error if we have wrapped another error.
      */

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

	@@ -1 +1 @@
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"]}
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 an i18n key.\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 CHANGED Viewed

@@ -11,7 +11,7 @@ export class GuardError extends BaseError {
     /**
      * Create a new instance of GuardError.
      * @param source The source of the error.
-     * @param message The message as a code.
+     * @param message The message as an i18n key.
      * @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.

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

	@@ -1 +1 @@
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"]}
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 an i18n key.\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 CHANGED Viewed

@@ -10,7 +10,7 @@ export class NotFoundError extends BaseError {
     /**
      * Create a new instance of NotFoundError.
      * @param source The source of the error.
-     * @param message The message as a code.
+     * @param message The message as an i18n key.
      * @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.

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

	@@ -1 +1 @@
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"]}
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 an i18n key.\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/notSupportedError.js CHANGED Viewed

@@ -10,7 +10,7 @@ export 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 message The message as an i18n key.
      * @param properties Any additional information for the error.
      * @param cause The cause of the error if we have wrapped another error.
      */

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

	@@ -1 +1 @@
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"]}
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 an i18n key.\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 CHANGED Viewed

@@ -1,6 +1,6 @@
 import { BaseError } from "./baseError.js";
 /**
- * Class to handle errors which are triggered by access not being unauthorized.
+ * Class to handle errors which are triggered by access not being authorized.
  */
 export class UnauthorizedError extends BaseError {
     /**
@@ -10,7 +10,7 @@ export 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 message The message as an i18n key.
      * @param properties Any additional information for the error.
      * @param cause The cause of the error if we have wrapped another error.
      */

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

	@@ -1 +1 @@
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"]}
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 authorized.\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 an i18n key.\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 CHANGED Viewed

@@ -10,7 +10,7 @@ export class UnprocessableError extends BaseError {
     /**
      * Create a new instance of UnprocessableError.
      * @param source The source of the error.
-     * @param message The message as a code.
+     * @param message The message as an i18n key.
      * @param properties Any additional information for the error.
      * @param cause The cause of the error if we have wrapped another error.
      */

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

	@@ -1 +1 @@
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"]}
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 an i18n key.\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/index.js CHANGED Viewed

@@ -30,8 +30,10 @@ export * from "./helpers/stringHelper.js";
 export * from "./helpers/uint8ArrayHelper.js";
 export * from "./models/coerceType.js";
 export * from "./models/compressionType.js";
+export * from "./models/healthStatus.js";
 export * from "./models/IComponent.js";
 export * from "./models/IError.js";
+export * from "./models/IHealth.js";
 export * from "./models/II18nShared.js";
 export * from "./models/IKeyValue.js";
 export * from "./models/ILabelledValue.js";

package/dist/es/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./encoding/base32.js\";\nexport * from \"./encoding/base58.js\";\nexport * from \"./encoding/base64.js\";\nexport * from \"./encoding/base64Url.js\";\nexport * from \"./errors/alreadyExistsError.js\";\nexport * from \"./errors/baseError.js\";\nexport * from \"./errors/conflictError.js\";\nexport * from \"./errors/generalError.js\";\nexport * from \"./errors/guardError.js\";\nexport * from \"./errors/notFoundError.js\";\nexport * from \"./errors/notImplementedError.js\";\nexport * from \"./errors/notSupportedError.js\";\nexport * from \"./errors/unauthorizedError.js\";\nexport * from \"./errors/unprocessableError.js\";\nexport * from \"./errors/validationError.js\";\nexport * from \"./factories/componentFactory.js\";\nexport * from \"./factories/factory.js\";\nexport * from \"./helpers/arrayHelper.js\";\nexport * from \"./helpers/envHelper.js\";\nexport * from \"./helpers/errorHelper.js\";\nexport * from \"./helpers/filenameHelper.js\";\nexport * from \"./helpers/hexHelper.js\";\nexport * from \"./helpers/jsonHelper.js\";\nexport * from \"./helpers/numberHelper.js\";\nexport * from \"./helpers/objectHelper.js\";\nexport * from \"./helpers/randomHelper.js\";\nexport * from \"./helpers/stringHelper.js\";\nexport * from \"./helpers/uint8ArrayHelper.js\";\nexport * from \"./models/coerceType.js\";\nexport * from \"./models/compressionType.js\";\nexport * from \"./models/IComponent.js\";\nexport * from \"./models/IError.js\";\nexport * from \"./models/II18nShared.js\";\nexport * from \"./models/IKeyValue.js\";\nexport * from \"./models/ILabelledValue.js\";\nexport * from \"./models/ILocale.js\";\nexport * from \"./models/ILocaleDictionary.js\";\nexport * from \"./models/ILocalesIndex.js\";\nexport * from \"./models/IPatchOperation.js\";\nexport * from \"./models/IUrlParts.js\";\nexport * from \"./models/IValidationFailure.js\";\nexport * from \"./types/bitString.js\";\nexport * from \"./types/objectOrArray.js\";\nexport * from \"./types/singleOccurrenceArray.js\";\nexport * from \"./types/url.js\";\nexport * from \"./types/urn.js\";\nexport * from \"./utils/asyncCache.js\";\nexport * from \"./utils/coerce.js\";\nexport * from \"./utils/compression.js\";\nexport * from \"./utils/converter.js\";\nexport * from \"./utils/guards.js\";\nexport * from \"./utils/i18n.js\";\nexport * from \"./utils/is.js\";\nexport * from \"./utils/sharedStore.js\";\nexport * from \"./utils/validation.js\";\n"]}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./encoding/base32.js\";\nexport * from \"./encoding/base58.js\";\nexport * from \"./encoding/base64.js\";\nexport * from \"./encoding/base64Url.js\";\nexport * from \"./errors/alreadyExistsError.js\";\nexport * from \"./errors/baseError.js\";\nexport * from \"./errors/conflictError.js\";\nexport * from \"./errors/generalError.js\";\nexport * from \"./errors/guardError.js\";\nexport * from \"./errors/notFoundError.js\";\nexport * from \"./errors/notImplementedError.js\";\nexport * from \"./errors/notSupportedError.js\";\nexport * from \"./errors/unauthorizedError.js\";\nexport * from \"./errors/unprocessableError.js\";\nexport * from \"./errors/validationError.js\";\nexport * from \"./factories/componentFactory.js\";\nexport * from \"./factories/factory.js\";\nexport * from \"./helpers/arrayHelper.js\";\nexport * from \"./helpers/envHelper.js\";\nexport * from \"./helpers/errorHelper.js\";\nexport * from \"./helpers/filenameHelper.js\";\nexport * from \"./helpers/hexHelper.js\";\nexport * from \"./helpers/jsonHelper.js\";\nexport * from \"./helpers/numberHelper.js\";\nexport * from \"./helpers/objectHelper.js\";\nexport * from \"./helpers/randomHelper.js\";\nexport * from \"./helpers/stringHelper.js\";\nexport * from \"./helpers/uint8ArrayHelper.js\";\nexport * from \"./models/coerceType.js\";\nexport * from \"./models/compressionType.js\";\nexport * from \"./models/healthStatus.js\";\nexport * from \"./models/IComponent.js\";\nexport * from \"./models/IError.js\";\nexport * from \"./models/IHealth.js\";\nexport * from \"./models/II18nShared.js\";\nexport * from \"./models/IKeyValue.js\";\nexport * from \"./models/ILabelledValue.js\";\nexport * from \"./models/ILocale.js\";\nexport * from \"./models/ILocaleDictionary.js\";\nexport * from \"./models/ILocalesIndex.js\";\nexport * from \"./models/IPatchOperation.js\";\nexport * from \"./models/IUrlParts.js\";\nexport * from \"./models/IValidationFailure.js\";\nexport * from \"./types/bitString.js\";\nexport * from \"./types/objectOrArray.js\";\nexport * from \"./types/singleOccurrenceArray.js\";\nexport * from \"./types/url.js\";\nexport * from \"./types/urn.js\";\nexport * from \"./utils/asyncCache.js\";\nexport * from \"./utils/coerce.js\";\nexport * from \"./utils/compression.js\";\nexport * from \"./utils/converter.js\";\nexport * from \"./utils/guards.js\";\nexport * from \"./utils/i18n.js\";\nexport * from \"./utils/is.js\";\nexport * from \"./utils/sharedStore.js\";\nexport * from \"./utils/validation.js\";\n"]}

package/dist/es/models/IComponent.js CHANGED Viewed

@@ -1,4 +1,2 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
 export {};
 //# sourceMappingURL=IComponent.js.map

package/dist/es/models/IComponent.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"IComponent.js","sourceRoot":"","sources":["../../../src/models/IComponent.ts"],"names":[],"mappings":"~~AAAA,gCAAgC;AAChC,uCAAuC~~","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/*\n Interface describing a component which can be bootstrapped, started and stopped.\n /\nexport interface IComponent {\n\t/\n\t Returns the class name of the component.\n\t * @returns The class name of the component.\n\t /\n\tclassName(): string;\n\n\t/\n\t Bootstrap the component by creating and initializing any resources it needs.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns True if the bootstrapping process was successful.\n\t /\n\tbootstrap?(nodeLoggingComponentType?: string): Promise<boolean>;\n\n\t/\n\t The component needs to be started when the node is initialized.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns Nothing.\n\t /\n\tstart?(nodeLoggingComponentType?: string): Promise<void>;\n\n\t/\n\t The component needs to be stopped when the node is closed.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns Nothing.\n\t */\n\tstop?(nodeLoggingComponentType?: string): Promise<void>;\n}\n"]}
1	+ {"version":3,"file":"IComponent.js","sourceRoot":"","sources":["../../../src/models/IComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHealth } from \"./IHealth.js\";\n\n/*\n Interface describing a component which can be bootstrapped, started and stopped.\n /\nexport interface IComponent {\n\t/\n\t Returns the class name of the component.\n\t * @returns The class name of the component.\n\t /\n\tclassName(): string;\n\n\t/\n\t Bootstrap the component by creating and initializing any resources it needs.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns True if the bootstrapping process was successful.\n\t /\n\tbootstrap?(nodeLoggingComponentType?: string): Promise<boolean>;\n\n\t/\n\t The component needs to be started when the node is initialized.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns Nothing.\n\t /\n\tstart?(nodeLoggingComponentType?: string): Promise<void>;\n\n\t/\n\t The component needs to be stopped when the node is closed.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns Nothing.\n\t /\n\tstop?(nodeLoggingComponentType?: string): Promise<void>;\n\n\t/\n\t Returns the health status of the component.\n\t * @returns The health status of the component, can return multiple entries for elements within the component.\n\t */\n\thealth?(): Promise<IHealth[]>;\n}\n"]}

package/dist/es/models/IError.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"IError.js","sourceRoot":"","sources":["../../../src/models/IError.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/*\n Model to describe serialized error.\n /\nexport interface IError {\n\t/\n\t The name for the error.\n\t /\n\tname: string;\n\n\t/\n\t The message for the error.\n\t /\n\tmessage: string;\n\n\t/\n\t The source of the error.\n\t /\n\tsource?: string;\n\n\t/\n\t Any additional information for the error.\n\t /\n\tproperties?: { [id: string]: unknown };\n\n\t/\n\t The stack trace for the error.\n\t /\n\tstack?: string;\n\n\t/\n\t The cause of the error if there was one.\n\t */\n\tcause?: IError;\n}\n"]}
1	+ {"version":3,"file":"IError.js","sourceRoot":"","sources":["../../../src/models/IError.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/*\n Model to describe serialized error.\n /\nexport interface IError {\n\t/\n\t The name for the error.\n\t /\n\tname: string;\n\n\t/\n\t The message for the error as an i18n key.\n\t /\n\tmessage: string;\n\n\t/\n\t The source of the error.\n\t /\n\tsource?: string;\n\n\t/\n\t Any additional information for the error.\n\t /\n\tproperties?: { [id: string]: unknown };\n\n\t/\n\t The stack trace for the error.\n\t /\n\tstack?: string;\n\n\t/\n\t The cause of the error if there was one.\n\t */\n\tcause?: IError;\n}\n"]}

package/dist/es/models/IHealth.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export {};
2	+ //# sourceMappingURL=IHealth.js.map

package/dist/es/models/IHealth.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"IHealth.js","sourceRoot":"","sources":["../../../src/models/IHealth.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HealthStatus } from \"./healthStatus.js\";\n\n/**\n * Provides health information for a component.\n */\nexport interface IHealth {\n\t/**\n\t * The name of the component.\n\t */\n\tname: string;\n\n\t/**\n\t * The description of the component as an i18n key.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * The overall status of the component, the entries can also report their own health.\n\t */\n\tstatus: HealthStatus;\n\n\t/**\n\t * The details for the status if there are further details to provide as an i18n key.\n\t */\n\tdetails?: string;\n\n\t/**\n\t * Properties to substitute in the i18n key for the details.\n\t */\n\tproperties?: { [id: string]: unknown };\n\n\t/**\n\t * The grouped child components, if any.\n\t */\n\tgrouped?: IHealth[];\n}\n"]}

package/dist/es/models/healthStatus.js ADDED Viewed

@@ -0,0 +1,21 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The health status of the component.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const HealthStatus = {
+    /**
+     * OK.
+     */
+    Ok: "ok",
+    /**
+     * Warning.
+     */
+    Warning: "warning",
+    /**
+     * Error.
+     */
+    Error: "error"
+};
+//# sourceMappingURL=healthStatus.js.map

package/dist/es/models/healthStatus.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"healthStatus.js","sourceRoot":"","sources":["../../../src/models/healthStatus.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B;;OAEG;IACH,EAAE,EAAE,IAAI;IAER;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,KAAK,EAAE,OAAO;CACL,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The health status of the component.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const HealthStatus = {\n\t/**\n\t * OK.\n\t */\n\tOk: \"ok\",\n\n\t/**\n\t * Warning.\n\t */\n\tWarning: \"warning\",\n\n\t/**\n\t * Error.\n\t */\n\tError: \"error\"\n} as const;\n\n/**\n * The health status of the component.\n */\nexport type HealthStatus = (typeof HealthStatus)[keyof typeof HealthStatus];\n"]}

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

@@ -10,7 +10,7 @@ export declare class AlreadyExistsError extends BaseError {
     /**
      * Create a new instance of AlreadyExistsError.
      * @param source The source of the error.
-     * @param message The message as a code.
+     * @param message The message as an i18n key.
      * @param existingId 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.

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

@@ -21,7 +21,7 @@ export declare class BaseError extends Error implements 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 message The message as an i18n key.
      * @param properties Any additional information for the error.
      * @param cause The cause of error if we have wrapped another error.
      */

package/dist/types/errors/conflictError.d.ts CHANGED Viewed

@@ -10,7 +10,7 @@ export declare class ConflictError extends BaseError {
     /**
      * Create a new instance of ConflictError.
      * @param source The source of the error.
-     * @param message The message as a code.
+     * @param message The message as an i18n key.
      * @param conflictId The id that has conflicts.
      * @param conflicts The conflicts that occurred.
      * @param properties Any additional information for the error.

package/dist/types/errors/generalError.d.ts CHANGED Viewed

@@ -10,7 +10,7 @@ export declare class GeneralError extends BaseError {
     /**
      * Create a new instance of GeneralError.
      * @param source The source of the error.
-     * @param message The message as a code.
+     * @param message The message as an i18n key.
      * @param properties Any additional information for the error.
      * @param cause The cause of the error if we have wrapped another error.
      */

package/dist/types/errors/guardError.d.ts CHANGED Viewed

@@ -10,7 +10,7 @@ export declare class GuardError extends BaseError {
     /**
      * Create a new instance of GuardError.
      * @param source The source of the error.
-     * @param message The message as a code.
+     * @param message The message as an i18n key.
      * @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.

package/dist/types/errors/notFoundError.d.ts CHANGED Viewed

@@ -10,7 +10,7 @@ export declare class NotFoundError extends BaseError {
     /**
      * Create a new instance of NotFoundError.
      * @param source The source of the error.
-     * @param message The message as a code.
+     * @param message The message as an i18n key.
      * @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.

package/dist/types/errors/notSupportedError.d.ts CHANGED Viewed

@@ -10,7 +10,7 @@ export declare 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 message The message as an i18n key.
      * @param properties Any additional information for the error.
      * @param cause The cause of the error if we have wrapped another error.
      */

package/dist/types/errors/unauthorizedError.d.ts CHANGED Viewed

@@ -1,6 +1,6 @@
 import { BaseError } from "./baseError.js";
 /**
- * Class to handle errors which are triggered by access not being unauthorized.
+ * Class to handle errors which are triggered by access not being authorized.
  */
 export declare class UnauthorizedError extends BaseError {
     /**
@@ -10,7 +10,7 @@ export declare 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 message The message as an i18n key.
      * @param properties Any additional information for the error.
      * @param cause The cause of the error if we have wrapped another error.
      */

package/dist/types/errors/unprocessableError.d.ts CHANGED Viewed

@@ -10,7 +10,7 @@ export declare class UnprocessableError extends BaseError {
     /**
      * Create a new instance of UnprocessableError.
      * @param source The source of the error.
-     * @param message The message as a code.
+     * @param message The message as an i18n key.
      * @param properties Any additional information for the error.
      * @param cause The cause of the error if we have wrapped another error.
      */

package/dist/types/index.d.ts CHANGED Viewed

@@ -28,8 +28,10 @@ export * from "./helpers/stringHelper.js";
 export * from "./helpers/uint8ArrayHelper.js";
 export * from "./models/coerceType.js";
 export * from "./models/compressionType.js";
+export * from "./models/healthStatus.js";
 export * from "./models/IComponent.js";
 export * from "./models/IError.js";
+export * from "./models/IHealth.js";
 export * from "./models/II18nShared.js";
 export * from "./models/IKeyValue.js";
 export * from "./models/ILabelledValue.js";

package/dist/types/models/IComponent.d.ts CHANGED Viewed

@@ -1,3 +1,4 @@
+import type { IHealth } from "./IHealth.js";
 /**
  * Interface describing a component which can be bootstrapped, started and stopped.
  */
@@ -25,4 +26,9 @@ export interface IComponent {
      * @returns Nothing.
      */
     stop?(nodeLoggingComponentType?: string): Promise<void>;
+    /**
+     * Returns the health status of the component.
+     * @returns The health status of the component, can return multiple entries for elements within the component.
+     */
+    health?(): Promise<IHealth[]>;
 }

package/dist/types/models/IError.d.ts CHANGED Viewed

@@ -7,7 +7,7 @@ export interface IError {
      */
     name: string;
     /**
-     * The message for the error.
+     * The message for the error as an i18n key.
      */
     message: string;
     /**

package/dist/types/models/IHealth.d.ts ADDED Viewed

@@ -0,0 +1,32 @@
+import type { HealthStatus } from "./healthStatus.js";
+/**
+ * Provides health information for a component.
+ */
+export interface IHealth {
+    /**
+     * The name of the component.
+     */
+    name: string;
+    /**
+     * The description of the component as an i18n key.
+     */
+    description?: string;
+    /**
+     * The overall status of the component, the entries can also report their own health.
+     */
+    status: HealthStatus;
+    /**
+     * The details for the status if there are further details to provide as an i18n key.
+     */
+    details?: string;
+    /**
+     * Properties to substitute in the i18n key for the details.
+     */
+    properties?: {
+        [id: string]: unknown;
+    };
+    /**
+     * The grouped child components, if any.
+     */
+    grouped?: IHealth[];
+}

package/dist/types/models/healthStatus.d.ts ADDED Viewed

@@ -0,0 +1,21 @@
+/**
+ * The health status of the component.
+ */
+export declare const HealthStatus: {
+    /**
+     * OK.
+     */
+    readonly Ok: "ok";
+    /**
+     * Warning.
+     */
+    readonly Warning: "warning";
+    /**
+     * Error.
+     */
+    readonly Error: "error";
+};
+/**
+ * The health status of the component.
+ */
+export type HealthStatus = (typeof HealthStatus)[keyof typeof HealthStatus];

package/docs/changelog.md CHANGED Viewed

@@ -1,5 +1,44 @@
 # Changelog
+## [0.0.3-next.34](https://github.com/twinfoundation/twin-framework/compare/core-v0.0.3-next.33...core-v0.0.3-next.34) (2026-05-06)
+### Features
+* health status grouping ([5007c29](https://github.com/twinfoundation/twin-framework/commit/5007c29fe4123fe56f754450b993dbe5dc32a057))
+### Dependencies
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.3-next.33 to 0.0.3-next.34
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.33 to 0.0.3-next.34
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.33 to 0.0.3-next.34
+## [0.0.3-next.33](https://github.com/twinfoundation/twin-framework/compare/core-v0.0.3-next.32...core-v0.0.3-next.33) (2026-05-05)
+### Features
+* add health method to components ([a88016d](https://github.com/twinfoundation/twin-framework/commit/a88016d90d172413e5bc5238dc1b3e35f82fcc2c))
+### Bug Fixes
+* improve jsdoc comments ([f7c8e43](https://github.com/twinfoundation/twin-framework/commit/f7c8e43fab9803dffa6461950d5b9979e25bcd24))
+### Dependencies
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.3-next.32 to 0.0.3-next.33
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.32 to 0.0.3-next.33
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.32 to 0.0.3-next.33
 ## [0.0.3-next.32](https://github.com/twinfoundation/twin-framework/compare/core-v0.0.3-next.31...core-v0.0.3-next.32) (2026-04-30)

package/docs/reference/classes/AlreadyExistsError.md CHANGED Viewed

@@ -26,7 +26,7 @@ The source of the error.
 `string`
-The message as a code.
+The message as an i18n key.
 ##### existingId?

package/docs/reference/classes/BaseError.md CHANGED Viewed

@@ -49,7 +49,7 @@ The source of the error.
 `string`
-The message as a code.
+The message as an i18n key.
 ##### properties?

package/docs/reference/classes/ConflictError.md CHANGED Viewed

@@ -26,7 +26,7 @@ The source of the error.
 `string`
-The message as a code.
+The message as an i18n key.
 ##### conflictId?

package/docs/reference/classes/GeneralError.md CHANGED Viewed

@@ -26,7 +26,7 @@ The source of the error.
 `string`
-The message as a code.
+The message as an i18n key.
 ##### properties?

package/docs/reference/classes/GuardError.md CHANGED Viewed

@@ -26,7 +26,7 @@ The source of the error.
 `string`
-The message as a code.
+The message as an i18n key.
 ##### propertyName

package/docs/reference/classes/NotFoundError.md CHANGED Viewed

@@ -26,7 +26,7 @@ The source of the error.
 `string`
-The message as a code.
+The message as an i18n key.
 ##### notFoundId?

package/docs/reference/classes/NotSupportedError.md CHANGED Viewed

@@ -26,7 +26,7 @@ The source of the error.
 `string`
-The message as a code.
+The message as an i18n key.
 ##### properties?

package/docs/reference/classes/UnauthorizedError.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # Class: UnauthorizedError
-Class to handle errors which are triggered by access not being unauthorized.
+Class to handle errors which are triggered by access not being authorized.
 ## Extends
@@ -26,7 +26,7 @@ The source of the error.
 `string`
-The message as a code.
+The message as an i18n key.
 ##### properties?

package/docs/reference/classes/UnprocessableError.md CHANGED Viewed

@@ -26,7 +26,7 @@ The source of the error.
 `string`
-The message as a code.
+The message as an i18n key.
 ##### properties?

package/docs/reference/index.md CHANGED Viewed

@@ -46,6 +46,7 @@
 - [IComponent](interfaces/IComponent.md)
 - [IError](interfaces/IError.md)
+- [IHealth](interfaces/IHealth.md)
 - [II18nShared](interfaces/II18nShared.md)
 - [IKeyValue](interfaces/IKeyValue.md)
 - [ILabelledValue](interfaces/ILabelledValue.md)
@@ -60,6 +61,7 @@
 - [CoerceType](type-aliases/CoerceType.md)
 - [CompressionType](type-aliases/CompressionType.md)
+- [HealthStatus](type-aliases/HealthStatus.md)
 - [ObjectOrArray](type-aliases/ObjectOrArray.md)
 - [SingleOccurrenceArrayDepthHelper](type-aliases/SingleOccurrenceArrayDepthHelper.md)
 - [SingleOccurrenceArray](type-aliases/SingleOccurrenceArray.md)
@@ -69,3 +71,4 @@
 - [ComponentFactory](variables/ComponentFactory.md)
 - [CoerceType](variables/CoerceType.md)
 - [CompressionType](variables/CompressionType.md)
+- [HealthStatus](variables/HealthStatus.md)

package/docs/reference/interfaces/IComponent.md CHANGED Viewed

@@ -81,3 +81,17 @@ The node logging component type.
 `Promise`\<`void`\>
 Nothing.
+***
+### health()? {#health}
+> `optional` **health**(): `Promise`\<[`IHealth`](IHealth.md)[]\>
+Returns the health status of the component.
+#### Returns
+`Promise`\<[`IHealth`](IHealth.md)[]\>
+The health status of the component, can return multiple entries for elements within the component.

package/docs/reference/interfaces/IError.md CHANGED Viewed

@@ -16,7 +16,7 @@ The name for the error.
 > **message**: `string`
-The message for the error.
+The message for the error as an i18n key.
 ***

package/docs/reference/interfaces/IHealth.md ADDED Viewed

@@ -0,0 +1,55 @@
+# Interface: IHealth
+Provides health information for a component.
+## Properties
+### name {#name}
+> **name**: `string`
+The name of the component.
+***
+### description? {#description}
+> `optional` **description?**: `string`
+The description of the component as an i18n key.
+***
+### status {#status}
+> **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
+The overall status of the component, the entries can also report their own health.
+***
+### details? {#details}
+> `optional` **details?**: `string`
+The details for the status if there are further details to provide as an i18n key.
+***
+### properties? {#properties}
+> `optional` **properties?**: `object`
+Properties to substitute in the i18n key for the details.
+#### Index Signature
+\[`id`: `string`\]: `unknown`
+***
+### grouped? {#grouped}
+> `optional` **grouped?**: `IHealth`[]
+The grouped child components, if any.

package/docs/reference/type-aliases/HealthStatus.md ADDED Viewed

@@ -0,0 +1,5 @@
+# Type Alias: HealthStatus
+> **HealthStatus** = *typeof* [`HealthStatus`](../variables/HealthStatus.md)\[keyof *typeof* [`HealthStatus`](../variables/HealthStatus.md)\]
+The health status of the component.

package/docs/reference/variables/HealthStatus.md ADDED Viewed

@@ -0,0 +1,25 @@
+# Variable: HealthStatus
+> `const` **HealthStatus**: `object`
+The health status of the component.
+## Type Declaration
+### Ok {#ok}
+> `readonly` **Ok**: `"ok"` = `"ok"`
+OK.
+### Warning {#warning}
+> `readonly` **Warning**: `"warning"` = `"warning"`
+Warning.
+### Error {#error}
+> `readonly` **Error**: `"error"` = `"error"`
+Error.

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.3-next.32",
+	"version": "0.0.3-next.34",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/nameof": "0.0.3-next.32",
+		"@twin.org/nameof": "0.0.3-next.34",
 		"intl-messageformat": "11.2.0",
 		"rfc6902": "5.2.0"
 	},