MnxdomProvenance.h

/*
 * Copyright (C) 2025, Robert Patterson
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#pragma once
 
#include <chrono>
#include <ctime>
#include <iomanip>
#include <sstream>
#include <string_view>
 
#include "BaseTypes.h"
 
namespace mnx {
 
inline constexpr std::string_view MNXDOM_PROVENANCE_KEY = "mnxdom";
inline constexpr int MNXDOM_PROVENANCE_SCHEMA_VERSION = 1;
 
namespace detail {
 
[[nodiscard]] inline std::string makeUtcTimestamp()
{
    const auto now = std::chrono::system_clock::now();
    const std::time_t nowTime = std::chrono::system_clock::to_time_t(now);
    std::tm utcTime {};
#if defined(_WIN32)
    gmtime_s(&utcTime, &nowTime);
#else
    gmtime_r(&nowTime, &utcTime);
#endif
 
    std::ostringstream out;
    out << std::put_time(&utcTime, "%Y-%m-%dT%H:%M:%SZ");
    return out.str();
}
 
} // namespace detail
 
class MnxdomGeneratorInfo : public Object
{
public:
    using Object::Object;
 
    MnxdomGeneratorInfo(Base& parent, std::string_view key)
        : Object(parent, key)
    {
        set_version(MNXDOM_VERSION);
        constexpr std::string_view commit = MNXDOM_GIT_COMMIT;
        if constexpr (!commit.empty()) {
            set_commit(std::string(commit));
        }
        constexpr std::string_view build = MNXDOM_BUILD_ID;
        if constexpr (!build.empty()) {
            set_build(std::string(build));
        }
    }
 
    MNX_REQUIRED_PROPERTY(std::string, version);     
    MNX_OPTIONAL_PROPERTY(std::string, build);       
    MNX_OPTIONAL_PROPERTY(std::string, commit);      
};
 
class MnxdomClientInfo : public Object
{
public:
    using Object::Object;
 
    MNX_REQUIRED_PROPERTY(std::string, name);        
    MNX_OPTIONAL_PROPERTY(std::string, version);     
    MNX_OPTIONAL_PROPERTY(std::string, build);       
    MNX_OPTIONAL_PROPERTY(std::string, commit);      
};
 
class MnxdomSourceInfo : public Object
{
public:
    using Object::Object;
 
    MNX_REQUIRED_PROPERTY(std::string, format);     
    MNX_OPTIONAL_PROPERTY(std::string, version);    
    MNX_OPTIONAL_PROPERTY(std::string, filename);   
};
 
class MnxdomExtensionData : public Object
{
public:
    using Object::Object;
 
    MnxdomExtensionData(Base& parent, std::string_view key)
        : Object(parent, key)
    {
        set_provenanceSchemaVersion(MNXDOM_PROVENANCE_SCHEMA_VERSION);
        set_mnxSchema(getMnxSchemaId());
        create_mnxdom();
        set_createdAt(detail::makeUtcTimestamp());
    }
 
    MNX_REQUIRED_PROPERTY(int, provenanceSchemaVersion);       
    MNX_REQUIRED_PROPERTY(std::string, mnxSchema);             
    MNX_REQUIRED_CHILD(MnxdomGeneratorInfo, mnxdom);            
    MNX_OPTIONAL_CHILD(MnxdomClientInfo, client);               
    MNX_OPTIONAL_CHILD(MnxdomSourceInfo, source);               
    MNX_REQUIRED_PROPERTY(std::string, createdAt);              
    MNX_OPTIONAL_PROPERTY(std::string, modifiedAt);             
    MNX_OPTIONAL_PROPERTY(std::string, documentId);             
};
 
} // namespace mnx