@inquirer/testing 2.1.9 → 2.1.11

package/README.md

@@ -31,6 +31,7 @@ describe('input prompt', () => {
 
     events.type('ohn');
     events.keypress('enter');
+    // or events.keypress({ name: 'enter' })
 
     await expect(answer).resolves.toEqual('John');
     expect(getScreen()).toMatchInlineSnapshot(`"? What is your name John"`);
@@ -51,7 +52,7 @@ The core utility of `@inquirer/testing` is the `render()` function. This `render
 
 1. `answer` (`Promise`) This is the promise that'll be resolved once an answer is provided and valid.
 2. `getScreen` (`({ raw: boolean }) => string`) This function returns the state of what is printed on the command line screen at any given time. You can use its return value to validate your prompt is properly rendered. By default this function will strip the ANSI codes (used for colors.)
-3. `events` (`{ keypress: (name) => void, type: (string) => void }`) Is the utilities allowing you to interact with the prompt. Use it to trigger keypress events, or typing any input.
+3. `events` (`{ keypress: (name | Key) => void, type: (string) => void }`) Is the utilities allowing you to interact with the prompt. Use it to trigger keypress events, or typing any input.
 4. `getFullOutput` (`() => string`) Return a raw dump of everything that got sent on the output stream.
 
 You can refer to [the `@inquirer/input` prompt test suite](https://github.com/SBoudrias/Inquirer.js/blob/master/packages/input/input.test.mts) as a practical example.

package/dist/cjs/index.js

@@ -73,8 +73,13 @@ function render(prompt, props, options) {
         yield Promise.resolve();
         yield Promise.resolve();
         const events = {
-            keypress(name) {
-                input.emit('keypress', null, { name });
+            keypress(key) {
+                if (typeof key === 'string') {
+                    input.emit('keypress', null, { name: key });
+                }
+                else {
+                    input.emit('keypress', null, key);
+                }
             },
             type(text) {
                 input.write(text);

package/dist/cjs/types/index.d.ts

@@ -4,7 +4,12 @@ export declare function render<TestedPrompt extends Prompt<any, any>>(prompt: Te
     answer: import("@inquirer/type").CancelablePromise<any>;
     input: MuteStream;
     events: {
-        keypress(name: string): void;
+        keypress(key: string | {
+            name?: string | undefined;
+            ctrl?: boolean | undefined;
+            meta?: boolean | undefined;
+            shift?: boolean | undefined;
+        }): void;
         type(text: string): void;
     };
     getScreen({ raw }?: {

package/dist/esm/index.mjs

@@ -41,8 +41,13 @@ export async function render(prompt, props, options) {
     await Promise.resolve();
     await Promise.resolve();
     const events = {
-        keypress(name) {
-            input.emit('keypress', null, { name });
+        keypress(key) {
+            if (typeof key === 'string') {
+                input.emit('keypress', null, { name: key });
+            }
+            else {
+                input.emit('keypress', null, key);
+            }
         },
         type(text) {
             input.write(text);

package/dist/esm/types/index.d.mts

@@ -4,7 +4,12 @@ export declare function render<TestedPrompt extends Prompt<any, any>>(prompt: Te
     answer: import("@inquirer/type").CancelablePromise<any>;
     input: MuteStream;
     events: {
-        keypress(name: string): void;
+        keypress(key: string | {
+            name?: string | undefined;
+            ctrl?: boolean | undefined;
+            meta?: boolean | undefined;
+            shift?: boolean | undefined;
+        }): void;
         type(text: string): void;
     };
     getScreen({ raw }?: {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@inquirer/testing",
-  "version": "2.1.9",
+  "version": "2.1.11",
   "engines": {
-    "node": ">=14.18.0"
+    "node": ">=18"
   },
   "description": "Inquirer testing utilities",
   "main": "./dist/cjs/index.js",
@@ -60,9 +60,9 @@
   "license": "MIT",
   "homepage": "https://github.com/SBoudrias/Inquirer.js/blob/master/packages/testing/README.md",
   "dependencies": {
-    "@inquirer/type": "^1.1.5",
+    "@inquirer/type": "^1.2.0",
     "@types/mute-stream": "^0.0.4",
-    "@types/node": "^20.9.0",
+    "@types/node": "^20.11.16",
     "ansi-escapes": "^4.3.2",
     "mute-stream": "^1.0.0",
     "strip-ansi": "^6.0.1"
@@ -84,5 +84,5 @@
       }
     }
   },
-  "gitHead": "a318aec57d33b53131c0b03cc8dd6ab4efae3e50"
+  "gitHead": "44016a40bc9e93455dfdb9fa6c25c27c1c109bd3"
 }