@redocly/openapi-core 1.25.9 → 1.25.11

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @redocly/openapi-core
 
+## 1.25.11
+
+### Patch Changes
+
+- Fixed an issue with the `remove-x-internal` decorator where bundling API descirptions containing discriminators could fail when using **Node.js** v17 or earlier.
+- Fixed API descriptions bundling. Previously, schemas containing nulls in examples were causing failures.
+
+## 1.25.10
+
+### Patch Changes
+
+- Fixed `component-name-unique` problems to include correct location.
+- Fixed the `remove-x-internal` decorator, which was not removing the reference in the corresponding discriminator mapping while removing the original `$ref`.
+- Updated @redocly/config to v0.16.0.
+
 ## 1.25.9
 
 ### Patch Changes

package/lib/bundle.js

@@ -267,7 +267,7 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
         },
         Example: {
             leave(node, ctx) {
-                if (node.externalValue && node.value === undefined) {
+                if ((0, ref_utils_1.isExternalValue)(node) && node.value === undefined) {
                     const resolved = ctx.resolve({ $ref: node.externalValue });
                     if (!resolved.location || resolved.node === undefined) {
                         (0, no_unresolved_refs_1.reportUnresolvedRef)(resolved, ctx.report, ctx.location);

package/lib/decorators/common/remove-x-internal.js

@@ -4,22 +4,29 @@ exports.RemoveXInternal = void 0;
 const utils_1 = require("../../utils");
 const ref_utils_1 = require("../../ref-utils");
 const DEFAULT_INTERNAL_PROPERTY_NAME = 'x-internal';
-const RemoveXInternal = ({ internalFlagProperty }) => {
-    const hiddenTag = internalFlagProperty || DEFAULT_INTERNAL_PROPERTY_NAME;
-    function removeInternal(node, ctx) {
+const RemoveXInternal = ({ internalFlagProperty = DEFAULT_INTERNAL_PROPERTY_NAME, }) => {
+    function removeInternal(node, ctx, originalMapping) {
         const { parent, key } = ctx;
         let didDelete = false;
         if (Array.isArray(node)) {
             for (let i = 0; i < node.length; i++) {
                 if ((0, ref_utils_1.isRef)(node[i])) {
                     const resolved = ctx.resolve(node[i]);
-                    if (resolved.node?.[hiddenTag]) {
+                    if (resolved.node?.[internalFlagProperty]) {
+                        // First, remove the reference in the discriminator mapping, if it exists:
+                        if ((0, utils_1.isPlainObject)(parent.discriminator?.mapping)) {
+                            for (const mapping in parent.discriminator.mapping) {
+                                if (originalMapping?.[mapping] === node[i].$ref) {
+                                    delete parent.discriminator.mapping[mapping];
+                                }
+                            }
+                        }
                         node.splice(i, 1);
                         didDelete = true;
                         i--;
                     }
                 }
-                if (node[i]?.[hiddenTag]) {
+                if (node[i]?.[internalFlagProperty]) {
                     node.splice(i, 1);
                     didDelete = true;
                     i--;
@@ -28,15 +35,14 @@ const RemoveXInternal = ({ internalFlagProperty }) => {
         }
         else if ((0, utils_1.isPlainObject)(node)) {
             for (const key of Object.keys(node)) {
-                node = node;
                 if ((0, ref_utils_1.isRef)(node[key])) {
                     const resolved = ctx.resolve(node[key]);
-                    if (resolved.node?.[hiddenTag]) {
+                    if ((0, utils_1.isPlainObject)(resolved.node) && resolved.node?.[internalFlagProperty]) {
                         delete node[key];
                         didDelete = true;
                     }
                 }
-                if (node[key]?.[hiddenTag]) {
+                if ((0, utils_1.isPlainObject)(node[key]) && node[key]?.[internalFlagProperty]) {
                     delete node[key];
                     didDelete = true;
                 }
@@ -46,10 +52,16 @@ const RemoveXInternal = ({ internalFlagProperty }) => {
             delete parent[key];
         }
     }
+    let originalMapping = {};
     return {
+        DiscriminatorMapping: {
+            enter: (mapping) => {
+                originalMapping = JSON.parse(JSON.stringify(mapping));
+            },
+        },
         any: {
             enter: (node, ctx) => {
-                removeInternal(node, ctx);
+                removeInternal(node, ctx, originalMapping);
             },
         },
     };

package/lib/rules/oas3/component-name-unique.js

@@ -34,27 +34,31 @@ const ComponentNameUnique = (options) => {
                     const resolvedRef = resolve(ref);
                     if (!resolvedRef.location)
                         return;
-                    addComponentFromAbsoluteLocation(typeName, resolvedRef.location.absolutePointer.toString());
+                    addComponentFromAbsoluteLocation(typeName, resolvedRef.location);
                 }
             },
         },
         Root: {
             leave(root, ctx) {
                 components.forEach((value, key, _) => {
-                    if (value.size > 1) {
+                    if (value.absolutePointers.size > 1) {
                         const component = getComponentFromKey(key);
                         const optionComponentName = getOptionComponentNameForTypeName(component.typeName);
-                        const definitions = Array.from(value)
-                            .map((v) => `- ${v}`)
-                            .join('\n');
-                        const problem = {
-                            message: `Component '${optionComponentName}/${component.componentName}' is not unique. It is defined at:\n${definitions}`,
-                        };
                         const componentSeverity = optionComponentName ? options[optionComponentName] : null;
-                        if (componentSeverity) {
-                            problem.forceSeverity = componentSeverity;
+                        for (const location of value.locations) {
+                            const definitions = Array.from(value.absolutePointers)
+                                .filter((v) => v !== location.absolutePointer.toString())
+                                .map((v) => `- ${v}`)
+                                .join('\n');
+                            const problem = {
+                                message: `Component '${optionComponentName}/${component.componentName}' is not unique. It is also defined at:\n${definitions}`,
+                                location: location,
+                            };
+                            if (componentSeverity) {
+                                problem.forceSeverity = componentSeverity;
+                            }
+                            ctx.report(problem);
                         }
-                        ctx.report(problem);
                     }
                 });
             },
@@ -63,28 +67,28 @@ const ComponentNameUnique = (options) => {
     if (options.schemas != 'off') {
         rule.NamedSchemas = {
             Schema(_, { location }) {
-                addComponentFromAbsoluteLocation(TYPE_NAME_SCHEMA, location.absolutePointer.toString());
+                addComponentFromAbsoluteLocation(TYPE_NAME_SCHEMA, location);
             },
         };
     }
     if (options.responses != 'off') {
         rule.NamedResponses = {
             Response(_, { location }) {
-                addComponentFromAbsoluteLocation(TYPE_NAME_RESPONSE, location.absolutePointer.toString());
+                addComponentFromAbsoluteLocation(TYPE_NAME_RESPONSE, location);
             },
         };
     }
     if (options.parameters != 'off') {
         rule.NamedParameters = {
             Parameter(_, { location }) {
-                addComponentFromAbsoluteLocation(TYPE_NAME_PARAMETER, location.absolutePointer.toString());
+                addComponentFromAbsoluteLocation(TYPE_NAME_PARAMETER, location);
             },
         };
     }
     if (options.requestBodies != 'off') {
         rule.NamedRequestBodies = {
             RequestBody(_, { location }) {
-                addComponentFromAbsoluteLocation(TYPE_NAME_REQUEST_BODY, location.absolutePointer.toString());
+                addComponentFromAbsoluteLocation(TYPE_NAME_REQUEST_BODY, location);
             },
         };
     }
@@ -98,15 +102,22 @@ const ComponentNameUnique = (options) => {
         }
         return componentName;
     }
-    function addFoundComponent(typeName, componentName, absoluteLocation) {
+    function addFoundComponent(typeName, componentName, location) {
         const key = getKeyForComponent(typeName, componentName);
-        const locations = components.get(key) ?? new Set();
-        locations.add(absoluteLocation);
-        components.set(key, locations);
+        const entry = components.get(key) ?? {
+            absolutePointers: new Set(),
+            locations: [],
+        };
+        const absoluteLocation = location.absolutePointer.toString();
+        if (!entry.absolutePointers.has(absoluteLocation)) {
+            entry.absolutePointers.add(absoluteLocation);
+            entry.locations.push(location);
+        }
+        components.set(key, entry);
     }
-    function addComponentFromAbsoluteLocation(typeName, absoluteLocation) {
-        const componentName = getComponentNameFromAbsoluteLocation(absoluteLocation);
-        addFoundComponent(typeName, componentName, absoluteLocation);
+    function addComponentFromAbsoluteLocation(typeName, location) {
+        const componentName = getComponentNameFromAbsoluteLocation(location.absolutePointer.toString());
+        addFoundComponent(typeName, componentName, location);
     }
 };
 exports.ComponentNameUnique = ComponentNameUnique;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.25.9",
+  "version": "1.25.11",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -36,7 +36,7 @@
   ],
   "dependencies": {
     "@redocly/ajv": "^8.11.2",
-    "@redocly/config": "^0.15.0",
+    "@redocly/config": "^0.16.0",
     "colorette": "^1.2.0",
     "https-proxy-agent": "^7.0.4",
     "js-levenshtein": "^1.1.6",

package/src/__tests__/bundle.test.ts

@@ -265,6 +265,57 @@ describe('bundle', () => {
     expect(problems).toHaveLength(0);
     expect(res.parsed).toMatchSnapshot();
   });
+
+  it('should not fail when bundling openapi with nulls', async () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+        openapi: 3.1.0
+        paths: 
+          /:
+            get: 
+              responses: 
+                200:
+                  content: 
+                    application/json: 
+                      schema: 
+                        type: object
+                        properties: 
+                      examples: 
+                        Foo:           
+      `,
+      ''
+    );
+
+    const config = await makeConfig({ rules: {} });
+
+    const {
+      bundle: { parsed },
+      problems,
+    } = await bundleDocument({
+      document: testDocument,
+      config: config,
+      externalRefResolver: new BaseResolver(),
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(parsed).toMatchInlineSnapshot(`
+      openapi: 3.1.0
+      paths:
+        /:
+          get:
+            responses:
+              '200':
+                content:
+                  application/json:
+                    schema:
+                      type: object
+                      properties: null
+                    examples:
+                      Foo: null
+      components: {}
+
+    `);
+  });
 });
 
 describe('bundleFromString', () => {

package/src/bundle.ts

@@ -9,7 +9,7 @@ import {
   SpecMajorVersion,
   SpecVersion,
 } from './oas-types';
-import { isAbsoluteUrl, isRef, refBaseName } from './ref-utils';
+import { isAbsoluteUrl, isExternalValue, isRef, refBaseName } from './ref-utils';
 import { initRules } from './config/rules';
 import { reportUnresolvedRef } from './rules/no-unresolved-refs';
 import { dequal, isPlainObject, isTruthy } from './utils';
@@ -380,7 +380,7 @@ function makeBundleVisitor(
     },
     Example: {
       leave(node: any, ctx: UserContext) {
-        if (node.externalValue && node.value === undefined) {
+        if (isExternalValue(node) && node.value === undefined) {
           const resolved = ctx.resolve({ $ref: node.externalValue });
 
           if (!resolved.location || resolved.node === undefined) {
@@ -446,7 +446,7 @@ function makeBundleVisitor(
 
   function saveComponent(
     componentType: string,
-    target: { node: any; location: Location },
+    target: { node: unknown; location: Location },
     ctx: UserContext
   ) {
     components[componentType] = components[componentType] || {};
@@ -464,8 +464,8 @@ function makeBundleVisitor(
   }
 
   function isEqualOrEqualRef(
-    node: any,
-    target: { node: any; location: Location },
+    node: unknown,
+    target: { node: unknown; location: Location },
     ctx: UserContext
   ) {
     if (
@@ -480,7 +480,7 @@ function makeBundleVisitor(
   }
 
   function getComponentName(
-    target: { node: any; location: Location },
+    target: { node: unknown; location: Location },
     componentType: string,
     ctx: UserContext
   ) {

package/src/decorators/__tests__/remove-x-internal.test.ts

@@ -271,6 +271,103 @@ describe('oas3 remove-x-internal', () => {
 
     `);
   });
+
+  it('should remove $refs and the corresponding discriminator mapping', async () => {
+    const testDoc = parseYamlToDocument(
+      outdent`
+        openapi: 3.1.0
+        info: {}
+        paths:
+          /test:
+            post:
+              requestBody:
+                content:
+                  application/json:
+                    schema:
+                      $ref: '#/components/schemas/christmas-tree'
+        components:
+          schemas:
+            christmas-tree:
+              type: array
+              items:
+                discriminator:
+                  propertyName: type
+                  mapping:
+                    candy-cane: '#/components/schemas/candy-cane'
+                    popcorn: '#/components/schemas/popcorn'
+                    cranberry: '#/components/schemas/cranberry'
+                anyOf:
+                  - $ref: '#/components/schemas/candy-cane'
+                  - $ref: '#/components/schemas/popcorn'
+                  - $ref: '#/components/schemas/cranberry'
+            candy-cane:
+              x-internal: true
+              title: candy-cane
+              type: object
+              properties:
+                type:
+                  type: string
+                  enum: [candy-cane]
+            popcorn:
+              type: object
+              properties:
+                type:
+                  type: string
+                  enum: [popcorn]
+            cranberry:
+              type: object
+              properties:
+                type:
+                  type: string
+                  enum: [cranberry]
+      `
+    );
+    const { bundle: res } = await bundleDocument({
+      document: testDoc,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig({ rules: {}, decorators: { 'remove-x-internal': 'on' } }),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      openapi: 3.1.0
+      info: {}
+      paths:
+        /test:
+          post:
+            requestBody:
+              content:
+                application/json:
+                  schema:
+                    $ref: '#/components/schemas/christmas-tree'
+      components:
+        schemas:
+          christmas-tree:
+            type: array
+            items:
+              discriminator:
+                propertyName: type
+                mapping:
+                  popcorn: '#/components/schemas/popcorn'
+                  cranberry: '#/components/schemas/cranberry'
+              anyOf:
+                - $ref: '#/components/schemas/popcorn'
+                - $ref: '#/components/schemas/cranberry'
+          popcorn:
+            type: object
+            properties:
+              type:
+                type: string
+                enum:
+                  - popcorn
+          cranberry:
+            type: object
+            properties:
+              type:
+                type: string
+                enum:
+                  - cranberry
+
+    `);
+  });
 });
 
 describe('oas2 remove-x-internal', () => {

package/src/decorators/common/remove-x-internal.ts

@@ -6,23 +6,35 @@ import type { UserContext } from '../../walk';
 
 const DEFAULT_INTERNAL_PROPERTY_NAME = 'x-internal';
 
-export const RemoveXInternal: Oas3Decorator | Oas2Decorator = ({ internalFlagProperty }) => {
-  const hiddenTag: string = internalFlagProperty || DEFAULT_INTERNAL_PROPERTY_NAME;
-
-  function removeInternal(node: any, ctx: UserContext) {
+export const RemoveXInternal: Oas3Decorator | Oas2Decorator = ({
+  internalFlagProperty = DEFAULT_INTERNAL_PROPERTY_NAME,
+}) => {
+  function removeInternal(
+    node: unknown,
+    ctx: UserContext,
+    originalMapping: Record<string, string>
+  ) {
     const { parent, key } = ctx;
     let didDelete = false;
     if (Array.isArray(node)) {
       for (let i = 0; i < node.length; i++) {
         if (isRef(node[i])) {
           const resolved = ctx.resolve(node[i]);
-          if (resolved.node?.[hiddenTag]) {
+          if (resolved.node?.[internalFlagProperty]) {
+            // First, remove the reference in the discriminator mapping, if it exists:
+            if (isPlainObject(parent.discriminator?.mapping)) {
+              for (const mapping in parent.discriminator.mapping) {
+                if (originalMapping?.[mapping] === node[i].$ref) {
+                  delete parent.discriminator.mapping[mapping];
+                }
+              }
+            }
             node.splice(i, 1);
             didDelete = true;
             i--;
           }
         }
-        if (node[i]?.[hiddenTag]) {
+        if (node[i]?.[internalFlagProperty]) {
           node.splice(i, 1);
           didDelete = true;
           i--;
@@ -30,15 +42,14 @@ export const RemoveXInternal: Oas3Decorator | Oas2Decorator = ({ internalFlagPro
       }
     } else if (isPlainObject(node)) {
       for (const key of Object.keys(node)) {
-        node = node as any;
         if (isRef(node[key])) {
-          const resolved = ctx.resolve<any>(node[key]);
-          if (resolved.node?.[hiddenTag]) {
+          const resolved = ctx.resolve(node[key]);
+          if (isPlainObject(resolved.node) && resolved.node?.[internalFlagProperty]) {
             delete node[key];
             didDelete = true;
           }
         }
-        if (node[key]?.[hiddenTag]) {
+        if (isPlainObject(node[key]) && node[key]?.[internalFlagProperty]) {
           delete node[key];
           didDelete = true;
         }
@@ -50,10 +61,16 @@ export const RemoveXInternal: Oas3Decorator | Oas2Decorator = ({ internalFlagPro
     }
   }
 
+  let originalMapping: Record<string, string> = {};
   return {
+    DiscriminatorMapping: {
+      enter: (mapping: Record<string, string>) => {
+        originalMapping = JSON.parse(JSON.stringify(mapping));
+      },
+    },
     any: {
       enter: (node, ctx) => {
-        removeInternal(node, ctx);
+        removeInternal(node, ctx, originalMapping);
       },
     },
   };