From ad776bc550c59a14f387157c2ea1dc733790fe49 Mon Sep 17 00:00:00 2001
From: Wouter R <gennerate@zonnet.nl>
Date: Wed, 5 Dec 2018 11:40:07 +0100
Subject: [PATCH] Update declarations to correspond with mongoose-paginate-v2
 module.

---
 types/mongoose-paginate-v2/index.d.ts         | 23 ++++++++++++++++---
 ...tests.ts => mongoose-paginate-v2-tests.ts} | 22 ++++++++++++++----
 types/mongoose-paginate-v2/tsconfig.json      |  4 ++--
 3 files changed, 39 insertions(+), 10 deletions(-)
 rename types/mongoose-paginate-v2/{mongoose-paginate-tests.ts => mongoose-paginate-v2-tests.ts} (68%)

diff --git a/types/mongoose-paginate-v2/index.d.ts b/types/mongoose-paginate-v2/index.d.ts
index ad54786f53..6c9103f852 100644
--- a/types/mongoose-paginate-v2/index.d.ts
+++ b/types/mongoose-paginate-v2/index.d.ts
@@ -1,15 +1,31 @@
-// Type definitions for mongoose-paginate 5.0.0
+// Type definitions for mongoose-paginate-v2 1.0.13
 // Project: https://github.com/edwardhotchkiss/mongoose-paginate
-// Definitions by: Linus Brolin <https://github.com/linusbrolin>, simonxca <https://github.com/simonxca>
+// Definitions by: Linus Brolin <https://github.com/linusbrolin>
+//                 simonxca <https://github.com/simonxca>
+//                 woutgg <https://github.com/woutgg>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 // TypeScript Version: 2.3
+//
+// Based on type declarations for mongoose-paginate 5.0.0.
 
 /// <reference types="mongoose" />
 
 declare module 'mongoose' {
+  export interface CustomLabels {
+    totalDocs?: string,
+    limit?: string,
+    page?: string,
+    totalPages?: string,
+    docs?: string,
+    nextPage?: string,
+    prevPage?: string,
+  }
+
   export interface PaginateOptions {
     select?: Object | string;
     sort?: Object | string;
+    customLabels?: CustomLabels,
+    collation?: CollationOptions,
     populate?: Array<Object> | Array<string> | Object | string;
     lean?: boolean;
     leanWithId?: boolean;
@@ -25,6 +41,7 @@ declare module 'mongoose' {
     page?: number;
     pages?: number;
     offset?: number;
+    [customLabel: string]: Array<T> | number | undefined;
   }
 
   interface PaginateModel<T extends Document> extends Model<T> {
@@ -44,7 +61,7 @@ declare module 'mongoose' {
     skipInit?: boolean): U;
 }
 
-declare module 'mongoose-paginate' {
+declare module 'mongoose-paginate-v2' {
   import mongoose = require('mongoose');
   var _: (schema: mongoose.Schema) => void;
   export = _;
diff --git a/types/mongoose-paginate-v2/mongoose-paginate-tests.ts b/types/mongoose-paginate-v2/mongoose-paginate-v2-tests.ts
similarity index 68%
rename from types/mongoose-paginate-v2/mongoose-paginate-tests.ts
rename to types/mongoose-paginate-v2/mongoose-paginate-v2-tests.ts
index d55f8a454e..8410c740e5 100644
--- a/types/mongoose-paginate-v2/mongoose-paginate-tests.ts
+++ b/types/mongoose-paginate-v2/mongoose-paginate-v2-tests.ts
@@ -43,12 +43,22 @@ router.get('/users.json', function(req: Request, res: Response) {
     let options: PaginateOptions = {} as PaginateOptions;
     options.select = 'email username';
     options.sort = { 'username': (descending ? -1 : 1) };
+    options.collation = { locale: 'en_US', strength: 1 };
     options.populate = '';
     options.lean = true;
     options.leanWithId = false;
     options.offset = 0;
     options.page = 1;
     options.limit = 10;
+    options.customLabels = {
+        totalDocs: 'totalDocsCustom',
+        limit: 'limitCustom',
+        page: 'pageCustom',
+        totalPages: 'totalPagesCustom',
+        docs: 'docsCustom',
+        nextPage: 'nextPageCustom',
+        prevPage: 'prevPageCustom'
+    };
 
     UserModel
     .paginate({}, options, (err: any, value: PaginateResult<User>) => {
@@ -57,13 +67,15 @@ router.get('/users.json', function(req: Request, res: Response) {
             return res.status(500).send(err);
         }
 
-        console.log('total: ' + value.total);
-        console.log('limit: ' + value.limit);
-        console.log('page: ' + value.page);
-        console.log('pages: ' + value.pages);
+        console.log('totalDocs: ' + value.totalDocsCustom);
+        console.log('limit: ' + value.limitCustom);
+        console.log('page: ' + value.pageCustom);
+        console.log('nextPage: ' + value.nextPageCustom);
+        console.log('prevPage: ' + value.prevPageCustom);
+        console.log('totalPages: ' + value.totalPagesCustom);
         console.log('offset: ' + value.offset);
         console.log('docs: ');
-        console.dir(value.docs);
+        console.dir(value.docsCustom);
         return res.json(value);
     });
 
diff --git a/types/mongoose-paginate-v2/tsconfig.json b/types/mongoose-paginate-v2/tsconfig.json
index 3194368f11..1e367240a9 100644
--- a/types/mongoose-paginate-v2/tsconfig.json
+++ b/types/mongoose-paginate-v2/tsconfig.json
@@ -18,6 +18,6 @@
     },
     "files": [
         "index.d.ts",
-        "mongoose-paginate-tests.ts"
+        "mongoose-paginate-v2-tests.ts"
     ]
-}
\ No newline at end of file
+}