@inquirer/testing 3.1.1 → 3.3.0

package/README.md

@@ -73,11 +73,42 @@ describe('input prompt', () => {
 
 - `answer` (`Promise`) - Resolves when an answer is provided and valid
 - `getScreen` (`({ raw?: boolean }) => string`) - Returns the current screen content. By default strips ANSI codes
+- `nextRender` (`() => Promise<void>`) - Wait for the next screen update. Use after triggering async actions (e.g. pressing enter with validation). Coalesces rapid back-to-back renders so a single `await nextRender()` captures the final settled state
 - `events` - Utilities to interact with the prompt:
   - `keypress(key: string | KeyObject)` - Trigger a keypress event
   - `type(text: string)` - Type text into the prompt
 - `getFullOutput` (`() => Promise<string>`) - Returns the full output interpreted through a virtual terminal, resolving ANSI escape sequences into the actual screen state
 
+### Async actions and `nextRender()`
+
+When a keypress triggers an asynchronous action (such as input validation), the screen won't update synchronously. Use `nextRender()` to wait for the prompt to settle before reading the screen:
+
+```ts
+import { render } from '@inquirer/testing';
+import input from '@inquirer/input';
+
+it('shows a validation error', async () => {
+  const { answer, events, getScreen, nextRender } = await render(input, {
+    message: 'Enter a number',
+    validate: (value) => /^\d+$/.test(value) || 'Must be a number',
+  });
+
+  events.type('abc');
+  events.keypress('enter');
+
+  await nextRender(); // wait for validation to complete and the error to render
+  expect(getScreen()).toContain('Must be a number');
+
+  events.keypress('backspace');
+  events.keypress('backspace');
+  events.keypress('backspace');
+  events.type('42');
+  events.keypress('enter');
+
+  await expect(answer).resolves.toEqual('42');
+});
+```
+
 ### Unit Testing Example
 
 You can refer to the [`@inquirer/input` test suite](https://github.com/SBoudrias/Inquirer.js/blob/main/packages/input/input.test.ts) for a comprehensive unit testing example using `render()`.

package/dist/index.d.ts

@@ -19,5 +19,6 @@ export declare function render<Value, const Config>(prompt: Prompt<Value, Config
     getFullOutput: ({ raw }?: {
         raw?: boolean;
     }) => Promise<string>;
+    nextRender: () => Promise<void>;
 }>;
 export {};

package/dist/index.js

@@ -30,6 +30,20 @@ export async function render(prompt, config, options) {
             }
         },
     };
+    let rendersConsumed = output.writeCount;
+    function nextRender() {
+        const waitForRender = output.writeCount > rendersConsumed
+            ? Promise.resolve()
+            : new Promise((resolve) => output.once('render', resolve));
+        // After detecting a render, let the event loop settle so that multiple
+        // synchronous-ish renders (e.g. validation: loading → error) are coalesced.
+        return waitForRender.then(() => new Promise((resolve) => {
+            setImmediate(() => {
+                rendersConsumed = output.writeCount;
+                resolve();
+            });
+        }));
+    }
     return {
         answer,
         input,
@@ -44,5 +58,6 @@ export async function render(prompt, config, options) {
                 return fullOutput;
             return interpretTerminalOutput(fullOutput);
         },
+        nextRender,
     };
 }

package/dist/jest.d.ts

@@ -15,5 +15,7 @@ export { screenInstance as screen };
  * });
  * ```
  */
-export declare function wrapPrompt<Value, Config>(prompt: Prompt<Value, Config>): Prompt<Value, Config>;
+export declare function wrapPrompt<Value, Config>(prompt: Prompt<Value, Config> | {
+    default: Prompt<Value, Config>;
+}): Prompt<Value, Config>;
 export { Screen, type KeypressEvent } from './screen.js';

package/dist/jest.js

@@ -22,9 +22,13 @@ beforeEach(() => {
  * ```
  */
 export function wrapPrompt(prompt) {
+    // Unwrap SWC-style module namespace objects where barrel re-exports like
+    // `export { default as input } from '@inquirer/input'` get transformed into
+    // `{ default: fn }` instead of the function directly.
+    const fn = typeof prompt === 'function' ? prompt : prompt.default;
     return (config, context) => {
         const output = screenInstance.createOutput();
-        const promise = prompt(config, {
+        const promise = fn(config, {
             ...context,
             input: screenInstance.input,
             output,
@@ -33,87 +37,160 @@ export function wrapPrompt(prompt) {
         return promise;
     };
 }
-// Mock individual prompt packages (covers `import input from '@inquirer/input'` style)
+// Prompt names used by the @inquirer/prompts barrel mock to wrap only prompt exports.
+const promptNames = [
+    'input',
+    'select',
+    'confirm',
+    'checkbox',
+    'password',
+    'expand',
+    'rawlist',
+    'number',
+    'search',
+    'editor',
+];
+// Mock individual prompt packages (covers `import input from '@inquirer/input'` style).
+// All prompt packages are optional peer dependencies, so factories silently skip
+// packages that aren't installed in the consumer's project.
 jest.mock('@inquirer/input', () => {
-    const actual = jest.requireActual('@inquirer/input');
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = jest.requireActual('@inquirer/input');
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 jest.mock('@inquirer/select', () => {
-    const actual = jest.requireActual('@inquirer/select');
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = jest.requireActual('@inquirer/select');
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 jest.mock('@inquirer/confirm', () => {
-    const actual = jest.requireActual('@inquirer/confirm');
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = jest.requireActual('@inquirer/confirm');
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 jest.mock('@inquirer/checkbox', () => {
-    const actual = jest.requireActual('@inquirer/checkbox');
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = jest.requireActual('@inquirer/checkbox');
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 jest.mock('@inquirer/password', () => {
-    const actual = jest.requireActual('@inquirer/password');
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = jest.requireActual('@inquirer/password');
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 jest.mock('@inquirer/expand', () => {
-    const actual = jest.requireActual('@inquirer/expand');
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = jest.requireActual('@inquirer/expand');
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 jest.mock('@inquirer/rawlist', () => {
-    const actual = jest.requireActual('@inquirer/rawlist');
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = jest.requireActual('@inquirer/rawlist');
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 jest.mock('@inquirer/number', () => {
-    const actual = jest.requireActual('@inquirer/number');
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = jest.requireActual('@inquirer/number');
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 jest.mock('@inquirer/search', () => {
-    const actual = jest.requireActual('@inquirer/search');
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = jest.requireActual('@inquirer/search');
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 jest.mock('@inquirer/editor', () => {
-    const actual = jest.requireActual('@inquirer/editor');
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = jest.requireActual('@inquirer/editor');
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 // Mock @inquirer/prompts barrel re-exports (covers `import { input } from '@inquirer/prompts'` style).
 // Jest's module mock for individual packages doesn't propagate through barrel re-exports.
+// Only prompt functions are wrapped; other exports (like Separator) are passed through.
 jest.mock('@inquirer/prompts', () => {
-    const actual = jest.requireActual('@inquirer/prompts');
-    return {
-        ...actual,
-        input: wrapPrompt(actual.input),
-        select: wrapPrompt(actual.select),
-        confirm: wrapPrompt(actual.confirm),
-        checkbox: wrapPrompt(actual.checkbox),
-        password: wrapPrompt(actual.password),
-        expand: wrapPrompt(actual.expand),
-        rawlist: wrapPrompt(actual.rawlist),
-        number: wrapPrompt(actual.number),
-        search: wrapPrompt(actual.search),
-        editor: wrapPrompt(actual.editor),
-    };
+    try {
+        const actual = jest.requireActual('@inquirer/prompts');
+        const wrapped = { ...actual };
+        for (const name of promptNames) {
+            if (name in actual) {
+                wrapped[name] = wrapPrompt(actual[name]);
+            }
+        }
+        return wrapped;
+    }
+    catch {
+        return {};
+    }
 });
 // Mock the external editor to capture typed input instead of spawning a real editor.
 // Buffers all screen.type() calls and submits on screen.keypress('enter'), matching
 // the interaction pattern of other prompts (type → enter).
-jest.mock('@inquirer/external-editor', () => ({
-    editAsync: (_text, callback) => {
-        let buffer = '';
-        const typeSpy = jest
-            .spyOn(screenInstance, 'type')
-            .mockImplementation((text) => {
-            buffer += text;
-        });
-        const keypressSpy = jest
-            .spyOn(screenInstance, 'keypress')
-            .mockImplementation((key) => {
-            const name = typeof key === 'string' ? key : key.name;
-            if (name === 'enter' || name === 'return') {
-                typeSpy.mockRestore();
-                keypressSpy.mockRestore();
-                process.nextTick(() => callback(undefined, buffer));
-            }
-        });
-    },
-}));
+jest.mock('@inquirer/external-editor', () => {
+    try {
+        jest.requireActual('@inquirer/external-editor');
+    }
+    catch {
+        return {};
+    }
+    return {
+        editAsync: (_text, callback) => {
+            let buffer = '';
+            const typeSpy = jest
+                .spyOn(screenInstance, 'type')
+                .mockImplementation((text) => {
+                buffer += text;
+            });
+            const keypressSpy = jest
+                .spyOn(screenInstance, 'keypress')
+                .mockImplementation((key) => {
+                const name = typeof key === 'string' ? key : key.name;
+                if (name === 'enter' || name === 'return') {
+                    typeSpy.mockRestore();
+                    keypressSpy.mockRestore();
+                    process.nextTick(() => callback(undefined, buffer));
+                }
+            });
+        },
+    };
+});
 // Re-export Screen class and KeypressEvent type for advanced use cases
 export { Screen } from './screen.js';

package/dist/vitest.d.ts

@@ -16,5 +16,7 @@ export { screenInstance as screen };
  * });
  * ```
  */
-export declare function wrapPrompt<Value, Config>(prompt: Prompt<Value, Config>): Prompt<Value, Config>;
+export declare function wrapPrompt<Value, Config>(prompt: Prompt<Value, Config> | {
+    default: Prompt<Value, Config>;
+}): Prompt<Value, Config>;
 export { Screen, type KeypressEvent } from './screen.js';

package/dist/vitest.js

@@ -22,9 +22,13 @@ beforeEach(() => {
  * ```
  */
 export function wrapPrompt(prompt) {
+    // Unwrap SWC-style module namespace objects where barrel re-exports like
+    // `export { default as input } from '@inquirer/input'` get transformed into
+    // `{ default: fn }` instead of the function directly.
+    const fn = typeof prompt === 'function' ? prompt : prompt.default;
     return (config, context) => {
         const output = screenInstance.createOutput();
-        const promise = prompt(config, {
+        const promise = fn(config, {
             ...context,
             input: screenInstance.input,
             output,
@@ -33,86 +37,161 @@ export function wrapPrompt(prompt) {
         return promise;
     };
 }
-// Mock individual prompt packages (covers `import input from '@inquirer/input'` style)
+// Prompt names used by the @inquirer/prompts barrel mock to wrap only prompt exports.
+const promptNames = [
+    'input',
+    'select',
+    'confirm',
+    'checkbox',
+    'password',
+    'expand',
+    'rawlist',
+    'number',
+    'search',
+    'editor',
+];
+// Mock individual prompt packages (covers `import input from '@inquirer/input'` style).
+// All prompt packages are optional peer dependencies, so factories silently skip
+// packages that aren't installed in the consumer's project.
 vi.mock('@inquirer/input', async (importOriginal) => {
-    const actual = await importOriginal();
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = await importOriginal();
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 vi.mock('@inquirer/select', async (importOriginal) => {
-    const actual = await importOriginal();
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = await importOriginal();
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 vi.mock('@inquirer/confirm', async (importOriginal) => {
-    const actual = await importOriginal();
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = await importOriginal();
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 vi.mock('@inquirer/checkbox', async (importOriginal) => {
-    const actual = await importOriginal();
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = await importOriginal();
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 vi.mock('@inquirer/password', async (importOriginal) => {
-    const actual = await importOriginal();
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = await importOriginal();
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 vi.mock('@inquirer/expand', async (importOriginal) => {
-    const actual = await importOriginal();
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = await importOriginal();
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 vi.mock('@inquirer/rawlist', async (importOriginal) => {
-    const actual = await importOriginal();
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = await importOriginal();
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 vi.mock('@inquirer/number', async (importOriginal) => {
-    const actual = await importOriginal();
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = await importOriginal();
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 vi.mock('@inquirer/search', async (importOriginal) => {
-    const actual = await importOriginal();
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = await importOriginal();
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 vi.mock('@inquirer/editor', async (importOriginal) => {
-    const actual = await importOriginal();
-    return { ...actual, default: wrapPrompt(actual.default) };
+    try {
+        const actual = await importOriginal();
+        return { ...actual, default: wrapPrompt(actual.default) };
+    }
+    catch {
+        return {};
+    }
 });
 // Mock @inquirer/prompts barrel re-exports (covers `import { input } from '@inquirer/prompts'` style).
 // While Vitest's module interception often propagates through ESM re-exports, an explicit mock
 // ensures consistent behavior across all environments and bundler configurations.
+// Only prompt functions are wrapped; other exports (like Separator) are passed through.
 vi.mock('@inquirer/prompts', async (importOriginal) => {
-    const actual = await importOriginal();
-    return {
-        ...actual,
-        input: wrapPrompt(actual.input),
-        select: wrapPrompt(actual.select),
-        confirm: wrapPrompt(actual.confirm),
-        checkbox: wrapPrompt(actual.checkbox),
-        password: wrapPrompt(actual.password),
-        expand: wrapPrompt(actual.expand),
-        rawlist: wrapPrompt(actual.rawlist),
-        number: wrapPrompt(actual.number),
-        search: wrapPrompt(actual.search),
-        editor: wrapPrompt(actual.editor),
-    };
+    try {
+        const actual = await importOriginal();
+        const wrapped = { ...actual };
+        for (const name of promptNames) {
+            if (name in actual) {
+                wrapped[name] = wrapPrompt(actual[name]);
+            }
+        }
+        return wrapped;
+    }
+    catch {
+        return {};
+    }
 });
 // Mock the external editor to capture typed input instead of spawning a real editor.
 // Buffers all screen.type() calls and submits on screen.keypress('enter'), matching
 // the interaction pattern of other prompts (type → enter).
-vi.mock('@inquirer/external-editor', () => ({
-    editAsync: (_text, callback) => {
-        let buffer = '';
-        const typeSpy = vi
-            .spyOn(screenInstance, 'type')
-            .mockImplementation((text) => {
-            buffer += text;
-        });
-        const keypressSpy = vi.spyOn(screenInstance, 'keypress').mockImplementation((key) => {
-            const name = typeof key === 'string' ? key : key.name;
-            if (name === 'enter' || name === 'return') {
-                typeSpy.mockRestore();
-                keypressSpy.mockRestore();
-                process.nextTick(() => callback(undefined, buffer));
-            }
-        });
-    },
-}));
+vi.mock('@inquirer/external-editor', async (importOriginal) => {
+    try {
+        await importOriginal();
+    }
+    catch {
+        return {};
+    }
+    return {
+        editAsync: (_text, callback) => {
+            let buffer = '';
+            const typeSpy = vi
+                .spyOn(screenInstance, 'type')
+                .mockImplementation((text) => {
+                buffer += text;
+            });
+            const keypressSpy = vi
+                .spyOn(screenInstance, 'keypress')
+                .mockImplementation((key) => {
+                const name = typeof key === 'string' ? key : key.name;
+                if (name === 'enter' || name === 'return') {
+                    typeSpy.mockRestore();
+                    keypressSpy.mockRestore();
+                    process.nextTick(() => callback(undefined, buffer));
+                }
+            });
+        },
+    };
+});
 // Re-export Screen class and KeypressEvent type for advanced use cases
 export { Screen } from './screen.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/testing",
-  "version": "3.1.1",
+  "version": "3.3.0",
   "description": "Inquirer testing utilities",
   "keywords": [
     "answer",
@@ -84,15 +84,15 @@
   },
   "dependencies": {
     "@inquirer/type": "^4.0.3",
-    "@xterm/headless": "^5.5.0",
+    "@xterm/headless": "^6.0.0",
     "mute-stream": "^3.0.0"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.0",
+    "@types/jest": "^30.0.0",
     "@types/mute-stream": "^0.0.4",
     "@types/node": "^25.0.2",
     "typescript": "^5.9.3",
-    "vitest": "^3.0.0"
+    "vitest": "^4.0.18"
   },
   "peerDependencies": {
     "@inquirer/checkbox": ">=1.0.0",
@@ -167,5 +167,5 @@
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "gitHead": "48b5d7e8b14d5c9fc4a19a8f1ead20a7593b29e1"
+  "gitHead": "526eca2e64853510821ffd457561840ec0cbfb93"
 }