/** * @license * @preserve * * Copyright 2023 KeeeX SAS * * Permission is hereby granted, free of charge, to any person obtaining a copy of * this software and associated documentation files (the "Software"), to deal in * the Software without restriction, including without limitation the rights to * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies * of the Software, and to permit persons to whom the Software is furnished to do * so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. * */ export declare enum OrderDirection { asc = "asc", desc = "desc" } export declare const isOrderDirection: import("@keeex/utils/types/types.js").TypePredicate; export type SortField = [string, "asc" | "desc" | OrderDirection] | [string]; export declare const isSortField: (value: unknown) => value is SortField; export type SortFieldValues = Array; export declare const isSortFieldValues: import("@keeex/utils/types/types.js").TypePredicate; /** Values set in the query */ export interface PaginationFields { limit: number; order?: SortFieldValues; page: number; } export interface OrderClause { direction?: OrderDirection; key: string; } export declare const isOrderClause: import("@keeex/utils/types/types.js").TypePredicate; export type OrderClauses = Array; export declare const isOrderClauses: import("@keeex/utils/types/types.js").TypePredicate; export type FieldOrder = Record; export declare const isFieldOrder: import("@keeex/utils/types/types.js").TypePredicate>; export type OrderInput = OrderClauses | SortFieldValues | FieldOrder; export declare const isOrderInput: import("@keeex/utils/types/types.js").TypePredicate; /** Input fields for paginated requests */ export interface PaginationInput { /** Number of elements per page */ limit?: number; /** Data ordering */ order?: OrderInput; /** Requested page */ page?: number; } export declare const isPaginationInput: import("@keeex/utils/types/types.js").TypePredicate; /** Helper for Api call parameters */ export type PaginationInputType = InputType extends undefined ? PaginationInput : InputType extends void ? PaginationInput : Omit & PaginationInput; export interface PaginatedResponse extends Required { /** total number of elements */ count: number; /** Elements for the current page */ rows: Array; } export declare const isSortDirection: (obj: unknown) => obj is OrderDirection; export declare const createOrderValue: (order: OrderInput | undefined) => SortFieldValues | undefined; /** Create a body block with pagination values */ export declare const getPaginationFromInput: (input: unknown) => PaginationFields; /** List all fields used for pagination */ export declare const getPaginationFields: () => Array;