Merge branch 'main' into jcisneros/default-scalarTypeSchema

jocisneros · jocisneros · commit 58658c200d37 · 2024-11-07T07:48:24.000-08:00
diff --git a/README.md b/README.md
@@ -203,7 +203,7 @@ type: `ValidationSchemaExportType` default: `'function'`
 
 Specify validation schema export type.
 
-### `useEnumTypeAsDefault`
+### `useEnumTypeAsDefaultValue`
 
 type: `boolean` default: `false`
 
@@ -215,8 +215,6 @@ type: `NamingConventionMap` default: `{ enumValues: "change-case-all#pascalCase"
 
 Uses the full path of the enum type as the default value instead of the stringified value.
 
-Note: This option has not been tested with `namingConvention.transformUnderscore` and `namingConvention.typeNames` options and may not work as expected.
-
 Related: https://the-guild.dev/graphql/codegen/docs/config-reference/naming-convention#namingconvention
 
 ### `directives`
diff --git a/package.json b/package.json
@@ -1,8 +1,8 @@
 {
   "name": "graphql-codegen-typescript-validation-schema",
   "type": "module",
-  "version": "0.16.0",
-  "packageManager": "pnpm@9.12.1",
+  "version": "0.16.1",
+  "packageManager": "pnpm@9.12.3",
   "description": "GraphQL Code Generator plugin to generate form validation schema from your GraphQL schema",
   "respository": {
     "type": "git",
@@ -88,13 +88,13 @@
     "@antfu/eslint-config": "^3.0.0",
     "@graphql-codegen/cli": "5.0.3",
     "@graphql-codegen/typescript": "^4.0.0",
-    "@tsconfig/recommended": "1.0.7",
+    "@tsconfig/recommended": "1.0.8",
     "@types/graphlib": "^2.1.8",
-    "@types/node": "^20.0.0",
-    "eslint": "9.12.0",
+    "@types/node": "^22.0.0",
+    "eslint": "9.14.0",
     "jest": "29.7.0",
     "myzod": "1.12.0",
-    "npm-run-all2": "6.2.3",
+    "npm-run-all2": "7.0.1",
     "ts-dedent": "^2.2.0",
     "ts-jest": "29.2.5",
     "typescript": "5.6.3",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/config.ts b/src/config.ts
@@ -241,7 +241,7 @@ export interface ValidationSchemaPluginConfig extends TypeScriptPluginConfig {
    *       - typescript
    *       - graphql-codegen-validation-schema
    *     config:
-   *       useEnumTypeAsDefault: true
+   *       useEnumTypeAsDefaultValue: true
    * ```
    */
   useEnumTypeAsDefaultValue?: boolean
diff --git a/src/directive.ts b/src/directive.ts
@@ -1,7 +1,7 @@
 import type { ConstArgumentNode, ConstDirectiveNode, ConstValueNode } from 'graphql';
 import type { DirectiveConfig, DirectiveObjectArguments } from './config.js';
-
 import { Kind, valueFromASTUntyped } from 'graphql';
+
 import { isConvertableRegexp } from './regexp.js';
 
 export interface FormattedDirectiveConfig {
diff --git a/src/index.ts b/src/index.ts
@@ -2,9 +2,9 @@ import type { PluginFunction, Types } from '@graphql-codegen/plugin-helpers';
 import type { GraphQLSchema } from 'graphql';
 import type { ValidationSchemaPluginConfig } from './config.js';
 import type { SchemaVisitor } from './types.js';
-
 import { transformSchemaAST } from '@graphql-codegen/schema-ast';
 import { buildSchema, printSchema, visit } from 'graphql';
+
 import { isGeneratedByIntrospection, topologicalSortAST } from './graphql.js';
 import { MyZodSchemaVisitor } from './myzod/index.js';
 import { ValibotSchemaVisitor } from './valibot/index.js';
diff --git a/src/myzod/index.ts b/src/myzod/index.ts
@@ -10,9 +10,9 @@ import type {
   TypeNode,
   UnionTypeDefinitionNode,
 } from 'graphql';
+
 import type { ValidationSchemaPluginConfig } from '../config.js';
 import type { Visitor } from '../visitor.js';
-
 import { resolveExternalModuleAndFn } from '@graphql-codegen/plugin-helpers';
 import { convertNameParts, DeclarationBlock, indent } from '@graphql-codegen/visitor-plugin-common';
 import {
@@ -290,10 +290,10 @@ function generateFieldTypeMyZodSchema(config: ValidationSchemaPluginConfig, visi
 
       if (defaultValue?.kind === Kind.STRING || defaultValue?.kind === Kind.ENUM) {
         if (config.useEnumTypeAsDefaultValue && defaultValue?.kind !== Kind.STRING) {
-          let value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn('change-case-all#pascalCase'));
+          let value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn('change-case-all#pascalCase'), config?.namingConvention?.transformUnderscore);
 
           if (config.namingConvention?.enumValues)
-            value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn(config.namingConvention?.enumValues));
+            value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn(config.namingConvention?.enumValues), config?.namingConvention?.transformUnderscore);
 
           appliedDirectivesGen = `${appliedDirectivesGen}.default(${visitor.convertName(type.name.value)}.${value})`;
         }
diff --git a/src/valibot/index.ts b/src/valibot/index.ts
@@ -11,8 +11,8 @@ import type {
   UnionTypeDefinitionNode,
 } from 'graphql';
 import type { ValidationSchemaPluginConfig } from '../config.js';
-
 import type { Visitor } from '../visitor.js';
+
 import { DeclarationBlock, indent } from '@graphql-codegen/visitor-plugin-common';
 import { buildApiForValibot, formatDirectiveConfig } from '../directive.js';
 import {
@@ -224,8 +224,13 @@ function generateFieldTypeValibotSchema(config: ValidationSchemaPluginConfig, vi
 
     const actions = actionsFromDirectives(config, field);
 
-    if (isNonNullType(parentType))
-      return pipeSchemaAndActions(gen, actions); ;
+    if (isNonNullType(parentType)) {
+      if (visitor.shouldEmitAsNotAllowEmptyString(type.name.value)) {
+        actions.push('v.minLength(1)');
+      }
+
+      return pipeSchemaAndActions(gen, actions);
+    }
 
     return `v.nullish(${pipeSchemaAndActions(gen, actions)})`;
   }
diff --git a/src/visitor.ts b/src/visitor.ts
@@ -6,8 +6,8 @@ import type {
   ObjectTypeDefinitionNode,
 } from 'graphql';
 import type { ValidationSchemaPluginConfig } from './config.js';
-import { TsVisitor } from '@graphql-codegen/typescript';
 
+import { TsVisitor } from '@graphql-codegen/typescript';
 import {
   specifiedScalarTypes,
 } from 'graphql';
diff --git a/src/yup/index.ts b/src/yup/index.ts
@@ -10,9 +10,9 @@ import type {
   TypeNode,
   UnionTypeDefinitionNode,
 } from 'graphql';
+
 import type { ValidationSchemaPluginConfig } from '../config.js';
 import type { Visitor } from '../visitor.js';
-
 import { resolveExternalModuleAndFn } from '@graphql-codegen/plugin-helpers';
 import { convertNameParts, DeclarationBlock, indent } from '@graphql-codegen/visitor-plugin-common';
 import {
@@ -292,10 +292,10 @@ function shapeFields(fields: readonly (FieldDefinitionNode | InputValueDefinitio
 
         if (defaultValue?.kind === Kind.STRING || defaultValue?.kind === Kind.ENUM) {
           if (config.useEnumTypeAsDefaultValue && defaultValue?.kind !== Kind.STRING) {
-            let value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn('change-case-all#pascalCase'));
+            let value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn('change-case-all#pascalCase'), config?.namingConvention?.transformUnderscore);
 
             if (config.namingConvention?.enumValues)
-              value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn(config.namingConvention?.enumValues));
+              value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn(config.namingConvention?.enumValues), config?.namingConvention?.transformUnderscore);
 
             fieldSchema = `${fieldSchema}.default(${visitor.convertName(field.name.value)}.${value})`;
           }
diff --git a/src/zod/index.ts b/src/zod/index.ts
@@ -10,9 +10,9 @@ import type {
   TypeNode,
   UnionTypeDefinitionNode,
 } from 'graphql';
+
 import type { ValidationSchemaPluginConfig } from '../config.js';
 import type { Visitor } from '../visitor.js';
-
 import { resolveExternalModuleAndFn } from '@graphql-codegen/plugin-helpers';
 import { convertNameParts, DeclarationBlock, indent } from '@graphql-codegen/visitor-plugin-common';
 import {
@@ -306,10 +306,10 @@ function generateFieldTypeZodSchema(config: ValidationSchemaPluginConfig, visito
 
       if (defaultValue?.kind === Kind.STRING || defaultValue?.kind === Kind.ENUM) {
         if (config.useEnumTypeAsDefaultValue && defaultValue?.kind !== Kind.STRING) {
-          let value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn('change-case-all#pascalCase'));
+          let value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn('change-case-all#pascalCase'), config.namingConvention?.transformUnderscore);
 
           if (config.namingConvention?.enumValues)
-            value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn(config.namingConvention?.enumValues));
+            value = convertNameParts(defaultValue.value, resolveExternalModuleAndFn(config.namingConvention?.enumValues), config.namingConvention?.transformUnderscore);
 
           appliedDirectivesGen = `${appliedDirectivesGen}.default(${type.name.value}.${value})`;
         }
diff --git a/tests/directive.spec.ts b/tests/directive.spec.ts
@@ -1,11 +1,11 @@
 import type { ConstArgumentNode, ConstDirectiveNode, ConstValueNode, NameNode } from 'graphql';
 import type { DirectiveConfig, DirectiveObjectArguments } from '../src/config';
-
 import type {
   FormattedDirectiveArguments,
   FormattedDirectiveConfig,
   FormattedDirectiveObjectArguments,
 } from '../src/directive';
+
 import { Kind, parseConstValue } from 'graphql';
 import {
   buildApi,
diff --git a/tests/myzod.spec.ts b/tests/myzod.spec.ts
@@ -1479,4 +1479,77 @@ describe('myzod', () => {
     expect(result.content).toContain('ratio: myzod.number().default(0.5).optional().nullable()');
     expect(result.content).toContain('isMember: myzod.boolean().default(true).optional().nullable()');
   });
+
+  it('with default input values as enum types with underscores', async () => {
+    const schema = buildSchema(/* GraphQL */ `
+      enum PageType {
+        PUBLIC
+        BASIC_AUTH
+      }
+      input PageInput {
+        pageType: PageType! = BASIC_AUTH
+        greeting: String = "Hello"
+        score: Int = 100
+        ratio: Float = 0.5
+        isMember: Boolean = true
+      }
+    `);
+    const result = await plugin(
+      schema,
+      [],
+      {
+        schema: 'myzod',
+        importFrom: './types',
+        useEnumTypeAsDefaultValue: true,
+      },
+      {},
+    );
+
+    expect(result.content).toContain('export const PageTypeSchema = myzod.enum(PageType)');
+    expect(result.content).toContain('export function PageInputSchema(): myzod.Type<PageInput>');
+
+    expect(result.content).toContain('pageType: PageTypeSchema.default(PageType.Basic_Auth)');
+    expect(result.content).toContain('greeting: myzod.string().default("Hello").optional().nullable()');
+    expect(result.content).toContain('score: myzod.number().default(100).optional().nullable()');
+    expect(result.content).toContain('ratio: myzod.number().default(0.5).optional().nullable()');
+    expect(result.content).toContain('isMember: myzod.boolean().default(true).optional().nullable()');
+  });
+
+  it('with default input values as enum types with no underscores', async () => {
+    const schema = buildSchema(/* GraphQL */ `
+      enum PageType {
+        PUBLIC
+        BASIC_AUTH
+      }
+      input PageInput {
+        pageType: PageType! = BASIC_AUTH
+        greeting: String = "Hello"
+        score: Int = 100
+        ratio: Float = 0.5
+        isMember: Boolean = true
+      }
+    `);
+    const result = await plugin(
+      schema,
+      [],
+      {
+        schema: 'myzod',
+        importFrom: './types',
+        useEnumTypeAsDefaultValue: true,
+        namingConvention: {
+          transformUnderscore: true,
+        },
+      },
+      {},
+    );
+
+    expect(result.content).toContain('export const PageTypeSchema = myzod.enum(PageType)');
+    expect(result.content).toContain('export function PageInputSchema(): myzod.Type<PageInput>');
+
+    expect(result.content).toContain('pageType: PageTypeSchema.default(PageType.BasicAuth)');
+    expect(result.content).toContain('greeting: myzod.string().default("Hello").optional().nullable()');
+    expect(result.content).toContain('score: myzod.number().default(100).optional().nullable()');
+    expect(result.content).toContain('ratio: myzod.number().default(0.5).optional().nullable()');
+    expect(result.content).toContain('isMember: myzod.boolean().default(true).optional().nullable()');
+  });
 });
diff --git a/tests/valibot.spec.ts b/tests/valibot.spec.ts
diff --git a/tests/yup.spec.ts b/tests/yup.spec.ts
diff --git a/tests/zod.spec.ts b/tests/zod.spec.ts
