@villedemontreal/mongo 6.7.0

package/dist/src/utils/logger.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTestingLoggerCreator = exports.createLogger = void 0;
+const logger_1 = require("@villedemontreal/logger");
+const configs_1 = require("../config/configs");
+let testingLoggerLibInitialised = false;
+/**
+ * Creates a Logger.
+ */
+function createLogger(name) {
+    // ==========================================
+    // We use a LazyLogger so the real Logger
+    // is only created when the first
+    // log is actually performed... At that point,
+    // our "configs.loggerCreator" configuration
+    // must have been set by the code using our library!
+    //
+    // This pattern allows calling code to import
+    // modules from us in which a logger is
+    // created in the global scope :
+    //
+    // let logger = createLogger('someName');
+    //
+    // Without a Lazy Logger, the library configurations
+    // would at that moment *not* have been set yet
+    // (by the calling code) and an Error would be thrown
+    // because the "configs.loggerCreator" is required.
+    // ==========================================
+    return new logger_1.LazyLogger(name, (nameArg) => {
+        return configs_1.configs.loggerCreator(nameArg);
+    });
+}
+exports.createLogger = createLogger;
+function initTestingLoggerConfigs() {
+    const loggerConfig = new logger_1.LoggerConfigs(() => 'test-cid');
+    loggerConfig.setLogLevel(logger_1.LogLevel.DEBUG);
+    logger_1.initLogger(loggerConfig);
+}
+/**
+ * A Logger that uses a dummy cid provider.
+ *
+ * Only use this when running the tests!
+ */
+function getTestingLoggerCreator() {
+    return (name) => {
+        if (!testingLoggerLibInitialised) {
+            initTestingLoggerConfigs();
+            testingLoggerLibInitialised = true;
+        }
+        return new logger_1.Logger(name);
+    };
+}
+exports.getTestingLoggerCreator = getTestingLoggerCreator;
+//# sourceMappingURL=logger.js.map

package/dist/src/utils/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../src/utils/logger.ts"],"names":[],"mappings":";;;AAAA,oDAA2G;AAC3G,+CAA4C;AAE5C,IAAI,2BAA2B,GAAG,KAAK,CAAC;AAExC;;GAEG;AACH,SAAgB,YAAY,CAAC,IAAY;IACvC,6CAA6C;IAC7C,yCAAyC;IACzC,iCAAiC;IACjC,8CAA8C;IAC9C,4CAA4C;IAC5C,oDAAoD;IACpD,EAAE;IACF,6CAA6C;IAC7C,uCAAuC;IACvC,gCAAgC;IAChC,EAAE;IACF,yCAAyC;IACzC,EAAE;IACF,oDAAoD;IACpD,+CAA+C;IAC/C,qDAAqD;IACrD,mDAAmD;IACnD,6CAA6C;IAC7C,OAAO,IAAI,mBAAU,CAAC,IAAI,EAAE,CAAC,OAAe,EAAE,EAAE;QAC9C,OAAO,iBAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAtBD,oCAsBC;AAED,SAAS,wBAAwB;IAC/B,MAAM,YAAY,GAAkB,IAAI,sBAAa,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC;IACxE,YAAY,CAAC,WAAW,CAAC,iBAAQ,CAAC,KAAK,CAAC,CAAC;IACzC,mBAAU,CAAC,YAAY,CAAC,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,SAAgB,uBAAuB;IACrC,OAAO,CAAC,IAAY,EAAW,EAAE;QAC/B,IAAI,CAAC,2BAA2B,EAAE;YAChC,wBAAwB,EAAE,CAAC;YAC3B,2BAA2B,GAAG,IAAI,CAAC;SACpC;QAED,OAAO,IAAI,eAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC,CAAC;AACJ,CAAC;AATD,0DASC"}

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

@@ -0,0 +1,8 @@
+/**
+ * Call this when your need to set
+ * *Testing* configurations to the current
+ * library, without the need for a calling code
+ * to do so.
+ *
+ */
+export declare function setTestingConfigurations(): void;

package/dist/src/utils/testingConfigurations.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setTestingConfigurations = void 0;
+const configs_1 = require("../config/configs");
+const logger_1 = require("../utils/logger");
+/**
+ * Call this when your need to set
+ * *Testing* configurations to the current
+ * library, without the need for a calling code
+ * to do so.
+ *
+ */
+function setTestingConfigurations() {
+    configs_1.configs.setLoggerCreator(logger_1.getTestingLoggerCreator());
+}
+exports.setTestingConfigurations = setTestingConfigurations;
+//# sourceMappingURL=testingConfigurations.js.map

package/dist/src/utils/testingConfigurations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testingConfigurations.js","sourceRoot":"","sources":["../../../src/utils/testingConfigurations.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAC5C,4CAA0D;AAE1D;;;;;;GAMG;AACH,SAAgB,wBAAwB;IACtC,iBAAO,CAAC,gBAAgB,CAAC,gCAAuB,EAAE,CAAC,CAAC;AACtD,CAAC;AAFD,4DAEC"}

package/dist/tests/testingMongoUpdates/1.0.0.d.ts

@@ -0,0 +1,5 @@
+import * as MongoDb from 'mongodb';
+/**
+ * TEST update - version 1.0.0
+ */
+export default function update(db: MongoDb.Db): Promise<void>;

package/dist/tests/testingMongoUpdates/1.0.0.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * TEST update - version 1.0.0
+ */
+async function update(db) {
+    // ==========================================
+    // Creating the "test" collection.
+    // ==========================================
+    const testCollection = await db.createCollection('test');
+    // ==========================================
+    // Creating indexes for the "test" collection.
+    //
+    // @see https://docs.mongodb.com/manual/reference/command/createIndexes/
+    // ==========================================
+    await testCollection.createIndexes([
+        {
+            key: {
+                email: 1
+            },
+            name: 'email_1',
+            unique: true
+        }
+    ]);
+}
+exports.default = update;
+//# sourceMappingURL=1.0.0.js.map

package/dist/tests/testingMongoUpdates/1.0.0.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"1.0.0.js","sourceRoot":"","sources":["../../../tests/testingMongoUpdates/1.0.0.ts"],"names":[],"mappings":";;AAEA;;GAEG;AACY,KAAK,UAAU,MAAM,CAAC,EAAc;IACjD,6CAA6C;IAC7C,kCAAkC;IAClC,6CAA6C;IAC7C,MAAM,cAAc,GAAuB,MAAM,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAE7E,6CAA6C;IAC7C,8CAA8C;IAC9C,EAAE;IACF,wEAAwE;IACxE,6CAA6C;IAC7C,MAAM,cAAc,CAAC,aAAa,CAAC;QACjC;YACE,GAAG,EAAE;gBACH,KAAK,EAAE,CAAC;aACT;YACD,IAAI,EAAE,SAAS;YACf,MAAM,EAAE,IAAI;SACb;KACF,CAAC,CAAC;AACL,CAAC;AApBD,yBAoBC"}

package/dist/tests/testingMongoUpdates/1.0.1.d.ts

@@ -0,0 +1,5 @@
+import * as MongoDb from 'mongodb';
+/**
+ * TEST update - version 1.0.1
+ */
+export default function update(db: MongoDb.Db): Promise<void>;

package/dist/tests/testingMongoUpdates/1.0.1.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * TEST update - version 1.0.1
+ */
+async function update(db) {
+    // ==========================================
+    // Adding extra indexes on the "test" collection.
+    // ==========================================
+    const testUserCollection = await db.collection('test');
+    await testUserCollection.createIndexes([
+        {
+            key: {
+                firstName: 1,
+                lastName: 1
+            },
+            name: 'firstName_lastName'
+        }
+    ]);
+}
+exports.default = update;
+//# sourceMappingURL=1.0.1.js.map

package/dist/tests/testingMongoUpdates/1.0.1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"1.0.1.js","sourceRoot":"","sources":["../../../tests/testingMongoUpdates/1.0.1.ts"],"names":[],"mappings":";;AAEA;;GAEG;AACY,KAAK,UAAU,MAAM,CAAC,EAAc;IACjD,6CAA6C;IAC7C,iDAAiD;IACjD,6CAA6C;IAC7C,MAAM,kBAAkB,GAAuB,MAAM,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAE3E,MAAM,kBAAkB,CAAC,aAAa,CAAC;QACrC;YACE,GAAG,EAAE;gBACH,SAAS,EAAE,CAAC;gBACZ,QAAQ,EAAE,CAAC;aACZ;YACD,IAAI,EAAE,oBAAoB;SAC3B;KACF,CAAC,CAAC;AACL,CAAC;AAfD,yBAeC"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@villedemontreal/mongo",
+  "version": "6.7.0",
+  "description": "Utilities for Mongo / Mongoose",
+  "main": "dist/src/index.js",
+  "typings": "dist/src",
+  "files": [
+    "src",
+    "dist"
+  ],
+  "scripts": {
+    "start": "node run test",
+    "test": "node run test",
+    "compile": "node run compile",
+    "lint": "node run lint",
+    "lint-fix": "node run lint-fix",
+    "tslint": "node run tslint",
+    "tslint-fix": "node run tslint-fix",
+    "prettier": "node run prettier",
+    "prettier-fix": "node run prettier-fix",
+    "watch": "node run watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/VilledeMontreal/node-mongo"
+  },
+  "homepage": "https://github.com/VilledeMontreal/node-mongo",
+  "keywords": [
+    "mongo",
+    "mongoose",
+    "utilities"
+  ],
+  "author": "Ville de Montréal",
+  "license": "MIT",
+  "dependencies": {
+    "@types/http-status-codes": "1.2.0",
+    "@types/lodash": "4.14.181",
+    "@types/semver": "7.3.9",
+    "@villedemontreal/general-utils": "5.16.3",
+    "@villedemontreal/logger": "6.5.3",
+    "@villedemontreal/scripting": "1.5.0",
+    "fs-extra": "10.0.1",
+    "http-status-codes": "2.2.0",
+    "lodash": "4.17.21",
+    "mongodb": "3.6.12",
+    "mongodb-memory-server-core": "7.2.1",
+    "mongoose": "5.13.13",
+    "semver": "7.3.5"
+  },
+  "devDependencies": {
+    "@types/chai": "4.3.0",
+    "@types/fs-extra": "9.0.13",
+    "@types/mocha": "9.1.0",
+    "@types/sinon": "10.0.11",
+    "@villedemontreal/lint-config": "1.7.7",
+    "chai": "4.3.6",
+    "mocha": "9.2.2",
+    "mocha-jenkins-reporter": "0.4.7",
+    "sinon": "13.0.1",
+    "tslint": "6.1.3",
+    "typescript": "3.9.5"
+  }
+}

package/src/config/configs.ts

@@ -0,0 +1,27 @@
+import { ILogger } from '@villedemontreal/logger';
+
+/**
+ * Lib configs
+ */
+export class Configs {
+  private _loggerCreator: (name: string) => ILogger;
+
+  /**
+   * The Logger creator
+   */
+  get loggerCreator(): (name: string) => ILogger {
+    if (!this._loggerCreator) {
+      throw new Error(`The Logger Creator HAS to be set as a configuration`);
+    }
+    return this._loggerCreator;
+  }
+
+  /**
+   * Sets the Logger creator.
+   */
+  public setLoggerCreator(loggerCreator: (name: string) => ILogger) {
+    this._loggerCreator = loggerCreator;
+  }
+}
+
+export let configs: Configs = new Configs();

package/src/config/constants.ts

@@ -0,0 +1,122 @@
+// ==========================================
+// Application constants
+// ==========================================
+import { path as appRoot } from 'app-root-path';
+import * as path from 'path';
+import { IMongooseConfigs } from './mongooseConfigs';
+
+/**
+ * Library constants
+ */
+export class Constants {
+  /**
+   * The library root. When this library is used
+   * as a dependency in a project, the "libRoot"
+   * will be the path to the dependency folder,
+   * inside the "node_modules".
+   */
+  public libRoot: string;
+
+  /**
+   * The app root. When this library is used
+   * as a dependency in a project, the "appRoot"
+   * will be the path to the root project!
+   */
+  public appRoot: string;
+
+  constructor() {
+    // From the "dist/src/config" folder
+    this.libRoot = path.normalize(__dirname + '/../../..');
+    this.appRoot = appRoot;
+  }
+
+  /**
+   * Base config to 'mock' a mongo server
+   */
+  get testsConfig(): IMongooseConfigs {
+    return {
+      applyUpdates: false,
+      connectionString: 'mock',
+      connectionOptions: {
+        useNewUrlParser: true,
+        useUnifiedTopology: true
+      },
+      updater: {
+        lockMaxAgeSeconds: 30,
+        mongoSchemaUpdatesDirPath: '/dist/tests/testingMongoUpdates',
+        appSchemaCollectionName: 'testAppSchema'
+      },
+      mockServer: {
+        serverVersion: '4.0.16'
+      }
+    };
+  }
+
+  /**
+   * Mongo constants
+   */
+  get mongo() {
+    return {
+      testing: {
+        /**
+         * The "connectionString" to use for a mock
+         * Mongo server to be used instead of a real one.
+         * This option is only available on the "development"
+         * environment, or when tests are ran.
+         */
+        MOCK_CONNECTION_STRING: 'mock'
+      },
+      /**
+       * The names of the Mongo collections used in
+       * this application.
+       */
+      collectionNames: {
+        /**
+         * Special collection that stores informations about the
+         * schema currently installed for the application.
+         */
+        APP_SCHEMA: 'appSchema'
+      },
+      /**
+       * Mongo error codes
+       */
+      mongoErrorCodes: {
+        /**
+         * The code for a Mongo "duplicate key" error.
+         */
+        DUPLICATE_KEY: 11000
+      },
+
+      /**
+       * Mongoose constants
+       */
+      mongoose: {
+        /**
+         *  Mongoose error codes
+         */
+        errorCodes: {
+          /**
+           * The code for a Mongoose "required" error.
+           */
+          REQUIRED_FIELD: 'required'
+        },
+
+        /**
+         *  Mongoose error kinds
+         */
+        errorKinds: {
+          OBJECT_ID: 'ObjectId'
+        },
+
+        /**
+         *  Mongoose error names
+         */
+        errorNames: {
+          CAST_ERROR: 'CastError'
+        }
+      }
+    };
+  }
+}
+
+export let constants: Constants = new Constants();

package/src/config/init.ts

@@ -0,0 +1,23 @@
+import { ILogger } from '@villedemontreal/logger';
+import { configs } from './configs';
+
+let libIsInitialized: boolean = false;
+/**
+ * Inits the library.
+ */
+export function init(loggerCreator: (name: string) => ILogger): void {
+  if (!loggerCreator) {
+    throw new Error(`The Logger Creator is required.`);
+  }
+
+  configs.setLoggerCreator(loggerCreator);
+
+  libIsInitialized = true;
+}
+
+/**
+ * checks if the library has been initialized.
+ */
+export function isInited(): boolean {
+  return libIsInitialized;
+}

package/src/config/mongooseConfigs.ts

@@ -0,0 +1,178 @@
+import { utils } from '@villedemontreal/general-utils';
+import * as _ from 'lodash';
+import { createLogger } from '../utils/logger';
+import { constants } from './constants';
+
+const logger = createLogger('mongooseConfigs');
+
+export interface IMongooseConfigs {
+  /**
+   * The updater.mongoSchemaUpdatesDirPath
+   * is a required config.
+   */
+  updater?: {
+    /**
+     * Name of the app schema collection name to use.
+     * Useful when multiple components use the same database.
+     */
+    appSchemaCollectionName?: string;
+    /**
+     * The path where to find update files.
+     */
+    mongoSchemaUpdatesDirPath: string;
+
+    lockMaxAgeSeconds?: number;
+  };
+
+  /**
+   * @param applyUpdates Should the database be checked for missing
+   * updates and have them applied if required?
+   * Defaults to true.
+   */
+  applyUpdates?: boolean;
+
+  /**
+   * If no connectionString is provided, "mock" will be
+   * used by default and a temporary Mongo server will
+   * be used.
+   */
+  connectionString?: string;
+
+  /**
+   * The Mongoose connection options.
+   */
+  connectionOptions?: any;
+
+  mockServer?: {
+    /**
+     *  @param mongoServerVersion the Mongo version to use.
+     *
+     * Pass null (or undefined) to use the default version
+     * downloaded by mockServer.
+     */
+    serverVersion?: string;
+  };
+}
+
+/**
+ * Mongoose configs with default values.
+ */
+export class MongooseConfigs implements IMongooseConfigs {
+  /**
+   * @param applyUpdates Should the database be checked for missing
+   * updates and have them applied if required?
+   */
+  public applyUpdates: boolean = true;
+
+  /**
+   * If no connectionString is provided, "mock" will be
+   * used by default and a temporary Mongo server will
+   * be used.
+   */
+  public connectionString: string = 'mock';
+
+  public connectionOptions: any = {
+    w: 1,
+    wtimeout: 5000,
+    auto_reconnect: true,
+    reconnectTries: 604800,
+    reconnectInterval: 1000,
+    useNewUrlParser: true
+  };
+
+  public updater: { lockMaxAgeSeconds: number; mongoSchemaUpdatesDirPath: string; appSchemaCollectionName: string } = {
+    appSchemaCollectionName: 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
+  };
+
+  public mockServer: { serverVersion: string } = {
+    serverVersion: '3.2.1'
+  };
+
+  /**
+   * Overrides default configurations using the ones passed
+   * as parameters.
+   */
+  // tslint:disable-next-line:cyclomatic-complexity
+  constructor(overridingConfigs: IMongooseConfigs) {
+    // ==========================================
+    // Required configs
+    // ==========================================
+
+    if (
+      _.isNil(overridingConfigs) ||
+      _.isNil(overridingConfigs.updater) ||
+      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 (!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) ||
+        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) || 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) ||
+        utils.isBlank(overridingConfigs.mockServer.serverVersion)
+      ) {
+        throw new Error(
+          `The mockServer.serverVersion config is not valid : ${overridingConfigs.mockServer.serverVersion}`
+        );
+      }
+      this.mockServer.serverVersion = overridingConfigs.mockServer.serverVersion;
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,13 @@
+export * from './mongoUtils';
+export * from './config/constants';
+export { IMongooseConfigs } from './config/mongooseConfigs';
+export * from './mongoClient';
+
+// ==========================================
+// We do not export the configs instance itself,
+// only the "init()" method, so we can define
+// which are the required parameters.
+// ==========================================
+export * from './config/init';
+export * from './plugins/pagination';
+// import { IPaginateOptions } from './plugins/pagination/specs/IPaginateOptions';