@reliverse/relinka 1.1.2 → 1.1.3

package/dist-npm/components/mono/monoTwo.d.ts

@@ -4,90 +4,27 @@ type SelectOption = {
     hint?: string;
 };
 export type TextPromptOptions = {
-    /**
-     * Specifies the prompt type as text.
-     * @optional
-     * @default "text"
-     */
-    type?: "text";
-    /**
-     * The default text value.
-     * @optional
-     */
-    default?: string;
-    /**
-     * A placeholder text displayed in the prompt.
-     * @optional
-     */
-    placeholder?: string;
-    /**
-     * The initial text value.
-     * @optional
-     */
-    initial?: string;
+        type?: "text";
+        default?: string;
+        placeholder?: string;
+        initial?: string;
 };
 export type ConfirmPromptOptions = {
-    /**
-     * Specifies the prompt type as confirm.
-     */
-    type: "confirm";
-    /**
-     * The initial value for the confirm prompt.
-     * @optional
-     */
-    initial?: boolean;
+        type: "confirm";
+        initial?: boolean;
 };
 export type SelectPromptOptions = {
-    /**
-     * Specifies the prompt type as select.
-     */
-    type: "select";
-    /**
-     * The initial value for the select prompt.
-     * @optional
-     */
-    initial?: string;
-    /**
-     * The options to select from. See {@link SelectOption}.
-     */
-    options: (string | SelectOption)[];
+        type: "select";
+        initial?: string;
+        options: (string | SelectOption)[];
 };
 export type MultiSelectOptions = {
-    /**
-     * Specifies the prompt type as multiselect.
-     */
-    type: "multiselect";
-    /**
-     * The options to select from. See {@link SelectOption}.
-     */
-    initial?: string[];
-    /**
-     * The options to select from. See {@link SelectOption}.
-     */
-    options: (string | SelectOption)[];
-    /**
-     * Whether the prompt requires at least one selection.
-     */
-    required?: boolean;
+        type: "multiselect";
+        initial?: string[];
+        options: (string | SelectOption)[];
+        required?: boolean;
 };
-/**
- * Defines a combined type for all prompt options.
- */
 export type PromptOptions = TextPromptOptions | ConfirmPromptOptions | SelectPromptOptions | MultiSelectOptions;
 type inferPromptReturnType<T extends PromptOptions> = T extends TextPromptOptions ? string : T extends ConfirmPromptOptions ? boolean : T extends SelectPromptOptions ? T["options"][number] extends SelectOption ? T["options"][number]["value"] : T["options"][number] : T extends MultiSelectOptions ? T["options"] : unknown;
-/**
- * Asynchronously prompts the user for input based on specified options.
- * Supports text, confirm, select and multi-select prompts.
- *
- * @param {string} message - The message to display in the prompt.
- * @param {PromptOptions} [opts={}] - The prompt options. See {@link PromptOptions}.
- * @returns {Promise<inferPromptReturnType<T>>} - A promise that resolves with the user's response, the type of which is inferred from the options. See {@link inferPromptReturnType}.
- */
 export declare function prompt<_ = any, __ = any, T extends PromptOptions = TextPromptOptions>(message: string, opts?: PromptOptions): Promise<inferPromptReturnType<T>>;
 export {};
-/**
- * Asynchronously prompts the user for a multi-select input.
- *
- * @param {MultiselectPromptOptionsSeparate} opts - The options for the multi-select prompt.
- * @returns {Promise<string[] | symbol>} - A promise that resolves with an array of selected options or a symbol.
- */

package/dist-npm/components/password/password-main.js

@@ -104,7 +104,7 @@ ${formattedBar}`);
         stdin.pause();
         stdin.removeListener("data", onData);
         reject(new Error("User aborted."));
-      } else if (char === "\x7F" || // Backspace
+      } else if (char === "\x7F" || 
       char === "\b" || char === "\x7F" || char === "\b") {
         if (password.length > 0) {
           password = password.slice(0, -1);

package/dist-npm/components/progressbar/ProgressBar.d.ts

@@ -16,18 +16,7 @@ export declare class ProgressBar {
     private format;
     private colorize;
     constructor(options: ProgressBarOptions);
-    /**
-     * Update the progress bar to a specific value.
-     * @param value - The current progress value.
-     */
-    update(value: number): void;
-    /**
-     * Increment the progress bar by a specific amount.
-     * @param amount - The amount to increment.
-     */
-    increment(amount?: number): void;
-    /**
-     * Render the progress bar in the console.
-     */
-    private render;
+        update(value: number): void;
+        increment(amount?: number): void;
+        private render;
 }

package/dist-npm/components/progressbar/ProgressBar.js

@@ -21,28 +21,17 @@ export class ProgressBar {
     this.format = options.format || "Progress: [:bar] :percent% | Elapsed: :elapsed s";
     this.colorize = options.colorize || false;
   }
-  /**
-   * Update the progress bar to a specific value.
-   * @param value - The current progress value.
-   */
-  update(value) {
+    update(value) {
     const newValue = Math.min(value, this.total);
     if (newValue !== this.current) {
       this.current = newValue;
       this.render();
     }
   }
-  /**
-   * Increment the progress bar by a specific amount.
-   * @param amount - The amount to increment.
-   */
-  increment(amount = 1) {
+    increment(amount = 1) {
     this.update(this.current + amount);
   }
-  /**
-   * Render the progress bar in the console.
-   */
-  render() {
+    render() {
     const percent = this.current / this.total;
     const filledLength = Math.round(this.width * percent);
     const emptyLength = this.width - filledLength;

package/dist-npm/components/progressbar/helper.d.ts

@@ -1,22 +1,6 @@
 import type { ProgressBarOptions } from "./ProgressBar.js";
-/**
- * Options for the progressbar helper function.
- */
 export type ProgressBarTaskOptions = ProgressBarOptions & {
-    /**
-     * The amount to increment the progress bar each step.
-     * @default 1
-     */
-    increment?: number;
-    /**
-     * Desired total time for the progress bar to complete in milliseconds.
-     * @default 3000
-     */
-    desiredTotalTime?: number;
+        increment?: number;
+        desiredTotalTime?: number;
 };
-/**
- * Displays a progress bar that completes based on the provided options.
- * @param options - Configuration options for the progress bar.
- * @returns A promise that resolves when the progress bar completes.
- */
 export declare function progressbar(options: ProgressBarTaskOptions): Promise<void>;

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

@@ -1,21 +1,8 @@
 import type { RelinkaOptions } from "../../types/general.js";
 import type { RelinkaInstance } from "./relinka.js";
 export * from "../instance/shared.js";
-/**
- * Factory function to create a new Relinka instance tailored for use in different environments.
- * It automatically adjusts logging levels based on environment variables and execution context.
- *
- * @param {Partial<RelinkaOptions & { fancy: boolean }>} [options={}] - Optional configuration options. See {@link RelinkaOptions}.
- * @returns {RelinkaInstance} A new Relinka instance with configurations based on the given options and the execution environment.
- */
 export declare function createRelinka(options?: Partial<RelinkaOptions & {
     fancy: boolean;
 }>): RelinkaInstance;
-/**
- * A default instance of Relinka, created and configured for immediate use.
- * This instance is configured based on the execution environment and the options provided.
- *
- * @type {RelinkaInstance} relinka - The default Relinka instance, ready to use.
- */
 export declare const relinka: RelinkaInstance;
 export default relinka;

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

@@ -26,13 +26,13 @@ function setRawMode(input, value) {
     input.setRawMode(value);
   }
 }
-const aliases = /* @__PURE__ */ new Map([
+const aliases =  new Map([
   ["k", "up"],
   ["j", "down"],
   ["h", "left"],
   ["l", "right"]
 ]);
-const keys = /* @__PURE__ */ new Set(["up", "down", "left", "right", "space", "enter"]);
+const keys =  new Set(["up", "down", "left", "right", "space", "enter"]);
 export default class Prompt {
   input;
   output;
@@ -103,7 +103,7 @@ export default class Prompt {
       });
     });
   }
-  subscribers = /* @__PURE__ */ new Map();
+  subscribers =  new Map();
   on(event, cb) {
     const arr = this.subscribers.get(event) ?? [];
     arr.push({ cb });

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

@@ -1,98 +1,26 @@
 export { isCancel } from "../../components/prompts/prompt.js";
 export type TextOptions = {
-    /**
-     * The primary message to display for the prompt.
-     */
-    message: string;
-    /**
-     * A placeholder string that is displayed in the input field when it is empty. It disappears when the user starts typing.
-     * @optional
-     */
-    placeholder?: string;
-    /**
-     * The primary message to display for the prompt.
-     * A default value for the input field.This value will be returned if the user does not enter a value.
-     * @optional
-     */
-    defaultValue?: string;
-    /**
-     * An initial value that appears in the input field. Unlike `defaultValue`, it can be edited or removed by the user.
-     * @optional
-     */
-    initialValue?: string;
-    /**
-     * A function to validate the input. If the input is not valid, this function should return a string message.
-     * The prompt will continue until a valid value is entered or the prompt is aborted.
-     * @param {string} value - The current value of the input field.
-     * @returns {string | void} A string with an error message if validation fails or `void` if the input is valid.
-     * optional
-     */
-    validate?: (value: string) => string | void;
+        message: string;
+        placeholder?: string;
+        defaultValue?: string;
+        initialValue?: string;
+        validate?: (value: string) => string | void;
 };
-/**
- * Provides text input functionality with customizable options.
- * @param {TextOptions} opts - Options to customize the text prompt. See {@link TextOptions}.
- * @returns {Promise<string | symbol>} A promise that resolves to the user input or a symbol for special cases.
- */
 export declare const text: (opts: TextOptions) => any;
 export type PasswordOptions = {
-    /**
-     * The message to be displayed above the input field.
-     */
-    message: string;
-    /**
-     * A character that masks the user's input, hiding the text they type.
-     * @optional
-     */
-    mask?: string;
-    /**
-     * A function to validate the input. Returns an error message if the input fails validation.
-     * @param {string} value - The current value of the input field.
-     * @returns {string | void} An error message if the input fails validation, or `void` if the input is valid.
-     * @optional
-     */
-    validate?: (value: string) => string | void;
+        message: string;
+        mask?: string;
+        validate?: (value: string) => string | void;
 };
-/**
- * Provides password input functionality with customizable options, including input masking.
- * @param {PasswordOptions} opts - Options to customize the password prompt. See {@link PasswordOptions}.
- * @returns {Promise<string | symbol>} A promise that resolves to the user input or a symbol for special cases.
- */
 export declare const password: (opts: PasswordOptions) => any;
 export type ConfirmOptions = {
-    /**
-     * The primary message to display for the prompt.
-     */
-    message: string;
-    /**
-     * The text to display for the active/affirmative choice.
-     * @optional
-     */
-    active?: string;
-    /**
-     * Text to display for the inactive/negative choice.
-     * @optional
-     */
-    inactive?: string;
-    /**
-     * The initial selection value.
-     * @optional
-     */
-    initialValue?: boolean;
+        message: string;
+        active?: string;
+        inactive?: string;
+        initialValue?: boolean;
 };
-/**
- * Provides a confirmation prompt with customizable options.
- * @param {ConfirmOptions} opts - Options to customize the confirmation prompt. See {@link ConfirmOptions}.
- * @returns {Promise<boolean | symbol>} A promise that resolves to the user's choice, or a symbol for special cases.
- */
 export declare const confirm: (opts: ConfirmOptions) => Promise<boolean | symbol>;
-/**
- * A generic type for option values in a select prompt, supporting both primitive and complex types.
- */
 type Primitive = Readonly<string | boolean | number>;
-/**
- * Defines the structure of an option in a select prompt.
- */
 type Option<Value> = Value extends Primitive ? {
     value: Value;
     label?: string;
@@ -102,181 +30,45 @@ type Option<Value> = Value extends Primitive ? {
     label: string;
     hint?: string;
 };
-/**
- * Options for configuring the select prompt.
- * @template Options - An array of option objects. See {@link Option}.
- * @template Value - The type of option value. See {@link Option}.
- */
 export type SelectOptions<Options extends Option<Value>[], Value> = {
-    /**
-     * The primary message to display at the prompt.
-     */
-    message: string;
-    /**
-     * The list of options from which the user can choose. See {@link Option}.
-     */
-    options: Options;
-    /**
-     * The initial value selected in the prompt. See {@link Value}.
-     * @optional
-     */
-    initialValue?: Value;
+        message: string;
+        options: Options;
+        initialValue?: Value;
 };
-/**
- * Provides a select prompt functionality where the user can choose from a list of options.
- * @param {SelectOptions<Options, Value>} opts - Options to customize the select prompt. See {@link SelectOptions}.
- * @returns {Promise<Value | Symbol>} A promise that resolves to the selected value or a symbol for special cases. See {@link Value}.
- */
 export declare const select: <Options extends Option<Value>[], Value>(opts: SelectOptions<Options, Value>) => Promise<Value | symbol>;
-/**
- * Provides a prompt that allows the user to select an option by pressing a key.
- * This is useful for scenarios where each option is associated with a specific key.
- * @param {SelectOptions<Options, Value>} opts - Configuration options for the select key prompt. See {@link SelectOptions}.
- * @returns {Promise<Value | Symbol>} A promise that resolves to the value of the selected option, or a symbol for special cases such as abort. See {@link Value}.
- */
 export declare const selectKey: <Options extends Option<Value>[], Value extends string>(opts: SelectOptions<Options, Value>) => Promise<Value | symbol>;
 export type MultiSelectOptions<Options extends Option<Value>[], Value> = {
-    /**
-     * The primary message to be displayed above the multi-select list.
-     */
-    message: string;
-    /**
-     * The list of options from which users can select multiple items. See {@link Option}.
-     */
-    options: Options;
-    /**
-     * An array of values representing the options initially selected in the prompt. See {@link Value}.
-     * @optional
-     */
-    initialValues?: Value[];
-    /**
-     * Specifies whether at least one selection is required before submitting.
-     * @optional
-     */
-    required?: boolean;
-    /**
-     * The value of the option on which the cursor is initially placed when the command prompt opens. See {@link Value}.
-     * @optional
-     */
-    cursorAt?: Value;
+        message: string;
+        options: Options;
+        initialValues?: Value[];
+        required?: boolean;
+        cursorAt?: Value;
 };
-/**
- * Provides multi-select prompt functionality where the user can select multiple options from a list.
- * @param {MultiSelectOptions<Options, Value>} opts - Options to customize the multi-select prompt. See {@link MultiSelectOptions}.
- * @returns {Promise<Value[] | Symbol>} A promise that resolves to an array of selected values, or a symbol for special cases.
- */
 export declare const multiselect: <Options extends Option<Value>[], Value>(opts: MultiSelectOptions<Options, Value>) => Promise<Value[] | symbol>;
 export type GroupMultiSelectOptions<Options extends Option<Value>[], Value> = {
-    /**
-     * The primary message to be displayed above the group multi-select list.
-     */
-    message: string;
-    /**
-     * An object containing groups of options. Each key represents a group name,
-     * and the associated value is an array of options within that group. See {@link Option}.
-     */
-    options: Record<string, Options>;
-    /**
-     * An array of values representing the initially selected options across all groups. See {@link Value}.
-     * @optional
-     */
-    initialValues?: Value[];
-    /**
-     * Specifies whether at least one selection is required before submission is allowed.
-     * @optional
-     */
-    required?: boolean;
-    /**
-     * The value of the option on which the cursor will initially appear when the command prompt opens. See {@link Value}.
-     * @optional
-     */
-    cursorAt?: Value;
+        message: string;
+        options: Record<string, Options>;
+        initialValues?: Value[];
+        required?: boolean;
+        cursorAt?: Value;
 };
 export declare const groupMultiselect: <Options extends Option<Value>[], Value>(opts: GroupMultiSelectOptions<Options, Value>) => Promise<Value[] | symbol>;
-/**
- * Displays a formatted note in the console, with an optional title. The note is visually distinguished
- * from regular console output with ANSI color codes and styles to make it stand out. The function calculates
- * the length of the longest line to ensure the note is properly aligned and framed.
- *
- * @param {string} [message=""] - The main text of the note. Supports multiline strings.
- * @param {string} [title=""] - An optional title for the note. If provided, it'll be displayed above the message.
- */
 export declare const note: (message?: string, title?: string) => void;
-/**
- * Prints an abort message to the console. This is typically used to indicate
- * that a process or operation has been cancelled. The message is colored for
- * for emphasis and visual differentiation.
- *
- * @param {string} [message=""] - The cancellation message to display. This parameter
- * is optional; if omitted, the default styling will be used without a specific message.
- */
 export declare const cancel: (message?: string) => void;
-/**
- * Prints an introductory message to the console. This function is used to
- * Display a title or short message at the beginning of a script or application.
- * framed by a specified bar character for visual distinction.
- *
- * @param {string} [title=""] - The title or message to display. This parameter is optional; if omitted, only the framing bar will be printed.
- */
 export declare const intro: (title?: string) => void;
-/**
- * Prints a closing message to the console. Similar to the `intro` function,
- * `outro' is designed to indicate the end of a script or application execution
- * with a framed message for clear visual separation from the rest of the console output.
- *
- * @param {string} [message=""] - The final message to display. This parameter is optional; if omitted, only the border will be printed.
- */
 export declare const outro: (message?: string) => void;
 export type LogMessageOptions = {
-    /**
-     * A custom icon to be placed in front of the log message. This allows visual differentiation
-     * log messages based on their importance or category (e.g. info, error).
-     * @optional
-     */
-    symbol?: string;
+        symbol?: string;
 };
-/**
- * Logs a message to the console, with support for different types of messages (info, success, warning, error).
- */
 export declare const log: {
-    /**
-     * Logs an message, prefixed with a gray bar.
-     * @param {string} message - The message to log.
-     * @param {LogMessageOptions} [opts] - Optional settings for the log message. See {@link LogMessageOptions}.
-     */
-    message: (message?: string, { symbol }?: LogMessageOptions) => void;
-    /**
-     * Logs an information message, prefixed with a blue info icon.
-     * @param {string} message - The message to log.
-     */
-    info: (message: string) => void;
-    /**
-     * Logs a success message, preceded by a green check symbol.
-     * @param {string} message - The message to log.
-     */
-    success: (message: string) => void;
-    /**
-     * Logs a step message, typically used to indicate a step in a process, preceded by a green submit symbol.
-     * @param {string} message - The message to log.
-     */
-    step: (message: string) => void;
-    /**
-     * Logs a warning message, preceded by a yellow warning icon.
-     * @param {string} message - The message to log.
-     */
-    warn: (message: string) => void;
-    /** alias for `log.warn()`. See {@link log.warn}. */
-    warning: (message: string) => void;
-    /**
-     * Logs an error message, preceded by a red error icon.
-     * @param {string} message - The message to log.
-     */
-    error: (message: string) => void;
+        message: (message?: string, { symbol }?: LogMessageOptions) => void;
+        info: (message: string) => void;
+        success: (message: string) => void;
+        step: (message: string) => void;
+        warn: (message: string) => void;
+        warning: (message: string) => void;
+        error: (message: string) => void;
 };
-/**
- * Displays an animated spinner with a message, with functionality to start and stop the animation.
- * @returns an object with `start` and `stop` methods to control the spinner.
- */
 export declare const spinner: () => {
     start(message?: string): void;
     stop(message?: string): void;
@@ -285,11 +77,7 @@ export type PromptGroupAwaitedReturn<T> = {
     [P in keyof T]: Exclude<Awaited<T[P]>, symbol>;
 };
 export type PromptGroupOptions<T> = {
-    /**
-     * Control how the group can be canceled
-     * if one of the prompts is canceled.
-     */
-    onCancel?: (opts: {
+        onCancel?: (opts: {
         results: Prettify<Partial<PromptGroupAwaitedReturn<T>>>;
     }) => void;
 };
@@ -301,10 +89,4 @@ export type PromptGroup<T> = {
         results: Prettify<Partial<PromptGroupAwaitedReturn<Omit<T, P>>>>;
     }) => void | Promise<T[P] | void>;
 };
-/**
- * Groups multiple prompts together so that they can be displayed and resolved in sequence.
- * @param {PromptGroup<T>} prompts - The prompts to display in the group. See {@link PromptGroup}.
- * @param {PromptGroupOptions<T>} [opts] - Optional settings for the prompt group. See {@link PromptGroupOptions}.
- * @returns {Promise<Prettify<PromptGroupAwaitedReturn<T>>>} A promise that resolves to an object containing the results of each prompt in the group.
- */
 export declare const group: <T>(prompts: PromptGroup<T>, opts?: PromptGroupOptions<T>) => Promise<Prettify<PromptGroupAwaitedReturn<T>>>;

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

@@ -568,43 +568,22 @@ export const log = {
     process.stdout.write(`${parts.join("\n")}
 `);
   },
-  /**
-   * Logs an information message, prefixed with a blue info icon.
-   * @param {string} message - The message to log.
-   */
-  info: (message) => {
+    info: (message) => {
     log.message(message, { symbol: color.blue(S_INFO) });
   },
-  /**
-   * Logs a success message, preceded by a green check symbol.
-   * @param {string} message - The message to log.
-   */
-  success: (message) => {
+    success: (message) => {
     log.message(message, { symbol: color.green(S_SUCCESS) });
   },
-  /**
-   * Logs a step message, typically used to indicate a step in a process, preceded by a green submit symbol.
-   * @param {string} message - The message to log.
-   */
-  step: (message) => {
+    step: (message) => {
     log.message(message, { symbol: color.green(S_STEP_SUBMIT) });
   },
-  /**
-   * Logs a warning message, preceded by a yellow warning icon.
-   * @param {string} message - The message to log.
-   */
-  warn: (message) => {
+    warn: (message) => {
     log.message(message, { symbol: color.yellow(S_WARN) });
   },
-  /** alias for `log.warn()`. See {@link log.warn}. */
-  warning: (message) => {
+    warning: (message) => {
     log.warn(message);
   },
-  /**
-   * Logs an error message, preceded by a red error icon.
-   * @param {string} message - The message to log.
-   */
-  error: (message) => {
+    error: (message) => {
     log.message(message, { symbol: color.red(S_ERROR) });
   }
 };