plugin.yaml
插件配置文件，描述了插件所使用到的能力、模块以及其他相关信息，开放平台将会插件安装与启用时消费该文件内容。
文件位置与结构：
service:
app_id: '********'
version: 1.0.0
name: MyPluginName
description: MyPluginDescription
language: nodejs
language_version: 16.13.0
host_version: 1.0.0
host_sub_version: 1.0.0
min_system_version: 3.5.0
contact: MyContactInformation
config:
- key: MyCustomConfigKey
type: Input
policy:
policy: simple
target: ''
abilities:
- id: Simple-login-SXgh
name: SimpleLoginVerification
abilityType: SimpleAuth
function:
validateFunc: SimpleAuthValidate
apis:
- type: addition
methods:
- GET
url: /hello
function: HelloWorld
modules:
- id: ones-global-banner-GXvd
title: example banner title
moduleType: ones:global:banner
entry: modules/ones-global-banner-GXvd/index.html
service
插件的基本信息配置，参数如下：
app_id
- 类型：
string
插件的唯一身份标识，由脚手架自动生成，一般不建议修改。
两个插件，即便名称一样，若 app_id 不一样，它们会被识别为不同的插件；反之，若 app_id 一致，无论名称是否一样，它们也会被识别为同一个插件。
若一个插件需要升级，则必须保证新旧版本的 app_id 一致，否则开放平台将视为新插件进行安装。
version
- 类型：
string
插件的版本号，建议遵循 Semantic Versioning 2.0.0 语义化版本规范。
name
- 类型：
string
插件名称，将会在插件管理与详情页展示。
description
- 类型：
string
插件的描述信息，将会在插件管理与详情页展示。
scope
- 类型：
1 | 2
声明插件的作用域。
| 类型 | 说明 |
|---|---|
| 1 | 团队级别插件，只能在「配置中心」=>「插件管理」下进行安装，只能对当前团队生效 |
| 2 | 组织级别插件，只能在「组织管理」=>「插件管理」下进行安装，对组织下所有团队生效 |
language
- 类型：
'nodejs'
插件的开发语言，目前仅支持 nodejs，一般无需修改。
host_version
- 类型：
string
开放平台 HOST 最低版本号，一般无需修改。
插件启用时，将会运行在最高位 patch 版本的 HOST 上，这与 npm 的 ~version 效果类似。
举例：
如果你当前的 host_version 版本是 1.0.4。
服务器存在如下 HOST 版本：
1.0.31.0.41.0.51.1.02.0.0
那么你的插件将运行在 1.0.5 版本的 HOST 上。
contact
- 类型：
string - 最大长度：
255
插件日志页显示 的联系方式展示（支持多行文本）。
示例：
service:
contact: |-
email: support@ones.com
Call: 400-188-1518
config
- 类型：
Config[]
插件自定义配置的配置项数组，你可以通过声明此配置快速提供一些插件自定义配置项，具体使用文档请查阅 插件自定义配置项。
配置只能在插件停用状态进行修改。
Config 参数：
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|---|---|---|---|---|
| key | 唯一标识 | string | 是 | |
| type | 类型 | 'Input'｜'TextArea'｜'Password' | 是 | |
| required | 是否必填 | boolean | 否 | false |
| label | 别名 | string | 否 | key |
| value | 默认值 | string | 否 |
示例：
service:
config:
- key: exampleConfigKey
label: my example key
type: Input
效果：
permission
- 类型：
Permission[]
插件自定义的标准权限点配置项数组，你可以通过此配置快速搭建自己的插件权限体系，具体使用文档请查阅 插件自定义权限点。
Permission 参数：
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|---|---|---|---|---|
| name | 权限名称 | string | 是 | |
| field | 权限唯一标识 | string | 是 | |
| desc | 权限描述 | string | 否 |
示例：
service:
permission:
- name: My custom read permission
field: my-custom-read-permission-key
desc: This is an example of custom read permission
- name: My custom write permission
field: my-custom-write-permission-key
配置入口（插件启用后）：
language_version
- 类型：
string - 保留字段
插件开发后端语言的版本号。
host_sub_version
- 类型：
string - 保留字段
开放平台 HOST 子版本号。
min_system_version
- 类型：
string - 保留字段
最低兼容的 ONES 系统版本。
mode
- 类型：
string - 已废弃
插件的模式。
logo
- 类型：
string - 已废弃
声明插件的 Logo，已废弃。
如需要修改插件 Logo，请修改 插件目录 下的 web/public/logo.svg 文件。
auth
- 类型：
string - 已废弃
插件授权声明。
policy
- 类型：
Policy
插件的售卖策略
** Policy参数：**
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|---|---|---|---|---|
| policy | 售卖策略 | 'simple' | 'standard' | 是 | |
| target | 保留字段，保持空值即可 | string | 是 |
示例：
service:
policy:
policy: standard
target: ''
abilities
插件能力配置项 数组，单个能力的配置参数如下：
id
- 类型：
string
插件的能力的唯一标识。
name
- 类型：
string
插件的能力名称。
label
- 类型：
string - 保留字段
插件能力别名。
relateModule
- 类型：
string
与当前能力绑定使用的 插件模块 ID，根据特定能力需求配置，一般无需修改。
version
- 类型：
string
添加能力时所选择插件能力版本，由脚手架自动生成，一般无需修改。
abilityType
- 类型：
string
插件的能力类型，由脚手架自动生成，一般无需修改。
function
- 类型：
Record<string, string>
插件的能力的调用入口方法名，由脚手架自动生成，如果同一个能力添加多次，你需要手动修改指定新的方法名。
config
- 类型：
AbilityConfig[]
插件能力配置项，由脚手架自动生成。
AbilityConfig 参数：
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|---|---|---|---|---|
| key | 唯一标识 | string | 是 | |
| fieldType | 类型 | FieldType | 是 | |
| required | 是否必填 | boolean | 否 | false |
| label | 别名 | string | 否 | key |
| value | 默认值 | string | 否 | |
| show | 插件详情页是否展示此配置 | boolean | 否 | true |
| props | 配置项 UI 输入控件的 props | object | 否 |
FieldType 类型：
'Input'：单行文本'TextArea'：多行文本'Password'：密码输入框'Number'：数字输入框'Select'：单选'MultiSelect'：多选'DatePicker'：日期选择器'DateTimePicker'：时间日期选择器'TimePicker'：时间选择器'Switch'：开关
** props 参数：**
配置项 UI 输入控件的 props。具体参数可结合 FieldType 查阅 ONES 组件库文档。
举例：
当你的 FieldType 为文本输入框时，你可以通过 props 控制输入框的占位符（placeholder）等。
当你的 FieldType 为选择框时，你可以通过 props 控制选择框的可选项（options）等。
仅支持部分参数（且受限于 yaml，只允许传入 string、number 或 null 类型的参数），建议你不要传入一些影响功能性的参数，我们不保证传入后配置表单的功能能正常运行。
apis
插件的接口配置项 数组，单个接口的配置参数如下：
type
- 类型：
'external' | 'addition'
接口的类型，具体使用详见 接口注册。
'external'：团队级别新增接口（会对登录进行校验，并且 URL 需要带上team/{teamUUID}前缀）'addition'：插件级别新增接口
methods
- 类型：
('GET' | 'POST')[]
接口支持的请求方式，可同时设置多种类型。
url
- 类型：
string - 示例：
/hello
接口访问地址。
function
- 类型：
string
接口访问时的调用入口方法名（此方法必须 export 导出才能够被开放平台调用）。
scope
- 类型：
'project' | 'wiki' - 默认值（含未定义）：
'project'
当前接口是对 ONES 标品接口修改时（即 type 是 'replace' | 'prefix' | 'suffix'），需要声明你当前修改的是 project 接口还是 wiki 接口。
如果是插件新增的接口，此字段无意义。
modules
插件的模块配置项 数组，单个模块配置参数如下：
id
- 类型：
string
插件内唯一的模块标识，由脚手架自动生成，一般无需修改。
title
- 类型：
string
模块标题。
description
- 类型：
string
模块描述。
icon
- 类型：
string - 示例：
./logo.svg
模块图标地址，开放平台会在插件 /web/public 目录下通过相对路径查询 svg 图标资源。
link
- 类型：
string
模块的跳转链接，与 entry 互斥。
entry
- 类型：
string
模块的入口文件路径，与 link 互斥，由脚手架自动生成，一般无需修改。
disabled
- 类型：
boolean
模块是否禁用，通常用于禁用 ONES 标品的一些模块。
新增类型的插槽不支持设置 disabled，如果你需要移除已添加的插件模块，你可以将 modules 下对应的模块声明注释或删除掉即可。
manual
- 类型：
boolean
模块是否由用户的特定操作触发，根据特定能力需求配置，一般无需修改。
preload
- 类型：
boolean
模块是否需要预加载，这通常与 manual 配合使用，根据特定能力需求配置，一般无需修改。
moduleType
- 类型：
string
模块类型，可选值详见 插槽模块列表，由脚手架自动生成，一般无需修改。
permission
- 类型：
string
权限标识，与插件 自定义的标准权限点配置 或插件自定义权限点能力配合使用，详情见 插件自定义权限点。
示例：
配合 自定义的标准权限点配置 控制当前模块生效权限，管理员可以在插件权限配置页通过配置「Effective Permission」权限，控制「ones-global-banner-GXvd」模块的生效用户范围。
service:
permission:
- name: Effective Permission
field: my-example-effective-permission-key
desc: This is an example of custom effective permission
modules:
- id: ones-global-banner-GXvd
title: example banner title
moduleType: ones:global:banner
entry: modules/ones-global-banner-GXvd/index.html
permission: my-example-effective-permission-key
needPermissionContext
- 类型：
boolean - ONES 要求: v3.13.59+
权限校验是否依赖页面上下文，为true时，会在页面上下文变动时重新校验一次模块权限，否则，只在首次进入页面时校验一次模块权限，需要与插件自定义权限点能力配合使用，详情见 插件自定义权限点。
enableDelayDestroy
-
类型：
boolean -
ONES 要求:
v3.13.58+
模块是否应该延迟销毁，仅适用于 manual 配置为 true 的插件。
如果您需要延迟销毁模块，您的插件将在 ONES 中激活一段时间。该插件可能会继续从 ONES 接收消息或将消息发送到 ONES（例如，op-store 和 op-event）。您应该卸载插件的根组件来取消这些操作，除了 @ones-design 的 provider，其可以用来弹出 toast 消息。可能你需要使用到OPProvider来实现这个功能。
enableMemoryRouter
-
类型：
boolean -
ONES 要求:
v3.13.58+
在这种路由器模式下，您可以在插件中使用其他第三方路由库。
此路由模式为插件创建了一个新的 location 和 history。插件获取的 URL 是插件模块的入口，并作为查询参数保存在浏览器地址栏中。
在使用该模式之前，您可以通过 window.location.href 获取浏览器地址栏中的真实 URL，开启此模式后，您将无法再依赖于来自此 URL 的数据。
如果你想使用 react-router-dom 中的 BrowserRouter，你需要设置 basename，该值可以通过 window.__op_router_basename__ 获取。
比如:
import { BrowserRouter } from 'react-router-dom'
ReactDOM.render(
<ConfigProvider>
<BrowserRouter basename={window.__op_router_basename__}>
<App />
</BrowserRouter>
</ConfigProvider>,
document.getElementById('ones-mf-root'),
)
或者您可以直接使用 HashRouter。
import { HashRouter } from 'react-router-dom'
ReactDOM.render(
<ConfigProvider>
<HashRouter>
<App />
</HashRouter>
</ConfigProvider>,
document.getElementById('ones-mf-root'),
)
当你在 react 组件中使用 Link 来渲染标签 <a />，并且允许用户通过右键在新标签页中打开链接时，浏览器会打开一个错误的页面，这种场景不推荐使用标签 <a href=""/>。如果你需要跳转到 ONES，并且知道绝对路径，则你可以使用标签 <a href="absolutePath"/>。
modules
- 类型：
modules
插件子模块，由脚手架自动生成，一般无需修改，添加方法详见 添加插槽子模块。
对于比较复杂的需要层级的插槽，可以使用此字段来表示层级关系，比如：我的工作台 应用插槽，可能包括多个顶栏。