apitype

type ActionSummary struct {
	Command map[string]CommandSummary `json:"command" yaml:"command"` // Summary of all command's
	WebHook map[string]WebHookSummary `json:"webhook" yaml:"webhook"` // Summary of all WebHook's
}

type BasicAuth struct {
	Username string `json:"username" yaml:"username"`
	Password string `json:"password" yaml:"password"`
}

type BuildInfo struct {
	Version   string `json:"version,omitempty" yaml:"version,omitempty"`
	BuildDate string `json:"build_date,omitempty" yaml:"build_date,omitempty"`
	GoVersion string `json:"go_version,omitempty" yaml:"go_version,omitempty"`
}

type Command []string

type CommandEdit struct {
	Arg string `json:"arg,omitempty" yaml:"arg,omitempty"` // Command argument
}

type CommandSlice []Command

type CommandStatusUpdate struct {
	Command string `json:"command" yaml:"command"` // Index of the Command
	Failed  bool   `json:"failed" yaml:"failed"`   // Whether the last attempt of this command failed
}

type CommandSummary struct {
	Failed       *bool     `json:"failed,omitempty" yaml:"failed,omitempty"`               // Whether this WebHook failed to send successfully for the LatestVersion
	NextRunnable time.Time `json:"next_runnable,omitempty" yaml:"next_runnable,omitempty"` // Time the Command can next be run (for staggering)
}

type Config struct {
	File         string        `json:"-" yaml:"-"`                                             // Path to the config file (-config.file=”)
	Settings     *Settings     `json:"settings,omitempty" yaml:"settings,omitempty"`           // Settings for the program
	HardDefaults *Defaults     `json:"hard_defaults,omitempty" yaml:"hard_defaults,omitempty"` // Hard default values
	Defaults     *Defaults     `json:"defaults,omitempty" yaml:"defaults,omitempty"`           // Default values
	Notify       *NotifySlice  `json:"notify,omitempty" yaml:"notify,omitempty"`               // Notify message(s) to send on a new release
	WebHook      *WebHookSlice `json:"webhook,omitempty" yaml:"webhook,omitempty"`             // WebHook(s) to send on a new release
	Service      *ServiceSlice `json:"service,omitempty" yaml:"service,omitempty"`             // The service(s) to monitor
	Order        []string      `json:"order,omitempty" yaml:"order,omitempty"`                 // Ordering for the Service(s) in the WebUI
}

type DashboardOptions struct {
	AutoApprove *bool  `json:"auto_approve,omitempty" yaml:"auto_approve,omitempty"` // default - true = Requre approval before actioning new releases
	Icon        string `json:"icon,omitempty" yaml:"icon,omitempty"`                 // Icon URL to use for messages/Web UI
	IconLinkTo  string `json:"icon_link_to,omitempty" yaml:"icon_link_to,omitempty"` // URL to redirect Icon clicks to
	WebURL      string `json:"web_url,omitempty" yaml:"web_url,omitempty"`           // URL to provide on the Web UI
}

type Defaults struct {
	Service ServiceDefaults `json:"service,omitempty" yaml:"service,omitempty"`
	Notify  NotifySlice     `json:"notify,omitempty" yaml:"notify,omitempty"`
	WebHook WebHook         `json:"webhook,omitempty" yaml:"webhook,omitempty"`
}

type DeployedVersionLookup struct {
	URL               string                 `json:"url,omitempty" yaml:"url,omitempty"`                                 // URL to query
	AllowInvalidCerts *bool                  `json:"allow_invalid_certs,omitempty" yaml:"allow_invalid_certs,omitempty"` // default - false = Disallows invalid HTTPS certificates
	BasicAuth         *BasicAuth             `json:"basic_auth,omitempty" yaml:"basic_auth,omitempty"`                   // Basic Auth for the HTTP(S) request
	Headers           []Header               `json:"headers,omitempty" yaml:"headers,omitempty"`                         // Headers for the HTTP(S) request
	JSON              string                 `json:"json,omitempty" yaml:"json,omitempty"`                               // JSON key to use e.g. version_current
	Regex             string                 `json:"regex,omitempty" yaml:"regex,omitempty"`                             // Regex to get the DeployedVersion
	RegexTemplate     *string                `json:"regex_template,omitempty" yaml:"regex_template,omitempty"`           // Template to use for the Regex
	HardDefaults      *DeployedVersionLookup `json:"-" yaml:"-"`                                                         // Hardcoded default values
	Defaults          *DeployedVersionLookup `json:"-" yaml:"-"`                                                         // Default values
}

type Flags struct {
	ConfigFile       *string `json:"config.file,omitempty" yaml:"config.file,omitempty"`
	LogLevel         string  `json:"log.level,omitempty" yaml:"log.level,omitempty"`
	LogTimestamps    *bool   `json:"log.timestamps,omitempty" yaml:"log.timestamps,omitempty"`
	DataDatabaseFile *string `json:"data.database-file,omitempty" yaml:"data.database-file,omitempty"`
	WebListenHost    string  `json:"web.listen-host,omitempty" yaml:"web.listen-host,omitempty"`
	WebListenPort    string  `json:"web.listen-port,omitempty" yaml:"web.listen-port,omitempty"`
	WebCertFile      *string `json:"web.cert-file" yaml:"web.cert-file"`
	WebPKeyFile      *string `json:"web.pkey-file" yaml:"web.pkey-file"`
	WebRoutePrefix   string  `json:"web.route-prefix,omitempty" yaml:"web.route-prefix,omitempty"`
}

type Header struct {
	Key   string `json:"key" yaml:"key"`     // Header key, e.g. X-Sig
	Value string `json:"value" yaml:"value"` // Value to give the key
}

type LatestVersion struct {
	Type              string                `json:"type,omitempty" yaml:"type,omitempty"`                               // Service Type, github/url
	URL               string                `json:"url,omitempty" yaml:"url,omitempty"`                                 // URL to query
	AccessToken       string                `json:"access_token,omitempty" yaml:"access_token,omitempty"`               // GitHub access token to use
	AllowInvalidCerts *bool                 `json:"allow_invalid_certs,omitempty" yaml:"allow_invalid_certs,omitempty"` // default - false = Disallows invalid HTTPS certificates
	UsePreRelease     *bool                 `json:"use_prerelease,omitempty" yaml:"use_prerelease,omitempty"`           // Whether GitHub prereleases should be used
	URLCommands       *URLCommandSlice      `json:"url_commands,omitempty" yaml:"url_commands,omitempty"`               // Commands to filter the release from the URL request
	Require           *LatestVersionRequire `json:"require,omitempty" yaml:"require,omitempty"`                         // Requirements for the version to be considered valid
}

type LatestVersionDefaults struct {
	Type              string                        `json:"type,omitempty" yaml:"type,omitempty"`                               // Service Type, github/url
	URL               string                        `json:"url,omitempty" yaml:"url,omitempty"`                                 // URL to query
	AccessToken       string                        `json:"access_token,omitempty" yaml:"access_token,omitempty"`               // GitHub access token to use
	AllowInvalidCerts *bool                         `json:"allow_invalid_certs,omitempty" yaml:"allow_invalid_certs,omitempty"` // default - false = Disallows invalid HTTPS certificates
	UsePreRelease     *bool                         `json:"use_prerelease,omitempty" yaml:"use_prerelease,omitempty"`           // Whether GitHub prereleases should be used
	Require           *LatestVersionRequireDefaults `json:"require,omitempty" yaml:"require,omitempty"`
}

type LatestVersionRequire struct {
	Command      []string            `json:"command,omitempty" yaml:"command,omitempty"`             // Require Command to pass
	Docker       *RequireDockerCheck `json:"docker,omitempty" yaml:"docker,omitempty"`               // Docker image tag requirements
	RegexContent string              `json:"regex_content,omitempty" yaml:"regex_content,omitempty"` // "abc-[a-z]+-{{ version }}_amd64.deb" This regex must exist in the body of the URL to trigger new version actions
	RegexVersion string              `json:"regex_version,omitempty" yaml:"regex_version,omitempty"` // "v*[0-9.]+" The version found must match this release to trigger new version actions
}

type LatestVersionRequireDefaults struct {
	Docker RequireDockerCheckDefaults `json:"docker,omitempty" yaml:"docker,omitempty"` // Docker repo defaults
}

type LogSettings struct {
	Timestamps *bool   `json:"timestamps,omitempty" yaml:"timestamps,omitempty"` // Timestamps in CLI output
	Level      *string `json:"level,omitempty" yaml:"level,omitempty"`           // Log level
}

type Notifiers struct {
	Notify *NotifySlice // Service.Notify
}

type Notify struct {
	ID        string                `json:"name,omitempty" yaml:"name,omitempty"`             // ID for this Notify sender
	Type      string                `json:"type,omitempty" yaml:"type,omitempty"`             // Notification type, e.g. slack
	Options   map[string]string     `json:"options,omitempty" yaml:"options,omitempty"`       // Options
	URLFields map[string]string     `json:"url_fields,omitempty" yaml:"url_fields,omitempty"` // URL Fields
	Params    shoutrrr_types.Params `json:"params,omitempty" yaml:"params,omitempty"`         // Param props
}

type NotifyParams map[string]string

type NotifySlice map[string]*Notify

type RefreshAPI struct {
	Version string    `json:"version"`
	Error   string    `json:"error,omitempty"`
	Date    time.Time `json:"timestamp"`
}

type RequireDockerCheck struct {
	Type     string `json:"type,omitempty" yaml:"type,omitempty"`         // Where to check, e.g. hub (DockerHub), GHCR, Quay
	Image    string `json:"image,omitempty" yaml:"image,omitempty"`       // Image to check
	Tag      string `json:"tag,omitempty" yaml:"tag,omitempty"`           // Tag to check for
	Username string `json:"username,omitempty" yaml:"username,omitempty"` // Username to get a new token
	Token    string `json:"token,omitempty" yaml:"token,omitempty"`       // Token to get the token for the queries
}

type RequireDockerCheckDefaults struct {
	Type string                                          `json:"type,omitempty" yaml:"type,omitempty"` // Default DockerCheck Type
	GHCR *RequireDockerCheckRegistryDefaults             `json:"ghcr,omitempty" yaml:"ghcr,omitempty"` // GHCR
	Hub  *RequireDockerCheckRegistryDefaultsWithUsername `json:"hub,omitempty" yaml:"hub,omitempty"`   // DockerHub
	Quay *RequireDockerCheckRegistryDefaults             `json:"quay,omitempty" yaml:"quay,omitempty"` // Quay
}

type RequireDockerCheckRegistryDefaults struct {
	Token string `json:"token,omitempty" yaml:"token,omitempty"` // Token to get the token for the queries
}

type RequireDockerCheckRegistryDefaultsWithUsername struct {
	RequireDockerCheckRegistryDefaults
	Username string `json:"username,omitempty" yaml:"username,omitempty"` // Username to get a new token
}

type RuntimeInfo struct {
	StartTime      time.Time `json:"start_time,omitempty" yaml:"start_time,omitempty"`
	CWD            string    `json:"cwd,omitempty" yaml:"cwd,omitempty"`
	GoRoutineCount int       `json:"goroutines,omitempty" yaml:"goroutines,omitempty"`
	GOMAXPROCS     int       `json:"GOMAXPROCS,omitempty" yaml:"GOMAXPROCS,omitempty"`
	GoGC           string    `json:"GOGC,omitempty" yaml:"GOGC,omitempty"`
	GoDebug        string    `json:"GODEBUG,omitempty" yaml:"GODEBUG,omitempty"`
}

type Service struct {
	Comment               string                 `json:"comment,omitempty" yaml:"comment,omitempty"`                   // Comment on the Service
	Options               *ServiceOptions        `json:"options,omitempty" yaml:"options,omitempty"`                   // Options to give the Service
	LatestVersion         *LatestVersion         `json:"latest_version,omitempty" yaml:"latest_version,omitempty"`     // Latest version lookup for the Service
	Command               *CommandSlice          `json:"command,omitempty" yaml:"command,omitempty"`                   // OS Commands to run on new release
	Notify                *NotifySlice           `json:"notify,omitempty" yaml:"notify,omitempty"`                     // Service-specific Notify vars
	WebHook               *WebHookSlice          `json:"webhook,omitempty" yaml:"webhook,omitempty"`                   // Service-specific WebHook vars
	DeployedVersionLookup *DeployedVersionLookup `json:"deployed_version,omitempty" yaml:"deployed_version,omitempty"` // Var to scrape the Service's current deployed version
	Dashboard             *DashboardOptions      `json:"dashboard,omitempty" yaml:"dashboard,omitempty"`               // Dashboard options
	Status                *Status                `json:"status,omitempty" yaml:"status,omitempty"`                     // Track the Status of this source (version and regex misses)
}

type ServiceDefaults struct {
	Comment               string                 `json:"comment,omitempty" yaml:"comment,omitempty"`                   // Comment on the Service
	Options               *ServiceOptions        `json:"options,omitempty" yaml:"options,omitempty"`                   // Options to give the Service
	LatestVersion         *LatestVersionDefaults `json:"latest_version,omitempty" yaml:"latest_version,omitempty"`     // Latest version lookup for the Service
	Notify                map[string]struct{}    `json:"notify,omitempty" yaml:"notify,omitempty"`                     // Service-specific Notify vars
	Command               CommandSlice           `json:"command,omitempty" yaml:"command,omitempty"`                   // OS Commands to run on new release
	WebHook               map[string]struct{}    `json:"webhook,omitempty" yaml:"webhook,omitempty"`                   // Service-specific WebHook vars
	DeployedVersionLookup *DeployedVersionLookup `json:"deployed_version,omitempty" yaml:"deployed_version,omitempty"` // Var to scrape the Service's current deployed version
	Dashboard             *DashboardOptions      `json:"dashboard,omitempty" yaml:"dashboard,omitempty"`               // Dashboard options
	Status                *Status                `json:"status,omitempty" yaml:"status,omitempty"`
}

type ServiceEdit struct {
	Comment               string                 `json:"comment,omitempty" yaml:"comment,omitempty"`                   // Comment on the Service
	Options               *ServiceOptions        `json:"options,omitempty" yaml:"options,omitempty"`                   // Options to give the Service
	LatestVersion         *LatestVersion         `json:"latest_version,omitempty" yaml:"latest_version,omitempty"`     // Latest version lookup for the Service
	Command               *CommandSlice          `json:"command,omitempty" yaml:"command,omitempty"`                   // OS Commands to run on new release
	Notify                *[]Notify              `json:"notify,omitempty" yaml:"notify,omitempty"`                     // Service-specific Notify vars
	WebHook               *[]*WebHook            `json:"webhook,omitempty" yaml:"webhook,omitempty"`                   // Service-specific WebHook vars
	DeployedVersionLookup *DeployedVersionLookup `json:"deployed_version,omitempty" yaml:"deployed_version,omitempty"` // Var to scrape the Service's current deployed version
	Dashboard             *DashboardOptions      `json:"dashboard,omitempty" yaml:"dashboard,omitempty"`               // Dashboard options
	Status                *Status                `json:"status,omitempty" yaml:"status,omitempty"`                     // Track the Status of this source (version and regex misses)
}

type ServiceOptions struct {
	Active             *bool  `json:"active,omitempty" yaml:"active,omitempty"`                           // Active Service?
	Interval           string `json:"interval,omitempty" yaml:"interval,omitempty"`                       // AhBmCs = Sleep A hours, B minutes and C seconds between queries
	SemanticVersioning *bool  `json:"semantic_versioning,omitempty" yaml:"semantic_versioning,omitempty"` // default - true = Version has to be greater than the previous to trigger alerts/WebHooks
}

type ServiceSlice map[string]*Service

type ServiceSummary struct {
	ID                       string  `json:"id,omitempty" yaml:"id,omitempty"`                                     //
	Active                   *bool   `json:"active,omitempty" yaml:"active,omitempty"`                             // Active Service?
	Comment                  *string `json:"comment,omitempty" yaml:"comment,omitempty"`                           // Comment on the Service
	Type                     *string `json:"type,omitempty" yaml:"type,omitempty"`                                 // "github"/"URL"
	WebURL                   string  `json:"url,omitempty" yaml:"url,omitempty"`                                   // URL to provide on the Web UI
	Icon                     *string `json:"icon,omitempty" yaml:"icon,omitempty"`                                 // Service.Dashboard.Icon / Service.Notify.*.Params.Icon / Service.Notify.*.Defaults.Params.Icon
	IconLinkTo               *string `json:"icon_link_to,omitempty" yaml:"icon_link_to,omitempty"`                 // URL to redirect Icon clicks to
	HasDeployedVersionLookup *bool   `json:"has_deployed_version,omitempty" yaml:"has_deployed_version,omitempty"` // Whether this service has a DeployedVersionLookup
	Command                  *int    `json:"command,omitempty" yaml:"command,omitempty"`                           // Number of Commands to send on a new release
	WebHook                  *int    `json:"webhook,omitempty" yaml:"webhook,omitempty"`                           // Number of WebHooks to send on a new release
	Status                   *Status `json:"status,omitempty" yaml:"status,omitempty"`                             // Track the Status of this source (version and regex misses)
}

type Settings struct {
	Log LogSettings `json:"log,omitempty" yaml:"log,omitempty"`
	Web WebSettings `json:"web,omitempty" yaml:"web,omitempty"`
}

type Status struct {
	ApprovedVersion          string `json:"approved_version,omitempty" yaml:"approved_version,omitempty"`                     // The version that's been approved
	DeployedVersion          string `json:"deployed_version,omitempty" yaml:"deployed_version,omitempty"`                     // Track the deployed version of the service from the last successful WebHook
	DeployedVersionTimestamp string `json:"deployed_version_timestamp,omitempty" yaml:"deployed_version_timestamp,omitempty"` // UTC timestamp that the deployed version change was noticed
	LatestVersion            string `json:"latest_version,omitempty" yaml:"latest_version,omitempty"`                         // Latest version found from query()
	LatestVersionTimestamp   string `json:"latest_version_timestamp,omitempty" yaml:"latest_version_timestamp,omitempty"`     // UTC timestamp that the latest version change was noticed
	LastQueried              string `json:"last_queried,omitempty" yaml:"last_queried,omitempty"`                             // UTC timestamp that version was last queried/checked
	RegexMissesContent       uint   `json:"regex_misses_content,omitempty" yaml:"regex_misses_content,omitempty"`             // Counter for the number of regex misses on URL content
	RegexMissesVersion       uint   `json:"regex_misses_version,omitempty" yaml:"regex_misses_version,omitempty"`             // Counter for the number of regex misses on version
}

type StatusFails struct {
	Notify  *[]bool `json:"notify,omitempty" yaml:"notify,omitempty"`   // Track whether any of the Slice failed
	WebHook *[]bool `json:"webhook,omitempty" yaml:"webhook,omitempty"` // Track whether any of the WebHookSlice failed
}

type StatusFailsSummary struct {
	Notify  *bool `json:"notify,omitempty" yaml:"notify,omitempty"`   // Track whether any of the Slice failed
	WebHook *bool `json:"webhook,omitempty" yaml:"webhook,omitempty"` // Track whether any of the WebHookSlice failed
}

type URLCommand struct {
	Type     string  `json:"type,omitempty" yaml:"type,omitempty"`         // regex/replace/split
	Regex    *string `json:"regex,omitempty" yaml:"regex,omitempty"`       // regex: regexp.MustCompile(Regex)
	Index    int     `json:"index,omitempty" yaml:"index,omitempty"`       // regex/split: re.FindAllString(URL_content, -1)[Index]  /  strings.Split("text")[Index]
	Template *string `yaml:"template,omitempty" json:"template,omitempty"` // regex: template
	Text     *string `json:"text,omitempty" yaml:"text,omitempty"`         // split:       strings.Split(tgtString, "Text")
	New      *string `json:"new,omitempty" yaml:"new,omitempty"`           // replace:     strings.ReplaceAll(tgtString, "Old", "New")
	Old      *string `json:"old,omitempty" yaml:"old,omitempty"`           // replace:     strings.ReplaceAll(tgtString, "Old", "New")
}

type URLCommandSlice []URLCommand

type VersionAPI struct {
	Version   string `json:"version"`
	BuildDate string `json:"buildDate"`
	GoVersion string `json:"goVersion"`
}

type WebHook struct {
	ServiceID         string    `json:"-" yaml:"-"`                                                         // ID of the service this WebHook is attached to
	ID                string    `json:"name,omitempty" yaml:"name,omitempty"`                               // Name of this WebHook
	Type              *string   `json:"type,omitempty" yaml:"type,omitempty"`                               // "github"/"url"
	URL               *string   `json:"url,omitempty" yaml:"url,omitempty"`                                 // "https://example.com"
	AllowInvalidCerts *bool     `json:"allow_invalid_certs,omitempty" yaml:"allow_invalid_certs,omitempty"` // default - false = Disallows invalid HTTPS certificates.
	Secret            *string   `json:"secret,omitempty" yaml:"secret,omitempty"`                           // "SECRET"
	CustomHeaders     *[]Header `json:"custom_headers,omitempty" yaml:"custom_headers,omitempty"`           // Custom Headers for the WebHook
	DesiredStatusCode *int      `json:"desired_status_code,omitempty" yaml:"desired_status_code,omitempty"` // e.g. 202
	Delay             string    `json:"delay,omitempty" yaml:"delay,omitempty"`                             // The delay before sending the WebHook
	MaxTries          *uint     `json:"max_tries,omitempty" yaml:"max_tries,omitempty"`                     // Number of times to attempt sending the WebHook if the desired status code is not received
	SilentFails       *bool     `json:"silent_fails,omitempty" yaml:"silent_fails,omitempty"`               // Whether to notify if this WebHook fails MaxTries times
}

type WebHookSlice map[string]*WebHook

type WebHookSummary struct {
	Failed       *bool     `json:"failed,omitempty" yaml:"failed,omitempty"`               // Whether this WebHook failed to send successfully for the LatestVersion
	NextRunnable time.Time `json:"next_runnable,omitempty" yaml:"next_runnable,omitempty"` // Time the WebHook can next be run (for staggering)
}

type WebSettings struct {
	ListenHost  *string `json:"listen_host,omitempty" yaml:"listen_host,omitempty"`   // Web listen host
	ListenPort  *string `json:"listen_port,omitempty" yaml:"listen_port,omitempty"`   // Web listen port
	CertFile    *string `json:"cert_file,omitempty" yaml:"cert_file,omitempty"`       // HTTPS certificate path
	KeyFile     *string `json:"pkey_file,omitempty" yaml:"pkey_file,omitempty"`       // HTTPS privkey path
	RoutePrefix *string `json:"route_prefix,omitempty" yaml:"route_prefix,omitempty"` // Web endpoint prefix
}

type WebSocketMessage struct {
	Version     *int                       `json:"version,omitempty"`
	Page        string                     `json:"page"`
	Type        string                     `json:"type"`
	SubType     string                     `json:"sub_type,omitempty"`
	Target      *string                    `json:"target,omitempty"`
	Order       *[]string                  `json:"order,omitempty"`
	ServiceData *ServiceSummary            `json:"service_data,omitempty"`
	CommandData map[string]*CommandSummary `json:"command_data,omitempty"`
	WebHookData map[string]*WebHookSummary `json:"webhook_data,omitempty"`
}