@deimoscloud/coreai 0.1.15 → 0.1.17

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 and include directives.
+ * 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>;
 /**
@@ -2344,7 +2330,7 @@ declare class StepTracker {
 /**
  * Skill category
  */
-type SkillCategory = 'core' | 'optional' | 'custom';
+type SkillCategory = 'core' | 'custom';
 /**
  * Integration dependency for a skill
  */
@@ -2425,8 +2411,13 @@ interface GenerateSkillsOptions {
      */
     projectRoot?: string;
     /**
-     * Output directory for generated skills
-     * Default: .claude/commands
+     * Path to core skills source directory.
+     * Default: <package>/skills (bundled with CoreAI)
+     */
+    coreSkillsDir?: string;
+    /**
+     * Output directory for generated skills.
+     * Default: .claude/skills
      */
     outputDir?: string;
     /**
@@ -2438,11 +2429,6 @@ interface GenerateSkillsOptions {
      * Default: true
      */
     includeCoreSkills?: boolean;
-    /**
-     * Whether to include optional skills based on integrations
-     * Default: true
-     */
-    includeOptionalSkills?: boolean;
     /**
      * Specific skills to generate (by name)
      * If not specified, generates all applicable skills
@@ -2450,7 +2436,7 @@ interface GenerateSkillsOptions {
     skills?: string[];
     /**
      * Whether to overwrite existing skills
-     * Default: false
+     * Default: true
      */
     overwrite?: boolean;
     /**
@@ -2517,10 +2503,28 @@ interface GenerateSkillsResult {
 /**
  * Skill Generator
  *
- * Generates Claude skills from templates based on project configuration.
- * Skills are output to .claude/commands/ directory.
+ * Discovers skill source files from skills/ directory and compiles them
+ * to .claude/skills/<name>/SKILL.md format for Claude Code.
+ *
+ * Source: skills/<category>/<name>/SKILL.md (grouped by category)
+ * Output: .claude/skills/<name>/SKILL.md (flat, one level deep)
  */
 
+/**
+ * Get the default core skills directory (bundled with CoreAI package)
+ */
+declare function getCoreSkillsDir(): string;
+/**
+ * Discover skill source files from a skills directory.
+ *
+ * Scans skills/<category>/<name>/SKILL.md structure.
+ * Each category directory (core, git, etc.) contains skill directories.
+ */
+declare function discoverSkills(skillsDir: string): SkillTemplate[];
+/**
+ * Parse a SKILL.md file into a SkillTemplate
+ */
+declare function parseSkillFile(name: string, category: SkillCategory, content: string): SkillTemplate;
 /**
  * Extract variables from config for template substitution
  */
@@ -2537,11 +2541,10 @@ declare function checkDependencies(skill: SkillTemplate, config?: ResolvedCoreAI
     missing: SkillDependency[];
 };
 /**
- * Load custom skill templates from a directory
- */
-declare function loadCustomTemplates(templatesDir: string): SkillTemplate[];
-/**
- * Generate skills from templates
+ * Generate skills from source files to Claude Code output format.
+ *
+ * Discovers skills from skills/<category>/<name>/SKILL.md and writes
+ * compiled output to .claude/skills/<name>/SKILL.md (flattened).
  */
 declare function generateSkills(config: ResolvedCoreAIConfig | undefined, options?: GenerateSkillsOptions): GenerateSkillsResult;
 /**
@@ -2549,18 +2552,6 @@ declare function generateSkills(config: ResolvedCoreAIConfig | undefined, option
  */
 declare function formatGenerateResult(result: GenerateSkillsResult): string;
 
-/**
- * Built-in Skill Templates
- *
- * Core skill templates that are included with CoreAI.
- * These templates use {{VARIABLE}} placeholders for substitution.
- */
-
-/**
- * All built-in skill templates
- */
-declare const builtInSkills: SkillTemplate[];
-
 /**
  * KnowledgeLibrary Types
  *
@@ -3038,4 +3029,4 @@ declare function formatAgentKnowledgeState(state: AgentKnowledgeState): string;
  */
 declare const VERSION: string;
 
-export { AGENT_DIRECTORIES, type Adapter, AdapterError, type AdapterErrorCode, AdapterFactory, type AdapterFactoryOptions, type AdapterImplementation, type AdapterInfo, type AdapterType, type AgentContext, type AgentControl, type AgentDefinition, type AgentDirectories, AgentError, type AgentErrorCode, type AgentKnowledgeState, type AgentMetadata, type AgentSource, type AgentType, type BaseAdapter, type BaseCommandOptions, CACHE_PATHS, CONTROL_FILES, type CacheConfig, type CacheEntry, CacheError, type CacheErrorCode, type CacheListOptions, type CacheManager$1 as CacheManager, type CacheManagerOptions, type CacheMetadata, type CacheOptions, type CacheProvider, type CacheSource, type CacheStats, type CacheStatus, type CommandArgumentDefinition, type CommandCategory, type CommandContext, type CommandDefinition, type CommandHandler, type CommandLoadResult, type CommandLoaderOptions, type CommandMetadata, type CommandOptionDefinition, CommandRegistry, type CommandResult, type CompileOptions, type CompileResult, ConfigError, type ConfigErrorCode, type ContextLoadResult, ContextLoader, type ContextLoaderOptions, type ContextSource, type CoreAIConfig, type CreateContextOptions, type CreateIssueData, type CreatePullRequestData, type CreateReviewData, DEFAULT_CACHE_CONFIG, DEFAULT_KNOWLEDGE_LIBRARY_PATH, type Decision, type Dependency, type DocumentationPage, type DocumentationProviderAdapter, type DocumentationQuery, type FetchOptions, CacheManager as FileCacheManager, FileCacheProvider, type FileCacheProviderOptions, type GenerateSkillsOptions, type GenerateSkillsResult, type GeneratedSkill, type GitProviderAdapter, type InitKnowledgeLibraryOptions, type InitKnowledgeLibraryResult, type IntegrationDependency, type IntegrationsConfig, type Issue, type IssueQuery, type IssueStatus, type IssueTrackerAdapter, type KnowledgeLibraryState, type LoadOptions, type MarkdownCommand, type Message, type MessageMetadata, type MessagePriority, type MessageType, type Objective, type ProjectConfig, type PullRequest, type PullRequestQuery, type PullRequestStatus, type QualityGatesConfig, type ReadMessagesOptions, type RegistryEntry, type RemoteFetcher, type ResolutionContext, ResolutionError, type ResolutionOptions, type ResolvedAgentDefinition, type ResolvedCoreAIConfig, type Review, type ReviewComment, type ReviewDecision, type RunCommandOptions, STANDARD_FILES, type SkillCategory, type SkillDependency, type SkillError, type SkillTemplate, type SkillVariables, type StateEntry, type StateOptions, type StateProviderAdapter, StepTracker, type SyncOptions, type SyncResult, type TeamConfig, type TechStackConfig, type UpdateIssueData, VERSION, type WorkflowType, type WriteMessageOptions, agentKnowledgeLibraryExists, builtInSkills, checkDependencies, cleanupContext, compileAgent, compileAgents, configExists, createAdapterFactory, createAdapterInfo, createCacheManager, createCommandContext, createCommandRegistry, createContextLoader, createDegradingHandler, createFileCacheProvider, executeWithDegradation, extractVariables as extractSkillVariables, extractVariables$1 as extractVariables, filterAgentsByTeam, findConfigFile, formatAgentKnowledgeState, formatGenerateResult, formatKnowledgeLibraryState, generateAgentMarkdown, generateMessageFilename, generateSkills, getAgentDirectories, getAgentKnowledgeState, getConfigPath, getCoreAgentsDir, getGlobalRegistry, getKnowledgeLibraryState, getRoleFromFilename, hasVariables, initAgentKnowledgeLibrary, initKnowledgeLibrary, loadAgentFromFile, loadAgentsFromDirectory, loadAllAgents, loadAllCommands, loadCommandFromFile, loadCommandsFromDirectory, loadConfig, loadConfigFromFile, loadCoreAICommands, loadCustomTemplates, markMessageProcessed, parseAgentYaml, readInboxMessages, resetGlobalRegistry, resolveAgentDefinition, resolveObject, resolveString, runCommand, substituteVariables, updateAgentContext, validateAgentDefinition, withContext, writeInboxMessage };
+export { AGENT_DIRECTORIES, type Adapter, AdapterError, type AdapterErrorCode, AdapterFactory, type AdapterFactoryOptions, type AdapterImplementation, type AdapterInfo, type AdapterType, type AgentContext, type AgentControl, type AgentDefinition, type AgentDirectories, AgentError, type AgentErrorCode, type AgentKnowledgeState, type AgentMetadata, type AgentSource, type AgentType, type BaseAdapter, type BaseCommandOptions, CACHE_PATHS, CONTROL_FILES, type CacheConfig, type CacheEntry, CacheError, type CacheErrorCode, type CacheListOptions, type CacheManager$1 as CacheManager, type CacheManagerOptions, type CacheMetadata, type CacheOptions, type CacheProvider, type CacheSource, type CacheStats, type CacheStatus, type CommandArgumentDefinition, type CommandCategory, type CommandContext, type CommandDefinition, type CommandHandler, type CommandLoadResult, type CommandLoaderOptions, type CommandMetadata, type CommandOptionDefinition, CommandRegistry, type CommandResult, type CompileOptions, type CompileResult, ConfigError, type ConfigErrorCode, type ContextLoadResult, ContextLoader, type ContextLoaderOptions, type ContextSource, type CoreAIConfig, type CreateContextOptions, type CreateIssueData, type CreatePullRequestData, type CreateReviewData, DEFAULT_CACHE_CONFIG, DEFAULT_KNOWLEDGE_LIBRARY_PATH, type Decision, type Dependency, type DocumentationPage, type DocumentationProviderAdapter, type DocumentationQuery, type FetchOptions, CacheManager as FileCacheManager, FileCacheProvider, type FileCacheProviderOptions, type GenerateSkillsOptions, type GenerateSkillsResult, type GeneratedSkill, type GitProviderAdapter, type InitKnowledgeLibraryOptions, type InitKnowledgeLibraryResult, type IntegrationDependency, type IntegrationsConfig, type Issue, type IssueQuery, type IssueStatus, type IssueTrackerAdapter, type KnowledgeLibraryState, type LoadOptions, type MarkdownCommand, type Message, type MessageMetadata, type MessagePriority, type MessageType, type Objective, type ProjectConfig, type PullRequest, type PullRequestQuery, type PullRequestStatus, type QualityGatesConfig, type ReadMessagesOptions, type RegistryEntry, type RemoteFetcher, type ResolutionContext, ResolutionError, type ResolutionOptions, type ResolvedAgentDefinition, type ResolvedCoreAIConfig, type Review, type ReviewComment, type ReviewDecision, type RunCommandOptions, STANDARD_FILES, type SkillCategory, type SkillDependency, type SkillError, type SkillTemplate, type SkillVariables, type StateEntry, type StateOptions, type StateProviderAdapter, StepTracker, type SyncOptions, type SyncResult, type TeamConfig, type TechStackConfig, type UpdateIssueData, VERSION, type WorkflowType, type WriteMessageOptions, agentKnowledgeLibraryExists, checkDependencies, cleanupContext, compileAgent, compileAgents, configExists, createAdapterFactory, createAdapterInfo, createCacheManager, createCommandContext, createCommandRegistry, createContextLoader, createDegradingHandler, createFileCacheProvider, discoverSkills, executeWithDegradation, extractVariables as extractSkillVariables, extractVariables$1 as extractVariables, filterAgentsByTeam, findConfigFile, formatAgentKnowledgeState, formatGenerateResult, formatKnowledgeLibraryState, generateAgentMarkdown, generateMessageFilename, generateSkills, getAgentDirectories, getAgentKnowledgeState, getConfigPath, getCoreAgentsDir, getCoreSkillsDir, getGlobalRegistry, getKnowledgeLibraryState, getRoleFromFilename, hasVariables, initAgentKnowledgeLibrary, initKnowledgeLibrary, loadAgentFromFile, loadAgentsFromDirectory, loadAllAgents, loadAllCommands, loadCommandFromFile, loadCommandsFromDirectory, loadConfig, loadConfigFromFile, loadCoreAICommands, markMessageProcessed, parseAgentYaml, parseSkillFile, readInboxMessages, resetGlobalRegistry, resolveAgentDefinition, resolveObject, resolveString, runCommand, substituteVariables, updateAgentContext, validateAgentDefinition, withContext, writeInboxMessage };