fix(types): accept $nested.syntax$ in WhereAttributeHash

[ephys]

Pull Request Checklist

Please make sure to review and check all of these items:

• Have you added new tests to prevent regressions?
• Does npm run test or npm run test-DIALECT pass with this change (including linting)?
• [n/a] Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
• Did you update the typescript typings accordingly (if applicable)?
• Does the description below contain a link to an existing issue (Closes #[issue]) or a description of the issue you are solving?
• Did you follow the commit message conventions explained in CONTRIBUTING.md?

Description Of Change

Tiny change that has become possible since we dropped TS < 4.1:
User.findOne({ where: { '$nested.column$': 'blah2' } }) is not reported as an error by TypeScript anymore.

Closes #13288

TODO

• Check whether $name$ is valid
• Check whether $include.include.name$ is valid
• Add tests for nested nested include

[ephys]

TypeScript < 4.4 does not support using Template Literal Types as keys so I had to ts-ignore both the test & the implementation - but it doesn't cause issues in ts < 4.4 and works in ts >= 4.4

We can enable it again on 2022-05-26 when we drop support for TS < 4.4

[ephys]

I think with some more black magic we should be able to typecheck include.where too, but I'll keep it for a follow-up PR

User.findOne({
  include: [{
    association: User.associations.group,
    where: {
      // these are not currently type-checked
      test: 'test',
    }
  }],
});

[ephys]

This PR should also include support for the JSON nested key syntax https://sequelize.org/v4/manual/tutorial/querying.html#nested-key

I can't find the documentation on that syntax for v6. Is it still a thing?

It's looking like it's not and was replaced with sequelize.json

Edit: I've found a place where it was used in order: https://github.com/sequelize/sequelize/blob/main/test/integration/model/json.test.js#L573

Edit 2: And in where, so it's still a thing https://github.com/sequelize/sequelize/blob/main/test/integration/model/json.test.js#L117

We should improve the documentation to reflect this

I wonder if $nested.column$.nested.json.property works. That would impact #13992

[WikiRik]

This PR should also include support for the JSON nested key syntax https://sequelize.org/v4/manual/tutorial/querying.html#nested-key

I can't find the documentation on that syntax for v6. Is it still a thing?

It seems that it got lost in #11825

[ephys]

I'll open a follow-up PR for the json.syntax as the typing I have in mind is a bit complicated

[ephys]

As the only issue is that the false-positive is still present in TS < 4.4, I think I'll merge this (tomorrow or friday to still leave some time to react). Then we can fix #14038, and then open a follow-up PR that uses typesVersion to provide an alternative typing for TS < 4.4

[WikiRik]

Sounds good! We should also publish a new alpha release of v7 after we merged all these typing PRs

[ephys]

@WikiRik @allawesome497 if you're ok with the above plan, can I get one of your review approvals? :)

[github-actions]

🎉 This PR is included in version 7.0.0-alpha.6 🎉

The release is available on:

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

Your semantic-release bot 📦🚀