feat: pagination functionality

Author: shivarm

docs/guide/pagination.md

@@ -0,0 +1,56 @@
+## How to handle pagination ?
+
+Pagination is a common requirement in applications that deal with large datasets. The `mongodb-atlas-sdk` provides a simple way to implement pagination using the `DataPagination` class. let's explore how to use it effectively. It will return most recent data first.
+
+```typescript
+import express, { Request, Response } from 'express';
+import { DataPagination } from 'mongodb-atlas-sdk';
+import { User } from '../model/userModel';
+
+const app = express();
+const dataPagination = new DataPagination();
+
+app.get('/users', async (req: Request, res: Response) => {
+  try {
+    const page = parseInt(req.query.page as string) || 1;
+    const limit = parseInt(req.query.limit as string) || 10;
+
+    const result = await dataPagination.paginateResults(User, page, limit);
+
+    res.status(200).json(result);
+  } catch (err) {
+    res.status(500).json({ message: 'Failed to paginate data', error: err.message });
+  }
+});
+
+const PORT = process.env.PORT || 5000;
+app.listen(PORT, () => {
+  console.log(`Server is running on http://localhost:${PORT}`);
+});
+```
+
+## Example Response
+
+```json
+{
+  "results": [
+    {
+      "_id": "679a1343c406f835121d0f9d",
+      "name": "John Doe",
+      "email": "[email protected]",
+      "age": 31,
+      "__v": 0
+    },
+    {
+      "_id": "67a98564855d0233c02db952",
+      "name": "Jane Doe",
+      "email": "[email protected]",
+      "age": 28,
+      "__v": 0
+    }
+  ],
+  "total": 2,
+  "page": 1,
+  "pages": 1
+}
+```

docs/summary.md

@@ -11,10 +11,11 @@
 - [Installation](./guide/installation.md)
 - [Connect to MongoDB Atlas](./guide/connection.md)
 - [Create Schema and Model](./guide/schema.md)
+- [Backup and Restore](./guide/backup.md)
 - [Connection Pooling](./guide/connection-pool.md)
+- [Data Pagination](./guide/pagination.md)
 - [Query Caching](./guide/queryCaching.md)
 - [Audit Logging](./guide/auditLogging.md)
-- [Backup and Restore](./guide/backup.md)
 
 </details>
 

src/core/pagination.ts

@@ -0,0 +1,19 @@
+import mongoose from 'mongoose';
+
+export class DataPagination {
+  async paginateResult(model: mongoose.Model<any>, page: number, limit: number, query: any = {}): Promise<any> {
+    if (page < 1) {
+      page = 1;
+    }
+    const skip = (page - 1) * limit;
+    const result = await model.find(query).sort({ createdAt: -1 }).skip(skip).limit(limit).lean().exec();
+    const total = await model.countDocuments(query).exec();
+
+    return {
+      result,
+      total,
+      page,
+      pages: Math.ceil(total / limit),
+    };
+  }
+}