AutoBE
    Preparing search index...

    Interface AutoBeInterfaceSchemaRenameEvent

    Event emitted when DTO type names are validated and refactored for naming compliance.

    This event is dispatched during the Interface phase when the Schema Rename agent analyzes existing DTO type names against Prisma table names to detect violations of the critical naming convention: ALL words from the Prisma table name MUST be preserved in the DTO type name.

    The agent identifies type names that incorrectly omit service prefixes or intermediate components and provides refactoring operations to fix them.

    Common violations detected:

    • Service prefix omission: ISale should be IShoppingSale
    • Intermediate word omission: IBbsComment should be IBbsArticleComment
    • Multiple words omitted: IShoppingRefund should be IShoppingOrderGoodRefund

    The orchestrator automatically applies these refactorings to:

    • Base types (e.g., ISale)
    • All variants (e.g., ISale.ICreate, ISale.IUpdate, ISale.ISummary)
    • Page types (e.g., IPageISale)
    • All $ref references throughout the OpenAPI document
      {
        type: "interfaceSchemaRename",
        id: "uuid-v7",
        refactors: [
          { from: "ISale", to: "IShoppingSale" },
          { from: "IBbsComment", to: "IBbsArticleComment" }
        ],
        total: 100,
        completed: 50,
        tokenUsage: { input: 1000, output: 200 },
        created_at: "2025-01-23T12:34:56.789Z"
      }

    AutoBeInterfaceSchemaRefactor for individual refactoring operations

    interface AutoBeInterfaceSchemaRenameEvent {
        completed: number;
        created_at: string & Format<"date-time">;
        id: string;
        metric: AutoBeFunctionCallingMetric;
        refactors: AutoBeInterfaceSchemaRefactor[];
        tokenUsage: IComponent;
        total: number;
        type: "interfaceSchemaRename";
    }

    Hierarchy (View Summary)

    Index

    Properties

    completed created_at id metric refactors tokenUsage total type

    Properties

    completed: number

    Number of items completed.

    Tracks how many items have been successfully processed so far in the current operation. This value increments as each item is completed, providing real-time progress indication.

    The ratio of completed to total gives the completion percentage: progress = (completed / total) * 100

    created_at: string & Format<"date-time">

    Timestamp when the event was created.

    ISO 8601 formatted date-time string indicating when this event was emitted by the system. This timestamp is crucial for event ordering, performance analysis, and debugging the agent workflow execution timeline.

    Format: "YYYY-MM-DDTHH:mm:ss.sssZ" (e.g., "2024-01-15T14:30:45.123Z")

    id: string

    A unique identifier for the event.

    metric: AutoBeFunctionCallingMetric

    Function calling trial statistics (total, success, failure counts).

    refactors: AutoBeInterfaceSchemaRefactor[]

    List of DTO type name refactoring operations to fix naming violations.

    Each refactor specifies a base type name that needs to be renamed from an incorrect form (omitting words) to the correct form (preserving all table name components).

    An empty array indicates no violations were detected - all type names correctly preserve their table name components.

      [
        { from: "ISale", to: "IShoppingSale" },
        { from: "IBbsComment", to: "IBbsArticleComment" },
        { from: "IShoppingRefund", to: "IShoppingOrderGoodRefund" }
      ]
    tokenUsage: IComponent

    Token consumption breakdown (input, output, cache hits).

    total: number

    Total number of items to process.

    Represents the complete count of operations, files, endpoints, or other entities that need to be processed in the current workflow step. This value is typically determined at the beginning of an operation and remains constant throughout the process.

    Used together with the completed field to calculate progress percentage and estimate time to completion.

    type: "interfaceSchemaRename"

    Unique identifier for the event type.

    A literal string that discriminates between different event types in the AutoBE system. This field enables TypeScript's discriminated union feature, allowing type-safe event handling through switch statements or conditional checks.

    Examples: "analyzeWrite", "databaseSchema", "interfaceOperation", "testScenario"

    Settings

    Member Visibility

    On This Page

    Properties