@cenk1cenk2/oclif-common 6.3.29 → 6.4.0

package/dist/index.d.ts

@@ -1,413 +1,51 @@
-import { InjectionToken, DynamicModule, INestApplicationContext } from '@nestjs/common';
-export { DynamicModule, Inject } from '@nestjs/common';
-import * as _oclif_core_lib_interfaces from '@oclif/core/lib/interfaces';
-export { Flag, InferredFlags } from '@oclif/core/lib/interfaces';
-import { Manager } from '@listr2/manager';
-import { Config, Command as Command$1, Interfaces, Hook } from '@oclif/core';
-export { Args, Flags, ux } from '@oclif/core';
-import { ChildProcess } from 'child_process';
-import { ListrTaskWrapper, splat, ListrContext } from 'listr2';
-import { Logger, LeveledLogMethod } from 'winston';
-import { ModuleRef } from '@nestjs/core';
-import fs from 'fs-extra';
-export { default as fs } from 'fs-extra';
-import op from 'object-path-immutable';
-import { ClassTransformOptions } from 'class-transformer';
-import { ValidatorOptions } from 'class-validator';
-export { Arg, ArgInput, FlagInput } from '@oclif/core/lib/interfaces/parser';
-
-type ClassType<T> = new (...args: any[]) => T;
-
-interface GlobalConfig {
-    logLevel: LogLevels;
-    isJson: boolean;
-}
-interface ConfigIterator {
-    key: (string | number)[];
-    env: string;
-    parser?: string;
-    extensions?: ConfigIterator[];
-}
-interface ConfigModuleOptions {
-    oclif?: Config;
-    command?: typeof Command$1;
-    config: GlobalConfig;
-}
-
-declare class GenericParser {
-    readonly extensions: string[];
-    parse<T = unknown>(data: string | Buffer): T;
-    stringify<T = any>(data: T): string;
-}
-
-declare function pipeProcessThroughListr(task: ListrTaskWrapper<any, any, any>, instance: ChildProcess): ChildProcess;
-
-declare enum LogLevels {
-    SILENT = "SILENT",
-    DIRECT = "DIRECT",
-    FATAL = "FATAL",
-    ERROR = "ERROR",
-    WARN = "WARN",
-    INFO = "INFO",
-    VERBOSE = "VERBOSE",
-    DEBUG = "DEBUG",
-    TRACE = "TRACE"
-}
-declare enum LogFieldStatus {
-    RUN = "run",
-    END = "end",
-    STAGE = "stage",
-    EXIT = "exit",
-    TERMINATE = "terminate"
-}
-
-interface PipeProcessToLoggerOptions {
-    /** Will log the command when the process starts. */
-    start?: LogLevels;
-    /** Will log the command when the process ends. */
-    end?: LogLevels;
-    /** enable/disable stdout */
-    stdout?: LogLevels;
-    /** enable/disable stderrr */
-    stderr?: LogLevels;
-    /** will callback on error in the instance */
-    callback?: (error?: Error) => void;
-    /** context for logger */
-    context?: string;
-}
-
-interface LoggerFormat {
-    level: LogLevels;
-    message: string;
-    context: string;
-    status: string;
-}
-type Winston = Logger & Record<keyof typeof LogLevels, LeveledLogMethod>;
-
-declare class WinstonService {
-    private readonly options;
-    readonly instance: Winston;
-    constructor(options: ConfigModuleOptions);
-    private initiateLogger;
-    private logColoring;
-}
-
-/**
- * A general logger for the the CLI applications.
- */
-declare class LoggerService {
-    private readonly winston;
-    context: string;
-    constructor(winston: WinstonService);
-    setup(context: string): LoggerService;
-    log(level: LogLevels, data: string | Buffer, ...args: any): void;
-    direct(data: string | Buffer, ...args: any): void;
-    fatal(data: string | Buffer, ...args: any): void;
-    error(data: string | Buffer, ...args: any): void;
-    warn(data: string | Buffer, ...args: any): void;
-    info(data: string | Buffer, ...args: any): void;
-    verbose(data: string | Buffer, ...args: any): void;
-    debug(data: string | Buffer, ...args: any): void;
-    trace(data: string | Buffer, ...args: any): void;
-    run(data: string | Buffer, ...args: any): void;
-    end(data: string | Buffer, ...args: any): void;
-    stage(data: string | Buffer, ...args: any): void;
-    splat(...args: Parameters<typeof splat>): ReturnType<typeof splat>;
-    private parseMessage;
-}
-
-/**
- * Given the instance it will pipe process output through the logger to append prefixes such as the application name.
- */
-declare function pipeProcessToLogger(logger: LoggerService, instance: ChildProcess, options?: PipeProcessToLoggerOptions): ChildProcess;
-
-declare class LoggerModule {
-}
-
-declare class EnvironmentVariableParser implements GenericParser {
-    private readonly logger;
-    readonly extensions: string[];
-    private readonly LINE;
-    constructor(logger: LoggerService);
-    parse<T = unknown>(data: string | Buffer): T;
-    stringify<T = any>(data: T): string;
-}
-
-declare class JsonParser implements GenericParser {
-    private readonly logger;
-    readonly extensions: string[];
-    constructor(logger: LoggerService);
-    parse<T = unknown>(data: string | Buffer): T;
-    stringify<T = any>(data: T): string;
-}
-
-declare class YamlParser implements GenericParser {
-    private readonly logger;
-    readonly extensions: string[];
-    constructor(logger: LoggerService);
-    parse<T = unknown>(data: string | Buffer): T;
-    stringify<T = any>(data: T): string;
-}
-
-declare class ParserModule {
-}
-
-declare class FileSystemService {
-    private readonly logger;
-    readonly extra: typeof fs;
-    constructor(logger: LoggerService);
-    exists(path: string): boolean;
-    stats(path: string): fs.Stats;
-    dirname(path: string): string;
-    extname(path: string): string;
-    read(file: string): Promise<string>;
-    readSync(file: string): string;
-    write(file: string, data: string | Buffer, options?: fs.WriteFileOptions): Promise<void>;
-    writeSync(file: string, data: string | Buffer, options?: fs.WriteFileOptions): void;
-    append(file: string, data: string | Buffer, options?: fs.WriteFileOptions): Promise<void>;
-    appendSync(file: string, data: string | Buffer): void;
-    remove(file: string, options?: fs.RmOptions): Promise<void>;
-    removeSync(file: string, options?: fs.RmOptions): void;
-    emptyDir(directory: string): Promise<void>;
-    emptyDirSync(directory: string): void;
-    removeDir(directory: string): Promise<void>;
-    removeDirSync(directory: string): void;
-    mkdir(directory: string): Promise<void>;
-    mkdirSync(directory: string): void;
-}
-
-declare class FilesystemModule {
-}
-
-declare class ParserService {
-    private moduleRef;
-    private fs;
-    private readonly logger;
-    private readonly instances;
-    constructor(moduleRef: ModuleRef, fs: FileSystemService, logger: LoggerService);
-    byFt(file: string): GenericParser;
-    fetch<T extends GenericParser>(Parser: ClassType<T>): T;
-    inject<T extends GenericParser>(Parser: ClassType<T>): Promise<T>;
-    register(...parsers: ClassType<GenericParser>[]): Promise<void>;
-    read<T = unknown>(file: string): Promise<T>;
-    write<T = LockableData>(file: string, data: T): Promise<void>;
-    parse<T = unknown>(file: string, data: string | Buffer): T;
-    parseWith<T = unknown>(Parser: ClassType<GenericParser>, data: string | Buffer): T;
-    stringify<T = any>(file: string, data: T): string;
-    stringifyWith<T = any>(Parser: ClassType<GenericParser>, data: T): string;
-}
-
-type SetCtxDefaultsOptions<T extends ListrContext = ListrContext> = Partial<T>;
-interface SetCtxAssignOptions<K = Record<PropertyKey, any>> {
-    from: K;
-    keys: (keyof K)[];
-}
-declare function setCtxDefaults<T extends ListrContext = ListrContext>(ctx: T, ...defaults: SetCtxDefaultsOptions<T>[]): void;
-declare function setCtxAssign<T extends ListrContext = ListrContext, K = Record<PropertyKey, any>>(ctx: T, ...assigns: SetCtxAssignOptions<K>[]): void;
-
-declare function isVerbose(logLevel: LogLevels): boolean;
-declare function isDebug(logLevel: LogLevels): boolean;
-declare function isSilent(logLevel: LogLevels): boolean;
-
-declare function isHookedWithShouldRunBefore<T extends Command$1 = Command$1>(command: T): command is T & ShouldRunBeforeHook;
-declare function isHookedWithShouldRunAfter<T extends Command$1 = Command$1>(command: T): command is T & ShouldRunAfterHook<any>;
-declare function isHookedWithRegister<T extends Command$1 = Command$1>(command: T): command is T & RegisterHook;
-
-declare enum MergeStrategy {
-    OVERWRITE = "OVERWRITE",
-    EXTEND = "EXTEND"
-}
-
-/** Merge objects deep from overwriting the properties from source to target.
- * Does not mutate the object */
-declare function merge<T extends Record<PropertyKey, any> | any[]>(strategy: MergeStrategy, ...source: Partial<T>[]): T;
-declare function uniqueArrayFilter(value: any, index: any, self: string | any[]): boolean;
-
-interface CommonLockerData {
-    path?: string | string[];
-    enabled?: boolean;
-    root?: boolean;
-}
-type LockableData = any;
-interface LockData<T extends LockableData = LockableData> extends Partial<CommonLockerData> {
-    data: T;
-    merge?: MergeStrategy;
-}
-interface UnlockData extends CommonLockerData {
-    path: string | string[];
-}
-interface LockerServiceOptions {
-    file: string;
-    parser: ClassType<GenericParser>;
-    root?: string[];
-    context?: string;
-    token?: InjectionToken;
-}
-
-declare class LockerService<LockFile extends LockableData = LockableData> {
-    private readonly logger;
-    private readonly fs;
-    private readonly parser;
-    private readonly options;
-    readonly op: typeof op;
-    private toLock;
-    private toUnlock;
-    constructor(logger: LoggerService, fs: FileSystemService, parser: ParserService, options: LockerServiceOptions);
-    hasLock(): boolean;
-    hasUnlock(): boolean;
-    addLock<T extends LockableData = LockFile>(...data: LockData<T>[]): void;
-    addUnlock(...data: UnlockData[]): void;
-    applyLockAll(lock: LockFile): Promise<LockFile>;
-    lockAll(): Promise<void>;
-    applyUnlockAll(lock: LockFile): Promise<LockFile>;
-    unlockAll(): Promise<void>;
-    all(): Promise<void>;
-    applyAll(lock: LockFile): Promise<LockFile>;
-    applyLock<T extends LockableData = LockFile>(lock: LockFile, ...data: LockData<T>[]): Promise<LockFile>;
-    lock<T extends LockableData = LockFile>(...data: LockData<T>[]): Promise<LockFile>;
-    applyUnlock(lock: LockFile, ...data: UnlockData[]): Promise<LockFile>;
-    unlock(...data: UnlockData[]): Promise<LockFile | undefined>;
-    read(): Promise<LockFile>;
-    tryRead(): Promise<LockFile | undefined>;
-    tryRemove(): Promise<void>;
-    write(data: LockFile): Promise<void>;
-    private buildPath;
-    private normalizePath;
-}
-
-declare class LockerModule {
-    static forFeature(options: LockerServiceOptions): DynamicModule;
-}
-
-declare class ConfigService {
-    private readonly parser;
-    private readonly logger;
-    defaults: string;
-    root: string;
-    config: GlobalConfig;
-    oclif: Config;
-    command: typeof Command$1;
-    constructor(parser: ParserService, logger: LoggerService, options: ConfigModuleOptions);
-    get isVerbose(): boolean;
-    get isDebug(): boolean;
-    get isSilent(): boolean;
-    get isJson(): boolean;
-    read<T extends LockableData = LockableData>(path: string): Promise<T>;
-    extend<T extends LockableData = LockableData>(paths: (string | Partial<T>)[], strategy?: MergeStrategy): Promise<T>;
-    merge<T extends LockableData = LockableData>(configs: Partial<T>[], strategy?: MergeStrategy): T;
-    env<T extends LockableData = LockableData>(definition: string | Record<PropertyKey, any>, config: T): Promise<T>;
-    write<T extends LockableData = LockableData>(path: string, data: T): Promise<void>;
-}
-
-declare class ConfigModule {
-}
-
-declare const TOKEN_LOGO_GENERATOR: InjectionToken;
-
-declare class LogoService {
-    readonly cs: ConfigService;
-    private generator;
-    constructor(cs: ConfigService, moduleRef: ModuleRef);
-    generate(): void;
-    shouldBeSilent(): boolean;
-    write(...data: string[]): void;
-}
-
-type LogoGeneratorFn = (this: LogoService) => void;
-
-declare class LogoModule {
-}
-
-declare const TOKEN_VALIDATOR_SERVICE_OPTIONS: InjectionToken;
-
-interface ValidatorServiceOptions {
-    validator?: ValidatorOptions;
-    transformer?: ClassTransformOptions;
-}
-
-declare class ValidatorModule {
-}
-
-declare class ValidatorService {
-    private readonly logger;
-    private options;
-    constructor(logger: LoggerService, moduleRef: ModuleRef);
-    validate<T extends Record<PropertyKey, any>>(classType: ClassType<T>, object: T, options?: ValidatorServiceOptions): Promise<T>;
-    validateSync<T extends Record<PropertyKey, any>>(classType: ClassType<T>, object: T, options?: ValidatorServiceOptions): T;
-    private logValidationError;
-}
-
-declare function setup(): Promise<void>;
-
-interface CliModuleOptions {
-    config: ConfigModuleOptions;
-}
-
-declare class CliModule {
-    static forRoot(options: CliModuleOptions): DynamicModule;
-    static forMinimum(): DynamicModule;
-    static create(cls: DynamicModule): Promise<INestApplicationContext>;
-}
-
-declare class ShouldRunBeforeHook {
-    shouldRunBefore(): void | Promise<void>;
-}
-declare class ShouldRunAfterHook<Ctx extends ListrContext = ListrContext> {
-    shouldRunAfter(ctx: Ctx): void | Promise<void>;
-}
-declare class RegisterHook {
-    register(cli: DynamicModule, options: CliModuleOptions): DynamicModule | Promise<DynamicModule>;
-}
-
-type InferFlags<T extends typeof Command$1> = Interfaces.InferredFlags<(typeof Command$1)['baseFlags'] & T['flags']>;
-type InferArgs<T extends typeof Command$1> = Interfaces.InferredArgs<T['args']>;
-
-/**
- * Makes the object deep partial.
- */
-type DeepPartial<T> = {
-    [P in keyof T]?: DeepPartial<T[P]>;
-};
-
-declare abstract class Command<T extends typeof Command$1 = typeof Command$1, Ctx extends ListrContext = ListrContext> extends Command$1 {
-    static baseFlags: {
-        "log-level": _oclif_core_lib_interfaces.OptionFlag<string, _oclif_core_lib_interfaces.CustomOptions>;
-        ci: _oclif_core_lib_interfaces.BooleanFlag<boolean>;
-        json: _oclif_core_lib_interfaces.BooleanFlag<boolean>;
-    };
-    logger: LoggerService;
-    tasks: Manager<Ctx>;
-    app: INestApplicationContext;
-    flags: InferFlags<T>;
-    args: InferArgs<T>;
-    exit(code?: number): never;
-    /** Run all tasks from task manager. */
-    runTasks<C extends Ctx = Ctx>(): Promise<C>;
-    protected setCtxDefaults<T extends Ctx = Ctx>(...defaults: SetCtxDefaultsOptions<T>[]): void;
-    protected setCtxAssign<K = Record<PropertyKey, any>>(...assigns: SetCtxAssignOptions<K>[]): void;
-    protected pipeProcessToLogger(instance: ChildProcess, options?: PipeProcessToLoggerOptions): ChildProcess;
-    protected pipeProcessThroughListr(instance: ChildProcess, task: ListrTaskWrapper<any, any, any>): ChildProcess;
-    /** Initial functions / constructor */
-    protected init(): Promise<void>;
-    /** Tasks to run before end of the command. */
-    protected finally<C extends Ctx = Ctx>(err: Error | undefined): Promise<{
-        ctx: C;
-    }>;
-    /** Catch any error occurred during command. */
-    protected catch(err: Error): Promise<never>;
-    abstract run(): Promise<any>;
-}
-
-declare enum FileConstants {
-    CONFIG_SERVICE_DEFAULTS_DIR = "config"
-}
-
-declare enum HelpGroups {
-    CLI = "CLI"
-}
-
-declare const notFoundHook: Hook<'command_not_found'>;
-
-declare const updateNotifierHook: Hook<'init'>;
-
-export { type ClassType, CliModule, type CliModuleOptions, Command, type CommonLockerData, type ConfigIterator, ConfigModule, type ConfigModuleOptions, ConfigService, type DeepPartial, EnvironmentVariableParser, FileConstants, FileSystemService, FilesystemModule, GenericParser, type GlobalConfig, HelpGroups, type InferArgs, type InferFlags, JsonParser, type LockData, type LockableData, LockerModule, LockerService, type LockerServiceOptions, LogFieldStatus, LogLevels, type LoggerFormat, LoggerModule, LoggerService, type LogoGeneratorFn, LogoModule, LogoService, MergeStrategy, ParserModule, ParserService, type PipeProcessToLoggerOptions, RegisterHook, type SetCtxAssignOptions, type SetCtxDefaultsOptions, ShouldRunAfterHook, ShouldRunBeforeHook, TOKEN_LOGO_GENERATOR, TOKEN_VALIDATOR_SERVICE_OPTIONS, type UnlockData, ValidatorModule, ValidatorService, type ValidatorServiceOptions, type Winston, WinstonService, YamlParser, isDebug, isHookedWithRegister, isHookedWithShouldRunAfter, isHookedWithShouldRunBefore, isSilent, isVerbose, merge, notFoundHook, pipeProcessThroughListr, pipeProcessToLogger, setCtxAssign, setCtxDefaults, setup, uniqueArrayFilter, updateNotifierHook };
+import { ClassType } from "./interfaces/class.interface.js";
+import { ConfigIterator, ConfigModuleOptions, GlobalConfig } from "./lib/config/config.interface.js";
+import { GenericParser } from "./lib/parser/parser.interface.js";
+import { pipeProcessThroughListr } from "./lib/logger/pipe/pipe-process-to-listr.js";
+import { LogFieldStatus, LogLevels } from "./lib/logger/logger.constants.js";
+import { PipeProcessToLoggerOptions } from "./lib/logger/pipe/pipe-process-to-logger.interface.js";
+import { LoggerFormat, Winston } from "./lib/logger/logger.interface.js";
+import { WinstonService } from "./lib/logger/winston.service.js";
+import { LoggerService } from "./lib/logger/logger.service.js";
+import { pipeProcessToLogger } from "./lib/logger/pipe/pipe-process-to-logger.js";
+import { LoggerModule } from "./lib/logger/logger.module.js";
+import { EnvironmentVariableParser } from "./lib/parser/fts/env-parser.service.js";
+import { JsonParser } from "./lib/parser/fts/json-parser.service.js";
+import { YamlParser } from "./lib/parser/fts/yaml-parser.service.js";
+import { ParserModule } from "./lib/parser/parser.module.js";
+import { fs } from "./lib/fs/filesystem.interface.js";
+import { FileSystemService } from "./lib/fs/filesystem.service.js";
+import { FilesystemModule } from "./lib/fs/filesystem.module.js";
+import { ParserService } from "./lib/parser/parser.service.js";
+import { SetCtxAssignOptions, SetCtxDefaultsOptions, setCtxAssign, setCtxDefaults } from "./utils/defaults.js";
+import { isDebug, isSilent, isVerbose } from "./utils/environment.js";
+import { isHookedWithRegister, isHookedWithShouldRunAfter, isHookedWithShouldRunBefore } from "./utils/guards.js";
+import { MergeStrategy } from "./utils/merge.constants.js";
+import { merge, uniqueArrayFilter } from "./utils/merge.js";
+import { ux } from "./utils/index.js";
+import { CommonLockerData, LockData, LockableData, LockerServiceOptions, UnlockData } from "./lib/locker/locker.interface.js";
+import { LockerService } from "./lib/locker/locker.service.js";
+import { LockerModule } from "./lib/locker/locker.module.js";
+import { ConfigService } from "./lib/config/config.service.js";
+import { ConfigModule } from "./lib/config/config.module.js";
+import { TOKEN_LOGO_GENERATOR } from "./lib/logo/logo.constants.js";
+import { LogoService } from "./lib/logo/logo.service.js";
+import { LogoGeneratorFn } from "./lib/logo/logo.interface.js";
+import { LogoModule } from "./lib/logo/logo.module.js";
+import { TOKEN_VALIDATOR_SERVICE_OPTIONS } from "./lib/validator/validator.constants.js";
+import { ValidatorServiceOptions } from "./lib/validator/validator.interface.js";
+import { ValidatorModule } from "./lib/validator/validator.module.js";
+import { ValidatorService } from "./lib/validator/validator.service.js";
+import { setup } from "./lib/setup.js";
+import { CliModuleOptions } from "./lib/cli.interface.js";
+import { CliModule } from "./lib/cli.module.js";
+import { RegisterHook, ShouldRunAfterHook, ShouldRunBeforeHook } from "./interfaces/hooks.interface.js";
+import { Arg, ArgInput, Args, Flag, FlagInput, Flags, InferArgs, InferFlags, InferredFlags } from "./interfaces/oclif.interface.js";
+import { DeepPartial } from "./interfaces/type-helper.interface.js";
+import { Command } from "./commands/base.command.js";
+import { FileConstants } from "./constants/file.constants.js";
+import { HelpGroups } from "./constants/help-groups.constants.js";
+import { notFoundHook } from "./hooks/not-found.hook.js";
+import { updateNotifierHook } from "./hooks/update-notifier.hook.js";
+import { DynamicModule, Inject } from "@nestjs/common";
+export { Arg, ArgInput, Args, ClassType, CliModule, CliModuleOptions, Command, CommonLockerData, ConfigIterator, ConfigModule, ConfigModuleOptions, ConfigService, DeepPartial, type DynamicModule, EnvironmentVariableParser, FileConstants, FileSystemService, FilesystemModule, Flag, FlagInput, Flags, GenericParser, GlobalConfig, HelpGroups, InferArgs, InferFlags, InferredFlags, Inject, JsonParser, LockData, LockableData, LockerModule, LockerService, LockerServiceOptions, LogFieldStatus, LogLevels, LoggerFormat, LoggerModule, LoggerService, LogoGeneratorFn, LogoModule, LogoService, MergeStrategy, ParserModule, ParserService, PipeProcessToLoggerOptions, RegisterHook, SetCtxAssignOptions, SetCtxDefaultsOptions, ShouldRunAfterHook, ShouldRunBeforeHook, TOKEN_LOGO_GENERATOR, TOKEN_VALIDATOR_SERVICE_OPTIONS, UnlockData, ValidatorModule, ValidatorService, ValidatorServiceOptions, Winston, WinstonService, YamlParser, fs, isDebug, isHookedWithRegister, isHookedWithShouldRunAfter, isHookedWithShouldRunBefore, isSilent, isVerbose, merge, notFoundHook, pipeProcessThroughListr, pipeProcessToLogger, setCtxAssign, setCtxDefaults, setup, uniqueArrayFilter, updateNotifierHook, ux };