@reliverse/relinka 1.1.2 → 1.1.3

package/dist-npm/components/prompts/relinka.d.ts

@@ -1,12 +1,6 @@
 import type { PromptOptions } from "../../components/mono/monoTwo.js";
 import type { RelinkaReporter, InputLogObject, LogObject, RelinkaOptions } from "../../types/general.js";
 import type { LogType } from "../../utils/constants.js";
-/**
- * Relinka class for logging management with support for pause/resume, mocking and customizable reporting.
- * Provides flexible logging capabilities including level-based logging, custom reporters and integration options.
- *
- * @class Relinka
- */
 export declare class Relinka {
     options: RelinkaOptions;
     _lastLog: {
@@ -17,112 +11,27 @@ export declare class Relinka {
         timeout?: ReturnType<typeof setTimeout>;
     };
     _mockFn?: RelinkaOptions["mockFn"];
-    /**
-     * Creates an instance of Relinka with specified options or defaults.
-     *
-     * @param {Partial<RelinkaOptions>} [options={}] - Configuration options for the Relinka instance.
-     */
-    constructor(options?: Partial<RelinkaOptions>);
-    /**
-     * Gets the current log level of the Relinka instance.
-     *
-     * @returns {number} The current log level.
-     */
-    get level(): any;
-    /**
-     * Sets the minimum log level that will be output by the instance.
-     *
-     * @param {number} level - The new log level to set.
-     */
-    set level(level: any);
-    /**
-     * Displays a prompt to the user and returns the response.
-     * Throw an error if `prompt` is not supported by the current configuration.
-     *
-     * @template T
-     * @param {string} message - The message to display in the prompt.
-     * @param {T} [opts] - Optional options for the prompt. See {@link PromptOptions}.
-     * @returns {promise<T>} A promise that infer with the prompt options. See {@link PromptOptions}.
-     */
-    prompt<T extends PromptOptions>(message: string, opts?: T): any;
-    /**
-     * Creates a new instance of Relinka, inheriting options from the current instance, with possible overrides.
-     *
-     * @param {Partial<RelinkaOptions>} options - Optional overrides for the new instance. See {@link RelinkaOptions}.
-     * @returns {RelinkaInstance} A new Relinka instance. See {@link RelinkaInstance}.
-     */
-    create(options: Partial<RelinkaOptions>): RelinkaInstance;
-    /**
-     * Creates a new Relinka instance with the specified default log object properties.
-     *
-     * @param {InputLogObject} defaults - Default properties to include in any log from the new instance. See {@link InputLogObject}.
-     * @returns {RelinkaInstance} A new Relinka instance. See {@link RelinkaInstance}.
-     */
-    withDefaults(defaults: InputLogObject): RelinkaInstance;
-    /**
-     * Creates a new Relinka instance with a specified tag, which will be included in every log.
-     *
-     * @param {string} tag - The tag to include in each log of the new instance.
-     * @returns {RelinkaInstance} A new Relinka instance. See {@link RelinkaInstance}.
-     */
-    withTag(tag: string): RelinkaInstance;
-    /**
-     * Adds a custom reporter to the Relinka instance.
-     * Reporters will be called for each log message, depending on their implementation and log level.
-     *
-     * @param {RelinkaReporter} reporter - The reporter to add. See {@link RelinkaReporter}.
-     * @returns {Relinka} The current Relinka instance.
-     */
-    addReporter(reporter: RelinkaReporter): this;
-    /**
-     * Removes a custom reporter from the Relinka instance.
-     * If no reporter is specified, all reporters will be removed.
-     *
-     * @param {RelinkaReporter} reporter - The reporter to remove. See {@link RelinkaReporter}.
-     * @returns {Relinka} The current Relinka instance.
-     */
-    removeReporter(reporter: RelinkaReporter): any;
-    /**
-     * Replaces all reporters of the Relinka instance with the specified array of reporters.
-     *
-     * @param {RelinkaReporter[]} reporters - The new reporters to set. See {@link RelinkaReporter}.
-     * @returns {Relinka} The current Relinka instance.
-     */
-    setReporters(reporters: RelinkaReporter[]): this;
+        constructor(options?: Partial<RelinkaOptions>);
+        get level(): any;
+        set level(level: any);
+        prompt<T extends PromptOptions>(message: string, opts?: T): any;
+        create(options: Partial<RelinkaOptions>): RelinkaInstance;
+        withDefaults(defaults: InputLogObject): RelinkaInstance;
+        withTag(tag: string): RelinkaInstance;
+        addReporter(reporter: RelinkaReporter): this;
+        removeReporter(reporter: RelinkaReporter): any;
+        setReporters(reporters: RelinkaReporter[]): this;
     wrapAll(): void;
     restoreAll(): void;
-    /**
-     * Overrides console methods with Relinka logging methods for consistent logging.
-     */
-    wrapConsole(): void;
-    /**
-     * Restores the original console methods, removing Relinka overrides.
-     */
-    restoreConsole(): void;
-    /**
-     * Overrides standard output and error streams to redirect them through Relinka.
-     */
-    wrapStd(): void;
+        wrapConsole(): void;
+        restoreConsole(): void;
+        wrapStd(): void;
     _wrapStream(stream: NodeJS.WriteStream | undefined, type: LogType): void;
-    /**
-     * Restores the original standard output and error streams, removing the Relinka redirection.
-     */
-    restoreStd(): void;
+        restoreStd(): void;
     _restoreStream(stream?: NodeJS.WriteStream): void;
-    /**
-     * Pauses logging, queues incoming logs until resumed.
-     */
-    pauseLogs(): void;
-    /**
-     * Resumes logging, processing any queued logs.
-     */
-    resumeLogs(): void;
-    /**
-     * Replaces logging methods with mocks if a mock function is provided.
-     *
-     * @param {RelinkaOptions["mockFn"]} mockFn - The function to use for mocking logging methods. See {@link RelinkaOptions["mockFn"]}.
-     */
-    mockTypes(mockFn?: RelinkaOptions["mockFn"]): void;
+        pauseLogs(): void;
+        resumeLogs(): void;
+        mockTypes(mockFn?: RelinkaOptions["mockFn"]): void;
     _wrapLogFn(defaults: InputLogObject, isRaw?: boolean): (...args: any[]) => false | undefined;
     _logFn(defaults: InputLogObject, args: any[], isRaw?: boolean): false | undefined;
     _log(logObj: LogObject): void;
@@ -132,10 +41,4 @@ export type LogFn = {
     raw: (...args: any[]) => void;
 };
 export type RelinkaInstance = Relinka & Record<LogType, LogFn>;
-/**
- * Utility for creating a new Relinka instance with optional configuration.
- *
- * @param {Partial<RelinkaOptions>} [options={}] - Optional configuration options for the new Relinka instance. See {@link RelinkaOptions}.
- * @returns {RelinkaInstance} A new instance of Relinka. See {@link RelinkaInstance}.
- */
 export declare function createRelinka(options?: Partial<RelinkaOptions>): RelinkaInstance;

package/dist-npm/components/prompts/relinka.js

@@ -7,12 +7,7 @@ export class Relinka {
   options;
   _lastLog;
   _mockFn;
-  /**
-   * Creates an instance of Relinka with specified options or defaults.
-   *
-   * @param {Partial<RelinkaOptions>} [options={}] - Configuration options for the Relinka instance.
-   */
-  constructor(options = {}) {
+    constructor(options = {}) {
     const types = options.types || LogTypes;
     this.options = defu(
       {
@@ -49,48 +44,23 @@ export class Relinka {
     }
     this._lastLog = {};
   }
-  /**
-   * Gets the current log level of the Relinka instance.
-   *
-   * @returns {number} The current log level.
-   */
-  get level() {
+    get level() {
     return this.options.level;
   }
-  /**
-   * Sets the minimum log level that will be output by the instance.
-   *
-   * @param {number} level - The new log level to set.
-   */
-  set level(level) {
+    set level(level) {
     this.options.level = _normalizeLogLevel(
       level,
       this.options.types,
       this.options.level
     );
   }
-  /**
-   * Displays a prompt to the user and returns the response.
-   * Throw an error if `prompt` is not supported by the current configuration.
-   *
-   * @template T
-   * @param {string} message - The message to display in the prompt.
-   * @param {T} [opts] - Optional options for the prompt. See {@link PromptOptions}.
-   * @returns {promise<T>} A promise that infer with the prompt options. See {@link PromptOptions}.
-   */
-  prompt(message, opts) {
+    prompt(message, opts) {
     if (!this.options.prompt) {
       throw new Error("prompt is not supported!");
     }
     return this.options.prompt(message, opts);
   }
-  /**
-   * Creates a new instance of Relinka, inheriting options from the current instance, with possible overrides.
-   *
-   * @param {Partial<RelinkaOptions>} options - Optional overrides for the new instance. See {@link RelinkaOptions}.
-   * @returns {RelinkaInstance} A new Relinka instance. See {@link RelinkaInstance}.
-   */
-  create(options) {
+    create(options) {
     const instance = new Relinka({
       ...this.options,
       ...options
@@ -100,13 +70,7 @@ export class Relinka {
     }
     return instance;
   }
-  /**
-   * Creates a new Relinka instance with the specified default log object properties.
-   *
-   * @param {InputLogObject} defaults - Default properties to include in any log from the new instance. See {@link InputLogObject}.
-   * @returns {RelinkaInstance} A new Relinka instance. See {@link RelinkaInstance}.
-   */
-  withDefaults(defaults) {
+    withDefaults(defaults) {
     return this.create({
       ...this.options,
       defaults: {
@@ -115,36 +79,16 @@ export class Relinka {
       }
     });
   }
-  /**
-   * Creates a new Relinka instance with a specified tag, which will be included in every log.
-   *
-   * @param {string} tag - The tag to include in each log of the new instance.
-   * @returns {RelinkaInstance} A new Relinka instance. See {@link RelinkaInstance}.
-   */
-  withTag(tag) {
+    withTag(tag) {
     return this.withDefaults({
       tag: this.options.defaults.tag ? this.options.defaults.tag + ":" + tag : tag
     });
   }
-  /**
-   * Adds a custom reporter to the Relinka instance.
-   * Reporters will be called for each log message, depending on their implementation and log level.
-   *
-   * @param {RelinkaReporter} reporter - The reporter to add. See {@link RelinkaReporter}.
-   * @returns {Relinka} The current Relinka instance.
-   */
-  addReporter(reporter) {
+    addReporter(reporter) {
     this.options.reporters.push(reporter);
     return this;
   }
-  /**
-   * Removes a custom reporter from the Relinka instance.
-   * If no reporter is specified, all reporters will be removed.
-   *
-   * @param {RelinkaReporter} reporter - The reporter to remove. See {@link RelinkaReporter}.
-   * @returns {Relinka} The current Relinka instance.
-   */
-  removeReporter(reporter) {
+    removeReporter(reporter) {
     if (reporter) {
       const i = this.options.reporters.indexOf(reporter);
       if (i >= 0) {
@@ -155,13 +99,7 @@ export class Relinka {
     }
     return this;
   }
-  /**
-   * Replaces all reporters of the Relinka instance with the specified array of reporters.
-   *
-   * @param {RelinkaReporter[]} reporters - The new reporters to set. See {@link RelinkaReporter}.
-   * @returns {Relinka} The current Relinka instance.
-   */
-  setReporters(reporters) {
+    setReporters(reporters) {
     this.options.reporters = Array.isArray(reporters) ? reporters : [reporters];
     return this;
   }
@@ -173,10 +111,7 @@ export class Relinka {
     this.restoreConsole();
     this.restoreStd();
   }
-  /**
-   * Overrides console methods with Relinka logging methods for consistent logging.
-   */
-  wrapConsole() {
+    wrapConsole() {
     for (const type in this.options.types) {
       if (!console["__" + type]) {
         console["__" + type] = console[type];
@@ -184,10 +119,7 @@ export class Relinka {
       console[type] = this[type].raw;
     }
   }
-  /**
-   * Restores the original console methods, removing Relinka overrides.
-   */
-  restoreConsole() {
+    restoreConsole() {
     for (const type in this.options.types) {
       if (console["__" + type]) {
         console[type] = console["__" + type];
@@ -195,10 +127,7 @@ export class Relinka {
       }
     }
   }
-  /**
-   * Overrides standard output and error streams to redirect them through Relinka.
-   */
-  wrapStd() {
+    wrapStd() {
     this._wrapStream(this.options.stdout, "log");
     this._wrapStream(this.options.stderr, "log");
   }
@@ -213,10 +142,7 @@ export class Relinka {
       this[type].raw(String(data).trim());
     };
   }
-  /**
-   * Restores the original standard output and error streams, removing the Relinka redirection.
-   */
-  restoreStd() {
+    restoreStd() {
     this._restoreStream(this.options.stdout);
     this._restoreStream(this.options.stderr);
   }
@@ -229,28 +155,17 @@ export class Relinka {
       delete stream.__write;
     }
   }
-  /**
-   * Pauses logging, queues incoming logs until resumed.
-   */
-  pauseLogs() {
+    pauseLogs() {
     paused = true;
   }
-  /**
-   * Resumes logging, processing any queued logs.
-   */
-  resumeLogs() {
+    resumeLogs() {
     paused = false;
     const _queue = queue.splice(0);
     for (const item of _queue) {
       item[0]._logFn(item[1], item[2]);
     }
   }
-  /**
-   * Replaces logging methods with mocks if a mock function is provided.
-   *
-   * @param {RelinkaOptions["mockFn"]} mockFn - The function to use for mocking logging methods. See {@link RelinkaOptions["mockFn"]}.
-   */
-  mockTypes(mockFn) {
+    mockTypes(mockFn) {
     const _mockFn = mockFn || this.options.mockFn;
     this._mockFn = _mockFn;
     if (typeof _mockFn !== "function") {
@@ -275,7 +190,7 @@ export class Relinka {
       return false;
     }
     const logObj = {
-      date: /* @__PURE__ */ new Date(),
+      date:  new Date(),
       args: [],
       ...defaults,
       level: _normalizeLogLevel(defaults.level, this.options.types)

package/dist-npm/components/range/range.d.ts

@@ -1,8 +1,5 @@
 import type { Writable } from "stream";
 import { EventEmitter } from "events";
-/**
- * Interface for RangePrompt options
- */
 type RangePromptOptions = {
     hint?: string;
     marker?: string;
@@ -17,9 +14,6 @@ type RangePromptOptions = {
     step?: number;
     size?: number;
 };
-/**
- * RangePrompt class extends EventEmitter to handle events
- */
 export declare class RangePrompt extends EventEmitter {
     hint: string;
     marker: string;
@@ -46,67 +40,21 @@ export declare class RangePrompt extends EventEmitter {
     private keyListener;
     private cursorHidden;
     constructor(msg: string, options?: RangePromptOptions);
-    /**
-     * Initializes the prompt by setting up listeners and terminal settings
-     */
-    private initialize;
-    /**
-     * Closes the prompt, restoring terminal settings and cleaning up
-     */
-    private _close;
-    /**
-     * Handles keypress events
-     * @param chunk - The input buffer
-     */
-    private onKeyPress;
-    /**
-     * Resets the prompt to its initial state
-     */
-    reset(): void;
-    /**
-     * Aborts the prompt
-     */
-    abort(): void;
-    /**
-     * Submits the current value
-     */
-    submit(): void;
-    /**
-     * Increases the value by the step
-     */
-    up(): void;
-    /**
-     * Decreases the value by the step
-     */
-    down(): void;
-    /**
-     * Handles numeric input
-     * @param n - The input character
-     */
-    handleNumericInput(n: string): void;
-    /**
-     * Handles unknown input
-     * @param input - The input string
-     */
-    handleUnknownInput(input: string): void;
-    /**
-     * Renders the prompt to the output
-     * @param first - Indicates if this is the first render
-     */
-    render(first?: boolean): void;
-    /**
-     * Emits a bell sound to indicate an error or invalid action
-     */
-    bell(): void;
+        private initialize;
+        private _close;
+        private onKeyPress;
+        reset(): void;
+        abort(): void;
+        submit(): void;
+        up(): void;
+        down(): void;
+        handleNumericInput(n: string): void;
+        handleUnknownInput(input: string): void;
+        render(first?: boolean): void;
+        bell(): void;
     left: () => void;
     right: () => void;
 }
-/**
- * Function to create a new RangePrompt instance
- * @param msg - The message to display
- * @param opt - Optional configuration options
- * @returns Wrapped RangePrompt instance
- */
 export declare const rangePrompt: (msg: string, opt?: RangePromptOptions) => any;
 declare const _default: ((msg: string, opt?: RangePromptOptions) => any) & {
     RangePrompt: typeof RangePrompt;

package/dist-npm/components/range/range.js

@@ -8,7 +8,7 @@ import stringWidth from "string-width";
 import windowSize from "window-size";
 import wrap from "../../utils/skeleton.js";
 export class RangePrompt extends EventEmitter {
-  // Prompt properties
+  
   hint;
   marker;
   bar;
@@ -30,8 +30,8 @@ export class RangePrompt extends EventEmitter {
   pause;
   resume;
   _;
-  // Property for handling unknown input
-  // Internal properties for managing listeners and state
+  
+  
   stdin;
   keyListener;
   cursorHidden;
@@ -99,10 +99,7 @@ export class RangePrompt extends EventEmitter {
     this.stdin.on("data", this.keyListener);
     this.render(true);
   }
-  /**
-   * Closes the prompt, restoring terminal settings and cleaning up
-   */
-  _close() {
+    _close() {
     this.stdin.removeListener("data", this.keyListener);
     if (this.stdin.isTTY) {
       this.stdin.setRawMode(false);
@@ -117,11 +114,7 @@ export class RangePrompt extends EventEmitter {
     }
     this.emit("close");
   }
-  /**
-   * Handles keypress events
-   * @param chunk - The input buffer
-   */
-  onKeyPress(chunk) {
+    onKeyPress(chunk) {
     const key = chunk.toString();
     if (key === "") {
       this.abort();
@@ -143,19 +136,13 @@ export class RangePrompt extends EventEmitter {
       this.handleUnknownInput(key);
     }
   }
-  /**
-   * Resets the prompt to its initial state
-   */
-  reset() {
+    reset() {
     this.typed = "";
     this.value = this.initialValue;
     this.emit("change");
     this.render();
   }
-  /**
-   * Aborts the prompt
-   */
-  abort() {
+    abort() {
     this.done = true;
     this.aborted = true;
     this.emit("abort");
@@ -163,10 +150,7 @@ export class RangePrompt extends EventEmitter {
     this.out.write("\n");
     this.close();
   }
-  /**
-   * Submits the current value
-   */
-  submit() {
+    submit() {
     this.done = true;
     this.aborted = false;
     this.emit("submit");
@@ -174,10 +158,7 @@ export class RangePrompt extends EventEmitter {
     this.out.write("\n");
     this.close();
   }
-  /**
-   * Increases the value by the step
-   */
-  up() {
+    up() {
     this.typed = "";
     if (this.value !== null && this.value >= this.max) {
       this.bell();
@@ -185,15 +166,14 @@ export class RangePrompt extends EventEmitter {
     }
     if (this.value !== null) {
       this.value = +(this.value + this.step).toFixed(precision(this.step));
-      if (this.value > this.max) this.value = this.max;
+      if (this.value > this.max) {
+        this.value = this.max;
+      }
     }
     this.emit("change");
     this.render();
   }
-  /**
-   * Decreases the value by the step
-   */
-  down() {
+    down() {
     this.typed = "";
     if (this.value !== null && this.value <= this.min) {
       this.bell();
@@ -201,22 +181,22 @@ export class RangePrompt extends EventEmitter {
     }
     if (this.value !== null) {
       this.value = +(this.value - this.step).toFixed(precision(this.step));
-      if (this.value < this.min) this.value = this.min;
+      if (this.value < this.min) {
+        this.value = this.min;
+      }
     }
     this.emit("change");
     this.render();
   }
-  /**
-   * Handles numeric input
-   * @param n - The input character
-   */
-  handleNumericInput(n) {
+    handleNumericInput(n) {
     if (!isFloat.test(n)) {
       this.bell();
       return;
     }
     const now = Date.now();
-    if (now - this.lastHit > 1e3) this.typed = "";
+    if (now - this.lastHit > 1e3) {
+      this.typed = "";
+    }
     this.typed += n;
     this.lastHit = now;
     const v = parseFloat(this.typed);
@@ -225,24 +205,20 @@ export class RangePrompt extends EventEmitter {
       return;
     }
     let newValue = v;
-    if (newValue > this.max) newValue = this.max;
-    if (newValue < this.min) newValue = this.min;
+    if (newValue > this.max) {
+      newValue = this.max;
+    }
+    if (newValue < this.min) {
+      newValue = this.min;
+    }
     this.value = newValue;
     this.emit("change");
     this.render();
   }
-  /**
-   * Handles unknown input
-   * @param input - The input string
-   */
-  handleUnknownInput(input) {
+    handleUnknownInput(input) {
     this.bell();
   }
-  /**
-   * Renders the prompt to the output
-   * @param first - Indicates if this is the first render
-   */
-  render(first = false) {
+    render(first = false) {
     let out = "";
     if (first) {
       out += esc.cursorHide;
@@ -273,20 +249,21 @@ export class RangePrompt extends EventEmitter {
     ].join(" ") + "\n";
     this.out.write(out);
   }
-  /**
-   * Emits a bell sound to indicate an error or invalid action
-   */
-  bell() {
+    bell() {
     this.out.write("\x07");
   }
-  // Left and Right bindings
+  
   left;
   right;
 }
 const isFloat = /^[0-9.]+$/;
 export const rangePrompt = (msg, opt) => {
-  if (typeof msg !== "string") throw new Error("Message must be string.");
-  if (Array.isArray(opt) || typeof opt !== "object") opt = {};
+  if (typeof msg !== "string") {
+    throw new Error("Message must be string.");
+  }
+  if (Array.isArray(opt) || typeof opt !== "object") {
+    opt = {};
+  }
   const prompt = new RangePrompt(msg, opt);
   return wrap(prompt);
 };

package/dist-npm/components/rawlist/index.js

@@ -16,7 +16,9 @@ function isSelectableChoice(choice) {
 function normalizeChoices(choices) {
   let index = 0;
   return choices.map((choice) => {
-    if (Separator.isSeparator(choice)) return choice;
+    if (Separator.isSeparator(choice)) {
+      return choice;
+    }
     index += 1;
     if (typeof choice === "string") {
       return {
@@ -28,12 +30,12 @@ function normalizeChoices(choices) {
     }
     const name = choice.name ?? String(choice.value);
     return {
-      // @ts-expect-error - TODO: fix ts
+      
       value: choice.value,
       name,
-      // @ts-expect-error - TODO: fix ts
+      
       short: choice.short ?? name,
-      // @ts-expect-error - TODO: fix ts
+      
       key: choice.key ?? String(index)
     };
   });