graphql-code-generator: Planned breaking changes for typescript plugins 🚀

1.0.0 is available now 👍

@NickClark Please open a new issue if something is wrong 😃

Looking over the output… Good work guys! Also love that Class documents are exported separately now!

Wow this last i totally missed, will run it today. My second thought was about how to generate types per module, but as already discussed it will be hard when modules require other modules. So one file maybe is still best 😃

@maapteh

Create schema changes overview. Our app is using graphql-modules and we can generate schema’s without running the application (so no endpoint needed). It would be nice if we could compare it with the current schema on production (which is also in our codebase). Then in our pipeline we can show this overview without running anything.

It feels like this feature it not part of the codegen’s scope, but I think https://github.com/kamilkisiela/graphql-inspector can do this for you 😃

Agreed, the __typename field is a bit special since it is part of the schema in the sense that you can query for it (and I guess that ability is part of the spec). But then again it is not really part of the schema as you don’t declare it in the types.

Btw, I just migrated from 0.13 to 0.17 yesterday and I am loving the new config files, so much simpler 👍

Yes, adding __typename to all types, including the “full” types that are today generated by typescript-server would solve my use-case. I need __typename when I add entities to the client-side cache because I use it to generate the unique ID in the cache. To explain some more, I have this on the client-side:

const newProduct: Partial<WithTypename<GqlSchema.Product>> = {
        __typename: "Product",
        id: "theid",
        name: "thename",
        description: "thedescription",
      };
const patch = GqlCachePatch.createEntity<Partial<GqlSchema.Product>>(getObjectId(newProduct), newProduct),

The getObjectId function uses __typename to generate a concatenated unique ID in the flat normalized cache as __typename;obj.id. WithTypename is my current workaround to add __typename. It is simply type WithTypename<T> = T & { readonly __typename: string }; but this is not safe as it is string rahter than the correct string literal type. I understand my use-case and this example is probably unusual but I hope the example clarifies rather than adds more confusion 😃.

My understanding of the outlined plan is that the typescript-common and typescript-server packages will be joined into a typescript package. This new package will also somehow be the base for typescript-client. So if the typescript package supports adding __typename then it will be possible to add it everywhere, both to types for query/mutation documents and for full schema types.