Generate typescript definitions from openapi spec

[juliushaertl]

As @enjeck brought up it is quite hard to work with a yet unfamiliar code base that has complex data structures as the tables app, so we thought that the openapi spec could be used to automatically generate typescript definitions.

While rolling out typescript in general is probably worth a general discussion and an iterative process, using https://www.npmjs.com/package/openapi-typescript seems to be able to generate a somewhat reasonable definition file:

npx openapi-typescript ./openapi.json -o ./src/schema.d.ts

We should see if:

• this can be used as jsdoc annotations to get proper IDE type hints
• We need any additional setup to be able to already move parts of the code to typescript
• Probably automate generating and updating the definitions

[enjeck]

this can be used as jsdoc annotations to get proper IDE type hints

I tried doing something like this. I created a new file with typedefs for Tables, Columns and others. Imported these types into other files, and it was kinda helpful.

The problem now might be VS Code not integrating well with Vue? For example, suppose there is a component, having a prop named columns under props. The columns prop doesn't get referenced when when I use it (via this.columns) under the data, computed and methods option. Wondering if using a specific IDE or extension helps with this. If I could fix this, I'll be very happy