History.md

@@ -1,3 +1,126 @@
+5.13.14 / 2021-12-27
+====================
+ * fix(timestamps): avoid setting createdAt on documents that already exist but dont have createdAt #11024
+ * docs(models): fix up nModified example for 5.x #11055
+
+5.13.13 / 2021-11-02
+====================
+ * fix: upgrade to mongodb@3.7.3 #10909 [gaurav-sharma-gs](https://github.com/gaurav-sharma-gs)
+ * fix: correctly emit end event in before close #10916 [iovanom](https://github.com/iovanom)
+ * fix(index.d.ts): improve ts types for query set #10942 [jneal-afs](https://github.com/jneal-afs)
+
+5.13.12 / 2021-10-19
+====================
+ * fix(cursor): use stream destroy method on close to prevent emitting duplicate 'close' #10897 [iovanom](https://github.com/iovanom)
+ * fix(index.d.ts): backport streamlining of FilterQuery and DocumentDefinition to avoid "excessively deep and possibly infinite" TS errors #10617
+
+5.13.11 / 2021-10-12
+====================
+ * fix: upgrade mongodb -> 3.7.2 #10871 [winstonralph](https://github.com/winstonralph)
+ * fix(connection): call setMaxListeners(0) on MongoClient to avoid event emitter memory leak warnings with `useDb()` #10732
+
+5.13.10 / 2021-10-05
+====================
+ * fix(index.d.ts): allow using type: SchemaDefinitionProperty in schema definitions #10674
+ * fix(index.d.ts): allow AnyObject as param to findOneAndReplace() #10714
+
+5.13.9 / 2021-09-06
+===================
+ * fix(populate): avoid setting empty array on lean document when populate result is undefined #10599
+ * fix(document): make depopulate() handle populated paths underneath document arrays #10592
+ * fix: peg @types/bson version to 1.x || 4.0.x to avoid stubbed 4.2.x release #10678
+ * fix(index.d.ts): simplify UpdateQuery to avoid "excessively deep and possibly infinite" errors with `extends Document` and `any` #10647
+ * fix(index.d.ts): allow specifying weights as an IndexOption #10586
+ * fix: upgrade to mpath v0.8.4 re: security issue #10683
+
+5.13.8 / 2021-08-23
+===================
+ * fix(populate): handle populating subdoc array virtual with sort #10552
+ * fix(model): check for code instead of codeName when checking for existing collections for backwards compat with MongoDB 3.2 #10420
+ * fix(index.d.ts): correct value of this for custom query helper methods #10545
+ * fix(index.d.ts): allow strings for ObjectIds in nested properties #10573
+ * fix(index.d.ts): add match to VirtualTypeOptions.options #8749
+ * fix(index.d.ts): allow QueryOptions populate parameter type PopulateOptions #10587 [osmanakol](https://github.com/osmanakol)
+ * docs(api): add Document#$where to API docs #10583
+
+5.13.7 / 2021-08-11
+===================
+ * perf(index.d.ts): loosen up restrictions on ModelType generic for Schema for a ~50% perf improvement when compiling TypeScript and using intellisense #10536 #10515 #10349
+ * fix(index.d.ts): fix broken `Schema#index()` types #10562 [JaredReisinger](https://github.com/JaredReisinger)
+ * fix(index.d.ts): allow using SchemaTypeOptions with array of raw document interfaces #10537
+ * fix(index.d.ts): define IndexOptions in terms of mongodb.IndexOptions #10563 [JaredReisinger](https://github.com/JaredReisinger)
+ * fix(index.d.ts): improve intellisense for DocumentArray `push()` #10546
+ * fix(index.d.ts): correct type for expires #10529
+ * fix(index.d.ts): add Query#model property to ts bindings #10531
+ * refactor(index.d.ts): make callbacks use the new Callback and CallbackWithoutResult types #10550 [thiagokisaki](https://github.com/thiagokisaki)
+
+5.13.6 / 2021-08-09
+===================
+ * fix: upgrade mongodb driver -> 3.6.11 #10543 [maon-fp](https://github.com/maon-fp)
+ * fix(schema): throw more helpful error when defining a document array using a schema from a different copy of the Mongoose module #10453
+ * fix: add explicit check on constructor property to avoid throwing an error when checking objects with null prototypes #10512
+ * fix(cursor): make sure to clear stack every 1000 docs when calling `next()` to avoid stack overflow with large batch size #10449
+ * fix(index.d.ts): improve types of Schema#(g|s)et #10555 [thiagokisaki](https://github.com/thiagokisaki)
+ * fix(index.d.ts): allow calling new Model(...) with generic Model param #10526
+ * fix(index.d.ts): update type declarations of Schema.index method #10538 #10530 [Raader](https://github.com/Raader)
+ * fix(index.d.ts): add useNewUrlParser and useUnifiedTopology to ConnectOptions #10500
+ * fix(index.d.ts): add missing type for diffIndexes #10547 [bvgusak](https://github.com/bvgusak)
+ * fix(index.d.ts): fixed incorrect type definition for Query's .map function #10544 [GCastilho](https://github.com/GCastilho)
+ * docs(schema): add more info and examples to Schema#indexes() docs #10446
+ * chore: add types property to package.json #10557 [thiagokisaki](https://github.com/thiagokisaki)
+
+5.13.5 / 2021-07-30
+===================
+ * perf(index.d.ts): improve typescript type checking performance #10515 [andreialecu](https://github.com/andreialecu)
+ * fix(index.d.ts): fix debug type in MongooseOptions #10510 [thiagokisaki](https://github.com/thiagokisaki)
+ * docs(api): clarify that `depopulate()` with no args depopulates all #10501 [gfrancz](https://github.com/gfrancz)
+
+5.13.4 / 2021-07-28
+===================
+ * fix: avoid pulling non-schema paths from documents into nested paths #10449
+ * fix(update): support overwriting nested map paths #10485
+ * fix(update): apply timestamps to subdocs that would be newly created by `$setOnInsert` #10460
+ * fix(map): correctly clone subdocs when calling toObject() on a map #10486
+ * fix(cursor): cap parallel batchSize for populate at 5000 #10449
+ * fix(index.d.ts): improve autocomplete for new Model() by making `doc` an object with correct keys #10475
+ * fix(index.d.ts): add MongooseOptions interface #10471 [thiagokisaki](https://github.com/thiagokisaki)
+ * fix(index.d.ts): make LeanDocument work with PopulatedDoc #10494
+ * docs(mongoose+connection): correct default value for bufferTimeoutMS #10476
+ * chore: remove unnecessary 'eslint-disable' comments #10466 [thiagokisaki](https://github.com/thiagokisaki)
+
+5.13.3 / 2021-07-16
+===================
+ * fix(model): avoid throwing error when bulkSave() called on a document with no changes #10437
+ * fix(timestamps): apply timestamps when creating new subdocs with `$addToSet` and with positional operator #10447
+ * fix(schema): allow calling Schema#loadClass() with class that has a static getter with no setter #10436
+ * fix(model): handle re-applying object defaults after explicitly unsetting #10442 [semirturgay](https://github.com/semirturgay)
+ * fix: bump mongodb driver -> 3.6.10 #10440 [AbdelrahmanHafez](https://github.com/AbdelrahmanHafez)
+ * fix(index.d.ts): consistently use NativeDate instead of Date for Date validators and timestamps functions #10426
+ * fix(index.d.ts): allow calling `discriminator()` with non-document #10452 #10421 [DouglasGabr](https://github.com/DouglasGabr)
+ * fix(index.d.ts): allow passing ResultType generic to Schema#path() #10435
+
+5.13.2 / 2021-07-03
+===================
+ * fix: hardcode @types/node version for now to avoid breaking changes from DefinitelyTyped/DefinitelyTyped#53669 #10415
+ * fix(index.d.ts): allow using type: Date with Date paths in SchemaDefinitionType #10409
+ * fix(index.d.ts): allow extra VirtualTypeOptions for better plugin support #10412
+ * docs(api): add SchemaArray to docs #10397
+ * docs(schema+validation): fix broken links #10396
+ * docs(transactions): add note about creating a connection to transactions docs #10406
+
+5.13.1 / 2021-07-02
+===================
+ * fix(discriminator): allow using array as discriminator key in schema and as tied value #10303
+ * fix(index.d.ts): allow using & Document in schema definition for required subdocument arrays #10370
+ * fix(index.d.ts): if using DocType that doesn't extends Document, default to returning that DocType from `toObject()` and `toJSON()` #10345
+ * fix(index.d.ts): use raw DocType instead of LeanDocument when using `lean()` with queries if raw DocType doesn't `extends Document` #10345
+ * fix(index.d.ts): remove err: any in callbacks, use `err: CallbackError` instead #10340
+ * fix(index.d.ts): allow defining map of schemas in TypeScript #10389
+ * fix(index.d.ts): correct return type for Model.createCollection() #10359
+ * docs(promises+discriminators): correctly escape () in regexp to pull in examples correctly #10364
+ * docs(update): fix outdated URL about unindexed upsert #10406 [grimmer0125](https://github.com/grimmer0125)
+ * docs(index.d.ts): proper placement of mongoose.Date JSDoc [thiagokisaki](https://github.com/thiagokisaki)
+
 5.13.0 / 2021-06-28
 ===================
  * feat(query): add sanitizeProjection option to opt in to automatically sanitizing untrusted query projections #10243

Makefile

@@ -41,10 +41,16 @@ copytmp:
 	mkdir -p ./tmp/docs/css
 	mkdir -p ./tmp/docs/js
 	mkdir -p ./tmp/docs/images
+	mkdir -p ./tmp/docs/api
+	mkdir -p ./tmp/docs/tutorials
+	mkdir -p ./tmp/docs/typescript
 	cp -R ./docs/*.html ./tmp/docs
 	cp -R ./docs/css/*.css ./tmp/docs/css
 	cp -R ./docs/js/*.js ./tmp/docs/js
 	cp -R ./docs/images/* ./tmp/docs/images
+	cp -R ./docs/api/* ./tmp/docs/api
+	cp -R ./docs/tutorials/* ./tmp/docs/tutorials
+	cp -R ./docs/typescript/* ./tmp/docs/typescript
 	cp index.html ./tmp
 
 gitreset:

docs/discriminators.md

@@ -15,7 +15,7 @@ key (defaults to the model name). It returns a model whose schema
 is the union of the base schema and the discriminator schema.
 
 ```javascript
-[require:The `model.discriminator()` function]
+[require:The `model.discriminator\(\)` function]
 ```
 
 ### Discriminators save to the Event model's collection