spreadsheet

type Built struct {
	Name    string
	Edition Edition
	Dataset string
	Data    []byte
}

type Cell struct {
	At        string      `json:"at"`   // report: A1 position; form cells stack from row 2
	Name      string      `json:"name"` // a name formulas use: [income]
	Label     Text        `json:"label"`
	Text      Text        `json:"text"`
	Value     any         `json:"value"` // an input's default
	Formula   string      `json:"formula"`
	Type      string      `json:"type"`  // text, number, money, percent, date, enum, check
	Style     string      `json:"style"` // title, heading, label, input, output, note, total
	Values    TextList    `json:"values"`
	From      string      `json:"from"`
	Highlight []Highlight `json:"highlight"`
	Note      Text        `json:"note"`
	Merge     int         `json:"merge"` // columns the cell spans to the right
}

type Chart struct {
	Type   string `json:"type"` // pie, doughnut, column, bar, line
	Title  Text   `json:"title"`
	Labels string `json:"labels"` // [sheet.column] or a range placeholder
	Values string `json:"values"`
	At     string `json:"at"`
	Width  int    `json:"width"` // pixels
	Height int    `json:"height"`
}

type Column struct {
	Key       string      `json:"key"`
	Title     Text        `json:"title"`
	Type      string      `json:"type"` // text, number, money, percent, date, enum, check
	Values    TextList    `json:"values"`
	From      string      `json:"from"`    // enum: the column its choices come from, as sheet.column
	Formula   string      `json:"formula"` // computed per row; [.other] is this row's cell of another column
	Width     float64     `json:"width"`
	Highlight []Highlight `json:"highlight"`
	Note      Text        `json:"note"` // shown as the header's comment
}

type Config struct {
	Path, Offer, Language, Sell, Version string
	Sheets                               map[string]string // edition key (or key-example) -> Google Sheets master
	Seller                               string
}

type Dataset struct {
	Tables map[string][]Row `json:"tables"`
	Cells  map[string]any   `json:"cells"`
}

type Edition struct {
	Key      string `json:"key"`      // e.g. en, de
	Language string `json:"language"` // the language its texts are picked in
	Currency string `json:"currency"` // ISO code: USD, EUR, GBP, CHF
}

type Highlight struct {
	If    string `json:"if"`
	Style string `json:"style"` // good, bad, warn, muted
}

type Image = deliver.Image

type ImagePlan struct {
	Name string
	Doc  []byte
}

type Palette struct {
	Accent, Ink, Input, Heading, HeadingInk, Muted, Line string
}

type Plan struct {
	Name, Buyer, Promise string
	Tabs                 []Tab
	Accent               string
	Lines                map[string]int
}

type Pos struct{ Col, Row int }

type Report struct {
	Config      Config
	Plan        Plan
	Workbook    Workbook
	Editions    []*edition
	Books       map[string]map[string]*book // edition key -> dataset -> computed book
	Summary     Summary
	Diagnostics []diagnostic.Diagnostic
	Listing     deliver.ShopListing
	Buildable   bool
}

type Row map[string]any

type Sheet struct {
	Key     string    `json:"key"` // stable name for placeholders: [log.amount]
	Name    Text      `json:"name"`
	Kind    string    `json:"kind"` // guide, form, table or report
	Hidden  bool      `json:"hidden"`
	Lines   []Text    `json:"lines"`   // guide: one per row; "# " starts a heading
	Cells   []Cell    `json:"cells"`   // form and report
	Columns []Column  `json:"columns"` // table
	Rows    int       `json:"rows"`    // table: how many data rows the template holds
	Seed    []Row     `json:"seed"`    // table: rows the blank template ships with, such as categories
	Charts  []Chart   `json:"charts"`  // report
	Widths  []float64 `json:"widths"`  // report: column widths in characters, from column A
}

type Summary struct {
	Name     string   `json:"name,omitempty"`
	Concept  bool     `json:"concept"`
	Workbook bool     `json:"workbook"`
	Editions []string `json:"editions,omitempty"`
	Sheets   int      `json:"sheets"`
	Formulas int      `json:"formulas"` // formula cells per edition
	Checked  []string `json:"checked,omitempty"`
	Sell     string   `json:"sell"`
	URL      string   `json:"url,omitempty"`
	Files    []string `json:"files,omitempty"`
	Listing  bool     `json:"listing"`
	Linked   int      `json:"linked"` // Google Sheets masters linked
	Channels []string `json:"channels,omitempty"`
	Images   int      `json:"images"`
	Pending  bool     `json:"pending"`
	Compat   string   `json:"compat,omitempty"`
}

type Tab struct {
	Key, Job string
	Line     int
}

type Text struct {
	One    string
	ByLang map[string]string
}

type TextList struct {
	One    []string
	ByLang map[string][]string
}

type Workbook struct {
	Editions []Edition                 `json:"editions"`
	Today    string                    `json:"today"` // the date TODAY() is evaluated at in checks and previews
	Words    map[string]Text           `json:"words"` // localized words formulas and choices use as [@key] and "@key"
	Sheets   []Sheet                   `json:"sheets"`
	Datasets map[string]Dataset        `json:"datasets"` // "example" fills the example file; "empty" is the blank template
	Expect   map[string]map[string]any `json:"expect"`   // dataset -> cell -> value
}