@qlucent/fishi-core 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,458 @@
+type ProjectType = 'greenfield' | 'brownfield' | 'hybrid';
+type CostMode = 'performance' | 'balanced' | 'economy';
+type ModelTier = 'opus' | 'sonnet' | 'haiku';
+type TaskStatus = 'backlog' | 'ready' | 'in_progress' | 'review' | 'done' | 'blocked';
+type GateStatus = 'pending' | 'approved' | 'rejected' | 'skipped';
+type AgentRole = 'master' | 'coordinator' | 'worker';
+interface FishiConfig {
+    version: string;
+    project: ProjectConfig;
+    execution: ExecutionConfig;
+    cost_mode: CostMode;
+    model_routing: ModelRoutingConfig;
+    git: GitConfig;
+    gates: GateConfig;
+    taskboard: TaskboardConfig;
+    state: StateConfig;
+    dynamic_agents: DynamicAgentConfig;
+    mcp: McpConfig;
+    plugins: string[];
+}
+interface ProjectConfig {
+    name: string;
+    description: string;
+    type: ProjectType;
+    language?: string;
+    framework?: string;
+}
+interface ExecutionConfig {
+    mode: 'cli' | 'headless' | 'api';
+    parallel: boolean;
+    max_parallel: number;
+}
+interface ModelRoutingConfig {
+    opus: string[];
+    sonnet: string[];
+    haiku: string[];
+}
+interface GitConfig {
+    strategy: 'auto' | 'single-branch' | 'milestone-branch' | 'worktree-per-agent';
+    main_branch: string;
+    dev_branch: string;
+    worktree_dir: string;
+    auto_commit: boolean;
+    commit_prefix: boolean;
+}
+interface GateConfig {
+    enabled: boolean;
+    gate_points: string[];
+}
+interface TaskboardConfig {
+    enabled: boolean;
+    auto_update: boolean;
+    sprint_duration: 'auto' | '1week' | '2weeks';
+}
+interface StateConfig {
+    checkpoint_on_stop: boolean;
+    max_checkpoints: number;
+    compress_after_sprint: boolean;
+}
+interface DynamicAgentConfig {
+    enabled: boolean;
+    require_approval: boolean;
+}
+interface McpConfig {
+    auto_discover: boolean;
+    core: string[];
+    project: McpServerConfig[];
+    agent_access: Record<string, string[]>;
+}
+interface McpServerConfig {
+    name: string;
+    env?: Record<string, string>;
+}
+interface AgentDefinition {
+    name: string;
+    description: string;
+    role: AgentRole;
+    tools: string[];
+    model: ModelTier;
+    isolation?: 'worktree';
+    manages?: string[];
+    reports_to?: string;
+}
+interface DetectionResult {
+    type: ProjectType;
+    checks: DetectionCheck[];
+    confidence: number;
+}
+interface DetectionCheck {
+    check: string;
+    passed: boolean;
+    evidence?: string;
+}
+interface InitOptions {
+    description?: string;
+    interactive: boolean;
+    costMode: CostMode;
+    language?: string;
+    framework?: string;
+}
+
+interface TemplateContext {
+    projectName: string;
+    projectDescription: string;
+    projectType: string;
+    language?: string;
+    framework?: string;
+    costMode: string;
+    timestamp: string;
+}
+interface AgentTemplate {
+    filename: string;
+    content: string;
+    directory: 'agents' | 'agents/coordinators';
+}
+interface SkillTemplate {
+    directory: string;
+    files: Record<string, string>;
+}
+interface HookTemplate {
+    filename: string;
+    content: string;
+}
+interface CommandTemplate {
+    filename: string;
+    content: string;
+}
+
+/**
+ * Master Orchestrator Agent Template
+ *
+ * The top-level agent in the FISHI hierarchy. Runs on Opus.
+ * Responsible for phase transitions, gate management, coordinator delegation,
+ * and project-level decision-making. Does NOT perform operational work directly.
+ */
+declare function getMasterOrchestratorTemplate(): string;
+
+declare function planningLeadTemplate(ctx: TemplateContext): string;
+
+declare function devLeadTemplate(ctx: TemplateContext): string;
+
+declare function qualityLeadTemplate(ctx: TemplateContext): string;
+
+declare function opsLeadTemplate(ctx: TemplateContext): string;
+
+declare function researchAgentTemplate(ctx: TemplateContext): string;
+
+declare function planningAgentTemplate(ctx: TemplateContext): string;
+
+declare function architectAgentTemplate(ctx: TemplateContext): string;
+
+declare function backendAgentTemplate(ctx: TemplateContext): string;
+
+declare function frontendAgentTemplate(ctx: TemplateContext): string;
+
+declare function uiuxAgentTemplate(ctx: TemplateContext): string;
+
+declare function fullstackAgentTemplate(ctx: TemplateContext): string;
+
+declare function devopsAgentTemplate(ctx: TemplateContext): string;
+
+declare function testingAgentTemplate(ctx: TemplateContext): string;
+
+declare function securityAgentTemplate(ctx: TemplateContext): string;
+
+declare function docsAgentTemplate(ctx: TemplateContext): string;
+
+declare function writingAgentTemplate(ctx: TemplateContext): string;
+
+declare function marketingAgentTemplate(ctx: TemplateContext): string;
+
+declare function getBrainstormingSkill(): string;
+
+declare function getBrownfieldAnalysisSkill(): string;
+
+declare function getTaskboardOpsSkill(): string;
+
+declare function getCodeGenSkill(): string;
+
+declare function getDebuggingSkill(): string;
+
+declare function getApiDesignSkill(): string;
+
+declare function getTestingSkill(): string;
+
+declare function getDeploymentSkill(): string;
+
+declare function getPrdSkill(): string;
+
+declare function getBrownfieldDiscoverySkill(): string;
+
+declare function getAdaptiveTaskGraphSkill(): string;
+
+/**
+ * Documentation Skill
+ *
+ * Instructs agents on documentation standards across all FISHI phases.
+ * Documentation is mandatory at every stage — no phase gate passes without proper docs.
+ */
+declare function getDocumentationSkill(): string;
+
+/**
+ * Session Start Hook Template
+ *
+ * Generates an .mjs hook that fires on SessionStart. It reads project state,
+ * the latest checkpoint, project context memory, and the taskboard to output
+ * a structured resume context summary to stdout for Claude Code to capture.
+ */
+declare function getSessionStartHook(): string;
+
+/**
+ * Auto-Checkpoint Hook Template
+ *
+ * Generates an .mjs hook that fires on Stop. It reads project state, taskboard
+ * counts, and active worktrees to create a checkpoint file, then updates
+ * project.yaml with the latest checkpoint reference. Keeps max 50 checkpoints.
+ */
+declare function getAutoCheckpointHook(): string;
+
+/**
+ * Agent Complete Hook Template
+ *
+ * Generates an .mjs hook that fires on SubagentStop. It reads the tool result
+ * from stdin, parses agent output for STATUS/FILES_CHANGED/SUMMARY fields,
+ * updates the taskboard (moves tasks from In Progress to Review), and logs
+ * the completion to an agent-specific log file.
+ */
+declare function getAgentCompleteHook(): string;
+
+/**
+ * Post-Edit Hook Template
+ *
+ * Generates an .mjs hook that fires on PostToolUse for Write|Edit.
+ * It reads the tool result from stdin to get the file path, then runs
+ * eslint --fix if available. Only acts on code files and skips excluded dirs.
+ * Never blocks or fails — always exits 0.
+ */
+declare function getPostEditHook(): string;
+
+/**
+ * Safety Check Hook Template
+ *
+ * Generates an .mjs hook that fires on PreToolUse for Bash.
+ * It reads the tool input JSON from stdin to get the command field,
+ * checks against dangerous patterns, and exits 2 to block or 0 to allow.
+ */
+declare function getSafetyCheckHook(): string;
+
+/**
+ * Worktree Setup Hook Template
+ *
+ * Generates an .mjs hook that fires on worktree creation. It copies
+ * environment files (.env, .env.local) to the new worktree, detects the
+ * package manager from lock files, and runs dependency installation with
+ * a 60-second timeout.
+ */
+declare function getWorktreeSetupHook(): string;
+
+/**
+ * Taskboard Update Hook Template
+ *
+ * Generates an .mjs hook that fires after task state changes. It reads the
+ * taskboard, counts tasks per column, finds the current sprint file, and
+ * updates the sprint burndown with new counts.
+ */
+declare function getTaskboardUpdateHook(): string;
+
+/**
+ * Worktree Manager Script Template
+ *
+ * Generates an .mjs CLI utility that manages git worktree lifecycle for
+ * agent tasks. Zero dependencies — Node.js built-ins only.
+ *
+ * Commands: create, status, review, merge, cleanup
+ */
+declare function getWorktreeManagerScript(): string;
+
+/**
+ * Gate Manager Script
+ *
+ * CLI utility for managing approval gates. Agents and coordinators invoke this
+ * to create, check, and update gate status.
+ *
+ * Zero dependencies — uses only Node.js built-ins.
+ */
+declare function getGateManagerScript(): string;
+
+/**
+ * Validate Scaffold Hook Template
+ *
+ * Generates an .mjs script that validates the entire FISHI scaffold is
+ * internally consistent: file existence, YAML frontmatter, cross-references,
+ * pipeline consistency, and permission validation.
+ * Zero dependencies: uses only Node.js built-ins.
+ */
+declare function getValidateScaffoldScript(): string;
+
+/**
+ * Phase Runner Script
+ *
+ * CLI utility that orchestrates phase transitions programmatically.
+ * Used by Master Agent and /fishi-init command to drive the pipeline.
+ * Also serves as a dry-run validator for the full pipeline.
+ *
+ * Zero dependencies — uses only Node.js built-ins.
+ */
+declare function getPhaseRunnerScript(): string;
+
+/**
+ * TODO Manager Script
+ *
+ * Returns a .mjs script (zero dependencies, Node.js built-ins only)
+ * that manages agent-level TODO lists stored at `.fishi/todos/{agent-name}.md`.
+ */
+declare function getTodoManagerScript(): string;
+
+/**
+ * Memory Manager Script
+ *
+ * CLI utility for managing persistent agent memory across sessions.
+ * Each agent gets a personal memory file at `.fishi/memory/agents/{agent-name}.md`
+ * with key-value entries stored as markdown H2 sections.
+ *
+ * Zero dependencies — uses only Node.js built-ins.
+ */
+declare function getMemoryManagerScript(): string;
+
+/**
+ * Learnings Manager Script
+ *
+ * CLI utility for capturing mistakes, fixes, and best practices.
+ * Stores learnings locally (per-project) and globally (cross-project).
+ *
+ * Zero dependencies — uses only Node.js built-ins.
+ */
+declare function getLearningsManagerScript(): string;
+
+/**
+ * Documentation Checker Script
+ *
+ * CLI utility for validating that required documentation exists for each
+ * FISHI phase before a gate can be approved.
+ *
+ * Zero dependencies — uses only Node.js built-ins.
+ */
+declare function getDocCheckerScript(): string;
+
+declare function getInitCommand(): string;
+
+declare function getStatusCommand(): string;
+
+declare function getResumeCommand(): string;
+
+declare function getGateCommand(): string;
+
+declare function getBoardCommand(): string;
+
+declare function getSprintCommand(): string;
+
+declare function getResetCommand(): string;
+
+declare function getPrdCommand(): string;
+
+interface FishiYamlOptions {
+    projectName: string;
+    projectDescription: string;
+    projectType: ProjectType;
+    costMode: CostMode;
+    language?: string;
+    framework?: string;
+}
+declare function getFishiYamlTemplate(options: FishiYamlOptions): string;
+
+declare function getSettingsJsonTemplate(): string;
+
+interface BrownfieldAnalysisData {
+    language: string | null;
+    framework: string | null;
+    testFramework: string | null;
+    packageManager: string | null;
+    linter: string | null;
+    formatter: string | null;
+    cssFramework: string | null;
+    orm: string | null;
+    database: string | null;
+    authProvider: string | null;
+    apiStyle: string | null;
+    monorepo: boolean;
+    conventions: string[];
+    codePatterns: Array<{
+        name: string;
+        evidence: string;
+        confidence: number;
+    }>;
+    fileStats: {
+        totalFiles: number;
+        codeFiles: number;
+        testFiles: number;
+    };
+}
+interface ClaudeMdOptions {
+    projectName: string;
+    projectDescription: string;
+    projectType: ProjectType;
+    language?: string;
+    framework?: string;
+    brownfieldAnalysis?: BrownfieldAnalysisData;
+}
+declare function getClaudeMdTemplate(options: ClaudeMdOptions): string;
+
+declare function getMcpJsonTemplate(): string;
+
+interface ProjectYamlOptions {
+    projectName: string;
+    projectDescription: string;
+    projectType: ProjectType;
+}
+declare function getProjectYamlTemplate(options: ProjectYamlOptions): string;
+
+declare function getAgentRegistryTemplate(): string;
+
+declare function getGitignoreAdditions(): string;
+
+declare function getModelRoutingReference(): string;
+
+/**
+ * Agent Factory Template
+ *
+ * Returns a markdown template with {{PLACEHOLDERS}} for generating
+ * specialized worker agent configuration files at runtime.
+ * Master and Coordinators fill in placeholders when creating dynamic agents.
+ */
+declare function getAgentFactoryTemplate(): string;
+
+/**
+ * Coordinator Factory Template
+ *
+ * Returns a markdown template with {{PLACEHOLDERS}} for generating
+ * coordinator agent configuration files at runtime.
+ * Master Agent fills in placeholders when creating dynamic coordinators.
+ */
+declare function getCoordinatorFactoryTemplate(): string;
+
+interface ScaffoldOptions extends InitOptions {
+    projectName: string;
+    projectType: ProjectType;
+    brownfieldAnalysis?: BrownfieldAnalysisData;
+}
+interface ScaffoldResult {
+    agentCount: number;
+    skillCount: number;
+    commandCount: number;
+    hookCount: number;
+    filesCreated: number;
+}
+declare function generateScaffold(targetDir: string, options: ScaffoldOptions): Promise<ScaffoldResult>;
+
+export { type AgentDefinition, type AgentRole, type AgentTemplate, type BrownfieldAnalysisData, type ClaudeMdOptions, type CommandTemplate, type CostMode, type DetectionCheck, type DetectionResult, type DynamicAgentConfig, type ExecutionConfig, type FishiConfig, type FishiYamlOptions, type GateConfig, type GateStatus, type GitConfig, type HookTemplate, type InitOptions, type McpConfig, type McpServerConfig, type ModelRoutingConfig, type ModelTier, type ProjectConfig, type ProjectType, type ProjectYamlOptions, type ScaffoldOptions, type ScaffoldResult, type SkillTemplate, type StateConfig, type TaskStatus, type TaskboardConfig, type TemplateContext, architectAgentTemplate, backendAgentTemplate, devLeadTemplate, devopsAgentTemplate, docsAgentTemplate, frontendAgentTemplate, fullstackAgentTemplate, generateScaffold, getAdaptiveTaskGraphSkill, getAgentCompleteHook, getAgentFactoryTemplate, getAgentRegistryTemplate, getApiDesignSkill, getAutoCheckpointHook, getBoardCommand, getBrainstormingSkill, getBrownfieldAnalysisSkill, getBrownfieldDiscoverySkill, getClaudeMdTemplate, getCodeGenSkill, getCoordinatorFactoryTemplate, getDebuggingSkill, getDeploymentSkill, getDocCheckerScript, getDocumentationSkill, getFishiYamlTemplate, getGateCommand, getGateManagerScript, getGitignoreAdditions, getInitCommand, getLearningsManagerScript, getMasterOrchestratorTemplate, getMcpJsonTemplate, getMemoryManagerScript, getModelRoutingReference, getPhaseRunnerScript, getPostEditHook, getPrdCommand, getPrdSkill, getProjectYamlTemplate, getResetCommand, getResumeCommand, getSafetyCheckHook, getSessionStartHook, getSettingsJsonTemplate, getSprintCommand, getStatusCommand, getTaskboardOpsSkill, getTaskboardUpdateHook, getTestingSkill, getTodoManagerScript, getValidateScaffoldScript, getWorktreeManagerScript, getWorktreeSetupHook, marketingAgentTemplate, opsLeadTemplate, planningAgentTemplate, planningLeadTemplate, qualityLeadTemplate, researchAgentTemplate, securityAgentTemplate, testingAgentTemplate, uiuxAgentTemplate, writingAgentTemplate };