@twin.org/logging-models 0.0.1-next.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN Logging Models
+
+Models which define the structure of the logging contracts and connectors.
+
+## Installation
+
+```shell
+npm install @twin.org/logging-models
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/dist/cjs/index.cjs

@@ -0,0 +1,159 @@
+'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.
+     */
+    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.
+     * @param options.loggingConnectorTypes The logging connectors to multiplex.
+     * @param options.config The configuration for the logging connector.
+     */
+    constructor(options) {
+        core.Guards.object(this.CLASS_NAME, "options", options);
+        core.Guards.arrayValue(this.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(this.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 page of entities.
+     * @param pageSize The maximum number of entities in a page.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     * @throws NotImplementedError if the implementation does not support retrieval.
+     */
+    async query(conditions, sortProperties, properties, cursor, pageSize) {
+        // 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) {
+            try {
+                const result = await loggingConnector.query(conditions, sortProperties, properties, cursor, pageSize);
+                return result;
+            }
+            catch (error) {
+                if (!core.BaseError.isErrorName(error, core.NotImplementedError.CLASS_NAME)) {
+                    throw error;
+                }
+            }
+        }
+        throw new core.NotImplementedError(this.CLASS_NAME, "query");
+    }
+}
+
+/**
+ * Class for performing logging operations to nowhere.
+ */
+class SilentLoggingConnector {
+    /**
+     * The namespace for the logging connector.
+     */
+    static NAMESPACE = "silent";
+    /**
+     * Runtime name for the class.
+     */
+    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 page of entities.
+     * @param pageSize The maximum number of entities in a page.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     * @throws NotImplementedError if the implementation does not support retrieval.
+     */
+    async query(conditions, sortProperties, properties, cursor, pageSize) {
+        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

@@ -0,0 +1,154 @@
+import { Factory, Guards, BaseError, NotImplementedError, 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.
+     */
+    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.
+     * @param options.loggingConnectorTypes The logging connectors to multiplex.
+     * @param options.config The configuration for the logging connector.
+     */
+    constructor(options) {
+        Guards.object(this.CLASS_NAME, "options", options);
+        Guards.arrayValue(this.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(this.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 page of entities.
+     * @param pageSize The maximum number of entities in a page.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     * @throws NotImplementedError if the implementation does not support retrieval.
+     */
+    async query(conditions, sortProperties, properties, cursor, pageSize) {
+        // 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) {
+            try {
+                const result = await loggingConnector.query(conditions, sortProperties, properties, cursor, pageSize);
+                return result;
+            }
+            catch (error) {
+                if (!BaseError.isErrorName(error, NotImplementedError.CLASS_NAME)) {
+                    throw error;
+                }
+            }
+        }
+        throw new NotImplementedError(this.CLASS_NAME, "query");
+    }
+}
+
+/**
+ * Class for performing logging operations to nowhere.
+ */
+class SilentLoggingConnector {
+    /**
+     * The namespace for the logging connector.
+     */
+    static NAMESPACE = "silent";
+    /**
+     * Runtime name for the class.
+     */
+    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 page of entities.
+     * @param pageSize The maximum number of entities in a page.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     * @throws NotImplementedError if the implementation does not support retrieval.
+     */
+    async query(conditions, sortProperties, properties, cursor, pageSize) {
+        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 };

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

@@ -0,0 +1,57 @@
+import type { EntityCondition, SortDirection } from "@twin.org/entity";
+import type { ILogEntry } from "../models/ILogEntry";
+import type { ILoggingConnector } from "../models/ILoggingConnector";
+import type { ILoggingLevelsConfig } from "../models/ILoggingLevelsConfig";
+/**
+ * Class for performing logging operations on multiple connectors.
+ */
+export declare class MultiLoggingConnector implements ILoggingConnector {
+    /**
+     * The namespace for the logging connector.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of MultiLoggingConnector.
+     * @param options The options for the connector.
+     * @param options.loggingConnectorTypes The logging connectors to multiplex.
+     * @param options.config The configuration for the logging connector.
+     */
+    constructor(options: {
+        loggingConnectorTypes: string[];
+        config?: ILoggingLevelsConfig | undefined;
+    });
+    /**
+     * Log an entry to the connector.
+     * @param logEntry The entry to log.
+     * @returns Nothing.
+     */
+    log(logEntry: ILogEntry): Promise<void>;
+    /**
+     * 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 page of entities.
+     * @param pageSize The maximum number of entities in a page.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     * @throws NotImplementedError if the implementation does not support retrieval.
+     */
+    query(conditions?: EntityCondition<ILogEntry>, sortProperties?: {
+        property: keyof Omit<ILogEntry, "error" | "data">;
+        sortDirection: SortDirection;
+    }[], properties?: (keyof ILogEntry)[], cursor?: string, pageSize?: number): Promise<{
+        /**
+         * The entities, which can be partial if a limited keys list was provided.
+         */
+        entities: Partial<ILogEntry>[];
+        /**
+         * An optional cursor, when defined can be used to call find to get more entities.
+         */
+        cursor?: string;
+    }>;
+}

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

@@ -0,0 +1,46 @@
+import type { EntityCondition, SortDirection } from "@twin.org/entity";
+import type { ILogEntry } from "../models/ILogEntry";
+import type { ILoggingConnector } from "../models/ILoggingConnector";
+/**
+ * Class for performing logging operations to nowhere.
+ */
+export declare class SilentLoggingConnector implements ILoggingConnector {
+    /**
+     * The namespace for the logging connector.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Log an entry to the connector.
+     * @param logEntry The entry to log.
+     * @returns Nothing.
+     */
+    log(logEntry: ILogEntry): Promise<void>;
+    /**
+     * 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 page of entities.
+     * @param pageSize The maximum number of entities in a page.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     * @throws NotImplementedError if the implementation does not support retrieval.
+     */
+    query(conditions?: EntityCondition<ILogEntry>, sortProperties?: {
+        property: keyof Omit<ILogEntry, "error" | "data">;
+        sortDirection: SortDirection;
+    }[], properties?: (keyof ILogEntry)[], cursor?: string, pageSize?: number): Promise<{
+        /**
+         * The entities, which can be partial if a limited keys list was provided.
+         */
+        entities: Partial<ILogEntry>[];
+        /**
+         * An optional cursor, when defined can be used to call find to get more entities.
+         */
+        cursor?: string;
+    }>;
+}

package/dist/types/factories/loggingConnectorFactory.d.ts

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { ILoggingConnector } from "../models/ILoggingConnector";
+/**
+ * Factory for creating logging connectors.
+ */
+export declare const LoggingConnectorFactory: Factory<ILoggingConnector>;

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

@@ -0,0 +1,12 @@
+import type { ILogEntry } from "../models/ILogEntry";
+/**
+ * Helper class for log entry operations.
+ */
+export declare 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: ILogEntry): string | undefined;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,12 @@
+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/logLevel";