@salesforce/sf-plugins-core 1.7.0 → 1.7.3

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.7.3](https://github.com/salesforcecli/sf-plugins-core/compare/v1.7.2...v1.7.3) (2022-03-17)
+
+### Bug Fixes
+
+- 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
+
+- need to pass ms to timedPrompt function ([f285e07](https://github.com/salesforcecli/sf-plugins-core/commit/f285e07525937798d0251da69c86c05cc683edfd))
+
+### [1.7.1](https://github.com/salesforcecli/sf-plugins-core/compare/v1.7.0...v1.7.1) (2022-03-11)
+
+### Bug Fixes
+
+- add oclif enum to exports ([71ee6ac](https://github.com/salesforcecli/sf-plugins-core/commit/71ee6ac7942790ffc519512ade67330614ada51b))
+- expose timed prompt in command class ([3b056c6](https://github.com/salesforcecli/sf-plugins-core/commit/3b056c668d3379ada6f85e2e5b5f6da76c1a3223))
+
 ## [1.7.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.6.1...v1.7.0) (2022-03-11)
 
 ### Features

package/lib/exported.d.ts

@@ -11,6 +11,7 @@ export declare const Flags: {
     directory: (opts?: ({
         exists?: boolean | undefined;
     } & Partial<import("@oclif/core/lib/interfaces").OptionFlag<string>>) | undefined) => import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+    enum: <T = string>(opts: import("@oclif/core/lib/interfaces").EnumFlagOptions<T>) => import("@oclif/core/lib/interfaces").OptionFlag<T>;
     file: (opts?: ({
         exists?: boolean | undefined;
     } & Partial<import("@oclif/core/lib/interfaces").OptionFlag<string>>) | undefined) => import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;

package/lib/exported.js

@@ -46,6 +46,7 @@ const duration_1 = require("./flags/duration");
 exports.Flags = {
     boolean: core_1.Flags.boolean,
     directory: core_1.Flags.directory,
+    enum: core_1.Flags.enum,
     file: core_1.Flags.file,
     integer: core_1.Flags.integer,
     string: core_1.Flags.string,

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

@@ -58,7 +58,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 +82,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 +107,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,10 @@ export declare abstract class SfCommand<T> extends Command {
      * }
      */
     prompt<R = Prompter.Answers>(questions: Prompter.Questions<R>, initialAnswers?: Partial<R>): Promise<R>;
+    /**
+     * Prompt user for information with a timeout (in milliseconds). See https://www.npmjs.com/package/inquirer for more.
+     */
+    timedPrompt<R = Prompter.Answers>(questions: Prompter.Questions<R>, ms?: number, initialAnswers?: Partial<R>): Promise<R>;
     _run<R>(): Promise<R | undefined>;
     /**
      * Wrap the command result into the standardized JSON structure.

package/lib/sfCommand.js

@@ -113,6 +113,12 @@ class SfCommand extends core_1.Command {
     async prompt(questions, initialAnswers) {
         return this.prompter.prompt(questions, initialAnswers);
     }
+    /**
+     * Prompt user for information with a timeout (in milliseconds). See https://www.npmjs.com/package/inquirer for more.
+     */
+    async timedPrompt(questions, ms = 10000, initialAnswers) {
+        return this.prompter.timedPrompt(questions, ms, initialAnswers);
+    }
     async _run() {
         if (this.statics.requiresProject) {
             this.project = await this.assignProject();

package/package.json

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