input

type Asker func(p survey.Prompt, response any) error

type AskerConsole struct {
	// contains filtered or unexported fields
}

type Console interface {
	// Prints out a message to the underlying console write
	Message(ctx context.Context, message string)
	// Prints out a message following a contract ux item
	MessageUxItem(ctx context.Context, item ux.UxItem)
	WarnForFeature(ctx context.Context, id alpha.FeatureId)
	// Prints progress spinner with the given title.
	// If a previous spinner is running, the title is updated.
	ShowSpinner(ctx context.Context, title string, format SpinnerUxType)
	// Stop the current spinner from the console and change the spinner bar for the lastMessage
	// Set lastMessage to empty string to clear the spinner message instead of a displaying a last message
	// If there is no spinner running, this is a no-op function
	StopSpinner(ctx context.Context, lastMessage string, format SpinnerUxType)
	// Preview mode brings an embedded console within the current session.
	// Use nil for options to use defaults.
	// Use the returned io.Writer to produce the output within the previewer
	ShowPreviewer(ctx context.Context, options *ShowPreviewerOptions) io.Writer
	// Finalize the preview mode from console.
	StopPreviewer(ctx context.Context, keepLogs bool)
	// Determines if there is a current spinner running.
	IsSpinnerRunning(ctx context.Context) bool
	// Determines if the current spinner is an interactive spinner, where messages are updated periodically.
	// If false, the spinner is non-interactive, which means messages are rendered as a new console message on each
	// call to ShowSpinner, even when the title is unchanged.
	IsSpinnerInteractive() bool
	// IsNoPromptMode returns true when --no-prompt is active and interactive prompts are disabled.
	IsNoPromptMode() bool
	SupportsPromptDialog() bool
	PromptDialog(ctx context.Context, dialog PromptDialog) (map[string]any, error)
	// Prompts the user for a single value
	Prompt(ctx context.Context, options ConsoleOptions) (string, error)
	// PromptFs prompts the user for a filesystem path or directory.
	PromptFs(ctx context.Context, options ConsoleOptions, fsOptions FsOptions) (string, error)
	// Prompts the user to select a single value from a set of values
	Select(ctx context.Context, options ConsoleOptions) (int, error)
	// Prompts the user to select zero or more values from a set of values
	MultiSelect(ctx context.Context, options ConsoleOptions) ([]string, error)
	// Prompts the user to confirm an operation
	Confirm(ctx context.Context, options ConsoleOptions) (bool, error)
	// block terminal until the next enter
	WaitForEnter()
	// Writes a new line to the writer if there if the last two characters written are not '\n'
	EnsureBlankLine(ctx context.Context)
	// Sets the underlying writer for the console
	SetWriter(writer io.Writer)
	// Gets the underlying writer for the console
	GetWriter() io.Writer
	// Gets the standard input, output and error stream
	Handles() ConsoleHandles
	// Executes an interactive action, managing spinner state
	DoInteraction(action func() error) error
	ConsoleShim
}

type ConsoleHandles struct {
	Stdin  io.Reader
	Stdout io.Writer
	Stderr io.Writer
}

type ConsoleOptions struct {
	Message string
	Help    string
	Options []string

	// OptionDetails is an optional field that can be used to provide additional information about the options.
	OptionDetails []string
	DefaultValue  any

	// Prompt-only options
	IsPassword bool
}

type ConsoleShim interface {
	// True if the console was instantiated with no format options.
	IsUnformatted() bool

	// Gets the underlying formatter used by the console
	GetFormatter() output.Formatter
}

type ExternalPromptConfiguration struct {
	Endpoint    string
	Key         string
	Transporter policy.Transporter
	// NoPromptDialog when true, disables the prompt dialog feature even when external prompting is enabled.
	// This causes each prompt to be sent individually through the external prompt API, which is useful
	// for clients that don't support the dialog API but still want location prompts to include the full
	// list of available locations.
	NoPromptDialog bool
}

type FsOptions struct {
	// Root directory.
	Root string

	// Path suggestion options.
	SuggestOpts FsSuggestOptions
}

type FsSuggestOptions struct {
	// Exclude the current directory './' in suggestions. Only applicable if displaying directories.
	ExcludeCurrentDir bool

	// Include hidden files in suggestions.
	IncludeHiddenFiles bool

	// Exclude directories from suggestions.
	ExcludeDirectories bool

	// Exclude files from suggestions.
	ExcludeFiles bool
}

type InputSource struct {
	Kind         InputSourceKind `json:"kind"`
	Name         string          `json:"name"`
	ExampleValue string          `json:"exampleValue,omitempty"`
}

type InputSourceKind string

type InterruptHandler func() (handled bool)

type PromptDialog struct {
	Title       string
	Description string
	Prompts     []PromptDialogItem
}

type PromptDialogChoice struct {
	Value       string
	Description string
}

type PromptDialogItem struct {
	ID           string
	Kind         string
	DisplayName  string
	Description  *string
	DefaultValue *string
	Required     bool
	Choices      []PromptDialogChoice
}

type PromptRequiredError struct {
	// Inputs is the list of required inputs that are missing.
	Inputs []RequiredInput
	// Message is the headline used for structured missing-input output.
	Message string

	// PromptMessage is the prompt text that would have been displayed to the user if interactive prompts were allowed.
	PromptMessage string
}

type RequiredInput struct {
	Name        string        `json:"name"`
	Description string        `json:"description,omitempty"`
	Sources     []InputSource `json:"sources,omitempty"`
}

type ShowPreviewerOptions struct {
	Prefix       string
	MaxLineCount int
	Title        string
}

type SpinnerUxType int

type TerminalWidthFn func() int

type Writers struct {
	// The writer to write output to.
	Output io.Writer

	// The writer to write spinner output to. If nil, the spinner will write to Output.
	Spinner io.Writer
}