@autobe/agent/lib/orchestrate/interface/structures/IAutoBeInterfaceOperationApplication.d.ts

AI backend server code generator

import { AutoBeOpenApi } from "@autobe/interface";
import { IAutoBePreliminaryComplete } from "../../common/structures/IAutoBePreliminaryComplete";
import { IAutoBePreliminaryGetAnalysisSections } from "../../common/structures/IAutoBePreliminaryGetAnalysisSections";
import { IAutoBePreliminaryGetDatabaseSchemas } from "../../common/structures/IAutoBePreliminaryGetDatabaseSchemas";
import { IAutoBePreliminaryGetPreviousAnalysisSections } from "../../common/structures/IAutoBePreliminaryGetPreviousAnalysisSections";
import { IAutoBePreliminaryGetPreviousDatabaseSchemas } from "../../common/structures/IAutoBePreliminaryGetPreviousDatabaseSchemas";
import { IAutoBePreliminaryGetPreviousInterfaceOperations } from "../../common/structures/IAutoBePreliminaryGetPreviousInterfaceOperations";
export interface IAutoBeInterfaceOperationApplication {
    /**
     * Process operation generation task.
     *
     * @param props Preliminary data request, write submission, or completion
     *   confirmation
     */
    process(props: IAutoBeInterfaceOperationApplication.IProps): void;
}
export declare namespace IAutoBeInterfaceOperationApplication {
    interface IProps {
        /**
         * Think before you act.
         *
         * For preliminary requests: what information is missing and why?
         *
         * For write: what you're submitting and key design decisions.
         *
         * For complete: why you consider the last write final.
         */
        thinking: string;
        /**
         * Action to perform. Exhausted preliminary types are removed from the
         * union, physically preventing repeated calls.
         */
        request: IWrite | IAutoBePreliminaryComplete | IAutoBePreliminaryGetAnalysisSections | IAutoBePreliminaryGetDatabaseSchemas | IAutoBePreliminaryGetPreviousAnalysisSections | IAutoBePreliminaryGetPreviousDatabaseSchemas | IAutoBePreliminaryGetPreviousInterfaceOperations;
    }
    /** Submit a detailed API operation. */
    interface IWrite {
        /** Type discriminator for write submission. */
        type: "write";
        /** Analysis of the endpoint's purpose and context. */
        analysis: string;
        /** Rationale for the operation design decisions. */
        rationale: string;
        /**
         * The API operation to generate.
         *
         * Follow CRUD operation patterns:
         *
         * - List/search (PATCH `index`): include pagination, search, and sorting in
         *   request body
         * - Detail retrieval (GET `at`): return single full entity
         * - Creation (POST): use `.ICreate` request body
         * - Modification (PUT): use `.IUpdate` request body
         *
         * Use object types for request/response bodies, reference named component
         * types, and `application/json` content-type.
         */
        operation: IOperation;
    }
    /**
     * RESTful API operation (excludes authorization and prerequisite fields).
     *
     * Use object types for request/response bodies, reference named component
     * types, use `application/json` content-type, and `string &
     * tags.Format<"uri">` for file operations.
     */
    interface IOperation extends Omit<AutoBeOpenApi.IOperation, "authorizationType" | "authorizationActor" | "prerequisites"> {
    }
}