import { Entity, FilterValues, User } from "@rebasepro/types";
import type { AdminCollection } from "@rebasepro/cms-types";
/**
 * @group Hooks and utilities
 */
export interface CollectionProps<M extends Record<string, any>> {
    /**
     * Absolute collection path
     */
    path: string;
    /**
     * collection of the entity displayed by this collection
     */
    collection: AdminCollection<M>;
    /**
     * Number of entities to fetch
     */
    itemCount?: number;
    /**
     * Number of items to skip
     */
    offset?: number;
    /**
     * Page number (1-indexed), alternative to offset
     */
    page?: number;
    /**
     * Filter the fetched data by the property
     */
    filterValues?: FilterValues<Extract<keyof M, string>>;
    /**
     * Sort the results by
     */
    sortBy?: [Extract<keyof M, string>, "asc" | "desc"];
    /**
     * Search string
     */
    searchString?: string;
}
/**
 * @group Hooks and utilities
 */
export interface CollectionResult<M extends Record<string, any>> {
    data: Entity<M>[];
    dataLoading: boolean;
    noMoreToLoad: boolean;
    dataLoadingError?: Error;
    totalCount?: number;
}
/**
 * This hook is used to fetch collections using a given collection
 * @param path
 * @param collection
 * @param filterValues
 * @param sortBy
 * @param itemCount
 * @param offset
 * @param page
 * @param searchString
 * @group Hooks and utilities
 */
export declare function useCollection<M extends Record<string, any>, USER extends User>({ path, collection, filterValues, sortBy, itemCount, offset, page, searchString }: CollectionProps<M>): CollectionResult<M>;