Fake Mirrors
    Preparing search index...

    Interface LureRepository

    Represents a lure repository.

    interface LureRepository {
        create(
            campaignId: string,
            lureId: string,
            path: string,
            redirectorId: string,
            lockSecret: string,
        ): Promise<void>;
        delete(
            campaignId: string,
            lureId: string,
            redirectorId: string,
            lockSecret: string,
        ): Promise<void>;
        disable(
            campaignId: string,
            lureId: string,
            lockSecret: string,
        ): Promise<void>;
        enable(
            campaignId: string,
            lureId: string,
            lockSecret: string,
        ): Promise<void>;
        find(campaignId: string, path: string): Promise<LureModel | null>;
        list(campaignId: string): Promise<LureModel[] | null>;
        read(campaignId: string, lureId: string): Promise<LureModel | null>;
    }

    Implemented by

    Methods

    • Creates a new lure in the specified campaign.

      The lure will be created in a disabled state (isEnabled = false). Use enable() to activate it for traffic routing.

      Parameters

      • campaignId: string

        The ID of the campaign to create the lure in

      • lureId: string

        The unique identifier for the new lure

      • path: string

        The URL path

      • redirectorId: string

        The ID of the redirector that handles this lure

      • lockSecret: string

        The campaign lock secret obtained from CampaignRepository.lock()

      Returns Promise<void>

      DatabaseError If the campaign does not exist

      DatabaseError If the campaign is not locked

      DatabaseError If the lock secret does not match

      DatabaseError If a lure with the same ID already exists

      DatabaseError If the path is already used by another lure in the campaign

      DatabaseError If the redirector does not exist

    • Delete a lure model by its ID.

      A lure must be disabled before it can be deleted.

      Parameters

      • campaignId: string

        The ID of the campaign containing the lure

      • lureId: string

        The lure ID to delete

      • redirectorId: string

        The ID of the redirector associated with the lure

      • lockSecret: string

        The campaign lock secret obtained from CampaignRepository.lock()

      Returns Promise<void>

      DatabaseError If the campaign does not exist

      DatabaseError If the campaign is not locked

      DatabaseError If the lock secret does not match

      DatabaseError If the lure does not exist

      DatabaseError If the redirector does not exist

      DatabaseError If the lure is still enabled

      DatabaseError If the lure's redirector ID does not match the provided one

    • Disables a lure, stopping request routing.

      When disabled, requests to the URL path will not be routed.

      Parameters

      • campaignId: string

        The ID of the campaign containing the lure

      • lureId: string

        The lure ID to disable

      • lockSecret: string

        The campaign lock secret obtained from CampaignRepository.lock()

      Returns Promise<void>

      DatabaseError If the campaign does not exist

      DatabaseError If the campaign is not locked

      DatabaseError If the lock secret does not match

      DatabaseError If the lure does not exist

    • Enables a lure, making it available for request routing.

      When enabled, the URL path becomes active and can be used to serve the associated redirector content.

      Parameters

      • campaignId: string

        The ID of the campaign containing the lure

      • lureId: string

        The lure ID to enable

      • lockSecret: string

        The campaign lock secret obtained from CampaignRepository.lock()

      Returns Promise<void>

      DatabaseError If the campaign does not exist

      DatabaseError If the campaign is not locked

      DatabaseError If the lock secret does not match

      DatabaseError If the lure does not exist

    • Finds a lure model by its URL path.

      This is the primary routing method for HTTP requests. When a request arrives at a mirror domain, the request path is extracted and used to instantly find the corresponding lure via a direct hash lookup.

      Parameters

      • campaignId: string

        The ID of the campaign to search in

      • path: string

        The URL path

      Returns Promise<LureModel | null>

      The lure model, or null if no lure matches the path

    • Lists all lures in a campaign.

      Lures are ordered by creation time (oldest first).

      Parameters

      • campaignId: string

        The ID of the campaign to list lures for

      Returns Promise<LureModel[] | null>

      An array of lure models, or null if the campaign does not exist

    • Reads a lure model by its ID.

      Parameters

      • campaignId: string

        The ID of the campaign containing the lure

      • lureId: string

        The lure ID to read

      Returns Promise<LureModel | null>

      The lure model, or null if not found

    Methods