@autobe/agent/lib/orchestrate/realize/structures/IAutoBeRealizeTransformerPlanApplication.d.ts

AI backend server code generator

import { IAutoBePreliminaryComplete } from "../../common/structures/IAutoBePreliminaryComplete";
import { IAutoBePreliminaryGetAnalysisSections } from "../../common/structures/IAutoBePreliminaryGetAnalysisSections";
import { IAutoBePreliminaryGetDatabaseSchemas } from "../../common/structures/IAutoBePreliminaryGetDatabaseSchemas";
import { IAutoBePreliminaryGetInterfaceSchemas } from "../../common/structures/IAutoBePreliminaryGetInterfaceSchemas";
/**
 * Plans whether a single DTO needs a transformer. Sets databaseSchemaName to
 * null for non-transformable DTOs.
 *
 * **Key Decisions**: Not all DTOs require transformers. Distinguish
 * transformable DTOs (Read DTO + DB-backed + direct mapping) from
 * non-transformable DTOs (request params, pagination wrappers, business logic
 * types).
 */
export interface IAutoBeRealizeTransformerPlanApplication {
    /**
     * Analyzes the given DTO type and generates a plan entry determining whether
     * a transformer is needed. Returns exactly ONE plan entry.
     *
     * @param props Preliminary data request, write submission, or completion
     *   confirmation
     */
    process(props: IAutoBeRealizeTransformerPlanApplication.IProps): void;
}
export declare namespace IAutoBeRealizeTransformerPlanApplication {
    interface IProps {
        /**
         * Think before you act.
         *
         * For preliminary requests: what schemas (database or DTO) are missing?
         *
         * For write: is this DTO transformable or non-transformable? What database
         * table does it map to (if transformable)?
         *
         * For complete: why you consider the decision final.
         */
        thinking: string;
        /**
         * Action to perform. Exhausted preliminary types are removed from the
         * union, physically preventing repeated calls.
         */
        request: IWrite | IAutoBePreliminaryGetAnalysisSections | IAutoBePreliminaryGetDatabaseSchemas | IAutoBePreliminaryGetInterfaceSchemas | IAutoBePreliminaryComplete;
    }
    /**
     * Generates exactly ONE plan entry indicating transformable (has DB schema
     * name) or not (null).
     */
    interface IWrite {
        /** Type discriminator for write submission. */
        type: "write";
        /**
         * Exactly ONE entry. databaseSchemaName non-null = transformable, null = no
         * transformer needed.
         */
        plans: IPlan[];
    }
    /** Planning decision for one DTO. */
    interface IPlan {
        /**
         * TypeScript interface type from the operation response (e.g.,
         * "IShoppingSaleUnitStock").
         */
        dtoTypeName: string;
        /**
         * Reasoning for this DTO's planning decision.
         *
         * Transformable: "Transforms shopping_sales to IShoppingSale with nested
         * category and tags".
         *
         * Non-transformable: "IPage.IRequest is pagination parameter, not
         * DB-backed".
         */
        thinking: string;
        /**
         * Database table name if transformable (e.g., "shopping_sales"), null if
         * non-transformable (request param, pagination wrapper, business logic).
         */
        databaseSchemaName: string | null;
    }
}