tachybase_todo/packages/core/server/src/plugin.ts
2023-04-04 16:08:10 +08:00

92 lines
1.5 KiB
TypeScript

import { Application } from './application';
import { InstallOptions } from './plugin-manager';
export interface PluginInterface {
beforeLoad?: () => void;
load();
getName(): string;
}
export interface PluginOptions {
activate?: boolean;
displayName?: string;
description?: string;
version?: string;
enabled?: boolean;
install?: (this: Plugin) => void;
load?: (this: Plugin) => void;
plugin?: typeof Plugin;
[key: string]: any;
}
export type PluginType = typeof Plugin;
export abstract class Plugin<O = any> implements PluginInterface {
options: any;
app: Application;
constructor(app: Application, options?: any) {
this.setOptions(options);
this.app = app;
this.setOptions(options);
this.afterAdd();
}
get name() {
return this.options.name as string;
}
get db() {
return this.app.db;
}
get enabled() {
return this.options.enabled;
}
set enabled(value) {
this.options.enabled = value;
}
setOptions(options: any) {
this.options = options || {};
}
getName() {
return (this.options as any).name;
}
afterAdd() {}
beforeLoad() {}
async load() {}
async install(options?: InstallOptions) {}
async beforeEnable() {}
async afterEnable() {}
async afterDisable() {}
async remove() {}
async importCollections(collectionsPath: string) {
await this.db.import({
directory: collectionsPath,
from: this.getName(),
});
}
requiredPlugins() {
return [];
}
}
export default Plugin;