dotansimha/graphql-code-generator-community

Missing generation of union types (typescript-type-graphql)

Open

#1,398 opened on Dec 13, 2020

View on GitHub
 (2 comments) (6 reactions) (0 assignees)TypeScript (195 forks)github user discovery
help wanted

Repository metrics

Stars
 (136 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the bug typescript-type-graphql plugin does not generate the necessary createUnionType function when generating a union type.

To Reproduce Steps to reproduce the behavior: Use a union type as a property of a document and generate using the typescript-type-graphql plugin.

https://codesandbox.io/s/strange-northcutt-ki24s?file=/types.ts

  1. My GraphQL schema:
type ALevel {
	subject: ALevelSubject!
	grade: ALevelGrade!
}

type BTEC {
	subject: String!
	grade: BTECGrade!
}

union Qualification = ALevel | BTEC

type Information {
	qualifications: [Qualification!]!
}
  1. My codegen.yml config file:
overwrite: true
schema: './src/*.gql'
generates:
../graphql/src/qlModels.ts:
    plugins:
      - typescript-type-graphql
    config:
      namingConvention: keep

Expected behavior a createUnionType function is generated for each union type.

Environment:

  • OS: Ubuntu 20.04
  • @graphql-codegen/cli: 1.19.4
  • @graphql-codegen/typescript-type-graphql: 1.18.2
  • NodeJS: 14.15.1

Contributor guide

Research direction
Examine the typescript type graphql plugin source to find where union type handling and createUnionType generation is implemented or missing.
Tech stack
typescriptgraphql
Domain
backendapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GraphQLTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60