@redocly/openapi-core 1.18.1 → 1.19.0

package/src/__tests__/bundle.test.ts

@@ -274,3 +274,145 @@ describe('bundleFromString', () => {
     expect(rest.source.body).toEqual(stringDocument);
   });
 });
+
+describe('bundle async', () => {
+  it('should bundle async of version 2.x', async () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+        asyncapi: '2.6.0'
+        info:
+          title: Account Service
+          version: 1.0.0
+          description: This service is in charge of processing user signups
+        channels:
+          user/signedup:
+            subscribe:
+              message:
+                $ref: '#/components/messages/UserSignedUp'
+        components:
+          schemas:
+            UserSignedUp:
+              type: object
+              properties:
+                displayName:
+                  type: string
+                  description: Name of the user
+          messages:
+            UserSignedUp:
+              payload:
+                $ref: '#/components/schemas/UserSignedUp'
+      `,
+      ''
+    );
+
+    const config = await makeConfig({});
+
+    const {
+      bundle: { parsed },
+      problems,
+    } = await bundleDocument({
+      document: testDocument,
+      config: config,
+      externalRefResolver: new BaseResolver(),
+      dereference: true,
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(parsed).toMatchInlineSnapshot(`
+      asyncapi: 2.6.0
+      info:
+        title: Account Service
+        version: 1.0.0
+        description: This service is in charge of processing user signups
+      channels:
+        user/signedup:
+          subscribe:
+            message:
+              payload: &ref_1
+                type: object
+                properties: &ref_0
+                  displayName:
+                    type: string
+                    description: Name of the user
+      components:
+        schemas:
+          UserSignedUp:
+            type: object
+            properties: *ref_0
+        messages:
+          UserSignedUp:
+            payload: *ref_1
+
+    `);
+  });
+
+  it('should bundle async of version 3.0', async () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+        asyncapi: 3.0.0
+        info:
+          title: Account Service
+          version: 1.0.0
+          description: This service is in charge of processing user signups
+        operations:
+          sendUserSignedup:
+            action: send
+            messages:
+              - $ref: '#/components/messages/UserSignedUp'
+        components:
+          schemas:
+            UserSignedUp:
+              type: object
+              properties:
+                displayName:
+                  type: string
+                  description: Name of the user
+          messages:
+            UserSignedUp:
+              payload:
+                $ref: '#/components/schemas/UserSignedUp'
+      `,
+      ''
+    );
+
+    const config = await makeConfig({});
+
+    const {
+      bundle: { parsed },
+      problems,
+    } = await bundleDocument({
+      document: testDocument,
+      config: config,
+      externalRefResolver: new BaseResolver(),
+      dereference: true,
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(parsed).toMatchInlineSnapshot(`
+      asyncapi: 3.0.0
+      info:
+        title: Account Service
+        version: 1.0.0
+        description: This service is in charge of processing user signups
+      operations:
+        sendUserSignedup:
+          action: send
+          messages:
+            - payload: &ref_1
+                type: object
+                properties: &ref_0
+                  displayName:
+                    type: string
+                    description: Name of the user
+      components:
+        schemas:
+          UserSignedUp:
+            type: object
+            properties: *ref_0
+        messages:
+          UserSignedUp:
+            payload: *ref_1
+
+    `);
+  });
+});

package/src/bundle.ts

@@ -18,14 +18,13 @@ 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 { 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 +83,7 @@ export async function bundle(
   opts: {
     ref?: string;
     doc?: Document;
+    collectSpecData?: CollectFn;
   } & BundleOptions
 ) {
   const {
@@ -102,6 +102,7 @@ export async function bundle(
   if (document instanceof Error) {
     throw document;
   }
+  opts.collectSpecData?.(document.parsed);
 
   return bundleDocument({
     document,
@@ -292,6 +293,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 +387,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 +439,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

@@ -18,6 +18,17 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "tag-description": "warn",
     "tags-alphabetical": "off",
   },
+  "async3Decorators": {},
+  "async3Preprocessors": {},
+  "async3Rules": {
+    "channels-kebab-case": "off",
+    "info-contact": "off",
+    "no-channel-trailing-slash": "off",
+    "operation-operationId": "warn",
+    "spec": "error",
+    "tag-description": "warn",
+    "tags-alphabetical": "off",
+  },
   "decorators": {},
   "doNotResolveExamples": undefined,
   "oas2Decorators": {},
@@ -135,6 +146,17 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "tag-description": "warn",
     "tags-alphabetical": "off",
   },
+  "async3Decorators": {},
+  "async3Preprocessors": {},
+  "async3Rules": {
+    "channels-kebab-case": "off",
+    "info-contact": "off",
+    "no-channel-trailing-slash": "off",
+    "operation-operationId": "warn",
+    "spec": "error",
+    "tag-description": "warn",
+    "tags-alphabetical": "off",
+  },
   "decorators": {},
   "doNotResolveExamples": undefined,
   "oas2Decorators": {},

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.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/all.ts

@@ -114,6 +114,15 @@ const all: PluginStyleguideConfig<'built-in'> = {
     'channels-kebab-case': 'error',
     'no-channel-trailing-slash': 'error',
   },
+  async3Rules: {
+    spec: 'error',
+    'info-contact': 'error',
+    'operation-operationId': 'error',
+    'tag-description': 'error',
+    'tags-alphabetical': 'error',
+    'channels-kebab-case': 'error',
+    'no-channel-trailing-slash': 'error',
+  },
   arazzoRules: { spec: 'error' },
 };
 

package/src/config/builtIn.ts

@@ -5,14 +5,17 @@ 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 async3Rules } from '../rules/async3';
 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 async3Preprocessors } from '../rules/async3';
 import { 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 +36,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,

package/src/config/config-resolvers.ts

@@ -181,7 +181,7 @@ export function resolvePlugins(
       if (pluginModule.rules) {
         if (!pluginModule.rules.oas3 && !pluginModule.rules.oas2 && !pluginModule.rules.async2) {
           throw new Error(
-            `Plugin rules must have \`oas3\`, \`oas2\`, \`async2\`, or \`arazzo\` rules "${p}.`
+            `Plugin rules must have \`oas3\`, \`oas2\`, \`async2\`, \`async3\` or \`arazzo\` rules "${p}.`
           );
         }
         plugin.rules = {};
@@ -194,6 +194,9 @@ export function resolvePlugins(
         if (pluginModule.rules.async2) {
           plugin.rules.async2 = prefixRules(pluginModule.rules.async2, id);
         }
+        if (pluginModule.rules.async3) {
+          plugin.rules.async3 = prefixRules(pluginModule.rules.async3, id);
+        }
         if (pluginModule.rules.arazzo) {
           plugin.rules.arazzo = prefixRules(pluginModule.rules.arazzo, id);
         }
@@ -203,6 +206,7 @@ export function resolvePlugins(
           !pluginModule.preprocessors.oas3 &&
           !pluginModule.preprocessors.oas2 &&
           !pluginModule.preprocessors.async2 &&
+          !pluginModule.preprocessors.async3 &&
           !pluginModule.preprocessors.arazzo
         ) {
           throw new Error(
@@ -219,6 +223,9 @@ export function resolvePlugins(
         if (pluginModule.preprocessors.async2) {
           plugin.preprocessors.async2 = prefixRules(pluginModule.preprocessors.async2, id);
         }
+        if (pluginModule.preprocessors.async3) {
+          plugin.preprocessors.async3 = prefixRules(pluginModule.preprocessors.async3, id);
+        }
         if (pluginModule.preprocessors.arazzo) {
           plugin.preprocessors.arazzo = prefixRules(pluginModule.preprocessors.arazzo, id);
         }
@@ -229,10 +236,11 @@ export function resolvePlugins(
           !pluginModule.decorators.oas3 &&
           !pluginModule.decorators.oas2 &&
           !pluginModule.decorators.async2 &&
+          !pluginModule.decorators.async3 &&
           !pluginModule.decorators.arazzo
         ) {
           throw new Error(
-            `Plugin \`decorators\` must have \`oas3\`, \`oas2\` or \`async2\` decorators "${p}.`
+            `Plugin \`decorators\` must have \`oas3\`, \`oas2\`, \`async2\` or \`async3\` decorators "${p}.`
           );
         }
         plugin.decorators = {};
@@ -245,6 +253,9 @@ export function resolvePlugins(
         if (pluginModule.decorators.async2) {
           plugin.decorators.async2 = prefixRules(pluginModule.decorators.async2, id);
         }
+        if (pluginModule.decorators.async3) {
+          plugin.decorators.async3 = prefixRules(pluginModule.decorators.async3, id);
+        }
         if (pluginModule.decorators.arazzo) {
           plugin.decorators.arazzo = prefixRules(pluginModule.decorators.arazzo, id);
         }
@@ -432,6 +443,8 @@ function getMergedRawStyleguideConfig(
     oas2Rules: { ...rootStyleguideConfig?.oas2Rules, ...apiStyleguideConfig?.oas2Rules },
     oas3_0Rules: { ...rootStyleguideConfig?.oas3_0Rules, ...apiStyleguideConfig?.oas3_0Rules },
     oas3_1Rules: { ...rootStyleguideConfig?.oas3_1Rules, ...apiStyleguideConfig?.oas3_1Rules },
+    async2Rules: { ...rootStyleguideConfig?.async2Rules, ...apiStyleguideConfig?.async2Rules },
+    async3Rules: { ...rootStyleguideConfig?.async3Rules, ...apiStyleguideConfig?.async3Rules },
     arazzoRules: { ...rootStyleguideConfig?.arazzoRules, ...apiStyleguideConfig?.arazzoRules },
     preprocessors: {
       ...rootStyleguideConfig?.preprocessors,

package/src/config/config.ts

@@ -9,6 +9,7 @@ import {
   Oas2RuleSet,
   Oas3RuleSet,
   Async2RuleSet,
+  Async3RuleSet,
   ArazzoRuleSet,
 } from '../oas-types';
 import { isBrowser } from '../env';
@@ -72,6 +73,7 @@ export class StyleguideConfig {
       [SpecVersion.OAS3_0]: { ...rawConfig.rules, ...rawConfig.oas3_0Rules },
       [SpecVersion.OAS3_1]: { ...rawConfig.rules, ...rawConfig.oas3_1Rules },
       [SpecVersion.Async2]: { ...rawConfig.rules, ...rawConfig.async2Rules },
+      [SpecVersion.Async3]: { ...rawConfig.rules, ...rawConfig.async3Rules },
       [SpecVersion.Arazzo]: { ...rawConfig.arazzoRules },
     };
 
@@ -80,6 +82,7 @@ export class StyleguideConfig {
       [SpecVersion.OAS3_0]: { ...rawConfig.preprocessors, ...rawConfig.oas3_0Preprocessors },
       [SpecVersion.OAS3_1]: { ...rawConfig.preprocessors, ...rawConfig.oas3_1Preprocessors },
       [SpecVersion.Async2]: { ...rawConfig.preprocessors, ...rawConfig.async2Preprocessors },
+      [SpecVersion.Async3]: { ...rawConfig.preprocessors, ...rawConfig.async3Preprocessors },
       [SpecVersion.Arazzo]: { ...rawConfig.arazzoPreprocessors },
     };
 
@@ -88,6 +91,7 @@ export class StyleguideConfig {
       [SpecVersion.OAS3_0]: { ...rawConfig.decorators, ...rawConfig.oas3_0Decorators },
       [SpecVersion.OAS3_1]: { ...rawConfig.decorators, ...rawConfig.oas3_1Decorators },
       [SpecVersion.Async2]: { ...rawConfig.decorators, ...rawConfig.async2Decorators },
+      [SpecVersion.Async3]: { ...rawConfig.decorators, ...rawConfig.async3Decorators },
       [SpecVersion.Arazzo]: { ...rawConfig.arazzoDecorators },
     };
 
@@ -182,6 +186,10 @@ export class StyleguideConfig {
             if (!plugin.typeExtension.async2) continue;
             extendedTypes = plugin.typeExtension.async2(extendedTypes, version);
             break;
+          case SpecVersion.Async3:
+            if (!plugin.typeExtension.async3) continue;
+            extendedTypes = plugin.typeExtension.async3(extendedTypes, version);
+            break;
           case SpecVersion.Arazzo:
             if (!plugin.typeExtension.arazzo) continue;
             extendedTypes = plugin.typeExtension.arazzo(extendedTypes, version);
@@ -276,15 +284,26 @@ export class StyleguideConfig {
         return oas2Rules;
       case SpecMajorVersion.Async2:
         // eslint-disable-next-line no-case-declarations
-        const asyncApiRules: Async2RuleSet[] = []; // default ruleset
+        const asyncApi2Rules: Async2RuleSet[] = []; // default ruleset
+        this.plugins.forEach(
+          (p) => p.preprocessors?.async2 && asyncApi2Rules.push(p.preprocessors.async2)
+        );
+        this.plugins.forEach((p) => p.rules?.async2 && asyncApi2Rules.push(p.rules.async2));
+        this.plugins.forEach(
+          (p) => p.decorators?.async2 && asyncApi2Rules.push(p.decorators.async2)
+        );
+        return asyncApi2Rules;
+      case SpecMajorVersion.Async3:
+        // eslint-disable-next-line no-case-declarations
+        const asyncApi3Rules: Async3RuleSet[] = []; // default ruleset
         this.plugins.forEach(
-          (p) => p.preprocessors?.async2 && asyncApiRules.push(p.preprocessors.async2)
+          (p) => p.preprocessors?.async3 && asyncApi3Rules.push(p.preprocessors.async3)
         );
-        this.plugins.forEach((p) => p.rules?.async2 && asyncApiRules.push(p.rules.async2));
+        this.plugins.forEach((p) => p.rules?.async3 && asyncApi3Rules.push(p.rules.async3));
         this.plugins.forEach(
-          (p) => p.decorators?.async2 && asyncApiRules.push(p.decorators.async2)
+          (p) => p.decorators?.async3 && asyncApi3Rules.push(p.decorators.async3)
         );
-        return asyncApiRules;
+        return asyncApi3Rules;
       case SpecMajorVersion.Arazzo:
         // eslint-disable-next-line no-case-declarations
         const arazzoRules: ArazzoRuleSet[] = []; // default ruleset

package/src/config/minimal.ts

@@ -96,6 +96,15 @@ const minimal: PluginStyleguideConfig<'built-in'> = {
     'channels-kebab-case': 'off',
     'no-channel-trailing-slash': 'off',
   },
+  async3Rules: {
+    spec: 'error',
+    'info-contact': 'off',
+    'operation-operationId': 'warn',
+    'tag-description': 'warn',
+    'tags-alphabetical': 'off',
+    'channels-kebab-case': 'off',
+    'no-channel-trailing-slash': 'off',
+  },
   arazzoRules: {
     spec: 'error',
   },

package/src/config/recommended-strict.ts

@@ -96,6 +96,15 @@ const recommendedStrict: PluginStyleguideConfig<'built-in'> = {
     'channels-kebab-case': 'off',
     'no-channel-trailing-slash': 'off',
   },
+  async3Rules: {
+    spec: 'error',
+    'info-contact': 'off',
+    'operation-operationId': 'error',
+    'tag-description': 'error',
+    'tags-alphabetical': 'off',
+    'channels-kebab-case': 'off',
+    'no-channel-trailing-slash': 'off',
+  },
   arazzoRules: {
     spec: 'error',
   },

package/src/config/recommended.ts

@@ -96,6 +96,15 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
     'channels-kebab-case': 'off',
     'no-channel-trailing-slash': 'off',
   },
+  async3Rules: {
+    spec: 'error',
+    'info-contact': 'off',
+    'operation-operationId': 'warn',
+    'tag-description': 'warn',
+    'tags-alphabetical': 'off',
+    'channels-kebab-case': 'off',
+    'no-channel-trailing-slash': 'off',
+  },
   arazzoRules: {
     spec: 'error',
   },

package/src/config/rules.ts

@@ -1,6 +1,14 @@
-import { RuleSet, SpecVersion } from '../oas-types';
-import { StyleguideConfig } from './config';
 import { isDefined } from '../utils';
+
+import type {
+  ArazzoRuleSet,
+  Async2RuleSet,
+  Async3RuleSet,
+  Oas2RuleSet,
+  Oas3RuleSet,
+  SpecVersion,
+} from '../oas-types';
+import type { StyleguideConfig } from './config';
 import type { ProblemSeverity } from '../walk';
 
 type InitializedRule = {
@@ -9,8 +17,8 @@ type InitializedRule = {
   visitor: any;
 };
 
-export function initRules<T extends Function, P extends RuleSet<T>>(
-  rules: P[],
+export function initRules(
+  rules: (Oas3RuleSet | Oas2RuleSet | Async2RuleSet | Async3RuleSet | ArazzoRuleSet)[],
   config: StyleguideConfig,
   type: 'rules' | 'preprocessors' | 'decorators',
   oasVersion: SpecVersion