fix: add function overloads to custom flags

salesforcecli · Aug 8, 2022 · 12c1178 · 12c1178
1 parent 043f664
commit 12c1178
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 10 deletions.
diff --git a/src/flags/duration.ts b/src/flags/duration.ts
@@ -37,14 +37,20 @@ export interface DurationFlagConfig extends Partial<Interfaces.OptionFlag<Durati
  *    }),
  * }
  */
-export const durationFlag = (durationConfig: DurationFlagConfig): Interfaces.OptionFlag<Duration | undefined> => {
+export function durationFlag(
+  durationConfig: DurationFlagConfig & ({ required: true } | { default: Interfaces.Default<Duration> })
+): Interfaces.OptionFlag<Duration>;
+export function durationFlag(durationConfig: DurationFlagConfig): Interfaces.OptionFlag<Duration | undefined>;
+export function durationFlag(
+  durationConfig: DurationFlagConfig
+): Interfaces.OptionFlag<Duration> | Interfaces.OptionFlag<Duration | undefined> {
   const { defaultValue, min, max, unit, ...baseProps } = durationConfig;
-  return Flags.build<Duration>({
+  return Flags.build({
     ...baseProps,
     parse: async (input: string) => validate(input, { min, max, unit }),
     default: defaultValue ? async () => toDuration(defaultValue, unit) : undefined,
   })();
-};
+}
 
 const validate = (input: string, config: DurationFlagConfig): Duration => {
   const { min, max, unit } = config || {};

diff --git a/src/flags/orgApiVersion.ts b/src/flags/orgApiVersion.ts
@@ -24,7 +24,7 @@ export const maxDeprecatedUrl = 'https://help.salesforce.com/s/articleView?id=00
  * 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 const orgApiVersionFlag = Flags.build<string>({
+export const orgApiVersionFlag = Flags.build({
   parse: async (input: string) => validate(input),
   default: async () => await getDefaultFromConfig(),
   description: messages.getMessage('flags.apiVersion.description'),

diff --git a/src/flags/orgFlags.ts b/src/flags/orgFlags.ts
@@ -63,7 +63,7 @@ const getHubOrThrow = async (aliasOrUsername?: string): Promise<Org> => {
  *     }),
  * }
  */
-export const optionalOrgFlag = Flags.build<Org | undefined>({
+export const optionalOrgFlag = Flags.build({
   char: 'e',
   parse: async (input: string | undefined) => await maybeGetOrg(input),
   default: async () => await maybeGetOrg(),
@@ -89,7 +89,7 @@ export const optionalOrgFlag = Flags.build<Org | undefined>({
  *     }),
  * }
  */
-export const requiredOrgFlag = Flags.build<Org>({
+export const requiredOrgFlag = Flags.build({
   char: 'e',
   parse: async (input: string | undefined) => await getOrgOrThrow(input),
   default: async () => await getOrgOrThrow(),
@@ -115,7 +115,7 @@ export const requiredOrgFlag = Flags.build<Org>({
  *     }),
  * }
  */
-export const requiredHubFlag = Flags.build<Org>({
+export const requiredHubFlag = Flags.build({
   char: 'v',
   parse: async (input: string | undefined) => await getHubOrThrow(input),
   default: async () => await getHubOrThrow(),

diff --git a/src/flags/salesforceId.ts b/src/flags/salesforceId.ts
@@ -40,14 +40,20 @@ export interface IdFlagConfig extends Partial<Interfaces.OptionFlag<string>> {
  *     }),
  * }
  */
-export const salesforceIdFlag = (inputs: IdFlagConfig = {}): Interfaces.OptionFlag<string | undefined> => {
+export function salesforceIdFlag(
+  inputs: IdFlagConfig & ({ required: true } | { default: Interfaces.Default<string> })
+): Interfaces.OptionFlag<string>;
+export function salesforceIdFlag(inputs: IdFlagConfig): Interfaces.OptionFlag<string | undefined>;
+export function salesforceIdFlag(
+  inputs: IdFlagConfig = {}
+): Interfaces.OptionFlag<string> | Interfaces.OptionFlag<string | undefined> {
   const { length, startsWith, ...baseProps } = inputs;
-  return Flags.build<string>({
+  return Flags.build({
     char: 'i',
     ...baseProps,
     parse: async (input: string) => validate(input, { length, startsWith }),
   })();
-};
+}
 
 const validate = (input: string, config?: IdFlagConfig): string => {
   const { length, startsWith } = config || {};