@tepez/mongo-cursor-pagination 8.0.1 → 8.0.2

package/index.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Based on https://github.com/mixmaxhq/mongo-cursor-pagination/blob/v7.3.1/README.md
+ */
+declare module '@tepez/mongo-cursor-pagination' {
+    import { Document, FilterQuery, LeanDocument, Schema } from 'mongoose';
+    type MongoosePlugin = Parameters<Schema['plugin']>[0]
+
+    export interface ICursorPaginationMongoosePluginOptions {
+        /**
+         * custom function name
+         * @default paginate
+         */
+        name?: string
+    }
+
+    export interface IPaginateOptions<T extends Document> {
+        /**
+         * The find query
+         */
+        query: FilterQuery<T>
+
+        /**
+         * The page size. Must be between 1 and `config.MAX_LIMIT`.
+         */
+        limit: number
+
+        /**
+         * Fields to query in the Mongo object format, e.g. {_id: 1, timestamp :1}.
+         * @default query all fields.
+         */
+        fields?: any
+
+        /**
+         * The field name to query the range for. The field must be:
+         * 1. Orderable. We must sort by this value. If duplicate values for paginatedField field
+         * exist, the results will be secondarily ordered by the _id.
+         * 2. Indexed. For large collections, this should be indexed for query performance.
+         * 3. Immutable. If the value changes between paged queries, it could appear twice.
+         * 4. Complete. A value must exist for all documents.
+         * The default is to use the Mongo built-in '_id' field, which satisfies the above criteria.
+         * The only reason to NOT use the Mongo _id field is if you chose to implement your own ids.
+         * @default _id
+         */
+        paginatedField?: string
+
+        /**
+         * True to sort using paginatedField ascending
+         * @default false - descending
+         */
+        sortAscending?: boolean
+
+        /**
+         * The value to start querying the page.
+         */
+        next?: string
+
+        /**
+         * The value to start querying previous page.
+         */
+        previous?: string
+    }
+
+    export interface IPaginateResult<T extends Document> {
+        results: LeanDocument<T>[]
+        previous?: string
+        /**
+         * base64 encoded
+         * Contains the ID of the last object in the page
+         */
+        next: string
+        hasNext: boolean
+    }
+
+    export interface ICursorPaginationExtendedModel<T extends Document> {
+        paginate(options: IPaginateOptions<T>): IPaginateResult<T>
+    }
+
+    export const mongoosePlugin: MongoosePlugin
+
+    export const config: {
+        /**
+         * @default 50
+         */
+        DEFAULT_LIMIT: number
+
+        /**
+         * @default 300
+         */
+        MAX_LIMIT: number
+    }
+}

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@tepez/mongo-cursor-pagination",
-  "version": "8.0.1",
+  "version": "8.0.2",
   "description": "Make it easy to return cursor-paginated results from a Mongo collection",
   "main": "index.js",
   "files": [
     "index.js",
     "dist",
-    "src"
+    "src",
+    "index.d.ts"
   ],
   "scripts": {
     "babelBuild": "babel src -d dist/node",