Merge pull request #3 from JeffreyNijs/refactor/mock-generation-config-to-use-mockStrategy

Refactor mock generation config to use mockStrategy

Author: JeffreyNijs

README.md

@@ -18,7 +18,7 @@
 - **Automatic Reference Resolution:** Handles `$ref` and schema composition, so your builders reflect your OpenAPI definitions accurately.
 - **Seamless Integration:** Designed to work with Hey API's plugin system and TypeScript type generation.
 - **Zero External Dependencies:** No need for faker.js or other heavy dependencies - the custom runtime is lightweight and fast.
-- **Configurable Output:** Choose between custom runtime, Zod, or static mock generation.
+- **Flexible Configuration:** Choose between custom runtime, Zod, or static mock generation using a simple `mockStrategy` option.
 
 ## Installation
 
@@ -56,17 +56,32 @@ export default defineConfig({
     defineBuildersConfig({
       // Optional: Generate Zod schemas for validation
       generateZod: true,
-      // Optional: Use Zod for mock generation (requires zod-mock library)
-      useZodForMocks: false,
-      // Optional: Use static mock generation (no runtime dependencies)
-      useStaticMocks: false,
+      // Optional: Mock generation strategy (default: 'runtime')
+      // Options: 'runtime' | 'zod' | 'static'
+      mockStrategy: 'runtime',
       // Optional: Custom output filename
       output: 'builders.gen.ts'
     }),
   ],
 });
 ```
 
+### Configuration Options
+
+- **generateZod** (boolean): Generate Zod schemas alongside builders for validation. Default: `false`.
+- **mockStrategy** (string): Strategy for generating mock data. Default: `'runtime'`.
+  - `'runtime'`: Use custom lightweight runtime mock generation
+  - `'zod'`: Use Zod for mock generation
+  - `'static'`: Generate static mock builders without runtime dependencies
+- **output** (string): Output filename (without extension) for the generated builders. Default: `'builders'`.
+
+### Deprecated Options
+
+The following options are deprecated but still supported for backward compatibility:
+
+- **useZodForMocks** (boolean): Use `mockStrategy: 'zod'` instead.
+- **useStaticMocks** (boolean): Use `mockStrategy: 'static'` instead.
+
 ## Usage
 
 After running the Hey API code generation, you'll get a file containing builder classes for each schema.
@@ -99,20 +114,19 @@ if (result.success) {
 }
 ```
 
-## Configuration Options
-
-- **generateZod** (boolean): Generate Zod schemas alongside builders for validation. Default: `false`.
-- **useZodForMocks** (boolean): Use Zod for mock generation instead of the custom runtime. Default: `false`.
-- **useStaticMocks** (boolean): Generate static mock builders without runtime dependencies. When enabled, generates hardcoded mock values based on schema types. Default: `false`.
-- **output** (string): Output filename (without extension) for the generated builders. Default: `'builders'`.
-
 ## Mock Generation Strategies
 
 ### Custom Runtime (Default)
 
 The default strategy uses a lightweight custom mock generator that supports all JSON Schema features without external dependencies. This provides fast, predictable mock data generation.
 
 ```typescript
+// Configuration
+defineBuildersConfig({
+  mockStrategy: 'runtime', // or omit for default
+})
+
+// Usage
 import { UserBuilder } from './client/builders';
 
 const user = new UserBuilder()
@@ -129,7 +143,7 @@ Features:
 
 ### Static Mocks
 
-When `useStaticMocks: true` is enabled, the plugin generates hardcoded mock values directly in the builder classes. This approach:
+When `mockStrategy: 'static'` is configured, the plugin generates hardcoded mock values directly in the builder classes. This approach:
 
 - **No runtime generation** - All values are pre-computed at build time
 - **Predictable values** - generates consistent, type-appropriate default values
@@ -139,7 +153,7 @@ When `useStaticMocks: true` is enabled, the plugin generates hardcoded mock valu
 ```typescript
 // Configuration
 defineBuildersConfig({
-  useStaticMocks: true,
+  mockStrategy: 'static',
 })
 
 // Usage - same API, but mocks are statically generated
@@ -159,7 +173,19 @@ Static mocks generate appropriate defaults based on OpenAPI types and formats:
 
 ### Zod Integration
 
-When `useZodForMocks: true` is enabled, mock generation uses Zod schemas. This is experimental and provides runtime validation.
+When `mockStrategy: 'zod'` is configured, mock generation uses Zod schemas. This is experimental and provides runtime validation.
+
+```typescript
+// Configuration
+defineBuildersConfig({
+  mockStrategy: 'zod',
+})
+
+// Usage
+const user = new UserBuilder()
+  .withName('Alice')
+  .build(); // Uses Zod for mock generation
+```
 
 ## Format Support
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hey-api-builders",
-  "version": "0.7.0",
+  "version": "0.8.1",
   "description": "A custom plugin for @hey-api/openapi-ts that generates mock data builders with a lightweight custom runtime, Zod integration, or static mock generation.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/core/code-generator.test.ts

@@ -78,10 +78,9 @@ describe('Code Generator', () => {
   });
 
   describe('generateImports', () => {
-    it('generates JSF imports when useStaticMocks is false', () => {
+    it('generates runtime imports when mockStrategy is runtime', () => {
       const result = generateImports({
-        useStaticMocks: false,
-        useZodForMocks: false,
+        mockStrategy: 'runtime',
         generateZod: false,
       });
 
@@ -91,10 +90,9 @@ describe('Code Generator', () => {
       expect(result).not.toContain('import { z }');
     });
 
-    it('generates Zod imports when useZodForMocks is true', () => {
+    it('generates Zod imports when mockStrategy is zod', () => {
       const result = generateImports({
-        useStaticMocks: false,
-        useZodForMocks: true,
+        mockStrategy: 'zod',
         generateZod: false,
       });
 
@@ -103,10 +101,9 @@ describe('Code Generator', () => {
       expect(result).not.toContain('import { generateMock }');
     });
 
-    it('generates no library imports when useStaticMocks is true', () => {
+    it('generates no library imports when mockStrategy is static', () => {
       const result = generateImports({
-        useStaticMocks: true,
-        useZodForMocks: false,
+        mockStrategy: 'static',
         generateZod: false,
       });
 
@@ -117,8 +114,7 @@ describe('Code Generator', () => {
 
     it('includes Zod import when generateZod is true', () => {
       const result = generateImports({
-        useStaticMocks: false,
-        useZodForMocks: false,
+        mockStrategy: 'runtime',
         generateZod: true,
       });
 
@@ -127,8 +123,7 @@ describe('Code Generator', () => {
 
     it('includes Zod import only once when both options use it', () => {
       const result = generateImports({
-        useStaticMocks: false,
-        useZodForMocks: true,
+        mockStrategy: 'zod',
         generateZod: true,
       });
 
@@ -212,8 +207,7 @@ describe('Code Generator', () => {
   describe('generateImports edge cases', () => {
     it('includes all imports when all options are enabled', () => {
       const result = generateImports({
-        useStaticMocks: false,
-        useZodForMocks: true,
+        mockStrategy: 'zod',
         generateZod: true,
       });
 
@@ -224,8 +218,7 @@ describe('Code Generator', () => {
 
     it('includes only base imports when no options are enabled', () => {
       const result = generateImports({
-        useStaticMocks: false,
-        useZodForMocks: false,
+        mockStrategy: 'runtime',
         generateZod: false,
       });
 
@@ -235,8 +228,7 @@ describe('Code Generator', () => {
 
     it('handles static mocks correctly', () => {
       const result = generateImports({
-        useStaticMocks: true,
-        useZodForMocks: false,
+        mockStrategy: 'static',
         generateZod: false,
       });
 

src/core/code-generator.ts

@@ -1,4 +1,4 @@
-import type { Schema } from '../types';
+import type { Schema, MockStrategy } from '../types';
 import type { ExtendedSchema } from '../types';
 import { toPascal } from './string-utils';
 
@@ -31,20 +31,19 @@ export function generateWithMethods(schema: Schema, typeName: string): string {
  * @returns Import statements
  */
 export function generateImports(options: {
-  useStaticMocks: boolean;
-  useZodForMocks: boolean;
+  mockStrategy: MockStrategy;
   generateZod: boolean;
 }): string {
-  const { useStaticMocks, useZodForMocks, generateZod } = options;
+  const { mockStrategy, generateZod } = options;
   let imports = '';
 
-  const needsZodImport = generateZod || useZodForMocks;
+  const needsZodImport = generateZod || mockStrategy === 'zod';
 
-  if (useStaticMocks) {
+  if (mockStrategy === 'static') {
     return 'import type * as types from "./types.gen"\n\n';
   }
 
-  if (useZodForMocks) {
+  if (mockStrategy === 'zod') {
     imports += 'import { generateMockFromZodSchema } from "hey-api-builders"\n';
   } else {
     imports += 'import { generateMock } from "hey-api-builders"\n';