@reliverse/relinka 1.3.7 → 1.4.0

package/bin/{relinka-types.d.ts → deprecated/types.d.ts}

@@ -1,194 +1,161 @@
-/// <reference types="node" />
-/** Configuration for special directory handling. */
-export type RelinkaSpecialDirsConfig = {
-    distDirNames?: string[];
-    useParentConfigInDist?: boolean;
-};
-/** Configuration for directory-related settings. */
-export type RelinkaDirsConfig = {
-    dailyLogs?: boolean;
-    logDir?: string;
-    maxLogFiles?: number;
-    specialDirs?: RelinkaSpecialDirsConfig;
-};
-/**
- * Configuration options for the Relinka logger.
- * All properties are optional to allow for partial configuration.
- * Defaults will be applied during initialization.
- */
-export type RelinkaConfig = {
-    debug?: boolean;
-    dirs?: RelinkaDirsConfig;
-    disableColors?: boolean;
-    logFilePath?: string;
-    saveLogsToFile?: boolean;
-    withTimestamp?: boolean;
-};
-/** Represents information about a log file for cleanup purposes. */
-export type LogFileInfo = {
-    path: string;
-    mtime: number;
-};
-/** Log level types used by the logger. */
-export type LogLevel = "error" | "info" | "success" | "verbose" | "warn";
-/**
- * Defines the level of logs as specific numbers or special number types.
- *
- * @type {0 | 1 | 2 | 3 | 4 | 5 | (number & {})} LogLevelDeprecated - Represents the log level.
- * @default 0 - Represents the default log level.
- */
-export type LogLevelDeprecated = 0 | 1 | 2 | 3 | 4 | 5 | (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"} LogTypeDeprecated - Represents the specific type of log message.
- */
-export type LogTypeDeprecated = "silent" | "fatal" | "error" | "warn" | "log" | "info" | "success" | "fail" | "ready" | "start" | "box" | "debug" | "trace" | "verbose";
-export type RelinkaOptionsDeprecated = {
-    /**
-     * An array of RelinkaReporterDeprecated instances used to handle and output log messages.
-     */
-    reporters: RelinkaReporterDeprecated[];
-    /**
-     * A record mapping LogTypeDeprecated to InputLogObject, defining the log configuration for each log type.
-     * See {@link LogTypeDeprecated} and {@link InputLogObject}.
-     */
-    types: Record<LogTypeDeprecated, InputLogObject>;
-    /**
-     * The minimum log level to output. See {@link LogLevelDeprecated}.
-     */
-    level: LogLevelDeprecated;
-    /**
-     * 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 timeframe.
-     */
-    throttle: number;
-    /**
-     * The minimum time in milliseconds that must elapse before a throttled log message can be logged again.
-     */
-    throttleMin: number;
-    /**
-     * The Node.js writable stream for standard output. See {@link NodeJS.WriteStream}.
-     * @optional
-     */
-    stdout?: NodeJS.WriteStream;
-    /**
-     * The Node.js 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: LogTypeDeprecated, defaults: InputLogObject) => (...args: any) => void;
-    /**
-     * Configuration options for formatting log messages. See {@link FormatOptions}.
-     */
-    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;
-};
-export type InputLogObject = {
-    /**
-     * The logging level of the message. See {@link LogLevelDeprecated}.
-     * @optional
-     */
-    level?: LogLevelDeprecated;
-    /**
-     * 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 LogTypeDeprecated}.
-     * @optional
-     */
-    type?: LogTypeDeprecated;
-    /**
-     * 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;
-};
-export type LogObject = {
-    /**
-     * The logging level of the message, overridden if required. See {@link LogLevelDeprecated}.
-     */
-    level: LogLevelDeprecated;
-    /**
-     * The type of log message, overridden if required. See {@link LogTypeDeprecated}.
-     */
-    type: LogTypeDeprecated;
-    /**
-     * 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;
-} & InputLogObject;
-export type RelinkaReporterDeprecated = {
-    /**
-     * 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 RelinkaOptionsDeprecated}.
-     */
-    log: (logObj: LogObject, ctx: {
-        options: RelinkaOptionsDeprecated;
-    }) => void;
-};
+/**
+ * Defines the level of logs as specific numbers or special number types.
+ *
+ * @type {0 | 1 | 2 | 3 | 4 | 5 | (number & {})} LogLevelDeprecated - Represents the log level.
+ * @default 0 - Represents the default log level.
+ */
+export type LogLevelDeprecated = 0 | 1 | 2 | 3 | 4 | 5 | (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"} LogTypeDeprecated - Represents the specific type of log message.
+ */
+export type LogTypeDeprecated = "silent" | "fatal" | "error" | "warn" | "log" | "info" | "success" | "fail" | "ready" | "start" | "box" | "debug" | "trace" | "verbose";
+export type RelinkaOptionsDeprecated = {
+    /**
+     * An array of RelinkaReporterDeprecated instances used to handle and output log messages.
+     */
+    reporters: RelinkaReporterDeprecated[];
+    /**
+     * A record mapping LogTypeDeprecated to InputLogObject, defining the log configuration for each log type.
+     * See {@link LogTypeDeprecated} and {@link InputLogObject}.
+     */
+    types: Record<LogTypeDeprecated, InputLogObject>;
+    /**
+     * The minimum log level to output. See {@link LogLevelDeprecated}.
+     */
+    level: LogLevelDeprecated;
+    /**
+     * 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 timeframe.
+     */
+    throttle: number;
+    /**
+     * The minimum time in milliseconds that must elapse before a throttled log message can be logged again.
+     */
+    throttleMin: number;
+    /**
+     * The Node.js writable stream for standard output. See {@link NodeJS.WriteStream}.
+     * @optional
+     */
+    stdout?: NodeJS.WriteStream;
+    /**
+     * The Node.js 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: LogTypeDeprecated, defaults: InputLogObject) => (...args: any) => void;
+    /**
+     * Configuration options for formatting log messages. See {@link FormatOptions}.
+     */
+    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;
+};
+export type InputLogObject = {
+    /**
+     * The logging level of the message. See {@link LogLevelDeprecated}.
+     * @optional
+     */
+    level?: LogLevelDeprecated;
+    /**
+     * 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 LogTypeDeprecated}.
+     * @optional
+     */
+    type?: LogTypeDeprecated;
+    /**
+     * 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;
+};
+export type LogObject = {
+    /**
+     * The logging level of the message, overridden if required. See {@link LogLevelDeprecated}.
+     */
+    level: LogLevelDeprecated;
+    /**
+     * The type of log message, overridden if required. See {@link LogTypeDeprecated}.
+     */
+    type: LogTypeDeprecated;
+    /**
+     * 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;
+} & InputLogObject;
+export type RelinkaReporterDeprecated = {
+    /**
+     * 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 RelinkaOptionsDeprecated}.
+     */
+    log: (logObj: LogObject, ctx: {
+        options: RelinkaOptionsDeprecated;
+    }) => void;
+};

package/bin/{relinka-impl/deprecated → 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 {};