resources.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Povl Filip Sonne-Frederiksen
//
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once

 
#include "reusex/core/ProjectDB.hpp"
#include "reusex/core/resource_keys.hpp"
 
#include <cstddef>
#include <cstdint>
#include <optional>
#include <stdexcept>
#include <string>
#include <string_view>
#include <vector>
 
namespace reusex::core {
 
struct ResourceValue {
  std::string key;
  std::optional<std::string> value; 
};
struct Resource {
  std::string code;
  int64_t type_id = 0;
  bool manual = false; 
  std::vector<ResourceValue> values;
};

std::optional<std::string> value_of(const Resource &r, std::string_view key);

std::vector<Resource> list_resources(
    const ProjectDB &db,
    const std::optional<std::vector<std::string>> &keys = std::nullopt);
Resource
resource(const ProjectDB &db, std::string_view code,
         const std::optional<std::vector<std::string>> &keys = std::nullopt);
 
struct ResourceWrite {
  std::string key;
  std::optional<std::string> value; 
};
struct ResourcePatchResult {
  Resource resource;
  std::vector<Resource> siblings;
};

ResourcePatchResult patch_resource(
    ProjectDB &db, std::string_view code,
    const std::vector<ResourceWrite> &writes,
    const std::optional<std::vector<std::string>> &keys = std::nullopt);

inline constexpr std::string_view kDesignationField = "designation";
Resource create_resource(ProjectDB &db, int64_t type_id,
                         const std::optional<std::string> &name = std::nullopt);

void delete_resource(ProjectDB &db, std::string_view code);
struct SurveyTypeDeletion {
  std::size_t parts_deleted = 0;
  std::size_t instances_dismissed = 0; 
};
SurveyTypeDeletion delete_survey_type(ProjectDB &db, int64_t type_id);

struct ColumnPatch {
  std::optional<std::string> name, type;
  std::optional<std::vector<std::string>> options;
  std::optional<int> sort_order, width;
};

ProjectDB::PropertyDefinition create_column(ProjectDB &db,
                                            ProjectDB::PropertyDefinition def);
void delete_column(ProjectDB &db, const std::string &id);
ProjectDB::PropertyDefinition
update_column(ProjectDB &db, const std::string &id, const ColumnPatch &patch);
 
} // namespace reusex::core