gristlabs_grist-core

Commit Graph

Author	SHA1	Message	Date
Dmitry S	8ddcff4310	(core) Update app/plugin/ documentation comments to improve generated docs Summary: - Move CellValue documentation to CellValue and add an example for each type. - Link to CellValue from places that mention it. - Update deprecated [[LINK]] syntax to a supported {@link} one, in a way that does not change generated documentation. - Also fix auto-pick-ports script used in tests (which had a bug causing occasional test failures), and add a test for it. Test Plan: No code changes for documentation changes. New test for auto-pick-ports. Reviewers: georgegevoian Reviewed By: georgegevoian Differential Revision: https://phab.getgrist.com/D4162	8 months ago
Dmitry S	527e9670ef	(core) Include linking rowIds into remembered cursor position and anchor links. Summary: When linking using a Reference List column, there may be multiple source records that show the same target record. With this change, we remember those (rather than just pick one that shows the target record). Test Plan: Added a browser test. Reviewers: jarek Reviewed By: jarek Differential Revision: https://phab.getgrist.com/D4140	8 months ago
Alex Hall	eea9f47e50	(core) Small fixes in plugin API docs Summary: While adding `FetchSelectedOptions` in `4e67c679b2`, I accidentally made `viewApi` become an undocumented variable, which is fixed here. While I was at it, I also fixed other errors emitted by `./build-plugin-api.sh`. Test Plan: Built changes in https://github.com/gristlabs/grist-help/pull/297 Reviewers: paulfitz Reviewed By: paulfitz Differential Revision: https://phab.getgrist.com/D4155	9 months ago
Alex Hall	4e67c679b2	(core) Options for plugin API functions which fetch data from the selected table or record Summary: Adds a new interface `FetchSelectedOptions` with three keys (including the preexisting `keepEncoded`) and adds/updates an optional `options: FetchSelectedOptions` to six related functions which fetch data from the selected table or record. The `keepEncoded` and `format` options have different default values for different methods for backwards compatibility, but otherwise the different methods now have much more similar behaviour. The new `includeColumns` option allows fetching all columns which was previously only possible using `docApi.fetchTable` (which wasn't always a great alternative) but this requires full access to avoid exposing more data than before and violating user expectations. Eventually, similar options should be added to `docApi.fetchTable` to make the API even more consistent. Discussion: https://grist.slack.com/archives/C0234CPPXPA/p1696510548994899 Test Plan: Added a new nbrowser test with a corresponding fixture site and document, showing how the functions have different default option values but are all configurable now. Reviewers: georgegevoian Reviewed By: georgegevoian Differential Revision: https://phab.getgrist.com/D4077	11 months ago
Jarosław Sadziński	b6a431dd58	(core) Cursor in custom widgets Summary: Adding a new method `setCursorPos` in the widget API, and a new configuration option for the ready message `allowSelectBy` that exposes custom widgets in the `Select by` dropdown. With this, a custom widget can control the position of the linked widgets and is able to change the column in the creator panel. Test Plan: Added new test. Existing tests should pass. Reviewers: JakubSerafin Reviewed By: JakubSerafin Subscribers: JakubSerafin Differential Revision: https://phab.getgrist.com/D3993	1 year ago
Paul Fitzpatrick	aeb7a4b849	(core) flesh out getAccessToken API documentation Summary: This extends the getAccessToken documentation so it can be picked up by typedoc and published, and makes a few other tweaks along the way prompted by a typescript/typedoc version change. Test Plan: made in concert with a grist-help update Reviewers: jarek Reviewed By: jarek Subscribers: jarek Differential Revision: https://phab.getgrist.com/D3548	2 years ago
Paul Fitzpatrick	dd8d2e18f5	(core) add an access token mechanism to help with attachments in custom widgets Summary: With this, a custom widget can render an attachment by doing: ``` const tokenInfo = await grist.docApi.getAccessToken({readOnly: true}); const img = document.getElementById('the_image'); const id = record.C[0]; // get an id of an attachment const src = `${tokenInfo.baseUrl}/attachments/${id}/download?auth=${tokenInfo.token}`; img.setAttribute('src', src) ``` The access token expires after a few mins, so if a user right-clicks on an image to save it, they may get access denied unless they refresh the page. A little awkward, but s3 pre-authorized links behave similarly and it generally isn't a deal-breaker. Test Plan: added tests Reviewers: dsagal Reviewed By: dsagal Subscribers: dsagal Differential Revision: https://phab.getgrist.com/D3488	2 years ago
George Gevoian	3d3a5e334a	(core) Update Plugin API documentation Summary: Updates to Plugin API documentation. Test Plan: Tested manually in grist-help. Reviewers: jarek Reviewed By: jarek Subscribers: jarek Differential Revision: https://phab.getgrist.com/D3447	2 years ago
Paul Fitzpatrick	c6d66e15bf	(core) configure typedoc for generating plugin api documentation Summary: This annotates the plugin api sufficiently to generate some documentation for it. See https://github.com/gristlabs/grist-help/pull/139 Contains some small code tweaks for things that caused typedoc some trouble. Test Plan: manual inspection of output Reviewers: jarek Reviewed By: jarek Differential Revision: https://phab.getgrist.com/D3342	2 years ago
Paul Fitzpatrick	98f64a8461	(core) add grist.selectedTable.create/update/destroy/upsert to custom widget api Summary: This makes an equivalent of the /records REST endpoint available within custom widgets. For simple operations, it is compatible with https://github.com/airtable/airtable.js/. About half of the diff is refactoring code from DocApi that implements /records using applyUserActions, to make that code available in the plugin api. Test Plan: added tests Reviewers: alexmojaki Reviewed By: alexmojaki Differential Revision: https://phab.getgrist.com/D3320	3 years ago
Edward Betts	d6e0e1fee3	Correct spelling mistakes	3 years ago
Cyprien P	2f6eafff35	(core) Adds setSelectedRows to the grist api for custom view Summary: This is needed to let custom widget driver filtering of other widget in the same page. Descripion here: - https://grist.quip.com/ctytAQJoFMsM/Hopefully-Small-Projects#temp:C:NNCfe2030b27647439886ca83595 Test Plan: New api tested in a new nbrowser test Reviewers: paulfitz Reviewed By: paulfitz Differential Revision: https://phab.getgrist.com/D3253	3 years ago
Paul Fitzpatrick	ac5452c89f	(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	4 years ago
Paul Fitzpatrick	5ef889addd	(core) move home server into core Summary: This moves enough server material into core to run a home server. The data engine is not yet incorporated (though in manual testing it works when ported). Test Plan: existing tests pass Reviewers: dsagal Reviewed By: dsagal Differential Revision: https://phab.getgrist.com/D2552	4 years ago

14 Commits (9509b2edcb2f2ca54130bdc5edd7c73b13f84397)