@redocly/openapi-core 1.18.1 → 1.20.0

package/src/config/utils.ts

@@ -6,13 +6,15 @@ import {
   showWarningForDeprecatedField,
 } from '../utils';
 import { Config } from './config';
+import { logger, colorize } from '../logger';
+
 import type {
   Api,
   DeprecatedInApi,
   DeprecatedInRawConfig,
+  ImportedPlugin,
   FlatApi,
   FlatRawConfig,
-  Plugin,
   RawConfig,
   RawResolveConfig,
   ResolveConfig,
@@ -20,8 +22,9 @@ import type {
   RulesFields,
   StyleguideRawConfig,
   ThemeConfig,
+  Plugin,
+  PluginCreator,
 } from './types';
-import { logger, colorize } from '../logger';
 
 export function parsePresetName(presetName: string): { pluginId: string; configName: string } {
   if (presetName.indexOf('/') > -1) {
@@ -56,6 +59,7 @@ function extractFlatConfig<
   oas3_0Rules,
   oas3_1Rules,
   async2Rules,
+  async3Rules,
   arazzoRules,
 
   preprocessors,
@@ -63,6 +67,7 @@ function extractFlatConfig<
   oas3_0Preprocessors,
   oas3_1Preprocessors,
   async2Preprocessors,
+  async3Preprocessors,
   arazzoPreprocessors,
 
   decorators,
@@ -70,6 +75,7 @@ function extractFlatConfig<
   oas3_0Decorators,
   oas3_1Decorators,
   async2Decorators,
+  async3Decorators,
   arazzoDecorators,
 
   ...rawConfigRest
@@ -86,6 +92,7 @@ function extractFlatConfig<
     oas3_0Rules,
     oas3_1Rules,
     async2Rules,
+    async3Rules,
     arazzoRules,
 
     preprocessors,
@@ -93,6 +100,7 @@ function extractFlatConfig<
     oas3_0Preprocessors,
     oas3_1Preprocessors,
     async2Preprocessors,
+    async3Preprocessors,
     arazzoPreprocessors,
 
     decorators,
@@ -100,6 +108,7 @@ function extractFlatConfig<
     oas3_0Decorators,
     oas3_1Decorators,
     async2Decorators,
+    async3Decorators,
     arazzoDecorators,
 
     doNotResolveExamples: rawConfigRest.resolve?.doNotResolveExamples,
@@ -158,6 +167,7 @@ export function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]) {
     oas3_0Rules: {},
     oas3_1Rules: {},
     async2Rules: {},
+    async3Rules: {},
     arazzoRules: {},
 
     preprocessors: {},
@@ -165,6 +175,7 @@ export function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]) {
     oas3_0Preprocessors: {},
     oas3_1Preprocessors: {},
     async2Preprocessors: {},
+    async3Preprocessors: {},
     arazzoPreprocessors: {},
 
     decorators: {},
@@ -172,6 +183,7 @@ export function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]) {
     oas3_0Decorators: {},
     oas3_1Decorators: {},
     async2Decorators: {},
+    async3Decorators: {},
     arazzoDecorators: {},
 
     plugins: [],
@@ -195,6 +207,8 @@ export function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]) {
     assignExisting(result.oas3_1Rules, rulesConf.rules || {});
     Object.assign(result.async2Rules, rulesConf.async2Rules);
     assignExisting(result.async2Rules, rulesConf.rules || {});
+    Object.assign(result.async3Rules, rulesConf.async3Rules);
+    assignExisting(result.async3Rules, rulesConf.rules || {});
     Object.assign(result.arazzoRules, rulesConf.arazzoRules);
     assignExisting(result.arazzoRules, rulesConf.rules || {});
 
@@ -207,6 +221,8 @@ export function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]) {
     assignExisting(result.oas3_1Preprocessors, rulesConf.preprocessors || {});
     Object.assign(result.async2Preprocessors, rulesConf.async2Preprocessors);
     assignExisting(result.async2Preprocessors, rulesConf.preprocessors || {});
+    Object.assign(result.async3Preprocessors, rulesConf.async3Preprocessors);
+    assignExisting(result.async3Preprocessors, rulesConf.preprocessors || {});
     Object.assign(result.arazzoPreprocessors, rulesConf.arazzoPreprocessors);
     assignExisting(result.arazzoPreprocessors, rulesConf.preprocessors || {});
 
@@ -219,6 +235,8 @@ export function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]) {
     assignExisting(result.oas3_1Decorators, rulesConf.decorators || {});
     Object.assign(result.async2Decorators, rulesConf.async2Decorators);
     assignExisting(result.async2Decorators, rulesConf.decorators || {});
+    Object.assign(result.async3Decorators, rulesConf.async3Decorators);
+    assignExisting(result.async3Decorators, rulesConf.decorators || {});
     Object.assign(result.arazzoDecorators, rulesConf.arazzoDecorators);
     assignExisting(result.arazzoDecorators, rulesConf.decorators || {});
 
@@ -383,3 +401,11 @@ export class ConfigValidationError extends Error {}
 export function deepCloneMapWithJSON<K, V>(originalMap: Map<K, V>): Map<K, V> {
   return new Map(JSON.parse(JSON.stringify([...originalMap])));
 }
+
+export function isDeprecatedPluginFormat(plugin: ImportedPlugin | undefined): plugin is Plugin {
+  return plugin !== undefined && typeof plugin === 'object' && 'id' in plugin;
+}
+
+export function isCommonJsPlugin(plugin: ImportedPlugin | undefined): plugin is PluginCreator {
+  return typeof plugin === 'function';
+}

package/src/decorators/__tests__/filter-in.test.ts

@@ -56,7 +56,10 @@ describe('oas3 filter-in', () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig({}, { 'filter-in': { value: 'public', property: 'x-access' } }),
+      config: await makeConfig({
+        rules: {},
+        decorators: { 'filter-in': { value: 'public', property: 'x-access' } },
+      }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
       openapi: 3.0.0
@@ -76,16 +79,16 @@ describe('oas3 filter-in', () => {
     const { bundle: res } = await bundleDocument({
       document: inputDoc,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'filter-in': {
             property: 'x-audience',
             value: ['Public', 'Protected'],
             matchStrategy: 'all',
           },
-        }
-      ),
+        },
+      }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
       openapi: 3.0.0
@@ -130,16 +133,16 @@ describe('oas3 filter-in', () => {
     const { bundle: res } = await bundleDocument({
       document: testDoc,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'filter-in': {
             property: 'x-audience',
             value: ['Public', 'Global'],
             matchStrategy: 'any',
           },
-        }
-      ),
+        },
+      }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
       openapi: 3.0.0
@@ -171,16 +174,16 @@ describe('oas3 filter-in', () => {
     const { bundle: res } = await bundleDocument({
       document: inputDoc,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'filter-in': {
             property: 'x-audience',
             value: 'non-existing-audience',
             matchStrategy: 'any',
           },
-        }
-      ),
+        },
+      }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
       openapi: 3.0.0
@@ -220,16 +223,16 @@ describe('oas3 filter-in', () => {
     const { bundle: res } = await bundleDocument({
       document: testDoc,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'filter-in': {
             property: 'x-audience',
             value: ['Public', 'Global'],
             matchStrategy: 'any',
           },
-        }
-      ),
+        },
+      }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
       openapi: 3.0.0
@@ -279,16 +282,16 @@ describe('oas2 filter-in', () => {
     const { bundle: res } = await bundleDocument({
       document: testDoc,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'filter-in': {
             property: 'x-access',
             value: ['public', 'global'],
             matchStrategy: 'any',
           },
-        }
-      ),
+        },
+      }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
       swagger: '2.0'

package/src/decorators/__tests__/filter-out.test.ts

@@ -52,7 +52,10 @@ describe('oas3 filter-out', () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig({}, { 'filter-out': { property: 'x-access', value: 'private' } }),
+      config: await makeConfig({
+        rules: {},
+        decorators: { 'filter-out': { property: 'x-access', value: 'private' } },
+      }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
           openapi: 3.0.0
@@ -68,16 +71,16 @@ describe('oas3 filter-out', () => {
     const { bundle: res } = await bundleDocument({
       document: inputDoc,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'filter-out': {
             property: 'x-audience',
             value: ['Private', 'Protected'],
             matchStrategy: 'all',
           },
-        }
-      ),
+        },
+      }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
       openapi: 3.0.0
@@ -99,16 +102,16 @@ describe('oas3 filter-out', () => {
     const { bundle: res } = await bundleDocument({
       document: inputDoc,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'filter-out': {
             property: 'x-audience',
             value: ['Private', 'Protected'],
             matchStrategy: 'any',
           },
-        }
-      ),
+        },
+      }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
         openapi: 3.0.0
@@ -138,16 +141,16 @@ describe('oas3 filter-out', () => {
     const { bundle: res } = await bundleDocument({
       document: testDoc,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'filter-out': {
             property: 'x-access',
             value: 'private',
             matchStrategy: 'any',
           },
-        }
-      ),
+        },
+      }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
       openapi: 3.0.0
@@ -192,7 +195,10 @@ describe('oas3 filter-out', () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig({}, { 'filter-out': { property: 'x-prop', value: false } }),
+      config: await makeConfig({
+        rules: {},
+        decorators: { 'filter-out': { property: 'x-prop', value: false } },
+      }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
       openapi: 3.0.0
@@ -244,7 +250,10 @@ describe('oas3 filter-out', () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig({}, { 'filter-out': { property: 'x-prop', value: null } }),
+      config: await makeConfig({
+        rules: {},
+        decorators: { 'filter-out': { property: 'x-prop', value: null } },
+      }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
       openapi: 3.0.0
@@ -305,16 +314,16 @@ describe('oas2 filter-out', () => {
     const { bundle: res } = await bundleDocument({
       document: testDoc,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'filter-out': {
             property: 'x-access',
             value: ['private', 'protected'],
             matchStrategy: 'any',
           },
-        }
-      ),
+        },
+      }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
       swagger: '2.0'

package/src/decorators/__tests__/media-type-examples-override.test.ts

@@ -28,9 +28,9 @@ describe('oas3 media-type-examples-override', () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'media-type-examples-override': {
             operationIds: {
               getUserById: {
@@ -43,8 +43,8 @@ describe('oas3 media-type-examples-override', () => {
               },
             },
           },
-        }
-      ),
+        },
+      }),
     });
 
     expect(res.parsed).toMatchInlineSnapshot(`
@@ -88,9 +88,9 @@ describe('oas3 media-type-examples-override', () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'media-type-examples-override': {
             operationIds: {
               getUserById: {
@@ -101,8 +101,8 @@ describe('oas3 media-type-examples-override', () => {
               },
             },
           },
-        }
-      ),
+        },
+      }),
     });
 
     expect(res.parsed).toMatchInlineSnapshot(`
@@ -153,9 +153,9 @@ describe('oas3 media-type-examples-override', () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'media-type-examples-override': {
             operationIds: {
               getUserById: {
@@ -176,8 +176,8 @@ describe('oas3 media-type-examples-override', () => {
               },
             },
           },
-        }
-      ),
+        },
+      }),
     });
 
     expect(res.parsed).toMatchInlineSnapshot(`
@@ -245,9 +245,9 @@ describe('oas3 media-type-examples-override', () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'media-type-examples-override': {
             operationIds: {
               getUserById: {
@@ -264,8 +264,8 @@ describe('oas3 media-type-examples-override', () => {
               },
             },
           },
-        }
-      ),
+        },
+      }),
     });
 
     expect(res.parsed).toMatchInlineSnapshot(`
@@ -345,9 +345,9 @@ describe('oas3 media-type-examples-override', () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'media-type-examples-override': {
             operationIds: {
               getUserById: {
@@ -364,8 +364,8 @@ describe('oas3 media-type-examples-override', () => {
               },
             },
           },
-        }
-      ),
+        },
+      }),
     });
 
     expect(res.parsed).toMatchInlineSnapshot(`
@@ -417,9 +417,9 @@ describe('oas3 media-type-examples-override', () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'media-type-examples-override': {
             operationIds: {
               getUserById: {
@@ -436,8 +436,8 @@ describe('oas3 media-type-examples-override', () => {
               },
             },
           },
-        }
-      ),
+        },
+      }),
     });
 
     expect(res.parsed).toMatchInlineSnapshot(`
@@ -489,9 +489,9 @@ describe('oas3 media-type-examples-override', () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'media-type-examples-override': {
             operationIds: {
               getUserById: {
@@ -504,8 +504,8 @@ describe('oas3 media-type-examples-override', () => {
               },
             },
           },
-        }
-      ),
+        },
+      }),
     });
 
     expect(res.parsed).toMatchInlineSnapshot(`
@@ -550,9 +550,9 @@ describe('oas3 media-type-examples-override', () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'media-type-examples-override': {
             operationIds: {
               getUserById: {
@@ -565,8 +565,8 @@ describe('oas3 media-type-examples-override', () => {
               },
             },
           },
-        }
-      ),
+        },
+      }),
     });
 
     expect(res.parsed).toMatchInlineSnapshot(`
@@ -618,9 +618,9 @@ describe('oas3 media-type-examples-override', () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig(
-        {},
-        {
+      config: await makeConfig({
+        rules: {},
+        decorators: {
           'media-type-examples-override': {
             operationIds: {
               getUserById: {
@@ -633,8 +633,8 @@ describe('oas3 media-type-examples-override', () => {
               },
             },
           },
-        }
-      ),
+        },
+      }),
     });
 
     expect(res.parsed).toMatchInlineSnapshot(`

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

@@ -25,7 +25,10 @@ describe('oas3 remove-x-internal', () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig({}, { 'remove-x-internal': { internalFlagProperty: 'removeit' } }),
+      config: await makeConfig({
+        rules: {},
+        decorators: { 'remove-x-internal': { internalFlagProperty: 'removeit' } },
+      }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
           openapi: 3.0.0
@@ -92,7 +95,7 @@ describe('oas3 remove-x-internal', () => {
     const { bundle: res } = await bundleDocument({
       document: testDoc,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig({}, { 'remove-x-internal': 'on' }),
+      config: await makeConfig({ rules: {}, decorators: { 'remove-x-internal': 'on' } }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
       openapi: 3.1.0
@@ -165,7 +168,7 @@ describe('oas3 remove-x-internal', () => {
     const { bundle: res } = await bundleDocument({
       document: testDoc,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig({}, { 'remove-x-internal': 'on' }),
+      config: await makeConfig({ rules: {}, decorators: { 'remove-x-internal': 'on' } }),
     });
 
     expect(res.parsed).toMatchInlineSnapshot(`
@@ -239,7 +242,7 @@ describe('oas3 remove-x-internal', () => {
     const { bundle: res } = await bundleDocument({
       document: testDoc,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig({}, { 'remove-x-internal': 'on' }),
+      config: await makeConfig({ rules: {}, decorators: { 'remove-x-internal': 'on' } }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
       openapi: 3.0.1
@@ -302,7 +305,7 @@ describe('oas2 remove-x-internal', () => {
     const { bundle: res } = await bundleDocument({
       document: testDoc,
       externalRefResolver: new BaseResolver(),
-      config: await makeConfig({}, { 'remove-x-internal': 'on' }),
+      config: await makeConfig({ rules: {}, decorators: { 'remove-x-internal': 'on' } }),
     });
     expect(res.parsed).toMatchInlineSnapshot(`
           swagger: '2.0'

package/src/decorators/async3/index.ts

@@ -0,0 +1 @@
+export const decorators = {};

package/src/decorators/common/filters/filter-helper.ts

@@ -1,7 +1,8 @@
-import { UserContext } from '../../../walk';
 import { isRef } from '../../../ref-utils';
 import { isEmptyArray, isEmptyObject, isPlainObject } from '../../../utils';
 
+import type { UserContext } from '../../../walk';
+
 export function filter(node: any, ctx: UserContext, criteria: (item: any) => boolean) {
   const { parent, key } = ctx;
   let didDelete = false;

package/src/decorators/common/filters/filter-in.ts

@@ -1,6 +1,7 @@
-import { Oas2Decorator, Oas3Decorator } from '../../../visitors';
 import { checkIfMatchByStrategy, filter } from './filter-helper';
 
+import type { Oas2Decorator, Oas3Decorator } from '../../../visitors';
+
 const DEFAULT_STRATEGY = 'any';
 
 export const FilterIn: Oas3Decorator | Oas2Decorator = ({ property, value, matchStrategy }) => {

package/src/decorators/common/filters/filter-out.ts

@@ -1,6 +1,7 @@
-import { Oas2Decorator, Oas3Decorator } from '../../../visitors';
 import { checkIfMatchByStrategy, filter } from './filter-helper';
 
+import type { Oas2Decorator, Oas3Decorator } from '../../../visitors';
+
 const DEFAULT_STRATEGY = 'any';
 
 export const FilterOut: Oas3Decorator | Oas2Decorator = ({ property, value, matchStrategy }) => {

package/src/decorators/common/info-description-override.ts

@@ -1,6 +1,7 @@
-import { Oas3Decorator, Oas2Decorator } from '../../visitors';
 import { readFileAsStringSync } from '../../utils';
-import { UserContext } from '../../walk';
+
+import type { Oas3Decorator, Oas2Decorator } from '../../visitors';
+import type { UserContext } from '../../walk';
 
 export const InfoDescriptionOverride: Oas3Decorator | Oas2Decorator = ({ filePath }) => {
   return {

package/src/decorators/common/info-override.ts

@@ -1,4 +1,4 @@
-import { Oas3Decorator, Oas2Decorator } from '../../visitors';
+import type { Oas3Decorator, Oas2Decorator } from '../../visitors';
 
 export const InfoOverride: Oas3Decorator | Oas2Decorator = (newInfo) => {
   return {