@salesforce/sf-plugins-core 1.5.3 → 1.6.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.6.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.5.3...v1.6.0) (2022-03-08)
+
+### Features
+
+- add timedPrompt method ([ea9e98c](https://github.com/salesforcecli/sf-plugins-core/commit/ea9e98c5bffdfc1e917d61006a91f4dba1f808f3))
+
 ### [1.5.3](https://github.com/salesforcecli/sf-plugins-core/compare/v1.5.2...v1.5.3) (2022-03-08)
 
 ### Bug Fixes

package/lib/ux/prompter.d.ts

@@ -5,6 +5,10 @@ export declare class Prompter {
      * Prompt user for information. See https://www.npmjs.com/package/inquirer for more.
      */
     prompt<T = Prompter.Answers>(questions: Prompter.Questions<T>, initialAnswers?: Partial<T>): Promise<T>;
+    /**
+     * Prompt user for information with a timeout (in milliseconds). See https://www.npmjs.com/package/inquirer for more.
+     */
+    timedPrompt<T = Prompter.Answers>(questions: Prompter.Questions<T>, ms?: number, initialAnswers?: Partial<T>): Promise<T>;
 }
 export declare namespace Prompter {
     type Answers<T = Record<string, unknown>> = T & Record<string, unknown>;

package/lib/ux/prompter.js

@@ -9,6 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateTableChoices = exports.Prompter = void 0;
 const inquirer_1 = require("inquirer");
 const ts_types_1 = require("@salesforce/ts-types");
+const core_1 = require("@oclif/core");
 class Prompter {
     /**
      * Prompt user for information. See https://www.npmjs.com/package/inquirer for more.
@@ -17,6 +18,27 @@ class Prompter {
         const answers = await (0, inquirer_1.prompt)(questions, initialAnswers);
         return answers;
     }
+    /**
+     * Prompt user for information with a timeout (in milliseconds). See https://www.npmjs.com/package/inquirer for more.
+     */
+    async timedPrompt(questions, ms = 10000, initialAnswers) {
+        let id;
+        const thePrompt = (0, inquirer_1.prompt)(questions, initialAnswers);
+        const timeout = new Promise((_, reject) => {
+            id = setTimeout(() => {
+                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                // @ts-expect-error
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+                thePrompt.ui['activePrompt'].done();
+                core_1.CliUx.ux.log();
+                reject(new Error(`Timed out after ${ms} ms.`));
+            }, ms).unref();
+        });
+        return Promise.race([timeout, thePrompt]).then((result) => {
+            clearTimeout(id);
+            return result;
+        });
+    }
 }
 exports.Prompter = Prompter;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.5.3",
+  "version": "1.6.0",
   "description": "Utils for writing deploy and retrieve plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",