feat: add support for declaring search indexes

[noseworthy]

MongoDB and mongoose now support adding search indexes to collections. Introduce a new decorator @searchIndex() that, similar to @index, adds a search index to a collection.

Search index support was added to mongoose in version 8.1.0, however the type definition for Schema.searchIndex() didn't exist until 8.2.3. Therefore in order to support this feature, update the mongoose dependencies to ~8.2.3.

Related Issues

• N/A

[noseworthy]

@hasezoey : Sorry, the typings sort of got out of hand here. I can totally remove all that if you'd like. I know it's probably not typegoose's responsibility. The typings in the mongo driver were so lacklustre though and when developing this I had to build up my own mental map of what was going on.

Anyway, It's pretty easy to simplify if you'd like. I can try and open a PR into the mongo driver repo and see if they'll take them on haha.

Also, wasn't sure how to handle the requirement on mongoose 8.2.3. Let me know if I should've done something different there.

Finally, thanks so much for your work on typegoose and mongoose. These libraries are fantastic 😄

[hasezoey]

Thanks for the work, there are some small things i have noticed and put some comments up, aside from that there is also:

• the new documentation page has not been added to the sidebars yet
• i would prefer if those extra types could be upstreamed to mongoose (or even mongodb?)
• some places have been missed for the changed mongoose version

i will put up a update on the beta branch, please target that as a base

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.67%. Comparing base (1e4d282) to head (95056d1).
Report is 1 commits behind head on beta.

❗ Current head 95056d1 differs from pull request most recent head eb324f3. Consider uploading reports for the commit eb324f3 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             beta     #921      +/-   ##
==========================================
+ Coverage   98.65%   98.67%   +0.02%     
==========================================
  Files          17       18       +1     
  Lines         967      984      +17     
  Branches      261      252       -9     
==========================================
+ Hits          954      971      +17     
  Misses         13       13              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[hasezoey]

i will not be able to upgrade mongoose until Automattic/mongoose#14463 is merged and released (the same cause on why the test CI failed here)

[noseworthy]

Thanks for the review @hasezoey ! I think I've addressed all the comments. I see that the beta branch is still a ways behind master, so once that updates I'll rebase on top of that.

I've created NODE-6044 in the mongodb jira and an associated PR. We'll see how the mongo team feels about that. It'd be great to have more detailed types other than just bson.Document for the search index definition 😅.

I've opened another PR in mongoose to re-export the SearchIndexDescription type from mongodb so that all three projects can stay in sync. Since I don't currently have access to this type, I've created a copy for the time being, but if that PR gets merged then I'll just remove the copy.

Thanks again for your patience with this and your review. I apologize in advance if there's any more dumb issues or if I've missed something. Still getting my feet under me in this repo 😅!

[hasezoey]

I think I've addressed all the comments.

from what i can see, yes

I see that the beta branch is still a ways behind master, so once that updates I'll rebase on top of that.

i dont want to push broken test commits, so i have not pushed the mongoose 8.2.3 update there and wait until Automattic/mongoose#14463 is resolved.
for the same reason this PR will likely not get merged for now.

[hasezoey]

slight update, Automattic/mongoose#14463 has been merged, now just waiting until 8.2.4 is released

[hasezoey]

the mongoose version 8.2.4 has been released and the beta branch has been updated (and also released as v12.3.0-beta.1), please rebase onto that

PS: also dont forgot the set the PR base branch to beta (if not done, i will do it later)

[noseworthy]

All done, @hasezoey! Thanks again for helping review this change. If there's anything else you'd like done, just let me know.

[github-actions]

🎉 This PR is included in version 12.3.0-beta.2 🎉

The release is available on:

• npm package (@beta dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version 12.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀