@autobe/agent/lib/orchestrate/realize/utils/getRealizeWriteCodeTemplate.d.ts

AI backend server code generator

import { AutoBeOpenApi, AutoBeRealizeAuthorization } from "@autobe/interface";
import { IAutoBeRealizeScenarioResult } from "../structures/IAutoBeRealizeScenarioResult";
/**
 * Generate a TypeScript function template for the Realize Agent to complete
 *
 * This utility creates a function skeleton with proper imports, parameters, and
 * return type that the AI needs to implement. The template includes:
 *
 * - Import statements for required dependencies
 * - Function signature with all parameters
 * - Return type specification
 *
 * @example
 *   // Returns a template like:
 *   ```typescript
 *   import { MyGlobal } from "../MyGlobal";
 *   // ... other imports
 *
 *   async function post__users_create(props: {
 *     body: IUserCreateRequest
 *   }): Promise<IUserResponse> {
 *     ...
 *   }
 *   ```;
 *
 * @param scenario - The realize scenario containing function metadata
 * @param operation - OpenAPI operation definition
 * @param authorization - Authorization context if endpoint is authenticated
 * @returns Complete TypeScript code template as a formatted string
 */
export declare function getRealizeWriteCodeTemplate(props: {
    scenario: IAutoBeRealizeScenarioResult;
    operation: AutoBeOpenApi.IOperation;
    schemas: Record<string, AutoBeOpenApi.IJsonSchemaDescriptive>;
    authorization: AutoBeRealizeAuthorization | null;
}): string;