@navios/commander 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -5,6 +5,32 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2026-01-10
+
+### Added
+
+- **TUI Mode Support** - New `enableTUI` option in `CommanderFactory.create()` to enable terminal UI mode
+  - Dynamically imports `@navios/commander-tui` when enabled
+  - Auto-binds `ScreenManager` with configurable options
+  - Falls back to standard console logger when TUI is disabled
+- **TUI Options** - New `CommanderTuiOptions` interface for TUI-specific configuration
+  - `exitOnCtrlC`, `sidebarWidth`, `sidebarPosition`, `sidebarTitle`
+  - `autoClose` with configurable delay
+  - `theme` support (preset name or custom object)
+  - `useMouse` and `hideDefaultScreen` options
+- **Log Levels Configuration** - New `logLevels` option in `CommanderFactoryOptions`
+- **Command Token Option** - New `token` option in `@Command()` decorator for custom injection tokens
+- **Help Command Token** - New `HelpCommandToken` for overriding the built-in help command
+
+### Changed
+
+- **Optional TUI Dependency** - `@navios/commander-tui` is now an optional peer dependency
+- **Command Decorator** - Internal token handling refactored to support custom tokens
+
+### Dependencies
+
+- Added optional peer dependency: `@navios/commander-tui` ^1.0.0
+
 ## [1.0.0] - 2026-01-09
 
 ### Added

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

@@ -43,16 +43,75 @@ export interface CommanderLoggerOptions {
      */
     showTimeDiff?: boolean;
 }
+/**
+ * TUI-specific options for terminal UI mode.
+ * Only used when enableTUI is true.
+ *
+ * @public
+ */
+export interface CommanderTuiOptions {
+    /**
+     * Exit on Ctrl+C.
+     * @default true
+     */
+    exitOnCtrlC?: boolean;
+    /**
+     * Sidebar width in columns.
+     */
+    sidebarWidth?: number;
+    /**
+     * Sidebar position.
+     */
+    sidebarPosition?: 'left' | 'right';
+    /**
+     * Sidebar header title.
+     */
+    sidebarTitle?: string;
+    /**
+     * Auto close after all screens complete successfully.
+     * Set to true for default delay (5000ms), or specify delay in milliseconds.
+     */
+    autoClose?: boolean | number;
+    /**
+     * Theme preset name ('dark', 'light', 'high-contrast') or custom theme object.
+     */
+    theme?: string | Record<string, unknown>;
+    /**
+     * Enable mouse support.
+     * @default false
+     */
+    useMouse?: boolean;
+    /**
+     * Hide the default console logger screen from the sidebar.
+     * @default false
+     */
+    hideDefaultScreen?: boolean;
+}
 /**
  * Configuration options for CommanderFactory.
  *
  * @public
  */
 export interface CommanderFactoryOptions {
+    /**
+     * Enabled log levels.
+     * @default ['log', 'error', 'warn', 'debug', 'verbose', 'fatal']
+     */
+    logLevels?: LogLevel[];
     /**
      * Logger display options. These override the default CLI-friendly logger settings.
+     * Ignored when enableTUI is true.
      */
     logger?: CommanderLoggerOptions;
+    /**
+     * Enable TUI mode with @navios/commander-tui.
+     * Requires @navios/commander-tui to be installed.
+     */
+    enableTUI?: boolean;
+    /**
+     * TUI-specific options. Only used when enableTUI is true.
+     */
+    tuiOptions?: CommanderTuiOptions;
 }
 /**
  * Factory class for creating CLI applications.

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

@@ -1 +1 @@
-{"version":3,"file":"commander.factory.d.mts","sourceRoot":"","sources":["../../src/commander.factory.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,QAAQ,EACR,iBAAiB,EACjB,YAAY,EACb,MAAM,cAAc,CAAA;AAIrB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAA;AAI5E;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;IACtB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAA;CAChC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,gBAAgB;IAC3B;;;;;;;;;;;;;;;OAeG;WACU,MAAM,CAAC,OAAO,SAAS,YAAY,GAAG,YAAY,EAC7D,SAAS,EAAE,qBAAqB,CAAC,OAAO,CAAC,EACzC,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;CAgB9C"}
+{"version":3,"file":"commander.factory.d.mts","sourceRoot":"","sources":["../../src/commander.factory.mts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAIpG,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAA;AAE5E;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;IACtB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACxC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;IACtB;;;OAGG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAA;IAC/B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,mBAAmB,CAAA;CACjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,gBAAgB;IAC3B;;;;;;;;;;;;;;;OAeG;WACU,MAAM,CAAC,OAAO,SAAS,YAAY,GAAG,YAAY,EAC7D,SAAS,EAAE,qBAAqB,CAAC,OAAO,CAAC,EACzC,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;CA4D9C"}

package/dist/src/commands/help.command.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"help.command.d.mts","sourceRoot":"","sources":["../../../src/commands/help.command.mts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6CAA6C,CAAA;AAKjF,QAAA,MAAM,iBAAiB;;iBAErB,CAAA;AAEF,KAAK,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEpD;;;;GAIG;AACH,qBAKa,WAAY,YAAW,cAAc,CAAC,WAAW,CAAC;IAC7D,OAAO,CAAC,MAAM,CAA2C;IACzD,OAAO,CAAC,eAAe,CAAiC;IAElD,OAAO,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAOnD"}
+{"version":3,"file":"help.command.d.mts","sourceRoot":"","sources":["../../../src/commands/help.command.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAMvB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6CAA6C,CAAA;AAEjF,QAAA,MAAM,iBAAiB;;iBAErB,CAAA;AAEF,KAAK,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEpD;;;;GAIG;AACH,qBAMa,WAAY,YAAW,cAAc,CAAC,WAAW,CAAC;IAC7D,OAAO,CAAC,MAAM,CAA2C;IACzD,OAAO,CAAC,eAAe,CAAiC;IAElD,OAAO,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAOnD"}

package/dist/src/decorators/command.decorator.d.mts

@@ -1,11 +1,18 @@
-import type { ClassType, Registry } from '@navios/core';
+import { InjectionToken } from '@navios/core';
+import type { ClassType, ClassTypeWithInstance, Registry } from '@navios/core';
 import type { ZodObject } from 'zod';
+import type { CommandHandler } from '../interfaces/index.mjs';
 /**
  * Options for the `@Command` decorator.
  *
  * @public
  */
 export interface CommandOptions {
+    /**
+     * The token to use for the command.
+     * If provided, the command will be registered with this token.
+     */
+    token?: InjectionToken<ClassTypeWithInstance<CommandHandler<any>>>;
     /**
      * The command path that users will invoke from the CLI.
      * Can be a single word (e.g., 'greet') or multi-word with colons (e.g., 'user:create', 'db:migrate').
@@ -62,5 +69,5 @@ export interface CommandOptions {
  * }
  * ```
  */
-export declare function Command({ path, description, optionsSchema, priority, registry, }: CommandOptions): (target: ClassType, context: ClassDecoratorContext) => ClassType;
+export declare function Command({ path, description, token, optionsSchema, priority, registry, }: CommandOptions): (target: ClassType, context: ClassDecoratorContext) => any;
 //# sourceMappingURL=command.decorator.d.mts.map

package/dist/src/decorators/command.decorator.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"command.decorator.d.mts","sourceRoot":"","sources":["../../../src/decorators/command.decorator.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AAMpC;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,CAAA;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,OAAO,CAAC,EACtB,IAAI,EACJ,WAAW,EACX,aAAa,EACb,QAAQ,EACR,QAAQ,GACT,EAAE,cAAc,IACE,QAAQ,SAAS,EAAE,SAAS,qBAAqB,eAiBnE"}
+{"version":3,"file":"command.decorator.d.mts","sourceRoot":"","sources":["../../../src/decorators/command.decorator.mts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,cAAc,EAAE,MAAM,cAAc,CAAA;AAE1E,OAAO,KAAK,EAAE,SAAS,EAAE,qBAAqB,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AAIpC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAE7D;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IAClE;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,CAAA;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,OAAO,CAAC,EACtB,IAAI,EACJ,WAAW,EACX,KAAK,EACL,aAAa,EACb,QAAQ,EACR,QAAQ,GACT,EAAE,cAAc,IACE,QAAQ,SAAS,EAAE,SAAS,qBAAqB,SAkBnE"}

package/dist/src/overrides/help.command.d.mts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import type { CommandHandler } from '../interfaces/command-handler.interface.mjs';
+declare const helpOptionsSchema: z.ZodObject<{
+    command: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type HelpOptions = z.infer<typeof helpOptionsSchema>;
+/**
+ * Built-in help command that lists all available commands or shows help for a specific command.
+ *
+ * @public
+ */
+export declare class HelpCommand implements CommandHandler<HelpOptions> {
+    private logger;
+    private commandRegistry;
+    execute(options: HelpOptions): Promise<void>;
+}
+export {};
+//# sourceMappingURL=help.command.d.mts.map

package/dist/src/overrides/help.command.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"help.command.d.mts","sourceRoot":"","sources":["../../../src/overrides/help.command.mts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAMvB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6CAA6C,CAAA;AAEjF,QAAA,MAAM,iBAAiB;;iBAErB,CAAA;AAEF,KAAK,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEpD;;;;GAIG;AACH,qBAOa,WAAY,YAAW,cAAc,CAAC,WAAW,CAAC;IAC7D,OAAO,CAAC,MAAM,CAAoF;IAClG,OAAO,CAAC,eAAe,CAAiC;IAElD,OAAO,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAOnD"}

package/dist/src/tokens/help-command.token.d.mts

@@ -0,0 +1,4 @@
+import { InjectionToken } from '@navios/core';
+import type { HelpCommand } from '../overrides/help.command.mjs';
+export declare const HelpCommandToken: InjectionToken<HelpCommand, undefined, false>;
+//# sourceMappingURL=help-command.token.d.mts.map

package/dist/src/tokens/help-command.token.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"help-command.token.d.mts","sourceRoot":"","sources":["../../../src/tokens/help-command.token.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAE7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAEhE,eAAO,MAAM,gBAAgB,+CAAoD,CAAA"}