@salesforce/sf-plugins-core 1.12.3 → 1.13.2

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.13.2](https://github.com/salesforcecli/sf-plugins-core/compare/v1.13.1...v1.13.2) (2022-08-09)
+
+### Bug Fixes
+
+- add function overloads to custom flags ([12c1178](https://github.com/salesforcecli/sf-plugins-core/commit/12c117837a08bc8cf8eff41832f95a19d3386b18))
+- compile errors ([3782a70](https://github.com/salesforcecli/sf-plugins-core/commit/3782a703b7b0eddbc3d47a7dcbdf33272bdfd6fc))
+
+### [1.13.1](https://github.com/salesforcecli/sf-plugins-core/compare/v1.13.0...v1.13.1) (2022-08-03)
+
+### Bug Fixes
+
+- add number to deploy function return type ([ac9457b](https://github.com/salesforcecli/sf-plugins-core/commit/ac9457b78ab1242090fc4322ec266e8d0157cb6f))
+
+## [1.13.0](https://github.com/salesforcecli/sf-plugins-core/compare/v1.12.3...v1.13.0) (2022-06-09)
+
+### Features
+
+- catch method supports base and SfError ([2b9a038](https://github.com/salesforcecli/sf-plugins-core/commit/2b9a038713c77e1230e21f5cc6f8ae2a6aaab5be))
+
+### Bug Fixes
+
+- error can't be spread ([30930b7](https://github.com/salesforcecli/sf-plugins-core/commit/30930b74ff5e6b59116228d547362a284ad98388))
+
 ### [1.12.3](https://github.com/salesforcecli/sf-plugins-core/compare/v1.12.2...v1.12.3) (2022-05-04)
 
 ### Bug Fixes

package/lib/deployer.d.ts

@@ -2,6 +2,9 @@
 import { EventEmitter } from 'events';
 import { AnyJson, JsonMap } from '@salesforce/ts-types';
 import { QuestionCollection } from 'inquirer';
+export declare type DeployerResult = {
+    exitCode: number;
+};
 export declare abstract class Deployable {
     abstract getName(): string;
     abstract getType(): string;
@@ -51,7 +54,7 @@ export declare abstract class Deployer extends EventEmitter {
     /**
      * Deploy the app.
      */
-    abstract deploy(): Promise<void>;
+    abstract deploy<R extends DeployerResult>(): Promise<void | R>;
 }
 export declare namespace Deployer {
     type Flags = {

package/lib/exported.d.ts

@@ -1,25 +1,23 @@
 /// <reference types="node" />
 export { toHelpSection } from './util';
-export { Deployable, Deployer } from './deployer';
+export { Deployable, Deployer, DeployerResult } from './deployer';
 export { Deauthorizer } from './deauthorizer';
 export { Progress, Prompter, generateTableChoices } from './ux';
 export { SfHook } from './hooks';
 export * from './types';
 export { SfCommand, SfCommandInterface, StandardColors } from './sfCommand';
+import { salesforceIdFlag } from './flags/salesforceId';
+import { durationFlag } from './flags/duration';
 export declare const Flags: {
     boolean: typeof import("@oclif/core/lib/parser/flags").boolean;
-    directory: (opts?: ({
-        exists?: boolean | undefined;
-    } & Partial<import("@oclif/core/lib/interfaces").OptionFlag<string>>) | undefined) => import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+    directory: typeof import("@oclif/core/lib/parser/flags").directory;
     enum: <T = string>(opts: import("@oclif/core/lib/interfaces").EnumFlagOptions<T>) => import("@oclif/core/lib/interfaces").OptionFlag<T>;
-    file: (opts?: ({
-        exists?: boolean | undefined;
-    } & Partial<import("@oclif/core/lib/interfaces").OptionFlag<string>>) | undefined) => import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
-    integer: import("@oclif/core/lib/interfaces").Definition<number>;
+    file: typeof import("@oclif/core/lib/parser/flags").file;
+    integer: typeof import("@oclif/core/lib/parser/flags").integer;
     string: import("@oclif/core/lib/interfaces").Definition<string>;
     url: import("@oclif/core/lib/interfaces").Definition<import("url").URL>;
-    duration: (durationConfig: import("./flags/duration").DurationFlagConfig) => import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/kit").Duration | undefined>;
-    salesforceId: (inputs?: import("./flags/salesforceId").IdFlagConfig) => import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+    duration: typeof durationFlag;
+    salesforceId: typeof salesforceIdFlag;
     orgApiVersion: import("@oclif/core/lib/interfaces").Definition<string>;
     requiredOrg: import("@oclif/core/lib/interfaces").Definition<import("@salesforce/core").Org>;
     requiredHub: import("@oclif/core/lib/interfaces").Definition<import("@salesforce/core").Org>;

package/lib/flags/duration.d.ts

@@ -24,6 +24,11 @@ export interface DurationFlagConfig extends Partial<Interfaces.OptionFlag<Durati
  *    }),
  * }
  */
-export declare const durationFlag: (durationConfig: DurationFlagConfig) => Interfaces.OptionFlag<Duration | undefined>;
+export declare function durationFlag(durationConfig: DurationFlagConfig & ({
+    required: true;
+} | {
+    default: Interfaces.Default<Duration>;
+})): Interfaces.OptionFlag<Duration>;
+export declare function durationFlag(durationConfig: DurationFlagConfig): Interfaces.OptionFlag<Duration | undefined>;
 export {};
 //# sourceMappingURL=duration.d.ts.map

package/lib/flags/duration.js

@@ -12,31 +12,14 @@ const core_2 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 core_2.Messages.importMessagesDirectory(__dirname);
 const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'messages');
-/**
- * Duration flag with built-in default and min/max validation
- * You must specify a unit
- * Defaults to undefined if you don't specify a default
- *
- * @example
- * import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
- * public static flags = {
- *    'wait': duration({
- *       min: 1,
- *       unit: 'minutes'
- *       defaultValue: 33,
- *       char: 'w',
- *       description: 'Wait time in minutes'
- *    }),
- * }
- */
-const durationFlag = (durationConfig) => {
+function durationFlag(durationConfig) {
     const { defaultValue, min, max, unit, ...baseProps } = durationConfig;
     return core_1.Flags.build({
         ...baseProps,
         parse: async (input) => validate(input, { min, max, unit }),
         default: defaultValue ? async () => toDuration(defaultValue, unit) : undefined,
     })();
-};
+}
 exports.durationFlag = durationFlag;
 const validate = (input, config) => {
     const { min, max, unit } = config || {};

package/lib/flags/salesforceId.d.ts

@@ -28,5 +28,10 @@ export interface IdFlagConfig extends Partial<Interfaces.OptionFlag<string>> {
  *     }),
  * }
  */
-export declare const salesforceIdFlag: (inputs?: IdFlagConfig) => Interfaces.OptionFlag<string | undefined>;
+export declare function salesforceIdFlag(inputs: IdFlagConfig & ({
+    required: true;
+} | {
+    default: Interfaces.Default<string>;
+})): Interfaces.OptionFlag<string>;
+export declare function salesforceIdFlag(inputs?: IdFlagConfig): Interfaces.OptionFlag<string | undefined>;
 //# sourceMappingURL=salesforceId.d.ts.map

package/lib/flags/salesforceId.js

@@ -11,33 +11,14 @@ 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');
-/**
- * Id flag with built-in validation.  Short character is `i`
- *
- * @example
- * import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
- * public static flags = {
- *     // set length or prefix
- *    'flag-name': salesforceId({ length: 15, startsWith: '00D' }),
- *    // add flag properties
- *    'flag2': salesforceId({
- *        required: true,
- *        description: 'flag2 description',
- *     }),
- *    // override the character i
- *    'flag3': salesforceId({
- *        char: 'j',
- *     }),
- * }
- */
-const salesforceIdFlag = (inputs = {}) => {
+function salesforceIdFlag(inputs = {}) {
     const { length, startsWith, ...baseProps } = inputs;
     return core_1.Flags.build({
         char: 'i',
         ...baseProps,
         parse: async (input) => validate(input, { length, startsWith }),
     })();
-};
+}
 exports.salesforceIdFlag = salesforceIdFlag;
 const validate = (input, config) => {
     const { length, startsWith } = config || {};

package/lib/sfCommand.d.ts

@@ -1,5 +1,5 @@
 import { CliUx, Command, Config, HelpSection, Interfaces } from '@oclif/core';
-import { SfProject, StructuredMessage } from '@salesforce/core';
+import { SfProject, StructuredMessage, SfError } from '@salesforce/core';
 import { AnyJson } from '@salesforce/ts-types';
 import * as chalk from 'chalk';
 import { Progress, Prompter, Spinner, Ux } from './ux';
@@ -114,9 +114,9 @@ export declare abstract class SfCommand<T> extends Command {
     /**
      * Wrap the command error into the standardized JSON structure.
      */
-    protected toErrorJson(error: Error): SfCommand.Error;
+    protected toErrorJson(error: SfCommand.Error): SfCommand.Error;
     protected assignProject(): Promise<SfProject>;
-    protected catch(error: SfCommand.Error): Promise<SfCommand.Error>;
+    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
@@ -153,6 +153,8 @@ export declare namespace SfCommand {
         actions?: string[];
         code?: unknown;
         exitCode?: number;
+        data?: unknown;
+        context?: string;
     }
 }
 //# sourceMappingURL=sfCommand.d.ts.map

package/lib/sfCommand.js

@@ -178,12 +178,8 @@ class SfCommand extends core_1.Command {
      * Wrap the command error into the standardized JSON structure.
      */
     toErrorJson(error) {
-        var _a;
         return {
-            status: (_a = process.exitCode) !== null && _a !== void 0 ? _a : 1,
-            stack: error.stack,
-            name: error.name,
-            message: error.message,
+            ...error,
             warnings: this.warnings,
         };
     }
@@ -200,15 +196,30 @@ class SfCommand extends core_1.Command {
     }
     async catch(error) {
         var _a, _b;
-        process.exitCode = (_b = (_a = process.exitCode) !== null && _a !== void 0 ? _a : error.exitCode) !== null && _b !== void 0 ? _b : 1;
+        // transform an unknown error into one that conforms to the interface
+        const codeFromError = error instanceof core_2.SfError ? error.exitCode : 1;
+        (_a = process.exitCode) !== null && _a !== void 0 ? _a : (process.exitCode = codeFromError);
+        const sfErrorProperties = error instanceof core_2.SfError
+            ? { data: error.data, actions: error.actions, code: codeFromError, context: error.context }
+            : {};
+        const sfCommandError = {
+            ...sfErrorProperties,
+            ...{
+                message: error.message,
+                name: (_b = error.name) !== null && _b !== void 0 ? _b : 'Error',
+                status: process.exitCode,
+                stack: error.stack,
+                exitCode: process.exitCode,
+            },
+        };
         if (this.jsonEnabled()) {
-            core_1.CliUx.ux.styledJSON(this.toErrorJson(error));
+            core_1.CliUx.ux.styledJSON(this.toErrorJson(sfCommandError));
         }
         else {
             // eslint-disable-next-line no-console
-            console.error(this.formatError(error));
+            console.error(this.formatError(sfCommandError));
         }
-        return error;
+        return sfCommandError;
     }
     /**
      * Format errors and actions for human consumption. Adds 'Error (<ErrorCode>):',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.12.3",
+  "version": "1.13.2",
   "description": "Utils for writing deploy and retrieve plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -32,9 +32,9 @@
     "/messages"
   ],
   "dependencies": {
-    "@oclif/core": "^1.7.0",
-    "@salesforce/core": "^3.15.5",
-    "@salesforce/kit": "^1.5.41",
+    "@oclif/core": "^1.13.9",
+    "@salesforce/core": "^3.25.0",
+    "@salesforce/kit": "^1.5.44",
     "@salesforce/ts-types": "^1.5.20",
     "chalk": "^4",
     "inquirer": "^8.2.0"
@@ -49,14 +49,14 @@
     "@typescript-eslint/eslint-plugin": "^4.33.0",
     "@typescript-eslint/parser": "^4.33.0",
     "chai": "^4.3.6",
-    "eslint": "^6.8.0",
+    "eslint": "^7.32.0",
     "eslint-config-prettier": "^6.15.0",
     "eslint-config-salesforce": "^0.1.6",
     "eslint-config-salesforce-license": "^0.1.6",
     "eslint-config-salesforce-typescript": "^0.2.8",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jsdoc": "^27.1.2",
+    "eslint-plugin-jsdoc": "^35.1.2",
     "eslint-plugin-prettier": "^3.4.1",
     "husky": "^7.0.4",
     "mocha": "^8.4.0",