api

type AuthStatus struct {
	// Required reports whether this install protects itself with a password at
	// all. False for a loopback-only bind.
	Required bool `json:"required"`
	// NeedsSetup means no password exists yet and one must be created.
	NeedsSetup bool `json:"needs_setup"`
	// Authenticated reports whether the caller is signed in.
	Authenticated bool `json:"authenticated"`
	// Version and Build identify this install on the one screen that is shown
	// before anybody can sign in. A person looking at a login box has no other
	// way to tell what they are looking at, and a bug report from that screen
	// is otherwise unattributable to a build.
	Version string `json:"version,omitempty"`
	Build   string `json:"build,omitempty"`
	// LockedOut reports whether this client has failed too many logins.
	LockedOut bool `json:"locked_out"`
	// Exposed reports whether the server is reachable beyond this machine,
	// which the UI says out loud so nobody is surprised by their own exposure.
	Exposed        bool `json:"exposed"`
	MinPasswordLen int  `json:"min_password_len"`
}

type DispatchState struct {
	// Enabled reports whether peering is running at all. When false, nothing
	// this instance observes has ever left the machine.
	Enabled bool `json:"enabled"`
	// PeerID identifies this instance to the people it pairs with, grouped for
	// reading aloud.
	PeerID string `json:"peer_id,omitempty"`
	// Listen is where peers reach this instance.
	Listen string `json:"listen,omitempty"`
	// Peers is every pairing and its current state.
	Peers []dispatch.PeerState `json:"peers"`
}

type Origin struct {
	Lat     float64 `json:"lat"`
	Lon     float64 `json:"lon"`
	Label   string  `json:"label"`
	Country string  `json:"country,omitempty"`
	City    string  `json:"city,omitempty"`
	// Known is false until the origin has been located, which lets the UI draw
	// arcs from a neutral position rather than from a wrong one.
	Known bool `json:"known"`
}

type Server struct {
	Store *store.Store
	Bus   *pipeline.Bus
	Probe capture.Probe

	// Version identifies the build in /api/summary.
	Version string
	// Build is the commit count, shown beside the version. Two builds of one
	// version are otherwise indistinguishable to somebody reporting a fault.
	Build string

	// CaptureInterfaces lists the devices capture could run on, and names the
	// one it is actually using. A function rather than the source itself, so
	// this package needs no capture build tag and --offline can leave it nil.
	//
	// Exists because the automatic choice was unreportable: on Windows every
	// device is named \Device\NPF_{GUID}, the startup log was the only place
	// the pick appeared, and choosing a virtual adapter with no traffic on it
	// looks exactly like a working install with a quiet network.
	CaptureInterfaces func() (active string, all []patrol.Interface, err error)

	// Auth guards the data endpoints.
	Auth *auth.Authenticator
	// SaveHash persists a newly created password hash.
	SaveHash func(hash string) error
	// Exposed reports whether the server is reachable beyond this machine.
	Exposed bool
	// DataDir is shown in settings so the user knows where their data lives.
	DataDir string
	// RDAP resolves registration detail on demand. Optional: a nil resolver
	// simply means the Rap Sheet shows no registration section.
	RDAP *enrich.RDAP
	// Labeller categorizes domains. Optional: a nil labeller means lookups are
	// shown unlabelled, which is a degradation rather than a failure.
	Labeller *enrich.Labeller

	// StartPeering brings peer sharing up, and is supplied by whatever is
	// hosting this server, building the service needs a listen address, a
	// data directory and a logger, none of which the API layer knows about.
	//
	// Nil means this host cannot start peering at runtime, which is a real
	// case: an instance reading somebody else's database offline has nothing
	// to share and no business sharing it.
	StartPeering func(context.Context) (*dispatch.Service, error)

	// IngestHealth reports whether observations are reaching storage. Optional;
	// when nil the endpoint reports that health is not being tracked rather
	// than claiming everything is fine.
	IngestHealth func() any
	// StartedAt is when this process began serving, for the uptime reading.
	StartedAt time.Time
	// contains filtered or unexported fields
}

type Settings struct {
	RetentionRawHours   int    `json:"retention_raw_hours"`
	RetentionRollupDays int    `json:"retention_rollup_days"`
	StorageMaxMB        int64  `json:"storage_max_mb"`
	DBBytes             int64  `json:"db_bytes"`
	DataDir             string `json:"data_dir"`
}

type SummaryResponse struct {
	store.Summary
	Mode         string `json:"mode"`
	Capabilities any    `json:"capabilities"`
	Origin       Origin `json:"origin"`
	Version      string `json:"version"`
	Build        string `json:"build"`
	Host         string `json:"host"`
	Since        int64  `json:"since"`
	// Notes is English prose for API consumers; NoteCodes is what the dashboard
	// translates.
	Notes     []string `json:"notes,omitempty"`
	NoteCodes []string `json:"note_codes,omitempty"`
}