@depup/mongoose 9.1.3-depup.0

package/lib/error/objectExpected.js

@@ -0,0 +1,31 @@
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('./mongooseError');
+
+/**
+ * Strict mode error constructor
+ *
+ * @param {string} type
+ * @param {string} value
+ * @api private
+ */
+
+class ObjectExpectedError extends MongooseError {
+
+  constructor(path, val) {
+    const typeDescription = Array.isArray(val) ? 'array' : 'primitive value';
+    super('Tried to set nested object field `' + path +
+      `\` to ${typeDescription} \`` + val + '`');
+    this.path = path;
+  }
+}
+
+Object.defineProperty(ObjectExpectedError.prototype, 'name', {
+  value: 'ObjectExpectedError'
+});
+
+module.exports = ObjectExpectedError;

package/lib/error/objectParameter.js

@@ -0,0 +1,31 @@
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('./mongooseError');
+
+/**
+ * Constructor for errors that happen when a parameter that's expected to be
+ * an object isn't an object
+ *
+ * @param {Any} value
+ * @param {String} paramName
+ * @param {String} fnName
+ * @api private
+ */
+
+class ObjectParameterError extends MongooseError {
+  constructor(value, paramName, fnName) {
+    super('Parameter "' + paramName + '" to ' + fnName +
+      '() must be an object, got "' + (value == null ? value : value.toString()) + '" (type ' + typeof value + ')');
+  }
+}
+
+
+Object.defineProperty(ObjectParameterError.prototype, 'name', {
+  value: 'ObjectParameterError'
+});
+
+module.exports = ObjectParameterError;

package/lib/error/overwriteModel.js

@@ -0,0 +1,31 @@
+
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('./mongooseError');
+
+/**
+ * OverwriteModel Error constructor.
+ * @param {String} name
+ * @api private
+ */
+
+class OverwriteModelError extends MongooseError {
+
+  constructor(name) {
+    super('Cannot overwrite `' + name + '` model once compiled.');
+  }
+}
+
+Object.defineProperty(OverwriteModelError.prototype, 'name', {
+  value: 'OverwriteModelError'
+});
+
+/*!
+ * exports
+ */
+
+module.exports = OverwriteModelError;

package/lib/error/parallelSave.js

@@ -0,0 +1,33 @@
+'use strict';
+
+/*!
+ * Module dependencies.
+ */
+
+const MongooseError = require('./mongooseError');
+
+
+/**
+ * ParallelSave Error constructor.
+ *
+ * @param {Document} doc
+ * @api private
+ */
+
+class ParallelSaveError extends MongooseError {
+
+  constructor(doc) {
+    const msg = 'Can\'t save() the same doc multiple times in parallel. Document: ';
+    super(msg + doc._doc._id);
+  }
+}
+
+Object.defineProperty(ParallelSaveError.prototype, 'name', {
+  value: 'ParallelSaveError'
+});
+
+/*!
+ * exports
+ */
+
+module.exports = ParallelSaveError;

package/lib/error/parallelValidate.js

@@ -0,0 +1,33 @@
+'use strict';
+
+/*!
+ * Module dependencies.
+ */
+
+const MongooseError = require('./mongooseError');
+
+
+/**
+ * ParallelValidate Error constructor.
+ *
+ * @param {Document} doc
+ * @api private
+ */
+
+class ParallelValidateError extends MongooseError {
+
+  constructor(doc) {
+    const msg = 'Can\'t validate() the same doc multiple times in parallel. Document: ';
+    super(msg + doc._doc._id);
+  }
+}
+
+Object.defineProperty(ParallelValidateError.prototype, 'name', {
+  value: 'ParallelValidateError'
+});
+
+/*!
+ * exports
+ */
+
+module.exports = ParallelValidateError;

package/lib/error/serverSelection.js

@@ -0,0 +1,62 @@
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('./mongooseError');
+const allServersUnknown = require('../helpers/topology/allServersUnknown');
+const isAtlas = require('../helpers/topology/isAtlas');
+const isSSLError = require('../helpers/topology/isSSLError');
+
+/*!
+ * ignore
+ */
+
+const atlasMessage = 'Could not connect to any servers in your MongoDB Atlas cluster. ' +
+  'One common reason is that you\'re trying to access the database from ' +
+  'an IP that isn\'t whitelisted. Make sure your current IP address is on your Atlas ' +
+  'cluster\'s IP whitelist: https://www.mongodb.com/docs/atlas/security-whitelist/';
+
+const sslMessage = 'Mongoose is connecting with SSL enabled, but the server is ' +
+  'not accepting SSL connections. Please ensure that the MongoDB server you are ' +
+  'connecting to is configured to accept SSL connections. Learn more: ' +
+  'https://mongoosejs.com/docs/tutorials/ssl.html';
+
+class MongooseServerSelectionError extends MongooseError {
+  /**
+   * MongooseServerSelectionError constructor
+   *
+   * @api private
+   */
+  assimilateError(err) {
+    const reason = err.reason;
+    // Special message for a case that is likely due to IP whitelisting issues.
+    const isAtlasWhitelistError = isAtlas(reason) &&
+      allServersUnknown(reason) &&
+      err.message.indexOf('bad auth') === -1 &&
+      err.message.indexOf('Authentication failed') === -1;
+
+    if (isAtlasWhitelistError) {
+      this.message = atlasMessage;
+    } else if (isSSLError(reason)) {
+      this.message = sslMessage;
+    } else {
+      this.message = err.message;
+    }
+    for (const key in err) {
+      if (key !== 'name') {
+        this[key] = err[key];
+      }
+    }
+    this.cause = reason;
+
+    return this;
+  }
+}
+
+Object.defineProperty(MongooseServerSelectionError.prototype, 'name', {
+  value: 'MongooseServerSelectionError'
+});
+
+module.exports = MongooseServerSelectionError;

package/lib/error/setOptionError.js

@@ -0,0 +1,103 @@
+/*!
+ * Module requirements
+ */
+
+'use strict';
+
+const MongooseError = require('./mongooseError');
+const util = require('util');
+const combinePathErrors = require('../helpers/error/combinePathErrors');
+
+/**
+ * Mongoose.set Error
+ *
+ * @api private
+ * @inherits MongooseError
+ */
+
+class SetOptionError extends MongooseError {
+
+  constructor() {
+    super('');
+
+    this.errors = {};
+  }
+
+  /**
+   * Console.log helper
+   */
+  toString() {
+    return combinePathErrors(this);
+  }
+
+  /**
+   * inspect helper
+   * @api private
+   */
+  inspect() {
+    return Object.assign(new Error(this.message), this);
+  }
+
+  /**
+  * add message
+  * @param {String} key
+  * @param {String|Error} error
+  * @api private
+  */
+  addError(key, error) {
+    if (error instanceof SetOptionError) {
+      const { errors } = error;
+      for (const optionKey of Object.keys(errors)) {
+        this.addError(optionKey, errors[optionKey]);
+      }
+
+      return;
+    }
+
+    this.errors[key] = error;
+    this.message = combinePathErrors(this);
+  }
+}
+
+
+if (util.inspect.custom) {
+  // Avoid Node deprecation warning DEP0079
+  SetOptionError.prototype[util.inspect.custom] = SetOptionError.prototype.inspect;
+}
+
+/**
+ * Helper for JSON.stringify
+ * Ensure `name` and `message` show up in toJSON output re: gh-9847
+ * @api private
+ */
+Object.defineProperty(SetOptionError.prototype, 'toJSON', {
+  enumerable: false,
+  writable: false,
+  configurable: true,
+  value: function() {
+    return Object.assign({}, this, { name: this.name, message: this.message });
+  }
+});
+
+
+Object.defineProperty(SetOptionError.prototype, 'name', {
+  value: 'SetOptionError'
+});
+
+class SetOptionInnerError extends MongooseError {
+  /**
+   * Error for the "errors" array in "SetOptionError" with consistent message
+   * @param {String} key
+   */
+  constructor(key) {
+    super(`"${key}" is not a valid option to set`);
+  }
+}
+
+SetOptionError.SetOptionInnerError = SetOptionInnerError;
+
+/*!
+ * Module exports
+ */
+
+module.exports = SetOptionError;

package/lib/error/strict.js

@@ -0,0 +1,35 @@
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('./mongooseError');
+
+/**
+ * Strict mode error constructor
+ *
+ * @param {String} path
+ * @param {String} [msg]
+ * @param {Boolean} [immutable]
+ * @inherits MongooseError
+ * @api private
+ */
+
+
+class StrictModeError extends MongooseError {
+
+  constructor(path, msg, immutable) {
+    msg = msg || 'Field `' + path + '` is not in schema and strict ' +
+      'mode is set to throw.';
+    super(msg);
+    this.isImmutableError = !!immutable;
+    this.path = path;
+  }
+}
+
+Object.defineProperty(StrictModeError.prototype, 'name', {
+  value: 'StrictModeError'
+});
+
+module.exports = StrictModeError;

package/lib/error/strictPopulate.js

@@ -0,0 +1,31 @@
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('./mongooseError');
+
+/**
+ * Strict mode error constructor
+ *
+ * @param {String} path
+ * @param {String} [msg]
+ * @inherits MongooseError
+ * @api private
+ */
+
+class StrictPopulateError extends MongooseError {
+
+  constructor(path, msg) {
+    msg = msg || 'Cannot populate path `' + path + '` because it is not in your schema. ' + 'Set the `strictPopulate` option to false to override.';
+    super(msg);
+    this.path = path;
+  }
+}
+
+Object.defineProperty(StrictPopulateError.prototype, 'name', {
+  value: 'StrictPopulateError'
+});
+
+module.exports = StrictPopulateError;

package/lib/error/syncIndexes.js

@@ -0,0 +1,30 @@
+'use strict';
+
+/*!
+ * Module dependencies.
+ */
+
+const MongooseError = require('./mongooseError');
+
+/**
+ * SyncIndexes Error constructor.
+ *
+ * @param {String} message
+ * @param {String} errorsMap
+ * @inherits MongooseError
+ * @api private
+ */
+
+class SyncIndexesError extends MongooseError {
+  constructor(message, errorsMap) {
+    super(message);
+    this.errors = errorsMap;
+  }
+}
+
+Object.defineProperty(SyncIndexesError.prototype, 'name', {
+  value: 'SyncIndexesError'
+});
+
+
+module.exports = SyncIndexesError;

package/lib/error/validation.js

@@ -0,0 +1,97 @@
+/*!
+ * Module requirements
+ */
+
+'use strict';
+
+const MongooseError = require('./mongooseError');
+const getConstructorName = require('../helpers/getConstructorName');
+const util = require('util');
+const combinePathErrors = require('../helpers/error/combinePathErrors');
+
+/**
+ * Document Validation Error
+ *
+ * @api private
+ * @param {Document} [instance]
+ * @inherits MongooseError
+ */
+
+class ValidationError extends MongooseError {
+
+  constructor(instance) {
+    let _message;
+    if (getConstructorName(instance) === 'model') {
+      _message = instance.constructor.modelName + ' validation failed';
+    } else {
+      _message = 'Validation failed';
+    }
+
+    super(_message);
+
+    this.errors = {};
+    this._message = _message;
+
+    if (instance) {
+      instance.$errors = this.errors;
+    }
+  }
+
+  /**
+   * Console.log helper
+   */
+  toString() {
+    return this.name + ': ' + combinePathErrors(this);
+  }
+
+  /**
+  * add message
+  * @param {String} path
+  * @param {String|Error} error
+  * @api private
+  */
+  addError(path, error) {
+    if (error instanceof ValidationError) {
+      const { errors } = error;
+      for (const errorPath of Object.keys(errors)) {
+        this.addError(`${path}.${errorPath}`, errors[errorPath]);
+      }
+
+      return;
+    }
+
+    this.errors[path] = error;
+    this.message = this._message + ': ' + combinePathErrors(this);
+  }
+}
+
+
+if (util.inspect.custom) {
+  // Avoid Node deprecation warning DEP0079
+  ValidationError.prototype[util.inspect.custom] = ValidationError.prototype.inspect;
+}
+
+/**
+ * Helper for JSON.stringify
+ * Ensure `name` and `message` show up in toJSON output re: gh-9847
+ * @api private
+ */
+Object.defineProperty(ValidationError.prototype, 'toJSON', {
+  enumerable: false,
+  writable: false,
+  configurable: true,
+  value: function() {
+    return Object.assign({}, this, { name: this.name, message: this.message });
+  }
+});
+
+
+Object.defineProperty(ValidationError.prototype, 'name', {
+  value: 'ValidationError'
+});
+
+/*!
+ * Module exports
+ */
+
+module.exports = ValidationError;

package/lib/error/validator.js

@@ -0,0 +1,100 @@
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('./mongooseError');
+
+/**
+ * Schema validator error
+ *
+ * @param {Object} properties
+ * @param {Document} doc
+ * @api private
+ */
+
+class ValidatorError extends MongooseError {
+
+  constructor(properties, doc) {
+    let msg = properties.message;
+    if (!msg) {
+      msg = MongooseError.messages.general.default;
+    }
+
+    const message = formatMessage(msg, properties, doc);
+    super(message);
+
+    properties = Object.assign({}, properties, { message: message });
+    this.properties = properties;
+    this.kind = properties.type;
+    this.path = properties.path;
+    this.value = properties.value;
+    this.reason = properties.reason;
+  }
+
+  /**
+   * toString helper
+   * TODO remove? This defaults to `${this.name}: ${this.message}`
+   * @api private
+   */
+  toString() {
+    return this.message;
+  }
+
+  /**
+   * Ensure `name` and `message` show up in toJSON output re: gh-9296
+   * @api private
+   */
+
+  toJSON() {
+    return Object.assign({ name: this.name, message: this.message }, this);
+  }
+}
+
+
+Object.defineProperty(ValidatorError.prototype, 'name', {
+  value: 'ValidatorError'
+});
+
+/**
+ * The object used to define this validator. Not enumerable to hide
+ * it from `require('util').inspect()` output re: gh-3925
+ * @api private
+ */
+
+Object.defineProperty(ValidatorError.prototype, 'properties', {
+  enumerable: false,
+  writable: true,
+  value: null
+});
+
+// Exposed for testing
+ValidatorError.prototype.formatMessage = formatMessage;
+
+/**
+ * Formats error messages
+ * @api private
+ */
+
+function formatMessage(msg, properties, doc) {
+  if (typeof msg === 'function') {
+    return msg(properties, doc);
+  }
+
+  const propertyNames = Object.keys(properties);
+  for (const propertyName of propertyNames) {
+    if (propertyName === 'message') {
+      continue;
+    }
+    msg = msg.replace('{' + propertyName.toUpperCase() + '}', properties[propertyName]);
+  }
+
+  return msg;
+}
+
+/*!
+ * exports
+ */
+
+module.exports = ValidatorError;

package/lib/error/version.js

@@ -0,0 +1,38 @@
+'use strict';
+
+/*!
+ * Module dependencies.
+ */
+
+const MongooseError = require('./mongooseError');
+
+/**
+ * Version Error constructor.
+ *
+ * @param {Document} doc
+ * @param {Number} currentVersion
+ * @param {Array<String>} modifiedPaths
+ * @api private
+ */
+
+class VersionError extends MongooseError {
+
+  constructor(doc, currentVersion, modifiedPaths) {
+    const modifiedPathsStr = modifiedPaths.join(', ');
+    super('No matching document found for id "' + doc._doc._id +
+      '" version ' + currentVersion + ' modifiedPaths "' + modifiedPathsStr + '"');
+    this.version = currentVersion;
+    this.modifiedPaths = modifiedPaths;
+  }
+}
+
+
+Object.defineProperty(VersionError.prototype, 'name', {
+  value: 'VersionError'
+});
+
+/*!
+ * exports
+ */
+
+module.exports = VersionError;

package/lib/helpers/aggregate/prepareDiscriminatorPipeline.js

@@ -0,0 +1,39 @@
+'use strict';
+
+module.exports = function prepareDiscriminatorPipeline(pipeline, schema, prefix) {
+  const discriminatorMapping = schema?.discriminatorMapping;
+  prefix = prefix || '';
+
+  if (discriminatorMapping && !discriminatorMapping.isRoot) {
+    const originalPipeline = pipeline;
+    const filterKey = (prefix.length > 0 ? prefix + '.' : prefix) + discriminatorMapping.key;
+    const discriminatorValue = discriminatorMapping.value;
+
+    // If the first pipeline stage is a match and it doesn't specify a `__t`
+    // key, add the discriminator key to it. This allows for potential
+    // aggregation query optimizations not to be disturbed by this feature.
+    if (originalPipeline[0] != null &&
+        originalPipeline[0].$match &&
+        (originalPipeline[0].$match[filterKey] === undefined || originalPipeline[0].$match[filterKey] === discriminatorValue)) {
+      originalPipeline[0].$match[filterKey] = discriminatorValue;
+      // `originalPipeline` is a ref, so there's no need for
+      // aggregate._pipeline = originalPipeline
+    } else if (originalPipeline[0]?.$geoNear) {
+      originalPipeline[0].$geoNear.query =
+          originalPipeline[0].$geoNear.query || {};
+      originalPipeline[0].$geoNear.query[filterKey] = discriminatorValue;
+    } else if (originalPipeline[0]?.$search) {
+      if (originalPipeline[1]?.$match != null) {
+        originalPipeline[1].$match[filterKey] = originalPipeline[1].$match[filterKey] || discriminatorValue;
+      } else {
+        const match = {};
+        match[filterKey] = discriminatorValue;
+        originalPipeline.splice(1, 0, { $match: match });
+      }
+    } else {
+      const match = {};
+      match[filterKey] = discriminatorValue;
+      originalPipeline.unshift({ $match: match });
+    }
+  }
+};