kinds

type AccessScope string

type Attribute struct {
	// Type is string, int, bool, enum or time.
	Type       string   `json:"type" yaml:"type"`
	Values     []string `json:"values,omitempty" yaml:"values"`
	Filterable bool     `json:"filterable,omitempty" yaml:"filterable"`
	Sortable   bool     `json:"sortable,omitempty" yaml:"sortable"`
	// Required fields must be present on completed content metadata. Empty
	// drafts may omit them while media uploads; versions inherit the parent.
	Required bool `json:"required,omitempty" yaml:"required"`
}

type Config struct {
	Languages      []string             `json:"languages" yaml:"languages"`
	Tiers          []string             `json:"tiers,omitempty" yaml:"tiers"`
	TokenClaims    []string             `json:"token_claims,omitempty" yaml:"token_claims"`
	Restrictions   []string             `json:"restrictions,omitempty" yaml:"restrictions"`
	ContentFilters ContentFilters       `json:"content_filters,omitempty" yaml:"content_filters"`
	Kinds          map[string]Kind      `json:"kinds" yaml:"kinds"`
	GroupKinds     map[string]GroupKind `json:"entity_kinds,omitempty" yaml:"group_kinds"`
}

type ContentFilter struct {
	Group      GroupRef `json:"-" yaml:",inline"`
	Visible    bool     `json:"visible" yaml:"visible"`
	UserToggle *bool    `json:"user_toggle,omitempty" yaml:"user_toggle,omitempty"`
}

type ContentFilters struct {
	AppliesTo []string `json:"applies_to" yaml:"applies_to"`
	Domains   []Domain `json:"domains" yaml:"domains"`
}

type Domain struct {
	Name            string                `json:"name" yaml:"name"`
	Hosts           []string              `json:"hosts,omitempty" yaml:"hosts,omitempty"`
	RequireEntities map[string][]GroupRef `json:"require_entities,omitempty" yaml:"require_entities,omitempty"`
	Filters         []ContentFilter       `json:"filters,omitempty" yaml:"filters,omitempty"`
}

type Download struct {
	// Off: the kind's versions have no download.
	Off bool `json:"off,omitempty" yaml:"off"`
	// Serve is DownloadPages, DownloadOriginal or a private MP4 preset of the
	// kind's media ("mp4-1080"); empty is the presentation's default.
	Serve string `json:"serve,omitempty" yaml:"serve"`
}

type GroupKind struct {
	Route string `json:"route,omitempty" yaml:"route"`
	// Ordered members carry positions (series, playlists, rails).
	Ordered bool `json:"ordered,omitempty" yaml:"ordered"`
	// Parent is the group kind a group may sit under (series under series).
	Parent string `json:"parent,omitempty" yaml:"parent"`
	// ScopedBy makes slugs unique within a group of that kind (character
	// within series).
	ScopedBy string `json:"scoped_by,omitempty" yaml:"scoped_by"`
	// Owner is "site" (staff-managed) or "user" (channels, playlists): a
	// signed-in person creates a user-owned group and owns it.
	Owner string `json:"owner,omitempty" yaml:"owner"`
	// MaxPerOwner caps the active groups of the kind one person owns; 0 is
	// no cap. Staff are not capped.
	MaxPerOwner int `json:"max_per_owner,omitempty" yaml:"max_per_owner"`
	// Avatar gives site-owned entities a square avatar beside their cover;
	// user-owned kinds always have one.
	Avatar bool `json:"avatar,omitempty" yaml:"avatar"`
	// Uploads limit what editors other than staff upload to a user-owned
	// group's media.
	Uploads UploadLimits `json:"uploads,omitzero" yaml:"uploads"`
	// Sellable groups carry offers; their key unlocks every member.
	Sellable bool `json:"sellable,omitempty" yaml:"sellable"`
	// AuthScope groups name an AuthKit group whose permissions govern their
	// content (OnlyDemo channels).
	AuthScope bool `json:"auth_scope,omitempty" yaml:"auth_scope"`
	// Windows lets memberships carry active_from/active_until (rails).
	Windows bool `json:"windows,omitempty" yaml:"windows"`
	// MembershipScopes declares where this entity kind can be attached.
	// Omitted keeps the legacy default: content, or version with VersionLevel.
	MembershipScopes []MembershipScope `json:"membership_scopes,omitempty" yaml:"membership_scopes"`
	// VersionLevel is the legacy version-only editor setting. Prefer
	// MembershipScopes; it cannot be combined with that explicit setting.
	VersionLevel bool `json:"version_level,omitempty" yaml:"version_level"`
	// Creatable lets a content edit create an entity of the kind from a name no
	// entity carries yet; never user-owned or authorization kinds.
	Creatable bool `json:"creatable,omitempty" yaml:"creatable"`
	// Roles are membership roles (publisher on an artist group).
	Roles      []string             `json:"roles,omitempty" yaml:"roles"`
	Attributes map[string]Attribute `json:"attributes,omitempty" yaml:"attributes"`
}

type GroupRef struct {
	Kind string `json:"kind" yaml:"kind"`
	Slug string `json:"slug" yaml:"slug"`
}

type Kind struct {
	// TitlePolicy defaults to localized text. OriginalAndVersion uses the
	// selected edition title, then the shared original title, then legacy text.
	TitlePolicy TitlePolicy `json:"title_policy,omitempty" yaml:"title_policy"`

	// AccessLevels limits content and version rules. Empty permits every level.
	// Omitting ppv and group_ppv also disables individual sales for this kind.
	AccessLevels []string `json:"access_levels,omitempty" yaml:"access_levels"`
	// AccessScope defaults to content; version presents a direct edition rule.
	AccessScope AccessScope `json:"access_scope,omitempty" yaml:"access_scope"`
	// CommentModes limits per-item comment settings. Empty permits every mode.
	CommentModes []string `json:"comment_modes,omitempty" yaml:"comment_modes"`
	// Route is the URL segment: /{lang}/{route}/{CODE}/{slug}.
	Route string `json:"route" yaml:"route"`
	// PathEntity names one of Groups whose slug prefixes the title in the
	// decorative path, /{lang}/{route}/{CODE}/{entity}/{title}, for SEO.
	PathEntity string `json:"path_entity,omitempty" yaml:"path_entity"`
	// Presentation tells contentkit-ui how to show it: reader, player or post.
	Presentation string       `json:"presentation" yaml:"presentation"`
	Versions     VersionRules `json:"versions" yaml:"versions"`
	// Segments enables ordered, individually released ranges (chapters).
	Segments bool `json:"segments,omitempty" yaml:"segments"`
	// Groups are the group kinds content of this kind may join.
	Groups     []string             `json:"entities,omitempty" yaml:"groups"`
	Attributes map[string]Attribute `json:"attributes,omitempty" yaml:"attributes"`
	// Sort is the default list order.
	Sort string `json:"sort,omitempty" yaml:"sort"`
	// Locked is what a viewer who does not open its content sees of it;
	// nil is DefaultLocked.
	Locked *Locked `json:"locked,omitempty" yaml:"locked"`
	// DraftTTL expires drafts that never went live this long after their
	// creation: they are deleted, media included. Zero keeps them.
	DraftTTL time.Duration `json:"draft_ttl,omitempty" yaml:"draft_ttl"`
	// Download is what a version's download serves; nil serves its
	// presentation's default (Download.Serves).
	Download *Download `json:"download,omitempty" yaml:"download"`
}

type Locked struct {
	Show []string `json:"show" yaml:"show"`
	// Preview is the free part when its access rule names none; nil is none.
	Preview *Preview `json:"preview,omitempty" yaml:"preview"`
}

type MembershipScope string

type Preview struct {
	Pages    int `json:"pages,omitempty" yaml:"pages"`
	Segments int `json:"segments,omitempty" yaml:"segments"`
}

type TitlePolicy string

type UploadLimits struct {
	// FilesPerHour and BytesPerDay limit each uploader.
	FilesPerHour int   `json:"files_per_hour,omitempty" yaml:"files_per_hour"`
	BytesPerDay  int64 `json:"bytes_per_day,omitempty" yaml:"bytes_per_day"`
	// QuotaBytes caps the group's stored originals.
	QuotaBytes int64 `json:"quota_bytes,omitempty" yaml:"quota_bytes"`
}

type VersionRules struct {
	// Languages is "one" (a version serves one language) or "many".
	Languages string `json:"languages" yaml:"languages"`
	// Traits are the declared version traits (colored, uncensored, ...).
	Traits []string `json:"traits,omitempty" yaml:"traits"`
	// Hidden kinds have exactly one version that clients never see.
	Hidden bool `json:"hidden,omitempty" yaml:"hidden"`
}