fix(types): allow use of sequelize.define models in types

[hsource]

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)?
• 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

Motivation

#13010 had fixed an issue where class-based Models with explicit types couldn't be used in includes and other places that expect static models, but it had inadvertently broken the same for Models created with sequelize.define(), which were the standard before it.

This is because it created a new ModelType type, that required explicit properties. sequelize.define outputs a ModelCtor type that doesn't conform to that:

Code with error:

  const commonQuestionOptions: FindOptions<QuestionAttributes> = {
    include: [
      { model: Answer },
    ],
  };

Error: TS2322: Type 'ModelCtor' is not assignable to type 'ModelType<any, any> | undefined'.

Fix

I wrote the original Typescript typings for v6 (#12405), but didn't document it really well. This change better documents how the types should be used and swaps out most uses of ModelType with ModelStatic, which is compatible with both class and sequelize.define Models.

Here's what I did:

1. Document when to use ModelCtor and ModelStatic in the typings file
2. Switch all uses of ModelType to use ModelStatic, which works with both class and sequelize.define models
3. Add Typescript tests to ensure that using both class and function components type-check in User.ts

Todos

None

[ephys]

Looks good to me, thank you for the extra jsdoc too

[wbourne0]

This is probably because typeof Model is a constructor and as such, its new function would take precedence over the constructor of { new(): M }.

[ephys]

Please don't merge this yet. This issue is related to a problem I've been trying to solve for the past year (ModelCtor not acting just right) and I think I've just solved it by changing ModelCtor to this definition

// remove the existing constructor that tries to return `Model<{},{}>` which would be incompatible with models that have typing defined & replace with proper constructor.
export type ModelCtor<M extends Model> = Omit<typeof Model, 'new'> & { new(): M };

Checking if tests pass, brb

[ephys]

Tests have passed in #13890

@hsource would you mind taking a look at it too?

[hsource]

@ephys and @AllAwesome the fix in #13890 looks better. Ship it!

[WikiRik]

I guess this one can be closed then, right?

[ephys]

Thanks @hsource :) I'll close this one then