@redocly/openapi-core 1.19.0 → 1.20.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/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 {

package/src/decorators/common/media-type-examples-override.ts

@@ -1,8 +1,9 @@
-import { Oas3Decorator } from '../../visitors';
-import { Oas3Operation, Oas3RequestBody, Oas3Response } from '../../typings/openapi';
 import { yamlAndJsonSyncReader } from '../../utils';
 import { isRef } from '../../ref-utils';
-import { NonUndefined, ResolveFn, UserContext } from '../../walk';
+
+import type { Oas3Decorator } from '../../visitors';
+import type { Oas3Operation, Oas3RequestBody, Oas3Response } from '../../typings/openapi';
+import type { NonUndefined, ResolveFn, UserContext } from '../../walk';
 
 export const MediaTypeExamplesOverride: Oas3Decorator = ({ operationIds }) => {
   return {

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

@@ -1,8 +1,9 @@
-import { Oas3Decorator, Oas2Decorator } from '../../visitors';
-import { Oas2Operation } from '../../typings/swagger';
-import { Oas3Operation } from '../../typings/openapi';
 import { readFileAsStringSync } from '../../utils';
-import { UserContext } from '../../walk';
+
+import type { Oas3Decorator, Oas2Decorator } from '../../visitors';
+import type { Oas2Operation } from '../../typings/swagger';
+import type { Oas3Operation } from '../../typings/openapi';
+import type { UserContext } from '../../walk';
 
 export const OperationDescriptionOverride: Oas3Decorator | Oas2Decorator = ({ operationIds }) => {
   return {

package/src/decorators/common/registry-dependencies.ts

@@ -1,7 +1,7 @@
-import { UserContext } from '../../walk';
 import { isRedoclyRegistryURL } from '../../redocly/domains';
 
-import { Oas3Decorator, Oas2Decorator } from '../../visitors';
+import type { UserContext } from '../../walk';
+import type { Oas3Decorator, Oas2Decorator } from '../../visitors';
 
 export const RegistryDependencies: Oas3Decorator | Oas2Decorator = () => {
   const registryDependencies = new Set<string>();

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

@@ -1,8 +1,9 @@
-import { Oas3Decorator, Oas2Decorator } from '../../visitors';
 import { isEmptyArray, isEmptyObject, isPlainObject } from '../../utils';
-import { UserContext } from '../../walk';
 import { isRef } from '../../ref-utils';
 
+import type { Oas3Decorator, Oas2Decorator } from '../../visitors';
+import type { UserContext } from '../../walk';
+
 const DEFAULT_INTERNAL_PROPERTY_NAME = 'x-internal';
 
 export const RemoveXInternal: Oas3Decorator | Oas2Decorator = ({ internalFlagProperty }) => {

package/src/decorators/common/tag-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 TagDescriptionOverride: Oas3Decorator | Oas2Decorator = ({ tagNames }) => {
   return {

package/src/decorators/oas2/__tests__/remove-unused-components.test.ts

@@ -38,7 +38,7 @@ describe('oas2 remove-unused-components', () => {
     const results = await bundleDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({}),
+      config: await makeConfig({ rules: {} }),
       removeUnusedComponents: true,
     });
 
@@ -111,7 +111,7 @@ describe('oas2 remove-unused-components', () => {
     const results = await bundleDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({}),
+      config: await makeConfig({ rules: {} }),
       removeUnusedComponents: true,
     });
 
@@ -192,7 +192,7 @@ describe('oas2 remove-unused-components', () => {
     const results = await bundleDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({}),
+      config: await makeConfig({ rules: {} }),
       removeUnusedComponents: true,
     });
 

package/src/decorators/oas2/index.ts

@@ -1,4 +1,3 @@
-import { Oas2Decorator } from '../../visitors';
 import { RegistryDependencies } from '../common/registry-dependencies';
 import { OperationDescriptionOverride } from '../common/operation-description-override';
 import { TagDescriptionOverride } from '../common/tag-description-override';
@@ -8,6 +7,8 @@ import { RemoveXInternal } from '../common/remove-x-internal';
 import { FilterIn } from '../common/filters/filter-in';
 import { FilterOut } from '../common/filters/filter-out';
 
+import type { Oas2Decorator } from '../../visitors';
+
 export const decorators = {
   'registry-dependencies': RegistryDependencies as Oas2Decorator,
   'operation-description-override': OperationDescriptionOverride as Oas2Decorator,

package/src/decorators/oas2/remove-unused-components.ts

@@ -1,6 +1,6 @@
-import { Location } from '../../ref-utils';
 import { isEmptyObject } from '../../utils';
 
+import type { Location } from '../../ref-utils';
 import type { Oas2Decorator } from '../../visitors';
 import type { Oas2Components, Oas2Definition } from '../../typings/swagger';
 

package/src/decorators/oas3/__tests__/remove-unused-components.test.ts

@@ -42,7 +42,7 @@ describe('oas3 remove-unused-components', () => {
     const results = await bundleDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({}),
+      config: await makeConfig({ rules: {} }),
       removeUnusedComponents: true,
     });
 
@@ -121,7 +121,7 @@ describe('oas3 remove-unused-components', () => {
     const results = await bundleDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({}),
+      config: await makeConfig({ rules: {} }),
       removeUnusedComponents: true,
     });
 
@@ -204,7 +204,7 @@ describe('oas3 remove-unused-components', () => {
     const results = await bundleDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({}),
+      config: await makeConfig({ rules: {} }),
       removeUnusedComponents: true,
     });
 
@@ -270,7 +270,7 @@ describe('oas3 remove-unused-components', () => {
     const results = await bundleDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({}),
+      config: await makeConfig({ rules: {} }),
       removeUnusedComponents: true,
     });
 

package/src/decorators/oas3/index.ts

@@ -1,4 +1,3 @@
-import { Oas3Decorator } from '../../visitors';
 import { RegistryDependencies } from '../common/registry-dependencies';
 import { OperationDescriptionOverride } from '../common/operation-description-override';
 import { TagDescriptionOverride } from '../common/tag-description-override';
@@ -9,6 +8,8 @@ import { FilterIn } from '../common/filters/filter-in';
 import { FilterOut } from '../common/filters/filter-out';
 import { MediaTypeExamplesOverride } from '../common/media-type-examples-override';
 
+import type { Oas3Decorator } from '../../visitors';
+
 export const decorators = {
   'registry-dependencies': RegistryDependencies as Oas3Decorator,
   'operation-description-override': OperationDescriptionOverride as Oas3Decorator,

package/src/decorators/oas3/remove-unused-components.ts

@@ -1,6 +1,6 @@
-import { Location } from '../../ref-utils';
 import { isEmptyObject } from '../../utils';
 
+import type { Location } from '../../ref-utils';
 import type { Oas3Decorator } from '../../visitors';
 import type { Oas3Components, Oas3Definition } from '../../typings/openapi';
 

package/src/format/codeframes.ts

@@ -1,8 +1,9 @@
 import * as yamlAst from 'yaml-ast-parser';
 import { unescapePointer } from '../ref-utils';
-import { LineColLocationObject, Loc, LocationObject } from '../walk';
 import { colorize, colorOptions } from '../logger';
 
+import type { LineColLocationObject, Loc, LocationObject } from '../walk';
+
 type YAMLMapping = yamlAst.YAMLMapping & { kind: yamlAst.Kind.MAPPING };
 type YAMLMap = yamlAst.YamlMap & { kind: yamlAst.Kind.MAP };
 type YAMLAnchorReference = yamlAst.YAMLAnchorReference & { kind: yamlAst.Kind.ANCHOR_REF };

package/src/format/format.ts

@@ -1,14 +1,19 @@
 import * as path from 'path';
 import { colorOptions, colorize, logger } from '../logger';
 import { output } from '../output';
-
-const coreVersion = require('../../package.json').version;
-
-import { NormalizedProblem, ProblemSeverity, LineColLocationObject, LocationObject } from '../walk';
 import { getCodeframe, getLineColLocation } from './codeframes';
 import { env, isBrowser } from '../env';
 import { isAbsoluteUrl } from '../ref-utils';
 
+import type {
+  NormalizedProblem,
+  ProblemSeverity,
+  LineColLocationObject,
+  LocationObject,
+} from '../walk';
+
+const coreVersion = require('../../package.json').version;
+
 export type Totals = {
   errors: number;
   warnings: number;

package/src/js-yaml/index.ts

@@ -1,7 +1,9 @@
 // TODO: add a type for "types" https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/js-yaml/index.d.ts
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
-import { JSON_SCHEMA, types, LoadOptions, DumpOptions, load, dump } from 'js-yaml';
+import { JSON_SCHEMA, types, load, dump } from 'js-yaml';
+
+import type { LoadOptions, DumpOptions } from 'js-yaml';
 
 const DEFAULT_SCHEMA_WITHOUT_TIMESTAMP = JSON_SCHEMA.extend({
   implicit: [types.merge],