gristlabs_grist-core/app/plugin/GristData.ts

export type CellValue = number|string|boolean|null|[string, ...unknown[]];

export interface RowRecord {
  id: number;
  [colId: string]: CellValue;
}
(core) Improve object serialization, to help get RECORD data to Custom Widgets. Summary: - Change RECORD's dates_as_str default to False. - Reimplement objtype encode_object/decode_object with less machinery. - Implement encoding of dicts (with string keys). - Make lists and dicts encode values recursively. - Implement encoding/decoding in the client - Decode automatically in plugins' fetchSelectedTable/Record, with an option to skip. Test Plan: Tested manually, not sure what tests may be affected yet. Reviewers: paulfitz Reviewed By: paulfitz Differential Revision: https://phab.getgrist.com/D2593 2020-08-21 21:14:42 +00:00			`export type CellValue = number\|string\|boolean\|null\|[string, ...unknown[]];`
(core) add grist.onRecord and grist.onRecords event handlers Summary: This simplifies writing custom widgets that access selected data. To access the record at which the cursor is set, and get any future changes to it as the cursor moves or data changes, it suffices now to do: ``` grist.ready(); grist.onRecord(record => /* render /); ``` Similarly to access the set of selected records, and get any changes, it suffices now to do: ``` grist.ready(); grist.onRecords(records => / render */); ``` The `records` argument will be a list of objects, each of which is a single record. This is distinct from the column-based representation favored in Grist up ontil now. That remains how methods like `fetchTable` or `fetchSelectedTable` represent their results. In the future, methods named like `fetchRecords` or `fetchSelectedRecords` could be added that return lists. Test Plan: extended tests Reviewers: dsagal Reviewed By: dsagal Differential Revision: https://phab.getgrist.com/D2583 2020-08-13 18:13:16 +00:00
			`export interface RowRecord {`
			`id: number;`
			`[colId: string]: CellValue;`
			`}`