namespace NpgsqlRest.TsClient;

public class TsClientOptions

{

/// <summary>

/// File path for the generated code. Set to null to skip the code generation. Use {0} to set schema name when BySchema is true

/// </summary>

public string? FilePath { get; set; } = null!;

/// <summary>

/// Force file overwrite.

/// </summary>

public bool FileOverwrite { get; set; } = false;

/// <summary>

/// Include current host information in the URL prefix.

/// </summary>

public bool IncludeHost { get; set; } = false;

/// <summary>

/// Set the custom host prefix information.

/// </summary>

public string? CustomHost { get; set; } = null;

/// <summary>

/// Adds comment header to above request based on PostgreSQL routine

/// Set None to skip.

/// Set Simple (default) to add name, parameters and return values to comment header.

/// Set Full to add the entire routine code as comment header.

/// </summary>

public CommentHeader CommentHeader { get; set; } = CommentHeader.Simple;

/// <summary>

/// When CommentHeader is set to Simple or Full, set to true to include routine comments in comment header.

/// </summary>

public bool CommentHeaderIncludeComments { get; set; } = true;

/// <summary>

/// Set to true to include status code in response: {status: response.status, response: model}

/// </summary>

public bool IncludeStatusCode { get; set; } = false;

/// <summary>

/// Create files by PostgreSQL schema. File name will use formatted FilePath where {0} is is the schema name in the pascal case.

/// </summary>

public bool BySchema { get; set; } = false;

/// <summary>

/// Create separate file with global types {name}Types.d.ts

/// </summary>

public bool CreateSeparateTypeFile { get; set; } = true;

/// <summary>

/// Emit request/response (and composite) interfaces with the `export` keyword so they can be imported by other modules.

/// When false (default), interfaces are emitted as plain `interface` declarations (module-private when inline, ambient/global in the separate `.d.ts` file).

/// When true and CreateSeparateTypeFile is true, the separate type file becomes an importable module (`{name}Types.ts` with `export interface`) instead of an ambient `{name}Types.d.ts`, and the generated client file imports the named types from it.

/// Has no effect when SkipTypes is true.

/// </summary>

public bool ExportTypes { get; set; } = false;

/// <summary>

/// Lines to add to each header. {0} format placeholder is current timestamp

/// </summary>

public List<string> HeaderLines { get; set; } = ["// autogenerated at {0}", "", ""];

/// <summary>

/// Module name to import "baseUrl" constant, instead of defining it in a module.

/// </summary>

public string? ImportBaseUrlFrom { get; set; } = null;

/// <summary>

/// Module name to import "pasreQuery" function, instead of defining it in a module.

/// </summary>

public string? ImportParseQueryFrom { get; set; } = null;

/// <summary>

/// Include optional parameter `parseUrl: (url: string) => string = url=>url` that will parse constructed url.

/// </summary>

public bool IncludeParseUrlParam { get; set; } = false;

/// <summary>

/// Include optional parameter `parseRequest: (request: RequestInit) => RequestInit = request=>request` that will parse constructed request.

/// </summary>

public bool IncludeParseRequestParam { get; set; } = false;

/// <summary>

/// Array of routine names to skip (without schema)

/// </summary>

public string[] SkipRoutineNames { get; set; } = [];

/// <summary>

/// Array of generated function names to skip (without schema)

/// </summary>

public string[] SkipFunctionNames { get; set; } = [];

/// <summary>

/// Array of url paths to skip

/// </summary>

public string[] SkipPaths { get; set; } = [];

/// <summary>

/// Array of schema names to skip

/// </summary>

public string[] SkipSchemas { get; set; } = [];

/// <summary>

/// Default TypeScript type for JSON types.

/// </summary>

public string DefaultJsonType { get; set; } = "any";

/// <summary>

/// Use routine name instead of endpoint name when generating a function name.

/// </summary>

public bool UseRoutineNameInsteadOfEndpoint { get; set; } = false;

/// <summary>

/// Export URLs as constants.

/// </summary>

public bool ExportUrls { get; set; } = false;

/// <summary>

/// Skip generating types and produce pure JavaScript code. Setting this to true will also change .ts extension to .js where applicable.

/// </summary>

public bool SkipTypes { get; set; } = false;

/// <summary>

/// Keep TypeScript models unique, meaning, models will same fields and types will be merged into one model with name of the last model. Significantly reduces number of generated models.

/// </summary>

public bool UniqueModels { get; set; } = false;

/// <summary>

/// Name of the header to use for XSRF token. Set to null to skip.

/// </summary>

public string? XsrfTokenHeaderName { get; set; } = null;

/// <summary>

/// Export event sources create functions for streaming events.

/// </summary>

public bool ExportEventSources { get; set; } = true;

/// <summary>

/// List if custom imports to add to the generated code. It adds line to a file. Use full expression like `import { MyType } from './my-type';`

/// </summary>

public string[] CustomImports { get; set; } = [];

/// <summary>

/// List if custom headers to add to the each request in generated code. Header key is automatically quoted if it doesn't contain quotes.

/// </summary>

public Dictionary<string, string> CustomHeaders { get; set; } = [];

/// <summary>

/// When true, include PostgreSQL schema name in the generated type names to avoid name collisions. Set to false to simplify type names when no name collisions are expected.

/// </summary>

public bool IncludeSchemaInNames { get; set; } = false;

/// <summary>

/// Expression to parse error response. Default is "await response.json()".

/// Only used when IncludeStatusCode is true.

/// </summary>

public string ErrorExpression { get; set; } = "await response.json()";

/// <summary>

/// TypeScript type for error response. Default is "{status: number; title: string; detail?: string | null} | undefined".

/// Only used when IncludeStatusCode is true.

/// </summary>

public string ErrorType { get; set; } = "{status: number; title: string; detail?: string | null} | undefined";

/// <summary>

/// Name for the error type alias emitted at the top of the generated file.

/// The alias body is derived from ErrorType (with " | undefined" stripped).

/// Only used when IncludeStatusCode is true and SkipTypes is false.

/// Default is "ApiError".

/// </summary>

public string ErrorTypeName { get; set; } = "ApiError";

/// <summary>

/// Name for the generic result type alias emitted at the top of the generated file.

/// Defined as: type {ResultTypeName}&lt;T&gt; = {status: number, response: T, error: {ErrorTypeName} | undefined}.

/// Only used when IncludeStatusCode is true and SkipTypes is false.

/// Default is "ApiResult".

/// </summary>

public string ResultTypeName { get; set; } = "ApiResult";

/// <summary>

/// When true, parameters that are filled by the server and cannot be set by the client are omitted

/// from the generated request interface, query string, and body. This covers automatic parameters

/// that are also optional: HTTP Custom Type fields, resolved-parameter expressions, upload metadata,

/// and — on endpoints that use user parameters — IP-address and user-claim parameters. A client value

/// for these would be overridden server-side, so emitting them is misleading. Default is false

/// (all parameters are emitted, preserving existing generated output).

/// </summary>

public bool OmitAutomaticParameters { get; set; } = false;

}