@salesforce/sf-plugins-core 2.1.3 → 2.2.1

package/lib/exported.d.ts

@@ -3,11 +3,12 @@ import { Flags as OclifFlags } from '@oclif/core';
 export { toHelpSection, parseVarArgs } from './util';
 export { Deployable, Deployer, DeployerResult } from './deployer';
 export { Deauthorizer } from './deauthorizer';
-export { Progress, Prompter, generateTableChoices, Ux } from './ux';
+export { Progress, Prompter, generateTableChoices, Ux, Spinner } from './ux';
 export { SfHook } from './hooks';
 export * from './types';
 export { SfCommand, SfCommandInterface, StandardColors } from './sfCommand';
 export * from './compatibility';
+export * from './stubUx';
 export declare const Flags: {
     boolean: typeof OclifFlags.boolean;
     directory: import("@oclif/core/lib/interfaces/parser").FlagDefinition<string, {

package/lib/exported.js

@@ -20,7 +20,7 @@ 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.Ux = exports.generateTableChoices = exports.Prompter = exports.Progress = exports.Deauthorizer = exports.Deployer = exports.Deployable = exports.parseVarArgs = exports.toHelpSection = void 0;
+exports.Flags = exports.StandardColors = exports.SfCommand = exports.SfHook = exports.Spinner = exports.Ux = 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; } });
@@ -35,6 +35,7 @@ Object.defineProperty(exports, "Progress", { enumerable: true, get: function ()
 Object.defineProperty(exports, "Prompter", { enumerable: true, get: function () { return ux_1.Prompter; } });
 Object.defineProperty(exports, "generateTableChoices", { enumerable: true, get: function () { return ux_1.generateTableChoices; } });
 Object.defineProperty(exports, "Ux", { enumerable: true, get: function () { return ux_1.Ux; } });
+Object.defineProperty(exports, "Spinner", { enumerable: true, get: function () { return ux_1.Spinner; } });
 var hooks_1 = require("./hooks");
 Object.defineProperty(exports, "SfHook", { enumerable: true, get: function () { return hooks_1.SfHook; } });
 __exportStar(require("./types"), exports);
@@ -42,6 +43,7 @@ var sfCommand_1 = require("./sfCommand");
 Object.defineProperty(exports, "SfCommand", { enumerable: true, get: function () { return sfCommand_1.SfCommand; } });
 Object.defineProperty(exports, "StandardColors", { enumerable: true, get: function () { return sfCommand_1.StandardColors; } });
 __exportStar(require("./compatibility"), exports);
+__exportStar(require("./stubUx"), exports);
 // custom flags
 const orgFlags_1 = require("./flags/orgFlags");
 const salesforceId_1 = require("./flags/salesforceId");

package/lib/sfCommand.d.ts

@@ -251,6 +251,7 @@ export declare abstract class SfCommand<T> extends Command {
      * Wrap the command error into the standardized JSON structure.
      */
     protected toErrorJson(error: SfCommand.Error): SfCommand.Error;
+    protected logJson(json: AnyJson | unknown): void;
     protected assignProject(): Promise<SfProject>;
     protected catch(error: Error | SfError | SfCommand.Error): Promise<SfCommand.Error>;
     /**

package/lib/sfCommand.js

@@ -235,6 +235,13 @@ class SfCommand extends core_1.Command {
         };
     }
     // eslint-disable-next-line class-methods-use-this
+    logJson(json) {
+        // If `--json` is enabled, then the ux instance on the class will disable output, which
+        // means that the logJson method will not output anything. So, we need to create a new
+        // instance of the ux class that does not have output disabled in order to log the json.
+        new ux_1.Ux().styledJSON(json);
+    }
+    // eslint-disable-next-line class-methods-use-this
     async assignProject() {
         try {
             return await core_2.SfProject.resolve();
@@ -248,11 +255,18 @@ class SfCommand extends core_1.Command {
     }
     async catch(error) {
         // transform an unknown error into one that conforms to the interface
-        const codeFromError = error instanceof core_2.SfError ? error.exitCode : 1;
+        // @ts-expect-error because exitCode is not on Error
+        const codeFromError = error.exitCode ?? 1;
         process.exitCode ?? (process.exitCode = codeFromError);
-        const sfErrorProperties = error instanceof core_2.SfError
-            ? { data: error.data, actions: error.actions, code: codeFromError, context: error.context }
-            : {};
+        const sfErrorProperties = removeEmpty({
+            // @ts-expect-error because data is not on Error
+            data: error.data ?? null,
+            // @ts-expect-error because actions is not on Error
+            actions: error.actions ?? null,
+            code: codeFromError,
+            // @ts-expect-error because context is not on Error
+            context: error.context ?? null,
+        });
         const sfCommandError = {
             ...sfErrorProperties,
             ...{
@@ -264,13 +278,12 @@ class SfCommand extends core_1.Command {
             },
         };
         if (this.jsonEnabled()) {
-            core_1.ux.styledJSON(this.toErrorJson(sfCommandError));
+            this.logJson(this.toErrorJson(sfCommandError));
         }
         else {
-            // eslint-disable-next-line no-console
-            console.error(this.formatError(sfCommandError));
+            this.logToStderr(this.formatError(sfCommandError));
         }
-        return sfCommandError;
+        throw sfCommandError;
     }
     /**
      * Format errors and actions for human consumption. Adds 'Error (<ErrorCode>):',
@@ -329,4 +342,8 @@ SfCommand.enableJsonFlag = true;
  * ```
  */
 SfCommand.tableFlags = core_1.ux.table.flags;
+function removeEmpty(obj) {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    return Object.fromEntries(Object.entries(obj).filter(([_, v]) => v != null));
+}
 //# sourceMappingURL=sfCommand.js.map

package/lib/stubUx.d.ts

@@ -0,0 +1,37 @@
+import { SinonSandbox } from 'sinon';
+import { SfCommand } from './sfCommand';
+import { Prompter, Ux } from './ux';
+export declare function stubUx(sandbox: SinonSandbox): {
+    log: import("sinon").SinonStub<[message?: string | undefined, ...args: string[]], void>;
+    warn: import("sinon").SinonStub<[message: string | Error], void>;
+    table: import("sinon").SinonStub<[data: Ux.Table.Data[], columns: Ux.Table.Columns<Ux.Table.Data>, options?: import("@oclif/core/lib/cli-ux/styled/table").table.Options | undefined], void>;
+    url: import("sinon").SinonStub<[text: string, uri: string, params?: {} | undefined], void>;
+    styledHeader: import("sinon").SinonStub<[text: string], void>;
+    styledObject: import("sinon").SinonStub<[obj: import("@salesforce/ts-types").AnyJson, keys?: string[] | undefined], void>;
+    styledJSON: import("sinon").SinonStub<[obj: import("@salesforce/ts-types").AnyJson], void>;
+};
+export declare function stubSfCommandUx(sandbox: SinonSandbox): {
+    log: import("sinon").SinonStub<[message?: string | undefined, ...args: any[]], void>;
+    logToStderr: import("sinon").SinonStub<[message?: string | undefined, ...args: any[]], void>;
+    logSuccess: import("sinon").SinonStub<[message: string], void>;
+    logSensitive: import("sinon").SinonStub<[msg?: string | undefined], void>;
+    info: import("sinon").SinonStub<[input: SfCommand.Info], void>;
+    warn: import("sinon").SinonStub<[input: SfCommand.Warning], SfCommand.Warning>;
+    table: import("sinon").SinonStub<[data: Ux.Table.Data[], columns: Ux.Table.Columns<Ux.Table.Data>, options?: import("@oclif/core/lib/cli-ux/styled/table").table.Options | undefined], void>;
+    url: import("sinon").SinonStub<[text: string, uri: string, params?: {} | undefined], void>;
+    styledHeader: import("sinon").SinonStub<[text: string], void>;
+    styledObject: import("sinon").SinonStub<[obj: import("@salesforce/ts-types").AnyJson], void>;
+    styledJSON: import("sinon").SinonStub<[obj: import("@salesforce/ts-types").AnyJson], void>;
+};
+export declare function stubSpinner(sandbox: SinonSandbox): {
+    start: import("sinon").SinonStub<[action: string, status?: string | undefined, opts?: {
+        stdout?: boolean | undefined;
+    } | undefined], void>;
+    stop: import("sinon").SinonStub<[msg?: string | undefined], void>;
+};
+export declare function stubPrompter(sandbox: SinonSandbox): {
+    prompt: import("sinon").SinonStub<[questions: Prompter.Questions<Record<string, unknown>>, initialAnswers?: Partial<Record<string, unknown>> | undefined], Promise<Record<string, unknown>>>;
+    confirm: import("sinon").SinonStub<[message: string, ms?: number | undefined, defaultAnswer?: boolean | undefined], Promise<boolean>>;
+    timedPrompt: import("sinon").SinonStub<[questions: Prompter.Questions<Record<string, unknown>>, ms?: number | undefined, initialAnswers?: Partial<Record<string, unknown>> | undefined], Promise<Record<string, unknown>>>;
+};
+//# sourceMappingURL=stubUx.d.ts.map

package/lib/stubUx.js

@@ -0,0 +1,55 @@
+"use strict";
+/*
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stubPrompter = exports.stubSpinner = exports.stubSfCommandUx = exports.stubUx = void 0;
+const sfCommand_1 = require("./sfCommand");
+const ux_1 = require("./ux");
+function stubUx(sandbox) {
+    return {
+        log: sandbox.stub(ux_1.Ux.prototype, 'log'),
+        warn: sandbox.stub(ux_1.Ux.prototype, 'warn'),
+        table: sandbox.stub(ux_1.Ux.prototype, 'table'),
+        url: sandbox.stub(ux_1.Ux.prototype, 'url'),
+        styledHeader: sandbox.stub(ux_1.Ux.prototype, 'styledHeader'),
+        styledObject: sandbox.stub(ux_1.Ux.prototype, 'styledObject'),
+        styledJSON: sandbox.stub(ux_1.Ux.prototype, 'styledJSON'),
+    };
+}
+exports.stubUx = stubUx;
+function stubSfCommandUx(sandbox) {
+    return {
+        log: sandbox.stub(sfCommand_1.SfCommand.prototype, 'log'),
+        logToStderr: sandbox.stub(sfCommand_1.SfCommand.prototype, 'logToStderr'),
+        logSuccess: sandbox.stub(sfCommand_1.SfCommand.prototype, 'logSuccess'),
+        logSensitive: sandbox.stub(sfCommand_1.SfCommand.prototype, 'logSensitive'),
+        info: sandbox.stub(sfCommand_1.SfCommand.prototype, 'info'),
+        warn: sandbox.stub(sfCommand_1.SfCommand.prototype, 'warn'),
+        table: sandbox.stub(sfCommand_1.SfCommand.prototype, 'table'),
+        url: sandbox.stub(sfCommand_1.SfCommand.prototype, 'url'),
+        styledHeader: sandbox.stub(sfCommand_1.SfCommand.prototype, 'styledHeader'),
+        styledObject: sandbox.stub(sfCommand_1.SfCommand.prototype, 'styledObject'),
+        styledJSON: sandbox.stub(sfCommand_1.SfCommand.prototype, 'styledJSON'),
+    };
+}
+exports.stubSfCommandUx = stubSfCommandUx;
+function stubSpinner(sandbox) {
+    return {
+        start: sandbox.stub(ux_1.Spinner.prototype, 'start'),
+        stop: sandbox.stub(ux_1.Spinner.prototype, 'stop'),
+    };
+}
+exports.stubSpinner = stubSpinner;
+function stubPrompter(sandbox) {
+    return {
+        prompt: sandbox.stub(ux_1.Prompter.prototype, 'prompt'),
+        confirm: sandbox.stub(ux_1.Prompter.prototype, 'confirm'),
+        timedPrompt: sandbox.stub(ux_1.Prompter.prototype, 'timedPrompt'),
+    };
+}
+exports.stubPrompter = stubPrompter;
+//# sourceMappingURL=stubUx.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "2.1.3",
+  "version": "2.2.1",
   "description": "Utils for writing Salesforce CLI plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",