mongoose 8.2.2 → 8.2.3

package/lib/schema.js

@@ -1220,10 +1220,18 @@ function _getPath(schema, path, cleanPath) {
     return schema.paths[path];
   }
   if (schema.subpaths.hasOwnProperty(cleanPath)) {
-    return schema.subpaths[cleanPath];
+    const subpath = schema.subpaths[cleanPath];
+    if (subpath === 'nested') {
+      return undefined;
+    }
+    return subpath;
   }
   if (schema.singleNestedPaths.hasOwnProperty(cleanPath) && typeof schema.singleNestedPaths[cleanPath] === 'object') {
-    return schema.singleNestedPaths[cleanPath];
+    const singleNestedPath = schema.singleNestedPaths[cleanPath];
+    if (singleNestedPath === 'nested') {
+      return undefined;
+    }
+    return singleNestedPath;
   }
 
   return null;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.2.2",
+  "version": "8.2.3",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -86,14 +86,13 @@
     "docs:checkout:5x": "git checkout 5.x",
     "docs:checkout:6x": "git checkout 6.x",
     "docs:generate": "node ./scripts/website.js",
-    "docs:generate:search": "node ./scripts/generateSearch.js",
     "docs:generate:sponsorData": "node ./scripts/loadSponsorData.js",
     "docs:merge:stable": "git merge master",
     "docs:merge:5x": "git merge 5.x",
     "docs:merge:6x": "git merge 6.x",
-    "docs:test": "npm run docs:generate && npm run docs:generate:search",
+    "docs:test": "npm run docs:generate",
     "docs:view": "node ./scripts/static.js",
-    "docs:prepare:publish:stable": "npm run docs:checkout:gh-pages && npm run docs:merge:stable && npm run docs:generate && npm run docs:generate:search",
+    "docs:prepare:publish:stable": "npm run docs:checkout:gh-pages && npm run docs:merge:stable && npm run docs:generate",
     "docs:prepare:publish:5x": "npm run docs:checkout:5x && npm run docs:merge:5x && npm run docs:clean:stable && npm run docs:generate && npm run docs:copy:tmp && npm run docs:checkout:gh-pages && npm run docs:copy:tmp:5x",
     "docs:prepare:publish:6x": "npm run docs:checkout:6x && npm run docs:merge:6x && npm run docs:clean:stable && env DOCS_DEPLOY=true npm run docs:generate && npm run docs:move:6x:tmp && npm run docs:checkout:gh-pages && npm run docs:copy:tmp:6x",
     "docs:prepare:publish:7x": "env DOCS_DEPLOY=true npm run docs:generate && npm run docs:checkout:gh-pages && rimraf ./docs/7.x && mv ./tmp ./docs/7.x",

package/types/index.d.ts

@@ -274,6 +274,13 @@ declare module 'mongoose' {
     /** Defines an index (most likely compound) for this schema. */
     index(fields: IndexDefinition, options?: IndexOptions): this;
 
+    /**
+     * Define a search index for this schema.
+     *
+     * @remarks Search indexes are only supported when used against a 7.0+ Mongo Atlas cluster.
+     */
+    searchIndex(description: mongodb.SearchIndexDescription): this;
+
     /**
      * Returns a list of indexes that this schema declares, via `schema.index()`
      * or by `index: true` in a path's options.

package/types/query.d.ts

@@ -1,8 +1,20 @@
 declare module 'mongoose' {
   import mongodb = require('mongodb');
 
-  export type ApplyBasicQueryCasting<T> = T | T[] | (T extends (infer U)[] ? U : any) | any;
-  type Condition<T> = ApplyBasicQueryCasting<T> | QuerySelector<ApplyBasicQueryCasting<T>>;
+  type StringQueryTypeCasting = string | RegExp;
+  type ObjectIdQueryTypeCasting = Types.ObjectId | string;
+  type UUIDQueryTypeCasting = Types.UUID | string;
+
+  type QueryTypeCasting<T> = T extends string
+    ? StringQueryTypeCasting
+    : T extends Types.ObjectId
+      ? ObjectIdQueryTypeCasting
+      : T extends Types.UUID
+        ? UUIDQueryTypeCasting
+        : T | any;
+
+  export type ApplyBasicQueryCasting<T> = T | T[] | (T extends (infer U)[] ? QueryTypeCasting<U> : T);
+  export type Condition<T> = ApplyBasicQueryCasting<QueryTypeCasting<T>> | QuerySelector<ApplyBasicQueryCasting<QueryTypeCasting<T>>>;
 
   type _FilterQuery<T> = {
     [P in keyof T]?: Condition<T[P]>;
@@ -385,7 +397,7 @@ declare module 'mongoose' {
     ): QueryWithHelpers<Array<DocType>, DocType, THelpers, RawDocType, 'find'>;
     find(
       filter: FilterQuery<RawDocType>
-    ): QueryWithHelpers<Array<RawDocType>, DocType, THelpers, RawDocType, 'find'>;
+    ): QueryWithHelpers<Array<DocType>, DocType, THelpers, RawDocType, 'find'>;
     find(): QueryWithHelpers<Array<DocType>, DocType, THelpers, RawDocType, 'find'>;
 
     /** Declares the query a findOne operation. When executed, returns the first found document. */
@@ -481,7 +493,7 @@ declare module 'mongoose' {
     get(path: string): any;
 
     /** Returns the current query filter (also known as conditions) as a POJO. */
-    getFilter(): FilterQuery<RawDocType>;
+    getFilter(): FilterQuery<DocType>;
 
     /** Gets query options. */
     getOptions(): QueryOptions<DocType>;
@@ -490,7 +502,7 @@ declare module 'mongoose' {
     getPopulatedPaths(): Array<string>;
 
     /** Returns the current query filter. Equivalent to `getFilter()`. */
-    getQuery(): FilterQuery<RawDocType>;
+    getQuery(): FilterQuery<DocType>;
 
     /** Returns the current update operations as a JSON object. */
     getUpdate(): UpdateQuery<DocType> | UpdateWithAggregationPipeline | null;

package/types/schemaoptions.d.ts

@@ -24,6 +24,11 @@ declare module 'mongoose' {
      * automatic index builds, you can set autoIndex to false.
      */
     autoIndex?: boolean;
+    /**
+     * Similar to autoIndex, except for automatically creates any Atlas search indexes defined in your
+     * schema. Unlike autoIndex, this option defaults to false.
+     */
+    autoSearchIndex?: boolean;
     /**
      * If set to `true`, Mongoose will call Model.createCollection() to create the underlying collection
      * in MongoDB if autoCreate is set to true. Calling createCollection() sets the collection's default