resource_templates.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/resource_keys.hpp"
 
#include <nlohmann/json.hpp>
 
#include <cstdint>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
namespace reusex::core {
 
enum class MemberKind { category, key };
struct TemplateMember {
  MemberKind kind = MemberKind::key;
  std::string ref; 
  bool operator==(const TemplateMember &) const = default;
};

std::vector<TemplateMember> parse_members(const nlohmann::json &members);
std::vector<TemplateMember> read_members(std::string_view stored,
                                         std::string_view template_name);
nlohmann::json members_json(const std::vector<TemplateMember> &members);
 
struct ResolvedTemplate {
  std::vector<std::string> keys;       
  std::vector<TemplateMember> missing; 
};

ResolvedTemplate resolve_template(const std::vector<TemplateMember> &members,
                                  const std::vector<ResourceKey> &catalogue);
 
inline constexpr std::string_view kSeedMaterialepas = "materialepas";
inline constexpr std::string_view kSeedScreening = "screening";
struct SeedTemplate {
  std::string tag, name;
  std::vector<TemplateMember> members;
};

std::vector<SeedTemplate> seed_templates();

struct CsvOptions {
  std::string delimiter = ";";                     
  std::string encoding = "utf-8-bom";              
  std::string header = "label";                    
  nlohmann::json extra = nlohmann::json::object(); 
};

CsvOptions parse_csv_options(const nlohmann::json &csv);
CsvOptions read_csv_options(std::string_view stored,
                            std::string_view template_name);
nlohmann::json csv_options_json(const CsvOptions &options);

inline constexpr std::string_view kLegacyKeyPrefix = "legacy:";
TemplateMember legacy_column_member(std::string_view column,
                                    const std::vector<ResourceKey> &catalogue);
std::string unique_name(std::string_view base, std::string_view tag,
                        const std::vector<std::string> &taken);
 
// ---- Template service over ProjectDB --------------------------------------

struct TemplateView {
  ProjectDB::ResourceTemplateRecord record;
  std::vector<TemplateMember> members;
  CsvOptions csv;
  ResolvedTemplate resolved;
};

std::vector<TemplateView> template_views(const ProjectDB &db);
TemplateView template_view(const ProjectDB &db, int64_t id);

struct TemplateInput {
  std::optional<std::string> name;
  std::optional<nlohmann::json> members, csv;
};

TemplateView create_template(ProjectDB &db, const TemplateInput &input);
TemplateView update_template(ProjectDB &db, int64_t id,
                             const TemplateInput &input);
void delete_template(ProjectDB &db, int64_t id);
TemplateView duplicate_template(ProjectDB &db, int64_t id);
std::vector<TemplateView> restore_seed_templates(ProjectDB &db);
 
} // namespace reusex::core