@depup/mongoose 9.1.3-depup.0

package/lib/options/populateOptions.js

@@ -0,0 +1,36 @@
+'use strict';
+
+const clone = require('../helpers/clone');
+
+class PopulateOptions {
+  constructor(obj) {
+    this._docs = {};
+    this._childDocs = [];
+
+    if (obj == null) {
+      return;
+    }
+    obj = clone(obj);
+    Object.assign(this, obj);
+    if (typeof obj.subPopulate === 'object') {
+      this.populate = obj.subPopulate;
+    }
+
+
+    if (obj.perDocumentLimit != null && obj.limit != null) {
+      throw new Error('Can not use `limit` and `perDocumentLimit` at the same time. Path: `' + obj.path + '`.');
+    }
+  }
+}
+
+/**
+ * The connection used to look up models by name. If not specified, Mongoose
+ * will default to using the connection associated with the model in
+ * `PopulateOptions#model`.
+ *
+ * @memberOf PopulateOptions
+ * @property {Connection} connection
+ * @api public
+ */
+
+module.exports = PopulateOptions;

package/lib/options/propertyOptions.js

@@ -0,0 +1,8 @@
+'use strict';
+
+module.exports = Object.freeze({
+  enumerable: true,
+  configurable: true,
+  writable: true,
+  value: void 0
+});

package/lib/options/saveOptions.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const clone = require('../helpers/clone');
+
+class SaveOptions {
+  constructor(obj) {
+    if (obj == null) {
+      return;
+    }
+    Object.assign(this, clone(obj));
+  }
+}
+
+SaveOptions.prototype.__subdocs = null;
+
+module.exports = SaveOptions;

package/lib/options/schemaArrayOptions.js

@@ -0,0 +1,78 @@
+'use strict';
+
+const SchemaTypeOptions = require('./schemaTypeOptions');
+
+/**
+ * The options defined on an Array schematype.
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({ tags: [String] });
+ *     schema.path('tags').options; // SchemaArrayOptions instance
+ *
+ * @api public
+ * @inherits SchemaTypeOptions
+ * @constructor SchemaArrayOptions
+ */
+
+class SchemaArrayOptions extends SchemaTypeOptions {}
+
+const opts = require('./propertyOptions');
+
+/**
+ * If this is an array of strings, an array of allowed values for this path.
+ * Throws an error if this array isn't an array of strings.
+ *
+ * @api public
+ * @property enum
+ * @memberOf SchemaArrayOptions
+ * @type {Array}
+ * @instance
+ */
+
+Object.defineProperty(SchemaArrayOptions.prototype, 'enum', opts);
+
+/**
+ * If set, specifies the type of this array's values. Equivalent to setting
+ * `type` to an array whose first element is `of`.
+ *
+ * #### Example:
+ *
+ *     // `arr` is an array of numbers.
+ *     new Schema({ arr: [Number] });
+ *     // Equivalent way to define `arr` as an array of numbers
+ *     new Schema({ arr: { type: Array, of: Number } });
+ *
+ * @api public
+ * @property of
+ * @memberOf SchemaArrayOptions
+ * @type {Function|String}
+ * @instance
+ */
+
+Object.defineProperty(SchemaArrayOptions.prototype, 'of', opts);
+
+/**
+ * If set to `false`, will always deactivate casting non-array values to arrays.
+ * If set to `true`, will cast non-array values to arrays if `init` and `SchemaArray.options.castNonArrays` are also `true`
+ *
+ * #### Example:
+ *
+ *     const Model = db.model('Test', new Schema({ x1: { castNonArrays: false, type: [String] } }));
+ *     const doc = new Model({ x1: "some non-array value" });
+ *     await doc.validate(); // Errors with "CastError"
+ *
+ * @api public
+ * @property castNonArrays
+ * @memberOf SchemaArrayOptions
+ * @type {Boolean}
+ * @instance
+ */
+
+Object.defineProperty(SchemaArrayOptions.prototype, 'castNonArrays', opts);
+
+/*!
+ * ignore
+ */
+
+module.exports = SchemaArrayOptions;

package/lib/options/schemaBufferOptions.js

@@ -0,0 +1,38 @@
+'use strict';
+
+const SchemaTypeOptions = require('./schemaTypeOptions');
+
+/**
+ * The options defined on a Buffer schematype.
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({ bitmap: Buffer });
+ *     schema.path('bitmap').options; // SchemaBufferOptions instance
+ *
+ * @api public
+ * @inherits SchemaTypeOptions
+ * @constructor SchemaBufferOptions
+ */
+
+class SchemaBufferOptions extends SchemaTypeOptions {}
+
+const opts = require('./propertyOptions');
+
+/**
+ * Set the default subtype for this buffer.
+ *
+ * @api public
+ * @property subtype
+ * @memberOf SchemaBufferOptions
+ * @type {Number}
+ * @instance
+ */
+
+Object.defineProperty(SchemaBufferOptions.prototype, 'subtype', opts);
+
+/*!
+ * ignore
+ */
+
+module.exports = SchemaBufferOptions;

package/lib/options/schemaDateOptions.js

@@ -0,0 +1,71 @@
+'use strict';
+
+const SchemaTypeOptions = require('./schemaTypeOptions');
+
+/**
+ * The options defined on a Date schematype.
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({ startedAt: Date });
+ *     schema.path('startedAt').options; // SchemaDateOptions instance
+ *
+ * @api public
+ * @inherits SchemaTypeOptions
+ * @constructor SchemaDateOptions
+ */
+
+class SchemaDateOptions extends SchemaTypeOptions {}
+
+const opts = require('./propertyOptions');
+
+/**
+ * If set, Mongoose adds a validator that checks that this path is after the
+ * given `min`.
+ *
+ * @api public
+ * @property min
+ * @memberOf SchemaDateOptions
+ * @type {Date}
+ * @instance
+ */
+
+Object.defineProperty(SchemaDateOptions.prototype, 'min', opts);
+
+/**
+ * If set, Mongoose adds a validator that checks that this path is before the
+ * given `max`.
+ *
+ * @api public
+ * @property max
+ * @memberOf SchemaDateOptions
+ * @type {Date}
+ * @instance
+ */
+
+Object.defineProperty(SchemaDateOptions.prototype, 'max', opts);
+
+/**
+ * If set, Mongoose creates a TTL index on this path.
+ *
+ * mongo TTL index `expireAfterSeconds` value will take 'expires' value expressed in seconds.
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({ "expireAt": { type: Date,  expires: 11 } });
+ *     // if 'expireAt' is set, then document expires at expireAt + 11 seconds
+ *
+ * @api public
+ * @property expires
+ * @memberOf SchemaDateOptions
+ * @type {Date}
+ * @instance
+ */
+
+Object.defineProperty(SchemaDateOptions.prototype, 'expires', opts);
+
+/*!
+ * ignore
+ */
+
+module.exports = SchemaDateOptions;

package/lib/options/schemaDocumentArrayOptions.js

@@ -0,0 +1,68 @@
+'use strict';
+
+const SchemaTypeOptions = require('./schemaTypeOptions');
+
+/**
+ * The options defined on an Document Array schematype.
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({ users: [{ name: string }] });
+ *     schema.path('users').options; // SchemaDocumentArrayOptions instance
+ *
+ * @api public
+ * @inherits SchemaTypeOptions
+ * @constructor SchemaDocumentOptions
+ */
+
+class SchemaDocumentArrayOptions extends SchemaTypeOptions {}
+
+const opts = require('./propertyOptions');
+
+/**
+ * If `true`, Mongoose will skip building any indexes defined in this array's schema.
+ * If not set, Mongoose will build all indexes defined in this array's schema.
+ *
+ * #### Example:
+ *
+ *     const childSchema = Schema({ name: { type: String, index: true } });
+ *     // If `excludeIndexes` is `true`, Mongoose will skip building an index
+ *     // on `arr.name`. Otherwise, Mongoose will build an index on `arr.name`.
+ *     const parentSchema = Schema({
+ *       arr: { type: [childSchema], excludeIndexes: true }
+ *     });
+ *
+ * @api public
+ * @property excludeIndexes
+ * @memberOf SchemaDocumentArrayOptions
+ * @type {Array}
+ * @instance
+ */
+
+Object.defineProperty(SchemaDocumentArrayOptions.prototype, 'excludeIndexes', opts);
+
+/**
+ * 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 SchemaDocumentArrayOptions
+ * @type {Array}
+ * @instance
+ */
+
+Object.defineProperty(SchemaDocumentArrayOptions.prototype, '_id', opts);
+
+/*!
+ * ignore
+ */
+
+module.exports = SchemaDocumentArrayOptions;

package/lib/options/schemaMapOptions.js

@@ -0,0 +1,43 @@
+'use strict';
+
+const SchemaTypeOptions = require('./schemaTypeOptions');
+
+/**
+ * The options defined on a Map schematype.
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({ socialMediaHandles: { type: Map, of: String } });
+ *     schema.path('socialMediaHandles').options; // SchemaMapOptions instance
+ *
+ * @api public
+ * @inherits SchemaTypeOptions
+ * @constructor SchemaMapOptions
+ */
+
+class SchemaMapOptions extends SchemaTypeOptions {}
+
+const opts = require('./propertyOptions');
+
+/**
+ * If set, specifies the type of this map's values. Mongoose will cast
+ * this map's values to the given type.
+ *
+ * If not set, Mongoose will not cast the map's values.
+ *
+ * #### Example:
+ *
+ *     // Mongoose will cast `socialMediaHandles` values to strings
+ *     const schema = new Schema({ socialMediaHandles: { type: Map, of: String } });
+ *     schema.path('socialMediaHandles').options.of; // String
+ *
+ * @api public
+ * @property of
+ * @memberOf SchemaMapOptions
+ * @type {Function|string}
+ * @instance
+ */
+
+Object.defineProperty(SchemaMapOptions.prototype, 'of', opts);
+
+module.exports = SchemaMapOptions;

package/lib/options/schemaNumberOptions.js

@@ -0,0 +1,101 @@
+'use strict';
+
+const SchemaTypeOptions = require('./schemaTypeOptions');
+
+/**
+ * The options defined on a Number schematype.
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({ count: Number });
+ *     schema.path('count').options; // SchemaNumberOptions instance
+ *
+ * @api public
+ * @inherits SchemaTypeOptions
+ * @constructor SchemaNumberOptions
+ */
+
+class SchemaNumberOptions extends SchemaTypeOptions {}
+
+const opts = require('./propertyOptions');
+
+/**
+ * If set, Mongoose adds a validator that checks that this path is at least the
+ * given `min`.
+ *
+ * @api public
+ * @property min
+ * @memberOf SchemaNumberOptions
+ * @type {Number}
+ * @instance
+ */
+
+Object.defineProperty(SchemaNumberOptions.prototype, 'min', opts);
+
+/**
+ * If set, Mongoose adds a validator that checks that this path is less than the
+ * given `max`.
+ *
+ * @api public
+ * @property max
+ * @memberOf SchemaNumberOptions
+ * @type {Number}
+ * @instance
+ */
+
+Object.defineProperty(SchemaNumberOptions.prototype, 'max', opts);
+
+/**
+ * If set, Mongoose adds a validator that checks that this path is strictly
+ * equal to one of the given values.
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({
+ *       favoritePrime: {
+ *         type: Number,
+ *         enum: [3, 5, 7]
+ *       }
+ *     });
+ *     schema.path('favoritePrime').options.enum; // [3, 5, 7]
+ *
+ * @api public
+ * @property enum
+ * @memberOf SchemaNumberOptions
+ * @type {Array}
+ * @instance
+ */
+
+Object.defineProperty(SchemaNumberOptions.prototype, 'enum', opts);
+
+/**
+ * Sets default [populate options](https://mongoosejs.com/docs/populate.html#query-conditions).
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({
+ *       child: {
+ *         type: Number,
+ *         ref: 'Child',
+ *         populate: { select: 'name' }
+ *       }
+ *     });
+ *     const Parent = mongoose.model('Parent', schema);
+ *
+ *     // Automatically adds `.select('name')`
+ *     Parent.findOne().populate('child');
+ *
+ * @api public
+ * @property populate
+ * @memberOf SchemaNumberOptions
+ * @type {Object}
+ * @instance
+ */
+
+Object.defineProperty(SchemaNumberOptions.prototype, 'populate', opts);
+
+/*!
+ * ignore
+ */
+
+module.exports = SchemaNumberOptions;

package/lib/options/schemaObjectIdOptions.js

@@ -0,0 +1,64 @@
+'use strict';
+
+const SchemaTypeOptions = require('./schemaTypeOptions');
+
+/**
+ * The options defined on an ObjectId schematype.
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({ testId: mongoose.ObjectId });
+ *     schema.path('testId').options; // SchemaObjectIdOptions instance
+ *
+ * @api public
+ * @inherits SchemaTypeOptions
+ * @constructor SchemaObjectIdOptions
+ */
+
+class SchemaObjectIdOptions extends SchemaTypeOptions {}
+
+const opts = require('./propertyOptions');
+
+/**
+ * If truthy, uses Mongoose's default built-in ObjectId path.
+ *
+ * @api public
+ * @property auto
+ * @memberOf SchemaObjectIdOptions
+ * @type {Boolean}
+ * @instance
+ */
+
+Object.defineProperty(SchemaObjectIdOptions.prototype, 'auto', opts);
+
+/**
+ * Sets default [populate options](https://mongoosejs.com/docs/populate.html#query-conditions).
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({
+ *       child: {
+ *         type: 'ObjectId',
+ *         ref: 'Child',
+ *         populate: { select: 'name' }
+ *       }
+ *     });
+ *     const Parent = mongoose.model('Parent', schema);
+ *
+ *     // Automatically adds `.select('name')`
+ *     Parent.findOne().populate('child');
+ *
+ * @api public
+ * @property populate
+ * @memberOf SchemaObjectIdOptions
+ * @type {Object}
+ * @instance
+ */
+
+Object.defineProperty(SchemaObjectIdOptions.prototype, 'populate', opts);
+
+/*!
+ * ignore
+ */
+
+module.exports = SchemaObjectIdOptions;

package/lib/options/schemaStringOptions.js

@@ -0,0 +1,138 @@
+'use strict';
+
+const SchemaTypeOptions = require('./schemaTypeOptions');
+
+/**
+ * The options defined on a string schematype.
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({ name: String });
+ *     schema.path('name').options; // SchemaStringOptions instance
+ *
+ * @api public
+ * @inherits SchemaTypeOptions
+ * @constructor SchemaStringOptions
+ */
+
+class SchemaStringOptions extends SchemaTypeOptions {}
+
+const opts = require('./propertyOptions');
+
+/**
+ * Array of allowed values for this path
+ *
+ * @api public
+ * @property enum
+ * @memberOf SchemaStringOptions
+ * @type {Array}
+ * @instance
+ */
+
+Object.defineProperty(SchemaStringOptions.prototype, 'enum', opts);
+
+/**
+ * Attach a validator that succeeds if the data string matches the given regular
+ * expression, and fails otherwise.
+ *
+ * @api public
+ * @property match
+ * @memberOf SchemaStringOptions
+ * @type {RegExp}
+ * @instance
+ */
+
+Object.defineProperty(SchemaStringOptions.prototype, 'match', opts);
+
+/**
+ * If truthy, Mongoose will add a [custom setter](https://mongoosejs.com/docs/api/schematype.html#SchemaType.prototype.set()) that lowercases this string
+ * using JavaScript's built-in `String#toLowerCase()`.
+ *
+ * @api public
+ * @property lowercase
+ * @memberOf SchemaStringOptions
+ * @type {Boolean}
+ * @instance
+ */
+
+Object.defineProperty(SchemaStringOptions.prototype, 'lowercase', opts);
+
+/**
+ * If truthy, Mongoose will add a [custom setter](https://mongoosejs.com/docs/api/schematype.html#SchemaType.prototype.set()) that removes leading and trailing
+ * whitespace using [JavaScript's built-in `String#trim()`](https://masteringjs.io/tutorials/fundamentals/trim-string).
+ *
+ * @api public
+ * @property trim
+ * @memberOf SchemaStringOptions
+ * @type {Boolean}
+ * @instance
+ */
+
+Object.defineProperty(SchemaStringOptions.prototype, 'trim', opts);
+
+/**
+ * If truthy, Mongoose will add a custom setter that uppercases this string
+ * using JavaScript's built-in [`String#toUpperCase()`](https://masteringjs.io/tutorials/fundamentals/uppercase).
+ *
+ * @api public
+ * @property uppercase
+ * @memberOf SchemaStringOptions
+ * @type {Boolean}
+ * @instance
+ */
+
+Object.defineProperty(SchemaStringOptions.prototype, 'uppercase', opts);
+
+/**
+ * If set, Mongoose will add a custom validator that ensures the given
+ * string's `length` is at least the given number.
+ *
+ * Mongoose supports two different spellings for this option: `minLength` and `minlength`.
+ * `minLength` is the recommended way to specify this option, but Mongoose also supports
+ * `minlength` (lowercase "l").
+ *
+ * @api public
+ * @property minLength
+ * @memberOf SchemaStringOptions
+ * @type {Number}
+ * @instance
+ */
+
+Object.defineProperty(SchemaStringOptions.prototype, 'minLength', opts);
+Object.defineProperty(SchemaStringOptions.prototype, 'minlength', opts);
+
+/**
+ * If set, Mongoose will add a custom validator that ensures the given
+ * string's `length` is at most the given number.
+ *
+ * Mongoose supports two different spellings for this option: `maxLength` and `maxlength`.
+ * `maxLength` is the recommended way to specify this option, but Mongoose also supports
+ * `maxlength` (lowercase "l").
+ *
+ * @api public
+ * @property maxLength
+ * @memberOf SchemaStringOptions
+ * @type {Number}
+ * @instance
+ */
+
+Object.defineProperty(SchemaStringOptions.prototype, 'maxLength', opts);
+Object.defineProperty(SchemaStringOptions.prototype, 'maxlength', opts);
+
+/**
+ * Sets default [populate options](https://mongoosejs.com/docs/populate.html#query-conditions).
+ *
+ * @api public
+ * @property populate
+ * @memberOf SchemaStringOptions
+ * @type {Object}
+ * @instance
+ */
+
+Object.defineProperty(SchemaStringOptions.prototype, 'populate', opts);
+
+/*!
+ * ignore
+ */
+
+module.exports = SchemaStringOptions;