Generate typescript types from rest API docs

[bbovenzi]

Use openapi-typescript to generate types for all rest API data. This keeps a single source of truth vs manually writing all the data endpoint types.

Also, found a bug where map_index was missing from the TaskInstance schema

---

^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

[pierrejeambrun]

Looking nice. Just a few suggestions.

For the camel case naming they recommend keeping it as snake case in their readme. (project goals section) Maybe we should do that and get completely rid of camel case.

If we still want to enforce camel case, as a last resort we could use the template litéral + conditionnal type recursion, and we could define this: (add this to the generated file)

type SnakeToCamelCase<word extends string> =
  word extends `${infer firstWord}_${infer rest}`
    ? `${firstWord}${Capitalize<SnakeToCamelCase<rest>>}`
    : word;

type KeysToCamelCase<T> = {
  [K in keyof T as SnakeToCamelCase<string & K>]: T[K]
}

Then we only need to wrap our generated type like so: (in the generation step)

export type UserCollectionItem = KeysToCamelCase<components['schemas']['UserCollectionItem']>;
export type User = KeysToCamelCase<components['schemas']['User']>;
export type UserCollection = KeysToCamelCase<components['schemas']['UserCollection']>;
export type ConnectionCollectionItem = KeysToCamelCase<components['schemas']['ConnectionCollectionItem']>;

[pierrejeambrun]

Should we also push the licence directly, or are we counting on the pre-commit hook to do that for us ?

[bbovenzi]

@pierrejeambrun Good idea to add a KeysToCamelCase. I think we may want to switch to snake_case in the future. But that's a large refactor with a large surface area to introduce bugs so I think converting the types to camelCase is fine for now.

Also, fixed spelling errors and auto-adding the license to the generated file.

[pierrejeambrun]

Good job on the nested type 👍

Should we add the type-generation step to the static-checks (pre-commit + CI)? What I mean by that is, if someone update the API, these changes should be reflected in the ts types. (And potentially linting error would arise)

Plus manually having to regenerate the types each time we pull from main in case the open api spec is updated is not ideal.

[jedcunningham]

Looks good, though there are some static check failures to clean up.

[bbovenzi]

#25167 will handle the pre-commit hook to auto-generate the type file