@andrew_l/mongo-pagination 0.3.22 → 0.4.0

package/dist/shared/mongo-pagination.D7Mb8JCq.d.ts

@@ -1,195 +0,0 @@
-import internal, { Readable } from 'node:stream';
-import { Sort } from 'mongodb';
-
-interface TokenOptions {
-    /**
-     * The schema version of the token.
-     */
-    schemaVersion: number;
-    /**
-     * The name of the model the token is related to.
-     */
-    modelName?: string;
-    /**
-     * The sorting direction used to building pagination query.
-     */
-    sortDirection?: Record<string, any>;
-    /**
-     * The values associated with sorting.
-     * Used in conjunction with `sortDirection` to building range query.
-     */
-    sortValues?: Record<string, any>;
-    /**
-     * The payload of the token. Contains additional data or metadata (can be `null`).
-     */
-    payload: Record<string, any> | null;
-}
-/**
- * Represents a token with pagination and metadata information.
- * This class holds the token data, including sorting details, and any payload.
- */
-declare class Token {
-    /**
-     * The CRC of the model name, used for verify the model.
-     */
-    modelNameCRC: number;
-    /**
-     * The sorting direction used for pagination building pagination query.
-     */
-    sortDirection: Record<string, any>;
-    /**
-     * The sorting values associated with the pagination.
-     */
-    sortValues: Record<string, any>;
-    /**
-     * The payload of the token, which can contain any associated metadata or data (may be `null`).
-     */
-    payload: Record<string, any> | null;
-    constructor(options?: Partial<TokenOptions>);
-    /**
-     * Retrieves the string representation of token.
-     */
-    stringify(): string;
-    /**
-     * Retrieves binary buffer representation of token.
-     */
-    buffer(): Uint8Array;
-    /**
-     * Encode token from provided value
-     */
-    static from(value: string | Buffer | Uint8Array): Token;
-}
-/**
- * Parses a token from provided value.
- * @group Utils
- */
-declare function parseToken(value: string | Buffer): Token;
-/**
- * Create a token with pagination and metadata information.
- * This holds the token data, including sorting details, and any payload.
- *
- * @group Utils
- */
-declare function createToken(options?: Partial<TokenOptions>): Token;
-
-declare namespace QueryAdapter {
-    type Options = {
-        sort?: Sort;
-        limit?: number;
-    };
-    type Filter = Record<string, any>;
-    interface QueryAdapter<T = any> {
-        getModelName(): string;
-        getOptions(): Options;
-        getFilter(): Filter;
-        setOptions(options: Options): void;
-        setFilter(filter: Filter): void;
-        toArray(): Promise<T[]>;
-        stream(): Readable;
-    }
-}
-
-interface QueryPaginatorOptions {
-    /**
-     * An optional list of fields used for building pagination query.
-     */
-    paginationFields?: string[];
-    /**
-     * The token to start the pagination from, if available.
-     */
-    next?: string | Buffer | null;
-    /**
-     * A callback function executed before the query is performed.
-     */
-    preQuery?: (this: QueryPaginator) => void;
-    /**
-     * A callback function executed after the query is performed.
-     */
-    postQuery?: (this: QueryPaginator) => void;
-    /** @internal */
-    debugQuery?: boolean;
-}
-interface QueryPaginatorMeta {
-    /**
-     * Indicates whether there is a next page available.
-     */
-    hasNext: boolean;
-    /**
-     * The token for the next page, or `null` if there is no next page.
-     */
-    next: string | null;
-}
-interface QueryPaginatorResult<T> {
-    /**
-     * The list of items for the current page.
-     */
-    items: T[];
-    /**
-     * Metadata providing information about pagination, such as whether more pages are available.
-     */
-    metadata: QueryPaginatorMeta;
-}
-/**
- * A generic class for handling query pagination.
- *
- * Look at `withMongoPagination` and `withMongoosePagination`
- *
- * @group Main
- */
-declare class QueryPaginator<T = any> {
-    private query;
-    private hooks;
-    private next;
-    private previous?;
-    private resHasNext;
-    private resLastItem;
-    private paginationFields;
-    private tweaked;
-    private debugQuery;
-    getMetadata: () => QueryPaginatorMeta;
-    constructor(query: QueryAdapter.QueryAdapter, { paginationFields, postQuery, preQuery, next: previousToken, debugQuery, }?: QueryPaginatorOptions);
-    /**
-     * Retrieves metadata about the current state of pagination.
-     */
-    get metadata(): QueryPaginatorMeta;
-    /**
-     * Indicates whether there is a next page available.
-     */
-    get hasNext(): boolean;
-    /**
-     * Retrieves the token for the next page.
-     */
-    get nextToken(): Token;
-    /**
-     * Retrieves the string representation of the next page token.
-     * If there is no next page, returns `null`.
-     */
-    get nextTokenString(): string | null;
-    /**
-     * Retrieves the token for the previous page.
-     */
-    get prevToken(): Token | null;
-    /**
-     * Retrieves the string representation of the previous page token.
-     */
-    get prevTokenString(): string | null;
-    getQuery(): QueryAdapter.QueryAdapter<any>;
-    pre(hookName: string, fn: Function): this;
-    post(hookName: string, fn: Function): this;
-    stream(): Promise<internal.Transform>;
-    /** @internal */
-    maybeTweak(): this;
-    /** @internal */
-    tweak(): this;
-    /** @internal */
-    _handleResult(items: any[]): QueryPaginatorResult<any>;
-    /**
-     * Executes the query and returns the results along with pagination metadata.
-     */
-    exec(): Promise<QueryPaginatorResult<T>>;
-    then: Promise<QueryPaginatorResult<T>>["then"];
-    cath: Promise<QueryPaginatorResult<T>>["catch"];
-    finally: Promise<QueryPaginatorResult<T>>["finally"];
-}
-
-export { QueryAdapter as Q, Token as T, type QueryPaginatorOptions as a, QueryPaginator as b, type QueryPaginatorMeta as c, type QueryPaginatorResult as d, createToken as e, type TokenOptions as f, parseToken as p };