tachybase_todo/packages/plugins/@nocobase/plugin-localization-management/src/server/plugin.ts
jack zhang 705b7449f0
feat: new plugin manager, supports adding plugins through UI (#2430)
* 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>
2023-09-12 22:39:23 +08:00

151 lines
4.6 KiB
TypeScript

import { Model } from '@nocobase/database';
import { UiSchemaStoragePlugin } from '@nocobase/plugin-ui-schema-storage';
import { InstallOptions, Plugin } from '@nocobase/server';
import deepmerge from 'deepmerge';
import { resolve } from 'path';
import localization from './actions/localization';
import localizationTexts from './actions/localizationTexts';
import Resources from './resources';
import { getTextsFromDBRecord } from './utils';
export class LocalizationManagementPlugin extends Plugin {
resources: Resources;
registerUISchemahook(plugin?: UiSchemaStoragePlugin) {
const uiSchemaStoragePlugin = plugin || this.app.getPlugin<UiSchemaStoragePlugin>('ui-schema-storage');
if (!uiSchemaStoragePlugin) {
return;
}
uiSchemaStoragePlugin.serverHooks.register('onSelfSave', 'extractTextToLocale', async ({ schemaInstance }) => {
const schema = schemaInstance.get('schema');
const title = schema?.title || schema?.['x-component-props']?.title;
if (!title) {
return;
}
const result = await this.resources.filterExists([title]);
if (!result.length) {
return;
}
this.db
.getRepository('localizationTexts')
.create({
values: {
module: 'resources.client',
text: title,
},
})
.then((res) => this.resources.updateCacheTexts([res]))
.catch((err) => {});
});
}
afterAdd() {}
beforeLoad() {}
async load() {
await this.db.import({
directory: resolve(__dirname, 'collections'),
});
this.db.addMigrations({
namespace: 'localization-management',
directory: resolve(__dirname, 'migrations'),
context: {
plugin: this,
},
});
this.app.resource({
name: 'localizationTexts',
actions: localizationTexts,
});
this.app.resource({
name: 'localization',
actions: localization,
});
this.app.acl.registerSnippet({
name: `pm.${this.name}.localization`,
actions: ['localization:*', 'localizationTexts:*', 'localizationTranslations:*'],
});
this.db.on('afterSave', async (instance: Model) => {
const model = instance.constructor as typeof Model;
const collection = model.collection;
if (!collection) {
return;
}
let texts = [];
const fields = Array.from(collection.fields.values())
.filter((field) => field.options?.translation && instance['_changed'].has(field.name))
.map((field) => field.name);
if (!fields.length) {
return;
}
const textsFromDB = getTextsFromDBRecord(fields, instance);
textsFromDB.forEach((text) => {
texts.push(text);
});
texts = await this.resources.filterExists(texts);
this.db
.getModel('localizationTexts')
.bulkCreate(texts.map((text) => ({ module: 'resources.client', text })))
.then((newTexts) => this.resources.updateCacheTexts(newTexts))
.catch((err) => {});
});
this.resources = new Resources(this.db);
this.registerUISchemahook();
this.app.resourcer.use(async (ctx, next) => {
await next();
const { resourceName, actionName } = ctx.action.params;
if (resourceName === 'app' && actionName === 'getLang') {
const custom = await this.resources.getResources(ctx.get('X-Locale') || 'en-US');
const appLang = ctx.body;
const resources = {};
Object.keys(appLang.resources).forEach((key) => {
const resource = custom[`resources.${key}`];
resources[key] = resource ? deepmerge(appLang.resources[key], resource) : { ...appLang.resources[key] };
});
// For duplicate texts, use translations from client to override translations in other modules
const client = resources['client'] || {};
Object.keys(resources).forEach((key) => {
if (key === 'client') {
return;
}
Object.keys(resources[key]).forEach((text) => {
if (client[text]) {
resources[key][text] = client[text];
}
});
});
ctx.body = {
...appLang,
resources,
};
}
});
}
async install(options?: InstallOptions) {}
async afterEnable() {}
async afterDisable() {
const uiSchemaStoragePlugin = this.app.getPlugin<UiSchemaStoragePlugin>('ui-schema-storage');
if (!uiSchemaStoragePlugin) {
return;
}
uiSchemaStoragePlugin.serverHooks.remove('onSelfSave', 'extractTextToLocale');
}
async remove() {}
}
export default LocalizationManagementPlugin;