Fake Mirrors
    Preparing search index...

    Interface MessageRepository

    Defines the public contract for a message repository.

    A message contains a complete HTTP request/response transaction for analysis. Messages are immutable records that capture all details of a processed request.

    interface MessageRepository {
        clear(campaignId: string): Promise<void>;
        create(
            campaignId: string,
            messageId: string,
            proxyId: string,
            targetId: string,
            sessionId: string,
            type:
                | "normal-simple"
                | "normal-stream-request"
                | "normal-stream-response"
                | "websocket",
            method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS",
            url: string,
            requestHeaders: HttpHeaders,
            requestBody: HttpBody,
            status: number,
            responseHeaders: HttpHeaders,
            responseBody: HttpBody,
            connection: HttpConnection,
            payload: HttpPayload,
            errors: HttpError[],
            analyze: string,
            startTime: number,
            finishTime: number,
        ): Promise<void>;
        createDummy(
            campaignId: string,
            messageId: string,
            proxyId: string,
            targetId: string,
            sessionId: string,
        ): Promise<void>;
        delete(campaignId: string, messageId: string): Promise<void>;
        list(campaignId: string, limit: number): Promise<MessageModel[] | null>;
        read(campaignId: string, messageId: string): Promise<MessageModel | null>;
        readFull(
            campaignId: string,
            messageId: string,
        ): Promise<FullMessageModel | null>;
    }

    Implemented by

    • Clears campaign message history.

      Parameters

      • campaignId: string

        The ID of the campaign to clear message history.

      Returns Promise<void>

      DatabaseError If the campaign does not exist.

      DatabaseError If the data validation fails.

    • Creates a new message.

      Parameters

      • campaignId: string

        The ID of the campaign to create the message in.

      • messageId: string

        The new message ID to create.

      • proxyId: string

        The ID of the proxy that processed this message.

      • targetId: string

        The ID of the target that handled this message.

      • sessionId: string

        The ID of the session that generated this message.

      • type:
            | "normal-simple"
            | "normal-stream-request"
            | "normal-stream-response"
            | "websocket"

        The message type.

      • method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS"

        The HTTP method.

      • url: string

        The HTTP request URL.

      • requestHeaders: HttpHeaders

        The HTTP request headers.

      • requestBody: HttpBody

        The HTTP request body.

      • status: number

        The HTTP status code.

      • responseHeaders: HttpHeaders

        The HTTP response headers.

      • responseBody: HttpBody

        The HTTP response body.

      • connection: HttpConnection

        The connection details.

      • payload: HttpPayload

        The payload data extracted from the transaction.

      • errors: HttpError[]

        The list of errors that occurred during processing.

      • analyze: string

        The analyze identifier.

      • startTime: number

        The start processing timestamp.

      • finishTime: number

        The finish processing timestamp.

      Returns Promise<void>

      DatabaseError If the campaign does not exist.

      DatabaseError If the proxy does not exist.

      DatabaseError If the target does not exist.

      DatabaseError If the session does not exist.

      DatabaseError If a message with the same ID already exists.

      DatabaseError If the data validation fails.

    • Creates a new dummy message.

      This method only increments counters and does not store the actual message data. Useful for tracking traffic without storing full transaction details.

      Parameters

      • campaignId: string

        The ID of the campaign to create the message in.

      • messageId: string

        The new message ID to create.

      • proxyId: string

        The ID of the proxy that processed this message.

      • targetId: string

        The ID of the target that handled this message.

      • sessionId: string

        The ID of the session that generated this message.

      Returns Promise<void>

      DatabaseError If the campaign does not exist.

      DatabaseError If the proxy does not exist.

      DatabaseError If the target does not exist.

      DatabaseError If the session does not exist.

      DatabaseError If a message with the same ID already exists.

      DatabaseError If the data validation fails.

    • Deletes the message by its ID.

      Parameters

      • campaignId: string

        The ID of the campaign containing the message.

      • messageId: string

        The message ID to delete.

      Returns Promise<void>

      DatabaseError If the campaign does not exist.

      DatabaseError If the data validation fails.

    • Lists campaign message history.

      Messages are ordered by creation time (newest first).

      Parameters

      • campaignId: string

        The ID of the campaign to list messages for.

      • limit: number

        Limit on the number of records.

      Returns Promise<MessageModel[] | null>

      The array of message models, or null if the campaign does not exist.

      DatabaseError If the data validation fails.

    • Reads the message by its ID.

      Parameters

      • campaignId: string

        The ID of the campaign containing the message.

      • messageId: string

        The message ID to read.

      Returns Promise<MessageModel | null>

      The message model, or null if the message is not found.

      DatabaseError If the data validation fails.

    • Reads the full message by its ID.

      Parameters

      • campaignId: string

        The ID of the campaign containing the message.

      • messageId: string

        The message ID to read.

      Returns Promise<FullMessageModel | null>

      The full message model, or null if the message is not found.

      DatabaseError If the data validation fails.

    Methods