// Provide a way to acess grist for iframe, web worker (which runs the main safeBrowser script) and // unsafeNode. WebView should work the same way as iframe, grist is exposed just the same way and // necessary api is exposed using preload script. Here we bootstrap from channel capabilities to key // parts of the grist API. // For iframe (and webview): // user will add '' and get a window.grist // For web worker: // use will add `self.importScripts('/grist-api.js');` // For node, user will do something like: // const {grist} = require('grist-api'); // grist.registerFunction(); // In TypeScript: // import {grist} from 'grist-api'; // grist.registerFunction(); // tslint:disable:no-console import { ColumnsToMap, CustomSectionAPI, InteractionOptions, InteractionOptionsRequest, WidgetColumnMap } from './CustomSectionAPI'; import { GristAPI, GristDocAPI, GristView, RPC_GRISTAPI_INTERFACE } from './GristAPI'; import { RowRecord } from './GristData'; import { ImportSource, ImportSourceAPI, InternalImportSourceAPI } from './InternalImportSourceAPI'; import { decodeObject, mapValues } from './objtypes'; import { RenderOptions, RenderTarget } from './RenderOptions'; import { checkers } from './TypeCheckers'; import { WidgetAPI } from './WidgetAPI'; export * from './TypeCheckers'; export * from './FileParserAPI'; export * from './GristAPI'; export * from './GristTable'; export * from './ImportSourceAPI'; export * from './StorageAPI'; export * from './RenderOptions'; export * from './WidgetAPI'; export * from './CustomSectionAPI'; import {IRpcLogger, Rpc} from 'grain-rpc'; export const rpc: Rpc = new Rpc({logger: createRpcLogger()}); export const api = rpc.getStub(RPC_GRISTAPI_INTERFACE, checkers.GristAPI); export const coreDocApi = rpc.getStub('GristDocAPI@grist', checkers.GristDocAPI); export const viewApi = rpc.getStub('GristView', checkers.GristView); export const widgetApi = rpc.getStub('WidgetAPI', checkers.WidgetAPI); export const sectionApi = rpc.getStub('CustomSectionAPI', checkers.CustomSectionAPI); export const allowSelectBy = viewApi.allowSelectBy; export const setSelectedRows = viewApi.setSelectedRows; export const docApi: GristDocAPI & GristView = { ...coreDocApi, ...viewApi, // Change fetchSelectedTable() to decode data by default, replacing e.g. ['D', timestamp] with // a moment date. New option `keepEncoded` skips the decoding step. async fetchSelectedTable(options: {keepEncoded?: boolean} = {}) { const table = await viewApi.fetchSelectedTable(); return options.keepEncoded ? table : mapValues(table, (col) => col.map(decodeObject)); }, // Change fetchSelectedRecord() to decode data by default, replacing e.g. ['D', timestamp] with // a moment date. New option `keepEncoded` skips the decoding step. async fetchSelectedRecord(rowId: number, options: {keepEncoded?: boolean} = {}) { const rec = await viewApi.fetchSelectedRecord(rowId); return options.keepEncoded ? rec : mapValues(rec, decodeObject); } }; export const on = rpc.on.bind(rpc); // For custom widgets that support custom columns mappings store current configuration // in a memory. // Actual cached value. Undefined means that widget hasn't asked for configuration yet. // Here we are storing serialized configuration instead of actual one, since widget can // mutate returned value. let _mappingsCache: WidgetColumnMap|null|undefined; // Since widget needs to ask for mappings during onRecord and onRecords event, we will reuse // current request if available; let _activeRefreshReq: Promise|null = null; // Remember columns requested during ready call. let _columnsToMap: ColumnsToMap|undefined; async function getMappingsIfChanged(data: any): Promise { const uninitialized = _mappingsCache === undefined; if (data.mappingsChange || uninitialized) { // If no active request. if (!_activeRefreshReq) { // Request for new mappings. _activeRefreshReq = sectionApi .mappings() // Store it in global variable. .then(mappings => void (_mappingsCache = mappings)) // Clear current request variable. .finally(() => _activeRefreshReq = null); } await _activeRefreshReq; } return _mappingsCache ? JSON.parse(JSON.stringify(_mappingsCache)) : null; } /** * Renames columns in the result using columns mapping configuration passed in ready method. * Returns null if not all required columns were mapped or not widget doesn't support * custom column mapping. */ export function mapColumnNames(data: any, options = { columns: _columnsToMap, mappings: _mappingsCache }) { // If not column configuration was requested or // table has no rows, return original data. if (!options.columns) { return data; } // If we haven't received columns configuration return null. if (!options.mappings) { return null; } // If we are renaming names for whole table, but it is empty, don't do anything. if (Array.isArray(data) && data.length === 0) { return data; } // Prepare convert function - a function that will take record returned from Grist // and convert it to a new record with mapped field names; // Convert function will consists of several transformations: const transformations: ((from: any, to: any) => void)[] = []; // First transformation is for copying id field: transformations.push((from, to) => to.id = from.id); // Helper function to test if a column was configured as optional. 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) ); } // For each widget column in mapping. for(const widgetCol in options.mappings) { // Get column from Grist. const gristCol = options.mappings[widgetCol]; // Copy column as series (multiple values) if (Array.isArray(gristCol) && gristCol.length) { transformations.push((from, to) => { to[widgetCol] = gristCol.map(col => from[col]); }); // Copy column directly under widget column name. } else if (!Array.isArray(gristCol) && gristCol) { transformations.push((from, to) => to[widgetCol] = from[gristCol]); } else if (!isOptional(widgetCol)) { // Column was not configured but was required. return null; } } // Finally assemble function to convert a single record. const convert = (rec: any) => transformations.reduce((obj, tran) => { tran(rec, obj); return obj; }, {} as any); // Transform all records (or a single one depending on the arguments). return Array.isArray(data) ? data.map(convert) : convert(data); } // For custom widgets, add a handler that will be called whenever the // row with the cursor changes - either by switching to a different row, or // by some value within the row potentially changing. Handler may // in the future be called with null if the cursor moves away from // any row. // TODO: currently this will be called even if the content of a different row // changes. export function onRecord(callback: (data: RowRecord | null, mappings: WidgetColumnMap | null) => unknown) { on('message', async function(msg) { if (!msg.tableId || !msg.rowId) { return; } const rec = await docApi.fetchSelectedRecord(msg.rowId); callback(rec, await getMappingsIfChanged(msg)); }); } // For custom widgets, add a handler that will be called whenever the // selected records change. Handler will be called with a list of records. export function onRecords(callback: (data: RowRecord[], mappings: WidgetColumnMap | null) => unknown) { on('message', async function(msg) { if (!msg.tableId || !msg.dataChange) { return; } const data = await docApi.fetchSelectedTable(); if (!data.id) { return; } const rows: RowRecord[] = []; for (let i = 0; i < data.id.length; i++) { const row: RowRecord = {id: data.id[i]}; for (const key of Object.keys(data)) { row[key] = data[key][i]; } rows.push(row); } callback(rows, await getMappingsIfChanged(msg)); }); } // For custom widgets, add a handler that will be called whenever the // widget options change (and on initial ready message). Handler will be // called with an object containing save json options, or null if no options were saved. // Second parameter export function onOptions(callback: (options: any, settings: InteractionOptions) => unknown) { on('message', async function(msg) { if (msg.settings) { callback(msg.options || null, msg.settings); } }); } /** * Calling `addImporter(...)` adds a safeBrowser importer. It is a short-hand for forwarding calls * to an `ImportSourceAPI` implementation registered in the file at `path`. It takes care of * creating the stub, registering an implementation that renders the file, forward the call and * dispose the view properly. If `mode` is `'inline'` embeds the view in the import modal, otherwise * renders fullscreen. * * Notes: it assumes that file at `path` registers an `ImportSourceAPI` implementation under * `name`. Calling `addImporter(...)` from another component than a `safeBrowser` component is not * currently supported. * */ export async function addImporter(name: string, path: string, mode: 'fullscreen' | 'inline', options?: RenderOptions) { // checker is omitted for implementation because call was alredy checked by grist. rpc.registerImpl(name, { async getImportSource(target: RenderTarget): Promise { const procId = await api.render(path, mode === 'inline' ? target : 'fullscreen', options); try { // stubName for the interface `name` at forward destination `path` const stubName = `${name}@${path}`; // checker is omitted in stub because call will be checked just after in grist. return await rpc.getStub(stubName).getImportSource(); } finally { await api.dispose(procId); } } }); } interface ReadyPayload extends Omit { /** * Handler that will be called by Grist to open additional configuration panel inside the Custom Widget. */ onEditOptions: () => unknown; } /** * Declare that a component is prepared to receive messages from the outside world. * Grist will not attempt to communicate with it until this method is called. */ export function ready(settings?: ReadyPayload): void { if (settings && settings.onEditOptions) { rpc.registerFunc('editOptions', settings.onEditOptions); } rpc.processIncoming(); void (async function() { await rpc.sendReadyMessage(); if (settings) { const options = { ...(settings), hasCustomOptions: Boolean(settings.onEditOptions), }; delete options.onEditOptions; _columnsToMap = options.columns; await sectionApi.configure(options).catch((err: unknown) => console.error(err)); } })(); } function getPluginPath(location: Location) { return location.pathname.replace(/^\/plugins\//, ''); } if (typeof window !== 'undefined') { // Window or iframe. const preloadWindow: any = window; if (preloadWindow.isRunningUnderElectron) { rpc.setSendMessage(msg => preloadWindow.sendToHost(msg)); preloadWindow.onGristMessage((data: any) => rpc.receiveMessage(data)); } else { rpc.setSendMessage(msg => window.parent.postMessage(msg, "*")); window.onmessage = (e: MessageEvent) => rpc.receiveMessage(e.data); } // Allow outer Grist application to trigger printing. This is similar to using // iframe.contentWindow.print(), but that call does not work cross-domain. rpc.registerFunc("print", () => window.print()); } else if (typeof process === 'undefined') { // Web worker. We can't really bring in the types for WebWorker (available with --lib flag) // without conflicting with a regular window, so use just use `self as any` here. self.onmessage = (e: MessageEvent) => rpc.receiveMessage(e.data); rpc.setSendMessage((mssg: any) => (self as any).postMessage(mssg)); } else if (typeof process.send !== 'undefined') { // Forked ChildProcess of node or electron. // sendMessage callback returns void 0 because rpc process.send returns a boolean and rpc // expecting void|Promise interprets truthy values as Promise which cause failure. rpc.setSendMessage((data) => { process.send!(data); }); process.on('message', (data: any) => rpc.receiveMessage(data)); process.on('disconnect', () => { process.exit(0); }); } else { // Not a recognized environment, perhaps plain nodejs run independently of Grist, or tests // running under mocha. For now, we only provide a disfunctional implementation. It allows // plugins to call methods like registerFunction() without failing, so that plugin code may be // imported, but the methods don't do anything useful. rpc.setSendMessage((data) => { return; }); } function createRpcLogger(): IRpcLogger { let prefix: string; if (typeof window !== 'undefined') { prefix = `PLUGIN VIEW ${getPluginPath(window.location)}:`; } else if (typeof process === 'undefined') { prefix = `PLUGIN VIEW ${getPluginPath(self.location)}:`; } else if (typeof process.send !== 'undefined') { prefix = `PLUGIN NODE ${process.env.GRIST_PLUGIN_PATH || ""}:`; } else { return {}; } return { info(msg: string) { console.log("%s %s", prefix, msg); }, warn(msg: string) { console.warn("%s %s", prefix, msg); }, }; }