SchemaGenerator.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2025 nfx
 *
 * 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 <optional>
#include <string>
#include <string_view>
#include <vector>
 
#include "Document.h"
 
namespace nfx::serialization::json
{
    //=====================================================================
    // SchemaGenerator class
    //=====================================================================

    class SchemaGenerator final
    {
    public:
        //----------------------------------------------
        // Options
        //----------------------------------------------

        struct Options
        {
            bool inferFormats = true;      
            bool inferConstraints = false; 
            bool detectEnums = false;      
            size_t enumThreshold = 10;     
            std::string title = {};        
            std::string description = {};  
            std::string id = {};           
        };
 
        //----------------------------------------------
        // Construction
        //----------------------------------------------

        explicit SchemaGenerator( const Document& document );

        SchemaGenerator( const Document& document, const Options& options );

        explicit SchemaGenerator( const std::vector<Document>& documents );

        SchemaGenerator( const std::vector<Document>& documents, const Options& options );

        SchemaGenerator( const SchemaGenerator& ) = default;

        SchemaGenerator( SchemaGenerator&& ) noexcept = default;
 
        //----------------------------------------------
        // Destruction
        //----------------------------------------------

        ~SchemaGenerator() = default;
 
        //----------------------------------------------
        // Assignment
        //----------------------------------------------

        SchemaGenerator& operator=( const SchemaGenerator& ) = default;

        SchemaGenerator& operator=( SchemaGenerator&& ) noexcept = default;
 
        //----------------------------------------------
        // Accessors
        //----------------------------------------------

        const Document& schema() const noexcept { return m_schema; }
 
    private:
        //----------------------------------------------
        // Internal methods
        //----------------------------------------------

        void addMetadata();

        Document generateSchema( const Document& value ) const;
 
        //----------------------------------------------
        // Member data
        //----------------------------------------------
 
        Document m_schema; 
        Options m_options; 
    };
} // namespace nfx::serialization::json