docs: add plug-in documentation

packages/plugins/acl/README.md

@@ -0,0 +1,11 @@
+# acl
+
+English | [中文](./README.zh-CN.md)
+
+基于角色的权限控制插件。
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/acl/README.zh-CN.md

@@ -0,0 +1,11 @@
+# acl
+
+[English](./README.md) | 中文
+
+基于角色的权限控制插件。
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/audit-logs/README.md

@@ -0,0 +1,11 @@
+# audit-logs
+
+English | [中文](./README.zh-CN.md)
+
+审计日志插件。
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/audit-logs/README.zh-CN.md

@@ -0,0 +1,11 @@
+# audit-logs
+
+[English](./README.md) | 中文
+
+审计日志插件。
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/china-region/README.md

@@ -0,0 +1,11 @@
+# china-region
+
+English | [中文](./README.zh-CN.md)
+
+中国行政区划插件。
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/china-region/README.zh-CN.md

@@ -0,0 +1,11 @@
+# china-region
+
+[English](./README.md) | 中文
+
+中国行政区划插件。
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/client/README.md

@@ -0,0 +1,9 @@
+# client
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/client/README.zh-CN.md

@@ -0,0 +1,9 @@
+# client
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/collection-manager/README.md

@@ -0,0 +1,9 @@
+# collection-manager
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/collection-manager/README.zh-CN.md

@@ -0,0 +1,9 @@
+# collection-manager
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/duplicator/README.md

@@ -0,0 +1,118 @@
+# Duplicator
+
+English | [中文](./README.zh-CN.md)
+
+NocoBase 应用的备份与还原插件，可用于应用的复制、迁移、升级等场景。
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法
+
+Duplicator 插件提供了 `dump` 和 `restore` 命令，分别用于备份和还原应用数据，可用于单应用的备份和还原，也可以跨应用。如果跨应用还原数据，请保证目标应用 NocoBase 版本与源应用一致，相对应插件也已下载本地。
+
+**⚠️ 如果使用了继承（PostgreSQL）、视图、触发器等不兼容的特性，跨数据库还原备份数据可能失败。**
+
+### 备份数据
+
+```bash
+yarn nocobase dump
+```
+
+选择需要备份的插件表结构及其数据
+
+```bash
+? Select the plugin collections to be dumped (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
+ == Required ==
+ - migration (core) (Disabled)
+ - collections (collection-manager) (Disabled)
+ - uiSchemas (ui-schema-storage) (Disabled)
+ - uiRoutes (ui-routes-storage) (Disabled)
+ - acl (acl) (Disabled)
+ - workflowConfig (workflow) (Disabled)
+ - snapshot-field (snapshot-field) (Disabled)
+ - sequences (sequence-field) (Disabled)
+ == Optional ==
+❯◉ executionLogs (workflow)
+ ◉ users (users)
+ ◉ storageSetting (file-manager)
+ ◉ attachmentRecords (file-manager)
+ ◉ systemSettings (system-settings)
+ ◉ verificationProviders (verification)
+ ◉ verificationData (verification)
+ ◉ oidcProviders (oidc)
+ ◉ samlProviders (saml)
+ ◉ mapConfiguration (map)
+(Move up and down to reveal more choices)
+```
+
+选择需要备份的其他数据表的记录
+
+```bash
+? Select the collection records to be dumped (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
+❯◉ Test1
+❯◉ Test2
+❯◉ Test3
+```
+
+数据备份成功之后，备份文件位于 `storage/duplicator` 目录下：
+
+```bash
+dumped to /your/apps/a/storage/duplicator/dump-20230210T223910.nbdump
+dumped file size: 20.8 kB
+```
+
+### 还原数据
+
+```bash
+yarn nocobase restore /your/apps/a/storage/duplicator/dump-20230210T223910.nbdump
+```
+
+导入前请先备份数据
+
+```bash
+? Danger !!! This action will overwrite your current data, please make sure you have a backup❗️❗️ (y/N)
+```
+
+选择需要还原的插件表结构及其数据
+
+```bash
+? Select the plugin collections to be restored (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
+ == Required ==
+ - migration (core) (Disabled)
+ - collections (collection-manager) (Disabled)
+ - uiSchemas (ui-schema-storage) (Disabled)
+ - uiRoutes (ui-routes-storage) (Disabled)
+ - acl (acl) (Disabled)
+ - workflowConfig (workflow) (Disabled)
+ - sequences (sequence-field) (Disabled)
+ == Optional ==
+❯◯ executionLogs (workflow)
+ ◯ users (users)
+ ◯ storageSetting (file-manager)
+ ◯ attachmentRecords (file-manager)
+ ◯ systemSettings (system-settings)
+ ◯ verificationProviders (verification)
+ ◯ verificationData (verification)
+ ◯ auditLogs (audit-logs)
+ ◯ iframe html storage (iframe-block)
+```
+
+选择需要还原的其他数据表的记录
+
+```bash
+? Select the collection records to be restored (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
+❯◉ Test1
+❯◉ Test2
+❯◉ Test3
+```
+
+成功之后，重启应用
+
+```bash
+# for development
+yarn dev
+# for production
+yarn start
+```

packages/plugins/duplicator/README.zh-CN.md

@@ -0,0 +1,118 @@
+# Duplicator
+
+[English](./README.md) | 中文
+
+NocoBase 应用的备份与还原插件，可用于应用的复制、迁移、升级等场景。
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法
+
+Duplicator 插件提供了 `dump` 和 `restore` 命令，分别用于备份和还原应用数据，可用于单应用的备份和还原，也可以跨应用。如果跨应用还原数据，请保证目标应用 NocoBase 版本与源应用一致，相对应插件也已下载本地。
+
+**⚠️ 如果使用了继承（PostgreSQL）、视图、触发器等不兼容的特性，跨数据库还原备份数据可能失败。**
+
+### 备份数据
+
+```bash
+yarn nocobase dump
+```
+
+选择需要备份的插件表结构及其数据
+
+```bash
+? Select the plugin collections to be dumped (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
+ == Required ==
+ - migration (core) (Disabled)
+ - collections (collection-manager) (Disabled)
+ - uiSchemas (ui-schema-storage) (Disabled)
+ - uiRoutes (ui-routes-storage) (Disabled)
+ - acl (acl) (Disabled)
+ - workflowConfig (workflow) (Disabled)
+ - snapshot-field (snapshot-field) (Disabled)
+ - sequences (sequence-field) (Disabled)
+ == Optional ==
+❯◉ executionLogs (workflow)
+ ◉ users (users)
+ ◉ storageSetting (file-manager)
+ ◉ attachmentRecords (file-manager)
+ ◉ systemSettings (system-settings)
+ ◉ verificationProviders (verification)
+ ◉ verificationData (verification)
+ ◉ oidcProviders (oidc)
+ ◉ samlProviders (saml)
+ ◉ mapConfiguration (map)
+(Move up and down to reveal more choices)
+```
+
+选择需要备份的其他数据表的记录
+
+```bash
+? Select the collection records to be dumped (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
+❯◉ Test1
+❯◉ Test2
+❯◉ Test3
+```
+
+数据备份成功之后，备份文件位于 `storage/duplicator` 目录下：
+
+```bash
+dumped to /your/apps/a/storage/duplicator/dump-20230210T223910.nbdump
+dumped file size: 20.8 kB
+```
+
+### 还原数据
+
+```bash
+yarn nocobase restore /your/apps/a/storage/duplicator/dump-20230210T223910.nbdump
+```
+
+导入前请先备份数据
+
+```bash
+? Danger !!! This action will overwrite your current data, please make sure you have a backup❗️❗️ (y/N)
+```
+
+选择需要还原的插件表结构及其数据
+
+```bash
+? Select the plugin collections to be restored (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
+ == Required ==
+ - migration (core) (Disabled)
+ - collections (collection-manager) (Disabled)
+ - uiSchemas (ui-schema-storage) (Disabled)
+ - uiRoutes (ui-routes-storage) (Disabled)
+ - acl (acl) (Disabled)
+ - workflowConfig (workflow) (Disabled)
+ - sequences (sequence-field) (Disabled)
+ == Optional ==
+❯◯ executionLogs (workflow)
+ ◯ users (users)
+ ◯ storageSetting (file-manager)
+ ◯ attachmentRecords (file-manager)
+ ◯ systemSettings (system-settings)
+ ◯ verificationProviders (verification)
+ ◯ verificationData (verification)
+ ◯ auditLogs (audit-logs)
+ ◯ iframe html storage (iframe-block)
+```
+
+选择需要还原的其他数据表的记录
+
+```bash
+? Select the collection records to be restored (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
+❯◉ Test1
+❯◉ Test2
+❯◉ Test3
+```
+
+成功之后，重启应用
+
+```bash
+# for development
+yarn dev
+# for production
+yarn start
+```

packages/plugins/duplicator/src/server/app-migrator.ts

@@ -1,12 +1,12 @@
 import { Application } from '@nocobase/server';
+import { applyMixins, AsyncEmitter } from '@nocobase/utils';
+import crypto from 'crypto';
+import EventEmitter from 'events';
+import fsPromises from 'fs/promises';
+import inquirer from 'inquirer';
+import lodash from 'lodash';
 import * as os from 'os';
 import path from 'path';
-import lodash from 'lodash';
-import fsPromises from 'fs/promises';
-import crypto from 'crypto';
-import inquirer from 'inquirer';
-import EventEmitter from 'events';
-import { applyMixins, AsyncEmitter, requireModule } from '@nocobase/utils';
 
 abstract class AppMigrator extends EventEmitter {
   protected workDir: string;
@@ -64,11 +64,11 @@ abstract class AppMigrator extends EventEmitter {
     return {
       type: 'checkbox',
       name: 'collectionGroups',
-      message: `选择需要${this.direction}的插件数据`,
+      message: `Select the plugin collections to be ${this.direction === 'dump' ? 'dumped' : 'restored'}`,
       loop: false,
       pageSize: 20,
       choices: [
-        new inquirer.Separator('== 必选数据 =='),
+        new inquirer.Separator('== Required =='),
         ...requiredGroups.map((collectionGroup) => ({
           name: `${collectionGroup.function} (${collectionGroup.pluginName})`,
           value: `${collectionGroup.pluginName}.${collectionGroup.function}`,
@@ -76,7 +76,7 @@ abstract class AppMigrator extends EventEmitter {
           disabled: true,
         })),
 
-        new inquirer.Separator('== 可选数据 =='),
+        new inquirer.Separator('== Optional =='),
         ...optionalGroups.map((collectionGroup) => ({
           name: `${collectionGroup.function} (${collectionGroup.pluginName})`,
           value: `${collectionGroup.pluginName}.${collectionGroup.function}`,
@@ -95,7 +95,7 @@ abstract class AppMigrator extends EventEmitter {
     return {
       type: 'checkbox',
       name: 'userCollections',
-      message: `选择需要${this.direction}的Collection数据`,
+      message: `Select the collection records to be ${this.direction === 'dump' ? 'dumped' : 'restored'}`,
       loop: false,
       pageSize: 30,
       choices: collections.map((collection) => {

packages/plugins/error-handler/README.md

@@ -0,0 +1,9 @@
+# error-handler
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/error-handler/README.zh-CN.md

@@ -0,0 +1,9 @@
+# error-handler
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/excel-formula-field/README.md

@@ -0,0 +1,9 @@
+# excel-formula-field
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/excel-formula-field/README.zh-CN.md

@@ -0,0 +1,9 @@
+# excel-formula-field
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/export/README.md

@@ -0,0 +1,9 @@
+# export
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/export/README.zh-CN.md

@@ -0,0 +1,9 @@
+# Export
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/file-manager/README.md

@@ -0,0 +1,9 @@
+# file-manager
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/file-manager/README.zh-CN.md

@@ -0,0 +1,9 @@
+# file-manager
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/graph-collection-manager/README.md

@@ -0,0 +1,11 @@
+# graph-collection-manager
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+```bash
+yarn pm enable graph-collection-manager 
+```
+
+## 使用方法

packages/plugins/graph-collection-manager/README.zh-CN.md

@@ -0,0 +1,11 @@
+# graph-collection-manager
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+```bash
+yarn pm enable graph-collection-manager 
+```
+
+## 使用方法

packages/plugins/iframe-block/README.md

@@ -0,0 +1,11 @@
+# iframe-block
+
+English | [中文](./README.zh-CN.md)
+
+Iframe 区块插件。
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/iframe-block/README.zh-CN.md

@@ -0,0 +1,11 @@
+# iframe-block
+
+[English](./README.md) | 中文
+
+Iframe 区块插件。
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/import/README.md

@@ -0,0 +1,11 @@
+# import
+
+English | [中文](./README.zh-CN.md)
+
+Excel 数据导入插件。
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/import/README.zh-CN.md

@@ -0,0 +1,11 @@
+# import
+
+[English](./README.md) | 中文
+
+Excel 数据导入插件。
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/map/README.md

@@ -0,0 +1,13 @@
+# map
+
+English | [中文](./README.zh-CN.md)
+
+地图插件。
+
+## 安装激活
+
+```bash
+yarn pm enable map
+```
+
+## 使用方法

packages/plugins/map/README.zh-CN.md

@@ -0,0 +1,13 @@
+# map
+
+[English](./README.md) | 中文
+
+地图插件。
+
+## 安装激活
+
+```bash
+yarn pm enable map
+```
+
+## 使用方法

packages/plugins/math-formula-field/README.md

@@ -0,0 +1,9 @@
+# math-formula-field
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/math-formula-field/README.zh-CN.md

@@ -0,0 +1,9 @@
+# math-formula-field
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/multi-app-manager/README.md

@@ -0,0 +1,13 @@
+# multi-app-manager
+
+English | [中文](./README.zh-CN.md)
+
+多应用管理插件。
+
+## 安装激活
+
+```bash
+yarn pm enable multi-app-manager
+```
+
+## 使用方法

packages/plugins/multi-app-manager/README.zh-CN.md

@@ -0,0 +1,13 @@
+# multi-app-manager
+
+[English](./README.md) | 中文
+
+多应用管理插件。
+
+## 安装激活
+
+```bash
+yarn pm enable multi-app-manager
+```
+
+## 使用方法

packages/plugins/notifications/README.md

@@ -0,0 +1,9 @@
+# notifications
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/notifications/README.zh-CN.md

@@ -0,0 +1,9 @@
+# notifications
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/oidc/README.md

@@ -0,0 +1,11 @@
+# oidc
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+```bash
+yarn pm enable oidc
+```
+
+## 使用方法

packages/plugins/oidc/README.zh-CN.md

@@ -0,0 +1,11 @@
+# OIDC
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+```bash
+yarn pm enable oidc
+```
+
+## 使用方法

packages/plugins/saml/README.md

@@ -0,0 +1,11 @@
+# SAML
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+```bash
+yarn pm enable saml
+```
+
+## 使用方法

packages/plugins/saml/README.zh-CN.md

@@ -0,0 +1,11 @@
+# SAML
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+```bash
+yarn pm enable saml
+```
+
+## 使用方法

packages/plugins/sequence-field/README.md

@@ -0,0 +1,9 @@
+# sequence-field
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/sequence-field/README.zh-CN.md

@@ -0,0 +1,9 @@
+# sequence-field
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/snapshot-field/README.md

@@ -0,0 +1,13 @@
+# snapshot-field
+
+English | [中文](./README.zh-CN.md)
+
+关系数据快照插件。
+
+## 安装激活
+
+```bash
+yarn pm enable snapshot-field
+```
+
+## 使用方法

packages/plugins/snapshot-field/README.zh-CN.md

@@ -0,0 +1,13 @@
+# snapshot-field
+
+[English](./README.md) | 中文
+
+关系数据快照插件。
+
+## 安装激活
+
+```bash
+yarn pm enable snapshot-field
+```
+
+## 使用方法

packages/plugins/system-settings/README.md

@@ -0,0 +1,9 @@
+# system-settings
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/system-settings/README.zh-CN.md

@@ -0,0 +1,9 @@
+# system-settings
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/ui-routes-storage/README.md

@@ -0,0 +1,9 @@
+# ui-routes-storage
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/ui-routes-storage/README.zh-CN.md

@@ -0,0 +1,9 @@
+# ui-routes-storage
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/ui-schema-storage/README.md

@@ -0,0 +1,9 @@
+# ui-schema-storage
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/ui-schema-storage/README.zh-CN.md

@@ -0,0 +1,9 @@
+# ui-schema-storage
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/users/README.md

@@ -0,0 +1,9 @@
+# users
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/users/README.zh-CN.md

@@ -0,0 +1,9 @@
+# users
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/verification/README.md

@@ -0,0 +1,9 @@
+# verification
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/verification/README.zh-CN.md

@@ -0,0 +1,9 @@
+# verification
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/workflow/README.md

@@ -0,0 +1,9 @@
+# workflow
+
+English | [中文](./README.zh-CN.md)
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法

packages/plugins/workflow/README.zh-CN.md

@@ -0,0 +1,9 @@
+# workflow
+
+[English](./README.md) | 中文
+
+## 安装激活
+
+内置插件无需手动安装激活。
+
+## 使用方法