@salesforce/sf-plugins-core 1.13.1 → 1.13.2

package/CHANGELOG.md

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

package/lib/exported.d.ts

@@ -6,23 +6,18 @@ 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: (opts?: ({
-        min?: number | undefined;
-        max?: number | undefined;
-    } & Partial<import("@oclif/core/lib/interfaces").OptionFlag<number>>) | undefined) => import("@oclif/core/lib/interfaces").OptionFlag<number | undefined>;
+    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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.13.1",
+  "version": "1.13.2",
   "description": "Utils for writing deploy and retrieve plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -32,7 +32,7 @@
     "/messages"
   ],
   "dependencies": {
-    "@oclif/core": "^1.13.0",
+    "@oclif/core": "^1.13.9",
     "@salesforce/core": "^3.25.0",
     "@salesforce/kit": "^1.5.44",
     "@salesforce/ts-types": "^1.5.20",