import { type CachedGetter, type Maybe, type Page, type PromiseOrValue } from '@dereekb/util';
import { FetchRequestFactoryError } from './error';
export declare class FetchPageNoNextPageError extends FetchRequestFactoryError {
    readonly page: FetchPage<unknown, unknown>;
    constructor(page: FetchPage<unknown, unknown>);
}
export declare class FetchPageLimitReachedError extends FetchRequestFactoryError {
    readonly page: FetchPage<unknown, unknown>;
    readonly limit: number;
    constructor(page: FetchPage<unknown, unknown>, limit: number);
}
/**
 * Query/Search cursor string.
 *
 * Used by some APIs for pagination.
 */
export type FetchPageCursor = string;
export interface FetchPage<I, O> {
    /**
     * Input for this page.
     */
    readonly input: I;
    /**
     * Fetches the next page of results.
     *
     * If the page of results has been returned, returns the same reference and does not perform the fetch request again.
     *
     * If there are no pages to return, calling this will throw a FetchPageNoNextPageError error.
     */
    readonly fetchNext: CachedGetter<Promise<FetchNextPage<I, O>>>;
}
export interface FetchPageResultInfo extends Page {
    /**
     * Cursor for this page, if applicable.
     */
    readonly cursor?: Maybe<FetchPageCursor>;
    /**
     * Cursor for the next page, if applicable.
     */
    readonly nextPageCursor?: Maybe<FetchPageCursor>;
    /**
     * Whether or not there are more results to fetch.
     *
     * If not defined, is assumed this info is not available and will default to true.
     *
     * Defaults to true.
     */
    readonly hasNext?: Maybe<boolean>;
}
export interface FetchPageResult<O> extends FetchPageResultInfo {
    /**
     * Result for this page.
     */
    readonly result: O;
    /**
     * Whether or not the max page has been reached.
     */
    readonly isAtMaxPage?: boolean;
}
export interface FetchPageResultWithInput<I, O> extends FetchPageResult<O> {
    /**
     * Input for this page.
     */
    readonly input: I;
}
export interface FetchNextPage<I, O> extends FetchPageResult<O>, FetchPage<I, O> {
    /**
     * Previous page.
     *
     * Undefined if this is the first page.
     */
    readonly previous?: Maybe<FetchNextPage<I, O>>;
}
export interface FetchPageFactoryInputOptions {
    /**
     * The max number of pages to load.
     *
     * Pass null to disable the max page amount.
     */
    readonly maxPage?: Maybe<number>;
    /**
     * The maximum number of items to load per page.
     */
    readonly maxItemsPerPage?: Maybe<number>;
}
export type ReadFetchPageResultInfo = Omit<FetchPageResultInfo, 'page'>;
export interface FetchPageFactoryConfigDefaults {
    /**
     * The default max page to load up to.
     *
     * Defaults to 100. Pass null to disable the max page amount.
     */
    readonly defaultMaxPage?: Maybe<number>;
    /**
     * The default maximum number of items to load per page.
     */
    readonly defaultMaxItemsPerPage?: Maybe<number>;
}
export interface FetchPageFactoryConfig<I, O> extends FetchPageFactoryConfigDefaults {
    /**
     * The configured Fetch function that takes in the input and returns a results.
     */
    readonly fetch: (input: I) => Promise<O>;
    /**
     * Returns the page results from the result.
     *
     * The page number is ignored as it is inferred from the previous page.
     *
     * @param result
     * @returns
     */
    readonly readFetchPageResultInfo: (result: O) => PromiseOrValue<ReadFetchPageResultInfo>;
    /**
     * Creates new input for the next page that is merged with the previous input.
     *
     * Returns undefined if the next page should not be loaded.
     *
     * @param result
     * @returns
     */
    readonly buildInputForNextPage: (pageResult: Partial<FetchPageResult<O>>, input: I, options: FetchPageFactoryInputOptions) => PromiseOrValue<Maybe<Partial<I>>>;
}
export type FetchPageFactoryOptions<I, O> = FetchPageFactoryInputOptions;
/**
 * Creates a new FetchPage instance.
 */
export type FetchPageFactory<I, O> = (input: I, options?: Maybe<FetchPageFactoryOptions<I, O>>) => FetchPage<I, O>;
/**
 * Default max page for a FetchPageFactory.
 */
export declare const FETCH_PAGE_FACTORY_DEFAULT_MAX_PAGE = 100;
/**
 * Creates a new FetchPageFactory from the input.
 *
 * @param config
 * @returns
 */
export declare function fetchPageFactory<I, O>(config: FetchPageFactoryConfig<I, O>): FetchPageFactory<I, O>;