* refactor: plugin manager page * fix: bug * feat: addByNpm api * fix: improve the addByNpm * feat: improve applicationPlugins:list api * fix: re-download npm package when restart app * fix: plugin delete api * feat: plugin detail api * feat: zipUrl add api * fix: upload api bug * fix: plugin detail info * feat: upgrade api * fix: upload api * feat: handle plugin load error * feat: support authToken * feat: muti lang * fix: build error * fix: self review * Update plugin-manager.ts * fix: bug * fix: bug * fix: bug * fix: bug * fix: bug * fix: bugs * fix: detail click and remove isOfficial * fix: upgrade no refresh * fix: file size and type check * fix: bug * fix: upgrade error * fix: bug * fix: bug * fix: plugin card layout * fix: handling exceptional cases * fix: tgz file support * fix: macos compress file * fix: bug * fix: bug * fix: bug * fix: bug * fix: add upgrade npm type * fix: bugs * fix: bug * fix: change plugins static expose url * fix: api prefix * fix: bug * fix: add nginx `/static/plugin/` path * fix: bugs and pr docker build no dts * fix: bug * fix: build tools bug * fix: improve code * fix: build bug * feat: improve plugin info * fix: ui bug * fix: plugin document bug * feat: improve code * feat: improve code * feat: process dev deps check * feat: improve code * feat: process.env.IS_DEV_CMD * fix: do not delete the plugin package * feat: plugin symlink * fix: tsx watch --ignore=./storage/plugins/** * fix: test error * fix: improve code * fix: improve code * fix: emitStartedEvent * fix: improve code * fix: type error * fix: test error * test: console.log * fix: createStoragePluginSymLink * fix: clientStaticMiddleware rename to clientStaticUtils * feat: build tools support plugins folder * fix: 350px * fix: error * feat: client dev support plugin folder * fix: clear cli options * fix: typeError: Converting circular structure to JSON * fix: plugin name * chore: restart application after command * feat: upgrade error & docs * Update v14-changelog.md * Update v14-changelog.md * Update v14-changelog.md * fix: gateway test * refactor(plugin-workflow): add ready state for gracefully tearing down * Revert "chore: restart application after command" This reverts commit 5015274f8e4e06e506e15754b672330330e8c7f8. * chore: stop application whe restart * T 1218 change plugin folder (#2629) * feat: change folder name * feat: change `pm create` command * feat: revert plugin name change * fix: delete samples * feat: change plugins folder * fix: pm create * feat: update docs * fix: link package error * fix: docs * fix: create command * fix: pm add error * fix: create add build * fix: pm creatre + add * feat: add tar command * fix: docs * fix: bug * fix: docs --------- Co-authored-by: chenos <chenlinxh@gmail.com> * feat: docs * Update your-fisrt-plugin.md * Update your-fisrt-plugin.md * chore: application reload * chore: test * fix: pm add error * chore: preset install skip exists plugin * fix: createIfNotExists --------- Co-authored-by: chenos <chenlinxh@gmail.com> Co-authored-by: chareice <chareice@live.com> Co-authored-by: Zhou <zhou.working@gmail.com> Co-authored-by: mytharcher <mytharcher@gmail.com>
137 lines
2.8 KiB
TypeScript
137 lines
2.8 KiB
TypeScript
import { Model } from '@nocobase/database';
|
|
import fs from 'fs';
|
|
import { resolve } from 'path';
|
|
import { Application } from './application';
|
|
import { InstallOptions, getExposeChangelogUrl, getExposeReadmeUrl } from './plugin-manager';
|
|
import { checkAndGetCompatible } from './plugin-manager/utils';
|
|
|
|
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 abstract class Plugin<O = any> implements PluginInterface {
|
|
options: any;
|
|
app: Application;
|
|
model: Model;
|
|
state: any = {};
|
|
|
|
constructor(app: Application, options?: any) {
|
|
this.app = app;
|
|
this.setOptions(options);
|
|
}
|
|
|
|
get log() {
|
|
return this.app.log;
|
|
}
|
|
|
|
get name() {
|
|
return this.options.name as string;
|
|
}
|
|
|
|
get pm() {
|
|
return this.app.pm;
|
|
}
|
|
|
|
get db() {
|
|
return this.app.db;
|
|
}
|
|
|
|
get enabled() {
|
|
return this.options.enabled;
|
|
}
|
|
|
|
set enabled(value) {
|
|
this.options.enabled = value;
|
|
}
|
|
|
|
get installed() {
|
|
return this.options.installed;
|
|
}
|
|
|
|
set installed(value) {
|
|
this.options.installed = 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 beforeDisable() {}
|
|
|
|
async afterDisable() {}
|
|
|
|
async beforeRemove() {}
|
|
|
|
async afterRemove() {}
|
|
|
|
async importCollections(collectionsPath: string) {
|
|
await this.db.import({
|
|
directory: collectionsPath,
|
|
from: this.getName(),
|
|
});
|
|
}
|
|
|
|
requiredPlugins() {
|
|
return [];
|
|
}
|
|
|
|
async toJSON(options: any = {}) {
|
|
const { locale = 'en-US' } = options;
|
|
const { packageName, packageJson } = this.options;
|
|
if (!packageName) {
|
|
return {
|
|
...this.options,
|
|
};
|
|
}
|
|
const file = await fs.promises.realpath(resolve(process.env.NODE_MODULES_PATH, packageName));
|
|
const lastUpdated = (await fs.promises.stat(file)).ctime;
|
|
const others = await checkAndGetCompatible(packageName);
|
|
return {
|
|
...this.options,
|
|
...others,
|
|
readmeUrl: getExposeReadmeUrl(packageName, locale),
|
|
changelogUrl: getExposeChangelogUrl(packageName),
|
|
lastUpdated,
|
|
file,
|
|
updatable: file.startsWith(process.env.PLUGIN_STORAGE_PATH),
|
|
displayName: packageJson[`displayName.${locale}`] || packageJson.displayName,
|
|
description: packageJson[`description.${locale}`] || packageJson.description,
|
|
};
|
|
}
|
|
}
|
|
|
|
export default Plugin;
|