fix(types): avoid inferring doc type from param to create()

Fix #12001 Re: #11960 Re: #11563
Automattic · Jul 1, 2022 · 9ba3f12 · 9ba3f12
1 parent 39f651c
commit 9ba3f12
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 10 deletions.
diff --git a/test/types/create.test.ts b/test/types/create.test.ts
@@ -5,7 +5,7 @@ const schema: Schema = new Schema({ name: { type: 'String' } });
 
 interface ITest {
   _id?: Types.ObjectId;
-  name?: string;
+  name: string;
 }
 
 const Test = model<ITest>('Test', schema);
@@ -105,7 +105,7 @@ Test.insertMany({ _id: '000000000000000000000000', name: 'test' }, (err, docs) =
 
 Test.insertMany({ _id: new Types.ObjectId('000000000000000000000000') }, (err, docs) => {
   expectType<Types.ObjectId>(docs[0]._id);
-  expectType<string | undefined>(docs[0].name);
+  expectType<string>(docs[0].name);
   expectType<boolean>(docs[0].isNew);
 });
 
@@ -153,13 +153,13 @@ Test.insertMany([{ name: 'test' }], { lean: true }).then(docs => {
 
 Test.insertMany([{ name: 'test' }], { lean: false }).then(docs => {
   expectType<Types.ObjectId>(docs[0]._id);
-  expectType<string | undefined>(docs[0].name);
+  expectType<string>(docs[0].name);
   expectType<boolean>(docs[0].isNew);
 });
 
 Test.insertMany([{ name: 'test' }], { }).then(docs => {
   expectType<Types.ObjectId>(docs[0]._id);
-  expectType<string | undefined>(docs[0].name);
+  expectType<string>(docs[0].name);
   expectType<boolean>(docs[0].isNew);
 });
 

diff --git a/test/types/models.test.ts b/test/types/models.test.ts
@@ -281,7 +281,6 @@ export function autoTypedModel() {
   // Model-functions-test
   // Create should works with arbitrary objects.
     const randomObject = await AutoTypedModel.create({ unExistKey: 'unExistKey', description: 'st' });
-    expectType<string>(randomObject.unExistKey);
     expectType<AutoTypedSchemaType['schema']['userName']>(randomObject.userName);
 
     const testDoc1 = await AutoTypedModel.create({ userName: 'M0_0a' });

diff --git a/types/models.d.ts b/types/models.d.ts
@@ -163,11 +163,11 @@ declare module 'mongoose' {
     countDocuments(callback?: Callback<number>): QueryWithHelpers<number, HydratedDocument<T, TMethodsAndOverrides, TVirtuals>, TQueryHelpers, T>;
 
     /** Creates a new document or documents */
-    create<DocContents = T>(docs: Array<T | DocContents>, options?: SaveOptions): Promise<HydratedDocument<MergeType<MergeType<T, DocContents>, RequireOnlyTypedId<T>>, TMethodsAndOverrides, TVirtuals>[]>;
-    create<DocContents = T>(docs: Array<T | DocContents>, callback: Callback<HydratedDocument<MergeType<MergeType<T, DocContents>, RequireOnlyTypedId<T>>, TMethodsAndOverrides, TVirtuals>[]>): void;
-    create<DocContents = T>(doc: DocContents | T): Promise<HydratedDocument<MergeType<MergeType<T, DocContents>, RequireOnlyTypedId<T>>, TMethodsAndOverrides, TVirtuals>>;
-    create<DocContents = T>(...docs: Array<T | DocContents>): Promise<HydratedDocument<MergeType<MergeType<T, DocContents>, RequireOnlyTypedId<T>>, TMethodsAndOverrides, TVirtuals>[]>;
-    create<DocContents = T>(doc: T | DocContents, callback: Callback<HydratedDocument<MergeType<MergeType<T, DocContents>, RequireOnlyTypedId<T>>, TMethodsAndOverrides, TVirtuals>>): void;
+    create<DocContents = AnyKeys<T>>(docs: Array<T | DocContents>, options?: SaveOptions): Promise<HydratedDocument<T, TMethodsAndOverrides, TVirtuals>[]>;
+    create<DocContents = AnyKeys<T>>(docs: Array<T | DocContents>, callback: Callback<HydratedDocument<T, TMethodsAndOverrides, TVirtuals>[]>): void;
+    create<DocContents = AnyKeys<T>>(doc: DocContents | T): Promise<HydratedDocument<T, TMethodsAndOverrides, TVirtuals>>;
+    create<DocContents = AnyKeys<T>>(...docs: Array<T | DocContents>): Promise<HydratedDocument<T, TMethodsAndOverrides, TVirtuals>[]>;
+    create<DocContents = AnyKeys<T>>(doc: T | DocContents, callback: Callback<HydratedDocument<T, TMethodsAndOverrides, TVirtuals>>): void;
 
     /**
    * Create the collection for this model. By default, if no indexes are specified,