@villedemontreal/mongo 6.7.0

package/dist/src/mongoUtils.js

@@ -0,0 +1,280 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mongoUtils = exports.MongoUtils = void 0;
+// ==========================================
+// Mongo utilities
+// ==========================================
+const general_utils_1 = require("@villedemontreal/general-utils");
+const logger_1 = require("@villedemontreal/logger");
+const fs = require("fs-extra");
+const HttpStatusCodes = require("http-status-codes");
+const _ = require("lodash");
+const mongodb_memory_server_core_1 = require("mongodb-memory-server-core");
+const mongoose = require("mongoose");
+const constants_1 = require("./config/constants");
+/**
+ * Mongo utilities
+ */
+class MongoUtils {
+    constructor() {
+        this.useReplSet = false;
+        this.mockgosseMockedFlag = 'mocked';
+    }
+    /**
+     * Mocks the Mongo databases created through Mongoose.
+     *
+     * IMPORTANT!!
+     * For the "mochaInstance" parameter to be the proper
+     * one, this function must be called from a *regular function* in a
+     * test file, not from an *arrow function*! For more informations,
+     * see : https://github.com/mochajs/mocha/issues/2018
+     *
+     * Note that, currently, once this mocking is in place,
+     * it can't be removed. You should only call this function
+     * during testing!
+     *
+     * If Mongoose is already mocked, the function does nothing.
+     *
+     * @param mocha from a Mocha test file, pass "this" as the value
+     * for this parameter or "null" from elsewhere.
+     *
+     * @param mongoServerVersion the Mongo version to use.
+     * Pass null (or undefined) to use the default version
+     * downloaded by mongodb-memory-server.
+     */
+    async mockMongoose(mochaInstance, mongoServerVersion, useReplSet = false) {
+        // ==========================================
+        // We only mock the database if it's
+        // not already so.
+        // ==========================================
+        if (!this.mongoMemServer) {
+            // this.useReplSet = useReplSet;
+            // ==========================================
+            // Path to download the mocked Mongo server to.
+            // We make sure this folder is wihtin the application
+            // so when the application is mounted in a Docker
+            // container, the server will not be downloaded
+            // over and over.
+            // ==========================================
+            const downloadDirPath = constants_1.constants.appRoot + '/temp/mockServer';
+            if (!fs.existsSync(downloadDirPath)) {
+                fs.mkdirsSync(downloadDirPath);
+            }
+            // ==========================================
+            // Data directory
+            // ==========================================
+            const dataRootPath = downloadDirPath + '/data';
+            if (!fs.existsSync(dataRootPath)) {
+                fs.mkdirsSync(dataRootPath);
+            }
+            else {
+                await general_utils_1.utils.clearDir(dataRootPath);
+            }
+            const dataPath = `${dataRootPath}/${Date.now()}`;
+            fs.mkdirsSync(dataPath);
+            // ==========================================
+            // Increases the Mocha timeout to allow more time to
+            // download the test server, if required.
+            // ==========================================
+            if (mochaInstance) {
+                if (!mochaInstance.timeout || !_.isFunction(mochaInstance.timeout)) {
+                    throw new Error(`The "mocha" parameter passed to the "mockMongoose(...)" method ` +
+                        `doesn't seems to be of the correct type. Make sure the function in which you ` +
+                        `call "mockMongoose(...)" is itself a *regular* function, not an *arrow* function. ` +
+                        `Have a look at https://github.com/mochajs/mocha/issues/2018 for more infos.`);
+                }
+                mochaInstance.timeout(120000);
+            }
+            // Voir https://www.npmjs.com/package/mongodb-memory-server pour les options
+            const memoryServerOption = {
+                instance: {
+                    dbPath: dataPath // by default create in temp directory,
+                },
+                binary: {
+                    version: mongoServerVersion ? mongoServerVersion : 'latest',
+                    downloadDir: downloadDirPath // by default node_modules/.cache/mongodb-memory-server/mongodb-binaries
+                },
+                debug: false
+            };
+            if (useReplSet) {
+                const replSetOptions = Object.assign(Object.assign({}, memoryServerOption), { replSet: { count: 3 } });
+                this.mongoMemServer = await mongodb_memory_server_core_1.MongoMemoryReplSet.create(replSetOptions);
+            }
+            else {
+                // Create mock
+                this.mongoMemServer = await mongodb_memory_server_core_1.MongoMemoryServer.create(memoryServerOption);
+            }
+        }
+        return this.mongoMemServer;
+    }
+    /**
+     * Drop all mocked Mongo databases.
+     *
+     */
+    async dropMockedDatabases() {
+        if (this.mongoMemServer) {
+            await mongoose.disconnect();
+            await this.mongoMemServer.stop();
+            this.mongoMemServer = null;
+        }
+    }
+    async getMockedServerPort() {
+        const mongooseConnection = mongoose[this.mockgosseMockedFlag];
+        if (mongooseConnection && this.mongoMemServer && !this.useReplSet) {
+            return this.mongoMemServer.instanceInfo.port;
+        }
+        if (mongooseConnection && this.mongoMemServer && this.useReplSet) {
+            const servers = this.mongoMemServer.servers;
+            let port = null;
+            for (const serv of servers) {
+                if (serv.instanceInfo.instance.isInstancePrimary) {
+                    port = serv.instanceInfo.port;
+                    break;
+                }
+            }
+            return port;
+        }
+        return null;
+    }
+    /**
+     * Validates if an object is a Mongoose
+     * error.
+     */
+    isMongooseError(obj) {
+        if (_.isEmpty(obj)) {
+            return false;
+        }
+        if (_.isEmpty(obj.errors) && 'kind' in obj && 'path' in obj && 'message' in obj) {
+            return true;
+        }
+        Object.keys(obj.errors).forEach(errorKey => {
+            const errorObject = obj.errors[errorKey];
+            if (!('kind' in errorObject) || !('path' in errorObject) || !('message' in errorObject)) {
+                return false;
+            }
+            return true;
+        });
+        return true;
+    }
+    /**
+     * Validates if an object is a plain
+     * Mongo error.
+     */
+    isPlainMongoError(errorObject) {
+        if (_.isEmpty(errorObject)) {
+            return false;
+        }
+        if (!('code' in errorObject) ||
+            !('name' in errorObject) ||
+            !('errmsg' in errorObject) ||
+            !('message' in errorObject)) {
+            return false;
+        }
+        return true;
+    }
+    /**
+     * Creates an Api eror from an error thrown
+     * by Mongoose.
+     *
+     * If the specified error is not a Mongo/Mongoose error, it
+     * will be returned as is.
+     *
+     * @param error the Mongo/Mongoose error object
+     * @param publicMessage a public message to be used in the
+     * generated error. Fopr example : "The user is invalid".
+     */
+    convertMongoOrMongooseErrorToApiError(err, publicMessage) {
+        if (!err) {
+            return general_utils_1.createServerError('Empty error object');
+        }
+        let errClean = err;
+        // ==========================================
+        // Plain Mongo error
+        // ==========================================
+        if (this.isPlainMongoError(errClean)) {
+            // ==========================================
+            // Duplicate key error?
+            // We create an error with a "Conflit" http status
+            // code.
+            // ==========================================
+            if (errClean.code === constants_1.constants.mongo.mongoErrorCodes.DUPLICATE_KEY) {
+                return general_utils_1.createError(general_utils_1.globalConstants.errors.apiGeneralErrors.codes.DUPLICATE_KEY, publicMessage)
+                    .httpStatus(HttpStatusCodes.CONFLICT)
+                    .publicMessage(publicMessage)
+                    .logLevel(logger_1.LogLevel.INFO)
+                    .logStackTrace(false)
+                    .build();
+            }
+            // ==========================================
+            // Unmanaged Mongo error, we return it as is.
+            // ==========================================
+            return errClean;
+        }
+        if (this.isMongooseError(errClean)) {
+            // ==========================================
+            // Mongoose error
+            // ==========================================
+            if (_.isEmpty(errClean.errors)) {
+                // ==========================================
+                // Invalid id
+                // ==========================================
+                if (errClean.kind === constants_1.constants.mongo.mongoose.errorKinds.OBJECT_ID &&
+                    errClean.name === constants_1.constants.mongo.mongoose.errorNames.CAST_ERROR) {
+                    throw general_utils_1.createNotFoundError('Invalid ObjectId id', publicMessage);
+                }
+                else {
+                    const error = errClean;
+                    errClean = {
+                        errors: [error]
+                    };
+                }
+            }
+            let errorDetails;
+            if (errClean.errors && !_.isEmpty(errClean.errors)) {
+                errorDetails = [];
+                Object.keys(errClean.errors).forEach(errorKey => {
+                    const errorMessage = errClean.errors[errorKey];
+                    const errorDetail = {
+                        code: errorMessage.kind,
+                        target: errorMessage.path,
+                        message: errorMessage.message
+                    };
+                    errorDetails.push(errorDetail);
+                });
+            }
+            throw general_utils_1.createInvalidParameterError(publicMessage, errorDetails);
+        }
+        else {
+            // ==========================================
+            // Not a Mongo or Mongoose error, we return it
+            // as is.
+            // ==========================================
+            return errClean;
+        }
+    }
+    /**
+     * Converts a Mongoose Document to a plain Pojo.
+     */
+    convertMongooseDocumentToPlainObject(document) {
+        if (!document) {
+            return document;
+        }
+        const pojo = document.toObject();
+        // ==========================================
+        // Converts the "_id" property to "id"
+        // ==========================================
+        // tslint:disable-next-line:no-string-literal
+        pojo['id'] = pojo['_id'].toString();
+        // tslint:disable-next-line:no-string-literal
+        delete pojo['_id'];
+        // ==========================================
+        // Removes the "__v"
+        // ==========================================
+        // tslint:disable-next-line:no-string-literal
+        delete pojo['__v'];
+        return pojo;
+    }
+}
+exports.MongoUtils = MongoUtils;
+exports.mongoUtils = new MongoUtils();
+//# sourceMappingURL=mongoUtils.js.map

package/dist/src/mongoUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongoUtils.js","sourceRoot":"","sources":["../../src/mongoUtils.ts"],"names":[],"mappings":";;;AAAA,6CAA6C;AAC7C,kBAAkB;AAClB,6CAA6C;AAC7C,kEASwC;AACxC,oDAAmD;AACnD,+BAA+B;AAC/B,qDAAqD;AACrD,4BAA4B;AAE5B,2EAAmF;AACnF,qCAAqC;AACrC,kDAA+C;AAE/C;;GAEG;AACH,MAAa,UAAU;IAAvB;QAEU,eAAU,GAAY,KAAK,CAAC;QAE5B,wBAAmB,GAAG,QAAQ,CAAC;IAmSzC,CAAC;IAjSC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,KAAK,CAAC,YAAY,CACvB,aAA4B,EAC5B,kBAA0B,EAC1B,aAAsB,KAAK;QAE3B,6CAA6C;QAC7C,oCAAoC;QACpC,kBAAkB;QAClB,6CAA6C;QAC7C,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YACxB,gCAAgC;YAChC,6CAA6C;YAC7C,+CAA+C;YAC/C,qDAAqD;YACrD,iDAAiD;YACjD,+CAA+C;YAC/C,iBAAiB;YACjB,6CAA6C;YAC7C,MAAM,eAAe,GAAG,qBAAS,CAAC,OAAO,GAAG,kBAAkB,CAAC;YAC/D,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE;gBACnC,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;aAChC;YAED,6CAA6C;YAC7C,iBAAiB;YACjB,6CAA6C;YAC7C,MAAM,YAAY,GAAG,eAAe,GAAG,OAAO,CAAC;YAC/C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;gBAChC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;aAC7B;iBAAM;gBACL,MAAM,qBAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;aACpC;YACD,MAAM,QAAQ,GAAG,GAAG,YAAY,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;YACjD,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAExB,6CAA6C;YAC7C,oDAAoD;YACpD,yCAAyC;YACzC,6CAA6C;YAC7C,IAAI,aAAa,EAAE;gBACjB,IAAI,CAAC,aAAa,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;oBAClE,MAAM,IAAI,KAAK,CACb,iEAAiE;wBAC/D,+EAA+E;wBAC/E,oFAAoF;wBACpF,6EAA6E,CAChF,CAAC;iBACH;gBAED,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aAC/B;YAED,4EAA4E;YAC5E,MAAM,kBAAkB,GAAQ;gBAC9B,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ,CAAC,uCAAuC;iBACzD;gBAED,MAAM,EAAE;oBACN,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,QAAQ;oBAC3D,WAAW,EAAE,eAAe,CAAC,wEAAwE;iBACtG;gBACD,KAAK,EAAE,KAAK;aACb,CAAC;YAEF,IAAI,UAAU,EAAE;gBACd,MAAM,cAAc,mCACf,kBAAkB,KACrB,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,GACtB,CAAC;gBACF,IAAI,CAAC,cAAc,GAAG,MAAM,+CAAkB,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;aACvE;iBAAM;gBACL,cAAc;gBACd,IAAI,CAAC,cAAc,GAAG,MAAM,8CAAiB,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;aAC1E;SACF;QACD,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,mBAAmB;QAC9B,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;YACjC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;SAC5B;IACH,CAAC;IAEM,KAAK,CAAC,mBAAmB;QAC9B,MAAM,kBAAkB,GAAG,QAAQ,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC9D,IAAI,kBAAkB,IAAI,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACjE,OAAQ,IAAI,CAAC,cAAoC,CAAC,YAAY,CAAC,IAAI,CAAC;SACrE;QACD,IAAI,kBAAkB,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,UAAU,EAAE;YAChE,MAAM,OAAO,GAAI,IAAI,CAAC,cAAqC,CAAC,OAAO,CAAC;YACpE,IAAI,IAAI,GAAG,IAAI,CAAC;YAChB,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE;gBAC1B,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,iBAAiB,EAAE;oBAChD,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;oBAC9B,MAAM;iBACP;aACF;YACD,OAAO,IAAI,CAAC;SACb;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,GAAQ;QAC7B,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAClB,OAAO,KAAK,CAAC;SACd;QAED,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,SAAS,IAAI,GAAG,EAAE;YAC/E,OAAO,IAAI,CAAC;SACb;QAED,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YACzC,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAEzC,IAAI,CAAC,CAAC,MAAM,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,SAAS,IAAI,WAAW,CAAC,EAAE;gBACvF,OAAO,KAAK,CAAC;aACd;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,WAAgB;QACvC,IAAI,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;YAC1B,OAAO,KAAK,CAAC;SACd;QAED,IACE,CAAC,CAAC,MAAM,IAAI,WAAW,CAAC;YACxB,CAAC,CAAC,MAAM,IAAI,WAAW,CAAC;YACxB,CAAC,CAAC,QAAQ,IAAI,WAAW,CAAC;YAC1B,CAAC,CAAC,SAAS,IAAI,WAAW,CAAC,EAC3B;YACA,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;OAUG;IACI,qCAAqC,CAAC,GAAQ,EAAE,aAAqB;QAC1E,IAAI,CAAC,GAAG,EAAE;YACR,OAAO,iCAAiB,CAAC,oBAAoB,CAAC,CAAC;SAChD;QAED,IAAI,QAAQ,GAAG,GAAG,CAAC;QAEnB,6CAA6C;QAC7C,oBAAoB;QACpB,6CAA6C;QAC7C,IAAI,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE;YACpC,6CAA6C;YAC7C,uBAAuB;YACvB,kDAAkD;YAClD,QAAQ;YACR,6CAA6C;YAC7C,IAAI,QAAQ,CAAC,IAAI,KAAK,qBAAS,CAAC,KAAK,CAAC,eAAe,CAAC,aAAa,EAAE;gBACnE,OAAO,2BAAW,CAAC,+BAAe,CAAC,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,aAAa,EAAE,aAAa,CAAC;qBAC3F,UAAU,CAAC,eAAe,CAAC,QAAQ,CAAC;qBACpC,aAAa,CAAC,aAAa,CAAC;qBAC5B,QAAQ,CAAC,iBAAQ,CAAC,IAAI,CAAC;qBACvB,aAAa,CAAC,KAAK,CAAC;qBACpB,KAAK,EAAE,CAAC;aACZ;YAED,6CAA6C;YAC7C,6CAA6C;YAC7C,6CAA6C;YAC7C,OAAO,QAAQ,CAAC;SACjB;QACD,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE;YAClC,6CAA6C;YAC7C,iBAAiB;YACjB,6CAA6C;YAC7C,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBAC9B,6CAA6C;gBAC7C,aAAa;gBACb,6CAA6C;gBAC7C,IACE,QAAQ,CAAC,IAAI,KAAK,qBAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS;oBAC/D,QAAQ,CAAC,IAAI,KAAK,qBAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,EAChE;oBACA,MAAM,mCAAmB,CAAC,qBAAqB,EAAE,aAAa,CAAC,CAAC;iBACjE;qBAAM;oBACL,MAAM,KAAK,GAAG,QAAQ,CAAC;oBACvB,QAAQ,GAAG;wBACT,MAAM,EAAE,CAAC,KAAK,CAAC;qBAChB,CAAC;iBACH;aACF;YAED,IAAI,YAAyB,CAAC;YAC9B,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBAClD,YAAY,GAAG,EAAE,CAAC;gBAClB,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;oBAC9C,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;oBAE/C,MAAM,WAAW,GAAc;wBAC7B,IAAI,EAAE,YAAY,CAAC,IAAI;wBACvB,MAAM,EAAE,YAAY,CAAC,IAAI;wBACzB,OAAO,EAAE,YAAY,CAAC,OAAO;qBAC9B,CAAC;oBACF,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACjC,CAAC,CAAC,CAAC;aACJ;YACD,MAAM,2CAA2B,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;SAChE;aAAM;YACL,6CAA6C;YAC7C,8CAA8C;YAC9C,SAAS;YACT,6CAA6C;YAC7C,OAAO,QAAQ,CAAC;SACjB;IACH,CAAC;IAED;;OAEG;IACI,oCAAoC,CAAI,QAA+B;QAC5E,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,QAAQ,CAAC;SACjB;QAED,MAAM,IAAI,GAAM,QAAQ,CAAC,QAAQ,EAAO,CAAC;QAEzC,6CAA6C;QAC7C,sCAAsC;QACtC,6CAA6C;QAC7C,6CAA6C;QAC7C,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;QACpC,6CAA6C;QAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;QAEnB,6CAA6C;QAC7C,oBAAoB;QACpB,6CAA6C;QAC7C,6CAA6C;QAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;QAEnB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAvSD,gCAuSC;AACU,QAAA,UAAU,GAAe,IAAI,UAAU,EAAE,CAAC"}

package/dist/src/mongoUtils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/mongoUtils.test.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const mongodb_memory_server_core_1 = require("mongodb-memory-server-core");
+const mongoUtils_1 = require("./mongoUtils");
+describe('MongoUtils - #mockMongoose', () => {
+    /*
+      It is mandatory to create a new instance of MongoUtils to test the function mockMongoose as the singleton will keep its parameters instanced if used again. The parameter mongoMemServer, if instanciated by a first call,
+      won't be changed on a second one, as if the memory server is already mocked, nothing happens.
+    */
+    it('should return a mongo memory server', async function () {
+        const mongoUtils = new mongoUtils_1.MongoUtils();
+        const memServ = await mongoUtils.mockMongoose(this, null, false);
+        chai_1.assert.isDefined(memServ);
+        chai_1.assert.instanceOf(memServ, mongodb_memory_server_core_1.MongoMemoryServer);
+    });
+    it('should return a mongo memory replica set', async function () {
+        const mongoUtils = new mongoUtils_1.MongoUtils();
+        const memServ = await mongoUtils.mockMongoose(this, null, true);
+        chai_1.assert.isDefined(memServ);
+        chai_1.assert.instanceOf(memServ, mongodb_memory_server_core_1.MongoMemoryReplSet);
+    });
+});
+//# sourceMappingURL=mongoUtils.test.js.map

package/dist/src/mongoUtils.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongoUtils.test.js","sourceRoot":"","sources":["../../src/mongoUtils.test.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAC9B,2EAAmF;AACnF,6CAA0C;AAE1C,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C;;;MAGE;IACF,EAAE,CAAC,qCAAqC,EAAE,KAAK;QAC7C,MAAM,UAAU,GAAG,IAAI,uBAAU,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QACjE,aAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC1B,aAAM,CAAC,UAAU,CAAC,OAAO,EAAE,8CAAiB,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK;QAClD,MAAM,UAAU,GAAG,IAAI,uBAAU,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAChE,aAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC1B,aAAM,CAAC,UAAU,CAAC,OAAO,EAAE,+CAAkB,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/plugins/pagination/index.d.ts

@@ -0,0 +1,11 @@
+import { IPaginateOptions } from './specs/IPaginateOptions';
+/**
+ * @param {Schema} schema
+ */
+export declare function mongoosePaginate(schema: any): void;
+export declare class PaginateBuilder {
+    private static readonly defaultOptions;
+    static getOptions(...options: IPaginateOptions[]): IPaginateOptions;
+    static executeQueries(model: any, query: any, options: IPaginateOptions): [Promise<any[]>, Promise<number>];
+    static processResult(promises: any[], options: IPaginateOptions, callback: (error: Error, result: any) => void): Promise<any>;
+}

package/dist/src/plugins/pagination/index.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaginateBuilder = exports.mongoosePaginate = void 0;
+function paginate(q, options, callback) {
+    const optionsClean = PaginateBuilder.getOptions(paginate.options, options);
+    const query = q || {};
+    const promises = PaginateBuilder.executeQueries(this, query, optionsClean);
+    return PaginateBuilder.processResult(promises, optionsClean, callback);
+}
+/**
+ * @param {Schema} schema
+ */
+function mongoosePaginate(schema) {
+    schema.statics.paginate = paginate;
+}
+exports.mongoosePaginate = mongoosePaginate;
+class PaginateBuilder {
+    static getOptions(...options) {
+        return Object.assign({}, PaginateBuilder.defaultOptions, ...options);
+    }
+    static executeQueries(model, query, options) {
+        const { select, sort, populate, lean, leanWithId, limit, offset } = options;
+        let itemsQuery;
+        if (leanWithId) {
+            // only to prevent "'leanWithId' is declared but its value is never read"
+        }
+        if (limit > 0) {
+            itemsQuery = model
+                .find(query)
+                .select(select)
+                .sort(sort)
+                .skip(offset)
+                .limit(limit)
+                .lean(lean);
+            if (populate) {
+                [].concat(populate).forEach(item => itemsQuery.populate(item));
+            }
+        }
+        return [itemsQuery && limit > 0 ? itemsQuery.exec() : Promise.resolve([]), model.countDocuments(query).exec()];
+    }
+    static processResult(promises, options, callback) {
+        const { lean, leanWithId, limit, offset } = options;
+        return new Promise((resolve, reject) => {
+            Promise.all(promises).then(data => {
+                const items = data[0];
+                const count = data[1];
+                const result = { paging: { limit, offset, totalCount: count } };
+                if (lean && leanWithId) {
+                    result.items = items.map((doc) => {
+                        doc.id = String(doc._id);
+                        delete doc._id;
+                        delete doc.__v;
+                        return doc;
+                    });
+                }
+                else {
+                    result.items = items;
+                }
+                if (typeof callback === 'function') {
+                    return callback(null, result);
+                }
+                resolve(result);
+            }, error => {
+                if (typeof callback === 'function') {
+                    return callback(error, null);
+                }
+                reject(error);
+            });
+        });
+    }
+}
+exports.PaginateBuilder = PaginateBuilder;
+PaginateBuilder.defaultOptions = Object.freeze({
+    lean: false,
+    leanWithId: true,
+    limit: 10,
+    offset: 0
+});
+//# sourceMappingURL=index.js.map

package/dist/src/plugins/pagination/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/plugins/pagination/index.ts"],"names":[],"mappings":";;;AAEA,SAAS,QAAQ,CAAC,CAAM,EAAE,OAAyB,EAAE,QAA6C;IAChG,MAAM,YAAY,GAAG,eAAe,CAAC,UAAU,CAAE,QAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAEpF,MAAM,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC;IACtB,MAAM,QAAQ,GAAG,eAAe,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;IAE3E,OAAO,eAAe,CAAC,aAAa,CAAC,QAAQ,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;AACzE,CAAC;AAED;;GAEG;AAEH,SAAgB,gBAAgB,CAAC,MAAW;IAC1C,MAAM,CAAC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACrC,CAAC;AAFD,4CAEC;AAED,MAAa,eAAe;IAQnB,MAAM,CAAC,UAAU,CAAC,GAAG,OAA2B;QACrD,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,eAAe,CAAC,cAAc,EAAE,GAAG,OAAO,CAAC,CAAC;IACvE,CAAC;IAEM,MAAM,CAAC,cAAc,CAAC,KAAU,EAAE,KAAU,EAAE,OAAyB;QAC5E,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAC5E,IAAI,UAAe,CAAC;QAEpB,IAAI,UAAU,EAAE;YACd,yEAAyE;SAC1E;QAED,IAAI,KAAK,GAAG,CAAC,EAAE;YACb,UAAU,GAAG,KAAK;iBACf,IAAI,CAAC,KAAK,CAAC;iBACX,MAAM,CAAC,MAAM,CAAC;iBACd,IAAI,CAAC,IAAI,CAAC;iBACV,IAAI,CAAC,MAAM,CAAC;iBACZ,KAAK,CAAC,KAAK,CAAC;iBACZ,IAAI,CAAC,IAAI,CAAC,CAAC;YAEd,IAAI,QAAQ,EAAE;gBACZ,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;aAChE;SACF;QAED,OAAO,CAAC,UAAU,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACjH,CAAC;IAEM,MAAM,CAAC,aAAa,CACzB,QAAe,EACf,OAAyB,EACzB,QAA6C;QAE7C,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QACpD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CACxB,IAAI,CAAC,EAAE;gBACL,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAU,CAAC;gBAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAW,CAAC;gBAChC,MAAM,MAAM,GAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,CAAC;gBAErE,IAAI,IAAI,IAAI,UAAU,EAAE;oBACtB,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,GAAQ,EAAE,EAAE;wBACpC,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;wBACzB,OAAO,GAAG,CAAC,GAAG,CAAC;wBACf,OAAO,GAAG,CAAC,GAAG,CAAC;wBACf,OAAO,GAAG,CAAC;oBACb,CAAC,CAAC,CAAC;iBACJ;qBAAM;oBACL,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;iBACtB;gBAED,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;oBAClC,OAAO,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;iBAC/B;gBAED,OAAO,CAAC,MAAM,CAAC,CAAC;YAClB,CAAC,EACD,KAAK,CAAC,EAAE;gBACN,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;oBAClC,OAAO,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;iBAC9B;gBACD,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;;AA3EH,0CA4EC;AA3EyB,8BAAc,GAAG,MAAM,CAAC,MAAM,CAAC;IACrD,IAAI,EAAE,KAAK;IACX,UAAU,EAAE,IAAI;IAChB,KAAK,EAAE,EAAE;IACT,MAAM,EAAE,CAAC;CACV,CAAC,CAAC"}

package/dist/src/plugins/pagination/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/plugins/pagination/index.test.js

@@ -0,0 +1,129 @@
+"use strict";
+// Some way of using chai requires disabling this rule:
+// tslint:disable:no-unused-expression
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai = require("chai");
+const mongoose = require("mongoose");
+const constants_1 = require("../../config/constants");
+const mongoUtils_1 = require("../../mongoUtils");
+const index_1 = require("./index");
+const expect = chai.expect;
+const authorSchema = new mongoose.Schema({ name: String });
+const authorModel = mongoose.model('Author', authorSchema);
+const bookSchema = new mongoose.Schema({
+    title: String,
+    date: Date,
+    author: {
+        type: String,
+        ref: 'Author'
+    }
+});
+bookSchema.plugin(index_1.mongoosePaginate);
+const bookModel = mongoose.model('Book', bookSchema);
+describe('plugin pagination', () => {
+    before(async function () {
+        this.timeout(120000);
+        // Makes sure Mongoose is mocked, but not in Jenkins as we will start a dedicated mongodb container.
+        const mockedDb = await mongoUtils_1.mongoUtils.mockMongoose(this, constants_1.constants.testsConfig.mockServer.serverVersion);
+        const connString = mockedDb.getUri();
+        await mongoose.connect(connString, { useNewUrlParser: true });
+    });
+    before(async function () {
+        this.timeout(10000);
+        let book;
+        const books = [];
+        const date = new Date();
+        return authorModel.create({ name: 'Arthur Conan Doyle' }).then(author => {
+            for (let i = 1; i <= 100; i++) {
+                book = new bookModel({
+                    title: 'Book #' + i,
+                    date: new Date(date.getTime() + i),
+                    author: author._id
+                });
+                books.push(book);
+            }
+            return bookModel.create(books);
+        });
+    });
+    it('returns promise', () => {
+        const promise = bookModel.paginate();
+        expect(promise.then).to.be.an.instanceof(Function);
+    });
+    it('calls callback', done => {
+        bookModel.paginate({}, {}, (err, result) => {
+            expect(err).to.be.null;
+            expect(result).to.be.an.instanceOf(Object);
+            done();
+        });
+    });
+    describe('paginates', () => {
+        it('with criteria', () => {
+            return bookModel.paginate({ title: 'Book #10' }).then((result) => {
+                expect(result.items).to.have.length(1);
+                expect(result.items[0].title).to.equal('Book #10');
+            });
+        });
+        it('with default options (limit=10, lean=false)', () => {
+            return bookModel.paginate().then((result) => {
+                expect(result.items).to.have.length(10);
+                expect(result.items[0]).to.be.an.instanceof(mongoose.Document);
+                expect(result.paging.totalCount).to.equal(100);
+                expect(result.paging.limit).to.equal(10);
+                expect(result.paging.offset).to.equal(0);
+            });
+        });
+        it('with offset and limit', () => {
+            return bookModel.paginate({}, { offset: 30, limit: 20 }).then((result) => {
+                expect(result.items).to.have.length(20);
+                expect(result.paging.totalCount).to.equal(100);
+                expect(result.paging.limit).to.equal(20);
+                expect(result.paging.offset).to.equal(30);
+            });
+        });
+        it('with zero limit', () => {
+            return bookModel.paginate({}, { page: 1, limit: 0 }).then((result) => {
+                expect(result.items).to.have.length(0);
+                expect(result.paging.totalCount).to.equal(100);
+                expect(result.paging.limit).to.equal(0);
+            });
+        });
+        it('with select', () => {
+            return bookModel.paginate({}, { select: 'title' }).then((result) => {
+                expect(result.items[0].title).to.exist;
+                expect(result.items[0].date).to.not.exist;
+            });
+        });
+        it('with sort', () => {
+            return bookModel.paginate({}, { sort: { date: -1 } }).then((result) => {
+                expect(result.items[0].title).to.equal('Book #100');
+            });
+        });
+        it('with populate', () => {
+            return bookModel.paginate({}, { populate: 'author' }).then((result) => {
+                expect(result.items[0].author.name).to.equal('Arthur Conan Doyle');
+            });
+        });
+        describe('with lean', () => {
+            it('with default leanWithId=true', () => {
+                return bookModel.paginate({}, { lean: true }).then((result) => {
+                    expect(result.items[0]).to.not.be.an.instanceof(mongoose.Document);
+                    expect(result.items[0].id).to.exist;
+                    expect(result.items[0]).to.not.have.property('_id');
+                });
+            });
+            it('with leanWithId=false', () => {
+                return bookModel.paginate({}, { lean: true, leanWithId: false }).then((result) => {
+                    expect(result.items[0]).to.not.be.an.instanceof(mongoose.Document);
+                    expect(result.items[0]).to.not.have.property('id');
+                });
+            });
+        });
+    });
+    after(done => {
+        mongoose.connection.db.dropDatabase(done);
+    });
+    after(done => {
+        mongoose.disconnect(done);
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/src/plugins/pagination/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../../../src/plugins/pagination/index.test.ts"],"names":[],"mappings":";AAAA,uDAAuD;AACvD,sCAAsC;;AAGtC,6BAA6B;AAC7B,qCAAqC;AACrC,sDAAmD;AACnD,iDAA8C;AAC9C,mCAA2C;AAE3C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;AAE3B,MAAM,YAAY,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AAC3D,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;AAE3D,MAAM,UAAU,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC;IACrC,KAAK,EAAE,MAAM;IACb,IAAI,EAAE,IAAI;IACV,MAAM,EAAE;QACN,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,QAAQ;KACd;CACF,CAAC,CAAC;AAEH,UAAU,CAAC,MAAM,CAAC,wBAAgB,CAAC,CAAC;AACpC,MAAM,SAAS,GAAQ,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAE1D,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,MAAM,CAAC,KAAK;QACV,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAErB,oGAAoG;QACpG,MAAM,QAAQ,GAAG,MAAM,uBAAU,CAAC,YAAY,CAAC,IAAI,EAAE,qBAAS,CAAC,WAAW,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QACrG,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;QACrC,MAAM,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,KAAK;QACV,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACpB,IAAI,IAAI,CAAC;QACT,MAAM,KAAK,GAAQ,EAAE,CAAC;QACtB,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,OAAO,WAAW,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YACtE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,EAAE,EAAE;gBAC7B,IAAI,GAAG,IAAI,SAAS,CAAC;oBACnB,KAAK,EAAE,QAAQ,GAAG,CAAC;oBACnB,IAAI,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;oBAClC,MAAM,EAAE,MAAM,CAAC,GAAG;iBACnB,CAAC,CAAC;gBACH,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAClB;YACD,OAAO,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;QACzB,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gBAAgB,EAAE,IAAI,CAAC,EAAE;QAC1B,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,GAAU,EAAE,MAA6B,EAAE,EAAE;YACvE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACvB,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC3C,IAAI,EAAE,CAAC;QACT,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACzB,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;YACvB,OAAO,SAAS,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAA6B,EAAE,EAAE;gBACtF,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACvC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACrD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC,MAA6B,EAAE,EAAE;gBACjE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBACxC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAE,QAAgB,CAAC,QAAQ,CAAC,CAAC;gBACxE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC/C,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACzC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;YAC/B,OAAO,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAA6B,EAAE,EAAE;gBAC9F,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBACxC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC/C,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACzC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;YACzB,OAAO,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAA6B,EAAE,EAAE;gBAC1F,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACvC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC/C,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;YACrB,OAAO,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAA6B,EAAE,EAAE;gBACxF,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC;gBACvC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC;YAC5C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;YACnB,OAAO,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAA6B,EAAE,EAAE;gBAC3F,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACtD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;YACvB,OAAO,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAA6B,EAAE,EAAE;gBAC3F,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;YACrE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;YACzB,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;gBACtC,OAAO,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAA6B,EAAE,EAAE;oBACnF,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAE,QAAgB,CAAC,QAAQ,CAAC,CAAC;oBAC5E,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC;oBACpC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACtD,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;gBAC/B,OAAO,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAA6B,EAAE,EAAE;oBACtG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAE,QAAgB,CAAC,QAAQ,CAAC,CAAC;oBAC5E,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACrD,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,IAAI,CAAC,EAAE;QACX,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,IAAI,CAAC,EAAE;QACX,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/plugins/pagination/specs/IPaginateOptions.d.ts

@@ -0,0 +1,51 @@
+export interface IPaginateOptions {
+    /**
+     * Fields to return (by default returns all fields)
+     * http://mongoosejs.com/docs/api.html#query_Query-select
+     * @type {string}
+     * @memberof IPaginateOptions
+     */
+    select?: string;
+    /**
+     * Sort order
+     * http://mongoosejs.com/docs/api.html#query_Query-sort
+     * @type {*}
+     * @memberof IPaginateOptions
+     */
+    sort?: any;
+    /**
+     * Paths which should be populated with other documents.
+     * http://mongoosejs.com/docs/api.html#query_Query-populate
+     * @type {string}
+     * @memberof IPaginateOptions
+     */
+    populate?: string;
+    /**
+     * Should return plain javascript objects instead of Mongoose documents?
+     * default false
+     * @type {boolean}
+     * @memberof IPaginateOptions
+     */
+    lean?: boolean;
+    /**
+     * If lean and leanWithId are true, adds id field with string representation of _id to every document
+     * default true
+     * @type {boolean}
+     * @memberof IPaginateOptions
+     */
+    leanWithId?: boolean;
+    /**
+     * Use offset to set skip position
+     * default 0
+     * @type {number}
+     * @memberof IPaginateOptions
+     */
+    offset?: number;
+    /**
+     * limit the items returned
+     * default 10
+     * @type {number}
+     * @memberof IPaginateOptions
+     */
+    limit?: number;
+}

package/dist/src/plugins/pagination/specs/IPaginateOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IPaginateOptions.js.map

package/dist/src/plugins/pagination/specs/IPaginateOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPaginateOptions.js","sourceRoot":"","sources":["../../../../../src/plugins/pagination/specs/IPaginateOptions.ts"],"names":[],"mappings":""}

package/dist/src/utils/logger.d.ts

@@ -0,0 +1,11 @@
+import { ILogger } from '@villedemontreal/logger';
+/**
+ * Creates a Logger.
+ */
+export declare function createLogger(name: string): ILogger;
+/**
+ * A Logger that uses a dummy cid provider.
+ *
+ * Only use this when running the tests!
+ */
+export declare function getTestingLoggerCreator(): (name: string) => ILogger;