@navios/commander 1.1.0 → 1.3.0

package/CHANGELOG.md

@@ -5,6 +5,24 @@ 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.3.0] - 2026-01-13
+
+### Added
+
+- **TUI Adapter Selection** - New `adapter` option in `CommanderTuiOptions` to choose the TUI framework
+  - `'react'` (default) - Uses React-based TUI components
+  - `'solid'` - Uses Solid.js-based TUI components
+  - Dynamically imports the appropriate adapter module
+
+## [1.2.0] - 2026-01-11
+
+### Added
+
+- **Legacy Compatibility Module** - New `@navios/commander/legacy-compat` subpath export for projects using TypeScript experimental decorators
+  - `Command` decorator wrapper that converts legacy decorator API to Stage 3 format
+  - `CliModule` decorator wrapper for legacy compatibility
+  - Re-exports `@navios/core/legacy-compat` utilities for convenience
+
 ## [1.1.0] - 2026-01-10
 
 ### Added

package/README.md

@@ -312,6 +312,78 @@ CLI adapter interface returned by `app.getAdapter()`.
 - `async executeCommand(path, options?)` - Executes a command programmatically with options
 - `getAllCommands()` - Returns all registered commands
 
+## TUI Mode
+
+Commander supports an optional Terminal User Interface (TUI) mode for rich, interactive CLI experiences.
+
+### Enabling TUI
+
+```typescript
+import { CommanderFactory } from '@navios/commander'
+
+const app = await CommanderFactory.create(AppModule, {
+  enableTUI: true,
+  tuiOptions: {
+    theme: 'dark',
+    autoClose: { enabled: true, delay: 3000 },
+  },
+})
+```
+
+### Choosing a Framework Adapter
+
+The TUI supports both React and Solid.js rendering frameworks:
+
+```typescript
+const app = await CommanderFactory.create(AppModule, {
+  enableTUI: true,
+  tuiOptions: {
+    adapter: 'react', // 'react' (default) or 'solid'
+    theme: 'dark',
+  },
+})
+```
+
+For Solid.js support, install the optional dependency:
+
+```bash
+npm install solid-js
+```
+
+### TUI Options
+
+- `adapter` - Framework adapter: `'react'` (default) or `'solid'`
+- `theme` - Theme preset: `'dark'`, `'light'`, or `'high-contrast'`
+- `exitOnCtrlC` - Exit on Ctrl+C (default: `true`)
+- `sidebarWidth` - Sidebar width in columns
+- `sidebarPosition` - Sidebar position: `'left'` or `'right'`
+- `sidebarTitle` - Sidebar title text
+- `autoClose` - Auto-close configuration with `enabled` and `delay`
+- `useMouse` - Enable mouse support (default: `true`)
+- `hideDefaultScreen` - Hide the default screen
+
+## Legacy Decorator Support
+
+If your project uses TypeScript experimental decorators (legacy mode), you can import from the `legacy-compat` subpath:
+
+```typescript
+import { Command, CliModule, CommandHandler } from '@navios/commander/legacy-compat'
+
+@Command({ path: 'greet' })
+export class GreetCommand implements CommandHandler {
+  async execute() {
+    console.log('Hello!')
+  }
+}
+
+@CliModule({
+  commands: [GreetCommand],
+})
+export class AppModule {}
+```
+
+This provides wrapper decorators that convert the legacy decorator API to Stage 3 format internally, allowing you to use the same decorator syntax while maintaining compatibility with older TypeScript configurations.
+
 ## License
 
 MIT

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

@@ -55,6 +55,11 @@ export interface CommanderTuiOptions {
      * @default true
      */
     exitOnCtrlC?: boolean;
+    /**
+     * Adapter to use for the TUI.
+     * @default 'react'
+     */
+    adapter?: 'react' | 'solid';
     /**
      * Sidebar width in columns.
      */

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":"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"}
+{"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;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAA;IAC3B;;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;CAiE9C"}

package/dist/src/legacy-compat/decorators/cli-module.decorator.d.mts

@@ -0,0 +1,26 @@
+import type { ClassType } from '@navios/core';
+import { type CliModuleOptions } from '../../decorators/cli-module.decorator.mjs';
+export type { CliModuleOptions };
+/**
+ * Legacy-compatible CliModule decorator.
+ *
+ * Works with TypeScript experimental decorators (legacy API).
+ *
+ * @param options - CLI module configuration options
+ * @returns A class decorator compatible with legacy decorator API
+ *
+ * @example
+ * ```typescript
+ * import { CliModule } from '@navios/commander/legacy-compat'
+ * import { GreetCommand } from './greet.command'
+ * import { UserModule } from './user.module'
+ *
+ * @CliModule({
+ *   commands: [GreetCommand],
+ *   imports: [UserModule]
+ * })
+ * export class AppModule {}
+ * ```
+ */
+export declare function CliModule(options?: CliModuleOptions): (target: ClassType) => ClassType;
+//# sourceMappingURL=cli-module.decorator.d.mts.map

package/dist/src/legacy-compat/decorators/cli-module.decorator.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-module.decorator.d.mts","sourceRoot":"","sources":["../../../../src/legacy-compat/decorators/cli-module.decorator.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAG7C,OAAO,EAEL,KAAK,gBAAgB,EACtB,MAAM,2CAA2C,CAAA;AAElD,YAAY,EAAE,gBAAgB,EAAE,CAAA;AAEhC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,SAAS,CACvB,OAAO,GAAE,gBAMR,IAEgB,QAAQ,SAAS,eAKnC"}

package/dist/src/legacy-compat/decorators/command.decorator.d.mts

@@ -0,0 +1,34 @@
+import type { ClassType } from '@navios/core';
+import { type CommandOptions } from '../../decorators/command.decorator.mjs';
+export type { CommandOptions };
+/**
+ * Legacy-compatible Command decorator.
+ *
+ * Works with TypeScript experimental decorators (legacy API).
+ *
+ * @param options - Command configuration options
+ * @returns A class decorator compatible with legacy decorator API
+ *
+ * @example
+ * ```typescript
+ * import { Command, CommandHandler } from '@navios/commander/legacy-compat'
+ * import { z } from 'zod'
+ *
+ * const optionsSchema = z.object({
+ *   name: z.string(),
+ *   greeting: z.string().optional().default('Hello')
+ * })
+ *
+ * @Command({
+ *   path: 'greet',
+ *   optionsSchema: optionsSchema
+ * })
+ * export class GreetCommand implements CommandHandler<z.infer<typeof optionsSchema>> {
+ *   async execute(options) {
+ *     console.log(`${options.greeting}, ${options.name}!`)
+ *   }
+ * }
+ * ```
+ */
+export declare function Command(options: CommandOptions): (target: ClassType) => any;
+//# sourceMappingURL=command.decorator.d.mts.map

package/dist/src/legacy-compat/decorators/command.decorator.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.decorator.d.mts","sourceRoot":"","sources":["../../../../src/legacy-compat/decorators/command.decorator.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAG7C,OAAO,EAEL,KAAK,cAAc,EACpB,MAAM,wCAAwC,CAAA;AAE/C,YAAY,EAAE,cAAc,EAAE,CAAA;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,cAAc,IAC5B,QAAQ,SAAS,SAKnC"}

package/dist/src/legacy-compat/decorators/index.d.mts

@@ -0,0 +1,3 @@
+export * from './command.decorator.mjs';
+export * from './cli-module.decorator.mjs';
+//# sourceMappingURL=index.d.mts.map

package/dist/src/legacy-compat/decorators/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../../src/legacy-compat/decorators/index.mts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,4BAA4B,CAAA"}

package/dist/src/legacy-compat/index.d.mts

@@ -0,0 +1,28 @@
+/**
+ * Legacy-compatible decorators for projects using TypeScript experimental decorators.
+ *
+ * These decorators wrap the Stage 3 decorator implementations and convert
+ * the legacy decorator arguments to Stage 3 format internally.
+ *
+ * @example
+ * ```typescript
+ * import { Command, CliModule, CommandHandler } from '@navios/commander/legacy-compat'
+ *
+ * @Command({ path: 'greet' })
+ * export class GreetCommand implements CommandHandler {
+ *   async execute() {
+ *     console.log('Hello!')
+ *   }
+ * }
+ *
+ * @CliModule({
+ *   commands: [GreetCommand],
+ * })
+ * export class AppModule {}
+ * ```
+ *
+ * @packageDocumentation
+ */
+export * from './decorators/index.mjs';
+export * from '@navios/core/legacy-compat';
+//# sourceMappingURL=index.d.mts.map

package/dist/src/legacy-compat/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/legacy-compat/index.mts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAGH,cAAc,wBAAwB,CAAA;AAGtC,cAAc,4BAA4B,CAAA"}