@redocly/openapi-core 1.18.1 → 1.20.0

package/src/bundle.ts

@@ -9,7 +9,7 @@ import {
   SpecMajorVersion,
   SpecVersion,
 } from './oas-types';
-import { isAbsoluteUrl, isRef, Location, refBaseName } from './ref-utils';
+import { isAbsoluteUrl, isRef, refBaseName } from './ref-utils';
 import { initRules } from './config/rules';
 import { reportUnresolvedRef } from './rules/no-unresolved-refs';
 import { dequal, isPlainObject, isTruthy } from './utils';
@@ -18,14 +18,14 @@ import { RemoveUnusedComponents as RemoveUnusedComponentsOas2 } from './decorato
 import { RemoveUnusedComponents as RemoveUnusedComponentsOas3 } from './decorators/oas3/remove-unused-components';
 import { ConfigTypes } from './types/redocly-yaml';
 
-import type { Oas3Rule, Oas3Visitor, Oas2Visitor } from './visitors';
+import type { Location } from './ref-utils';
+import type { Oas3Visitor, Oas2Visitor } from './visitors';
 import type { NormalizedNodeType, NodeType } from './types';
 import type { WalkContext, UserContext, ResolveResult, NormalizedProblem } from './walk';
 import type { Config, StyleguideConfig } from './config';
 import type { OasRef } from './typings/openapi';
 import type { Document, ResolvedRefMap } from './resolve';
-
-export type Oas3RuleSet = Record<string, Oas3Rule>;
+import type { CollectFn } from './utils';
 
 export enum OasVersion {
   Version2 = 'oas2',
@@ -84,6 +84,7 @@ export async function bundle(
   opts: {
     ref?: string;
     doc?: Document;
+    collectSpecData?: CollectFn;
   } & BundleOptions
 ) {
   const {
@@ -102,6 +103,7 @@ export async function bundle(
   if (document instanceof Error) {
     throw document;
   }
+  opts.collectSpecData?.(document.parsed);
 
   return bundleDocument({
     document,
@@ -292,6 +294,15 @@ export function mapTypeToComponent(typeName: string, version: SpecMajorVersion)
         default:
           return null;
       }
+    case SpecMajorVersion.Async3:
+      switch (typeName) {
+        case 'Schema':
+          return 'schemas';
+        case 'Parameter':
+          return 'parameters';
+        default:
+          return null;
+      }
     case SpecMajorVersion.Arazzo:
       switch (typeName) {
         case 'Root.x-parameters_items':
@@ -377,6 +388,8 @@ function makeBundleVisitor(
           components = root;
         } else if (version === SpecMajorVersion.Async2) {
           components = root.components = root.components || {};
+        } else if (version === SpecMajorVersion.Async3) {
+          components = root.components = root.components || {};
         } else if (version === SpecMajorVersion.Arazzo) {
           components = root.components = root.components || {};
         }
@@ -427,6 +440,8 @@ function makeBundleVisitor(
     components[componentType][name] = target.node;
     if (version === SpecMajorVersion.OAS3) {
       return `#/components/${componentType}/${name}`;
+    } else if (version === SpecMajorVersion.Async2 || version === SpecMajorVersion.Async3) {
+      return `#/components/${componentType}/${name}`;
     } else {
       return `#/${componentType}/${name}`;
     }

package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap

@@ -5,6 +5,7 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
   "arazzoDecorators": {},
   "arazzoPreprocessors": {},
   "arazzoRules": {
+    "parameters-no-body-inside-in": "off",
     "spec": "error",
   },
   "async2Decorators": {},
@@ -12,6 +13,19 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
   "async2Rules": {
     "channels-kebab-case": "off",
     "info-contact": "off",
+    "info-license-strict": "warn",
+    "no-channel-trailing-slash": "off",
+    "operation-operationId": "warn",
+    "spec": "error",
+    "tag-description": "warn",
+    "tags-alphabetical": "off",
+  },
+  "async3Decorators": {},
+  "async3Preprocessors": {},
+  "async3Rules": {
+    "channels-kebab-case": "off",
+    "info-contact": "off",
+    "info-license-strict": "warn",
     "no-channel-trailing-slash": "off",
     "operation-operationId": "warn",
     "spec": "error",
@@ -74,7 +88,8 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "boolean-parameter-prefixes": "error",
     "info-contact": "off",
     "info-license": "warn",
-    "info-license-url": "warn",
+    "info-license-strict": "warn",
+    "info-license-url": "off",
     "local/operation-id-not-test": "error",
     "no-ambiguous-paths": "warn",
     "no-enum-type-mismatch": "error",
@@ -122,6 +137,7 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
   "arazzoDecorators": {},
   "arazzoPreprocessors": {},
   "arazzoRules": {
+    "parameters-no-body-inside-in": "off",
     "spec": "error",
   },
   "async2Decorators": {},
@@ -129,6 +145,19 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
   "async2Rules": {
     "channels-kebab-case": "off",
     "info-contact": "off",
+    "info-license-strict": "warn",
+    "no-channel-trailing-slash": "off",
+    "operation-operationId": "warn",
+    "spec": "error",
+    "tag-description": "warn",
+    "tags-alphabetical": "off",
+  },
+  "async3Decorators": {},
+  "async3Preprocessors": {},
+  "async3Rules": {
+    "channels-kebab-case": "off",
+    "info-contact": "off",
+    "info-license-strict": "warn",
     "no-channel-trailing-slash": "off",
     "operation-operationId": "warn",
     "spec": "error",
@@ -209,7 +238,8 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "boolean-parameter-prefixes": "error",
     "info-contact": "off",
     "info-license": "warn",
-    "info-license-url": "warn",
+    "info-license-strict": "warn",
+    "info-license-url": "off",
     "local/operation-id-not-test": "error",
     "no-ambiguous-paths": "warn",
     "no-enum-type-mismatch": "error",

package/src/config/__tests__/__snapshots__/config.test.ts.snap

@@ -12,6 +12,11 @@ StyleguideConfig {
       "oas3_0": {},
       "oas3_1": {},
     },
+    "async3": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
+    },
     "oas2": {
       "oas2": {},
       "oas3_0": {},
@@ -51,6 +56,11 @@ StyleguideConfig {
       "oas3_0": {},
       "oas3_1": {},
     },
+    "async3": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
+    },
     "oas2": {
       "oas2": {},
       "oas3_0": {},
@@ -124,6 +134,20 @@ StyleguideConfig {
         "operation-summary": "error",
       },
     },
+    "async3": {
+      "oas2": {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_0": {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_1": {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+    },
     "oas2": {
       "oas2": {
         "no-empty-servers": "error",

package/src/config/__tests__/config-resolvers.test.ts

@@ -91,6 +91,88 @@ describe('resolveStyleguideConfig', () => {
     });
   });
 
+  it('should resolve local file config with esm plugin', async () => {
+    const config = {
+      ...baseStyleguideConfig,
+      extends: ['local-config-with-esm.yaml'],
+    };
+
+    const { plugins, ...styleguide } = await resolveStyleguideConfig({
+      styleguideConfig: config,
+      configPath,
+    });
+
+    expect(styleguide?.rules?.['operation-2xx-response']).toEqual('warn');
+    expect(plugins).toBeDefined();
+    expect(plugins?.length).toBe(2);
+
+    const localPlugin = plugins?.find((p) => p.id === 'test-plugin');
+    expect(localPlugin).toBeDefined();
+
+    expect(localPlugin).toMatchObject({
+      id: 'test-plugin',
+      rules: {
+        oas3: {
+          'test-plugin/oas3-rule-name': 'oas3-rule-stub',
+        },
+      },
+    });
+
+    expect(styleguide.extendPaths!.map(removeAbsolutePath)).toEqual([
+      'resolve-config/redocly.yaml',
+      'resolve-config/local-config-with-esm.yaml',
+      'resolve-config/redocly.yaml',
+    ]);
+    expect(styleguide.pluginPaths!.map(removeAbsolutePath)).toEqual([
+      'resolve-config/plugin-esm.mjs',
+    ]);
+
+    expect(styleguide.rules).toEqual({
+      'operation-2xx-response': 'warn',
+    });
+  });
+
+  it('should resolve local file config with commonjs plugin with a default export function', async () => {
+    const config = {
+      ...baseStyleguideConfig,
+      extends: ['local-config-with-commonjs-export-function.yaml'],
+    };
+
+    const { plugins, ...styleguide } = await resolveStyleguideConfig({
+      styleguideConfig: config,
+      configPath,
+    });
+
+    expect(styleguide?.rules?.['operation-2xx-response']).toEqual('warn');
+    expect(plugins).toBeDefined();
+    expect(plugins?.length).toBe(2);
+
+    const localPlugin = plugins?.find((p) => p.id === 'test-plugin');
+    expect(localPlugin).toBeDefined();
+
+    expect(localPlugin).toMatchObject({
+      id: 'test-plugin',
+      rules: {
+        oas3: {
+          'test-plugin/oas3-rule-name': 'oas3-rule-stub',
+        },
+      },
+    });
+
+    expect(styleguide.extendPaths!.map(removeAbsolutePath)).toEqual([
+      'resolve-config/redocly.yaml',
+      'resolve-config/local-config-with-commonjs-export-function.yaml',
+      'resolve-config/redocly.yaml',
+    ]);
+    expect(styleguide.pluginPaths!.map(removeAbsolutePath)).toEqual([
+      'resolve-config/plugin-with-export-function.cjs',
+    ]);
+
+    expect(styleguide.rules).toEqual({
+      'operation-2xx-response': 'warn',
+    });
+  });
+
   // TODO: fix circular test
   it.skip('should throw circular error', () => {
     const config = {

package/src/config/__tests__/config.test.ts

@@ -119,6 +119,7 @@ describe('getMergedConfig', () => {
           "decorators": {
             "arazzo": {},
             "async2": {},
+            "async3": {},
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
@@ -131,6 +132,7 @@ describe('getMergedConfig', () => {
           "preprocessors": {
             "arazzo": {},
             "async2": {},
+            "async3": {},
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
@@ -148,6 +150,9 @@ describe('getMergedConfig', () => {
             "async2": {
               "operation-summary": "warn",
             },
+            "async3": {
+              "operation-summary": "warn",
+            },
             "oas2": {
               "operation-summary": "warn",
             },
@@ -227,6 +232,7 @@ describe('getMergedConfig', () => {
           "decorators": {
             "arazzo": {},
             "async2": {},
+            "async3": {},
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
@@ -239,6 +245,7 @@ describe('getMergedConfig', () => {
           "preprocessors": {
             "arazzo": {},
             "async2": {},
+            "async3": {},
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
@@ -259,6 +266,10 @@ describe('getMergedConfig', () => {
               "no-empty-servers": "error",
               "operation-summary": "error",
             },
+            "async3": {
+              "no-empty-servers": "error",
+              "operation-summary": "error",
+            },
             "oas2": {
               "no-empty-servers": "error",
               "operation-summary": "error",

package/src/config/__tests__/fixtures/resolve-config/local-config-with-commonjs-export-function.yaml

@@ -0,0 +1,2 @@
+plugins:
+  - plugin-with-export-function.cjs

package/src/config/__tests__/fixtures/resolve-config/local-config-with-esm.yaml

@@ -0,0 +1,2 @@
+plugins:
+  - plugin-esm.mjs

package/src/config/__tests__/fixtures/resolve-config/plugin-esm.mjs

@@ -0,0 +1,10 @@
+export default async function () {
+  return {
+    id: 'test-plugin',
+    rules: {
+      oas3: {
+        'oas3-rule-name': 'oas3-rule-stub',
+      },
+    },
+  };
+}

package/src/config/__tests__/fixtures/resolve-config/plugin-with-export-function.cjs

@@ -0,0 +1,10 @@
+module.exports = async function () {
+  return {
+    id: 'test-plugin',
+    rules: {
+      oas3: {
+        'oas3-rule-name': 'oas3-rule-stub',
+      },
+    },
+  };
+};

package/src/config/__tests__/resolve-plugins.test.ts

@@ -1,7 +1,10 @@
 import * as path from 'path';
 import { loadConfig } from '../load';
 
-describe('resolving a plugin', () => {
+// FIXME: skipping due to the 'Test environment has been torn down' Jest error.
+// Covered the below in the `miscellaneous/resolve-plugins` e2e tests.
+// Unskip when Jest gets this fixed.
+describe.skip('resolving a plugin', () => {
   const configPath = path.join(__dirname, 'fixtures/plugin-config.yaml');
 
   it('should prefix rule names with the plugin id', async () => {

package/src/config/all.ts

@@ -5,6 +5,7 @@ const all: PluginStyleguideConfig<'built-in'> = {
     'info-contact': 'error',
     'info-license': 'error',
     'info-license-url': 'error',
+    'info-license-strict': 'error',
     'tag-description': 'error',
     'tags-alphabetical': 'error',
     'parameter-description': 'error',
@@ -108,13 +109,24 @@ const all: PluginStyleguideConfig<'built-in'> = {
   async2Rules: {
     spec: 'error',
     'info-contact': 'error',
+    'info-license-strict': 'error',
     'operation-operationId': 'error',
     'tag-description': 'error',
     'tags-alphabetical': 'error',
     'channels-kebab-case': 'error',
     'no-channel-trailing-slash': 'error',
   },
-  arazzoRules: { spec: 'error' },
+  async3Rules: {
+    spec: 'error',
+    'info-contact': 'error',
+    'info-license-strict': 'error',
+    'operation-operationId': 'error',
+    'tag-description': 'error',
+    'tags-alphabetical': 'error',
+    'channels-kebab-case': 'error',
+    'no-channel-trailing-slash': 'error',
+  },
+  arazzoRules: { spec: 'error', 'parameters-no-body-inside-in': 'off' },
 };
 
 export default all;

package/src/config/builtIn.ts

@@ -2,17 +2,15 @@ import recommended from './recommended';
 import recommendedStrict from './recommended-strict';
 import all from './all';
 import minimal from './minimal';
-import { rules as oas3Rules } from '../rules/oas3';
-import { rules as oas2Rules } from '../rules/oas2';
-import { rules as async2Rules } from '../rules/async2';
-import { rules as arazzoRules } from '../rules/arazzo';
-import { preprocessors as oas3Preprocessors } from '../rules/oas3';
-import { preprocessors as oas2Preprocessors } from '../rules/oas2';
-import { preprocessors as async2Preprocessors } from '../rules/async2';
-import { preprocessors as arazzoPreprocessors } from '../rules/arazzo';
+import { rules as oas3Rules, preprocessors as oas3Preprocessors } from '../rules/oas3';
+import { rules as oas2Rules, preprocessors as oas2Preprocessors } from '../rules/oas2';
+import { rules as async2Rules, preprocessors as async2Preprocessors } from '../rules/async2';
+import { rules as async3Rules, preprocessors as async3Preprocessors } from '../rules/async3';
+import { rules as arazzoRules, preprocessors as arazzoPreprocessors } from '../rules/arazzo';
 import { decorators as oas3Decorators } from '../decorators/oas3';
 import { decorators as oas2Decorators } from '../decorators/oas2';
 import { decorators as async2Decorators } from '../decorators/async2';
+import { decorators as async3Decorators } from '../decorators/async3';
 import { decorators as arazzoDecorators } from '../decorators/arazzo';
 
 import type { CustomRulesConfig, StyleguideRawConfig, Plugin } from './types';
@@ -33,18 +31,21 @@ export const defaultPlugin: Plugin = {
     oas3: oas3Rules,
     oas2: oas2Rules,
     async2: async2Rules,
+    async3: async3Rules,
     arazzo: arazzoRules,
   } as CustomRulesConfig,
   preprocessors: {
     oas3: oas3Preprocessors,
     oas2: oas2Preprocessors,
     async2: async2Preprocessors,
+    async3: async3Preprocessors,
     arazzo: arazzoPreprocessors,
   },
   decorators: {
     oas3: oas3Decorators,
     oas2: oas2Decorators,
     async2: async2Decorators,
+    async3: async3Decorators,
     arazzo: arazzoDecorators,
   },
   configs: builtInConfigs,