@autobe/agent 0.30.0-dev.20260315 → 0.30.0

package/src/orchestrate/realize/structures/IAutoBeRealizeCollectorPlanApplication.ts

@@ -1,177 +1,177 @@
-import { AutoBeRealizeCollectorReference } from "@autobe/interface";
-
-import { IAutoBePreliminaryGetAnalysisSections } from "../../common/structures/IAutoBePreliminaryGetAnalysisSections";
-import { IAutoBePreliminaryGetDatabaseSchemas } from "../../common/structures/IAutoBePreliminaryGetDatabaseSchemas";
-import { IAutoBePreliminaryGetInterfaceOperations } from "../../common/structures/IAutoBePreliminaryGetInterfaceOperations";
-import { IAutoBePreliminaryGetInterfaceSchemas } from "../../common/structures/IAutoBePreliminaryGetInterfaceSchemas";
-
-/**
- * Function calling interface for planning collector DTO generation.
- *
- * Guides the AI agent through analyzing a single DTO type and determining
- * whether it needs a collector. Each DTO is analyzed independently, enabling
- * parallel processing across all DTOs.
- *
- * The planning follows a structured RAG workflow: preliminary context gathering
- * (database schemas, DTO schemas, Operations) → eligibility analysis → plan
- * generation.
- *
- * **Key Decisions**: Not all DTOs require collectors. The agent must
- * distinguish collectable DTOs (Create DTO + DB-backed + Direct mapping) from
- * non-collectable DTOs (read-only DTOs, computed types) and set
- * databaseSchemaName to null for non-collectable ones.
- */
-export interface IAutoBeRealizeCollectorPlanApplication {
-  /**
-   * Process collector planning task or preliminary data requests.
-   *
-   * Analyzes the given DTO type and generates a plan entry determining whether
-   * a collector is needed. Returns exactly ONE plan entry for the given DTO.
-   *
-   * @param props Request containing either preliminary data request or complete
-   *   plan
-   */
-  process(props: IAutoBeRealizeCollectorPlanApplication.IProps): void;
-}
-export namespace IAutoBeRealizeCollectorPlanApplication {
-  export interface IProps {
-    /**
-     * Think before you act.
-     *
-     * Before requesting preliminary data or completing your plan, reflect on
-     * your current state and explain your reasoning:
-     *
-     * For preliminary requests:
-     *
-     * - What schemas (database, DTO, Operations) are missing that you need?
-     * - Why do you need them for planning?
-     * - Be brief - state the gap, don't list everything you have.
-     *
-     * For completion:
-     *
-     * - Is this DTO collectable or non-collectable?
-     * - What database table does it map to (if collectable)?
-     * - Why is it non-collectable (if applicable)?
-     *
-     * This reflection helps you avoid duplicate requests and premature
-     * completion.
-     */
-    thinking: string;
-
-    /**
-     * Type discriminator for the request.
-     *
-     * Determines which action to perform:
-     *
-     * - "getDatabaseSchemas": Retrieve database table schemas for DB structure
-     * - "getAnalysisSections": Retrieve analysis sections for context
-     * - "getInterfaceOperations": Retrieve operation specifications
-     * - "getInterfaceSchemas": Retrieve DTO type definitions for API contracts
-     * - "complete": Generate final collector plan
-     *
-     * The preliminary types are removed from the union after their respective
-     * data has been provided, physically preventing repeated calls.
-     */
-    request:
-      | IComplete
-      | IAutoBePreliminaryGetDatabaseSchemas
-      | IAutoBePreliminaryGetAnalysisSections
-      | IAutoBePreliminaryGetInterfaceOperations
-      | IAutoBePreliminaryGetInterfaceSchemas;
-  }
-
-  /**
-   * Request to complete collector planning.
-   *
-   * Generates a plan with exactly ONE entry for the given DTO, indicating
-   * whether it is collectable (has database schema name) or non-collectable
-   * (null).
-   */
-  export interface IComplete {
-    /** Type discriminator for completion request. */
-    type: "complete";
-
-    /**
-     * Plan entry for the given DTO.
-     *
-     * Must contain exactly ONE entry with:
-     *
-     * - DTO type name matching the given DTO
-     * - Chain of thought explaining the analysis
-     * - Database schema name if collectable, or null if not
-     *
-     * Use databaseSchemaName to distinguish:
-     *
-     * - Non-null: Collectable DTO, collector will be generated
-     * - Null: Non-collectable DTO, no collector needed
-     */
-    plans: IPlan[];
-  }
-
-  /**
-   * Plan for a single DTO analysis result.
-   *
-   * Records the planning decision for one DTO from the operation request.
-   */
-  export interface IPlan {
-    /**
-     * DTO type name being analyzed.
-     *
-     * The TypeScript interface type from the operation request body.
-     *
-     * Example: "IShoppingSale.ICreate", "IShoppingCategory.ICreate"
-     */
-    dtoTypeName: string;
-
-    /**
-     * Chain of thought for this DTO's planning decision.
-     *
-     * Explains the agent's reasoning:
-     *
-     * - For collectable DTOs: Why a collector is needed, which database table it
-     *   maps to
-     * - For non-collectable DTOs: Why no collector is needed (read-only DTO,
-     *   computed type, etc.)
-     *
-     * Example (collectable): "Collects IShoppingSale.ICreate to shopping_sales
-     * with nested category"
-     *
-     * Example (non-collectable): "IShoppingSale is read-only response DTO, not
-     * for creation"
-     */
-    thinking: string;
-
-    /**
-     * Database schema name if collectable, null if not.
-     *
-     * - **Non-null**: The database table name this DTO maps to. A collector will
-     *   be generated for this DTO.
-     * - **Null**: This DTO is non-collectable (read-only DTO, computed type). No
-     *   collector will be generated.
-     *
-     * Examples:
-     *
-     * - (collectable): "shopping_sales", "shopping_categories"
-     * - (non-collectable): null
-     */
-    databaseSchemaName: string | null;
-
-    /**
-     * Referenced entities from path parameters or auth context.
-     *
-     * Each reference contains:
-     *
-     * - `databaseSchemaName`: Database table name (e.g., "shopping_sales")
-     * - `source`: Origin of reference
-     *
-     *   - "from path parameter {paramName}"
-     *   - "from authorized actor"
-     *   - "from authorized session"
-     *
-     * See `AutoBeRealizeCollectorReference` for details.
-     *
-     * Empty array means the Create DTO contains all necessary references.
-     */
-    references: AutoBeRealizeCollectorReference[];
-  }
-}
+import { AutoBeRealizeCollectorReference } from "@autobe/interface";
+
+import { IAutoBePreliminaryGetAnalysisSections } from "../../common/structures/IAutoBePreliminaryGetAnalysisSections";
+import { IAutoBePreliminaryGetDatabaseSchemas } from "../../common/structures/IAutoBePreliminaryGetDatabaseSchemas";
+import { IAutoBePreliminaryGetInterfaceOperations } from "../../common/structures/IAutoBePreliminaryGetInterfaceOperations";
+import { IAutoBePreliminaryGetInterfaceSchemas } from "../../common/structures/IAutoBePreliminaryGetInterfaceSchemas";
+
+/**
+ * Function calling interface for planning collector DTO generation.
+ *
+ * Guides the AI agent through analyzing a single DTO type and determining
+ * whether it needs a collector. Each DTO is analyzed independently, enabling
+ * parallel processing across all DTOs.
+ *
+ * The planning follows a structured RAG workflow: preliminary context gathering
+ * (database schemas, DTO schemas, Operations) → eligibility analysis → plan
+ * generation.
+ *
+ * **Key Decisions**: Not all DTOs require collectors. The agent must
+ * distinguish collectable DTOs (Create DTO + DB-backed + Direct mapping) from
+ * non-collectable DTOs (read-only DTOs, computed types) and set
+ * databaseSchemaName to null for non-collectable ones.
+ */
+export interface IAutoBeRealizeCollectorPlanApplication {
+  /**
+   * Process collector planning task or preliminary data requests.
+   *
+   * Analyzes the given DTO type and generates a plan entry determining whether
+   * a collector is needed. Returns exactly ONE plan entry for the given DTO.
+   *
+   * @param props Request containing either preliminary data request or complete
+   *   plan
+   */
+  process(props: IAutoBeRealizeCollectorPlanApplication.IProps): void;
+}
+export namespace IAutoBeRealizeCollectorPlanApplication {
+  export interface IProps {
+    /**
+     * Think before you act.
+     *
+     * Before requesting preliminary data or completing your plan, reflect on
+     * your current state and explain your reasoning:
+     *
+     * For preliminary requests:
+     *
+     * - What schemas (database, DTO, Operations) are missing that you need?
+     * - Why do you need them for planning?
+     * - Be brief - state the gap, don't list everything you have.
+     *
+     * For completion:
+     *
+     * - Is this DTO collectable or non-collectable?
+     * - What database table does it map to (if collectable)?
+     * - Why is it non-collectable (if applicable)?
+     *
+     * This reflection helps you avoid duplicate requests and premature
+     * completion.
+     */
+    thinking: string;
+
+    /**
+     * Type discriminator for the request.
+     *
+     * Determines which action to perform:
+     *
+     * - "getDatabaseSchemas": Retrieve database table schemas for DB structure
+     * - "getAnalysisSections": Retrieve analysis sections for context
+     * - "getInterfaceOperations": Retrieve operation specifications
+     * - "getInterfaceSchemas": Retrieve DTO type definitions for API contracts
+     * - "complete": Generate final collector plan
+     *
+     * The preliminary types are removed from the union after their respective
+     * data has been provided, physically preventing repeated calls.
+     */
+    request:
+      | IComplete
+      | IAutoBePreliminaryGetDatabaseSchemas
+      | IAutoBePreliminaryGetAnalysisSections
+      | IAutoBePreliminaryGetInterfaceOperations
+      | IAutoBePreliminaryGetInterfaceSchemas;
+  }
+
+  /**
+   * Request to complete collector planning.
+   *
+   * Generates a plan with exactly ONE entry for the given DTO, indicating
+   * whether it is collectable (has database schema name) or non-collectable
+   * (null).
+   */
+  export interface IComplete {
+    /** Type discriminator for completion request. */
+    type: "complete";
+
+    /**
+     * Plan entry for the given DTO.
+     *
+     * Must contain exactly ONE entry with:
+     *
+     * - DTO type name matching the given DTO
+     * - Chain of thought explaining the analysis
+     * - Database schema name if collectable, or null if not
+     *
+     * Use databaseSchemaName to distinguish:
+     *
+     * - Non-null: Collectable DTO, collector will be generated
+     * - Null: Non-collectable DTO, no collector needed
+     */
+    plans: IPlan[];
+  }
+
+  /**
+   * Plan for a single DTO analysis result.
+   *
+   * Records the planning decision for one DTO from the operation request.
+   */
+  export interface IPlan {
+    /**
+     * DTO type name being analyzed.
+     *
+     * The TypeScript interface type from the operation request body.
+     *
+     * Example: "IShoppingSale.ICreate", "IShoppingCategory.ICreate"
+     */
+    dtoTypeName: string;
+
+    /**
+     * Chain of thought for this DTO's planning decision.
+     *
+     * Explains the agent's reasoning:
+     *
+     * - For collectable DTOs: Why a collector is needed, which database table it
+     *   maps to
+     * - For non-collectable DTOs: Why no collector is needed (read-only DTO,
+     *   computed type, etc.)
+     *
+     * Example (collectable): "Collects IShoppingSale.ICreate to shopping_sales
+     * with nested category"
+     *
+     * Example (non-collectable): "IShoppingSale is read-only response DTO, not
+     * for creation"
+     */
+    thinking: string;
+
+    /**
+     * Database schema name if collectable, null if not.
+     *
+     * - **Non-null**: The database table name this DTO maps to. A collector will
+     *   be generated for this DTO.
+     * - **Null**: This DTO is non-collectable (read-only DTO, computed type). No
+     *   collector will be generated.
+     *
+     * Examples:
+     *
+     * - (collectable): "shopping_sales", "shopping_categories"
+     * - (non-collectable): null
+     */
+    databaseSchemaName: string | null;
+
+    /**
+     * Referenced entities from path parameters or auth context.
+     *
+     * Each reference contains:
+     *
+     * - `databaseSchemaName`: Database table name (e.g., "shopping_sales")
+     * - `source`: Origin of reference
+     *
+     *   - "from path parameter {paramName}"
+     *   - "from authorized actor"
+     *   - "from authorized session"
+     *
+     * See `AutoBeRealizeCollectorReference` for details.
+     *
+     * Empty array means the Create DTO contains all necessary references.
+     */
+    references: AutoBeRealizeCollectorReference[];
+  }
+}