@depup/mongoose 9.1.3-depup.0

package/lib/options/schemaSubdocumentOptions.js

@@ -0,0 +1,66 @@
+'use strict';
+
+const SchemaTypeOptions = require('./schemaTypeOptions');
+
+/**
+ * The options defined on a single nested schematype.
+ *
+ * #### Example:
+ *
+ *     const schema = Schema({ child: Schema({ name: String }) });
+ *     schema.path('child').options; // SchemaSubdocumentOptions instance
+ *
+ * @api public
+ * @inherits SchemaTypeOptions
+ * @constructor SchemaSubdocumentOptions
+ */
+
+class SchemaSubdocumentOptions extends SchemaTypeOptions {}
+
+const opts = require('./propertyOptions');
+
+/**
+ * If set, overwrites the child schema's `_id` option.
+ *
+ * #### Example:
+ *
+ *     const childSchema = Schema({ name: String });
+ *     const parentSchema = Schema({
+ *       child: { type: childSchema, _id: false }
+ *     });
+ *     parentSchema.path('child').schema.options._id; // false
+ *
+ * @api public
+ * @property _id
+ * @memberOf SchemaSubdocumentOptions
+ * @type {Function|string}
+ * @instance
+ */
+
+Object.defineProperty(SchemaSubdocumentOptions.prototype, '_id', opts);
+
+/**
+ * If set, overwrites the child schema's `minimize` option. In addition, configures whether the entire
+ * subdocument can be minimized out.
+ *
+ * #### Example:
+ *
+ *     const childSchema = Schema({ name: String });
+ *     const parentSchema = Schema({
+ *       child: { type: childSchema, minimize: false }
+ *     });
+ *     const ParentModel = mongoose.model('Parent', parentSchema);
+ *     // Saves `{ child: {} }` to the db. Without `minimize: false`, Mongoose would remove the empty
+ *     // object and save `{}` to the db.
+ *     await ParentModel.create({ child: {} });
+ *
+ * @api public
+ * @property minimize
+ * @memberOf SchemaSubdocumentOptions
+ * @type {Function|string}
+ * @instance
+ */
+
+Object.defineProperty(SchemaSubdocumentOptions.prototype, 'minimize', opts);
+
+module.exports = SchemaSubdocumentOptions;

package/lib/options/schemaTypeOptions.js

@@ -0,0 +1,244 @@
+'use strict';
+
+const clone = require('../helpers/clone');
+
+/**
+ * The options defined on a schematype.
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({ name: String });
+ *     schema.path('name').options instanceof mongoose.SchemaTypeOptions; // true
+ *
+ * @api public
+ * @constructor SchemaTypeOptions
+ */
+
+class SchemaTypeOptions {
+  constructor(obj) {
+    if (obj == null) {
+      return this;
+    }
+    Object.assign(this, clone(obj));
+  }
+}
+
+const opts = require('./propertyOptions');
+
+/**
+ * The type to cast this path to.
+ *
+ * @api public
+ * @property type
+ * @memberOf SchemaTypeOptions
+ * @type {Function|String|Object}
+ * @instance
+ */
+
+Object.defineProperty(SchemaTypeOptions.prototype, 'type', opts);
+
+/**
+ * Function or object describing how to validate this schematype.
+ *
+ * @api public
+ * @property validate
+ * @memberOf SchemaTypeOptions
+ * @type {Function|Object}
+ * @instance
+ */
+
+Object.defineProperty(SchemaTypeOptions.prototype, 'validate', opts);
+
+/**
+ * Allows overriding casting logic for this individual path. If a string, the
+ * given string overwrites Mongoose's default cast error message.
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({
+ *       num: {
+ *         type: Number,
+ *         cast: '{VALUE} is not a valid number'
+ *       }
+ *     });
+ *
+ *     // Throws 'CastError: "bad" is not a valid number'
+ *     schema.path('num').cast('bad');
+ *
+ *     const Model = mongoose.model('Test', schema);
+ *     const doc = new Model({ num: 'fail' });
+ *     const err = doc.validateSync();
+ *
+ *     err.errors['num']; // 'CastError: "fail" is not a valid number'
+ *
+ * @api public
+ * @property cast
+ * @memberOf SchemaTypeOptions
+ * @type {String}
+ * @instance
+ */
+
+Object.defineProperty(SchemaTypeOptions.prototype, 'cast', opts);
+
+/**
+ * If true, attach a required validator to this path, which ensures this path
+ * cannot be set to a nullish value. If a function, Mongoose calls the
+ * function and only checks for nullish values if the function returns a truthy value.
+ *
+ * @api public
+ * @property required
+ * @memberOf SchemaTypeOptions
+ * @type {Function|Boolean}
+ * @instance
+ */
+
+Object.defineProperty(SchemaTypeOptions.prototype, 'required', opts);
+
+/**
+ * The default value for this path. If a function, Mongoose executes the function
+ * and uses the return value as the default.
+ *
+ * @api public
+ * @property default
+ * @memberOf SchemaTypeOptions
+ * @type {Function|Any}
+ * @instance
+ */
+
+Object.defineProperty(SchemaTypeOptions.prototype, 'default', opts);
+
+/**
+ * The model that `populate()` should use if populating this path.
+ *
+ * @api public
+ * @property ref
+ * @memberOf SchemaTypeOptions
+ * @type {Function|String}
+ * @instance
+ */
+
+Object.defineProperty(SchemaTypeOptions.prototype, 'ref', opts);
+
+/**
+ * The path in the document that `populate()` should use to find the model
+ * to use.
+ *
+ * @api public
+ * @property ref
+ * @memberOf SchemaTypeOptions
+ * @type {Function|String}
+ * @instance
+ */
+
+Object.defineProperty(SchemaTypeOptions.prototype, 'refPath', opts);
+
+/**
+ * Whether to include or exclude this path by default when loading documents
+ * using `find()`, `findOne()`, etc.
+ *
+ * @api public
+ * @property select
+ * @memberOf SchemaTypeOptions
+ * @type {Boolean|Number}
+ * @instance
+ */
+
+Object.defineProperty(SchemaTypeOptions.prototype, 'select', opts);
+
+/**
+ * If [truthy](https://masteringjs.io/tutorials/fundamentals/truthy), Mongoose will
+ * build an index on this path when the model is compiled.
+ *
+ * @api public
+ * @property index
+ * @memberOf SchemaTypeOptions
+ * @type {Boolean|Number|Object}
+ * @instance
+ */
+
+Object.defineProperty(SchemaTypeOptions.prototype, 'index', opts);
+
+/**
+ * If [truthy](https://masteringjs.io/tutorials/fundamentals/truthy), Mongoose
+ * will build a unique index on this path when the
+ * model is compiled. [The `unique` option is **not** a validator](https://mongoosejs.com/docs/validation.html#the-unique-option-is-not-a-validator).
+ *
+ * @api public
+ * @property unique
+ * @memberOf SchemaTypeOptions
+ * @type {Boolean|Number}
+ * @instance
+ */
+
+Object.defineProperty(SchemaTypeOptions.prototype, 'unique', opts);
+
+/**
+ * If [truthy](https://masteringjs.io/tutorials/fundamentals/truthy), Mongoose will
+ * disallow changes to this path once the document
+ * is saved to the database for the first time. Read more about [immutability in Mongoose here](https://thecodebarbarian.com/whats-new-in-mongoose-5-6-immutable-properties.html).
+ *
+ * @api public
+ * @property immutable
+ * @memberOf SchemaTypeOptions
+ * @type {Function|Boolean}
+ * @instance
+ */
+
+Object.defineProperty(SchemaTypeOptions.prototype, 'immutable', opts);
+
+/**
+ * If [truthy](https://masteringjs.io/tutorials/fundamentals/truthy), Mongoose will
+ * build a sparse index on this path.
+ *
+ * @api public
+ * @property sparse
+ * @memberOf SchemaTypeOptions
+ * @type {Boolean|Number}
+ * @instance
+ */
+
+Object.defineProperty(SchemaTypeOptions.prototype, 'sparse', opts);
+
+/**
+ * If [truthy](https://masteringjs.io/tutorials/fundamentals/truthy), Mongoose
+ * will build a text index on this path.
+ *
+ * @api public
+ * @property text
+ * @memberOf SchemaTypeOptions
+ * @type {Boolean|Number|Object}
+ * @instance
+ */
+
+Object.defineProperty(SchemaTypeOptions.prototype, 'text', opts);
+
+/**
+ * Define a transform function for this individual schema type.
+ * Only called when calling `toJSON()` or `toObject()`.
+ *
+ * #### Example:
+ *
+ *     const schema = Schema({
+ *       myDate: {
+ *         type: Date,
+ *         transform: v => v.getFullYear()
+ *       }
+ *     });
+ *     const Model = mongoose.model('Test', schema);
+ *
+ *     const doc = new Model({ myDate: new Date('2019/06/01') });
+ *     doc.myDate instanceof Date; // true
+ *
+ *     const res = doc.toObject({ transform: true });
+ *     res.myDate; // 2019
+ *
+ * @api public
+ * @property transform
+ * @memberOf SchemaTypeOptions
+ * @type {Function}
+ * @instance
+ */
+
+Object.defineProperty(SchemaTypeOptions.prototype, 'transform', opts);
+
+module.exports = SchemaTypeOptions;

package/lib/options/schemaUnionOptions.js

@@ -0,0 +1,32 @@
+'use strict';
+
+const SchemaTypeOptions = require('./schemaTypeOptions');
+
+/**
+ * The options defined on a Union schematype.
+ *
+ * @api public
+ * @inherits SchemaTypeOptions
+ * @constructor SchemaUnionOptions
+ */
+
+class SchemaUnionOptions extends SchemaTypeOptions {}
+
+const opts = require('./propertyOptions');
+
+/**
+ * If set, specifies the types that this union can take. Mongoose will cast
+ * the value to one of the given types.
+ *
+ * If not set, Mongoose will not cast the value to any specific type.
+ *
+ * @api public
+ * @property of
+ * @memberOf SchemaUnionOptions
+ * @type {Function|Function[]|string|string[]}
+ * @instance
+ */
+
+Object.defineProperty(SchemaUnionOptions.prototype, 'of', opts);
+
+module.exports = SchemaUnionOptions;

package/lib/options/virtualOptions.js

@@ -0,0 +1,164 @@
+'use strict';
+
+const opts = require('./propertyOptions');
+
+class VirtualOptions {
+  constructor(obj) {
+    Object.assign(this, obj);
+
+    if (obj?.options != null) {
+      this.options = Object.assign({}, obj.options);
+    }
+  }
+}
+
+/**
+ * Marks this virtual as a populate virtual, and specifies the model to
+ * use for populate.
+ *
+ * @api public
+ * @property ref
+ * @memberOf VirtualOptions
+ * @type {String|Model|Function}
+ * @instance
+ */
+
+Object.defineProperty(VirtualOptions.prototype, 'ref', opts);
+
+/**
+ * Marks this virtual as a populate virtual, and specifies the path that
+ * contains the name of the model to populate
+ *
+ * @api public
+ * @property refPath
+ * @memberOf VirtualOptions
+ * @type {String|Function}
+ * @instance
+ */
+
+Object.defineProperty(VirtualOptions.prototype, 'refPath', opts);
+
+/**
+ * The name of the property in the local model to match to `foreignField`
+ * in the foreign model.
+ *
+ * @api public
+ * @property localField
+ * @memberOf VirtualOptions
+ * @type {String|Function}
+ * @instance
+ */
+
+Object.defineProperty(VirtualOptions.prototype, 'localField', opts);
+
+/**
+ * The name of the property in the foreign model to match to `localField`
+ * in the local model.
+ *
+ * @api public
+ * @property foreignField
+ * @memberOf VirtualOptions
+ * @type {String|Function}
+ * @instance
+ */
+
+Object.defineProperty(VirtualOptions.prototype, 'foreignField', opts);
+
+/**
+ * Whether to populate this virtual as a single document (true) or an
+ * array of documents (false).
+ *
+ * @api public
+ * @property justOne
+ * @memberOf VirtualOptions
+ * @type {Boolean}
+ * @instance
+ */
+
+Object.defineProperty(VirtualOptions.prototype, 'justOne', opts);
+
+/**
+ * If true, populate just the number of documents where `localField`
+ * matches `foreignField`, as opposed to the documents themselves.
+ *
+ * If `count` is set, it overrides `justOne`.
+ *
+ * @api public
+ * @property count
+ * @memberOf VirtualOptions
+ * @type {Boolean}
+ * @instance
+ */
+
+Object.defineProperty(VirtualOptions.prototype, 'count', opts);
+
+/**
+ * Add an additional filter to populate, in addition to `localField`
+ * matches `foreignField`.
+ *
+ * @api public
+ * @property match
+ * @memberOf VirtualOptions
+ * @type {Object|Function}
+ * @instance
+ */
+
+Object.defineProperty(VirtualOptions.prototype, 'match', opts);
+
+/**
+ * Additional options to pass to the query used to `populate()`:
+ *
+ * - `sort`
+ * - `skip`
+ * - `limit`
+ *
+ * @api public
+ * @property options
+ * @memberOf VirtualOptions
+ * @type {Object}
+ * @instance
+ */
+
+Object.defineProperty(VirtualOptions.prototype, 'options', opts);
+
+/**
+ * If true, add a `skip` to the query used to `populate()`.
+ *
+ * @api public
+ * @property skip
+ * @memberOf VirtualOptions
+ * @type {Number}
+ * @instance
+ */
+
+Object.defineProperty(VirtualOptions.prototype, 'skip', opts);
+
+/**
+ * If true, add a `limit` to the query used to `populate()`.
+ *
+ * @api public
+ * @property limit
+ * @memberOf VirtualOptions
+ * @type {Number}
+ * @instance
+ */
+
+Object.defineProperty(VirtualOptions.prototype, 'limit', opts);
+
+/**
+ * The `limit` option for `populate()` has [some unfortunate edge cases](https://mongoosejs.com/docs/populate.html#query-conditions)
+ * when working with multiple documents, like `.find().populate()`. The
+ * `perDocumentLimit` option makes `populate()` execute a separate query
+ * for each document returned from `find()` to ensure each document
+ * gets up to `perDocumentLimit` populated docs if possible.
+ *
+ * @api public
+ * @property perDocumentLimit
+ * @memberOf VirtualOptions
+ * @type {Number}
+ * @instance
+ */
+
+Object.defineProperty(VirtualOptions.prototype, 'perDocumentLimit', opts);
+
+module.exports = VirtualOptions;

package/lib/options.js

@@ -0,0 +1,17 @@
+'use strict';
+
+/*!
+ * ignore
+ */
+
+exports.internalToObjectOptions = {
+  transform: false,
+  virtuals: false,
+  getters: false,
+  _skipDepopulateTopLevel: true,
+  depopulate: true,
+  flattenDecimals: false,
+  useProjection: false,
+  versionKey: true,
+  flattenObjectIds: false
+};

package/lib/plugins/index.js

@@ -0,0 +1,6 @@
+'use strict';
+
+exports.saveSubdocs = require('./saveSubdocs');
+exports.sharding = require('./sharding');
+exports.trackTransaction = require('./trackTransaction');
+exports.validateBeforeSave = require('./validateBeforeSave');

package/lib/plugins/saveSubdocs.js

@@ -0,0 +1,76 @@
+'use strict';
+
+/*!
+ * ignore
+ */
+
+module.exports = function saveSubdocs(schema) {
+  const unshift = true;
+  schema.s.hooks.pre('save', false, async function saveSubdocsPreSave() {
+    if (this.$isSubdocument) {
+      return;
+    }
+
+    const subdocs = this.$getAllSubdocs({ useCache: true });
+
+    if (!subdocs.length) {
+      return;
+    }
+
+    const options = this.$__.saveOptions;
+    await Promise.all(subdocs.map(subdoc => subdoc._execDocumentPreHooks('save', options)));
+
+    // Invalidate subdocs cache because subdoc pre hooks can add new subdocuments
+    if (this.$__.saveOptions) {
+      this.$__.saveOptions.__subdocs = null;
+    }
+  }, null, unshift);
+
+  schema.s.hooks.pre('save', async function saveSubdocsPreDeleteOne() {
+    const removedSubdocs = this.$__.removedSubdocs;
+    if (!removedSubdocs?.length) {
+      return;
+    }
+
+    const promises = [];
+    for (const subdoc of removedSubdocs) {
+      promises.push(subdoc._execDocumentPreHooks('deleteOne'));
+    }
+
+    await Promise.all(promises);
+  });
+
+  schema.s.hooks.post('save', async function saveSubdocsPostDeleteOne() {
+    const removedSubdocs = this.$__.removedSubdocs;
+    if (!removedSubdocs?.length) {
+      return;
+    }
+
+    const promises = [];
+    for (const subdoc of removedSubdocs) {
+      promises.push(subdoc._execDocumentPostHooks('deleteOne'));
+    }
+
+    this.$__.removedSubdocs = null;
+    await Promise.all(promises);
+  });
+
+  schema.s.hooks.post('save', async function saveSubdocsPostSave() {
+    if (this.$isSubdocument) {
+      return;
+    }
+
+    const subdocs = this.$getAllSubdocs({ useCache: true });
+
+    if (!subdocs.length) {
+      return;
+    }
+
+    const promises = [];
+    for (const subdoc of subdocs) {
+      promises.push(subdoc._execDocumentPostHooks('save'));
+    }
+
+    await Promise.all(promises);
+  }, null, unshift);
+};

package/lib/plugins/sharding.js

@@ -0,0 +1,84 @@
+'use strict';
+
+const objectIdSymbol = require('../helpers/symbols').objectIdSymbol;
+const utils = require('../utils');
+
+/*!
+ * ignore
+ */
+
+module.exports = function shardingPlugin(schema) {
+  schema.post('init', function shardingPluginPostInit() {
+    storeShard.call(this);
+    return this;
+  });
+  schema.pre('save', function shardingPluginPreSave() {
+    applyWhere.call(this);
+  });
+  schema.pre('deleteOne', { document: true, query: false }, function shardingPluginPreDeleteOne() {
+    applyWhere.call(this);
+  });
+  schema.pre('updateOne', { document: true, query: false }, function shardingPluginPreUpdateOne() {
+    applyWhere.call(this);
+  });
+  schema.post('save', function shardingPluginPostSave() {
+    storeShard.call(this);
+  });
+};
+
+/*!
+ * ignore
+ */
+
+function applyWhere() {
+  let paths;
+  let len;
+
+  if (this.$__.shardval) {
+    paths = Object.keys(this.$__.shardval);
+    len = paths.length;
+
+    this.$where = this.$where || {};
+    for (let i = 0; i < len; ++i) {
+      this.$where[paths[i]] = this.$__.shardval[paths[i]];
+    }
+  }
+}
+
+/*!
+ * ignore
+ */
+
+module.exports.storeShard = storeShard;
+
+/*!
+ * ignore
+ */
+
+function storeShard() {
+  // backwards compat
+  const key = this.$__schema.options.shardKey || this.$__schema.options.shardkey;
+  if (!utils.isPOJO(key)) {
+    return;
+  }
+
+  const orig = this.$__.shardval = {};
+  const paths = Object.keys(key);
+  const len = paths.length;
+  let val;
+
+  for (let i = 0; i < len; ++i) {
+    val = this.$__getValue(paths[i]);
+    if (val == null) {
+      orig[paths[i]] = val;
+    } else if (utils.isMongooseObject(val)) {
+      orig[paths[i]] = val.toObject({ depopulate: true, _isNested: true });
+    } else if (val instanceof Date || val[objectIdSymbol]) {
+      orig[paths[i]] = val;
+    } else if (typeof val.valueOf === 'function') {
+      orig[paths[i]] = val.valueOf();
+    } else {
+      orig[paths[i]] = val;
+    }
+  }
+}