44f99eb304
Summary: Made Sandy plugins part of the export / import logic Note that in the export format there is now a `pluginStates2` field. It could have been put in `pluginStates` as well, but I started with that and it felt very weird, as the `pluginStates` are supposed to reflect what is living in the Redux stores, where sandy state doesn't live in the Redux store (not directly at least). Trying to store it in the same field made things overcomplicated and confusing. Reviewed By: jknoxville Differential Revision: D22432769 fbshipit-source-id: d9858e561fad4fadbf0f90858874ed444e3a836c
100 lines
2.7 KiB
TypeScript
100 lines
2.7 KiB
TypeScript
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @format
|
|
*/
|
|
|
|
import {PluginDetails} from 'flipper-plugin-lib';
|
|
import {FlipperPluginFactory, FlipperPluginComponent} from './Plugin';
|
|
|
|
/**
|
|
* FlipperPluginModule describe the exports that are provided by a typical Flipper Desktop plugin
|
|
*/
|
|
export type FlipperPluginModule<
|
|
Factory extends FlipperPluginFactory<any, any>
|
|
> = {
|
|
/** the factory function that initializes a plugin instance */
|
|
plugin: Factory;
|
|
/** the component type that can render this plugin */
|
|
Component: FlipperPluginComponent;
|
|
// TODO: support device plugins T68738317
|
|
// devicePlugin: FlipperPluginFactory
|
|
};
|
|
|
|
/**
|
|
* A sandy plugin definition represents a loaded plugin definition, storing two things:
|
|
* the loaded JS module, and the meta data (typically coming from package.json).
|
|
*
|
|
* Also delegates some of the standard plugin functionality to have a similar public static api as FlipperPlugin
|
|
*/
|
|
export class SandyPluginDefinition {
|
|
id: string;
|
|
module: FlipperPluginModule<any>;
|
|
details: PluginDetails;
|
|
|
|
// TODO: Implement T68683476
|
|
exportPersistedState:
|
|
| ((
|
|
callClient: (method: string, params?: any) => Promise<any>,
|
|
persistedState: any, // TODO: type StaticPersistedState | undefined,
|
|
store: any, // TODO: ReduxState | undefined,
|
|
idler?: any, // TODO: Idler,
|
|
statusUpdate?: (msg: string) => void,
|
|
supportsMethod?: (method: string) => Promise<boolean>,
|
|
) => Promise<any /* TODO: StaticPersistedState | undefined */>)
|
|
| undefined = undefined;
|
|
|
|
constructor(details: PluginDetails, module: FlipperPluginModule<any>) {
|
|
this.id = details.id;
|
|
this.details = details;
|
|
if (!module.plugin || typeof module.plugin !== 'function') {
|
|
throw new Error(
|
|
`Flipper plugin '${this.id}' should export named function called 'plugin'`,
|
|
);
|
|
}
|
|
if (!module.Component || typeof module.Component !== 'function') {
|
|
throw new Error(
|
|
`Flipper plugin '${this.id}' should export named function called 'Component'`,
|
|
);
|
|
}
|
|
this.module = module;
|
|
this.module.Component.displayName = `FlipperPlugin(${this.id})`;
|
|
}
|
|
|
|
get packageName() {
|
|
return this.details.name;
|
|
}
|
|
|
|
get title() {
|
|
return this.details.title;
|
|
}
|
|
|
|
get icon() {
|
|
return this.details.icon;
|
|
}
|
|
|
|
get category() {
|
|
return this.details.category;
|
|
}
|
|
|
|
get gatekeeper() {
|
|
return this.details.gatekeeper;
|
|
}
|
|
|
|
get version() {
|
|
return this.details.version;
|
|
}
|
|
|
|
get isDefault() {
|
|
return this.details.isDefault;
|
|
}
|
|
|
|
get keyboardActions() {
|
|
// TODO: T68882551 support keyboard actions
|
|
return [];
|
|
}
|
|
}
|