44 lines
1.4 KiB
TypeScript
44 lines
1.4 KiB
TypeScript
// File path: contracts\pluginContract.ts
|
||
|
||
/**
|
||
* 插件配置接口
|
||
*
|
||
* 该接口定义了插件的基本配置，包括插件的名称、版本、描述、作者等信息。
|
||
* 还包括插件的生命周期钩子和依赖项的配置。
|
||
*/
|
||
import { SerializeType } from "contracts/generalContract";
|
||
import { CapabilityProps } from "contracts/capabilityContract";
|
||
|
||
|
||
export interface PluginConfig {
|
||
name: string; // 插件名称
|
||
version: string; // 插件版本
|
||
displayName: string; // 插件显示名称
|
||
description?: string; // 插件描述（可选）
|
||
author?: string; // 插件作者（可选）
|
||
enabled: boolean; // 插件是否启用
|
||
icon?: string; // 插件图标URL（可选）
|
||
managePath?: string; // 插件管理页面路径（可选）
|
||
configuration?: PluginConfiguration; // 插件配置
|
||
/** 声明需要使用的能力，没有实际作用 */
|
||
capabilities?: Set<CapabilityProps<void>>;
|
||
routs: Set<{
|
||
description?: string; // 路由描述（可选）
|
||
path: string; // 路由路径
|
||
}>;
|
||
}
|
||
|
||
/**
|
||
* 插件配置接口
|
||
*
|
||
* 该接口定义了插件的配置类型及其属性。
|
||
*/
|
||
export interface PluginConfiguration {
|
||
[key: string]: {
|
||
title: string; // 属性标题
|
||
description?: string; // 属性描述（可选）
|
||
data: SerializeType; // 额外数据（可选），支持序列化
|
||
};
|
||
}
|
||
|