@depup/mongoose 9.1.3-depup.0

package/lib/error/cast.js

@@ -0,0 +1,158 @@
+'use strict';
+
+/*!
+ * Module dependencies.
+ */
+
+const MongooseError = require('./mongooseError');
+const util = require('util');
+
+/**
+ * Casting Error constructor.
+ *
+ * @param {String} type
+ * @param {String} value
+ * @inherits MongooseError
+ * @api private
+ */
+
+class CastError extends MongooseError {
+  constructor(type, value, path, reason, schemaType) {
+    // If no args, assume we'll `init()` later.
+    if (arguments.length > 0) {
+      const valueType = getValueType(value);
+      const messageFormat = getMessageFormat(schemaType);
+      const msg = formatMessage(null, type, value, path, messageFormat, valueType, reason);
+      super(msg);
+      this.init(type, value, path, reason, schemaType);
+    } else {
+      super(formatMessage());
+    }
+  }
+
+  toJSON() {
+    return {
+      stringValue: this.stringValue,
+      valueType: this.valueType,
+      kind: this.kind,
+      value: this.value,
+      path: this.path,
+      reason: this.reason,
+      name: this.name,
+      message: this.message
+    };
+  }
+  /*!
+   * ignore
+   */
+  init(type, value, path, reason, schemaType) {
+    this.stringValue = getStringValue(value);
+    this.messageFormat = getMessageFormat(schemaType);
+    this.kind = type;
+    this.value = value;
+    this.path = path;
+    this.reason = reason;
+    this.valueType = getValueType(value);
+  }
+
+  /**
+   * ignore
+   * @param {Readonly<CastError>} other
+   * @api private
+   */
+  copy(other) {
+    this.messageFormat = other.messageFormat;
+    this.stringValue = other.stringValue;
+    this.kind = other.kind;
+    this.value = other.value;
+    this.path = other.path;
+    this.reason = other.reason;
+    this.message = other.message;
+    this.valueType = other.valueType;
+  }
+
+  /*!
+   * ignore
+   */
+  setModel(model) {
+    this.message = formatMessage(model, this.kind, this.value, this.path,
+      this.messageFormat, this.valueType);
+  }
+}
+
+Object.defineProperty(CastError.prototype, 'name', {
+  value: 'CastError'
+});
+
+function getStringValue(value) {
+  let stringValue = util.inspect(value);
+  stringValue = stringValue.replace(/^'|'$/g, '"');
+  if (!stringValue.startsWith('"')) {
+    stringValue = '"' + stringValue + '"';
+  }
+  return stringValue;
+}
+
+function getValueType(value) {
+  if (value == null) {
+    return '' + value;
+  }
+
+  const t = typeof value;
+  if (t !== 'object') {
+    return t;
+  }
+  if (typeof value.constructor !== 'function') {
+    return t;
+  }
+  return value.constructor.name;
+}
+
+function getMessageFormat(schemaType) {
+  const messageFormat = schemaType?._castErrorMessage || null;
+  if (typeof messageFormat === 'string' || typeof messageFormat === 'function') {
+    return messageFormat;
+  }
+}
+
+/*!
+ * ignore
+ */
+
+function formatMessage(model, kind, value, path, messageFormat, valueType, reason) {
+  if (typeof messageFormat === 'string') {
+    const stringValue = getStringValue(value);
+    let ret = messageFormat.
+      replace('{KIND}', kind).
+      replace('{VALUE}', stringValue).
+      replace('{PATH}', path);
+    if (model != null) {
+      ret = ret.replace('{MODEL}', model.modelName);
+    }
+
+    return ret;
+  } else if (typeof messageFormat === 'function') {
+    return messageFormat(value, path, model, kind);
+  } else {
+    const stringValue = getStringValue(value);
+    const valueTypeMsg = valueType ? ' (type ' + valueType + ')' : '';
+    let ret = 'Cast to ' + kind + ' failed for value ' +
+      stringValue + valueTypeMsg + ' at path "' + path + '"';
+    if (model != null) {
+      ret += ' for model "' + model.modelName + '"';
+    }
+    if (reason != null &&
+        typeof reason.constructor === 'function' &&
+        reason.constructor.name !== 'AssertionError' &&
+        reason.constructor.name !== 'Error') {
+      ret += ' because of "' + reason.constructor.name + '"';
+    }
+    return ret;
+  }
+}
+
+/*!
+ * exports
+ */
+
+module.exports = CastError;

package/lib/error/createCollectionsError.js

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

package/lib/error/divergentArray.js

@@ -0,0 +1,40 @@
+
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('./mongooseError');
+
+/**
+ * DivergentArrayError constructor.
+ * @param {Array<String>} paths
+ * @api private
+ */
+
+class DivergentArrayError extends MongooseError {
+
+  constructor(paths) {
+    const msg = 'For your own good, using `document.save()` to update an array '
+            + 'which was selected using an $elemMatch projection OR '
+            + 'populated using skip, limit, query conditions, or exclusion of '
+            + 'the _id field when the operation results in a $pop or $set of '
+            + 'the entire array is not supported. The following '
+            + 'path(s) would have been modified unsafely:\n'
+            + '  ' + paths.join('\n  ') + '\n'
+            + 'Use Model.updateOne() to update these arrays instead. '
+            + 'See https://mongoosejs.com/docs/faq.html#divergent-array-error for more information.';
+    super(msg);
+  }
+}
+
+Object.defineProperty(DivergentArrayError.prototype, 'name', {
+  value: 'DivergentArrayError'
+});
+
+/*!
+ * exports
+ */
+
+module.exports = DivergentArrayError;

package/lib/error/eachAsyncMultiError.js

@@ -0,0 +1,41 @@
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('./mongooseError');
+
+
+/**
+ * If `eachAsync()` is called with `continueOnError: true`, there can be
+ * multiple errors. This error class contains an `errors` property, which
+ * contains an array of all errors that occurred in `eachAsync()`.
+ *
+ * @api private
+ */
+
+class EachAsyncMultiError extends MongooseError {
+  /**
+   * @param {String} connectionString
+   */
+  constructor(errors) {
+    let preview = errors.map(e => e.message).join(', ');
+    if (preview.length > 50) {
+      preview = preview.slice(0, 50) + '...';
+    }
+    super(`eachAsync() finished with ${errors.length} errors: ${preview}`);
+
+    this.errors = errors;
+  }
+}
+
+Object.defineProperty(EachAsyncMultiError.prototype, 'name', {
+  value: 'EachAsyncMultiError'
+});
+
+/*!
+ * exports
+ */
+
+module.exports = EachAsyncMultiError;

package/lib/error/index.js

@@ -0,0 +1,237 @@
+'use strict';
+
+/**
+ * MongooseError constructor. MongooseError is the base class for all
+ * Mongoose-specific errors.
+ *
+ * #### Example:
+ *
+ *     const Model = mongoose.model('Test', new mongoose.Schema({ answer: Number }));
+ *     const doc = new Model({ answer: 'not a number' });
+ *     const err = doc.validateSync();
+ *
+ *     err instanceof mongoose.Error.ValidationError; // true
+ *
+ * @constructor Error
+ * @param {String} msg Error message
+ * @inherits Error https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error
+ */
+
+const MongooseError = require('./mongooseError');
+
+/**
+ * The name of the error. The name uniquely identifies this Mongoose error. The
+ * possible values are:
+ *
+ * - `MongooseError`: general Mongoose error
+ * - `CastError`: Mongoose could not convert a value to the type defined in the schema path. May be in a `ValidationError` class' `errors` property.
+ * - `DivergentArrayError`: You attempted to `save()` an array that was modified after you loaded it with a `$elemMatch` or similar projection
+ * - `MissingSchemaError`: You tried to access a model with [`mongoose.model()`](https://mongoosejs.com/docs/api/mongoose.html#Mongoose.model()) that was not defined
+ * - `DocumentNotFoundError`: The document you tried to [`save()`](https://mongoosejs.com/docs/api/document.html#Document.prototype.save()) was not found
+ * - `ValidatorError`: error from an individual schema path's validator
+ * - `ValidationError`: error returned from [`validate()`](https://mongoosejs.com/docs/api/document.html#Document.prototype.validate()) or [`validateSync()`](https://mongoosejs.com/docs/api/document.html#Document.prototype.validateSync()). Contains zero or more `ValidatorError` instances in `.errors` property.
+ * - `MissingSchemaError`: You called `mongoose.Document()` without a schema
+ * - `ObjectExpectedError`: Thrown when you set a nested path to a non-object value with [strict mode set](https://mongoosejs.com/docs/guide.html#strict).
+ * - `ObjectParameterError`: Thrown when you pass a non-object value to a function which expects an object as a paramter
+ * - `OverwriteModelError`: Thrown when you call [`mongoose.model()`](https://mongoosejs.com/docs/api/mongoose.html#Mongoose.model()) to re-define a model that was already defined.
+ * - `ParallelSaveError`: Thrown when you call [`save()`](https://mongoosejs.com/docs/api/model.html#Model.prototype.save()) on a document when the same document instance is already saving.
+ * - `StrictModeError`: Thrown when you set a path that isn't the schema and [strict mode](https://mongoosejs.com/docs/guide.html#strict) is set to `throw`.
+ * - `VersionError`: Thrown when the [document is out of sync](https://mongoosejs.com/docs/guide.html#versionKey)
+ *
+ * @api public
+ * @property {String} name
+ * @memberOf Error
+ * @instance
+ */
+
+/*!
+ * Module exports.
+ */
+
+module.exports = exports = MongooseError;
+
+/**
+ * The default built-in validator error messages.
+ *
+ * @see Error.messages https://mongoosejs.com/docs/api/error.html#Error.messages
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.messages = require('./messages');
+
+// backward compat
+MongooseError.Messages = MongooseError.messages;
+
+/**
+ * An instance of this error class will be thrown when mongoose failed to
+ * cast a value.
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.CastError = require('./cast');
+
+/**
+ * An instance of this error class will be thrown when `save()` fails
+ * because the underlying
+ * document was not found. The constructor takes one parameter, the
+ * conditions that mongoose passed to `updateOne()` when trying to update
+ * the document.
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.DocumentNotFoundError = require('./notFound');
+
+/**
+ * An instance of this error class will be thrown when [validation](https://mongoosejs.com/docs/validation.html) failed.
+ * The `errors` property contains an object whose keys are the paths that failed and whose values are
+ * instances of CastError or ValidationError.
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.ValidationError = require('./validation');
+
+/**
+ * A `ValidationError` has a hash of `errors` that contain individual
+ * `ValidatorError` instances.
+ *
+ * #### Example:
+ *
+ *     const schema = Schema({ name: { type: String, required: true } });
+ *     const Model = mongoose.model('Test', schema);
+ *     const doc = new Model({});
+ *
+ *     // Top-level error is a ValidationError, **not** a ValidatorError
+ *     const err = doc.validateSync();
+ *     err instanceof mongoose.Error.ValidationError; // true
+ *
+ *     // A ValidationError `err` has 0 or more ValidatorErrors keyed by the
+ *     // path in the `err.errors` property.
+ *     err.errors['name'] instanceof mongoose.Error.ValidatorError;
+ *
+ *     err.errors['name'].kind; // 'required'
+ *     err.errors['name'].path; // 'name'
+ *     err.errors['name'].value; // undefined
+ *
+ * Instances of `ValidatorError` have the following properties:
+ *
+ * - `kind`: The validator's `type`, like `'required'` or `'regexp'`
+ * - `path`: The path that failed validation
+ * - `value`: The value that failed validation
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.ValidatorError = require('./validator');
+
+/**
+ * An instance of this error class will be thrown when you call `save()` after
+ * the document in the database was changed in a potentially unsafe way. See
+ * the [`versionKey` option](https://mongoosejs.com/docs/guide.html#versionKey) for more information.
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.VersionError = require('./version');
+
+/**
+ * An instance of this error class will be thrown when you call `save()` multiple
+ * times on the same document in parallel. See the [FAQ](https://mongoosejs.com/docs/faq.html) for more
+ * information.
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.ParallelSaveError = require('./parallelSave');
+
+/**
+ * Thrown when a model with the given name was already registered on the connection.
+ * See [the FAQ about `OverwriteModelError`](https://mongoosejs.com/docs/faq.html#overwrite-model-error).
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.OverwriteModelError = require('./overwriteModel');
+
+/**
+ * Thrown when you try to access a model that has not been registered yet
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.MissingSchemaError = require('./missingSchema');
+
+/**
+ * Thrown when some documents failed to save when calling `bulkSave()`
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.MongooseBulkSaveIncompleteError = require('./bulkSaveIncompleteError');
+
+/**
+ * Thrown when the MongoDB Node driver can't connect to a valid server
+ * to send an operation to.
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.MongooseServerSelectionError = require('./serverSelection');
+
+/**
+ * An instance of this error will be thrown if you used an array projection
+ * and then modified the array in an unsafe way.
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.DivergentArrayError = require('./divergentArray');
+
+/**
+ * Thrown when your try to pass values to model constructor that
+ * were not specified in schema or change immutable properties when
+ * `strict` mode is `"throw"`
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.StrictModeError = require('./strict');
+
+/**
+ * An instance of this error class will be returned when mongoose failed to
+ * populate with a path that is not existing.
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.StrictPopulateError = require('./strictPopulate');

package/lib/error/invalidSchemaOption.js

@@ -0,0 +1,32 @@
+
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('./mongooseError');
+
+/**
+ * InvalidSchemaOption Error constructor.
+ * @param {String} name
+ * @api private
+ */
+
+class InvalidSchemaOptionError extends MongooseError {
+
+  constructor(name, option) {
+    const msg = `Cannot create use schema for property "${name}" because the schema has the ${option} option enabled.`;
+    super(msg);
+  }
+}
+
+Object.defineProperty(InvalidSchemaOptionError.prototype, 'name', {
+  value: 'InvalidSchemaOptionError'
+});
+
+/*!
+ * exports
+ */
+
+module.exports = InvalidSchemaOptionError;

package/lib/error/messages.js

@@ -0,0 +1,47 @@
+
+/**
+ * The default built-in validator error messages. These may be customized.
+ *
+ *     // customize within each schema or globally like so
+ *     const mongoose = require('mongoose');
+ *     mongoose.Error.messages.String.enum  = "Your custom message for {PATH}.";
+ *
+ * Error messages support basic templating. Mongoose will replace the following strings with the corresponding value.
+ *
+ * - `{PATH}` is replaced with the invalid document path
+ * - `{VALUE}` is replaced with the invalid value
+ * - `{TYPE}` is replaced with the validator type such as "regexp", "min", or "user defined"
+ * - `{MIN}` is replaced with the declared min value for the Number.min validator
+ * - `{MAX}` is replaced with the declared max value for the Number.max validator
+ *
+ * Click the "show code" link below to see all defaults.
+ *
+ * @static
+ * @memberOf MongooseError
+ * @api public
+ */
+
+'use strict';
+
+const msg = module.exports = exports = {};
+
+msg.DocumentNotFoundError = null;
+
+msg.general = {};
+msg.general.default = 'Validator failed for path `{PATH}` with value `{VALUE}`';
+msg.general.required = 'Path `{PATH}` is required.';
+
+msg.Number = {};
+msg.Number.min = 'Path `{PATH}` ({VALUE}) is less than minimum allowed value ({MIN}).';
+msg.Number.max = 'Path `{PATH}` ({VALUE}) is more than maximum allowed value ({MAX}).';
+msg.Number.enum = '`{VALUE}` is not a valid enum value for path `{PATH}`.';
+
+msg.Date = {};
+msg.Date.min = 'Path `{PATH}` ({VALUE}) is before minimum allowed value ({MIN}).';
+msg.Date.max = 'Path `{PATH}` ({VALUE}) is after maximum allowed value ({MAX}).';
+
+msg.String = {};
+msg.String.enum = '`{VALUE}` is not a valid enum value for path `{PATH}`.';
+msg.String.match = 'Path `{PATH}` is invalid ({VALUE}).';
+msg.String.minlength = 'Path `{PATH}` (`{VALUE}`, length {LENGTH}) is shorter than the minimum allowed length ({MINLENGTH}).';
+msg.String.maxlength = 'Path `{PATH}` (`{VALUE}`, length {LENGTH}) is longer than the maximum allowed length ({MAXLENGTH}).';

package/lib/error/missingSchema.js

@@ -0,0 +1,33 @@
+
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('./mongooseError');
+
+/**
+ * MissingSchema Error constructor.
+ * @param {String} name
+ * @api private
+ */
+
+class MissingSchemaError extends MongooseError {
+
+  constructor(name) {
+    const msg = 'Schema hasn\'t been registered for model "' + name + '".\n'
+            + 'Use mongoose.model(name, schema)';
+    super(msg);
+  }
+}
+
+Object.defineProperty(MissingSchemaError.prototype, 'name', {
+  value: 'MissingSchemaError'
+});
+
+/*!
+ * exports
+ */
+
+module.exports = MissingSchemaError;

package/lib/error/mongooseError.js

@@ -0,0 +1,13 @@
+'use strict';
+
+/*!
+ * ignore
+ */
+
+class MongooseError extends Error { }
+
+Object.defineProperty(MongooseError.prototype, 'name', {
+  value: 'MongooseError'
+});
+
+module.exports = MongooseError;

package/lib/error/notFound.js

@@ -0,0 +1,47 @@
+'use strict';
+
+/*!
+ * Module dependencies.
+ */
+
+const MongooseError = require('./mongooseError');
+const util = require('util');
+
+/**
+ * OverwriteModel Error constructor.
+ * @api private
+ */
+
+class DocumentNotFoundError extends MongooseError {
+
+  constructor(filter, model, numAffected, result) {
+    let msg;
+    const messages = MongooseError.messages;
+    if (messages.DocumentNotFoundError != null) {
+      msg = typeof messages.DocumentNotFoundError === 'function' ?
+        messages.DocumentNotFoundError(filter, model) :
+        messages.DocumentNotFoundError;
+    } else {
+      msg = 'No document found for query "' + util.inspect(filter) +
+        '" on model "' + model + '"';
+    }
+
+    super(msg);
+
+    this.result = result;
+    this.numAffected = numAffected;
+    this.filter = filter;
+    // Backwards compat
+    this.query = filter;
+  }
+}
+
+Object.defineProperty(DocumentNotFoundError.prototype, 'name', {
+  value: 'DocumentNotFoundError'
+});
+
+/*!
+ * exports
+ */
+
+module.exports = DocumentNotFoundError;