@andrew_l/mongo-pagination 0.3.22 → 0.4.0

package/dist/index.d.cts

@@ -1,150 +0,0 @@
-import { Q as QueryAdapter, T as Token, a as QueryPaginatorOptions, b as QueryPaginator } from './shared/mongo-pagination.D7Mb8JCq.cjs';
-export { c as QueryPaginatorMeta, d as QueryPaginatorResult, f as TokenOptions, e as createToken, p as parseToken } from './shared/mongo-pagination.D7Mb8JCq.cjs';
-import { Sort, FindCursor } from 'mongodb';
-import { Query } from 'mongoose';
-import 'node:stream';
-
-/**
- * Creates a range filter based on sorting direction and values.
- *
- * This function generates a range filter to be used in queries, typically for pagination,
- * based on the provided sorting direction (ascending or descending) and the sorting values (field names and values).
- *
- * @param sortDirection - The sorting direction, which could be ascending or descending.
- * @param sortValues - The sorting values, including field names and their respective values for sorting.
- * @returns A range filter object that can be used in MongoDB.
- *
- * @example
- * // Example usage
- * const sortDirection = { age: 1 };
- * const sortValues = { age: 30 };
- * const rangeFilter = createRangeFilter(sortDirection, sortValues);
- * console.log(rangeFilter);
- * // Output: { age: { $gt: 30 } }
- *
- * @group Utils
- */
-declare function createRangeFilter(sortDirection: Sort, sortValues: Record<string, any>): Record<string, any>;
-/**
- * Merges two MongoDB filters in the most effective way.
- *
- * This function combines two filters, prioritizing the most specific criteria
- * from both and ensuring the merged filter works efficiently for MongoDB queries.
- *
- * @param first - The first MongoDB filter object.
- * @param second - The second MongoDB filter object.
- * @returns The merged MongoDB filter object, combining both filters.
- *
- * @example
- * // Basic usage:
- * const filter1 = { status: 'active', age: { $gt: 18 } };
- * const filter2 = { age: { $lt: 60 }, country: 'USA' };
- *
- * const mergedFilter = mergeFilters(filter1, filter2);
- * console.log(mergedFilter);
- * // Output: { status: 'active', age: { $gt: 18, $lt: 60 }, country: 'USA' }
- *
- * @group Utils
- */
-declare function mergeFilters(first: Record<string, any>, second: Record<string, any>): Record<string, any>;
-interface TweakQueryOptions {
-    query: QueryAdapter.QueryAdapter;
-    paginationFields: string[];
-    token?: Token;
-}
-declare function tweakQuery({ paginationFields, token, query, }: TweakQueryOptions): string[];
-
-type AnyQuery = Query<any, any>;
-type ExtractDocType<T> = T extends Query<infer X, any> ? X : never;
-/**
- * Enhances a Mongoose query with pagination capabilities.
- *
- * @param query - The Mongoose query to be paginated.
- * @param [options] - Optional configuration for pagination.
- *
- * @example
- * // Basic usage with a Mongoose query:
- * import { withMongoosePagination } from './pagination';
- * import mongoose from 'mongoose';
- *
- * async function paginateMongooseQuery() {
- *   const User = mongoose.model('User', new mongoose.Schema({ name: String, status: String }));
- *
- *   const query = User.find({ status: 'active' });
- *
- *   const paginator = withMongoosePagination(query, {
- *     paginationFields: ['_id'],
- *     next: null,
- *   });
- *
- *   const result = await paginator.exec();
- *   console.log(result.items); // Logs the items for the current page
- *   console.log(result.metadata); // Logs pagination metadata
- * }
- *
- * @example
- * // Using custom preQuery and postQuery callbacks:
- * const paginator = withMongoosePagination(query, {
- *   preQuery: function () {
- *     console.log('Before executing the query');
- *   },
- *   postQuery: function () {
- *     console.log('After executing the query');
- *   },
- * });
- *
- * const result = await paginator.exec();
- * console.log(result.items); // Logs items for the current page
- * console.log(result.metadata); // Logs pagination metadata
- *
- * @group Main
- */
-declare function withMongoosePagination<T extends AnyQuery>(query: T, options?: QueryPaginatorOptions): QueryPaginator<ExtractDocType<T>>;
-
-type ExtractSchema<T> = T extends FindCursor<infer X> ? X : never;
-/**
- * Enhances a MongoDB `FindCursor` with pagination capabilities.
- *
- * @param cursor - The MongoDB cursor to be paginated.
- * @param [options] - Optional configuration for pagination.
- *
- * @example
- * // Basic usage with a MongoDB cursor:
- * import { MongoClient } from 'mongodb';
- *
- * async function paginateCollection() {
- *   const client = new MongoClient('mongodb://localhost:27017');
- *   await client.connect();
- *
- *   const db = client.db('exampleDb');
- *   const collection = db.collection('exampleCollection');
- *
- *   const cursor = collection.find({ status: 'active' });
- *
- *   const paginator = withMongoPagination(cursor, {
- *     paginationFields: ['_id'],
- *     next: null,
- *   });
- *
- *   const result = await paginator.exec();
- *   console.log(result.items); // Logs the items for the current page
- *   console.log(result.metadata); // Logs pagination metadata
- * }
- *
- *
- * @example
- * // Using a custom preQuery callback:
- * const paginator = withMongoPagination(cursor, {
- *   preQuery: function () {
- *     console.log('Executing query...');
- *   },
- * });
- *
- * const result = await paginator.exec();
- * console.log(result.items);
- *
- * @group Main
- */
-declare function withMongoPagination<T extends FindCursor>(cursor: T, options?: QueryPaginatorOptions): QueryPaginator<ExtractSchema<T>>;
-
-export { QueryPaginatorOptions, createRangeFilter, mergeFilters, tweakQuery, withMongoPagination, withMongoosePagination };

package/dist/index.d.ts

@@ -1,150 +0,0 @@
-import { Q as QueryAdapter, T as Token, a as QueryPaginatorOptions, b as QueryPaginator } from './shared/mongo-pagination.D7Mb8JCq.js';
-export { c as QueryPaginatorMeta, d as QueryPaginatorResult, f as TokenOptions, e as createToken, p as parseToken } from './shared/mongo-pagination.D7Mb8JCq.js';
-import { Sort, FindCursor } from 'mongodb';
-import { Query } from 'mongoose';
-import 'node:stream';
-
-/**
- * Creates a range filter based on sorting direction and values.
- *
- * This function generates a range filter to be used in queries, typically for pagination,
- * based on the provided sorting direction (ascending or descending) and the sorting values (field names and values).
- *
- * @param sortDirection - The sorting direction, which could be ascending or descending.
- * @param sortValues - The sorting values, including field names and their respective values for sorting.
- * @returns A range filter object that can be used in MongoDB.
- *
- * @example
- * // Example usage
- * const sortDirection = { age: 1 };
- * const sortValues = { age: 30 };
- * const rangeFilter = createRangeFilter(sortDirection, sortValues);
- * console.log(rangeFilter);
- * // Output: { age: { $gt: 30 } }
- *
- * @group Utils
- */
-declare function createRangeFilter(sortDirection: Sort, sortValues: Record<string, any>): Record<string, any>;
-/**
- * Merges two MongoDB filters in the most effective way.
- *
- * This function combines two filters, prioritizing the most specific criteria
- * from both and ensuring the merged filter works efficiently for MongoDB queries.
- *
- * @param first - The first MongoDB filter object.
- * @param second - The second MongoDB filter object.
- * @returns The merged MongoDB filter object, combining both filters.
- *
- * @example
- * // Basic usage:
- * const filter1 = { status: 'active', age: { $gt: 18 } };
- * const filter2 = { age: { $lt: 60 }, country: 'USA' };
- *
- * const mergedFilter = mergeFilters(filter1, filter2);
- * console.log(mergedFilter);
- * // Output: { status: 'active', age: { $gt: 18, $lt: 60 }, country: 'USA' }
- *
- * @group Utils
- */
-declare function mergeFilters(first: Record<string, any>, second: Record<string, any>): Record<string, any>;
-interface TweakQueryOptions {
-    query: QueryAdapter.QueryAdapter;
-    paginationFields: string[];
-    token?: Token;
-}
-declare function tweakQuery({ paginationFields, token, query, }: TweakQueryOptions): string[];
-
-type AnyQuery = Query<any, any>;
-type ExtractDocType<T> = T extends Query<infer X, any> ? X : never;
-/**
- * Enhances a Mongoose query with pagination capabilities.
- *
- * @param query - The Mongoose query to be paginated.
- * @param [options] - Optional configuration for pagination.
- *
- * @example
- * // Basic usage with a Mongoose query:
- * import { withMongoosePagination } from './pagination';
- * import mongoose from 'mongoose';
- *
- * async function paginateMongooseQuery() {
- *   const User = mongoose.model('User', new mongoose.Schema({ name: String, status: String }));
- *
- *   const query = User.find({ status: 'active' });
- *
- *   const paginator = withMongoosePagination(query, {
- *     paginationFields: ['_id'],
- *     next: null,
- *   });
- *
- *   const result = await paginator.exec();
- *   console.log(result.items); // Logs the items for the current page
- *   console.log(result.metadata); // Logs pagination metadata
- * }
- *
- * @example
- * // Using custom preQuery and postQuery callbacks:
- * const paginator = withMongoosePagination(query, {
- *   preQuery: function () {
- *     console.log('Before executing the query');
- *   },
- *   postQuery: function () {
- *     console.log('After executing the query');
- *   },
- * });
- *
- * const result = await paginator.exec();
- * console.log(result.items); // Logs items for the current page
- * console.log(result.metadata); // Logs pagination metadata
- *
- * @group Main
- */
-declare function withMongoosePagination<T extends AnyQuery>(query: T, options?: QueryPaginatorOptions): QueryPaginator<ExtractDocType<T>>;
-
-type ExtractSchema<T> = T extends FindCursor<infer X> ? X : never;
-/**
- * Enhances a MongoDB `FindCursor` with pagination capabilities.
- *
- * @param cursor - The MongoDB cursor to be paginated.
- * @param [options] - Optional configuration for pagination.
- *
- * @example
- * // Basic usage with a MongoDB cursor:
- * import { MongoClient } from 'mongodb';
- *
- * async function paginateCollection() {
- *   const client = new MongoClient('mongodb://localhost:27017');
- *   await client.connect();
- *
- *   const db = client.db('exampleDb');
- *   const collection = db.collection('exampleCollection');
- *
- *   const cursor = collection.find({ status: 'active' });
- *
- *   const paginator = withMongoPagination(cursor, {
- *     paginationFields: ['_id'],
- *     next: null,
- *   });
- *
- *   const result = await paginator.exec();
- *   console.log(result.items); // Logs the items for the current page
- *   console.log(result.metadata); // Logs pagination metadata
- * }
- *
- *
- * @example
- * // Using a custom preQuery callback:
- * const paginator = withMongoPagination(cursor, {
- *   preQuery: function () {
- *     console.log('Executing query...');
- *   },
- * });
- *
- * const result = await paginator.exec();
- * console.log(result.items);
- *
- * @group Main
- */
-declare function withMongoPagination<T extends FindCursor>(cursor: T, options?: QueryPaginatorOptions): QueryPaginator<ExtractSchema<T>>;
-
-export { QueryPaginatorOptions, createRangeFilter, mergeFilters, tweakQuery, withMongoPagination, withMongoosePagination };

package/dist/mongoose-7.cjs

@@ -1,36 +0,0 @@
-'use strict';
-
-const withMongoosePagination = require('./shared/mongo-pagination.odJCU2tV.cjs');
-require('@andrew_l/toolkit');
-require('kareem');
-require('mongodb');
-require('@andrew_l/tl-pack');
-require('debug');
-require('node:stream');
-
-function setupPlugin(mongoose) {
-  const Query = mongoose.Query;
-  Query.prototype.paginator = paginator;
-  Query.prototype.paginatorNext = paginatorNext;
-}
-function paginator(options = {}) {
-  const query = this;
-  if (arguments.length === 0 && query._paginator) {
-    return query._paginator;
-  }
-  query._paginator = withMongoosePagination.withMongoosePagination(query, options);
-  return query._paginator;
-}
-function paginatorNext(nextToken) {
-  const query = this;
-  if (arguments.length === 0 && query._paginator) {
-    return query._paginator;
-  }
-  query._paginator = withMongoosePagination.withMongoosePagination(query, {
-    next: nextToken
-  });
-  return query._paginator;
-}
-
-module.exports = setupPlugin;
-//# sourceMappingURL=mongoose-7.cjs.map

package/dist/mongoose-7.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"mongoose-7.cjs","sources":["../src/mongoose-7.ts"],"sourcesContent":["import type { Query } from 'mongoose';\nimport type { QueryPaginator, QueryPaginatorOptions } from './QueryPaginator';\nimport { withMongoosePagination } from './withMongoosePagination';\n\ntype MongooseQuery = Query<any, any> & {\n  /** @internal */\n  _paginator?: QueryPaginator;\n};\n\nexport default function setupPlugin(mongoose: any) {\n  const Query = mongoose.Query;\n\n  Query.prototype.paginator = paginator;\n  Query.prototype.paginatorNext = paginatorNext;\n}\n\nfunction paginator(this: MongooseQuery, options: QueryPaginatorOptions = {}) {\n  const query = this;\n\n  if (arguments.length === 0 && query._paginator) {\n    return query._paginator;\n  }\n\n  query._paginator = withMongoosePagination(query, options);\n\n  return query._paginator;\n}\n\nfunction paginatorNext(this: MongooseQuery, nextToken: string) {\n  const query = this;\n\n  if (arguments.length === 0 && query._paginator) {\n    return query._paginator;\n  }\n\n  query._paginator = withMongoosePagination(query, {\n    next: nextToken,\n  });\n\n  return query._paginator;\n}\n\ndeclare module 'mongoose' {\n  /**\n   * Patch original mongoose types\n   */\n  // @ts-expect-error\n  interface Query<ResultType, DocType, THelpers = {}, RawDocType = DocType> {\n    paginator(options?: QueryPaginatorOptions): QueryPaginator<ResultType>;\n    paginatorNext(nextToken: string): QueryPaginator<ResultType>;\n  }\n}\n"],"names":["withMongoosePagination"],"mappings":";;;;;;;;;;AASA,SAAwB,YAAY,QAAA,EAAe;AACjD,EAAA,MAAM,QAAQ,QAAA,CAAS,KAAA;AAEvB,EAAA,KAAA,CAAM,UAAU,SAAA,GAAY,SAAA;AAC5B,EAAA,KAAA,CAAM,UAAU,aAAA,GAAgB,aAAA;AAClC;AAEA,SAAS,SAAA,CAA+B,OAAA,GAAiC,EAAC,EAAG;AAC3E,EAAA,MAAM,KAAA,GAAQ,IAAA;AAEd,EAAA,IAAI,SAAA,CAAU,MAAA,KAAW,CAAA,IAAK,KAAA,CAAM,UAAA,EAAY;AAC9C,IAAA,OAAO,KAAA,CAAM,UAAA;AAAA,EACf;AAEA,EAAA,KAAA,CAAM,UAAA,GAAaA,6CAAA,CAAuB,KAAA,EAAO,OAAO,CAAA;AAExD,EAAA,OAAO,KAAA,CAAM,UAAA;AACf;AAEA,SAAS,cAAmC,SAAA,EAAmB;AAC7D,EAAA,MAAM,KAAA,GAAQ,IAAA;AAEd,EAAA,IAAI,SAAA,CAAU,MAAA,KAAW,CAAA,IAAK,KAAA,CAAM,UAAA,EAAY;AAC9C,IAAA,OAAO,KAAA,CAAM,UAAA;AAAA,EACf;AAEA,EAAA,KAAA,CAAM,UAAA,GAAaA,8CAAuB,KAAA,EAAO;AAAA,IAC/C,IAAA,EAAM;AAAA,GACP,CAAA;AAED,EAAA,OAAO,KAAA,CAAM,UAAA;AACf;;;;"}

package/dist/mongoose-7.d.cts

@@ -1,16 +0,0 @@
-import { a as QueryPaginatorOptions, b as QueryPaginator } from './shared/mongo-pagination.D7Mb8JCq.cjs';
-import 'node:stream';
-import 'mongodb';
-
-declare function setupPlugin(mongoose: any): void;
-declare module 'mongoose' {
-    /**
-     * Patch original mongoose types
-     */
-    interface Query<ResultType, DocType, THelpers = {}, RawDocType = DocType> {
-        paginator(options?: QueryPaginatorOptions): QueryPaginator<ResultType>;
-        paginatorNext(nextToken: string): QueryPaginator<ResultType>;
-    }
-}
-
-export = setupPlugin;

package/dist/mongoose-7.d.ts

@@ -1,16 +0,0 @@
-import { a as QueryPaginatorOptions, b as QueryPaginator } from './shared/mongo-pagination.D7Mb8JCq.js';
-import 'node:stream';
-import 'mongodb';
-
-declare function setupPlugin(mongoose: any): void;
-declare module 'mongoose' {
-    /**
-     * Patch original mongoose types
-     */
-    interface Query<ResultType, DocType, THelpers = {}, RawDocType = DocType> {
-        paginator(options?: QueryPaginatorOptions): QueryPaginator<ResultType>;
-        paginatorNext(nextToken: string): QueryPaginator<ResultType>;
-    }
-}
-
-export = setupPlugin;

package/dist/mongoose-8.cjs

@@ -1,36 +0,0 @@
-'use strict';
-
-const withMongoosePagination = require('./shared/mongo-pagination.odJCU2tV.cjs');
-require('@andrew_l/toolkit');
-require('kareem');
-require('mongodb');
-require('@andrew_l/tl-pack');
-require('debug');
-require('node:stream');
-
-function setupPlugin(mongoose) {
-  const Query = mongoose.Query;
-  Query.prototype.paginator = paginator;
-  Query.prototype.paginatorNext = paginatorNext;
-}
-function paginator(options = {}) {
-  const query = this;
-  if (arguments.length === 0 && query._paginator) {
-    return query._paginator;
-  }
-  query._paginator = withMongoosePagination.withMongoosePagination(query, options);
-  return query._paginator;
-}
-function paginatorNext(nextToken) {
-  const query = this;
-  if (arguments.length === 0 && query._paginator) {
-    return query._paginator;
-  }
-  query._paginator = withMongoosePagination.withMongoosePagination(query, {
-    next: nextToken
-  });
-  return query._paginator;
-}
-
-module.exports = setupPlugin;
-//# sourceMappingURL=mongoose-8.cjs.map

package/dist/mongoose-8.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"mongoose-8.cjs","sources":["../src/mongoose-8.ts"],"sourcesContent":["import type { Query } from 'mongoose';\nimport type { QueryPaginator, QueryPaginatorOptions } from './QueryPaginator';\nimport { withMongoosePagination } from './withMongoosePagination';\n\ntype MongooseQuery = Query<any, any> & {\n  /** @internal */\n  _paginator?: QueryPaginator;\n};\n\nexport default function setupPlugin(mongoose: any) {\n  const Query = mongoose.Query;\n\n  Query.prototype.paginator = paginator;\n  Query.prototype.paginatorNext = paginatorNext;\n}\n\nfunction paginator(this: MongooseQuery, options: QueryPaginatorOptions = {}) {\n  const query = this;\n\n  if (arguments.length === 0 && query._paginator) {\n    return query._paginator;\n  }\n\n  query._paginator = withMongoosePagination(query, options);\n\n  return query._paginator;\n}\n\nfunction paginatorNext(this: MongooseQuery, nextToken: string) {\n  const query = this;\n\n  if (arguments.length === 0 && query._paginator) {\n    return query._paginator;\n  }\n\n  query._paginator = withMongoosePagination(query, {\n    next: nextToken,\n  });\n\n  return query._paginator;\n}\n\ndeclare module 'mongoose' {\n  /**\n   * Patch original mongoose types for mongoose 8\n   */\n  // @ts-expect-error\n  interface Query<ResultType, DocType> {\n    paginator(options?: QueryPaginatorOptions): QueryPaginator<DocType>;\n    paginatorNext(nextToken: string): QueryPaginator<DocType>;\n  }\n}\n"],"names":["withMongoosePagination"],"mappings":";;;;;;;;;;AASA,SAAwB,YAAY,QAAA,EAAe;AACjD,EAAA,MAAM,QAAQ,QAAA,CAAS,KAAA;AAEvB,EAAA,KAAA,CAAM,UAAU,SAAA,GAAY,SAAA;AAC5B,EAAA,KAAA,CAAM,UAAU,aAAA,GAAgB,aAAA;AAClC;AAEA,SAAS,SAAA,CAA+B,OAAA,GAAiC,EAAC,EAAG;AAC3E,EAAA,MAAM,KAAA,GAAQ,IAAA;AAEd,EAAA,IAAI,SAAA,CAAU,MAAA,KAAW,CAAA,IAAK,KAAA,CAAM,UAAA,EAAY;AAC9C,IAAA,OAAO,KAAA,CAAM,UAAA;AAAA,EACf;AAEA,EAAA,KAAA,CAAM,UAAA,GAAaA,6CAAA,CAAuB,KAAA,EAAO,OAAO,CAAA;AAExD,EAAA,OAAO,KAAA,CAAM,UAAA;AACf;AAEA,SAAS,cAAmC,SAAA,EAAmB;AAC7D,EAAA,MAAM,KAAA,GAAQ,IAAA;AAEd,EAAA,IAAI,SAAA,CAAU,MAAA,KAAW,CAAA,IAAK,KAAA,CAAM,UAAA,EAAY;AAC9C,IAAA,OAAO,KAAA,CAAM,UAAA;AAAA,EACf;AAEA,EAAA,KAAA,CAAM,UAAA,GAAaA,8CAAuB,KAAA,EAAO;AAAA,IAC/C,IAAA,EAAM;AAAA,GACP,CAAA;AAED,EAAA,OAAO,KAAA,CAAM,UAAA;AACf;;;;"}

package/dist/mongoose-8.d.cts

@@ -1,16 +0,0 @@
-import { a as QueryPaginatorOptions, b as QueryPaginator } from './shared/mongo-pagination.D7Mb8JCq.cjs';
-import 'node:stream';
-import 'mongodb';
-
-declare function setupPlugin(mongoose: any): void;
-declare module 'mongoose' {
-    /**
-     * Patch original mongoose types for mongoose 8
-     */
-    interface Query<ResultType, DocType> {
-        paginator(options?: QueryPaginatorOptions): QueryPaginator<DocType>;
-        paginatorNext(nextToken: string): QueryPaginator<DocType>;
-    }
-}
-
-export = setupPlugin;

package/dist/mongoose-8.d.ts

@@ -1,16 +0,0 @@
-import { a as QueryPaginatorOptions, b as QueryPaginator } from './shared/mongo-pagination.D7Mb8JCq.js';
-import 'node:stream';
-import 'mongodb';
-
-declare function setupPlugin(mongoose: any): void;
-declare module 'mongoose' {
-    /**
-     * Patch original mongoose types for mongoose 8
-     */
-    interface Query<ResultType, DocType> {
-        paginator(options?: QueryPaginatorOptions): QueryPaginator<DocType>;
-        paginatorNext(nextToken: string): QueryPaginator<DocType>;
-    }
-}
-
-export = setupPlugin;