@comate/zulu 0.0.9 → 0.0.12

package/comate-engine/node_modules/@comate/plugin-engine/dist/index.d.ts

@@ -0,0 +1,188 @@
+/// <reference types="node" />
+import * as _comate_plugin_shared_internals from '@comate/plugin-shared-internals';
+import { Channel, SessionInit, Session, ACTION_CHAT_TASK_PROGRESS, TaskProgressPayload, ACTION_REQUEST_PERMISSION, RequestPermissionPayload, ACTION_ASK_LLM, LlmPayload, ACTION_ASK_RAG, RAGPayload, ACTION_ASK_LLM_STREAMING, ACTION_GET_PLUGIN_CONFIG, GetPluginConfigPayload, ACTION_INFORMATION_QUERY, InformationPayload, ACTION_DIAGNOSTIC_SCAN_TASK_PROGRESS, DiagnosticScanTaskProgressPayload, ACTION_DIAGNOSTIC_SCAN_TASK_COUNT, DiagnosticScanCountPayload, ACTION_SECUBOT_TASK_PROGRESS, SecubotQueryPayload, ACTION_DEBUG_TASK_PROCESS, DebugAgentPluginPayload, ACTION_CODE_SEARCH, CodeSearchPayload, ACTION_BATCH_ACCEPT, BatchAcceptPayload, ACTION_ISCAN_RESULT, IScanResultPayload, ACTION_ISCAN_JOB_BUILD_ID, IScanJobBuildPayload, ACTION_SA_SCAN_DIAGNOSTIC_RESULT, SAScanDiagnosticResult, ACTION_PLUS_MODULE_LIST_RESULT, PlusModuleListResultPayload, PluginDescription, DiagnosticScanPayload, DiagnosticScanTaskProgressChunk, ActivationContext, DiagnosticCacheValue, DiagnosticScanChangedFiles, ModelOptions, ChannelImplementMaybe, QuerySelectorPayload } from '@comate/plugin-shared-internals';
+import * as execa from 'execa';
+import { ChildProcess } from 'node:child_process';
+
+interface PayloadMap {
+    [ACTION_CHAT_TASK_PROGRESS]: TaskProgressPayload;
+    [ACTION_REQUEST_PERMISSION]: RequestPermissionPayload;
+    [ACTION_ASK_LLM]: LlmPayload;
+    [ACTION_ASK_RAG]: RAGPayload;
+    [ACTION_ASK_LLM_STREAMING]: LlmPayload;
+    [ACTION_GET_PLUGIN_CONFIG]: GetPluginConfigPayload;
+    [ACTION_INFORMATION_QUERY]: InformationPayload;
+    [ACTION_DIAGNOSTIC_SCAN_TASK_PROGRESS]: DiagnosticScanTaskProgressPayload;
+    [ACTION_DIAGNOSTIC_SCAN_TASK_COUNT]: DiagnosticScanCountPayload;
+    [ACTION_SECUBOT_TASK_PROGRESS]: SecubotQueryPayload;
+    [ACTION_DEBUG_TASK_PROCESS]: DebugAgentPluginPayload;
+    [ACTION_CODE_SEARCH]: CodeSearchPayload;
+    [ACTION_BATCH_ACCEPT]: BatchAcceptPayload;
+    [ACTION_ISCAN_RESULT]: IScanResultPayload;
+    [ACTION_ISCAN_JOB_BUILD_ID]: IScanJobBuildPayload;
+    [ACTION_SA_SCAN_DIAGNOSTIC_RESULT]: SAScanDiagnosticResult;
+    [ACTION_PLUS_MODULE_LIST_RESULT]: PlusModuleListResultPayload;
+}
+/**
+ * 处理Engine与插件之间的会话
+ */
+declare class PluginSession extends Session<PayloadMap> {
+    protected initializeListeners(): void;
+}
+declare class PluginChannel extends Channel<PluginSession> {
+    protected createSession(init: SessionInit): PluginSession;
+}
+
+interface PluginInitContext {
+    description: PluginDescription;
+    directory: string;
+    inspectPort?: number;
+}
+interface AttachedPlugin extends PluginInitContext {
+    onSetup: ((channel: PluginChannel) => void) | undefined;
+    onExit: (() => void) | undefined;
+}
+interface PluginGroupValue {
+    channel: PluginChannel;
+}
+interface PluginGroup<G extends PluginGroupValue = PluginGroupValue> {
+    key: string;
+    value: G;
+    inspectPort?: number;
+    plugins: Map<string, AttachedPlugin>;
+}
+interface PluginSetupContext {
+    description: PluginDescription;
+    directory: string;
+    inspectPort?: number;
+}
+interface GroupJoinOptions {
+    onExit?: AttachedPlugin['onExit'];
+    onSetup?: AttachedPlugin['onSetup'];
+}
+declare abstract class ChannelGroupManager<G extends PluginGroupValue = PluginGroupValue> {
+    protected readonly groups: Map<string, PluginGroup<G>>;
+    joinGroup(setupContext: PluginSetupContext, { onExit, onSetup }: GroupJoinOptions): Promise<void>;
+    exitGroup(setupContext: PluginSetupContext): Promise<void>;
+    protected createGroup(groupKey: string, inspectPort?: number): PluginGroup<G>;
+    /**
+     * 插件加入到分组后的逻辑钩子
+     *
+     * @param group 插件加入的分组
+     * @param plugin 插件信息
+     */
+    protected abstract onPluginJoinGroup(group: PluginGroup<G>, plugin: PluginSetupContext): Promise<void>;
+    /**
+     * 插件从分组移除后的逻辑钩子
+     *
+     * @param group 插件加入的分组
+     * @param plugin 插件信息
+     */
+    protected abstract onPluginExitGroup(group: PluginGroup<G>, plugin: PluginSetupContext): Promise<void>;
+    /**
+     * 销毁一个分组，通常在所有插件都已经从中移除后调用
+     *
+     * @param group 待销毁的分组
+     */
+    protected abstract destroyGroup(group: PluginGroup<G>): void;
+    /**
+     * 通过插件信息计算出分组的键名
+     *
+     * @param context 插件信息
+     */
+    protected abstract getGroupKey(context: PluginSetupContext): string;
+    /**
+     * 创建分组的具体实现
+     *
+     * @param groupKey 分级键
+     * @param inspectPort 调试用监听端口
+     */
+    protected abstract createGroupValue(groupKey: string, inspectPort?: number): G;
+}
+
+interface PluginProcessForkOptions {
+    nodeOptions?: string[];
+    onUnexpectedExit?: (code: number) => void;
+    onUnexpectedError?: (error: Error) => void;
+    onPluginSetup?: (pluginName: string) => void;
+}
+declare function forkPluginProcess(groupKey: string, options: PluginProcessForkOptions): execa.ExecaChildProcess<string>;
+interface PluginSetupInput {
+    name: string;
+    directory: string;
+}
+declare function invokePluginSetupToProcess(process: ChildProcess, input: PluginSetupInput): Promise<void>;
+
+declare abstract class DiagnosticCache {
+    private readonly deletedFilePath;
+    private readonly diagnosticCache;
+    start(payload: DiagnosticScanPayload): Promise<void>;
+    put(chunk: DiagnosticScanTaskProgressChunk): void;
+    get(payload: DiagnosticScanPayload & {
+        context: ActivationContext;
+    }): DiagnosticCacheValue | undefined;
+    hasDiagnostics(): boolean;
+    private isDirectory;
+    private isModifiedRecently;
+    private isAddedRecently;
+    private getChangedFiles;
+    private watch;
+    protected abstract handleChangedFiles(payload: DiagnosticScanPayload, changedFiles: DiagnosticScanChangedFiles): Promise<void>;
+    protected abstract init(payload: DiagnosticScanPayload): Promise<void>;
+    protected abstract beforeGet(payload: DiagnosticScanPayload & {
+        context: ActivationContext;
+    }): void;
+}
+
+interface ChatMessage {
+    role: 'user' | 'assistant';
+    content: string;
+    originalQuery?: string;
+}
+declare class ConversationBufferMemory {
+    private readonly conversationBuffer;
+    private readonly cleanupInterval;
+    constructor();
+    dispose(): void;
+    clear(conversationId?: string): void;
+    get(conversationId: string): ChatMessage[];
+    putUser(enableMultiturnDialogue: ModelOptions['enableMultiturnDialogue'], conversationId: string, message: ChatMessage): void;
+    putAssistant(conversationId: string, content: string): void;
+    getConversationId(enableMultiturnDialogue: ModelOptions['enableMultiturnDialogue'], pluginName: string, capabilityName: string): string;
+    trimConversation(conversationId: string, maxChars?: number): ChatMessage[] | null;
+    private cleanup;
+    private getTotalChars;
+}
+
+interface EngineInit {
+    pluginDirectories: string[];
+    channelGroupManager: ChannelGroupManager;
+    channel: ChannelImplementMaybe;
+    localConfig?: Record<string, any>;
+}
+declare class PluginEngine {
+    private readonly channelGroupManager;
+    private readonly registry;
+    private readonly plugins;
+    private readonly ideChannel;
+    private readonly pluginDirectories;
+    private readonly localConfig?;
+    constructor(init: EngineInit);
+    /**
+     * 启动插件引擎
+     *
+     * @param entryDirectory 放置所有插件的目录
+     */
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    /**
+     * 获取所有插件注册的能力
+     *
+     * @returns 全部能力的数组
+     */
+    listAllCapabilities(): _comate_plugin_shared_internals.ProviderCapabilityInfo[];
+    suggestCapabilitiesByMatch(payload: QuerySelectorPayload): Promise<_comate_plugin_shared_internals.ProviderCapabilityInfo[]>;
+    private run;
+}
+
+export { ChannelGroupManager, type ChatMessage, ConversationBufferMemory, DiagnosticCache, type EngineInit, PluginChannel, PluginEngine, type PluginGroup, type PluginGroupValue, type PluginSetupContext, forkPluginProcess, invokePluginSetupToProcess };