@twin.org/logging-connector-file 0.9.1-next.5

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,23 @@
+# TWIN Logging Connector File
+
+File connector for persisting TWIN log events to size-limited files on disk with rotation and retention.
+
+Entries are written as newline delimited JSON through a persistent file handle. The connector assumes a single writer per file: one owner (process) should be responsible for a given log file, as it does not coordinate rotation across separate processes.
+
+## Installation
+
+```shell
+npm install @twin.org/logging-connector-file
+```
+
+## 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/es/fileLoggingConnector.js

@@ -0,0 +1,321 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { mkdir, open, rename, rm, stat } from "node:fs/promises";
+import path from "node:path";
+import { BaseError, Coerce, GeneralError, Guards, Is, Mutex } from "@twin.org/core";
+import { LogLevel } from "@twin.org/logging-models";
+/**
+ * Class for performing logging operations to size-limited files on disk.
+ *
+ * Entries are appended to an active file as newline delimited JSON through a file handle
+ * that is opened once and kept open, avoiding an open and close on every write. Each entry
+ * is written straight through to the file so it is durable as soon as log() resolves.
+ * When the active file would exceed the configured size limit it is rotated: the active
+ * file becomes the newest numbered file and any file beyond the retained file limit is
+ * removed, keeping total on-disk usage predictable.
+ *
+ * The connector assumes a single writer per file: one instance should own a given log file.
+ * Its own writes and rotations are serialised with a mutex, but it does not coordinate with
+ * other processes or external tools rotating the same file.
+ */
+export class FileLoggingConnector {
+    /**
+     * The namespace for the logging connector.
+     */
+    static NAMESPACE = "file";
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "FileLoggingConnector";
+    /**
+     * Default name for the active log file.
+     */
+    static DEFAULT_FILENAME = "app.log";
+    /**
+     * Default maximum size in bytes of the active log file before rotation (10 MB).
+     */
+    static DEFAULT_MAX_FILE_SIZE_BYTES = 10 * 1024 * 1024;
+    /**
+     * Minimum size in bytes that can be configured for the active log file before rotation (100 KB).
+     */
+    static MIN_MAX_FILE_SIZE_BYTES = 100 * 1024;
+    /**
+     * Default number of rotated log files to retain.
+     */
+    static DEFAULT_MAX_RETAINED_FILES = 5;
+    /**
+     * The log levels to capture, will default to all.
+     * @internal
+     */
+    _levels;
+    /**
+     * The directory the log files are written to.
+     * @internal
+     */
+    _directory;
+    /**
+     * The name of the active log file.
+     * @internal
+     */
+    _filename;
+    /**
+     * Rotate the active file when it reaches this size in bytes; 0 disables size rotation.
+     * @internal
+     */
+    _maxFileSizeBytes;
+    /**
+     * Number of rotated files to retain; 0 retains none.
+     * @internal
+     */
+    _maxRetainedFiles;
+    /**
+     * Timeout in milliseconds passed to Mutex.lock calls.
+     * @internal
+     */
+    _mutexTimeoutMs;
+    /**
+     * Key used to serialize concurrent writes and rotations via Mutex, the resolved active path.
+     * @internal
+     */
+    _mutexKey;
+    /**
+     * The tracked size in bytes of the active file, avoiding a stat on every write.
+     * @internal
+     */
+    _currentSize;
+    /**
+     * The open handle for the active file, present only while the connector is open.
+     * @internal
+     */
+    _handle;
+    /**
+     * Create a new instance of FileLoggingConnector.
+     * @param options The options for the logging connector.
+     * @throws GeneralError if maxFileSizeBytes is a positive value below the minimum.
+     */
+    constructor(options) {
+        Guards.object(FileLoggingConnector.CLASS_NAME, "options", options);
+        Guards.object(FileLoggingConnector.CLASS_NAME, "options.config", options.config);
+        Guards.stringValue(FileLoggingConnector.CLASS_NAME, "options.config.directory", options.config.directory);
+        this._levels = options.config.levels ?? Object.values(LogLevel);
+        this._directory = options.config.directory;
+        this._filename = Is.stringValue(options.config.filename)
+            ? options.config.filename
+            : FileLoggingConnector.DEFAULT_FILENAME;
+        const cfgMaxFileSizeBytes = Coerce.integer(options.config.maxFileSizeBytes) ??
+            FileLoggingConnector.DEFAULT_MAX_FILE_SIZE_BYTES;
+        if (cfgMaxFileSizeBytes > 0 &&
+            cfgMaxFileSizeBytes < FileLoggingConnector.MIN_MAX_FILE_SIZE_BYTES) {
+            throw new GeneralError(FileLoggingConnector.CLASS_NAME, "maxFileSizeTooSmall", {
+                maxFileSizeBytes: cfgMaxFileSizeBytes,
+                minimum: FileLoggingConnector.MIN_MAX_FILE_SIZE_BYTES
+            });
+        }
+        this._maxFileSizeBytes = cfgMaxFileSizeBytes <= 0 ? 0 : cfgMaxFileSizeBytes;
+        const cfgMaxRetainedFiles = Coerce.integer(options.config.maxRetainedFiles) ??
+            FileLoggingConnector.DEFAULT_MAX_RETAINED_FILES;
+        this._maxRetainedFiles = cfgMaxRetainedFiles > 0 ? cfgMaxRetainedFiles : 0;
+        this._mutexTimeoutMs = Coerce.integer(options.config.mutexTimeoutMs);
+        this._mutexKey = path.resolve(this._directory, this._filename);
+        this._currentSize = 0;
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return FileLoggingConnector.CLASS_NAME;
+    }
+    /**
+     * Start the connector; ensures the target directory exists and opens the file handle.
+     * @returns A promise that resolves when the connector is ready to accept log entries.
+     */
+    async start() {
+        const locked = await Mutex.lock(this._mutexKey, {
+            throwOnTimeout: true,
+            timeoutMs: this._mutexTimeoutMs
+        });
+        if (locked) {
+            try {
+                await this.ensureOpen();
+            }
+            finally {
+                Mutex.unlock(this._mutexKey);
+            }
+        }
+    }
+    /**
+     * Stop the connector; closes the file handle, releasing the descriptor.
+     * Calling stop() on a connector that has not been opened is a no-op.
+     * @returns A promise that resolves when the handle has been closed.
+     */
+    async stop() {
+        const locked = await Mutex.lock(this._mutexKey, {
+            throwOnTimeout: true,
+            timeoutMs: this._mutexTimeoutMs
+        });
+        if (locked) {
+            try {
+                await this.closeHandle();
+            }
+            finally {
+                Mutex.unlock(this._mutexKey);
+            }
+        }
+    }
+    /**
+     * Log an entry to the connector.
+     * The entry is appended to the active file as a single newline delimited JSON record;
+     * when the active file exceeds the configured size limit it is rotated first.
+     * @param logEntry The entry to log.
+     * @returns A promise that resolves when the entry has been written to disk.
+     */
+    async log(logEntry) {
+        Guards.object(FileLoggingConnector.CLASS_NAME, "logEntry", logEntry);
+        if (!this._levels.includes(logEntry.level)) {
+            return;
+        }
+        const line = `${JSON.stringify(this.toRecord(logEntry))}\n`;
+        const lineBytes = Buffer.byteLength(line, "utf8");
+        const locked = await Mutex.lock(this._mutexKey, {
+            throwOnTimeout: true,
+            timeoutMs: this._mutexTimeoutMs
+        });
+        if (locked) {
+            try {
+                await this.ensureOpen();
+                if (this._maxFileSizeBytes > 0 &&
+                    this._currentSize > 0 &&
+                    this._currentSize + lineBytes > this._maxFileSizeBytes) {
+                    await this.rotate();
+                }
+                // Read after any rotation, which reopens the handle for the fresh active file.
+                const handle = this._handle;
+                if (!Is.empty(handle)) {
+                    await handle.write(line, null, "utf8");
+                    this._currentSize += lineBytes;
+                }
+            }
+            finally {
+                Mutex.unlock(this._mutexKey);
+            }
+        }
+    }
+    /**
+     * Build the plain record written to disk from a log entry, defaulting the timestamp to the
+     * current time as an ISO string and flattening any error into a serialisable form.
+     * @param logEntry The entry being logged.
+     * @returns The record to serialise as a single JSON line.
+     * @internal
+     */
+    toRecord(logEntry) {
+        return {
+            level: logEntry.level,
+            source: logEntry.source,
+            timestamp: new Date(logEntry.ts ?? Date.now()).toISOString(),
+            message: logEntry.message,
+            data: logEntry.data,
+            error: Is.object(logEntry.error) ? BaseError.flatten(logEntry.error) : undefined
+        };
+    }
+    /**
+     * Ensure the target directory exists, the tracked size matches the active file on disk and
+     * the file handle is open.
+     * @returns A promise that resolves once the handle is open.
+     * @internal
+     */
+    async ensureOpen() {
+        if (Is.empty(this._handle)) {
+            await mkdir(this._directory, { recursive: true });
+            this._currentSize = await this.fileSize(this.activePath());
+            this._handle = await open(this.activePath(), "a");
+        }
+    }
+    /**
+     * Close the active file handle if it is open.
+     * @returns A promise that resolves once the handle has been closed.
+     * @internal
+     */
+    async closeHandle() {
+        const handle = this._handle;
+        if (!Is.empty(handle)) {
+            this._handle = undefined;
+            await handle.close();
+        }
+    }
+    /**
+     * Rotate the active file by closing the handle, shifting the numbered files up, discarding
+     * any beyond the retained file limit, then reopening a fresh active file. When no rotated
+     * files are retained the active file is removed.
+     * @returns A promise that resolves once rotation has completed.
+     * @internal
+     */
+    async rotate() {
+        await this.closeHandle();
+        const active = this.activePath();
+        if (this._maxRetainedFiles <= 0) {
+            await rm(active, { force: true });
+        }
+        else {
+            await rm(this.rotatedPath(this._maxRetainedFiles), { force: true });
+            for (let index = this._maxRetainedFiles - 1; index >= 1; index--) {
+                const from = this.rotatedPath(index);
+                if (await this.fileExists(from)) {
+                    await rename(from, this.rotatedPath(index + 1));
+                }
+            }
+            await rename(active, this.rotatedPath(1));
+        }
+        await this.ensureOpen();
+        this._currentSize = 0;
+    }
+    /**
+     * The path to the active log file.
+     * @returns The path to the active file.
+     * @internal
+     */
+    activePath() {
+        return path.join(this._directory, this._filename);
+    }
+    /**
+     * The path to a numbered rotated log file.
+     * @param index The rotation index.
+     * @returns The path to the rotated file, inserting the index before the file extension.
+     * @internal
+     */
+    rotatedPath(index) {
+        const parsed = path.parse(this._filename);
+        return path.join(this._directory, `${parsed.name}.${index}${parsed.ext}`);
+    }
+    /**
+     * Get the size in bytes of a file, returning 0 when it does not exist.
+     * @param filePath The path to the file.
+     * @returns The size of the file in bytes, or 0 if it does not exist.
+     * @internal
+     */
+    async fileSize(filePath) {
+        try {
+            const stats = await stat(filePath);
+            return stats.size;
+        }
+        catch {
+            return 0;
+        }
+    }
+    /**
+     * Determine whether a file exists.
+     * @param filePath The path to the file.
+     * @returns True if the file exists.
+     * @internal
+     */
+    async fileExists(filePath) {
+        try {
+            await stat(filePath);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+}
+//# sourceMappingURL=fileLoggingConnector.js.map

package/dist/es/fileLoggingConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileLoggingConnector.js","sourceRoot":"","sources":["../../src/fileLoggingConnector.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAmB,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAClF,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAe,EAAE,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACjG,OAAO,EAA0C,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAI5F;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,oBAAoB;IAChC;;OAEG;IACI,MAAM,CAAU,SAAS,GAAW,MAAM,CAAC;IAElD;;OAEG;IACI,MAAM,CAAU,UAAU,0BAA0C;IAE3E;;OAEG;IACI,MAAM,CAAU,gBAAgB,GAAW,SAAS,CAAC;IAE5D;;OAEG;IACI,MAAM,CAAU,2BAA2B,GAAW,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;IAE9E;;OAEG;IACI,MAAM,CAAU,uBAAuB,GAAW,GAAG,GAAG,IAAI,CAAC;IAEpE;;OAEG;IACI,MAAM,CAAU,0BAA0B,GAAW,CAAC,CAAC;IAE9D;;;OAGG;IACc,OAAO,CAAa;IAErC;;;OAGG;IACc,UAAU,CAAS;IAEpC;;;OAGG;IACc,SAAS,CAAS;IAEnC;;;OAGG;IACc,iBAAiB,CAAS;IAE3C;;;OAGG;IACc,iBAAiB,CAAS;IAE3C;;;OAGG;IACc,eAAe,CAAU;IAE1C;;;OAGG;IACc,SAAS,CAAS;IAEnC;;;OAGG;IACK,YAAY,CAAS;IAE7B;;;OAGG;IACK,OAAO,CAAc;IAE7B;;;;OAIG;IACH,YAAY,OAAgD;QAC3D,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QACzE,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,UAAU,oBAA0B,OAAO,CAAC,MAAM,CAAC,CAAC;QACvF,MAAM,CAAC,WAAW,CACjB,oBAAoB,CAAC,UAAU,8BAE/B,OAAO,CAAC,MAAM,CAAC,SAAS,CACxB,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChE,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;YACvD,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ;YACzB,CAAC,CAAC,oBAAoB,CAAC,gBAAgB,CAAC;QAEzC,MAAM,mBAAmB,GACxB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;YAC/C,oBAAoB,CAAC,2BAA2B,CAAC;QAClD,IACC,mBAAmB,GAAG,CAAC;YACvB,mBAAmB,GAAG,oBAAoB,CAAC,uBAAuB,EACjE,CAAC;YACF,MAAM,IAAI,YAAY,CAAC,oBAAoB,CAAC,UAAU,EAAE,qBAAqB,EAAE;gBAC9E,gBAAgB,EAAE,mBAAmB;gBACrC,OAAO,EAAE,oBAAoB,CAAC,uBAAuB;aACrD,CAAC,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,iBAAiB,GAAG,mBAAmB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC;QAE5E,MAAM,mBAAmB,GACxB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;YAC/C,oBAAoB,CAAC,0BAA0B,CAAC;QACjD,IAAI,CAAC,iBAAiB,GAAG,mBAAmB,GAAG,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3E,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QACrE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/D,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;IACvB,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,oBAAoB,CAAC,UAAU,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,KAAK;QACjB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YAC/C,cAAc,EAAE,IAAI;YACpB,SAAS,EAAE,IAAI,CAAC,eAAe;SAC/B,CAAC,CAAC;QACH,IAAI,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC;gBACJ,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;YACzB,CAAC;oBAAS,CAAC;gBACV,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9B,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI;QAChB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YAC/C,cAAc,EAAE,IAAI;YACpB,SAAS,EAAE,IAAI,CAAC,eAAe;SAC/B,CAAC,CAAC;QACH,IAAI,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC;gBACJ,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1B,CAAC;oBAAS,CAAC;gBACV,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9B,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CAAC,QAAmB;QACnC,MAAM,CAAC,MAAM,CAAY,oBAAoB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAEtF,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5C,OAAO;QACR,CAAC;QAED,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;QAC5D,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YAC/C,cAAc,EAAE,IAAI;YACpB,SAAS,EAAE,IAAI,CAAC,eAAe;SAC/B,CAAC,CAAC;QACH,IAAI,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC;gBACJ,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;gBAExB,IACC,IAAI,CAAC,iBAAiB,GAAG,CAAC;oBAC1B,IAAI,CAAC,YAAY,GAAG,CAAC;oBACrB,IAAI,CAAC,YAAY,GAAG,SAAS,GAAG,IAAI,CAAC,iBAAiB,EACrD,CAAC;oBACF,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;gBACrB,CAAC;gBAED,+EAA+E;gBAC/E,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;gBAC5B,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;oBACvB,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;oBACvC,IAAI,CAAC,YAAY,IAAI,SAAS,CAAC;gBAChC,CAAC;YACF,CAAC;oBAAS,CAAC;gBACV,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9B,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACK,QAAQ,CAAC,QAAmB;QACnC,OAAO;YACN,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,SAAS,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE;YAC5D,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,KAAK,EAAE,EAAE,CAAC,MAAM,CAAS,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;SACxF,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,UAAU;QACvB,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,MAAM,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAClD,IAAI,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;YAC3D,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,GAAG,CAAC,CAAC;QACnD,CAAC;IACF,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,WAAW;QACxB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;YACzB,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACtB,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,MAAM;QACnB,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAEjC,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,EAAE,CAAC;YACjC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACnC,CAAC;aAAM,CAAC;YACP,MAAM,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YAEpE,KAAK,IAAI,KAAK,GAAG,IAAI,CAAC,iBAAiB,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;gBAClE,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;gBACrC,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBACjC,MAAM,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;gBACjD,CAAC;YACF,CAAC;YAED,MAAM,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,CAAC;QAED,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACK,UAAU;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACK,WAAW,CAAC,KAAa;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,MAAM,CAAC,IAAI,IAAI,KAAK,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,QAAQ,CAAC,QAAgB;QACtC,IAAI,CAAC;YACJ,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnC,OAAO,KAAK,CAAC,IAAI,CAAC;QACnB,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,CAAC,CAAC;QACV,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,UAAU,CAAC,QAAgB;QACxC,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;YACrB,OAAO,IAAI,CAAC;QACb,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { type FileHandle, mkdir, open, rename, rm, stat } from \"node:fs/promises\";\nimport path from \"node:path\";\nimport { BaseError, Coerce, GeneralError, Guards, type IError, Is, Mutex } from \"@twin.org/core\";\nimport { type ILogEntry, type ILoggingConnector, LogLevel } from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IFileLoggingConnectorConstructorOptions } from \"./models/IFileLoggingConnectorConstructorOptions.js\";\n\n/**\n * Class for performing logging operations to size-limited files on disk.\n *\n * Entries are appended to an active file as newline delimited JSON through a file handle\n * that is opened once and kept open, avoiding an open and close on every write. Each entry\n * is written straight through to the file so it is durable as soon as log() resolves.\n * When the active file would exceed the configured size limit it is rotated: the active\n * file becomes the newest numbered file and any file beyond the retained file limit is\n * removed, keeping total on-disk usage predictable.\n *\n * The connector assumes a single writer per file: one instance should own a given log file.\n * Its own writes and rotations are serialised with a mutex, but it does not coordinate with\n * other processes or external tools rotating the same file.\n */\nexport class FileLoggingConnector implements ILoggingConnector {\n\t/**\n\t * The namespace for the logging connector.\n\t */\n\tpublic static readonly NAMESPACE: string = \"file\";\n\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<FileLoggingConnector>();\n\n\t/**\n\t * Default name for the active log file.\n\t */\n\tpublic static readonly DEFAULT_FILENAME: string = \"app.log\";\n\n\t/**\n\t * Default maximum size in bytes of the active log file before rotation (10 MB).\n\t */\n\tpublic static readonly DEFAULT_MAX_FILE_SIZE_BYTES: number = 10 * 1024 * 1024;\n\n\t/**\n\t * Minimum size in bytes that can be configured for the active log file before rotation (100 KB).\n\t */\n\tpublic static readonly MIN_MAX_FILE_SIZE_BYTES: number = 100 * 1024;\n\n\t/**\n\t * Default number of rotated log files to retain.\n\t */\n\tpublic static readonly DEFAULT_MAX_RETAINED_FILES: number = 5;\n\n\t/**\n\t * The log levels to capture, will default to all.\n\t * @internal\n\t */\n\tprivate readonly _levels: LogLevel[];\n\n\t/**\n\t * The directory the log files are written to.\n\t * @internal\n\t */\n\tprivate readonly _directory: string;\n\n\t/**\n\t * The name of the active log file.\n\t * @internal\n\t */\n\tprivate readonly _filename: string;\n\n\t/**\n\t * Rotate the active file when it reaches this size in bytes; 0 disables size rotation.\n\t * @internal\n\t */\n\tprivate readonly _maxFileSizeBytes: number;\n\n\t/**\n\t * Number of rotated files to retain; 0 retains none.\n\t * @internal\n\t */\n\tprivate readonly _maxRetainedFiles: number;\n\n\t/**\n\t * Timeout in milliseconds passed to Mutex.lock calls.\n\t * @internal\n\t */\n\tprivate readonly _mutexTimeoutMs?: number;\n\n\t/**\n\t * Key used to serialize concurrent writes and rotations via Mutex, the resolved active path.\n\t * @internal\n\t */\n\tprivate readonly _mutexKey: string;\n\n\t/**\n\t * The tracked size in bytes of the active file, avoiding a stat on every write.\n\t * @internal\n\t */\n\tprivate _currentSize: number;\n\n\t/**\n\t * The open handle for the active file, present only while the connector is open.\n\t * @internal\n\t */\n\tprivate _handle?: FileHandle;\n\n\t/**\n\t * Create a new instance of FileLoggingConnector.\n\t * @param options The options for the logging connector.\n\t * @throws GeneralError if maxFileSizeBytes is a positive value below the minimum.\n\t */\n\tconstructor(options: IFileLoggingConnectorConstructorOptions) {\n\t\tGuards.object(FileLoggingConnector.CLASS_NAME, nameof(options), options);\n\t\tGuards.object(FileLoggingConnector.CLASS_NAME, nameof(options.config), options.config);\n\t\tGuards.stringValue(\n\t\t\tFileLoggingConnector.CLASS_NAME,\n\t\t\tnameof(options.config.directory),\n\t\t\toptions.config.directory\n\t\t);\n\n\t\tthis._levels = options.config.levels ?? Object.values(LogLevel);\n\t\tthis._directory = options.config.directory;\n\t\tthis._filename = Is.stringValue(options.config.filename)\n\t\t\t? options.config.filename\n\t\t\t: FileLoggingConnector.DEFAULT_FILENAME;\n\n\t\tconst cfgMaxFileSizeBytes =\n\t\t\tCoerce.integer(options.config.maxFileSizeBytes) ??\n\t\t\tFileLoggingConnector.DEFAULT_MAX_FILE_SIZE_BYTES;\n\t\tif (\n\t\t\tcfgMaxFileSizeBytes > 0 &&\n\t\t\tcfgMaxFileSizeBytes < FileLoggingConnector.MIN_MAX_FILE_SIZE_BYTES\n\t\t) {\n\t\t\tthrow new GeneralError(FileLoggingConnector.CLASS_NAME, \"maxFileSizeTooSmall\", {\n\t\t\t\tmaxFileSizeBytes: cfgMaxFileSizeBytes,\n\t\t\t\tminimum: FileLoggingConnector.MIN_MAX_FILE_SIZE_BYTES\n\t\t\t});\n\t\t}\n\t\tthis._maxFileSizeBytes = cfgMaxFileSizeBytes <= 0 ? 0 : cfgMaxFileSizeBytes;\n\n\t\tconst cfgMaxRetainedFiles =\n\t\t\tCoerce.integer(options.config.maxRetainedFiles) ??\n\t\t\tFileLoggingConnector.DEFAULT_MAX_RETAINED_FILES;\n\t\tthis._maxRetainedFiles = cfgMaxRetainedFiles > 0 ? cfgMaxRetainedFiles : 0;\n\n\t\tthis._mutexTimeoutMs = Coerce.integer(options.config.mutexTimeoutMs);\n\t\tthis._mutexKey = path.resolve(this._directory, this._filename);\n\t\tthis._currentSize = 0;\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 FileLoggingConnector.CLASS_NAME;\n\t}\n\n\t/**\n\t * Start the connector; ensures the target directory exists and opens the file handle.\n\t * @returns A promise that resolves when the connector is ready to accept log entries.\n\t */\n\tpublic async start(): Promise<void> {\n\t\tconst locked = await Mutex.lock(this._mutexKey, {\n\t\t\tthrowOnTimeout: true,\n\t\t\ttimeoutMs: this._mutexTimeoutMs\n\t\t});\n\t\tif (locked) {\n\t\t\ttry {\n\t\t\t\tawait this.ensureOpen();\n\t\t\t} finally {\n\t\t\t\tMutex.unlock(this._mutexKey);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Stop the connector; closes the file handle, releasing the descriptor.\n\t * Calling stop() on a connector that has not been opened is a no-op.\n\t * @returns A promise that resolves when the handle has been closed.\n\t */\n\tpublic async stop(): Promise<void> {\n\t\tconst locked = await Mutex.lock(this._mutexKey, {\n\t\t\tthrowOnTimeout: true,\n\t\t\ttimeoutMs: this._mutexTimeoutMs\n\t\t});\n\t\tif (locked) {\n\t\t\ttry {\n\t\t\t\tawait this.closeHandle();\n\t\t\t} finally {\n\t\t\t\tMutex.unlock(this._mutexKey);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Log an entry to the connector.\n\t * The entry is appended to the active file as a single newline delimited JSON record;\n\t * when the active file exceeds the configured size limit it is rotated first.\n\t * @param logEntry The entry to log.\n\t * @returns A promise that resolves when the entry has been written to disk.\n\t */\n\tpublic async log(logEntry: ILogEntry): Promise<void> {\n\t\tGuards.object<ILogEntry>(FileLoggingConnector.CLASS_NAME, nameof(logEntry), logEntry);\n\n\t\tif (!this._levels.includes(logEntry.level)) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst line = `${JSON.stringify(this.toRecord(logEntry))}\\n`;\n\t\tconst lineBytes = Buffer.byteLength(line, \"utf8\");\n\n\t\tconst locked = await Mutex.lock(this._mutexKey, {\n\t\t\tthrowOnTimeout: true,\n\t\t\ttimeoutMs: this._mutexTimeoutMs\n\t\t});\n\t\tif (locked) {\n\t\t\ttry {\n\t\t\t\tawait this.ensureOpen();\n\n\t\t\t\tif (\n\t\t\t\t\tthis._maxFileSizeBytes > 0 &&\n\t\t\t\t\tthis._currentSize > 0 &&\n\t\t\t\t\tthis._currentSize + lineBytes > this._maxFileSizeBytes\n\t\t\t\t) {\n\t\t\t\t\tawait this.rotate();\n\t\t\t\t}\n\n\t\t\t\t// Read after any rotation, which reopens the handle for the fresh active file.\n\t\t\t\tconst handle = this._handle;\n\t\t\t\tif (!Is.empty(handle)) {\n\t\t\t\t\tawait handle.write(line, null, \"utf8\");\n\t\t\t\t\tthis._currentSize += lineBytes;\n\t\t\t\t}\n\t\t\t} finally {\n\t\t\t\tMutex.unlock(this._mutexKey);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Build the plain record written to disk from a log entry, defaulting the timestamp to the\n\t * current time as an ISO string and flattening any error into a serialisable form.\n\t * @param logEntry The entry being logged.\n\t * @returns The record to serialise as a single JSON line.\n\t * @internal\n\t */\n\tprivate toRecord(logEntry: ILogEntry): { [key: string]: unknown } {\n\t\treturn {\n\t\t\tlevel: logEntry.level,\n\t\t\tsource: logEntry.source,\n\t\t\ttimestamp: new Date(logEntry.ts ?? Date.now()).toISOString(),\n\t\t\tmessage: logEntry.message,\n\t\t\tdata: logEntry.data,\n\t\t\terror: Is.object<IError>(logEntry.error) ? BaseError.flatten(logEntry.error) : undefined\n\t\t};\n\t}\n\n\t/**\n\t * Ensure the target directory exists, the tracked size matches the active file on disk and\n\t * the file handle is open.\n\t * @returns A promise that resolves once the handle is open.\n\t * @internal\n\t */\n\tprivate async ensureOpen(): Promise<void> {\n\t\tif (Is.empty(this._handle)) {\n\t\t\tawait mkdir(this._directory, { recursive: true });\n\t\t\tthis._currentSize = await this.fileSize(this.activePath());\n\t\t\tthis._handle = await open(this.activePath(), \"a\");\n\t\t}\n\t}\n\n\t/**\n\t * Close the active file handle if it is open.\n\t * @returns A promise that resolves once the handle has been closed.\n\t * @internal\n\t */\n\tprivate async closeHandle(): Promise<void> {\n\t\tconst handle = this._handle;\n\t\tif (!Is.empty(handle)) {\n\t\t\tthis._handle = undefined;\n\t\t\tawait handle.close();\n\t\t}\n\t}\n\n\t/**\n\t * Rotate the active file by closing the handle, shifting the numbered files up, discarding\n\t * any beyond the retained file limit, then reopening a fresh active file. When no rotated\n\t * files are retained the active file is removed.\n\t * @returns A promise that resolves once rotation has completed.\n\t * @internal\n\t */\n\tprivate async rotate(): Promise<void> {\n\t\tawait this.closeHandle();\n\n\t\tconst active = this.activePath();\n\n\t\tif (this._maxRetainedFiles <= 0) {\n\t\t\tawait rm(active, { force: true });\n\t\t} else {\n\t\t\tawait rm(this.rotatedPath(this._maxRetainedFiles), { force: true });\n\n\t\t\tfor (let index = this._maxRetainedFiles - 1; index >= 1; index--) {\n\t\t\t\tconst from = this.rotatedPath(index);\n\t\t\t\tif (await this.fileExists(from)) {\n\t\t\t\t\tawait rename(from, this.rotatedPath(index + 1));\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tawait rename(active, this.rotatedPath(1));\n\t\t}\n\n\t\tawait this.ensureOpen();\n\t\tthis._currentSize = 0;\n\t}\n\n\t/**\n\t * The path to the active log file.\n\t * @returns The path to the active file.\n\t * @internal\n\t */\n\tprivate activePath(): string {\n\t\treturn path.join(this._directory, this._filename);\n\t}\n\n\t/**\n\t * The path to a numbered rotated log file.\n\t * @param index The rotation index.\n\t * @returns The path to the rotated file, inserting the index before the file extension.\n\t * @internal\n\t */\n\tprivate rotatedPath(index: number): string {\n\t\tconst parsed = path.parse(this._filename);\n\t\treturn path.join(this._directory, `${parsed.name}.${index}${parsed.ext}`);\n\t}\n\n\t/**\n\t * Get the size in bytes of a file, returning 0 when it does not exist.\n\t * @param filePath The path to the file.\n\t * @returns The size of the file in bytes, or 0 if it does not exist.\n\t * @internal\n\t */\n\tprivate async fileSize(filePath: string): Promise<number> {\n\t\ttry {\n\t\t\tconst stats = await stat(filePath);\n\t\t\treturn stats.size;\n\t\t} catch {\n\t\t\treturn 0;\n\t\t}\n\t}\n\n\t/**\n\t * Determine whether a file exists.\n\t * @param filePath The path to the file.\n\t * @returns True if the file exists.\n\t * @internal\n\t */\n\tprivate async fileExists(filePath: string): Promise<boolean> {\n\t\ttry {\n\t\t\tawait stat(filePath);\n\t\t\treturn true;\n\t\t} catch {\n\t\t\treturn false;\n\t\t}\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,6 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./fileLoggingConnector.js";
+export * from "./models/IFileLoggingConnectorConfig.js";
+export * from "./models/IFileLoggingConnectorConstructorOptions.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,2BAA2B,CAAC;AAC1C,cAAc,yCAAyC,CAAC;AACxD,cAAc,qDAAqD,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./fileLoggingConnector.js\";\nexport * from \"./models/IFileLoggingConnectorConfig.js\";\nexport * from \"./models/IFileLoggingConnectorConstructorOptions.js\";\n"]}

package/dist/es/models/IFileLoggingConnectorConfig.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IFileLoggingConnectorConfig.js","sourceRoot":"","sources":["../../../src/models/IFileLoggingConnectorConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ILoggingLevelsConfig } from \"@twin.org/logging-models\";\n\n/**\n * Configuration for the File Logging Connector.\n */\nexport interface IFileLoggingConnectorConfig extends ILoggingLevelsConfig {\n\t/**\n\t * The directory in which the log files are written, created if it does not exist.\n\t */\n\tdirectory: string;\n\n\t/**\n\t * The name of the active log file within the directory.\n\t * @default app.log\n\t */\n\tfilename?: string;\n\n\t/**\n\t * The maximum size in bytes the active log file can reach before it is rotated.\n\t * A value of 0 or less disables size based rotation, allowing the file to grow without bound.\n\t * A positive value below the minimum of 102400 (100 KB) throws on construction, to avoid\n\t * excessive rotation.\n\t * @default 10485760\n\t */\n\tmaxFileSizeBytes?: number;\n\n\t/**\n\t * The maximum number of rotated log files to retain alongside the active file.\n\t * When the limit is reached the oldest rotated file is removed.\n\t * A value of 0 or less retains no rotated files, the active file is discarded on rotation.\n\t * @default 5\n\t */\n\tmaxRetainedFiles?: number;\n\n\t/**\n\t * The timeout in milliseconds to wait when acquiring the write lock before a log call fails.\n\t * Defaults to the Mutex default when not set.\n\t */\n\tmutexTimeoutMs?: number;\n}\n"]}

package/dist/es/models/IFileLoggingConnectorConstructorOptions.js

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

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

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

package/dist/types/fileLoggingConnector.d.ts

@@ -0,0 +1,72 @@
+import { type ILogEntry, type ILoggingConnector } from "@twin.org/logging-models";
+import type { IFileLoggingConnectorConstructorOptions } from "./models/IFileLoggingConnectorConstructorOptions.js";
+/**
+ * Class for performing logging operations to size-limited files on disk.
+ *
+ * Entries are appended to an active file as newline delimited JSON through a file handle
+ * that is opened once and kept open, avoiding an open and close on every write. Each entry
+ * is written straight through to the file so it is durable as soon as log() resolves.
+ * When the active file would exceed the configured size limit it is rotated: the active
+ * file becomes the newest numbered file and any file beyond the retained file limit is
+ * removed, keeping total on-disk usage predictable.
+ *
+ * The connector assumes a single writer per file: one instance should own a given log file.
+ * Its own writes and rotations are serialised with a mutex, but it does not coordinate with
+ * other processes or external tools rotating the same file.
+ */
+export declare class FileLoggingConnector implements ILoggingConnector {
+    /**
+     * The namespace for the logging connector.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Default name for the active log file.
+     */
+    static readonly DEFAULT_FILENAME: string;
+    /**
+     * Default maximum size in bytes of the active log file before rotation (10 MB).
+     */
+    static readonly DEFAULT_MAX_FILE_SIZE_BYTES: number;
+    /**
+     * Minimum size in bytes that can be configured for the active log file before rotation (100 KB).
+     */
+    static readonly MIN_MAX_FILE_SIZE_BYTES: number;
+    /**
+     * Default number of rotated log files to retain.
+     */
+    static readonly DEFAULT_MAX_RETAINED_FILES: number;
+    /**
+     * Create a new instance of FileLoggingConnector.
+     * @param options The options for the logging connector.
+     * @throws GeneralError if maxFileSizeBytes is a positive value below the minimum.
+     */
+    constructor(options: IFileLoggingConnectorConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Start the connector; ensures the target directory exists and opens the file handle.
+     * @returns A promise that resolves when the connector is ready to accept log entries.
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the connector; closes the file handle, releasing the descriptor.
+     * Calling stop() on a connector that has not been opened is a no-op.
+     * @returns A promise that resolves when the handle has been closed.
+     */
+    stop(): Promise<void>;
+    /**
+     * Log an entry to the connector.
+     * The entry is appended to the active file as a single newline delimited JSON record;
+     * when the active file exceeds the configured size limit it is rotated first.
+     * @param logEntry The entry to log.
+     * @returns A promise that resolves when the entry has been written to disk.
+     */
+    log(logEntry: ILogEntry): Promise<void>;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./fileLoggingConnector.js";
+export * from "./models/IFileLoggingConnectorConfig.js";
+export * from "./models/IFileLoggingConnectorConstructorOptions.js";

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

@@ -0,0 +1,35 @@
+import type { ILoggingLevelsConfig } from "@twin.org/logging-models";
+/**
+ * Configuration for the File Logging Connector.
+ */
+export interface IFileLoggingConnectorConfig extends ILoggingLevelsConfig {
+    /**
+     * The directory in which the log files are written, created if it does not exist.
+     */
+    directory: string;
+    /**
+     * The name of the active log file within the directory.
+     * @default app.log
+     */
+    filename?: string;
+    /**
+     * The maximum size in bytes the active log file can reach before it is rotated.
+     * A value of 0 or less disables size based rotation, allowing the file to grow without bound.
+     * A positive value below the minimum of 102400 (100 KB) throws on construction, to avoid
+     * excessive rotation.
+     * @default 10485760
+     */
+    maxFileSizeBytes?: number;
+    /**
+     * The maximum number of rotated log files to retain alongside the active file.
+     * When the limit is reached the oldest rotated file is removed.
+     * A value of 0 or less retains no rotated files, the active file is discarded on rotation.
+     * @default 5
+     */
+    maxRetainedFiles?: number;
+    /**
+     * The timeout in milliseconds to wait when acquiring the write lock before a log call fails.
+     * Defaults to the Mutex default when not set.
+     */
+    mutexTimeoutMs?: number;
+}

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

@@ -0,0 +1,10 @@
+import type { IFileLoggingConnectorConfig } from "./IFileLoggingConnectorConfig.js";
+/**
+ * Options for the file logging connector constructor.
+ */
+export interface IFileLoggingConnectorConstructorOptions {
+    /**
+     * The configuration for the file logging connector.
+     */
+    config: IFileLoggingConnectorConfig;
+}

package/docs/changelog.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## [0.9.1-next.5](https://github.com/iotaledger/twin-logging/compare/logging-connector-file-v0.9.1-next.4...logging-connector-file-v0.9.1-next.5) (2026-07-20)
+
+
+### Features
+
+* add file logging connector with rotation and retention ([#67](https://github.com/iotaledger/twin-logging/issues/67)) ([d3ede7e](https://github.com/iotaledger/twin-logging/commit/d3ede7e7e12c765c4f8a3b5758252104ee0fe0d6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/logging-models bumped from 0.9.1-next.4 to 0.9.1-next.5
+
+## v0.9.1-next.0
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1,137 @@
+# Logging Connector File Examples
+
+These examples show how to persist TWIN log events to disk. The connector appends each
+entry to an active log file as newline delimited JSON (one JSON object per line), a format
+that is easy to inspect, grep, and ingest with external log collection agents.
+
+When the active file reaches the configured size limit it is rotated, and only a configured
+number of rotated files are retained, so total on-disk usage stays predictable. This
+connector persists entries but does not implement `query()`.
+
+The connector assumes a single writer per file: one instance should own a given log file. It
+does not coordinate with separate processes or external tools rotating the same file.
+
+## Basic Setup
+
+Pass a `directory` for the log files to the connector constructor. The directory is created
+if it does not already exist.
+
+```typescript
+import { FileLoggingConnector } from '@twin.org/logging-connector-file';
+
+const connector = new FileLoggingConnector({
+  config: {
+    directory: './logs',
+    filename: 'app.log',
+    maxFileSizeBytes: 10 * 1024 * 1024,
+    maxRetainedFiles: 5
+  }
+});
+
+// start() ensures the directory exists.
+await connector.start();
+```
+
+## Logging Entries
+
+```typescript
+await connector.log({
+  level: 'info',
+  source: 'api-server',
+  message: 'startupComplete',
+  data: {
+    port: 8080,
+    environment: 'production'
+  }
+});
+
+await connector.log({
+  level: 'error',
+  source: 'worker',
+  message: 'jobFailed',
+  error: {
+    name: 'GeneralError',
+    message: 'queue.itemFailed'
+  },
+  data: {
+    jobId: 'job-42',
+    retries: 3
+  }
+});
+```
+
+Each entry is written as a single line, for example:
+
+```text
+{"level":"info","source":"api-server","timestamp":"2023-11-14T22:13:20.000Z","message":"startupComplete","data":{"port":8080,"environment":"production"}}
+```
+
+The timestamp is populated automatically when not supplied, and an `error` is flattened
+into a serialisable array preserving the cause chain.
+
+## Shutting Down
+
+The connector keeps the log file open between writes. Call `stop()` during a graceful
+shutdown to close the file handle and release the descriptor. Entries are written straight
+through to the file, so there is nothing buffered to lose if `stop()` is not called.
+
+```typescript
+await connector.stop();
+```
+
+## Rotation and Retention
+
+The active file is always `<filename>`. When a write would take it past `maxFileSizeBytes`,
+the existing files are shifted up by one and a fresh active file is started:
+
+```text
+app.log    <- active file
+app.1.log  <- most recently rotated
+app.2.log
+...
+app.5.log  <- oldest retained (removed on the next rotation)
+```
+
+With `maxRetainedFiles` rotated files plus the active file, total on-disk usage is bounded
+to roughly `(maxRetainedFiles + 1) * maxFileSizeBytes`. A single entry is
+never split across files.
+
+Set `maxFileSizeBytes` to `0` to disable size based rotation, or `maxRetainedFiles` to `0` to
+keep no rotated files (the active file is discarded when it rotates). A positive
+`maxFileSizeBytes` below 100 KB throws on construction to avoid excessive rotation.
+
+## Filtering Levels
+
+Limit which levels are written with `levels`:
+
+```typescript
+const connector = new FileLoggingConnector({
+  config: {
+    directory: './logs',
+    levels: ['warn', 'error']
+  }
+});
+```
+
+## Composing with Other Connectors
+
+The file connector can be combined with other connectors through `MultiLoggingConnector`,
+for example to write to disk while also logging to the console:
+
+```typescript
+import { LoggingConnectorFactory, MultiLoggingConnector } from '@twin.org/logging-models';
+import { ConsoleLoggingConnector } from '@twin.org/logging-connector-console';
+import { FileLoggingConnector } from '@twin.org/logging-connector-file';
+
+LoggingConnectorFactory.register('console', () => new ConsoleLoggingConnector());
+LoggingConnectorFactory.register(
+  'file',
+  () => new FileLoggingConnector({ config: { directory: './logs' } })
+);
+
+const logging = new MultiLoggingConnector({
+  loggingConnectorTypes: ['console', 'file']
+});
+
+await logging.log({ level: 'info', source: 'api-server', message: 'ready' });
+```

package/docs/reference/classes/FileLoggingConnector.md

@@ -0,0 +1,173 @@
+# Class: FileLoggingConnector
+
+Class for performing logging operations to size-limited files on disk.
+
+Entries are appended to an active file as newline delimited JSON through a file handle
+that is opened once and kept open, avoiding an open and close on every write. Each entry
+is written straight through to the file so it is durable as soon as log() resolves.
+When the active file would exceed the configured size limit it is rotated: the active
+file becomes the newest numbered file and any file beyond the retained file limit is
+removed, keeping total on-disk usage predictable.
+
+The connector assumes a single writer per file: one instance should own a given log file.
+Its own writes and rotations are serialised with a mutex, but it does not coordinate with
+other processes or external tools rotating the same file.
+
+## Implements
+
+- `ILoggingConnector`
+
+## Constructors
+
+### Constructor
+
+> **new FileLoggingConnector**(`options`): `FileLoggingConnector`
+
+Create a new instance of FileLoggingConnector.
+
+#### Parameters
+
+##### options
+
+[`IFileLoggingConnectorConstructorOptions`](../interfaces/IFileLoggingConnectorConstructorOptions.md)
+
+The options for the logging connector.
+
+#### Returns
+
+`FileLoggingConnector`
+
+#### Throws
+
+GeneralError if maxFileSizeBytes is a positive value below the minimum.
+
+## Properties
+
+### NAMESPACE {#namespace}
+
+> `readonly` `static` **NAMESPACE**: `string` = `"file"`
+
+The namespace for the logging connector.
+
+***
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+***
+
+### DEFAULT\_FILENAME {#default_filename}
+
+> `readonly` `static` **DEFAULT\_FILENAME**: `string` = `"app.log"`
+
+Default name for the active log file.
+
+***
+
+### DEFAULT\_MAX\_FILE\_SIZE\_BYTES {#default_max_file_size_bytes}
+
+> `readonly` `static` **DEFAULT\_MAX\_FILE\_SIZE\_BYTES**: `number`
+
+Default maximum size in bytes of the active log file before rotation (10 MB).
+
+***
+
+### MIN\_MAX\_FILE\_SIZE\_BYTES {#min_max_file_size_bytes}
+
+> `readonly` `static` **MIN\_MAX\_FILE\_SIZE\_BYTES**: `number`
+
+Minimum size in bytes that can be configured for the active log file before rotation (100 KB).
+
+***
+
+### DEFAULT\_MAX\_RETAINED\_FILES {#default_max_retained_files}
+
+> `readonly` `static` **DEFAULT\_MAX\_RETAINED\_FILES**: `number` = `5`
+
+Default number of rotated log files to retain.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`ILoggingConnector.className`
+
+***
+
+### start() {#start}
+
+> **start**(): `Promise`\<`void`\>
+
+Start the connector; ensures the target directory exists and opens the file handle.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the connector is ready to accept log entries.
+
+#### Implementation of
+
+`ILoggingConnector.start`
+
+***
+
+### stop() {#stop}
+
+> **stop**(): `Promise`\<`void`\>
+
+Stop the connector; closes the file handle, releasing the descriptor.
+Calling stop() on a connector that has not been opened is a no-op.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the handle has been closed.
+
+#### Implementation of
+
+`ILoggingConnector.stop`
+
+***
+
+### log() {#log}
+
+> **log**(`logEntry`): `Promise`\<`void`\>
+
+Log an entry to the connector.
+The entry is appended to the active file as a single newline delimited JSON record;
+when the active file exceeds the configured size limit it is rotated first.
+
+#### Parameters
+
+##### logEntry
+
+`ILogEntry`
+
+The entry to log.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the entry has been written to disk.
+
+#### Implementation of
+
+`ILoggingConnector.log`

package/docs/reference/index.md

@@ -0,0 +1,10 @@
+# @twin.org/logging-connector-file
+
+## Classes
+
+- [FileLoggingConnector](classes/FileLoggingConnector.md)
+
+## Interfaces
+
+- [IFileLoggingConnectorConfig](interfaces/IFileLoggingConnectorConfig.md)
+- [IFileLoggingConnectorConstructorOptions](interfaces/IFileLoggingConnectorConstructorOptions.md)

package/docs/reference/interfaces/IFileLoggingConnectorConfig.md

@@ -0,0 +1,83 @@
+# Interface: IFileLoggingConnectorConfig
+
+Configuration for the File Logging Connector.
+
+## Extends
+
+- `ILoggingLevelsConfig`
+
+## Properties
+
+### directory {#directory}
+
+> **directory**: `string`
+
+The directory in which the log files are written, created if it does not exist.
+
+***
+
+### filename? {#filename}
+
+> `optional` **filename?**: `string`
+
+The name of the active log file within the directory.
+
+#### Default
+
+```ts
+app.log
+```
+
+***
+
+### maxFileSizeBytes? {#maxfilesizebytes}
+
+> `optional` **maxFileSizeBytes?**: `number`
+
+The maximum size in bytes the active log file can reach before it is rotated.
+A value of 0 or less disables size based rotation, allowing the file to grow without bound.
+A positive value below the minimum of 102400 (100 KB) throws on construction, to avoid
+excessive rotation.
+
+#### Default
+
+```ts
+10485760
+```
+
+***
+
+### maxRetainedFiles? {#maxretainedfiles}
+
+> `optional` **maxRetainedFiles?**: `number`
+
+The maximum number of rotated log files to retain alongside the active file.
+When the limit is reached the oldest rotated file is removed.
+A value of 0 or less retains no rotated files, the active file is discarded on rotation.
+
+#### Default
+
+```ts
+5
+```
+
+***
+
+### mutexTimeoutMs? {#mutextimeoutms}
+
+> `optional` **mutexTimeoutMs?**: `number`
+
+The timeout in milliseconds to wait when acquiring the write lock before a log call fails.
+Defaults to the Mutex default when not set.
+
+***
+
+### levels? {#levels}
+
+> `optional` **levels?**: `LogLevel`[]
+
+The log levels to display, will default to all.
+
+#### Inherited from
+
+`ILoggingLevelsConfig.levels`

package/docs/reference/interfaces/IFileLoggingConnectorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IFileLoggingConnectorConstructorOptions
+
+Options for the file logging connector constructor.
+
+## Properties
+
+### config {#config}
+
+> **config**: [`IFileLoggingConnectorConfig`](IFileLoggingConnectorConfig.md)
+
+The configuration for the file logging connector.

package/locales/.validate-ignore

@@ -0,0 +1,2 @@
+# Default log file names are not locale keys.
+\.log$

package/locales/en.json

@@ -0,0 +1,7 @@
+{
+	"error": {
+		"fileLoggingConnector": {
+			"maxFileSizeTooSmall": "The maximum file size of {maxFileSizeBytes} bytes is below the minimum of {minimum} bytes, use 0 to disable rotation"
+		}
+	}
+}

package/package.json

@@ -0,0 +1,55 @@
+{
+	"name": "@twin.org/logging-connector-file",
+	"version": "0.9.1-next.5",
+	"description": "Writes log events to size-limited files on disk with rotation and retention for local log persistence.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/iotaledger/twin-logging.git",
+		"directory": "packages/logging-connector-file"
+	},
+	"author": "vitaliy@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/logging-models": "0.9.1-next.5",
+		"@twin.org/nameof": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"logging",
+		"file",
+		"rotation",
+		"retention",
+		"connector",
+		"adapter",
+		"integration"
+	],
+	"bugs": {
+		"url": "git+https://github.com/iotaledger/twin-logging/issues"
+	},
+	"homepage": "https://twindev.org"
+}