printable

type Axis struct {
	Name   string
	Values []string
}

type Bingo struct {
	Cards []BingoCard
	Calls []string // every item, for the caller's list
	// FirstWin is the median number of calls until the first card completes a
	// line when all cards play, from simulated games.
	FirstWin int
}

type BingoCard struct {
	N     int
	Cells [][]string
}

type Calendar struct {
	Start    time.Weekday // the first day of every week row
	Weekdays []Weekday    // the week's day names from Start
	Months   []Month
	Weeks    []Week // every week touching the range, in order
	Days     []Day  // every day of the range
}

type Config struct {
	Path     string
	Offer    string
	Language string
	Shop     string // the seller's name on the cover and in the licence
	Version  string // printed in the guide, e.g. 2027.1
	Sell     string // page (default), shops or bundle
}

type Day struct {
	ID      string // d2027-01-05
	Date    time.Time
	Day     int
	Month   int
	Year    int
	Weekday Weekday
	Week    string // the ID of its week
	InRange bool
}

type Edition struct {
	Key     string // a4-color-monday
	Label   string // A4 · color · monday
	Size    Size
	Options map[string]string // axis name, lowercased -> value
}

type Image = deliver.Image

type ImagePlan struct {
	Name string
	Doc  []byte
}

type Maze struct {
	Width, Height int
	Right, Bottom [][]bool
	Path          [][2]int // the solution from the top-left to the bottom-right cell
}

type Month struct {
	ID          string // m2027-01
	Year, Num   int
	Name, Short string
	Rows        []Week // the grid: weeks from the one holding the 1st to the one holding the last day
	Days        []Day
}

type Page struct {
	N        int
	Part     string
	Role     string
	IDs      []string
	Links    []string // internal targets, without "#"
	External []string
	Images   []string // as written in src
}

type Part struct {
	Name  string
	Pages int
	Job   string
	Line  int
}

type Placement struct {
	Word           string
	Row, Col       int
	DRow, DCol     int
	Cells          [][2]int
	ReadsBackwards bool
}

type Plan struct {
	Name     string
	Buyer    string
	Promise  string
	Parts    []Part
	Sizes    []string // paper size keys, in order
	Axes     []Axis   // variant axes beside the size, such as Ink: color, ink-saver
	Body     string   // font stacks and accent of the Look
	Headings string
	Accent   string
	Lines    map[string]int // section name -> line, for findings
}

type Printed struct {
	PDFs    map[string][]byte // edition key -> PDF
	Images  []Image
	Pending bool // some prints wait for the next release
}

type Rendered struct {
	Edition Edition
	Doc     []byte
	Pages   []Page
	Links   int // internal links, the hyperlink count buyers are told
	Stray   int // elements outside a page section
}

type Report struct {
	Config      Config
	Plan        Plan
	Summary     Summary
	Diagnostics []diagnostic.Diagnostic
	Editions    []Rendered
	Assets      map[string][]byte // flat name -> bytes, for printing
	Listing     deliver.ShopListing
	Buildable   bool // every edition rendered without errors
}

type Shot struct {
	Page int    // 1-based
	Name string // the asset name the image documents use, page-3.png
}

type Size struct {
	Key, Label    string
	Width, Height float64
	Digital       bool // for note apps on tablets and e-ink, not for paper
}

type Sudoku struct {
	Puzzle   [9][9]int // 0 for an empty cell
	Solution [9][9]int
	Clues    int
}

type Summary struct {
	Name     string   `json:"name,omitempty"`
	Concept  bool     `json:"concept"`
	Template bool     `json:"template"`
	Editions []string `json:"editions,omitempty"`
	Pages    int      `json:"pages"` // per edition, as the first one renders
	Links    int      `json:"links"`
	Cut      int      `json:"cut"` // pages to cut out (data-role="cut")
	URL      string   `json:"url,omitempty"`
	Files    []string `json:"files,omitempty"`
	Pending  bool     `json:"pending"` // the PDFs print with --release
	Listing  bool     `json:"listing"`
	Channels []string `json:"channels,omitempty"`
	Images   int      `json:"images"` // listing images rendered
	Layout   string   `json:"layout,omitempty"`
	Sell     string   `json:"sell"` // page, shops or bundle
}

type View struct {
	Edition  Edition
	Name     string
	Promise  string
	Parts    []Part
	Language string
	Shop     string
	Version  string
	Data     map[string]any // data/<name>.json as .Data.<name>
}

type Week struct {
	ID     string // w2027-05: ISO year and week of the week's Thursday
	Number int    // ISO week number (KW)
	Year   int    // ISO year
	Days   []Day
}

type Weekday struct{ Name, Short string }

type WordSearch struct {
	Grid  [][]string
	Words []string // as listed for the solver, in the order given
	Found []Placement
}