/* ========================================================================
 * Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
 *
 * OPC Foundation MIT License 1.00
 *
 * 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.
 *
 * The complete license agreement can be found here:
 * http://opcfoundation.org/License/MIT/1.00/
 * ======================================================================*/

using System.Collections.Generic;
using Opc.Ua.Schema.Model;

namespace Opc.Ua.SourceGeneration
{
    /// <summary>
    /// Interface for generator context to enable testing and dependency injection.
    /// </summary>
    public interface IGeneratorContext
    {
        /// <summary>
        /// File system to use for file operations.
        /// </summary>
        IFileSystem FileSystem { get; }

        /// <summary>
        /// Output folder for generated files.
        /// </summary>
        string OutputFolder { get; }

        /// <summary>
        /// Model design validator.
        /// </summary>
        IModelDesign ModelDesign { get; }

        /// <summary>
        /// Telemetry context for logging.
        /// </summary>
        ITelemetryContext Telemetry { get; }

        /// <summary>
        /// Generator options.
        /// </summary>
        GeneratorOptions Options { get; }

        /// <summary>
        /// Models that referenced assemblies have already generated, keyed
        /// by model URI. Used to skip locally generating models a referenced
        /// assembly already provides and to satisfy transitive nodeset
        /// dependencies without requiring the consumer to re-add every
        /// upstream <c>&lt;AdditionalFiles&gt;</c> entry.
        /// </summary>
        IReadOnlyDictionary<string, ModelDependencyReference> ReferencedModels { get; }
    }
}