@cerios/openapi-to-zod 1.0.0 → 1.1.0

package/README.md

@@ -187,6 +187,7 @@ Examples:
 | `schemaType` | `"all"` \| `"request"` \| `"response"` | Schema filtering |
 | `prefix` | `string` | Prefix for schema names |
 | `suffix` | `string` | Suffix for schema names |
+| `stripSchemaPrefix` | `string \| RegExp` | Strip prefix from schema names before generating (e.g., `"Company.Models."` or `/^[A-Z]+\./`) |
 | `showStats` | `boolean` | Include generation statistics |
 | `request` | `object` | Request-specific options (mode, includeDescriptions, useDescribe) |
 | `response` | `object` | Response-specific options (mode, includeDescriptions, useDescribe) |
@@ -598,6 +599,183 @@ This is useful when:
 - Following specific naming conventions (DTO, Model, Entity)
 - Avoiding naming conflicts with existing code
 
+### Schema Prefix Stripping
+
+The `stripSchemaPrefix` option removes common prefixes from schema names in your OpenAPI spec before generating Zod schemas. This is particularly useful when your OpenAPI spec uses namespaced schema names (like .NET-generated specs with "Company.Models.User").
+
+**OpenAPI Spec with Namespaced Schemas:**
+```yaml
+components:
+  schemas:
+    Company.Models.User:
+      type: object
+      properties:
+        id:
+          type: string
+        name:
+          type: string
+        role:
+          $ref: '#/components/schemas/Company.Models.UserRole'
+    Company.Models.UserRole:
+      type: string
+      enum: [admin, user, guest]
+    Company.Models.Post:
+      type: object
+      properties:
+        id:
+          type: string
+        title:
+          type: string
+        author:
+          $ref: '#/components/schemas/Company.Models.User'
+```
+
+**Without `stripSchemaPrefix`:**
+```typescript
+export const companyModelsUserRoleSchema = z.enum(["admin", "user", "guest"]);
+
+export const companyModelsUserSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  role: companyModelsUserRoleSchema  // Long reference name
+});
+
+export const companyModelsPostSchema = z.object({
+  id: z.string(),
+  title: z.string(),
+  author: companyModelsUserSchema  // Long reference name
+});
+
+export type CompanyModelsUserRole = z.infer<typeof companyModelsUserRoleSchema>;
+export type CompanyModelsUser = z.infer<typeof companyModelsUserSchema>;
+export type CompanyModelsPost = z.infer<typeof companyModelsPostSchema>;
+```
+
+**With `stripSchemaPrefix: "Company.Models."`:**
+```typescript
+export const userRoleSchema = z.enum(["admin", "user", "guest"]);
+
+export const userSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  role: userRoleSchema  // Clean reference
+});
+
+export const postSchema = z.object({
+  id: z.string(),
+  title: z.string(),
+  author: userSchema  // Clean reference
+});
+
+export type UserRole = z.infer<typeof userRoleSchema>;
+export type User = z.infer<typeof userSchema>;
+export type Post = z.infer<typeof postSchema>;
+```
+
+#### Usage
+
+```typescript
+export default defineConfig({
+  specs: [{
+    input: 'openapi.yaml',
+    output: 'schemas.ts',
+    stripSchemaPrefix: 'Company.Models.'  // Strip this exact prefix
+  }]
+});
+```
+
+#### Regex Patterns
+
+Use regex patterns to strip dynamic prefixes:
+
+```typescript
+export default defineConfig({
+  specs: [{
+    input: 'openapi.yaml',
+    output: 'schemas.ts',
+    // Strip any namespace prefix ending with a dot
+    stripSchemaPrefix: '^[A-Z][a-z]+\\.'
+  }]
+});
+```
+
+**Regex Auto-Detection:**
+
+Regex patterns are auto-detected if they contain: `^`, `$`, `\\d`, `\\w`, `\\s`, `.*`, `.+`, `[]`, `()`
+
+```typescript
+// These are all treated as regex patterns:
+stripSchemaPrefix: '^Company\\.'       // Starts with ^
+stripSchemaPrefix: '[A-Z]+\\.'         // Contains []
+stripSchemaPrefix: '.*\\.Models\\.'    // Contains .*
+
+// This is a literal string:
+stripSchemaPrefix: 'Company.Models.'   // No regex markers
+```
+
+For TypeScript configs, you can also use `RegExp` objects:
+
+```typescript
+stripSchemaPrefix: /^[A-Z][a-z]+\./
+```
+
+#### Common Patterns
+
+**Pattern 1: .NET Namespaces**
+```typescript
+{
+  stripSchemaPrefix: 'Company.Models.'
+}
+// Company.Models.User → User
+// Company.Models.Post → Post
+```
+
+**Pattern 2: Multiple Namespaces**
+```typescript
+{
+  stripSchemaPrefix: '^[A-Za-z]+\\.Models\\.'
+}
+// MyApp.Models.User → User
+// OtherApp.Models.User → User
+```
+
+**Pattern 3: Version Prefixes**
+```typescript
+{
+  stripSchemaPrefix: '^v\\d+\\.'
+}
+// v1.User → User
+// v2.Product → Product
+```
+
+#### Interaction with prefix/suffix Options
+
+`stripSchemaPrefix` is applied **before** `prefix` and `suffix` options:
+
+```typescript
+export default defineConfig({
+  specs: [{
+    input: 'openapi.yaml',
+    output: 'schemas.ts',
+    stripSchemaPrefix: 'Company.Models.',  // Applied first
+    prefix: 'api',                          // Applied second
+    suffix: 'dto'                           // Applied third
+  }]
+});
+```
+
+**Result:**
+- `Company.Models.User` → `User` → `apiUserDtoSchema`
+- `Company.Models.Post` → `Post` → `apiPostDtoSchema`
+
+#### Benefits
+
+1. **Cleaner Schema Names**: Generates `userSchema` instead of `companyModelsUserSchema`
+2. **Better Type Names**: Creates `User` type instead of `CompanyModelsUser`
+3. **Shorter References**: Simpler schema references in composed types
+4. **Better Code Completion**: Easier to find schemas in IDE autocomplete
+5. **Flexible Pattern Matching**: Use regex for dynamic prefixes
+
 ## Generation Statistics
 
 Statistics are **included by default** in generated files. Use `showStats: false` to disable:

package/dist/cli.js

@@ -5137,8 +5137,20 @@ init_cjs_shims();
 
 // src/utils/name-utils.ts
 init_cjs_shims();
+function sanitizeIdentifier(str) {
+  return str.replace(/[^a-zA-Z0-9._\-\s]+/g, "_");
+}
 function toCamelCase(str, options) {
-  let name = str.charAt(0).toLowerCase() + str.slice(1);
+  const sanitized = sanitizeIdentifier(str);
+  const words = sanitized.split(/[.\-_\s]+/).filter((word) => word.length > 0);
+  let name;
+  if (words.length === 0) {
+    name = str.charAt(0).toLowerCase() + str.slice(1);
+  } else if (words.length === 1) {
+    name = words[0].charAt(0).toLowerCase() + words[0].slice(1);
+  } else {
+    name = words[0].charAt(0).toLowerCase() + words[0].slice(1) + words.slice(1).map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join("");
+  }
   if (options == null ? void 0 : options.prefix) {
     const prefix = options.prefix.toLowerCase();
     name = prefix + name.charAt(0).toUpperCase() + name.slice(1);
@@ -5151,12 +5163,23 @@ function toCamelCase(str, options) {
 }
 function toPascalCase(str) {
   const stringValue = String(str);
-  let result = stringValue.replace(/[^a-zA-Z0-9_]+/g, "_").split(/[-_]+/).filter((word) => word.length > 0).map((word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase()).join("");
+  const isAlreadyValidCase = /^[a-zA-Z][a-zA-Z0-9]*$/.test(stringValue);
+  if (isAlreadyValidCase) {
+    return stringValue.charAt(0).toUpperCase() + stringValue.slice(1);
+  }
+  const sanitized = sanitizeIdentifier(stringValue);
+  const words = sanitized.split(/[.\-_\s]+/).filter((word) => word.length > 0);
+  let result;
+  if (words.length === 0) {
+    result = "Value";
+  } else {
+    result = words.map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join("");
+  }
   if (/^\d/.test(result)) {
     result = `N${result}`;
   }
   if (!result || /^_+$/.test(result)) {
-    result = "Value";
+    return "Value";
   }
   return result;
 }
@@ -5168,9 +5191,10 @@ function resolveRef(ref) {
 // src/generators/enum-generator.ts
 function generateEnum(name, values, options) {
   const schemaName = `${toCamelCase(name, options)}Schema`;
+  const typeName = toPascalCase(name);
   const enumValues = values.map((v) => `"${v}"`).join(", ");
   const schemaCode = `export const ${schemaName} = z.enum([${enumValues}]);`;
-  const typeCode = `export type ${name} = z.infer<typeof ${schemaName}>;`;
+  const typeCode = `export type ${typeName} = z.infer<typeof ${schemaName}>;`;
   return { schemaCode, typeCode };
 }
 
@@ -5311,6 +5335,77 @@ var LRUCache = class {
   }
 };
 
+// src/utils/pattern-utils.ts
+init_cjs_shims();
+function isRegexPattern(pattern) {
+  if (pattern.startsWith("^") || pattern.endsWith("$")) {
+    return true;
+  }
+  if (/\\[dDwWsS]/.test(pattern)) {
+    return true;
+  }
+  if (/\.\*|\.\+/.test(pattern)) {
+    return true;
+  }
+  if (/[[\]()]/.test(pattern)) {
+    return true;
+  }
+  if (/[^/][+?*]\{/.test(pattern)) {
+    return true;
+  }
+  return false;
+}
+function patternToRegex(pattern) {
+  if (pattern instanceof RegExp) {
+    return pattern;
+  }
+  if (isRegexPattern(pattern)) {
+    try {
+      return new RegExp(pattern);
+    } catch (error) {
+      console.warn(`\u26A0\uFE0F  Invalid regex pattern "${pattern}": ${error instanceof Error ? error.message : String(error)}`);
+      return null;
+    }
+  }
+  return null;
+}
+function stripPrefix(input, pattern, ensureLeadingChar) {
+  if (!pattern) {
+    return input;
+  }
+  const regex = patternToRegex(pattern);
+  if (regex) {
+    const match = input.match(regex);
+    if (match && match.index === 0) {
+      const stripped = input.substring(match[0].length);
+      if (ensureLeadingChar) {
+        if (stripped === "") {
+          return ensureLeadingChar;
+        }
+        if (!stripped.startsWith(ensureLeadingChar)) {
+          return `${ensureLeadingChar}${stripped}`;
+        }
+      }
+      return stripped;
+    }
+  } else {
+    const stringPattern = pattern;
+    if (input.startsWith(stringPattern)) {
+      const stripped = input.substring(stringPattern.length);
+      if (ensureLeadingChar) {
+        if (stripped === "") {
+          return ensureLeadingChar;
+        }
+        if (!stripped.startsWith(ensureLeadingChar)) {
+          return `${ensureLeadingChar}${stripped}`;
+        }
+      }
+      return stripped;
+    }
+  }
+  return input;
+}
+
 // src/validators/array-validator.ts
 init_cjs_shims();
 function generateArrayValidation(schema, context) {
@@ -6175,8 +6270,9 @@ var _PropertyGenerator = class _PropertyGenerator {
         }
         (_a = this.context.schemaDependencies.get(currentSchema)) == null ? void 0 : _a.add(refName);
       }
-      const schemaName = `${toCamelCase(resolvedRefName, this.context.namingOptions)}Schema`;
-      if (currentSchema && this.isCircularThroughAlias(currentSchema, refName)) {
+      const strippedRefName = stripPrefix(resolvedRefName, this.context.stripSchemaPrefix);
+      const schemaName = `${toCamelCase(strippedRefName, this.context.namingOptions)}Schema`;
+      if (currentSchema && (refName === currentSchema || this.isCircularThroughAlias(currentSchema, refName))) {
         const lazySchema = `z.lazy((): z.ZodTypeAny => ${schemaName})`;
         return wrapNullable(lazySchema, nullable);
       }
@@ -6477,6 +6573,7 @@ var OpenApiGenerator = class {
       schemaType: options.schemaType || "all",
       prefix: options.prefix,
       suffix: options.suffix,
+      stripSchemaPrefix: options.stripSchemaPrefix,
       showStats: (_c = options.showStats) != null ? _c : true,
       request: options.request,
       response: options.response,
@@ -6553,7 +6650,8 @@ var OpenApiGenerator = class {
       namingOptions: {
         prefix: this.options.prefix,
         suffix: this.options.suffix
-      }
+      },
+      stripSchemaPrefix: this.options.stripSchemaPrefix
     });
   }
   /**
@@ -6587,9 +6685,11 @@ var OpenApiGenerator = class {
       const typeCode = this.types.get(name);
       if (schemaCode) {
         output.push(schemaCode);
-        if (!schemaCode.includes(`export type ${name}`)) {
-          const schemaName = `${toCamelCase(name, { prefix: this.options.prefix, suffix: this.options.suffix })}Schema`;
-          output.push(`export type ${name} = z.infer<typeof ${schemaName}>;`);
+        const strippedName = stripPrefix(name, this.options.stripSchemaPrefix);
+        const typeName = toPascalCase(strippedName);
+        if (!schemaCode.includes(`export type ${typeName}`)) {
+          const schemaName = `${toCamelCase(strippedName, { prefix: this.options.prefix, suffix: this.options.suffix })}Schema`;
+          output.push(`export type ${typeName} = z.infer<typeof ${schemaName}>;`);
         }
         output.push("");
       } else if (typeCode) {
@@ -6905,7 +7005,8 @@ var OpenApiGenerator = class {
     const resolvedOptions = context === "response" ? this.responseOptions : this.requestOptions;
     if (schema.enum) {
       const jsdoc2 = generateJSDoc(schema, name, { includeDescriptions: resolvedOptions.includeDescriptions });
-      const { schemaCode, typeCode } = generateEnum(name, schema.enum, {
+      const strippedName2 = stripPrefix(name, this.options.stripSchemaPrefix);
+      const { schemaCode, typeCode } = generateEnum(strippedName2, schema.enum, {
         prefix: this.options.prefix,
         suffix: this.options.suffix
       });
@@ -6914,7 +7015,8 @@ ${typeCode}`;
       this.schemas.set(name, enumSchemaCode);
       return;
     }
-    const schemaName = `${toCamelCase(name, { prefix: this.options.prefix, suffix: this.options.suffix })}Schema`;
+    const strippedName = stripPrefix(name, this.options.stripSchemaPrefix);
+    const schemaName = `${toCamelCase(strippedName, { prefix: this.options.prefix, suffix: this.options.suffix })}Schema`;
     const jsdoc = generateJSDoc(schema, name, { includeDescriptions: resolvedOptions.includeDescriptions });
     if (schema.allOf && schema.allOf.length === 1 && schema.allOf[0].$ref) {
       const refName = resolveRef(schema.allOf[0].$ref);
@@ -6930,7 +7032,8 @@ ${typeCode}`;
       namingOptions: {
         prefix: this.options.prefix,
         suffix: this.options.suffix
-      }
+      },
+      stripSchemaPrefix: this.options.stripSchemaPrefix
     });
     const isAlias = !!(schema.$ref && !schema.properties && !schema.allOf && !schema.oneOf && !schema.anyOf);
     const zodSchema = this.propertyGenerator.generatePropertySchema(schema, name, isAlias);
@@ -7132,7 +7235,8 @@ ${propsCode}
   generateQueryParamType(schema, param) {
     if (schema.$ref) {
       const refName = resolveRef(schema.$ref);
-      const schemaName = toCamelCase(refName, { prefix: this.options.prefix, suffix: this.options.suffix });
+      const strippedRefName = stripPrefix(refName, this.options.stripSchemaPrefix);
+      const schemaName = toCamelCase(strippedRefName, { prefix: this.options.prefix, suffix: this.options.suffix });
       return `${schemaName}Schema`;
     }
     if (schema.enum) {
@@ -7368,6 +7472,7 @@ var OpenApiGeneratorOptionsSchema = import_zod2.z.strictObject({
   schemaType: import_zod2.z.enum(["all", "request", "response"]).optional(),
   prefix: import_zod2.z.string().optional(),
   suffix: import_zod2.z.string().optional(),
+  stripSchemaPrefix: import_zod2.z.string().optional(),
   showStats: import_zod2.z.boolean().optional(),
   request: RequestResponseOptionsSchema.optional(),
   response: RequestResponseOptionsSchema.optional(),
@@ -7384,6 +7489,7 @@ var ConfigFileSchema = import_zod2.z.strictObject({
     schemaType: import_zod2.z.enum(["all", "request", "response"]).optional(),
     prefix: import_zod2.z.string().optional(),
     suffix: import_zod2.z.string().optional(),
+    stripSchemaPrefix: import_zod2.z.string().optional(),
     showStats: import_zod2.z.boolean().optional(),
     request: RequestResponseOptionsSchema.optional(),
     response: RequestResponseOptionsSchema.optional(),
@@ -7413,7 +7519,7 @@ async function loadConfig(configPath) {
   }
   if (!result || !result.config) {
     throw new Error(
-      configPath ? `Config file not found at: ${configPath}` : "No config file found. Searched for: openapi-to-zod.config.ts, openapi-to-zod.config.json, package.json (openapi-to-zod key)"
+      configPath ? `Config file not found at: ${configPath}` : "No config file found. Searched for: openapi-to-zod.config.ts, openapi-to-zod.config.json, package.json (openapi-to-zod key)\nRun 'openapi-to-zod init' to create a new config file."
     );
   }
   try {
@@ -7520,14 +7626,7 @@ function findSpecFiles() {
 }
 async function executeConfigMode(options) {
   var _a, _b;
-  let config;
-  try {
-    config = await loadConfig(options.config);
-  } catch {
-    throw new CliOptionsError("No config file found. Run 'openapi-to-zod init' to create one.", {
-      configPath: options.config
-    });
-  }
+  const config = await loadConfig(options.config);
   const specs = mergeConfigWithDefaults(config);
   const executionMode = config.executionMode || "parallel";
   const batchSize = (_b = (_a = specs[0]) == null ? void 0 : _a.batchSize) != null ? _b : 10;