actions

type Action interface {
	// Run executes the CLI command.
	//
	// It is currently valid to both return an error and a non-nil ActionResult.
	Run(ctx context.Context) (*ActionResult, error)
}

type ActionDescriptor struct {
	// Name of the descriptor (also used for command name if not specified in options)
	Name string
	// Descriptor options
	Options *ActionDescriptorOptions
	// contains filtered or unexported fields
}

type ActionDescriptorOptions struct {
	// Cobra command configuration
	*cobra.Command
	// Function to resolve / create the flags instance required for the action
	FlagsResolver any
	// Function to resolve / create the action instance
	ActionResolver any
	// Array of support output formats
	OutputFormats []output.Format
	// The default output format if omitted in the command flags
	DefaultFormat output.Format
	// Whether or not telemetry should be disabled for the current action
	DisableTelemetry bool
	// Whether or not troubleshooting should be disabled for the current action
	DisableTroubleshooting bool
	// The logic that produces the command help
	HelpOptions ActionHelpOptions
	// Defines grouping options for the command
	GroupingOptions CommandGroupOptions
	// Whether or not the command requires a principal login
	RequireLogin bool
	// Whether the command should execute as fast as possible, skipping
	// non-essential background work like update checks.
	// Use for programmatic/hidden commands (e.g., auth token) where
	// blocking process exit is unacceptable.
	Lightspeed bool
}

type ActionFunc func(context.Context) (*ActionResult, error)

type ActionHelpGenerator func(cmd *cobra.Command) string

type ActionHelpOptions struct {
	Description ActionHelpGenerator
	Usage       ActionHelpGenerator
	Commands    ActionHelpGenerator
	Flags       ActionHelpGenerator
	Footer      ActionHelpGenerator
}

type ActionResult struct {
	Message *ResultMessage
}

type CommandGroupOptions struct {
	RootLevelHelp RootLevelHelpOption
}

type FlagCompletionFunc func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

type MiddlewareRegistration struct {
	// The name of the middleware used for logging purposes
	Name string
	// The constructor/resolver used to create the middleware instance
	Resolver any
	// An optional predicate to control when this middleware is registered
	Predicate UseMiddlewareWhenPredicate
}

type ResultMessage struct {
	Header   string
	FollowUp string
}

type RootLevelHelpOption string

type UseMiddlewareWhenPredicate func(descriptor *ActionDescriptor) bool