zod-codegen 1.6.3 → 1.7.0

package/dist/tests/unit/type-builder.test.js

@@ -0,0 +1,108 @@
+import { beforeEach, describe, expect, it } from 'vitest';
+import { TypeScriptTypeBuilderService } from '../../src/services/type-builder.service';
+import * as ts from 'typescript';
+describe('TypeScriptTypeBuilderService', () => {
+    let builder;
+    beforeEach(() => {
+        builder = new TypeScriptTypeBuilderService();
+    });
+    describe('buildType', () => {
+        it('should build string type', () => {
+            const typeNode = builder.buildType('string');
+            expect(typeNode.kind).toBe(ts.SyntaxKind.StringKeyword);
+        });
+        it('should build number type', () => {
+            const typeNode = builder.buildType('number');
+            expect(typeNode.kind).toBe(ts.SyntaxKind.NumberKeyword);
+        });
+        it('should build boolean type', () => {
+            const typeNode = builder.buildType('boolean');
+            expect(typeNode.kind).toBe(ts.SyntaxKind.BooleanKeyword);
+        });
+        it('should build unknown type', () => {
+            const typeNode = builder.buildType('unknown');
+            expect(typeNode.kind).toBe(ts.SyntaxKind.UnknownKeyword);
+        });
+        it('should build array type', () => {
+            const typeNode = builder.buildType('string[]');
+            expect(typeNode.kind).toBe(ts.SyntaxKind.ArrayType);
+        });
+        it('should build Record type (returns unknown)', () => {
+            const typeNode = builder.buildType('Record<string, number>');
+            expect(typeNode.kind).toBe(ts.SyntaxKind.UnknownKeyword);
+        });
+        it('should build custom type reference', () => {
+            const typeNode = builder.buildType('CustomType');
+            expect(typeNode.kind).toBe(ts.SyntaxKind.TypeReference);
+        });
+    });
+    describe('createProperty', () => {
+        it('should create property with readonly modifier', () => {
+            const property = builder.createProperty('name', 'string', true);
+            expect(property.modifiers).toBeDefined();
+            expect(property.modifiers?.some((m) => m.kind === ts.SyntaxKind.ReadonlyKeyword)).toBe(true);
+        });
+        it('should create property without readonly modifier', () => {
+            const property = builder.createProperty('name', 'string', false);
+            const hasReadonly = property.modifiers?.some((m) => m.kind === ts.SyntaxKind.ReadonlyKeyword) ?? false;
+            expect(hasReadonly).toBe(false);
+        });
+        it('should handle private identifier (#)', () => {
+            const property = builder.createProperty('#private', 'string');
+            expect(property.name).toBeDefined();
+        });
+    });
+    describe('createParameter', () => {
+        it('should create optional parameter', () => {
+            const param = builder.createParameter('name', 'string', undefined, true);
+            expect(param.questionToken).toBeDefined();
+        });
+        it('should create required parameter', () => {
+            const param = builder.createParameter('name', 'string', undefined, false);
+            expect(param.questionToken).toBeUndefined();
+        });
+        it('should create parameter with TypeNode type', () => {
+            const typeNode = ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword);
+            const param = builder.createParameter('name', typeNode);
+            expect(param.type).toBe(typeNode);
+        });
+    });
+    describe('sanitizeIdentifier', () => {
+        it('should sanitize identifier with special characters', () => {
+            const sanitized = builder.sanitizeIdentifier('test-name@123');
+            expect(sanitized).toBe('test_name_123');
+        });
+        it('should add prefix for identifiers starting with number', () => {
+            const sanitized = builder.sanitizeIdentifier('123test');
+            expect(sanitized).toBe('_123test');
+        });
+        it('should handle empty string', () => {
+            const sanitized = builder.sanitizeIdentifier('');
+            expect(sanitized).toBe('_');
+        });
+    });
+    describe('toCamelCase', () => {
+        it('should convert first letter to lowercase', () => {
+            const result = builder.toCamelCase('Test');
+            expect(result).toBe('test');
+        });
+        it('should handle single character', () => {
+            const result = builder.toCamelCase('T');
+            expect(result).toBe('t');
+        });
+        it('should handle empty string', () => {
+            const result = builder.toCamelCase('');
+            expect(result).toBe('');
+        });
+    });
+    describe('toPascalCase', () => {
+        it('should convert first letter to uppercase', () => {
+            const result = builder.toPascalCase('test');
+            expect(result).toBe('Test');
+        });
+        it('should handle single character', () => {
+            const result = builder.toPascalCase('t');
+            expect(result).toBe('T');
+        });
+    });
+});

package/dist/vitest.config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vitest.config.d.ts","sourceRoot":"","sources":["../vitest.config.ts"],"names":[],"mappings":";AAGA,wBAmCG"}
+{"version":3,"file":"vitest.config.d.ts","sourceRoot":"","sources":["../vitest.config.ts"],"names":[],"mappings":";AAGA,wBAyBG"}

package/dist/vitest.config.js

@@ -1,38 +1,28 @@
-import { defineConfig } from 'vitest/config';
 import { resolve } from 'node:path';
+import { defineConfig } from 'vitest/config';
 export default defineConfig({
     test: {
         globals: true,
         environment: 'node',
-        include: ['**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
+        include: ['**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts}'],
         exclude: ['node_modules', 'dist', 'coverage'],
         coverage: {
             provider: 'v8',
             reporter: ['text', 'json', 'html', 'lcov'],
-            exclude: [
-                'coverage/**',
-                'dist/**',
-                'node_modules/**',
-                '**/*.d.ts',
-                '**/*.config.*',
-                '**/*.test.*',
-                '**/*.spec.*',
-                'scripts/**',
-                'samples/**',
-            ],
+            exclude: ['coverage/**', 'dist/**', 'node_modules/**', '**/*.d.ts', '**/*.config.*', '**/*.test.*', '**/*.spec.*', 'scripts/**', 'samples/**'],
             thresholds: {
                 global: {
                     branches: 80,
                     functions: 80,
                     lines: 80,
-                    statements: 80,
-                },
-            },
-        },
+                    statements: 80
+                }
+            }
+        }
     },
     resolve: {
         alias: {
-            '@': resolve(__dirname, 'src'),
-        },
-    },
+            '@': resolve(__dirname, 'src')
+        }
+    }
 });

package/eslint.config.mjs

@@ -1,52 +1,62 @@
 import eslint from '@eslint/js';
+import eslintConfigPrettier from 'eslint-config-prettier';
 import { defineConfig } from 'eslint/config';
 import tseslint from 'typescript-eslint';
 
+// Default ignores for consuming projects
+const defaultIgnores = ['**/*.mjs', '**/dist/**', '**/coverage/**'];
+
 export default defineConfig([
   {
-    ignores: [
-      '**/*.mjs',
-      'dist/**/*',
-      'node_modules/**/*',
-      '**/*.test*.ts',
-      '**/coverage/*',
-      'examples/**/*.ts',
-    ],
+    ignores: defaultIgnores
   },
   eslint.configs.recommended,
-  tseslint.configs.strictTypeChecked,
-  tseslint.configs.stylisticTypeChecked,
+  ...tseslint.configs.strictTypeChecked,
+  ...tseslint.configs.stylisticTypeChecked,
+  eslintConfigPrettier,
+  {
+    files: ['examples/**/*.ts', 'tests/**/*.ts'],
+    extends: [tseslint.configs.disableTypeChecked],
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }]
+    }
+  },
   {
     languageOptions: {
       parserOptions: {
         projectService: true,
-      },
+        tsconfigRootDir: import.meta.dirname
+      }
     },
     rules: {
+      '@typescript-eslint/no-deprecated': 'warn',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+          varsIgnorePattern: '^_'
+        }
+      ],
+      'brace-style': ['error', '1tbs', { allowSingleLine: false }],
+      'curly': ['error', 'all'],
       'no-var': 'error',
+      'padding-line-between-statements': ['error', { blankLine: 'always', prev: 'if', next: '*' }],
       'prefer-const': [
         'error',
         {
           destructuring: 'all',
-          ignoreReadBeforeAssign: false,
-        },
+          ignoreReadBeforeAssign: false
+        }
       ],
-      quotes: ['error', 'single', { avoidEscape: true }],
+      'quotes': ['error', 'single', { avoidEscape: true }],
       'sort-imports': [
         'error',
         {
           ignoreCase: true,
-          ignoreDeclarationSort: true,
-        },
-      ],
-      '@typescript-eslint/no-deprecated': 'warn',
-      '@typescript-eslint/no-unused-vars': [
-        'error',
-        {
-          argsIgnorePattern: '^_',
-          varsIgnorePattern: '^_',
-        },
-      ],
-    },
-  },
-]);
+          ignoreDeclarationSort: true
+        }
+      ]
+    }
+  }
+]);

package/examples/.gitkeep

@@ -1,3 +1,3 @@
 # This file ensures the examples directory is tracked by git
-# Generated type.ts files are ignored via .gitignore
+# Generated api.ts files are ignored via .gitignore
 

package/examples/README.md

@@ -26,12 +26,14 @@ npx ts-node examples/petstore/basic-usage.ts
 npx ts-node examples/petstore/authenticated-usage.ts
 npx ts-node examples/petstore/server-variables-usage.ts
 npx ts-node examples/petstore/retry-handler-usage.ts
+npx ts-node examples/petstore/error-handling-usage.ts
 ```
 
 **Additional examples:**
 
 - `server-variables-usage.ts` - Using server variables for different environments
 - `retry-handler-usage.ts` - Custom retry handler implementation
+- `error-handling-usage.ts` - Handling 4xx/5xx with custom HttpError
 
 ### ⚡ [PokéAPI](./pokeapi/)
 
@@ -53,7 +55,7 @@ zod-codegen --input ./samples/pokeapi-openapi.json --output ./examples/pokeapi
 
 Each example directory contains:
 
-- `type.ts` - Generated client and schemas (created by zod-codegen)
+- `api.ts` - Generated client and schemas (created by zod-codegen)
 - `README.md` - Example-specific documentation
 - `basic-usage.ts` - Basic usage examples
 - `authenticated-usage.ts` - Authentication examples (if applicable)
@@ -62,7 +64,7 @@ Each example directory contains:
 
 1. **Choose an example** that matches your use case
 2. **Generate the client** using the command shown in the example's README
-3. **Review the generated code** in `type.ts`
+3. **Review the generated code** in `api.ts`
 4. **Run the example scripts** to see it in action
 5. **Extend the client** using patterns from [EXAMPLES.md](../EXAMPLES.md)
 

package/examples/petstore/README.md

@@ -6,12 +6,12 @@ This example demonstrates how to use `zod-codegen` with the Swagger Petstore Ope
 
 After running `zod-codegen`, you'll get:
 
-- `type.ts` - Contains all Zod schemas and the generated API client
+- `api.ts` - Contains all Zod schemas and the generated API client
 
 ## Basic Usage
 
 ```typescript
-import {SwaggerPetstoreOpenAPI30} from './type';
+import SwaggerPetstoreOpenAPI30 from './api';
 
 // Create a client instance using default server from OpenAPI spec
 const client = new SwaggerPetstoreOpenAPI30({});
@@ -26,19 +26,20 @@ console.log('Available pets:', pets);
 The generated client supports flexible server configuration:
 
 ```typescript
-import {SwaggerPetstoreOpenAPI30, ClientOptions} from './type';
+import SwaggerPetstoreOpenAPI30 from './api';
+import type { ClientOptions } from './api';
 
 // Option 1: Use default server (first server from OpenAPI spec)
 const defaultClient = new SwaggerPetstoreOpenAPI30({});
 
 // Option 2: Override with custom base URL
 const customClient = new SwaggerPetstoreOpenAPI30({
-  baseUrl: 'https://custom-api.example.com/v3',
+  baseUrl: 'https://custom-api.example.com/v3'
 });
 
 // Option 3: Select server by index (if multiple servers exist)
 const indexedClient = new SwaggerPetstoreOpenAPI30({
-  serverIndex: 0,
+  serverIndex: 0
 });
 
 // Option 4: Use server variables (if your OpenAPI spec has templated URLs)
@@ -48,15 +49,15 @@ const variableClient = new SwaggerPetstoreOpenAPI30({
   serverVariables: {
     environment: 'api.staging',
     port: '8443',
-    version: '2',
-  },
+    version: '2'
+  }
 });
 ```
 
 ## Example: Finding Pets
 
 ```typescript
-import {SwaggerPetstoreOpenAPI30} from './type';
+import SwaggerPetstoreOpenAPI30 from './api';
 
 async function findAvailablePets() {
   const client = new SwaggerPetstoreOpenAPI30({});
@@ -84,25 +85,25 @@ findAvailablePets();
 ## Example: Adding a Pet
 
 ```typescript
-import {SwaggerPetstoreOpenAPI30, Pet, PetStatus} from './type';
-import {z} from 'zod';
+import SwaggerPetstoreOpenAPI30 from './api';
+import type { Pet } from './api';
 
 async function addNewPet() {
   const client = new SwaggerPetstoreOpenAPI30({});
 
-  const newPet: z.infer<typeof Pet> = {
+  const newPet: Pet = {
     id: 12345,
     name: 'Fluffy',
-    status: PetStatus.enum.available,
+    status: 'available',
     category: {
       id: 1,
-      name: 'Dogs',
+      name: 'Dogs'
     },
     photoUrls: ['https://example.com/fluffy.jpg'],
     tags: [
-      {id: 1, name: 'friendly'},
-      {id: 2, name: 'cute'},
-    ],
+      { id: 1, name: 'friendly' },
+      { id: 2, name: 'cute' }
+    ]
   };
 
   try {
@@ -118,4 +119,4 @@ addNewPet();
 
 ## Example: Extending the Client
 
-See the main [EXAMPLES.md](../../EXAMPLES.md) for comprehensive examples on extending the client for authentication, CORS, and custom headers.
+See the main [EXAMPLES.md](../../EXAMPLES.md) for comprehensive examples on extending the client for authentication, CORS, custom headers, and response handling (including [4xx/5xx error handling](../../EXAMPLES.md#handling-4xx5xx-in-handleresponse)).