@navios/commander 1.0.0-alpha.4 → 1.1.0

package/dist/src/commander.application.d.mts

@@ -1,147 +0,0 @@
-import type { ClassTypeWithInstance, NaviosModule } from '@navios/core';
-import { Container } from '@navios/core';
-/**
- * Configuration options for CommanderApplication.
- *
- * @public
- */
-export interface CommanderApplicationOptions {
-}
-/**
- * Main application class for managing CLI command execution.
- *
- * This class handles module loading, command registration, and command execution.
- * It provides both programmatic and CLI-based command execution capabilities.
- *
- * @example
- * ```typescript
- * const app = await CommanderFactory.create(AppModule)
- * await app.init()
- * await app.run(process.argv)
- * ```
- */
-export declare class CommanderApplication {
-    private moduleLoader;
-    private cliParser;
-    protected container: Container;
-    private appModule;
-    private options;
-    /**
-     * Indicates whether the application has been initialized.
-     * Set to `true` after `init()` is called successfully.
-     */
-    isInitialized: boolean;
-    /**
-     * @internal
-     * Sets up the application with the provided module and options.
-     * This is called automatically by CommanderFactory.create().
-     */
-    setup(appModule: ClassTypeWithInstance<NaviosModule>, options?: CommanderApplicationOptions): Promise<void>;
-    /**
-     * Gets the dependency injection container used by this application.
-     *
-     * @returns The Container instance
-     *
-     * @example
-     * ```typescript
-     * const container = app.getContainer()
-     * const service = await container.get(MyService)
-     * ```
-     */
-    getContainer(): Container;
-    /**
-     * Initializes the application by loading all modules and registering commands.
-     *
-     * This method must be called before executing commands or running the CLI.
-     * It traverses the module tree, loads all imported modules, and collects command metadata.
-     *
-     * @throws {Error} If the app module is not set (setup() was not called)
-     *
-     * @example
-     * ```typescript
-     * const app = await CommanderFactory.create(AppModule)
-     * await app.init() // Must be called before run() or executeCommand()
-     * ```
-     */
-    init(): Promise<void>;
-    /**
-     * Executes a command programmatically with the provided options.
-     *
-     * This method is useful for testing, automation, or programmatic workflows.
-     * The options will be validated against the command's Zod schema if one is provided.
-     *
-     * @param commandPath - The command path (e.g., 'greet', 'user:create')
-     * @param options - The command options object (will be validated if schema exists)
-     * @throws {Error} If the application is not initialized
-     * @throws {Error} If the command is not found
-     * @throws {Error} If the command does not implement the execute method
-     * @throws {ZodError} If options validation fails
-     *
-     * @example
-     * ```typescript
-     * await app.executeCommand('greet', {
-     *   name: 'World',
-     *   greeting: 'Hi'
-     * })
-     * ```
-     */
-    executeCommand(commandPath: string, options?: any): Promise<void>;
-    /**
-     * Gets all registered commands with their paths and class references.
-     *
-     * @returns An array of objects containing the command path and class
-     *
-     * @example
-     * ```typescript
-     * const commands = app.getAllCommands()
-     * commands.forEach(({ path }) => {
-     *   console.log(`Available: ${path}`)
-     * })
-     * ```
-     */
-    getAllCommands(): {
-        path: string;
-        class: ClassTypeWithInstance<any>;
-    }[];
-    /**
-     * Runs the CLI application by parsing command-line arguments and executing the appropriate command.
-     *
-     * This is the main entry point for CLI usage. It parses `argv`, validates options,
-     * and executes the matching command. Supports help command (`help`, `--help`, `-h`)
-     * which displays all available commands.
-     *
-     * @param argv - Command-line arguments array (defaults to `process.argv`)
-     * @throws {Error} If the application is not initialized
-     * @throws {Error} If no command is provided
-     * @throws {Error} If the command is not found
-     * @throws {ZodError} If options validation fails
-     *
-     * @example
-     * ```typescript
-     * // Parse and execute from process.argv
-     * await app.run()
-     *
-     * // Or provide custom arguments
-     * await app.run(['node', 'cli.js', 'greet', '--name', 'World'])
-     * ```
-     */
-    run(argv?: string[]): Promise<void>;
-    /**
-     * @internal
-     * Disposes of resources used by the application.
-     */
-    dispose(): Promise<void>;
-    /**
-     * Closes the application and cleans up resources.
-     *
-     * This should be called when the application is no longer needed to free up resources.
-     *
-     * @example
-     * ```typescript
-     * await app.run(process.argv)
-     * await app.close()
-     * ```
-     */
-    close(): Promise<void>;
-}
-//# sourceMappingURL=commander.application.d.mts.map

package/dist/src/commander.application.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"commander.application.d.mts","sourceRoot":"","sources":["../../src/commander.application.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EAErB,YAAY,EACb,MAAM,cAAc,CAAA;AAErB,OAAO,EAAE,SAAS,EAAsB,MAAM,cAAc,CAAA;AAQ5D;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;CAAG;AAE/C;;;;;;;;;;;;GAYG;AACH,qBACa,oBAAoB;IAC/B,OAAO,CAAC,YAAY,CAAiC;IACrD,OAAO,CAAC,SAAS,CAA2B;IAC5C,SAAS,CAAC,SAAS,YAAoB;IAEvC,OAAO,CAAC,SAAS,CAAmD;IACpE,OAAO,CAAC,OAAO,CAAkC;IAEjD;;;OAGG;IACH,aAAa,UAAQ;IAErB;;;;OAIG;IACG,KAAK,CACT,SAAS,EAAE,qBAAqB,CAAC,YAAY,CAAC,EAC9C,OAAO,GAAE,2BAAgC;IAM3C;;;;;;;;;;OAUG;IACH,YAAY;IAIZ;;;;;;;;;;;;;OAaG;IACG,IAAI;IAUV;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,GAAQ;IAuD3D;;;;;;;;;;;;OAYG;IACH,cAAc;cAIJ,MAAM;eACL,qBAAqB,CAAC,GAAG,CAAC;;IAarC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,GAAG,CAAC,IAAI,GAAE,MAAM,EAAiB;IAgDvC;;;OAGG;IACG,OAAO;IAMb;;;;;;;;;;OAUG;IACG,KAAK;CAGZ"}

package/dist/src/metadata/cli-module.metadata.d.mts

@@ -1,60 +0,0 @@
-import type { ClassType } from '@navios/core';
-/**
- * @internal
- * Symbol key used to store CLI module metadata on classes.
- */
-export declare const CliModuleMetadataKey: unique symbol;
-/**
- * Metadata associated with a CLI module.
- *
- * @public
- */
-export interface CliModuleMetadata {
-    /**
-     * Set of command classes registered in this module.
-     */
-    commands: Set<ClassType>;
-    /**
-     * Set of other modules imported by this module.
-     */
-    imports: Set<ClassType>;
-    /**
-     * Set of service override classes imported for side effects.
-     */
-    overrides: Set<ClassType>;
-    /**
-     * Map of custom attributes that can be attached to the module.
-     */
-    customAttributes: Map<string | symbol, any>;
-}
-/**
- * Gets or creates CLI module metadata for a class.
- *
- * @internal
- * @param target - The module class
- * @param context - The decorator context
- * @returns The module metadata
- */
-export declare function getCliModuleMetadata(target: ClassType, context: ClassDecoratorContext): CliModuleMetadata;
-/**
- * Extracts CLI module metadata from a class.
- *
- * @param target - The module class
- * @returns The module metadata
- * @throws {Error} If the class is not decorated with @CliModule
- *
- * @example
- * ```typescript
- * const metadata = extractCliModuleMetadata(AppModule)
- * console.log(metadata.commands.size) // Number of commands
- * ```
- */
-export declare function extractCliModuleMetadata(target: ClassType): CliModuleMetadata;
-/**
- * Checks if a class has CLI module metadata.
- *
- * @param target - The class to check
- * @returns `true` if the class is decorated with @CliModule, `false` otherwise
- */
-export declare function hasCliModuleMetadata(target: ClassType): boolean;
-//# sourceMappingURL=cli-module.metadata.d.mts.map

package/dist/src/metadata/cli-module.metadata.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"cli-module.metadata.d.mts","sourceRoot":"","sources":["../../../src/metadata/cli-module.metadata.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAE7C;;;GAGG;AACH,eAAO,MAAM,oBAAoB,eAAiC,CAAA;AAElE;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAC,SAAS,CAAC,CAAA;IACxB;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC,SAAS,CAAC,CAAA;IACvB;;OAEG;IACH,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAA;IACzB;;OAEG;IACH,gBAAgB,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAA;CAC5C;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,qBAAqB,GAC7B,iBAAiB,CAqBnB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,SAAS,GAAG,iBAAiB,CAS7E;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAG/D"}

package/dist/src/services/module-loader.service.d.mts

@@ -1,74 +0,0 @@
-import type { ClassTypeWithInstance, NaviosModule } from '@navios/core';
-import { Container } from '@navios/core';
-import type { CommandHandler } from '../interfaces/index.mjs';
-import type { CliModuleMetadata, CommandMetadata } from '../metadata/index.mjs';
-/**
- * Command class with its associated metadata.
- *
- * @public
- */
-export interface CommandWithMetadata {
-    /**
-     * The command class constructor.
-     */
-    class: ClassTypeWithInstance<CommandHandler>;
-    /**
-     * The command metadata including path and options schema.
-     */
-    metadata: CommandMetadata;
-}
-/**
- * Service for loading and managing CLI modules and commands.
- *
- * Handles module traversal, command registration, and metadata collection.
- * This service is used internally by CommanderApplication.
- *
- * @public
- */
-export declare class CliModuleLoaderService {
-    private logger;
-    protected container: Container;
-    private modulesMetadata;
-    private loadedModules;
-    private commandsMetadata;
-    private initialized;
-    /**
-     * Loads all modules starting from the root app module.
-     *
-     * Traverses the module tree, loads imported modules, and collects command metadata.
-     *
-     * @param appModule - The root CLI module
-     */
-    loadModules(appModule: ClassTypeWithInstance<NaviosModule>): Promise<void>;
-    private traverseModules;
-    private validateOverrides;
-    private mergeMetadata;
-    /**
-     * Gets all loaded module metadata.
-     *
-     * @returns Map of module names to their metadata
-     */
-    getAllModules(): Map<string, CliModuleMetadata>;
-    /**
-     * Gets all command classes indexed by command class name.
-     *
-     * @returns Map of command class names to command classes
-     */
-    getAllCommands(): Map<string, ClassTypeWithInstance<any>>;
-    /**
-     * Get all commands with their metadata, indexed by command path.
-     * This is populated during loadModules, so path information is available
-     * before parsing CLI argv.
-     */
-    getAllCommandsWithMetadata(): Map<string, CommandWithMetadata>;
-    /**
-     * Get a command by its path, with metadata already extracted.
-     * Returns undefined if command is not found.
-     */
-    getCommandByPath(path: string): CommandWithMetadata | undefined;
-    /**
-     * Disposes of all loaded modules and commands, clearing internal state.
-     */
-    dispose(): void;
-}
-//# sourceMappingURL=module-loader.service.d.mts.map

package/dist/src/services/module-loader.service.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"module-loader.service.d.mts","sourceRoot":"","sources":["../../../src/services/module-loader.service.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvE,OAAO,EACL,SAAS,EAKV,MAAM,cAAc,CAAA;AAErB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAC7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAO/E;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,qBAAqB,CAAC,cAAc,CAAC,CAAA;IAC5C;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAA;CAC1B;AAED;;;;;;;GAOG;AACH,qBACa,sBAAsB;IACjC,OAAO,CAAC,MAAM,CAEZ;IACF,SAAS,CAAC,SAAS,YAAoB;IACvC,OAAO,CAAC,eAAe,CAA4C;IACnE,OAAO,CAAC,aAAa,CAA8B;IACnD,OAAO,CAAC,gBAAgB,CAA8C;IACtE,OAAO,CAAC,WAAW,CAAQ;IAE3B;;;;;;OAMG;IACG,WAAW,CAAC,SAAS,EAAE,qBAAqB,CAAC,YAAY,CAAC;YAQlD,eAAe;IAqC7B,OAAO,CAAC,iBAAiB;IA6DzB,OAAO,CAAC,aAAa;IAcrB;;;;OAIG;IACH,aAAa,IAAI,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAI/C;;;;OAIG;IACH,cAAc,IAAI,GAAG,CAAC,MAAM,EAAE,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAUzD;;;;OAIG;IACH,0BAA0B,IAAI,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAI9D;;;OAGG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS;IAI/D;;OAEG;IACH,OAAO;CAMR"}