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

package/lib/util.js

@@ -1,15 +1,10 @@
-"use strict";
 /*
  * Copyright (c) 2022, 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
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseVarArgs = exports.toHelpSection = void 0;
-const core_1 = require("@salesforce/core");
-core_1.Messages.importMessagesDirectory(__dirname);
-const messages = core_1.Messages.loadMessages('@salesforce/sf-plugins-core', 'messages');
+import { ORG_CONFIG_ALLOWED_PROPERTIES, SFDX_ALLOWED_PROPERTIES, SUPPORTED_ENV_VARS, Messages, } from '@salesforce/core';
 /**
  * Function to build a help section for command help.
  * Takes a string to be used as section header text and an array of enums
@@ -19,19 +14,19 @@ const messages = core_1.Messages.loadMessages('@salesforce/sf-plugins-core', 'me
  * @param header
  * @param vars
  */
-function toHelpSection(header, ...vars) {
+export function toHelpSection(header, ...vars) {
     const body = vars
         .flatMap((v) => {
         if (typeof v === 'string') {
-            const orgConfig = core_1.ORG_CONFIG_ALLOWED_PROPERTIES.find(({ key }) => key.toString() === v);
+            const orgConfig = ORG_CONFIG_ALLOWED_PROPERTIES.find(({ key }) => key.toString() === v);
             if (orgConfig) {
                 return { name: orgConfig.key, description: orgConfig.description };
             }
-            const sfdxProperty = core_1.SFDX_ALLOWED_PROPERTIES.find(({ key }) => key.toString() === v);
+            const sfdxProperty = SFDX_ALLOWED_PROPERTIES.find(({ key }) => key.toString() === v);
             if (sfdxProperty) {
                 return { name: sfdxProperty.key.valueOf(), description: sfdxProperty.description };
             }
-            const envVar = Object.entries(core_1.SUPPORTED_ENV_VARS).find(([k]) => k === v);
+            const envVar = Object.entries(SUPPORTED_ENV_VARS).find(([k]) => k === v);
             if (envVar) {
                 const [eKey, data] = envVar;
                 return { name: eKey, description: data.description };
@@ -45,9 +40,8 @@ function toHelpSection(header, ...vars) {
         .filter(isHelpSectionBodyEntry);
     return { header, body };
 }
-exports.toHelpSection = toHelpSection;
 const isHelpSectionBodyEntry = (entry) => typeof entry === 'object' && entry !== null && 'name' in entry && 'description' in entry;
-function parseVarArgs(args, argv) {
+export function parseVarArgs(args, argv) {
     const final = {};
     const argVals = Object.values(args);
     // Remove arguments from varargs
@@ -56,6 +50,8 @@ function parseVarArgs(args, argv) {
     if (varargs.length === 2 && !varargs[0].includes('=')) {
         return { [varargs[0]]: varargs[1] };
     }
+    Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+    const messages = Messages.loadMessages('@salesforce/sf-plugins-core', 'messages');
     // Ensure that all args are in the right format (e.g. key=value key1=value1)
     varargs.forEach((arg) => {
         const split = arg.split('=');
@@ -70,5 +66,5 @@ function parseVarArgs(args, argv) {
     });
     return final;
 }
-exports.parseVarArgs = parseVarArgs;
+export const removeEmpty = (obj) => Object.fromEntries(Object.entries(obj).filter(([, v]) => v != null));
 //# sourceMappingURL=util.js.map

package/lib/ux/base.d.ts

@@ -1,4 +1,4 @@
-import { AnyFunction } from '@salesforce/ts-types';
+import type { AnyFunction } from '@salesforce/ts-types';
 export declare class UxBase {
     readonly outputEnabled: boolean;
     constructor(outputEnabled: boolean);

package/lib/ux/base.js

@@ -1,13 +1,11 @@
-"use strict";
 /*
  * Copyright (c) 2022, 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
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UxBase = void 0;
-class UxBase {
+export class UxBase {
+    outputEnabled;
     constructor(outputEnabled) {
         this.outputEnabled = outputEnabled;
     }
@@ -16,5 +14,4 @@ class UxBase {
             fn();
     }
 }
-exports.UxBase = UxBase;
 //# sourceMappingURL=base.js.map

package/lib/ux/progress.d.ts

@@ -1,4 +1,4 @@
-import { UxBase } from '.';
+import { UxBase } from './base.js';
 /**
  * Class for display a progress bar to the console. Will automatically be suppressed if the --json flag is present.
  */

package/lib/ux/progress.js

@@ -1,22 +1,28 @@
-"use strict";
 /*
  * Copyright (c) 2022, 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
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Progress = void 0;
-const util = require("node:util");
-const core_1 = require("@oclif/core");
-const _1 = require(".");
+import * as util from 'node:util';
+import { ux } from '@oclif/core';
+import { UxBase } from './base.js';
 /**
  * Class for display a progress bar to the console. Will automatically be suppressed if the --json flag is present.
  */
-class Progress extends _1.UxBase {
+export class Progress extends UxBase {
+    static DEFAULT_OPTIONS = {
+        title: 'PROGRESS',
+        format: '%s | {bar} | {value}/{total} Components',
+        barCompleteChar: '\u2588',
+        barIncompleteChar: '\u2591',
+        linewrap: true,
+    };
+    bar;
+    total;
+    started = false;
     constructor(outputEnabled) {
         super(outputEnabled);
-        this.started = false;
     }
     /**
      * Set the total number of expected components.
@@ -35,7 +41,7 @@ class Progress extends _1.UxBase {
         this.started = true;
         this.maybeNoop(() => {
             const { title, ...rest } = { ...Progress.DEFAULT_OPTIONS, ...options };
-            this.bar = core_1.ux.progress({
+            this.bar = ux.progress({
                 ...rest,
                 format: util.format(rest.format, title),
             });
@@ -70,12 +76,4 @@ class Progress extends _1.UxBase {
             this.bar.stop();
     }
 }
-exports.Progress = Progress;
-Progress.DEFAULT_OPTIONS = {
-    title: 'PROGRESS',
-    format: '%s | {bar} | {value}/{total} Components',
-    barCompleteChar: '\u2588',
-    barIncompleteChar: '\u2591',
-    linewrap: true,
-};
 //# sourceMappingURL=progress.js.map

package/lib/ux/prompts.d.ts

@@ -0,0 +1,17 @@
+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>;
+export declare const prompts: {
+    confirm: ({ message, ms, defaultAnswer, }: PromptInputs<boolean>) => Promise<boolean>;
+    secretPrompt: ({ message, ms }: PromptInputs<string>) => Promise<string>;
+};
+//# sourceMappingURL=prompts.d.ts.map

package/lib/ux/prompts.js

@@ -0,0 +1,26 @@
+/*
+ * 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.');
+});
+export const prompts = { confirm, secretPrompt };
+//# sourceMappingURL=prompts.js.map

package/lib/ux/spinner.d.ts

@@ -1,4 +1,4 @@
-import { UxBase } from '.';
+import { UxBase } from './base.js';
 /**
  * This class is a light wrapper around ux.action that allows us to
  * automatically suppress any actions if `--json` flag is present.

package/lib/ux/spinner.js

@@ -1,19 +1,16 @@
-"use strict";
 /*
  * Copyright (c) 2022, 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
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Spinner = void 0;
-const core_1 = require("@oclif/core");
-const _1 = require(".");
+import { ux } from '@oclif/core';
+import { UxBase } from './base.js';
 /**
  * This class is a light wrapper around ux.action that allows us to
  * automatically suppress any actions if `--json` flag is present.
  */
-class Spinner extends _1.UxBase {
+export class Spinner extends UxBase {
     constructor(outputEnabled) {
         super(outputEnabled);
     }
@@ -22,33 +19,32 @@ class Spinner extends _1.UxBase {
      */
     // eslint-disable-next-line class-methods-use-this
     get status() {
-        return core_1.ux.action.status;
+        return ux.action.status;
     }
     /**
      * Set the status of the current spinner.
      */
     // eslint-disable-next-line class-methods-use-this
     set status(status) {
-        core_1.ux.action.status = status;
+        ux.action.status = status;
     }
     /**
      * Start a spinner on the console.
      */
     start(action, status, opts) {
-        this.maybeNoop(() => core_1.ux.action.start(action, status, opts));
+        this.maybeNoop(() => ux.action.start(action, status, opts));
     }
     /**
      * Stop the spinner on the console.
      */
     stop(msg) {
-        this.maybeNoop(() => core_1.ux.action.stop(msg));
+        this.maybeNoop(() => ux.action.stop(msg));
     }
     /**
      * Pause the spinner on the console.
      */
     pause(fn, icon) {
-        this.maybeNoop(() => core_1.ux.action.pause(fn, icon));
+        this.maybeNoop(() => ux.action.pause(fn, icon));
     }
 }
-exports.Spinner = Spinner;
 //# sourceMappingURL=spinner.js.map

package/lib/ux/standardColors.d.ts

@@ -0,0 +1,7 @@
+export declare const StandardColors: {
+    error: import("chalk").ChalkInstance;
+    warning: import("chalk").ChalkInstance;
+    info: import("chalk").ChalkInstance;
+    success: import("chalk").ChalkInstance;
+};
+//# sourceMappingURL=standardColors.d.ts.map

package/lib/ux/standardColors.js

@@ -0,0 +1,14 @@
+/*
+ * 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 chalk from 'chalk';
+export const StandardColors = {
+    error: chalk.bold.red,
+    warning: chalk.bold.yellow,
+    info: chalk.dim,
+    success: chalk.bold.green,
+};
+//# sourceMappingURL=standardColors.js.map

package/lib/ux/ux.d.ts

@@ -1,8 +1,7 @@
 import { ux } from '@oclif/core';
 import { AnyJson } from '@salesforce/ts-types';
-import { UxBase } from './base';
-import { Prompter } from './prompter';
-import { Spinner } from './spinner';
+import { UxBase } from './base.js';
+import { Spinner } from './spinner.js';
 /**
  * UX methods for plugins. Automatically suppress console output if outputEnabled is set to false.
  *
@@ -21,7 +20,6 @@ import { Spinner } from './spinner';
  */
 export declare class Ux extends UxBase {
     readonly spinner: Spinner;
-    readonly prompter: Prompter;
     readonly outputEnabled: boolean;
     constructor({ jsonEnabled }?: {
         jsonEnabled: boolean;

package/lib/ux/ux.js

@@ -1,16 +1,12 @@
-"use strict";
 /*
  * Copyright (c) 2022, 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
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Ux = void 0;
-const core_1 = require("@oclif/core");
-const base_1 = require("./base");
-const prompter_1 = require("./prompter");
-const spinner_1 = require("./spinner");
+import { ux } from '@oclif/core';
+import { UxBase } from './base.js';
+import { Spinner } from './spinner.js';
 /**
  * UX methods for plugins. Automatically suppress console output if outputEnabled is set to false.
  *
@@ -27,12 +23,13 @@ const spinner_1 = require("./spinner");
  *
  * ```
  */
-class Ux extends base_1.UxBase {
+export class Ux extends UxBase {
+    spinner;
+    outputEnabled;
     constructor({ jsonEnabled } = { jsonEnabled: false }) {
         super(!jsonEnabled);
         this.outputEnabled = !jsonEnabled;
-        this.spinner = new spinner_1.Spinner(this.outputEnabled);
-        this.prompter = new prompter_1.Prompter();
+        this.spinner = new Spinner(this.outputEnabled);
     }
     /**
      * Log a message to the console. This will be automatically suppressed if output is disabled.
@@ -41,7 +38,7 @@ class Ux extends base_1.UxBase {
      * @param args Args to be used for formatting.
      */
     log(message, ...args) {
-        this.maybeNoop(() => core_1.ux.log(message, ...args));
+        this.maybeNoop(() => ux.log(message, ...args));
     }
     /**
      * Log a warning message to the console. This will be automatically suppressed if output is disabled.
@@ -49,7 +46,7 @@ class Ux extends base_1.UxBase {
      * @param message Warning message to log.
      */
     warn(message) {
-        this.maybeNoop(() => core_1.ux.warn(message));
+        this.maybeNoop(() => ux.warn(message));
     }
     /**
      * Display a table to the console. This will be automatically suppressed if output is disabled.
@@ -59,7 +56,7 @@ class Ux extends base_1.UxBase {
      * @param options Options for how the table should be displayed
      */
     table(data, columns, options) {
-        this.maybeNoop(() => core_1.ux.table(data, columns, { 'no-truncate': true, ...options }));
+        this.maybeNoop(() => ux.table(data, columns, { 'no-truncate': true, ...options }));
     }
     /**
      * Display a url to the console. This will be automatically suppressed if output is disabled.
@@ -69,7 +66,7 @@ class Ux extends base_1.UxBase {
      * @param params
      */
     url(text, uri, params = {}) {
-        this.maybeNoop(() => core_1.ux.url(text, uri, params));
+        this.maybeNoop(() => ux.url(text, uri, params));
     }
     /**
      * Display stylized JSON to the console. This will be automatically suppressed if output is disabled.
@@ -77,7 +74,7 @@ class Ux extends base_1.UxBase {
      * @param obj JSON to display
      */
     styledJSON(obj) {
-        this.maybeNoop(() => core_1.ux.styledJSON(obj));
+        this.maybeNoop(() => ux.styledJSON(obj));
     }
     /**
      * Display stylized object to the console. This will be automatically suppressed if output is disabled.
@@ -86,7 +83,7 @@ class Ux extends base_1.UxBase {
      * @param keys Keys of object to display
      */
     styledObject(obj, keys) {
-        this.maybeNoop(() => core_1.ux.styledObject(obj, keys));
+        this.maybeNoop(() => ux.styledObject(obj, keys));
     }
     /**
      * Display stylized header to the console. This will be automatically suppressed if output is disabled.
@@ -94,8 +91,7 @@ class Ux extends base_1.UxBase {
      * @param text header to display
      */
     styledHeader(text) {
-        this.maybeNoop(() => core_1.ux.styledHeader(text));
+        this.maybeNoop(() => ux.styledHeader(text));
     }
 }
-exports.Ux = Ux;
 //# sourceMappingURL=ux.js.map

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "5.0.13",
+  "version": "5.0.14-dev.1",
   "description": "Utils for writing Salesforce CLI plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
+  "type": "module",
   "license": "BSD-3-Clause",
   "scripts": {
     "build": "wireit",
@@ -21,6 +22,13 @@
     "test": "wireit",
     "test:only": "wireit"
   },
+  "exports": {
+    "./SfCommand": "./lib/SfCommand.js",
+    "./Flags": "./lib/flags/flags.js",
+    "./Ux": "./lib/ux/ux.js",
+    "./StandardColors": "./lib/ux/standardColors.js",
+    ".": "./lib/exported.js"
+  },
   "repository": "salesforcecli/sf-plugins-core",
   "bugs": {
     "url": "https://github.com/salesforcecli/sf-plugins-core/issues"
@@ -35,22 +43,20 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@oclif/core": "^3.15.1",
-    "@salesforce/core": "^6.4.1",
+    "@inquirer/confirm": "^2.0.15",
+    "@inquirer/password": "^1.1.14",
+    "@oclif/core": "^3.16.0",
+    "@salesforce/core": "^6.4.2",
     "@salesforce/kit": "^3.0.15",
     "@salesforce/ts-types": "^2.0.9",
-    "@types/inquirer": "^8.2.3",
-    "chalk": "^4",
-    "inquirer": "^8.2.5"
+    "chalk": "^5.3.0"
   },
   "devDependencies": {
-    "@oclif/test": "^3.1.5",
-    "@salesforce/dev-scripts": "^8.1.2",
+    "@inquirer/type": "^1.1.5",
+    "@salesforce/dev-scripts": "^8.1.3",
     "eslint-plugin-sf-plugin": "^1.17.0",
-    "shelljs": "0.8.5",
-    "strip-ansi": "6.0.1",
     "ts-node": "^10.9.2",
-    "typescript": "^4.9.5"
+    "typescript": "^5.3.3"
   },
   "publishConfig": {
     "access": "public"

package/lib/deauthorizer.d.ts

@@ -1,22 +0,0 @@
-import { JsonMap } from '@salesforce/ts-types';
-/**
- * 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>;
-    /**
-     * This method should return a list of all the environments a deauthorizer could deauthorize.
-     */
-    abstract find(): Promise<Record<string, T>>;
-    /**
-     * This method should deauthorize an environment.
-     */
-    abstract remove(id: string): Promise<boolean>;
-}
-export declare namespace Deauthorizer {
-    type Result = {
-        successes: string[];
-        failures: string[];
-    };
-}
-//# sourceMappingURL=deauthorizer.d.ts.map

package/lib/deauthorizer.js

@@ -1,35 +0,0 @@
-"use strict";
-/*
- * Copyright (c) 2022, 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Deauthorizer = void 0;
-/**
- * The Deauthorizer is an abstract class that is used to implement a concrete implementation of deauthorizing an environment.
- */
-class Deauthorizer {
-    async removeAll() {
-        const result = {
-            successes: [],
-            failures: [],
-        };
-        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);
-            }
-            catch {
-                result.failures.push(id);
-            }
-        }
-        return result;
-    }
-}
-exports.Deauthorizer = Deauthorizer;
-//# sourceMappingURL=deauthorizer.js.map

package/lib/deployer.d.ts

@@ -1,81 +0,0 @@
-/// <reference types="node" />
-import { EventEmitter } from 'node:events';
-import { AnyJson, JsonMap } from '@salesforce/ts-types';
-import { QuestionCollection, Answers } from 'inquirer';
-export type DeployerResult = {
-    exitCode: number;
-};
-export declare abstract class Deployable {
-    abstract getName(): string;
-    abstract getType(): string;
-    abstract getPath(): string;
-    abstract getParent(): Deployer;
-}
-/**
- * Interface for deploying Deployables.
- */
-export declare abstract class Deployer extends EventEmitter {
-    /**
-     * Deployables are individual pieces that can be deployed on their own. For example,
-     * each package in a salesforce project is considered a deployable that can be deployed
-     * on its own.
-     */
-    deployables: Deployable[];
-    private prompter;
-    /**
-     * Method for displaying deploy progress to the user
-     */
-    progress(current: number, total: number, message: string): void;
-    /**
-     * Log messages to the console
-     */
-    log(msg?: string | undefined, ...args: string[]): void;
-    /**
-     * Prompt user for additional information
-     */
-    prompt<T extends Answers>(questions: QuestionCollection<T>, initialAnswers?: Partial<T>): Promise<T>;
-    /**
-     * Overwrite the deployables property on the class.
-     */
-    selectDeployables(deployables: Deployable[]): void;
-    /**
-     * The human readable name of the deployer
-     */
-    abstract getName(): string;
-    /**
-     * Perform any initialization or setup. This is the time to prompt the
-     * user for any needed information.
-     *
-     * If options are passed it, it should use those instead of prompting the for the passed in information
-     *
-     * Uses the returned dictionary as the information to store in the deploy-options.json file.
-     */
-    abstract setup(flags: Deployer.Flags, options: Deployer.Options): Promise<Deployer.Options>;
-    /**
-     * Deploy the app.
-     */
-    abstract deploy<R extends DeployerResult>(): Promise<void | R>;
-}
-export declare namespace Deployer {
-    type Flags = {
-        interactive: boolean;
-    };
-    /**
-     * This interface represents the aggregation of all deployer options, e.g.
-     *
-     * @example
-     * ```
-     * {
-     *   'Salesforce Apps': {
-     *      testLevel: 'RunLocalTests',
-     *      apps: ['force-app'],
-     *    },
-     *   'Salesforce Functions': { username: 'user@salesforce.com' },
-     * }
-     * ```
-     */
-    type Options<T = AnyJson> = JsonMap & {
-        [key: string]: T | undefined;
-    };
-}
-//# sourceMappingURL=deployer.d.ts.map