contentsource

type Adapter interface {
	// Standing reads the account's own standing.
	Standing(ctx context.Context) (Standing, error)
	// Search lists pages matching a query.
	Search(ctx context.Context, q string) ([]Hit, error)
	// Resolve turns what a product manager pasted — an address, a key or an id
	// — into the page's stable id. An address of another host than the source's
	// is refused.
	Resolve(ctx context.Context, input string) (string, error)
	// Page reads one page by id, with its security facts.
	Page(ctx context.Context, id string) (Page, error)
	// Ancestors reads the whole parent chain of a page, nearest first. An
	// ancestor the account cannot read is [ErrUnreadable].
	Ancestors(ctx context.Context, p Page) ([]Page, error)
	// Children lists a page's readable child pages, by id, in sibling order.
	Children(ctx context.Context, p Page) ([]string, error)
	// Attachment reads the file of a page named name — or whose id is name, as
	// an image block names it — at most max bytes, with the media type the
	// source gives it.
	Attachment(ctx context.Context, pageID, name string, max int64) ([]byte, string, error)
	// Watch asks the source to report changes to a page in its feed.
	Watch(ctx context.Context, id string) error
	// Unwatch ends the watch of a page Atlas no longer holds anything of, by
	// id — which ends it even when the page can no longer be read.
	Unwatch(ctx context.Context, id string) error
	// Head is the feed's current position, from which no change is yet known.
	Head(ctx context.Context) (int64, error)
	// Changes waits up to wait for changes after the cursor.
	Changes(ctx context.Context, after int64, wait time.Duration) (Changes, error)
}

type Block struct {
	Kind BlockKind
	// Source is the source's own name for the block's kind, for the preview's
	// account of what was dropped.
	Source string
	Text   string
	Marks  []Mark
	// Ref names what an image (an attachment of the page) or an embed (another
	// item) shows.
	Ref string
	// Level is a heading's level, 1 to 3; Tone a panel's tone; Checked whether a
	// task is done; Align and Width how an image or a paragraph is laid out.
	Level   int
	Tone    string
	Checked bool
	Align   string
	Width   int
}

type BlockKind string

type Bound interface {
	// Referenced names every source a binding names, configured or not: a
	// binding to a source that was removed is rechecked too, and fails.
	Referenced() ([]string, error)
	// Targets lists the products bound to a source.
	Targets(source string) ([]Target, error)
	// Record writes what a recheck found.
	Record(source string, results []Result) error
}

type Change struct {
	Seq int64
	// Item is the changed page's id, or empty for "a watched page you can no
	// longer read changed" — which names nothing, so everything is rechecked.
	Item string
}

type Changes struct {
	Changes []Change
	Last    int64
}

type Check struct {
	ID       string   `json:"id"`
	Passages []string `json:"passages,omitempty"`
}

type Content struct {
	Languages map[string]Language
	Keywords  []string
	Picture   *Picture
	// Images are the images the rich descriptions show, by the id their blocks
	// name: copied out of the source, so the shop never asks it for anything.
	Images map[string]*Picture
}

type Converted struct {
	// Text is the page's body as plain text. Never markup: it is rendered as
	// text wherever it is shown.
	Text string
	// Passages are the protected passages removed, by the id the source gives
	// them. They are kept so a recheck can tell a passage protected after the
	// copy was taken — whose text Atlas then holds — from one it removed.
	Passages []string
	// Dropped names the blocks not taken, by the source's kind, in order.
	Dropped []string
	// Problems refuse the page: something the conversion could not make safe.
	Problems []string
}

type Dropped struct {
	// Page names the page it was on, by key where it has one.
	Page string `json:"page"`
	// What is "page" for a child page dropped with everything below it,
	// "passage" for a protected passage removed, or the source's kind of a block
	// not taken.
	What    string   `json:"what"`
	Reasons []string `json:"reasons,omitempty"`
}

type Fact int

type Hit struct {
	ID    string `json:"id"`
	Key   string `json:"key"`
	Title string `json:"title"`
	Space string `json:"space"`
	State string `json:"state,omitempty"`
	URL   string `json:"url,omitempty"`
}

type Language struct {
	// Input is what was asked for — an address, a key or an id.
	Input string `json:"input"`
	// Page is the language page itself.
	Page  Taken  `json:"page"`
	Space string `json:"space,omitempty"`
	State string `json:"state,omitempty"`
	// Labels are the page's own labels, as the source answered them.
	Labels []string `json:"labels,omitempty"`
	// Children are the child pages taken, depth first in sibling order.
	Children []Taken `json:"children,omitempty"`
	// Text is the description: the page's body followed by its children's.
	Text string `json:"text"`
	// Rich is the description as the source lays it out: the page's blocks,
	// then each child page with its own, depth first, every embedded item in
	// place (amendment of 2026-10-28).
	Rich []Rich `json:"rich,omitempty"`
	// Embeds are the items embedded anywhere in the description and taken.
	Embeds []Taken `json:"embeds,omitempty"`
	// Dropped is everything the rules or the conversion left out.
	Dropped []Dropped `json:"dropped,omitempty"`
	// Refusals refuse the page. Empty is the only pass.
	Refusals []string `json:"refusals,omitempty"`
	// contains filtered or unexported fields
}

type Mark struct {
	Kind  MarkKind
	Start int
	End   int
	// Ref names the passage a MarkPassage protects.
	Ref string
}

type MarkKind string

type Page struct {
	ID      string
	Key     string
	Title   string
	Space   string
	Parent  string
	URL     string
	Version int
	State   string
	Labels  []string
	// Properties are the page's typed properties, as the source answered them.
	Properties map[string]any
	Body       []Block

	// ReadRestricted is a read restriction on the page itself, whoever it
	// names — including the account (§ 8).
	ReadRestricted Fact
	// Held is an open data protection hold.
	Held Fact
	// Withdrawn is a page not live: trashed, purged or redacted.
	Withdrawn Fact
	// Presence is the source's own word for where the page stands, for the
	// refusal's sentence.
	Presence string
}

type Picture struct {
	Name string
	Type string
	Data []byte
}

type Refused struct {
	// Problems name the slot (a language tag, or "" for the whole binding) and
	// why.
	Problems []SlotProblem
}

type Registry struct {

	// Transport is the HTTP transport adapters use; nil is the process-wide one.
	// Tests set a test server's.
	Transport http.RoundTripper
	// Dial builds the adapter for a source. Nil dials by kind; tests replace it.
	Dial func(src Source, token string, transport http.RoundTripper) (Adapter, error)
	// contains filtered or unexported fields
}

type Result struct {
	Item   string
	At     int64
	Passed bool
	Reason string
}

type Rich struct {
	// Kind is heading, paragraph, bullet, ordered, quote, code, panel, table,
	// divider, image, page (a child page: Title and Blocks) or embed (an
	// embedded item: Title and Blocks).
	Kind string `json:"kind"`
	// Level is a heading's level, 1 to 3.
	Level int `json:"level,omitempty"`
	// Text is the block's text with every protected passage and mention
	// removed; an image's caption.
	Text string `json:"text,omitempty"`
	// Checked is a task's state, for a bullet that came from one.
	Checked bool `json:"checked,omitempty"`
	// Tone is a panel's tone, as the source names it.
	Tone string `json:"tone,omitempty"`
	// Rows are a table's cells, the first row its header.
	Rows [][]string `json:"rows,omitempty"`
	// Image is an image's id in Atlas's own store: the shop never asks the
	// source for anything. Empty in a preview, which copies nothing.
	Image string `json:"image,omitempty"`
	// Width is an image's width in percent of the column, 0 for its own size;
	// Align its alignment, as the source names it.
	Width int    `json:"width,omitempty"`
	Align string `json:"align,omitempty"`
	// Title and Blocks are a child page's or an embedded item's.
	Title  string `json:"title,omitempty"`
	Blocks []Rich `json:"blocks,omitempty"`
	// contains filtered or unexported fields
}

type Runner struct {

	// Interval is the sweep's period; Wait is how long one long poll of the feed
	// is held; Backoff is the pause after the feed failed. Settable for tests.
	Interval time.Duration
	Wait     time.Duration
	Backoff  time.Duration
	// contains filtered or unexported fields
}

type Service struct {

	// InUse names the products bound to a source, so removing one that still
	// supplies something is refused rather than leaving bindings nothing can
	// recheck. Off the loop. Nil answers none.
	InUse func(id string) ([]string, error)
	// contains filtered or unexported fields
}

type SlotProblem struct {
	Lang    string `json:"lang,omitempty"`
	Page    string `json:"page,omitempty"`
	Message string `json:"message"`
}

type Source struct {
	// ID names the source in a binding. It is chosen, not minted, because a
	// binding names it for as long as the item exists.
	ID string `json:"id"`
	// Name is what a product manager reads when choosing a source.
	Name string `json:"name"`
	// Kind is the adapter, one of [Kinds].
	Kind string `json:"kind"`
	// BaseURL is where the source answers, https only. A page address of any
	// other host is refused when it is pasted (§ 5), and the adapter follows no
	// redirect away from it.
	BaseURL string `json:"baseURL"`
	// CredentialsRef names the vault secret (or ATLAS_CONNECTOR_<REF>_TOKEN)
	// holding the technical account's read token.
	CredentialsRef string `json:"credentialsRef"`
	// CredentialsRefRedacted is set only on a source as an API answer shows it
	// (see [Source.Shown]): the stored credentialsRef looked like a credential
	// itself, so it is not shown, and the administrator must name a secret.
	CredentialsRefRedacted bool `json:"credentialsRefRedacted,omitempty"`
	// PictureField is the property of the primary page that names the
	// attachments to use as pictures. Empty means the source supplies none.
	PictureField string `json:"pictureField,omitempty"`
	// ExcludedLabels are labels that organise the wiki and are not keywords.
	ExcludedLabels []string `json:"excludedLabels,omitempty"`
	// LinkInShop says whether the shop may show "more in the wiki" under a
	// description. Off by default: the address of a page is itself something
	// the product owner may not have meant every orderer to see.
	LinkInShop bool `json:"linkInShop,omitempty"`
	// CreatedAt and UpdatedAt are the server's Unix nanoseconds.
	CreatedAt int64 `json:"createdAt,omitempty"`
	UpdatedAt int64 `json:"updatedAt,omitempty"`
}

type SpaceGrant struct {
	Space string
	Role  string
	Via   string
}

type Standing struct {
	// Scope is the token's scope; only "read" passes.
	Scope            string
	SystemRoles      []string
	SystemRolesKnown bool
	Spaces           []SpaceGrant
	SpacesKnown      bool
}

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

type Taken struct {
	ID       string   `json:"ref"`
	Key      string   `json:"key,omitempty"`
	Title    string   `json:"title,omitempty"`
	URL      string   `json:"url,omitempty"`
	Version  int      `json:"version"`
	Passages []string `json:"passages,omitempty"`
}

type Target struct {
	Item   string
	Checks []Check
}

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