@homedev/framework 1.0.5 → 1.0.6

package/dist/index.d.ts

@@ -1,652 +0,0 @@
-export declare type ColorValue = string | {
-    r: number;
-    g: number;
-    b: number;
-} | [number, number, number] | number;
-
-/**
- * Parses and queries command-line arguments.
- *
- * Accepts argv-like arrays and parses only the provided tokens.
- *
- * @public
- */
-export declare class CommandLineArgs {
-    #private;
-    /**
-     * Creates a parser for the provided command-line tokens.
-     *
-     * @param args - Argument tokens to parse.
-     * @param definitions - Known argument definitions used by usage output.
-     */
-    constructor(args: string[], definitions?: CommandLineArgumentDefinition[]);
-    /**
-     * Returns normalized parsed argument tokens.
-     */
-    get args(): string[];
-    /**
-     * Returns non-option positional values.
-     */
-    get positionals(): string[];
-    /**
-     * Returns true if a flag was provided.
-     *
-     * @param flag - Option name with or without `-`/`--` prefix.
-     */
-    has(flag: string): boolean;
-    /**
-     * Returns values for a flag.
-     *
-     * @param flag - Option name with or without `-`/`--` prefix.
-     */
-    getArgs(flag: string): string[];
-    /**
-     * Returns true for boolean flags, first value for valued flags, or undefined.
-     *
-     * @param flag - Option name with or without `-`/`--` prefix.
-     */
-    get(flag: string): string | true | undefined;
-    /**
-     * Returns all options as a plain object.
-     */
-    toObject(): Record<string, string[] | true>;
-    /**
-     * Builds usage output from provided argument definitions.
-     *
-     * @param command - Command name shown in usage output.
-     */
-    usage(command?: string): string;
-}
-
-/**
- * Defines an argument for usage output.
- *
- * @public
- */
-export declare interface CommandLineArgumentDefinition {
-    name: string;
-    alias?: string;
-    description?: string;
-    takesValue?: boolean;
-    multiple?: boolean;
-    valueName?: string;
-}
-
-/**
- * Parsed representation of a single CLI option.
- *
- * @public
- */
-export declare interface CommandLineOption {
-    values: string[];
-    sawEqualsStyle: boolean;
-}
-
-/**
- * Checks whether a file is readable.
- *
- * @param fileName - File path to check.
- * @returns True when the file can be accessed for reading.
- * @public
- */
-export declare const exists: (fileName: string) => Promise<boolean>;
-
-/**
- * @public
- */
-export declare interface FilePatternOptions {
-    cwd: string;
-    filter?: (fileName: string, index: number, array: string[]) => boolean;
-    map: (fileName: string, index: number, array: string[]) => Promise<any>;
-}
-
-/**
- * Resolves the working directory used by file utilities.
- *
- * @param cwd - Optional absolute or relative directory override.
- * @returns Absolute working directory path.
- * @public
- */
-export declare const getCwd: (cwd?: string) => string;
-
-/**
- * Maps files matching a glob pattern (or a single path) with async projection.
- *
- * @param pattern - Glob pattern(s) or direct file path.
- * @param options - Mapping options including cwd, optional filter, and map function.
- * @returns Mapped result for a direct path, or mapped array for glob patterns.
- * @public
- */
-export declare const globMap: <T>(pattern: string | string[], options: FilePatternOptions) => Promise<T[] | T>;
-
-/**
- * @public
- */
-export declare const importGlob: (patterns: string[], options?: ImportOptions) => Promise<any[]>;
-
-/**
- * @public
- */
-export declare const importList: (modules: string[], options?: ImportOptions) => Promise<any[]>;
-
-/**
- * @public
- */
-export declare interface ImportOptions {
-    cwd?: string;
-    resolveDefault?: boolean | 'only';
-    filter?: (name: string) => boolean | undefined;
-    fail?: (name: string, error: any) => boolean | undefined;
-    map?: (module: any, name: string) => any;
-}
-
-/**
- * @public
- * @param fileName - Name or path of the file to load.
- * @param options - Loading options including parser selection and lookup directories.
- * @returns Parsed file content and path metadata.
- * @throws - When no parser is resolved or locating/reading/parsing fails.
- */
-export declare const loadFormat: <T = any>(fileName: string, options?: LoadOptions) => Promise<LoadResult<T>>;
-
-/**
- * @public
- */
-export declare interface LoadFormatParser {
-    matching?: string[];
-    fn: (data: string) => any;
-}
-
-/**
- * @public
- */
-export declare interface LoadOptions {
-    dirs?: string[];
-    parsers?: Record<string, LoadFormatParser>;
-    format?: string;
-}
-
-/**
- * Result of loading and parsing a file.
- *
- * @typeParam T - Parsed content type.
- * @public
- */
-export declare interface LoadResult<T> {
-    fullPath: string;
-    folderPath: string;
-    content: T;
-}
-
-/**
- * Resolves a file path by searching the provided directories.
- *
- * @param fileName - File name or path to locate.
- * @param dirs - Optional directories to search when fileName is relative.
- * @returns Absolute path to the first matching file.
- * @throws - When no matching file is found.
- * @public
- */
-export declare const locate: (fileName: string, dirs?: string[]) => Promise<string>;
-
-/**
- * @public
- */
-export declare type LogFunction = (className: string, ...args: any[]) => void;
-
-/**
- * @public
- */
-export declare class Logger {
-    options: LoggerOptions;
-    /**
-     * Creates a logger with optional configuration overrides.
-     *
-     * @param options - Partial logger options to merge with defaults.
-     */
-    constructor(options?: Partial<LoggerOptions>);
-    /**
-     * Writes a log entry when the message level passes the configured filter.
-     *
-     * @param className - Log level name.
-     * @param args - Log payload values.
-     */
-    write(className: string, ...args: any[]): void;
-    /**
-     * Wraps a text in an RGB color code for console output.
-     * @param text - The text to color.
-     * @param color - The RGB color.
-     * @returns The colored text for console output.
-     */
-    color(text: string, color: ColorValue): string;
-    /**
-     * Writes an INFO level log entry.
-     *
-     * @param args - Log payload values.
-     */
-    info(...args: any[]): void;
-    /**
-     * Writes an ERROR level log entry.
-     *
-     * @param args - Log payload values.
-     */
-    error(...args: any[]): void;
-    /**
-     * Writes a WARN level log entry.
-     *
-     * @param args - Log payload values.
-     */
-    warn(...args: any[]): void;
-    /**
-     * Writes a DEBUG level log entry.
-     *
-     * @param args - Log payload values.
-     */
-    debug(...args: any[]): void;
-    /**
-     * Writes a VERBOSE level log entry.
-     *
-     * @param args - Log payload values.
-     */
-    verbose(...args: any[]): void;
-}
-
-/**
- * @public
- */
-export declare interface LoggerOptions {
-    level: string;
-    showClass: boolean;
-    useColors: boolean;
-    levels: string[];
-    timeStamp: boolean;
-    timeLocale?: string;
-    timeOptions?: Intl.DateTimeFormatOptions;
-    logFunction: LogFunction;
-    onClass: (className: string) => string;
-    onTime: (time: string, className: string) => string;
-    onPrefix: (prefix: string, className: string) => string;
-}
-
-/**
- * Fluent markdown content builder.
- *
- * @public
- */
-export declare class Markdown extends StringBuilder {
-    #private;
-    /**
-     * Writes a markdown heading and trailing blank line.
-     *
-     * @param text - Heading text.
-     * @param level - Heading level from 1 to 6.
-     */
-    header(text: string, level?: number): this;
-    /**
-     * Starts a fenced code block and optionally writes code and closes it.
-     *
-     * @param code - Optional code content.
-     * @param language - Optional code language id.
-     */
-    codeBlock(code?: string, language?: string): this;
-    /** Closes the current fenced code block. */
-    endCodeBlock(): this;
-    /** Writes an inline markdown link. */
-    link(text: string, url: string, title?: string): this;
-    /** Writes a markdown table from headers and rows. */
-    table(headers: string[], rows: string[][]): this;
-    /** Writes one or more quoted lines. */
-    blockquote(text: string): this;
-    /** Writes bold text. */
-    bold(text: string): this;
-    /** Writes italic text. */
-    italic(text: string): this;
-    /** Writes a bullet item line. */
-    item(text: string): this;
-    /** Writes bullet items from an array or key-value map. */
-    items(items: string[] | Record<string, any>): this;
-    /** Writes an ordered list starting from the provided number. */
-    orderedList(items: string[], start?: number): this;
-    /** Writes inline code text. */
-    code(text: string): this;
-    /** Writes a horizontal rule. */
-    horizontalRule(): this;
-    /** Writes an image markdown line. */
-    image(alt: string, url: string): this;
-    /** Writes strikethrough text. */
-    strikethrough(text: string): this;
-    /** Writes highlighted text using == syntax. */
-    highlight(text: string): this;
-    /** Writes subscript text using ~ syntax. */
-    subscript(text: string): this;
-    /** Writes superscript text using ^ syntax. */
-    superscript(text: string): this;
-    /** Writes a markdown task list. */
-    taskList(items: {
-        text: string;
-        checked: boolean;
-    }[]): this;
-    /**
-     * Starts a section heading and increments internal nesting level.
-     *
-     * @param text - Section title.
-     * @param level - Optional explicit heading level baseline.
-     */
-    section(text: string, level?: number): this;
-    /** Decrements section nesting level by one. */
-    endSection(): this;
-    /** Sets the internal section nesting level directly. */
-    setSectionLevel(level: number): this;
-}
-
-/**
- * @public
- */
-export declare type MergeMode = 'merge' | 'source' | 'target' | 'skip';
-
-/**
- * @public
- */
-export declare interface MergeOptions {
-    conflict?: (key: string, source: any, target: any, sourceContainer: any, targetContainer: any) => any;
-    mismatch?: (key: string, source: any, target: any, sourceContainer: any, targetContainer: any) => any;
-    navigate?: (key: string, source: any, target: any, sourceContainer: any, targetContainer: any) => boolean | undefined;
-    mode?: (key: string, source: any, target: any, sourceContainer: any, targetContainer: any) => MergeMode | void;
-}
-
-/**
- * @public
- */
-export declare enum NavigateAction {
-    Explore = 0,
-    SkipSiblings = 1,
-    NoExplore = 2,
-    ReplaceParent = 3,
-    DeleteParent = 4,
-    MergeParent = 5,
-    ReplaceItem = 6,
-    DeleteItem = 7
-}
-
-/**
- * @public
- */
-export declare type NavigateCallback = (context: NavigateContext) => Promise<NavigateResult> | NavigateResult;
-
-/**
- * @public
- */
-export declare interface NavigateContext {
-    key: string;
-    value: any;
-    path: string[];
-    parent: any;
-    parents: any[];
-}
-
-/**
- * @public
- */
-export declare class NavigateResult {
-    readonly action: NavigateAction;
-    by?: any | undefined;
-    skipSiblings?: boolean | undefined;
-    reexplore?: boolean | undefined;
-    constructor(action: NavigateAction, by?: any | undefined, skipSiblings?: boolean | undefined, reexplore?: boolean | undefined);
-    private static readonly _explore;
-    private static readonly _noExplore;
-    private static readonly _skipSiblings;
-    private static readonly _deleteParent;
-    static ReplaceParent(by: any, reexplore?: boolean): NavigateResult;
-    static SkipSiblings(): NavigateResult;
-    static Explore(): NavigateResult;
-    static NoExplore(): NavigateResult;
-    static DeleteParent(): NavigateResult;
-    static MergeParent(by: any): NavigateResult;
-    static ReplaceItem(by: any, skipSiblings?: boolean): NavigateResult;
-    static DeleteItem(skipSiblings?: boolean): NavigateResult;
-}
-
-/**
- * @public
- */
-export declare interface Output {
-    name: string;
-    type?: 'json' | 'yaml' | 'text';
-    value: any;
-    class?: string;
-}
-
-/**
- * Options for configuring the select function behavior
- * @public
- */
-export declare interface SelectOptions {
-    /** Value to set at the selected path */
-    set?: any;
-    /** Alternative key to use (currently unused) */
-    key?: string;
-    /** Path separator character (default: '.') */
-    separator?: string;
-    /** Default value to return when path is not found */
-    defaultValue?: any;
-    /** If true, returns undefined instead of throwing on missing paths */
-    optional?: boolean;
-}
-
-/**
- * @public
- */
-export declare class StringBuilder {
-    #private;
-    options: StringBuilderOptions;
-    /**
-     * Creates a new StringBuilder instance.
-     *
-     * @param initial - Optional initial content.
-     * @param options - Builder formatting options.
-     */
-    constructor(initial?: string | string[] | StringBuilder, options?: StringBuilderOptions);
-    /**
-     * Replaces current formatting options.
-     *
-     * @param options - New builder options.
-     * @returns Current builder instance.
-     */
-    setOptions(options: StringBuilderOptions): this;
-    /** Clears all buffered blocks. */
-    clear(): this;
-    /** Returns true when no content is buffered. */
-    isEmpty(): boolean;
-    /** Returns concatenated content. */
-    toString(): string;
-    /** Increases indentation level by one. */
-    indent(): this;
-    /** Decreases indentation level by one when possible. */
-    dedent(): this;
-    /** Returns current indentation level. */
-    getCurrentIndent(): number;
-    /** Returns current content split by newline. */
-    getLines(): string[];
-    /**
-     * Formats a line according to indentation and line options.
-     *
-     * @param line - Input line to format.
-     * @returns Formatted line including line separator.
-     */
-    formatLine(line?: string): string;
-    /**
-     * Appends one or more values to the buffer.
-     *
-     * @param args - Values to append.
-     * @returns Current builder instance.
-     */
-    write(...args: any[]): this;
-    /**
-     * Writes one or more formatted lines.
-     *
-     * @param args - Values to write as lines.
-     * @returns Current builder instance.
-     */
-    writeLine(...args: any[]): this;
-    /**
-     * Maps input items to writes using a callback.
-     *
-     * @param items - Source items.
-     * @param fn - Mapping callback.
-     * @returns Current builder instance.
-     */
-    writeMap<T>(items: T[], fn: (item: T, index: number, builder: this) => string | this): this;
-}
-
-/**
- * @public
- */
-export declare interface StringBuilderOptions {
-    indentChar?: string;
-    indentSize?: number;
-    trim?: boolean;
-    lineSeparator?: string;
-    linePrefix?: string;
-    lineSuffix?: string;
-}
-
-/**
- * Encodes and writes content to a file path using the selected format encoder.
- *
- * @param filePath - Destination file path.
- * @param content - Data to encode and write.
- * @param options - Encoder selection options.
- * @returns Promise resolved when writing completes.
- * @throws - When no encoder can be resolved.
- * @public
- */
-export declare const writeFormat: (filePath: string, content: any, options?: WriteFormatOptions) => Promise<void>;
-
-/**
- * @public
- */
-export declare interface WriteFormatEncoder {
-    matching?: string[];
-    fn: (data: any) => Promise<string> | string;
-}
-
-/**
- * @public
- */
-export declare interface WriteFormatOptions {
-    format: string;
-    encoders?: Record<string, WriteFormatEncoder>;
-}
-
-/**
- * Writes a single output entry to disk.
- *
- * @param o - Output entry to write.
- * @param options - Writing behavior configuration.
- * @returns Promise resolved when output is processed.
- * @throws - When class requirements fail or file operations fail.
- * @public
- */
-export declare const writeOutput: (o: Output, options?: WriteOutputOption) => Promise<void>;
-
-/**
- * @public
- */
-export declare interface WriteOutputOption {
-    targetDirectory?: string;
-    writing?: (output: Output) => boolean | undefined | void;
-    classes?: string[];
-    classRequired?: boolean;
-}
-
-/**
- * Writes multiple outputs to disk.
- *
- * @param outputs - Output definitions to write.
- * @param options - Writing behavior configuration.
- * @returns Promise resolved when all outputs are processed.
- * @public
- */
-export declare const writeOutputs: (outputs: Output[], options?: WriteOutputsOption) => Promise<void>;
-
-/**
- * @public
- */
-export declare interface WriteOutputsOption extends WriteOutputOption {
-    removeFirst?: boolean;
-}
-
-export { }
-
-/* Global declarations */
-
-declare global {
-    type Constructor<T = any> = new (...args: any[]) => T;
-    type MaybePromise<T> = T | Promise<T>;
-    type AsyncFunction<T = any> = (...args: any[]) => Promise<T>;
-    var AsyncFunction: typeof Function;
-    var defined: <T>(value: T | undefined | null, msg?: string) => T;
-}
-
-declare global {
-    interface String {
-        capitalize(): string;
-        toPascal(): string;
-        toCamel(): string;
-        toSnake(): string;
-        toKebab(): string;
-        changeCase(to: 'upper' | 'lower' | 'pascal' | 'camel' | 'snake' | 'kebab'): string;
-        splitWithQuotes(separator?: string): {
-            value: string;
-            quoted: boolean;
-        }[];
-        splitNested(separator: string, open: string, close: string): string[];
-        padBlock(indent: number, separator?: string, padder?: string): string;
-        tokenize(from: Record<string, unknown>, tokenizer?: RegExp): string;
-        stripIndent(): string;
-        toHtmlLink(path?: string): string;
-        toStringBuilder(): StringBuilder;
-        toRgb(): string;
-        toArgb(): string;
-        single(char: string): string;
-        remove(char: string): string;
-        toAlphanum(replaceWith?: string): string;
-        toAlpha(replaceWith?: string): string;
-    }
-}
-
-declare global {
-    interface Array<T> {
-        mapAsync<U>(callback: (value: T, index: number, array: T[]) => Promise<U>): Promise<U[]>;
-        forEachAsync(callback: (value: T, index: number, array: T[]) => Promise<void>): Promise<void>;
-        sortBy<K extends keyof T>(selector: (item: T) => T[K], ascending?: boolean): T[];
-        unique(): T[];
-        uniqueBy<K extends keyof T>(selector: (item: T) => T[K]): T[];
-        groupBy<K extends keyof T>(selector: (item: T) => T[K]): Record<T[K] & (string | number | symbol), T[]>;
-        toObject<K extends keyof T, V>(keySelector: (item: T) => T[K], valueSelector?: (item: T) => V): Record<T[K] & (string | number | symbol), V>;
-        toObjectWithKey<K extends keyof T>(key: K): Record<string, T>;
-        nonNullMap<U>(callback: (value: T, index: number, array: T[]) => U | null | undefined): U[];
-        nonNullMapAsync<U>(callback: (value: T, index: number, array: T[]) => Promise<U | null | undefined>): Promise<U[]>;
-        findOrFail(predicate: (value: T, index: number, array: T[]) => boolean, message?: string, thisArg?: any): T;
-        selectFor<K>(predicate: (value: T, index: number, array: T[]) => boolean, selector: (value: T) => K, message?: string, thisArg?: any): K;
-        createInstances<TTarget>(targetConstructor: new (...args: any[]) => TTarget, ...args: any[]): TTarget[];
-        mergeAll(options?: MergeOptions): any;
-    }
-    interface ArrayConstructor {
-        flat<T>(v: T | T[] | T[][]): T[];
-    }
-}
-
-declare global {
-    interface ObjectConstructor {
-        mapEntries<T extends object, U>(obj: T, callback: (key: keyof T, value: T[keyof T]) => [string | number | symbol, U]): Record<string | number | symbol, U>;
-        toList<T extends object, U extends object, X extends string>(obj: T, key: X): (Record<X, string> & U)[];
-        deepClone<T extends object>(obj: T): T;
-        merge(source: any, target: any, options?: MergeOptions): void;
-        navigate(o: any, cb: NavigateCallback): Promise<void>;
-        find(from: any, cb: (path: string, value: any) => boolean): Promise<any[]>;
-        select(from: any, path: string, options?: SelectOptions): any;
-    }
-}
-