@salesforce/sf-plugins-core 1.14.1 → 1.15.1

package/README.md

@@ -13,7 +13,7 @@ The SfCommand abstract class extends [@oclif/core's Command class](https://githu
 - Enable the json flag support by default
 - Provides functions that help place success messages, warnings and errors into the correct location in JSON results
 - Enables additional help sections to the standard oclif command help output
-- Provides access to the [cli-ux cli actions](https://github.com/oclif/cli-ux#cliaction) via the public property `spinner` in SfCommand. This avoids having to import that interface from cli-ux.
+- Provides access to the [cli-ux cli actions](https://github.com/oclif/cli-ux#cliaction). This avoids having to import that interface from cli-ux and manually handling the `--json` flag.
 
 ## Sf Hooks
 

package/lib/deauthorizer.d.ts

@@ -1,7 +1,6 @@
 import { JsonMap } from '@salesforce/ts-types';
 /**
- * The Deauthorizer is an abstract class that is used to implement a concrete implementations
- * of deauthorizing an environment.
+ * The Deauthorizer is an abstract class that is used to implement a concrete implementation of deauthorizing an environment.
  */
 export declare abstract class Deauthorizer<T = JsonMap> {
     removeAll(): Promise<Deauthorizer.Result>;

package/lib/deauthorizer.js

@@ -8,8 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Deauthorizer = void 0;
 /**
- * The Deauthorizer is an abstract class that is used to implement a concrete implementations
- * of deauthorizing an environment.
+ * The Deauthorizer is an abstract class that is used to implement a concrete implementation of deauthorizing an environment.
  */
 class Deauthorizer {
     async removeAll() {
@@ -20,6 +19,8 @@ class Deauthorizer {
         const environments = await this.find();
         for (const id of Object.keys(environments)) {
             try {
+                // avoid configFile collision bug
+                // eslint-disable-next-line no-await-in-loop
                 await this.remove(id);
                 result.successes.push(id);
             }

package/lib/deployer.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
 import { AnyJson, JsonMap } from '@salesforce/ts-types';
-import { QuestionCollection } from 'inquirer';
+import { QuestionCollection, Answers } from 'inquirer';
 export declare type DeployerResult = {
     exitCode: number;
 };
@@ -33,7 +33,7 @@ export declare abstract class Deployer extends EventEmitter {
     /**
      * Prompt user for additional information
      */
-    prompt<T>(questions: QuestionCollection<T>, initialAnswers?: Partial<T>): Promise<T>;
+    prompt<T extends Answers>(questions: QuestionCollection<T>, initialAnswers?: Partial<T>): Promise<T>;
     /**
      * Overwrite the deployables property on the class.
      */
@@ -62,6 +62,9 @@ export declare namespace Deployer {
     };
     /**
      * This interface represents the aggregation of all deployer options, e.g.
+     *
+     * @example
+     * ```
      * {
      *   'Salesforce Apps': {
      *      testLevel: 'RunLocalTests',
@@ -69,6 +72,7 @@ export declare namespace Deployer {
      *    },
      *   'Salesforce Functions': { username: 'user@salesforce.com' },
      * }
+     * ```
      */
     type Options<T = AnyJson> = JsonMap & {
         [key: string]: T;

package/lib/deployer.js

@@ -5,6 +5,7 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
+/* eslint-disable @typescript-eslint/explicit-member-accessibility */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Deployer = exports.Deployable = void 0;
 const events_1 = require("events");
@@ -30,11 +31,12 @@ class Deployer extends events_1.EventEmitter {
     /**
      * Method for displaying deploy progress to the user
      */
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function, class-methods-use-this
     progress(current, total, message) { }
     /**
      * Log messages to the console
      */
+    // eslint-disable-next-line class-methods-use-this
     log(msg, ...args) {
         core_1.CliUx.ux.log(msg, ...args);
     }

package/lib/exported.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { Flags as OclifFlags } from '@oclif/core';
-export { toHelpSection } from './util';
+export { toHelpSection, parseVarArgs } from './util';
 export { Deployable, Deployer, DeployerResult } from './deployer';
 export { Deauthorizer } from './deauthorizer';
 export { Progress, Prompter, generateTableChoices } from './ux';

package/lib/exported.js

@@ -20,10 +20,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Flags = exports.StandardColors = exports.SfCommand = exports.SfHook = exports.generateTableChoices = exports.Prompter = exports.Progress = exports.Deauthorizer = exports.Deployer = exports.Deployable = exports.toHelpSection = void 0;
+exports.Flags = exports.StandardColors = exports.SfCommand = exports.SfHook = exports.generateTableChoices = exports.Prompter = exports.Progress = exports.Deauthorizer = exports.Deployer = exports.Deployable = exports.parseVarArgs = exports.toHelpSection = void 0;
 const core_1 = require("@oclif/core");
 var util_1 = require("./util");
 Object.defineProperty(exports, "toHelpSection", { enumerable: true, get: function () { return util_1.toHelpSection; } });
+Object.defineProperty(exports, "parseVarArgs", { enumerable: true, get: function () { return util_1.parseVarArgs; } });
 var deployer_1 = require("./deployer");
 Object.defineProperty(exports, "Deployable", { enumerable: true, get: function () { return deployer_1.Deployable; } });
 Object.defineProperty(exports, "Deployer", { enumerable: true, get: function () { return deployer_1.Deployer; } });

package/lib/flags/duration.d.ts

@@ -12,9 +12,11 @@ export declare type DurationFlagConfig = {
  * Defaults to undefined if you don't specify a default
  *
  * @example
- * import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+ *
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
  * public static flags = {
- *    'wait': duration({
+ *    wait: Flags.duration({
  *       min: 1,
  *       unit: 'minutes'
  *       defaultValue: 33,
@@ -22,6 +24,7 @@ export declare type DurationFlagConfig = {
  *       description: 'Wait time in minutes'
  *    }),
  * }
+ * ```
  */
 export declare const durationFlag: import("@oclif/core/lib/interfaces").Definition<Duration, DurationFlagConfig>;
 export {};

package/lib/flags/duration.js

@@ -18,9 +18,11 @@ const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'me
  * Defaults to undefined if you don't specify a default
  *
  * @example
- * import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+ *
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
  * public static flags = {
- *    'wait': duration({
+ *    wait: Flags.duration({
  *       min: 1,
  *       unit: 'minutes'
  *       defaultValue: 33,
@@ -28,12 +30,11 @@ const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'me
  *       description: 'Wait time in minutes'
  *    }),
  * }
+ * ```
  */
 exports.durationFlag = core_1.Flags.custom({
     parse: async (input, _, opts) => validate(input, opts),
-    default: async (context) => {
-        return context.options.defaultValue ? toDuration(context.options.defaultValue, context.options.unit) : undefined;
-    },
+    default: async (context) => context.options.defaultValue ? toDuration(context.options.defaultValue, context.options.unit) : undefined,
 });
 const validate = (input, config) => {
     const { min, max, unit } = config || {};
@@ -55,7 +56,5 @@ const validate = (input, config) => {
     }
     return toDuration(parsedInput, unit);
 };
-const toDuration = (parsedInput, unit) => {
-    return kit_1.Duration[unit](parsedInput);
-};
+const toDuration = (parsedInput, unit) => kit_1.Duration[unit](parsedInput);
 //# sourceMappingURL=duration.js.map

package/lib/flags/orgApiVersion.d.ts

@@ -8,6 +8,18 @@ export declare const maxDeprecatedUrl = "https://help.salesforce.com/s/articleVi
  *
  * CAVEAT: unlike the apiversion flag on sfdxCommand, this does not set the version on the org/connection
  * We leave this up to the plugins to implement
+ *
+ * @example
+ *
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
+ * public static flags = {
+ *    'api-version': Flags.orgApiVersion({
+ *       char: 'a',
+ *       description: 'api version for the org'
+ *    }),
+ * }
+ * ```
  */
 export declare const orgApiVersionFlag: import("@oclif/core/lib/interfaces").Definition<string, Record<string, unknown>>;
 //# sourceMappingURL=orgApiVersion.d.ts.map

package/lib/flags/orgApiVersion.js

@@ -23,18 +23,29 @@ exports.maxDeprecatedUrl = 'https://help.salesforce.com/s/articleView?id=0003544
  *
  * CAVEAT: unlike the apiversion flag on sfdxCommand, this does not set the version on the org/connection
  * We leave this up to the plugins to implement
+ *
+ * @example
+ *
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
+ * public static flags = {
+ *    'api-version': Flags.orgApiVersion({
+ *       char: 'a',
+ *       description: 'api version for the org'
+ *    }),
+ * }
+ * ```
  */
 exports.orgApiVersionFlag = core_1.Flags.custom({
     parse: async (input) => validate(input),
-    default: async () => await getDefaultFromConfig(),
+    default: async () => getDefaultFromConfig(),
     description: messages.getMessage('flags.apiVersion.description'),
 });
 const getDefaultFromConfig = async () => {
-    var _a;
     // (perf) only import ConfigAggregator if necessary
     const { ConfigAggregator } = await Promise.resolve().then(() => require('@salesforce/core'));
     const config = await ConfigAggregator.create();
-    const apiVersionFromConfig = (_a = config.getInfo(core_2.OrgConfigProperties.ORG_API_VERSION)) === null || _a === void 0 ? void 0 : _a.value;
+    const apiVersionFromConfig = config.getInfo(core_2.OrgConfigProperties.ORG_API_VERSION)?.value;
     if (apiVersionFromConfig) {
         await core_2.Lifecycle.getInstance().emitWarning(messages.getMessage('flags.apiVersion.overrideWarning', [apiVersionFromConfig]));
         return validate(apiVersionFromConfig);

package/lib/flags/orgFlags.d.ts

@@ -5,7 +5,9 @@ import { Org } from '@salesforce/core';
  * Will not throw if the specified org and default do not exist
  *
  * @example
- * import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+ *
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
  * public static flags = {
  *     // setting length or prefix
  *    'target-org': Flags.optionalOrg(),
@@ -15,6 +17,7 @@ import { Org } from '@salesforce/core';
  *        description: 'flag2 description',
  *     }),
  * }
+ * ```
  */
 export declare const optionalOrgFlag: import("@oclif/core/lib/interfaces").Definition<Org | undefined, Record<string, unknown>>;
 /**
@@ -24,7 +27,9 @@ export declare const optionalOrgFlag: import("@oclif/core/lib/interfaces").Defin
  * Will throw if no default org exists and none is specified
  *
  * @example
- * import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+ *
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
  * public static flags = {
  *     // setting length or prefix
  *    'target-org': Flags.requiredOrg(),
@@ -35,6 +40,7 @@ export declare const optionalOrgFlag: import("@oclif/core/lib/interfaces").Defin
  *        char: 'o'
  *     }),
  * }
+ * ```
  */
 export declare const requiredOrgFlag: import("@oclif/core/lib/interfaces").Definition<Org, Record<string, unknown>>;
 /**
@@ -44,7 +50,9 @@ export declare const requiredOrgFlag: import("@oclif/core/lib/interfaces").Defin
  * Will throw if no default deb hub exists and none is specified
  *
  * @example
- * import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+ *
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
  * public static flags = {
  *     // setting length or prefix
  *    'target-org': requiredHub(),
@@ -55,6 +63,7 @@ export declare const requiredOrgFlag: import("@oclif/core/lib/interfaces").Defin
  *        char: 'h'
  *     }),
  * }
+ * ```
  */
 export declare const requiredHubFlag: import("@oclif/core/lib/interfaces").Definition<Org, Record<string, unknown>>;
 //# sourceMappingURL=orgFlags.d.ts.map

package/lib/flags/orgFlags.js

@@ -32,11 +32,10 @@ const getOrgOrThrow = async (input) => {
     return org;
 };
 const getHubOrThrow = async (aliasOrUsername) => {
-    var _a;
     if (!aliasOrUsername) {
         // check config for a default
         const config = await core_2.ConfigAggregator.create();
-        aliasOrUsername = (_a = config.getInfo(core_2.OrgConfigProperties.TARGET_DEV_HUB)) === null || _a === void 0 ? void 0 : _a.value;
+        aliasOrUsername = config.getInfo(core_2.OrgConfigProperties.TARGET_DEV_HUB)?.value;
         if (!aliasOrUsername) {
             throw messages.createError('errors.NoDefaultDevHub');
         }
@@ -53,7 +52,9 @@ const getHubOrThrow = async (aliasOrUsername) => {
  * Will not throw if the specified org and default do not exist
  *
  * @example
- * import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+ *
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
  * public static flags = {
  *     // setting length or prefix
  *    'target-org': Flags.optionalOrg(),
@@ -63,12 +64,13 @@ const getHubOrThrow = async (aliasOrUsername) => {
  *        description: 'flag2 description',
  *     }),
  * }
+ * ```
  */
 exports.optionalOrgFlag = core_1.Flags.custom({
     char: 'e',
-    parse: async (input) => await maybeGetOrg(input),
-    default: async () => await maybeGetOrg(),
-    defaultHelp: async () => { var _a; return (_a = (await maybeGetOrg())) === null || _a === void 0 ? void 0 : _a.getUsername(); },
+    parse: async (input) => maybeGetOrg(input),
+    default: async () => maybeGetOrg(),
+    defaultHelp: async () => (await maybeGetOrg())?.getUsername(),
 });
 /**
  * A required org, specified by username or alias
@@ -77,7 +79,9 @@ exports.optionalOrgFlag = core_1.Flags.custom({
  * Will throw if no default org exists and none is specified
  *
  * @example
- * import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+ *
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
  * public static flags = {
  *     // setting length or prefix
  *    'target-org': Flags.requiredOrg(),
@@ -88,12 +92,13 @@ exports.optionalOrgFlag = core_1.Flags.custom({
  *        char: 'o'
  *     }),
  * }
+ * ```
  */
 exports.requiredOrgFlag = core_1.Flags.custom({
     char: 'e',
-    parse: async (input) => await getOrgOrThrow(input),
-    default: async () => await getOrgOrThrow(),
-    defaultHelp: async () => { var _a; return (_a = (await getOrgOrThrow())) === null || _a === void 0 ? void 0 : _a.getUsername(); },
+    parse: async (input) => getOrgOrThrow(input),
+    default: async () => getOrgOrThrow(),
+    defaultHelp: async () => (await getOrgOrThrow())?.getUsername(),
 });
 /**
  * A required org that is a devHub
@@ -102,7 +107,9 @@ exports.requiredOrgFlag = core_1.Flags.custom({
  * Will throw if no default deb hub exists and none is specified
  *
  * @example
- * import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+ *
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
  * public static flags = {
  *     // setting length or prefix
  *    'target-org': requiredHub(),
@@ -113,11 +120,12 @@ exports.requiredOrgFlag = core_1.Flags.custom({
  *        char: 'h'
  *     }),
  * }
+ * ```
  */
 exports.requiredHubFlag = core_1.Flags.custom({
     char: 'v',
-    parse: async (input) => await getHubOrThrow(input),
-    default: async () => await getHubOrThrow(),
-    defaultHelp: async () => { var _a; return (_a = (await getHubOrThrow())) === null || _a === void 0 ? void 0 : _a.getUsername(); },
+    parse: async (input) => getHubOrThrow(input),
+    default: async () => getHubOrThrow(),
+    defaultHelp: async () => (await getHubOrThrow())?.getUsername(),
 });
 //# sourceMappingURL=orgFlags.js.map

package/lib/flags/salesforceId.d.ts

@@ -12,7 +12,9 @@ export declare type IdFlagConfig = {
  * Id flag with built-in validation.  Short character is `i`
  *
  * @example
- * import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+ *
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
  * public static flags = {
  *     // set length or prefix
  *    'flag-name': salesforceId({ length: 15, startsWith: '00D' }),
@@ -26,6 +28,7 @@ export declare type IdFlagConfig = {
  *        char: 'j',
  *     }),
  * }
+ * ```
  */
 export declare const salesforceIdFlag: import("@oclif/core/lib/interfaces").Definition<string, IdFlagConfig>;
 //# sourceMappingURL=salesforceId.d.ts.map

package/lib/flags/salesforceId.js

@@ -15,7 +15,9 @@ const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'me
  * Id flag with built-in validation.  Short character is `i`
  *
  * @example
- * import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+ *
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
  * public static flags = {
  *     // set length or prefix
  *    'flag-name': salesforceId({ length: 15, startsWith: '00D' }),
@@ -29,13 +31,14 @@ const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'me
  *        char: 'j',
  *     }),
  * }
+ * ```
  */
 exports.salesforceIdFlag = core_1.Flags.custom({
     parse: async (input, _ctx, opts) => validate(input, opts),
     char: 'i',
 });
 const validate = (input, config) => {
-    const { length, startsWith } = config || {};
+    const { length, startsWith } = config ?? {};
     if (length && input.length !== length) {
         throw messages.createError('errors.InvalidIdLength', [length]);
     }

package/lib/hooks.d.ts

@@ -15,9 +15,12 @@ interface SfHooks<T = unknown> extends Hooks {
 }
 declare type GenericHook<T extends keyof SfHooks, P> = Hook<T, SfHooks<P>>;
 /**
- * Class that provides a static method to run a well known hook.
+ * Class that provides a static method to run a pre-defined sf hook. See {@link SfHooks}.
  */
 export declare class SfHook {
+    /**
+     * Executes a well known Unified CLI hook. See {@link SfHooks}.
+     */
     static run<T extends keyof SfHooks>(config: Config, hookName: T, options?: SfHooks[T]['options']): Promise<Hook.Result<SfHooks[T]['return']>>;
 }
 export declare namespace SfHook {

package/lib/hooks.js

@@ -10,11 +10,14 @@ exports.SfHook = void 0;
 const kit_1 = require("@salesforce/kit");
 const core_1 = require("@oclif/core");
 /**
- * Class that provides a static method to run a well known hook.
+ * Class that provides a static method to run a pre-defined sf hook. See {@link SfHooks}.
  */
 class SfHook {
+    /**
+     * Executes a well known Unified CLI hook. See {@link SfHooks}.
+     */
     static async run(config, hookName, options = {}) {
-        const timeout = kit_1.Duration.milliseconds(kit_1.env.getNumber('SF_HOOK_TIMEOUT_MS') || 5000);
+        const timeout = kit_1.Duration.milliseconds(kit_1.env.getNumber('SF_HOOK_TIMEOUT_MS') ?? 5000);
         const results = await config.runHook(hookName, options, timeout.milliseconds);
         results.failures.forEach((failure) => {
             core_1.CliUx.ux.debug(`Failed to run ${hookName} hook for ${failure.plugin.name}`);