@depup/mongoose 9.1.3-depup.0

package/lib/schema/objectId.js

@@ -0,0 +1,333 @@
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const SchemaObjectIdOptions = require('../options/schemaObjectIdOptions');
+const SchemaType = require('../schemaType');
+const castObjectId = require('../cast/objectid');
+const createJSONSchemaTypeDefinition = require('../helpers/createJSONSchemaTypeDefinition');
+const getConstructorName = require('../helpers/getConstructorName');
+const oid = require('../types/objectid');
+const isBsonType = require('../helpers/isBsonType');
+const utils = require('../utils');
+
+const CastError = SchemaType.CastError;
+let Document;
+
+/**
+ * ObjectId SchemaType constructor.
+ *
+ * @param {String} key
+ * @param {Object} options
+ * @param {Object} schemaOptions
+ * @param {Schema} parentSchema
+ * @inherits SchemaType
+ * @api public
+ */
+
+function SchemaObjectId(key, options, _schemaOptions, parentSchema) {
+  const isKeyHexStr = typeof key === 'string' && key.length === 24 && /^[a-f0-9]+$/i.test(key);
+  const suppressWarning = options?.suppressWarning;
+  if ((isKeyHexStr || typeof key === 'undefined') && !suppressWarning) {
+    utils.warn('mongoose: To create a new ObjectId please try ' +
+      '`Mongoose.Types.ObjectId` instead of using ' +
+      '`Mongoose.Schema.Types.ObjectId`. Set the `suppressWarning` option if ' +
+      'you\'re trying to create a hex char path in your schema.');
+  }
+  SchemaType.call(this, key, options, 'ObjectId', parentSchema);
+}
+
+/**
+ * This schema type's name, to defend against minifiers that mangle
+ * function names.
+ *
+ * @api public
+ */
+SchemaObjectId.schemaName = 'ObjectId';
+
+SchemaObjectId.defaultOptions = {};
+
+/*!
+ * Inherits from SchemaType.
+ */
+SchemaObjectId.prototype = Object.create(SchemaType.prototype);
+SchemaObjectId.prototype.constructor = SchemaObjectId;
+SchemaObjectId.prototype.OptionsConstructor = SchemaObjectIdOptions;
+
+/**
+ * Attaches a getter for all ObjectId instances
+ *
+ * #### Example:
+ *
+ *     // Always convert to string when getting an ObjectId
+ *     mongoose.ObjectId.get(v => v.toString());
+ *
+ *     const Model = mongoose.model('Test', new Schema({}));
+ *     typeof (new Model({})._id); // 'string'
+ *
+ * @param {Function} getter
+ * @return {this}
+ * @function get
+ * @static
+ * @api public
+ */
+
+SchemaObjectId.get = SchemaType.get;
+
+/**
+ * Sets a default option for all ObjectId instances.
+ *
+ * #### Example:
+ *
+ *     // Make all object ids have option `required` equal to true.
+ *     mongoose.Schema.Types.ObjectId.set('required', true);
+ *
+ *     const Order = mongoose.model('Order', new Schema({ userId: ObjectId }));
+ *     new Order({ }).validateSync().errors.userId.message; // Path `userId` is required.
+ *
+ * @param {String} option The option you'd like to set the value for
+ * @param {Any} value value for option
+ * @return {undefined}
+ * @function set
+ * @static
+ * @api public
+ */
+
+SchemaObjectId.set = SchemaType.set;
+
+SchemaObjectId.setters = [];
+
+/**
+ * Adds an auto-generated ObjectId default if turnOn is true.
+ * @param {Boolean} turnOn auto generated ObjectId defaults
+ * @api public
+ * @return {SchemaType} this
+ */
+
+SchemaObjectId.prototype.auto = function(turnOn) {
+  if (turnOn) {
+    this.default(defaultId);
+    this.set(resetId);
+  }
+
+  return this;
+};
+
+/*!
+ * ignore
+ */
+
+SchemaObjectId._checkRequired = v => isBsonType(v, 'ObjectId');
+
+/*!
+ * ignore
+ */
+
+SchemaObjectId._cast = castObjectId;
+
+/**
+ * Get/set the function used to cast arbitrary values to objectids.
+ *
+ * #### Example:
+ *
+ *     // Make Mongoose only try to cast length 24 strings. By default, any 12
+ *     // char string is a valid ObjectId.
+ *     const original = mongoose.ObjectId.cast();
+ *     mongoose.ObjectId.cast(v => {
+ *       assert.ok(typeof v !== 'string' || v.length === 24);
+ *       return original(v);
+ *     });
+ *
+ *     // Or disable casting entirely
+ *     mongoose.ObjectId.cast(false);
+ *
+ * @param {Function} caster
+ * @return {Function}
+ * @function cast
+ * @static
+ * @api public
+ */
+
+SchemaObjectId.cast = function cast(caster) {
+  if (arguments.length === 0) {
+    return this._cast;
+  }
+  if (caster === false) {
+    caster = this._defaultCaster;
+  }
+  this._cast = caster;
+
+  return this._cast;
+};
+
+/*!
+ * ignore
+ */
+
+SchemaObjectId._defaultCaster = v => {
+  if (!(isBsonType(v, 'ObjectId'))) {
+    throw new Error(v + ' is not an instance of ObjectId');
+  }
+  return v;
+};
+
+/**
+ * Override the function the required validator uses to check whether a string
+ * passes the `required` check.
+ *
+ * #### Example:
+ *
+ *     // Allow empty strings to pass `required` check
+ *     mongoose.Schema.Types.String.checkRequired(v => v != null);
+ *
+ *     const M = mongoose.model({ str: { type: String, required: true } });
+ *     new M({ str: '' }).validateSync(); // `null`, validation passes!
+ *
+ * @param {Function} fn
+ * @return {Function}
+ * @function checkRequired
+ * @static
+ * @api public
+ */
+
+SchemaObjectId.checkRequired = SchemaType.checkRequired;
+
+/**
+ * Check if the given value satisfies a required validator.
+ *
+ * @param {Any} value
+ * @param {Document} doc
+ * @return {Boolean}
+ * @api public
+ */
+
+SchemaObjectId.prototype.checkRequired = function checkRequired(value, doc) {
+  if (SchemaType._isRef(this, value, doc, true)) {
+    return !!value;
+  }
+
+  // `require('util').inherits()` does **not** copy static properties, and
+  // plugins like mongoose-float use `inherits()` for pre-ES6.
+  const _checkRequired = typeof this.constructor.checkRequired === 'function' ?
+    this.constructor.checkRequired() :
+    SchemaObjectId.checkRequired();
+
+  return _checkRequired(value);
+};
+
+/**
+ * Casts to ObjectId
+ *
+ * @param {Object} value
+ * @param {Object} doc
+ * @param {Boolean} init whether this is an initialization cast
+ * @api private
+ */
+
+SchemaObjectId.prototype.cast = function(value, doc, init, prev, options) {
+  if (!(isBsonType(value, 'ObjectId')) && SchemaType._isRef(this, value, doc, init)) {
+    // wait! we may need to cast this to a document
+    if ((getConstructorName(value) || '').toLowerCase() === 'objectid') {
+      return new oid(value.toHexString());
+    }
+
+    if (value == null || utils.isNonBuiltinObject(value)) {
+      return this._castRef(value, doc, init, options);
+    }
+  }
+
+  let castObjectId;
+  if (typeof this._castFunction === 'function') {
+    castObjectId = this._castFunction;
+  } else if (typeof this.constructor.cast === 'function') {
+    castObjectId = this.constructor.cast();
+  } else {
+    castObjectId = SchemaObjectId.cast();
+  }
+
+  try {
+    return castObjectId(value);
+  } catch (error) {
+    throw new CastError('ObjectId', value, this.path, error, this);
+  }
+};
+
+/*!
+ * ignore
+ */
+
+function handleSingle(val) {
+  return this.cast(val);
+}
+
+const $conditionalHandlers = {
+  ...SchemaType.prototype.$conditionalHandlers,
+  $gt: handleSingle,
+  $gte: handleSingle,
+  $lt: handleSingle,
+  $lte: handleSingle
+};
+
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$in` is the function Mongoose calls to cast `$in` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @memberOf SchemaObjectId
+ * @instance
+ * @api public
+ */
+
+Object.defineProperty(SchemaObjectId.prototype, '$conditionalHandlers', {
+  enumerable: false,
+  value: $conditionalHandlers
+});
+
+/*!
+ * ignore
+ */
+
+function defaultId() {
+  return new oid();
+}
+
+defaultId.$runBeforeSetters = true;
+
+function resetId(v) {
+  Document || (Document = require('../document'));
+
+  if (this instanceof Document) {
+    if (v === void 0) {
+      const _v = new oid();
+      return _v;
+    }
+  }
+
+  return v;
+}
+
+/**
+ * Returns this schema type's representation in a JSON schema.
+ *
+ * @param [options]
+ * @param [options.useBsonType=false] If true, return a representation with `bsonType` for use with MongoDB's `$jsonSchema`.
+ * @returns {Object} JSON schema properties
+ * @api public
+ */
+
+SchemaObjectId.prototype.toJSONSchema = function toJSONSchema(options) {
+  const isRequired = (this.options.required && typeof this.options.required !== 'function') || this.path === '_id';
+  return createJSONSchemaTypeDefinition('string', 'objectId', options?.useBsonType, isRequired);
+};
+
+SchemaObjectId.prototype.autoEncryptionType = function autoEncryptionType() {
+  return 'objectId';
+};
+
+/*!
+ * Module exports.
+ */
+
+module.exports = SchemaObjectId;

package/lib/schema/operators/bitwise.js

@@ -0,0 +1,38 @@
+/*!
+ * Module requirements.
+ */
+
+'use strict';
+
+const CastError = require('../../error/cast');
+
+/*!
+ * ignore
+ */
+
+function handleBitwiseOperator(val) {
+  const _this = this;
+  if (Array.isArray(val)) {
+    return val.map(function(v) {
+      return _castNumber(_this.path, v);
+    });
+  } else if (Buffer.isBuffer(val)) {
+    return val;
+  }
+  // Assume trying to cast to number
+  return _castNumber(_this.path, val);
+}
+
+/*!
+ * ignore
+ */
+
+function _castNumber(path, num) {
+  const v = Number(num);
+  if (isNaN(v)) {
+    throw new CastError('number', num, path);
+  }
+  return v;
+}
+
+module.exports = handleBitwiseOperator;

package/lib/schema/operators/exists.js

@@ -0,0 +1,12 @@
+'use strict';
+
+const castBoolean = require('../../cast/boolean');
+
+/*!
+ * ignore
+ */
+
+module.exports = function(val) {
+  const path = this?.path ?? null;
+  return castBoolean(val, path);
+};

package/lib/schema/operators/geospatial.js

@@ -0,0 +1,107 @@
+/*!
+ * Module requirements.
+ */
+
+'use strict';
+
+const castArraysOfNumbers = require('./helpers').castArraysOfNumbers;
+const castToNumber = require('./helpers').castToNumber;
+
+/*!
+ * ignore
+ */
+
+exports.cast$geoIntersects = cast$geoIntersects;
+exports.cast$near = cast$near;
+exports.cast$within = cast$within;
+
+function cast$near(val) {
+  const SchemaArray = require('../array');
+
+  if (Array.isArray(val)) {
+    castArraysOfNumbers(val, this);
+    return val;
+  }
+
+  _castMinMaxDistance(this, val);
+
+  if (val?.$geometry) {
+    return cast$geometry(val, this);
+  }
+
+  if (!Array.isArray(val)) {
+    throw new TypeError('$near must be either an array or an object ' +
+      'with a $geometry property');
+  }
+
+  return SchemaArray.prototype.castForQuery.call(this, null, val);
+}
+
+function cast$geometry(val, self) {
+  switch (val.$geometry.type) {
+    case 'Polygon':
+    case 'LineString':
+    case 'Point':
+      castArraysOfNumbers(val.$geometry.coordinates, self);
+      break;
+    default:
+      // ignore unknowns
+      break;
+  }
+
+  _castMinMaxDistance(self, val);
+
+  return val;
+}
+
+function cast$within(val) {
+  _castMinMaxDistance(this, val);
+
+  if (val.$box || val.$polygon) {
+    const type = val.$box ? '$box' : '$polygon';
+    val[type].forEach(arr => {
+      if (!Array.isArray(arr)) {
+        const msg = 'Invalid $within $box argument. '
+            + 'Expected an array, received ' + arr;
+        throw new TypeError(msg);
+      }
+      arr.forEach((v, i) => {
+        arr[i] = castToNumber.call(this, v);
+      });
+    });
+  } else if (val.$center || val.$centerSphere) {
+    const type = val.$center ? '$center' : '$centerSphere';
+    val[type].forEach((item, i) => {
+      if (Array.isArray(item)) {
+        item.forEach((v, j) => {
+          item[j] = castToNumber.call(this, v);
+        });
+      } else {
+        val[type][i] = castToNumber.call(this, item);
+      }
+    });
+  } else if (val.$geometry) {
+    cast$geometry(val, this);
+  }
+
+  return val;
+}
+
+function cast$geoIntersects(val) {
+  const geo = val.$geometry;
+  if (!geo) {
+    return;
+  }
+
+  cast$geometry(val, this);
+  return val;
+}
+
+function _castMinMaxDistance(self, val) {
+  if (val.$maxDistance) {
+    val.$maxDistance = castToNumber.call(self, val.$maxDistance);
+  }
+  if (val.$minDistance) {
+    val.$minDistance = castToNumber.call(self, val.$minDistance);
+  }
+}

package/lib/schema/operators/helpers.js

@@ -0,0 +1,32 @@
+'use strict';
+
+/*!
+ * Module requirements.
+ */
+
+const SchemaNumber = require('../number');
+
+/*!
+ * ignore
+ */
+
+exports.castToNumber = castToNumber;
+exports.castArraysOfNumbers = castArraysOfNumbers;
+
+/*!
+ * ignore
+ */
+
+function castToNumber(val) {
+  return SchemaNumber.cast()(val);
+}
+
+function castArraysOfNumbers(arr, self) {
+  arr.forEach(function(v, i) {
+    if (Array.isArray(v)) {
+      castArraysOfNumbers(v, self);
+    } else {
+      arr[i] = castToNumber.call(self, v);
+    }
+  });
+}

package/lib/schema/operators/text.js

@@ -0,0 +1,39 @@
+'use strict';
+
+const CastError = require('../../error/cast');
+const castBoolean = require('../../cast/boolean');
+const castString = require('../../cast/string');
+
+/**
+ * Casts val to an object suitable for `$text`. Throws an error if the object
+ * can't be casted.
+ *
+ * @param {Any} val value to cast
+ * @param {String} [path] path to associate with any errors that occured
+ * @return {Object} casted object
+ * @see https://www.mongodb.com/docs/manual/reference/operator/query/text/
+ * @api private
+ */
+
+module.exports = function castTextSearch(val, path) {
+  if (val == null || typeof val !== 'object') {
+    throw new CastError('$text', val, path);
+  }
+
+  if (val.$search != null) {
+    val.$search = castString(val.$search, path + '.$search');
+  }
+  if (val.$language != null) {
+    val.$language = castString(val.$language, path + '.$language');
+  }
+  if (val.$caseSensitive != null) {
+    val.$caseSensitive = castBoolean(val.$caseSensitive,
+      path + '.$caseSensitive');
+  }
+  if (val.$diacriticSensitive != null) {
+    val.$diacriticSensitive = castBoolean(val.$diacriticSensitive,
+      path + '.$diacriticSensitive');
+  }
+
+  return val;
+};

package/lib/schema/operators/type.js

@@ -0,0 +1,20 @@
+'use strict';
+
+/*!
+ * ignore
+ */
+
+module.exports = function(val) {
+  if (Array.isArray(val)) {
+    if (!val.every(v => typeof v === 'number' || typeof v === 'string')) {
+      throw new Error('$type array values must be strings or numbers');
+    }
+    return val;
+  }
+
+  if (typeof val !== 'number' && typeof val !== 'string') {
+    throw new Error('$type parameter must be number, string, or array of numbers and strings');
+  }
+
+  return val;
+};