Archives/gristlabs_grist-core
1
0
Fork 0
mirror of https://github.com/gristlabs/grist-core.git synced 2026-03-02 04:09:24 +00:00
Code Issues Projects Releases Wiki Activity

(core) Improving custom widget API. Changing destroy function signature.

Browse Source 
Summary:
Destroy function in TableOperations was throwing error when invoked with a single
record id instead of an array. Now it returns a void type.

Also changing mapColumns function signature as it doesn't require options for a default
behavior.

Test Plan: Updated tests.

Reviewers: alexmojaki

Reviewed By: alexmojaki

Differential Revision: https://phab.getgrist.com/D3404
This commit is contained in:
Jarosław Sadziński
2022-05-05 13:42:50 +02:00
parent 1e42871cc9
commit db57815d2b
4 changed files with 14 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
app/plugin/grist-plugin-api.ts
View File

@@ -216,13 +216,13 @@ async function getMappingsIfChanged(data: any): Promise<WidgetColumnMap|null> {
* Returns null if not all required columns were mapped or not widget doesn't support
* custom column mapping.
*/
export function mapColumnNames(data: any, options: {
export function mapColumnNames(data: any, options?: {
columns?: ColumnsToMap
mappings?: WidgetColumnMap|null,
reverse?: boolean,
}) {
options = {columns: _columnsToMap, mappings: _mappingsCache, reverse: false, ...options};
// If not column configuration was requested or
// If no column configuration was requested or
// table has no rows, return original data.
if (!options.columns) {
return data;
@@ -246,8 +246,8 @@ export function mapColumnNames(data: any, options: {
function isOptional(col: string) {
return Boolean(
// Columns passed as strings are required.
!options.columns?.includes(col)
&& options.columns?.find(c => typeof c === 'object' && c?.name === col && c.optional)
!options!.columns?.includes(col)
&& options!.columns?.find(c => typeof c === 'object' && c?.name === col && c.optional)
);
}
// For each widget column in mapping.
@@ -292,7 +292,7 @@ export function mapColumnNames(data: any, options: {
* original table in a widget with column mappings. As for mapColumnNames(),
* we don't attempt to do these transformations automatically.
*/
export function mapColumnNamesBack(data: any, options: {
export function mapColumnNamesBack(data: any, options?: {
columns?: ColumnsToMap
mappings?: WidgetColumnMap|null,
}) {
@@ -320,10 +320,10 @@ export function onRecord(callback: (data: RowRecord | null, mappings: WidgetColu
* For custom widgets, add a handler that will be called whenever the
* new (blank) row is selected.
*/
export function onNewRecord(callback: () => unknown) {
export function onNewRecord(callback: (mappings: WidgetColumnMap | null) => unknown) {
on('message', async function(msg) {
if (msg.tableId && msg.rowId === 'new') {
callback();
callback(await getMappingsIfChanged(msg));
}
});
}