@inquirer/input 0.0.28-alpha.0 → 1.0.0

package/README.md

@@ -26,7 +26,7 @@ const answer = await input({ message: 'Enter your name' });
 | ----------- | ----------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | message     | `string`                                                    | yes      | The question to ask                                                                                                                                                                                                     |
 | default     | `string`                                                    | no       | Default value if no answer is provided (clear it by pressing backspace)                                                                                                                                                 |
-| transformer | `(string, { isFinal: boolean }) => string`                  | no       | Transform/Format the raw value entered by the user. Once the prompt is completed, `isFinal` will be `true`. This function is purely visual; to modify the answer, use the `filter` option.                              |
+| transformer | `(string, { isFinal: boolean }) => string`                  | no       | Transform/Format the raw value entered by the user. Once the prompt is completed, `isFinal` will be `true`. This function is purely visual, modify the answer in your code if needed.                              |
 | validate    | `string => boolean \| string \| Promise<string \| boolean>` | no       | On submit, validate the filtered answered content. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash. |
 
 # License

package/dist/cjs/index.js

@@ -0,0 +1,71 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@inquirer/core");
+const chalk_1 = __importDefault(require("chalk"));
+exports.default = (0, core_1.createPrompt)((config, done) => {
+    const [status, setStatus] = (0, core_1.useState)('pending');
+    const [defaultValue, setDefaultValue] = (0, core_1.useState)(config.default);
+    const [errorMsg, setError] = (0, core_1.useState)(undefined);
+    const [value, setValue] = (0, core_1.useState)('');
+    const isLoading = status === 'loading';
+    const prefix = (0, core_1.usePrefix)(isLoading);
+    (0, core_1.useKeypress)((key, rl) => __awaiter(void 0, void 0, void 0, function* () {
+        // Ignore keypress while our prompt is doing other processing.
+        if (status !== 'pending') {
+            return;
+        }
+        if ((0, core_1.isEnterKey)(key)) {
+            const answer = value || defaultValue || '';
+            setStatus('loading');
+            const isValid = yield config.validate(answer);
+            if (isValid === true) {
+                setValue(answer);
+                setStatus('done');
+                done(answer);
+            }
+            else {
+                // TODO: Can we keep the value after validation failure?
+                // `rl.line = value` works but it looses the cursor position.
+                setValue('');
+                setError(isValid || 'You must provide a valid value');
+                setStatus('pending');
+            }
+        }
+        else if ((0, core_1.isBackspaceKey)(key) && !value) {
+            setDefaultValue(undefined);
+        }
+        else {
+            setValue(rl.line);
+            setError(undefined);
+        }
+    }));
+    const message = chalk_1.default.bold(config.message);
+    let formattedValue = value;
+    if (typeof config.transformer === 'function') {
+        formattedValue = config.transformer(value, { isFinal: status === 'done' });
+    }
+    if (status === 'done') {
+        formattedValue = chalk_1.default.cyan(formattedValue);
+    }
+    let defaultStr = '';
+    if (defaultValue && status !== 'done' && !value) {
+        defaultStr = chalk_1.default.dim(` (${defaultValue})`);
+    }
+    let error = '';
+    if (errorMsg) {
+        error = chalk_1.default.red(`> ${errorMsg}`);
+    }
+    return [`${prefix} ${message}${defaultStr} ${formattedValue}`, error];
+});

package/dist/{index.d.ts → cjs/types/index.d.mts}

@@ -1,5 +1,5 @@
 import { AsyncPromptConfig } from '@inquirer/core';
-declare type InputConfig = AsyncPromptConfig & {
+type InputConfig = AsyncPromptConfig & {
     default?: string;
     transformer?: (value: string, { isFinal }: {
         isFinal: boolean;

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

@@ -0,0 +1,9 @@
+import { AsyncPromptConfig } from '@inquirer/core';
+type InputConfig = AsyncPromptConfig & {
+    default?: string;
+    transformer?: (value: string, { isFinal }: {
+        isFinal: boolean;
+    }) => string;
+};
+declare const _default: import("@inquirer/type").Prompt<string, InputConfig>;
+export default _default;

package/package.json

@@ -1,21 +1,22 @@
 {
   "name": "@inquirer/input",
-  "type": "module",
-  "version": "0.0.28-alpha.0",
+  "version": "1.0.0",
   "description": "Inquirer input text prompt",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "./dist/cjs/index.js",
+  "typings": "./dist/cjs/types/index.d.mts",
   "files": [
-    "dist/"
+    "dist/**/*"
   ],
-  "repository": "SBoudrias/Inquirer.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SBoudrias/Inquirer.js.git"
+  },
   "keywords": [
     "answer",
     "answers",
     "ask",
     "base",
     "cli",
-    "cli",
     "command",
     "command-line",
     "confirm",
@@ -53,14 +54,38 @@
   "license": "MIT",
   "homepage": "https://github.com/SBoudrias/Inquirer.js/blob/master/packages/input/README.md",
   "dependencies": {
-    "@inquirer/core": "^0.0.30-alpha.0",
-    "chalk": "^5.1.2"
+    "@inquirer/core": "^1.0.1",
+    "@inquirer/type": "^1.0.0",
+    "chalk": "^5.2.0"
+  },
+  "devDependencies": {
+    "@inquirer/testing": "^1.0.0",
+    "@jest/globals": "^29.5.0"
   },
   "scripts": {
-    "tsc": "tsc"
+    "tsc": "yarn run clean && yarn run tsc:esm && yarn run tsc:cjs",
+    "clean": "rm -rf dist",
+    "tsc:esm": "tsc -p ./tsconfig.esm.json",
+    "tsc:cjs": "tsc -p ./tsconfig.cjs.json && yarn run fix-ext",
+    "fix-ext": "ts-node ../../tools/rename-ext.ts"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f532af8be2d622caa5e54adf4c084d588c9ffad6"
+  "engines": {
+    "node": ">=14.18.0"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/types/index.d.mts",
+        "default": "./dist/esm/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/types/index.d.mts",
+        "default": "./dist/cjs/index.js"
+      }
+    }
+  },
+  "gitHead": "e93c4cb14f0c35ebd1efb065776b90f48899b075"
 }