gristlabs_grist-core/app/plugin/GristAPI.ts

127 lines
4.4 KiB
TypeScript
Raw Normal View History

/**
* This file defines the interface for the grist api exposed to SafeBrowser plugins. Grist supports
* various ways to require it to cover various scenarios. If writing the main safeBrowser module
* (the one referenced by the components.safeBrowser key of the manifest) use
* `self.importScript('grist');`, if writing a view include the script in the html `<script src="grist"></script>`
*
*
* Example usage (let's assume that Grist let's plugin contributes to a Foo API defined as follow ):
*
* interface Foo {
* foo(name: string): Promise<string>;
* }
*
* > main.ts:
* class MyFoo {
* public foo(name: string): Promise<string> {
* return new Promise<string>( async resolve => {
* grist.rpc.onMessage( e => {
* resolve(e.data + name);
* });
* grist.ready();
* await grist.api.render('view1.html', 'fullscreen');
* });
* }
* }
* grist.rpc.registerImpl<Foo>('grist', new MyFoo()); // can add 3rd arg with type information
*
* > view1.html includes:
* grist.api.render('static/view2.html', 'fullscreen').then( view => {
* grist.rpc.onMessage(e => grist.rpc.postMessageForward("main.ts", e.data));
* });
*
* > view2.html includes:
* grist.rpc.postMessage('view1.html', 'foo ');
*
*/
import {RenderOptions, RenderTarget} from './RenderOptions';
export type ComponentKind = "safeBrowser" | "safePython" | "unsafeNode";
export const RPC_GRISTAPI_INTERFACE = '_grist_api';
export interface GristAPI {
/**
* Render the file at `path` into the `target` location in Grist. `path` must be relative to the
* root of the plugin's directory and point to an html that is contained within the plugin's
2022-02-19 09:46:49 +00:00
* directory. `target` is a predefined location of the Grist UI, it could be `fullscreen` or
* identifier for an inline target. Grist provides inline target identifiers in certain call
* plugins. E.g. ImportSourceAPI.getImportSource is given a target identifier to allow rende UI
* inline in the import dialog. Returns the procId which can be used to dispose the view.
*/
render(path: string, target: RenderTarget, options?: RenderOptions): Promise<number>;
/**
* Dispose the process with id procId. If the process was embedded into the UI, removes the
* corresponding element from the view.
*/
dispose(procId: number): Promise<void>;
// Subscribes to actions for `tableId`. Actions of all subscribed tables are send as rpc's
// message.
// TODO: document format of messages that can be listened on `rpc.onMessage(...);`
subscribe(tableId: string): Promise<void>;
// Unsubscribe from actions for `tableId`.
unsubscribe(tableId: string): Promise<void>;
}
/**
* Allows getting information from and nteracting with the Grist document to which a plugin or widget is attached.
*/
export interface GristDocAPI {
/**
* Returns an identifier for the document.
*/
getDocName(): Promise<string>;
/**
* Returns a sorted list of table IDs.
*/
listTables(): Promise<string[]>;
/**
* Returns a complete table of data in the format {colId: [values]}, including the 'id' column.
* Do not modify the returned arrays in-place, especially if used directly (not over RPC).
* TODO: return type is Promise{[colId: string]: CellValue[]}> but cannot be specified because
* ts-interface-builder does not properly support index-signature.
*/
fetchTable(tableId: string): Promise<any>;
/**
* Applies an array of user actions.
* TODO: return type should be Promise<ApplyUAResult>, but this requires importing modules from
* `app/common` which is not currently supported by the build.
*/
applyUserActions(actions: any[][], options?: any): Promise<any>;
}
/**
* Interface for the data backing a single widget.
*/
export interface GristView {
/**
* Like [[GristDocAPI.fetchTable]], but gets data for the custom section specifically, if there is any.
* TODO: return type is Promise{[colId: string]: CellValue[]}> but cannot be specified because
* ts-interface-builder does not properly support index-signature.
*/
fetchSelectedTable(): Promise<any>;
/**
* Similar TODO to `fetchSelectedTable()` for return type.
*/
fetchSelectedRecord(rowId: number): Promise<any>;
/**
* Allow custom widget to be listed as a possible source for linking with SELECT BY.
*/
allowSelectBy(): Promise<void>;
/**
* Set the list of selected rows to be used against any linked widget. Requires `allowSelectBy()`.
*/
setSelectedRows(rowIds: number[]): Promise<void>;
}