graphql-types-generator

An Alternative type generator for graphql client

Features:

A direct alternative to this package is only a combination of @graphql-codegen/typescript and @graphql-codegen/typescript-operations. So, if you want, you can consider it two in one.

But not only that. This package can do a little more little joys:

• binding output and input graphql types - @graphql-codegen/typescript-operations is able to generate output types and incoming types based on graphql types. And it's actually very cool, but these remain for each separated case two independent types, and some more work needs to be done to link them. This work can be done manually or with the help of an additional script that you will have to write. graphql-types-generator does this work for you via one of two ways:

  • with the declarateSource option. Creates .d.ts file with generics directly linking arguments to types:

    export const someQueryVar: QueryString<OutputType, InputType>
    

  • using the matchTypeNames option, which creates a special type of relations.:

     export type ArgTypes = {
         // ...
         OutputType: InputType,      
     }
    

• branded types for unknown types - in the case, when graphql server does not provide any data about type (codegen in this case simply substitutes any type for the fields (possible to changed via defaultScalarType option to another, like unknown or Object, for example, but no more)) graphql-types-generator generates appropriate human-readable branded types. A trifle, but nice.

  codegen:

   type SomeType = {
      errors?: any
   }
  

  graphql-types-generator

   type SomeType = {
      errors?: ExpectedErrorType
   }
  

• generates types directly from javascript code - generates types directly from javascript code, which avoids code duplication, whereas codegen is designed for the * format.graphql files, for generating javascript code from which a separate package is needed.

• generate types for unknown types - the possibility to define types, about which server dpusn't give any data. This is very rare case. Unlike the previous paragraphs, I do not attribute it to the advantages, rather to the specificity of the current package.

• has possibility to specify more tiny type for types generation via specify naming rules or server type description (look up typeFromDescMark option). Its may be usefull for example for Unions of some fixed strings or numbers instead of base scalar types or using string template literal in the types. That maky possible use the types as generics for more typing covering

• Performs generation faster then codegen/typescript-operations

• supports watch mode - these mode soesn't supplied in codegen out of the box - you need install special package called @parcel/watcher. The graphql-types-generator in opposite supports the feature out of the box

Currently there is support:

• ✅ queries result typing
• ✅ mutation result typing
• ✅ supports of nested interfaces (like relay)
• ✅ queries and mutation arguments typing including:
  • ✅ nullable arguments
  • ✅ required arguments
  • ✅ complex arguments (required unique field names of each argument in once query)

Does not support:

• ❌ subscriptions - may be will be done in the distant future
• ❌ fragments - unlike due to the lack of need for such entities in meta-development, which is implied by this package

Frequently asked questions