@autobe/agent 0.30.0-dev.20260315 → 0.30.1

package/src/orchestrate/analyze/structures/IAutoBeAnalyzeSectionReviewApplication.ts

@@ -1,192 +1,192 @@
-import { IAutoBePreliminaryGetPreviousAnalysisSections } from "../../common/structures/IAutoBePreliminaryGetPreviousAnalysisSections";
-
-/**
- * Application interface for the Cross-File Section Review agent.
- *
- * This agent reviews ALL files' section content together in a single LLM call,
- * providing cross-file validation for value consistency, terminology, Mermaid
- * diagram style, and EARS format (03-functional-requirements, 04-business-rules
- * only).
- */
-export interface IAutoBeAnalyzeSectionReviewApplication {
-  /**
-   * Process cross-file section review task or preliminary data requests.
-   *
-   * Reviews and validates section content across ALL files in a single call,
-   * ensuring cross-file consistency and uniformity.
-   *
-   * @param props Request containing either preliminary data request or complete
-   *   task
-   */
-  process(props: IAutoBeAnalyzeSectionReviewApplicationProps): void;
-}
-
-export interface IAutoBeAnalyzeSectionReviewApplicationProps {
-  /**
-   * Think before you act.
-   *
-   * Before requesting preliminary data or completing your task, reflect on your
-   * current state and explain your reasoning:
-   *
-   * For preliminary requests:
-   *
-   * - What additional context do you need for cross-file validation?
-   *
-   * For completion:
-   *
-   * - Is EARS format consistent across requirement files (03, 04)?
-   * - Are values and constraints consistent across all files?
-   * - Is terminology aligned across all files?
-   * - Are Mermaid diagram styles uniform?
-   */
-  thinking?: string | null;
-
-  /** Type discriminator for the request. */
-  request:
-    | IAutoBeAnalyzeSectionReviewApplicationComplete
-    | IAutoBePreliminaryGetPreviousAnalysisSections;
-}
-
-/**
- * Request to complete the cross-file section review.
- *
- * Provides per-file review verdicts for all files' section content.
- */
-export interface IAutoBeAnalyzeSectionReviewApplicationComplete {
-  /** Type discriminator for the request. */
-  type: "complete";
-
-  /**
-   * Per-file review results.
-   *
-   * Each entry contains the verdict for one file's section content.
-   */
-  fileResults: IAutoBeAnalyzeSectionReviewApplicationFileResult[];
-}
-
-/** Per-file review result. */
-export interface IAutoBeAnalyzeSectionReviewApplicationFileResult {
-  /** Index of the file in the scenario's files array. */
-  fileIndex: number;
-
-  /**
-   * Whether this file's section content passed review.
-   *
-   * If true: File's sections are consistent with other files. If false: File's
-   * sections must be regenerated with feedback.
-   */
-  approved: boolean;
-
-  /**
-   * Detailed review feedback for this file's section content.
-   *
-   * Cross-file review criteria evaluated:
-   *
-   * - EARS format compliance (03-functional-requirements, 04-business-rules only)
-   * - Value and constraint consistency
-   * - Terminology alignment
-   * - Mermaid diagram style uniformity
-   * - No prohibited content
-   *
-   * For rejected files:
-   *
-   * - Specific inconsistencies identified
-   * - Recommendations for alignment
-   */
-  feedback: string;
-
-  /**
-   * Structured review issues for targeted rewrites / patches.
-   *
-   * Optional for backward compatibility.
-   */
-  issues?: IAutoBeAnalyzeSectionReviewApplicationReviewIssue[] | null;
-
-  /**
-   * Revised sections for this file if modifications were made.
-   *
-   * Organized by moduleIndex and unitIndex. Set to `null` if no revisions were
-   * made.
-   */
-  revisedSections:
-    | IAutoBeAnalyzeSectionReviewApplicationRevisedModuleSections[]
-    | null;
-
-  /**
-   * Specific module/unit pairs whose sections were rejected.
-   *
-   * When rejecting a file, identify EXACTLY which modules and units have
-   * problematic sections. Only these will be regenerated on retry.
-   *
-   * Set to null if all module/units need regeneration, or if approving.
-   */
-  rejectedModuleUnits:
-    | IAutoBeAnalyzeSectionReviewApplicationRejectedModuleUnit[]
-    | null;
-}
-
-/** Identifies specific module/unit pairs whose sections were rejected. */
-export interface IAutoBeAnalyzeSectionReviewApplicationRejectedModuleUnit {
-  /** Index of the module section. */
-  moduleIndex: number;
-
-  /** Indices of units within this module that need section regeneration. */
-  unitIndices: number[];
-
-  /** Specific feedback for this module/unit group's issues. */
-  feedback: string;
-
-  /**
-   * Structured issues scoped to this module/unit group.
-   *
-   * Optional for backward compatibility.
-   */
-  issues?: IAutoBeAnalyzeSectionReviewApplicationReviewIssue[] | null;
-
-  /**
-   * Per-unit mapping of specific section indices that need regeneration.
-   *
-   * Keys are unit indices (from `unitIndices`), values are arrays of section
-   * indices within that unit's `sectionSections[]` that failed review.
-   *
-   * When null/undefined or when a unitIndex is not present as a key, ALL
-   * sections for that unit are regenerated (backward-compatible fallback).
-   */
-  sectionIndicesPerUnit?: Record<number, number[]> | null;
-}
-
-export interface IAutoBeAnalyzeSectionReviewApplicationReviewIssue {
-  ruleCode: string;
-  moduleIndex: number | null;
-  unitIndex: number | null;
-  sectionIndex?: number | null;
-  fixInstruction: string;
-  evidence?: string | null;
-}
-
-/** Structure for revised sections of a single module. */
-export interface IAutoBeAnalyzeSectionReviewApplicationRevisedModuleSections {
-  /** Index of the module section. */
-  moduleIndex: number;
-
-  /** Revised sections for each unit in this module. */
-  units: IAutoBeAnalyzeSectionReviewApplicationRevisedUnitSections[];
-}
-
-/** Structure for revised sections of a single unit. */
-export interface IAutoBeAnalyzeSectionReviewApplicationRevisedUnitSections {
-  /** Index of the unit section. */
-  unitIndex: number;
-
-  /** Revised section sections for this unit. */
-  sectionSections: IAutoBeAnalyzeSectionReviewApplicationRevisedSectionSection[];
-}
-
-/** Structure for a revised section. */
-export interface IAutoBeAnalyzeSectionReviewApplicationRevisedSectionSection {
-  /** Title of the section. */
-  title: string;
-
-  /** Revised content. */
-  content: string;
-}
+import { IAutoBePreliminaryGetPreviousAnalysisSections } from "../../common/structures/IAutoBePreliminaryGetPreviousAnalysisSections";
+
+/**
+ * Application interface for the Cross-File Section Review agent.
+ *
+ * This agent reviews ALL files' section content together in a single LLM call,
+ * providing cross-file validation for value consistency, terminology, Mermaid
+ * diagram style, and EARS format (03-functional-requirements, 04-business-rules
+ * only).
+ */
+export interface IAutoBeAnalyzeSectionReviewApplication {
+  /**
+   * Process cross-file section review task or preliminary data requests.
+   *
+   * Reviews and validates section content across ALL files in a single call,
+   * ensuring cross-file consistency and uniformity.
+   *
+   * @param props Request containing either preliminary data request or complete
+   *   task
+   */
+  process(props: IAutoBeAnalyzeSectionReviewApplicationProps): void;
+}
+
+export interface IAutoBeAnalyzeSectionReviewApplicationProps {
+  /**
+   * Think before you act.
+   *
+   * Before requesting preliminary data or completing your task, reflect on your
+   * current state and explain your reasoning:
+   *
+   * For preliminary requests:
+   *
+   * - What additional context do you need for cross-file validation?
+   *
+   * For completion:
+   *
+   * - Is EARS format consistent across requirement files (03, 04)?
+   * - Are values and constraints consistent across all files?
+   * - Is terminology aligned across all files?
+   * - Are Mermaid diagram styles uniform?
+   */
+  thinking?: string | null;
+
+  /** Type discriminator for the request. */
+  request:
+    | IAutoBeAnalyzeSectionReviewApplicationComplete
+    | IAutoBePreliminaryGetPreviousAnalysisSections;
+}
+
+/**
+ * Request to complete the cross-file section review.
+ *
+ * Provides per-file review verdicts for all files' section content.
+ */
+export interface IAutoBeAnalyzeSectionReviewApplicationComplete {
+  /** Type discriminator for the request. */
+  type: "complete";
+
+  /**
+   * Per-file review results.
+   *
+   * Each entry contains the verdict for one file's section content.
+   */
+  fileResults: IAutoBeAnalyzeSectionReviewApplicationFileResult[];
+}
+
+/** Per-file review result. */
+export interface IAutoBeAnalyzeSectionReviewApplicationFileResult {
+  /** Index of the file in the scenario's files array. */
+  fileIndex: number;
+
+  /**
+   * Whether this file's section content passed review.
+   *
+   * If true: File's sections are consistent with other files. If false: File's
+   * sections must be regenerated with feedback.
+   */
+  approved: boolean;
+
+  /**
+   * Detailed review feedback for this file's section content.
+   *
+   * Cross-file review criteria evaluated:
+   *
+   * - EARS format compliance (03-functional-requirements, 04-business-rules only)
+   * - Value and constraint consistency
+   * - Terminology alignment
+   * - Mermaid diagram style uniformity
+   * - No prohibited content
+   *
+   * For rejected files:
+   *
+   * - Specific inconsistencies identified
+   * - Recommendations for alignment
+   */
+  feedback: string;
+
+  /**
+   * Structured review issues for targeted rewrites / patches.
+   *
+   * Optional for backward compatibility.
+   */
+  issues?: IAutoBeAnalyzeSectionReviewApplicationReviewIssue[] | null;
+
+  /**
+   * Revised sections for this file if modifications were made.
+   *
+   * Organized by moduleIndex and unitIndex. Set to `null` if no revisions were
+   * made.
+   */
+  revisedSections:
+    | IAutoBeAnalyzeSectionReviewApplicationRevisedModuleSections[]
+    | null;
+
+  /**
+   * Specific module/unit pairs whose sections were rejected.
+   *
+   * When rejecting a file, identify EXACTLY which modules and units have
+   * problematic sections. Only these will be regenerated on retry.
+   *
+   * Set to null if all module/units need regeneration, or if approving.
+   */
+  rejectedModuleUnits:
+    | IAutoBeAnalyzeSectionReviewApplicationRejectedModuleUnit[]
+    | null;
+}
+
+/** Identifies specific module/unit pairs whose sections were rejected. */
+export interface IAutoBeAnalyzeSectionReviewApplicationRejectedModuleUnit {
+  /** Index of the module section. */
+  moduleIndex: number;
+
+  /** Indices of units within this module that need section regeneration. */
+  unitIndices: number[];
+
+  /** Specific feedback for this module/unit group's issues. */
+  feedback: string;
+
+  /**
+   * Structured issues scoped to this module/unit group.
+   *
+   * Optional for backward compatibility.
+   */
+  issues?: IAutoBeAnalyzeSectionReviewApplicationReviewIssue[] | null;
+
+  /**
+   * Per-unit mapping of specific section indices that need regeneration.
+   *
+   * Keys are unit indices (from `unitIndices`), values are arrays of section
+   * indices within that unit's `sectionSections[]` that failed review.
+   *
+   * When null/undefined or when a unitIndex is not present as a key, ALL
+   * sections for that unit are regenerated (backward-compatible fallback).
+   */
+  sectionIndicesPerUnit?: Record<number, number[]> | null;
+}
+
+export interface IAutoBeAnalyzeSectionReviewApplicationReviewIssue {
+  ruleCode: string;
+  moduleIndex: number | null;
+  unitIndex: number | null;
+  sectionIndex?: number | null;
+  fixInstruction: string;
+  evidence?: string | null;
+}
+
+/** Structure for revised sections of a single module. */
+export interface IAutoBeAnalyzeSectionReviewApplicationRevisedModuleSections {
+  /** Index of the module section. */
+  moduleIndex: number;
+
+  /** Revised sections for each unit in this module. */
+  units: IAutoBeAnalyzeSectionReviewApplicationRevisedUnitSections[];
+}
+
+/** Structure for revised sections of a single unit. */
+export interface IAutoBeAnalyzeSectionReviewApplicationRevisedUnitSections {
+  /** Index of the unit section. */
+  unitIndex: number;
+
+  /** Revised section sections for this unit. */
+  sectionSections: IAutoBeAnalyzeSectionReviewApplicationRevisedSectionSection[];
+}
+
+/** Structure for a revised section. */
+export interface IAutoBeAnalyzeSectionReviewApplicationRevisedSectionSection {
+  /** Title of the section. */
+  title: string;
+
+  /** Revised content. */
+  content: string;
+}

package/src/orchestrate/analyze/structures/IAutoBeAnalyzeWriteSectionApplication.ts

@@ -1,142 +1,142 @@
-import { IAutoBePreliminaryGetPreviousAnalysisSections } from "../../common/structures/IAutoBePreliminaryGetPreviousAnalysisSections";
-
-/**
- * Application interface for the Section (###) generation agent.
- *
- * This agent is responsible for creating detailed sections within an approved
- * unit section structure, producing implementation-ready requirement
- * specifications.
- */
-export interface IAutoBeAnalyzeWriteSectionApplication {
-  /**
-   * Process section generation task or preliminary data requests.
-   *
-   * Creates detailed sections for a specific unit section, including complete
-   * content with Mermaid diagrams and, for requirement-heavy files
-   * (03-functional-requirements, 04-business-rules), EARS format requirements.
-   *
-   * @param props Request containing either preliminary data request or complete
-   *   task
-   */
-  process(props: IAutoBeAnalyzeWriteSectionApplicationProps): void;
-}
-
-export interface IAutoBeAnalyzeWriteSectionApplicationProps {
-  /**
-   * Think before you act.
-   *
-   * Before requesting preliminary data or completing your task, reflect on your
-   * current state and explain your reasoning:
-   *
-   * For preliminary requests:
-   *
-   * - What additional context do you need for detailed content?
-   *
-   * For completion:
-   *
-   * - How do the sections address the keywords from the unit section?
-   * - For 03/04 files: Are requirements specific and in EARS format?
-   * - For other files: Is content written in clear, descriptive prose?
-   * - Are Mermaid diagrams properly formatted?
-   */
-  thinking?: string | null;
-
-  /** Type discriminator for the request. */
-  request:
-    | IAutoBeAnalyzeWriteSectionApplicationComplete
-    | IAutoBePreliminaryGetPreviousAnalysisSections;
-}
-
-/**
- * Request to generate section content.
- *
- * Creates the detailed content within a unit section, including
- * implementation-ready requirements specifications with proper formatting and
- * diagrams.
- */
-export interface IAutoBeAnalyzeWriteSectionApplicationComplete {
-  /** Type discriminator for the request. */
-  type: "complete";
-
-  /** Index of the grandparent module section. */
-  moduleIndex: number;
-
-  /** Index of the parent unit section. */
-  unitIndex: number;
-
-  /**
-   * Array of sections for this unit section.
-   *
-   * Each section represents a detailed subsection (#### level) containing
-   * specific requirements, specifications, or process descriptions. The content
-   * should:
-   *
-   * - Use EARS format for requirements in 03-functional-requirements and
-   *   04-business-rules files; use natural language prose for other files
-   * - Include Mermaid diagrams with proper syntax
-   * - Be specific and implementation-ready
-   * - Avoid prohibited content (DB schemas, API specs)
-   */
-  sectionSections: IAutoBeAnalyzeWriteSectionApplicationSectionSection[];
-}
-
-/** Structure representing a single section. */
-export interface IAutoBeAnalyzeWriteSectionApplicationSectionSection {
-  /**
-   * Title of the section (#### level heading).
-   *
-   * Should clearly indicate the specific requirement, process, or feature being
-   * detailed.
-   */
-  title: string;
-
-  /**
-   * Complete content for the section.
-   *
-   * Contains detailed requirements, specifications, and diagrams. Content
-   * guidelines:
-   *
-   * EARS Format (ONLY for 03-functional-requirements, 04-business-rules):
-   *
-   * - Ubiquitous: "THE <system> SHALL <function>"
-   * - Event-driven: "WHEN <trigger>, THE <system> SHALL <function>"
-   * - State-driven: "WHILE <state>, THE <system> SHALL <function>"
-   * - Unwanted: "IF <condition>, THEN THE <system> SHALL <function>"
-   * - Optional: "WHERE <feature>, THE <system> SHALL <function>"
-   *
-   * Natural Language (for 00-toc, 01-actors-and-auth, 02-domain-model,
-   * 05-non-functional):
-   *
-   * - Use clear, descriptive prose for definitions, concepts, and policies
-   * - Focus on readability over formal structure
-   * - Tables and bullet points are preferred for structured data
-   *
-   * Mermaid Diagram Rules:
-   *
-   * - ALL labels must use double quotes: A["User Login"]
-   * - NO spaces between brackets and quotes
-   * - Arrow syntax: --> (NOT --|)
-   * - LR orientation preferred for flowcharts
-   *
-   * Prohibited Content:
-   *
-   * - Database schemas or ERD
-   * - API endpoint specifications
-   * - Technical implementation details
-   * - Frontend UI/UX specifications
-   *
-   * Hallucination Prevention:
-   *
-   * - Every requirement must trace to the original user input
-   * - Do NOT invent SLA numbers, timeout values, or performance targets
-   * - Do NOT add security mechanisms (2FA, JWT, encryption) user did not mention
-   * - Do NOT add infrastructure requirements (CDN, caching) user did not mention
-   * - 05-non-functional: only describe aspects the user explicitly mentioned
-   *
-   * Conciseness:
-   *
-   * - One concept = one section, not multiple sections rephrasing the same idea
-   * - 02-domain-model: max 1-3 sections per business concept
-   */
-  content: string;
-}
+import { IAutoBePreliminaryGetPreviousAnalysisSections } from "../../common/structures/IAutoBePreliminaryGetPreviousAnalysisSections";
+
+/**
+ * Application interface for the Section (###) generation agent.
+ *
+ * This agent is responsible for creating detailed sections within an approved
+ * unit section structure, producing implementation-ready requirement
+ * specifications.
+ */
+export interface IAutoBeAnalyzeWriteSectionApplication {
+  /**
+   * Process section generation task or preliminary data requests.
+   *
+   * Creates detailed sections for a specific unit section, including complete
+   * content with Mermaid diagrams and, for requirement-heavy files
+   * (03-functional-requirements, 04-business-rules), EARS format requirements.
+   *
+   * @param props Request containing either preliminary data request or complete
+   *   task
+   */
+  process(props: IAutoBeAnalyzeWriteSectionApplicationProps): void;
+}
+
+export interface IAutoBeAnalyzeWriteSectionApplicationProps {
+  /**
+   * Think before you act.
+   *
+   * Before requesting preliminary data or completing your task, reflect on your
+   * current state and explain your reasoning:
+   *
+   * For preliminary requests:
+   *
+   * - What additional context do you need for detailed content?
+   *
+   * For completion:
+   *
+   * - How do the sections address the keywords from the unit section?
+   * - For 03/04 files: Are requirements specific and in EARS format?
+   * - For other files: Is content written in clear, descriptive prose?
+   * - Are Mermaid diagrams properly formatted?
+   */
+  thinking?: string | null;
+
+  /** Type discriminator for the request. */
+  request:
+    | IAutoBeAnalyzeWriteSectionApplicationComplete
+    | IAutoBePreliminaryGetPreviousAnalysisSections;
+}
+
+/**
+ * Request to generate section content.
+ *
+ * Creates the detailed content within a unit section, including
+ * implementation-ready requirements specifications with proper formatting and
+ * diagrams.
+ */
+export interface IAutoBeAnalyzeWriteSectionApplicationComplete {
+  /** Type discriminator for the request. */
+  type: "complete";
+
+  /** Index of the grandparent module section. */
+  moduleIndex: number;
+
+  /** Index of the parent unit section. */
+  unitIndex: number;
+
+  /**
+   * Array of sections for this unit section.
+   *
+   * Each section represents a detailed subsection (#### level) containing
+   * specific requirements, specifications, or process descriptions. The content
+   * should:
+   *
+   * - Use EARS format for requirements in 03-functional-requirements and
+   *   04-business-rules files; use natural language prose for other files
+   * - Include Mermaid diagrams with proper syntax
+   * - Be specific and implementation-ready
+   * - Avoid prohibited content (DB schemas, API specs)
+   */
+  sectionSections: IAutoBeAnalyzeWriteSectionApplicationSectionSection[];
+}
+
+/** Structure representing a single section. */
+export interface IAutoBeAnalyzeWriteSectionApplicationSectionSection {
+  /**
+   * Title of the section (#### level heading).
+   *
+   * Should clearly indicate the specific requirement, process, or feature being
+   * detailed.
+   */
+  title: string;
+
+  /**
+   * Complete content for the section.
+   *
+   * Contains detailed requirements, specifications, and diagrams. Content
+   * guidelines:
+   *
+   * EARS Format (ONLY for 03-functional-requirements, 04-business-rules):
+   *
+   * - Ubiquitous: "THE <system> SHALL <function>"
+   * - Event-driven: "WHEN <trigger>, THE <system> SHALL <function>"
+   * - State-driven: "WHILE <state>, THE <system> SHALL <function>"
+   * - Unwanted: "IF <condition>, THEN THE <system> SHALL <function>"
+   * - Optional: "WHERE <feature>, THE <system> SHALL <function>"
+   *
+   * Natural Language (for 00-toc, 01-actors-and-auth, 02-domain-model,
+   * 05-non-functional):
+   *
+   * - Use clear, descriptive prose for definitions, concepts, and policies
+   * - Focus on readability over formal structure
+   * - Tables and bullet points are preferred for structured data
+   *
+   * Mermaid Diagram Rules:
+   *
+   * - ALL labels must use double quotes: A["User Login"]
+   * - NO spaces between brackets and quotes
+   * - Arrow syntax: --> (NOT --|)
+   * - LR orientation preferred for flowcharts
+   *
+   * Prohibited Content:
+   *
+   * - Database schemas or ERD
+   * - API endpoint specifications
+   * - Technical implementation details
+   * - Frontend UI/UX specifications
+   *
+   * Hallucination Prevention:
+   *
+   * - Every requirement must trace to the original user input
+   * - Do NOT invent SLA numbers, timeout values, or performance targets
+   * - Do NOT add security mechanisms (2FA, JWT, encryption) user did not mention
+   * - Do NOT add infrastructure requirements (CDN, caching) user did not mention
+   * - 05-non-functional: only describe aspects the user explicitly mentioned
+   *
+   * Conciseness:
+   *
+   * - One concept = one section, not multiple sections rephrasing the same idea
+   * - 02-domain-model: max 1-3 sections per business concept
+   */
+  content: string;
+}