// SPDX-License-Identifier: MIT

pragma solidity ^0.8.15;
import {Types} from 'contracts/libraries/constants/Types.sol';

/**
 * @title IReferenceModule
 * @author Lens Protocol
 *
 * @notice This is the standard interface for all Lens-compatible ReferenceModules.
 */
interface IReferenceModule {
    /**
     * @notice Initializes data for a given publication being published. This can only be called by the hub.
     *
     * @param profileId The token ID of the profile publishing the publication.
     * @param executor The owner or an approved delegated executor.
     * @param pubId The associated publication's LensHub publication ID.
     * @param data Arbitrary data passed from the user to be decoded.
     *
     * @return bytes An abi encoded byte array encapsulating the execution's state changes. This will be emitted by the
     * hub alongside the collect module's address and should be consumed by front ends.
     */
    function initializeReferenceModule(
        uint256 profileId,
        address executor,
        uint256 pubId,
        bytes calldata data
    ) external returns (bytes memory);

    /**
     * @notice Processes a comment action referencing a given publication. This can only be called by the hub.
     *
     * @param profileId The token ID of the profile associated with the publication being published.
     * @param executor The commenter or an approved delegated executor.
     * @param pointedProfileId The profile ID of the profile associated the publication being referenced.
     * @param pointedPubId The publication ID of the publication being referenced.
     * @param referrerProfileId The ID of the profile authoring the mirror if the comment was done through it, zero if
     the comment was performed directly through the original publication.
     * @param data Arbitrary data __passed from the commenter!__ to be decoded.
     */
    function processComment(
        uint256 profileId,
        address executor,
        uint256 pointedProfileId,
        uint256 pointedPubId,
        uint256 referrerProfileId,
        uint256 referrerPubId,
        Types.PublicationType referrerPubType,
        bytes calldata data
    ) external;

    /**
     * @notice Processes a quote action referencing a given publication. This can only be called by the hub.
     *
     * @param profileId The token ID of the profile associated with the publication being published.
     * @param executor The profile owner or an approved delegated executor.
     * @param pointedProfileId The profile ID of the profile associated the publication being quoted.
     * @param pointedPubId The publication ID of the publication being quoted.
     * @param referrerProfileId The ID of the profile authoring the mirror if the quote was done through it, zero if
     the quote was performed directly through the original publication. // TODO: is this correct?
     * @param data Arbitrary data __passed from the executor!__ to be decoded.
     */
    function processQuote(
        uint256 profileId,
        address executor,
        uint256 pointedProfileId,
        uint256 pointedPubId,
        uint256 referrerProfileId,
        uint256 referrerPubId,
        Types.PublicationType referrerPubType,
        bytes calldata data
    ) external;

    /**
     * @notice Processes a mirror action referencing a given publication. This can only be called by the hub.
     *
     * @param profileId The token ID of the profile associated with the publication being published.
     * @param executor The mirror creator or an approved delegated executor.
     * @param pointedProfileId The profile ID of the profile associated the publication being referenced.
     * @param pointedPubId The publication ID of the publication being referenced.
     * @param data Arbitrary data __passed from the mirrorer!__ to be decoded.
     */
    function processMirror(
        uint256 profileId,
        address executor,
        uint256 pointedProfileId,
        uint256 pointedPubId,
        uint256 referrerProfileId,
        uint256 referrerPubId,
        Types.PublicationType referrerPubType,
        bytes calldata data
    ) external;
}