@salesforce/sf-plugins-core 5.0.13 → 5.0.14-dev.0

package/lib/flags/orgFlags.d.ts

@@ -25,7 +25,7 @@ export declare const getHubOrThrow: (aliasOrUsername?: string) => Promise<Org>;
  * }
  * ```
  */
-export declare const optionalOrgFlag: import("@oclif/core/lib/interfaces").FlagDefinition<Org, import("@oclif/core/lib/interfaces").CustomOptions, {
+export declare const optionalOrgFlag: import("@oclif/core/lib/interfaces/parser.js").FlagDefinition<Org, import("@oclif/core/lib/interfaces/parser.js").CustomOptions, {
     multiple: false;
     requiredOrDefaulted: true;
 }>;
@@ -51,7 +51,7 @@ export declare const optionalOrgFlag: import("@oclif/core/lib/interfaces").FlagD
  * }
  * ```
  */
-export declare const requiredOrgFlag: import("@oclif/core/lib/interfaces").FlagDefinition<Org, import("@oclif/core/lib/interfaces").CustomOptions, {
+export declare const requiredOrgFlag: import("@oclif/core/lib/interfaces/parser.js").FlagDefinition<Org, import("@oclif/core/lib/interfaces/parser.js").CustomOptions, {
     multiple: false;
     requiredOrDefaulted: true;
 }>;
@@ -77,7 +77,7 @@ export declare const requiredOrgFlag: import("@oclif/core/lib/interfaces").FlagD
  * }
  * ```
  */
-export declare const requiredHubFlag: import("@oclif/core/lib/interfaces").FlagDefinition<Org, import("@oclif/core/lib/interfaces").CustomOptions, {
+export declare const requiredHubFlag: import("@oclif/core/lib/interfaces/parser.js").FlagDefinition<Org, import("@oclif/core/lib/interfaces/parser.js").CustomOptions, {
     multiple: false;
     requiredOrDefaulted: true;
 }>;
@@ -102,7 +102,7 @@ export declare const requiredHubFlag: import("@oclif/core/lib/interfaces").FlagD
  * }
  * ```
  */
-export declare const optionalHubFlag: import("@oclif/core/lib/interfaces").FlagDefinition<Org, import("@oclif/core/lib/interfaces").CustomOptions, {
+export declare const optionalHubFlag: import("@oclif/core/lib/interfaces/parser.js").FlagDefinition<Org, import("@oclif/core/lib/interfaces/parser.js").CustomOptions, {
     multiple: false;
     requiredOrDefaulted: true;
 }>;

package/lib/flags/orgFlags.js

@@ -1,19 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.optionalHubFlag = exports.requiredHubFlag = exports.requiredOrgFlag = exports.optionalOrgFlag = exports.getHubOrThrow = exports.getOrgOrThrow = exports.maybeGetHub = exports.maybeGetOrg = void 0;
 /*
  * Copyright (c) 2020, salesforce.com, inc.
  * All rights reserved.
  * 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
  */
-const core_1 = require("@oclif/core");
-const core_2 = require("@salesforce/core");
-core_2.Messages.importMessagesDirectory(__dirname);
-const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'messages');
-async function maybeGetOrg(input) {
+import { Flags } from '@oclif/core';
+import { ConfigAggregator, Messages, Org, OrgConfigProperties } from '@salesforce/core';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/sf-plugins-core', 'messages');
+export async function maybeGetOrg(input) {
     try {
-        return await core_2.Org.create({ aliasOrUsername: input });
+        return await Org.create({ aliasOrUsername: input });
     }
     catch (e) {
         if (!input) {
@@ -24,19 +21,18 @@ async function maybeGetOrg(input) {
         }
     }
 }
-exports.maybeGetOrg = maybeGetOrg;
-const maybeGetHub = async (input) => {
+export const maybeGetHub = async (input) => {
     let org;
     // user provided input, verify the org exits
     if (input) {
-        org = await (0, exports.getOrgOrThrow)(input);
+        org = await getOrgOrThrow(input);
     }
     else {
         // no input, check config for a default
         const aliasOrUsername = await getDefaultHub(false);
         // if there is a default, verify the org exists
         if (aliasOrUsername) {
-            org = await (0, exports.getOrgOrThrow)(aliasOrUsername);
+            org = await getOrgOrThrow(aliasOrUsername);
         }
     }
     if (org) {
@@ -46,15 +42,13 @@ const maybeGetHub = async (input) => {
         return undefined;
     }
 };
-exports.maybeGetHub = maybeGetHub;
-const getOrgOrThrow = async (input) => {
+export const getOrgOrThrow = async (input) => {
     const org = await maybeGetOrg(input);
     if (!org) {
         throw messages.createError('errors.NoDefaultEnv');
     }
     return org;
 };
-exports.getOrgOrThrow = getOrgOrThrow;
 const ensureDevHub = async (org, aliasOrUsername) => {
     if (await org.determineIfDevHubOrg()) {
         return org;
@@ -63,19 +57,18 @@ const ensureDevHub = async (org, aliasOrUsername) => {
 };
 async function getDefaultHub(throwIfNotFound) {
     // check config for a default
-    const config = await core_2.ConfigAggregator.create();
-    const aliasOrUsername = config.getInfo(core_2.OrgConfigProperties.TARGET_DEV_HUB)?.value;
+    const config = await ConfigAggregator.create();
+    const aliasOrUsername = config.getInfo(OrgConfigProperties.TARGET_DEV_HUB)?.value;
     if (throwIfNotFound && !aliasOrUsername) {
         throw messages.createError('errors.NoDefaultDevHub');
     }
     return aliasOrUsername;
 }
-const getHubOrThrow = async (aliasOrUsername) => {
+export const getHubOrThrow = async (aliasOrUsername) => {
     const resolved = aliasOrUsername ?? (await getDefaultHub(true));
-    const org = await core_2.Org.create({ aliasOrUsername: resolved, isDevHub: true });
+    const org = await Org.create({ aliasOrUsername: resolved, isDevHub: true });
     return ensureDevHub(org, resolved);
 };
-exports.getHubOrThrow = getHubOrThrow;
 /**
  * An optional org specified by username or alias
  * Will default to the default org if one is not specified.
@@ -96,13 +89,13 @@ exports.getHubOrThrow = getHubOrThrow;
  * }
  * ```
  */
-exports.optionalOrgFlag = core_1.Flags.custom({
+export const optionalOrgFlag = Flags.custom({
     char: 'o',
     noCacheDefault: true,
     parse: async (input) => maybeGetOrg(input),
     default: async () => maybeGetOrg(),
     defaultHelp: async (context) => {
-        if (context.options instanceof core_2.Org) {
+        if (context.options instanceof Org) {
             const org = context.options;
             return org.getUsername();
         }
@@ -131,14 +124,14 @@ exports.optionalOrgFlag = core_1.Flags.custom({
  * }
  * ```
  */
-exports.requiredOrgFlag = core_1.Flags.custom({
+export const requiredOrgFlag = Flags.custom({
     char: 'o',
     summary: messages.getMessage('flags.targetOrg.summary'),
     noCacheDefault: true,
-    parse: async (input) => (0, exports.getOrgOrThrow)(input),
-    default: async () => (0, exports.getOrgOrThrow)(),
+    parse: async (input) => getOrgOrThrow(input),
+    default: async () => getOrgOrThrow(),
     defaultHelp: async (context) => {
-        if (context.options instanceof core_2.Org) {
+        if (context.options instanceof Org) {
             const org = context.options;
             return org.getUsername();
         }
@@ -168,18 +161,18 @@ exports.requiredOrgFlag = core_1.Flags.custom({
  * }
  * ```
  */
-exports.requiredHubFlag = core_1.Flags.custom({
+export const requiredHubFlag = Flags.custom({
     char: 'v',
     summary: messages.getMessage('flags.targetDevHubOrg.summary'),
     noCacheDefault: true,
-    parse: async (input) => (0, exports.getHubOrThrow)(input),
-    default: async () => (0, exports.getHubOrThrow)(),
+    parse: async (input) => getHubOrThrow(input),
+    default: async () => getHubOrThrow(),
     defaultHelp: async (context) => {
-        if (context.options instanceof core_2.Org) {
+        if (context.options instanceof Org) {
             const org = context.options;
             return org.getUsername();
         }
-        return (await (0, exports.maybeGetHub)())?.getUsername();
+        return (await maybeGetHub())?.getUsername();
     },
     required: true,
 });
@@ -204,18 +197,18 @@ exports.requiredHubFlag = core_1.Flags.custom({
  * }
  * ```
  */
-exports.optionalHubFlag = core_1.Flags.custom({
+export const optionalHubFlag = Flags.custom({
     char: 'v',
     summary: messages.getMessage('flags.targetDevHubOrg.summary'),
     noCacheDefault: true,
-    parse: async (input) => (0, exports.maybeGetHub)(input),
-    default: async () => (0, exports.maybeGetHub)(),
+    parse: async (input) => maybeGetHub(input),
+    default: async () => maybeGetHub(),
     defaultHelp: async (context) => {
-        if (context.options instanceof core_2.Org) {
+        if (context.options instanceof Org) {
             const org = context.options;
             return org.getUsername();
         }
-        return (await (0, exports.maybeGetHub)())?.getUsername();
+        return (await maybeGetHub())?.getUsername();
     },
     required: false,
 });

package/lib/flags/salesforceId.d.ts

@@ -30,7 +30,7 @@ export type IdFlagConfig = {
  * }
  * ```
  */
-export declare const salesforceIdFlag: import("@oclif/core/lib/interfaces").FlagDefinition<string, IdFlagConfig, {
+export declare const salesforceIdFlag: import("@oclif/core/lib/interfaces/parser.js").FlagDefinition<string, IdFlagConfig, {
     multiple: false;
     requiredOrDefaulted: false;
 }>;

package/lib/flags/salesforceId.js

@@ -1,16 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.salesforceIdFlag = void 0;
 /*
  * Copyright (c) 2020, salesforce.com, inc.
  * All rights reserved.
  * 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
  */
-const core_1 = require("@oclif/core");
-const core_2 = require("@salesforce/core");
-core_2.Messages.importMessagesDirectory(__dirname);
-const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'messages');
+import { Flags } from '@oclif/core';
+import { Messages, validateSalesforceId } from '@salesforce/core';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/sf-plugins-core', 'messages');
 /**
  * Id flag with built-in validation.  Short character is `i`
  *
@@ -33,7 +30,7 @@ const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'me
  * }
  * ```
  */
-exports.salesforceIdFlag = core_1.Flags.custom({
+export const salesforceIdFlag = Flags.custom({
     // eslint-disable-next-line @typescript-eslint/require-await
     parse: async (input, _ctx, opts) => validate(input, opts),
     char: 'i',
@@ -47,7 +44,7 @@ const validate = (input, config) => {
             allowedIdLength.join(` ${messages.getMessage('errors.InvalidIdLength.or')} `),
         ]);
     }
-    if (!(0, core_2.validateSalesforceId)(input)) {
+    if (!validateSalesforceId(input)) {
         throw messages.createError('errors.InvalidId');
     }
     if (startsWith && !input.startsWith(startsWith)) {

package/lib/prompts.d.ts

@@ -0,0 +1,13 @@
+export type PromptInputs<T> = {
+    /** text to display.  Do not include a question mark */
+    message: string;
+    /** after this many ms, the prompt will time out.  If a default value is provided, the default will be used.  Otherwise the prompt will throw an error */
+    ms?: number;
+    /**
+     * default value to offer to the user.  Will be used if the user does not respond within the timeout period.
+     */
+    defaultAnswer?: T;
+};
+export declare const confirm: ({ message, ms, defaultAnswer, }: PromptInputs<boolean>) => Promise<boolean>;
+export declare const secretPrompt: ({ message, ms }: PromptInputs<string>) => Promise<string>;
+//# sourceMappingURL=prompts.d.ts.map

package/lib/prompts.js

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * 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
+ */
+import { setTimeout } from 'node:timers/promises';
+import { SfError } from '@salesforce/core';
+export const confirm = async ({ message, ms = 10000, defaultAnswer = false, }) => {
+    const promptConfirm = (await import('@inquirer/confirm')).default;
+    const answer = promptConfirm({ message, default: defaultAnswer });
+    return Promise.race([answer, handleTimeout(answer, ms, defaultAnswer)]);
+};
+export const secretPrompt = async ({ message, ms = 60000 }) => {
+    const promptSecret = (await import('@inquirer/password')).default;
+    const answer = promptSecret({ message });
+    return Promise.race([answer, handleTimeout(answer, ms)]);
+};
+const handleTimeout = async (answer, ms, defaultAnswer) => setTimeout(ms, undefined, { ref: false }).then(() => {
+    answer.cancel();
+    if (typeof defaultAnswer !== 'undefined')
+        return defaultAnswer;
+    throw new SfError('Prompt timed out.');
+});
+//# sourceMappingURL=prompts.js.map

package/lib/sfCommand.d.ts

@@ -1,19 +1,16 @@
-import { ux, Command, Config, HelpSection } from '@oclif/core';
-import { SfProject, StructuredMessage, SfError, ConfigAggregator } from '@salesforce/core';
-import { AnyJson } from '@salesforce/ts-types';
-import * as chalk from 'chalk';
-import { Progress, Prompter, Spinner, Ux } from './ux';
+import { Command, Config, HelpSection } from '@oclif/core';
+import { SfProject, SfError, ConfigAggregator } from '@salesforce/core';
+import type { AnyJson } from '@salesforce/ts-types';
+import { Progress } from './ux/progress.js';
+import { Spinner } from './ux/spinner.js';
+import { Ux } from './ux/ux.js';
+import { SfCommand as ns } from './sfCommandNamespace.js';
+import { PromptInputs } from './prompts.js';
 export interface SfCommandInterface extends Command.Class {
     configurationVariablesSection?: HelpSection;
     envVariablesSection?: HelpSection;
     errorCodes?: HelpSection;
 }
-export declare const StandardColors: {
-    error: chalk.Chalk;
-    warning: chalk.Chalk;
-    info: chalk.Chalk;
-    success: chalk.Chalk;
-};
 /**
  * A base command that provided common functionality for all sf commands.
  * Functionality includes:
@@ -46,7 +43,6 @@ export declare const StandardColors: {
  * ```
  */
 export declare abstract class SfCommand<T> extends Command {
-    static SF_ENV: string;
     static enableJsonFlag: boolean;
     /**
      * Add a CONFIGURATION VARIABLES section to the help output.
@@ -97,21 +93,6 @@ export declare abstract class SfCommand<T> extends Command {
      * ```
      */
     static errorCodes?: HelpSection;
-    /**
-     * Flags that you can use for manipulating tables.
-     *
-     * @example
-     * ```
-     * import { SfCommand } from '@salesforce/sf-plugins-core';
-     * export default class MyCommand extends SfCommand {
-     *   public static flags = {
-     *    ...SfCommand.tableFags,
-     *    'my-flags: flags.string({ char: 'm', description: 'my flag' }),
-     *   }
-     * }
-     * ```
-     */
-    static tableFlags: typeof ux.Table.table.flags;
     /**
      * Set to true if the command must be executed inside a Salesforce project directory.
      *
@@ -128,14 +109,13 @@ export declare abstract class SfCommand<T> extends Command {
      * Add a progress bar to the console. {@link Progress}
      */
     progress: Progress;
-    project: SfProject;
+    project?: SfProject;
     /**
      * ConfigAggregator instance for accessing global and local configuration.
      */
     configAggregator: ConfigAggregator;
     private warnings;
     private ux;
-    private prompter;
     private lifecycle;
     constructor(argv: string[], config: Config);
     protected get statics(): typeof SfCommand;
@@ -151,13 +131,13 @@ export declare abstract class SfCommand<T> extends Command {
      *
      * @param input {@link SfCommand.Warning} The message to log.
      */
-    warn(input: SfCommand.Warning): SfCommand.Warning;
+    warn(input: ns.Warning): ns.Warning;
     /**
      * Log info message to users.
      *
      * @param input {@link SfCommand.Info} The message to log.
      */
-    info(input: SfCommand.Info): void;
+    info(input: ns.Info): void;
     /**
      * Warn user about sensitive information (access tokens, etc...) before logging to the console.
      *
@@ -195,82 +175,34 @@ export declare abstract class SfCommand<T> extends Command {
     styledHeader(text: string): void;
     logJson(json: AnyJson | unknown): void;
     /**
-     * Prompt user for information. See https://www.npmjs.com/package/inquirer for more.
-     *
-     * This will NOT be automatically suppressed when the --json flag is present since we assume
-     * that any command that prompts the user for required information will not also support the --json flag.
+     * Prompt user for yes/no confirmation.
+     * Avoid calling in --json scenarios and always provide a `--no-prompt` option for scripting
      *
-     * If you need to conditionally suppress prompts to support json output, then do the following:
+     * @param message text to display.  Do not include a question mark.
+     * @param ms milliseconds to wait for user input.  Defaults to 60s.  Will throw an error when timeout is reached.
      *
-     * @example
-     * if (!this.jsonEnabled()) {
-     *   await this.prompt();
-     * }
      */
-    prompt<R extends Prompter.Answers>(questions: Prompter.Questions<R>, initialAnswers?: Partial<R>): Promise<R>;
+    secretPrompt({ message, ms }: PromptInputs<string>): Promise<string>;
     /**
-     * Simplified prompt for single-question confirmation. Times out and throws after 10s
+     * Prompt user for yes/no confirmation.
+     * Avoid calling in --json scenarios and always provide a `--no-prompt` option for scripting
+     *
+     * @param message text to display.  Do not include a question mark or Y/N.
+     * @param ms milliseconds to wait for user input.  Defaults to 10s.  Will use the default value when timeout is reached.
+     * @param defaultAnswer boolean to set the default answer to.  Defaults to false.
      *
-     * @param message text to display.  Do not include a question mark.
-     * @param ms milliseconds to wait for user input.  Defaults to 10s.
-     * @param defaultAnswer boolean to set the default answer to.  Defaults to true.
-     * @return true if the user confirms, false if they do not.
-     */
-    confirm(message: string, ms?: number, defaultAnswer?: boolean): Promise<boolean>;
-    /**
-     * Prompt user for information with a timeout (in milliseconds). See https://www.npmjs.com/package/inquirer for more.
      */
-    timedPrompt<R extends Prompter.Answers>(questions: Prompter.Questions<R>, ms?: number, initialAnswers?: Partial<R>): Promise<R>;
+    confirm({ message, ms, defaultAnswer }: PromptInputs<boolean>): Promise<boolean>;
     _run<R>(): Promise<R>;
     /**
      * Wrap the command result into the standardized JSON structure.
      */
-    protected toSuccessJson(result: T): SfCommand.Json<T>;
+    protected toSuccessJson(result: T): ns.Json<T>;
     /**
      * Wrap the command error into the standardized JSON structure.
      */
-    protected toErrorJson(error: SfCommand.Error): SfCommand.Error;
-    protected assignProject(): Promise<SfProject>;
-    protected catch(error: Error | SfError | SfCommand.Error): Promise<SfCommand.Error>;
-    /**
-     * Format errors and actions for human consumption. Adds 'Error (<ErrorCode>):',
-     * When there are actions, we add 'Try this:' in blue
-     * followed by each action in red on its own line.
-     * If Error.code is present it is output last in parentheses
-     *
-     * @returns {string} Returns decorated messages.
-     */
-    protected formatError(error: SfCommand.Error): string;
-    /**
-     * Utility function to format actions lines
-     *
-     * @param actions
-     * @param options
-     * @private
-     */
-    private formatActions;
+    protected toErrorJson(error: ns.Error): ns.Error;
+    protected catch(error: Error | SfError | ns.Error): Promise<never>;
     abstract run(): Promise<T>;
 }
-export declare namespace SfCommand {
-    type Info = StructuredMessage | string;
-    type Warning = StructuredMessage | string;
-    interface Json<T> {
-        status: number;
-        result: T;
-        warnings?: Warning[];
-    }
-    interface Error {
-        status: number;
-        name: string;
-        message: string;
-        stack: string | undefined;
-        warnings?: Warning[];
-        actions?: string[];
-        code?: unknown;
-        exitCode?: number;
-        data?: unknown;
-        context?: string;
-        commandName?: string;
-    }
-}
 //# sourceMappingURL=sfCommand.d.ts.map