zod-codegen 1.5.1 → 1.6.2

package/.github/workflows/ci.yml

@@ -76,7 +76,7 @@ jobs:
         run: npm ci
 
       - name: Run security audit
-        run: npm audit --audit-level=high
+        run: npm audit --audit-level=high --omit=dev
 
   build:
     name: Build & Package
@@ -137,6 +137,12 @@ jobs:
       - name: Build project
         run: npm run build
 
+      - name: Verify build output
+        run: |
+          test -f dist/src/cli.js || (echo "ERROR: dist/src/cli.js not found" && exit 1)
+          test -f dist/src/utils/reporter.js || (echo "ERROR: dist/src/utils/reporter.js not found" && exit 1)
+          echo "Build output verified successfully"
+
       - name: Preview semantic-release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/release.yml

@@ -44,12 +44,12 @@ jobs:
       - name: Run formatter check
         run: npm run format:check
 
-      - name: Run tests with coverage
-        run: npm run test:coverage
-
       - name: Build project
         run: npm run build
 
+      - name: Run tests with coverage
+        run: npm run test:coverage
+
       - name: Test CLI functionality
         run: |
           echo '{"openapi": "3.0.0", "info": {"title": "Test", "version": "1.0.0"}, "paths": {}}' > test-openapi.json

package/CHANGELOG.md

@@ -1,3 +1,37 @@
+## <small>1.6.2 (2026-01-19)</small>
+
+- fix: improve URL construction and filter undefined query params (#58) ([b9c3d32](https://github.com/julienandreu/zod-codegen/commit/b9c3d32)), closes [#58](https://github.com/julienandreu/zod-codegen/issues/58)
+- chore(deps): bump the dev-dependencies group across 1 directory with 5 updates (#57) ([30110fd](https://github.com/julienandreu/zod-codegen/commit/30110fd)), closes [#57](https://github.com/julienandreu/zod-codegen/issues/57)
+
+## <small>1.6.1 (2026-01-09)</small>
+
+- Merge pull request #55 from julienandreu/fix/integration-tests-timeout ([1e48796](https://github.com/julienandreu/zod-codegen/commit/1e48796)), closes [#55](https://github.com/julienandreu/zod-codegen/issues/55)
+- fix: remove npm build from integration tests to prevent timeouts ([1cfceac](https://github.com/julienandreu/zod-codegen/commit/1cfceac))
+
+## 1.6.0 (2026-01-09)
+
+- Merge pull request #54 from julienandreu/feat/response-handling-policies ([3f99c8f](https://github.com/julienandreu/zod-codegen/commit/3f99c8f)), closes [#54](https://github.com/julienandreu/zod-codegen/issues/54)
+- fix: add path mapping for zod-codegen/policies in examples ([d3dd5c9](https://github.com/julienandreu/zod-codegen/commit/d3dd5c9))
+- fix: export policies from package.json ([c1a3344](https://github.com/julienandreu/zod-codegen/commit/c1a3344))
+- fix: prevent duplicate method names for HEAD/OPTIONS with same operationId ([8c0b891](https://github.com/julienandreu/zod-codegen/commit/8c0b891))
+- fix: remove invalid semver-diff override causing CI failure ([278db05](https://github.com/julienandreu/zod-codegen/commit/278db05))
+- fix: remove unnecessary Promise.resolve in error handler ([d730ef4](https://github.com/julienandreu/zod-codegen/commit/d730ef4))
+- fix: update example to use zod-codegen/policies import path ([c7e3b07](https://github.com/julienandreu/zod-codegen/commit/c7e3b07))
+- fix: update TypeScript module resolution for Node.js ESM compatibility ([2d8f6a0](https://github.com/julienandreu/zod-codegen/commit/2d8f6a0))
+- fix: use extensionless imports in TypeScript source files ([dc0698c](https://github.com/julienandreu/zod-codegen/commit/dc0698c))
+- ci: add build output verification step to diagnose module resolution issue ([5174320](https://github.com/julienandreu/zod-codegen/commit/5174320))
+- docs: fix examples documentation ([04d6db8](https://github.com/julienandreu/zod-codegen/commit/04d6db8))
+- docs: update Node.js version requirement in CONTRIBUTING.md ([16cdc1e](https://github.com/julienandreu/zod-codegen/commit/16cdc1e))
+- docs: update PR description with latest test count ([f2ef4a8](https://github.com/julienandreu/zod-codegen/commit/f2ef4a8))
+- test: add comprehensive test suite to increase confidence ([48a7e2d](https://github.com/julienandreu/zod-codegen/commit/48a7e2d))
+- test: add tests for buildBasicTypeFromSchema edge cases ([c567c51](https://github.com/julienandreu/zod-codegen/commit/c567c51))
+- test: improve code coverage for code-generator.service.ts ([edbc92a](https://github.com/julienandreu/zod-codegen/commit/edbc92a))
+- refactor: completely remove policy system ([7c6439a](https://github.com/julienandreu/zod-codegen/commit/7c6439a))
+- refactor: implement quality improvements ([a5b1b14](https://github.com/julienandreu/zod-codegen/commit/a5b1b14))
+- refactor: remove policies export, keep zod-codegen as dev-dependency ([4eae513](https://github.com/julienandreu/zod-codegen/commit/4eae513))
+- refactor: remove unused code and improve Reporter ([51ae06a](https://github.com/julienandreu/zod-codegen/commit/51ae06a))
+- feat: add response handling policies system ([ad98229](https://github.com/julienandreu/zod-codegen/commit/ad98229))
+
 ## <small>1.5.1 (2026-01-05)</small>
 
 - Merge pull request #52 from julienandreu/dependabot/npm_and_yarn/production-dependencies-3204786a64 ([c2fa562](https://github.com/julienandreu/zod-codegen/commit/c2fa562)), closes [#52](https://github.com/julienandreu/zod-codegen/issues/52)

package/CONTRIBUTING.md

@@ -21,7 +21,7 @@ This project adheres to a code of conduct. By participating, you are expected to
 
 ### Prerequisites
 
-- Node.js >= 24.11.1
+- Node.js >= 18.0.0
 - yarn
 - Git
 

package/EXAMPLES.md

@@ -13,7 +13,7 @@ All examples below demonstrate how to extend the generated client class to add t
 ### Example: Adding Bearer Token Authentication
 
 ```typescript
-import {SwaggerPetstoreOpenAPI30, ClientOptions} from './generated/type.js';
+import {SwaggerPetstoreOpenAPI30, ClientOptions} from './generated/type';
 
 class AuthenticatedPetstoreAPI extends SwaggerPetstoreOpenAPI30 {
   private accessToken: string | null = null;
@@ -69,7 +69,7 @@ void main();
 ### Example: Session Management with Token Refresh
 
 ```typescript
-import {SwaggerPetstoreOpenAPI30} from './generated/type.js';
+import {SwaggerPetstoreOpenAPI30} from './generated/type';
 
 class SessionManagedPetstoreAPI extends SwaggerPetstoreOpenAPI30 {
   private accessToken: string | null = null;
@@ -132,7 +132,7 @@ class SessionManagedPetstoreAPI extends SwaggerPetstoreOpenAPI30 {
 If you need to pass custom headers for specific requests, you can extend the client and add helper methods:
 
 ```typescript
-import {SwaggerPetstoreOpenAPI30, ClientOptions} from './generated/type.js';
+import {SwaggerPetstoreOpenAPI30, ClientOptions} from './generated/type';
 
 class CustomHeadersPetstoreAPI extends SwaggerPetstoreOpenAPI30 {
   constructor(options: ClientOptions = {}) {
@@ -159,7 +159,7 @@ class CustomHeadersPetstoreAPI extends SwaggerPetstoreOpenAPI30 {
 ### Example: API Key Authentication
 
 ```typescript
-import {SwaggerPetstoreOpenAPI30, ClientOptions} from './generated/type.js';
+import {SwaggerPetstoreOpenAPI30, ClientOptions} from './generated/type';
 
 class ApiKeyAuthenticatedPetstoreAPI extends SwaggerPetstoreOpenAPI30 {
   constructor(options: ClientOptions & {apiKey: string}) {
@@ -185,7 +185,7 @@ class ApiKeyAuthenticatedPetstoreAPI extends SwaggerPetstoreOpenAPI30 {
 ### Example: Using AbortController for Request Cancellation
 
 ```typescript
-import {SwaggerPetstoreOpenAPI30, ClientOptions} from './generated/type.js';
+import {SwaggerPetstoreOpenAPI30, ClientOptions} from './generated/type';
 
 class CancellablePetstoreAPI extends SwaggerPetstoreOpenAPI30 {
   constructor(options: ClientOptions = {}) {
@@ -220,7 +220,7 @@ client.cancelRequests();
 ### Example: Custom Credentials and CORS Mode
 
 ```typescript
-import {SwaggerPetstoreOpenAPI30, ClientOptions} from './generated/type.js';
+import {SwaggerPetstoreOpenAPI30, ClientOptions} from './generated/type';
 
 class CustomCorsPetstoreAPI extends SwaggerPetstoreOpenAPI30 {
   constructor(options: ClientOptions = {}) {
@@ -249,7 +249,7 @@ grep
 Here's a comprehensive example showing how to combine CORS settings, custom User-Agent, and authentication:
 
 ```typescript
-import {SwaggerPetstoreOpenAPI30, ClientOptions} from './generated/type.js';
+import {SwaggerPetstoreOpenAPI30, ClientOptions} from './generated/type';
 
 class FullyConfiguredPetstoreAPI extends SwaggerPetstoreOpenAPI30 {
   private accessToken: string | null = null;
@@ -315,7 +315,7 @@ const pets = await client.findPetsByStatus('available');
 You can also create different configurations for different environments:
 
 ```typescript
-import {SwaggerPetstoreOpenAPI30, ClientOptions} from './generated/type.js';
+import {SwaggerPetstoreOpenAPI30, ClientOptions} from './generated/type';
 
 interface ClientConfig {
   userAgent?: string;
@@ -595,7 +595,7 @@ class RobustAPI extends YourAPI {
 ### Pattern 1: Simple Authentication
 
 ```typescript
-import {YourAPI, ClientOptions} from './generated/type.js';
+import {YourAPI, ClientOptions} from './generated/type';
 
 class SimpleAuthAPI extends YourAPI {
   private token: string | null = null;
@@ -620,7 +620,7 @@ class SimpleAuthAPI extends YourAPI {
 ### Pattern 2: Multiple Headers
 
 ```typescript
-import {YourAPI, ClientOptions} from './generated/type.js';
+import {YourAPI, ClientOptions} from './generated/type';
 
 class MultiHeaderAPI extends YourAPI {
   constructor(options: ClientOptions = {}) {
@@ -645,7 +645,7 @@ class MultiHeaderAPI extends YourAPI {
 ### Pattern 3: Conditional Options
 
 ```typescript
-import {YourAPI, ClientOptions} from './generated/type.js';
+import {YourAPI, ClientOptions} from './generated/type';
 
 class ConditionalAPI extends YourAPI {
   constructor(options: ClientOptions = {}) {
@@ -702,7 +702,7 @@ return {
 **Solution**: Store token as instance property:
 
 ```typescript
-import {YourAPI, ClientOptions} from './generated/type.js';
+import {YourAPI, ClientOptions} from './generated/type';
 
 class MyAPI extends YourAPI {
   private token: string | null = null; // ✅ Instance property
@@ -728,3 +728,82 @@ protected getBaseRequestOptions(): Partial<Omit<RequestInit, 'method' | 'body'>>
   // ✅ Correct return type
 }
 ```
+
+## Response Handling
+
+The generated client includes a protected `handleResponse()` method that you can override to implement custom response handling logic such as retries, logging, and error transformation.
+
+### Understanding handleResponse
+
+The `handleResponse()` method is called **before** error checking, allowing you to:
+
+- Intercept responses and handle special cases
+- Implement retry logic for specific status codes
+- Log requests and responses
+- Transform or modify responses
+
+**Method Signature:**
+
+```typescript
+protected async handleResponse<T>(
+  response: Response,
+  method: string,
+  path: string,
+  options: {
+    params?: Record<string, string | number | boolean>;
+    data?: unknown;
+    contentType?: string;
+    headers?: Record<string, string>;
+  },
+): Promise<Response>
+```
+
+### Example: Basic Retry Handler
+
+```typescript
+import {SwaggerPetstoreOpenAPI30} from './generated/type';
+
+class PetstoreClientWithRetry extends SwaggerPetstoreOpenAPI30 {
+  private retrying = false;
+
+  protected async handleResponse<T>(
+    response: Response,
+    method: string,
+    path: string,
+    options: {...},
+  ): Promise<Response> {
+    // Prevent infinite loops
+    if (this.retrying) {
+      return response;
+    }
+
+    // Handle 429 Too Many Requests
+    if (response.status === 429) {
+      const retryAfter = response.headers.get('Retry-After');
+      const delay = retryAfter ? parseInt(retryAfter, 10) * 1000 : 1000;
+
+      for (let attempt = 0; attempt < 3; attempt++) {
+        await new Promise((resolve) => setTimeout(resolve, delay * (attempt + 1)));
+
+        this.retrying = true;
+        try {
+          const retryResponse = await this.retryRequest(method, path, options);
+          if (retryResponse.ok) {
+            return retryResponse;
+          }
+        } finally {
+          this.retrying = false;
+        }
+      }
+    }
+
+    return response;
+  }
+
+  private async retryRequest(...): Promise<Response> {
+    // Reconstruct and make the request
+  }
+}
+```
+
+See [examples/petstore/retry-handler-usage.ts](./examples/petstore/retry-handler-usage.ts) for a complete example.

package/README.md

@@ -20,6 +20,7 @@ A powerful TypeScript code generator that creates **Zod schemas** and **type-saf
 - **🛡️ Runtime Validation**: Built-in Zod validation for request/response data
 - **🌍 Form Support**: Supports both JSON and form-urlencoded request bodies
 - **🔐 Extensible**: Override `getBaseRequestOptions()` to add authentication, custom headers, CORS, and other fetch options
+- **🔄 Response Handling**: Override `handleResponse()` to implement custom retry logic, logging, and error handling
 - **🌐 Server Configuration**: Full support for OpenAPI server variables and templating (e.g., `{environment}.example.com`)
 - **⚙️ Flexible Client Options**: Options-based constructor supporting server selection, variable overrides, and custom base URLs
 
@@ -145,7 +146,9 @@ The generator creates a single TypeScript file (`type.ts`) containing:
 - **API Client Class**: A type-safe client class with methods for each endpoint operation
 - **Server Configuration**: `serverConfigurations` array and `defaultBaseUrl` constant extracted from OpenAPI servers
 - **Client Options Type**: `ClientOptions` type for flexible server selection and variable overrides
-- **Protected Extension Point**: A `getBaseRequestOptions()` method that can be overridden for customization
+- **Protected Extension Points**:
+  - `getBaseRequestOptions()` method for customizing request options
+  - `handleResponse()` method for response handling (retries, circuit breakers, etc.)
 
 ### Generated Client Structure
 
@@ -164,6 +167,9 @@ export class YourAPI {
   // Protected method - override to customize request options
   protected getBaseRequestOptions(): Partial<Omit<RequestInit, 'method' | 'body'>>;
 
+  // Protected method - override to handle responses (retries, circuit breakers, etc.)
+  protected async handleResponse<T>(response: Response, method: string, path: string, options: {...}): Promise<Response>;
+
   // Private method - handles all HTTP requests
   async #makeRequest<T>(method: string, path: string, options: {...}): Promise<T>;
 
@@ -289,7 +295,7 @@ export class UserAPI {
 **Usage:**
 
 ```typescript
-import {UserAPI, User} from './generated/type.js';
+import {UserAPI, User} from './generated/type';
 
 // Use default server from OpenAPI spec
 const client = new UserAPI({});
@@ -310,7 +316,7 @@ The generated client includes a protected `getBaseRequestOptions()` method that
 #### Basic Authentication Example
 
 ```typescript
-import {UserAPI, ClientOptions} from './generated/type.js';
+import {UserAPI, ClientOptions} from './generated/type';
 
 class AuthenticatedUserAPI extends UserAPI {
   private accessToken: string | null = null;
@@ -344,7 +350,7 @@ const user = await client.getUserById(123); // Includes Authorization header
 #### Complete Configuration Example
 
 ```typescript
-import {UserAPI, ClientOptions} from './generated/type.js';
+import {UserAPI, ClientOptions} from './generated/type';
 
 class FullyConfiguredAPI extends UserAPI {
   private accessToken: string | null = null;
@@ -403,6 +409,7 @@ See [EXAMPLES.md](EXAMPLES.md) for comprehensive examples including:
 - CORS configuration
 - Request cancellation with AbortController
 - Environment-specific configurations
+- Response handling with custom retry logic and error handling
 
 ## 📖 Examples
 

package/dist/scripts/add-js-extensions.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=add-js-extensions.d.ts.map

package/dist/scripts/add-js-extensions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-js-extensions.d.ts","sourceRoot":"","sources":["../../scripts/add-js-extensions.ts"],"names":[],"mappings":""}

package/dist/scripts/add-js-extensions.js

@@ -0,0 +1,66 @@
+import { readdirSync, readFileSync, statSync, writeFileSync } from 'node:fs';
+import { extname, join } from 'node:path';
+/**
+ * Recursively finds all .js files in a directory
+ */
+function findJsFiles(dir) {
+    const files = [];
+    const entries = readdirSync(dir);
+    for (const entry of entries) {
+        const fullPath = join(dir, entry);
+        const stat = statSync(fullPath);
+        if (stat.isDirectory()) {
+            files.push(...findJsFiles(fullPath));
+        }
+        else if (extname(entry) === '.js') {
+            files.push(fullPath);
+        }
+    }
+    return files;
+}
+/**
+ * Adds .js extensions to relative imports in a JavaScript file
+ */
+function addJsExtensions(content) {
+    // Match relative imports: './something' or '../something' but not './something.js' or node: imports
+    // Handles both single and double quotes
+    // Also handles type imports: import type { ... } from './something'
+    const importRegex = /from\s+(['"])(\.\.?\/[^'"]+?)(['"])/g;
+    return content.replace(importRegex, (match, quote, importPath, endQuote) => {
+        // Skip if already has an extension
+        if (importPath.endsWith('.js') || importPath.endsWith('.json')) {
+            return match;
+        }
+        // Add .js extension
+        return `from ${quote}${importPath}.js${endQuote}`;
+    });
+}
+/**
+ * Main function to process all JavaScript files in dist/src
+ */
+function main() {
+    const distDir = join(process.cwd(), 'dist', 'src');
+    try {
+        const jsFiles = findJsFiles(distDir);
+        if (jsFiles.length === 0) {
+            console.warn('No .js files found in dist/src');
+            process.exit(0);
+        }
+        let processedCount = 0;
+        for (const filePath of jsFiles) {
+            const content = readFileSync(filePath, 'utf-8');
+            const updatedContent = addJsExtensions(content);
+            if (content !== updatedContent) {
+                writeFileSync(filePath, updatedContent, 'utf-8');
+                processedCount++;
+            }
+        }
+        console.log(`✅ Added .js extensions to ${String(processedCount)} file(s)`);
+        process.exit(0);
+    }
+    catch (error) {
+        console.error('❌ Error processing files:', error);
+        process.exit(1);
+    }
+}
+main();

package/dist/scripts/update-manifest.d.ts

@@ -0,0 +1,14 @@
+interface PackageJson {
+    name: string;
+    version: string;
+    description: string;
+}
+/**
+ * Type guard for the package.json object
+ *
+ * @param input Unknown input
+ * @returns true if the input is an event object
+ */
+export declare function isPackageJson(input: unknown): input is PackageJson;
+export {};
+//# sourceMappingURL=update-manifest.d.ts.map

package/dist/scripts/update-manifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-manifest.d.ts","sourceRoot":"","sources":["../../scripts/update-manifest.ts"],"names":[],"mappings":"AAKA,UAAU,WAAW;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAclE"}

package/dist/scripts/update-manifest.js

@@ -0,0 +1,33 @@
+import { readFileSync, writeFileSync } from 'node:fs';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { z } from 'zod';
+/**
+ * Type guard for the package.json object
+ *
+ * @param input Unknown input
+ * @returns true if the input is an event object
+ */
+export function isPackageJson(input) {
+    const event = z
+        .object({
+        name: z.string(),
+        version: z.string(),
+        description: z.string(),
+    })
+        .strict()
+        .catchall(z.any())
+        .required();
+    const { success } = event.safeParse(input);
+    return success;
+}
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const sourcePath = resolve(__dirname, '..', 'package.json');
+const data = JSON.parse(readFileSync(sourcePath, 'utf8'));
+if (!isPackageJson(data)) {
+    process.exit(1);
+}
+const { name, version, description } = data;
+const targetPath = resolve(__dirname, '..', 'src', 'assets', 'manifest.json');
+writeFileSync(targetPath, JSON.stringify({ name, version, description }, null, 2));
+process.exit(0);

package/dist/src/assets/manifest.json

@@ -1,5 +1,5 @@
 {
   "name": "zod-codegen",
-  "version": "1.0.1",
+  "version": "1.5.0",
   "description": "A powerful TypeScript code generator that creates Zod schemas and type-safe clients from OpenAPI specifications"
 }

package/dist/src/cli.js

@@ -37,12 +37,12 @@ if (!packageJsonPath) {
 }
 const packageData = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
 const { name, description, version } = packageData;
-const reporter = new Reporter(process.stdout);
+const reporter = new Reporter(process.stdout, process.stderr);
 const startTime = process.hrtime.bigint();
 debug(`${name}:${String(process.pid)}`);
 loudRejection();
-handleSignals(process, startTime);
-handleErrors(process, startTime);
+handleSignals(process, startTime, reporter);
+handleErrors(process, startTime, reporter);
 const argv = yargs(hideBin(process.argv))
     .scriptName(name)
     .usage(`${description}\n\nUsage: $0 [options]`)

package/dist/src/generator.d.ts

@@ -1,7 +1,34 @@
-import type { Reporter } from './utils/reporter.js';
-import type { GeneratorOptions } from './types/generator-options.js';
-export type { GeneratorOptions } from './types/generator-options.js';
-export type { NamingConvention, OperationDetails, OperationNameTransformer } from './utils/naming-convention.js';
+import type { Reporter } from './utils/reporter';
+import type { GeneratorOptions } from './types/generator-options';
+export type { GeneratorOptions } from './types/generator-options';
+export type { NamingConvention, OperationDetails, OperationNameTransformer } from './utils/naming-convention';
+/**
+ * Main generator class for creating TypeScript code from OpenAPI specifications.
+ *
+ * This class orchestrates the code generation process:
+ * 1. Reads the OpenAPI specification file (local or remote)
+ * 2. Parses and validates the specification
+ * 3. Generates TypeScript code with Zod schemas and type-safe API client
+ * 4. Writes the generated code to the output directory
+ *
+ * @example
+ * ```typescript
+ * import {Generator} from 'zod-codegen';
+ * import {Reporter} from './utils/reporter';
+ *
+ * const reporter = new Reporter(process.stdout, process.stderr);
+ * const generator = new Generator(
+ *   'my-app',
+ *   '1.0.0',
+ *   reporter,
+ *   './openapi.yaml',
+ *   './generated',
+ *   {namingConvention: 'camelCase'}
+ * );
+ *
+ * const exitCode = await generator.run();
+ * ```
+ */
 export declare class Generator {
     private readonly _name;
     private readonly _version;
@@ -13,7 +40,22 @@ export declare class Generator {
     private readonly codeGenerator;
     private readonly fileWriter;
     private readonly outputPath;
+    /**
+     * Creates a new Generator instance.
+     *
+     * @param _name - The name of the application/library (used in generated file headers)
+     * @param _version - The version of the application/library (used in generated file headers)
+     * @param reporter - Reporter instance for logging messages and errors
+     * @param inputPath - Path or URL to the OpenAPI specification file
+     * @param _outputDir - Directory where generated files will be written
+     * @param options - Optional configuration for code generation
+     */
     constructor(_name: string, _version: string, reporter: Reporter, inputPath: string, _outputDir: string, options?: GeneratorOptions);
+    /**
+     * Executes the code generation process.
+     *
+     * @returns Promise that resolves to an exit code (0 for success, 1 for failure)
+     */
     run(): Promise<number>;
     private readFile;
     private parseFile;

package/dist/src/generator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/generator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,qBAAqB,CAAC;AAElD,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,8BAA8B,CAAC;AAMnE,YAAY,EAAC,gBAAgB,EAAC,MAAM,8BAA8B,CAAC;AACnE,YAAY,EAAC,gBAAgB,EAAE,gBAAgB,EAAE,wBAAwB,EAAC,MAAM,8BAA8B,CAAC;AAE/G,qBAAa,SAAS;IAQlB,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAX7B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA+B;IAC1D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAkC;IAC7D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiC;IAC/D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAwB;IACnD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;gBAGjB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EACnC,OAAO,GAAE,gBAAqB;IAO1B,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC;YAqBd,QAAQ;IAItB,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,SAAS;CAGlB"}
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/generator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,2BAA2B,CAAC;AAMhE,YAAY,EAAC,gBAAgB,EAAC,MAAM,2BAA2B,CAAC;AAChE,YAAY,EAAC,gBAAgB,EAAE,gBAAgB,EAAE,wBAAwB,EAAC,MAAM,2BAA2B,CAAC;AAE5G;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,SAAS;IAkBlB,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,UAAU;IArB7B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA+B;IAC1D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAkC;IAC7D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiC;IAC/D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAwB;IACnD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IAEpC;;;;;;;;;OASG;gBAEgB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EACnC,OAAO,GAAE,gBAAqB;IAOhC;;;;OAIG;IACG,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC;YAqBd,QAAQ;IAItB,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,SAAS;CAGlB"}

package/dist/src/generator.js

@@ -1,6 +1,33 @@
 import { OpenApiFileParserService, SyncFileReaderService } from './services/file-reader.service.js';
 import { TypeScriptCodeGeneratorService } from './services/code-generator.service.js';
 import { SyncFileWriterService } from './services/file-writer.service.js';
+/**
+ * Main generator class for creating TypeScript code from OpenAPI specifications.
+ *
+ * This class orchestrates the code generation process:
+ * 1. Reads the OpenAPI specification file (local or remote)
+ * 2. Parses and validates the specification
+ * 3. Generates TypeScript code with Zod schemas and type-safe API client
+ * 4. Writes the generated code to the output directory
+ *
+ * @example
+ * ```typescript
+ * import {Generator} from 'zod-codegen';
+ * import {Reporter} from './utils/reporter.js';
+ *
+ * const reporter = new Reporter(process.stdout, process.stderr);
+ * const generator = new Generator(
+ *   'my-app',
+ *   '1.0.0',
+ *   reporter,
+ *   './openapi.yaml',
+ *   './generated',
+ *   {namingConvention: 'camelCase'}
+ * );
+ *
+ * const exitCode = await generator.run();
+ * ```
+ */
 export class Generator {
     _name;
     _version;
@@ -12,6 +39,16 @@ export class Generator {
     codeGenerator;
     fileWriter;
     outputPath;
+    /**
+     * Creates a new Generator instance.
+     *
+     * @param _name - The name of the application/library (used in generated file headers)
+     * @param _version - The version of the application/library (used in generated file headers)
+     * @param reporter - Reporter instance for logging messages and errors
+     * @param inputPath - Path or URL to the OpenAPI specification file
+     * @param _outputDir - Directory where generated files will be written
+     * @param options - Optional configuration for code generation
+     */
     constructor(_name, _version, reporter, inputPath, _outputDir, options = {}) {
         this._name = _name;
         this._version = _version;
@@ -22,6 +59,11 @@ export class Generator {
         this.outputPath = this.fileWriter.resolveOutputPath(this._outputDir);
         this.codeGenerator = new TypeScriptCodeGeneratorService(options);
     }
+    /**
+     * Executes the code generation process.
+     *
+     * @returns Promise that resolves to an exit code (0 for success, 1 for failure)
+     */
     async run() {
         try {
             const rawSource = await this.readFile();
@@ -38,7 +80,7 @@ export class Generator {
             else {
                 this.reporter.error('❌ An unknown error occurred');
             }
-            return Promise.resolve(1);
+            return 1;
         }
     }
     async readFile() {

package/dist/src/interfaces/code-generator.d.ts

@@ -1,4 +1,4 @@
-import type { OpenApiSpecType } from '../types/openapi.js';
+import type { OpenApiSpecType } from '../types/openapi';
 export interface CodeGenerator {
     generate(spec: OpenApiSpecType): string;
 }

package/dist/src/interfaces/code-generator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"code-generator.d.ts","sourceRoot":"","sources":["../../../src/interfaces/code-generator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,qBAAqB,CAAC;AAEzD,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,CAAC;CACzC;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAC3D;AAED,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CAClC;AAED,MAAM,WAAW,aAAa;IAC5B,YAAY,IAAI,OAAO,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC;CAC5C;AAED,MAAM,WAAW,UAAU;IACzB,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACpE"}
+{"version":3,"file":"code-generator.d.ts","sourceRoot":"","sources":["../../../src/interfaces/code-generator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,kBAAkB,CAAC;AAEtD,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,CAAC;CACzC;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAC3D;AAED,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CAClC;AAED,MAAM,WAAW,aAAa;IAC5B,YAAY,IAAI,OAAO,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC;CAC5C;AAED,MAAM,WAAW,UAAU;IACzB,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACpE"}