@visulima/pail 4.0.0-alpha.8 → 4.0.0

package/dist/reporter/file/json-file-reporter.d.ts

@@ -1,46 +1,113 @@
-import type { Options as RfsOptions } from "rotating-file-stream";
-import type { AbstractJsonReporterOptions } from "../json/abstract-json-reporter.d.ts";
-import { AbstractJsonReporter } from "../json/abstract-json-reporter.d.ts";
-import RotatingFileStream from "./utils/rotating-file-stream.d.ts";
+import { Options } from 'rotating-file-stream';
+import { A as AbstractJsonReporterOptions, a as AbstractJsonReporter } from "../../packem_shared/abstract-json-reporter.d-wfESoEa-.js";
+import "../../packem_shared/index.d-T71KjNAr.js";
+import 'type-fest';
+import "../../packem_shared/types.d-bWnqHJKL.js";
+import '@visulima/colorize';
+import '@visulima/interactive-manager';
 /**
- * Options for configuring the JsonFileReporter.
- */
-export type FileReporterOptions = AbstractJsonReporterOptions & RfsOptions & {
-    /** Path to the log file */
-    filePath: string;
-    /** Whether to write immediately to disk instead of buffering */
-    writeImmediately?: boolean;
+* Rotating File Stream.
+*
+* A wrapper for the `rotating-file-stream` module that provides optional immediate
+* writing to disk by creating and closing a new stream on each write operation.
+* This is useful for ensuring log messages are written immediately rather than buffered.
+* @example
+* ```typescript
+* // Buffered writing (default)
+* const bufferedStream = new RotatingFileStream("/var/log/app.log", false, {
+*   interval: "1d",
+*   size: "10M"
+* });
+*
+* // Immediate writing
+* const immediateStream = new RotatingFileStream("/var/log/app.log", true, {
+*   interval: "1d"
+* });
+* ```
+*/
+declare class RotatingFileStream {
+  #private;
+  /**
+  * Creates a new RotatingFileStream instance.
+  * @param filePath Path to the log file
+  * @param writeImmediately Whether to write immediately or buffer writes
+  * @param options Options for the rotating file stream
+  * @throws {Error} If the 'rotating-file-stream' package is not installed
+  */
+  constructor(filePath: string, writeImmediately?: boolean, options?: Options);
+  /**
+  * Writes a message to the rotating file stream.
+  *
+  * If writeImmediately was set to true in the constructor, a new stream
+  * is created for each write operation. Otherwise, uses the buffered stream.
+  * @param message The message to write to the file
+  */
+  write(message: string): void;
+  /**
+  * Ends the rotating file stream.
+  *
+  * Closes the underlying stream. When `writeImmediately` is not `true`,
+  * calling `write` after calling this method will throw an error.
+  */
+  end(): void;
+}
+/**
+* Options for configuring the JsonFileReporter.
+*/
+type FileReporterOptions = AbstractJsonReporterOptions & Options & {
+  /** Path to the log file */
+  filePath: string;
+  /** Whether to write immediately to disk instead of buffering */
+  writeImmediately?: boolean;
 };
 /**
- * JSON File Reporter.
- *
- * A reporter that writes structured JSON log entries to rotating files on disk.
- * Supports automatic file rotation based on size, time intervals, and compression.
- * @template L - The log level type
- * @example
- * ```typescript
- * const reporter = new JsonFileReporter({
- *   filePath: "/var/log/app.log",
- *   interval: "1d", // Rotate daily
- *   size: "10M",   // Rotate when file reaches 10MB
- *   compress: "gzip"
- * });
- *
- * logger.registerReporters([reporter]);
- * ```
- */
-export declare class JsonFileReporter<L extends string = string> extends AbstractJsonReporter<L> {
-    /** The rotating file stream instance */
-    protected stream: RotatingFileStream;
-    /**
-     * Creates a new JsonFileReporter instance.
-     * @param options Configuration options for file rotation and JSON formatting
-     */
-    constructor(options: FileReporterOptions);
-    /**
-     * Writes a JSON message to the rotating file stream.
-     * @param message The JSON-formatted log message to write
-     * @protected
-     */
-    protected _log(message: string): void;
+* JSON File Reporter.
+*
+* A reporter that writes structured JSON log entries to rotating files on disk.
+* Supports automatic file rotation based on size, time intervals, and compression.
+* @template L - The log level type
+* @example
+* ```typescript
+* const reporter = new JsonFileReporter({
+*   filePath: "/var/log/app.log",
+*   interval: "1d", // Rotate daily
+*   size: "10M",   // Rotate when file reaches 10MB
+*   compress: "gzip"
+* });
+*
+* logger.registerReporters([reporter]);
+* ```
+*/
+declare class JsonFileReporter<L extends string = string> extends AbstractJsonReporter<L> {
+  /** The rotating file stream instance */
+  protected stream: RotatingFileStream;
+  /**
+  * Creates a new JsonFileReporter instance.
+  * @param options Configuration options for file rotation and JSON formatting
+  */
+  constructor(options: FileReporterOptions);
+  /**
+  * Closes the underlying rotating file stream.
+  *
+  * Ends the buffered stream so any queued writes are flushed to disk before the
+  * process exits. Without this the tail of the log can be lost on a short-lived
+  * process. After calling `close()` no further writes should be made (unless
+  * `writeImmediately` was enabled, in which case each write owns its own stream).
+  * @example
+  * ```typescript
+  * process.on("beforeExit", () => reporter.close());
+  * ```
+  */
+  close(): void;
+  /**
+  * Alias for {@link close} to match common transport `dispose` conventions.
+  */
+  dispose(): void;
+  /**
+  * Writes a JSON message to the rotating file stream.
+  * @param message The JSON-formatted log message to write
+  * @protected
+  */
+  protected override _log(message: string): void;
 }
+export { FileReporterOptions, JsonFileReporter };

package/dist/reporter/file/json-file-reporter.js

@@ -1,136 +1,2 @@
-import { AbstractJsonReporter } from '../../packem_shared/AbstractJsonReporter-CGKHS8_M.js';
-
-class SafeStreamHandler {
-  #ready = true;
-  #stream;
-  #name;
-  constructor(stream, name) {
-    this.#stream = stream;
-    this.#name = name;
-  }
-  /**
-   * Writes `message` to the instance's internal stream.
-   * @param message Message to write
-   */
-  write(message) {
-    this.writeStream(message);
-  }
-  /**
-   * Calls `end` on this instance's internal stream
-   */
-  end(...arguments_) {
-    this.#stream.end(...arguments_);
-  }
-  get isReady() {
-    return this.#ready;
-  }
-  writeStream(message) {
-    if (!this.#ready) {
-      console.warn(`Stream busy: ${this.#name}. Write will be dropped: "${message}"`);
-      return;
-    }
-    this.#ready = false;
-    this.#stream.on("error", (error) => {
-      throw error;
-    });
-    this.#stream.on("drain", () => {
-      this.#ready = true;
-    });
-    this.#stream.on("finish", () => {
-      this.#ready = true;
-    });
-    this.#ready = this.#stream.write(message, () => {
-    });
-  }
-}
-
-class RotatingFileStream {
-  #filePath;
-  #immediate;
-  #stream;
-  #options;
-  #createRfsStream;
-  /**
-   * Creates a new RotatingFileStream instance.
-   * @param filePath Path to the log file
-   * @param writeImmediately Whether to write immediately or buffer writes
-   * @param options Options for the rotating file stream
-   * @throws {Error} If the 'rotating-file-stream' package is not installed
-   */
-  constructor(filePath, writeImmediately = false, options = {}) {
-    this.#filePath = filePath;
-    this.#immediate = writeImmediately;
-    this.#options = options;
-    if (!this.#immediate) {
-      try {
-        this.#createRfsStream = require("rotating-file-stream").createStream;
-      } catch {
-        throw new Error("The 'rotating-file-stream' package is missing. Make sure to install the 'rotating-file-stream' package.");
-      }
-      this.#stream = this.#createRfsStream(this.#filePath, options);
-    }
-  }
-  /**
-   * Writes a message to the rotating file stream.
-   *
-   * If writeImmediately was set to true in the constructor, a new stream
-   * is created for each write operation. Otherwise, uses the buffered stream.
-   * @param message The message to write to the file
-   */
-  write(message) {
-    let fileStream = this.#stream;
-    if (this.#immediate) {
-      fileStream = this.#createRfsStream(this.#filePath, this.#options);
-    }
-    const stream = new SafeStreamHandler(fileStream, this.#filePath);
-    stream.write(message);
-    if (this.#immediate) {
-      stream.end();
-    }
-  }
-  /**
-   * Ends the rotating file stream.
-   *
-   * Closes the underlying stream. When `writeImmediately` is not `true`,
-   * calling `write` after calling this method will throw an error.
-   */
-  end() {
-    if (this.#stream !== void 0) {
-      this.#stream.end();
-    }
-  }
-}
-
-class JsonFileReporter extends AbstractJsonReporter {
-  /** The rotating file stream instance */
-  stream;
-  /**
-   * Creates a new JsonFileReporter instance.
-   * @param options Configuration options for file rotation and JSON formatting
-   */
-  constructor(options) {
-    super();
-    const { filePath, writeImmediately = false, ...rfsOptions } = options;
-    this.stream = new RotatingFileStream(filePath, writeImmediately, {
-      compress: "gzip",
-      // compress rotated files
-      interval: "1d",
-      // rotate daily
-      size: "10M",
-      // rotate every 10 MegaBytes written,
-      ...rfsOptions
-    });
-  }
-  /**
-   * Writes a JSON message to the rotating file stream.
-   * @param message The JSON-formatted log message to write
-   * @protected
-   */
-  // eslint-disable-next-line no-underscore-dangle
-  _log(message) {
-    this.stream.write(`${message}
-`);
-  }
-}
-
-export { JsonFileReporter };
+import{AbstractJsonReporter as a}from"../../packem_shared/AbstractJsonReporter-w_bGGiD-.js";class r{#t=!0;#s;#e;constructor(t,e){this.#s=t,this.#e=e,this.#s.on("error",s=>{throw s}),this.#s.on("drain",()=>{this.#t=!0}),this.#s.on("finish",()=>{this.#t=!0})}write(t){this.writeStream(t)}end(...t){this.#s.end(...t)}get isReady(){return this.#t}writeStream(t){if(!this.#t){console.warn(`Stream busy: ${this.#e}. Write will be dropped: "${t}"`);return}this.#t=!1,this.#t=this.#s.write(t,()=>{})}}class o{#t;#s;#e;#r;#i;#h;constructor(t,e=!1,s={}){this.#t=t,this.#s=e,this.#r=s;try{this.#i=require("rotating-file-stream").createStream}catch{throw new Error("The 'rotating-file-stream' package is missing. Make sure to install the 'rotating-file-stream' package.")}this.#s||(this.#e=this.#i(this.#t,s),this.#h=new r(this.#e,this.#t))}write(t){if(this.#s){const e=this.#i(this.#t,this.#r),s=new r(e,this.#t);s.write(t),s.end();return}this.#h.write(t)}end(){this.#e!==void 0&&this.#e.end()}}class c extends a{stream;constructor(t){super();const{filePath:e,writeImmediately:s=!1,...h}=t;this.stream=new o(e,s,{compress:"gzip",interval:"1d",size:"10M",...h})}close(){this.stream.end()}dispose(){this.close()}_log(t){this.stream.write(`${t}
+`)}}export{c as JsonFileReporter};