@salesforce/sf-plugins-core 1.7.2 → 1.8.1

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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.8.1](https://github.com/salesforcecli/sf-plugins-core/compare/v1.8.0...v1.8.1) (2022-03-24)
+
+### Bug Fixes
+
+- log errors to stderr ([9958d8e](https://github.com/salesforcecli/sf-plugins-core/commit/9958d8e49cf1fbe514026491d8d095651d1cb88b))
+
+## [1.8.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.7.2...v1.8.0) (2022-03-17)
+
+### Features
+
+- confirms are timed ([9c89ee9](https://github.com/salesforcecli/sf-plugins-core/commit/9c89ee99901c7abefc11a811e8e4dda0c704ed1c))
+- simplified confirm prompts ([ddf1364](https://github.com/salesforcecli/sf-plugins-core/commit/ddf1364a48fb384bd0ad66bc310a35abcef20d68))
+
+### Bug Fixes
+
+- better checking of hub ([8c92bfe](https://github.com/salesforcecli/sf-plugins-core/commit/8c92bfed8f0600ff03489abbb253b5b95c95128a))
+- no unused, respects timeout ([c41c43e](https://github.com/salesforcecli/sf-plugins-core/commit/c41c43e5c480dc1dd914a86ec8c97a8af41369a1))
+- use OptionFlag interface so that exactlyOne can be used ([0e65453](https://github.com/salesforcecli/sf-plugins-core/commit/0e65453dacb68a90f4af2387e571edbd4077ba1b))
+
 ### [1.7.2](https://github.com/salesforcecli/sf-plugins-core/compare/v1.7.1...v1.7.2) (2022-03-15)
 
 ### Bug Fixes

package/lib/flags/duration.d.ts

@@ -1,7 +1,7 @@
 import { Interfaces } from '@oclif/core';
 import { Duration } from '@salesforce/kit';
 declare type DurationUnit = Lowercase<keyof typeof Duration.Unit>;
-export interface DurationFlagConfig extends Partial<Interfaces.OptionFlagProps> {
+export interface DurationFlagConfig extends Partial<Interfaces.OptionFlag<Duration>> {
     unit: Required<DurationUnit>;
     defaultValue?: number;
     min?: number;

package/lib/flags/orgFlags.js

@@ -31,11 +31,10 @@ const getHubOrThrow = async (aliasOrUsername) => {
         }
     }
     const org = await core_2.Org.create({ aliasOrUsername });
-    // check the synchronous, cached version and only use "determine" if we didn't get a positive result
-    if (!org.isDevHubOrg() || !(await org.determineIfDevHubOrg())) {
-        throw messages.createError('errors.NotADevHub', [aliasOrUsername]);
+    if (await org.determineIfDevHubOrg()) {
+        return org;
     }
-    return org;
+    throw messages.createError('errors.NotADevHub', [aliasOrUsername]);
 };
 /**
  * An optional org specified by username or alias
@@ -58,7 +57,7 @@ exports.optionalOrgFlag = core_1.Flags.build({
     char: 'e',
     parse: async (input) => await maybeGetOrg(input),
     default: async () => await maybeGetOrg(),
-    defaultHelp: async () => { var _a; return (_a = (await maybeGetOrg(undefined))) === null || _a === void 0 ? void 0 : _a.getUsername(); },
+    defaultHelp: async () => { var _a; return (_a = (await maybeGetOrg())) === null || _a === void 0 ? void 0 : _a.getUsername(); },
 });
 /**
  * An required org, specified by username or alias
@@ -82,8 +81,8 @@ exports.optionalOrgFlag = core_1.Flags.build({
 exports.requiredOrgFlag = core_1.Flags.build({
     char: 'e',
     parse: async (input) => await getOrgOrThrow(input),
-    default: async () => await getOrgOrThrow(undefined),
-    defaultHelp: async () => { var _a; return (_a = (await getOrgOrThrow(undefined))) === null || _a === void 0 ? void 0 : _a.getUsername(); },
+    default: async () => await getOrgOrThrow(),
+    defaultHelp: async () => { var _a; return (_a = (await getOrgOrThrow())) === null || _a === void 0 ? void 0 : _a.getUsername(); },
 });
 /**
  * An required org that is a devHub
@@ -107,7 +106,7 @@ exports.requiredOrgFlag = core_1.Flags.build({
 exports.requiredHubFlag = core_1.Flags.build({
     char: 'v',
     parse: async (input) => await getHubOrThrow(input),
-    default: async () => await getHubOrThrow(undefined),
-    defaultHelp: async () => { var _a; return (_a = (await getHubOrThrow(undefined))) === null || _a === void 0 ? void 0 : _a.getUsername(); },
+    default: async () => await getHubOrThrow(),
+    defaultHelp: async () => { var _a; return (_a = (await getHubOrThrow())) === null || _a === void 0 ? void 0 : _a.getUsername(); },
 });
 //# sourceMappingURL=orgFlags.js.map

package/lib/flags/salesforceId.d.ts

@@ -1,5 +1,5 @@
 import { Interfaces } from '@oclif/core';
-export interface IdFlagConfig extends Partial<Interfaces.OptionFlagProps> {
+export interface IdFlagConfig extends Partial<Interfaces.OptionFlag<string>> {
     /**
      * Can specify if the version must be 15 or 18 characters long.  Leave blank to allow either 15 or 18.
      */

package/lib/sfCommand.d.ts

@@ -80,6 +80,14 @@ export declare abstract class SfCommand<T> extends Command {
      * }
      */
     prompt<R = Prompter.Answers>(questions: Prompter.Questions<R>, initialAnswers?: Partial<R>): Promise<R>;
+    /**
+     * Simplified prompt for single-question confirmation.  Times out and throws after 10s
+     *
+     * @param message text to display.  Do not include a question mark.
+     * @param ms milliseconds to wait for user input.  Defaults to 10s.
+     * @return true if the user confirms, false if they do not.
+     */
+    confirm(message: string, ms?: number): Promise<boolean>;
     /**
      * Prompt user for information with a timeout (in milliseconds). See https://www.npmjs.com/package/inquirer for more.
      */

package/lib/sfCommand.js

@@ -113,6 +113,23 @@ class SfCommand extends core_1.Command {
     async prompt(questions, initialAnswers) {
         return this.prompter.prompt(questions, initialAnswers);
     }
+    /**
+     * Simplified prompt for single-question confirmation.  Times out and throws after 10s
+     *
+     * @param message text to display.  Do not include a question mark.
+     * @param ms milliseconds to wait for user input.  Defaults to 10s.
+     * @return true if the user confirms, false if they do not.
+     */
+    async confirm(message, ms = 10000) {
+        const { confirmed } = await this.timedPrompt([
+            {
+                name: 'confirmed',
+                message,
+                type: 'confirm',
+            },
+        ], ms);
+        return confirmed;
+    }
     /**
      * Prompt user for information with a timeout (in milliseconds). See https://www.npmjs.com/package/inquirer for more.
      */
@@ -166,10 +183,13 @@ class SfCommand extends core_1.Command {
     async catch(error) {
         var _a, _b;
         process.exitCode = (_b = (_a = process.exitCode) !== null && _a !== void 0 ? _a : error.exitCode) !== null && _b !== void 0 ? _b : 1;
-        this.log(this.formatError(error));
         if (this.jsonEnabled()) {
             core_1.CliUx.ux.styledJSON(this.toErrorJson(error));
         }
+        else {
+            // eslint-disable-next-line no-console
+            console.error(this.formatError(error));
+        }
         return error;
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.7.2",
+  "version": "1.8.1",
   "description": "Utils for writing deploy and retrieve plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -32,7 +32,7 @@
     "/messages"
   ],
   "dependencies": {
-    "@oclif/core": "^1.5.2",
+    "@oclif/core": "^1.6.0",
     "@salesforce/core": "^3.7.9",
     "@salesforce/kit": "^1.5.34",
     "@salesforce/ts-types": "^1.5.20",