entity.h

Go to the documentation of this file.

 
#ifndef MANTISBASE_ENTITY_H
#define MANTISBASE_ENTITY_H
 
#include <string>
#include "mantisbase/mantis.h"
#include "mantisbase/core/exceptions.h"
#include "mantisbase/utils/soci_wrappers.h"
#include "../types.h"
#include "access_rules.h"
 
namespace mb {
    using Record = nlohmann::json;  
    using Records = std::vector<Record>;  
 
    class Entity {
    public:
        explicit Entity(const nlohmann::json &schema);
        
        explicit Entity(const std::string &name, const std::string& type);
 
        // --------------- DB TABLE OPS ------------------ //
        [[nodiscard]] std::string id() const;
 
        [[nodiscard]] std::string name() const;
 
        [[nodiscard]] std::string type() const;
 
        [[nodiscard]] bool isSystem() const;
 
        [[nodiscard]] bool hasApi() const;
 
        [[nodiscard]] std::string viewQuery() const;
 
        [[nodiscard]] const std::vector<json> &fields() const;
        
        [[nodiscard]] std::optional<json> field(const std::string& field_name) const;
        
        [[nodiscard]] std::optional<json> hasField(const std::string& field_name) const;
 
        [[nodiscard]] const json& rules() const;
 
        [[nodiscard]] AccessRule listRule() const;
 
        [[nodiscard]] AccessRule getRule() const;
 
        [[nodiscard]] AccessRule addRule() const;
 
        [[nodiscard]] AccessRule updateRule() const;
 
        [[nodiscard]] AccessRule deleteRule() const;
 
        // --------------- DB CRUD OPS ------------------ //
        [[nodiscard]] Record create(const json &record, const json &opts = json::object()) const;
 
        [[nodiscard]] Records list(const json &opts = json::object()) const;
 
        [[nodiscard]] std::optional<Record> read(const std::string &id, const json &opts = json::object()) const;
 
        [[nodiscard]] Record update(const std::string &id, const json &data, const json &opts = json::object()) const;
 
        void remove(const std::string &id) const;
 
        // --------------- SCHEMA OPS ------------------ //
        [[nodiscard]] const json &schema() const;
 
        [[nodiscard]] int countRecords() const;
 
        [[nodiscard]] bool isEmpty() const;
 
        // --------------- UTILITY OPS ------------------ //
        [[nodiscard]] bool recordExists(const std::string &id) const;
 
        [[nodiscard]] std::optional<json> findField(const std::string &field_name) const;
 
        [[nodiscard]] std::optional<json> queryFromCols(const std::string &value,
                                                        const std::vector<std::string> &columns) const;
 
        // --------------- SCHEMA ROUTING ------------------ //
        [[nodiscard]] HandlerFn getOneRouteHandler() const;
 
        [[nodiscard]] HandlerFn getManyRouteHandler() const;
 
        [[nodiscard]] HandlerWithContentReaderFn postRouteHandler() const;
 
        [[nodiscard]] HandlerWithContentReaderFn patchRouteHandler() const;
 
        [[nodiscard]] HandlerFn deleteRouteHandler() const;
 
        void createEntityRoutes() const;
 
    private:
        nlohmann::json m_schema;
    };
} // mb
 
#endif //MANTISBASE_ENTITY_H