fix(index.d.ts): allow strings for ObjectIds in nested properties

Fix #10573
Automattic · Aug 21, 2021 · 6c36263 · 6c36263
1 parent e90aab1
commit 6c36263
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1270,10 +1270,10 @@ declare module 'mongoose' {
     /**
      * Create a new schema
      */
-    constructor(definition?: SchemaDefinition<DocumentDefinition<SchemaDefinitionType>>, options?: SchemaOptions);
+    constructor(definition?: SchemaDefinition<LeanDocument<SchemaDefinitionType>>, options?: SchemaOptions);
 
     /** Adds key path / schema type pairs to this schema. */
-    add(obj: SchemaDefinition<DocumentDefinition<SchemaDefinitionType>> | Schema, prefix?: string): this;
+    add(obj: SchemaDefinition<LeanDocument<SchemaDefinitionType>> | Schema, prefix?: string): this;
 
     /**
      * Array of child schemas (from document arrays and single nested subdocs)
@@ -2587,8 +2587,12 @@ declare module 'mongoose' {
   export type UpdateQuery<T> = (_UpdateQuery<DocumentDefinition<T>> & mongodb.MatchKeysAndValues<DocumentDefinition<T>>);
 
   type _AllowStringsForIds<T> = {
-    [K in keyof T]: [Extract<T[K], mongodb.ObjectId>] extends [never] ? T[K] : T[K] | string;
-  };
+    [K in keyof T]: [Extract<T[K], mongodb.ObjectId>] extends [never]
+      ? T[K] extends TreatAsPrimitives
+        ? T[K]
+        : _AllowStringsForIds<T[K]>
+      : T[K] | string;
+    };
   export type DocumentDefinition<T> = _AllowStringsForIds<LeanDocument<T>>;
 
   type actualPrimitives = string | boolean | number | bigint | symbol | null | undefined;

diff --git a/test/typescript/queries.ts b/test/typescript/queries.ts
@@ -8,7 +8,7 @@ interface QueryHelpers {
 const schema: Schema<ITest, Model<ITest, QueryHelpers>> = new Schema({
   name: { type: 'String' },
   tags: [String],
-  docs: [{ nested: { id: Number, tags: [String] } }],
+  docs: [{ _id: 'ObjectId', id: Number, tags: [String] }],
   endDate: Date
 });
 
@@ -22,6 +22,7 @@ schema.query.byName = function(name: string): QueryWithHelpers<any, ITest> {
 };
 
 interface ISubdoc extends Document {
+  myId?: Types.ObjectId;
   id?: number;
   tags?: string[];
 }
@@ -89,6 +90,8 @@ Test.findOneAndUpdate({ name: 'test' }, [{ $set: { endDate: true } }]);
 
 Test.findByIdAndUpdate({ name: 'test' }, { name: 'test2' }, (err, doc) => console.log(doc));
 
+Test.findOneAndUpdate({ name: 'test' }, { 'docs.0.myId': '0'.repeat(24) });
+
 const query: Query<ITest | null, ITest> = Test.findOne();
 query instanceof Query;