cli-menu-kit 0.1.0

package/dist/api.d.ts

@@ -0,0 +1,158 @@
+/**
+ * Unified API - Main entry point for CLI Menu Kit
+ * Provides a simple, consistent API for all components
+ */
+import { WizardConfig, WizardResult } from './features/wizard.js';
+import { RadioMenuConfig, CheckboxMenuConfig, BooleanMenuConfig, RadioMenuResult, CheckboxMenuResult, BooleanMenuResult } from './types/menu.types.js';
+import { TextInputConfig, NumberInputConfig, LanguageSelectorConfig, ModifyFieldConfig, TextInputResult, NumberInputResult, LanguageSelectorResult, ModifyFieldResult } from './types/input.types.js';
+/**
+ * Unified menu API
+ */
+export declare const menuAPI: {
+    /**
+     * Show a radio menu (single-select)
+     * @param config - Menu configuration
+     * @returns Promise resolving to selected option
+     */
+    radio: (config: RadioMenuConfig) => Promise<RadioMenuResult>;
+    /**
+     * Show a checkbox menu (multi-select)
+     * @param config - Menu configuration
+     * @returns Promise resolving to selected options
+     */
+    checkbox: (config: CheckboxMenuConfig) => Promise<CheckboxMenuResult>;
+    /**
+     * Show a boolean menu (yes/no)
+     * @param config - Menu configuration
+     * @returns Promise resolving to boolean result
+     */
+    boolean: (config: BooleanMenuConfig) => Promise<BooleanMenuResult>;
+    /**
+     * Show a boolean menu (horizontal)
+     * @param question - Question text
+     * @param defaultValue - Default value
+     * @returns Promise resolving to boolean result
+     */
+    booleanH: (question: string, defaultValue?: boolean) => Promise<boolean>;
+    /**
+     * Show a boolean menu (vertical)
+     * @param question - Question text
+     * @param defaultValue - Default value
+     * @returns Promise resolving to boolean result
+     */
+    booleanV: (question: string, defaultValue?: boolean) => Promise<boolean>;
+};
+/**
+ * Unified input API
+ */
+export declare const inputAPI: {
+    /**
+     * Show a text input
+     * @param config - Input configuration
+     * @returns Promise resolving to entered text
+     */
+    text: (config: TextInputConfig) => Promise<TextInputResult>;
+    /**
+     * Show a number input
+     * @param config - Input configuration
+     * @returns Promise resolving to entered number
+     */
+    number: (config: NumberInputConfig) => Promise<NumberInputResult>;
+    /**
+     * Show a language selector
+     * @param config - Selector configuration
+     * @returns Promise resolving to selected language code
+     */
+    language: (config: LanguageSelectorConfig) => Promise<LanguageSelectorResult>;
+    /**
+     * Show a modify field prompt
+     * @param config - Field configuration
+     * @returns Promise resolving to modification result
+     */
+    modifyField: (config: ModifyFieldConfig) => Promise<ModifyFieldResult>;
+};
+/**
+ * Unified wizard API
+ */
+export declare const wizardAPI: {
+    /**
+     * Run a wizard
+     * @param config - Wizard configuration
+     * @returns Promise resolving to wizard results
+     */
+    run: (config: WizardConfig) => Promise<WizardResult>;
+};
+/**
+ * Default export with all APIs
+ */
+declare const _default: {
+    menu: {
+        /**
+         * Show a radio menu (single-select)
+         * @param config - Menu configuration
+         * @returns Promise resolving to selected option
+         */
+        radio: (config: RadioMenuConfig) => Promise<RadioMenuResult>;
+        /**
+         * Show a checkbox menu (multi-select)
+         * @param config - Menu configuration
+         * @returns Promise resolving to selected options
+         */
+        checkbox: (config: CheckboxMenuConfig) => Promise<CheckboxMenuResult>;
+        /**
+         * Show a boolean menu (yes/no)
+         * @param config - Menu configuration
+         * @returns Promise resolving to boolean result
+         */
+        boolean: (config: BooleanMenuConfig) => Promise<BooleanMenuResult>;
+        /**
+         * Show a boolean menu (horizontal)
+         * @param question - Question text
+         * @param defaultValue - Default value
+         * @returns Promise resolving to boolean result
+         */
+        booleanH: (question: string, defaultValue?: boolean) => Promise<boolean>;
+        /**
+         * Show a boolean menu (vertical)
+         * @param question - Question text
+         * @param defaultValue - Default value
+         * @returns Promise resolving to boolean result
+         */
+        booleanV: (question: string, defaultValue?: boolean) => Promise<boolean>;
+    };
+    input: {
+        /**
+         * Show a text input
+         * @param config - Input configuration
+         * @returns Promise resolving to entered text
+         */
+        text: (config: TextInputConfig) => Promise<TextInputResult>;
+        /**
+         * Show a number input
+         * @param config - Input configuration
+         * @returns Promise resolving to entered number
+         */
+        number: (config: NumberInputConfig) => Promise<NumberInputResult>;
+        /**
+         * Show a language selector
+         * @param config - Selector configuration
+         * @returns Promise resolving to selected language code
+         */
+        language: (config: LanguageSelectorConfig) => Promise<LanguageSelectorResult>;
+        /**
+         * Show a modify field prompt
+         * @param config - Field configuration
+         * @returns Promise resolving to modification result
+         */
+        modifyField: (config: ModifyFieldConfig) => Promise<ModifyFieldResult>;
+    };
+    wizard: {
+        /**
+         * Run a wizard
+         * @param config - Wizard configuration
+         * @returns Promise resolving to wizard results
+         */
+        run: (config: WizardConfig) => Promise<WizardResult>;
+    };
+};
+export default _default;

package/dist/api.js

@@ -0,0 +1,128 @@
+"use strict";
+/**
+ * Unified API - Main entry point for CLI Menu Kit
+ * Provides a simple, consistent API for all components
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wizardAPI = exports.inputAPI = exports.menuAPI = void 0;
+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 modify_field_js_1 = require("./components/inputs/modify-field.js");
+const wizard_js_1 = require("./features/wizard.js");
+/**
+ * Unified menu API
+ */
+exports.menuAPI = {
+    /**
+     * Show a radio menu (single-select)
+     * @param config - Menu configuration
+     * @returns Promise resolving to selected option
+     */
+    radio: (config) => {
+        return (0, radio_menu_js_1.showRadioMenu)(config);
+    },
+    /**
+     * Show a checkbox menu (multi-select)
+     * @param config - Menu configuration
+     * @returns Promise resolving to selected options
+     */
+    checkbox: (config) => {
+        return (0, checkbox_menu_js_1.showCheckboxMenu)(config);
+    },
+    /**
+     * Show a boolean menu (yes/no)
+     * @param config - Menu configuration
+     * @returns Promise resolving to boolean result
+     */
+    boolean: (config) => {
+        return (0, boolean_menu_js_1.showBooleanMenu)(config);
+    },
+    /**
+     * Show a boolean menu (horizontal)
+     * @param question - Question text
+     * @param defaultValue - Default value
+     * @returns Promise resolving to boolean result
+     */
+    booleanH: (question, defaultValue) => {
+        return (0, boolean_menu_js_1.showBooleanMenu)({
+            question,
+            orientation: 'horizontal',
+            defaultValue
+        });
+    },
+    /**
+     * Show a boolean menu (vertical)
+     * @param question - Question text
+     * @param defaultValue - Default value
+     * @returns Promise resolving to boolean result
+     */
+    booleanV: (question, defaultValue) => {
+        return (0, boolean_menu_js_1.showBooleanMenu)({
+            question,
+            orientation: 'vertical',
+            defaultValue
+        });
+    }
+};
+/**
+ * Unified input API
+ */
+exports.inputAPI = {
+    /**
+     * Show a text input
+     * @param config - Input configuration
+     * @returns Promise resolving to entered text
+     */
+    text: (config) => {
+        return (0, text_input_js_1.showTextInput)(config);
+    },
+    /**
+     * Show a number input
+     * @param config - Input configuration
+     * @returns Promise resolving to entered number
+     */
+    number: (config) => {
+        return (0, number_input_js_1.showNumberInput)(config);
+    },
+    /**
+     * Show a language selector
+     * @param config - Selector configuration
+     * @returns Promise resolving to selected language code
+     */
+    language: (config) => {
+        return (0, language_input_js_1.showLanguageSelector)(config);
+    },
+    /**
+     * Show a modify field prompt
+     * @param config - Field configuration
+     * @returns Promise resolving to modification result
+     */
+    modifyField: (config) => {
+        return (0, modify_field_js_1.showModifyField)(config);
+    }
+};
+/**
+ * Unified wizard API
+ */
+exports.wizardAPI = {
+    /**
+     * Run a wizard
+     * @param config - Wizard configuration
+     * @returns Promise resolving to wizard results
+     */
+    run: (config) => {
+        return (0, wizard_js_1.runWizard)(config);
+    }
+};
+/**
+ * Default export with all APIs
+ */
+exports.default = {
+    menu: exports.menuAPI,
+    input: exports.inputAPI,
+    wizard: exports.wizardAPI
+};

package/dist/components/display/headers.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Headers - Display header components
+ * Provides simple and ASCII art headers
+ */
+import { SimpleHeaderConfig, AsciiHeaderConfig } from '../../types/display.types.js';
+/**
+ * Render a simple header
+ * @param config - Header configuration
+ */
+export declare function renderSimpleHeader(config: SimpleHeaderConfig): void;
+/**
+ * Render an ASCII art header with decorations
+ * @param config - Header configuration
+ */
+export declare function renderAsciiHeader(config: AsciiHeaderConfig): void;
+/**
+ * Create a simple header
+ * @param text - Header text
+ * @param color - Optional color
+ */
+export declare function createSimpleHeader(text: string, color?: string): void;
+/**
+ * Create an ASCII header
+ * @param asciiArt - ASCII art string
+ * @param options - Optional configuration
+ */
+export declare function createAsciiHeader(asciiArt: string, options?: {
+    subtitle?: string;
+    version?: string;
+    url?: string;
+    borderChar?: string;
+}): void;

package/dist/components/display/headers.js

@@ -0,0 +1,84 @@
+"use strict";
+/**
+ * Headers - Display header components
+ * Provides simple and ASCII art headers
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderSimpleHeader = renderSimpleHeader;
+exports.renderAsciiHeader = renderAsciiHeader;
+exports.createSimpleHeader = createSimpleHeader;
+exports.createAsciiHeader = createAsciiHeader;
+const terminal_js_1 = require("../../core/terminal.js");
+const colors_js_1 = require("../../core/colors.js");
+const terminal_js_2 = require("../../core/terminal.js");
+/**
+ * Render a simple header
+ * @param config - Header configuration
+ */
+function renderSimpleHeader(config) {
+    const { text, color } = config;
+    if (color) {
+        (0, terminal_js_1.writeLine)((0, colors_js_1.colorize)(text, color));
+    }
+    else {
+        (0, terminal_js_1.writeLine)(text);
+    }
+}
+/**
+ * Render an ASCII art header with decorations
+ * @param config - Header configuration
+ */
+function renderAsciiHeader(config) {
+    const { asciiArt, subtitle, version, url, borderChar = '═' } = config;
+    const termWidth = (0, terminal_js_2.getTerminalWidth)();
+    const border = borderChar.repeat(termWidth);
+    // Top border
+    (0, terminal_js_1.writeLine)(colors_js_1.colors.cyan + border + colors_js_1.colors.reset);
+    (0, terminal_js_1.writeLine)('');
+    // ASCII art (centered)
+    const artLines = asciiArt.split('\n');
+    artLines.forEach(line => {
+        (0, terminal_js_1.writeLine)(colors_js_1.colors.cyan + line + colors_js_1.colors.reset);
+    });
+    // Subtitle if provided
+    if (subtitle) {
+        (0, terminal_js_1.writeLine)('');
+        const padding = Math.floor((termWidth - subtitle.length) / 2);
+        (0, terminal_js_1.writeLine)(' '.repeat(padding) + colors_js_1.colors.brightCyan + subtitle + colors_js_1.colors.reset);
+    }
+    (0, terminal_js_1.writeLine)('');
+    // Bottom border
+    (0, terminal_js_1.writeLine)(colors_js_1.colors.cyan + border + colors_js_1.colors.reset);
+    // Footer info (version and URL)
+    if (version || url) {
+        const footerParts = [];
+        if (version)
+            footerParts.push(`Version: ${version}`);
+        if (url)
+            footerParts.push(url);
+        const footer = footerParts.join('  |  ');
+        const footerPadding = Math.floor((termWidth - footer.length) / 2);
+        (0, terminal_js_1.writeLine)('');
+        (0, terminal_js_1.writeLine)(' '.repeat(footerPadding) + colors_js_1.colors.dim + footer + colors_js_1.colors.reset);
+    }
+    (0, terminal_js_1.writeLine)('');
+}
+/**
+ * Create a simple header
+ * @param text - Header text
+ * @param color - Optional color
+ */
+function createSimpleHeader(text, color) {
+    renderSimpleHeader({ text, color });
+}
+/**
+ * Create an ASCII header
+ * @param asciiArt - ASCII art string
+ * @param options - Optional configuration
+ */
+function createAsciiHeader(asciiArt, options) {
+    renderAsciiHeader({
+        asciiArt,
+        ...options
+    });
+}

package/dist/components/display/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Display components index
+ * Exports all display component functions
+ */
+export { renderSimpleHeader, renderAsciiHeader, createSimpleHeader, createAsciiHeader } from './headers.js';
+export { renderProgressIndicator, renderStageHeader, renderStageSeparator, createProgressIndicator, createStageHeader, createStageSeparator } from './progress.js';
+export { renderMessage, showSuccess, showError, showWarning, showInfo, showQuestion, createMessage } from './messages.js';
+export { renderSummaryTable, createSummaryTable, createSimpleSummary } from './summary.js';

package/dist/components/display/index.js

@@ -0,0 +1,31 @@
+"use strict";
+/**
+ * Display components index
+ * Exports all display component functions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSimpleSummary = exports.createSummaryTable = exports.renderSummaryTable = exports.createMessage = exports.showQuestion = exports.showInfo = exports.showWarning = exports.showError = exports.showSuccess = exports.renderMessage = exports.createStageSeparator = exports.createStageHeader = exports.createProgressIndicator = exports.renderStageSeparator = exports.renderStageHeader = exports.renderProgressIndicator = exports.createAsciiHeader = exports.createSimpleHeader = exports.renderAsciiHeader = exports.renderSimpleHeader = void 0;
+var headers_js_1 = require("./headers.js");
+Object.defineProperty(exports, "renderSimpleHeader", { enumerable: true, get: function () { return headers_js_1.renderSimpleHeader; } });
+Object.defineProperty(exports, "renderAsciiHeader", { enumerable: true, get: function () { return headers_js_1.renderAsciiHeader; } });
+Object.defineProperty(exports, "createSimpleHeader", { enumerable: true, get: function () { return headers_js_1.createSimpleHeader; } });
+Object.defineProperty(exports, "createAsciiHeader", { enumerable: true, get: function () { return headers_js_1.createAsciiHeader; } });
+var progress_js_1 = require("./progress.js");
+Object.defineProperty(exports, "renderProgressIndicator", { enumerable: true, get: function () { return progress_js_1.renderProgressIndicator; } });
+Object.defineProperty(exports, "renderStageHeader", { enumerable: true, get: function () { return progress_js_1.renderStageHeader; } });
+Object.defineProperty(exports, "renderStageSeparator", { enumerable: true, get: function () { return progress_js_1.renderStageSeparator; } });
+Object.defineProperty(exports, "createProgressIndicator", { enumerable: true, get: function () { return progress_js_1.createProgressIndicator; } });
+Object.defineProperty(exports, "createStageHeader", { enumerable: true, get: function () { return progress_js_1.createStageHeader; } });
+Object.defineProperty(exports, "createStageSeparator", { enumerable: true, get: function () { return progress_js_1.createStageSeparator; } });
+var messages_js_1 = require("./messages.js");
+Object.defineProperty(exports, "renderMessage", { enumerable: true, get: function () { return messages_js_1.renderMessage; } });
+Object.defineProperty(exports, "showSuccess", { enumerable: true, get: function () { return messages_js_1.showSuccess; } });
+Object.defineProperty(exports, "showError", { enumerable: true, get: function () { return messages_js_1.showError; } });
+Object.defineProperty(exports, "showWarning", { enumerable: true, get: function () { return messages_js_1.showWarning; } });
+Object.defineProperty(exports, "showInfo", { enumerable: true, get: function () { return messages_js_1.showInfo; } });
+Object.defineProperty(exports, "showQuestion", { enumerable: true, get: function () { return messages_js_1.showQuestion; } });
+Object.defineProperty(exports, "createMessage", { enumerable: true, get: function () { return messages_js_1.createMessage; } });
+var summary_js_1 = require("./summary.js");
+Object.defineProperty(exports, "renderSummaryTable", { enumerable: true, get: function () { return summary_js_1.renderSummaryTable; } });
+Object.defineProperty(exports, "createSummaryTable", { enumerable: true, get: function () { return summary_js_1.createSummaryTable; } });
+Object.defineProperty(exports, "createSimpleSummary", { enumerable: true, get: function () { return summary_js_1.createSimpleSummary; } });

package/dist/components/display/messages.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Messages - Message display components
+ * Displays success, error, warning, info, and question messages
+ */
+import { MessageConfig, MessageType } from '../../types/display.types.js';
+/**
+ * Render a message with icon
+ * @param config - Message configuration
+ */
+export declare function renderMessage(config: MessageConfig): void;
+/**
+ * Display a success message
+ * @param message - Message text
+ */
+export declare function showSuccess(message: string): void;
+/**
+ * Display an error message
+ * @param message - Message text
+ */
+export declare function showError(message: string): void;
+/**
+ * Display a warning message
+ * @param message - Message text
+ */
+export declare function showWarning(message: string): void;
+/**
+ * Display an info message
+ * @param message - Message text
+ */
+export declare function showInfo(message: string): void;
+/**
+ * Display a question message
+ * @param message - Message text
+ */
+export declare function showQuestion(message: string): void;
+/**
+ * Create a message
+ * @param type - Message type
+ * @param message - Message text
+ */
+export declare function createMessage(type: MessageType, message: string): void;

package/dist/components/display/messages.js

@@ -0,0 +1,90 @@
+"use strict";
+/**
+ * Messages - Message display components
+ * Displays success, error, warning, info, and question messages
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderMessage = renderMessage;
+exports.showSuccess = showSuccess;
+exports.showError = showError;
+exports.showWarning = showWarning;
+exports.showInfo = showInfo;
+exports.showQuestion = showQuestion;
+exports.createMessage = createMessage;
+const terminal_js_1 = require("../../core/terminal.js");
+const colors_js_1 = require("../../core/colors.js");
+/**
+ * Render a message with icon
+ * @param config - Message configuration
+ */
+function renderMessage(config) {
+    const { type, message } = config;
+    let icon = '';
+    let color = colors_js_1.colors.reset;
+    switch (type) {
+        case 'success':
+            icon = '✓';
+            color = colors_js_1.colors.green;
+            break;
+        case 'error':
+            icon = '✗';
+            color = colors_js_1.colors.red;
+            break;
+        case 'warning':
+            icon = '⚠';
+            color = colors_js_1.colors.yellow;
+            break;
+        case 'info':
+            icon = 'ℹ';
+            color = colors_js_1.colors.blue;
+            break;
+        case 'question':
+            icon = '?';
+            color = colors_js_1.colors.yellow;
+            break;
+    }
+    (0, terminal_js_1.writeLine)(`${color}${icon}${colors_js_1.colors.reset} ${message}`);
+}
+/**
+ * Display a success message
+ * @param message - Message text
+ */
+function showSuccess(message) {
+    renderMessage({ type: 'success', message });
+}
+/**
+ * Display an error message
+ * @param message - Message text
+ */
+function showError(message) {
+    renderMessage({ type: 'error', message });
+}
+/**
+ * Display a warning message
+ * @param message - Message text
+ */
+function showWarning(message) {
+    renderMessage({ type: 'warning', message });
+}
+/**
+ * Display an info message
+ * @param message - Message text
+ */
+function showInfo(message) {
+    renderMessage({ type: 'info', message });
+}
+/**
+ * Display a question message
+ * @param message - Message text
+ */
+function showQuestion(message) {
+    renderMessage({ type: 'question', message });
+}
+/**
+ * Create a message
+ * @param type - Message type
+ * @param message - Message text
+ */
+function createMessage(type, message) {
+    renderMessage({ type, message });
+}

package/dist/components/display/progress.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Progress - Progress indicator components
+ * Displays step flow and stage information
+ */
+import { ProgressConfig } from '../../types/display.types.js';
+/**
+ * Render a progress indicator showing steps
+ * @param config - Progress configuration
+ */
+export declare function renderProgressIndicator(config: ProgressConfig): void;
+/**
+ * Render a stage header with step number
+ * @param stageName - Name of the stage
+ * @param stepNumber - Step number (1-based)
+ */
+export declare function renderStageHeader(stageName: string, stepNumber: number): void;
+/**
+ * Render a stage separator
+ * @param char - Character to use for separator
+ * @param width - Width of separator (default: terminal width)
+ */
+export declare function renderStageSeparator(char?: string, width?: number): void;
+/**
+ * Create a progress indicator
+ * @param steps - Array of step names
+ * @param currentStep - Index of current step (0-based)
+ * @param separator - Optional separator character
+ */
+export declare function createProgressIndicator(steps: string[], currentStep: number, separator?: string): void;
+/**
+ * Create a stage header
+ * @param stageName - Name of the stage
+ * @param stepNumber - Step number (1-based)
+ */
+export declare function createStageHeader(stageName: string, stepNumber: number): void;
+/**
+ * Create a stage separator
+ * @param char - Optional separator character
+ * @param width - Optional width
+ */
+export declare function createStageSeparator(char?: string, width?: number): void;