import { Client } from "../Client";
import { FACTOR_API_PATH, POST, SEARCH_API_PATH } from "../Constants";
import { FactorRequest, SearchRequest } from "../interfaces/Api";
import { FactorResponse } from "../interfaces/response/FactorResponse";
import { SearchResponse } from "../interfaces/response/SearchResponse";
import { makeApiRequest } from "../request";

/**
 * Retrieves a factor details by making a POST request to the factor API endpoint.
 * 
 * @export
 * @param {FactorRequest} payload - The factor request data to be sent to the API
 * @return {Promise<FactorResponse>} A promise that resolves to the FactorResponse returned by the API
 * @throws {Error} May throw an error if the API request fails
 * 
 * @example
 * const factorRequest = {
    "activity": {
      "factorId": 12345
    }
  };
  
  OR

  const factorRequest = {
    "time" : {
      "date": "2025-01-04"
    },
    "location": {
      "country": "usa",
      "stateProvince": "new york"
    },
    "activity": {
      "type":"natural gas"
    },
    "includeDetails": true
  };
 * const factor = await retrieveFactor(factorRequest);
 */

export async function retrieveFactor(
  payload: FactorRequest
): Promise<FactorResponse> {
  const client = Client.getInstance();
  const url =  client.getDomain() + FACTOR_API_PATH;

  return makeApiRequest<FactorResponse>({
    method: POST,
    url,
    data: payload,
  });
}


/**
 * Performs a search operation by making a POST request to the search API endpoint.
 *
 * @export
 * @param {SearchRequest} payload - The search request data to be sent to the API
 * @return {Promise<SearchResponse>} A promise that resolves to the search results returned by the API
 * @throws {Error} May throw an error if the API request fails
 *
 * The API applies cross-encoder reranking by default. Set `enableReranker` to
 * `false` to keep semantic similarity ordering without reranking.
 *
 * @example
 * // Basic search
 * const searchRequest = {
    "time":{
      "date": "2020-06-10"
    },
    "activity": {
      "search" : "travel"
    },
    "location": {
      "country": "USA"
    }
  };
 * const results = await search(searchRequest);
 *
 * @example
 * // Search without cross-encoder reranking
 * const searchWithoutReranker = {
    "time":{
      "date": "2020-06-10"
    },
    "activity": {
      "search" : "travel"
    },
    "location": {
      "country": "USA"
    },
    "enableReranker": false
  };
 * const results = await search(searchWithoutReranker);
 *
 * @example
 * // Search with optional unit parameter
 * const searchWithUnit = {
    "time":{
      "date": "2020-06-10"
    },
    "activity": {
      "search": "electricity",
      "unit": "kWh"
    },
    "location": {
      "country": "USA"
    }
  };
 * const results = await search(searchWithUnit);
 *
 * @example
 * // Search with optional scope parameter
 * const searchWithScope = {
    "time":{
      "date": "2020-06-10"
    },
    "activity": {
      "search": "natural gas",
      "scope": "1"
    },
    "location": {
      "country": "USA"
    }
  };
 * const results = await search(searchWithScope);
 *
 * @example
 * // Search with both unit and scope parameters
 * const searchWithBoth = {
    "time":{
      "date": "2020-06-10"
    },
    "activity": {
      "search": "electricity",
      "unit": "MWh",
      "scope": "2"
    },
    "location": {
      "country": "USA",
      "stateProvince": "california"
    }
  };
 * const results = await search(searchWithBoth);
 */
export async function search(
  payload: SearchRequest
): Promise<SearchResponse> {
  const client = Client.getInstance();
  const url = client.getDomain() + SEARCH_API_PATH;

  return makeApiRequest<SearchResponse>({
    method: POST,
    url,
    data: payload,
  });
}