fix(NODE-6690): Remove extraneous Document in replaceOne return type

[arturmuller]

Description

What is changing?

Type signature of replaceOne method no longer includes the general Document type. There doesn't seem to be any reason for the Document type to be included, as:

1. returning a document from the replaceOne method is not documented anywhere
2. it is not consistent with other methods
3. based on Git history seems like an accident

Note: If the method indeed can return Document in some circumstances, perhaps it would be worth documenting in which situations that can happen, and perhaps type it with TSchema to follow the stronger typing of other methods like find and findOne.

Is there new documentation needed for these changes?

No. The docs already match my proposed change.

What is the motivation for this change?

More accurate typing is always helpful! Currently, TS is complaining about the return type when replaceOne is used in places which expect UpdateResult<TSchema> because of the extraneous Document, which makes using it awkward.

Release Highlight

Remove extraneous Promise<Document> in Collection.replaceOne return type

The return type signature of the replaceOne method no longer includes the general Promise<Document> type. Thanks to @arturmuller, the replaceOne type signature is now more accurate! 🎉

Double check the following

• Ran npm run check:lint script
• Self-review completed using the steps outlined here
• PR title follows the correct format: type(NODE-xxxx)[!]: description
  • Wasn't able to create a ticket. Not sure what I am doing wrong 😅
• Changes are covered by tests
• New TODOs have a related JIRA ticket

[aditi-khare-mongoDB]

Thanks for your submission @arturmuller!

You’re right, the replaceOne method's signature was imprecise and accurate typing is always important! Thanks again for catching this and submitting the improvement.

[aditi-khare-mongoDB]

I'll merge this once the tests finish running!