cli-menu-kit 0.1.0

package/dist/features/commands.js

@@ -0,0 +1,161 @@
+"use strict";
+/**
+ * Commands - Command handling system
+ * Handles special commands like /quit, /help, /clear, /back
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerCommand = registerCommand;
+exports.unregisterCommand = unregisterCommand;
+exports.clearCustomCommands = clearCustomCommands;
+exports.isCommand = isCommand;
+exports.parseCommand = parseCommand;
+exports.handleCommand = handleCommand;
+exports.getAvailableCommands = getAvailableCommands;
+exports.showCommandHelp = showCommandHelp;
+const terminal_js_1 = require("../core/terminal.js");
+const colors_js_1 = require("../core/colors.js");
+/**
+ * Default command registry
+ */
+const defaultCommands = {
+    quit: {
+        handler: () => {
+            (0, terminal_js_1.writeLine)('\n👋 再见!');
+            process.exit(0);
+        },
+        description: '退出应用程序'
+    },
+    help: {
+        handler: () => {
+            (0, terminal_js_1.writeLine)('\n可用命令:');
+            Object.entries(defaultCommands).forEach(([cmd, { description }]) => {
+                (0, terminal_js_1.writeLine)(`  ${colors_js_1.colors.cyan}/${cmd}${colors_js_1.colors.reset} - ${description}`);
+            });
+            (0, terminal_js_1.writeLine)('');
+            return false; // Don't exit, continue
+        },
+        description: '显示帮助信息'
+    },
+    clear: {
+        handler: () => {
+            (0, terminal_js_1.clearScreen)();
+            return false; // Don't exit, continue
+        },
+        description: '清除屏幕'
+    },
+    back: {
+        handler: () => {
+            return true; // Signal to go back
+        },
+        description: '返回上一级菜单'
+    }
+};
+/**
+ * Custom command registry (can be extended by users)
+ */
+let customCommands = {};
+/**
+ * Register a custom command
+ * @param command - Command name (without /)
+ * @param handler - Command handler function
+ * @param description - Command description
+ */
+function registerCommand(command, handler, description) {
+    customCommands[command.toLowerCase()] = { handler, description };
+}
+/**
+ * Unregister a custom command
+ * @param command - Command name (without /)
+ */
+function unregisterCommand(command) {
+    delete customCommands[command.toLowerCase()];
+}
+/**
+ * Clear all custom commands
+ */
+function clearCustomCommands() {
+    customCommands = {};
+}
+/**
+ * Check if input is a command
+ * @param input - Input string
+ * @returns True if input is a command
+ */
+function isCommand(input) {
+    return input.startsWith('/');
+}
+/**
+ * Parse command from input
+ * @param input - Input string
+ * @returns Command name and args, or null if not a command
+ */
+function parseCommand(input) {
+    if (!isCommand(input)) {
+        return null;
+    }
+    const parts = input.slice(1).split(/\s+/);
+    const command = parts[0].toLowerCase();
+    const args = parts.slice(1);
+    return { command, args };
+}
+/**
+ * Handle a command
+ * @param input - Input string
+ * @returns Command result (true = handled and should exit/go back, false = continue, undefined = not a command)
+ */
+function handleCommand(input) {
+    const parsed = parseCommand(input);
+    if (!parsed) {
+        return undefined; // Not a command
+    }
+    const { command, args } = parsed;
+    // Check custom commands first
+    if (customCommands[command]) {
+        const result = customCommands[command].handler(args);
+        return result === undefined ? false : result;
+    }
+    // Check default commands
+    if (defaultCommands[command]) {
+        const result = defaultCommands[command].handler(args);
+        return result === undefined ? false : result;
+    }
+    // Unknown command
+    (0, terminal_js_1.writeLine)(`${colors_js_1.colors.red}✗ 未知命令: /${command}${colors_js_1.colors.reset}`);
+    (0, terminal_js_1.writeLine)(`${colors_js_1.colors.dim}输入 /help 查看可用命令${colors_js_1.colors.reset}\n`);
+    return false;
+}
+/**
+ * Get all available commands
+ * @returns Array of command names with descriptions
+ */
+function getAvailableCommands() {
+    const commands = [];
+    // Add default commands
+    Object.entries(defaultCommands).forEach(([cmd, { description }]) => {
+        commands.push({ command: cmd, description });
+    });
+    // Add custom commands
+    Object.entries(customCommands).forEach(([cmd, { description }]) => {
+        commands.push({ command: cmd, description });
+    });
+    return commands;
+}
+/**
+ * Show help for all commands
+ */
+function showCommandHelp() {
+    (0, terminal_js_1.writeLine)('\n可用命令:');
+    // Show default commands
+    (0, terminal_js_1.writeLine)(`\n${colors_js_1.colors.cyan}默认命令:${colors_js_1.colors.reset}`);
+    Object.entries(defaultCommands).forEach(([cmd, { description }]) => {
+        (0, terminal_js_1.writeLine)(`  ${colors_js_1.colors.cyan}/${cmd}${colors_js_1.colors.reset} - ${description}`);
+    });
+    // Show custom commands if any
+    if (Object.keys(customCommands).length > 0) {
+        (0, terminal_js_1.writeLine)(`\n${colors_js_1.colors.cyan}自定义命令:${colors_js_1.colors.reset}`);
+        Object.entries(customCommands).forEach(([cmd, { description }]) => {
+            (0, terminal_js_1.writeLine)(`  ${colors_js_1.colors.cyan}/${cmd}${colors_js_1.colors.reset} - ${description}`);
+        });
+    }
+    (0, terminal_js_1.writeLine)('');
+}

package/dist/features/wizard.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Wizard - Initialization wizard system
+ * Multi-step configuration flow with progress tracking
+ */
+/**
+ * Wizard step component type
+ */
+export type WizardComponentType = 'radio-menu' | 'checkbox-menu' | 'boolean-menu' | 'text-input' | 'number-input' | 'language-selector';
+/**
+ * Wizard step configuration
+ */
+export interface WizardStep {
+    /** Step name/identifier */
+    name: string;
+    /** Step title for display */
+    title: string;
+    /** Component type to use */
+    component: WizardComponentType;
+    /** Component-specific configuration */
+    config: any;
+    /** Whether this step is required */
+    required?: boolean;
+    /** Validation function */
+    validate?: (value: any) => boolean | string;
+    /** Skip condition (if returns true, skip this step) */
+    skip?: (results: Record<string, any>) => boolean;
+}
+/**
+ * Wizard configuration
+ */
+export interface WizardConfig {
+    /** Wizard title */
+    title?: string;
+    /** Array of wizard steps */
+    steps: WizardStep[];
+    /** Show progress indicator */
+    showProgress?: boolean;
+    /** Callback when wizard completes */
+    onComplete?: (results: Record<string, any>) => void;
+    /** Callback when wizard is cancelled */
+    onCancel?: () => void;
+}
+/**
+ * Wizard result
+ */
+export interface WizardResult {
+    completed: boolean;
+    results: Record<string, any>;
+}
+/**
+ * Run a wizard
+ * @param config - Wizard configuration
+ * @returns Promise resolving to wizard results
+ */
+export declare function runWizard(config: WizardConfig): Promise<WizardResult>;
+/**
+ * Create a simple wizard
+ * @param steps - Array of wizard steps
+ * @param onComplete - Completion callback
+ * @returns Promise resolving to wizard results
+ */
+export declare function createWizard(steps: WizardStep[], onComplete?: (results: Record<string, any>) => void): Promise<WizardResult>;

package/dist/features/wizard.js

@@ -0,0 +1,112 @@
+"use strict";
+/**
+ * Wizard - Initialization wizard system
+ * Multi-step configuration flow with progress tracking
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runWizard = runWizard;
+exports.createWizard = createWizard;
+const radio_menu_js_1 = require("../components/menus/radio-menu.js");
+const checkbox_menu_js_1 = require("../components/menus/checkbox-menu.js");
+const boolean_menu_js_1 = require("../components/menus/boolean-menu.js");
+const text_input_js_1 = require("../components/inputs/text-input.js");
+const number_input_js_1 = require("../components/inputs/number-input.js");
+const language_input_js_1 = require("../components/inputs/language-input.js");
+const progress_js_1 = require("../components/display/progress.js");
+const messages_js_1 = require("../components/display/messages.js");
+/**
+ * Run a wizard
+ * @param config - Wizard configuration
+ * @returns Promise resolving to wizard results
+ */
+async function runWizard(config) {
+    const { title, steps, showProgress = true, onComplete, onCancel } = config;
+    const results = {};
+    const stepNames = steps.map(s => s.title);
+    for (let i = 0; i < steps.length; i++) {
+        const step = steps[i];
+        // Check skip condition
+        if (step.skip && step.skip(results)) {
+            continue;
+        }
+        // Show progress
+        if (showProgress) {
+            console.log('');
+            (0, progress_js_1.createProgressIndicator)(stepNames, i);
+            console.log('');
+        }
+        // Show stage header
+        (0, progress_js_1.createStageHeader)(step.title, i + 1);
+        console.log('');
+        // Execute step component
+        let value;
+        try {
+            switch (step.component) {
+                case 'radio-menu':
+                    value = await (0, radio_menu_js_1.showRadioMenu)(step.config);
+                    break;
+                case 'checkbox-menu':
+                    value = await (0, checkbox_menu_js_1.showCheckboxMenu)(step.config);
+                    break;
+                case 'boolean-menu':
+                    value = await (0, boolean_menu_js_1.showBooleanMenu)(step.config);
+                    break;
+                case 'text-input':
+                    value = await (0, text_input_js_1.showTextInput)(step.config);
+                    break;
+                case 'number-input':
+                    value = await (0, number_input_js_1.showNumberInput)(step.config);
+                    break;
+                case 'language-selector':
+                    value = await (0, language_input_js_1.showLanguageSelector)(step.config);
+                    break;
+                default:
+                    throw new Error(`Unknown component type: ${step.component}`);
+            }
+        }
+        catch (error) {
+            // User cancelled (Ctrl+C)
+            if (onCancel) {
+                onCancel();
+            }
+            return { completed: false, results };
+        }
+        // Validate result
+        if (step.validate) {
+            const validationResult = step.validate(value);
+            if (validationResult !== true) {
+                const errorMsg = typeof validationResult === 'string'
+                    ? validationResult
+                    : 'Validation failed';
+                console.log(`\n❌ ${errorMsg}\n`);
+                i--; // Retry this step
+                continue;
+            }
+        }
+        // Store result
+        results[step.name] = value;
+        // Show stage separator (except after last step)
+        if (i < steps.length - 1) {
+            console.log('');
+            (0, progress_js_1.createStageSeparator)();
+            console.log('');
+        }
+    }
+    // Wizard completed
+    console.log('');
+    (0, messages_js_1.showSuccess)('配置完成!');
+    console.log('');
+    if (onComplete) {
+        onComplete(results);
+    }
+    return { completed: true, results };
+}
+/**
+ * Create a simple wizard
+ * @param steps - Array of wizard steps
+ * @param onComplete - Completion callback
+ * @returns Promise resolving to wizard results
+ */
+async function createWizard(steps, onComplete) {
+    return runWizard({ steps, onComplete });
+}

package/dist/i18n/languages/en.d.ts

@@ -0,0 +1,5 @@
+/**
+ * English translations
+ */
+import { LanguageMap } from '../types.js';
+export declare const en: LanguageMap;

package/dist/i18n/languages/en.js

@@ -0,0 +1,54 @@
+"use strict";
+/**
+ * English translations
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.en = void 0;
+exports.en = {
+    menus: {
+        selectPrompt: 'Enter option or use ↑↓ to select, press Enter to confirm',
+        multiSelectPrompt: 'Space to toggle, Enter to confirm',
+        confirmPrompt: 'Press Enter to confirm',
+        selectedCount: 'selected'
+    },
+    hints: {
+        arrows: '↑↓ Arrow keys',
+        space: 'Space Toggle',
+        enter: '⏎ Confirm',
+        numbers: '0-9 Number keys',
+        letters: 'A-Z Letter keys',
+        selectAll: 'A Select all',
+        invert: 'I Invert',
+        yesNo: 'Y/N Quick keys'
+    },
+    messages: {
+        success: 'Success',
+        error: 'Error',
+        warning: 'Warning',
+        info: 'Info',
+        question: 'Question',
+        goodbye: '👋 Goodbye!',
+        unknownCommand: 'Unknown command',
+        helpPrompt: 'Type /help to see available commands'
+    },
+    inputs: {
+        defaultValue: 'default',
+        enterText: 'Enter text',
+        enterNumber: 'Enter number',
+        minLength: 'Min length',
+        maxLength: 'Max length',
+        minValue: 'Min value',
+        maxValue: 'Max value',
+        invalidInput: 'Invalid input',
+        cannotBeEmpty: 'Cannot be empty'
+    },
+    commands: {
+        quit: 'Exit application',
+        help: 'Show help information',
+        clear: 'Clear screen',
+        back: 'Go back to previous menu',
+        availableCommands: 'Available commands',
+        defaultCommands: 'Default commands',
+        customCommands: 'Custom commands'
+    }
+};

package/dist/i18n/languages/zh.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Chinese (Simplified) translations
+ */
+import { LanguageMap } from '../types.js';
+export declare const zh: LanguageMap;

package/dist/i18n/languages/zh.js

@@ -0,0 +1,54 @@
+"use strict";
+/**
+ * Chinese (Simplified) translations
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zh = void 0;
+exports.zh = {
+    menus: {
+        selectPrompt: '输入选项或用↑↓选择,回车确认',
+        multiSelectPrompt: '空格选中/取消,回车确认',
+        confirmPrompt: '回车确认',
+        selectedCount: '项已选'
+    },
+    hints: {
+        arrows: '↑↓ 方向键',
+        space: '空格 选中/取消',
+        enter: '⏎ 确认',
+        numbers: '0-9 输入序号',
+        letters: 'A-Z 字母选择',
+        selectAll: 'A 全选',
+        invert: 'I 反选',
+        yesNo: 'Y/N 快捷键'
+    },
+    messages: {
+        success: '成功',
+        error: '错误',
+        warning: '警告',
+        info: '提示',
+        question: '问题',
+        goodbye: '👋 再见!',
+        unknownCommand: '未知命令',
+        helpPrompt: '输入 /help 查看可用命令'
+    },
+    inputs: {
+        defaultValue: '默认',
+        enterText: '请输入文本',
+        enterNumber: '请输入数字',
+        minLength: '最小长度',
+        maxLength: '最大长度',
+        minValue: '最小值',
+        maxValue: '最大值',
+        invalidInput: '输入无效',
+        cannotBeEmpty: '输入不能为空'
+    },
+    commands: {
+        quit: '退出应用程序',
+        help: '显示帮助信息',
+        clear: '清除屏幕',
+        back: '返回上一级菜单',
+        availableCommands: '可用命令',
+        defaultCommands: '默认命令',
+        customCommands: '自定义命令'
+    }
+};

package/dist/i18n/registry.d.ts

@@ -0,0 +1,36 @@
+/**
+ * i18n registry - Language management system
+ */
+import { LanguageCode, LanguageMap } from './types.js';
+/**
+ * Get current language code
+ * @returns Current language code
+ */
+export declare function getCurrentLanguage(): LanguageCode;
+/**
+ * Set current language
+ * @param lang - Language code to set
+ */
+export declare function setLanguage(lang: LanguageCode): void;
+/**
+ * Get translation for a key path
+ * @param keyPath - Dot-separated key path (e.g., 'menus.selectPrompt')
+ * @returns Translated string
+ */
+export declare function t(keyPath: string): string;
+/**
+ * Register a new language
+ * @param code - Language code
+ * @param translations - Language translations
+ */
+export declare function registerLanguage(code: string, translations: LanguageMap): void;
+/**
+ * Get all registered languages
+ * @returns Array of language codes
+ */
+export declare function getAvailableLanguages(): LanguageCode[];
+/**
+ * Get current language map
+ * @returns Current language translations
+ */
+export declare function getCurrentLanguageMap(): LanguageMap;

package/dist/i18n/registry.js

@@ -0,0 +1,82 @@
+"use strict";
+/**
+ * i18n registry - Language management system
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCurrentLanguage = getCurrentLanguage;
+exports.setLanguage = setLanguage;
+exports.t = t;
+exports.registerLanguage = registerLanguage;
+exports.getAvailableLanguages = getAvailableLanguages;
+exports.getCurrentLanguageMap = getCurrentLanguageMap;
+const zh_js_1 = require("./languages/zh.js");
+const en_js_1 = require("./languages/en.js");
+/**
+ * Global i18n registry
+ */
+const registry = {
+    languages: {
+        zh: zh_js_1.zh,
+        en: en_js_1.en
+    },
+    current: 'zh' // Default language
+};
+/**
+ * Get current language code
+ * @returns Current language code
+ */
+function getCurrentLanguage() {
+    return registry.current;
+}
+/**
+ * Set current language
+ * @param lang - Language code to set
+ */
+function setLanguage(lang) {
+    if (!registry.languages[lang]) {
+        throw new Error(`Language '${lang}' is not registered`);
+    }
+    registry.current = lang;
+}
+/**
+ * Get translation for a key path
+ * @param keyPath - Dot-separated key path (e.g., 'menus.selectPrompt')
+ * @returns Translated string
+ */
+function t(keyPath) {
+    const keys = keyPath.split('.');
+    const langMap = registry.languages[registry.current];
+    let value = langMap;
+    for (const key of keys) {
+        if (value && typeof value === 'object' && key in value) {
+            value = value[key];
+        }
+        else {
+            console.warn(`Translation key not found: ${keyPath}`);
+            return keyPath; // Return key path as fallback
+        }
+    }
+    return typeof value === 'string' ? value : keyPath;
+}
+/**
+ * Register a new language
+ * @param code - Language code
+ * @param translations - Language translations
+ */
+function registerLanguage(code, translations) {
+    registry.languages[code] = translations;
+}
+/**
+ * Get all registered languages
+ * @returns Array of language codes
+ */
+function getAvailableLanguages() {
+    return Object.keys(registry.languages);
+}
+/**
+ * Get current language map
+ * @returns Current language translations
+ */
+function getCurrentLanguageMap() {
+    return registry.languages[registry.current];
+}

package/dist/i18n/types.d.ts

@@ -0,0 +1,65 @@
+/**
+ * i18n types - Internationalization type definitions
+ */
+/**
+ * Language code type
+ */
+export type LanguageCode = 'zh' | 'en';
+/**
+ * Translation map structure
+ */
+export interface LanguageMap {
+    menus: {
+        selectPrompt: string;
+        multiSelectPrompt: string;
+        confirmPrompt: string;
+        selectedCount: string;
+    };
+    hints: {
+        arrows: string;
+        space: string;
+        enter: string;
+        numbers: string;
+        letters: string;
+        selectAll: string;
+        invert: string;
+        yesNo: string;
+    };
+    messages: {
+        success: string;
+        error: string;
+        warning: string;
+        info: string;
+        question: string;
+        goodbye: string;
+        unknownCommand: string;
+        helpPrompt: string;
+    };
+    inputs: {
+        defaultValue: string;
+        enterText: string;
+        enterNumber: string;
+        minLength: string;
+        maxLength: string;
+        minValue: string;
+        maxValue: string;
+        invalidInput: string;
+        cannotBeEmpty: string;
+    };
+    commands: {
+        quit: string;
+        help: string;
+        clear: string;
+        back: string;
+        availableCommands: string;
+        defaultCommands: string;
+        customCommands: string;
+    };
+}
+/**
+ * i18n registry interface
+ */
+export interface I18nRegistry {
+    languages: Record<LanguageCode, LanguageMap>;
+    current: LanguageCode;
+}

package/dist/i18n/types.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * i18n types - Internationalization type definitions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+/**
+ * CLI Menu Kit - Main Entry Point
+ * A comprehensive, modular menu system for Node.js CLI applications
+ */
+export { menuAPI as menu, inputAPI as input, wizardAPI as wizard } from './api.js';
+export { default } from './api.js';
+export { showRadioMenu, showCheckboxMenu, showBooleanMenu } from './components/menus/index.js';
+export { showTextInput, showNumberInput, showLanguageSelector, showModifyField } from './components/inputs/index.js';
+export { renderSimpleHeader, renderAsciiHeader, createSimpleHeader, createAsciiHeader, renderProgressIndicator, renderStageHeader, renderStageSeparator, createProgressIndicator, createStageHeader, createStageSeparator, renderMessage, showSuccess, showError, showWarning, showInfo, showQuestion, createMessage, renderSummaryTable, createSummaryTable, createSimpleSummary } from './components/display/index.js';
+export { runWizard, createWizard, WizardConfig, WizardStep, WizardResult } from './features/wizard.js';
+export { registerCommand, unregisterCommand, clearCustomCommands, isCommand, parseCommand, handleCommand, getAvailableCommands, showCommandHelp } from './features/commands.js';
+export { getCurrentLanguage, setLanguage, t, registerLanguage, getAvailableLanguages, getCurrentLanguageMap } from './i18n/registry.js';
+export type { MenuLayout, LayoutElement, LayoutVisibility, LayoutSpacing } from './types/layout.types.js';
+export type { MenuOption, BaseMenuConfig, RadioMenuConfig, CheckboxMenuConfig, BooleanMenuConfig, RadioMenuResult, CheckboxMenuResult, BooleanMenuResult } from './types/menu.types.js';
+export type { BaseInputConfig, TextInputConfig, NumberInputConfig, LanguageSelectorConfig, ModifyFieldConfig, TextInputResult, NumberInputResult, LanguageSelectorResult, ModifyFieldResult } from './types/input.types.js';
+export type { HeaderType, SimpleHeaderConfig, AsciiHeaderConfig, ProgressConfig, MessageType, MessageConfig, SummaryTableConfig } from './types/display.types.js';
+export type { LanguageCode, LanguageMap, I18nRegistry } from './i18n/types.js';
+export { colors, createGradient, applyGradient, colorize } from './core/colors.js';
+export { KEY_CODES } from './core/keyboard.js';
+export { LAYOUT_PRESETS } from './types/layout.types.js';
+export * from './types';
+export * from './components';
+export * from './menu-core';
+export * from './menu-single';
+export * from './menu-multi';
+export * from './input';
+export * from './menu';