feat: expose the codegen scalars (#567)

Diizzayy · Dec 1, 2024 · 968cdb7 · 968cdb7
1 parent ca4ce30
commit 968cdb7
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 3 deletions.
diff --git a/docs/content/1.getting-started/4.configuration.md b/docs/content/1.getting-started/4.configuration.md
@@ -72,7 +72,8 @@ export default defineNuxtConfig({
             onlyOperationTypes: true,
             avoidOptionals: false,
             disableOnBuild: false,
-            maybeValue: 'T | null'
+            maybeValue: 'T | null',
+            scalars: {}
         }
     }
 })
@@ -128,6 +129,13 @@ Disable Code Generation for production builds.
 
 Allow to override the type value of `Maybe`. See [GraphQL Code Generator documentation](https://the-guild.dev/graphql/codegen/plugins/typescript/typescript-operations#maybevalue) for more options
 
+### `scalars`
+
+  - default: `{}`
+
+Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type. See [GraphQL Code Generator documentation](https://the-guild.dev/graphql/codegen/plugins/typescript/typescript#scalars) for more options
+
+
 ## Client configuration
 
 ::alert{type="warning"}

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

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

diff --git a/src/types.d.ts b/src/types.d.ts
@@ -201,6 +201,12 @@ export interface GqlCodegen {
    (https://the-guild.dev/graphql/codegen/plugins/typescript/typescript-operations#maybevalue)
    */
   maybeValue?: string
+
+  /**
+   * Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type.
+   (https://the-guild.dev/graphql/codegen/plugins/typescript/typescript#scalars
+   */
+  scalars?: string | { [name: string]: string | { input: string, output: string } }
 }
 
 export interface GqlConfig<T = GqlClient> {