@twin.org/logging-connector-console 0.0.2-next.2 → 0.0.3-next.1

package/dist/{esm/index.mjs → es/consoleLoggingConnector.js}

@@ -1,12 +1,15 @@
-import { Guards, Is } from '@twin.org/core';
-import { LogEntryHelper } from '@twin.org/logging-models';
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { Guards, Is } from "@twin.org/core";
+import { LogEntryHelper, LogLevel } from "@twin.org/logging-models";
 /**
  * Class for performing logging operations in the console.
  */
-class ConsoleLoggingConnector {
+export class ConsoleLoggingConnector {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "ConsoleLoggingConnector";
     /**
      * The namespace for the logging connector.
      */
@@ -22,10 +25,6 @@ class ConsoleLoggingConnector {
         magenta: 35,
         red: 31
     };
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "ConsoleLoggingConnector";
     /**
      * The log levels to display, will default to all.
      * @internal
@@ -51,17 +50,24 @@ class ConsoleLoggingConnector {
      * @param options The options for the logging connector.
      */
     constructor(options) {
-        this._levels = options?.config?.levels ?? ["debug", "info", "warn", "error", "trace"];
+        this._levels = options?.config?.levels ?? Object.values(LogLevel);
         this._translateMessages = options?.config?.translateMessages ?? false;
         this._hideGroups = options?.config?.hideGroups ?? false;
     }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return ConsoleLoggingConnector.CLASS_NAME;
+    }
     /**
      * Log an entry to the connector.
      * @param logEntry The entry to log.
      * @returns Nothing.
      */
     async log(logEntry) {
-        Guards.object(this.CLASS_NAME, "logEntry", logEntry);
+        Guards.object(ConsoleLoggingConnector.CLASS_NAME, "logEntry", logEntry);
         if (this._levels.includes(logEntry.level)) {
             logEntry.ts ??= Date.now();
             const params = [
@@ -138,5 +144,4 @@ class ConsoleLoggingConnector {
         }
     }
 }
-
-export { ConsoleLoggingConnector };
+//# sourceMappingURL=consoleLoggingConnector.js.map

package/dist/es/consoleLoggingConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consoleLoggingConnector.js","sourceRoot":"","sources":["../../src/consoleLoggingConnector.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EACN,cAAc,EACd,QAAQ,EAGR,MAAM,0BAA0B,CAAC;AAIlC;;GAEG;AACH,MAAM,OAAO,uBAAuB;IACnC;;OAEG;IACI,MAAM,CAAU,UAAU,6BAA6C;IAE9E;;OAEG;IACI,MAAM,CAAU,SAAS,GAAW,SAAS,CAAC;IAErD;;;OAGG;IACK,MAAM,CAAU,OAAO,GAA6B;QAC3D,IAAI,EAAE,EAAE;QACR,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,EAAE;QACT,OAAO,EAAE,EAAE;QACX,GAAG,EAAE,EAAE;KACP,CAAC;IAEF;;;OAGG;IACc,OAAO,CAAa;IAErC;;;OAGG;IACc,kBAAkB,CAAU;IAE7C;;;OAGG;IACc,WAAW,CAAU;IAEtC;;;OAGG;IACK,UAAU,CAAU;IAE5B;;;OAGG;IACH,YAAY,OAAoD;QAC/D,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAClE,IAAI,CAAC,kBAAkB,GAAG,OAAO,EAAE,MAAM,EAAE,iBAAiB,IAAI,KAAK,CAAC;QACtE,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,MAAM,EAAE,UAAU,IAAI,KAAK,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,uBAAuB,CAAC,UAAU,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,CAAC,QAAmB;QACnC,MAAM,CAAC,MAAM,CAAY,uBAAuB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAEzF,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3C,QAAQ,CAAC,EAAE,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC;YAE3B,MAAM,MAAM,GAAc;gBACzB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC;gBACzF,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,GAAG,EAAE,SAAS,CAAC;aACpE,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;gBACvB,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACnC,CAAC;iBAAM,CAAC;gBACP,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;YACrD,CAAC;YAED,IAAI,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;YAC/B,IAAI,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;YAEzB,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAC7B,MAAM,iBAAiB,GAAG,cAAc,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBAC7D,IAAI,EAAE,CAAC,WAAW,CAAC,iBAAiB,CAAC,EAAE,CAAC;oBACvC,OAAO,GAAG,iBAAiB,CAAC;oBAC5B,IAAI,GAAG,SAAS,CAAC;gBAClB,CAAC;YACF,CAAC;YAED,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;YAE5C,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrB,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;oBACvC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;gBACnC,CAAC;qBAAM,CAAC;oBACP,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACnB,CAAC;YACF,CAAC;YAED,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;gBACpB,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC7B,CAAC;YAED,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;QAC/C,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACK,aAAa,CAAC,GAAW;QAChC,MAAM,gBAAgB,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM;QACvC,sCAAsC;QACtC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,EACtD,CAAC,CACD,CAAC;QACF,OAAO,OAAO,gBAAgB,GAAG,GAAG,aAAa,CAAC;IACnD,CAAC;IAED;;;;;;OAMG;IACK,QAAQ,CAAC,OAAe,EAAE,KAAoD;QACrF,qEAAqE;QACrE,OAAO,QAAQ,uBAAuB,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,UAAU,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACK,WAAW,CAAC,KAAa;QAChC,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YACxB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACrB,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC/B,CAAC;YACD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACtB,UAAU,CAAC,OAAO,CAAC,KAAK,CACvB,KAAK,KAAK,EAAE,EACZ,+BAA+B,IAAI,CAAC,aAAa,CAChD,KAAK,CACL,4EAA4E,CAC7E,CAAC;YACH,CAAC;QACF,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Guards, Is } from \"@twin.org/core\";\nimport {\n\tLogEntryHelper,\n\tLogLevel,\n\ttype ILogEntry,\n\ttype ILoggingConnector\n} from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IConsoleLoggingConnectorConstructorOptions } from \"./models/IConsoleLoggingConnectorConstructorOptions.js\";\n\n/**\n * Class for performing logging operations in the console.\n */\nexport class ConsoleLoggingConnector implements ILoggingConnector {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ConsoleLoggingConnector>();\n\n\t/**\n\t * The namespace for the logging connector.\n\t */\n\tpublic static readonly NAMESPACE: string = \"console\";\n\n\t/**\n\t * Colors for highlighting.\n\t * @internal\n\t */\n\tprivate static readonly _COLORS: { [id: string]: number } = {\n\t\tblue: 34,\n\t\tcyan: 36,\n\t\tgreen: 32,\n\t\tmagenta: 35,\n\t\tred: 31\n\t};\n\n\t/**\n\t * The log levels to display, will default to all.\n\t * @internal\n\t */\n\tprivate readonly _levels: LogLevel[];\n\n\t/**\n\t * Translate messages using the current locale.\n\t * @internal\n\t */\n\tprivate readonly _translateMessages: boolean;\n\n\t/**\n\t * Hide the groups.\n\t * @internal\n\t */\n\tprivate readonly _hideGroups: boolean;\n\n\t/**\n\t * The last group identity.\n\t * @internal\n\t */\n\tprivate _lastGroup?: string;\n\n\t/**\n\t * Create a new instance of ConsoleLoggingConnector.\n\t * @param options The options for the logging connector.\n\t */\n\tconstructor(options?: IConsoleLoggingConnectorConstructorOptions) {\n\t\tthis._levels = options?.config?.levels ?? Object.values(LogLevel);\n\t\tthis._translateMessages = options?.config?.translateMessages ?? false;\n\t\tthis._hideGroups = options?.config?.hideGroups ?? false;\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn ConsoleLoggingConnector.CLASS_NAME;\n\t}\n\n\t/**\n\t * Log an entry to the connector.\n\t * @param logEntry The entry to log.\n\t * @returns Nothing.\n\t */\n\tpublic async log(logEntry: ILogEntry): Promise<void> {\n\t\tGuards.object<ILogEntry>(ConsoleLoggingConnector.CLASS_NAME, nameof(logEntry), logEntry);\n\n\t\tif (this._levels.includes(logEntry.level)) {\n\t\t\tlogEntry.ts ??= Date.now();\n\n\t\t\tconst params: unknown[] = [\n\t\t\t\tthis.colorize(logEntry.level.toUpperCase(), logEntry.level === \"error\" ? \"red\" : \"green\"),\n\t\t\t\tthis.colorize(`[${new Date(logEntry.ts).toISOString()}]`, \"magenta\")\n\t\t\t];\n\n\t\t\tif (!this._hideGroups) {\n\t\t\t\tthis.handleGroup(logEntry.source);\n\t\t\t} else {\n\t\t\t\tparams.push(this.colorize(logEntry.source, \"blue\"));\n\t\t\t}\n\n\t\t\tlet message = logEntry.message;\n\t\t\tlet data = logEntry.data;\n\n\t\t\tif (this._translateMessages) {\n\t\t\t\tconst translatedMessage = LogEntryHelper.translate(logEntry);\n\t\t\t\tif (Is.stringValue(translatedMessage)) {\n\t\t\t\t\tmessage = translatedMessage;\n\t\t\t\t\tdata = undefined;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tparams.push(this.colorize(message, \"cyan\"));\n\n\t\t\tif (!Is.empty(data)) {\n\t\t\t\tif (Is.object(data) || Is.array(data)) {\n\t\t\t\t\tparams.push(JSON.stringify(data));\n\t\t\t\t} else {\n\t\t\t\t\tparams.push(data);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (logEntry.error) {\n\t\t\t\tparams.push(logEntry.error);\n\t\t\t}\n\n\t\t\tglobalThis.console[logEntry.level](...params);\n\t\t}\n\t}\n\n\t/**\n\t * Convert a string to a color.\n\t * @param str The string to convert.\n\t * @returns The color.\n\t * @internal\n\t */\n\tprivate stringToColor(str: string): string {\n\t\tconst stringUniqueHash = [...str].reduce(\n\t\t\t// eslint-disable-next-line no-bitwise\n\t\t\t(acc, char) => char.charCodeAt(0) + ((acc << 5) - acc),\n\t\t\t0\n\t\t);\n\t\treturn `hsl(${stringUniqueHash % 360}, 95%, 35%)`;\n\t}\n\n\t/**\n\t * Add color to a string.\n\t * @param string The string to colorize.\n\t * @param color The color to use.\n\t * @returns The colorized string.\n\t * @internal\n\t */\n\tprivate colorize(message: string, color: \"blue\" | \"cyan\" | \"green\" | \"magenta\" | \"red\"): string {\n\t\t// eslint-disable-next-line unicorn/escape-case,unicorn/no-hex-escape\n\t\treturn `\\x1b[${ConsoleLoggingConnector._COLORS[color]}m${message}\\x1b[39m`;\n\t}\n\n\t/**\n\t * Handle a group.\n\t * @param group The group.\n\t * @internal\n\t */\n\tprivate handleGroup(group: string): void {\n\t\tif (this._lastGroup !== group) {\n\t\t\tthis._lastGroup = group;\n\t\t\tif (this._lastGroup) {\n\t\t\t\tglobalThis.console.groupEnd();\n\t\t\t}\n\t\t\tif (group.length > 0) {\n\t\t\t\tglobalThis.console.group(\n\t\t\t\t\t`%c${group}`,\n\t\t\t\t\t`color: #ffffff; background: ${this.stringToColor(\n\t\t\t\t\t\tgroup\n\t\t\t\t\t)}; font-size: 10px; font-weight: bold; padding: 2px 4px; border-radius: 5px`\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,6 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./consoleLoggingConnector.js";
+export * from "./models/IConsoleLoggingConnectorConfig.js";
+export * from "./models/IConsoleLoggingConnectorConstructorOptions.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,wDAAwD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./consoleLoggingConnector.js\";\nexport * from \"./models/IConsoleLoggingConnectorConfig.js\";\nexport * from \"./models/IConsoleLoggingConnectorConstructorOptions.js\";\n"]}

package/dist/es/models/IConsoleLoggingConnectorConfig.js

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

package/dist/es/models/IConsoleLoggingConnectorConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IConsoleLoggingConnectorConfig.js","sourceRoot":"","sources":["../../../src/models/IConsoleLoggingConnectorConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ILoggingLevelsConfig } from \"@twin.org/logging-models\";\n\n/**\n * Configuration for the Console Logging Connector.\n */\nexport interface IConsoleLoggingConnectorConfig extends ILoggingLevelsConfig {\n\t/**\n\t * Translate message using the current locale.\n\t */\n\ttranslateMessages?: boolean;\n\n\t/**\n\t * Hide the group display.\n\t */\n\thideGroups?: boolean;\n}\n"]}

package/dist/es/models/IConsoleLoggingConnectorConstructorOptions.js

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

package/dist/es/models/IConsoleLoggingConnectorConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IConsoleLoggingConnectorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IConsoleLoggingConnectorConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IConsoleLoggingConnectorConfig } from \"./IConsoleLoggingConnectorConfig.js\";\n\n/**\n * Options for the console logging connector constructor.\n */\nexport interface IConsoleLoggingConnectorConstructorOptions {\n\t/**\n\t * The configuration for the console logging connector.\n\t */\n\tconfig?: IConsoleLoggingConnectorConfig;\n}\n"]}

package/dist/types/consoleLoggingConnector.d.ts

@@ -1,22 +1,27 @@
 import { type ILogEntry, type ILoggingConnector } from "@twin.org/logging-models";
-import type { IConsoleLoggingConnectorConstructorOptions } from "./models/IConsoleLoggingConnectorConstructorOptions";
+import type { IConsoleLoggingConnectorConstructorOptions } from "./models/IConsoleLoggingConnectorConstructorOptions.js";
 /**
  * Class for performing logging operations in the console.
  */
 export declare class ConsoleLoggingConnector implements ILoggingConnector {
     /**
-     * The namespace for the logging connector.
+     * Runtime name for the class.
      */
-    static readonly NAMESPACE: string;
+    static readonly CLASS_NAME: string;
     /**
-     * Runtime name for the class.
+     * The namespace for the logging connector.
      */
-    readonly CLASS_NAME: string;
+    static readonly NAMESPACE: string;
     /**
      * Create a new instance of ConsoleLoggingConnector.
      * @param options The options for the logging connector.
      */
     constructor(options?: IConsoleLoggingConnectorConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Log an entry to the connector.
      * @param logEntry The entry to log.

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./consoleLoggingConnector";
-export * from "./models/IConsoleLoggingConnectorConfig";
-export * from "./models/IConsoleLoggingConnectorConstructorOptions";
+export * from "./consoleLoggingConnector.js";
+export * from "./models/IConsoleLoggingConnectorConfig.js";
+export * from "./models/IConsoleLoggingConnectorConstructorOptions.js";

package/dist/types/models/IConsoleLoggingConnectorConstructorOptions.d.ts

@@ -1,4 +1,4 @@
-import type { IConsoleLoggingConnectorConfig } from "./IConsoleLoggingConnectorConfig";
+import type { IConsoleLoggingConnectorConfig } from "./IConsoleLoggingConnectorConfig.js";
 /**
  * Options for the console logging connector constructor.
  */

package/docs/changelog.md

@@ -1,5 +1,38 @@
 # @twin.org/logging-connector-console - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/logging/compare/logging-connector-console-v0.0.3-next.0...logging-connector-console-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add context id features ([#33](https://github.com/twinfoundation/logging/issues/33)) ([38e982c](https://github.com/twinfoundation/logging/commit/38e982c9f009019fc02b67d919444b52657c9021))
+* add validate-locales ([df53f13](https://github.com/twinfoundation/logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
+* eslint migration to flat config ([1f9fdde](https://github.com/twinfoundation/logging/commit/1f9fddedfdcce9942afed431d9460a0f22092744))
+* update dependencies ([976fc06](https://github.com/twinfoundation/logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
+* update framework core ([aac823c](https://github.com/twinfoundation/logging/commit/aac823c2ead88843618b8a82b308d5a793411764))
+* use shared store mechanism ([#20](https://github.com/twinfoundation/logging/issues/20)) ([bbacd31](https://github.com/twinfoundation/logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/logging-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [0.0.2-next.3](https://github.com/twinfoundation/logging/compare/logging-connector-console-v0.0.2-next.2...logging-connector-console-v0.0.2-next.3) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([df53f13](https://github.com/twinfoundation/logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/logging-models bumped from 0.0.2-next.2 to 0.0.2-next.3
+
 ## [0.0.2-next.2](https://github.com/twinfoundation/logging/compare/logging-connector-console-v0.0.2-next.1...logging-connector-console-v0.0.2-next.2) (2025-08-29)
 
 

package/docs/reference/classes/ConsoleLoggingConnector.md

@@ -28,25 +28,39 @@ The options for the logging connector.
 
 ## Properties
 
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+***
+
 ### NAMESPACE
 
 > `readonly` `static` **NAMESPACE**: `string` = `"console"`
 
 The namespace for the logging connector.
 
-***
+## Methods
 
-### CLASS\_NAME
+### className()
 
-> `readonly` **CLASS\_NAME**: `string`
+> **className**(): `string`
 
-Runtime name for the class.
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
 
 #### Implementation of
 
-`ILoggingConnector.CLASS_NAME`
+`ILoggingConnector.className`
 
-## Methods
+***
 
 ### log()
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/logging-connector-console",
-	"version": "0.0.2-next.2",
+	"version": "0.0.3-next.1",
 	"description": "Logging connector implementation using the console",
 	"repository": {
 		"type": "git",
@@ -15,25 +15,38 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
-		"@twin.org/logging-models": "0.0.2-next.2",
+		"@twin.org/logging-models": "0.0.3-next.1",
 		"@twin.org/nameof": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"logging",
+		"connector",
+		"adapter",
+		"integration"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/logging/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,144 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-var loggingModels = require('@twin.org/logging-models');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class for performing logging operations in the console.
- */
-class ConsoleLoggingConnector {
-    /**
-     * The namespace for the logging connector.
-     */
-    static NAMESPACE = "console";
-    /**
-     * Colors for highlighting.
-     * @internal
-     */
-    static _COLORS = {
-        blue: 34,
-        cyan: 36,
-        green: 32,
-        magenta: 35,
-        red: 31
-    };
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "ConsoleLoggingConnector";
-    /**
-     * The log levels to display, will default to all.
-     * @internal
-     */
-    _levels;
-    /**
-     * Translate messages using the current locale.
-     * @internal
-     */
-    _translateMessages;
-    /**
-     * Hide the groups.
-     * @internal
-     */
-    _hideGroups;
-    /**
-     * The last group identity.
-     * @internal
-     */
-    _lastGroup;
-    /**
-     * Create a new instance of ConsoleLoggingConnector.
-     * @param options The options for the logging connector.
-     */
-    constructor(options) {
-        this._levels = options?.config?.levels ?? ["debug", "info", "warn", "error", "trace"];
-        this._translateMessages = options?.config?.translateMessages ?? false;
-        this._hideGroups = options?.config?.hideGroups ?? false;
-    }
-    /**
-     * Log an entry to the connector.
-     * @param logEntry The entry to log.
-     * @returns Nothing.
-     */
-    async log(logEntry) {
-        core.Guards.object(this.CLASS_NAME, "logEntry", logEntry);
-        if (this._levels.includes(logEntry.level)) {
-            logEntry.ts ??= Date.now();
-            const params = [
-                this.colorize(logEntry.level.toUpperCase(), logEntry.level === "error" ? "red" : "green"),
-                this.colorize(`[${new Date(logEntry.ts).toISOString()}]`, "magenta")
-            ];
-            if (!this._hideGroups) {
-                this.handleGroup(logEntry.source);
-            }
-            else {
-                params.push(this.colorize(logEntry.source, "blue"));
-            }
-            let message = logEntry.message;
-            let data = logEntry.data;
-            if (this._translateMessages) {
-                const translatedMessage = loggingModels.LogEntryHelper.translate(logEntry);
-                if (core.Is.stringValue(translatedMessage)) {
-                    message = translatedMessage;
-                    data = undefined;
-                }
-            }
-            params.push(this.colorize(message, "cyan"));
-            if (!core.Is.empty(data)) {
-                if (core.Is.object(data) || core.Is.array(data)) {
-                    params.push(JSON.stringify(data));
-                }
-                else {
-                    params.push(data);
-                }
-            }
-            if (logEntry.error) {
-                params.push(logEntry.error);
-            }
-            globalThis.console[logEntry.level](...params);
-        }
-    }
-    /**
-     * Convert a string to a color.
-     * @param str The string to convert.
-     * @returns The color.
-     * @internal
-     */
-    stringToColor(str) {
-        const stringUniqueHash = [...str].reduce(
-        // eslint-disable-next-line no-bitwise
-        (acc, char) => char.charCodeAt(0) + ((acc << 5) - acc), 0);
-        return `hsl(${stringUniqueHash % 360}, 95%, 35%)`;
-    }
-    /**
-     * Add color to a string.
-     * @param string The string to colorize.
-     * @param color The color to use.
-     * @returns The colorized string.
-     * @internal
-     */
-    colorize(message, color) {
-        // eslint-disable-next-line unicorn/escape-case,unicorn/no-hex-escape
-        return `\x1b[${ConsoleLoggingConnector._COLORS[color]}m${message}\x1b[39m`;
-    }
-    /**
-     * Handle a group.
-     * @param group The group.
-     * @internal
-     */
-    handleGroup(group) {
-        if (this._lastGroup !== group) {
-            this._lastGroup = group;
-            if (this._lastGroup) {
-                globalThis.console.groupEnd();
-            }
-            if (group.length > 0) {
-                globalThis.console.group(`%c${group}`, `color: #ffffff; background: ${this.stringToColor(group)}; font-size: 10px; font-weight: bold; padding: 2px 4px; border-radius: 5px`);
-            }
-        }
-    }
-}
-
-exports.ConsoleLoggingConnector = ConsoleLoggingConnector;