echoes/frontend/Requirements/pluginRequirement.ts

// File path: ../Requirements/pluginRequirement.ts

/**
 * 插件配置接口
 * 
 * 该接口定义了插件的基本配置，包括插件的名称、版本、描述、作者等信息。
 * 还包括插件的生命周期钩子和依赖项的配置。
 */
import { SerializeType } from "./generalRequirement";
import { ExtensionProps } from "types/extensionRequirement";
import { useExtention } from "hooks/extensionService";
import { ExtensionService } from "service/extensionService";

export interface PluginConfig {
    name: string;       // 插件名称
    version: string;    // 插件版本
    displayName: string; // 插件显示名称
    description?: string; // 插件描述（可选）
    author?: string;    // 插件作者（可选）
    enabled: boolean;   // 插件是否启用
    icon?: string;      // 插件图标URL（可选）
    managePath?: string; // 插件管理页面路径（可选）
    configuration?: PluginConfiguration; // 插件配置
    hooks?: {
        onInstall?: (context: any) => {}; // 安装时调用的钩子（可选）
        onUninstall?: (context: any) => {}; // 卸载时调用的钩子（可选）
        onEnable?: (context: any) => {}; // 启用时调用的钩子（可选）
        onDisable?: (context: any) => {}; // 禁用时调用的钩子（可选）
    };
    routs: Set<{
        description?: string; // 路由描述（可选）
        path: string; // 路由路径
    }>;
}

/**
 * 插件配置接口
 * 
 * 该接口定义了插件的配置类型及其属性。
 */
export interface PluginConfiguration {
    [key: string]: {
        title: string; // 属性标题
        description?: string; // 属性描述（可选）
        data: SerializeType; // 额外数据（可选），支持序列化
    };
}

export interface PluginDependencies {
    plugins: string[]; // 依赖的插件列表（可选）
    themes: string[];  // 依赖的主题列表（可选）
}

/**
 * 插件属性接口
 * 
 * 该接口定义了插件的属性和行为。
 */
export class usePluginProps implements ExtensionProps {
    private extensionService: ExtensionService = useExtention();
    private dependencies: PluginDependencies;

    constructor(dependencies: PluginDependencies) {
        this.dependencies = dependencies;
    }

    action?: ((...args: any[]) => void); // 动作函数（可选）
    component?: (...args: any[]) => React.FC; // 组件函数（可选）
    text?: (...args: any[]) => string; // 文本生成函数（可选）
}