chore: update dependencies and enhance TypeScript configuration

Signed-off-by: Alejandro Dominguez <adborroto90@gmail.com>

Author: adborroto

package-lock.json

@@ -39,7 +39,7 @@
   },
   "homepage": "https://github.com/mixmaxhq/mongo-cursor-pagination#readme",
   "dependencies": {
-    "@types/express": "^5.0.0",
+    "@types/express": "^4.17.21",
     "base64-url": "^2.2.0",
     "bson": "^4.7.2",
     "object-path": "^0.11.8",
@@ -54,7 +54,7 @@
     "@mixmaxhq/semantic-release-config": "^2.0.0",
     "@mixmaxhq/ts-config": "^1.2.1",
     "@types/jest": "^29.5.12",
-    "@types/node": "^22.7.4",
+    "@types/node": "^18.19.70",
     "@typescript-eslint/eslint-plugin": "^4.33.0",
     "@typescript-eslint/parser": "^4.33.0",
     "cz-conventional-changelog": "^3.2.0",

package.json

@@ -43,7 +43,7 @@ export default async function aggregate(
     aggregationPipeline = params.aggregation.concat([{ $match }, { $sort }, { $limit }]);
   }
 
-  const options: Record<string, any> = { ...params.options };
+  const options: Record<string, any> = { ...(params.options || {}) };
 
   // Handle collation
   const isCollationNull = params.collation === null;

src/aggregate.ts

@@ -34,7 +34,7 @@ export default async function findWithPagination(
   let response;
   if (params.sortCaseInsensitive) {
     // For case-insensitive sorting, we need to work with an aggregation:
-    response = aggregate(
+    response = await aggregate(
       collection,
       Object.assign({}, params, {
         aggregation: params.query ? [{ $match: params.query }] : [],

src/find.ts

@@ -1,13 +1,13 @@
 import { Collection, Document } from 'mongodb';
 import _ from 'underscore';
 import config from './config';
-import bsonUrlEncoding from './utils/bsonUrlEncoding';
+import bsonUrlEncoding, { Encodable } from './utils/bsonUrlEncoding';
 
 export interface SearchParams {
   query?: Record<string, any>;
   limit?: number;
   fields?: Record<string, number>;
-  next?: string;
+  next?: Encodable;
 }
 
 export interface SearchResponse<T = Document> {
@@ -35,7 +35,7 @@ export default async function search<T = Document>(
   params: SearchParams
 ): Promise<SearchResponse<T>> {
   if (params.next) {
-    params.next = bsonUrlEncoding.decode(params.next) as string;
+    params.next = bsonUrlEncoding.decode(params.next as string);
   }
 
   params = _.defaults(params, {

src/search.ts

@@ -52,7 +52,9 @@ export default async function sanitizeParams(
       if (doc) {
         // Handle usage of dot notation in paginatedField
         let prop = getPropertyViaDotNotation(params.paginatedField, doc);
-        if (params.sortCaseInsensitive) prop = (prop as string).toLowerCase();
+        if (params.sortCaseInsensitive && typeof prop === 'string') {
+          prop = prop.toLowerCase();
+        }
         params.next = [prop, params.after];
       }
     } else {
@@ -77,7 +79,10 @@ export default async function sanitizeParams(
       if (doc) {
         // Handle usage of dot notation in paginatedField
         let prop = getPropertyViaDotNotation(params.paginatedField, doc);
-        if (params.sortCaseInsensitive) prop = (prop as string).toLowerCase();
+        if (params.sortCaseInsensitive && typeof prop === 'string') {
+          prop = prop.toLowerCase();
+        }
+
         params.previous = [prop, params.before];
       }
     } else {

src/utils/sanitizeParams.ts

@@ -0,0 +1,78 @@
+import { Collection } from 'mongodb';
+import sanitizeParams from '../../src/utils/sanitizeParams';
+import bsonUrlEncoding from '../../src/utils/bsonUrlEncoding';
+import config from '../../src/config';
+
+describe('sanitizeParams', () => {
+  let collection: Collection;
+
+  beforeEach(() => {
+    collection = ({
+      findOne: jest.fn(),
+    } as unknown) as Collection;
+  });
+
+  it('should decode previous and next params', async () => {
+    const params = {
+      previous: bsonUrlEncoding.encode([1, 'test']),
+      next: bsonUrlEncoding.encode([1, 'test_next']),
+    };
+    const sanitizedParams = await sanitizeParams(collection, params);
+    expect(sanitizedParams.previous).toEqual([1, 'test']);
+    expect(sanitizedParams.next).toEqual([1, 'test_next']);
+  });
+
+  it('should set default limit and paginatedField', async () => {
+    const params = {};
+    const sanitizedParams = await sanitizeParams(collection, params);
+    expect(sanitizedParams.limit).toBe(50);
+    expect(sanitizedParams.paginatedField).toBe('_id');
+  });
+
+  it('should limit the number of results', async () => {
+    const params = { limit: 0 };
+    let sanitizedParams = await sanitizeParams(collection, params);
+    expect(sanitizedParams.limit).toBe(1);
+
+    params.limit = 2000;
+    sanitizedParams = await sanitizeParams(collection, params);
+    expect(sanitizedParams.limit).toBe(config.MAX_LIMIT);
+  });
+
+  it('should handle `after` param', async () => {
+    const params = { after: 'some_id' };
+    const sanitizedParams = await sanitizeParams(collection, params);
+    expect(sanitizedParams.next).toBe('some_id');
+  });
+
+  it('should handle `before` param', async () => {
+    const params = { before: 'some_id' };
+    const sanitizedParams = await sanitizeParams(collection, params);
+    expect(sanitizedParams.previous).toBe('some_id');
+  });
+
+  it('should include paginatedField in query fields', async () => {
+    const params = { fields: { name: 1 } };
+    const sanitizedParams = await sanitizeParams(collection, params);
+    expect(sanitizedParams.fields).toEqual({ _id: 1, name: 1 });
+  });
+
+  it('should handle `sortCaseInsensitive` param', async () => {
+    const params = {
+      paginatedField: 'name',
+      sortCaseInsensitive: true,
+      before: 'some_id',
+    };
+    const mockDoc = { _id: 'some_id', name: 'John' };
+    (collection.findOne as jest.Mock).mockResolvedValueOnce(mockDoc);
+
+    const paramsWithBefore = {
+      ...params,
+      before: 'some_id',
+    };
+    const sanitizedParamsWithBefore = await sanitizeParams(collection, paramsWithBefore);
+    expect(sanitizedParamsWithBefore.previous).toEqual(['john', 'some_id']);
+
+    expect(collection.findOne).toHaveBeenCalledWith({ _id: 'some_id' }, { name: true, _id: false });
+  });
+});

test/utils/sanitizeParams.test.ts

@@ -1,7 +1,12 @@
 {
   "extends": "@mixmaxhq/ts-config/tsconfig.json",
   "compilerOptions": {
-    "outDir": "dist/node"
+    "outDir": "dist/node",
+    "declaration": true,
+    "sourceMap": true,
+    "removeComments": true,
+    "importHelpers": true,
+    "skipLibCheck": true
   },
   "include": [
     "./src/**/*"