AutoBE
    Preparing search index...

    Interface AutoBeRealizeAuthorizationWriteEvent

    Event fired when the Realize Authorization agent writes authorization-related implementation files.

    This event represents the generation of authorization components including decorators, providers, and payload interfaces that enable role-based access control throughout the application. The event occurs during the authorization implementation phase where security policies defined in the API specification are transformed into working authorization code.

    The generated authorization files include custom decorators for endpoint protection, payload interfaces for JWT token structure, and provider functions that handle authorization logic validation and enforcement.

    Michael

    interface AutoBeRealizeAuthorizationWriteEvent {
        authorization: AutoBeRealizeAuthorization;
        completed: number;
        created_at: string & Format<"date-time">;
        id: string;
        step: number;
        tokenUsage: IAutoBeTokenUsageJson.IComponent;
        total: number;
        type: "realizeAuthorizationWrite";
    }

    Hierarchy (View Summary)

    Index

    Properties

    Authorization implementation details being written.

    Contains the complete authorization component specification including the role name, decorator implementation, payload interface, and provider function. This object represents a single authorization component that will be generated for a specific user role in the system.

    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.

    step: number

    Iteration number of the requirements analysis this authorization implementation reflects.

    Indicates which version of the requirements analysis this authorization work is based on. This step number ensures that the authorization implementation is aligned with the current requirements and helps track the development of access control components as they evolve with changing business needs.

    The step value enables proper synchronization between authorization implementation and the underlying requirements, ensuring that the generated authentication and authorization code remains relevant to the current project scope and security requirements.

    Detailed token usage metrics for the current operation.

    Contains comprehensive token consumption data including total usage, input token breakdown with cache statistics, and output token categorization by generation type. This component-level tracking enables precise analysis of resource utilization for specific agent operations such as schema generation, test writing, or code implementation.

    The token usage data helps identify optimization opportunities, monitor operational costs, and ensure efficient use of AI resources throughout the automated backend development process.

    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: "realizeAuthorizationWrite"

    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", "prismaSchemas", "interfaceOperations", "testScenarios"