@depup/mongoose 9.1.3-depup.0

package/lib/types/arraySubdocument.js

@@ -0,0 +1,207 @@
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const EventEmitter = require('events').EventEmitter;
+const Subdocument = require('./subdocument');
+const utils = require('../utils');
+
+const documentArrayParent = require('../helpers/symbols').documentArrayParent;
+
+/**
+ * A constructor.
+ *
+ * @param {Object} obj js object returned from the db
+ * @param {MongooseDocumentArray} parentArr the parent array of this document
+ * @param {Boolean} skipId
+ * @param {Object} fields
+ * @param {Number} index
+ * @inherits Document
+ * @api private
+ */
+
+function ArraySubdocument(obj, parentArr, skipId, fields, index) {
+  if (utils.isMongooseDocumentArray(parentArr)) {
+    this.__parentArray = parentArr;
+    this[documentArrayParent] = parentArr.$parent();
+  } else {
+    this.__parentArray = undefined;
+    this[documentArrayParent] = undefined;
+  }
+  this.$setIndex(index);
+  this.$__parent = this[documentArrayParent];
+
+  let options;
+  if (typeof skipId === 'object' && skipId != null) {
+    options = { isNew: true, ...skipId };
+    skipId = undefined;
+  } else {
+    options = { isNew: true };
+  }
+
+  Subdocument.call(this, obj, fields, this[documentArrayParent], options);
+}
+
+/*!
+ * Inherit from Subdocument
+ */
+ArraySubdocument.prototype = Object.create(Subdocument.prototype);
+ArraySubdocument.prototype.constructor = ArraySubdocument;
+
+Object.defineProperty(ArraySubdocument.prototype, '$isSingleNested', {
+  configurable: false,
+  writable: false,
+  value: false
+});
+
+Object.defineProperty(ArraySubdocument.prototype, '$isDocumentArrayElement', {
+  configurable: false,
+  writable: false,
+  value: true
+});
+
+for (const i in EventEmitter.prototype) {
+  ArraySubdocument[i] = EventEmitter.prototype[i];
+}
+
+/*!
+ * ignore
+ */
+
+ArraySubdocument.prototype.$setIndex = function(index) {
+  this.__index = index;
+
+  if (this.$__?.validationError != null) {
+    const keys = Object.keys(this.$__.validationError.errors);
+    for (const key of keys) {
+      this.invalidate(key, this.$__.validationError.errors[key]);
+    }
+  }
+};
+
+/*!
+ * ignore
+ */
+
+ArraySubdocument.prototype.populate = function() {
+  throw new Error('Mongoose does not support calling populate() on nested ' +
+    'docs. Instead of `doc.arr[0].populate("path")`, use ' +
+    '`doc.populate("arr.0.path")`');
+};
+
+/*!
+ * ignore
+ */
+
+ArraySubdocument.prototype.$__removeFromParent = function() {
+  const _id = this._doc._id;
+  if (!_id) {
+    throw new Error('For your own good, Mongoose does not know ' +
+      'how to remove an ArraySubdocument that has no _id');
+  }
+  this.__parentArray.pull({ _id: _id });
+};
+
+/**
+ * Returns the full path to this document. If optional `path` is passed, it is appended to the full path.
+ *
+ * @param {String} [path]
+ * @param {Boolean} [skipIndex] Skip adding the array index. For example `arr.foo` instead of `arr.0.foo`.
+ * @return {String}
+ * @api private
+ * @method $__fullPath
+ * @memberOf ArraySubdocument
+ * @instance
+ */
+
+ArraySubdocument.prototype.$__fullPath = function(path, skipIndex) {
+  if (this.__index == null) {
+    return null;
+  }
+  if (!this.$__.fullPath) {
+    this.ownerDocument();
+  }
+
+  if (skipIndex) {
+    return path ?
+      this.$__.fullPath + '.' + path :
+      this.$__.fullPath;
+  }
+
+  return path ?
+    this.$__.fullPath + '.' + this.__index + '.' + path :
+    this.$__.fullPath + '.' + this.__index;
+};
+
+/**
+ * Given a path relative to this document, return the path relative
+ * to the top-level document.
+ * @method $__pathRelativeToParent
+ * @memberOf ArraySubdocument
+ * @instance
+ * @api private
+ */
+
+ArraySubdocument.prototype.$__pathRelativeToParent = function(path, skipIndex) {
+  if (this.__index == null || !this.__parentArray?.$path) {
+    return null;
+  }
+  if (skipIndex) {
+    return path == null ? this.__parentArray.$path() : this.__parentArray.$path() + '.' + path;
+  }
+  if (path == null) {
+    return this.__parentArray.$path() + '.' + this.__index;
+  }
+  return this.__parentArray.$path() + '.' + this.__index + '.' + path;
+};
+
+/**
+ * Returns this sub-documents parent document.
+ * @method $parent
+ * @memberOf ArraySubdocument
+ * @instance
+ * @api public
+ */
+
+ArraySubdocument.prototype.$parent = function() {
+  return this[documentArrayParent];
+};
+
+/*!
+ * Sets this sub-documents parent document.
+ *
+ * @api private
+ */
+
+ArraySubdocument.prototype.$__setParent = function $__setParent(parent) {
+  this[documentArrayParent] = parent;
+};
+
+/**
+ * Returns this subdocument's parent array.
+ *
+ * #### Example:
+ *
+ *     const Test = mongoose.model('Test', new Schema({
+ *       docArr: [{ name: String }]
+ *     }));
+ *     const doc = new Test({ docArr: [{ name: 'test subdoc' }] });
+ *
+ *     doc.docArr[0].parentArray() === doc.docArr; // true
+ *
+ * @api public
+ * @method parentArray
+ * @returns DocumentArray
+ */
+
+ArraySubdocument.prototype.parentArray = function() {
+  return this.__parentArray;
+};
+
+/*!
+ * Module exports.
+ */
+
+module.exports = ArraySubdocument;

package/lib/types/buffer.js

@@ -0,0 +1,294 @@
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const Binary = require('mongodb/lib/bson').Binary;
+const UUID = require('mongodb/lib/bson').UUID;
+const utils = require('../utils');
+
+/**
+ * Mongoose Buffer constructor.
+ *
+ * Values always have to be passed to the constructor to initialize.
+ *
+ * @param {Buffer} value
+ * @param {String} encode
+ * @param {Number} offset
+ * @api private
+ * @inherits Buffer https://nodejs.org/api/buffer.html
+ * @see https://bit.ly/f6CnZU
+ */
+
+function MongooseBuffer(value, encode, offset) {
+  let val = value;
+  if (value == null) {
+    val = 0;
+  }
+
+  let encoding;
+  let path;
+  let doc;
+
+  if (Array.isArray(encode)) {
+    // internal casting
+    path = encode[0];
+    doc = encode[1];
+  } else {
+    encoding = encode;
+  }
+
+  let buf;
+  if (typeof val === 'number' || val instanceof Number) {
+    buf = Buffer.alloc(val);
+  } else { // string, array or object { type: 'Buffer', data: [...] }
+    buf = Buffer.from(val, encoding, offset);
+  }
+  utils.decorate(buf, MongooseBuffer.mixin);
+  buf.isMongooseBuffer = true;
+
+  // make sure these internal props don't show up in Object.keys()
+  buf[MongooseBuffer.pathSymbol] = path;
+  buf[parentSymbol] = doc;
+
+  buf._subtype = 0;
+  return buf;
+}
+
+const pathSymbol = Symbol.for('mongoose#Buffer#_path');
+const parentSymbol = Symbol.for('mongoose#Buffer#_parent');
+MongooseBuffer.pathSymbol = pathSymbol;
+
+/*!
+ * Inherit from Buffer.
+ */
+
+MongooseBuffer.mixin = {
+
+  /**
+   * Default subtype for the Binary representing this Buffer
+   *
+   * @api private
+   * @property _subtype
+   * @memberOf MongooseBuffer.mixin
+   * @static
+   */
+
+  _subtype: undefined,
+
+  /**
+   * Marks this buffer as modified.
+   *
+   * @api private
+   * @method _markModified
+   * @memberOf MongooseBuffer.mixin
+   * @static
+   */
+
+  _markModified: function() {
+    const parent = this[parentSymbol];
+
+    if (parent) {
+      parent.markModified(this[MongooseBuffer.pathSymbol]);
+    }
+    return this;
+  },
+
+  /**
+   * Writes the buffer.
+   *
+   * @api public
+   * @method write
+   * @memberOf MongooseBuffer.mixin
+   * @static
+   */
+
+  write: function() {
+    const written = Buffer.prototype.write.apply(this, arguments);
+
+    if (written > 0) {
+      this._markModified();
+    }
+
+    return written;
+  },
+
+  /**
+   * Copies the buffer.
+   *
+   * #### Note:
+   *
+   * `Buffer#copy` does not mark `target` as modified so you must copy from a `MongooseBuffer` for it to work as expected. This is a work around since `copy` modifies the target, not this.
+   *
+   * @return {Number} The number of bytes copied.
+   * @param {Buffer} target
+   * @method copy
+   * @memberOf MongooseBuffer.mixin
+   * @static
+   */
+
+  copy: function(target) {
+    const ret = Buffer.prototype.copy.apply(this, arguments);
+
+    if (target?.isMongooseBuffer) {
+      target._markModified();
+    }
+
+    return ret;
+  }
+};
+
+/*!
+ * Compile other Buffer methods marking this buffer as modified.
+ */
+
+utils.each(
+  [
+    // node < 0.5
+    'writeUInt8', 'writeUInt16', 'writeUInt32', 'writeInt8', 'writeInt16', 'writeInt32',
+    'writeFloat', 'writeDouble', 'fill',
+    'utf8Write', 'binaryWrite', 'asciiWrite', 'set',
+
+    // node >= 0.5
+    'writeUInt16LE', 'writeUInt16BE', 'writeUInt32LE', 'writeUInt32BE',
+    'writeInt16LE', 'writeInt16BE', 'writeInt32LE', 'writeInt32BE', 'writeFloatLE', 'writeFloatBE', 'writeDoubleLE', 'writeDoubleBE']
+  , function(method) {
+    if (!Buffer.prototype[method]) {
+      return;
+    }
+    MongooseBuffer.mixin[method] = function() {
+      const ret = Buffer.prototype[method].apply(this, arguments);
+      this._markModified();
+      return ret;
+    };
+  });
+
+/**
+ * Converts this buffer to its Binary type representation.
+ *
+ * #### SubTypes:
+ *
+ *     const mongodb = require('mongodb')
+ *     mongodb.BSON.BSON_BINARY_SUBTYPE_DEFAULT
+ *     mongodb.BSON.BSON_BINARY_SUBTYPE_FUNCTION
+ *     mongodb.BSON.BSON_BINARY_SUBTYPE_BYTE_ARRAY
+ *     mongodb.BSON.BSON_BINARY_SUBTYPE_UUID
+ *     mongodb.BSON.BSON_BINARY_SUBTYPE_MD5
+ *     mongodb.BSON.BSON_BINARY_SUBTYPE_USER_DEFINED
+ *     doc.buffer.toObject(mongodb.BSON.BSON_BINARY_SUBTYPE_USER_DEFINED);
+ *
+ * @see bsonspec https://bsonspec.org/#/specification
+ * @param {Hex} [subtype]
+ * @return {Binary}
+ * @api public
+ * @method toObject
+ * @memberOf MongooseBuffer
+ */
+
+MongooseBuffer.mixin.toObject = function(options) {
+  const subtype = typeof options === 'number'
+    ? options
+    : (this._subtype || 0);
+  return new Binary(Buffer.from(this), subtype);
+};
+
+MongooseBuffer.mixin.$toObject = MongooseBuffer.mixin.toObject;
+
+/**
+ * Converts this buffer for storage in MongoDB, including subtype
+ *
+ * @return {Binary}
+ * @api public
+ * @method toBSON
+ * @memberOf MongooseBuffer
+ */
+
+MongooseBuffer.mixin.toBSON = function() {
+  return new Binary(this, this._subtype || 0);
+};
+
+/**
+ * Converts this buffer to a UUID. Throws an error if subtype is not 4.
+ *
+ * @return {UUID}
+ * @api public
+ * @method toUUID
+ * @memberOf MongooseBuffer
+ */
+
+MongooseBuffer.mixin.toUUID = function() {
+  if (this._subtype !== 4) {
+    throw new Error('Cannot convert a Buffer with subtype ' + this._subtype + ' to a UUID');
+  }
+  return new UUID(this);
+};
+
+/**
+ * Determines if this buffer is equals to `other` buffer
+ *
+ * @param {Buffer} other
+ * @return {Boolean}
+ * @method equals
+ * @memberOf MongooseBuffer
+ */
+
+MongooseBuffer.mixin.equals = function(other) {
+  if (!Buffer.isBuffer(other)) {
+    return false;
+  }
+
+  if (this.length !== other.length) {
+    return false;
+  }
+
+  for (let i = 0; i < this.length; ++i) {
+    if (this[i] !== other[i]) {
+      return false;
+    }
+  }
+
+  return true;
+};
+
+/**
+ * Sets the subtype option and marks the buffer modified.
+ *
+ * #### SubTypes:
+ *
+ *     const bson = require('bson')
+ *     bson.BSON_BINARY_SUBTYPE_DEFAULT
+ *     bson.BSON_BINARY_SUBTYPE_FUNCTION
+ *     bson.BSON_BINARY_SUBTYPE_BYTE_ARRAY
+ *     bson.BSON_BINARY_SUBTYPE_UUID
+ *     bson.BSON_BINARY_SUBTYPE_MD5
+ *     bson.BSON_BINARY_SUBTYPE_USER_DEFINED
+ *
+ *     doc.buffer.subtype(bson.BSON_BINARY_SUBTYPE_UUID);
+ *
+ * @see bsonspec https://bsonspec.org/#/specification
+ * @param {Hex} subtype
+ * @api public
+ * @method subtype
+ * @memberOf MongooseBuffer
+ */
+
+MongooseBuffer.mixin.subtype = function(subtype) {
+  if (typeof subtype !== 'number') {
+    throw new TypeError('Invalid subtype. Expected a number');
+  }
+
+  if (this._subtype !== subtype) {
+    this._markModified();
+  }
+
+  this._subtype = subtype;
+};
+
+/*!
+ * Module exports.
+ */
+
+MongooseBuffer.Binary = Binary;
+
+module.exports = MongooseBuffer;

package/lib/types/decimal128.js

@@ -0,0 +1,13 @@
+/**
+ * Decimal128 type constructor
+ *
+ * #### Example:
+ *
+ *     const id = new mongoose.Types.Decimal128('3.1415');
+ *
+ * @constructor Decimal128
+ */
+
+'use strict';
+
+module.exports = require('mongodb/lib/bson').Decimal128;

package/lib/types/documentArray/index.js

@@ -0,0 +1,113 @@
+'use strict';
+
+/*!
+ * Module dependencies.
+ */
+
+const ArrayMethods = require('../array/methods');
+const DocumentArrayMethods = require('./methods');
+
+const arrayAtomicsSymbol = require('../../helpers/symbols').arrayAtomicsSymbol;
+const arrayAtomicsBackupSymbol = require('../../helpers/symbols').arrayAtomicsBackupSymbol;
+const arrayParentSymbol = require('../../helpers/symbols').arrayParentSymbol;
+const arrayPathSymbol = require('../../helpers/symbols').arrayPathSymbol;
+const arraySchemaSymbol = require('../../helpers/symbols').arraySchemaSymbol;
+
+const _basePush = Array.prototype.push;
+const numberRE = /^\d+$/;
+/**
+ * DocumentArray constructor
+ *
+ * @param {Array} values
+ * @param {String} path the path to this array
+ * @param {Document} doc parent document
+ * @api private
+ * @return {MongooseDocumentArray}
+ * @inherits MongooseArray
+ * @see https://bit.ly/f6CnZU
+ */
+
+function MongooseDocumentArray(values, path, doc, schematype) {
+  const __array = [];
+
+  const internals = {
+    [arrayAtomicsSymbol]: {},
+    [arrayAtomicsBackupSymbol]: void 0,
+    [arrayPathSymbol]: path,
+    [arraySchemaSymbol]: void 0,
+    [arrayParentSymbol]: void 0
+  };
+
+  if (Array.isArray(values)) {
+    if (values[arrayPathSymbol] === path &&
+        values[arrayParentSymbol] === doc) {
+      internals[arrayAtomicsSymbol] = Object.assign({}, values[arrayAtomicsSymbol]);
+    }
+    values.forEach(v => {
+      _basePush.call(__array, v);
+    });
+  }
+  internals[arrayPathSymbol] = path;
+  internals.__array = __array;
+
+  if (doc?.$__) {
+    internals[arrayParentSymbol] = doc;
+    internals[arraySchemaSymbol] = doc.$__schema.path(path);
+
+    // `schema.path()` doesn't drill into nested arrays properly yet, see
+    // gh-6398, gh-6602. This is a workaround because nested arrays are
+    // always plain non-document arrays, so once you get to a document array
+    // nesting is done. Matryoshka code.
+    while (internals[arraySchemaSymbol] != null &&
+        internals[arraySchemaSymbol].$isMongooseArray &&
+        !internals[arraySchemaSymbol].$isMongooseDocumentArray) {
+      internals[arraySchemaSymbol] = internals[arraySchemaSymbol].embeddedSchemaType;
+    }
+  }
+
+  const proxy = new Proxy(__array, {
+    get: function(target, prop) {
+      if (prop === 'isMongooseArray' ||
+          prop === 'isMongooseArrayProxy' ||
+          prop === 'isMongooseDocumentArray' ||
+          prop === 'isMongooseDocumentArrayProxy') {
+        return true;
+      }
+      if (Object.hasOwn(internals, prop)) {
+        return internals[prop];
+      }
+      if (Object.hasOwn(DocumentArrayMethods, prop)) {
+        return DocumentArrayMethods[prop];
+      }
+      if (schematype?.virtuals && Object.hasOwn(schematype.virtuals, prop)) {
+        return schematype.virtuals[prop].applyGetters(undefined, target);
+      }
+      if (Object.hasOwn(ArrayMethods, prop)) {
+        return ArrayMethods[prop];
+      }
+
+      return __array[prop];
+    },
+    set: function(target, prop, value) {
+      if (typeof prop === 'string' && numberRE.test(prop)) {
+        DocumentArrayMethods.set.call(proxy, prop, value, false);
+      } else if (Object.hasOwn(internals, prop)) {
+        internals[prop] = value;
+      } else if (schematype?.virtuals && Object.hasOwn(schematype.virtuals, prop)) {
+        schematype.virtuals[prop].applySetters(value, target);
+      } else {
+        __array[prop] = value;
+      }
+
+      return true;
+    }
+  });
+
+  return proxy;
+}
+
+/*!
+ * Module exports.
+ */
+
+module.exports = MongooseDocumentArray;

package/lib/types/documentArray/isMongooseDocumentArray.js

@@ -0,0 +1,5 @@
+'use strict';
+
+exports.isMongooseDocumentArray = function(mongooseDocumentArray) {
+  return Array.isArray(mongooseDocumentArray) && mongooseDocumentArray.isMongooseDocumentArray;
+};