datagrid

type CellWriteRequest struct {
	DocID string
	RowID string
	Field string
	Value string
}

type Column struct {
	Field  string `json:"field"`
	Header string `json:"header"`
	// Width is the initial column width in px (0 = AG Grid default).
	Width int `json:"width,omitempty"`
	// Type is "text" (default) or "number". Numbers right-align in the
	// frame and sort numerically in the host's rows source.
	Type string `json:"type,omitempty"`
	// Sortable / Editable toggle the obvious frame affordances. Sortable
	// columns trigger server-side sorts; editable ones (only when data:write
	// is granted) open a cell editor whose result round-trips through
	// POST /cell.
	Sortable bool `json:"sortable,omitempty"`
	// Filterable is accepted for symmetry with the doc shape; the demo
	// filter box filters every column, so it is currently unused by the
	// frame.
	Filterable bool `json:"filterable,omitempty"`
	Editable   bool `json:"editable,omitempty"`
}

type Doc struct {
	SchemaVersion string      `json:"schemaVersion"`
	Columns       []Column    `json:"columns"`
	Sort          []SortModel `json:"sort,omitempty"`
	Filter        string      `json:"filter,omitempty"`
	PageSize      int         `json:"pageSize,omitempty"`
}

type ExportRequest struct {
	DocID  string
	Format string // always "csv" today
	// Columns the export covers, normalised by /export before the scan.
	Columns []Column
	Sort    []SortModel
	Filter  string
	// CSV streams the export body. The scan pages through the rows source
	// in 5,000-row chunks and spills to a temp file as it goes, so peak
	// memory stays at one chunk regardless of table size, and a mid-scan
	// source error aborts the whole export (an error response, never a
	// short file). The handler MUST fully consume CSV before returning —
	// the underlying temp file is removed once the handler returns.
	CSV io.Reader
	// RowCount is the number of data rows in CSV (the header is excluded).
	RowCount int
}

type MountConfig struct {
	// DocID is the persistence key for the view-state doc.
	DocID string
	// Doc is the initial view-state doc JSON server-rendered into the
	// marker (data-fui-plugin-doc) — the frame reads columns, sort, filter
	// and pageSize out of it on init.
	Doc string
	// Field is the hidden-input name the adapter mirrors the current
	// view-state doc into on docChanged, so a normal form POST round-trips
	// it. Defaults to "datagrid_doc". The name is published on the marker
	// as data-fui-plugin-field, which is how the adapter finds it — the
	// input itself is rendered after the marker, not inside it.
	Field string
	// MinHeight is the initial iframe height before the grid sizes itself.
	MinHeight string
	// Capabilities is an optional CSV grant override.
	Capabilities string
}

type Option func(*Plugin)

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

type Row struct {
	ID    string            `json:"id"`
	Cells map[string]string `json:"cells"`
}

type RowsPage struct {
	Rows    []Row `json:"rows"`
	LastRow int   `json:"lastRow"`
}

type RowsQuery struct {
	DocID    string
	StartRow int
	EndRow   int
	Sort     []SortModel
	Filter   string
	Columns  []Column
}

type SaveRequest struct {
	DocID string
	Doc   Doc
	// DocJSON is the canonical JSON of the VALIDATED, normalised doc — the
	// same shape /save hands the save handler. The raw request body's JSON
	// is never persisted: a doc that failed a bound (page size, sort keys,
	// filter length) cannot be saved verbatim and reloaded later.
	DocJSON       string
	SchemaVersion string
}

type SortModel struct {
	Field string `json:"field"`
	Dir   string `json:"dir"` // "asc" | "desc"
}