@salesforce/sf-plugins-core 1.13.1 → 1.14.1

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 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.14.1](https://github.com/salesforcecli/sf-plugins-core/compare/v1.13.2...v1.14.1) (2022-08-23)
+
+### Features
+
+- update custom flag definitions ([828daac](https://github.com/salesforcecli/sf-plugins-core/commit/828daac881124e7f1ef75a2efbcbd0de4a71bb3c))
+
+### [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

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import { Flags as OclifFlags } from '@oclif/core';
 export { toHelpSection } from './util';
 export { Deployable, Deployer, DeployerResult } from './deployer';
 export { Deauthorizer } from './deauthorizer';
@@ -7,25 +8,25 @@ export { SfHook } from './hooks';
 export * from './types';
 export { SfCommand, SfCommandInterface, StandardColors } from './sfCommand';
 export declare const Flags: {
-    boolean: typeof import("@oclif/core/lib/parser/flags").boolean;
-    directory: (opts?: ({
+    boolean: typeof OclifFlags.boolean;
+    directory: import("@oclif/core/lib/interfaces").Definition<string, {
         exists?: boolean | undefined;
-    } & Partial<import("@oclif/core/lib/interfaces").OptionFlag<string>>) | undefined) => import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
-    enum: <T = string>(opts: import("@oclif/core/lib/interfaces").EnumFlagOptions<T>) => import("@oclif/core/lib/interfaces").OptionFlag<T>;
-    file: (opts?: ({
+    }>;
+    enum: typeof OclifFlags._enum;
+    file: import("@oclif/core/lib/interfaces").Definition<string, {
         exists?: boolean | undefined;
-    } & Partial<import("@oclif/core/lib/interfaces").OptionFlag<string>>) | undefined) => import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
-    integer: (opts?: ({
+    }>;
+    integer: import("@oclif/core/lib/interfaces").Definition<number, {
         min?: number | undefined;
         max?: number | undefined;
-    } & Partial<import("@oclif/core/lib/interfaces").OptionFlag<number>>) | undefined) => import("@oclif/core/lib/interfaces").OptionFlag<number | undefined>;
-    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>;
-    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>;
-    optionalOrg: import("@oclif/core/lib/interfaces").Definition<import("@salesforce/core").Org | 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>>;
 };
 //# sourceMappingURL=exported.d.ts.map

package/lib/flags/duration.d.ts

@@ -1,12 +1,11 @@
-import { Interfaces } from '@oclif/core';
 import { Duration } from '@salesforce/kit';
 declare type DurationUnit = Lowercase<keyof typeof Duration.Unit>;
-export interface DurationFlagConfig extends Partial<Interfaces.OptionFlag<Duration>> {
+export declare type DurationFlagConfig = {
     unit: Required<DurationUnit>;
     defaultValue?: number;
     min?: number;
     max?: number;
-}
+};
 /**
  * Duration flag with built-in default and min/max validation
  * You must specify a unit
@@ -24,6 +23,6 @@ export interface DurationFlagConfig extends Partial<Interfaces.OptionFlag<Durati
  *    }),
  * }
  */
-export declare const durationFlag: (durationConfig: DurationFlagConfig) => Interfaces.OptionFlag<Duration | undefined>;
+export declare const durationFlag: import("@oclif/core/lib/interfaces").Definition<Duration, DurationFlagConfig>;
 export {};
 //# sourceMappingURL=duration.d.ts.map

package/lib/flags/duration.js

@@ -29,15 +29,12 @@ const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'me
  *    }),
  * }
  */
-const 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;
+exports.durationFlag = core_1.Flags.custom({
+    parse: async (input, _, opts) => validate(input, opts),
+    default: async (context) => {
+        return context.options.defaultValue ? toDuration(context.options.defaultValue, context.options.unit) : undefined;
+    },
+});
 const validate = (input, config) => {
     const { min, max, unit } = config || {};
     let parsedInput;

package/lib/flags/orgApiVersion.d.ts

@@ -9,5 +9,5 @@ export declare const maxDeprecatedUrl = "https://help.salesforce.com/s/articleVi
  * CAVEAT: unlike the apiversion flag on sfdxCommand, this does not set the version on the org/connection
  * We leave this up to the plugins to implement
  */
-export declare const orgApiVersionFlag: import("@oclif/core/lib/interfaces").Definition<string>;
+export declare const orgApiVersionFlag: import("@oclif/core/lib/interfaces").Definition<string, Record<string, unknown>>;
 //# sourceMappingURL=orgApiVersion.d.ts.map

package/lib/flags/orgApiVersion.js

@@ -24,7 +24,7 @@ exports.maxDeprecatedUrl = 'https://help.salesforce.com/s/articleView?id=0003544
  * CAVEAT: unlike the apiversion flag on sfdxCommand, this does not set the version on the org/connection
  * We leave this up to the plugins to implement
  */
-exports.orgApiVersionFlag = core_1.Flags.build({
+exports.orgApiVersionFlag = core_1.Flags.custom({
     parse: async (input) => validate(input),
     default: async () => await getDefaultFromConfig(),
     description: messages.getMessage('flags.apiVersion.description'),

package/lib/flags/orgFlags.d.ts

@@ -16,7 +16,7 @@ import { Org } from '@salesforce/core';
  *     }),
  * }
  */
-export declare const optionalOrgFlag: import("@oclif/core/lib/interfaces").Definition<Org | undefined>;
+export declare const optionalOrgFlag: import("@oclif/core/lib/interfaces").Definition<Org | undefined, Record<string, unknown>>;
 /**
  * A required org, specified by username or alias
  * Will throw if the specified org default do not exist
@@ -36,7 +36,7 @@ export declare const optionalOrgFlag: import("@oclif/core/lib/interfaces").Defin
  *     }),
  * }
  */
-export declare const requiredOrgFlag: import("@oclif/core/lib/interfaces").Definition<Org>;
+export declare const requiredOrgFlag: import("@oclif/core/lib/interfaces").Definition<Org, Record<string, unknown>>;
 /**
  * A required org that is a devHub
  * Will throw if the specified org does not exist
@@ -56,5 +56,5 @@ export declare const requiredOrgFlag: import("@oclif/core/lib/interfaces").Defin
  *     }),
  * }
  */
-export declare const requiredHubFlag: import("@oclif/core/lib/interfaces").Definition<Org>;
+export declare const requiredHubFlag: import("@oclif/core/lib/interfaces").Definition<Org, Record<string, unknown>>;
 //# sourceMappingURL=orgFlags.d.ts.map

package/lib/flags/orgFlags.js

@@ -64,7 +64,7 @@ const getHubOrThrow = async (aliasOrUsername) => {
  *     }),
  * }
  */
-exports.optionalOrgFlag = core_1.Flags.build({
+exports.optionalOrgFlag = core_1.Flags.custom({
     char: 'e',
     parse: async (input) => await maybeGetOrg(input),
     default: async () => await maybeGetOrg(),
@@ -89,7 +89,7 @@ exports.optionalOrgFlag = core_1.Flags.build({
  *     }),
  * }
  */
-exports.requiredOrgFlag = core_1.Flags.build({
+exports.requiredOrgFlag = core_1.Flags.custom({
     char: 'e',
     parse: async (input) => await getOrgOrThrow(input),
     default: async () => await getOrgOrThrow(),
@@ -114,7 +114,7 @@ exports.requiredOrgFlag = core_1.Flags.build({
  *     }),
  * }
  */
-exports.requiredHubFlag = core_1.Flags.build({
+exports.requiredHubFlag = core_1.Flags.custom({
     char: 'v',
     parse: async (input) => await getHubOrThrow(input),
     default: async () => await getHubOrThrow(),

package/lib/flags/salesforceId.d.ts

@@ -1,5 +1,4 @@
-import { Interfaces } from '@oclif/core';
-export interface IdFlagConfig extends Partial<Interfaces.OptionFlag<string>> {
+export declare type IdFlagConfig = {
     /**
      * Can specify if the version must be 15 or 18 characters long.  Leave blank to allow either 15 or 18.
      */
@@ -8,7 +7,7 @@ export interface IdFlagConfig extends Partial<Interfaces.OptionFlag<string>> {
      * If the ID belongs to a certain sobject type, specify the 3 character prefix.
      */
     startsWith?: string;
-}
+};
 /**
  * Id flag with built-in validation.  Short character is `i`
  *
@@ -28,5 +27,5 @@ export interface IdFlagConfig extends Partial<Interfaces.OptionFlag<string>> {
  *     }),
  * }
  */
-export declare const salesforceIdFlag: (inputs?: IdFlagConfig) => Interfaces.OptionFlag<string | undefined>;
+export declare const salesforceIdFlag: import("@oclif/core/lib/interfaces").Definition<string, IdFlagConfig>;
 //# sourceMappingURL=salesforceId.d.ts.map

package/lib/flags/salesforceId.js

@@ -30,15 +30,10 @@ const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'me
  *     }),
  * }
  */
-const 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;
+exports.salesforceIdFlag = core_1.Flags.custom({
+    parse: async (input, _ctx, opts) => validate(input, opts),
+    char: 'i',
+});
 const validate = (input, config) => {
     const { length, startsWith } = config || {};
     if (length && input.length !== length) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.13.1",
+  "version": "1.14.1",
   "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.15.0",
     "@salesforce/core": "^3.25.0",
     "@salesforce/kit": "^1.5.44",
     "@salesforce/ts-types": "^1.5.20",