mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-10-27 20:44:07 +00:00
b80e56a4e1
Summary: Exposing new API in CustomSectionAPI for column mapping. The custom widget can call configure method (or use a ready method) with additional parameter "columns". This parameter is a list of column names that should be mapped by the user. Mapping configuration is exposed through an additional method in the CustomSectionAPI "mappings". It is also available through the onRecord(s) event. This DIFF is connected with PR for grist-widgets repository https://github.com/gristlabs/grist-widget/pull/15 Design document and discussion: https://grist.quip.com/Y2waA8h8Zuzu/Custom-Widget-field-mapping Test Plan: browser tests Reviewers: paulfitz Reviewed By: paulfitz Differential Revision: https://phab.getgrist.com/D3241
78 lines
2.0 KiB
TypeScript
78 lines
2.0 KiB
TypeScript
/**
|
|
* API definitions for CustomSection plugins.
|
|
*/
|
|
|
|
export interface ColumnToMap {
|
|
/**
|
|
* Column name that Widget expects. Must be a valid JSON property name.
|
|
*/
|
|
name: string;
|
|
/**
|
|
* Title or short description of a column (used as a label in section mapping).
|
|
*/
|
|
title?: string|null,
|
|
/**
|
|
* Column type, by default ANY.
|
|
*/
|
|
type?: string, // GristType, TODO: ts-interface-checker doesn't know how to parse this
|
|
/**
|
|
* Mark column as optional all columns are required by default.
|
|
*/
|
|
optional?: boolean
|
|
/**
|
|
* Allow multiple column assignment, the result will be list of mapped table column names.
|
|
*/
|
|
allowMultiple?: boolean,
|
|
}
|
|
|
|
export type ColumnsToMap = (string|ColumnToMap)[];
|
|
|
|
/**
|
|
* Initial message sent by the CustomWidget with initial requirements.
|
|
*/
|
|
export interface InteractionOptionsRequest {
|
|
/**
|
|
* Required access level. If it wasn't granted already, Grist will prompt user to change the current access
|
|
* level.
|
|
*/
|
|
requiredAccess?: string,
|
|
/**
|
|
* Instructs Grist to show additional menu options that will trigger onEditOptions callback, that Widget
|
|
* can use to show custom options screen.
|
|
*/
|
|
hasCustomOptions?: boolean,
|
|
/**
|
|
* Tells Grist what columns Custom Widget expects and allows user to map between existing column names
|
|
* and those requested by Custom Widget.
|
|
*/
|
|
columns?: ColumnsToMap,
|
|
}
|
|
|
|
/**
|
|
* Widget configuration set and approved by Grist, sent as part of ready message.
|
|
*/
|
|
export interface InteractionOptions{
|
|
/**
|
|
* Granted access level.
|
|
*/
|
|
accessLevel: string,
|
|
}
|
|
|
|
/**
|
|
* Current columns mapping between viewFields in section and Custom widget.
|
|
*/
|
|
export interface WidgetColumnMap {
|
|
[key: string]: string|string[]|null
|
|
}
|
|
|
|
export interface CustomSectionAPI {
|
|
/**
|
|
* Initial request from a Custom Widget that wants to declare its requirements.
|
|
*/
|
|
configure(customOptions: InteractionOptionsRequest): Promise<void>;
|
|
/**
|
|
* Returns current widget configuration (if requested through configuration method).
|
|
*/
|
|
mappings(): Promise<WidgetColumnMap|null>;
|
|
}
|