@deimoscloud/coreai 0.1.15 → 0.1.16

package/dist/index.d.ts

@@ -165,13 +165,17 @@ declare function getConfigPath(startDir?: string): string | null;
  *
  * TypeScript types corresponding to the JSON schema at schemas/agent.schema.json
  */
+/** @deprecated Used only for YAML backward compatibility. Will be removed when YAML support is dropped. */
 type AgentType = 'ic-engineer' | 'manager' | 'specialist' | 'coordinator';
+/** @deprecated Used only for YAML backward compatibility. Will be removed when YAML support is dropped. */
 type WorkflowType = 'ticket-implementation' | 'bug-investigation' | 'code-review' | 'planning-estimation' | 'product-planning';
+/** @deprecated Used only for YAML backward compatibility. Will be removed when YAML support is dropped. */
 interface AgentExpertise {
     primary?: string[];
     tech_stack?: string;
     [key: string]: unknown;
 }
+/** @deprecated Used only for YAML backward compatibility. Will be removed when YAML support is dropped. */
 interface AgentPrinciples {
     code_quality?: string[];
     testing?: string[];
@@ -179,30 +183,32 @@ interface AgentPrinciples {
     performance?: string[];
     [key: string]: string[] | undefined;
 }
+/** @deprecated Used only for YAML backward compatibility. Will be removed when YAML support is dropped. */
 interface AgentBehaviors {
     workflow?: WorkflowType;
     quality_gates?: string;
     [key: string]: unknown;
 }
-/**
- * @deprecated Use AgentKnowledgeLibrary instead
- */
+/** @deprecated Used only for YAML backward compatibility. Will be removed when YAML support is dropped. */
 interface AgentContextSources {
     shared?: string[];
     personal?: string[];
 }
+/** @deprecated Used only for YAML backward compatibility. Will be removed when YAML support is dropped. */
 interface AgentKnowledgeLibraryControl {
     objectives?: string;
     decisions?: string;
     dependencies?: string;
     index?: string;
 }
+/** @deprecated Used only for YAML backward compatibility. Will be removed when YAML support is dropped. */
 interface AgentKnowledgeLibraryShared {
     context?: string;
     architecture?: string;
     prd?: string;
     remote?: string[];
 }
+/** @deprecated Used only for YAML backward compatibility. Will be removed when YAML support is dropped. */
 interface AgentKnowledgeLibraryPersonal {
     context?: string;
     history?: string;
@@ -211,10 +217,12 @@ interface AgentKnowledgeLibraryPersonal {
     tech?: string;
     control?: AgentKnowledgeLibraryControl;
 }
+/** @deprecated Used only for YAML backward compatibility. Will be removed when YAML support is dropped. */
 interface AgentKnowledgeLibrary {
     shared?: AgentKnowledgeLibraryShared;
     personal?: AgentKnowledgeLibraryPersonal;
 }
+/** @deprecated Used only for YAML backward compatibility. Will be removed when YAML support is dropped. */
 interface AgentCommunication {
     inbox?: string;
     outbox?: string;
@@ -222,31 +230,43 @@ interface AgentCommunication {
     outbox_format?: string;
     processed_dir?: string;
 }
+/** @deprecated Used only for YAML backward compatibility. Will be removed when YAML support is dropped. */
 interface AgentStartupProtocol {
     first_session?: string[];
     subsequent?: string[];
 }
+/** @deprecated Used only for YAML backward compatibility. Will be removed when YAML support is dropped. */
 interface AgentProtocols {
     startup?: AgentStartupProtocol;
     completion?: string[];
 }
 /**
- * Raw agent definition as loaded from YAML (before variable resolution)
+ * Agent definition.
+ * For MD agents: role, type, display_name, description, tools are used.
+ * For deprecated YAML agents: all fields may be populated.
  */
 interface AgentDefinition {
     role: string;
     type: AgentType;
     display_name: string;
     description: string;
+    /** @deprecated YAML-only. In MD agents, responsibilities are in the template body. */
     responsibilities?: string[];
+    /** @deprecated YAML-only. In MD agents, expertise is in the template body. */
     expertise?: AgentExpertise;
+    /** @deprecated YAML-only. In MD agents, skills are in the template body. */
     skills?: string[];
+    /** @deprecated YAML-only. In MD agents, principles are in the template body. */
     principles?: AgentPrinciples;
+    /** @deprecated YAML-only. In MD agents, behaviors are in the template body. */
     behaviors?: AgentBehaviors;
-    /** @deprecated Use knowledge_library instead */
+    /** @deprecated YAML-only. Use knowledge_library or MD template body instead. */
     context_sources?: AgentContextSources;
+    /** @deprecated YAML-only. In MD agents, knowledge library structure is in the template body. */
     knowledge_library?: AgentKnowledgeLibrary;
+    /** @deprecated YAML-only. In MD agents, communication details are in the template body. */
     communication?: AgentCommunication;
+    /** @deprecated YAML-only. In MD agents, protocols are in the template body. */
     protocols?: AgentProtocols;
     /**
      * Claude Code tools available to this agent.
@@ -255,7 +275,7 @@ interface AgentDefinition {
     tools?: string[];
 }
 /**
- * Agent definition after variable resolution
+ * @deprecated Used only for YAML backward compatibility.
  */
 interface ResolvedAgentDefinition extends AgentDefinition {
     expertise?: AgentExpertise & {
@@ -281,7 +301,8 @@ interface AgentMetadata {
 /**
  * Agent Loader
  *
- * Handles loading and validating agent YAML definitions.
+ * Handles loading agent definitions from Markdown templates (primary)
+ * and YAML files (deprecated, backward compatible).
  */
 
 declare class AgentError extends Error {
@@ -292,14 +313,17 @@ declare class AgentError extends Error {
 type AgentErrorCode = 'NOT_FOUND' | 'PARSE_ERROR' | 'VALIDATION_ERROR' | 'READ_ERROR';
 /**
  * Parse YAML content into an agent definition
+ * @deprecated Use Markdown agent files instead
  */
 declare function parseAgentYaml(content: string, filePath?: string): unknown;
 /**
  * Validate parsed YAML against agent schema
+ * @deprecated Use Markdown agent files instead
  */
 declare function validateAgentDefinition(agent: unknown): AgentDefinition;
 /**
- * Load and validate an agent definition from a file
+ * Load an agent definition from a file (MD or YAML).
+ * MD files are the primary format. YAML files are deprecated but supported.
  */
 declare function loadAgentFromFile(filePath: string): AgentDefinition;
 /**
@@ -368,60 +392,30 @@ declare function resolveAgentDefinition(agent: AgentDefinition, config?: CoreAIC
 /**
  * Agent Compiler
  *
- * Transforms YAML agent definitions into Claude-compatible Markdown files.
+ * Processes agent Markdown templates with variable substitution.
+ * For deprecated YAML agents, falls back to structural transformation.
  */
 
 /**
  * Options for compiling agents
  */
 interface CompileOptions {
-    /**
-     * Output directory for compiled markdown files.
-     * Default: .claude/agents
-     */
     outputDir?: string;
-    /**
-     * Core agents directory (built-in agents).
-     * Default: uses package's agents/ directory
-     */
     coreAgentsDir?: string;
-    /**
-     * Custom agents directory (project-specific agents).
-     * Default: coreai/agents in project root
-     */
     customAgentsDir?: string;
-    /**
-     * Project root directory.
-     * Default: process.cwd()
-     */
     projectRoot?: string;
-    /**
-     * Filter function to select which agents to compile.
-     * Returns true to include the agent, false to exclude.
-     */
     filter?: (agent: AgentDefinition) => boolean;
-    /**
-     * MCP server names to include as tools.
-     * These will be added to the agent's tools as mcp__<server-name>.
-     * Example: ['github', 'postgres'] -> 'mcp__github, mcp__postgres'
-     */
     mcpServers?: string[];
 }
 /**
  * Result of compiling agents
  */
 interface CompileResult {
-    /**
-     * Successfully compiled agents
-     */
     compiled: {
         role: string;
         source: AgentSource;
         outputPath: string;
     }[];
-    /**
-     * Agents that failed to compile
-     */
     errors: {
         role: string;
         source: AgentSource;
@@ -429,30 +423,22 @@ interface CompileResult {
     }[];
 }
 /**
- * Generate markdown content from a resolved agent definition
- *
- * The output includes YAML frontmatter required by Claude Code for subagent detection.
- * See: https://code.claude.com/docs/en/sub-agents
- *
- * @param agent - Resolved agent definition
- * @param mcpServers - Optional MCP server names to include as tools
+ * Generate markdown content from a resolved YAML agent definition.
+ * @deprecated Use MD templates instead. This exists for backward compatibility with YAML agents.
  */
 declare function generateAgentMarkdown(agent: AgentDefinition, mcpServers?: string[]): string;
 /**
- * Compile a single agent to markdown
- *
- * @param agent - Agent definition to compile
- * @param config - Optional CoreAI config for variable resolution
- * @param mcpServers - Optional MCP server names to include as tools
+ * Compile a single agent.
+ * MD templates use simple variable substitution.
+ * YAML files use the deprecated structural transformation.
  */
-declare function compileAgent(agent: AgentDefinition, config?: CoreAIConfig, mcpServers?: string[]): string;
+declare function compileAgent(agent: AgentDefinition, filePath: string, config?: CoreAIConfig, mcpServers?: string[]): string;
 /**
  * Load all agents from core and custom directories
  */
 declare function loadAllAgents(options?: CompileOptions): Map<string, AgentMetadata>;
 /**
- * Filter agents based on team configuration.
- * Custom and override agents are always included regardless of team filter.
+ * Filter agents based on team configuration
  */
 declare function filterAgentsByTeam(agents: Map<string, AgentMetadata>, config?: CoreAIConfig): Map<string, AgentMetadata>;
 /**