mongoose 6.9.0 → 6.9.2

package/lib/schema/SubdocumentPath.js

@@ -111,7 +111,7 @@ function _createConstructor(schema, baseClass) {
 /**
  * Special case for when users use a common location schema to represent
  * locations for use with $geoWithin.
- * https://docs.mongodb.org/manual/reference/operator/query/geoWithin/
+ * https://www.mongodb.com/docs/manual/reference/operator/query/geoWithin/
  *
  * @param {Object} val
  * @api private

package/lib/schema/operators/text.js

@@ -11,7 +11,7 @@ const castString = require('../../cast/string');
  * @param {Any} val value to cast
  * @param {String} [path] path to associate with any errors that occured
  * @return {Object} casted object
- * @see https://docs.mongodb.com/manual/reference/operator/query/text/
+ * @see https://www.mongodb.com/docs/manual/reference/operator/query/text/
  * @api private
  */
 

package/lib/schema/uuid.js

@@ -23,7 +23,7 @@ const Binary = MongooseBuffer.Binary;
 
 function hex2buffer(hex) {
   // use buffer built-in function to convert from hex-string to buffer
-  const buff = Buffer.from(hex, 'hex');
+  const buff = hex != null && Buffer.from(hex, 'hex');
   return buff;
 }
 
@@ -36,7 +36,7 @@ function hex2buffer(hex) {
 
 function binary2hex(buf) {
   // use buffer built-in function to convert from buffer to hex-string
-  const hex = buf.toString('hex');
+  const hex = buf != null && buf.toString('hex');
   return hex;
 }
 
@@ -67,7 +67,7 @@ function stringToBinary(uuidStr) {
 function binaryToString(uuidBin) {
   // i(hasezoey) dont quite know why, but "uuidBin" may sometimes also be the already processed string
   let hex;
-  if (typeof uuidBin !== 'string') {
+  if (typeof uuidBin !== 'string' && uuidBin != null) {
     hex = binary2hex(uuidBin);
     const uuidStr = hex.substring(0, 8) + '-' + hex.substring(8, 8 + 4) + '-' + hex.substring(12, 12 + 4) + '-' + hex.substring(16, 16 + 4) + '-' + hex.substring(20, 20 + 12);
     return uuidStr;

package/lib/schema.js

@@ -61,7 +61,7 @@ let id = 0;
  * - [_id](/docs/guide.html#_id): bool - defaults to true
  * - [minimize](/docs/guide.html#minimize): bool - controls [document#toObject](#document_Document-toObject) behavior when called manually - defaults to true
  * - [read](/docs/guide.html#read): string
- * - [writeConcern](/docs/guide.html#writeConcern): object - defaults to null, use to override [the MongoDB server's default write concern settings](https://docs.mongodb.com/manual/reference/write-concern/)
+ * - [writeConcern](/docs/guide.html#writeConcern): object - defaults to null, use to override [the MongoDB server's default write concern settings](https://www.mongodb.com/docs/manual/reference/write-concern/)
  * - [shardKey](/docs/guide.html#shardKey): object - defaults to `null`
  * - [strict](/docs/guide.html#strict): bool - defaults to true
  * - [strictQuery](/docs/guide.html#strictQuery): bool - defaults to false
@@ -2252,6 +2252,7 @@ function _deletePath(schema, name) {
 }
 
 /**
+ * Removes the given virtual or virtuals from the schema.
  *
  * @param {String|Array} path The virutal path(s) to remove.
  * @returns {Schema} the Schema instance, or a mongoose error if the virtual does not exist.

package/lib/schematype.js

@@ -402,7 +402,7 @@ SchemaType.prototype.default = function(val) {
  *
  * #### Note:
  *
- * _Indexes are created [in the background](https://docs.mongodb.com/manual/core/index-creation/#index-creation-background)
+ * _Indexes are created [in the background](https://www.mongodb.com/docs/manual/core/index-creation/#index-creation-background)
  * by default. If `background` is set to `false`, MongoDB will not execute any
  * read/write operations you send until the index build.
  * Specify `background: false` to override Mongoose's default._

package/lib/types/array/index.js

@@ -24,7 +24,7 @@ const arraySchemaSymbol = require('../../helpers/symbols').arraySchemaSymbol;
  * @param {String} path
  * @param {Document} doc parent document
  * @api private
- * @inherits Array
+ * @inherits Array https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
  * @see https://bit.ly/f6CnZU
  */
 const _basePush = Array.prototype.push;

package/lib/types/array/methods/index.js

@@ -137,12 +137,13 @@ const methods = {
     this._markModified();
 
     // only allow shifting once
-    if (this._shifted) {
+    const __array = this.__array;
+    if (__array._shifted) {
       return;
     }
-    this._shifted = true;
+    __array._shifted = true;
 
-    return [].shift.call(this);
+    return [].shift.call(__array);
   },
 
   /**

package/lib/types/buffer.js

@@ -16,7 +16,7 @@ const utils = require('../utils');
  * @param {String} encode
  * @param {Number} offset
  * @api private
- * @inherits Buffer
+ * @inherits Buffer https://nodejs.org/api/buffer.html
  * @see https://bit.ly/f6CnZU
  */
 

package/lib/virtualtype.js

@@ -18,7 +18,7 @@ const utils = require('./utils');
  * @param {String|Function} [options.foreignField] the foreign field to populate on if this is a populated virtual.
  * @param {Boolean} [options.justOne=false] by default, a populated virtual is an array. If you set `justOne`, the populated virtual will be a single doc or `null`.
  * @param {Boolean} [options.getters=false] if you set this to `true`, Mongoose will call any custom getters you defined on this virtual
- * @param {Boolean} [options.count=false] if you set this to `true`, `populate()` will set this virtual to the number of populated documents, as opposed to the documents themselves, using [`Query#countDocuments()`](./api/query.html#query_Query-countDocuments)
+ * @param {Boolean} [options.count=false] if you set this to `true`, `populate()` will set this virtual to the number of populated documents, as opposed to the documents themselves, using [`Query#countDocuments()`](/docs/api/query.html#query_Query-countDocuments)
  * @param {Object|Function} [options.match=null] add an extra match condition to `populate()`
  * @param {Number} [options.limit=null] add a default `limit` to the `populate()` query
  * @param {Number} [options.skip=null] add a default `skip` to the `populate()` query

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "6.9.0",
+  "version": "6.9.2",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -28,10 +28,10 @@
     "sift": "16.0.1"
   },
   "devDependencies": {
-    "@babel/core": "7.20.7",
+    "@babel/core": "7.20.12",
     "@babel/preset-env": "7.20.2",
-    "@typescript-eslint/eslint-plugin": "5.47.1",
-    "@typescript-eslint/parser": "5.47.1",
+    "@typescript-eslint/eslint-plugin": "5.50.0",
+    "@typescript-eslint/parser": "5.50.0",
     "acquit": "1.2.1",
     "acquit-ignore": "0.2.0",
     "acquit-require": "0.1.1",
@@ -40,21 +40,22 @@
     "babel-loader": "8.2.5",
     "benchmark": "2.1.4",
     "bluebird": "3.7.2",
+    "broken-link-checker": "^0.7.8",
     "buffer": "^5.6.0",
     "cheerio": "1.0.0-rc.12",
     "crypto-browserify": "3.12.0",
     "dox": "1.0.0",
-    "eslint": "8.31.0",
+    "eslint": "8.33.0",
     "eslint-plugin-mocha-no-only": "1.1.1",
     "express": "^4.18.1",
     "highlight.js": "11.7.0",
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
-    "marked": "4.2.5",
-    "mkdirp": "^1.0.4",
+    "marked": "4.2.12",
+    "mkdirp": "^2.1.3",
     "mocha": "10.2.0",
     "moment": "2.x",
-    "mongodb-memory-server": "8.10.2",
+    "mongodb-memory-server": "8.11.4",
     "ncp": "^2.0.0",
     "nyc": "15.1.0",
     "pug": "3.0.2",
@@ -62,7 +63,7 @@
     "sinon": "15.0.1",
     "stream-browserify": "3.0.0",
     "tsd": "0.25.0",
-    "typescript": "4.9.4",
+    "typescript": "4.9.5",
     "uuid": "9.0.0",
     "webpack": "5.75.0"
   },
@@ -85,6 +86,7 @@
     "docs:view": "node ./scripts/static.js",
     "docs:prepare:publish:stable": "npm run docs:checkout:gh-pages && npm run docs:merge:stable && npm run docs:clean:stable && npm run docs:generate && npm run docs:generate:search",
     "docs:prepare:publish:legacy": "npm run docs:checkout:legacy && npm run docs:merge:legacy && npm run docs:clean:stable && npm run docs:generate && npm run docs:copy:tmp && docs:checkout:gh-pages && docs:copy:tmp:legacy",
+    "docs:check-links": "blc http://127.0.0.1:8089 -ro",
     "lint": "eslint .",
     "lint-js": "eslint . --ext .js",
     "lint-ts": "eslint . --ext .ts",
@@ -94,7 +96,7 @@
     "release-legacy": "git pull origin 5.x && git push origin 5.x --tags && npm publish --tag legacy",
     "mongo": "node ./tools/repl.js",
     "test": "mocha --exit ./test/*.test.js",
-    "test-deno": "deno run --allow-env --allow-read --allow-net --allow-run --allow-sys ./test/deno.js",
+    "test-deno": "deno run --allow-env --allow-read --allow-net --allow-run --allow-sys --allow-write ./test/deno.js",
     "test-rs": "START_REPLICA_SET=1 mocha --timeout 30000 --exit ./test/*.test.js",
     "test-tsd": "node ./test/types/check-types-filename && tsd",
     "tdd": "mocha ./test/*.test.js --inspect --watch --recursive --watch-files ./**/*.{js,ts}",

package/types/aggregate.d.ts

@@ -4,67 +4,7 @@ declare module 'mongoose' {
   /** Extract generic type from Aggregate class */
   type AggregateExtract<P> = P extends Aggregate<infer T> ? T : never;
 
-  interface AggregateOptions extends
-    SessionOption {
-    /**
-     * If true, the MongoDB server will use the hard drive to store data during this aggregation.
-     */
-    allowDiskUse?: boolean;
-    /**
-     * Applicable only if you specify the $out or $merge aggregation stages.
-     *
-     * Enables db.collection.aggregate() to bypass document validation during the operation. This lets you insert documents that do not meet the validation requirements.
-     */
-    bypassDocumentValidation?: boolean;
-    /**
-     * The BSON-serializer will check if keys are valid
-     */
-    collation?: mongodb.CollationOptions;
-    /**
-     * Users can specify an arbitrary string to help trace the operation through the database profiler, currentOp, and logs.
-     */
-    comment?: string;
-    /**
-     *  Specifies the initial batch size for the cursor. The value of the cursor field is a document with the field batchSize.
-     */
-    cursor?: { batchSize?: number; };
-
-    /**
-     * Specifies to return the information on the processing of the pipeline. See Return Information on Aggregation Pipeline Operation for an example.
-     *
-     * Not available in multi-document transactions.
-     */
-    explain?: mongodb.ExplainVerbosityLike;
-    /**
-     * The index to use for the aggregation. The index is on the initial collection/view against which the aggregation is run.
-     */
-    hint?: string | AnyObject;
-    /**
-     * Specifies a document with a list of variables. This allows you to improve command readability by separating the variables from the query text.
-     */
-    let?: AnyObject;
-    /**
-     * Specifies a time limit in milliseconds for processing operations on a cursor. If you do not specify a value for maxTimeMS, operations will not time out. A value of 0 explicitly specifies the default unbounded behavior.
-     *
-     * @see https://docs.mongodb.com/manual/reference/operator/meta/maxTimeMS/
-     */
-    maxTimeMS?: number;
-    /**
-     * Return BSON filled buffers from operations.
-     */
-    raw?: boolean;
-    /**
-     * Specifies the read concern.
-     */
-    readConcern?: mongodb.ReadConcernLike;
-    /**
-     * The preferred read preference.
-     */
-    readPreference?: mongodb.ReadPreferenceLike;
-    /**
-     * Specifies the write concern.
-     */
-    writeConcern?: mongodb.WriteConcern;
+  interface AggregateOptions extends Omit<mongodb.AggregateOptions, 'session'>, SessionOption {
     [key: string]: any;
   }
 
@@ -171,11 +111,8 @@ declare module 'mongoose' {
      */
     model(): Model<any>;
 
-    /**
-     * Append a new $near operator to this aggregation pipeline
-     * @param arg $near operator contents
-     */
-    near(arg: { near?: number[]; distanceField: string; maxDistance?: number; query?: Record<string, any>; includeLocs?: string; num?: number; uniqueDocs?: boolean }): this;
+    /** Appends a new $geoNear operator to this aggregate pipeline. */
+    near(arg: PipelineStage.GeoNear['$geoNear']): this;
 
     /** Returns the current pipeline */
     pipeline(): PipelineStage[];
@@ -196,7 +133,7 @@ declare module 'mongoose' {
     replaceRoot(newRoot: PipelineStage.ReplaceRoot['$replaceRoot']['newRoot'] | string): this;
 
     /**
-     * Helper for [Atlas Text Search](https://docs.atlas.mongodb.com/reference/atlas-search/tutorial/)'s
+     * Helper for [Atlas Text Search](https://www.mongodb.com/docs/atlas/atlas-search/tutorial/)'s
      * `$search` stage.
      */
     search(options: PipelineStage.Search['$search']): this;

package/types/connection.d.ts

@@ -85,8 +85,8 @@ declare module 'mongoose' {
 
     /**
      * Helper for `createCollection()`. Will explicitly create the given collection
-     * with specified options. Used to create [capped collections](https://docs.mongodb.com/manual/core/capped-collections/)
-     * and [views](https://docs.mongodb.com/manual/core/views/) from mongoose.
+     * with specified options. Used to create [capped collections](https://www.mongodb.com/docs/manual/core/capped-collections/)
+     * and [views](https://www.mongodb.com/docs/manual/core/views/) from mongoose.
      */
     createCollection<T extends AnyObject = AnyObject>(name: string, options: mongodb.CreateCollectionOptions, callback: Callback<mongodb.Collection<T>>): void;
     createCollection<T extends AnyObject = AnyObject>(name: string, callback: Callback<mongodb.Collection<T>>): void;
@@ -204,8 +204,8 @@ declare module 'mongoose' {
     setClient(client: mongodb.MongoClient): this;
 
     /**
-     * _Requires MongoDB >= 3.6.0._ Starts a [MongoDB session](https://docs.mongodb.com/manual/release-notes/3.6/#client-sessions)
-     * for benefits like causal consistency, [retryable writes](https://docs.mongodb.com/manual/core/retryable-writes/),
+     * _Requires MongoDB >= 3.6.0._ Starts a [MongoDB session](https://www.mongodb.com/docs/manual/release-notes/3.6/#client-sessions)
+     * for benefits like causal consistency, [retryable writes](https://www.mongodb.com/docs/manual/core/retryable-writes/),
      * and [transactions](http://thecodebarbarian.com/a-node-js-perspective-on-mongodb-4-transactions.html).
      */
     startSession(options: ClientSessionOptions | undefined | null, callback: Callback<ClientSession>): void;

package/types/error.d.ts

@@ -129,5 +129,10 @@ declare module 'mongoose' {
 
       constructor(doc: Document, currentVersion: number, modifiedPaths: Array<string>);
     }
+
+    export class StrictPopulateError extends MongooseError {
+      name: 'StrictPopulateError';
+      path: string;
+    }
   }
 }