How to generate the types/generated/ctp.ts file?

[jluterek]

Which part of the documentation does it affect and which topic does it refer to?

The typescript starter project leverages the file types/generated/ctp.ts for things like TFetchChannelsQuery. We are trying to follow this example for fetching other commercetools objects, but do not see a script for generating an updated version of this file.

We are looking for guidance on how to update this generated file to include the other query endpoints besides channel.

Describe what needs to be improved

I'd like to see the typescript page - https://docs.commercetools.com/merchant-center-customizations/development/adding-typescript - talk about generating the necessary types from the CTP graphql endpoint.

[CarlosCortizasCT]

Hello James,

Thanks for letting us know about this missing feature in our typescript starter templates!

We would like to work on improving the templates DX by providing a way for developers to autogenerate typescript types based on the different commercetools GraphQL schemas and so, this is actually something we already have in our backlog.

We don’t have an estimated release date yet, but we will let you know as soon as we have something decided about it.

In the meantime, we would suggest to take a look at the setup we have in this repository as a guidance for setting it up in your own projects.
Here are the custom scripts that we use and the codegen.*.yml files are what we use for the configuration (example).

Hope this can help in the meantime.