data

type AbstractProvider struct {
	BotName string `yaml:"bot_name,omitempty"`
	Name    string `yaml:"name,omitempty"`
}

type Bundle struct {
	GortBundleVersion int                       `yaml:"gort_bundle_version,omitempty" json:",omitempty"`
	Name              string                    `yaml:",omitempty" json:",omitempty"`
	Version           string                    `yaml:",omitempty" json:",omitempty"`
	Enabled           bool                      `yaml:",omitempty" json:",omitempty"`
	Author            string                    `yaml:",omitempty" json:",omitempty"`
	Homepage          string                    `yaml:",omitempty" json:",omitempty"`
	Description       string                    `yaml:",omitempty" json:",omitempty"`
	Image             string                    `yaml:",omitempty" json:",omitempty"`
	InstalledOn       time.Time                 `yaml:"-" json:",omitempty"`
	InstalledBy       string                    `yaml:",omitempty" json:",omitempty"`
	LongDescription   string                    `yaml:"long_description,omitempty" json:",omitempty"`
	Kubernetes        BundleKubernetes          `yaml:",omitempty" json:",omitempty"`
	Permissions       []string                  `yaml:",omitempty" json:",omitempty"`
	Commands          map[string]*BundleCommand `yaml:",omitempty" json:",omitempty"`
	Default           bool                      `yaml:"-" json:",omitempty"`
	Templates         Templates                 `yaml:",omitempty" json:",omitempty"`
}

type BundleCommand struct {
	Description     string    `yaml:",omitempty" json:"description,omitempty"`
	Executable      []string  `yaml:",omitempty,flow" json:"executable,omitempty"`
	LongDescription string    `yaml:"long_description,omitempty" json:"long_description,omitempty"`
	Name            string    `yaml:"-" json:"-"`
	Rules           []string  `yaml:",omitempty" json:"rules,omitempty"`
	Templates       Templates `yaml:",omitempty" json:"templates,omitempty"`
}

type BundleInfo struct {
	Name           string
	Versions       []string
	Enabled        bool
	EnabledVersion Bundle
}

type BundleKubernetes struct {
	ServiceAccountName string `yaml:"serviceAccountName,omitempty" json:"serviceAccountName,omitempty"`
}

type CommandEntry struct {
	Bundle  Bundle
	Command BundleCommand
}

type CommandParameters []string

type CommandRequest struct {
	CommandEntry
	Adapter    string            // The name of the adapter this request originated from
	ChannelID  string            // The provider ID of the channel that the request originated in
	Context    context.Context   // The request context
	Parameters CommandParameters // Tokenized command parameters
	RequestID  int64             // A unique requestID
	Timestamp  time.Time         // The time this request was triggered
	UserID     string            // The provider ID of user making this request
	UserEmail  string            // The email address associated with the user making the request
	UserName   string            // The gort username of the user making the request
}

type CommandResponse struct {
	// Lines contains the command output (from both stdout and stderr) as
	// a string slice, delimitted along newlines.
	Lines []string

	// Out The command output as a single block of text, with lines joined
	// with newlines.
	Out string

	// Structured is true if the command output is valid JSON. If so, then it
	// also be unmarshalled as Payload; else Payload will be a string (equal
	// to Out).
	Structured bool

	// Title includes a title. Usually only set by the relay for certain
	// internally-detected errors. It can be used to build a user output
	// message, and generally contains a short description of the result.
	Title string
}

type CommandResponseData struct {
	// Duration is how long the command required to execute.
	// TODO(mtitmus) What are the start and endpoints? Do we want to track
	// multiple durations for "framework time" and "command time" and whatever
	// else?
	Duration time.Duration

	// ExitCode is the exit code reported by the command.
	ExitCode int16

	// Error is set by the relay under certain internal error conditions.
	Error error
}

type CommandResponseEnvelope struct {
	// Request is the original request used to execute the command. It contains
	// the original CommandEntry value as well as the user and adapter data.
	Request CommandRequest

	// Response contains the
	Response CommandResponse

	// Data contains about the command execution, including its duration and exit code.
	// If the relay set an an explicit error, it will be here as well.
	Data CommandResponseData

	// Payload includes the command output. If the output is structured JSON,
	// it will be unmarshalled and placed here where it can be accessible to
	// Go templates. If it's not, this will be a string equal to Out.
	Payload interface{}
}

type CommandResponseEnvelopeOption func(e *CommandResponseEnvelope)

type DatabaseConfigs struct {
	Host                  string        `yaml:"host,omitempty"`
	Port                  int           `yaml:"port,omitempty"`
	User                  string        `yaml:"user,omitempty"`
	Password              string        `yaml:"password,omitempty"`
	SSLEnabled            bool          `yaml:"ssl_enabled,omitempty"`
	ConnectionMaxIdleTime time.Duration `yaml:"connection_max_idle_time,omitempty"`
	ConnectionMaxLifetime time.Duration `yaml:"connection_max_life_time,omitempty"`
	MaxIdleConnections    int           `yaml:"max_idle_connections,omitempty"`
	MaxOpenConnections    int           `yaml:"max_open_connections,omitempty"`
	QueryTimeout          time.Duration `yaml:"query_timeout,omitempty"`
}

type DiscordProvider struct {
	AbstractProvider `yaml:",inline"`

	BotToken string `yaml:"bot_token,omitempty"`
}

type DockerConfigs struct {
	DockerHost string `yaml:"host,omitempty"`
	Network    string `yaml:"network,omitempty"`
}

type GlobalConfigs struct {
	CommandTimeout time.Duration `yaml:"command_timeout,omitempty"`
}

type GortConfig struct {
	GortServerConfigs GortServerConfigs `yaml:"gort,omitempty"`
	GlobalConfigs     GlobalConfigs     `yaml:"global,omitempty"`
	DatabaseConfigs   DatabaseConfigs   `yaml:"database,omitempty"`
	DockerConfigs     DockerConfigs     `yaml:"docker,omitempty"`
	JaegerConfigs     JaegerConfigs     `yaml:"jaeger,omitempty"`
	KubernetesConfigs KubernetesConfigs `yaml:"kubernetes,omitempty"`
	SlackProviders    []SlackProvider   `yaml:"slack,omitempty"`
	DiscordProviders  []DiscordProvider `yaml:"discord,omitempty"`
	Templates         Templates         `yaml:"templates,omitempty"`
}

type GortServerConfigs struct {
	AllowSelfRegistration bool   `yaml:"allow_self_registration,omitempty"`
	APIAddress            string `yaml:"api_address,omitempty"`
	APIURLBase            string `yaml:"api_url_base,omitempty"`
	DevelopmentMode       bool   `yaml:"development_mode,omitempty"`
	EnableSpokenCommands  bool   `yaml:"enable_spoken_commands,omitempty"`
	TLSCertFile           string `yaml:"tls_cert_file,omitempty"`
	TLSKeyFile            string `yaml:"tls_key_file,omitempty"`
}

type JaegerConfigs struct {
	Endpoint string `yaml:"endpoint,omitempty"`
	Password string `yaml:"password,omitempty"`
	Username string `yaml:"username,omitempty"`
}

type KubernetesConfigs struct {
	Namespace             string `yaml:"namespace,omitempty"`
	EndpointFieldSelector string `yaml:"endpoint_field_selector,omitempty"`
	EndpointLabelSelector string `yaml:"endpoint_label_selector,omitempty"`
	PodFieldSelector      string `yaml:"pod_field_selector,omitempty"`
	PodLabelSelector      string `yaml:"pod_label_selector,omitempty"`
}

type Provider interface{}

type SlackProvider struct {
	AbstractProvider `yaml:",inline"`
	IconURL          string `yaml:"icon_url,omitempty"`

	// App and Bot tokens, used for Socket mode.
	AppToken string `yaml:"app_token,omitempty"`
	BotToken string `yaml:"bot_token,omitempty"`

	// Deprecated, used for Classic Slack apps
	APIToken string `yaml:"api_token,omitempty"`
}

type TemplateType string

type Templates struct {
	// Command templates are used to format the outputs from successfully
	// executed commands.
	Command string `yaml:"command,omitempty" json:"command,omitempty"`

	// CommandError templates are used to format the error messages produced
	// by commands that return with a non-zero status.
	CommandError string `yaml:"command_error,omitempty" json:"command_error,omitempty"`

	// Message templates are used to format standard informative (non-error)
	// messages from the Gort system (not commands).
	Message string `yaml:"message,omitempty" json:"message,omitempty"`

	// MessageError templates are used to format error messages from the Gort
	// system (not commands).
	MessageError string `yaml:"message_error,omitempty" json:"message_error,omitempty"`
}