feat: improve identifier sanitization across generators

Author: owinter86

src/generator/clientGenerator.ts

@@ -11,8 +11,18 @@ export interface OperationInfo {
   responses: OpenAPIV3.ResponsesObject;
 }
 
+function sanitizeOperationId(operationId: string): string {
+  return operationId.replace(/[^a-zA-Z0-9_]/g, '_');
+}
+
+function sanitizePropertyName(name: string): string {
+  return /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(name) ? name : `'${name}'`;
+}
+
 function generateAxiosMethod(operation: OperationInfo, spec: OpenAPIV3.Document): string {
-  const { method, path, operationId, summary, description, parameters, requestBody, responses } = operation;
+  const { method, path, operationId: rawOperationId, summary, description, parameters, requestBody, responses } = operation;
+  const operationId = rawOperationId || `${method.toLowerCase()}${path.replace(/\W+/g, '_')}`;
+  const sanitizedOperationId = sanitizeOperationId(operationId);
 
   // Generate JSDoc
   const jsDocLines = ['/**'];
@@ -36,7 +46,7 @@ function generateAxiosMethod(operation: OperationInfo, spec: OpenAPIV3.Document)
     const responseObj = response as OpenAPIV3.ResponseObject;
     const desc = 'description' in responseObj ? responseObj.description : '';
     const contentType = responseObj.content?.['application/json']?.schema;
-    const typeName = `${operationId}Response${code}`;
+    const typeName = `${sanitizedOperationId}Response${code}`;
 
     if (contentType) {
       if (desc) {
@@ -68,23 +78,25 @@ function generateAxiosMethod(operation: OperationInfo, spec: OpenAPIV3.Document)
 
   // Add path and query parameters
   urlParams.forEach(p => {
-    dataProps.push(`${p.name}: ${getTypeFromParam(p)}`);
+    const safeName = sanitizePropertyName(p.name);
+    dataProps.push(`${safeName}: ${getTypeFromParam(p)}`);
   });
   queryParams.forEach(p => {
-    dataProps.push(`${p.name}${p.required ? '' : '?'}: ${getTypeFromParam(p)}`);
+    const safeName = sanitizePropertyName(p.name);
+    dataProps.push(`${safeName}${p.required ? '' : '?'}: ${getTypeFromParam(p)}`);
   });
 
   // Add request body type if it exists
   const hasData = (parameters && parameters.length > 0) || operation.requestBody;
   const dataType = hasData 
     ? requestBody 
-      ? `${operationId}Request & { ${dataProps.join('; ')} }`
+      ? `${sanitizedOperationId}Request & { ${dataProps.join('; ')} }`
       : `{ ${dataProps.join('; ')} }`
     : 'undefined';
 
   // Get response type from 2xx response
   const successResponse = Object.entries(responses).find(([code]) => code.startsWith('2'));
-  const responseType = successResponse ? `${operationId}Response${successResponse[0]}` : 'any';
+  const responseType = successResponse ? `${sanitizedOperationId}Response${successResponse[0]}` : 'any';
 
   const urlWithParams = urlParams.length > 0 
     ? path.replace(/{(\w+)}/g, '${data.$1}')
@@ -116,7 +128,7 @@ function generateAxiosMethod(operation: OperationInfo, spec: OpenAPIV3.Document)
 
   return `
   ${jsDocLines.join('\n  ')}
-  async ${operationId}(data${hasData ? `: ${dataType}` : '?: undefined'}, headers?: Record<string, string>): Promise<AxiosResponse<${responseType}>> {
+  async ${sanitizedOperationId}(data${hasData ? `: ${dataType}` : '?: undefined'}, headers?: Record<string, string>): Promise<AxiosResponse<${responseType}>> {
     ${methodBody}
   }`;
 }
@@ -150,7 +162,7 @@ export function generateApiClient(spec: OpenAPIV3.Document): string {
       operations.push({
         method: method.toUpperCase(),
         path,
-        operationId: operation.operationId || `${method}${path.replace(/\W+/g, '_')}`,
+        operationId: sanitizeOperationId(operation.operationId || `${method}${path.replace(/\W+/g, '_')}`),
         summary: operation.summary,
         description: operation.description,
         parameters: [...(pathItem.parameters || []), ...(operation.parameters || [])] as OpenAPIV3.ParameterObject[],
@@ -174,11 +186,13 @@ export function generateApiClient(spec: OpenAPIV3.Document): string {
     }
   });
 
+  const title = spec.info.title.toLowerCase().replace(/\s+/g, '-');
+
   // Generate the client class
   return `import axios, { AxiosInstance, AxiosResponse } from 'axios';
 import { 
   ${Array.from(usedTypes).join(',\n  ')}
-} from './types';
+} from './${title}.schema';
 
 export class ApiClient {
   private axios: AxiosInstance;

src/generator/reactQueryGenerator.ts

@@ -1,8 +1,17 @@
 import { OpenAPIV3 } from 'openapi-types';
 import { OperationInfo } from './clientGenerator';
 
+function sanitizeOperationId(operationId: string): string {
+  return operationId.replace(/[^a-zA-Z0-9_]/g, '_');
+}
+
+function sanitizePropertyName(name: string): string {
+  return /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(name) ? name : `'${name}'`;
+}
+
 function generateQueryOptions(operation: OperationInfo, spec: OpenAPIV3.Document): string {
-  const { operationId, parameters, requestBody } = operation;
+  const { operationId: rawOperationId, parameters, requestBody } = operation;
+  const operationId = sanitizeOperationId(rawOperationId);
 
   const hasData = (parameters && parameters.length > 0) || operation.requestBody;
 
@@ -60,7 +69,7 @@ export function generateReactQuery(spec: OpenAPIV3.Document): string {
       operations.push({
         method: method.toUpperCase(),
         path,
-        operationId: operation.operationId || `${method}${path.replace(/\W+/g, '_')}`,
+        operationId: sanitizeOperationId(operation.operationId || `${method}${path.replace(/\W+/g, '_')}`),
         summary: operation.summary,
         description: operation.description,
         parameters: [...(pathItem.parameters || []), ...(operation.parameters || [])] as OpenAPIV3.ParameterObject[],
@@ -70,8 +79,10 @@ export function generateReactQuery(spec: OpenAPIV3.Document): string {
     });
   });
 
+  const title = spec.info.title.toLowerCase().replace(/\s+/g, '-');
+
   return `import { queryOptions, skipToken } from '@tanstack/react-query';
-import type { ApiClient } from './client';
+import type { ApiClient } from './${title}.client';
 
 const hasDefinedProps = <T extends { [P in K]?: any }, K extends PropertyKey>(
   obj: T,

src/generator/schemaGenerator.ts

@@ -8,12 +8,17 @@ interface SchemaContext {
 /**
  * Converts OpenAPI schema type to TypeScript type
  */
+function sanitizePropertyName(name: string): string {
+  // If property name has special characters, wrap it in quotes
+  return /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(name) ? name : `'${name}'`;
+}
+
 function getTypeFromSchema(schema: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject, context: SchemaContext): string {
   if (!schema) return 'any';
 
   if ('$ref' in schema) {
     const refType = schema.$ref.split('/').pop()!;
-    return refType;
+    return sanitizeString(refType);
   }
 
   // Handle enum types properly
@@ -38,7 +43,8 @@ function getTypeFromSchema(schema: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceO
           .map(([key, prop]) => {
             const isRequired = schema.required?.includes(key);
             const propertyType = getTypeFromSchema(prop as OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject, context);
-            return `  ${key}${isRequired ? '' : '?'}: ${propertyType};`;
+            const safeName = sanitizePropertyName(key);
+            return `  ${safeName}${isRequired ? '' : '?'}: ${propertyType};`;
           })
           .join('\n');
         return `{\n${properties}\n}`;
@@ -55,11 +61,13 @@ function getTypeFromSchema(schema: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceO
   }
 }
 
-function generateTypeDefinition(name: string, schema: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject, context: SchemaContext): string {
+function generateTypeDefinition(badName: string, schema: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject, context: SchemaContext): string {
   const description = !('$ref' in schema) && schema.description 
     ? `/**\n * ${schema.description}\n */\n`
     : '';
 
+  const name = sanitizeString(badName)
+
   const typeValue = getTypeFromSchema(schema, context);
 
   // Use 'type' for primitives, unions, and simple types
@@ -71,6 +79,10 @@ function generateTypeDefinition(name: string, schema: OpenAPIV3.SchemaObject | O
     : `${description}export type ${name} = ${typeValue}\n\n`;
 }
 
+function sanitizeString(operationId: string): string {
+  return operationId.replace(/[^a-zA-Z0-9_]/g, '_');
+}
+
 /**
  * Generates TypeScript interface definitions from OpenAPI schemas
  */
@@ -103,7 +115,7 @@ export function generateTypeDefinitions(spec: OpenAPIV3.Document): string {
           const content = (operationObject.requestBody as OpenAPIV3.RequestBodyObject).content;
           const jsonContent = content['application/json'] || content['multipart/form-data']
           if (jsonContent?.schema) {
-            const typeName = `${operationObject.operationId}Request`;
+            const typeName = sanitizeString(`${operationObject.operationId}Request`);
             output += generateTypeDefinition(typeName, jsonContent.schema as OpenAPIV3.SchemaObject, context);
           }
         }
@@ -114,7 +126,7 @@ export function generateTypeDefinitions(spec: OpenAPIV3.Document): string {
             const responseObj = response as OpenAPIV3.ResponseObject;
             const content = responseObj.content?.['application/json'];
             if (content?.schema) {
-              const typeName = `${operationObject.operationId}Response${code}`;
+              const typeName = sanitizeString(`${operationObject.operationId || `${method.toLowerCase()}${path.replace(/\W+/g, '_')}`}Response${code}`);
               output += generateTypeDefinition(typeName, content.schema as OpenAPIV3.SchemaObject, context);
             }
           }