@andrew_l/mongo-pagination 0.0.2

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../src/QueryAdapterMongodb.ts","../src/withMongoPagination.ts"],"sourcesContent":["import type { FindCursor, FindOptions } from 'mongodb';\nimport type { Readable } from 'node:stream';\nimport type { QueryAdapter } from './QueryAdapter';\n\nexport class QueryAdapterMongodb<T = any>\n  implements QueryAdapter.QueryAdapter<T>\n{\n  constructor(private cursor: FindCursor) {}\n\n  getModelName(): string {\n    return this.cursor.namespace.collection!;\n  }\n\n  getOptions(): QueryAdapter.Options {\n    const findOptions = (this.cursor as any).findOptions as FindOptions;\n\n    return {\n      limit: findOptions.limit,\n      sort: findOptions.sort,\n    };\n  }\n\n  getFilter(): QueryAdapter.Filter {\n    return (this.cursor as any).cursorFilter;\n  }\n\n  setOptions({ limit, sort }: QueryAdapter.Options): void {\n    if (limit !== undefined) this.cursor.limit(limit);\n    if (sort !== undefined) this.cursor.sort(sort);\n  }\n\n  setFilter(filter: QueryAdapter.Filter): void {\n    this.cursor.filter(filter);\n  }\n\n  toArray(): Promise<T[]> {\n    return this.cursor.toArray();\n  }\n\n  stream(): Readable {\n    return this.cursor.stream();\n  }\n}\n","import type { FindCursor } from 'mongodb';\nimport { QueryAdapterMongodb } from './QueryAdapterMongodb';\nimport { QueryPaginator, type QueryPaginatorOptions } from './QueryPaginator';\n\ntype ExtractSchema<T> = T extends FindCursor<infer X> ? X : never;\n\n/**\n * Enhances a MongoDB `FindCursor` with pagination capabilities.\n *\n * @param cursor - The MongoDB cursor to be paginated.\n * @param [options] - Optional configuration for pagination.\n *\n * @example\n * // Basic usage with a MongoDB cursor:\n * import { MongoClient } from 'mongodb';\n *\n * async function paginateCollection() {\n *   const client = new MongoClient('mongodb://localhost:27017');\n *   await client.connect();\n *\n *   const db = client.db('exampleDb');\n *   const collection = db.collection('exampleCollection');\n *\n *   const cursor = collection.find({ status: 'active' });\n *\n *   const paginator = withMongoPagination(cursor, {\n *     paginationFields: ['_id'],\n *     next: null,\n *   });\n *\n *   const result = await paginator.exec();\n *   console.log(result.items); // Logs the items for the current page\n *   console.log(result.metadata); // Logs pagination metadata\n * }\n *\n *\n * @example\n * // Using a custom preQuery callback:\n * const paginator = withMongoPagination(cursor, {\n *   preQuery: function () {\n *     console.log('Executing query...');\n *   },\n * });\n *\n * const result = await paginator.exec();\n * console.log(result.items);\n *\n * @group Main\n */\nexport function withMongoPagination<T extends FindCursor>(\n  cursor: T,\n  options?: QueryPaginatorOptions,\n): QueryPaginator<ExtractSchema<T>> {\n  const adapter = new QueryAdapterMongodb(cursor);\n  const pagin = new QueryPaginator(adapter, options);\n\n  return pagin;\n}\n"],"names":[],"mappings":";;;;;;;;;AAIO,MAAM,mBAEb,CAAA;AAAA,EACE,YAAoB,MAAoB,EAAA;AAApB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAAA,GAAqB;AAAA,EAEzC,YAAuB,GAAA;AACrB,IAAO,OAAA,IAAA,CAAK,OAAO,SAAU,CAAA,UAAA,CAAA;AAAA,GAC/B;AAAA,EAEA,UAAmC,GAAA;AACjC,IAAM,MAAA,WAAA,GAAe,KAAK,MAAe,CAAA,WAAA,CAAA;AAEzC,IAAO,OAAA;AAAA,MACL,OAAO,WAAY,CAAA,KAAA;AAAA,MACnB,MAAM,WAAY,CAAA,IAAA;AAAA,KACpB,CAAA;AAAA,GACF;AAAA,EAEA,SAAiC,GAAA;AAC/B,IAAA,OAAQ,KAAK,MAAe,CAAA,YAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,UAAW,CAAA,EAAE,KAAO,EAAA,IAAA,EAAoC,EAAA;AACtD,IAAA,IAAI,KAAU,KAAA,KAAA,CAAA,EAAgB,IAAA,CAAA,MAAA,CAAO,MAAM,KAAK,CAAA,CAAA;AAChD,IAAA,IAAI,IAAS,KAAA,KAAA,CAAA,EAAgB,IAAA,CAAA,MAAA,CAAO,KAAK,IAAI,CAAA,CAAA;AAAA,GAC/C;AAAA,EAEA,UAAU,MAAmC,EAAA;AAC3C,IAAK,IAAA,CAAA,MAAA,CAAO,OAAO,MAAM,CAAA,CAAA;AAAA,GAC3B;AAAA,EAEA,OAAwB,GAAA;AACtB,IAAO,OAAA,IAAA,CAAK,OAAO,OAAQ,EAAA,CAAA;AAAA,GAC7B;AAAA,EAEA,MAAmB,GAAA;AACjB,IAAO,OAAA,IAAA,CAAK,OAAO,MAAO,EAAA,CAAA;AAAA,GAC5B;AACF;;ACOgB,SAAA,mBAAA,CACd,QACA,OACkC,EAAA;AAClC,EAAM,MAAA,OAAA,GAAU,IAAI,mBAAA,CAAoB,MAAM,CAAA,CAAA;AAC9C,EAAA,MAAM,KAAQ,GAAA,IAAI,cAAe,CAAA,OAAA,EAAS,OAAO,CAAA,CAAA;AAEjD,EAAO,OAAA,KAAA,CAAA;AACT;;;;"}

package/dist/mongoose-7.cjs

@@ -0,0 +1,36 @@
+'use strict';
+
+const withMongoosePagination = require('./shared/mongo-pagination.CHC5agt7.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

@@ -0,0 +1 @@
+{"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,QAAe,EAAA;AACjD,EAAA,MAAM,QAAQ,QAAS,CAAA,KAAA,CAAA;AAEvB,EAAA,KAAA,CAAM,UAAU,SAAY,GAAA,SAAA,CAAA;AAC5B,EAAA,KAAA,CAAM,UAAU,aAAgB,GAAA,aAAA,CAAA;AAClC,CAAA;AAEA,SAAS,SAAA,CAA+B,OAAiC,GAAA,EAAI,EAAA;AAC3E,EAAA,MAAM,KAAQ,GAAA,IAAA,CAAA;AAEd,EAAA,IAAI,SAAU,CAAA,MAAA,KAAW,CAAK,IAAA,KAAA,CAAM,UAAY,EAAA;AAC9C,IAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AAAA,GACf;AAEA,EAAM,KAAA,CAAA,UAAA,GAAaA,6CAAuB,CAAA,KAAA,EAAO,OAAO,CAAA,CAAA;AAExD,EAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AACf,CAAA;AAEA,SAAS,cAAmC,SAAmB,EAAA;AAC7D,EAAA,MAAM,KAAQ,GAAA,IAAA,CAAA;AAEd,EAAA,IAAI,SAAU,CAAA,MAAA,KAAW,CAAK,IAAA,KAAA,CAAM,UAAY,EAAA;AAC9C,IAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AAAA,GACf;AAEA,EAAM,KAAA,CAAA,UAAA,GAAaA,8CAAuB,KAAO,EAAA;AAAA,IAC/C,IAAM,EAAA,SAAA;AAAA,GACP,CAAA,CAAA;AAED,EAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AACf;;;;"}

package/dist/mongoose-7.d.cts

@@ -0,0 +1,16 @@
+import { a as QueryPaginatorOptions, b as QueryPaginator } from './shared/mongo-pagination.BU3-d0QB.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 as default };

package/dist/mongoose-7.d.mts

@@ -0,0 +1,16 @@
+import { a as QueryPaginatorOptions, b as QueryPaginator } from './shared/mongo-pagination.BU3-d0QB.mjs';
+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 as default };

package/dist/mongoose-7.d.ts

@@ -0,0 +1,16 @@
+import { a as QueryPaginatorOptions, b as QueryPaginator } from './shared/mongo-pagination.BU3-d0QB.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 as default };

package/dist/mongoose-7.mjs

@@ -0,0 +1,34 @@
+import { w as withMongoosePagination } from './shared/mongo-pagination.YG1DNE27.mjs';
+import '@andrew_l/toolkit';
+import 'kareem';
+import 'mongodb';
+import '@andrew_l/tl-pack';
+import 'debug';
+import '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(query, options);
+  return query._paginator;
+}
+function paginatorNext(nextToken) {
+  const query = this;
+  if (arguments.length === 0 && query._paginator) {
+    return query._paginator;
+  }
+  query._paginator = withMongoosePagination(query, {
+    next: nextToken
+  });
+  return query._paginator;
+}
+
+export { setupPlugin as default };
+//# sourceMappingURL=mongoose-7.mjs.map

package/dist/mongoose-7.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongoose-7.mjs","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":[],"mappings":";;;;;;;;AASA,SAAwB,YAAY,QAAe,EAAA;AACjD,EAAA,MAAM,QAAQ,QAAS,CAAA,KAAA,CAAA;AAEvB,EAAA,KAAA,CAAM,UAAU,SAAY,GAAA,SAAA,CAAA;AAC5B,EAAA,KAAA,CAAM,UAAU,aAAgB,GAAA,aAAA,CAAA;AAClC,CAAA;AAEA,SAAS,SAAA,CAA+B,OAAiC,GAAA,EAAI,EAAA;AAC3E,EAAA,MAAM,KAAQ,GAAA,IAAA,CAAA;AAEd,EAAA,IAAI,SAAU,CAAA,MAAA,KAAW,CAAK,IAAA,KAAA,CAAM,UAAY,EAAA;AAC9C,IAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AAAA,GACf;AAEA,EAAM,KAAA,CAAA,UAAA,GAAa,sBAAuB,CAAA,KAAA,EAAO,OAAO,CAAA,CAAA;AAExD,EAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AACf,CAAA;AAEA,SAAS,cAAmC,SAAmB,EAAA;AAC7D,EAAA,MAAM,KAAQ,GAAA,IAAA,CAAA;AAEd,EAAA,IAAI,SAAU,CAAA,MAAA,KAAW,CAAK,IAAA,KAAA,CAAM,UAAY,EAAA;AAC9C,IAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AAAA,GACf;AAEA,EAAM,KAAA,CAAA,UAAA,GAAa,uBAAuB,KAAO,EAAA;AAAA,IAC/C,IAAM,EAAA,SAAA;AAAA,GACP,CAAA,CAAA;AAED,EAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AACf;;;;"}

package/dist/mongoose-8.cjs

@@ -0,0 +1,36 @@
+'use strict';
+
+const withMongoosePagination = require('./shared/mongo-pagination.CHC5agt7.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

@@ -0,0 +1 @@
+{"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\n   */\n  // @ts-expect-error\n  class Query<\n    ResultType,\n    DocType,\n    THelpers = {},\n    RawDocType = unknown,\n    QueryOp = 'find',\n    TInstanceMethods = Record<string, never>,\n  > implements SessionOperation\n  {\n    paginator(options?: QueryPaginatorOptions): QueryPaginator<ResultType>;\n    paginatorNext(nextToken: string): QueryPaginator<ResultType>;\n  }\n}\n"],"names":["withMongoosePagination"],"mappings":";;;;;;;;;;AASA,SAAwB,YAAY,QAAe,EAAA;AACjD,EAAA,MAAM,QAAQ,QAAS,CAAA,KAAA,CAAA;AAEvB,EAAA,KAAA,CAAM,UAAU,SAAY,GAAA,SAAA,CAAA;AAC5B,EAAA,KAAA,CAAM,UAAU,aAAgB,GAAA,aAAA,CAAA;AAClC,CAAA;AAEA,SAAS,SAAA,CAA+B,OAAiC,GAAA,EAAI,EAAA;AAC3E,EAAA,MAAM,KAAQ,GAAA,IAAA,CAAA;AAEd,EAAA,IAAI,SAAU,CAAA,MAAA,KAAW,CAAK,IAAA,KAAA,CAAM,UAAY,EAAA;AAC9C,IAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AAAA,GACf;AAEA,EAAM,KAAA,CAAA,UAAA,GAAaA,6CAAuB,CAAA,KAAA,EAAO,OAAO,CAAA,CAAA;AAExD,EAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AACf,CAAA;AAEA,SAAS,cAAmC,SAAmB,EAAA;AAC7D,EAAA,MAAM,KAAQ,GAAA,IAAA,CAAA;AAEd,EAAA,IAAI,SAAU,CAAA,MAAA,KAAW,CAAK,IAAA,KAAA,CAAM,UAAY,EAAA;AAC9C,IAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AAAA,GACf;AAEA,EAAM,KAAA,CAAA,UAAA,GAAaA,8CAAuB,KAAO,EAAA;AAAA,IAC/C,IAAM,EAAA,SAAA;AAAA,GACP,CAAA,CAAA;AAED,EAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AACf;;;;"}

package/dist/mongoose-8.d.cts

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

package/dist/mongoose-8.d.mts

@@ -0,0 +1,16 @@
+import { a as QueryPaginatorOptions, b as QueryPaginator } from './shared/mongo-pagination.BU3-d0QB.mjs';
+import 'node:stream';
+import 'mongodb';
+
+declare function setupPlugin(mongoose: any): void;
+declare module 'mongoose' {
+    /**
+     * Patch original mongoose types
+     */
+    class Query<ResultType, DocType, THelpers = {}, RawDocType = unknown, QueryOp = 'find', TInstanceMethods = Record<string, never>> implements SessionOperation {
+        paginator(options?: QueryPaginatorOptions): QueryPaginator<ResultType>;
+        paginatorNext(nextToken: string): QueryPaginator<ResultType>;
+    }
+}
+
+export { setupPlugin as default };

package/dist/mongoose-8.d.ts

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

package/dist/mongoose-8.mjs

@@ -0,0 +1,34 @@
+import { w as withMongoosePagination } from './shared/mongo-pagination.YG1DNE27.mjs';
+import '@andrew_l/toolkit';
+import 'kareem';
+import 'mongodb';
+import '@andrew_l/tl-pack';
+import 'debug';
+import '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(query, options);
+  return query._paginator;
+}
+function paginatorNext(nextToken) {
+  const query = this;
+  if (arguments.length === 0 && query._paginator) {
+    return query._paginator;
+  }
+  query._paginator = withMongoosePagination(query, {
+    next: nextToken
+  });
+  return query._paginator;
+}
+
+export { setupPlugin as default };
+//# sourceMappingURL=mongoose-8.mjs.map

package/dist/mongoose-8.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongoose-8.mjs","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\n   */\n  // @ts-expect-error\n  class Query<\n    ResultType,\n    DocType,\n    THelpers = {},\n    RawDocType = unknown,\n    QueryOp = 'find',\n    TInstanceMethods = Record<string, never>,\n  > implements SessionOperation\n  {\n    paginator(options?: QueryPaginatorOptions): QueryPaginator<ResultType>;\n    paginatorNext(nextToken: string): QueryPaginator<ResultType>;\n  }\n}\n"],"names":[],"mappings":";;;;;;;;AASA,SAAwB,YAAY,QAAe,EAAA;AACjD,EAAA,MAAM,QAAQ,QAAS,CAAA,KAAA,CAAA;AAEvB,EAAA,KAAA,CAAM,UAAU,SAAY,GAAA,SAAA,CAAA;AAC5B,EAAA,KAAA,CAAM,UAAU,aAAgB,GAAA,aAAA,CAAA;AAClC,CAAA;AAEA,SAAS,SAAA,CAA+B,OAAiC,GAAA,EAAI,EAAA;AAC3E,EAAA,MAAM,KAAQ,GAAA,IAAA,CAAA;AAEd,EAAA,IAAI,SAAU,CAAA,MAAA,KAAW,CAAK,IAAA,KAAA,CAAM,UAAY,EAAA;AAC9C,IAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AAAA,GACf;AAEA,EAAM,KAAA,CAAA,UAAA,GAAa,sBAAuB,CAAA,KAAA,EAAO,OAAO,CAAA,CAAA;AAExD,EAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AACf,CAAA;AAEA,SAAS,cAAmC,SAAmB,EAAA;AAC7D,EAAA,MAAM,KAAQ,GAAA,IAAA,CAAA;AAEd,EAAA,IAAI,SAAU,CAAA,MAAA,KAAW,CAAK,IAAA,KAAA,CAAM,UAAY,EAAA;AAC9C,IAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AAAA,GACf;AAEA,EAAM,KAAA,CAAA,UAAA,GAAa,uBAAuB,KAAO,EAAA;AAAA,IAC/C,IAAM,EAAA,SAAA;AAAA,GACP,CAAA,CAAA;AAED,EAAA,OAAO,KAAM,CAAA,UAAA,CAAA;AACf;;;;"}

package/dist/shared/mongo-pagination.BU3-d0QB.d.cts

@@ -0,0 +1,194 @@
+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 schema version of the token.
+     */
+    schemaVersion: number;
+    /**
+     * 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(): Buffer;
+    /**
+     * Encode token from provided value
+     */
+    static from(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 };

package/dist/shared/mongo-pagination.BU3-d0QB.d.mts

@@ -0,0 +1,194 @@
+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 schema version of the token.
+     */
+    schemaVersion: number;
+    /**
+     * 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(): Buffer;
+    /**
+     * Encode token from provided value
+     */
+    static from(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 };