supporting x-protobuf-name vendor extension

Author: luckyxilu66

tools/proto-convert/src/VendorExtensionProcessor.ts

@@ -10,6 +10,7 @@ import Logger from './utils/logger';
 export class VendorExtensionProcessor {
     private static readonly PROTOBUF_EXCLUDED_EXTENSION = 'x-protobuf-excluded';
     private static readonly PROTOBUF_TYPE_EXTENSION = 'x-protobuf-type';
+    private static readonly PROTOBUF_NAME_EXTENSION = 'x-protobuf-name';
 
     private static readonly PROTOBUF_TYPE_MAPPING: Record<string, { type: string; format?: string }> = {
         'int32': { type: 'integer', format: 'int32' },
@@ -36,17 +37,23 @@ export class VendorExtensionProcessor {
 
         this.removeProtobufExcludedFromPaths();
         traverse(this.root, {
+            onParameter: (param: any, name: string) => {
+                this.applyNameOverrideToParameter(param);
+            },
             onSchema: (schema: any, name: string) => {
                 this.removeProtobufExcludedProperties(schema);
                 this.applyTypeOverride(schema);
+                this.applyNameOverride(schema);
             },
             onResponseSchema: (schema: any, name: string) => {
                 this.removeProtobufExcludedProperties(schema);
                 this.applyTypeOverride(schema);
+                this.applyNameOverride(schema);
             },
             onRequestSchema: (schema: any, name: string) => {
                 this.removeProtobufExcludedProperties(schema);
                 this.applyTypeOverride(schema);
+                this.applyNameOverride(schema);
             },
             onSchemaProperty: (schema: any, name: string) => {
                 this.applyTypeOverride(schema);
@@ -127,6 +134,67 @@ export class VendorExtensionProcessor {
         }
     }
 
+    /**
+     * Apply name override to a parameter if it has x-protobuf-name
+     */
+    private applyNameOverrideToParameter(param: OpenAPIV3.ParameterObject): void {
+        if (!param || typeof param !== 'object' || !(VendorExtensionProcessor.PROTOBUF_NAME_EXTENSION in param)) return;
+
+        const newName = param[VendorExtensionProcessor.PROTOBUF_NAME_EXTENSION];
+        if (typeof newName === 'string' && param.name && newName !== param.name) {
+            const oldName = param.name;
+            param.name = newName;
+            delete param[VendorExtensionProcessor.PROTOBUF_NAME_EXTENSION];
+            this.logger.info(`Renamed parameter '${oldName}' -> '${newName}' (${VendorExtensionProcessor.PROTOBUF_NAME_EXTENSION})`);
+        }
+    }
+
+
+    /**
+     * Apply name override to schema properties and composed schemas (oneOf, anyOf, allOf)
+     * - For properties: renames property keys
+     * - For composed schemas: sets title field for sub-schemas
+     */
+    private applyNameOverride(schema: any): void {
+        if (!schema || typeof schema !== 'object') return;
+
+        // Rename properties within schema.properties collection
+        if (schema?.properties) {
+            for (const prop in schema.properties) {
+                const propSchema = schema.properties[prop];
+                if (propSchema && typeof propSchema === 'object' && VendorExtensionProcessor.PROTOBUF_NAME_EXTENSION in propSchema) {
+                    const newName = propSchema[VendorExtensionProcessor.PROTOBUF_NAME_EXTENSION];
+                    if (typeof newName === 'string' && newName !== prop) {
+                        schema.properties[newName] = schema.properties[prop];
+                        delete schema.properties[prop];
+                        delete schema.properties[newName][VendorExtensionProcessor.PROTOBUF_NAME_EXTENSION];
+
+                        this.logger.info(`Renamed property '${prop}' -> '${newName}' (${VendorExtensionProcessor.PROTOBUF_NAME_EXTENSION})`);
+                    }
+                }
+            }
+        }
+
+        // Set title for composed schemas (oneOf, anyOf, allOf)
+        const composedKeys = ['allOf', 'anyOf', 'oneOf'] as const;
+        for (const key of composedKeys) {
+            const subschemas = schema[key];
+            if (!Array.isArray(subschemas)) continue;
+
+            for (const subschema of subschemas) {
+                if (subschema && typeof subschema === 'object' && VendorExtensionProcessor.PROTOBUF_NAME_EXTENSION in subschema) {
+                    const titleValue = subschema[VendorExtensionProcessor.PROTOBUF_NAME_EXTENSION];
+                    if (typeof titleValue === 'string') {
+                        const oldTitle = subschema.title;
+                        subschema.title = titleValue;
+                        delete subschema[VendorExtensionProcessor.PROTOBUF_NAME_EXTENSION];
+                        this.logger.info(`Set title for ${key} sub-schema: '${oldTitle}' -> '${titleValue}' (${VendorExtensionProcessor.PROTOBUF_NAME_EXTENSION})`);
+                    }
+                }
+            }
+        }
+    }
+
     /**
      * Apply type override to a schema if it has x-protobuf-type
      */
@@ -170,4 +238,5 @@ export class VendorExtensionProcessor {
             this.logger.info(`Applied ${VendorExtensionProcessor.PROTOBUF_TYPE_EXTENSION}: ${protoType} -> type: ${schema.type}${schema.format ? `, format: ${schema.format}` : ''}`);
         }
     }
+
 }