mongoose 6.1.9 → 6.2.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "6.1.9",
+  "version": "6.2.2",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -19,14 +19,12 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@types/node": "< 17.0.6",
     "bson": "^4.2.2",
-    "kareem": "2.3.3",
-    "mongodb": "4.2.2",
+    "kareem": "2.3.4",
+    "mongodb": "4.3.1",
     "mpath": "0.8.4",
     "mquery": "4.0.2",
     "ms": "2.1.2",
-    "regexp-clone": "1.0.0",
     "sift": "13.5.2"
   },
   "devDependencies": {
@@ -45,7 +43,6 @@
     "eslint": "8.5.0",
     "eslint-plugin-mocha-no-only": "1.1.0",
     "highlight.js": "9.18.3",
-    "js-yaml": "4.1.0",
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
     "marked": "2.1.3",
@@ -58,6 +55,7 @@
     "q": "1.5.1",
     "rimraf": "2.6.3",
     "serve-handler": "6.1.3",
+    "tsd": "0.19.1",
     "typescript": "4.5.3",
     "uuid": "8.3.2",
     "webpack": "4.44.1"
@@ -72,12 +70,13 @@
     "release": "git pull && git push origin master --tags && npm publish",
     "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/typescript/main.test.js",
+    "test": "mocha --exit ./test/*.test.js",
+    "test-tsd": "tsd",
     "tdd": "mocha ./test/*.test.js ./test/typescript/main.test.js --inspect --watch --recursive --watch-files ./**/*.js",
     "test-coverage": "nyc --reporter=html --reporter=text npm test"
   },
   "main": "./index.js",
-  "types": "./index.d.ts",
+  "types": "./types/index.d.ts",
   "engines": {
     "node": ">=12.0.0"
   },
@@ -98,149 +97,6 @@
       "test/**/*.js"
     ]
   },
-  "eslintConfig": {
-    "extends": [
-      "eslint:recommended"
-    ],
-    "overrides": [
-      {
-        "files": [
-          "**/*.{ts,tsx}"
-        ],
-        "extends": [
-          "plugin:@typescript-eslint/eslint-recommended",
-          "plugin:@typescript-eslint/recommended"
-        ],
-        "plugins": [
-          "@typescript-eslint"
-        ],
-        "rules": {
-          "@typescript-eslint/no-explicit-any": "off",
-          "@typescript-eslint/ban-types": "off",
-          "@typescript-eslint/no-unused-vars": "off",
-          "@typescript-eslint/explicit-module-boundary-types": "off"
-        }
-      }
-    ],
-    "plugins": [
-      "mocha-no-only"
-    ],
-    "parserOptions": {
-      "ecmaVersion": 2020
-    },
-    "env": {
-      "node": true,
-      "es6": true
-    },
-    "rules": {
-      "comma-style": "error",
-      "indent": [
-        "error",
-        2,
-        {
-          "SwitchCase": 1,
-          "VariableDeclarator": 2
-        }
-      ],
-      "keyword-spacing": "error",
-      "no-whitespace-before-property": "error",
-      "no-buffer-constructor": "warn",
-      "no-console": "off",
-      "no-constant-condition": "off",
-      "no-multi-spaces": "error",
-      "func-call-spacing": "error",
-      "no-trailing-spaces": "error",
-      "no-undef": "error",
-      "no-unneeded-ternary": "error",
-      "no-const-assign": "error",
-      "no-useless-rename": "error",
-      "no-dupe-keys": "error",
-      "space-in-parens": [
-        "error",
-        "never"
-      ],
-      "spaced-comment": [
-        "error",
-        "always",
-        {
-          "block": {
-            "markers": [
-              "!"
-            ],
-            "balanced": true
-          }
-        }
-      ],
-      "key-spacing": [
-        "error",
-        {
-          "beforeColon": false,
-          "afterColon": true
-        }
-      ],
-      "comma-spacing": [
-        "error",
-        {
-          "before": false,
-          "after": true
-        }
-      ],
-      "array-bracket-spacing": 1,
-      "arrow-spacing": [
-        "error",
-        {
-          "before": true,
-          "after": true
-        }
-      ],
-      "object-curly-spacing": [
-        "error",
-        "always"
-      ],
-      "comma-dangle": [
-        "error",
-        "never"
-      ],
-      "no-unreachable": "error",
-      "quotes": [
-        "error",
-        "single"
-      ],
-      "quote-props": [
-        "error",
-        "as-needed"
-      ],
-      "semi": "error",
-      "no-extra-semi": "error",
-      "semi-spacing": "error",
-      "no-spaced-func": "error",
-      "no-throw-literal": "error",
-      "space-before-blocks": "error",
-      "space-before-function-paren": [
-        "error",
-        "never"
-      ],
-      "space-infix-ops": "error",
-      "space-unary-ops": "error",
-      "no-var": "warn",
-      "prefer-const": "warn",
-      "strict": [
-        "error",
-        "global"
-      ],
-      "no-restricted-globals": [
-        "error",
-        {
-          "name": "context",
-          "message": "Don't use Mocha's global context"
-        }
-      ],
-      "no-prototype-builtins": "off",
-      "mocha-no-only/mocha-no-only": [
-        "error"
-      ]
-    }
-  },
   "config": {
     "mongodbMemoryServer": {
       "disablePostinstall": true
@@ -249,5 +105,17 @@
   "funding": {
     "type": "opencollective",
     "url": "https://opencollective.com/mongoose"
+  },
+  "tsd": {
+    "directory": "test/types",
+    "compilerOptions": {
+      "esModuleInterop": false,
+      "strict": true,
+      "allowSyntheticDefaultImports": true,
+      "strictPropertyInitialization": false,
+      "noImplicitAny": false,
+      "module": "commonjs",
+      "target": "ES2017"
+    }
   }
 }

package/tools/repl.js

@@ -11,7 +11,7 @@ async function run () {
   // Create new instance
   const replSet = new ReplSet({
     binary: {
-      version: process.argv[3]
+      version: process.argv[2]
     },
     instanceOpts: [
       // Set the expiry job in MongoDB to run every second

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "paths": {
+      "mongoose" : ["./types/index.d.ts"]
+    }
+  },
+  "strictNullChecks": true
+}

package/types/PipelineStage.d.ts

@@ -0,0 +1,272 @@
+declare module 'mongoose' {
+    /**
+     * [Stages reference](https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/#aggregation-pipeline-stages)
+     */
+    export type PipelineStage =
+      | PipelineStage.AddFields
+      | PipelineStage.Bucket
+      | PipelineStage.BucketAuto
+      | PipelineStage.CollStats
+      | PipelineStage.Count
+      | PipelineStage.Facet
+      | PipelineStage.GeoNear
+      | PipelineStage.GraphLookup
+      | PipelineStage.Group
+      | PipelineStage.IndexStats
+      | PipelineStage.Limit
+      | PipelineStage.ListSessions
+      | PipelineStage.Lookup
+      | PipelineStage.Match
+      | PipelineStage.Merge
+      | PipelineStage.Out
+      | PipelineStage.PlanCacheStats
+      | PipelineStage.Project
+      | PipelineStage.Redact
+      | PipelineStage.ReplaceRoot
+      | PipelineStage.ReplaceWith
+      | PipelineStage.Sample
+      | PipelineStage.Search
+      | PipelineStage.Set
+      | PipelineStage.SetWindowFields
+      | PipelineStage.Skip
+      | PipelineStage.Sort
+      | PipelineStage.SortByCount
+      | PipelineStage.UnionWith
+      | PipelineStage.Unset
+      | PipelineStage.Unwind
+
+    export namespace PipelineStage {
+      export interface AddFields {
+        /** [`$addFields` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/addFields/) */
+        $addFields: Record<string, any>
+      }
+
+      export interface Bucket {
+        /** [`$bucket` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/bucket/) */
+        $bucket: {
+          groupBy: any
+          boundaries: any[]
+          default?: any
+          output?: Record<string, { [op in AccumulatorOperator]?: any }>
+        }
+      }
+
+      export interface BucketAuto {
+        /** [`$bucketAuto` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/bucketAuto/) */
+        $bucketAuto: {
+          groupBy: any
+          buckets: number
+          output?: Record<string, { [op in AccumulatorOperator]?: any }>
+          granularity?: 'R5' | 'R10' | 'R20' | 'R40' | 'R80' | '1-2-5' | 'E6' | 'E12' | 'E24' | 'E48' | 'E96' | 'E192' | 'POWERSOF2'
+        }
+      }
+
+      export interface CollStats {
+        /** [`$collStats` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/collStats/) */
+        $collStats: {
+          latencyStats?: { histograms?: boolean }
+          storageStats?: { scale?: number }
+          count?: {}
+          queryExecStats?: {}
+        }
+      }
+
+      export interface Count {
+        /** [`$count` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/count/) */
+        $count: string
+      }
+
+      export interface Facet {
+        /** [`$facet` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/facet/) */
+        $facet: Record<string, FacetPipelineStage[]>
+      }
+
+      export type FacetPipelineStage = Exclude<PipelineStage, PipelineStage.CollStats | PipelineStage.Facet | PipelineStage.GeoNear | PipelineStage.IndexStats | PipelineStage.Out | PipelineStage.Merge | PipelineStage.PlanCacheStats>
+
+      export interface GeoNear {
+        /** [`$geoNear` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/geoNear/) */
+        $geoNear: {
+          near: { type: 'Point'; coordinates: [number, number] } | [number, number]
+          distanceField: string
+          distanceMultiplier?: number
+          includeLocs?: string
+          key?: string
+          maxDistance?: number
+          minDistance?: number
+          query?: AnyObject
+          spherical?: boolean
+          uniqueDocs?: boolean
+        }
+      }
+
+      export interface GraphLookup {
+        /** [`$graphLookup` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/graphLookup/) */
+        $graphLookup: {
+          from: string
+          startWith: any
+          connectFromField: string
+          connectToField: string
+          as: string
+          maxDepth?: number
+          depthField?: string
+          restrictSearchWithMatch?: AnyObject
+        }
+      }
+
+      export interface Group {
+        /** [`$group` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/group) */
+        $group: { _id: any } | { [key: string]: { [op in AccumulatorOperator]?: any } }
+      }
+
+      export interface IndexStats {
+        /** [`$indexStats` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/indexStats/) */
+        $indexStats: {}
+      }
+
+      export interface Limit {
+        /** [`$limit` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/limit/) */
+        $limit: number
+      }
+
+      export interface ListSessions {
+        /** [`$listSessions` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/listSessions/) */
+        $listSessions: { users?: { user: string; db: string }[] } | { allUsers?: true }
+      }
+
+      export interface Lookup {
+        /** [`$lookup` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/lookup/) */
+        $lookup: {
+          from: string
+          as: string
+          localField?: string
+          foreignField?: string
+          let?: Record<string, any>
+          pipeline?: Exclude<PipelineStage, PipelineStage.Merge | PipelineStage.Out | PipelineStage.Search>[]
+        }
+      }
+
+      export interface Match {
+        /** [`$match` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/match/) */
+        $match: AnyObject
+      }
+
+      export interface Merge {
+        /** [`$merge` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/merge/) */
+        $merge: {
+          into: string | { db: string; coll: string }
+          on?: string | string[]
+          let?: Record<string, any>
+          whenMatched?: 'replace' | 'keepExisting' | 'merge' | 'fail' | Extract<PipelineStage, PipelineStage.AddFields | PipelineStage.Set | PipelineStage.Project | PipelineStage.Unset | PipelineStage.ReplaceRoot | PipelineStage.ReplaceWith>[]
+          whenNotMatched?: 'insert' | 'discard' | 'fail'
+        }
+      }
+
+      export interface Out {
+        /** [`$out` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/out/) */
+        $out: string | { db: string; coll: string }
+      }
+
+      export interface PlanCacheStats {
+        /** [`$planCacheStats` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/planCacheStats/) */
+        $planCacheStats: {}
+      }
+
+      export interface Project {
+        /** [`$project` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/project/) */
+        $project: { [field: string]: any }
+      }
+
+      export interface Redact {
+        /** [`$redact` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/redact/) */
+        $redact: any
+      }
+
+      export interface ReplaceRoot {
+        /** [`$replaceRoot` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/replaceRoot/) */
+        $replaceRoot: { newRoot: any }
+      }
+
+      export interface ReplaceWith {
+        /** [`$replaceWith` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/replaceWith/) */
+        $replaceWith: any
+      }
+
+      export interface Sample {
+        /** [`$sample` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/sample/) */
+        $sample: { size: number }
+      }
+
+      export interface Search {
+        /** [`$search` reference](https://docs.atlas.mongodb.com/reference/atlas-search/query-syntax/) */
+        $search: {
+          index?: string;
+          highlight?: {
+          /** [`highlightPath` reference](https://docs.atlas.mongodb.com/atlas-search/path-construction/#multiple-field-search) */
+            path: string | string[] | { value: string, multi: string};
+            maxCharsToExamine?: number;
+            maxNumPassages?: number;
+          };
+          [key: string]: any;
+        }
+      }
+
+      export interface Set {
+        /** [`$set` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/set/) */
+        $set: Record<string, any>
+      }
+
+      export interface SetWindowFields {
+        /** [`$setWindowFields` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/setWindowFields/) */
+        $setWindowFields: {
+          partitionBy?: any
+          sortBy?: Record<string, 1 | -1>
+          output: Record<
+            string,
+            { [op in WindowOperator]?: any } & {
+              window?: {
+                documents?: [string | number, string | number]
+                range?: [string | number, string | number]
+                unit?: 'year' | 'quarter' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second' | 'millisecond'
+              }
+            }
+          >
+        }
+      }
+
+      export interface Skip {
+        /** [`$skip` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/skip/) */
+        $skip: number
+      }
+
+      export interface Sort {
+        /** [`$sort` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/sort/) */
+        $sort: Record<string, 1 | -1 | { $meta: 'textScore' }>
+      }
+
+      export interface SortByCount {
+        /** [`$sortByCount` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/sortByCount/) */
+        $sortByCount: any
+      }
+
+      export interface UnionWith {
+        /** [`$unionWith` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/unionWith/) */
+        $unionWith:
+          | string
+          | { coll: string; pipeline?: Exclude<PipelineStage, PipelineStage.Out | PipelineStage.Merge>[] }
+      }
+
+      export interface Unset {
+        /** [`$unset` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/unset/) */
+        $unset: string | string[]
+      }
+
+      export interface Unwind {
+        /** [`$unwind` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/unwind/) */
+        $unwind: string | { path: string; includeArrayIndex?: string; preserveNullAndEmptyArrays?: boolean }
+      }
+
+      type AccumulatorOperator = '$accumulator' | '$addToSet' | '$avg' | '$count' | '$first' | '$last' | '$max' | '$mergeObjects' | '$min' | '$push' | '$stdDevPop' | '$stdDevSamp' | '$sum'
+
+      type WindowOperator = '$addToSet' | '$avg' | '$count' | '$covariancePop' | '$covarianceSamp' | '$derivative' | '$expMovingAvg' | '$integral' | '$max' | '$min' | '$push' | '$stdDevSamp' | '$stdDevPop' | '$sum' | '$first' | '$last' | '$shift' | '$denseRank' | '$documentNumber' | '$rank'
+    }
+  }