mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-10-27 20:44:07 +00:00
cc9a9ae8c5
Summary: This adds support for bundling custom widgets with the Grist app, as follows: * Adds a new `widgets` component to plugins mechanism. * When a set of widgets is provided in a plugin, the html/js/css assets for those widgets are served on the existing untrusted user content port. * Any bundled `grist-plugin-api.js` will be served with the Grist app's own version of that file. It is important that bundled widgets not refer to https://docs.getgrist.com for the plugin js, since they must be capable of working offline. * The logic for configuring that port is updated a bit. * I removed the CustomAttachedView class in favor of applying settings of bundled custom widgets more directly, without modification on view. Any Grist installation via docker will need an extra step now, since there is an extra port that needs exposing for full functionality. I did add a `GRIST_TRUST_PLUGINS` option for anyone who really doesn't want to do this, and would prefer to trust the plugins and have them served on the same port. Actually making use of bundling will be another step. It'll be important to mesh it with our SaaS's use of APP_STATIC_URL for serving most static assets. Design sketch: https://grist.quip.com/bJlWACWzr2R9/Bundled-custom-widgets Test Plan: added a test Reviewers: georgegevoian Reviewed By: georgegevoian Differential Revision: https://phab.getgrist.com/D4069
64 lines
1.6 KiB
TypeScript
64 lines
1.6 KiB
TypeScript
/**
|
|
* This module was automatically generated by `ts-interface-builder`
|
|
*/
|
|
import * as t from "ts-interface-checker";
|
|
// tslint:disable:object-literal-key-quotes
|
|
|
|
export const PublishedPlugin = t.iface(["BarePlugin"], {
|
|
"name": "string",
|
|
"version": "string",
|
|
});
|
|
|
|
export const BarePlugin = t.iface([], {
|
|
"name": t.opt("string"),
|
|
"components": t.iface([], {
|
|
"safeBrowser": t.opt("string"),
|
|
"safePython": t.opt("string"),
|
|
"unsafeNode": t.opt("string"),
|
|
"widgets": t.opt("string"),
|
|
"deactivate": t.opt(t.iface([], {
|
|
"inactivitySec": t.opt("number"),
|
|
})),
|
|
}),
|
|
"contributions": t.iface([], {
|
|
"importSources": t.opt(t.array("ImportSource")),
|
|
"fileParsers": t.opt(t.array("FileParser")),
|
|
"customSections": t.opt(t.array("CustomSection")),
|
|
}),
|
|
"experimental": t.opt("boolean"),
|
|
});
|
|
|
|
export const ImportSource = t.iface([], {
|
|
"label": "string",
|
|
"safeHome": t.opt("boolean"),
|
|
"importSource": "Implementation",
|
|
"importProcessor": t.opt("Implementation"),
|
|
});
|
|
|
|
export const FileParser = t.iface([], {
|
|
"fileExtensions": t.array("string"),
|
|
"editOptions": t.opt("Implementation"),
|
|
"parseFile": "Implementation",
|
|
});
|
|
|
|
export const CustomSection = t.iface([], {
|
|
"path": "string",
|
|
"name": "string",
|
|
});
|
|
|
|
export const Implementation = t.iface([], {
|
|
"component": t.union(t.lit("safeBrowser"), t.lit("safePython"), t.lit("unsafeNode")),
|
|
"name": "string",
|
|
"path": t.opt("string"),
|
|
});
|
|
|
|
const exportedTypeSuite: t.ITypeSuite = {
|
|
PublishedPlugin,
|
|
BarePlugin,
|
|
ImportSource,
|
|
FileParser,
|
|
CustomSection,
|
|
Implementation,
|
|
};
|
|
export default exportedTypeSuite;
|