@reliverse/relinka 1.3.7 → 1.3.8

package/bin/{relinka-impl → core-impl}/deprecated/utils/box.d.ts

@@ -1,114 +1,114 @@
-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;
-};
-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;
-};
-/**
- * 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;
-    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 {};
+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;
+};
+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;
+};
+/**
+ * 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;
+    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/bin/{relinka-impl → core-impl}/deprecated/utils/deprecatedColors.d.ts

@@ -1,69 +1,69 @@
-/**
- * Based on https://github.com/jorgebucaran/colorette
- * Read LICENSE file for more information
- * https://github.com/jorgebucaran/colorette/blob/20fc196d07d0f87c61e0256eadd7831c79b24108/index.js
- */
-declare const colorDefs: {
-    reset: (string: string) => string;
-    bold: (string: string) => string;
-    dim: (string: string) => string;
-    italic: (string: string) => string;
-    underline: (string: string) => string;
-    inverse: (string: string) => string;
-    hidden: (string: string) => string;
-    strikethrough: (string: string) => string;
-    black: (string: string) => string;
-    red: (string: string) => string;
-    green: (string: string) => string;
-    yellow: (string: string) => string;
-    blue: (string: string) => string;
-    magenta: (string: string) => string;
-    cyan: (string: string) => string;
-    white: (string: string) => string;
-    gray: (string: string) => string;
-    bgBlack: (string: string) => string;
-    bgRed: (string: string) => string;
-    bgGreen: (string: string) => string;
-    bgYellow: (string: string) => string;
-    bgBlue: (string: string) => string;
-    bgMagenta: (string: string) => string;
-    bgCyan: (string: string) => string;
-    bgWhite: (string: string) => string;
-    blackBright: (string: string) => string;
-    redBright: (string: string) => string;
-    greenBright: (string: string) => string;
-    yellowBright: (string: string) => string;
-    blueBright: (string: string) => string;
-    magentaBright: (string: string) => string;
-    cyanBright: (string: string) => string;
-    whiteBright: (string: string) => string;
-    bgBlackBright: (string: string) => string;
-    bgRedBright: (string: string) => string;
-    bgGreenBright: (string: string) => string;
-    bgYellowBright: (string: string) => string;
-    bgBlueBright: (string: string) => string;
-    bgMagentaBright: (string: string) => string;
-    bgCyanBright: (string: string) => string;
-    bgWhiteBright: (string: string) => string;
-};
-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<"bold" | "cyan" | "red" | "green" | "magenta" | "yellow" | "gray" | "bgWhite" | "white" | "reset" | "dim" | "italic" | "underline" | "inverse" | "hidden" | "strikethrough" | "black" | "blue" | "bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright", 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 {};
+/**
+ * Based on https://github.com/jorgebucaran/colorette
+ * Read LICENSE file for more information
+ * https://github.com/jorgebucaran/colorette/blob/20fc196d07d0f87c61e0256eadd7831c79b24108/index.js
+ */
+declare const colorDefs: {
+    reset: (string: string) => string;
+    bold: (string: string) => string;
+    dim: (string: string) => string;
+    italic: (string: string) => string;
+    underline: (string: string) => string;
+    inverse: (string: string) => string;
+    hidden: (string: string) => string;
+    strikethrough: (string: string) => string;
+    black: (string: string) => string;
+    red: (string: string) => string;
+    green: (string: string) => string;
+    yellow: (string: string) => string;
+    blue: (string: string) => string;
+    magenta: (string: string) => string;
+    cyan: (string: string) => string;
+    white: (string: string) => string;
+    gray: (string: string) => string;
+    bgBlack: (string: string) => string;
+    bgRed: (string: string) => string;
+    bgGreen: (string: string) => string;
+    bgYellow: (string: string) => string;
+    bgBlue: (string: string) => string;
+    bgMagenta: (string: string) => string;
+    bgCyan: (string: string) => string;
+    bgWhite: (string: string) => string;
+    blackBright: (string: string) => string;
+    redBright: (string: string) => string;
+    greenBright: (string: string) => string;
+    yellowBright: (string: string) => string;
+    blueBright: (string: string) => string;
+    magentaBright: (string: string) => string;
+    cyanBright: (string: string) => string;
+    whiteBright: (string: string) => string;
+    bgBlackBright: (string: string) => string;
+    bgRedBright: (string: string) => string;
+    bgGreenBright: (string: string) => string;
+    bgYellowBright: (string: string) => string;
+    bgBlueBright: (string: string) => string;
+    bgMagentaBright: (string: string) => string;
+    bgCyanBright: (string: string) => string;
+    bgWhiteBright: (string: string) => string;
+};
+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/bin/{relinka-impl → core-impl}/deprecated/utils/error.d.ts

@@ -1,6 +1,6 @@
-/**
- * Parses a stack trace string and normalizes its paths by removing the current working directory and the "file://" protocol.
- * @param {string} stack - The stack trace string.
- * @returns {string[]} An array of stack trace lines with normalized paths.
- */
-export declare function parseStack(stack: string): string[];
+/**
+ * Parses a stack trace string and normalizes its paths by removing the current working directory and the "file://" protocol.
+ * @param {string} stack - The stack trace string.
+ * @returns {string[]} An array of stack trace lines with normalized paths.
+ */
+export declare function parseStack(stack: string): string[];

package/bin/{relinka-impl → core-impl}/deprecated/utils/format.d.ts

@@ -1,14 +1,14 @@
-/**
- * Compiles a format string by replacing placeholders with appropriate position indices.
- * Caches compiled formats for efficiency.
- * @param {string} format - The format string containing the placeholders to replace.
- * @returns {string} The compiled format string with placeholders replaced by positional indices.
- */
-export declare function compileFormat(format: string): any;
-/**
- * Formats a string according to a custom format, using vsprintf for string formatting.
- * @param {string} format - The custom format string.
- * @param {any[]} argv - The arguments to format into the string.
- * @returns {string} The formatted string.
- */
-export declare function formatString(format: string, argv: any): string;
+/**
+ * Compiles a format string by replacing placeholders with appropriate position indices.
+ * Caches compiled formats for efficiency.
+ * @param {string} format - The format string containing the placeholders to replace.
+ * @returns {string} The compiled format string with placeholders replaced by positional indices.
+ */
+export declare function compileFormat(format: string): any;
+/**
+ * Formats a string according to a custom format, using vsprintf for string formatting.
+ * @param {string} format - The custom format string.
+ * @param {any[]} argv - The arguments to format into the string.
+ * @returns {string} The formatted string.
+ */
+export declare function formatString(format: string, argv: any): string;

package/bin/{relinka-impl → core-impl}/deprecated/utils/log.d.ts

@@ -1,13 +1,13 @@
-/**
- * Checks if the given argument is a simple JavaScript object.
- * @param {any} obj - The object to test.
- * @returns {boolean} `true` if the argument is a plain object, otherwise `false`.
- */
-export declare function isPlainObject(obj: any): boolean;
-/**
- * Determines whether the given argument is a protocol object. A log object must be a simple object and
- * must contain either a 'message' or 'args' field, but not a 'stack' field.
- * @param {any} arg - The argument to check.
- * @returns {boolean} `true` if the argument is a log object according to the specified criteria, otherwise `false`.
- */
-export declare function isLogObj(arg: any): boolean;
+/**
+ * Checks if the given argument is a simple JavaScript object.
+ * @param {any} obj - The object to test.
+ * @returns {boolean} `true` if the argument is a plain object, otherwise `false`.
+ */
+export declare function isPlainObject(obj: any): boolean;
+/**
+ * Determines whether the given argument is a protocol object. A log object must be a simple object and
+ * must contain either a 'message' or 'args' field, but not a 'stack' field.
+ * @param {any} arg - The argument to check.
+ * @returns {boolean} `true` if the argument is a log object according to the specified criteria, otherwise `false`.
+ */
+export declare function isLogObj(arg: any): boolean;

package/bin/{relinka-impl → core-impl}/deprecated/utils/stream.d.ts

@@ -1,15 +1,14 @@
-/// <reference types="node" />
-/**
- * Writes data to a specified NodeJS writable stream. This function supports streams that have a custom
- * `__write' method, and will fall back to the default `write' method if `__write' is not present.
- *
- * @param {any} data - The data to write to the stream. This can be a string, a buffer, or any data type
- * supported by the stream's `write' or `__write' method.
- * @param {NodeJS.WriteStream} stream - The writable stream to write the data to. This stream
- * must implement the `write' method, and can optionally implement a custom `__write' method.
- * @returns {boolean} `true` if the data has been completely processed by the write operation,
- * indicating that further writes can be performed immediately. Returns `false` if the data is
- * buffered by the stream, indicating that the `drain` event should be waited for before writing
- * more data.
- */
-export declare function writeStream(data: any, stream: NodeJS.WriteStream): any;
+/**
+ * Writes data to a specified NodeJS writable stream. This function supports streams that have a custom
+ * `__write' method, and will fall back to the default `write' method if `__write' is not present.
+ *
+ * @param {any} data - The data to write to the stream. This can be a string, a buffer, or any data type
+ * supported by the stream's `write' or `__write' method.
+ * @param {NodeJS.WriteStream} stream - The writable stream to write the data to. This stream
+ * must implement the `write' method, and can optionally implement a custom `__write' method.
+ * @returns {boolean} `true` if the data has been completely processed by the write operation,
+ * indicating that further writes can be performed immediately. Returns `false` if the data is
+ * buffered by the stream, indicating that the `drain` event should be waited for before writing
+ * more data.
+ */
+export declare function writeStream(data: any, stream: NodeJS.WriteStream): any;

package/bin/{relinka-impl → core-impl}/deprecated/utils/string.d.ts

@@ -1,50 +1,50 @@
-/**
- * Removes ANSI escape codes from a given string. This is particularly useful for
- * processing text that contains formatting codes, such as colors or styles, so that the
- * the raw text without any visual formatting.
- *
- * @param {string} text - The text string from which to strip the ANSI escape codes.
- * @returns {string} The text without ANSI escape codes.
- */
-export declare function stripAnsi(text: string): string;
-/**
- * Centers a string within a specified total width, padding it with spaces or another specified character.
- * If the string is longer than the total width, it is returned as is.
- *
- * @param {string} str - The string to centre.
- * @param {number} len - The total width in which to centre the string.
- * @param {string} [space=" "] - The character to use for padding. Defaults to a space.
- * @returns {string} The centred string.
- */
-export declare function centerAlign(str: string, len: number, space?: string): string;
-/**
- * Right-justifies a string within a given total width, padding it with whitespace or another specified character.
- * If the string is longer than the total width, it is returned as is.
- *
- * @param {string} str - The string to right-justify.
- * @param {number} len - The total width to align the string.
- * @param {string} [space=" "] - The character to use for padding. Defaults to a space.
- * @returns {string} The right-justified string.
- */
-export declare function rightAlign(str: string, len: number, space?: string): string;
-/**
- * Left-aligns a string within a given total width, padding it with whitespace or another specified character on the right.
- * If the string is longer than the total width, it is returned as is.
- *
- * @param {string} str - The string to align left.
- * @param {number} len - The total width to align the string.
- * @param {string} [space=" "] - The character to use for padding. Defaults to a space.
- * @returns {string} The left-justified string.
- */
-export declare function leftAlign(str: string, len: number, space?: string): string;
-/**
- * Aligns a string (left, right, or centre) within a given total width, padding it with spaces or another specified character.
- * If the string is longer than the total width, it is returned as is. This function acts as a wrapper for individual alignment functions.
- *
- * @param {"left" | "right" | "centre"} alignment - The desired alignment of the string.
- * @param {string} str - The string to align.
- * @param {number} len - The total width in which to align the string.
- * @param {string} [space=" "] - The character to use for padding. Defaults to a space.
- * @returns {string} The aligned string, according to the given alignment.
- */
-export declare function align(alignment: "left" | "right" | "center", str: string, len: number, space?: string): string;
+/**
+ * Removes ANSI escape codes from a given string. This is particularly useful for
+ * processing text that contains formatting codes, such as colors or styles, so that the
+ * the raw text without any visual formatting.
+ *
+ * @param {string} text - The text string from which to strip the ANSI escape codes.
+ * @returns {string} The text without ANSI escape codes.
+ */
+export declare function stripAnsi(text: string): string;
+/**
+ * Centers a string within a specified total width, padding it with spaces or another specified character.
+ * If the string is longer than the total width, it is returned as is.
+ *
+ * @param {string} str - The string to centre.
+ * @param {number} len - The total width in which to centre the string.
+ * @param {string} [space=" "] - The character to use for padding. Defaults to a space.
+ * @returns {string} The centred string.
+ */
+export declare function centerAlign(str: string, len: number, space?: string): string;
+/**
+ * Right-justifies a string within a given total width, padding it with whitespace or another specified character.
+ * If the string is longer than the total width, it is returned as is.
+ *
+ * @param {string} str - The string to right-justify.
+ * @param {number} len - The total width to align the string.
+ * @param {string} [space=" "] - The character to use for padding. Defaults to a space.
+ * @returns {string} The right-justified string.
+ */
+export declare function rightAlign(str: string, len: number, space?: string): string;
+/**
+ * Left-aligns a string within a given total width, padding it with whitespace or another specified character on the right.
+ * If the string is longer than the total width, it is returned as is.
+ *
+ * @param {string} str - The string to align left.
+ * @param {number} len - The total width to align the string.
+ * @param {string} [space=" "] - The character to use for padding. Defaults to a space.
+ * @returns {string} The left-justified string.
+ */
+export declare function leftAlign(str: string, len: number, space?: string): string;
+/**
+ * Aligns a string (left, right, or centre) within a given total width, padding it with spaces or another specified character.
+ * If the string is longer than the total width, it is returned as is. This function acts as a wrapper for individual alignment functions.
+ *
+ * @param {"left" | "right" | "centre"} alignment - The desired alignment of the string.
+ * @param {string} str - The string to align.
+ * @param {number} len - The total width in which to align the string.
+ * @param {string} [space=" "] - The character to use for padding. Defaults to a space.
+ * @returns {string} The aligned string, according to the given alignment.
+ */
+export declare function align(alignment: "left" | "right" | "center", str: string, len: number, space?: string): string;