KvdbApi.hpp

#ifndef _PRIVMXLIB_ENDPOINT_KVDB_KVDBAPI_HPP_
#define _PRIVMXLIB_ENDPOINT_KVDB_KVDBAPI_HPP_
 
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
#include "privmx/endpoint/core/Connection.hpp"
#include "privmx/endpoint/core/Types.hpp"
#include "privmx/endpoint/kvdb/Types.hpp"
#include <privmx/endpoint/core/ExtendedPointer.hpp>
 
namespace privmx {
namespace endpoint {
namespace kvdb {
 
class KvdbApiImpl;

class KvdbApi : public privmx::endpoint::core::ExtendedPointer<KvdbApiImpl> {
public:
    static KvdbApi create(core::Connection& connection);

    KvdbApi();
    KvdbApi(const KvdbApi& obj);
    KvdbApi& operator=(const KvdbApi& obj);
    KvdbApi(KvdbApi&& obj);
    ~KvdbApi();

    std::string createKvdb(
        const std::string& contextId,
        const std::vector<core::UserWithPubKey>& users,
        const std::vector<core::UserWithPubKey>& managers,
        const core::Buffer& publicMeta,
        const core::Buffer& privateMeta,
        const std::optional<core::ContainerPolicy>& policies = std::nullopt
    );

    void updateKvdb(
        const std::string& kvdbId,
        const std::vector<core::UserWithPubKey>& users,
        const std::vector<core::UserWithPubKey>& managers,
        const core::Buffer& publicMeta,
        const core::Buffer& privateMeta,
        const int64_t version,
        const bool force,
        const bool forceGenerateNewKey,
        const std::optional<core::ContainerPolicy>& policies = std::nullopt
    );

    void deleteKvdb(const std::string& kvdbId);

    Kvdb getKvdb(const std::string& kvdbId);

    core::PagingList<Kvdb> listKvdbs(const std::string& contextId, const core::PagingQuery& pagingQuery);

    KvdbEntry getEntry(const std::string& kvdbId, const std::string& key);

    bool hasEntry(const std::string& kvdbId, const std::string& key);

    core::PagingList<std::string> listEntriesKeys(const std::string& kvdbId, const core::PagingQuery& pagingQuery);

    core::PagingList<KvdbEntry> listEntries(const std::string& kvdbId, const core::PagingQuery& pagingQuery);

    void setEntry(
        const std::string& kvdbId,
        const std::string& key,
        const core::Buffer& publicMeta,
        const core::Buffer& privateMeta,
        const core::Buffer& data,
        int64_t version = 0
    );

    void deleteEntry(const std::string& kvdbId, const std::string& key);

    std::map<std::string, bool> deleteEntries(const std::string& kvdbId, const std::vector<std::string>& keys);

    std::vector<std::string> subscribeFor(const std::vector<std::string>& subscriptionQueries);

    void unsubscribeFrom(const std::vector<std::string>& subscriptionIds);

    std::string buildSubscriptionQuery(
        EventType eventType,
        EventSelectorType selectorType,
        const std::string& selectorId
    );

    std::string buildSubscriptionQueryForSelectedEntry(
        EventType eventType,
        const std::string& kvdbId,
        const std::string& kvdbEntryKey
    );
 
private:
    KvdbApi(const std::shared_ptr<KvdbApiImpl>& impl);
};
 
} // namespace kvdb
} // namespace endpoint
} // namespace privmx
 
#endif // _PRIVMXLIB_ENDPOINT_KVDB_KVDBAPI_HPP_