grimoire-wizard 0.5.2 → 0.6.0

package/dist/index.d.ts

@@ -64,6 +64,12 @@ interface SeparatorOption {
     separator: string;
 }
 type SelectChoice = SelectOption | SeparatorOption;
+type ReviewFormat = 'none' | 'uppercase' | 'lowercase' | 'capitalize';
+interface StepReviewConfig {
+    hide?: boolean;
+    label?: string;
+    format?: ReviewFormat;
+}
 interface BaseStepConfig {
     id: string;
     type: string;
@@ -74,6 +80,7 @@ interface BaseStepConfig {
     keepValuesOnPrevious?: boolean;
     required?: boolean;
     group?: string;
+    review?: StepReviewConfig;
 }
 interface TextStepConfig extends BaseStepConfig {
     type: 'text';
@@ -89,6 +96,7 @@ interface SelectStepConfig extends BaseStepConfig {
     routes?: Record<string, string>;
     pageSize?: number;
     loop?: boolean;
+    columns?: number;
 }
 interface MultiSelectStepConfig extends BaseStepConfig {
     type: 'multiselect';
@@ -99,6 +107,7 @@ interface MultiSelectStepConfig extends BaseStepConfig {
     max?: number;
     pageSize?: number;
     loop?: boolean;
+    columns?: number;
 }
 interface ConfirmStepConfig extends BaseStepConfig {
     type: 'confirm';
@@ -122,6 +131,7 @@ interface SearchStepConfig extends BaseStepConfig {
     default?: string;
     placeholder?: string;
     pageSize?: number;
+    columns?: number;
     loop?: boolean;
 }
 interface EditorStepConfig extends BaseStepConfig {
@@ -146,8 +156,22 @@ interface MessageStepConfig extends BaseStepConfig {
 }
 interface NoteStepConfig extends BaseStepConfig {
     type: 'note';
+    style?: NoteStyle;
+}
+interface BrowserStepConfig extends BaseStepConfig {
+    type: 'browser';
+    url: string;
+    fallback?: string;
 }
-type StepConfig = TextStepConfig | SelectStepConfig | MultiSelectStepConfig | ConfirmStepConfig | PasswordStepConfig | NumberStepConfig | SearchStepConfig | EditorStepConfig | PathStepConfig | ToggleStepConfig | MessageStepConfig | NoteStepConfig;
+type StepConfig = TextStepConfig | SelectStepConfig | MultiSelectStepConfig | ConfirmStepConfig | PasswordStepConfig | NumberStepConfig | SearchStepConfig | EditorStepConfig | PathStepConfig | ToggleStepConfig | MessageStepConfig | NoteStepConfig | BrowserStepConfig;
+type ProgressBarStyle = 'blocks' | 'line' | 'dots' | 'arrow';
+interface ProgressBarConfig {
+    width?: number;
+    filledColor?: string;
+    emptyColor?: string;
+    style?: ProgressBarStyle;
+}
+type NoteStyle = 'info' | 'warning' | 'error' | 'success' | 'code' | 'banner';
 interface ThemeConfig {
     preset?: string;
     tokens?: {
@@ -158,6 +182,11 @@ interface ThemeConfig {
         info?: string;
         muted?: string;
         accent?: string;
+        highlight?: string;
+        highlightBg?: string;
+        pointer?: string;
+        checked?: string;
+        dimmed?: string;
     };
     icons?: {
         step?: string;
@@ -169,11 +198,14 @@ interface ThemeConfig {
         frames: string[];
         interval?: number;
     };
+    spinnerElapsed?: boolean;
+    progressBar?: ProgressBarConfig;
 }
 interface PreFlightCheck {
     name: string;
     run: string;
     message: string;
+    showOutput?: boolean;
 }
 interface ActionConfig {
     name?: string;
@@ -184,6 +216,7 @@ type OnCompleteHandler = (context: {
     answers: Record<string, unknown>;
     config: WizardConfig;
 }) => Promise<void> | void;
+type ChecksStyle = 'spinner' | 'tasklist';
 interface WizardConfig {
     meta: {
         name: string;
@@ -191,6 +224,12 @@ interface WizardConfig {
         description?: string;
         review?: boolean;
         icon?: string;
+        iconSize?: 'small' | 'medium' | 'large' | number;
+        font?: string;
+        banner?: string | ((theme: ResolvedTheme) => string);
+        subtitle?: string;
+        clearBetweenSteps?: boolean;
+        checksStyle?: ChecksStyle;
     };
     theme?: ThemeConfig;
     steps: StepConfig[];
@@ -202,6 +241,8 @@ interface WizardConfig {
     checks?: PreFlightCheck[];
     actions?: ActionConfig[];
     onComplete?: string;
+    /** Internal — set by loadWizardConfig to enable relative path resolution */
+    _configFilePath?: string;
 }
 interface WizardState {
     currentStepId: string;
@@ -264,6 +305,7 @@ type WizardEvent = {
 } | {
     type: 'checks:start';
     checks: PreFlightCheck[];
+    mode?: 'spinner' | 'tasklist';
 } | {
     type: 'check:pass';
     name: string;
@@ -287,6 +329,16 @@ type WizardEvent = {
     type: 'oncomplete:fail';
     error: string;
 };
+interface ResolvedProgressBar {
+    width: number;
+    filledColor: (text: string) => string;
+    emptyColor: (text: string) => string;
+    style: ProgressBarStyle;
+    chars: {
+        filled: string;
+        empty: string;
+    };
+}
 interface ResolvedTheme {
     primary: (text: string) => string;
     success: (text: string) => string;
@@ -295,12 +347,51 @@ interface ResolvedTheme {
     info: (text: string) => string;
     muted: (text: string) => string;
     accent: (text: string) => string;
+    highlight: (text: string) => string;
+    highlightBg: (text: string) => string;
+    pointer: (text: string) => string;
+    checked: (text: string) => string;
+    dimmed: (text: string) => string;
     bold: (text: string) => string;
     icons: Required<NonNullable<ThemeConfig['icons']>>;
     spinner: {
         frames: string[];
         interval: number;
     };
+    spinnerElapsed: boolean;
+    progressBar: ResolvedProgressBar;
+}
+type PromptConfig = {
+    type: 'select';
+    message: string;
+    options: SelectChoice[];
+    default?: string;
+} | {
+    type: 'text' | 'password';
+    message: string;
+    default?: string;
+} | {
+    type: 'confirm';
+    message: string;
+    default?: boolean;
+} | {
+    type: 'number';
+    message: string;
+    default?: number;
+};
+interface HookContext {
+    readonly answers: Readonly<Record<string, unknown>>;
+    readonly state: Readonly<WizardState>;
+    showNote: (title: string, body: string) => void;
+    setNextStep: (stepId: string) => void;
+}
+interface HookContext {
+    readonly answers: Readonly<Record<string, unknown>>;
+    readonly state: Readonly<WizardState>;
+    showNote: (title: string, body: string) => void;
+    setNextStep: (stepId: string) => void;
+    openBrowser: (url: string) => Promise<void>;
+    prompt: (config: PromptConfig) => Promise<unknown>;
 }
 interface WizardRenderer {
     renderText(step: TextStepConfig, state: WizardState, theme: ResolvedTheme): Promise<string>;
@@ -430,10 +521,10 @@ interface RunWizardOptions {
     plain?: boolean;
     mockAnswers?: Record<string, unknown>;
     templateAnswers?: Record<string, unknown>;
-    onBeforeStep?: (stepId: string, step: StepConfig, state: WizardState) => Promise<void> | void;
-    onAfterStep?: (stepId: string, value: unknown, state: WizardState) => Promise<void> | void;
+    onBeforeStep?: (stepId: string, step: StepConfig, context: HookContext) => Promise<void> | void;
+    onAfterStep?: (stepId: string, value: unknown, context: HookContext) => Promise<void> | void;
     onStepComplete?: (stepId: string, value: unknown, state: WizardState) => void;
-    onCancel?: (state: WizardState) => void;
+    onCancel?: (state: WizardState) => Promise<void> | void;
     plugins?: GrimoirePlugin[];
     asyncValidate?: (stepId: string, value: unknown, answers: Record<string, unknown>) => Promise<string | null>;
     cache?: boolean | {
@@ -444,13 +535,14 @@ interface RunWizardOptions {
     configFilePath?: string;
     optionsProvider?: (stepId: string, answers: Record<string, unknown>) => Promise<SelectOption[] | undefined>;
 }
-declare function runPreFlightChecks(checks: PreFlightCheck[], theme: ResolvedTheme, renderer?: WizardRenderer): void;
+declare function runPreFlightChecks(checks: PreFlightCheck[], theme: ResolvedTheme, renderer?: WizardRenderer, checksStyle?: 'spinner' | 'tasklist'): void;
 declare function runWizard(config: WizardConfig, options?: RunWizardOptions): Promise<Record<string, unknown>>;
 
 declare function defineWizard(config: WizardConfig): WizardConfig;
 
 declare class InquirerRenderer implements WizardRenderer {
     renderStepHeader(stepIndex: number, totalVisible: number, message: string, theme: ResolvedTheme, description?: string): void;
+    renderNote(step: NoteStepConfig, theme: ResolvedTheme): void;
     renderText(step: TextStepConfig, state: WizardState, theme: ResolvedTheme): Promise<string>;
     renderSelect(step: SelectStepConfig, state: WizardState, theme: ResolvedTheme): Promise<string>;
     renderMultiSelect(step: MultiSelectStepConfig, state: WizardState, theme: ResolvedTheme): Promise<string[]>;
@@ -466,6 +558,12 @@ declare class InquirerRenderer implements WizardRenderer {
     renderSummary(answers: Record<string, unknown>, steps: StepConfig[], theme: ResolvedTheme): void;
     clear(): void;
 }
+declare function applyColumns<T extends {
+    name: string;
+    value: string;
+    description?: string;
+    disabled?: boolean | string;
+}>(items: T[], columns: number): T[];
 
 /**
  * Resolve {{stepId}} placeholders in a template string.
@@ -479,14 +577,15 @@ declare function resolveTemplate(template: string, answers: Record<string, unkno
  */
 declare function resolveTemplateStrict(template: string, answers: Record<string, unknown>): string;
 
-/**
- * Render a figlet ASCII art banner for the wizard name.
- * Falls back to plain bold text if figlet rendering fails.
- */
-declare function renderBanner(name: string, theme: ResolvedTheme, options?: {
+interface BannerOptions {
     plain?: boolean;
     icon?: string;
-}): string;
+    iconSize?: 'small' | 'medium' | 'large' | number;
+    font?: string;
+    banner?: string | ((theme: ResolvedTheme) => string);
+    subtitle?: string;
+}
+declare function renderBanner(name: string, theme: ResolvedTheme, options?: BannerOptions): string;
 
 declare function slugify(name: string): string;
 declare function getCacheDir(customDir?: string): string;
@@ -519,6 +618,8 @@ declare class InkRenderer implements WizardRenderer {
 declare class ClackRenderer extends InquirerRenderer {
     private spinnerInterval;
     private spinnerFrameIndex;
+    private spinnerStartTime;
+    private checksMode;
     renderStepHeader(): void;
     renderGroupHeader(): void;
     renderSummary(answers: Record<string, unknown>, steps: StepConfig[], theme: ResolvedTheme): void;
@@ -559,4 +660,4 @@ interface PipelineStep {
 }
 declare function runPipeline(steps: PipelineStep[], globalOptions?: Omit<RunWizardOptions, 'mockAnswers' | 'templateAnswers'>): Promise<Record<string, Record<string, unknown>>>;
 
-export { type ActionConfig, ClackRenderer, type Condition, type ConfirmStepConfig, DEFAULT_SPINNER, type EditorStepConfig, type GrimoirePlugin, InkRenderer, InquirerRenderer, type MessageStepConfig, type MultiSelectStepConfig, type NoteStepConfig, type NumberStepConfig, type OnCompleteHandler, type PasswordStepConfig, type PathStepConfig, type PipelineStep, type PreFlightCheck, type ResolvedTheme, type RunWizardOptions, type SavedProgress, type SearchStepConfig, type SelectChoice, type SelectOption, type SelectStepConfig, type SeparatorOption, type SpinnerConfig, type SpinnerName, type StepConfig, type StepPlugin, type TextStepConfig, type ThemeConfig, type ToggleStepConfig, type ValidationRule, type WizardConfig, type WizardEvent, type WizardRenderer, type WizardState, type WizardTransition, clearCache, clearMruData, clearPlugins, clearProgress, createWizardState, defineWizard, deleteTemplate, evaluateCondition, getCacheDir, getOrderedOptions, getPluginStep, getVisibleSteps, isStepVisible, listTemplates, loadCachedAnswers, loadProgress, loadTemplate, loadWizardConfig, parseWizardConfig, parseWizardYAML, recordSelection, registerPlugin, renderBanner, resolveEnvDefault, resolveNextStep, resolveSpinner, resolveTemplate, resolveTemplateStrict, resolveTheme, runPipeline, runPreFlightChecks, runWizard, saveCachedAnswers, saveProgress, saveTemplate, slugify, spinners, validateStepAnswer, wizardReducer };
+export { type ActionConfig, type BrowserStepConfig, type ChecksStyle, ClackRenderer, type Condition, type ConfirmStepConfig, DEFAULT_SPINNER, type EditorStepConfig, type GrimoirePlugin, type HookContext, InkRenderer, InquirerRenderer, type MessageStepConfig, type MultiSelectStepConfig, type NoteStepConfig, type NoteStyle, type NumberStepConfig, type OnCompleteHandler, type PasswordStepConfig, type PathStepConfig, type PipelineStep, type PreFlightCheck, type ProgressBarConfig, type ProgressBarStyle, type PromptConfig, type ResolvedProgressBar, type ResolvedTheme, type ReviewFormat, type RunWizardOptions, type SavedProgress, type SearchStepConfig, type SelectChoice, type SelectOption, type SelectStepConfig, type SeparatorOption, type SpinnerConfig, type SpinnerName, type StepConfig, type StepPlugin, type StepReviewConfig, type TextStepConfig, type ThemeConfig, type ToggleStepConfig, type ValidationRule, type WizardConfig, type WizardEvent, type WizardRenderer, type WizardState, type WizardTransition, applyColumns, clearCache, clearMruData, clearPlugins, clearProgress, createWizardState, defineWizard, deleteTemplate, evaluateCondition, getCacheDir, getOrderedOptions, getPluginStep, getVisibleSteps, isStepVisible, listTemplates, loadCachedAnswers, loadProgress, loadTemplate, loadWizardConfig, parseWizardConfig, parseWizardYAML, recordSelection, registerPlugin, renderBanner, resolveEnvDefault, resolveNextStep, resolveSpinner, resolveTemplate, resolveTemplateStrict, resolveTheme, runPipeline, runPreFlightChecks, runWizard, saveCachedAnswers, saveProgress, saveTemplate, slugify, spinners, validateStepAnswer, wizardReducer };