add support for avoidOptionals codegen config (#325)

Co-authored-by: Conrawl Rogers <[email protected]>
Diizzayy · Jul 17, 2023 · d3eea5b · d3eea5b
1 parent 7735746
commit d3eea5b
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 2 deletions.
diff --git a/docs/content/1.getting-started/4.configuration.md b/docs/content/1.getting-started/4.configuration.md
@@ -70,6 +70,7 @@ export default defineNuxtConfig({
             useTypeImports: true,
             dedupeFragments: true,
             onlyOperationTypes: true,
+            avoidOptionals: false,
             disableOnBuild: false
         }
     }
@@ -108,6 +109,12 @@ Only generate the types for the operations in your GraphQL documents.
 When set to true, only the types needed for your operations will be generated.
 When set to false, all types from the GraphQL API will be generated.
 
+### `avoidOptionals`
+
+  - default: `false`
+
+Avoid using TypeScript optionals on types. See [GraphQL Code Generator documentation](https://the-guild.dev/graphql/codegen/plugins/typescript/typescript#usage-examples) for more options
+
 ### `disableOnBuild`
 
   - default: `false`

diff --git a/src/generate.ts b/src/generate.ts
@@ -48,7 +48,8 @@ function prepareConfig (options: GenerateOptions & GqlCodegen): CodegenConfig {
     onlyOperationTypes: options.onlyOperationTypes,
     namingConvention: {
       enumValues: 'change-case-all#upperCaseFirst'
-    }
+    },
+    avoidOptionals: options?.avoidOptionals
   }
 
   const generates: CodegenConfig['generates'] = Object.entries(options.clients || {}).reduce((acc, [k, v]) => {

diff --git a/src/module.ts b/src/module.ts
@@ -48,7 +48,8 @@ export default defineNuxtModule<GqlConfig>({
       useTypeImports: true,
       dedupeFragments: true,
       disableOnBuild: false,
-      onlyOperationTypes: true
+      onlyOperationTypes: true,
+      avoidOptionals: false
     }
 
     config.codegen = !!config.codegen && defu<GqlCodegen, [GqlCodegen]>(config.codegen, codegenDefaults)

diff --git a/src/types.d.ts b/src/types.d.ts
@@ -172,6 +172,16 @@ export interface GqlCodegen {
    * @default true
    * */
   onlyOperationTypes?: boolean
+
+  /**
+   * Avoid using TypeScript optionals on generated types.
+   */
+  avoidOptionals?: boolean | {
+    field?: boolean
+    inputValue?: boolean
+    object?: boolean
+    defaultValue?: boolean
+  }
 }
 
 export interface GqlConfig<T = GqlClient> {