apiclient

type AdminPage struct {
	Status          AdminStatus
	Users           []AdminUser
	PasswordEnabled bool
	PasswordForced  bool
	SignupOpen      bool
	Providers       []AdminProvider
	Form            AdminProvider // the add or edit form
	Editing         bool
	Withings        AdminWithings
	Audit           []AuditLine
	Key             KeyView
	Require2FA      string // off, admins or everyone
	Server          ServerSettingsView
	Analytics       Analytics
	SMTP            SMTPView
	ResetByEmail    bool // users can ask for a reset e-mail
	TLS             TLSView
}

type AdminProvider struct {
	models.AuthProvider
	CallbackURL string
	HasSecret   bool
}

type AdminResult struct {
	Message       string     `json:"message,omitempty"`
	ConfigChanged bool       `json:"config_changed,omitempty"`
	ListenCheck   bool       `json:"listen_check,omitempty"`
	ResetLink     *ResetLink `json:"reset_link,omitempty"`
}

type AdminStatus struct {
	Driver        string
	Encrypted     bool
	SchemaVersion int64
	Users         int
	Admins        int
	DexaScans     int
	ScaleReadings int
	// BodyUnavailable is set when the service that holds the scans and readings did not answer, so
	// the two counts above are unknown and not zero.
	BodyUnavailable bool
	Sessions        int
	AccessTokens    int
	TwoFactorUsers  int
}

type AdminUser struct {
	ID        int64
	Username  string
	FirstName string
	LastName  string
	Email     string
	Admin     bool
	Self      bool
	Created   string
	SignIn    string
	// StrengthLevel is whether the user may sync to Strength Level automatically.
	StrengthLevel bool
	// StrengthLevelBulk is whether the user may also run the multi-day sync from Settings.
	StrengthLevelBulk bool
	TwoFactor         bool // two-step verification is on
	// JobPriority (1-100) orders the user's worker jobs among other users'; a higher number goes
	// first, and administrators always go before everyone.
	JobPriority int
}

type AdminWithings struct {
	Available       bool
	Configured      bool
	ClientID        string
	RedirectURL     string
	DefaultRedirect string // used when the field is left empty
	SecretSaved     bool
}

type Analytics struct {
	ScarfPixelID      string `json:"scarf_pixel_id,omitempty"`      // a UUID
	GoogleAnalyticsID string `json:"google_analytics_id,omitempty"` // G-XXXXXXXXXX
	AdSensePublisher  string `json:"adsense_publisher,omitempty"`   // ca-pub-0000000000000000
}

type AuditLine struct {
	When, Action, Detail, IP string
	Actor, Target            string
}

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

type Error struct {
	Status  int    `json:"status"`
	Code    string `json:"code"`
	Message string `json:"message"`
}

type EstimatesPage struct {
	Result   estimate.Result  `json:"result"`
	Withings *IntegrationView `json:"withings"`
	SLReady  bool             `json:"sl_ready"`
}

type Flash struct {
	Message string `json:"message"`
	UserID  int64  `json:"user_id,omitempty"`
}

type FrontendConfig struct {
	// Generation changes with every change to the settings.
	Generation int64  `json:"generation"`
	Version    string `json:"version"`

	BaseURL        string   `json:"base_url,omitempty"`
	TrustedProxies []string `json:"trusted_proxies,omitempty"` // prefixes in CIDR form
	ProxyProtocol  bool     `json:"proxy_protocol"`

	TLSMode   string `json:"tls_mode"` // off, upload or selfsigned
	CertPEM   string `json:"cert_pem,omitempty"`
	KeyPEM    string `json:"key_pem,omitempty"` // only over the authenticated internal link
	HTTPSPort string `json:"https_port,omitempty"`
	HTTP3     bool   `json:"http3"`

	// Analytics are the optional measuring and ad services an administrator turned on. The frontend
	// loads them, after a visitor agrees, on the public pages only.
	Analytics Analytics `json:"analytics"`
}

type IntegrationView struct {
	Configured bool // the server has the provider's credentials
	Connected  bool // the user has linked their account
	// AutoPaused is why automatic runs for the user were paused after repeated failures; empty when they are not.
	AutoPaused string
}

type KeyView struct {
	Shown   bool
	ID      string
	Since   string // date the key was introduced, at least; empty when unknown
	AgeDays int
	Due     bool // older than the reminder
	Rekey   bool // the database still belongs to a previous key
}

type LinkedProvider struct {
	Slug, Label string
	Linked      bool
}

type LoginPage struct {
	PasswordEnabled bool
	SignupOpen      bool
	FirstUser       bool
	Providers       []LoginProvider
	CanReset        bool // people can ask for a reset e-mail
	Passkeys        bool // the browser can use passkeys here
}

type LoginProvider struct{ Slug, Label string }

type NewTokenRequest struct {
	Name    string `json:"name"`
	Expires string `json:"expires"` // days, "never" or empty
	Current string `json:"current"`
}

type PasskeyItem struct {
	ID, Name, Created, LastUsed string
}

type PasskeysView struct {
	Ready bool // the browser can use passkeys here: HTTPS or localhost
	Items []PasskeyItem
}

type PasswordChange struct {
	Current  string `json:"current"`
	Password string `json:"password"`
	Confirm  string `json:"confirm"`
}

type Profile struct {
	Username  string `json:"username"`
	FirstName string `json:"first_name"`
	LastName  string `json:"last_name"`
	Email     string `json:"email"`
	Timezone  string `json:"timezone"`
	HeightCm  string `json:"height_cm"`
	Current   string `json:"current"`
}

type ProviderForm struct {
	Slug, Label, Kind, Issuer, AuthURL, TokenURL, UserinfoURL, ClientID, ClientSecret string
	AppleTeamID, AppleKeyID, Scopes, SubjectClaim, NameClaim                          string
	AllowSignup                                                                       bool
}

type Request struct {
	Cookie   string
	ClientIP string
	Host     string
	Secure   bool

	// Relay receives the Set-Cookie headers the backend answers with. May be nil.
	Relay http.ResponseWriter
}

type ResetLink struct {
	For     string
	URL     string
	Expires string
	Emailed bool
	Warning bool // made from the request's host, which the request controls
}

type ResetStep struct {
	Redirect  string `json:"redirect,omitempty"`
	Mode      string `json:"mode,omitempty"` // "forgot", "sent", "form" or "invalid"
	Error     string `json:"error,omitempty"`
	NeedsCode bool   `json:"needs_code,omitempty"` // the account has two-step verification
	Status    int    `json:"status,omitempty"`     // HTTP status of the page; 200 when zero
}

type Result struct {
	Status int
	Header http.Header
}

type SLJobView struct {
	Running     bool
	Text        string
	Done, Total int
}

type SLView struct {
	UserID int64
	Saved  bool
	Email  string // the saved login's e-mail address; the password is never sent back
	Msg    string
	Bulk   bool // the multi-day sync is allowed
	// AutoPaused is why automatic syncs for the user were paused after repeated failures; empty when they are not.
	AutoPaused string
	Job        *SLJobView // the latest multi-day sync, if any
}

type SMTPForm struct {
	Host, Port, Username, Password, From, TLS string
	RemovePassword                            bool
}

type SMTPView struct {
	Host, Username, From, TLS string
	Port                      int
	PasswordSaved             bool
}

type ScalePage struct {
	Readings []models.ScaleReading `json:"readings"`
	// Next is the cursor of the next (older) page; empty on the last page.
	Next string `json:"next,omitempty"`
}

type SecondStep struct {
	Redirect string   `json:"redirect,omitempty"`
	Status   int      `json:"status,omitempty"` // HTTP status of the page; 200 when zero
	Mode     string   `json:"mode,omitempty"`
	Error    string   `json:"error,omitempty"`
	QR       string   `json:"qr,omitempty"` // SVG made by the backend
	Secret   string   `json:"secret,omitempty"`
	Codes    []string `json:"codes,omitempty"` // recovery codes, shown once
	Continue string   `json:"continue,omitempty"`
}

type SecurityView struct {
	Activity        []AuditLine // the latest events about this account
	PasswordEnabled bool
	HasPassword     bool
	ConfirmPassword bool // sensitive changes ask for the current password
	Tokens          []TokenView
	NewToken        string // shown once, right after it was created
	Linked          []LinkedProvider
	TwoFactor       TwoFactorSettings
	Passkeys        PasskeysView
}

type ServerForm struct {
	BaseURL, TrustedProxies, AuditDays, KeyReminderDays string
	ProxyProtocol                                       bool
	AllowPrivateProviders, AllowPrivateMail             bool
}

type ServerSettingsView struct {
	BaseURL               string
	TrustedProxies        string
	ProxyProtocol         bool
	AllowPrivateProviders bool // sign-in providers may be on private network addresses
	AllowPrivateMail      bool // the mail server may be on a private network address
	AuditDays             string
	KeyReminderDays       string
}

type SessionUser struct {
	models.User
	HiddenColumns     []string `json:"hidden_columns"`
	StrengthLevelAuto bool     `json:"strength_level_auto"`
	StrengthLevelBulk bool     `json:"strength_level_bulk"`
	DataVersion       int64    `json:"data_version"`
}

type Settings struct {
	AthleteDefault bool     `json:"athlete_default"`
	MethodRanking  []string `json:"method_ranking"`
}

type SettingsPage struct {
	Withings      *IntegrationView
	StrengthLevel *SLView
	Security      *SecurityView
}

type SignInOutcome struct {
	Redirect string `json:"redirect,omitempty"`
	Error    string `json:"error,omitempty"`  // fit to show on the sign-in page
	Status   int    `json:"status,omitempty"` // HTTP status to show it with
}

type Status struct {
	CheckedAt  string // UTC, when the backend last checked (it keeps an answer for a few seconds)
	Components []StatusComponent
}

type StatusComponent struct {
	Name  string // a stable key: web, api, database, body, valkey, workers.<provider>
	Label string
	State string
}

type StatusDetail struct {
	Status
	Notes   map[string]string // component name to the reason it is not up
	Workers []StatusWorker
}

type StatusWorker struct {
	ID       string
	Version  string
	Kinds    []string
	LastSeen string
	Live     bool // asked for work recently enough to count as running
}

type TLSForm struct {
	Mode, Port, Cert, Key, Names string
	HTTP3                        bool
}

type TLSView struct {
	Mode        string // off, upload or selfsigned
	Names       string // names for a self-signed certificate, as typed
	Active      bool   // a certificate is in force
	Subject     string
	CertNames   string
	NotAfter    string
	Fingerprint string
	HTTP3       bool
	HTTP3Active bool
	Port        string
}

type TokenView struct {
	ID       int64
	Name     string
	Prefix   string
	Created  string
	LastUsed string
	Expires  string
}

type TwoFactorChange struct {
	Error  string          `json:"error,omitempty"`
	Status int             `json:"status,omitempty"`
	Setup  *TwoFactorSetup `json:"setup,omitempty"`
	Codes  []string        `json:"codes,omitempty"`
}

type TwoFactorSettings struct {
	Available    bool // the user signs in with a password, so there is something to protect
	Enabled      bool
	Required     bool // an administrator requires it for this user
	RecoveryLeft int
	Setup        *TwoFactorSetup
	NewCodes     []string // shown once
}

type TwoFactorSetup struct {
	QR     template.HTML
	Secret string
}

type WithingsForm struct {
	ClientID, RedirectURL, ClientSecret string
	ClearSecret                         bool
}

type WorkerInstanceView struct {
	ID       string
	Version  string
	Kinds    []string
	LastSeen string
}

type WorkerJobView struct {
	ID          string
	Kind        string
	User        string
	UserID      int64
	Priority    int
	UserIsAdmin bool
	State       string
	Origin      string
	Attempts    int
	MaxAttempts int
	Error       string
	Created     string
	Updated     string
	Active      bool // can still be canceled
}

type WorkerKindForm struct {
	Enabled          bool
	MaxRunning       int
	MaxAttempts      int
	RetryBaseSeconds int
	TimeoutSeconds   int
	ScheduleHours    int
	PauseAfter       int
	Breaker          int
	Options          map[string]int
}

type WorkerKindView struct {
	Kind  string
	Label string
	// Enabled is false when an administrator (or the circuit breaker, see PausedReason) paused it.
	Enabled      bool
	PausedReason string

	MaxRunning       int // at once in all workers together; 0 is no limit
	MaxAttempts      int
	RetryBaseSeconds int
	TimeoutSeconds   int
	ScheduleHours    int // 0: no automatic runs
	PauseAfter       int
	Breaker          int
	Schedulable      bool
	Options          []WorkerOptionView

	Queued          int
	Running         int
	Failed24h       int
	WorkersOnline   int
	PausedSchedules int // users whose automatic runs are paused
}

type WorkerOptionView struct {
	Name     string
	Label    string
	Value    int
	Min, Max int
	Millis   bool // shown in milliseconds
}

type WorkerProviderView struct {
	Name  string
	Label string
	Kinds []WorkerKindView
}

type WorkersGlobalForm struct {
	DefaultPriority int
	KeepHistoryDays int
}

type WorkersPage struct {
	Providers       []WorkerProviderView
	Workers         []WorkerInstanceView
	Jobs            []WorkerJobView
	DefaultPriority int
	KeepHistoryDays int
}