/*
  SPDX-FileCopyrightText: 2025-2026 Laurent Montel <montel@kde.org>

  SPDX-License-Identifier: GPL-2.0-or-later
*/

#pragma once
#include "textautogeneratetext_export.h"
#include <QJsonObject>
#include <QObject>
#include <TextAutoGenerateText/TextAutoGenerateAttachmentUtils>
#include <TextAutoGenerateText/TextAutoGenerateReply>
#include <TextAutoGenerateText/TextAutoGenerateTextToolPluginProperty>
namespace TextAutoGenerateText
{
class TextAutoGenerateTextToolPluginJob;
/*!
 * \class TextAutoGenerateText::TextAutoGenerateTextToolPlugin
 * \brief The TextAutoGenerateTextToolPlugin class
 * \author Laurent Montel <montel@kde.org>
 * \inmodule TextAutoGenerateText
 * \inheaderfile TextAutoGenerateText/TextAutoGenerateTextToolPlugin
 */
class TEXTAUTOGENERATETEXT_EXPORT TextAutoGenerateTextToolPlugin : public QObject
{
    Q_OBJECT
public:
    struct TEXTAUTOGENERATETEXT_EXPORT TextToolPluginInfo {
        QString content;
        QByteArray messageUuid;
        QByteArray chatId;
        QByteArray toolIdentifier;
        QList<TextAutoGenerateAttachmentUtils::AttachmentElementInfo> attachementInfoList;
    };

    /*!
     */
    explicit TextAutoGenerateTextToolPlugin(QObject *parent = nullptr);
    /*!
     */
    ~TextAutoGenerateTextToolPlugin() override;

    /*!
     */
    [[nodiscard]] virtual QString displayName() const = 0;
    /*!
     */
    [[nodiscard]] virtual QString description() const = 0;
    /*!
     */
    [[nodiscard]] virtual int order() const = 0;

    /*!
     */
    [[nodiscard]] QJsonObject metadata();

    /*!
     */
    [[nodiscard]] bool enabled() const;
    /*!
     */
    void setEnabled(bool newEnabled);

    /*!
     */
    [[nodiscard]] QByteArray toolNameId() const;
    /*!
     */
    void setToolNameId(const QByteArray &newToolName);

    /*!
     */
    virtual void showConfigureDialog(QWidget *parent = nullptr);

    /*!
     */
    [[nodiscard]] bool isValid() const;

    /*!
     */
    [[nodiscard]] QList<TextAutoGenerateTextToolPluginProperty> properties() const;
    /*!
     */
    void setProperties(const QList<TextAutoGenerateTextToolPluginProperty> &newProperties);

    /*!
     */
    [[nodiscard]] virtual TextAutoGenerateText::TextAutoGenerateTextToolPluginJob *callTool() = 0;

    /*!
     */
    [[nodiscard]] virtual QString iconName() const;

    /*!
     */
    [[nodiscard]] QStringList required() const;
    /*!
     */
    void setRequired(const QStringList &newRequired);

protected:
    /*!
     */
    [[nodiscard]] QJsonObject generateMetadata() const;
    QList<TextAutoGenerateTextToolPluginProperty> mProperties;
    QStringList mRequired;
    QByteArray mToolNameId;
    QJsonObject mMetaData;
    bool mEnabled = true;
};
}
TEXTAUTOGENERATETEXT_EXPORT QDebug operator<<(QDebug d, const TextAutoGenerateText::TextAutoGenerateTextToolPlugin::TextToolPluginInfo &t);
