Support auto-generated record types for specific Kintone apps

[koba04]

Package

• @kintone/rest-api-client
• (@kintone/dts-gen)

Why

Some methods rest-api-client provides accept a type parameter for a type definition of your app.

type MyAppRecord = { /* ... */ }
// the type of the record will be MyAppRecord
const record = client.record.getRecord<MyAppRecord>({ app: 1, id: 10 })

After #404 has been merged, we could define the type definition using types #404 exposes.
But it's a bit cumbersome because we have to define the type definition manually.

dts-gen provides us a command to be able to generate type definitions for your app.
But the type definition dts-gen generates is not compatible with rest-api-client expects (refs. #442).

What

We'd like to provide a way to generate type definitions, which are compatible with rest-api-client, automatically.

We could take some options to fix the issue.

1. Adding a feature to generate type definitions to be able to use with rest-api-client into dts-gen.
2. Creating a new package to generate type definitions to be able to use with rest-api-client.

Now, we have several types for a Kintone record type like the following.

• JS API
• API Response
• API Request

So we have to sort each type definition respectively.

[mura-]

@koba04

I'm looking forward to fix this issue.

Could you tell me the expected date when new package including #404 will be released?
I want to use the new version as soon as possible 😀

[koba04]

@mura-
We've just released a new version that includes #404 as kintone/[email protected].
Please let us know If you have a problem with the types!

[mura-]

@koba04
Thank you so much!!!
I will try it! 🙏 🙏 🙏

[potaracom]

Can't wait!

[Lorenzras]

What's the status of this?