contenturl

type AliasKey struct {
	Source string `json:"source"`
	Kind   string `json:"kind"`
	Key    string `json:"key"`
}

type AliasLookup struct {
	Aliases []AliasKey `json:"aliases"`
}

type AliasMatch struct {
	Link
	Locator string
}

type AliasResult struct {
	AliasKey
	// Status is found, not_found or gone.
	Status string `json:"status"`
	// Resolved is a found alias's link and canonical path.
	Resolved *Resolved `json:"resolved,omitempty"`
	// Locator is a found alias's position inside its content, such as a page.
	Locator string `json:"locator,omitempty"`
}

type AliasResults struct {
	Aliases []AliasResult `json:"aliases"`
}

type Code string

type Decision struct {
	// Matched: the request names visible, routed content. When neither
	// Matched nor Gone, the host serves the request as it would without the
	// router (usually its 404).
	Matched bool
	// Gone: the request names routed content the host removed (410).
	Gone bool
	// Redirect: the path is not canonical; answer 301 to Location.
	Redirect bool
	// Private: matched only for this viewer (Preview); never cache or index it.
	Private  bool
	Link     Link
	Language string
	Path     string // the canonical path
	Location string // Path plus the request's query
}

type Link struct {
	contentref.ContentRef
	Code  Code              `json:"code"`
	Slug  string            `json:"slug"`
	Slugs map[string]string `json:"slugs,omitempty"`
}

type Parsed struct {
	Language string // "" when unprefixed (an old link: it redirects)
	Route    string
	Code     Code   // canonical form
	RawCode  string // as written
	Slug     string // decorative segments as written, "/"-joined; "" when absent
}

type Resolved struct {
	Link
	Path string `json:"path"`
	// VersionID is the live version ?v= names; "" when it names none, and the
	// page shows its language's default edition.
	VersionID string `json:"version_id,omitempty"`
}

type RouterOptions struct {
	// Routes maps content kinds to the host's routes. Required.
	Routes Routes
	// Languages are the site's languages, its default first. Required: every
	// content page is under one (/{lang}/{route}/...), which picks its slug;
	// a request without one redirects to the language Accept-Language names,
	// else the default.
	Languages []string
	// BaseURL ("https://example.com") makes Middleware send the canonical URL
	// as a `Link: <url>; rel="canonical"` header. Empty: no header.
	BaseURL string
	// Visibility is the host's verdict on each resolved link, in order
	// (drafts, removed content, viewer restrictions). nil: every registered
	// code is Visible.
	Visibility func(r *http.Request, links []Link) ([]Visibility, error)
	// Gone answers requests for Gone content. nil: a plain 410.
	Gone http.Handler
	// Logger receives resolution failures (5xx). nil: slog.Default().
	Logger *slog.Logger
}

type Routes map[string]string

type VersionCode string

type VersionKey struct {
	ContentID string
	Code      VersionCode
}

type Visibility int