@twin.org/logging-models 0.0.2-next.3 → 0.0.2-next.4

package/dist/es/connectors/multiLoggingConnector.js

@@ -0,0 +1,81 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Guards, Is } from "@twin.org/core";
+import { LoggingConnectorFactory } from "../factories/loggingConnectorFactory.js";
+import { LogLevel } from "../models/logLevel.js";
+/**
+ * Class for performing logging operations on multiple connectors.
+ */
+export class MultiLoggingConnector {
+    /**
+     * The namespace for the logging connector.
+     */
+    static NAMESPACE = "multi";
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "MultiLoggingConnector";
+    /**
+     * The connectors to send the log entries to.
+     * @internal
+     */
+    _loggingConnectors;
+    /**
+     * The log levels to display, will default to all.
+     * @internal
+     */
+    _levels;
+    /**
+     * Create a new instance of MultiLoggingConnector.
+     * @param options The options for the connector.
+     */
+    constructor(options) {
+        Guards.object(MultiLoggingConnector.CLASS_NAME, "options", options);
+        Guards.arrayValue(MultiLoggingConnector.CLASS_NAME, "options.loggingConnectorTypes", options.loggingConnectorTypes);
+        this._levels = options?.config?.levels ?? Object.values(LogLevel);
+        this._loggingConnectors = options.loggingConnectorTypes.map(t => LoggingConnectorFactory.get(t));
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return MultiLoggingConnector.CLASS_NAME;
+    }
+    /**
+     * Log an entry to the connector.
+     * @param logEntry The entry to log.
+     * @returns Nothing.
+     */
+    async log(logEntry) {
+        Guards.object(MultiLoggingConnector.CLASS_NAME, "logEntry", logEntry);
+        if (this._levels.includes(logEntry.level)) {
+            logEntry.ts ??= Date.now();
+            await Promise.allSettled(this._loggingConnectors.map(async (loggingConnector) => loggingConnector.log(logEntry)));
+        }
+    }
+    /**
+     * Query the log entries.
+     * @param conditions The conditions to match for the entities.
+     * @param sortProperties The optional sort order.
+     * @param properties The optional keys to return, defaults to all.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     */
+    async query(conditions, sortProperties, properties, cursor, limit) {
+        // See if we can find a connector that supports querying.
+        // If it throws anything other than not implemented, we should throw it.
+        for (const loggingConnector of this._loggingConnectors) {
+            // eslint-disable-next-line @typescript-eslint/unbound-method
+            if (Is.function(loggingConnector.query)) {
+                return loggingConnector.query(conditions, sortProperties, properties, cursor, limit);
+            }
+        }
+        return {
+            entities: []
+        };
+    }
+}
+//# sourceMappingURL=multiLoggingConnector.js.map

package/dist/es/connectors/multiLoggingConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multiLoggingConnector.js","sourceRoot":"","sources":["../../../src/connectors/multiLoggingConnector.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAG5C,OAAO,EAAE,uBAAuB,EAAE,MAAM,yCAAyC,CAAC;AAIlF,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD;;GAEG;AACH,MAAM,OAAO,qBAAqB;IACjC;;OAEG;IACI,MAAM,CAAU,SAAS,GAAW,OAAO,CAAC;IAEnD;;OAEG;IACI,MAAM,CAAU,UAAU,2BAA2C;IAE5E;;;OAGG;IACc,kBAAkB,CAAsB;IAEzD;;;OAGG;IACc,OAAO,CAAa;IAErC;;;OAGG;IACH,YAAY,OAAiD;QAC5D,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QAC1E,MAAM,CAAC,UAAU,CAChB,qBAAqB,CAAC,UAAU,mCAEhC,OAAO,CAAC,qBAAqB,CAC7B,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAClE,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAC/D,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC,CAC9B,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,qBAAqB,CAAC,UAAU,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,CAAC,QAAmB;QACnC,MAAM,CAAC,MAAM,CAAY,qBAAqB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAEvF,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,OAAO,CAAC,UAAU,CACvB,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,KAAK,EAAC,gBAAgB,EAAC,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CACrF,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,KAAK,CACjB,UAAuC,EACvC,cAGG,EACH,UAAgC,EAChC,MAAe,EACf,KAAc;QAWd,yDAAyD;QACzD,wEAAwE;QACxE,KAAK,MAAM,gBAAgB,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxD,6DAA6D;YAC7D,IAAI,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzC,OAAO,gBAAgB,CAAC,KAAK,CAAC,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;YACtF,CAAC;QACF,CAAC;QAED,OAAO;YACN,QAAQ,EAAE,EAAE;SACZ,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Guards, Is } from \"@twin.org/core\";\nimport type { EntityCondition, SortDirection } from \"@twin.org/entity\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { LoggingConnectorFactory } from \"../factories/loggingConnectorFactory.js\";\nimport type { ILogEntry } from \"../models/ILogEntry.js\";\nimport type { ILoggingConnector } from \"../models/ILoggingConnector.js\";\nimport type { IMultiLoggingConnectorConstructorOptions } from \"../models/IMultiLoggingConnectorConstructorOptions.js\";\nimport { LogLevel } from \"../models/logLevel.js\";\n\n/**\n * Class for performing logging operations on multiple connectors.\n */\nexport class MultiLoggingConnector implements ILoggingConnector {\n\t/**\n\t * The namespace for the logging connector.\n\t */\n\tpublic static readonly NAMESPACE: string = \"multi\";\n\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<MultiLoggingConnector>();\n\n\t/**\n\t * The connectors to send the log entries to.\n\t * @internal\n\t */\n\tprivate readonly _loggingConnectors: ILoggingConnector[];\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 * Create a new instance of MultiLoggingConnector.\n\t * @param options The options for the connector.\n\t */\n\tconstructor(options: IMultiLoggingConnectorConstructorOptions) {\n\t\tGuards.object(MultiLoggingConnector.CLASS_NAME, nameof(options), options);\n\t\tGuards.arrayValue(\n\t\t\tMultiLoggingConnector.CLASS_NAME,\n\t\t\tnameof(options.loggingConnectorTypes),\n\t\t\toptions.loggingConnectorTypes\n\t\t);\n\t\tthis._levels = options?.config?.levels ?? Object.values(LogLevel);\n\t\tthis._loggingConnectors = options.loggingConnectorTypes.map(t =>\n\t\t\tLoggingConnectorFactory.get(t)\n\t\t);\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 MultiLoggingConnector.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>(MultiLoggingConnector.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\tawait Promise.allSettled(\n\t\t\t\tthis._loggingConnectors.map(async loggingConnector => loggingConnector.log(logEntry))\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Query the log entries.\n\t * @param conditions The conditions to match for the entities.\n\t * @param sortProperties The optional sort order.\n\t * @param properties The optional keys to return, defaults to all.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t */\n\tpublic async query(\n\t\tconditions?: EntityCondition<ILogEntry>,\n\t\tsortProperties?: {\n\t\t\tproperty: keyof Omit<ILogEntry, \"error\" | \"data\">;\n\t\t\tsortDirection: SortDirection;\n\t\t}[],\n\t\tproperties?: (keyof ILogEntry)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The entities, which can be partial if a limited keys list was provided.\n\t\t */\n\t\tentities: Partial<ILogEntry>[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}> {\n\t\t// See if we can find a connector that supports querying.\n\t\t// If it throws anything other than not implemented, we should throw it.\n\t\tfor (const loggingConnector of this._loggingConnectors) {\n\t\t\t// eslint-disable-next-line @typescript-eslint/unbound-method\n\t\t\tif (Is.function(loggingConnector.query)) {\n\t\t\t\treturn loggingConnector.query(conditions, sortProperties, properties, cursor, limit);\n\t\t\t}\n\t\t}\n\n\t\treturn {\n\t\t\tentities: []\n\t\t};\n\t}\n}\n"]}

package/dist/es/connectors/silentLoggingConnector.js

@@ -0,0 +1,42 @@
+/**
+ * Class for performing logging operations to nowhere.
+ */
+export class SilentLoggingConnector {
+    /**
+     * The namespace for the logging connector.
+     */
+    static NAMESPACE = "silent";
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "SilentLoggingConnector";
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return SilentLoggingConnector.CLASS_NAME;
+    }
+    /**
+     * Log an entry to the connector.
+     * @param logEntry The entry to log.
+     * @returns Nothing.
+     */
+    async log(logEntry) { }
+    /**
+     * Query the log entries.
+     * @param conditions The conditions to match for the entities.
+     * @param sortProperties The optional sort order.
+     * @param properties The optional keys to return, defaults to all.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     */
+    async query(conditions, sortProperties, properties, cursor, limit) {
+        return {
+            entities: []
+        };
+    }
+}
+//# sourceMappingURL=silentLoggingConnector.js.map

package/dist/es/connectors/silentLoggingConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"silentLoggingConnector.js","sourceRoot":"","sources":["../../../src/connectors/silentLoggingConnector.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAClC;;OAEG;IACI,MAAM,CAAU,SAAS,GAAW,QAAQ,CAAC;IAEpD;;OAEG;IACI,MAAM,CAAU,UAAU,4BAA4C;IAE7E;;;OAGG;IACI,SAAS;QACf,OAAO,sBAAsB,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,CAAC,QAAmB,IAAkB,CAAC;IAEvD;;;;;;;;;OASG;IACI,KAAK,CAAC,KAAK,CACjB,UAAuC,EACvC,cAGG,EACH,UAAgC,EAChC,MAAe,EACf,KAAc;QAWd,OAAO;YACN,QAAQ,EAAE,EAAE;SACZ,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { EntityCondition, SortDirection } from \"@twin.org/entity\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { ILogEntry } from \"../models/ILogEntry.js\";\nimport type { ILoggingConnector } from \"../models/ILoggingConnector.js\";\n\n/**\n * Class for performing logging operations to nowhere.\n */\nexport class SilentLoggingConnector implements ILoggingConnector {\n\t/**\n\t * The namespace for the logging connector.\n\t */\n\tpublic static readonly NAMESPACE: string = \"silent\";\n\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<SilentLoggingConnector>();\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 SilentLoggingConnector.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\n\t/**\n\t * Query the log entries.\n\t * @param conditions The conditions to match for the entities.\n\t * @param sortProperties The optional sort order.\n\t * @param properties The optional keys to return, defaults to all.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t */\n\tpublic async query(\n\t\tconditions?: EntityCondition<ILogEntry>,\n\t\tsortProperties?: {\n\t\t\tproperty: keyof Omit<ILogEntry, \"error\" | \"data\">;\n\t\t\tsortDirection: SortDirection;\n\t\t}[],\n\t\tproperties?: (keyof ILogEntry)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The entities, which can be partial if a limited keys list was provided.\n\t\t */\n\t\tentities: Partial<ILogEntry>[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}> {\n\t\treturn {\n\t\t\tentities: []\n\t\t};\n\t}\n}\n"]}

package/dist/es/factories/loggingConnectorFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@twin.org/core";
+/**
+ * Factory for creating logging connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const LoggingConnectorFactory = Factory.createFactory("logging");
+//# sourceMappingURL=loggingConnectorFactory.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"loggingConnectorFactory.js","sourceRoot":"","sources":["../../../src/factories/loggingConnectorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,uBAAuB,GAAG,OAAO,CAAC,aAAa,CAAoB,SAAS,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { ILoggingConnector } from \"../models/ILoggingConnector.js\";\n\n/**\n * Factory for creating logging connectors.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const LoggingConnectorFactory = Factory.createFactory<ILoggingConnector>(\"logging\");\n"]}

package/dist/es/helpers/logEntryHelper.js

@@ -0,0 +1,31 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { I18n, Is, StringHelper } from "@twin.org/core";
+/**
+ * Helper class for log entry operations.
+ */
+export class LogEntryHelper {
+    /**
+     * Translate the log entry.
+     * @param logEntry The log entry.
+     * @returns The translated log entry if a translation can be found.
+     */
+    static translate(logEntry) {
+        if (Is.stringValue(logEntry.level) && Is.stringValue(logEntry.source)) {
+            const sourceMessage = `${logEntry.level}.${StringHelper.camelCase(logEntry.source)}.${logEntry.message}`;
+            if (I18n.hasMessage(sourceMessage)) {
+                return I18n.formatMessage(sourceMessage, logEntry.data);
+            }
+        }
+        if (Is.stringValue(logEntry.source)) {
+            const sourceMessage = `${StringHelper.camelCase(logEntry.source)}.${logEntry.message}`;
+            if (I18n.hasMessage(sourceMessage)) {
+                return I18n.formatMessage(sourceMessage, logEntry.data);
+            }
+        }
+        if (I18n.hasMessage(logEntry.message)) {
+            return I18n.formatMessage(logEntry.message, logEntry.data);
+        }
+    }
+}
+//# sourceMappingURL=logEntryHelper.js.map

package/dist/es/helpers/logEntryHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logEntryHelper.js","sourceRoot":"","sources":["../../../src/helpers/logEntryHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAGxD;;GAEG;AACH,MAAM,OAAO,cAAc;IAC1B;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,QAAmB;QAC1C,IAAI,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACvE,MAAM,aAAa,GAAG,GAAG,QAAQ,CAAC,KAAK,IAAI,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;YACzG,IAAI,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;gBACpC,OAAO,IAAI,CAAC,aAAa,CACxB,aAAa,EACb,QAAQ,CAAC,IAER,CACD,CAAC;YACH,CAAC;QACF,CAAC;QAED,IAAI,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACrC,MAAM,aAAa,GAAG,GAAG,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;YACvF,IAAI,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;gBACpC,OAAO,IAAI,CAAC,aAAa,CACxB,aAAa,EACb,QAAQ,CAAC,IAER,CACD,CAAC;YACH,CAAC;QACF,CAAC;QAED,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,OAAO,IAAI,CAAC,aAAa,CACxB,QAAQ,CAAC,OAAO,EAChB,QAAQ,CAAC,IAER,CACD,CAAC;QACH,CAAC;IACF,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { I18n, Is, StringHelper } from \"@twin.org/core\";\nimport type { ILogEntry } from \"../models/ILogEntry.js\";\n\n/**\n * Helper class for log entry operations.\n */\nexport class LogEntryHelper {\n\t/**\n\t * Translate the log entry.\n\t * @param logEntry The log entry.\n\t * @returns The translated log entry if a translation can be found.\n\t */\n\tpublic static translate(logEntry: ILogEntry): string | undefined {\n\t\tif (Is.stringValue(logEntry.level) && Is.stringValue(logEntry.source)) {\n\t\t\tconst sourceMessage = `${logEntry.level}.${StringHelper.camelCase(logEntry.source)}.${logEntry.message}`;\n\t\t\tif (I18n.hasMessage(sourceMessage)) {\n\t\t\t\treturn I18n.formatMessage(\n\t\t\t\t\tsourceMessage,\n\t\t\t\t\tlogEntry.data as {\n\t\t\t\t\t\t[key: string]: unknown;\n\t\t\t\t\t}\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\n\t\tif (Is.stringValue(logEntry.source)) {\n\t\t\tconst sourceMessage = `${StringHelper.camelCase(logEntry.source)}.${logEntry.message}`;\n\t\t\tif (I18n.hasMessage(sourceMessage)) {\n\t\t\t\treturn I18n.formatMessage(\n\t\t\t\t\tsourceMessage,\n\t\t\t\t\tlogEntry.data as {\n\t\t\t\t\t\t[key: string]: unknown;\n\t\t\t\t\t}\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\n\t\tif (I18n.hasMessage(logEntry.message)) {\n\t\t\treturn I18n.formatMessage(\n\t\t\t\tlogEntry.message,\n\t\t\t\tlogEntry.data as {\n\t\t\t\t\t[key: string]: unknown;\n\t\t\t\t}\n\t\t\t);\n\t\t}\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,16 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./connectors/multiLoggingConnector.js";
+export * from "./connectors/silentLoggingConnector.js";
+export * from "./factories/loggingConnectorFactory.js";
+export * from "./helpers/logEntryHelper.js";
+export * from "./models/api/ILoggingCreateRequest.js";
+export * from "./models/api/ILoggingListRequest.js";
+export * from "./models/api/ILoggingListResponse.js";
+export * from "./models/ILogEntry.js";
+export * from "./models/ILoggingComponent.js";
+export * from "./models/ILoggingConnector.js";
+export * from "./models/ILoggingLevelsConfig.js";
+export * from "./models/IMultiLoggingConnectorConstructorOptions.js";
+export * from "./models/logLevel.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,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,wCAAwC,CAAC;AACvD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uCAAuC,CAAC;AACtD,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC;AACrD,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,sDAAsD,CAAC;AACrE,cAAc,sBAAsB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./connectors/multiLoggingConnector.js\";\nexport * from \"./connectors/silentLoggingConnector.js\";\nexport * from \"./factories/loggingConnectorFactory.js\";\nexport * from \"./helpers/logEntryHelper.js\";\nexport * from \"./models/api/ILoggingCreateRequest.js\";\nexport * from \"./models/api/ILoggingListRequest.js\";\nexport * from \"./models/api/ILoggingListResponse.js\";\nexport * from \"./models/ILogEntry.js\";\nexport * from \"./models/ILoggingComponent.js\";\nexport * from \"./models/ILoggingConnector.js\";\nexport * from \"./models/ILoggingLevelsConfig.js\";\nexport * from \"./models/IMultiLoggingConnectorConstructorOptions.js\";\nexport * from \"./models/logLevel.js\";\n"]}

package/dist/es/models/ILogEntry.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ILogEntry.js","sourceRoot":"","sources":["../../../src/models/ILogEntry.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@twin.org/core\";\nimport type { LogLevel } from \"./logLevel.js\";\n\n/**\n * Interface describing a log entry.\n */\nexport interface ILogEntry {\n\t/**\n\t * The level of the error being logged.\n\t */\n\tlevel: LogLevel;\n\n\t/**\n\t * The source of the log entry.\n\t */\n\tsource: string;\n\n\t/**\n\t * The timestamp of the log entry, if left blank will be populated by the connector.\n\t */\n\tts?: number;\n\n\t/**\n\t * The message.\n\t */\n\tmessage: string;\n\n\t/**\n\t * Optional error details.\n\t */\n\terror?: IError;\n\n\t/**\n\t * Optional data for the message.\n\t */\n\tdata?: { [key: string]: unknown };\n}\n"]}

package/dist/es/models/ILoggingComponent.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ILoggingComponent.js","sourceRoot":"","sources":["../../../src/models/ILoggingComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { ILogEntry } from \"./ILogEntry.js\";\nimport type { LogLevel } from \"./logLevel.js\";\n\n/**\n * Interface describing a logging contract.\n */\nexport interface ILoggingComponent extends IComponent {\n\t/**\n\t * Log an entry to the component.\n\t * @param logEntry The entry to log.\n\t * @returns Nothing.\n\t */\n\tlog(logEntry: ILogEntry): Promise<void>;\n\n\t/**\n\t * Query the log entries.\n\t * @param level The level of the log entries.\n\t * @param source The source of the log entries.\n\t * @param timeStart The inclusive time as the start of the log entries.\n\t * @param timeEnd The inclusive time as the end of the log entries.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t */\n\tquery(\n\t\tlevel?: LogLevel,\n\t\tsource?: string,\n\t\ttimeStart?: number,\n\t\ttimeEnd?: number,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The entities, which can be partial if a limited keys list was provided.\n\t\t */\n\t\tentities: ILogEntry[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}>;\n}\n"]}

package/dist/es/models/ILoggingConnector.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ILoggingConnector.js","sourceRoot":"","sources":["../../../src/models/ILoggingConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { EntityCondition, SortDirection } from \"@twin.org/entity\";\nimport type { ILogEntry } from \"./ILogEntry.js\";\n\n/**\n * Interface describing a logging connector.\n */\nexport interface ILoggingConnector extends IComponent {\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\tlog(logEntry: ILogEntry): Promise<void>;\n\n\t/**\n\t * Query the log entries.\n\t * @param conditions The conditions to match for the entities.\n\t * @param sortProperties The optional sort order.\n\t * @param properties The optional keys to return, defaults to all.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t */\n\tquery?(\n\t\tconditions?: EntityCondition<ILogEntry>,\n\t\tsortProperties?: {\n\t\t\tproperty: keyof Omit<ILogEntry, \"error\" | \"data\">;\n\t\t\tsortDirection: SortDirection;\n\t\t}[],\n\t\tproperties?: (keyof ILogEntry)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The entities, which can be partial if a limited keys list was provided.\n\t\t */\n\t\tentities: Partial<ILogEntry>[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}>;\n}\n"]}

package/dist/es/models/ILoggingLevelsConfig.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ILoggingLevelsConfig.js","sourceRoot":"","sources":["../../../src/models/ILoggingLevelsConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { LogLevel } from \"./logLevel.js\";\n\n/**\n * Configuration for the logging connectors to specify the levels to display.\n */\nexport interface ILoggingLevelsConfig {\n\t/**\n\t * The log levels to display, will default to all.\n\t */\n\tlevels?: LogLevel[];\n}\n"]}

package/dist/es/models/IMultiLoggingConnectorConstructorOptions.js

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

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

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

package/dist/es/models/api/ILoggingCreateRequest.js

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

package/dist/es/models/api/ILoggingCreateRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ILoggingCreateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/ILoggingCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ILogEntry } from \"../ILogEntry.js\";\n\n/**\n * Create a new log entry.\n */\nexport interface ILoggingCreateRequest {\n\t/**\n\t * The data to be used in the create.\n\t */\n\tbody: ILogEntry;\n}\n"]}

package/dist/es/models/api/ILoggingListRequest.js

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

package/dist/es/models/api/ILoggingListRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ILoggingListRequest.js","sourceRoot":"","sources":["../../../../src/models/api/ILoggingListRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { LogLevel } from \"../logLevel.js\";\n\n/**\n * Get the a list of the log entries.\n */\nexport interface ILoggingListRequest {\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The level of the log entries to retrieve.\n\t\t */\n\t\tlevel?: LogLevel;\n\n\t\t/**\n\t\t * The source of the log entries to retrieve.\n\t\t */\n\t\tsource?: string;\n\n\t\t/**\n\t\t * The start time of the metrics to retrieve as a timestamp in ms.\n\t\t */\n\t\ttimeStart?: number | string;\n\n\t\t/**\n\t\t * The end time of the metrics to retrieve as a timestamp in ms.\n\t\t */\n\t\ttimeEnd?: number | string;\n\n\t\t/**\n\t\t * The optional cursor to get next chunk.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * Limit the number of entities to return.\n\t\t */\n\t\tlimit?: string;\n\t};\n}\n"]}

package/dist/es/models/api/ILoggingListResponse.js

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

package/dist/es/models/api/ILoggingListResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ILoggingListResponse.js","sourceRoot":"","sources":["../../../../src/models/api/ILoggingListResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ILogEntry } from \"../ILogEntry.js\";\n\n/**\n * Response for log entry list request.\n */\nexport interface ILoggingListResponse {\n\t/**\n\t * The response payload.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The entities, which can be partial if a limited keys list was provided.\n\t\t */\n\t\tentities: ILogEntry[];\n\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}

package/dist/es/models/logLevel.js

@@ -0,0 +1,29 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The log levels.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const LogLevel = {
+    /**
+     * Info.
+     */
+    Info: "info",
+    /**
+     * Error.
+     */
+    Error: "error",
+    /**
+     * Warn.
+     */
+    Warn: "warn",
+    /**
+     * Trace.
+     */
+    Trace: "trace",
+    /**
+     * Debug.
+     */
+    Debug: "debug"
+};
+//# sourceMappingURL=logLevel.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"logLevel.js","sourceRoot":"","sources":["../../../src/models/logLevel.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,QAAQ,GAAG;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,KAAK,EAAE,OAAO;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,KAAK,EAAE,OAAO;IAEd;;OAEG;IACH,KAAK,EAAE,OAAO;CACL,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The log levels.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const LogLevel = {\n\t/**\n\t * Info.\n\t */\n\tInfo: \"info\",\n\n\t/**\n\t * Error.\n\t */\n\tError: \"error\",\n\n\t/**\n\t * Warn.\n\t */\n\tWarn: \"warn\",\n\n\t/**\n\t * Trace.\n\t */\n\tTrace: \"trace\",\n\n\t/**\n\t * Debug.\n\t */\n\tDebug: \"debug\"\n} as const;\n\n/**\n * The log levels.\n */\nexport type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];\n"]}

package/dist/types/connectors/multiLoggingConnector.d.ts

@@ -1,7 +1,7 @@
 import type { EntityCondition, SortDirection } from "@twin.org/entity";
-import type { ILogEntry } from "../models/ILogEntry";
-import type { ILoggingConnector } from "../models/ILoggingConnector";
-import type { IMultiLoggingConnectorConstructorOptions } from "../models/IMultiLoggingConnectorConstructorOptions";
+import type { ILogEntry } from "../models/ILogEntry.js";
+import type { ILoggingConnector } from "../models/ILoggingConnector.js";
+import type { IMultiLoggingConnectorConstructorOptions } from "../models/IMultiLoggingConnectorConstructorOptions.js";
 /**
  * Class for performing logging operations on multiple connectors.
  */
@@ -19,6 +19,11 @@ export declare class MultiLoggingConnector implements ILoggingConnector {
      * @param options The options for the connector.
      */
     constructor(options: IMultiLoggingConnectorConstructorOptions);
+    /**
+     * 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/connectors/silentLoggingConnector.d.ts

@@ -1,6 +1,6 @@
 import type { EntityCondition, SortDirection } from "@twin.org/entity";
-import type { ILogEntry } from "../models/ILogEntry";
-import type { ILoggingConnector } from "../models/ILoggingConnector";
+import type { ILogEntry } from "../models/ILogEntry.js";
+import type { ILoggingConnector } from "../models/ILoggingConnector.js";
 /**
  * Class for performing logging operations to nowhere.
  */
@@ -13,6 +13,11 @@ export declare class SilentLoggingConnector implements ILoggingConnector {
      * Runtime name for the class.
      */
     static readonly CLASS_NAME: string;
+    /**
+     * 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/factories/loggingConnectorFactory.d.ts

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { ILoggingConnector } from "../models/ILoggingConnector";
+import type { ILoggingConnector } from "../models/ILoggingConnector.js";
 /**
  * Factory for creating logging connectors.
  */

package/dist/types/helpers/logEntryHelper.d.ts

@@ -1,4 +1,4 @@
-import type { ILogEntry } from "../models/ILogEntry";
+import type { ILogEntry } from "../models/ILogEntry.js";
 /**
  * Helper class for log entry operations.
  */

package/dist/types/index.d.ts

@@ -1,13 +1,13 @@
-export * from "./connectors/multiLoggingConnector";
-export * from "./connectors/silentLoggingConnector";
-export * from "./factories/loggingConnectorFactory";
-export * from "./helpers/logEntryHelper";
-export * from "./models/api/ILoggingCreateRequest";
-export * from "./models/api/ILoggingListRequest";
-export * from "./models/api/ILoggingListResponse";
-export * from "./models/ILogEntry";
-export * from "./models/ILoggingComponent";
-export * from "./models/ILoggingConnector";
-export * from "./models/ILoggingLevelsConfig";
-export * from "./models/IMultiLoggingConnectorConstructorOptions";
-export * from "./models/logLevel";
+export * from "./connectors/multiLoggingConnector.js";
+export * from "./connectors/silentLoggingConnector.js";
+export * from "./factories/loggingConnectorFactory.js";
+export * from "./helpers/logEntryHelper.js";
+export * from "./models/api/ILoggingCreateRequest.js";
+export * from "./models/api/ILoggingListRequest.js";
+export * from "./models/api/ILoggingListResponse.js";
+export * from "./models/ILogEntry.js";
+export * from "./models/ILoggingComponent.js";
+export * from "./models/ILoggingConnector.js";
+export * from "./models/ILoggingLevelsConfig.js";
+export * from "./models/IMultiLoggingConnectorConstructorOptions.js";
+export * from "./models/logLevel.js";

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

@@ -1,5 +1,5 @@
 import type { IError } from "@twin.org/core";
-import type { LogLevel } from "./logLevel";
+import type { LogLevel } from "./logLevel.js";
 /**
  * Interface describing a log entry.
  */

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

@@ -1,6 +1,6 @@
 import type { IComponent } from "@twin.org/core";
-import type { ILogEntry } from "./ILogEntry";
-import type { LogLevel } from "./logLevel";
+import type { ILogEntry } from "./ILogEntry.js";
+import type { LogLevel } from "./logLevel.js";
 /**
  * Interface describing a logging contract.
  */

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

@@ -1,6 +1,6 @@
 import type { IComponent } from "@twin.org/core";
 import type { EntityCondition, SortDirection } from "@twin.org/entity";
-import type { ILogEntry } from "./ILogEntry";
+import type { ILogEntry } from "./ILogEntry.js";
 /**
  * Interface describing a logging connector.
  */

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

@@ -1,4 +1,4 @@
-import type { LogLevel } from "./logLevel";
+import type { LogLevel } from "./logLevel.js";
 /**
  * Configuration for the logging connectors to specify the levels to display.
  */

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

@@ -1,4 +1,4 @@
-import type { ILoggingLevelsConfig } from "../models/ILoggingLevelsConfig";
+import type { ILoggingLevelsConfig } from "../models/ILoggingLevelsConfig.js";
 /**
  * Options for the multi logging connector.
  */

package/dist/types/models/api/ILoggingCreateRequest.d.ts

@@ -1,4 +1,4 @@
-import type { ILogEntry } from "../ILogEntry";
+import type { ILogEntry } from "../ILogEntry.js";
 /**
  * Create a new log entry.
  */

package/dist/types/models/api/ILoggingListRequest.d.ts

@@ -1,4 +1,4 @@
-import type { LogLevel } from "../logLevel";
+import type { LogLevel } from "../logLevel.js";
 /**
  * Get the a list of the log entries.
  */

package/dist/types/models/api/ILoggingListResponse.d.ts

@@ -1,4 +1,4 @@
-import type { ILogEntry } from "../ILogEntry";
+import type { ILogEntry } from "../ILogEntry.js";
 /**
  * Response for log entry list request.
  */

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

@@ -1,4 +1,29 @@
 /**
- * Log level.
+ * The log levels.
  */
-export type LogLevel = "info" | "error" | "warn" | "trace" | "debug";
+export declare const LogLevel: {
+    /**
+     * Info.
+     */
+    readonly Info: "info";
+    /**
+     * Error.
+     */
+    readonly Error: "error";
+    /**
+     * Warn.
+     */
+    readonly Warn: "warn";
+    /**
+     * Trace.
+     */
+    readonly Trace: "trace";
+    /**
+     * Debug.
+     */
+    readonly Debug: "debug";
+};
+/**
+ * The log levels.
+ */
+export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];

package/docs/reference/classes/LogEntryHelper.md

@@ -16,7 +16,7 @@ Helper class for log entry operations.
 
 ### translate()
 
-> `static` **translate**(`logEntry`): `undefined` \| `string`
+> `static` **translate**(`logEntry`): `string` \| `undefined`
 
 Translate the log entry.
 
@@ -30,6 +30,6 @@ The log entry.
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 The translated log entry if a translation can be found.

package/docs/reference/classes/MultiLoggingConnector.md

@@ -44,6 +44,24 @@ Runtime name for the class.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`ILoggingConnector.className`
+
+***
+
 ### log()
 
 > **log**(`logEntry`): `Promise`\<`void`\>

package/docs/reference/classes/SilentLoggingConnector.md

@@ -34,6 +34,24 @@ Runtime name for the class.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`ILoggingConnector.className`
+
+***
+
 ### log()
 
 > **log**(`logEntry`): `Promise`\<`void`\>

package/docs/reference/index.md

@@ -24,3 +24,4 @@
 ## Variables
 
 - [LoggingConnectorFactory](variables/LoggingConnectorFactory.md)
+- [LogLevel](variables/LogLevel.md)

package/docs/reference/interfaces/ILoggingComponent.md

@@ -6,14 +6,6 @@ Interface describing a logging contract.
 
 - `IComponent`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
 ### log()

package/docs/reference/interfaces/ILoggingConnector.md

@@ -6,14 +6,6 @@ Interface describing a logging connector.
 
 - `IComponent`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
 ### log()

package/docs/reference/type-aliases/LogLevel.md

@@ -1,5 +1,5 @@
 # Type Alias: LogLevel
 
-> **LogLevel** = `"info"` \| `"error"` \| `"warn"` \| `"trace"` \| `"debug"`
+> **LogLevel** = *typeof* [`LogLevel`](../variables/LogLevel.md)\[keyof *typeof* [`LogLevel`](../variables/LogLevel.md)\]
 
-Log level.
+The log levels.

package/docs/reference/variables/LogLevel.md

@@ -0,0 +1,37 @@
+# Variable: LogLevel
+
+> `const` **LogLevel**: `object`
+
+The log levels.
+
+## Type Declaration
+
+### Info
+
+> `readonly` **Info**: `"info"` = `"info"`
+
+Info.
+
+### Error
+
+> `readonly` **Error**: `"error"` = `"error"`
+
+Error.
+
+### Warn
+
+> `readonly` **Warn**: `"warn"` = `"warn"`
+
+Warn.
+
+### Trace
+
+> `readonly` **Trace**: `"trace"` = `"trace"`
+
+Trace.
+
+### Debug
+
+> `readonly` **Debug**: `"debug"` = `"debug"`
+
+Debug.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/logging-models",
-	"version": "0.0.2-next.3",
+	"version": "0.0.2-next.4",
 	"description": "Models which define the structure of the logging connectors and services",
 	"repository": {
 		"type": "git",
@@ -13,25 +13,51 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
+	"scripts": {
+		"clean": "rimraf dist coverage docs/reference",
+		"build": "tspc",
+		"dev": "nodemon --watch src --ext ts --exec \"npm run build\"",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"test:build": "tspc -p ./tests/tsconfig.json --noEmit",
+		"validate-locales": "validate-locales",
+		"test:coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run validate-locales && npm run test:build && npm run test && npm run docs",
+		"dist:no-test": "npm run clean && npm run build && npm run test:build && npm run docs"
+	},
 	"dependencies": {
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"devDependencies": {
+		"@twin.org/nameof-transformer": "next",
+		"@twin.org/nameof-vitest-plugin": "next",
+		"@twin.org/validate-locales": "next",
+		"@vitest/coverage-v8": "4.0.8",
+		"copyfiles": "2.4.1",
+		"nodemon": "3.1.10",
+		"rimraf": "6.1.0",
+		"ts-patch": "3.3.0",
+		"typedoc": "0.28.14",
+		"typedoc-plugin-markdown": "4.9.0",
+		"typescript": "5.9.3",
+		"vitest": "4.0.8"
+	},
+	"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"

package/dist/cjs/index.cjs

@@ -1,152 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating logging connectors.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const LoggingConnectorFactory = core.Factory.createFactory("logging");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class for performing logging operations on multiple connectors.
- */
-class MultiLoggingConnector {
-    /**
-     * The namespace for the logging connector.
-     */
-    static NAMESPACE = "multi";
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "MultiLoggingConnector";
-    /**
-     * The connectors to send the log entries to.
-     * @internal
-     */
-    _loggingConnectors;
-    /**
-     * The log levels to display, will default to all.
-     * @internal
-     */
-    _levels;
-    /**
-     * Create a new instance of MultiLoggingConnector.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        core.Guards.object(MultiLoggingConnector.CLASS_NAME, "options", options);
-        core.Guards.arrayValue(MultiLoggingConnector.CLASS_NAME, "options.loggingConnectorTypes", options.loggingConnectorTypes);
-        this._levels = options?.config?.levels ?? ["debug", "info", "warn", "error", "trace"];
-        this._loggingConnectors = options.loggingConnectorTypes.map(t => LoggingConnectorFactory.get(t));
-    }
-    /**
-     * Log an entry to the connector.
-     * @param logEntry The entry to log.
-     * @returns Nothing.
-     */
-    async log(logEntry) {
-        core.Guards.object(MultiLoggingConnector.CLASS_NAME, "logEntry", logEntry);
-        if (this._levels.includes(logEntry.level)) {
-            logEntry.ts ??= Date.now();
-            await Promise.allSettled(this._loggingConnectors.map(async (loggingConnector) => loggingConnector.log(logEntry)));
-        }
-    }
-    /**
-     * Query the log entries.
-     * @param conditions The conditions to match for the entities.
-     * @param sortProperties The optional sort order.
-     * @param properties The optional keys to return, defaults to all.
-     * @param cursor The cursor to request the next chunk of entities.
-     * @param limit Limit the number of entities to return.
-     * @returns All the entities for the storage matching the conditions,
-     * and a cursor which can be used to request more entities.
-     */
-    async query(conditions, sortProperties, properties, cursor, limit) {
-        // See if we can find a connector that supports querying.
-        // If it throws anything other than not implemented, we should throw it.
-        for (const loggingConnector of this._loggingConnectors) {
-            // eslint-disable-next-line @typescript-eslint/unbound-method
-            if (core.Is.function(loggingConnector.query)) {
-                return loggingConnector.query(conditions, sortProperties, properties, cursor, limit);
-            }
-        }
-        return {
-            entities: []
-        };
-    }
-}
-
-/**
- * Class for performing logging operations to nowhere.
- */
-class SilentLoggingConnector {
-    /**
-     * The namespace for the logging connector.
-     */
-    static NAMESPACE = "silent";
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "SilentLoggingConnector";
-    /**
-     * Log an entry to the connector.
-     * @param logEntry The entry to log.
-     * @returns Nothing.
-     */
-    async log(logEntry) { }
-    /**
-     * Query the log entries.
-     * @param conditions The conditions to match for the entities.
-     * @param sortProperties The optional sort order.
-     * @param properties The optional keys to return, defaults to all.
-     * @param cursor The cursor to request the next chunk of entities.
-     * @param limit Limit the number of entities to return.
-     * @returns All the entities for the storage matching the conditions,
-     * and a cursor which can be used to request more entities.
-     */
-    async query(conditions, sortProperties, properties, cursor, limit) {
-        return {
-            entities: []
-        };
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Helper class for log entry operations.
- */
-class LogEntryHelper {
-    /**
-     * Translate the log entry.
-     * @param logEntry The log entry.
-     * @returns The translated log entry if a translation can be found.
-     */
-    static translate(logEntry) {
-        if (core.Is.stringValue(logEntry.level) && core.Is.stringValue(logEntry.source)) {
-            const sourceMessage = `${logEntry.level}.${core.StringHelper.camelCase(logEntry.source)}.${logEntry.message}`;
-            if (core.I18n.hasMessage(sourceMessage)) {
-                return core.I18n.formatMessage(sourceMessage, logEntry.data);
-            }
-        }
-        if (core.Is.stringValue(logEntry.source)) {
-            const sourceMessage = `${core.StringHelper.camelCase(logEntry.source)}.${logEntry.message}`;
-            if (core.I18n.hasMessage(sourceMessage)) {
-                return core.I18n.formatMessage(sourceMessage, logEntry.data);
-            }
-        }
-        if (core.I18n.hasMessage(logEntry.message)) {
-            return core.I18n.formatMessage(logEntry.message, logEntry.data);
-        }
-    }
-}
-
-exports.LogEntryHelper = LogEntryHelper;
-exports.LoggingConnectorFactory = LoggingConnectorFactory;
-exports.MultiLoggingConnector = MultiLoggingConnector;
-exports.SilentLoggingConnector = SilentLoggingConnector;

package/dist/esm/index.mjs

@@ -1,147 +0,0 @@
-import { Factory, Guards, Is, StringHelper, I18n } from '@twin.org/core';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating logging connectors.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const LoggingConnectorFactory = Factory.createFactory("logging");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class for performing logging operations on multiple connectors.
- */
-class MultiLoggingConnector {
-    /**
-     * The namespace for the logging connector.
-     */
-    static NAMESPACE = "multi";
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "MultiLoggingConnector";
-    /**
-     * The connectors to send the log entries to.
-     * @internal
-     */
-    _loggingConnectors;
-    /**
-     * The log levels to display, will default to all.
-     * @internal
-     */
-    _levels;
-    /**
-     * Create a new instance of MultiLoggingConnector.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        Guards.object(MultiLoggingConnector.CLASS_NAME, "options", options);
-        Guards.arrayValue(MultiLoggingConnector.CLASS_NAME, "options.loggingConnectorTypes", options.loggingConnectorTypes);
-        this._levels = options?.config?.levels ?? ["debug", "info", "warn", "error", "trace"];
-        this._loggingConnectors = options.loggingConnectorTypes.map(t => LoggingConnectorFactory.get(t));
-    }
-    /**
-     * Log an entry to the connector.
-     * @param logEntry The entry to log.
-     * @returns Nothing.
-     */
-    async log(logEntry) {
-        Guards.object(MultiLoggingConnector.CLASS_NAME, "logEntry", logEntry);
-        if (this._levels.includes(logEntry.level)) {
-            logEntry.ts ??= Date.now();
-            await Promise.allSettled(this._loggingConnectors.map(async (loggingConnector) => loggingConnector.log(logEntry)));
-        }
-    }
-    /**
-     * Query the log entries.
-     * @param conditions The conditions to match for the entities.
-     * @param sortProperties The optional sort order.
-     * @param properties The optional keys to return, defaults to all.
-     * @param cursor The cursor to request the next chunk of entities.
-     * @param limit Limit the number of entities to return.
-     * @returns All the entities for the storage matching the conditions,
-     * and a cursor which can be used to request more entities.
-     */
-    async query(conditions, sortProperties, properties, cursor, limit) {
-        // See if we can find a connector that supports querying.
-        // If it throws anything other than not implemented, we should throw it.
-        for (const loggingConnector of this._loggingConnectors) {
-            // eslint-disable-next-line @typescript-eslint/unbound-method
-            if (Is.function(loggingConnector.query)) {
-                return loggingConnector.query(conditions, sortProperties, properties, cursor, limit);
-            }
-        }
-        return {
-            entities: []
-        };
-    }
-}
-
-/**
- * Class for performing logging operations to nowhere.
- */
-class SilentLoggingConnector {
-    /**
-     * The namespace for the logging connector.
-     */
-    static NAMESPACE = "silent";
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "SilentLoggingConnector";
-    /**
-     * Log an entry to the connector.
-     * @param logEntry The entry to log.
-     * @returns Nothing.
-     */
-    async log(logEntry) { }
-    /**
-     * Query the log entries.
-     * @param conditions The conditions to match for the entities.
-     * @param sortProperties The optional sort order.
-     * @param properties The optional keys to return, defaults to all.
-     * @param cursor The cursor to request the next chunk of entities.
-     * @param limit Limit the number of entities to return.
-     * @returns All the entities for the storage matching the conditions,
-     * and a cursor which can be used to request more entities.
-     */
-    async query(conditions, sortProperties, properties, cursor, limit) {
-        return {
-            entities: []
-        };
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Helper class for log entry operations.
- */
-class LogEntryHelper {
-    /**
-     * Translate the log entry.
-     * @param logEntry The log entry.
-     * @returns The translated log entry if a translation can be found.
-     */
-    static translate(logEntry) {
-        if (Is.stringValue(logEntry.level) && Is.stringValue(logEntry.source)) {
-            const sourceMessage = `${logEntry.level}.${StringHelper.camelCase(logEntry.source)}.${logEntry.message}`;
-            if (I18n.hasMessage(sourceMessage)) {
-                return I18n.formatMessage(sourceMessage, logEntry.data);
-            }
-        }
-        if (Is.stringValue(logEntry.source)) {
-            const sourceMessage = `${StringHelper.camelCase(logEntry.source)}.${logEntry.message}`;
-            if (I18n.hasMessage(sourceMessage)) {
-                return I18n.formatMessage(sourceMessage, logEntry.data);
-            }
-        }
-        if (I18n.hasMessage(logEntry.message)) {
-            return I18n.formatMessage(logEntry.message, logEntry.data);
-        }
-    }
-}
-
-export { LogEntryHelper, LoggingConnectorFactory, MultiLoggingConnector, SilentLoggingConnector };