1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
import mongoose, { Schema, model, Document, PopulatedDoc, Types, HydratedDocument, SchemaTypeOptions } from 'mongoose';// Use the mongodb ObjectId to make instanceof calls possibleimport { ObjectId } from 'mongodb';import { expectAssignable, expectError, expectType } from 'tsd';
interface Child {  name: string;}
const childSchema: Schema = new Schema({ name: String });const ChildModel = model<Child>('Child', childSchema);
interface Parent {  child: PopulatedDoc<Document<ObjectId> & Child>,  name?: string}
const ParentModel = model<Parent>('Parent', new Schema({  child: { type: 'ObjectId', ref: 'Child' },  name: String}));
ParentModel.findOne({}).populate('child').orFail().then((doc: Document<ObjectId, {}, Parent> & Parent) => {  const child = doc.child;  if (child == null || child instanceof ObjectId) {    throw new Error('should be populated');  } else {    useChildDoc(child);  }  const lean = doc.toObject();  const leanChild = lean.child;  if (leanChild == null || leanChild instanceof ObjectId) {    throw new Error('should be populated');  } else {    const name = leanChild.name;    expectError(leanChild.save());  }});
function useChildDoc(child: Child): void {  console.log(child.name.trim());}
interface IPerson {  name?: string;  stories?: PopulatedDoc<IStory>[];}
interface IStory {  title?: string;  author?: PopulatedDoc<IPerson>;  fans?: PopulatedDoc<IPerson>[];}
const personSchema = new Schema<IPerson>({  name: String,  stories: [{ type: Schema.Types.ObjectId, ref: 'Story' }]});
const storySchema = new Schema<IStory>({  title: String,  author: { type: Schema.Types.ObjectId, ref: 'Person' },  fans: [{ type: Schema.Types.ObjectId, ref: 'Person' }]});
const Person = model<IPerson>('Person', personSchema);
const Story = model<IStory>('Story', storySchema);
(async() => {  const story = await Story.findOne().orFail();
  await story.populate('author');  await story.populate({ path: 'fans' });  await story.populate({ path: 'fans', model: Person });  await story.populate(['author']);  await story.populate([{ path: 'fans' }]);  await story.populate(['author', { path: 'fans' }]);
  await Story.findOne().populate(['author']);})();
async function documentDepopulate() {  const story = await Story.findOne().populate('author').orFail();
  story.depopulate('author');  story.depopulate(['author']);  story.depopulate();}
async function testPathsParam() {  const story = await Story.findOne().populate<{ author: IPerson }>('author').orFail();
  if (story.author.name === undefined) {    return;  }  const name: string = story.author.name;}
function gh11014() {  interface Parent {    child?: Types.ObjectId    name?: string  }  interface Child {    name: string  }  interface PopulatedParent {    child: Child | null  }  const ParentModel = model<Parent>(    'Parent',    new Schema({      child: { type: 'ObjectId', ref: 'Child' },      name: String    })  );  const childSchema: Schema = new Schema({ name: String });  const ChildModel = model<Child>('Child', childSchema);
  // Populate with `Paths` generic `{ child: Child }` to override `child` path  ParentModel.find({})    .populate<{ child: Child }>('child')    .orFail()    .then(parents => {      parents.map(p => p.child.name);    });}
function gh11321(): void {  interface Parent {    child?: ObjectId,    name?: string  }
  const parentSchema: Schema<Parent> = new Schema<Parent>({    child: { type: 'ObjectId', ref: 'Child' },    name: String  });
  parentSchema.virtual('test', {    localField: (doc: HydratedDocument<Parent, {}>): string => {      if (typeof doc.name === 'string') {        return doc.name;      }      return 'foo';    },    foreignField: (doc: HydratedDocument<Parent, {}>): string => {      if (typeof doc.name === 'string') {        return doc.name;      }      return 'foo';    }  });}
function gh11503() {  interface Friend {    blocked: boolean  }  const FriendSchema = new Schema<Friend>({    blocked: Boolean  });
  interface IUser {    friends: Types.ObjectId[];  }  const userSchema = new Schema<IUser>({    friends: [{ type: Schema.Types.ObjectId, ref: 'friends' }]  });  const User = model<IUser>('friends', userSchema);
  User.findOne({}).populate('friends').then(user => {    if (!user) return;    expectType<Types.ObjectId>(user?.friends[0]);    expectError(user?.friends[0].blocked);    expectError(user?.friends.map(friend => friend.blocked));  });
  User.findOne({}).populate<{ friends: Friend[] }>('friends').then(user => {    if (!user) return;    expectAssignable<Friend>(user?.friends[0]);    expectType<boolean>(user?.friends[0].blocked);    const firstFriendBlockedValue = user?.friends.map(friend => friend)[0];    expectType<boolean>(firstFriendBlockedValue?.blocked);  });}

function gh11544() {  interface IUser {    friends: Types.ObjectId[];  }  const userSchema = new Schema<IUser>({    friends: [{ type: Schema.Types.ObjectId, ref: 'friends' }]  });  const User = model<IUser>('friends', userSchema);
  User.findOne({}).populate({ path: 'friends', strictPopulate: false });  User.findOne({}).populate({ path: 'friends', strictPopulate: true });  User.findOne({}).populate({ path: 'friends', populate: { path: 'someNestedPath', strictPopulate: false } });}
function gh11862() {  interface IUser {    userType: string;    friend: Types.ObjectId;  }
  const t: SchemaTypeOptions<mongoose.Types.ObjectId> = { type: 'ObjectId', refPath: 'userType' };
  const userSchema = new Schema<IUser>({    userType: String,    friend: { type: 'ObjectId', refPath: 'userType' }  });  const User = model<IUser>('friends', userSchema);
  User.findOne({}).populate('friend');}
async function _11532() {  interface IParent {    name: string;    child: Types.ObjectId;  }  interface IChild {    name: string;  }
  const parentSchema = new Schema(    {      name: { type: String, required: true },      child: { type: Schema.Types.ObjectId, ref: 'Child', required: true }    });
  const parent = model<IParent>('Parent', parentSchema);
  const populateQuery = parent.findOne().populate<{ child: IChild }>('child');  const populateResult = await populateQuery;  const leanResult = await populateQuery.lean();
  if (!populateResult) return;  expectType<string>(populateResult.child.name);
  if (!leanResult) return;  expectType<string>(leanResult.child.name);  expectError(leanResult?.__v);}
async function gh11710() {
  // `Parent` represents the object as it is stored in MongoDB  interface Parent {    child?: Types.ObjectId,    name?: string  }  interface Child {    name: string;  }  interface PopulatedParent {    child: Child | null;  }  const ParentModel = model<Parent>('Parent', new Schema({    child: { type: Schema.Types.ObjectId, ref: 'Child' },    name: String  }));  const childSchema: Schema = new Schema({ name: String });  const ChildModel = model<Child>('Child', childSchema);
  // Populate with `Paths` generic `{ child: Child }` to override `child` path  const doc = await ParentModel.findOne({}).populate<Pick<PopulatedParent, 'child'>>('child').orFail();  expectType<Child | null>(doc.child);}
async function gh11758() {  interface NestedChild {    name: string    _id: Types.ObjectId  }  const nestedChildSchema: Schema = new Schema({ name: String });
  interface Parent {    nestedChild: Types.ObjectId    name?: string  }
  const ParentModel = model<Parent>('Parent', new Schema({    nestedChild: { type: Schema.Types.ObjectId, ref: 'NestedChild' },    name: String  }));
  const NestedChildModel = model<NestedChild>('NestedChild', nestedChildSchema);
  const parent = new ParentModel({    nestedChild: new NestedChildModel({ name: 'test' }),    name: 'Parent'  }).$assertPopulated<{ nestedChild: NestedChild }>('nestedChild');
  expectType<string>(parent.nestedChild.name);
  await parent.save();}
async function gh11955() {  // `Parent` represents the object as it is stored in MongoDB  interface Parent {    children?: Types.ObjectId[],    name?: string  }
  const ParentModel = model<Parent>('Parent', new Schema({    children: [{ type: Schema.Types.ObjectId, ref: 'Child' }],    name: String  }));
  interface Child {    name: string;  }  const childSchema: Schema = new Schema({ name: String });  model<Child>('Child', childSchema);
  const parent = await ParentModel.findOne({}).exec();
  const populatedParent = await parent!.populate<{ children: Child[] }>('child');
  populatedParent.children.find(({ name }) => console.log(name));}
function gh12136() {  type ChildDocument = Child & Document;  type ParentDocument = Parent & Document;
  class Child {    parent: PopulatedDoc<ParentDocument>;  }
  class Parent {    child: PopulatedDoc<ChildDocument>;  }
}