import { PageFolderListResponse } from './PageFolderListResponse.js';
import { PagePreviewResponse } from './PagePreviewResponse.js';
import { PageResponse } from './PageResponse.js';
import './PageViewData.js';
import { ServerOptions } from '../../cookieHandling/ServerOptions.js';
import { AcceptedQueryTypes } from '../../Query.js';
import { SDKResponse } from '../../sdk/SDKResponse.js';
import { RedirectResponse } from './RedirectResponse.js';
import './Page.js';
import '@frontastic/extension-types';
import 'cookie';
import 'http';
import '../../../library/FetchError.js';

interface PageApi {
    /**
     * The method to get page data from the API-hub.
     *
     * @param {string} options.path - A string representing the relative path of the page data to be fetched, for example "/sale".
     * @param {Object.<string, number, boolean, string[], number[], boolean[]>} [options.query] - An optional key, value pair object to be serialised into the url query.
     * @param {string} [options.customHeaderValue] - An optional string, the value to assign to a "coFE-Custom-Configuration" header value. Overrides customHeaderValue passed in {@link SDK.configure}.
     * @param {Object} [options.serverOptions] - An optional object containing the res and req objects for ServerResponse and IncomingMessage with cookies respectively.  Required for server-side rendering session management.
     *
     * @returns {PromiseLike<PageResponse | RedirectResponse>} An object with a boolean isError property, and either an error or data property for true and false respectively. Data contains Page, PageFolder and PageView data or a RedirectResponse.
     */
    getPage: (options: {
        path: string;
        query?: AcceptedQueryTypes;
        customHeaderValue?: string;
        serverOptions?: ServerOptions;
    }) => Promise<SDKResponse<PageResponse | RedirectResponse>>;
    /**
     * The method to get page preview data from the API-hub.
     *
     * @param {string} options.previewId - A string representing the ID of the preview to be fetched, likely to be acquired from a query in the visited URL.
     * @param {string} [options.customHeaderValue] - An optional string, the value to assign to a "coFE-Custom-Configuration" header value. Overrides customHeaderValue passed in {@link SDK.configure}.
     * @param {Object} [options.serverOptions] - An optional object containing the res and req objects for ServerResponse and IncomingMessage with cookies respectively.  Required for server-side rendering session management.
     *
     * @returns {PromiseLike<PagePreviewResponse>} An object with a boolean isError property, and either an error or data property for true and false respectively. Data contains Page, PageFolder and PageView data.
     */
    getPreview: (options: {
        previewId: string;
        customHeaderValue?: string;
        serverOptions?: ServerOptions;
    }) => Promise<SDKResponse<PagePreviewResponse>>;
    /**
     * The method to get a flat folder structure of pages from a relative path.
     *
     * @param {string} [options.path="/"] - An optional string with a default value of "" for home, representing the relative path of the page to start fetching data, for example "/sale".
     * @param {number} [options.depth=16] - An optional number with a default value of 16, the depth to dig into page folders to fetch.
     * @param {string} [options.types="static"] - An optional string with a default value of "static". The types of pages to fetch.
     * @param {string} [options.customHeaderValue] - An optional string, the value to assign to a "coFE-Custom-Configuration" header value. Overrides customHeaderValue passed in {@link SDK.configure}.
     * @param {Object} [options.serverOptions] - An optional object containing the res and req objects for ServerResponse and IncomingMessage with cookies respectively.  Required for server-side rendering session management.
     *
     * @returns {PromiseLike<PageFolderListResponse>} An object with a boolean isError property, and either an error or data property for true and false respectively. Data is an array of PageFolder data.
     */
    getPages: (options?: {
        path?: string;
        depth?: number;
        types?: "static";
        customHeaderValue?: string;
        serverOptions?: ServerOptions;
    }) => Promise<SDKResponse<PageFolderListResponse>>;
}

export type { PageApi };