catalog

type AuthError struct{ Err error }

type Content struct {
	ID   string `json:"id"`
	Kind string `json:"kind"`
	// Code and Path are its page: [/{lang}]/{route}/{code}/{slug}.
	Code string `json:"code"`
	Path string `json:"path"`
	// Language is the language of the text below.
	Language    string `json:"language"`
	Title       string `json:"title"`
	Slug        string `json:"slug,omitempty"`
	Description string `json:"description,omitempty"`
	// Body shows each inline image with a current public file as its URL;
	// only editors and viewers Decision allows get it. Description is the
	// teaser everyone reads.
	Body string `json:"body,omitempty"`
	// Decision is the viewer's access to the item: allowed when they open any
	// of its versions, else its first version's paywall.
	Decision Decision `json:"decision"`
	// Images maps each resolved image name of Body and the cover to its URL.
	Images  map[string]string `json:"images,omitempty"`
	Cover   *Cover            `json:"cover,omitempty"`
	State   string            `json:"state"`
	Listing string            `json:"listing"`
	// Comments is open, closed or hidden.
	Comments     string         `json:"comments"`
	PublishAt    *time.Time     `json:"publish_at,omitempty"`
	PublishedAt  *time.Time     `json:"published_at,omitempty"`
	Live         bool           `json:"live"`
	Access       access.Rule    `json:"access"`
	Restrictions []string       `json:"restrictions"`
	Attributes   map[string]any `json:"attributes"`
	OwnerGroupID string         `json:"owner_group_id,omitempty"`
	// Owner is the owner group's card (a channel's name, path, avatar and
	// cover) while it is active.
	Owner    *groups.GroupCard `json:"owner,omitempty"`
	Creators []Creator         `json:"creators"`
	Groups   []GroupSummary    `json:"groups"`
	Versions []Version         `json:"versions"`
	// Views counts its distinct viewers of all time plus its imported legacy
	// view count, as cards' counts.views do.
	Views int64 `json:"views"`
	// Viewer is the signed-in reader's standing with the item, to resume
	// it; each version carries its own.
	Viewer *ViewerState `json:"viewer,omitempty"`
	// Editor: the viewer may edit it; the fields below are theirs.
	Editor           bool            `json:"editor"`
	Text             map[string]Text `json:"text,omitempty"`
	Moderation       string          `json:"moderation,omitempty"`
	ModerationReason string          `json:"moderation_reason,omitempty"`
	EverSold         bool            `json:"ever_sold,omitempty"`
	// Offer is the item's current offer, for its offer editors.
	Offer     *offers.Offer `json:"offer,omitempty"`
	Revision  int64         `json:"revision"`
	CreatedAt time.Time     `json:"created_at"`
	UpdatedAt time.Time     `json:"updated_at"`
	DeletedAt *time.Time    `json:"deleted_at,omitempty"`
}

type ContentInput struct {
	Kind string `json:"kind"`
	// Text is the text per language.
	Text    map[string]Text `json:"text,omitempty"`
	Listing string          `json:"listing,omitempty"` // default listed
	// Comments is open (the default), closed (existing ones show, new ones
	// are refused) or hidden.
	Comments string `json:"comments,omitempty"`
	// Access defaults to public.
	Access       *access.Rule   `json:"access,omitempty"`
	Restrictions []string       `json:"restrictions,omitempty"`
	Attributes   map[string]any `json:"attributes,omitempty"`
	// OwnerGroupID is the home group (a channel); its editors edit the item.
	// It never changes.
	OwnerGroupID string `json:"owner_group_id,omitempty"`
	// Creators nil credits the creating person as its author.
	Creators *[]Creator `json:"creators,omitempty"`
	// Versions: at least one, except for a kind with hidden versions, which
	// gets its one version automatically.
	Versions []VersionInput `json:"versions,omitempty"`
}

type ContentPatch struct {
	Listing      *string        `json:"listing,omitempty"`
	Comments     *string        `json:"comments,omitempty"`
	Access       *access.Rule   `json:"access,omitempty"`
	Restrictions *[]string      `json:"restrictions,omitempty"`
	Attributes   map[string]any `json:"attributes,omitempty"` // replaces all
	Creators     *[]Creator     `json:"creators,omitempty"`
	// Cover is an inline image name of the content's folder; "" clears.
	Cover *string `json:"cover,omitempty"`
	// Revision, when set, refuses the edit (409) unless it is current.
	Revision *int64 `json:"revision,omitempty"`
}

type Cover struct {
	Image string  `json:"image"`
	URL   *string `json:"url,omitempty"`
}

type Creator struct {
	UserID   string `json:"user_id"`
	Role     string `json:"role,omitempty"`
	Position int    `json:"position"`
}

type CreatorsInput struct {
	Creators []Creator `json:"creators"`
}

type Decision struct {
	Allowed bool `json:"allowed"`
	// Unknown: entitlements could not be read; denied, nothing offered.
	Unknown bool `json:"unknown,omitempty"`
	// Sell is the keys a paywall offers; Requires the key a buyer holds first.
	Sell     []string `json:"sell,omitempty"`
	Requires string   `json:"requires,omitempty"`
	// Preview is what a locked viewer still reads; FreeAfter when it opens to all.
	Preview   *access.Preview `json:"preview,omitempty"`
	FreeAfter *time.Time      `json:"free_after,omitempty"`
	// Offers are the purchasable offers of Sell's keys; tiers are the host's
	// to label.
	Offers []offers.Sale `json:"offers,omitempty"`
}

type Event struct {
	ID        int64     `json:"id"`
	Type      string    `json:"type"`
	Kind      string    `json:"kind"`
	ContentID string    `json:"content_id"`
	VersionID string    `json:"version_id,omitempty"`
	CreatedAt time.Time `json:"created_at"`
}

type GroupSummary struct {
	ID   string `json:"id"`
	Kind string `json:"kind"`
	Slug string `json:"slug"`
	Name string `json:"name"`
	Code string `json:"code,omitempty"`
	Path string `json:"path,omitempty"`
}

type Groups interface {
	EffectiveGroups(ctx context.Context, q groups.Querier, versionIDs []string) (map[string][]string, error)
	Cards(ctx context.Context, ids []groups.GroupID, o groups.CardOptions) ([]groups.GroupCard, error)
}

type Images interface {
	Images(ctx context.Context, qs ...media.ImageQuery) ([][]media.PublicImage, error)
}

type ImportContent struct {
	ID          string
	Kind        string
	State       string
	PublishAt   *time.Time
	PublishedAt *time.Time
	DeletedAt   *time.Time
	Listing     string
	// Comments is open (when empty), closed or hidden.
	Comments string
	// ViewBaseline is the legacy all-time view count, added to the viewers
	// the signal plane counts.
	ViewBaseline int64
	Access       *access.Rule
	Restrictions []string
	Attributes   map[string]any
	OwnerGroupID string
	Cover        string
	Creators     []Creator
	Text         map[string]Text
	Versions     []ImportVersion
	Code         string
	CreatedAt    *time.Time
	UpdatedAt    *time.Time
}

type ImportVersion struct {
	ID          string
	Languages   []string
	Traits      []string
	Label       string
	State       string
	PublishAt   *time.Time
	PublishedAt *time.Time
	DeletedAt   *time.Time
	Access      *access.Rule
	Attributes  map[string]any
	Ordinal     *int
	Text        map[string]VersionText
	Segments    []Segment
	CreatedAt   *time.Time
	UpdatedAt   *time.Time
}

type InlineImage struct {
	Ref string  `json:"ref"`
	URL *string `json:"url"`
}

type LanguageTotal struct {
	Public int64            `json:"public"`
	Tiers  map[string]int64 `json:"tiers"`
}

type ManageQuery struct {
	Kind string
	// State is draft, scheduled, published (live) or deleted; "" is every
	// state but deleted.
	State      string
	OwnerGroup string
	// Text matches title, description or body, ignoring case.
	Text          string
	Limit, Offset int
}

type Media struct {
	Images Images // *media.Manifests
	// Reader gives editors an unpublished item's image previews.
	Reader   Reader
	Versions VersionMedia // *versions.Service
}

type Moderation interface {
	Screen(ctx context.Context, in content.ModerationInput) (content.Screening, error)
}

type Offers interface {
	Resync(ctx context.Context, tx pgx.Tx, targets []offers.Target) error
	Sales(ctx context.Context, keys []string) (map[string]offers.Sale, error)
	Current(ctx context.Context, a auth.Authenticator, actor access.Actor, targets []offers.Target) ([]*offers.Offer, error)
}

type Options struct {
	Pool   *pgxpool.Pool
	Schema string
	Tenant string
	// Kinds is the site's content model. Required.
	Kinds kinds.Config
	// Auth gates the routes and answers staff and owner-group permissions.
	Auth auth.Authenticator
	// Gate answers viewers' entitlements; nil builds one without billing
	// (only free rules and claimed tiers open).
	Gate *access.Gate
	// Offers renames the products of content whose title changes and answers
	// paywalls' offers; nil when nothing is sold.
	Offers Offers
	// Groups answers effective group ids for content_facets; nil: none. Wire
	// its Options.ContentChanged to Store.ContentChanged.
	Groups Groups
	// Moderation screens text of content that is or goes live; nil approves
	// unless contentkit.NewRuntime binds its content runtime (BindModeration).
	Moderation Moderation
	// Body sanitizes text bodies; nil strips tags.
	Body Sanitizer
	// DeletedRetention: see DefaultDeletedRetention.
	DeletedRetention time.Duration
	// DocumentsChanged runs in the writing transaction after a write queued
	// search documents, so the engine can sync them at once. Optional.
	DocumentsChanged func(ctx context.Context, q Querier) error
	Now              func() time.Time
	Logger           *slog.Logger
}

type OrderInput struct {
	IDs []string `json:"ids"`
}

type Publish struct {
	ContentID string
	At        *time.Time
}

type PublishInput struct {
	PublishAt *time.Time `json:"publish_at,omitempty"`
}

type Querier interface {
	Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)
	QueryRow(ctx context.Context, sql string, args ...any) pgx.Row
	Exec(ctx context.Context, sql string, args ...any) (pgconn.CommandTag, error)
}

type Reader interface {
	Read(ctx context.Context, ref contentref.ContentRef, actor access.Actor, o media.ReadOptions) (*media.ReadResult, error)
	// NamedURLs signs an opened item's named images that have no public files.
	NamedURLs(ctx context.Context, ref contentref.ContentRef, actor access.Actor, names []string) (map[string]string, error)
}

type Sanitizer = content.ContentProcessor

type Segment struct {
	Position  int        `json:"position"`
	Title     string     `json:"title,omitempty"`
	Start     int        `json:"start"`
	End       int        `json:"end"`
	ReleaseAt *time.Time `json:"release_at,omitempty"`
	// Released is computed on reads.
	Released bool `json:"released"`
}

type SegmentsInput struct {
	Segments []Segment `json:"segments"`
}

type Standing interface {
	Standing(ctx context.Context, actor access.Actor, refs []contentref.ContentRef) ([]ViewerState, error)
}

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

type Subscriber func(ctx context.Context, events []Event) error

type Text struct {
	Title       string   `json:"title"`
	Slug        string   `json:"slug,omitempty"`
	Description string   `json:"description,omitempty"`
	Body        string   `json:"body,omitempty"`
	SortKey     string   `json:"sort_key,omitempty"`
	Aliases     []string `json:"aliases,omitempty"`
}

type TextPut struct {
	ContentID string
	Language  string
	Text      *Text
}

type Total struct {
	Public    int64                    `json:"public"`
	Tiers     map[string]int64         `json:"tiers"`
	Languages map[string]LanguageTotal `json:"languages"`
}

type Totals struct {
	Kinds map[string]Total `json:"kinds"`
}

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

type TotalsQuery struct {
	// Kinds are content kinds; empty means all of them.
	Kinds []string
	// Languages are the languages Total.Languages reports; empty means every
	// language with a counted item. Kind totals ignore it.
	Languages []string
	// Site is the site whose scope applies (its name); empty is the first
	// site. The HTTP route takes it from the request's host.
	Site string
}

type Update struct {
	ID string
	ContentPatch
}

type Version struct {
	ID        string   `json:"id"`
	Position  int      `json:"position"`
	Languages []string `json:"languages"`
	Traits    []string `json:"traits"`
	Label     string   `json:"label,omitempty"`
	// Title and Description are the override in the detail's language.
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
	// State is the editors' to see.
	State       string     `json:"state,omitempty"`
	PublishAt   *time.Time `json:"publish_at,omitempty"`
	PublishedAt *time.Time `json:"published_at,omitempty"`
	// Live: published, past PublishAt, its content live.
	Live bool `json:"live"`
	// Access is the version's own rule; nil inherits the content's.
	Access     *access.Rule   `json:"access,omitempty"`
	Attributes map[string]any `json:"attributes"`
	Pages      *int           `json:"pages,omitempty"`
	DurationMS *int64         `json:"duration_ms,omitempty"`
	Width      *int           `json:"width,omitempty"`
	Height     *int           `json:"height,omitempty"`
	HasAudio   bool           `json:"has_audio"`
	Ordinal    *int           `json:"ordinal,omitempty"`
	Segments   []Segment      `json:"segments"`
	Decision   Decision       `json:"decision"`
	// Text is every language's override, for editors.
	Text map[string]VersionText `json:"text,omitempty"`
	// Offer is the version's current offer, for its offer editors.
	Offer *offers.Offer `json:"offer,omitempty"`
	// Viewer is the signed-in reader's standing with the version.
	Viewer *ViewerState `json:"viewer,omitempty"`
}

type VersionFork struct {
	From     string `json:"from"`
	Playback bool   `json:"playback,omitempty"`
	Segments bool   `json:"segments,omitempty"`
}

type VersionInput struct {
	Languages []string  `json:"languages,omitempty"`
	Traits    *[]string `json:"traits,omitempty"`
	Label     *string   `json:"label,omitempty"`
	// State is draft or published (the default for a new version): a
	// published version is live once its content is and PublishAt passed.
	State     string     `json:"state,omitempty"`
	PublishAt *time.Time `json:"publish_at,omitempty"`
	// Access overrides the content's rule; ClearAccess inherits it again.
	Access      *access.Rule           `json:"access,omitempty"`
	ClearAccess bool                   `json:"clear_access,omitempty"`
	Attributes  map[string]any         `json:"attributes,omitempty"` // replaces all
	Text        map[string]VersionText `json:"text,omitempty"`       // replaces all
	Segments    *[]Segment             `json:"segments,omitempty"`   // replaces all
	Ordinal     *int                   `json:"ordinal,omitempty"`
	// Fork fills a new version's media from a sibling (creation only).
	Fork *VersionFork `json:"fork,omitempty"`
}

type VersionKey struct{ ContentID, VersionID string }

type VersionMedia interface {
	// ExposeTx follows a visibility change.
	ExposeTx(ctx context.Context, tx pgx.Tx, targets []versions.Target) error
	// RepublishTx follows a change of a version's effective rule or segments.
	RepublishTx(ctx context.Context, tx pgx.Tx, versions []versions.Target) error
	// DeleteTx deletes media before the rows go.
	DeleteTx(ctx context.Context, tx pgx.Tx, targets []versions.Target) error
	// ForkTx fills new versions' media from siblings.
	ForkTx(ctx context.Context, tx pgx.Tx, forks []versions.Fork) error
}

type VersionPut struct {
	ContentID string
	VersionID string
	VersionInput
}

type VersionText struct {
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
}

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

type ViewerOptions struct {
	Actor access.Actor
	// Host is the request's host; it picks the site (kinds.Config.SiteFor).
	Host string
	// Language, when set, lists only content with a live version serving it.
	Language string
	// Mode defaults to access.Lock.
	Mode access.Mode
	// EditorGroups are owner groups (channels) whose editors see their whole
	// content in lists; the viewer's editorship of each is checked.
	EditorGroups []string
}

type ViewerState struct {
	Favorited bool `json:"favorited"`
	// Seen, Completed, Progress, ProgressMax and Resume (the client's own
	// pointer, such as a page) come from the signal plane.
	Seen        bool       `json:"seen"`
	Completed   bool       `json:"completed"`
	Progress    uint32     `json:"progress"`
	ProgressMax uint32     `json:"progress_max"`
	Resume      string     `json:"resume,omitempty"`
	LastViewAt  *time.Time `json:"last_view_at,omitempty"`
}