From 9fa93d5b63b4b7e41a4caae46b6411944159ae80 Mon Sep 17 00:00:00 2001 From: svc-cli-bot Date: Sun, 17 Nov 2024 05:47:00 +0000 Subject: [PATCH] docs: publishing gh-pages [skip ci] --- classes/SfCommandError.SfCommandError.html | 4 +- classes/sfCommand.SfCommand-1.html | 44 +++++++++---------- classes/ux_base.UxBase.html | 4 +- classes/ux_progress.Progress-1.html | 14 +++--- classes/ux_spinner.Spinner.html | 14 +++--- classes/ux_ux.Ux.html | 20 ++++----- .../compatibility.arrayWithDeprecation.html | 2 +- functions/errorFormatting.formatError.html | 2 +- functions/errorHandling.computeErrorCode.html | 2 +- functions/errorHandling.errorIsGack.html | 2 +- functions/errorHandling.errorIsTypeError.html | 2 +- functions/flags_duration.durationFlag.html | 2 +- ...flags_orgApiVersion.orgApiVersionFlag.html | 2 +- functions/flags_orgFlags.getHubOrThrow.html | 2 +- functions/flags_orgFlags.getOrgOrThrow.html | 2 +- functions/flags_orgFlags.maybeGetHub.html | 2 +- functions/flags_orgFlags.maybeGetOrg.html | 2 +- functions/flags_orgFlags.optionalHubFlag.html | 2 +- functions/flags_orgFlags.optionalOrgFlag.html | 2 +- functions/flags_orgFlags.requiredHubFlag.html | 2 +- functions/flags_orgFlags.requiredOrgFlag.html | 2 +- .../flags_salesforceId.salesforceIdFlag.html | 2 +- functions/stubUx.stubPrompter.html | 2 +- functions/stubUx.stubSfCommandUx.html | 2 +- functions/stubUx.stubSpinner.html | 2 +- functions/stubUx.stubUx.html | 2 +- functions/util.parseVarArgs.html | 2 +- functions/util.removeEmpty.html | 2 +- functions/util.toHelpSection.html | 2 +- functions/ux_prompts.confirm.html | 2 +- functions/ux_prompts.secretPrompt.html | 2 +- functions/ux_styledObject.default.html | 2 +- functions/ux_table.convertToNewTableAPI.html | 2 +- modules/SfCommandError.html | 2 +- modules/compatibility.html | 2 +- modules/errorFormatting.html | 2 +- modules/errorHandling.html | 2 +- modules/exported.html | 2 +- modules/flags_duration.html | 2 +- modules/flags_flags.html | 2 +- modules/flags_orgApiVersion.html | 2 +- modules/flags_orgFlags.html | 2 +- modules/flags_salesforceId.html | 2 +- modules/sfCommand.SfCommand.html | 2 +- modules/sfCommand.html | 2 +- modules/stubUx.html | 2 +- modules/util.html | 2 +- modules/ux_base.html | 2 +- modules/ux_progress.Progress.html | 2 +- modules/ux_progress.html | 2 +- modules/ux_prompts.html | 2 +- modules/ux_spinner.html | 2 +- modules/ux_standardColors.html | 2 +- modules/ux_styledObject.html | 2 +- modules/ux_table.html | 2 +- modules/ux_ux.html | 2 +- .../SfCommandError.SfCommandErrorOptions.html | 2 +- ...atibility.ArrayWithDeprecationOptions.html | 2 +- types/flags_duration.DurationFlagConfig.html | 2 +- types/flags_salesforceId.IdFlagConfig.html | 2 +- types/sfCommand.SfCommand.Error.html | 2 +- types/sfCommand.SfCommand.Info.html | 2 +- types/sfCommand.SfCommand.Json.html | 2 +- types/sfCommand.SfCommand.Warning.html | 2 +- types/sfCommand.SfCommandInterface.html | 2 +- types/ux_progress.Progress.Bar.html | 2 +- types/ux_progress.Progress.Options.html | 2 +- types/ux_progress.Progress.Payload.html | 2 +- types/ux_prompts.PromptInputs.html | 2 +- variables/compatibility.loglevel.html | 2 +- ...ility.optionalHubFlagWithDeprecations.html | 2 +- ...ility.optionalOrgFlagWithDeprecations.html | 2 +- ...ity.orgApiVersionFlagWithDeprecations.html | 2 +- ...ility.requiredHubFlagWithDeprecations.html | 2 +- ...ility.requiredOrgFlagWithDeprecations.html | 2 +- variables/flags_flags.Flags.html | 2 +- .../flags_orgApiVersion.maxDeprecated.html | 2 +- .../flags_orgApiVersion.maxDeprecatedUrl.html | 2 +- ...lags_orgApiVersion.minValidApiVersion.html | 2 +- variables/ux_prompts.prompts.html | 2 +- .../ux_standardColors.StandardColors.html | 2 +- 81 files changed, 125 insertions(+), 125 deletions(-) diff --git a/classes/SfCommandError.SfCommandError.html b/classes/SfCommandError.SfCommandError.html index b86544c4..4190b05b 100644 --- a/classes/SfCommandError.SfCommandError.html +++ b/classes/SfCommandError.SfCommandError.html @@ -1,4 +1,4 @@ -SfCommandError | @salesforce/sf-plugins-core

Hierarchy

  • SfError
    • SfCommandError

Properties

commandName +SfCommandError | @salesforce/sf-plugins-core

Hierarchy

  • SfError
    • SfCommandError

Properties

commandName: string
oclif: {
    exit: number;
}
result?: unknown
skipOclifErrorHandling: boolean
status: number
warnings?: (string | StructuredMessage)[]

Methods

+

Properties

commandName: string
oclif: {
    exit: number;
}
result?: unknown
skipOclifErrorHandling: boolean
status: number
warnings?: (string | StructuredMessage)[]

Methods

diff --git a/classes/sfCommand.SfCommand-1.html b/classes/sfCommand.SfCommand-1.html index 88ac1d79..3ca23460 100644 --- a/classes/sfCommand.SfCommand-1.html +++ b/classes/sfCommand.SfCommand-1.html @@ -17,7 +17,7 @@
import { SfCommand } from '@salesforce/sf-plugins-core';
export type MyJsonOutput = { success: boolean };
export default class MyCommand extends SfCommand<MyJsonOutput> {
public async run(): Promise<MyJsonOutput> {
return { success: true };
}
}
-

Type Parameters

Hierarchy

Constructors

Type Parameters

  • T

Hierarchy

  • Command
    • SfCommand

Constructors

Properties

Constructors

Properties

configAggregator: ConfigAggregator

ConfigAggregator instance for accessing global and local configuration.

-
progress: Progress

Add a progress bar to the console. Progress

-
project?: SfProject
spinner: Spinner

Add a spinner to the console. Spinner

-
baseFlags: {
    flags-dir: OptionFlag<undefined | string, CustomOptions>;
} = ...
configurationVariablesSection?: HelpSection

Add a CONFIGURATION VARIABLES section to the help output.

+

Constructors

Properties

configAggregator: ConfigAggregator

ConfigAggregator instance for accessing global and local configuration.

+
progress: Progress

Add a progress bar to the console. Progress

+
project?: SfProject
spinner: Spinner

Add a spinner to the console. Spinner

+
baseFlags: {
    flags-dir: OptionFlag<undefined | string, CustomOptions>;
} = ...
configurationVariablesSection?: HelpSection

Add a CONFIGURATION VARIABLES section to the help output.

import { SfCommand, toHelpSection } from '@salesforce/sf-plugins-core';
import { OrgConfigProperties } from '@salesforce/core';
export default class MyCommand extends SfCommand {
public static configurationVariablesSection = toHelpSection(
'CONFIGURATION VARIABLES',
OrgConfigProperties.TARGET_ORG,
OrgConfigProperties.ORG_API_VERSION,
);
}
-
enableJsonFlag: boolean = true
envVariablesSection?: HelpSection

Add an Environment VARIABLES section to the help output.

+
enableJsonFlag: boolean = true
envVariablesSection?: HelpSection

Add an Environment VARIABLES section to the help output.

import { SfCommand, toHelpSection } from '@salesforce/sf-plugins-core';
import { EnvironmentVariable } from '@salesforce/core';
export default class MyCommand extends SfCommand {
public static envVariablesSection = toHelpSection(
'ENVIRONMENT VARIABLES',
EnvironmentVariable.SF_TARGET_ORG,
EnvironmentVariable.SF_USE_PROGRESS_BAR,
);
}
-
errorCodes?: HelpSection

Add an ERROR CODES section to the help output.

+
errorCodes?: HelpSection

Add an ERROR CODES section to the help output.

import { SfCommand, toHelpSection } from '@salesforce/sf-plugins-core';
export default class MyCommand extends SfCommand {
public static errorCodes = toHelpSection(
'ERROR CODES',
{ 0: 'Success', 1: 'Failure' },
);
}
-
requiresProject: boolean

Set to true if the command must be executed inside a Salesforce project directory.

+
requiresProject: boolean

Set to true if the command must be executed inside a Salesforce project directory.

If set to true the command will throw an error if the command is executed outside of a Salesforce project directory. Additionally, this.project will be set to the current Salesforce project (SfProject).

-

Methods

  • Prompt user for yes/no confirmation. +

Methods

  • Prompt user for yes/no confirmation. Avoid calling in --json scenarios and always provide a --no-prompt option for scripting

    -

    Parameters

    Returns Promise<boolean>

  • Determine if the command is being run with the --json flag in a command that supports it.

    +

Returns void

  • Determine if the command is being run with the --json flag in a command that supports it.

    Returns boolean

    true if the command supports json and the --json flag is present

    -
  • Parameters

    • json: unknown

    Returns void

  • Warn user about sensitive information (access tokens, etc...) before logging to the console.

    +
  • Parameters

    • json: unknown

    Returns void

  • Warn user about sensitive information (access tokens, etc...) before logging to the console.

    Parameters

    • Optionalmsg: string

      The message to log.

      -

    Returns void

  • Log a success message that has the standard success message color applied.

    +

Returns void

  • Log a success message that has the standard success message color applied.

    Parameters

    • message: string

      The message to log.

      -

    Returns void

  • actual command run code goes here

    -

    Returns Promise<T>

  • Prompt user for yes/no confirmation. +

Returns void

  • actual command run code goes here

    +

    Returns Promise<T>

  • Prompt user for yes/no confirmation. Avoid calling in --json scenarios and always provide a --no-prompt option for scripting

    -

    Parameters

    Returns Promise<string>

  • Log stylized header to the console. Will automatically be suppressed when --json flag is present.

    +

    Parameters

    Returns Promise<string>

  • Log stylized header to the console. Will automatically be suppressed when --json flag is present.

    Parameters

    • text: string

      the text to display as a header.

      -

    Returns void

  • Log stylized JSON to the console. Will automatically be suppressed when --json flag is present.

    +

Returns void

  • Log stylized JSON to the console. Will automatically be suppressed when --json flag is present.

    Parameters

    • obj: AnyJson

      The JSON to log.

      -

    Returns void

  • Log stylized object to the console. Will automatically be suppressed when --json flag is present.

    +

Returns void

  • Log stylized object to the console. Will automatically be suppressed when --json flag is present.

    Parameters

    • obj: AnyJson

      The object to log.

      -

    Returns void

  • Display a table on the console. Will automatically be suppressed when --json flag is present.

    -

    Type Parameters

    • R extends Record<string, unknown>

    Parameters

    • options: TableOptions<R>

    Returns void

  • Log a stylized url to the console. Will automatically be suppressed when --json flag is present.

    +

Returns void

  • Display a table on the console. Will automatically be suppressed when --json flag is present.

    +

    Type Parameters

    • R extends Record<string, unknown>

    Parameters

    • options: TableOptions<R>

    Returns void

  • Log a stylized url to the console. Will automatically be suppressed when --json flag is present.

    Parameters

    • text: string

      The text to display for the url.

    • uri: string

      The url to display.

      -
    • params: {} = {}

      Returns void

    • Log warning to users. If --json is enabled, then the warning will be added to the json output under the warnings property.

      +
    • params: {} = {}

      Returns void

      +

      Returns Warning

      diff --git a/classes/ux_base.UxBase.html b/classes/ux_base.UxBase.html index 65869d18..deae5f5a 100644 --- a/classes/ux_base.UxBase.html +++ b/classes/ux_base.UxBase.html @@ -1,3 +1,3 @@ -UxBase | @salesforce/sf-plugins-core

      Hierarchy (view full)

      Constructors

      constructor +UxBase | @salesforce/sf-plugins-core

      Hierarchy (view full)

      Constructors

      Properties

      Constructors

      Properties

      outputEnabled: boolean
      +

      Constructors

      Properties

      outputEnabled: boolean
      diff --git a/classes/ux_progress.Progress-1.html b/classes/ux_progress.Progress-1.html index b4187e82..19ae4e55 100644 --- a/classes/ux_progress.Progress-1.html +++ b/classes/ux_progress.Progress-1.html @@ -1,14 +1,14 @@ Progress | @salesforce/sf-plugins-core

      Class for display a progress bar to the console. Will automatically be suppressed if the --json flag is present.

      -

      Hierarchy (view full)

      Constructors

      Hierarchy (view full)

      Constructors

      Properties

      Methods

      Constructors

      Properties

      outputEnabled: boolean

      Methods

      • Update the progress bar with the final number and stop it.

        -

        Parameters

        • payload: {} = {}

          Returns void

        • Set the total number of expected components.

          -

          Parameters

          • total: number

          Returns void

        • Start the progress bar.

          -

          Parameters

          • total: number
          • payload: Payload = {}
          • options: Partial<Options> = Progress.DEFAULT_OPTIONS

          Returns void

        • Update the progress bar.

          -

          Parameters

          • num: number
          • payload: {} = {}

            Returns void

          +

          Constructors

          Properties

          outputEnabled: boolean

          Methods

          • Update the progress bar with the final number and stop it.

            +

            Parameters

            • payload: {} = {}

              Returns void

            • Set the total number of expected components.

              +

              Parameters

              • total: number

              Returns void

            • Start the progress bar.

              +

              Parameters

              • total: number
              • payload: Payload = {}
              • options: Partial<Options> = Progress.DEFAULT_OPTIONS

              Returns void

            • Update the progress bar.

              +

              Parameters

              • num: number
              • payload: {} = {}

                Returns void

              diff --git a/classes/ux_spinner.Spinner.html b/classes/ux_spinner.Spinner.html index d8e4f6d4..d4595ba7 100644 --- a/classes/ux_spinner.Spinner.html +++ b/classes/ux_spinner.Spinner.html @@ -1,14 +1,14 @@ Spinner | @salesforce/sf-plugins-core

              This class is a light wrapper around ux.action that allows us to automatically suppress any actions if --json flag is present.

              -

              Hierarchy (view full)

              Constructors

              Hierarchy (view full)

              Constructors

              Properties

              Accessors

              Methods

              Constructors

              Properties

              outputEnabled: boolean

              Accessors

              • get status(): undefined | string
              • Get the status of the current spinner.

                -

                Returns undefined | string

              • set status(status): void
              • Set the status of the current spinner.

                -

                Parameters

                • status: undefined | string

                Returns void

              Methods

              • Pause the spinner on the console.

                -

                Parameters

                • fn: (() => unknown)
                    • (): unknown
                    • Returns unknown

                • Optionalicon: string

                Returns void

              • Start a spinner on the console.

                -

                Parameters

                • action: string
                • Optionalstatus: string
                • Optionalopts: {
                      stdout?: boolean;
                  }
                  • Optionalstdout?: boolean

                Returns void

              • Stop the spinner on the console.

                -

                Parameters

                • Optionalmsg: string

                Returns void

              +

              Constructors

              Properties

              outputEnabled: boolean

              Accessors

              • get status(): undefined | string
              • Get the status of the current spinner.

                +

                Returns undefined | string

              • set status(status): void
              • Set the status of the current spinner.

                +

                Parameters

                • status: undefined | string

                Returns void

              Methods

              • Pause the spinner on the console.

                +

                Parameters

                • fn: (() => unknown)
                    • (): unknown
                    • Returns unknown

                • Optionalicon: string

                Returns void

              • Start a spinner on the console.

                +

                Parameters

                • action: string
                • Optionalstatus: string
                • Optionalopts: {
                      stdout?: boolean;
                  }
                  • Optionalstdout?: boolean

                Returns void

              • Stop the spinner on the console.

                +

                Parameters

                • Optionalmsg: string

                Returns void

              diff --git a/classes/ux_ux.Ux.html b/classes/ux_ux.Ux.html index 5259e79f..01d8be0f 100644 --- a/classes/ux_ux.Ux.html +++ b/classes/ux_ux.Ux.html @@ -2,7 +2,7 @@
              import { SfCommand, Ux } from '@salesforce/sf-plugins-core';
              import { AnyJson } from '@salesforce/ts-types';

              class MyCommand extends SfCommand<AnyJson> {
              public async run(): Promise<AnyJson> {
              const ux = new Ux(!this.jsonEnabled());
              }
              }
              -

              Hierarchy (view full)

              Constructors

              Hierarchy (view full)

              Constructors

              Properties

              Methods

              log @@ -13,24 +13,24 @@ table url warn -

              Constructors

              • Parameters

                • __namedParameters: {
                      jsonEnabled: boolean;
                  } = ...
                  • jsonEnabled: boolean

                Returns Ux

              Properties

              outputEnabled: boolean
              spinner: Spinner

              Methods

              • Log a message to the console. This will be automatically suppressed if output is disabled.

                +

              Constructors

              • Parameters

                • __namedParameters: {
                      jsonEnabled: boolean;
                  } = ...
                  • jsonEnabled: boolean

                Returns Ux

              Properties

              outputEnabled: boolean
              spinner: Spinner

              Methods

              • Log a message to the console. This will be automatically suppressed if output is disabled.

                Parameters

                • Optionalmessage: string

                  Message to log. Formatting is supported.

                • Rest...args: string[]

                  Args to be used for formatting.

                  -

                Returns void

              • Log a message to stderr. This will be automatically suppressed if output is disabled.

                +

              Returns void

              • Log a message to stderr. This will be automatically suppressed if output is disabled.

                Parameters

                • Optionalmessage: string

                  Message to log. Formatting is supported.

                • Rest...args: string[]

                  Args to be used for formatting.

                  -

                Returns void

              • Display stylized header to the console. This will be automatically suppressed if output is disabled.

                +

              Returns void

              • Display stylized header to the console. This will be automatically suppressed if output is disabled.

                Parameters

                • text: string

                  header to display

                  -

                Returns void

              • Display stylized JSON to the console. This will be automatically suppressed if output is disabled.

                +

              Returns void

              • Display stylized JSON to the console. This will be automatically suppressed if output is disabled.

                Parameters

                • obj: AnyJson

                  JSON to display

                  -
                • Optionaltheme: Record<string, string>

                Returns void

              • Display stylized object to the console. This will be automatically suppressed if output is disabled.

                +
              • Optionaltheme: Record<string, string>

              Returns void

              • Display stylized object to the console. This will be automatically suppressed if output is disabled.

                Parameters

                • obj: AnyJson

                  Object to display

                • Optionalkeys: string[]

                  Keys of object to display

                  -

                Returns void

              • Display a table to the console. This will be automatically suppressed if output is disabled.

                +

              Returns void

              • Display a table to the console. This will be automatically suppressed if output is disabled.

                Type Parameters

                • T extends Record<string, unknown>

                Parameters

                • options: TableOptions<T>

                  Table properties

                  -

                Returns void

              • Display a url to the console. This will be automatically suppressed if output is disabled.

                +

              Returns void

              • Display a url to the console. This will be automatically suppressed if output is disabled.

                Parameters

                • text: string

                  text to display

                • uri: string

                  URL link

                  -
                • params: {} = {}

                  Returns void

                • Log a warning message to the console. This will be automatically suppressed if output is disabled.

                  +
                • params: {} = {}

                  Returns void

                  • Log a warning message to the console. This will be automatically suppressed if output is disabled.

                    Parameters

                    • message: string | Error

                      Warning message to log.

                      -

                    Returns void

                  +

                  Returns void

                  diff --git a/functions/compatibility.arrayWithDeprecation.html b/functions/compatibility.arrayWithDeprecation.html index c2bd8c60..f82c138e 100644 --- a/functions/compatibility.arrayWithDeprecation.html +++ b/functions/compatibility.arrayWithDeprecation.html @@ -1,2 +1,2 @@ arrayWithDeprecation | @salesforce/sf-plugins-core

                  @deprecated. Use multiple: true with delimiter: ',' instead

                  -
                  +
                  diff --git a/functions/errorFormatting.formatError.html b/functions/errorFormatting.formatError.html index d0825160..997d23f7 100644 --- a/functions/errorFormatting.formatError.html +++ b/functions/errorFormatting.formatError.html @@ -1 +1 @@ -formatError | @salesforce/sf-plugins-core
                  +formatError | @salesforce/sf-plugins-core
                  diff --git a/functions/errorHandling.computeErrorCode.html b/functions/errorHandling.computeErrorCode.html index 5ffa1ac2..df2c3261 100644 --- a/functions/errorHandling.computeErrorCode.html +++ b/functions/errorHandling.computeErrorCode.html @@ -8,4 +8,4 @@
                • use the process exitCode
                • default to 1
                • -
                  +
                  diff --git a/functions/errorHandling.errorIsGack.html b/functions/errorHandling.errorIsGack.html index 949f3fc1..58e38c9d 100644 --- a/functions/errorHandling.errorIsGack.html +++ b/functions/errorHandling.errorIsGack.html @@ -1,2 +1,2 @@ errorIsGack | @salesforce/sf-plugins-core

                  identifies gacks via regex. Searches the error message, stack, and recursively checks the cause chain

                  -
                  • Parameters

                    • error: Error | SfError<AnyJson>

                    Returns boolean

                  +
                  diff --git a/functions/errorHandling.errorIsTypeError.html b/functions/errorHandling.errorIsTypeError.html index aaa39c0a..fa1a0752 100644 --- a/functions/errorHandling.errorIsTypeError.html +++ b/functions/errorHandling.errorIsTypeError.html @@ -1,2 +1,2 @@ errorIsTypeError | @salesforce/sf-plugins-core

                  identifies TypeError. Searches the error message, stack, and recursively checks the cause chain

                  -
                  • Parameters

                    • error: Error | SfError<AnyJson>

                    Returns boolean

                  +
                  diff --git a/functions/flags_duration.durationFlag.html b/functions/flags_duration.durationFlag.html index 79aa77c3..62cf7120 100644 --- a/functions/flags_duration.durationFlag.html +++ b/functions/flags_duration.durationFlag.html @@ -4,4 +4,4 @@
                  import { Flags } from '@salesforce/sf-plugins-core';
                  public static flags = {
                  wait: Flags.duration({
                  min: 1,
                  unit: 'minutes'
                  defaultValue: 33,
                  char: 'w',
                  description: 'Wait time in minutes'
                  }),
                  }
                  -
                  +
                  diff --git a/functions/flags_orgApiVersion.orgApiVersionFlag.html b/functions/flags_orgApiVersion.orgApiVersionFlag.html index 7415caa0..bc3defb9 100644 --- a/functions/flags_orgApiVersion.orgApiVersionFlag.html +++ b/functions/flags_orgApiVersion.orgApiVersionFlag.html @@ -6,4 +6,4 @@
                  import { Flags } from '@salesforce/sf-plugins-core';
                  public static flags = {
                  'api-version': Flags.orgApiVersion({
                  char: 'a',
                  description: 'api version for the org'
                  }),
                  }
                  -
                  +
                  diff --git a/functions/flags_orgFlags.getHubOrThrow.html b/functions/flags_orgFlags.getHubOrThrow.html index b7af84b5..42d38c1b 100644 --- a/functions/flags_orgFlags.getHubOrThrow.html +++ b/functions/flags_orgFlags.getHubOrThrow.html @@ -1 +1 @@ -getHubOrThrow | @salesforce/sf-plugins-core
                  • Parameters

                    • OptionalaliasOrUsername: string

                    Returns Promise<Org>

                  +getHubOrThrow | @salesforce/sf-plugins-core
                  • Parameters

                    • OptionalaliasOrUsername: string

                    Returns Promise<Org>

                  diff --git a/functions/flags_orgFlags.getOrgOrThrow.html b/functions/flags_orgFlags.getOrgOrThrow.html index 518ff073..f024eedc 100644 --- a/functions/flags_orgFlags.getOrgOrThrow.html +++ b/functions/flags_orgFlags.getOrgOrThrow.html @@ -1 +1 @@ -getOrgOrThrow | @salesforce/sf-plugins-core
                  • Parameters

                    • Optionalinput: string

                    Returns Promise<Org>

                  +getOrgOrThrow | @salesforce/sf-plugins-core
                  • Parameters

                    • Optionalinput: string

                    Returns Promise<Org>

                  diff --git a/functions/flags_orgFlags.maybeGetHub.html b/functions/flags_orgFlags.maybeGetHub.html index b0fc8c2c..76805137 100644 --- a/functions/flags_orgFlags.maybeGetHub.html +++ b/functions/flags_orgFlags.maybeGetHub.html @@ -1 +1 @@ -maybeGetHub | @salesforce/sf-plugins-core
                  • Parameters

                    • Optionalinput: string

                    Returns Promise<undefined | Org>

                  +maybeGetHub | @salesforce/sf-plugins-core
                  • Parameters

                    • Optionalinput: string

                    Returns Promise<undefined | Org>

                  diff --git a/functions/flags_orgFlags.maybeGetOrg.html b/functions/flags_orgFlags.maybeGetOrg.html index 48a33f23..8fe501d5 100644 --- a/functions/flags_orgFlags.maybeGetOrg.html +++ b/functions/flags_orgFlags.maybeGetOrg.html @@ -1 +1 @@ -maybeGetOrg | @salesforce/sf-plugins-core
                  • Parameters

                    • input: string

                    Returns Promise<Org>

                  • Parameters

                    • input: undefined

                    Returns Promise<undefined>

                  • Parameters

                    • Optionalinput: string

                    Returns Promise<Org | undefined>

                  +maybeGetOrg | @salesforce/sf-plugins-core
                  • Parameters

                    • input: string

                    Returns Promise<Org>

                  • Parameters

                    • input: undefined

                    Returns Promise<undefined>

                  • Parameters

                    • Optionalinput: string

                    Returns Promise<Org | undefined>

                  diff --git a/functions/flags_orgFlags.optionalHubFlag.html b/functions/flags_orgFlags.optionalHubFlag.html index 6cb12a11..ebf63588 100644 --- a/functions/flags_orgFlags.optionalHubFlag.html +++ b/functions/flags_orgFlags.optionalHubFlag.html @@ -5,4 +5,4 @@
                  import { Flags } from '@salesforce/sf-plugins-core';
                  public static flags = {
                  // setting length or prefix
                  'target-org': optionalHubFlag(),
                  // adding properties
                  'flag2': optionalHubFlag({
                  description: 'flag2 description',
                  char: 'h'
                  }),
                  }
                  -
                  +
                  diff --git a/functions/flags_orgFlags.optionalOrgFlag.html b/functions/flags_orgFlags.optionalOrgFlag.html index f65d500d..239839fd 100644 --- a/functions/flags_orgFlags.optionalOrgFlag.html +++ b/functions/flags_orgFlags.optionalOrgFlag.html @@ -4,4 +4,4 @@
                  import { Flags } from '@salesforce/sf-plugins-core';
                  public static flags = {
                  // setting length or prefix
                  'target-org': Flags.optionalOrg(),
                  // adding properties
                  'flag2': Flags.optionalOrg({
                  required: true,
                  description: 'flag2 description',
                  }),
                  }
                  -
                  +
                  diff --git a/functions/flags_orgFlags.requiredHubFlag.html b/functions/flags_orgFlags.requiredHubFlag.html index 72740afe..bd6d67cd 100644 --- a/functions/flags_orgFlags.requiredHubFlag.html +++ b/functions/flags_orgFlags.requiredHubFlag.html @@ -5,4 +5,4 @@
                  import { Flags } from '@salesforce/sf-plugins-core';
                  public static flags = {
                  // setting length or prefix
                  'target-org': requiredHub(),
                  // adding properties
                  'flag2': requiredHub({
                  required: true,
                  description: 'flag2 description',
                  char: 'h'
                  }),
                  }
                  -
                  +
                  diff --git a/functions/flags_orgFlags.requiredOrgFlag.html b/functions/flags_orgFlags.requiredOrgFlag.html index 0a991aec..c08d86e5 100644 --- a/functions/flags_orgFlags.requiredOrgFlag.html +++ b/functions/flags_orgFlags.requiredOrgFlag.html @@ -5,4 +5,4 @@
                  import { Flags } from '@salesforce/sf-plugins-core';
                  public static flags = {
                  // setting length or prefix
                  'target-org': Flags.requiredOrg(),
                  // adding properties
                  'flag2': Flags.requiredOrg({
                  required: true,
                  description: 'flag2 description',
                  char: 'o'
                  }),
                  }
                  -
                  +
                  diff --git a/functions/flags_salesforceId.salesforceIdFlag.html b/functions/flags_salesforceId.salesforceIdFlag.html index eb535305..69a10a41 100644 --- a/functions/flags_salesforceId.salesforceIdFlag.html +++ b/functions/flags_salesforceId.salesforceIdFlag.html @@ -2,4 +2,4 @@
                  import { 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',
                  }),
                  }
                  -
                  +
                  diff --git a/functions/stubUx.stubPrompter.html b/functions/stubUx.stubPrompter.html index 4f04e19a..0c92f134 100644 --- a/functions/stubUx.stubPrompter.html +++ b/functions/stubUx.stubPrompter.html @@ -2,4 +2,4 @@

                  Parameters

                  Returns {
                      confirm: SinonStub<[PromptInputs<boolean>], Promise<boolean>>;
                      secret: SinonStub<[PromptInputs<string>], Promise<string>>;
                  }

                  import { stubPrompter } from '@salesforce/sf-plugins-core';
                  let prompterStubs: ReturnType<typeof stubPrompter>;

                  // inside your beforeEach, $$ is a SinonSandbox
                  prompterStubs = stubPrompter($$.SANDBOX);

                  // inside some test
                  expect(prompterStubs.confirm.firstCall.args[0]).to.equal(
                  messages.getMessage('confirmDelete', ['scratch', testOrg.username])
                  );
                  -
                  +
                  diff --git a/functions/stubUx.stubSfCommandUx.html b/functions/stubUx.stubSfCommandUx.html index 5c7f090c..808e35de 100644 --- a/functions/stubUx.stubSfCommandUx.html +++ b/functions/stubUx.stubSfCommandUx.html @@ -3,4 +3,4 @@

                  Parameters

                  Returns {
                      info: SinonStub<[input: Info], void>;
                      log: SinonStub<[message?: string, ...args: any[]], void>;
                      logJson: SinonStub<[json: unknown], void>;
                      logSensitive: SinonStub<[msg?: string], void>;
                      logSuccess: SinonStub<[message: string], void>;
                      logToStderr: SinonStub<[message?: string, ...args: any[]], void>;
                      styledHeader: SinonStub<[text: string], void>;
                      styledJSON: SinonStub<[obj: AnyJson], void>;
                      styledObject: SinonStub<[obj: AnyJson], void>;
                      table: SinonStub<[options: TableOptions<Record<string, unknown>>], void>;
                      url: SinonStub<[text: string, uri: string, params: {}], void>;
                      warn: SinonStub<[input: Warning], Warning>;
                  }

                  import { stubSfCommandUx } from '@salesforce/sf-plugins-core';
                  let stubSfCommandUxStubs: ReturnType<typeof stubSfCommandUx>;

                  // inside your beforeEach, $$ is a SinonSandbox
                  cmdStubs = stubSfCommandUx($$.SANDBOX);

                  // inside some test
                  expect(cmdStubs.warn.args.flat()).to.deep.include(`foo`);
                  -
                  +
                  diff --git a/functions/stubUx.stubSpinner.html b/functions/stubUx.stubSpinner.html index e649124c..5671603a 100644 --- a/functions/stubUx.stubSpinner.html +++ b/functions/stubUx.stubSpinner.html @@ -3,4 +3,4 @@

                  Parameters

                  Returns {
                      start: SinonStub<[action: string, status?: string, opts?: {
                          stdout?: boolean;
                      }], void>;
                      stop: SinonStub<[msg?: string], void>;
                  }

                  import { stubSpinner } from '@salesforce/sf-plugins-core';
                  let spinnerStubs: ReturnType<typeof stubSpinner>;

                  // inside your beforeEach, $$ is a SinonSandbox
                  spinnerStubs = stubSpinner($$.SANDBOX);

                  // inside some test
                  expect(spinnerStubs.callCount).equals(1);
                  -
                  +
                  diff --git a/functions/stubUx.stubUx.html b/functions/stubUx.stubUx.html index fd3b6a08..d566e26b 100644 --- a/functions/stubUx.stubUx.html +++ b/functions/stubUx.stubUx.html @@ -3,4 +3,4 @@

                  Parameters

                  Returns {
                      log: SinonStub<[message?: string, ...args: string[]], void>;
                      styledHeader: SinonStub<[text: string], void>;
                      styledJSON: SinonStub<[obj: AnyJson, theme?: Record<string, string>], void>;
                      styledObject: SinonStub<[obj: AnyJson, keys?: string[]], void>;
                      table: SinonStub<[options: TableOptions<Record<string, unknown>>], void>;
                      url: SinonStub<[text: string, uri: string, params: {}], void>;
                      warn: SinonStub<[message: string | Error], void>;
                  }

                  import { stubUx } from '@salesforce/sf-plugins-core';
                  let stubUxStubs: ReturnType<typeof stubUx>;

                  // inside your beforeEach, $$ is a SinonSandbox
                  stubUxStubs = stubUx($$.SANDBOX);

                  // inside some test
                  expect(stubUxStubs.log.args.flat()).to.deep.include(`foo`);
                  -
                  +
                  diff --git a/functions/util.parseVarArgs.html b/functions/util.parseVarArgs.html index 17e95220..70ba08be 100644 --- a/functions/util.parseVarArgs.html +++ b/functions/util.parseVarArgs.html @@ -1 +1 @@ -parseVarArgs | @salesforce/sf-plugins-core
                  • Parameters

                    • args: Record<string, unknown>
                    • argv: string[]

                    Returns Record<string, string | undefined>

                  +parseVarArgs | @salesforce/sf-plugins-core
                  • Parameters

                    • args: Record<string, unknown>
                    • argv: string[]

                    Returns Record<string, string | undefined>

                  diff --git a/functions/util.removeEmpty.html b/functions/util.removeEmpty.html index f1e4a05c..0a9e11eb 100644 --- a/functions/util.removeEmpty.html +++ b/functions/util.removeEmpty.html @@ -1 +1 @@ -removeEmpty | @salesforce/sf-plugins-core
                  • Parameters

                    • obj: Record<string, unknown>

                    Returns Record<string, unknown>

                  +removeEmpty | @salesforce/sf-plugins-core
                  • Parameters

                    • obj: Record<string, unknown>

                    Returns Record<string, unknown>

                  diff --git a/functions/util.toHelpSection.html b/functions/util.toHelpSection.html index d44be60c..4cad8453 100644 --- a/functions/util.toHelpSection.html +++ b/functions/util.toHelpSection.html @@ -2,4 +2,4 @@ Takes a string to be used as section header text and an array of enums that identify the variable or property to be included in the help body.

                  -

                  Parameters

                  Returns HelpSection

                  +

                  Parameters

                  Returns HelpSection

                  diff --git a/functions/ux_prompts.confirm.html b/functions/ux_prompts.confirm.html index a273174e..7463b024 100644 --- a/functions/ux_prompts.confirm.html +++ b/functions/ux_prompts.confirm.html @@ -1 +1 @@ -confirm | @salesforce/sf-plugins-core
                  +confirm | @salesforce/sf-plugins-core
                  diff --git a/functions/ux_prompts.secretPrompt.html b/functions/ux_prompts.secretPrompt.html index 2c3f85f4..2f907baf 100644 --- a/functions/ux_prompts.secretPrompt.html +++ b/functions/ux_prompts.secretPrompt.html @@ -1 +1 @@ -secretPrompt | @salesforce/sf-plugins-core
                  +secretPrompt | @salesforce/sf-plugins-core
                  diff --git a/functions/ux_styledObject.default.html b/functions/ux_styledObject.default.html index da7dc799..497f9caf 100644 --- a/functions/ux_styledObject.default.html +++ b/functions/ux_styledObject.default.html @@ -1 +1 @@ -default | @salesforce/sf-plugins-core
                  +default | @salesforce/sf-plugins-core
                  diff --git a/functions/ux_table.convertToNewTableAPI.html b/functions/ux_table.convertToNewTableAPI.html index 0e2d805f..39b9e34f 100644 --- a/functions/ux_table.convertToNewTableAPI.html +++ b/functions/ux_table.convertToNewTableAPI.html @@ -10,4 +10,4 @@
                • 'print-line'
                • Type Parameters

                  Parameters

                  Returns TableOptions<Record<string, unknown>>

                  Please use the new table API directly.

                  -
                  +
                  diff --git a/modules/SfCommandError.html b/modules/SfCommandError.html index 528d8250..82a1fc15 100644 --- a/modules/SfCommandError.html +++ b/modules/SfCommandError.html @@ -1,3 +1,3 @@ -SfCommandError | @salesforce/sf-plugins-core

                  Index

                  Classes

                  SfCommandError +SfCommandError | @salesforce/sf-plugins-core
                  diff --git a/modules/compatibility.html b/modules/compatibility.html index 2ea3eda2..b76a7f53 100644 --- a/modules/compatibility.html +++ b/modules/compatibility.html @@ -1,4 +1,4 @@ -compatibility | @salesforce/sf-plugins-core

                  Index

                  Type Aliases

                  ArrayWithDeprecationOptions +compatibility | @salesforce/sf-plugins-core

                  Index

                  Type Aliases

                  Variables

                  loglevel optionalHubFlagWithDeprecations optionalOrgFlagWithDeprecations diff --git a/modules/errorFormatting.html b/modules/errorFormatting.html index c72f8b82..73a64852 100644 --- a/modules/errorFormatting.html +++ b/modules/errorFormatting.html @@ -1,2 +1,2 @@ -errorFormatting | @salesforce/sf-plugins-core

                  Index

                  Functions

                  formatError +errorFormatting | @salesforce/sf-plugins-core
                  diff --git a/modules/errorHandling.html b/modules/errorHandling.html index 3fc82780..896254db 100644 --- a/modules/errorHandling.html +++ b/modules/errorHandling.html @@ -1,4 +1,4 @@ -errorHandling | @salesforce/sf-plugins-core

                  Index

                  Functions

                  computeErrorCode +errorHandling | @salesforce/sf-plugins-core
                  diff --git a/modules/exported.html b/modules/exported.html index 0915ef8f..3c3ea6ff 100644 --- a/modules/exported.html +++ b/modules/exported.html @@ -1,4 +1,4 @@ -exported | @salesforce/sf-plugins-core

                  References

                  ArrayWithDeprecationOptions +exported | @salesforce/sf-plugins-core

                  References

                  ArrayWithDeprecationOptions Flags Progress SfCommand diff --git a/modules/flags_duration.html b/modules/flags_duration.html index d0936ec4..8024469f 100644 --- a/modules/flags_duration.html +++ b/modules/flags_duration.html @@ -1,3 +1,3 @@ -flags/duration | @salesforce/sf-plugins-core

                  Index

                  Type Aliases

                  DurationFlagConfig +flags/duration | @salesforce/sf-plugins-core
                  diff --git a/modules/flags_flags.html b/modules/flags_flags.html index 1ea7349d..ef565862 100644 --- a/modules/flags_flags.html +++ b/modules/flags_flags.html @@ -1,2 +1,2 @@ -flags/flags | @salesforce/sf-plugins-core

                  Index

                  Variables

                  Flags +flags/flags | @salesforce/sf-plugins-core

                  Index

                  Variables

                  diff --git a/modules/flags_orgApiVersion.html b/modules/flags_orgApiVersion.html index 253e0aa7..d1a7de2b 100644 --- a/modules/flags_orgApiVersion.html +++ b/modules/flags_orgApiVersion.html @@ -1,4 +1,4 @@ -flags/orgApiVersion | @salesforce/sf-plugins-core

                  Index

                  Variables

                  maxDeprecated +flags/orgApiVersion | @salesforce/sf-plugins-core

                  Index

                  Variables

                  Functions

                  orgApiVersionFlag diff --git a/modules/flags_orgFlags.html b/modules/flags_orgFlags.html index 46c00988..119739f4 100644 --- a/modules/flags_orgFlags.html +++ b/modules/flags_orgFlags.html @@ -1,4 +1,4 @@ -flags/orgFlags | @salesforce/sf-plugins-core

                  Index

                  Functions

                  getHubOrThrow +flags/orgFlags | @salesforce/sf-plugins-core

                  Index

                  Functions

                  getHubOrThrow getOrgOrThrow maybeGetHub maybeGetOrg diff --git a/modules/flags_salesforceId.html b/modules/flags_salesforceId.html index 3b45964a..c3c096c9 100644 --- a/modules/flags_salesforceId.html +++ b/modules/flags_salesforceId.html @@ -1,3 +1,3 @@ -flags/salesforceId | @salesforce/sf-plugins-core

                  Index

                  Type Aliases

                  IdFlagConfig +flags/salesforceId | @salesforce/sf-plugins-core
                  diff --git a/modules/sfCommand.SfCommand.html b/modules/sfCommand.SfCommand.html index b6ad115b..7ce08580 100644 --- a/modules/sfCommand.SfCommand.html +++ b/modules/sfCommand.SfCommand.html @@ -1,4 +1,4 @@ -SfCommand | @salesforce/sf-plugins-core

                  Index

                  Type Aliases

                  Error +SfCommand | @salesforce/sf-plugins-core

                  Index

                  Type Aliases

                  Error Info Json Warning diff --git a/modules/sfCommand.html b/modules/sfCommand.html index 48606fec..eb8e95f8 100644 --- a/modules/sfCommand.html +++ b/modules/sfCommand.html @@ -1,4 +1,4 @@ -sfCommand | @salesforce/sf-plugins-core

                  Index

                  Namespaces

                  SfCommand +sfCommand | @salesforce/sf-plugins-core

                  Index

                  Namespaces

                  Classes

                  Type Aliases

                  diff --git a/modules/stubUx.html b/modules/stubUx.html index ba7d69bd..8e3c3cb5 100644 --- a/modules/stubUx.html +++ b/modules/stubUx.html @@ -1,4 +1,4 @@ -stubUx | @salesforce/sf-plugins-core

                  Index

                  Functions

                  stubPrompter +stubUx | @salesforce/sf-plugins-core

                  Index

                  Functions

                  stubPrompter stubSfCommandUx stubSpinner stubUx diff --git a/modules/util.html b/modules/util.html index 382906bb..ee2f0790 100644 --- a/modules/util.html +++ b/modules/util.html @@ -1,4 +1,4 @@ -util | @salesforce/sf-plugins-core

                  Index

                  Functions

                  parseVarArgs +util | @salesforce/sf-plugins-core
                  diff --git a/modules/ux_base.html b/modules/ux_base.html index 1c076063..07c13028 100644 --- a/modules/ux_base.html +++ b/modules/ux_base.html @@ -1,2 +1,2 @@ -ux/base | @salesforce/sf-plugins-core

                  Index

                  Classes

                  UxBase +ux/base | @salesforce/sf-plugins-core

                  Index

                  Classes

                  diff --git a/modules/ux_progress.Progress.html b/modules/ux_progress.Progress.html index c4877435..e782523c 100644 --- a/modules/ux_progress.Progress.html +++ b/modules/ux_progress.Progress.html @@ -1,4 +1,4 @@ -Progress | @salesforce/sf-plugins-core

                  Index

                  Type Aliases

                  Bar +Progress | @salesforce/sf-plugins-core
                  diff --git a/modules/ux_progress.html b/modules/ux_progress.html index 745ec8bb..f0074caf 100644 --- a/modules/ux_progress.html +++ b/modules/ux_progress.html @@ -1,3 +1,3 @@ -ux/progress | @salesforce/sf-plugins-core

                  Index

                  Namespaces

                  Progress +ux/progress | @salesforce/sf-plugins-core

                  Index

                  Namespaces

                  Classes

                  diff --git a/modules/ux_prompts.html b/modules/ux_prompts.html index 1fd7b3fb..4a145a89 100644 --- a/modules/ux_prompts.html +++ b/modules/ux_prompts.html @@ -1,4 +1,4 @@ -ux/prompts | @salesforce/sf-plugins-core

                  Index

                  Type Aliases

                  PromptInputs +ux/prompts | @salesforce/sf-plugins-core

                  Index

                  Type Aliases

                  Variables

                  Functions

                  confirm secretPrompt diff --git a/modules/ux_spinner.html b/modules/ux_spinner.html index 735c099f..1335c248 100644 --- a/modules/ux_spinner.html +++ b/modules/ux_spinner.html @@ -1,2 +1,2 @@ -ux/spinner | @salesforce/sf-plugins-core

                  Index

                  Classes

                  Spinner +ux/spinner | @salesforce/sf-plugins-core
                  diff --git a/modules/ux_standardColors.html b/modules/ux_standardColors.html index 1b766496..575fa10e 100644 --- a/modules/ux_standardColors.html +++ b/modules/ux_standardColors.html @@ -1,2 +1,2 @@ -ux/standardColors | @salesforce/sf-plugins-core

                  Index

                  Variables

                  StandardColors +ux/standardColors | @salesforce/sf-plugins-core
                  diff --git a/modules/ux_styledObject.html b/modules/ux_styledObject.html index 5de44a16..672afac3 100644 --- a/modules/ux_styledObject.html +++ b/modules/ux_styledObject.html @@ -1,2 +1,2 @@ -ux/styledObject | @salesforce/sf-plugins-core

                  Index

                  Functions

                  default +ux/styledObject | @salesforce/sf-plugins-core
                  diff --git a/modules/ux_table.html b/modules/ux_table.html index 6fddb68b..9ada27ed 100644 --- a/modules/ux_table.html +++ b/modules/ux_table.html @@ -1,2 +1,2 @@ -ux/table | @salesforce/sf-plugins-core

                  Index

                  Functions

                  convertToNewTableAPI +ux/table | @salesforce/sf-plugins-core
                  diff --git a/modules/ux_ux.html b/modules/ux_ux.html index b9b360e6..a078a160 100644 --- a/modules/ux_ux.html +++ b/modules/ux_ux.html @@ -1,2 +1,2 @@ -ux/ux | @salesforce/sf-plugins-core

                  Index

                  Classes

                  Ux +ux/ux | @salesforce/sf-plugins-core

                  Index

                  Classes

                  diff --git a/types/SfCommandError.SfCommandErrorOptions.html b/types/SfCommandError.SfCommandErrorOptions.html index b9c01347..d4b1b16b 100644 --- a/types/SfCommandError.SfCommandErrorOptions.html +++ b/types/SfCommandError.SfCommandErrorOptions.html @@ -1 +1 @@ -SfCommandErrorOptions | @salesforce/sf-plugins-core
                  SfCommandErrorOptions<T>: {
                      actions?: string[];
                      cause?: unknown;
                      code: string;
                      commandName: string;
                      context?: string;
                      data?: T;
                      exitCode: number;
                      message: string;
                      name?: string;
                      result?: unknown;
                      warnings?: (StructuredMessage | string)[];
                  }

                  Type Parameters

                  • T extends ErrorDataProperties = ErrorDataProperties
                  +SfCommandErrorOptions | @salesforce/sf-plugins-core
                  SfCommandErrorOptions<T>: {
                      actions?: string[];
                      cause?: unknown;
                      code: string;
                      commandName: string;
                      context?: string;
                      data?: T;
                      exitCode: number;
                      message: string;
                      name?: string;
                      result?: unknown;
                      warnings?: (StructuredMessage | string)[];
                  }

                  Type Parameters

                  • T extends ErrorDataProperties = ErrorDataProperties
                  diff --git a/types/compatibility.ArrayWithDeprecationOptions.html b/types/compatibility.ArrayWithDeprecationOptions.html index 68178534..40e50d0a 100644 --- a/types/compatibility.ArrayWithDeprecationOptions.html +++ b/types/compatibility.ArrayWithDeprecationOptions.html @@ -1 +1 @@ -ArrayWithDeprecationOptions | @salesforce/sf-plugins-core
                  ArrayWithDeprecationOptions: {
                      multiple?: true;
                      parse?: undefined;
                  }
                  +ArrayWithDeprecationOptions | @salesforce/sf-plugins-core
                  ArrayWithDeprecationOptions: {
                      multiple?: true;
                      parse?: undefined;
                  }
                  diff --git a/types/flags_duration.DurationFlagConfig.html b/types/flags_duration.DurationFlagConfig.html index d4970765..dcc46c89 100644 --- a/types/flags_duration.DurationFlagConfig.html +++ b/types/flags_duration.DurationFlagConfig.html @@ -1 +1 @@ -DurationFlagConfig | @salesforce/sf-plugins-core
                  DurationFlagConfig: {
                      defaultValue?: number;
                      max?: number;
                      min?: number;
                      unit: Required<DurationUnit>;
                  }
                  +DurationFlagConfig | @salesforce/sf-plugins-core
                  DurationFlagConfig: {
                      defaultValue?: number;
                      max?: number;
                      min?: number;
                      unit: Required<DurationUnit>;
                  }
                  diff --git a/types/flags_salesforceId.IdFlagConfig.html b/types/flags_salesforceId.IdFlagConfig.html index 72e90cf5..fdec6ba3 100644 --- a/types/flags_salesforceId.IdFlagConfig.html +++ b/types/flags_salesforceId.IdFlagConfig.html @@ -1,3 +1,3 @@ IdFlagConfig | @salesforce/sf-plugins-core
                  IdFlagConfig: {
                      length?: 15 | 18 | "both";
                      startsWith?: string;
                  }

                  Type declaration

                  • Optionallength?: 15 | 18 | "both"

                    Can specify if the version must be 15 or 18 characters long or 'both'. Leave blank to allow either 15 or 18.

                  • OptionalstartsWith?: string

                    If the ID belongs to a certain sobject type, specify the 3 character prefix.

                    -
                  +
                  diff --git a/types/sfCommand.SfCommand.Error.html b/types/sfCommand.SfCommand.Error.html index 27515877..17e3bd89 100644 --- a/types/sfCommand.SfCommand.Error.html +++ b/types/sfCommand.SfCommand.Error.html @@ -1 +1 @@ -Error | @salesforce/sf-plugins-core
                  +Error | @salesforce/sf-plugins-core
                  diff --git a/types/sfCommand.SfCommand.Info.html b/types/sfCommand.SfCommand.Info.html index 8b422e5c..f8d73eff 100644 --- a/types/sfCommand.SfCommand.Info.html +++ b/types/sfCommand.SfCommand.Info.html @@ -1 +1 @@ -Info | @salesforce/sf-plugins-core
                  Info: StructuredMessage | string
                  +Info | @salesforce/sf-plugins-core
                  Info: StructuredMessage | string
                  diff --git a/types/sfCommand.SfCommand.Json.html b/types/sfCommand.SfCommand.Json.html index d625ba36..b974963c 100644 --- a/types/sfCommand.SfCommand.Json.html +++ b/types/sfCommand.SfCommand.Json.html @@ -1 +1 @@ -Json | @salesforce/sf-plugins-core
                  Json<T>: {
                      result: T;
                      status: number;
                      warnings?: Warning[];
                  }

                  Type Parameters

                  • T
                  +Json | @salesforce/sf-plugins-core
                  Json<T>: {
                      result: T;
                      status: number;
                      warnings?: Warning[];
                  }

                  Type Parameters

                  • T
                  diff --git a/types/sfCommand.SfCommand.Warning.html b/types/sfCommand.SfCommand.Warning.html index 67f30e5c..510fac36 100644 --- a/types/sfCommand.SfCommand.Warning.html +++ b/types/sfCommand.SfCommand.Warning.html @@ -1 +1 @@ -Warning | @salesforce/sf-plugins-core
                  Warning: StructuredMessage | string
                  +Warning | @salesforce/sf-plugins-core
                  Warning: StructuredMessage | string
                  diff --git a/types/sfCommand.SfCommandInterface.html b/types/sfCommand.SfCommandInterface.html index 5599dbda..b3c18251 100644 --- a/types/sfCommand.SfCommandInterface.html +++ b/types/sfCommand.SfCommandInterface.html @@ -1 +1 @@ -SfCommandInterface | @salesforce/sf-plugins-core
                  SfCommandInterface: {
                      configurationVariablesSection?: HelpSection;
                      envVariablesSection?: HelpSection;
                      errorCodes?: HelpSection;
                  } & Command.Class
                  +SfCommandInterface | @salesforce/sf-plugins-core
                  SfCommandInterface: {
                      configurationVariablesSection?: HelpSection;
                      envVariablesSection?: HelpSection;
                      errorCodes?: HelpSection;
                  } & Command.Class
                  diff --git a/types/ux_progress.Progress.Bar.html b/types/ux_progress.Progress.Bar.html index 8748bcbc..aeb904cc 100644 --- a/types/ux_progress.Progress.Bar.html +++ b/types/ux_progress.Progress.Bar.html @@ -1 +1 @@ -Bar | @salesforce/sf-plugins-core
                  Bar: {
                      setTotal: ((num: number) => void);
                      start: ((total: number, startValue: number, payload?: object) => void);
                      stop: (() => void);
                      update: ((num: number, payload?: object) => void);
                  }
                  +Bar | @salesforce/sf-plugins-core
                  Bar: {
                      setTotal: ((num: number) => void);
                      start: ((total: number, startValue: number, payload?: object) => void);
                      stop: (() => void);
                      update: ((num: number, payload?: object) => void);
                  }
                  diff --git a/types/ux_progress.Progress.Options.html b/types/ux_progress.Progress.Options.html index 5eb4370e..cd5edc19 100644 --- a/types/ux_progress.Progress.Options.html +++ b/types/ux_progress.Progress.Options.html @@ -1 +1 @@ -Options | @salesforce/sf-plugins-core
                  Options: {
                      barCompleteChar: string;
                      barIncompleteChar: string;
                      format: string;
                      linewrap: boolean;
                      noTTYOutput: boolean;
                      title: string;
                  }
                  +Options | @salesforce/sf-plugins-core
                  Options: {
                      barCompleteChar: string;
                      barIncompleteChar: string;
                      format: string;
                      linewrap: boolean;
                      noTTYOutput: boolean;
                      title: string;
                  }
                  diff --git a/types/ux_progress.Progress.Payload.html b/types/ux_progress.Progress.Payload.html index ddf0cc4d..aa1c023e 100644 --- a/types/ux_progress.Progress.Payload.html +++ b/types/ux_progress.Progress.Payload.html @@ -1 +1 @@ -Payload | @salesforce/sf-plugins-core
                  Payload: Record<string, unknown>
                  +Payload | @salesforce/sf-plugins-core
                  Payload: Record<string, unknown>
                  diff --git a/types/ux_prompts.PromptInputs.html b/types/ux_prompts.PromptInputs.html index 252f5125..3a191e7e 100644 --- a/types/ux_prompts.PromptInputs.html +++ b/types/ux_prompts.PromptInputs.html @@ -1,4 +1,4 @@ PromptInputs | @salesforce/sf-plugins-core
                  PromptInputs<T>: {
                      defaultAnswer?: T;
                      message: string;
                      ms?: number;
                  }

                  Type Parameters

                  • T

                  Type declaration

                  • OptionaldefaultAnswer?: T

                    default value to offer to the user. Will be used if the user does not respond within the timeout period.

                  • message: string

                    text to display. Do not include a question mark

                  • Optionalms?: number

                    after this many ms, the prompt will time out. If a default value is provided, the default will be used. Otherwise the prompt will throw an error

                    -
                  +
                  diff --git a/variables/compatibility.loglevel.html b/variables/compatibility.loglevel.html index cb18b92e..60af89e5 100644 --- a/variables/compatibility.loglevel.html +++ b/variables/compatibility.loglevel.html @@ -1,4 +1,4 @@ loglevel | @salesforce/sf-plugins-core
                  loglevel: OptionFlag<undefined | string, CustomOptions> = ...

                  Use only for commands that maintain sfdx compatibility. Flag will be hidden and will show a warning if used. Flag does not set the loglevel

                  -
                  +
                  diff --git a/variables/compatibility.optionalHubFlagWithDeprecations.html b/variables/compatibility.optionalHubFlagWithDeprecations.html index 29211ed5..c4d8629b 100644 --- a/variables/compatibility.optionalHubFlagWithDeprecations.html +++ b/variables/compatibility.optionalHubFlagWithDeprecations.html @@ -1 +1 @@ -optionalHubFlagWithDeprecations | @salesforce/sf-plugins-core
                  optionalHubFlagWithDeprecations: OptionFlag<undefined | Org, CustomOptions> = ...
                  +optionalHubFlagWithDeprecations | @salesforce/sf-plugins-core
                  optionalHubFlagWithDeprecations: OptionFlag<undefined | Org, CustomOptions> = ...
                  diff --git a/variables/compatibility.optionalOrgFlagWithDeprecations.html b/variables/compatibility.optionalOrgFlagWithDeprecations.html index 1ad10401..35c3f3a3 100644 --- a/variables/compatibility.optionalOrgFlagWithDeprecations.html +++ b/variables/compatibility.optionalOrgFlagWithDeprecations.html @@ -1 +1 @@ -optionalOrgFlagWithDeprecations | @salesforce/sf-plugins-core
                  optionalOrgFlagWithDeprecations: OptionFlag<Org, CustomOptions> = ...
                  +optionalOrgFlagWithDeprecations | @salesforce/sf-plugins-core
                  optionalOrgFlagWithDeprecations: OptionFlag<Org, CustomOptions> = ...
                  diff --git a/variables/compatibility.orgApiVersionFlagWithDeprecations.html b/variables/compatibility.orgApiVersionFlagWithDeprecations.html index 0e9e188b..2fb19000 100644 --- a/variables/compatibility.orgApiVersionFlagWithDeprecations.html +++ b/variables/compatibility.orgApiVersionFlagWithDeprecations.html @@ -3,4 +3,4 @@
                  import { Flags } from '@salesforce/sf-plugins-core';
                  public static flags = {
                  'api-version': Flags.orgApiVersion({
                  char: 'a',
                  description: 'api version for the org'
                  }),
                  }
                  -
                  +
                  diff --git a/variables/compatibility.requiredHubFlagWithDeprecations.html b/variables/compatibility.requiredHubFlagWithDeprecations.html index b8185893..58617a9e 100644 --- a/variables/compatibility.requiredHubFlagWithDeprecations.html +++ b/variables/compatibility.requiredHubFlagWithDeprecations.html @@ -1 +1 @@ -requiredHubFlagWithDeprecations | @salesforce/sf-plugins-core
                  requiredHubFlagWithDeprecations: OptionFlag<Org, CustomOptions> = ...
                  +requiredHubFlagWithDeprecations | @salesforce/sf-plugins-core
                  requiredHubFlagWithDeprecations: OptionFlag<Org, CustomOptions> = ...
                  diff --git a/variables/compatibility.requiredOrgFlagWithDeprecations.html b/variables/compatibility.requiredOrgFlagWithDeprecations.html index 98062dd3..f424d1ed 100644 --- a/variables/compatibility.requiredOrgFlagWithDeprecations.html +++ b/variables/compatibility.requiredOrgFlagWithDeprecations.html @@ -1 +1 @@ -requiredOrgFlagWithDeprecations | @salesforce/sf-plugins-core
                  requiredOrgFlagWithDeprecations: OptionFlag<Org, CustomOptions> = ...
                  +requiredOrgFlagWithDeprecations | @salesforce/sf-plugins-core
                  requiredOrgFlagWithDeprecations: OptionFlag<Org, CustomOptions> = ...
                  diff --git a/variables/flags_flags.Flags.html b/variables/flags_flags.Flags.html index aa79df71..85ce86ea 100644 --- a/variables/flags_flags.Flags.html +++ b/variables/flags_flags.Flags.html @@ -11,4 +11,4 @@

                  Type Parameters

                  • T extends readonly string[]
                  • P extends CustomOptions

                  Parameters

                  • defaults: Partial<OptionFlag<ReadonlyElementOf<T>[], P>> & {} & ({} | {})

                  Returns FlagDefinition<typeof defaults.options[number], P, {}>

                  export default class MyCommand extends Command {
                  static flags = {
                  name: Flags.option({
                  options: ['foo', 'bar'] as const,
                  })(),
                  }
                  }
                  -
                • <T, P>(defaults): FlagDefinition<typeof defaults.options[number], P, {}>
                • Type Parameters

                  • T extends readonly string[]
                  • P extends CustomOptions

                  Parameters

                  • defaults: Partial<OptionFlag<ReadonlyElementOf<T>, P>> & {} & ({} | {})

                  Returns FlagDefinition<typeof defaults.options[number], P, {}>

                • <T, P>(defaults): FlagDefinition<typeof defaults.options[number], P, {}>
                • Type Parameters

                  • T extends readonly string[]
                  • P extends CustomOptions

                  Parameters

                  • defaults: Partial<OptionFlag<ReadonlyElementOf<T>, P>> & {}

                  Returns FlagDefinition<typeof defaults.options[number], P, {}>

                • <T, P>(defaults): FlagDefinition<typeof defaults.options[number], P, {}>
                • Type Parameters

                  • T extends readonly string[]
                  • P extends CustomOptions

                  Parameters

                  • defaults: Partial<OptionFlag<ReadonlyElementOf<T>[], P>> & {}

                  Returns FlagDefinition<typeof defaults.options[number], P, {}>

                • optionalHub: FlagDefinition<Org, CustomOptions, {}>
                • optionalOrg: FlagDefinition<Org, CustomOptions, {}>
                • orgApiVersion: FlagDefinition<string, CustomOptions, {}>
                • requiredHub: FlagDefinition<Org, CustomOptions, {}>
                • requiredOrg: FlagDefinition<Org, CustomOptions, {}>
                • salesforceId: FlagDefinition<string, IdFlagConfig, {}>
                • string: FlagDefinition<string, CustomOptions, {}>
                • url: FlagDefinition<URL, CustomOptions, {}>
                • +
                • <T, P>(defaults): FlagDefinition<typeof defaults.options[number], P, {}>
                • Type Parameters

                  • T extends readonly string[]
                  • P extends CustomOptions

                  Parameters

                  • defaults: Partial<OptionFlag<ReadonlyElementOf<T>, P>> & {} & ({} | {})

                  Returns FlagDefinition<typeof defaults.options[number], P, {}>

                • <T, P>(defaults): FlagDefinition<typeof defaults.options[number], P, {}>
                • Type Parameters

                  • T extends readonly string[]
                  • P extends CustomOptions

                  Parameters

                  • defaults: Partial<OptionFlag<ReadonlyElementOf<T>, P>> & {}

                  Returns FlagDefinition<typeof defaults.options[number], P, {}>

                • <T, P>(defaults): FlagDefinition<typeof defaults.options[number], P, {}>
                • Type Parameters

                  • T extends readonly string[]
                  • P extends CustomOptions

                  Parameters

                  • defaults: Partial<OptionFlag<ReadonlyElementOf<T>[], P>> & {}

                  Returns FlagDefinition<typeof defaults.options[number], P, {}>

                • optionalHub: FlagDefinition<Org, CustomOptions, {}>
                • optionalOrg: FlagDefinition<Org, CustomOptions, {}>
                • orgApiVersion: FlagDefinition<string, CustomOptions, {}>
                • requiredHub: FlagDefinition<Org, CustomOptions, {}>
                • requiredOrg: FlagDefinition<Org, CustomOptions, {}>
                • salesforceId: FlagDefinition<string, IdFlagConfig, {}>
                • string: FlagDefinition<string, CustomOptions, {}>
                • url: FlagDefinition<URL, CustomOptions, {}>
                • diff --git a/variables/flags_orgApiVersion.maxDeprecated.html b/variables/flags_orgApiVersion.maxDeprecated.html index 2fc455f4..fcde69ae 100644 --- a/variables/flags_orgApiVersion.maxDeprecated.html +++ b/variables/flags_orgApiVersion.maxDeprecated.html @@ -1 +1 @@ -maxDeprecated | @salesforce/sf-plugins-core
                  maxDeprecated: 30 = 30
                  +maxDeprecated | @salesforce/sf-plugins-core
                  maxDeprecated: 30 = 30
                  diff --git a/variables/flags_orgApiVersion.maxDeprecatedUrl.html b/variables/flags_orgApiVersion.maxDeprecatedUrl.html index e4a501a0..f6fc8cf8 100644 --- a/variables/flags_orgApiVersion.maxDeprecatedUrl.html +++ b/variables/flags_orgApiVersion.maxDeprecatedUrl.html @@ -1 +1 @@ -maxDeprecatedUrl | @salesforce/sf-plugins-core
                  maxDeprecatedUrl: "https://help.salesforce.com/s/articleView?id=000354473&type=1;" = 'https://help.salesforce.com/s/articleView?id=000354473&type=1;'
                  +maxDeprecatedUrl | @salesforce/sf-plugins-core
                  maxDeprecatedUrl: "https://help.salesforce.com/s/articleView?id=000354473&type=1;" = 'https://help.salesforce.com/s/articleView?id=000354473&type=1;'
                  diff --git a/variables/flags_orgApiVersion.minValidApiVersion.html b/variables/flags_orgApiVersion.minValidApiVersion.html index 06d26ad0..e6dc3c14 100644 --- a/variables/flags_orgApiVersion.minValidApiVersion.html +++ b/variables/flags_orgApiVersion.minValidApiVersion.html @@ -1 +1 @@ -minValidApiVersion | @salesforce/sf-plugins-core
                  minValidApiVersion: 21 = 21
                  +minValidApiVersion | @salesforce/sf-plugins-core
                  minValidApiVersion: 21 = 21
                  diff --git a/variables/ux_prompts.prompts.html b/variables/ux_prompts.prompts.html index 0922d8f9..2b95e554 100644 --- a/variables/ux_prompts.prompts.html +++ b/variables/ux_prompts.prompts.html @@ -1 +1 @@ -prompts | @salesforce/sf-plugins-core
                  prompts: {
                      confirm: ((__namedParameters: PromptInputs<boolean>) => Promise<boolean>);
                      secretPrompt: ((__namedParameters: PromptInputs<string>) => Promise<string>);
                  } = ...
                  +prompts | @salesforce/sf-plugins-core
                  prompts: {
                      confirm: ((__namedParameters: PromptInputs<boolean>) => Promise<boolean>);
                      secretPrompt: ((__namedParameters: PromptInputs<string>) => Promise<string>);
                  } = ...
                  diff --git a/variables/ux_standardColors.StandardColors.html b/variables/ux_standardColors.StandardColors.html index 28cd4bde..36a63e7d 100644 --- a/variables/ux_standardColors.StandardColors.html +++ b/variables/ux_standardColors.StandardColors.html @@ -1 +1 @@ -StandardColors | @salesforce/sf-plugins-core
                  StandardColors: {
                      error: Ansis;
                      info: Ansis;
                      success: Ansis;
                      warning: Ansis;
                  } = ...
                  +StandardColors | @salesforce/sf-plugins-core
                  StandardColors: {
                      error: Ansis;
                      info: Ansis;
                      success: Ansis;
                      warning: Ansis;
                  } = ...