devconsole

type Address struct {
	Name    string `json:"name"`
	Address string `json:"address"`
}

type App struct {
	Name      string `json:"name"`
	Version   string `json:"version"`
	Commit    string `json:"commit,omitempty"`
	GoVersion string `json:"go_version"`
	// Env is APP_ENV.
	Env string `json:"env"`
	// Libraries are the gorbital library modules linked into the binary.
	Libraries []Library `json:"libraries"`
	// Modules are the API's areas: the OpenAPI document's tags.
	Modules []string `json:"modules"`
	// Jobs, Settings, Flags and Permissions are empty in apps without them.
	Jobs        []Job               `json:"jobs"`
	Settings    []Setting           `json:"settings"`
	Flags       []Flag              `json:"flags"`
	Permissions []PermissionCatalog `json:"permissions"`
}

type Attr struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type ConfigList struct {
	Variables []EnvKey `json:"variables"`
}

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

type EnvKey struct {
	Name string `json:"name"`
	// Secret reports a variable read as a secret, or whose name looks like
	// one; its value is never kept.
	Secret bool `json:"secret"`
	// Set reports a non-empty value.
	Set bool `json:"set"`
	// Value is the value of a variable that isn't secret, with the user
	// information and query of URLs replaced by "[redacted]". Empty for
	// secrets.
	Value string `json:"value,omitempty"`
}

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

type Flag struct {
	Key         string `json:"key"`
	Group       string `json:"group"`
	Description string `json:"description"`
	Client      bool   `json:"client"`
	Enabled     bool   `json:"enabled"`
	Default     bool   `json:"default"`
	// Percentage is the rollout percentage; nil without a rollout.
	Percentage *int `json:"percentage"`
	// Targets counts the organisation and user IDs in allow and deny lists.
	Targets  int  `json:"targets"`
	Modified bool `json:"modified"`
}

type Index struct {
	// Endpoints are the paths this app serves, sorted.
	Endpoints []string `json:"endpoints"`
}

type Job struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Enabled     bool   `json:"enabled"`
	// Schedule is a cron expression or descriptor; empty for on-demand jobs.
	Schedule  string     `json:"schedule"`
	Modified  bool       `json:"modified"`
	NextRunAt *time.Time `json:"next_run_at,omitempty"`
}

type JobRun struct {
	ID          int64      `json:"id"`
	Kind        string     `json:"kind"`
	Queue       string     `json:"queue"`
	State       string     `json:"state"`
	Attempt     int        `json:"attempt"`
	MaxAttempts int        `json:"max_attempts"`
	CreatedAt   time.Time  `json:"created_at"`
	ScheduledAt time.Time  `json:"scheduled_at"`
	AttemptedAt *time.Time `json:"attempted_at,omitempty"`
	FinalizedAt *time.Time `json:"finalized_at,omitempty"`
	// Errors are the failed attempts' messages, oldest first.
	Errors    []string `json:"errors"`
	RequestID string   `json:"request_id,omitempty"`
}

type JobRunList struct {
	Runs []JobRun `json:"runs"`
}

type Library struct {
	Path    string `json:"path"`
	Version string `json:"version"`
	// Replaced reports a module replaced by a local directory or another
	// module, as in a gorbital checkout.
	Replaced bool `json:"replaced,omitempty"`
}

type Log struct {
	Time    time.Time `json:"time"`
	Level   string    `json:"level"`
	Message string    `json:"message"`
	// Attrs are the record's attributes in order, groups flattened into
	// dotted keys ("request.id"), values as text. DroppedAttrs counts those
	// left out: past 50, or past 8 KiB for the whole record.
	Attrs        []Attr `json:"attrs"`
	DroppedAttrs int    `json:"dropped_attrs,omitempty"`
}

type LogList struct {
	// Max is how many records the console keeps.
	Max  int   `json:"max"`
	Logs []Log `json:"logs"`
}

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

type Mail struct {
	// WebURL is Mailpit's web interface, where messages can be read.
	WebURL string `json:"web_url"`
	// Total counts every captured message; Messages holds the newest 50.
	Total    int       `json:"total"`
	Messages []Message `json:"messages"`
}

type MailPreview struct {
	// Name identifies the preview: letters, digits, dots, hyphens and
	// underscores, such as auth.verification_code.
	Name string `json:"name"`
	// Description says when the app sends it.
	Description string `json:"description"`
	// Category is the message's tag, when the app sets one.
	Category string `json:"category,omitempty"`
}

type MailPreviewList struct {
	Previews []MailPreview `json:"previews"`
}

type MailPreviewMessage struct {
	MailPreview
	Subject string `json:"subject"`
	Text    string `json:"text"`
	HTML    string `json:"html"`
	// To is the sample recipient the message was rendered for.
	To string `json:"to"`
}

type MailPreviewSent struct {
	Name string `json:"name"`
	To   string `json:"to"`
	Sent bool   `json:"sent"`
}

type MailPreviewer struct {
	Previews []MailPreview
	Build    func(ctx context.Context, name, to string) (gmail.Message, error)
	Send     func(ctx context.Context, m gmail.Message) error
}

type Message struct {
	ID          string    `json:"id"`
	From        Address   `json:"from"`
	To          []Address `json:"to"`
	Subject     string    `json:"subject"`
	Snippet     string    `json:"snippet"`
	Created     time.Time `json:"created"`
	Size        int       `json:"size"`
	Attachments int       `json:"attachments"`
	Read        bool      `json:"read"`
}

type Migrations struct {
	// Current is the highest applied version, Latest the newest migration
	// file's, Pending the files not applied yet.
	Current int64 `json:"current"`
	Latest  int64 `json:"latest"`
	Pending int   `json:"pending"`
}

type Option func(*options)

type Permission struct {
	Name        string `json:"name"`
	Description string `json:"description"`
}

type PermissionCatalog struct {
	Name        string       `json:"name"`
	Permissions []Permission `json:"permissions"`
	Roles       []Role       `json:"roles"`
}

type Request struct {
	// Time is when the request finished.
	Time   time.Time `json:"time"`
	Method string    `json:"method"`
	// Route is the pattern the router matched, such as "/v1/projects/{id}";
	// empty when no route matched.
	Route string `json:"route"`
	// Path is the request path, without the query string.
	Path       string  `json:"path"`
	Status     int     `json:"status"`
	DurationMS float64 `json:"duration_ms"`
	RequestID  string  `json:"request_id,omitempty"`
	TraceID    string  `json:"trace_id,omitempty"`
}

type RequestList struct {
	// Max is how many requests the console keeps.
	Max      int       `json:"max"`
	Requests []Request `json:"requests"`
}

type Role struct {
	Name        string   `json:"name"`
	Description string   `json:"description"`
	Permissions []string `json:"permissions"`
}

type Route struct {
	Method string `json:"method"`
	// Path is the route's pattern, such as "/v1/projects/{id}".
	Path        string   `json:"path"`
	OperationID string   `json:"operation_id,omitempty"`
	Summary     string   `json:"summary,omitempty"`
	Tags        []string `json:"tags"`
	// Secured reports an operation that declares a security requirement.
	Secured bool `json:"secured"`
	// Source is [RouteOpenAPI] or [RouteHandler].
	Source string `json:"source"`
}

type RouteList struct {
	Routes []Route `json:"routes"`
}

type Setting struct {
	Key            string          `json:"key"`
	Group          string          `json:"group"`
	Description    string          `json:"description"`
	Kind           string          `json:"kind"`
	Value          json.RawMessage `json:"value"`
	Default        json.RawMessage `json:"default"`
	Modified       bool            `json:"modified"`
	OrgOverridable bool            `json:"org_overridable"`
}

type Sources struct {
	// App describes the running app (GET /_dev/app).
	App func(ctx context.Context) (App, error)
	// Routes lists the app's HTTP routes (GET /_dev/routes); see
	// [RoutesFromOpenAPI].
	Routes func(ctx context.Context) ([]Route, error)
	// Config lists the environment variables the app read (GET
	// /_dev/config); see [EnvKeys].
	Config func(ctx context.Context) ([]EnvKey, error)
	// Mail lists captured email (GET /_dev/mail); see [MailpitSource].
	Mail func(ctx context.Context) (Mail, error)
	// Migrations reports the database's migration state (GET
	// /_dev/migrations).
	Migrations func(ctx context.Context) (Migrations, error)
	// Jobs lists recent job runs (GET /_dev/jobs).
	Jobs func(ctx context.Context) ([]JobRun, error)
	// MailPreviews renders the app's emails with sample data (GET
	// /_dev/mail/previews, /_dev/mail/preview, POST /_dev/mail/preview/send);
	// see [MailPreviewer].
	MailPreviews *MailPreviewer
}

type StreamDropped struct {
	Count int `json:"count"`
}

type StreamEnd struct {
	// Reason is "max_duration" or "shutdown".
	Reason string `json:"reason"`
}