Class PromptUtils

Index

Constructors

Methods

createPathExcludeFilter getFuzzyPathExclude getKeyPathExclude createCertFileQuestion createKeyFileQuestion promptFuzzyPath promptCertFile promptKeyFile selectPreset promptForCommonName promptManualDetails promptForVariables

Constructors

constructor

new PromptUtils(): PromptUtils
Returns PromptUtils

Methods

`Static`createPathExcludeFilter

createPathExcludeFilter(
allowedExtensions: string[],
): (nodePath: string) => boolean
Creates a filter function for fuzzy path that excludes standard directories and filters files by allowed extensions.
Parameters
- allowedExtensions: string[]
  Array of file extensions to allow (e.g., ['.pem', '.crt'])
Returns (nodePath: string) => boolean
- Defined in src/utils/prompts.ts:30

`Static`getFuzzyPathExclude

getFuzzyPathExclude(): (nodePath: string) => boolean
Returns a filter function for inquirer-fuzzy-path to exclude non-certificate files and standard ignored directories.

Returns (nodePath: string) => boolean
- Defined in src/utils/prompts.ts:56

`Static`getKeyPathExclude

getKeyPathExclude(): (nodePath: string) => boolean
Returns a filter function for inquirer-fuzzy-path to exclude non-key files and standard ignored directories.

Returns (nodePath: string) => boolean
- Defined in src/utils/prompts.ts:64

`Static`createCertFileQuestion

createCertFileQuestion(name: string, message: string): FuzzyPathQuestion
Creates a FuzzyPathQuestion for selecting certificate files.
Parameters
- name: string
  The answer key name
- message: string
  The prompt message to display
Returns FuzzyPathQuestion
- Defined in src/utils/prompts.ts:73

`Static`createKeyFileQuestion

createKeyFileQuestion(name: string, message: string): FuzzyPathQuestion
Creates a FuzzyPathQuestion for selecting private key files.
Parameters
- name: string
  The answer key name
- message: string
  The prompt message to display
Returns FuzzyPathQuestion
- Defined in src/utils/prompts.ts:91

`Static`promptFuzzyPath

promptFuzzyPath<T extends string = string>(
question: FuzzyPathQuestion,
): Promise<T>
Prompts user to select a file using fuzzy path search.
Type Parameters
- T extends string = string
Parameters
- question: FuzzyPathQuestion
  The FuzzyPathQuestion configuration
Returns Promise<T>
The selected file path
- Defined in src/utils/prompts.ts:109

`Static`promptCertFile

promptCertFile(message: string): Promise<string>
Shorthand to prompt for a certificate file.
Parameters
- message: string
  The prompt message
Returns Promise<string>
The selected certificate file path
- Defined in src/utils/prompts.ts:123

`Static`promptKeyFile

promptKeyFile(message: string): Promise<string>
Shorthand to prompt for a private key file.
Parameters
- message: string
  The prompt message
Returns Promise<string>
The selected key file path
- Defined in src/utils/prompts.ts:133

`Static`selectPreset

selectPreset(presets: Record<string, ConfigPreset>): Promise<string>
Prompts the user to select a preset from the available configuration.
Parameters
- presets: Record<string, ConfigPreset>
Returns Promise<string>
- Defined in src/utils/prompts.ts:141

`Static`promptForCommonName

promptForCommonName(): Promise<string>
Prompts for the Common Name (CN)

Returns Promise<string>
- Defined in src/utils/prompts.ts:184

`Static`promptManualDetails

promptManualDetails(
    defaults: ConfigPkiDefaults,
): Promise<
    {
        countryName: string;
        stateOrProvinceName: string;
        localityName: string;
        organizationName: string;
        organizationalUnitName: string;
        validityDays: number;
        sanInput: string;
        keyAlgo: "rsa";
        keySize: number;
    },
>
Prompts for manual certificate details
Parameters
- defaults: ConfigPkiDefaults
Returns Promise<
    {
        countryName: string;
        stateOrProvinceName: string;
        localityName: string;
        organizationName: string;
        organizationalUnitName: string;
        validityDays: number;
        sanInput: string;
        keyAlgo: "rsa";
        keySize: number;
    },
>
- Defined in src/utils/prompts.ts:200

`Static`promptForVariables

promptForVariables(
preset: ConfigPreset,
existingOptions: Record<string, unknown>,
): Promise<Record<string, unknown>>
Prompts the user for variables defined in the preset, skipping those already provided.
Parameters
- preset: ConfigPreset
- existingOptions: Record<string, unknown>
Returns Promise<Record<string, unknown>>
- Defined in src/utils/prompts.ts:273

Class PromptUtils

Index

Constructors

Methods

Constructors

constructor

Returns PromptUtils

Methods

StaticcreatePathExcludeFilter

Parameters

Returns (nodePath: string) => boolean

StaticgetFuzzyPathExclude

Returns (nodePath: string) => boolean

StaticgetKeyPathExclude

Returns (nodePath: string) => boolean

StaticcreateCertFileQuestion

Parameters

Returns FuzzyPathQuestion

StaticcreateKeyFileQuestion

Parameters

Returns FuzzyPathQuestion

StaticpromptFuzzyPath

Type Parameters

Parameters

Returns Promise<T>

StaticpromptCertFile

Parameters

Returns Promise<string>

StaticpromptKeyFile

Parameters

Returns Promise<string>

StaticselectPreset

Parameters

Returns Promise<string>

StaticpromptForCommonName

Returns Promise<string>

StaticpromptManualDetails

Parameters

Returns Promise< { countryName: string; stateOrProvinceName: string; localityName: string; organizationName: string; organizationalUnitName: string; validityDays: number; sanInput: string; keyAlgo: "rsa"; keySize: number; },>

StaticpromptForVariables

Parameters

Returns Promise<Record<string, unknown>>

Settings

On This Page

`Static`createPathExcludeFilter

`Static`getFuzzyPathExclude

`Static`getKeyPathExclude

`Static`createCertFileQuestion

`Static`createKeyFileQuestion

`Static`promptFuzzyPath

`Static`promptCertFile

`Static`promptKeyFile

`Static`selectPreset

`Static`promptForCommonName

`Static`promptManualDetails

Returns Promise<
{
countryName: string;
stateOrProvinceName: string;
localityName: string;
organizationName: string;
organizationalUnitName: string;
validityDays: number;
sanInput: string;
keyAlgo: "rsa";
keySize: number;
},
>

`Static`promptForVariables