pulse-coder-engine 0.0.1-alpha.1 → 0.0.1-alpha.2

package/dist/index.d.ts

@@ -0,0 +1,598 @@
+import { FlexibleSchema, ModelMessage, StepResult, ToolSet, Tool as Tool$1, streamText } from 'ai';
+import { EventEmitter } from 'events';
+import { z } from 'zod';
+
+interface ClarificationRequest {
+    id: string;
+    question: string;
+    context?: string;
+    defaultAnswer?: string;
+    timeout: number;
+}
+interface ToolExecutionContext {
+    onClarificationRequest?: (request: ClarificationRequest) => Promise<string>;
+    abortSignal?: AbortSignal;
+}
+interface Tool<Input = any, Output = any> {
+    name: string;
+    description: string;
+    inputSchema: FlexibleSchema<Input>;
+    execute: (input: Input, context?: ToolExecutionContext) => Promise<Output>;
+}
+interface Context {
+    messages: ModelMessage[];
+}
+interface IPlugin {
+    name: string;
+    version: string;
+    extensions: Extension[];
+    activate(context: IExtensionContext): Promise<void>;
+    deactivate?(): Promise<void>;
+}
+interface Extension {
+    type: 'skill' | 'mcp' | 'tool' | 'context';
+    provider: any;
+}
+interface IExtensionContext {
+    registerTools(toolName: string, tool: Tool<any, any>): void;
+    logger: ILogger;
+}
+interface ILogger {
+    debug(message: string, meta?: Record<string, unknown>): void;
+    info(message: string, meta?: Record<string, unknown>): void;
+    warn(message: string, meta?: Record<string, unknown>): void;
+    error(message: string, error?: Error, meta?: Record<string, unknown>): void;
+}
+
+interface LoopOptions {
+    onText?: (delta: string) => void;
+    onToolCall?: (toolCall: any) => void;
+    onToolResult?: (toolResult: any) => void;
+    onStepFinish?: (step: StepResult<any>) => void;
+    onClarificationRequest?: (request: ClarificationRequest) => Promise<string>;
+    onCompacted?: (newMessages: ModelMessage[]) => void;
+    onResponse?: (messages: StepResult<ToolSet>['response']['messages']) => void;
+    abortSignal?: AbortSignal;
+    tools?: Record<string, Tool>;
+}
+declare function loop(context: Context, options?: LoopOptions): Promise<string>;
+
+interface EnginePlugin {
+    name: string;
+    version: string;
+    dependencies?: string[];
+    beforeInitialize?(context: EnginePluginContext): Promise<void>;
+    initialize(context: EnginePluginContext): Promise<void>;
+    afterInitialize?(context: EnginePluginContext): Promise<void>;
+    destroy?(context: EnginePluginContext): Promise<void>;
+}
+interface EnginePluginContext {
+    registerTool(name: string, tool: Tool$1): void;
+    registerTools(tools: Record<string, Tool$1>): void;
+    getTool(name: string): Tool$1 | undefined;
+    registerProtocol(name: string, handler: ProtocolHandler): void;
+    getProtocol(name: string): ProtocolHandler | undefined;
+    registerService<T>(name: string, service: T): void;
+    getService<T>(name: string): T | undefined;
+    getConfig<T>(key: string): T | undefined;
+    setConfig<T>(key: string, value: T): void;
+    events: EventEmitter;
+    logger: {
+        debug(message: string, meta?: any): void;
+        info(message: string, meta?: any): void;
+        warn(message: string, meta?: any): void;
+        error(message: string, error?: Error, meta?: any): void;
+    };
+}
+interface ProtocolHandler {
+    name: string;
+    handle(message: any): Promise<any>;
+}
+interface EnginePluginLoadOptions {
+    plugins?: EnginePlugin[];
+    dirs?: string[];
+    scan?: boolean;
+}
+
+/**
+ * 用户配置插件接口 - 面向终端用户
+ * 使用声明式配置扩展引擎能力
+ */
+interface UserConfigPlugin {
+    version: string;
+    name?: string;
+    description?: string;
+    tools?: Record<string, ToolConfig>;
+    mcp?: {
+        servers: MCPServerConfig[];
+    };
+    prompts?: {
+        system?: string;
+        user?: string;
+        assistant?: string;
+    };
+    subAgents?: SubAgentConfig[];
+    skills?: {
+        directories?: string[];
+        autoScan?: boolean;
+        cache?: boolean;
+    };
+    env?: Record<string, string>;
+    conditions?: {
+        environment?: string;
+        features?: string[];
+    };
+}
+/**
+ * 工具配置接口
+ */
+declare const ToolConfigSchema: z.ZodObject<{
+    type: z.ZodEnum<{
+        skill: "skill";
+        bash: "bash";
+        http: "http";
+        javascript: "javascript";
+        custom: "custom";
+    }>;
+    command: z.ZodOptional<z.ZodString>;
+    args: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    cwd: z.ZodOptional<z.ZodString>;
+    env: z.ZodOptional<z.ZodAny>;
+    timeout: z.ZodOptional<z.ZodNumber>;
+    method: z.ZodOptional<z.ZodEnum<{
+        GET: "GET";
+        POST: "POST";
+        PUT: "PUT";
+        DELETE: "DELETE";
+        PATCH: "PATCH";
+    }>>;
+    url: z.ZodOptional<z.ZodString>;
+    baseUrl: z.ZodOptional<z.ZodString>;
+    headers: z.ZodOptional<z.ZodAny>;
+    params: z.ZodOptional<z.ZodAny>;
+    data: z.ZodOptional<z.ZodAny>;
+    code: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    enabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    conditions: z.ZodOptional<z.ZodObject<{
+        environment: z.ZodOptional<z.ZodString>;
+        platform: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type ToolConfig = z.infer<typeof ToolConfigSchema>;
+/**
+ * MCP 服务器配置接口
+ */
+declare const MCPServerConfigSchema: z.ZodObject<{
+    name: z.ZodString;
+    command: z.ZodString;
+    args: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    env: z.ZodOptional<z.ZodAny>;
+    cwd: z.ZodOptional<z.ZodString>;
+    timeout: z.ZodOptional<z.ZodNumber>;
+    description: z.ZodOptional<z.ZodString>;
+    enabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>;
+type MCPServerConfig = z.infer<typeof MCPServerConfigSchema>;
+/**
+ * 子代理配置接口
+ */
+declare const SubAgentConfigSchema: z.ZodObject<{
+    name: z.ZodString;
+    trigger: z.ZodArray<z.ZodString>;
+    prompt: z.ZodString;
+    model: z.ZodOptional<z.ZodString>;
+    temperature: z.ZodOptional<z.ZodNumber>;
+    maxTokens: z.ZodOptional<z.ZodNumber>;
+    tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    enabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>;
+type SubAgentConfig = z.infer<typeof SubAgentConfigSchema>;
+/**
+ * 用户配置插件加载选项
+ */
+interface UserConfigPluginLoadOptions {
+    configs?: UserConfigPlugin[];
+    dirs?: string[];
+    scan?: boolean;
+}
+
+interface StreamOptions {
+    abortSignal?: AbortSignal;
+    onStepFinish?: (event: StepResult<any>) => void;
+    onChunk?: (event: {
+        chunk: any;
+    }) => void;
+    toolExecutionContext?: ToolExecutionContext;
+}
+declare const streamTextAI: (messages: ModelMessage[], tools: Record<string, Tool>, options?: StreamOptions) => ReturnType<typeof streamText> & {
+    steps: StepResult<any>[];
+    finishReason: string;
+};
+
+type CompactResult = {
+    didCompact: boolean;
+    reason?: string;
+    newMessages?: ModelMessage[];
+};
+declare const maybeCompactContext: (context: Context, options?: {
+    force?: boolean;
+}) => Promise<CompactResult>;
+
+interface ClarifyInput {
+    question: string;
+    context?: string;
+    defaultAnswer?: string;
+    timeout?: number;
+}
+interface ClarifyOutput {
+    answer: string;
+    timedOut: boolean;
+}
+declare const ClarifyTool: Tool<ClarifyInput, ClarifyOutput>;
+
+declare const ReadTool: Tool<{
+    filePath: string;
+    offset?: number;
+    limit?: number;
+}, {
+    content: string;
+    totalLines?: number;
+}>;
+
+declare const WriteTool: Tool<{
+    filePath: string;
+    content: string;
+}, {
+    success: boolean;
+    created: boolean;
+    bytes: number;
+}>;
+
+declare const EditTool: Tool<{
+    filePath: string;
+    oldString: string;
+    newString: string;
+    replaceAll?: boolean;
+}, {
+    success: boolean;
+    replacements: number;
+    preview?: string;
+}>;
+
+declare const GrepTool: Tool<{
+    pattern: string;
+    path?: string;
+    glob?: string;
+    type?: string;
+    outputMode?: 'content' | 'files_with_matches' | 'count';
+    context?: number;
+    caseInsensitive?: boolean;
+    headLimit?: number;
+    offset?: number;
+    multiline?: boolean;
+}, {
+    output: string;
+    matches?: number;
+}>;
+
+declare const LsTool: Tool<{
+    path?: string;
+}, {
+    files: string[];
+}>;
+
+declare const BashTool: Tool<{
+    command: string;
+    timeout?: number;
+    cwd?: string;
+    description?: string;
+}, {
+    output: string;
+    error?: string;
+    exitCode?: number;
+}>;
+
+declare const TavilyTool: Tool<{
+    query: string;
+    maxResults?: number;
+}, {
+    results: Array<{
+        title: string;
+        url: string;
+        content: string;
+        score?: number;
+    }>;
+}>;
+
+declare const BuiltinTools: readonly [Tool<{
+    filePath: string;
+    offset?: number;
+    limit?: number;
+}, {
+    content: string;
+    totalLines?: number;
+}>, Tool<{
+    filePath: string;
+    content: string;
+}, {
+    success: boolean;
+    created: boolean;
+    bytes: number;
+}>, Tool<{
+    filePath: string;
+    oldString: string;
+    newString: string;
+    replaceAll?: boolean;
+}, {
+    success: boolean;
+    replacements: number;
+    preview?: string;
+}>, Tool<{
+    pattern: string;
+    path?: string;
+    glob?: string;
+    type?: string;
+    outputMode?: "content" | "files_with_matches" | "count";
+    context?: number;
+    caseInsensitive?: boolean;
+    headLimit?: number;
+    offset?: number;
+    multiline?: boolean;
+}, {
+    output: string;
+    matches?: number;
+}>, Tool<{
+    path?: string;
+}, {
+    files: string[];
+}>, Tool<{
+    command: string;
+    timeout?: number;
+    cwd?: string;
+    description?: string;
+}, {
+    output: string;
+    error?: string;
+    exitCode?: number;
+}>, Tool<{
+    query: string;
+    maxResults?: number;
+}, {
+    results: Array<{
+        title: string;
+        url: string;
+        content: string;
+        score?: number;
+    }>;
+}>, Tool<ClarifyInput, ClarifyOutput>];
+declare const BuiltinToolsMap: Record<string, any>;
+declare const getFinalToolsMap: (customTools?: Record<string, Tool$1>) => Record<string, any>;
+
+/**
+ * 引擎配置选项
+ */
+interface EngineOptions {
+    enginePlugins?: EnginePluginLoadOptions;
+    userConfigPlugins?: UserConfigPluginLoadOptions;
+    disableBuiltInPlugins?: boolean;
+    config?: Record<string, any>;
+}
+/**
+ * 重构后的引擎类
+ * 自动包含内置插件，支持可选禁用
+ */
+declare class Engine {
+    private pluginManager;
+    private tools;
+    private options;
+    private config;
+    constructor(options?: EngineOptions);
+    /**
+     * 初始化引擎和插件系统
+     * 自动包含内置插件
+     */
+    initialize(): Promise<void>;
+    /**
+     * 准备引擎插件列表（包含内置插件）
+     */
+    private prepareEnginePlugins;
+    /**
+     * 运行AI循环
+     */
+    run(context: Context, options?: LoopOptions): Promise<string>;
+    /**
+     * 获取插件状态
+     */
+    getPluginStatus(): {
+        enginePlugins: string[];
+        userConfigPlugins: string[];
+        tools: string[];
+        services: string[];
+        protocols: string[];
+    };
+    /**
+     * 获取工具
+     */
+    getTools(): Record<string, any>;
+    /**
+     * 获取服务
+     */
+    getService<T>(name: string): T | undefined;
+    /**
+     * 获取配置
+     */
+    getConfig<T>(key: string): T | undefined;
+    /**
+     * 设置配置
+     */
+    setConfig<T>(key: string, value: T): void;
+}
+
+/**
+ * 插件管理器 - 管理双轨插件系统
+ */
+declare class PluginManager {
+    private enginePlugins;
+    private userConfigPlugins;
+    private tools;
+    private services;
+    private protocols;
+    private config;
+    private events;
+    private logger;
+    /**
+     * 初始化插件系统
+     */
+    initialize(options?: {
+        enginePlugins?: EnginePluginLoadOptions;
+        userConfigPlugins?: UserConfigPluginLoadOptions;
+    }): Promise<void>;
+    /**
+     * 加载引擎插件
+     */
+    private loadEnginePlugins;
+    /**
+     * 扫描引擎插件目录
+     */
+    private scanEnginePlugins;
+    /**
+     * 加载单个引擎插件文件
+     */
+    private loadEnginePluginFile;
+    /**
+     * 初始化单个引擎插件
+     */
+    private initializeEnginePlugin;
+    /**
+     * 加载用户配置插件
+     */
+    private loadUserConfigPlugins;
+    /**
+     * 扫描用户配置插件目录
+     */
+    private scanUserConfigPlugins;
+    /**
+     * 加载单个用户配置文件
+     */
+    private loadUserConfigFile;
+    /**
+     * 应用用户配置
+     */
+    private applyUserConfig;
+    /**
+     * 验证核心能力
+     */
+    private validateCoreCapabilities;
+    /**
+     * 插件依赖排序
+     */
+    private sortPluginsByDependencies;
+    /**
+     * 工具获取
+     */
+    getTools(): Record<string, any>;
+    /**
+     * 服务获取
+     */
+    getService<T>(name: string): T | undefined;
+    /**
+     * 协议获取
+     */
+    getProtocol(name: string): any;
+    /**
+     * 获取插件状态
+     */
+    getStatus(): {
+        enginePlugins: string[];
+        userConfigPlugins: string[];
+        tools: string[];
+        services: string[];
+        protocols: string[];
+    };
+    /**
+     * 解析路径（支持 ~ 和相对路径）
+     */
+    private resolvePath;
+}
+
+declare class SubAgentPlugin implements EnginePlugin {
+    name: string;
+    version: string;
+    private configLoader;
+    private agentRunner;
+    initialize(context: EnginePluginContext): Promise<void>;
+    private getAvailableTools;
+    private registerAgentTool;
+    destroy(context: EnginePluginContext): Promise<void>;
+}
+
+/**
+ * Built-in MCP Plugin for Pulse Coder Engine
+ * 将 MCP 功能作为引擎内置插件
+ */
+
+declare const builtInMCPPlugin: EnginePlugin;
+
+/**
+ * Built-in Skills Plugin for Pulse Coder Engine
+ * 将技能系统作为引擎内置插件
+ */
+
+/**
+ * 技能信息接口
+ */
+interface SkillInfo {
+    name: string;
+    description: string;
+    location: string;
+    content: string;
+    metadata?: Record<string, any>;
+}
+/**
+ * 技能注册表
+ */
+declare class BuiltInSkillRegistry {
+    private skills;
+    private initialized;
+    /**
+     * 初始化注册表，扫描并加载所有技能
+     */
+    initialize(cwd: string): Promise<void>;
+    /**
+     * 扫描技能文件
+     */
+    private scanSkills;
+    /**
+     * 解析技能文件
+     */
+    private parseSkillFile;
+    /**
+     * 获取所有技能
+     */
+    getAll(): SkillInfo[];
+    /**
+     * 根据名称获取技能
+     */
+    get(name: string): SkillInfo | undefined;
+    /**
+     * 检查技能是否存在
+     */
+    has(name: string): boolean;
+    /**
+     * 搜索技能（模糊匹配）
+     */
+    search(keyword: string): SkillInfo[];
+}
+/**
+ * 内置技能插件
+ */
+declare const builtInSkillsPlugin: EnginePlugin;
+
+/**
+ * 默认内置插件列表
+ * 这些插件会在引擎启动时自动加载
+ */
+declare const builtInPlugins: (EnginePlugin | SubAgentPlugin)[];
+
+export { BashTool, BuiltInSkillRegistry, BuiltinTools, BuiltinToolsMap, type ClarificationRequest, ClarifyTool, type Context, EditTool, Engine, type EnginePlugin, type EnginePluginContext, type Extension, GrepTool, type IExtensionContext, type ILogger, type IPlugin, LsTool, PluginManager, Engine as PulseAgent, ReadTool, TavilyTool, type Tool, type ToolExecutionContext, type UserConfigPlugin, type UserConfigPluginLoadOptions, WriteTool, builtInMCPPlugin, builtInPlugins, builtInSkillsPlugin, getFinalToolsMap, loop, maybeCompactContext, streamTextAI };