tunnel

type Binary struct {
	Found bool `json:"found"`
	// Path is the program; FromEnv reports it came from ORB_CLOUDFLARED.
	Path    string `json:"path,omitempty"`
	FromEnv bool   `json:"from_env"`
	// Version is the first line of cloudflared --version.
	Version string `json:"version,omitempty"`
	// Problem says why it wasn't found.
	Problem string `json:"problem,omitempty"`
}

type Callback struct {
	// Provider is google, apple, github or resend.
	Provider string `json:"provider"`
	// Label names the address, such as "Authorized redirect URI".
	Label string `json:"label"`
	// URL is the full address; Path the app's route it reaches.
	URL    string `json:"url"`
	Method string `json:"method"`
	Path   string `json:"path"`
	// Where is where to paste it in the provider's console.
	Where string `json:"where"`
	// Configured reports that the app's environment sets up the provider
	// (such as GOOGLE_CLIENT_ID).
	Configured bool `json:"configured"`
}

type Config struct {
	// Dir is the app directory (for SettingsFile and cloudflared's working
	// directory).
	Dir string
	// Env returns orb dev's view of the environment: the process
	// environment and .env, the environment winning. It is read on every
	// start, for APP_ENV, the token, the hostname and ORB_CLOUDFLARED.
	Env func() []string
	// Target returns the app's address as reachable from this machine,
	// such as http://127.0.0.1:8080.
	Target func() (string, error)
	// OnChange receives the status after every change; it must not block.
	OnChange func(Status)
	// Logf prints orb's own messages about the tunnel; nil discards them.
	Logf func(format string, args ...any)
	// LookPath finds programs; nil uses exec.LookPath.
	LookPath func(string) (string, error)
	// ProcessEnv is the environment cloudflared inherits (without any
	// tunnel token variables); nil uses os.Environ.
	ProcessEnv func() []string
	// StartTimeout bounds how long cloudflared may take to connect (and a
	// quick tunnel to report its URL); zero means 45 seconds.
	StartTimeout time.Duration
	// StopTimeout is how long cloudflared gets to exit after SIGTERM
	// before its group is killed; zero means 5 seconds.
	StopTimeout time.Duration
	// Client makes reachability checks; nil uses a client with a 10 second
	// timeout that resolves names with Go's own DNS client, so a lookup
	// made before a new quick tunnel's name existed isn't answered from the
	// system's negative cache. Redirects are never followed.
	Client *http.Client
	// CheckAttempts and CheckInterval shape the check after connecting,
	// which waits an interval first and retries while DNS and Cloudflare
	// catch up; zero means 12 and 5 seconds, and negative attempts turn the
	// automatic check off.
	CheckAttempts int
	CheckInterval time.Duration
}

type EnvChange struct {
	Key string `json:"key"`
	// Current is the value .env (or the environment) has, "" when unset.
	Current string `json:"current"`
	// Proposed is the value the tunnel needs.
	Proposed string `json:"proposed"`
	Reason   string `json:"reason"`
	// Optional changes are proposed but not needed for sign-in to work
	// through the tunnel; the portal leaves them unticked.
	Optional bool `json:"optional"`
}

type Error struct {
	Code   string
	Detail string
}

type Info struct {
	Status      Status        `json:"status"`
	Cloudflared Binary        `json:"cloudflared"`
	Install     []InstallStep `json:"install"`
	// OS is this machine's operating system, to pick install steps.
	OS string `json:"os"`
	// Hostname is a named tunnel's hostname as configured (normalized when
	// valid) and HostnameSource where it comes from: ORB_TUNNEL_HOSTNAME,
	// the portal's saved setting, or "".
	Hostname       string `json:"hostname,omitempty"`
	HostnameSource string `json:"hostname_source,omitempty"`
	// TokenSource is the variable a named tunnel's token comes from, or ""
	// when none is set; TokenProblem says what is wrong with it. The token
	// itself is never included.
	TokenSource  string `json:"token_source,omitempty"`
	TokenProblem string `json:"token_problem,omitempty"`
	// AppEnv is APP_ENV as orb dev runs the app; Allowed reports a tunnel
	// may start (development only).
	AppEnv  string `json:"app_env"`
	Allowed bool   `json:"allowed"`
	// Target is where a tunnel forwards: the app's address.
	Target string `json:"target,omitempty"`
}

type InstallStep struct {
	// OS is darwin, linux or windows (as Go names them).
	OS      string `json:"os"`
	Label   string `json:"label"`
	Command string `json:"command,omitempty"`
	URL     string `json:"url,omitempty"`
}

type LogLine struct {
	Time time.Time `json:"time"`
	// Level is cloudflared's: DBG, INF, WRN, ERR, FTL, or "".
	Level string `json:"level,omitempty"`
	Text  string `json:"text"`
}

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

type Mode string

type Reachability struct {
	URL       string    `json:"url"`
	OK        bool      `json:"ok"`
	Status    int       `json:"status,omitempty"`
	Detail    string    `json:"detail"`
	CheckedAt time.Time `json:"checked_at"`
	LatencyMS float64   `json:"latency_ms"`
}

type Route struct {
	Method string
	Path   string
}

type Setup struct {
	PublicURL string `json:"public_url"`
	Hostname  string `json:"hostname"`
	Stable    bool   `json:"stable"`
	// Changes are the .env changes for sign-in, passkeys and client
	// addresses through the tunnel; Set holds the required ones as the env
	// editor's PUT body takes them.
	Changes []EnvChange       `json:"changes"`
	Set     map[string]string `json:"set"`
	// Callbacks are the addresses to register with providers.
	Callbacks []Callback `json:"callbacks"`
	// RoutesKnown is false when the addresses are the defaults because the
	// app's routes couldn't be listed.
	RoutesKnown bool `json:"routes_known"`
	// Warnings say what to watch out for, such as a quick tunnel's URL
	// changing on the next run.
	Warnings []string `json:"warnings"`
}

type SetupInput struct {
	// Status is the tunnel's; Setup needs its PublicURL.
	Status Status
	// Env is the environment as the app would read it (.env with the
	// process environment winning).
	Env []string
	// AppPort is the port the app listens on.
	AppPort string
	// Routes are the app's routes; RoutesKnown is false when they couldn't
	// be listed, and the provider addresses are then the defaults.
	Routes      []Route
	RoutesKnown bool
}

type StartOptions struct {
	Mode Mode `json:"mode"`
	// Hostname is a named tunnel's public hostname; empty uses
	// ORB_TUNNEL_HOSTNAME, then the one saved from the portal. A hostname
	// given here is saved for the next run unless ORB_TUNNEL_HOSTNAME is set.
	Hostname string `json:"hostname,omitempty"`
}

type State string

type Status struct {
	State State `json:"state"`
	Mode  Mode  `json:"mode,omitempty"`
	// PublicURL is https://<hostname>: a quick tunnel's once cloudflared
	// reports it, a named tunnel's from the start.
	PublicURL string `json:"public_url,omitempty"`
	Hostname  string `json:"hostname,omitempty"`
	// Stable reports a URL that stays the same across runs (named
	// tunnels): only such a URL suits sign-in callbacks and passkeys.
	Stable bool `json:"stable"`
	// Target is the app's address cloudflared forwards to (a quick
	// tunnel's --url; for a named tunnel, where its public hostname
	// should point in the dashboard).
	Target      string     `json:"target,omitempty"`
	PID         int        `json:"pid,omitempty"`
	StartedAt   *time.Time `json:"started_at,omitempty"`
	ConnectedAt *time.Time `json:"connected_at,omitempty"`
	// Problem says why the tunnel failed, or what needs attention.
	Problem string `json:"problem,omitempty"`
	// Restarts counts starts after the first in this orb dev run.
	Restarts int `json:"restarts"`
	// Check is the last reachability check.
	Check *Reachability `json:"check,omitempty"`
	// Log holds cloudflared's most recent lines, oldest first.
	Log []LogLine `json:"log"`
}