namespace NpgsqlRest;

/// <summary>

/// Base interface for endpoint sources. Provides the minimal contract needed

/// to yield routines into the NpgsqlRest pipeline.

/// </summary>

public interface IEndpointSource

{

/// <summary>

/// Comments mode for the current source.

/// </summary>

CommentsMode? CommentsMode { get; set; }

/// <summary>

/// When true, composite type columns in the response are serialized as nested JSON objects.

/// For example, a column "req" of type "my_request(id int, name text)" becomes {"req": {"id": 1, "name": "test"}}

/// instead of the default flat structure {"id": 1, "name": "test"}.

/// Default is false.

/// </summary>

bool NestedJsonForCompositeTypes { get; set; }

/// <summary>

/// Yield all routines with the formatters from the current source.

/// </summary>

/// <param name="serviceProvider">Service provider</param>

/// <param name="retryStrategy"></param>

/// <returns></returns>

IEnumerable<(Routine, IRoutineSourceParameterFormatter)> Read(IServiceProvider? serviceProvider, RetryStrategy? retryStrategy);

}

/// <summary>

/// Extended endpoint source interface for database catalog-based sources (functions, procedures, tables, views).

/// Adds query filtering properties for schema/name patterns.

/// </summary>

public interface IRoutineSource : IEndpointSource

{

/// <summary>

/// SQL Query that returns data source.

/// When it doesn't contain any blanks, it is interpreted as a function name.

/// Set to NULL to use default source query.

/// </summary>

string? Query { get; set; }

/// <summary>

/// Query parameter

/// </summary>

string? SchemaSimilarTo { get; set; }

/// <summary>

/// Query parameter

/// </summary>

string? SchemaNotSimilarTo { get; set; }

/// <summary>

/// Query parameter

/// </summary>

string[]? IncludeSchemas { get; set; }

/// <summary>

/// Query parameter

/// </summary>

string[]? ExcludeSchemas { get; set; }

/// <summary>

/// Query parameter

/// </summary>

string? NameSimilarTo { get; set; }

/// <summary>

/// Query parameter

/// </summary>

string? NameNotSimilarTo { get; set; }

/// <summary>

/// Query parameter

/// </summary>

string[]? IncludeNames { get; set; }

/// <summary>

/// Query parameter

/// </summary>

string[]? ExcludeNames { get; set; }

}