api

type Base struct {
	Header      string `json:"header,omitempty" yaml:"header"`
	Description string `json:"description,omitempty" yaml:"description"`
	Body        Body   `json:"body,omitempty" yaml:"body"`
}

type Body struct {
	CodeBlock string `json:"codeBlock,omitempty" yaml:"codeBlock"`
	Plaintext string `json:"plaintext,omitempty" yaml:"plaintext"`
}

type BotNameOption func(opts *BotNameOptions)

type BotNameOptions struct {
	ClusterName string
}

type BulletList struct {
	Title string   `json:"title,omitempty" yaml:"title"`
	Items []string `json:"items,omitempty" yaml:"items"`
}

type BulletLists []BulletList

type Button struct {
	Description string `json:"description,omitempty" yaml:"description"`

	// DescriptionStyle defines the style of the button description. If not provided, the default style (ButtonDescriptionStyleCode) is used.
	DescriptionStyle ButtonDescriptionStyle `json:"descriptionStyle" yaml:"descriptionStyle"`

	Name    string      `json:"name,omitempty" yaml:"name"`
	Command string      `json:"command,omitempty" yaml:"command"`
	URL     string      `json:"url,omitempty" yaml:"url"`
	Style   ButtonStyle `json:"style,omitempty" yaml:"style"`
}

type ButtonBuilder struct{}

type ButtonDescriptionStyle string

type ButtonStyle string

type Buttons []Button

type ContextItem struct {
	Text string `json:"text,omitempty" yaml:"text"`
}

type ContextItems []ContextItem

type Dependency struct {
	// URLs holds the URLs for a given dependency depending on the platform and architecture.
	URLs URLs `yaml:"urls"`
}

type DispatchedInputAction string

type DividerStyle string

type ExternalRequestMetadata struct {
	// Payload contains the external requests payload information.
	Payload ExternalRequestPayload
}

type ExternalRequestPayload struct {
	// JSONSchema is a JSON schema for a given incoming webhook payload.
	JSONSchema JSONSchema
}

type JSONSchema struct {
	// Value is the JSON schema string.
	Value string
	// RefURL is the remote reference of the schema.
	RefURL string
}

type LabelInput struct {
	Command          string                `json:"command,omitempty" yaml:"command"`
	Text             string                `json:"text,omitempty" yaml:"text"`
	Placeholder      string                `json:"placeholder,omitempty" yaml:"placeholder"`
	DispatchedAction DispatchedInputAction `json:"dispatchedAction,omitempty" yaml:"dispatchedAction"`
}

type LabelInputs []LabelInput

type Message struct {
	Type              MessageType `json:"type,omitempty" yaml:"type"`
	BaseBody          Body        `json:"baseBody,omitempty" yaml:"baseBody"`
	Timestamp         time.Time   `json:"timestamp,omitempty" yaml:"timestamp"`
	Sections          []Section   `json:"sections,omitempty" yaml:"sections"`
	PlaintextInputs   LabelInputs `json:"plaintextInputs,omitempty" yaml:"plaintextInputs"`
	OnlyVisibleForYou bool        `json:"onlyVisibleForYou,omitempty" yaml:"onlyVisibleForYou"`
	ReplaceOriginal   bool        `json:"replaceOriginal,omitempty" yaml:"replaceOriginal"`
	UserHandle        string      `json:"userHandle,omitempty" yaml:"userHandle"`

	// ParentActivityID represents the originating message that started a thread. If set, message will be sent in that thread instead of the default one.
	ParentActivityID string `json:"parentActivityId,omitempty" yaml:"parentActivityId,omitempty"`
}

type MessageType string

type MetadataOutput struct {
	// Version is a version of a given plugin. It should follow the SemVer syntax.
	Version string
	// Descriptions is a description of a given plugin.
	Description string
	// URL to plugin documentation.
	DocumentationURL string
	// JSONSchema is a JSON schema for a given plugin configuration.
	JSONSchema JSONSchema

	// ExternalRequest holds the metadata for external requests.
	ExternalRequest ExternalRequestMetadata

	// Dependencies holds the dependencies for a given platform binary.
	Dependencies map[string]Dependency
	// Recommended plugin recommended
	Recommended bool
}

type MultiSelect struct {
	Name        string `json:"name,omitempty" yaml:"name"`
	Description Body   `json:"description,omitempty" yaml:"description"`
	Command     string `json:"command,omitempty" yaml:"command"`

	// Options holds all available options
	Options []OptionItem `json:"options,omitempty" yaml:"options"`

	// InitialOptions hold already pre-selected options. MUST be a sub-set of Options.
	InitialOptions []OptionItem `json:"initialOptions,omitempty" yaml:"initialOptions"`
}

type OptionGroup struct {
	Name    string       `json:"name,omitempty" yaml:"name"`
	Options []OptionItem `json:"options,omitempty" yaml:"options"`
}

type OptionItem struct {
	Name  string `json:"name,omitempty" yaml:"name"`
	Value string `json:"value,omitempty" yaml:"value"`
}

type PluginDependencyURLsGetter interface {
	GetUrls() map[string]string
}

type PluginDependencyURLsSetter[T any] interface {
	SetUrls(in map[string]string)
	*T // This is needed to ensure we can create an instance of the concrete type as a part of the ConvertDependenciesFromAPI function.
}

type Section struct {
	Style SectionStyle `json:"style,omitempty" yaml:"style"`

	Base            `json:",inline" yaml:"base"`
	Buttons         Buttons      `json:"buttons,omitempty" yaml:"buttons"`
	MultiSelect     MultiSelect  `json:"multiSelect,omitempty" yaml:"multiSelect"`
	Selects         Selects      `json:"selects,omitempty" yaml:"selects"`
	PlaintextInputs LabelInputs  `json:"plaintextInputs,omitempty" yaml:"plaintextInputs"`
	TextFields      TextFields   `json:"textFields,omitempty" yaml:"textFields"`
	BulletLists     BulletLists  `json:"bulletLists,omitempty" yaml:"bulletLists"`
	Context         ContextItems `json:"context,omitempty" yaml:"context"`
}

type SectionStyle struct {
	Divider DividerStyle `json:"divider,omitempty" yaml:"dividerStyle"`
}

type Select struct {
	Type    SelectType `json:"type,omitempty" yaml:"type"`
	Name    string     `json:"name,omitempty" yaml:"name"`
	Command string     `json:"command,omitempty" yaml:"command"`
	// OptionGroups provides a way to group options in a select menu.
	OptionGroups []OptionGroup `json:"optionGroups,omitempty" yaml:"optionGroups"`
	// InitialOption holds already pre-selected options. MUST be a sub-set of OptionGroups.
	InitialOption *OptionItem `json:"initialOption,omitempty" yaml:"initialOption"`
}

type SelectType string

type Selects struct {
	// ID allows to identify a given block when we do the updated.
	ID    string   `json:"id,omitempty" yaml:"id"`
	Items []Select `json:"items,omitempty" yaml:"items"`
}

type TextField struct {
	Key   string `json:"key,omitempty" yaml:"key"`
	Value string `json:"value,omitempty" yaml:"value"`
}

type TextFields []TextField

type URLs map[string]string