@salesforce/sf-plugins-core 1.22.2 → 2.0.0-beta.2

package/lib/compatibility.d.ts

@@ -14,7 +14,7 @@
  * }
  * ```
  */
-export declare const orgApiVersionFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+export declare const orgApiVersionFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, Record<string, unknown>>;
 /**
  * Use only for commands that maintain sfdx compatibility.
  * Flag will be hidden and will show a warning if used.
@@ -23,23 +23,23 @@ export declare const orgApiVersionFlagWithDeprecations: import("@oclif/core/lib/
  * @deprecated
  *
  */
-export declare const loglevel: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+export declare const loglevel: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, Record<string, unknown>>;
 /**
  * @deprecated
  */
-export declare const optionalOrgFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org | undefined>;
+export declare const optionalOrgFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org | undefined, Record<string, unknown>>;
 /**
  * @deprecated
  */
-export declare const requiredOrgFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org>;
+export declare const requiredOrgFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org, Record<string, unknown>>;
 /**
  * @deprecated
  */
-export declare const requiredHubFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org>;
+export declare const requiredHubFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org, Record<string, unknown>>;
 /**
  * @deprecated
  */
-export declare const optionalHubFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org | undefined>;
+export declare const optionalHubFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org | undefined, Record<string, unknown>>;
 export type ArrayWithDeprecationOptions = {
     multiple?: true;
     parse?: undefined;
@@ -47,5 +47,5 @@ export type ArrayWithDeprecationOptions = {
 /**
  * @deprecated
  */
-export declare const arrayWithDeprecation: import("@oclif/core/lib/interfaces").Definition<string[], ArrayWithDeprecationOptions>;
+export declare const arrayWithDeprecation: import("@oclif/core/lib/interfaces/parser").FlagDefinition<string[], ArrayWithDeprecationOptions>;
 //# sourceMappingURL=compatibility.d.ts.map

package/lib/deployer.js

@@ -38,7 +38,7 @@ class Deployer extends events_1.EventEmitter {
      */
     // eslint-disable-next-line class-methods-use-this
     log(msg, ...args) {
-        core_1.CliUx.ux.log(msg, ...args);
+        core_1.ux.log(msg, ...args);
     }
     /**
      * Prompt user for additional information

package/lib/exported.d.ts

@@ -10,25 +10,24 @@ export { SfCommand, SfCommandInterface, StandardColors } from './sfCommand';
 export * from './compatibility';
 export declare const Flags: {
     boolean: typeof OclifFlags.boolean;
-    directory: import("@oclif/core/lib/interfaces").Definition<string, {
+    directory: import("@oclif/core/lib/interfaces/parser").FlagDefinition<string, {
         exists?: boolean | undefined;
     }>;
-    enum: typeof OclifFlags._enum;
-    file: import("@oclif/core/lib/interfaces").Definition<string, {
+    file: import("@oclif/core/lib/interfaces/parser").FlagDefinition<string, {
         exists?: boolean | undefined;
     }>;
-    integer: import("@oclif/core/lib/interfaces").Definition<number, {
+    integer: import("@oclif/core/lib/interfaces/parser").FlagDefinition<number, {
         min?: number | undefined;
         max?: number | undefined;
     }>;
-    string: import("@oclif/core/lib/interfaces").Definition<string, Record<string, unknown>>;
-    url: import("@oclif/core/lib/interfaces").Definition<import("url").URL, Record<string, unknown>>;
-    duration: import("@oclif/core/lib/interfaces").Definition<import("@salesforce/kit").Duration, import("./flags/duration").DurationFlagConfig>;
-    salesforceId: import("@oclif/core/lib/interfaces").Definition<string, import("./flags/salesforceId").IdFlagConfig>;
-    orgApiVersion: import("@oclif/core/lib/interfaces").Definition<string, Record<string, unknown>>;
-    requiredOrg: import("@oclif/core/lib/interfaces").Definition<import("@salesforce/core").Org, Record<string, unknown>>;
-    requiredHub: import("@oclif/core/lib/interfaces").Definition<import("@salesforce/core").Org, Record<string, unknown>>;
-    optionalOrg: import("@oclif/core/lib/interfaces").Definition<import("@salesforce/core").Org | undefined, Record<string, unknown>>;
-    optionalHub: import("@oclif/core/lib/interfaces").Definition<import("@salesforce/core").Org | undefined, Record<string, unknown>>;
+    string: import("@oclif/core/lib/interfaces/parser").FlagDefinition<string, Record<string, unknown>>;
+    url: import("@oclif/core/lib/interfaces/parser").FlagDefinition<import("url").URL, Record<string, unknown>>;
+    duration: import("@oclif/core/lib/interfaces/parser").FlagDefinition<import("@salesforce/kit").Duration, import("./flags/duration").DurationFlagConfig>;
+    salesforceId: import("@oclif/core/lib/interfaces/parser").FlagDefinition<string, import("./flags/salesforceId").IdFlagConfig>;
+    orgApiVersion: import("@oclif/core/lib/interfaces/parser").FlagDefinition<string, Record<string, unknown>>;
+    requiredOrg: import("@oclif/core/lib/interfaces/parser").FlagDefinition<import("@salesforce/core").Org, Record<string, unknown>>;
+    requiredHub: import("@oclif/core/lib/interfaces/parser").FlagDefinition<import("@salesforce/core").Org, Record<string, unknown>>;
+    optionalOrg: import("@oclif/core/lib/interfaces/parser").FlagDefinition<import("@salesforce/core").Org | undefined, Record<string, unknown>>;
+    optionalHub: import("@oclif/core/lib/interfaces/parser").FlagDefinition<import("@salesforce/core").Org | undefined, Record<string, unknown>>;
 };
 //# sourceMappingURL=exported.d.ts.map

package/lib/exported.js

@@ -50,7 +50,6 @@ 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

@@ -26,6 +26,6 @@ export type DurationFlagConfig = {
  * }
  * ```
  */
-export declare const durationFlag: import("@oclif/core/lib/interfaces").Definition<Duration, DurationFlagConfig>;
+export declare const durationFlag: import("@oclif/core/lib/interfaces/parser").FlagDefinition<Duration, DurationFlagConfig>;
 export {};
 //# sourceMappingURL=duration.d.ts.map

package/lib/flags/orgApiVersion.d.ts

@@ -21,5 +21,5 @@ export declare const maxDeprecatedUrl = "https://help.salesforce.com/s/articleVi
  * }
  * ```
  */
-export declare const orgApiVersionFlag: import("@oclif/core/lib/interfaces").Definition<string, Record<string, unknown>>;
+export declare const orgApiVersionFlag: import("@oclif/core/lib/interfaces/parser").FlagDefinition<string, Record<string, unknown>>;
 //# sourceMappingURL=orgApiVersion.d.ts.map

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").Definition<Org | undefined, Record<string, unknown>>;
+export declare const optionalOrgFlag: import("@oclif/core/lib/interfaces/parser").FlagDefinition<Org | undefined, Record<string, unknown>>;
 /**
  * A required org, specified by username or alias
  * Will throw if the specified org default do not exist
@@ -48,7 +48,7 @@ export declare const optionalOrgFlag: import("@oclif/core/lib/interfaces").Defin
  * }
  * ```
  */
-export declare const requiredOrgFlag: import("@oclif/core/lib/interfaces").Definition<Org, Record<string, unknown>>;
+export declare const requiredOrgFlag: import("@oclif/core/lib/interfaces/parser").FlagDefinition<Org, Record<string, unknown>>;
 /**
  * A required org that is a devHub
  * Will throw if the specified org does not exist
@@ -71,7 +71,7 @@ export declare const requiredOrgFlag: import("@oclif/core/lib/interfaces").Defin
  * }
  * ```
  */
-export declare const requiredHubFlag: import("@oclif/core/lib/interfaces").Definition<Org, Record<string, unknown>>;
+export declare const requiredHubFlag: import("@oclif/core/lib/interfaces/parser").FlagDefinition<Org, Record<string, unknown>>;
 /**
  * An optional org that, if present, must be a devHub
  * Will throw if the specified org does not exist
@@ -93,5 +93,5 @@ export declare const requiredHubFlag: import("@oclif/core/lib/interfaces").Defin
  * }
  * ```
  */
-export declare const optionalHubFlag: import("@oclif/core/lib/interfaces").Definition<Org | undefined, Record<string, unknown>>;
+export declare const optionalHubFlag: import("@oclif/core/lib/interfaces/parser").FlagDefinition<Org | undefined, Record<string, unknown>>;
 //# sourceMappingURL=orgFlags.d.ts.map

package/lib/flags/salesforceId.d.ts

@@ -30,5 +30,5 @@ export type IdFlagConfig = {
  * }
  * ```
  */
-export declare const salesforceIdFlag: import("@oclif/core/lib/interfaces").Definition<string, IdFlagConfig>;
+export declare const salesforceIdFlag: import("@oclif/core/lib/interfaces/parser").FlagDefinition<string, IdFlagConfig>;
 //# sourceMappingURL=salesforceId.d.ts.map

package/lib/hooks.js

@@ -20,8 +20,8 @@ class SfHook {
         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}`);
-            core_1.CliUx.ux.debug(failure.error.toString());
+            core_1.ux.debug(`Failed to run ${hookName} hook for ${failure.plugin.name}`);
+            core_1.ux.debug(failure.error.toString());
         });
         return results;
     }

package/lib/sfCommand.d.ts

@@ -1,9 +1,9 @@
-import { CliUx, Command, Config, HelpSection, Interfaces } from '@oclif/core';
+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';
-export interface SfCommandInterface extends Interfaces.Command {
+export interface SfCommandInterface extends Command.Class {
     configurationVariablesSection?: HelpSection;
     envVariablesSection?: HelpSection;
     errorCodes?: HelpSection;
@@ -111,7 +111,7 @@ export declare abstract class SfCommand<T> extends Command {
      * }
      * ```
      */
-    static tableFlags: typeof CliUx.Table.table.flags;
+    static tableFlags: typeof ux.Table.table.flags;
     /**
      * Set to true if the command must be executed inside a Salesforce project directory.
      *

package/lib/sfCommand.js

@@ -263,7 +263,7 @@ class SfCommand extends core_1.Command {
             },
         };
         if (this.jsonEnabled()) {
-            core_1.CliUx.ux.styledJSON(this.toErrorJson(sfCommandError));
+            core_1.ux.styledJSON(this.toErrorJson(sfCommandError));
         }
         else {
             // eslint-disable-next-line no-console
@@ -327,5 +327,5 @@ SfCommand.enableJsonFlag = true;
  * }
  * ```
  */
-SfCommand.tableFlags = core_1.CliUx.ux.table.flags;
+SfCommand.tableFlags = core_1.ux.table.flags;
 //# sourceMappingURL=sfCommand.js.map

package/lib/ux/progress.d.ts

@@ -31,9 +31,8 @@ export declare class Progress extends UxBase {
 }
 export declare namespace Progress {
     type Bar = {
-        start: (num: number, payload?: unknown) => void;
-        update: (num: number, payload?: unknown) => void;
-        updateTotal: (num: number) => void;
+        start: (total: number, startValue: number, payload?: object) => void;
+        update: (num: number, payload?: object) => void;
         setTotal: (num: number) => void;
         stop: () => void;
     };

package/lib/ux/progress.js

@@ -36,14 +36,14 @@ class Progress extends _1.UxBase {
         this.maybeNoop(() => {
             const opts = Object.assign(Progress.DEFAULT_OPTIONS, options);
             opts.format = util.format(opts.format, opts.title);
-            this.bar = core_1.CliUx.ux.progress({
+            this.bar = core_1.ux.progress({
                 format: opts.format,
                 barCompleteChar: opts.barCompleteChar,
                 barIncompleteChar: opts.barIncompleteChar,
                 linewrap: opts.linewrap,
             });
             this.bar.setTotal(total);
-            this.bar.start(total);
+            this.bar.start(total, 0);
             if (Object.keys(payload).length) {
                 this.bar.update(0, payload);
             }

package/lib/ux/prompter.js

@@ -32,7 +32,7 @@ class Prompter {
                 // @ts-expect-error
                 // eslint-disable-next-line @typescript-eslint/no-unsafe-call
                 thePrompt.ui['activePrompt'].done();
-                core_1.CliUx.ux.log();
+                core_1.ux.log();
                 reject(new Error(`Timed out after ${ms} ms.`));
             }, ms).unref();
         });

package/lib/ux/spinner.d.ts

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

package/lib/ux/spinner.js

@@ -10,7 +10,7 @@ exports.Spinner = void 0;
 const core_1 = require("@oclif/core");
 const _1 = require(".");
 /**
- * This class is a light wrapper around CliUx.ux.action that allows us to
+ * 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 {
@@ -22,32 +22,32 @@ class Spinner extends _1.UxBase {
      */
     // eslint-disable-next-line class-methods-use-this
     get status() {
-        return core_1.CliUx.ux.action.status;
+        return core_1.ux.action.status;
     }
     /**
      * Set the status of the current spinner.
      */
     // eslint-disable-next-line class-methods-use-this
     set status(status) {
-        core_1.CliUx.ux.action.status = status;
+        core_1.ux.action.status = status;
     }
     /**
      * Start a spinner on the console.
      */
     start(action, status, opts) {
-        this.maybeNoop(() => core_1.CliUx.ux.action.start(action, status, opts));
+        this.maybeNoop(() => core_1.ux.action.start(action, status, opts));
     }
     /**
      * Stop the spinner on the console.
      */
     stop(msg) {
-        this.maybeNoop(() => core_1.CliUx.ux.action.stop(msg));
+        this.maybeNoop(() => core_1.ux.action.stop(msg));
     }
     /**
      * Pause the spinner on the console.
      */
     pause(fn, icon) {
-        this.maybeNoop(() => core_1.CliUx.ux.action.pause(fn, icon));
+        this.maybeNoop(() => core_1.ux.action.pause(fn, icon));
     }
 }
 exports.Spinner = Spinner;

package/lib/ux/ux.d.ts

@@ -1,4 +1,4 @@
-import { CliUx } from '@oclif/core';
+import { ux } from '@oclif/core';
 import { AnyJson } from '@salesforce/ts-types';
 import { UxBase } from './base';
 import { Prompter } from './prompter';
@@ -78,8 +78,8 @@ export declare class Ux extends UxBase {
 export declare namespace Ux {
     namespace Table {
         type Data = Record<string, unknown>;
-        type Columns<T extends Data> = CliUx.Table.table.Columns<T>;
-        type Options = CliUx.Table.table.Options;
+        type Columns<T extends Data> = ux.Table.table.Columns<T>;
+        type Options = ux.Table.table.Options;
     }
 }
 //# sourceMappingURL=ux.d.ts.map

package/lib/ux/ux.js

@@ -41,7 +41,7 @@ class Ux extends base_1.UxBase {
      * @param args Args to be used for formatting.
      */
     log(message, ...args) {
-        this.maybeNoop(() => core_1.CliUx.ux.log(message, ...args));
+        this.maybeNoop(() => core_1.ux.log(message, ...args));
     }
     /**
      * Log a warning message to the console. This will be automatically suppressed if output is disabled.
@@ -49,7 +49,7 @@ class Ux extends base_1.UxBase {
      * @param message Warning message to log.
      */
     warn(message) {
-        this.maybeNoop(() => core_1.CliUx.ux.warn(message));
+        this.maybeNoop(() => core_1.ux.warn(message));
     }
     /**
      * Display a table to the console. This will be automatically suppressed if output is disabled.
@@ -59,7 +59,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.CliUx.ux.table(data, columns, options));
+        this.maybeNoop(() => core_1.ux.table(data, columns, options));
     }
     /**
      * Display a url to the console. This will be automatically suppressed if output is disabled.
@@ -69,7 +69,7 @@ class Ux extends base_1.UxBase {
      * @param params
      */
     url(text, uri, params = {}) {
-        this.maybeNoop(() => core_1.CliUx.ux.url(text, uri, params));
+        this.maybeNoop(() => core_1.ux.url(text, uri, params));
     }
     /**
      * Display stylized JSON to the console. This will be automatically suppressed if output is disabled.
@@ -77,7 +77,7 @@ class Ux extends base_1.UxBase {
      * @param obj JSON to display
      */
     styledJSON(obj) {
-        this.maybeNoop(() => core_1.CliUx.ux.styledJSON(obj));
+        this.maybeNoop(() => core_1.ux.styledJSON(obj));
     }
     /**
      * Display stylized object to the console. This will be automatically suppressed if output is disabled.
@@ -86,7 +86,7 @@ class Ux extends base_1.UxBase {
      * @param keys Keys of object to display
      */
     styledObject(obj, keys) {
-        this.maybeNoop(() => core_1.CliUx.ux.styledObject(obj, keys));
+        this.maybeNoop(() => core_1.ux.styledObject(obj, keys));
     }
     /**
      * Display stylized header to the console. This will be automatically suppressed if output is disabled.
@@ -94,7 +94,7 @@ class Ux extends base_1.UxBase {
      * @param text header to display
      */
     styledHeader(text) {
-        this.maybeNoop(() => core_1.CliUx.ux.styledHeader(text));
+        this.maybeNoop(() => core_1.ux.styledHeader(text));
     }
 }
 exports.Ux = Ux;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.22.2",
-  "description": "Utils for writing deploy and retrieve plugins",
+  "version": "2.0.0-beta.2",
+  "description": "Utils for writing Salesforce CLI plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
   "license": "BSD-3-Clause",
@@ -32,7 +32,7 @@
     "/messages"
   ],
   "dependencies": {
-    "@oclif/core": "^1.23.1",
+    "@oclif/core": "^2.0.4",
     "@salesforce/core": "^3.32.12",
     "@salesforce/kit": "^1.8.3",
     "@salesforce/ts-types": "^1.7.1",
@@ -49,13 +49,13 @@
     "@typescript-eslint/eslint-plugin": "^5.44.0",
     "@typescript-eslint/parser": "^5.47.0",
     "chai": "^4.3.7",
-    "eslint": "^8.31.0",
-    "eslint-config-prettier": "^8.5.0",
+    "eslint": "^8.32.0",
+    "eslint-config-prettier": "^8.6.0",
     "eslint-config-salesforce": "^1.1.0",
     "eslint-config-salesforce-license": "^0.1.6",
     "eslint-config-salesforce-typescript": "^1.1.1",
     "eslint-plugin-header": "^3.1.1",
-    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jsdoc": "^39.6.4",
     "husky": "^7.0.4",
     "mocha": "^9.1.3",