/* Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
 *
 * This file is part of a Moko Consulting project.
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * FILE INFORMATION
 * DEFGROUP: {{PROJECT_NAME}}.Types
 * INGROUP: {{PROJECT_NAME}}
 * REPO: https://git.mokoconsulting.tech/MokoConsulting/{{PROJECT_NAME}}
 * PATH: /src/types.ts
 * VERSION: 01.00.00
 * BRIEF: TypeScript type definitions for {{DISPLAY_NAME}} MCP server
 */

/**
 * Connection configuration for a single API instance.
 *
 * Rename and extend these fields to match your target API's auth mechanism:
 * - `apiKey` + DOLAPIKEY header  (Dolibarr)
 * - `apiToken` + Bearer header   (Joomla, GitHub)
 * - `username`/`password`        (Basic auth)
 * - `oauth` fields               (OAuth2 flows)
 */
export interface ApiConnection {
	/** Base URL of the API instance (no trailing slash) */
	baseUrl: string;
	/** API key or token for authentication */
	apiKey: string;
	/** Skip TLS certificate verification (self-signed certs) */
	insecure?: boolean;
}

/**
 * Top-level configuration supporting multiple named connections.
 */
export interface ApiConfig {
	connections: Record<string, ApiConnection>;
	defaultConnection: string;
}

/**
 * Normalized API response returned by the HTTP client.
 */
export interface ApiResponse {
	status: number;
	data: unknown;
}