zod-codegen 1.0.2 → 1.1.0

package/examples/petstore/type.ts

@@ -0,0 +1,217 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+// Built with zod-codegen@1.0.1
+// Latest edit: Thu, 13 Nov 2025 13:36:35 GMT
+// Source file: ./samples/swagger-petstore.yaml
+/* eslint-disable */
+// @ts-nocheck
+
+// Imports
+import {z} from 'zod';
+
+// Components schemas
+export const Order = z.object({
+  id: z.number().int().optional(),
+  petId: z.number().int().optional(),
+  quantity: z.number().int().optional(),
+  shipDate: z.string().datetime().optional(),
+  status: z.enum(['placed', 'approved', 'delivered']).optional(),
+  complete: z.boolean().optional(),
+});
+export const Address = z.object({
+  street: z.string().optional(),
+  city: z.string().optional(),
+  state: z.string().optional(),
+  zip: z.string().optional(),
+});
+export const Customer = z.object({
+  id: z.number().int().optional(),
+  username: z.string().optional(),
+  address: z.array(Address).optional(),
+});
+export const Category = z.object({
+  id: z.number().int().optional(),
+  name: z.string().optional(),
+});
+export const User = z.object({
+  id: z.number().int().optional(),
+  username: z.string().optional(),
+  firstName: z.string().optional(),
+  lastName: z.string().optional(),
+  email: z.string().optional(),
+  password: z.string().optional(),
+  phone: z.string().optional(),
+  userStatus: z.number().int().optional(),
+});
+export const Tag = z.object({
+  id: z.number().int().optional(),
+  name: z.string().optional(),
+});
+export const Pet = z.object({
+  id: z.number().int().optional(),
+  name: z.string(),
+  category: Category.optional(),
+  photoUrls: z.array(z.string()),
+  tags: z.array(Tag).optional(),
+  status: z.enum(['available', 'pending', 'sold']).optional(),
+});
+export const ApiResponse = z.object({
+  code: z.number().int().optional(),
+  type: z.string().optional(),
+  message: z.string().optional(),
+});
+export const serverConfigurations = [
+  {
+    url: 'https://petstore3.swagger.io/api/v3',
+  },
+];
+export const defaultBaseUrl = 'https://petstore3.swagger.io/api/v3';
+export type ClientOptions = {
+  baseUrl?: string;
+  serverIndex?: number;
+  serverVariables?: Record<string, string>;
+};
+function resolveServerUrl(serverIndex?: number | undefined, serverVariables?: Record<string, string> = {}): string {
+  const configs = [
+    {
+      url: 'https://petstore3.swagger.io/api/v3',
+    },
+  ];
+  const idx = serverIndex ?? 0;
+  if (idx < configs.length) {
+    const config = configs[idx];
+    let url = config.url;
+    if (config.variables && serverVariables) {
+      for (const [key, value] of Object.entries(serverVariables)) {
+        url = url.replace(new RegExp('\\{' + key + '\\}', 'g'), value);
+      }
+    }
+    return url;
+  }
+  return 'https://petstore3.swagger.io/api/v3';
+}
+
+// Client class
+export class SwaggerPetstoreOpenAPI30 {
+  readonly #baseUrl: string;
+  constructor(options: ClientOptions) {
+    const resolvedUrl =
+      options.baseUrl !== null ? options.baseUrl : resolveServerUrl(options.serverIndex, options.serverVariables);
+    this.#baseUrl = resolvedUrl;
+  }
+  protected getBaseRequestOptions(): Partial<Omit<RequestInit, 'method' | 'body'>> {
+    return {};
+  }
+  async #makeRequest<T>(
+    method: string,
+    path: string,
+    options: _params___Record_string__string___number___boolean___data___unknown__contentType___string__headers___Record_string__string__ = {},
+  ): Promise<T> {
+    const baseUrl = `${this.#baseUrl}${path}`;
+    const url =
+      options.params && Object.keys(options.params).length > 0
+        ? (() => {
+            Object.entries(options.params).forEach(([key, value]) => {
+              new URL(baseUrl).searchParams.set(key, String(value));
+            });
+            return new URL(baseUrl).toString();
+          })()
+        : new URL(baseUrl).toString();
+    const baseOptions = this.getBaseRequestOptions();
+    const contentType =
+      options.contentType === 'application/x-www-form-urlencoded'
+        ? 'application/x-www-form-urlencoded'
+        : 'application/json';
+    const baseHeaders = baseOptions.headers !== undefined ? baseOptions.headers : {};
+    const headers = Object.assign(
+      {},
+      baseHeaders,
+      {'Content-Type': contentType},
+      options.headers !== undefined ? options.headers : {},
+    );
+    const body =
+      options.data !== undefined
+        ? options.contentType === 'application/x-www-form-urlencoded'
+          ? (() => {
+              const params = new URLSearchParams();
+              Object.entries(options.data).forEach(([key, value]) => {
+                params.set(key, String(value));
+              });
+              return params.toString();
+            })()
+          : JSON.stringify(options.data)
+        : null;
+    const response = await fetch(url, Object.assign({}, baseOptions, {method, headers: headers, body: body}));
+    if (!response.ok) throw new Error(`HTTP ${response.status}: ${response.statusText}`);
+    return await response.json();
+  }
+  async addPet(body: Pet): Promise<Pet> {
+    return Pet.parse(
+      await this.#makeRequest('POST', '/pet', {data: body, contentType: 'application/x-www-form-urlencoded'}),
+    );
+  }
+  async updatePet(body: Pet): Promise<Pet> {
+    return Pet.parse(
+      await this.#makeRequest('PUT', '/pet', {data: body, contentType: 'application/x-www-form-urlencoded'}),
+    );
+  }
+  async findPetsByStatus(status?: string): Promise<Pet[]> {
+    return await this.#makeRequest('GET', '/pet/findByStatus', {params: {status: status}});
+  }
+  async findPetsByTags(tags?: string[]): Promise<Pet[]> {
+    return await this.#makeRequest('GET', '/pet/findByTags', {params: {tags: tags}});
+  }
+  async getPetById(petId: number): Promise<Pet> {
+    return Pet.parse(await this.#makeRequest('GET', `/pet/${petId}`, {}));
+  }
+  async updatePetWithForm(petId: number, name?: string, status?: string): Promise<void> {
+    return await this.#makeRequest('POST', `/pet/${petId}`, {params: {name: name, status: status}});
+  }
+  async deletePet(petId: number): Promise<void> {
+    return await this.#makeRequest('DELETE', `/pet/${petId}`, {});
+  }
+  async uploadFile(petId: number, additionalMetadata?: string): Promise<ApiResponse> {
+    return ApiResponse.parse(
+      await this.#makeRequest('POST', `/pet/${petId}/uploadImage`, {params: {additionalMetadata: additionalMetadata}}),
+    );
+  }
+  async getInventory(): Promise<Record<string, unknown>> {
+    return await this.#makeRequest('GET', '/store/inventory', {});
+  }
+  async placeOrder(body?: Order): Promise<Order> {
+    return Order.parse(
+      await this.#makeRequest('POST', '/store/order', {data: body, contentType: 'application/x-www-form-urlencoded'}),
+    );
+  }
+  async getOrderById(orderId: number): Promise<Order> {
+    return Order.parse(await this.#makeRequest('GET', `/store/order/${orderId}`, {}));
+  }
+  async deleteOrder(orderId: number): Promise<void> {
+    return await this.#makeRequest('DELETE', `/store/order/${orderId}`, {});
+  }
+  async createUser(body?: User): Promise<User> {
+    return User.parse(
+      await this.#makeRequest('POST', '/user', {data: body, contentType: 'application/x-www-form-urlencoded'}),
+    );
+  }
+  async createUsersWithListInput(body?: User[]): Promise<User> {
+    return User.parse(await this.#makeRequest('POST', '/user/createWithList', {data: body}));
+  }
+  async loginUser(username?: string, password?: string): Promise<string> {
+    return await this.#makeRequest('GET', '/user/login', {params: {username: username, password: password}});
+  }
+  async logoutUser(): Promise<void> {
+    return await this.#makeRequest('GET', '/user/logout', {});
+  }
+  async getUserByName(username: string): Promise<User> {
+    return User.parse(await this.#makeRequest('GET', `/user/${username}`, {}));
+  }
+  async updateUser(username: string, body?: User): Promise<void> {
+    return await this.#makeRequest('PUT', `/user/${username}`, {
+      data: body,
+      contentType: 'application/x-www-form-urlencoded',
+    });
+  }
+  async deleteUser(username: string): Promise<void> {
+    return await this.#makeRequest('DELETE', `/user/${username}`, {});
+  }
+}

package/examples/pokeapi/README.md

@@ -0,0 +1,105 @@
+# PokéAPI Example
+
+This example demonstrates how to use `zod-codegen` with the PokéAPI OpenAPI specification.
+
+## Setup
+
+First, generate the client from the PokéAPI OpenAPI spec:
+
+```bash
+zod-codegen --input ./samples/pokeapi-openapi.json --output ./examples/pokeapi
+```
+
+**Note**: PokéAPI doesn't provide an official OpenAPI specification, so we've created a simplified OpenAPI spec based on their API structure. For production use, you may want to create a more complete specification based on the [PokéAPI documentation](https://pokeapi.co/docs/v2).
+
+## Basic Usage
+
+```typescript
+import {PokAPI, defaultBaseUrl} from './type.js';
+
+// Create a client instance
+const client = new PokAPI(defaultBaseUrl);
+
+// Use the generated methods
+const pokemon = await client.getPokemonById('pikachu');
+console.log('Pokemon:', pokemon);
+```
+
+## Example: Fetching Pokémon Data
+
+See [basic-usage.ts](./basic-usage.ts) for a complete example:
+
+```typescript
+import {PokAPI, defaultBaseUrl} from './type.js';
+
+async function getPokemonInfo() {
+  const client = new PokAPI(defaultBaseUrl);
+
+  try {
+    // Get a specific Pokémon by ID or name
+    const pikachu = await client.getPokemonById('pikachu');
+    console.log(`Name: ${pikachu.name}`);
+    console.log(`Height: ${pikachu.height} dm`);
+    console.log(`Weight: ${pikachu.weight} hg`);
+
+    if (pikachu.types && pikachu.types.length > 0) {
+      const types = pikachu.types
+        .map((t) => t.type?.name)
+        .filter(Boolean)
+        .join(', ');
+      console.log(`Types: ${types}`);
+    }
+
+    // Get Pokémon list with pagination
+    const pokemonList = await client.getPokemonList(20, 0);
+    console.log(`\nTotal Pokémon: ${pokemonList.count}`);
+    console.log(`Showing: ${pokemonList.results.length} results`);
+  } catch (error) {
+    console.error('Error fetching Pokémon:', error);
+  }
+}
+
+getPokemonInfo();
+```
+
+**Run the example:**
+
+```bash
+npx ts-node examples/pokeapi/basic-usage.ts
+```
+
+## Example: Extending for Custom Headers
+
+See [custom-client.ts](./custom-client.ts) for a complete example:
+
+```typescript
+import {PokAPI, defaultBaseUrl} from './type.js';
+
+class CustomPokeAPI extends PokAPI {
+  protected getBaseRequestOptions(): Partial<Omit<RequestInit, 'method' | 'body'>> {
+    const options = super.getBaseRequestOptions();
+    return {
+      ...options,
+      headers: {
+        ...((options.headers as Record<string, string>) || {}),
+        'User-Agent': 'MyPokemonApp/1.0.0',
+        Accept: 'application/json',
+      },
+      mode: 'cors',
+      cache: 'default',
+    };
+  }
+}
+
+const client = new CustomPokeAPI(defaultBaseUrl);
+```
+
+**Run the example:**
+
+```bash
+npx ts-node examples/pokeapi/custom-client.ts
+```
+
+## Note
+
+PokéAPI is a public API that doesn't require authentication, making it perfect for testing and learning. The generated client will work out of the box without any additional configuration.

package/examples/pokeapi/basic-usage.ts

@@ -0,0 +1,57 @@
+/**
+ * Basic usage example for the generated PokéAPI client
+ *
+ * Run with: npx ts-node examples/pokeapi/basic-usage.ts
+ */
+
+import {PokAPI, defaultBaseUrl} from './type.js';
+
+async function main() {
+  const client = new PokAPI(defaultBaseUrl);
+
+  try {
+    console.log('🔍 Fetching Pokémon data...\n');
+
+    // Get a specific Pokémon by ID or name
+    console.log('📖 Getting Pikachu...');
+    const pikachu = await client.getPokemonById('pikachu');
+    console.log(`✅ Found: ${pikachu.name}`);
+    console.log(`   ID: ${pikachu.id}`);
+    console.log(`   Height: ${pikachu.height} dm`);
+    console.log(`   Weight: ${pikachu.weight} hg`);
+
+    if (pikachu.types && pikachu.types.length > 0) {
+      const types = pikachu.types
+        .map((t) => t.type?.name)
+        .filter(Boolean)
+        .join(', ');
+      console.log(`   Types: ${types}`);
+    }
+
+    if (pikachu.sprites?.front_default) {
+      console.log(`   Sprite: ${pikachu.sprites.front_default}`);
+    }
+
+    // Get Pokémon list
+    console.log('\n📋 Getting Pokémon list...');
+    const pokemonList = await client.getPokemonList(10, 0);
+    console.log(`✅ Found ${pokemonList.count} total Pokémon`);
+    console.log(`   Showing first ${pokemonList.results.length} results:`);
+
+    pokemonList.results.slice(0, 5).forEach((pokemon, index) => {
+      console.log(`   ${index + 1}. ${pokemon.name}`);
+    });
+  } catch (error) {
+    if (error instanceof Error) {
+      console.error('❌ Error:', error.message);
+      if (error.message.includes('HTTP')) {
+        console.error('   This might be a network issue or the API endpoint may have changed.');
+      }
+    } else {
+      console.error('❌ Unknown error:', error);
+    }
+    process.exit(1);
+  }
+}
+
+void main();

package/examples/pokeapi/custom-client.ts

@@ -0,0 +1,56 @@
+/**
+ * Example showing how to extend the PokéAPI client with custom configuration
+ *
+ * Run with: npx ts-node examples/pokeapi/custom-client.ts
+ */
+
+import {PokAPI, defaultBaseUrl} from './type.js';
+
+class CustomPokeAPIClient extends PokAPI {
+  protected getBaseRequestOptions(): Partial<Omit<RequestInit, 'method' | 'body'>> {
+    const options = super.getBaseRequestOptions();
+    return {
+      ...options,
+      headers: {
+        ...((options.headers as Record<string, string>) || {}),
+        'User-Agent': 'MyPokemonApp/1.0.0 (https://myapp.com)',
+        Accept: 'application/json',
+      },
+      mode: 'cors',
+      cache: 'default',
+    };
+  }
+}
+
+async function main() {
+  const client = new CustomPokeAPIClient(defaultBaseUrl);
+
+  try {
+    console.log('🔍 Fetching Pokémon with custom client...\n');
+
+    // Get Charizard
+    const charizard = await client.getPokemonById('charizard');
+    console.log(`✅ ${charizard.name.toUpperCase()}`);
+    console.log(`   ID: ${charizard.id}`);
+    console.log(`   Height: ${charizard.height} dm`);
+    console.log(`   Weight: ${charizard.weight} hg`);
+
+    if (charizard.abilities && charizard.abilities.length > 0) {
+      console.log('\n   Abilities:');
+      charizard.abilities.forEach((ability, index) => {
+        const abilityName = ability.ability?.name || 'Unknown';
+        const hidden = ability.is_hidden ? ' (hidden)' : '';
+        console.log(`   ${index + 1}. ${abilityName}${hidden}`);
+      });
+    }
+  } catch (error) {
+    if (error instanceof Error) {
+      console.error('❌ Error:', error.message);
+    } else {
+      console.error('❌ Unknown error:', error);
+    }
+    process.exit(1);
+  }
+}
+
+void main();

package/examples/pokeapi/type.ts

@@ -0,0 +1,109 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+// Built with zod-codegen@1.0.1
+// Latest edit: Thu, 13 Nov 2025 13:32:35 GMT
+// Source file: ./samples/pokeapi-openapi.json
+/* eslint-disable */
+// @ts-nocheck
+
+// Imports
+import {z} from 'zod';
+
+// Components schemas
+export const NamedAPIResource = z.object({
+  name: z.string(),
+  url: z.string().url(),
+});
+export const PokemonType = z.object({
+  slot: z.number().int().optional(),
+  type: NamedAPIResource.optional(),
+});
+export const PokemonAbility = z.object({
+  ability: NamedAPIResource.optional(),
+  is_hidden: z.boolean().optional(),
+  slot: z.number().int().optional(),
+});
+export const PokemonSprites = z.object({
+  front_default: z.string().url().optional(),
+  front_shiny: z.string().url().optional(),
+  back_default: z.string().url().optional(),
+  back_shiny: z.string().url().optional(),
+});
+export const Pokemon = z.object({
+  id: z.number().int(),
+  name: z.string(),
+  height: z.number().int().optional(),
+  weight: z.number().int().optional(),
+  base_experience: z.number().int().optional(),
+  types: z.array(PokemonType).optional(),
+  abilities: z.array(PokemonAbility).optional(),
+  sprites: PokemonSprites.optional(),
+});
+export const PokemonListResponse = z.object({
+  count: z.number().int(),
+  next: z.string().url().optional(),
+  previous: z.string().url().optional(),
+  results: z.array(NamedAPIResource),
+});
+export const defaultBaseUrl = 'https://pokeapi.co/api/v2';
+
+// Client class
+export class PokAPI {
+  readonly #baseUrl: string;
+  constructor(baseUrl: string = defaultBaseUrl, _?: unknown) {
+    this.#baseUrl = baseUrl;
+  }
+  protected getBaseRequestOptions(): Partial<Omit<RequestInit, 'method' | 'body'>> {
+    return {};
+  }
+  async #makeRequest<T>(
+    method: string,
+    path: string,
+    options: _params___Record_string__string___number___boolean___data___unknown__contentType___string__headers___Record_string__string__ = {},
+  ): Promise<T> {
+    const baseUrl = `${this.#baseUrl}${path}`;
+    const url =
+      options.params && Object.keys(options.params).length > 0
+        ? (() => {
+            Object.entries(options.params).forEach(([key, value]) => {
+              new URL(baseUrl).searchParams.set(key, String(value));
+            });
+            return new URL(baseUrl).toString();
+          })()
+        : new URL(baseUrl).toString();
+    const baseOptions = this.getBaseRequestOptions();
+    const contentType =
+      options.contentType === 'application/x-www-form-urlencoded'
+        ? 'application/x-www-form-urlencoded'
+        : 'application/json';
+    const baseHeaders = baseOptions.headers !== undefined ? baseOptions.headers : {};
+    const headers = Object.assign(
+      {},
+      baseHeaders,
+      {'Content-Type': contentType},
+      options.headers !== undefined ? options.headers : {},
+    );
+    const body =
+      options.data !== undefined
+        ? options.contentType === 'application/x-www-form-urlencoded'
+          ? (() => {
+              const params = new URLSearchParams();
+              Object.entries(options.data).forEach(([key, value]) => {
+                params.set(key, String(value));
+              });
+              return params.toString();
+            })()
+          : JSON.stringify(options.data)
+        : null;
+    const response = await fetch(url, Object.assign({}, baseOptions, {method, headers: headers, body: body}));
+    if (!response.ok) throw new Error(`HTTP ${response.status}: ${response.statusText}`);
+    return await response.json();
+  }
+  async getPokemonById(id: string): Promise<Pokemon> {
+    return Pokemon.parse(await this.#makeRequest('GET', `/pokemon/${id}`, {}));
+  }
+  async getPokemonList(limit?: number, offset?: number): Promise<PokemonListResponse> {
+    return PokemonListResponse.parse(
+      await this.#makeRequest('GET', '/pokemon', {params: {limit: limit, offset: offset}}),
+    );
+  }
+}

package/package.json

@@ -79,8 +79,9 @@
   },
   "scripts": {
     "build": "rm -rf dist && tsc --project tsconfig.json && cp -r src/assets dist/src/ && chmod +x ./dist/src/cli.js",
+    "build:native": "rm -rf dist && npx tsgo --project tsconfig.json && cp -r src/assets dist/src/ && chmod +x ./dist/src/cli.js",
     "build:watch": "tsc --project tsconfig.json --watch",
-    "dev": "npm run build && node ./dist/src/cli.js --input ./samples/saris-openapi.json && npm run format && npm run lint",
+    "dev": "npm run build && node ./dist/src/cli.js --input ./samples/swagger-petstore.yaml --output ./examples/petstore && npm run format && npm run lint",
     "lint": "eslint src --fix",
     "lint:check": "eslint src",
     "format": "prettier src --write --log-level error",
@@ -95,8 +96,9 @@
     "prepublishOnly": "npm run build && npm run test && npm run lint:check && npm run type-check",
     "clean": "rm -rf dist coverage node_modules/.cache",
     "validate": "npm run type-check && npm run lint:check && npm run format:check && npm run test",
+    "validate:examples": "tsc -p ./tsconfig.examples.json --noEmit",
     "release": "semantic-release",
     "release:dry": "semantic-release --dry-run"
   },
-  "version": "1.0.2"
+  "version": "1.1.0"
 }