@reliverse/relinka 1.1.2 → 1.1.4

package/dist-npm/types/general.d.ts

@@ -90,155 +90,44 @@ export type ChoiceOptionalOptions = {
 export type ChoiceOptions = ChoiceRequiredOptions & ChoiceOptionalOptions;
 export type PromptType = "text" | "number" | "confirm" | "numSelect" | "select" | "multiselect" | "password" | "date" | "start" | "nextSteps" | "end";
 export type RelinkaOptions = {
-    /**
-     * An array of RelinkaReporter instances used to handle and output log messages.
-     */
-    reporters: RelinkaReporter[];
-    /**
-     * A record mapping LogType to InputLogObject, defining the log configuration for each log type.
-     * See {@link LogType} and {@link InputLogObject}.
-     */
-    types: Record<LogType, InputLogObject>;
-    /**
-     * The minimum log level to output. See {@link LogLevel}.
-     */
-    level: LogLevel;
-    /**
-     * Default properties applied to all log messages unless overridden. See {@link InputLogObject}.
-     */
-    defaults: InputLogObject;
-    /**
-     * The maximum number of times a log message can be repeated within a given frame of time.
-     */
-    throttle: number;
-    /**
-     * The minimum time in milliseconds that must elapse before a throttled log message can be logged again.
-     */
-    throttleMin: number;
-    /**
-     * The Node writable stream for standard output. See {@link NodeJS.WriteStream}.
-     * @optional
-     */
-    stdout?: NodeJS.WriteStream;
-    /**
-     * The Node writeable stream for standard error output. See {@link NodeJS.WriteStream}.
-     * @optional
-     */
-    stderr?: NodeJS.WriteStream;
-    /**
-     * A function that allows you to mock log messages for testing purposes.
-     * @optional
-     */
-    mockFn?: (type: LogType, defaults: InputLogObject) => (...args: any) => void;
-    /**
-     * Custom prompt function to use. It can be undefined.
-     * @optional
-     */
-    prompt?: typeof import("../components/mono/monoTwo.js").prompt | undefined;
-    /**
-     * Configuration options for formatting log messages. See {@link FormatOptions}.
-     */
-    formatOptions: FormatOptions;
+        reporters: RelinkaReporter[];
+        types: Record<LogType, InputLogObject>;
+        level: LogLevel;
+        defaults: InputLogObject;
+        throttle: number;
+        throttleMin: number;
+        stdout?: NodeJS.WriteStream;
+        stderr?: NodeJS.WriteStream;
+        mockFn?: (type: LogType, defaults: InputLogObject) => (...args: any) => void;
+        prompt?: typeof import("../components/mono/monoTwo.js").prompt | undefined;
+        formatOptions: FormatOptions;
 };
-/**
- * @see https://nodejs.org/api/util.html#util_util_inspect_object_showhidden_depth_colors
- */
 export type FormatOptions = {
-    /**
-     * The maximum number of columns to output, affects formatting.
-     * @optional
-     */
-    columns?: number;
-    /**
-     * Whether to include timestamp information in log messages.
-     * @optional
-     */
-    date?: boolean;
-    /**
-     * Whether to use colors in the output.
-     * @optional
-     */
-    colors?: boolean;
-    /**
-     * Specifies whether or not the output should be compact. Accepts a boolean or numeric level of compactness.
-     * @optional
-     */
-    compact?: boolean | number;
-    /**
-     * Allows additional custom formatting options.
-     */
-    [key: string]: unknown;
+        columns?: number;
+        date?: boolean;
+        colors?: boolean;
+        compact?: boolean | number;
+        [key: string]: unknown;
 };
 export type InputLogObject = {
-    /**
-     * The logging level of the message. See {@link LogLevel}.
-     * @optional
-     */
-    level?: LogLevel;
-    /**
-     * A string tag to categorize or identify the log message.
-     * @optional
-     */
-    tag?: string;
-    /**
-     * The type of log message, which affects how it's processed and displayed. See {@link LogType}.
-     * @optional
-     */
-    type?: LogType;
-    /**
-     * The main log message text.
-     * @optional
-     */
-    message?: string;
-    /**
-     * Additional text or texts to be logged with the message.
-     * @optional
-     */
-    additional?: string | string[];
-    /**
-     * Additional arguments to be logged with the message.
-     * @optional
-     */
-    args?: any[];
-    /**
-     * The date and time when the log message was created.
-     * @optional
-     */
-    date?: Date;
+        level?: LogLevel;
+        tag?: string;
+        type?: LogType;
+        message?: string;
+        additional?: string | string[];
+        args?: any[];
+        date?: Date;
 };
 export type LogObject = {
-    /**
-     * The logging level of the message, overridden if required. See {@link LogLevel}.
-     */
-    level: LogLevel;
-    /**
-     * The type of log message, overridden if required. See {@link LogType}.
-     */
-    type: LogType;
-    /**
-     * A string tag to categorize or identify the log message, overridden if necessary.
-     */
-    tag: string;
-    /**
-     * Additional arguments to be logged with the message, overridden if necessary.
-     */
-    args: any[];
-    /**
-     * The date and time the log message was created, overridden if necessary.
-     */
-    date: Date;
-    /**
-     * Allows additional custom properties to be set on the log object.
-     */
-    [key: string]: unknown;
+        level: LogLevel;
+        type: LogType;
+        tag: string;
+        args: any[];
+        date: Date;
+        [key: string]: unknown;
 } & InputLogObject;
 export type RelinkaReporter = {
-    /**
-     * Defines how a log message is processed and displayed by this reporter.
-     * @param logObj The LogObject containing the log information to process. See {@link LogObject}.
-     * @param ctx An object containing context information such as options. See {@link RelinkaOptions}.
-     */
-    log: (logObj: LogObject, ctx: {
+        log: (logObj: LogObject, ctx: {
         options: RelinkaOptions;
     }) => void;
 };

package/dist-npm/types/keypress.d.ts

@@ -44,9 +44,6 @@ export type Keypress = {
     raw: string;
 };
 export type KeypressCallback = (key: Keypress) => void;
-/**
- * Type definition for the listenForKeys function
- */
 export type ListenForKeys = {
     (stream: Readable, callback: KeypressCallback): () => void;
     parse: (s: string | Buffer, enc?: string) => Keypress | Keypress[];

package/dist-npm/types/keypress.js

@@ -1,4 +1,4 @@
-export var KeyName = /* @__PURE__ */ ((KeyName2) => {
+export var KeyName =  ((KeyName2) => {
   KeyName2["RETURN"] = "return";
   KeyName2["ENTER"] = "enter";
   KeyName2["TAB"] = "tab";

package/dist-npm/types/readline.d.ts

@@ -1,11 +1,4 @@
 import type { Duplex } from "node:stream";
-/**
- * `RelinkaReadline` is a re-implementation of `readline.Interface` from Node.
- * It is reimplemented because of 3 reasons:
- * 1. The `readline.Interface` API is not complete; it's missing for example `clearLine`.
- * 2. The input/output streams are not generics, meaning they're inexact.
- * 3. Since ReadLine isn't built-in Typescript Global NodeJS type, it'd force us to ship `@types/node` as a dependency to all users.
- */
 export type RelinkaReadline = {
     output: Duplex & {
         mute: () => void;
@@ -33,6 +26,5 @@ export type Context = {
     signal?: AbortSignal;
 };
 export type Prompt<Value, Config> = (config: Config, context?: Context) => Promise<Value> & {
-    /** @deprecated pass an AbortSignal in the context options instead. */
-    cancel: () => void;
+        cancel: () => void;
 };

package/dist-npm/types/relinka.d.ts

@@ -1,11 +1,4 @@
 import type { Duplex } from "node:stream";
-/**
- * `RelinkaReadline` is a re-implementation of `readline.Interface` from Node.js.
- * It's reimplemented because of 3 reasons:
- * 1. The `readline.Interface` API is not complete; it's missing for example `clearLine`.
- * 2. The input/output streams are not generics, meaning they're inexact.
- * 3. Since ReadLine isn't built-in Typescript Global NodeJS type, it'd force us to ship `@types/node` as a dependency to all users.
- */
 export type RelinkaReadline = {
     output: Duplex & {
         mute: () => void;
@@ -33,6 +26,5 @@ export type Context = {
     signal?: AbortSignal;
 };
 export type Prompt<Value, Config> = (config: Config, context?: Context) => Promise<Value> & {
-    /** @deprecated pass an AbortSignal in the context options instead. See {@link https://github.com/SBoudrias/Relinka.js#canceling-prompt} */
-    cancel: () => void;
+        cancel: () => void;
 };

package/dist-npm/types/utils.d.ts

@@ -9,21 +9,9 @@ export type LiteralUnion<T extends F, F = string> = T | (F & {});
 export type KeyUnion<T> = LiteralUnion<Extract<keyof T, string>>;
 export type DistributiveMerge<A, B> = A extends any ? Prettify<Omit<A, keyof B> & B> : never;
 export type UnionToIntersection<T> = (T extends any ? (input: T) => void : never) extends (input: infer Intersection) => void ? Intersection : never;
-/**
- * @hidden
- */
 type __Pick<O extends object, K extends keyof O> = {
     [P in K]: O[P];
 } & {};
-/**
- * @hidden
- */
 export type _Pick<O extends object, K extends Key> = __Pick<O, keyof O & K>;
-/**
- * Extract out of `O` the fields of key `K`
- * @param O to extract from
- * @param K to chose fields
- * @returns [[Object]]
- */
 export type Pick<O extends object, K extends Key> = O extends unknown ? _Pick<O, K> : never;
 export {};

package/dist-npm/utils/box.d.ts

@@ -1,114 +1,24 @@
 export type BoxBorderStyle = {
-    /**
-     * Top left corner
-     * @example `┌`
-     * @example `╔`
-     * @example `╓`
-     */
-    tl: string;
-    /**
-     * Top right corner
-     * @example `┐`
-     * @example `╗`
-     * @example `╖`
-     */
-    tr: string;
-    /**
-     * Bottom left corner
-     * @example `└`
-     * @example `╚`
-     * @example `╙`
-     */
-    bl: string;
-    /**
-     * Bottom right corner
-     * @example `┘`
-     * @example `╝`
-     * @example `╜`
-     */
-    br: string;
-    /**
-     * Horizontal line
-     * @example `─`
-     * @example `═`
-     * @example `─`
-     */
-    h: string;
-    /**
-     * Vertical line
-     * @example `│`
-     * @example `║`
-     * @example `║`
-     */
-    v: string;
+        tl: string;
+        tr: string;
+        bl: string;
+        br: string;
+        h: string;
+        v: string;
 };
 declare const boxStylePresets: Record<string, BoxBorderStyle>;
 export type BoxStyle = {
-    /**
-     * The border color
-     * @default 'white'
-     */
-    borderColor: "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright";
-    /**
-     * The border style
-     * @default 'solid'
-     * @example 'single-double-rounded'
-     * @example
-     * ```ts
-     * {
-     *   tl: '┌',
-     *   tr: '┐',
-     *   bl: '└',
-     *   br: '┘',
-     *   h: '─',
-     *   v: '│',
-     * }
-     * ```
-     */
-    borderStyle: BoxBorderStyle | keyof typeof boxStylePresets;
-    /**
-     * The vertical alignment of the text
-     * @default 'center'
-     */
-    valign: "top" | "center" | "bottom";
-    /**
-     * The padding of the box
-     * @default 2
-     */
-    padding: number;
-    /**
-     * The left margin of the box
-     * @default 1
-     */
-    marginLeft: number;
-    /**
-     * The top margin of the box
-     * @default 1
-     */
-    marginTop: number;
-    /**
-     * The top margin of the box
-     * @default 1
-     */
-    marginBottom: number;
+        borderColor: "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright";
+        borderStyle: BoxBorderStyle | keyof typeof boxStylePresets;
+        valign: "top" | "center" | "bottom";
+        padding: number;
+        marginLeft: number;
+        marginTop: number;
+        marginBottom: number;
 };
-/**
- * The border options of the box
- */
 export type BoxOpts = {
-    /**
-     * Title that will be displayed on top of the box
-     * @example 'Hello World'
-     * @example 'Hello {name}'
-     */
-    title?: string;
+        title?: string;
     style?: Partial<BoxStyle>;
 };
-/**
- * Creates a styled box with text content, customizable via options.
- * @param {string} text - The text to display in the box.
- * @param {BoxOpts} [_opts={}] - Optional settings for the appearance and behavior of the box. See {@link BoxOpts}.
- * @returns {string} The formatted box as a string, ready for printing or logging.
- */
 export declare function box(text: string, _opts?: BoxOpts): string;
 export {};

package/dist-npm/utils/color.d.ts

@@ -1,8 +1,3 @@
-/**
- * Based on https://github.com/jorgebucaran/colorette
- * Read LICENSE file for more information
- * https://github.com/jorgebucaran/colorette/blob/20fc196d07d0f87c61e0256eadd7831c79b24108/index
- */
 declare const colorDefs: {
     reset: (string: string) => string;
     bold: (string: string) => string;
@@ -48,22 +43,7 @@ declare const colorDefs: {
 };
 export type ColorName = keyof typeof colorDefs;
 export type ColorFunction = (text: string | number) => string;
-/**
- * An object containing functions for coloring text. Each function corresponds to a terminal color. See {@link ColorName} for available colors.
- */
 export declare const colors: Record<ColorName, ColorFunction>;
-/**
- * Gets a color function by name, with an option for a fallback color if the requested color is not found.
- * @param {ColorName} color - The name of the color function to get. See {@link ColorName}.
- * @param {ColorName} [fallback="reset"] - The name of the fallback color function if the requested color is not found. See {@link ColorName}.
- * @returns {ColorFunction} The color function that corresponds to the requested color, or the fallback color function. See {@link ColorFunction}.
- */
 export declare function getColor(color: ColorName, fallback?: ColorName): ColorFunction;
-/**
- * Applies a specified color to a given text string or number.
- * @param {ColorName} color - The color to apply. See {@link ColorName}.
- * @param {string | number} text - The text to color.
- * @returns {string} The colored text.
- */
 export declare function colorize(color: ColorName, text: string | number): string;
 export {};

package/dist-npm/utils/colorize.js

@@ -103,10 +103,11 @@ export function colorize(text, colorName, typography) {
     "rainbowGradient",
     "viceGradient"
   ];
-  if (gradientColors.includes(colorName ?? "") && typography)
+  if (gradientColors.includes(colorName ?? "") && typography) {
     throw new Error(
       "[colorize] Cannot apply typography to gradient color.\n\u2502  Use regular colorize()'s color or remove typography."
     );
+  }
   if (!gradientColors.includes(colorName ?? "") && typography) {
     switch (typography) {
       case "bold":

package/dist-npm/utils/component.d.ts

@@ -68,8 +68,7 @@ export declare const log: {
     success: (message: string) => void;
     step: (message: string) => void;
     warn: (message: string) => void;
-    /** alias for `log.warn()`. */
-    warning: (message: string) => void;
+        warning: (message: string) => void;
     error: (message: string) => void;
 };
 export declare const spinner: () => {
@@ -81,11 +80,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;
 };
@@ -97,26 +92,10 @@ export type PromptGroup<T> = {
         results: Prettify<Partial<PromptGroupAwaitedReturn<Omit<T, P>>>>;
     }) => void | Promise<T[P] | void>;
 };
-/**
- * Define a group of prompts to be displayed
- * and return a results of objects within the group
- */
 export declare const group: <T>(prompts: PromptGroup<T>, opts?: PromptGroupOptions<T>) => Promise<Prettify<PromptGroupAwaitedReturn<T>>>;
 export type Task = {
-    /**
-     * Task title
-     */
-    title: string;
-    /**
-     * Task function
-     */
-    task: (message: (string: string) => void) => string | Promise<string> | void | Promise<void>;
-    /**
-     * If enabled === false the task will be skipped
-     */
-    enabled?: boolean;
+        title: string;
+        task: (message: (string: string) => void) => string | Promise<string> | void | Promise<void>;
+        enabled?: boolean;
 };
-/**
- * Define a group of tasks to be executed
- */
 export declare const tasks: (tasks: Task[]) => Promise<void>;

package/dist-npm/utils/component.js

@@ -517,8 +517,7 @@ export const log = {
   warn: (message) => {
     log.message(message, { symbol: color.yellow(S_WARN) });
   },
-  /** alias for `log.warn()`. */
-  warning: (message) => {
+    warning: (message) => {
     log.warn(message);
   },
   error: (message) => {

package/dist-npm/utils/constants.d.ts

@@ -1,26 +1,5 @@
 import type { LogObject } from "../types/general.js";
-/**
- * Defines the level of logs as specific numbers or special number types.
- *
- * @type {0 | 1 | 2 | 3 | 4 | 5 | (number & {})} LogLevel - Represents the log level.
- * @default 0 - Represents the default log level.
- */
 export type LogLevel = 0 | 1 | 2 | 3 | 4 | 5 | (number & {});
-/**
- * A mapping of `LogType` to its corresponding numeric log level.
- *
- * @type {Record<LogType, number>} LogLevels - key-value pairs of log types to their numeric levels. See {@link LogType}.
- */
 export declare const LogLevels: Record<LogType, number>;
-/**
- * Lists the types of log messages supported by the system.
- *
- * @type {"silent" | "fatal" | "error" | "warn" | "log" | "info" | "success" | "fail" | "ready" | "start" | "box" | "debug" | "trace" | "verbose"} LogType - Represents the specific type of log message.
- */
 export type LogType = "silent" | "fatal" | "error" | "warn" | "log" | "info" | "success" | "fail" | "ready" | "start" | "box" | "debug" | "trace" | "verbose";
-/**
- * Maps `LogType` to a `Partial<LogObject>`, primarily defining the log level.
- *
- * @type {Record<LogType, Partial<LogObject>>} LogTypes - key-value pairs of log types to partial log objects, specifying log levels. See {@link LogType} and {@link LogObject}.
- */
 export declare const LogTypes: Record<LogType, Partial<LogObject>>;

package/dist-npm/utils/constants.js

@@ -15,26 +15,26 @@ export const LogLevels = {
   verbose: Number.POSITIVE_INFINITY
 };
 export const LogTypes = {
-  // Silent
+  
   silent: {
     level: -1
   },
-  // Level 0
+  
   fatal: {
     level: LogLevels.fatal
   },
   error: {
     level: LogLevels.error
   },
-  // Level 1
+  
   warn: {
     level: LogLevels.warn
   },
-  // Level 2
+  
   log: {
     level: LogLevels.log
   },
-  // Level 3
+  
   info: {
     level: LogLevels.info
   },
@@ -53,15 +53,15 @@ export const LogTypes = {
   box: {
     level: LogLevels.info
   },
-  // Level 4
+  
   debug: {
     level: LogLevels.debug
   },
-  // Level 5
+  
   trace: {
     level: LogLevels.trace
   },
-  // Verbose
+  
   verbose: {
     level: LogLevels.verbose
   }

package/dist-npm/utils/decoder.d.ts

@@ -1,9 +1,4 @@
 import { Buffer } from "safe-buffer";
-/**
- * StringDecoder provides an interface for efficiently splitting a series of
- * buffers into a series of JS strings without breaking apart multi-byte
- * characters.
- */
 export declare class StringDecoder {
     encoding: BufferEncoding;
     lastNeed: number;
@@ -14,16 +9,6 @@ export declare class StringDecoder {
     endFn?: (buf?: Buffer) => string;
     writeFn: (buf: Buffer) => string;
     constructor(encoding?: BufferEncoding | string);
-    /**
-     * Writes the buffer and returns the decoded string.
-     * @param buf - The buffer to write.
-     * @returns The decoded string.
-     */
-    write(buf: Buffer): string;
-    /**
-     * Ends the decoding and returns any remaining characters.
-     * @param buf - Optional buffer to write before ending.
-     * @returns The final decoded string.
-     */
-    end(buf?: Buffer): string;
+        write(buf: Buffer): string;
+        end(buf?: Buffer): string;
 }