@villedemontreal/mongo 6.7.0

package/dist/src/config/mongooseConfigs.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MongooseConfigs = void 0;
+const general_utils_1 = require("@villedemontreal/general-utils");
+const _ = require("lodash");
+const logger_1 = require("../utils/logger");
+const constants_1 = require("./constants");
+const logger = logger_1.createLogger('mongooseConfigs');
+/**
+ * Mongoose configs with default values.
+ */
+class MongooseConfigs {
+    /**
+     * Overrides default configurations using the ones passed
+     * as parameters.
+     */
+    // tslint:disable-next-line:cyclomatic-complexity
+    constructor(overridingConfigs) {
+        // ==========================================
+        // Required configs
+        // ==========================================
+        /**
+         * @param applyUpdates Should the database be checked for missing
+         * updates and have them applied if required?
+         */
+        this.applyUpdates = true;
+        /**
+         * If no connectionString is provided, "mock" will be
+         * used by default and a temporary Mongo server will
+         * be used.
+         */
+        this.connectionString = 'mock';
+        this.connectionOptions = {
+            w: 1,
+            wtimeout: 5000,
+            auto_reconnect: true,
+            reconnectTries: 604800,
+            reconnectInterval: 1000,
+            useNewUrlParser: true
+        };
+        this.updater = {
+            appSchemaCollectionName: constants_1.constants.mongo.collectionNames.APP_SCHEMA,
+            lockMaxAgeSeconds: 60,
+            /**
+             * The path *relative* to the app root, of the directory
+             * where the update files are.
+             * Required!
+             */
+            mongoSchemaUpdatesDirPath: null
+        };
+        this.mockServer = {
+            serverVersion: '3.2.1'
+        };
+        if (_.isNil(overridingConfigs) ||
+            _.isNil(overridingConfigs.updater) ||
+            general_utils_1.utils.isBlank(overridingConfigs.updater.mongoSchemaUpdatesDirPath)) {
+            throw new Error(`The updater.mongoSchemaUpdatesDirPath config is required!`);
+        }
+        this.updater.mongoSchemaUpdatesDirPath = overridingConfigs.updater.mongoSchemaUpdatesDirPath;
+        // ==========================================
+        // Not required...
+        // ==========================================
+        if (!_.isNil(overridingConfigs.updater.lockMaxAgeSeconds)) {
+            if (!general_utils_1.utils.isIntegerValue(overridingConfigs.updater.lockMaxAgeSeconds, true, false)) {
+                throw new Error(`The updater.lockMaxAgeSeconds config is not valid : ${overridingConfigs.updater.lockMaxAgeSeconds}`);
+            }
+            this.updater.lockMaxAgeSeconds = Number(overridingConfigs.updater.lockMaxAgeSeconds);
+        }
+        if (!_.isNil(overridingConfigs.updater.appSchemaCollectionName)) {
+            if (!_.isString(overridingConfigs.updater.appSchemaCollectionName) ||
+                general_utils_1.utils.isBlank(overridingConfigs.updater.appSchemaCollectionName)) {
+                throw new Error(`The appSchemaCollectionName config is not valid : ${overridingConfigs.updater.appSchemaCollectionName}`);
+            }
+            this.updater.appSchemaCollectionName = overridingConfigs.updater.appSchemaCollectionName;
+        }
+        if (!_.isNil(overridingConfigs.applyUpdates)) {
+            if (!_.isBoolean(overridingConfigs.applyUpdates)) {
+                throw new Error(`The applyUpdates config must be a boolean: ${overridingConfigs.applyUpdates}`);
+            }
+            this.applyUpdates = overridingConfigs.applyUpdates;
+        }
+        if (!_.isNil(overridingConfigs.connectionString)) {
+            if (!_.isString(overridingConfigs.connectionString) || general_utils_1.utils.isBlank(overridingConfigs.connectionString)) {
+                throw new Error(`The connectionString config is not valid : ${overridingConfigs.connectionString}`);
+            }
+            this.connectionString = overridingConfigs.connectionString;
+        }
+        else {
+            logger.warning(`No "connectionString" config was provided: a *mocked* Mongo server will be used!`);
+        }
+        if (!_.isNil(overridingConfigs.connectionOptions)) {
+            if (!_.isObject(overridingConfigs.connectionOptions)) {
+                throw new Error(`The connectionOptions config is not valid : ${overridingConfigs.connectionString}`);
+            }
+            this.connectionOptions = overridingConfigs.connectionOptions;
+        }
+        if (!_.isNil(overridingConfigs.mockServer) && !_.isNil(overridingConfigs.mockServer.serverVersion)) {
+            if (!_.isString(overridingConfigs.mockServer.serverVersion) ||
+                general_utils_1.utils.isBlank(overridingConfigs.mockServer.serverVersion)) {
+                throw new Error(`The mockServer.serverVersion config is not valid : ${overridingConfigs.mockServer.serverVersion}`);
+            }
+            this.mockServer.serverVersion = overridingConfigs.mockServer.serverVersion;
+        }
+    }
+}
+exports.MongooseConfigs = MongooseConfigs;
+//# sourceMappingURL=mongooseConfigs.js.map

package/dist/src/config/mongooseConfigs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongooseConfigs.js","sourceRoot":"","sources":["../../../src/config/mongooseConfigs.ts"],"names":[],"mappings":";;;AAAA,kEAAuD;AACvD,4BAA4B;AAC5B,4CAA+C;AAC/C,2CAAwC;AAExC,MAAM,MAAM,GAAG,qBAAY,CAAC,iBAAiB,CAAC,CAAC;AAmD/C;;GAEG;AACH,MAAa,eAAe;IAuC1B;;;OAGG;IACH,iDAAiD;IACjD,YAAY,iBAAmC;QAC7C,6CAA6C;QAC7C,mBAAmB;QACnB,6CAA6C;QA9C/C;;;WAGG;QACI,iBAAY,GAAY,IAAI,CAAC;QAEpC;;;;WAIG;QACI,qBAAgB,GAAW,MAAM,CAAC;QAElC,sBAAiB,GAAQ;YAC9B,CAAC,EAAE,CAAC;YACJ,QAAQ,EAAE,IAAI;YACd,cAAc,EAAE,IAAI;YACpB,cAAc,EAAE,MAAM;YACtB,iBAAiB,EAAE,IAAI;YACvB,eAAe,EAAE,IAAI;SACtB,CAAC;QAEK,YAAO,GAAsG;YAClH,uBAAuB,EAAE,qBAAS,CAAC,KAAK,CAAC,eAAe,CAAC,UAAU;YACnE,iBAAiB,EAAE,EAAE;YAErB;;;;eAIG;YACH,yBAAyB,EAAE,IAAI;SAChC,CAAC;QAEK,eAAU,GAA8B;YAC7C,aAAa,EAAE,OAAO;SACvB,CAAC;QAYA,IACE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC;YAC1B,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC;YAClC,qBAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,yBAAyB,CAAC,EAClE;YACA,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;SAC9E;QACD,IAAI,CAAC,OAAO,CAAC,yBAAyB,GAAG,iBAAiB,CAAC,OAAO,CAAC,yBAAyB,CAAC;QAE7F,6CAA6C;QAC7C,kBAAkB;QAClB,6CAA6C;QAE7C,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE;YACzD,IAAI,CAAC,qBAAK,CAAC,cAAc,CAAC,iBAAiB,CAAC,OAAO,CAAC,iBAAiB,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE;gBACnF,MAAM,IAAI,KAAK,CACb,uDAAuD,iBAAiB,CAAC,OAAO,CAAC,iBAAiB,EAAE,CACrG,CAAC;aACH;YACD,IAAI,CAAC,OAAO,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;SACtF;QAED,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,uBAAuB,CAAC,EAAE;YAC/D,IACE,CAAC,CAAC,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,uBAAuB,CAAC;gBAC9D,qBAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,uBAAuB,CAAC,EAChE;gBACA,MAAM,IAAI,KAAK,CACb,qDAAqD,iBAAiB,CAAC,OAAO,CAAC,uBAAuB,EAAE,CACzG,CAAC;aACH;YACD,IAAI,CAAC,OAAO,CAAC,uBAAuB,GAAG,iBAAiB,CAAC,OAAO,CAAC,uBAAuB,CAAC;SAC1F;QAED,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE;YAC5C,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE;gBAChD,MAAM,IAAI,KAAK,CAAC,8CAA8C,iBAAiB,CAAC,YAAY,EAAE,CAAC,CAAC;aACjG;YACD,IAAI,CAAC,YAAY,GAAG,iBAAiB,CAAC,YAAY,CAAC;SACpD;QAED,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,EAAE;YAChD,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,qBAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,EAAE;gBACxG,MAAM,IAAI,KAAK,CAAC,8CAA8C,iBAAiB,CAAC,gBAAgB,EAAE,CAAC,CAAC;aACrG;YACD,IAAI,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,gBAAgB,CAAC;SAC5D;aAAM;YACL,MAAM,CAAC,OAAO,CAAC,kFAAkF,CAAC,CAAC;SACpG;QAED,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,EAAE;YACjD,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,EAAE;gBACpD,MAAM,IAAI,KAAK,CAAC,+CAA+C,iBAAiB,CAAC,gBAAgB,EAAE,CAAC,CAAC;aACtG;YACD,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC,iBAAiB,CAAC;SAC9D;QAED,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;YAClG,IACE,CAAC,CAAC,CAAC,QAAQ,CAAC,iBAAiB,CAAC,UAAU,CAAC,aAAa,CAAC;gBACvD,qBAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,aAAa,CAAC,EACzD;gBACA,MAAM,IAAI,KAAK,CACb,sDAAsD,iBAAiB,CAAC,UAAU,CAAC,aAAa,EAAE,CACnG,CAAC;aACH;YACD,IAAI,CAAC,UAAU,CAAC,aAAa,GAAG,iBAAiB,CAAC,UAAU,CAAC,aAAa,CAAC;SAC5E;IACH,CAAC;CACF;AAtHD,0CAsHC"}

package/dist/src/index.d.ts

@@ -0,0 +1,6 @@
+export * from './mongoUtils';
+export * from './config/constants';
+export { IMongooseConfigs } from './config/mongooseConfigs';
+export * from './mongoClient';
+export * from './config/init';
+export * from './plugins/pagination';

package/dist/src/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./mongoUtils"), exports);
+__exportStar(require("./config/constants"), exports);
+__exportStar(require("./mongoClient"), exports);
+// ==========================================
+// We do not export the configs instance itself,
+// only the "init()" method, so we can define
+// which are the required parameters.
+// ==========================================
+__exportStar(require("./config/init"), exports);
+__exportStar(require("./plugins/pagination"), exports);
+// import { IPaginateOptions } from './plugins/pagination/specs/IPaginateOptions';
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+CAA6B;AAC7B,qDAAmC;AAEnC,gDAA8B;AAE9B,6CAA6C;AAC7C,gDAAgD;AAChD,6CAA6C;AAC7C,qCAAqC;AACrC,6CAA6C;AAC7C,gDAA8B;AAC9B,uDAAqC;AACrC,kFAAkF"}

package/dist/src/mongoClient.d.ts

@@ -0,0 +1,19 @@
+import * as mongoose from 'mongoose';
+import { IMongooseConfigs } from './config/mongooseConfigs';
+/**
+ * This is the entry point to use this library to manage your
+ * Mongoose connections.
+ *
+ * It *must* be called when the application starts, before any
+ * connection is made to Mongo.
+ *
+ * @returns the Mongoose connection to Mongo.
+ */
+export declare function initMongoose(mongooseConfig: IMongooseConfigs): Promise<mongoose.Connection>;
+/**
+ * Returns the Mongoose connection.
+ *
+ * Will throw an error if Mongo haass not been initialized
+ * using the "initMongo()" function.
+ */
+export declare function getMongooseConnection(): mongoose.Connection;

package/dist/src/mongoClient.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMongooseConnection = exports.initMongoose = void 0;
+const lodash_1 = require("lodash");
+const mongoose = require("mongoose");
+const constants_1 = require("./config/constants");
+const mongooseConfigs_1 = require("./config/mongooseConfigs");
+const mongoUpdater_1 = require("./mongoUpdater");
+const mongoUtils_1 = require("./mongoUtils");
+const logger_1 = require("./utils/logger");
+const logger = logger_1.createLogger('mongoClient');
+let mongooseConnection;
+/**
+ * This is the entry point to use this library to manage your
+ * Mongoose connections.
+ *
+ * It *must* be called when the application starts, before any
+ * connection is made to Mongo.
+ *
+ * @returns the Mongoose connection to Mongo.
+ */
+async function initMongoose(mongooseConfig) {
+    // ==========================================
+    // Uses the MongooseConfigs to make sure unspecified
+    // configs have a default value.
+    // ==========================================
+    const mongooseConfigClean = new mongooseConfigs_1.MongooseConfigs(mongooseConfig);
+    return new Promise(async (resolve, reject) => {
+        let connectionString = mongooseConfigClean.connectionString;
+        // ==========================================
+        // Mocked Mongo server?
+        // ==========================================
+        if (connectionString === constants_1.constants.mongo.testing.MOCK_CONNECTION_STRING) {
+            // ==========================================
+            // Mock!
+            // ==========================================
+            const mongoServer = await mongoUtils_1.mongoUtils.mockMongoose(null, mongooseConfigClean.mockServer.serverVersion);
+            connectionString = mongoServer.getUri();
+        }
+        try {
+            if (mongooseConnection) {
+                await mongooseConnection.close();
+                mongooseConnection = undefined;
+            }
+            // Updates Promise for mongoose, avoid warning log emit by mongoose
+            mongoose.Promise = global.Promise;
+            const mongoOptions = lodash_1.defaultsDeep(mongooseConfigClean.connectionOptions, {
+                promiseLibrary: global.Promise
+            });
+            // Creates the connection
+            mongooseConnection = mongoose.createConnection(connectionString, mongoOptions);
+            // Triggered if an error occured
+            mongooseConnection.on('error', (err) => {
+                mongooseConnection = null;
+                reject('Mongo Database: Error connecting to Mongo: ' + err);
+            });
+            // Triggered when the connection is made.
+            mongooseConnection.on('connected', async () => {
+                // Check for schema updates once the connexion is made
+                if (mongooseConfigClean.applyUpdates) {
+                    try {
+                        await checkForUpdates(mongooseConfigClean);
+                    }
+                    catch (err) {
+                        try {
+                            await mongooseConnection.close();
+                            mongooseConnection = undefined;
+                        }
+                        catch (err) {
+                            logger.warning(`Error closing connection to Mongo : ${err}`);
+                        }
+                        return reject('Error updating Mongo: ' + err);
+                    }
+                }
+                else {
+                    logger.info(`Mongo updates skipped`);
+                }
+                // All good!
+                resolve(mongooseConnection);
+            });
+        }
+        catch (err) {
+            return reject('Error initializing Mongo: ' + err);
+        }
+    });
+}
+exports.initMongoose = initMongoose;
+/**
+ * Uses the MongoUpdater to validate if updates are required
+ * to run the application on the target Mongo database.
+ */
+async function checkForUpdates(mongooseConfig) {
+    const connection = await getMongooseConnection();
+    const updater = new mongoUpdater_1.MongoUpdater(connection.db, mongooseConfig.updater.mongoSchemaUpdatesDirPath, mongooseConfig.updater.lockMaxAgeSeconds, mongooseConfig.updater.appSchemaCollectionName);
+    await updater.checkInstallation();
+    await updater.checkUpdates();
+}
+/**
+ * Returns the Mongoose connection.
+ *
+ * Will throw an error if Mongo haass not been initialized
+ * using the "initMongo()" function.
+ */
+function getMongooseConnection() {
+    if (!mongooseConnection) {
+        throw new Error("Mongo is not initialized! Please call the 'initMongo()' method first...");
+    }
+    return mongooseConnection;
+}
+exports.getMongooseConnection = getMongooseConnection;
+//# sourceMappingURL=mongoClient.js.map

package/dist/src/mongoClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongoClient.js","sourceRoot":"","sources":["../../src/mongoClient.ts"],"names":[],"mappings":";;;AAAA,mCAAsC;AACtC,qCAAqC;AACrC,kDAA+C;AAC/C,8DAA6E;AAC7E,iDAA6D;AAC7D,6CAA0C;AAC1C,2CAA8C;AAE9C,MAAM,MAAM,GAAG,qBAAY,CAAC,aAAa,CAAC,CAAC;AAE3C,IAAI,kBAAuC,CAAC;AAE5C;;;;;;;;GAQG;AACI,KAAK,UAAU,YAAY,CAAC,cAAgC;IACjE,6CAA6C;IAC7C,oDAAoD;IACpD,gCAAgC;IAChC,6CAA6C;IAC7C,MAAM,mBAAmB,GAAG,IAAI,iCAAe,CAAC,cAAc,CAAC,CAAC;IAEhE,OAAO,IAAI,OAAO,CAAsB,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;QAChE,IAAI,gBAAgB,GAAG,mBAAmB,CAAC,gBAAgB,CAAC;QAE5D,6CAA6C;QAC7C,uBAAuB;QACvB,6CAA6C;QAC7C,IAAI,gBAAgB,KAAK,qBAAS,CAAC,KAAK,CAAC,OAAO,CAAC,sBAAsB,EAAE;YACvE,6CAA6C;YAC7C,QAAQ;YACR,6CAA6C;YAC7C,MAAM,WAAW,GAAG,MAAM,uBAAU,CAAC,YAAY,CAAC,IAAI,EAAE,mBAAmB,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YAEtG,gBAAgB,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC;SACzC;QAED,IAAI;YACF,IAAI,kBAAkB,EAAE;gBACtB,MAAM,kBAAkB,CAAC,KAAK,EAAE,CAAC;gBACjC,kBAAkB,GAAG,SAAS,CAAC;aAChC;YAED,mEAAmE;YAClE,QAAgB,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;YAC3C,MAAM,YAAY,GAA+B,qBAAY,CAAC,mBAAmB,CAAC,iBAAiB,EAAE;gBACnG,cAAc,EAAE,MAAM,CAAC,OAAO;aAC/B,CAAC,CAAC;YAEH,yBAAyB;YACzB,kBAAkB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;YAE/E,gCAAgC;YAChC,kBAAkB,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAQ,EAAE,EAAE;gBAC1C,kBAAkB,GAAG,IAAI,CAAC;gBAC1B,MAAM,CAAC,6CAA6C,GAAG,GAAG,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YAEH,yCAAyC;YACzC,kBAAkB,CAAC,EAAE,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;gBAC5C,sDAAsD;gBACtD,IAAI,mBAAmB,CAAC,YAAY,EAAE;oBACpC,IAAI;wBACF,MAAM,eAAe,CAAC,mBAAmB,CAAC,CAAC;qBAC5C;oBAAC,OAAO,GAAG,EAAE;wBACZ,IAAI;4BACF,MAAM,kBAAkB,CAAC,KAAK,EAAE,CAAC;4BACjC,kBAAkB,GAAG,SAAS,CAAC;yBAChC;wBAAC,OAAO,GAAG,EAAE;4BACZ,MAAM,CAAC,OAAO,CAAC,uCAAuC,GAAG,EAAE,CAAC,CAAC;yBAC9D;wBAED,OAAO,MAAM,CAAC,wBAAwB,GAAG,GAAG,CAAC,CAAC;qBAC/C;iBACF;qBAAM;oBACL,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;iBACtC;gBAED,YAAY;gBACZ,OAAO,CAAC,kBAAkB,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;SACJ;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,MAAM,CAAC,4BAA4B,GAAG,GAAG,CAAC,CAAC;SACnD;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAtED,oCAsEC;AAED;;;GAGG;AACH,KAAK,UAAU,eAAe,CAAC,cAAgC;IAC7D,MAAM,UAAU,GAAG,MAAM,qBAAqB,EAAE,CAAC;IACjD,MAAM,OAAO,GAAkB,IAAI,2BAAY,CAC7C,UAAU,CAAC,EAAE,EACb,cAAc,CAAC,OAAO,CAAC,yBAAyB,EAChD,cAAc,CAAC,OAAO,CAAC,iBAAiB,EACxC,cAAc,CAAC,OAAO,CAAC,uBAAuB,CAC/C,CAAC;IACF,MAAM,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAClC,MAAM,OAAO,CAAC,YAAY,EAAE,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB;IACnC,IAAI,CAAC,kBAAkB,EAAE;QACvB,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;KAC5F;IAED,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAND,sDAMC"}

package/dist/src/mongoUpdater.d.ts

@@ -0,0 +1,103 @@
+import * as MongoDb from 'mongodb';
+/**
+ * Mongo updater
+ * Manages the updates of the mongo schemas
+ */
+export interface IMongoUpdater {
+    /**
+     * Validates that the application has been installed.
+     * This involves creating a special "appSchema" collection
+     * and document to track the application version and being able
+     * to update its schemas and documents...
+     */
+    checkInstallation(): Promise<void>;
+    /**
+     * Checks if the application needs update or not. Installs the updates
+     * if so.
+     */
+    checkUpdates(): Promise<void>;
+    /**
+     * Locks the appSchema document.
+     *
+     * @returns true if the lock has been acquired succesfully
+     * or false if the document was already locked.
+     */
+    lockAppSchemaDocument(): Promise<boolean>;
+    /**
+     * Unlocks the appSchema document.
+     *
+     * @returns true if the lock has been removed succesfully
+     * or false if the document was not locked.
+     */
+    unlockAppSchemaDocument(): Promise<boolean>;
+    /**
+     * Updates the app schema version stored in mongo database
+     */
+    updateAppSchemaVersion(currentVersion: string, newVersion: string): Promise<void>;
+    /**
+     * Installs the appSchema collection.
+     */
+    installAppSchemaCollection(): Promise<any>;
+    /**
+     * Gets a list of available app schema update files.
+     */
+    getAppSchemaUpdateFiles(currentVersion: string, newVersion: string): Promise<string[]>;
+    /**
+     * Updates the app schema
+     */
+    applyAppSchemaUpdates(currentVersion: string, newVersion: string): Promise<any>;
+    /**
+     * Gets the appSchema collection
+     */
+    getAppSchemaCollection(): Promise<MongoDb.Collection>;
+    /**
+     * Gets the current version from the appSchema document.
+     */
+    getAppSchemaVersion(): Promise<string>;
+}
+export interface ISchemeInfo {
+    version: string;
+    lock: boolean;
+    lockTimestamp: number;
+}
+export declare class MongoUpdater implements IMongoUpdater {
+    private mongoDb;
+    /**
+     * The *relative* path to the directory where the
+     * update files are.
+     */
+    private mongoSchemaUpdatesDirPath;
+    private lockMaxAgeSeconds;
+    private appSchemaCollectionName;
+    constructor(mongoDb: MongoDb.Db, 
+    /**
+     * The *relative* path to the directory where the
+     * update files are.
+     */
+    mongoSchemaUpdatesDirPath: string, lockMaxAgeSeconds: number, appSchemaCollectionName: string);
+    installAppSchemaCollection(): Promise<any>;
+    updateAppSchemaVersion(currentVersion: string, newVersion: string): Promise<void>;
+    getAppSchemaUpdateFiles(currentAppSchemaVersion: string, targetAppSchemaVersion: string): Promise<string[]>;
+    applyAppSchemaUpdates(currentVersion: string, newVersion: string): Promise<void>;
+    getAppSchemaCollection(): Promise<MongoDb.Collection>;
+    getAppSchemaVersion(): Promise<string>;
+    /**
+     * Tries to get the lock to modify Mongo's schemas.
+     *
+     * If a lock already exists, checks if it is too old.
+     * If too old, will create a new one... This is to prevents
+     * situations where a lock would have been taken by an app
+     * but that app *crashed* while the lock was on. We don't want
+     * suck lock to be active forever...
+     *
+     */
+    lockAppSchemaDocument(): Promise<boolean>;
+    unlockAppSchemaDocument(): Promise<boolean>;
+    checkInstallation(): Promise<void>;
+    checkUpdates: () => Promise<void>;
+    protected getAppSchemaFilesDirPath(): string;
+    /**
+     * Finds the latest Mongo update file version.
+     */
+    protected findMongoAppSchemaTargetVersion(): string;
+}