Tracking Issue: Typescript Type generation

[derrickmehaffy]

Bug report

Describe the bug

This is a tracking issue for all issues related to Typescript type generation issues (bugs, requests, enhancements, etc)

List of initial issues that contributed to creating this tracking issue:

• CLI ts:generate-types emits wrong types for MediaAttribute #14795
• Extending Strapi Services causes TypeError w/ Strapi (TS) v4.4.5 #14762
• make only property optional in the RouterConfig  #14720
• Generated schema.d.ts can't be directly imported without errors? #14578
• IDEA shows ts errors in just generated plugin #14501
• Typescript) Database interface does not contain connection #14469
• TS QueryEngine populate accepts only array type #14286
• Typescript lifecycle Event type missing result property for 11 Action types: eg: afterCreate, afterCreateMany , etc... #14167
• Typescript Subscriber typing doesn't allow models property. #14165
• Failed to build Typescript Plugin after v4.5.1; Cannot find module design-system/icons #15072
• Incomplete type generation for graphql #14843
• Extend user registration using Typescript strapi-server file #14889

Steps to reproduce the behavior

See various linked issues

Expected behavior

Various type issues and requests should be addressed at a later date

Additional context

Additional duplicate issues will be linked in the comments below:

[sjoukedv]

+1 on this one!

I generate the typescript definitions from Strapi and import it in our NextJS frontend. The id field of the REST API response is not being used for e.g. ApiCollectionCollection type (the relation attributes format is also off):

{
  data: {
    id: 1 // <-- this id is missing from the definition
    attributes: {
      ...
      relationField: { // <-- e.g. has type MediaAttribute, but needs to be wrapped in StrapiResponse
        id: ...,
        attributes: {
           // field attributes
        }
   }
  }
}

Where my workaround is to define another type StrapiResponse<ApiCollectionCollection> and use

export interface StrapiResponse<T> {
  id: number
  attributes: T['attributes']
}

I think the relational attribute should also be wrapped in such a 'StrapiResponse' to enfore the type is equal.
Perhaps this issue is specific to REST and works better with something like GraphQL, but in that case it's still valueable to have the exact type definition (maybe with REST prefix?).

[julesrenaud]

@sjoukedv look into this package, I installed it as a global package and had pretty good results with it https://www.npmjs.com/package/strapi-generate-types

[axelinternet]

Do you accept PRs for the sub issues?

Something like this that is crashing the whole application for me because of the invalid types is something that seems like a pretty quick fix:

strapi/packages/core/database/lib/index.d.ts

Lines 44 to 57 in cf179e3

	interface FindParams<T> {
	select?: (keyof T)[];
	// TODO: add nested operators & relations
	where?: WhereParams<T>;
	limit?: number;
	offset?: number;
	orderBy?: // TODO: add relations
	| Sortables<T>
	| Sortables<T>[]
	| { [K in Sortables<T>]?: Direction }
	| { [K in Sortables<T>]?: Direction }[];
	// TODO: define nested obj
	populate?: (keyof T)[];
	}

[arpadgabor]

Hello, are there any workarounds or plans to fix these type issues? I know it may not be trivial but it's a rather big issue when trying to build reliable apps. I might be open to try and fix some issues in a PR if there's any follow-up.

[simohr]

Hello, are there any workarounds or plans to fix these type issues? I know it may not be trivial but it's a rather big issue when trying to build reliable apps. I might be open to try and fix some issues in a PR if there's any follow-up.

Only quick thing I was able to do is add // @ts-ignore above the line where you get the error.

[gregg-cbs]

Looks like a lot of tickets were closed but not merged as this is still an issue?

[Boegie19]

@gregg-cbs Correct they where all closed in and this 1 tracking issue opened in its place.