apply prefix name to all 'components' types for consistency

Author: fmigneault

.github/redocly/schema-name-prefix.plugin.js

@@ -1,19 +1,20 @@
 /**
- * Redocly plugin to preserve schema name prefixes based on directory structure.
+ * Redocly plugin to preserve component name prefixes based on directory structure.
  * Workaround for: https://github.com/Redocly/redocly-cli/issues/661
  *
- * When bundling, Redocly auto-renames conflicting schemas (e.g., link.yaml -> link-2).
- * This plugin modifies the bundled output to use directory-based prefixes for schema names.
+ * When bundling, Redocly auto-renames conflicting components (e.g., link.yaml -> link-2).
+ * This plugin modifies the bundled output to use directory-based prefixes for ALL component types
+ * (schemas, responses, parameters, examples, requestBodies, headers, securitySchemes, links, callbacks).
  */
 
-// Store mapping of schema objects to their source information
-const schemaSourceMap = new WeakMap();
+// Store mapping of component objects to their source information
+const componentSourceMap = new WeakMap();
 
-const PreserveSchemaNamePrefixes = () => {
+const PreserveComponentNamePrefixes = () => {
   return {
     any: {
       enter(node, ctx) {
-        // Track all nodes from schema files
+        // Track all nodes from component files
         if (!node || typeof node !== 'object') {
           return;
         }
@@ -30,14 +31,19 @@ const PreserveSchemaNamePrefixes = () => {
           return;
         }
 
-        // Extract: .../schemas/{directory}/{filename}.yaml
-        const match = filePath.match(/\/schemas\/([^\/]+)\/([^\/]+)\.yaml$/);
+        // Extract directory and filename from various component paths:
+        // - schemas/{directory}/{filename}.yaml
+        // - responses/{directory}/{filename}.yaml
+        // - parameters/{directory}/{filename}.yaml
+        // etc.
+        const match = filePath.match(/\/(schemas|responses|parameters|examples|requestBodies|headers|securitySchemes|links|callbacks)\/([^\/]+)\/([^\/]+)\.yaml$/);
         if (match) {
-          const [, directory, filename] = match;
+          const [, componentType, directory, filename] = match;
 
-          if (directory && directory !== 'schemas') {
+          if (directory && directory !== componentType) {
             // Store the source info for this node
-            schemaSourceMap.set(node, {
+            componentSourceMap.set(node, {
+              componentType,
               directory,
               filename,
               prefixedName: `${directory}-${filename}`
@@ -48,32 +54,57 @@ const PreserveSchemaNamePrefixes = () => {
     },
     Root: {
       leave(root) {
-        // Post-process: rename component schemas after bundling
-        if (!root.components || !root.components.schemas) {
+        // Post-process: rename all component types after bundling
+        if (!root.components) {
           return;
         }
 
-        const schemas = root.components.schemas;
+        // List of all possible component types in OpenAPI 3.x
+        const componentTypes = [
+          'schemas',
+          'responses',
+          'parameters',
+          'examples',
+          'requestBodies',
+          'headers',
+          'securitySchemes',
+          'links',
+          'callbacks'
+        ];
+
         const renameMap = new Map();
 
-        // Identify schemas that should be renamed
-        for (const [schemaName, schemaContent] of Object.entries(schemas)) {
-          const sourceInfo = schemaSourceMap.get(schemaContent);
+        // Process each component type
+        for (const componentType of componentTypes) {
+          const components = root.components[componentType];
+          if (!components) {
+            continue;
+          }
 
-          if (sourceInfo && sourceInfo.prefixedName) {
-            // Only rename if the name differs
-            if (schemaName !== sourceInfo.prefixedName) {
-              renameMap.set(schemaName, sourceInfo.prefixedName);
+          // Identify components that should be renamed
+          for (const [componentName, componentContent] of Object.entries(components)) {
+            const sourceInfo = componentSourceMap.get(componentContent);
+
+            if (sourceInfo && sourceInfo.prefixedName) {
+              // Only rename if the name differs
+              if (componentName !== sourceInfo.prefixedName) {
+                const key = `${componentType}/${componentName}`;
+                renameMap.set(key, {
+                  componentType,
+                  oldName: componentName,
+                  newName: sourceInfo.prefixedName
+                });
+              }
             }
           }
         }
 
         // Apply renames
-        for (const [oldName, newName] of renameMap.entries()) {
-          // Move the schema to new name
-          if (schemas[oldName]) {
-            schemas[newName] = schemas[oldName];
-            delete schemas[oldName];
+        for (const [key, { componentType, oldName, newName }] of renameMap.entries()) {
+          const components = root.components[componentType];
+          if (components && components[oldName]) {
+            components[newName] = components[oldName];
+            delete components[oldName];
           }
         }
 
@@ -84,9 +115,9 @@ const PreserveSchemaNamePrefixes = () => {
           }
 
           if (obj.$ref && typeof obj.$ref === 'string') {
-            for (const [oldName, newName] of renameMap.entries()) {
-              const oldRef = `#/components/schemas/${oldName}`;
-              const newRef = `#/components/schemas/${newName}`;
+            for (const [key, { componentType, oldName, newName }] of renameMap.entries()) {
+              const oldRef = `#/components/${componentType}/${oldName}`;
+              const newRef = `#/components/${componentType}/${newName}`;
               if (obj.$ref === oldRef) {
                 obj.$ref = newRef;
               }
@@ -111,9 +142,11 @@ module.exports = {
   id: 'schema-prefix',
   decorators: {
     oas3: {
-      'preserve-schema-name-prefixes': PreserveSchemaNamePrefixes,
+      'preserve-schema-name-prefixes': PreserveComponentNamePrefixes,
     }
   }
 };
 
 
+
+