// kafka — a privacy-respecting metasearch engine
// Copyright (C) 2026-present metamorphosis-dev
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

package contracts

// OutputFormat matches the `/search?format=...` values.
type OutputFormat string

const (
	FormatHTML OutputFormat = "html" // accepted for compatibility (not yet implemented)
	FormatJSON OutputFormat = "json"
	FormatCSV  OutputFormat = "csv"
	FormatRSS  OutputFormat = "rss"
)

type SearchRequest struct {
	// Format is what the client requested via `format=...`.
	Format OutputFormat

	Query string

	Pageno     int
	Safesearch int
	TimeRange  *string

	TimeoutLimit *float64
	Language     string

	// Engines and categories are used for deciding which engines run locally vs are proxied.
	// For now, engines can be supplied directly via the `engines` form parameter.
	Engines    []string
	Categories []string

	// EngineData matches the `engine_data-<engine>-<key>=<value>` parameters.
	EngineData map[string]map[string]string

	// AccessToken is an optional request token used to gate paid/limited engines.
	// It is not part of the upstream JSON schema; it only influences local engines.
	AccessToken string
}

// SearchResponse matches the JSON schema used by `webutils.get_json_response()`.
type SearchResponse struct {
	Query                string         `json:"query"`
	NumberOfResults     int            `json:"number_of_results"`
	Results              []MainResult  `json:"results"`
	Answers              []map[string]any     `json:"answers"`
	Corrections          []string      `json:"corrections"`
	Infoboxes            []map[string]any     `json:"infoboxes"`
	Suggestions          []string      `json:"suggestions"`
	UnresponsiveEngines [][2]string   `json:"unresponsive_engines"`
}