fix(NODE-4513): type for nested objects in query & update

[jer-sen]

Description

Fix type for nested objects in query & update added in #3328

What is changing?

• Support union types (... extends unknown ? ... : never)
• Fail if path is wrong (never vs unknown)
• Support array operators in the middle of a path (number replaced by number | $${'' | [${string}]} and NestedPathsOfType removed)

Is there new documentation needed for these changes?

No

What is the motivation for this change?

const _: MatchKeysAndValues<{ aaa: readonly { bbb: 'ccc' }[] }> = { 'aaa.$.bbb': 'ccc' }; // Error
const _: MatchKeysAndValues<{ aaa: { bbb: { ccc: 'ddd'[] }[] }> = { 'aaa.$.bbb.$[arrayFilter]': 'ddd' }; // Error

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>
• Changes are covered by tests
• New TODOs have a related JIRA ticket

[nbbeeken]

Hi @jer-sen, thanks so much for your help with our types! Would it be possible to add some tests to demonstrate the fix?
We use tsd to check our types, the files: test/types/community/collection/filterQuery.test-d.ts and test/types/community/collection/updateX.test-d.ts might be good spots to put some examples. You can run the type tests locally with npm run check:tsd

[jer-sen]

@nbbeeken sorry I will not have time for that, the fix works on my project, I took time to share it and give some simple repo but that's it. It will take to an already contributor less time to finalise what you are asking.

[nbbeeken]

Just a heads up, there's a failure with a Map<string, number> type resolving one of the conditional types to never

Demonstrated by:
test/types/community/collection/filterQuery.test-d.ts:186:19

collectionT.find({ 'laps.foo': 123 });
// Type number is not assignable to type FilterOperators<never>

I'm looking into it on my end but let me know if you have any thoughts @jer-sen

[jer-sen]

@nbbeeken fixed!

[nbbeeken]

LGTM, just added some tests, thanks again for the help!

[jer-sen]

@nbbeeken you're welcome! Type checks are very useful. It could be further improved (arrayFilters, projections, first aggregate stages...)