@redocly/openapi-core 1.0.0-beta.105 → 1.0.0-beta.108

package/src/__tests__/walk.test.ts

@@ -4,7 +4,11 @@ import * as path from 'path';
 
 import { lintDocument } from '../lint';
 
-import { parseYamlToDocument, replaceSourceWithRef, makeConfigForRuleset } from '../../__tests__/utils';
+import {
+  parseYamlToDocument,
+  replaceSourceWithRef,
+  makeConfigForRuleset,
+} from '../../__tests__/utils';
 import { BaseResolver, Document } from '../resolve';
 import { listOf } from '../types';
 import { Oas3RuleSet } from '../oas-types';
@@ -43,7 +47,7 @@ describe('walk order', () => {
           contact: {}
           license: {}
       `,
-      '',
+      ''
     );
 
     await lintDocument({
@@ -70,14 +74,10 @@ describe('walk order', () => {
             leave: jest.fn((op) => calls.push(`leave operation: ${op.operationId}`)),
             Parameter: {
               enter: jest.fn((param, _ctx, parents) =>
-                calls.push(
-                  `enter operation ${parents.Operation.operationId} > param ${param.name}`,
-                ),
+                calls.push(`enter operation ${parents.Operation.operationId} > param ${param.name}`)
               ),
               leave: jest.fn((param, _ctx, parents) =>
-                calls.push(
-                  `leave operation ${parents.Operation.operationId} > param ${param.name}`,
-                ),
+                calls.push(`leave operation ${parents.Operation.operationId} > param ${param.name}`)
               ),
             },
           },
@@ -110,7 +110,7 @@ describe('walk order', () => {
                 - name: post_a
 
       `,
-      '',
+      ''
     );
 
     await lintDocument({
@@ -154,14 +154,10 @@ describe('walk order', () => {
             leave: jest.fn((op) => calls.push(`leave operation: ${op.operationId}`)),
             Parameter: {
               enter: jest.fn((param, _ctx, parents) =>
-                calls.push(
-                  `enter operation ${parents.Operation.operationId} > param ${param.name}`,
-                ),
+                calls.push(`enter operation ${parents.Operation.operationId} > param ${param.name}`)
               ),
               leave: jest.fn((param, _ctx, parents) =>
-                calls.push(
-                  `leave operation ${parents.Operation.operationId} > param ${param.name}`,
-                ),
+                calls.push(`leave operation ${parents.Operation.operationId} > param ${param.name}`)
               ),
             },
           },
@@ -194,7 +190,7 @@ describe('walk order', () => {
                 - name: post_a
 
       `,
-      '',
+      ''
     );
 
     await lintDocument({
@@ -238,14 +234,10 @@ describe('walk order', () => {
             leave: jest.fn((op) => calls.push(`leave operation: ${op.operationId}`)),
             Parameter: {
               enter: jest.fn((param, _ctx, parents) =>
-                calls.push(
-                  `enter operation ${parents.Operation.operationId} > param ${param.name}`,
-                ),
+                calls.push(`enter operation ${parents.Operation.operationId} > param ${param.name}`)
               ),
               leave: jest.fn((param, _ctx, parents) =>
-                calls.push(
-                  `leave operation ${parents.Operation.operationId} > param ${param.name}`,
-                ),
+                calls.push(`leave operation ${parents.Operation.operationId} > param ${param.name}`)
               ),
             },
           },
@@ -279,7 +271,7 @@ describe('walk order', () => {
             shared_a:
               name: shared-a
       `,
-      '',
+      ''
     );
 
     await lintDocument({
@@ -317,7 +309,7 @@ describe('walk order', () => {
           PathItem: {
             Parameter: {
               enter: jest.fn((param, _ctx, parents) =>
-                calls.push(`enter path ${parents.PathItem.id} > param ${param.name}`),
+                calls.push(`enter path ${parents.PathItem.id} > param ${param.name}`)
               ),
             },
           },
@@ -351,7 +343,7 @@ describe('walk order', () => {
             shared_a:
               name: shared-a
       `,
-      '',
+      ''
     );
 
     await lintDocument({
@@ -379,15 +371,15 @@ describe('walk order', () => {
           PathItem: {
             Parameter: {
               enter: jest.fn((param, _ctx, parents) =>
-                calls.push(`enter path ${parents.PathItem.id} > param ${param.name}`),
+                calls.push(`enter path ${parents.PathItem.id} > param ${param.name}`)
               ),
             },
             Operation: {
               Parameter: {
                 enter: jest.fn((param, _ctx, parents) =>
                   calls.push(
-                    `enter operation ${parents.Operation.operationId} > param ${param.name}`,
-                  ),
+                    `enter operation ${parents.Operation.operationId} > param ${param.name}`
+                  )
                 ),
               },
             },
@@ -423,7 +415,7 @@ describe('walk order', () => {
             shared_b:
               name: shared-b
       `,
-      '',
+      ''
     );
 
     await lintDocument({
@@ -452,10 +444,10 @@ describe('walk order', () => {
           PathItem: {
             Parameter: {
               enter: jest.fn((param, _ctx, parents) =>
-                calls.push(`enter path ${parents.PathItem.id} > param ${param.name}`),
+                calls.push(`enter path ${parents.PathItem.id} > param ${param.name}`)
               ),
               leave: jest.fn((param, _ctx, parents) =>
-                calls.push(`leave path ${parents.PathItem.id} > param ${param.name}`),
+                calls.push(`leave path ${parents.PathItem.id} > param ${param.name}`)
               ),
             },
             Operation(op, _ctx, parents) {
@@ -490,7 +482,7 @@ describe('walk order', () => {
             shared_a:
               name: shared-a
       `,
-      '',
+      ''
     );
 
     await lintDocument({
@@ -544,7 +536,7 @@ describe('walk order', () => {
                 - $ref: "#/components/parameters/shared_a"
                 - id: 'nested'
       `,
-      '',
+      ''
     );
 
     await lintDocument({
@@ -569,7 +561,7 @@ describe('walk order', () => {
         return {
           Parameter: {
             Schema: jest.fn((schema: any, _ctx, parents) =>
-              calls.push(`enter param ${parents.Parameter.name} > schema ${schema.id}`),
+              calls.push(`enter param ${parents.Parameter.name} > schema ${schema.id}`)
             ),
           },
         };
@@ -600,7 +592,7 @@ describe('walk order', () => {
                 - $ref: "#/components/parameters/shared_a"
                 - id: 'nested'
       `,
-      '',
+      ''
     );
 
     await lintDocument({
@@ -642,7 +634,7 @@ describe('walk order', () => {
             put:
               operationId: put
       `,
-      '',
+      ''
     );
 
     await lintDocument({
@@ -668,7 +660,7 @@ describe('walk order', () => {
           Operation: {
             skip: (op) => op.operationId === 'put',
             Parameter: jest.fn((param, _ctx, parents) =>
-              calls.push(`enter operation ${parents.Operation.operationId} > param ${param.name}`),
+              calls.push(`enter operation ${parents.Operation.operationId} > param ${param.name}`)
             ),
           },
         };
@@ -697,7 +689,7 @@ describe('walk order', () => {
             shared_a:
               name: shared-a
       `,
-      '',
+      ''
     );
 
     await lintDocument({
@@ -724,10 +716,10 @@ describe('walk order', () => {
           PathItem: {
             Parameter: {
               enter: jest.fn((param, _ctx, parents) =>
-                calls.push(`enter path ${parents.PathItem.id} > param ${param.name}`),
+                calls.push(`enter path ${parents.PathItem.id} > param ${param.name}`)
               ),
               leave: jest.fn((param, _ctx, parents) =>
-                calls.push(`leave path ${parents.PathItem.id} > param ${param.name}`),
+                calls.push(`leave path ${parents.PathItem.id} > param ${param.name}`)
               ),
             },
             Operation: {
@@ -735,13 +727,13 @@ describe('walk order', () => {
               Parameter: {
                 enter: jest.fn((param, _ctx, parents) =>
                   calls.push(
-                    `enter operation ${parents.Operation.operationId} > param ${param.name}`,
-                  ),
+                    `enter operation ${parents.Operation.operationId} > param ${param.name}`
+                  )
                 ),
                 leave: jest.fn((param, _ctx, parents) =>
                   calls.push(
-                    `leave operation ${parents.Operation.operationId} > param ${param.name}`,
-                  ),
+                    `leave operation ${parents.Operation.operationId} > param ${param.name}`
+                  )
                 ),
               },
             },
@@ -783,7 +775,7 @@ describe('walk order', () => {
             shared_b:
               name: shared-b
       `,
-      '',
+      ''
     );
 
     await lintDocument({
@@ -817,10 +809,10 @@ describe('walk order', () => {
           Schema: {
             Schema: {
               enter: jest.fn((schema: any, _ctx, parents) =>
-                calls.push(`enter nested schema ${parents.Schema.id} > ${schema.id}`),
+                calls.push(`enter nested schema ${parents.Schema.id} > ${schema.id}`)
               ),
               leave: jest.fn((schema: any, _ctx, parents) =>
-                calls.push(`leave nested schema ${parents.Schema.id} > ${schema.id}`),
+                calls.push(`leave nested schema ${parents.Schema.id} > ${schema.id}`)
               ),
             },
           },
@@ -862,7 +854,7 @@ describe('walk order', () => {
                     a:
                       id: inline-nested-nested
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     await lintDocument({
@@ -934,7 +926,7 @@ describe('walk order', () => {
             schema:
               $ref: '#/components/parameters/shared_b'
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     await lintDocument({
@@ -978,7 +970,7 @@ describe('walk order', () => {
           b:
             type: number
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     await lintDocument({
@@ -1043,7 +1035,7 @@ describe('walk order', () => {
             a:
               type: object
       `,
-      '',
+      ''
     );
 
     await lintDocument({
@@ -1131,7 +1123,7 @@ describe('context.report', () => {
             shared_a:
               name: shared_a
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -1207,7 +1199,7 @@ describe('context.report', () => {
     const externalRefResolver = new BaseResolver();
     const document = (await externalRefResolver.resolveDocument(
       null,
-      `${cwd}/openapi-with-external-refs.yaml`,
+      `${cwd}/openapi-with-external-refs.yaml`
     )) as Document;
 
     if (document === null) {
@@ -1319,7 +1311,7 @@ describe('context.resolve', () => {
                 a:
                   $ref: '#/components/schemas/b'
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     await lintDocument({
@@ -1368,7 +1360,7 @@ describe('type extensions', () => {
           parameters:
             - name: a
       `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     await lintDocument({
@@ -1462,7 +1454,7 @@ describe('ignoreNextRules', () => {
             put:
               operationId: put
       `,
-      '',
+      ''
     );
 
     await lintDocument({

package/src/benchmark/benches/lint-with-many-rules.bench.ts

@@ -9,7 +9,7 @@ export const count = 10;
 const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
 const rebillyDocument = parseYamlToDocument(
   readFileSync(rebillyDefinitionRef, 'utf-8'),
-  rebillyDefinitionRef,
+  rebillyDefinitionRef
 );
 
 const ruleset: any = {};

package/src/benchmark/benches/lint-with-nested-rule.bench.ts

@@ -9,7 +9,7 @@ export const count = 10;
 const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
 const rebillyDocument = parseYamlToDocument(
   readFileSync(rebillyDefinitionRef, 'utf-8'),
-  rebillyDefinitionRef,
+  rebillyDefinitionRef
 );
 const visitor = {
   test: () => {

package/src/benchmark/benches/lint-with-no-rules.bench.ts

@@ -8,7 +8,7 @@ export const count = 10;
 const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
 const rebillyDocument = parseYamlToDocument(
   readFileSync(rebillyDefinitionRef, 'utf-8'),
-  rebillyDefinitionRef,
+  rebillyDefinitionRef
 );
 const config = makeConfigForRuleset({});
 export function measureAsync() {

package/src/benchmark/benches/lint-with-top-level-rule-report.bench.ts

@@ -9,13 +9,12 @@ export const count = 10;
 const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
 const rebillyDocument = parseYamlToDocument(
   readFileSync(rebillyDefinitionRef, 'utf-8'),
-  rebillyDefinitionRef,
+  rebillyDefinitionRef
 );
 
 const config = makeConfigForRuleset({
   test: () => {
     return {
-      // @ts-ignore
       Schema(schema, ctx) {
         if (schema.type === 'number') {
           ctx.report({

package/src/benchmark/benches/lint-with-top-level-rule.bench.ts

@@ -8,7 +8,7 @@ export const count = 10;
 const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
 const rebillyDocument = parseYamlToDocument(
   readFileSync(rebillyDefinitionRef, 'utf-8'),
-  rebillyDefinitionRef,
+  rebillyDefinitionRef
 );
 
 const config = makeConfigForRuleset({

package/src/benchmark/benches/recommended-oas3.bench.ts

@@ -1,7 +1,7 @@
 import { readFileSync } from 'fs';
 import { join as pathJoin, resolve as pathResolve } from 'path';
 import { lintDocument } from '../../lint';
-import { LintConfig, defaultPlugin, resolvePreset } from '../../config';
+import { StyleguideConfig, defaultPlugin, resolvePreset } from '../../config';
 import { BaseResolver } from '../../resolve';
 import { parseYamlToDocument } from '../utils';
 
@@ -10,13 +10,13 @@ export const count = 10;
 const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
 const rebillyDocument = parseYamlToDocument(
   readFileSync(rebillyDefinitionRef, 'utf-8'),
-  rebillyDefinitionRef,
+  rebillyDefinitionRef
 );
 
 export function measureAsync() {
   return lintDocument({
     externalRefResolver: new BaseResolver(),
     document: rebillyDocument,
-    config: new LintConfig(resolvePreset('recommended', [defaultPlugin])),
+    config: new StyleguideConfig(resolvePreset('recommended', [defaultPlugin])),
   });
 }

package/src/benchmark/benches/resolve-with-no-external.bench.ts

@@ -10,7 +10,7 @@ export const count = 10;
 const rebillyDefinitionRef = path.resolve(path.join(__dirname, 'rebilly.yaml'));
 const rebillyDocument = parseYamlToDocument(
   readFileSync(rebillyDefinitionRef, 'utf-8'),
-  rebillyDefinitionRef,
+  rebillyDefinitionRef
 );
 const externalRefResolver = new BaseResolver();
 

package/src/benchmark/benchmark.js

@@ -31,7 +31,7 @@ function prepareRevision(revision) {
   const hash = exec(`git rev-parse "${revision}"`);
   const dir = path.join(os.tmpdir(), 'redocly-cli-benchmark', hash);
   if (fs.existsSync(dir)) {
-    fs.rmdirSync(dir, { recursive: true});
+    fs.rmdirSync(dir, { recursive: true });
   }
   fs.mkdirSync(dir, { recursive: true });
 
@@ -48,7 +48,10 @@ function tscBuild(dir) {
   process.chdir(dir);
   execSync('npm run compile', { stdio: 'inherit' });
   exec(
-    `cp ${path.join(dir, 'packages/core/src/benchmark/benches/*.yaml')} ${path.join(dir, 'packages/core/lib/benchmark/benches/')}`,
+    `cp ${path.join(dir, 'packages/core/src/benchmark/benches/*.yaml')} ${path.join(
+      dir,
+      'packages/core/lib/benchmark/benches/'
+    )}`
   );
   process.chdir(oldCwd);
   return path.join(dir, 'packages/core/lib/benchmark/benches');
@@ -70,7 +73,8 @@ async function collectSamples(modulePath) {
 
 // T-Distribution two-tailed critical values for 95% confidence.
 // See http://www.itl.nist.gov/div898/handbook/eda/section3/eda3672.htm.
-const tTable = /* prettier-ignore */ {
+const tTable =
+  /* prettier-ignore */ {
   '1':  12.706, '2':  4.303, '3':  3.182, '4':  2.776, '5':  2.571, '6':  2.447,
   '7':  2.365,  '8':  2.306, '9':  2.262, '10': 2.228, '11': 2.201, '12': 2.179,
   '13': 2.16,   '14': 2.145, '15': 2.131, '16': 2.12,  '17': 2.11,  '18': 2.101,
@@ -150,7 +154,7 @@ function beautifyBenchmark(results) {
         grey(' x ') +
         memPerOpStr() +
         '/op' +
-        grey(' (' + numSamples + ' runs sampled)'),
+        grey(' (' + numSamples + ' runs sampled)')
     );
 
     function nameStr() {
@@ -255,7 +259,7 @@ function matchBenchmarks(patterns) {
   let benchmarks = findFiles(LOCAL_DIR('../lib/benchmark/benches'), '*.bench.js');
   if (patterns.length > 0) {
     benchmarks = benchmarks.filter((benchmark) =>
-      patterns.some((pattern) => path.join('../lib/benchmark/benches', benchmark).includes(pattern)),
+      patterns.some((pattern) => path.join('../lib/benchmark/benches', benchmark).includes(pattern))
     );
   }
 

package/src/benchmark/utils.ts

@@ -1,9 +1,9 @@
 import { parseYaml } from '../js-yaml';
 import { Document, Source } from '../resolve';
 import { Oas3RuleSet } from '../oas-types';
-import { LintConfig, mergeExtends, resolvePlugins } from '../config';
+import { StyleguideConfig, mergeExtends, resolvePlugins } from '../config';
 
-import type { RuleConfig, Plugin, ResolvedLintConfig } from '../config/types';
+import type { RuleConfig, Plugin, ResolvedStyleguideConfig } from '../config/types';
 
 export function parseYamlToDocument(body: string, absoluteRef: string = ''): Document {
   return {
@@ -25,12 +25,12 @@ export function makeConfigForRuleset(rules: Oas3RuleSet, plugin?: Partial<Plugin
         id: ruleId,
         rules: { oas3: rules },
       },
-    ]) as ResolvedLintConfig,
+    ]) as ResolvedStyleguideConfig,
   ];
   if (rules) {
     extendConfigs.push({ rules });
   }
-  const lint = mergeExtends(extendConfigs);
+  const styleguide = mergeExtends(extendConfigs);
 
-  return new LintConfig(lint);
+  return new StyleguideConfig(styleguide);
 }

package/src/bundle.ts

@@ -7,16 +7,16 @@ import { Oas3_1Types } from './types/oas3_1';
 import { NormalizedNodeType, normalizeTypes, NodeType } from './types';
 import { WalkContext, walkDocument, UserContext, ResolveResult } from './walk';
 import { detectOpenAPI, openAPIMajor, OasMajorVersion } from './oas-types';
-import {isAbsoluteUrl, isRef, Location, refBaseName} from './ref-utils';
+import { isAbsoluteUrl, isRef, Location, refBaseName } from './ref-utils';
 import { initRules } from './config/rules';
 import { reportUnresolvedRef } from './rules/no-unresolved-refs';
-import { isPlainObject } from './utils';
+import { isPlainObject, isTruthy } from './utils';
 import { OasRef } from './typings/openapi';
 import { isRedoclyRegistryURL } from './redocly';
 import { RemoveUnusedComponents as RemoveUnusedComponentsOas2 } from './rules/oas2/remove-unused-components';
 import { RemoveUnusedComponents as RemoveUnusedComponentsOas3 } from './rules/oas3/remove-unused-components';
 
-import type { Config, LintConfig } from './config';
+import type { Config, StyleguideConfig } from './config';
 
 export type Oas3RuleSet = Record<string, Oas3Rule>;
 
@@ -57,7 +57,7 @@ export async function bundle(opts: {
   return bundleDocument({
     document,
     ...opts,
-    config: opts.config.lint,
+    config: opts.config.styleguide,
     externalRefResolver,
   });
 }
@@ -66,7 +66,7 @@ type BundleContext = WalkContext;
 
 export async function bundleDocument(opts: {
   document: Document;
-  config: LintConfig;
+  config: StyleguideConfig;
   customTypes?: Record<string, NodeType>;
   externalRefResolver: BaseResolver;
   dereference?: boolean;
@@ -94,9 +94,9 @@ export async function bundleDocument(opts: {
           ? Oas3_1Types
           : Oas3Types
         : Oas2Types,
-      oasVersion,
+      oasVersion
     ),
-    config,
+    config
   );
 
   const preprocessors = initRules(rules as any, config, 'preprocessors', oasVersion);
@@ -113,10 +113,11 @@ export async function bundleDocument(opts: {
     decorators.push({
       severity: 'error',
       ruleId: 'remove-unused-components',
-      visitor: oasMajorVersion === OasMajorVersion.Version2
-        ? RemoveUnusedComponentsOas2({})
-        : RemoveUnusedComponentsOas3({})
-    })
+      visitor:
+        oasMajorVersion === OasMajorVersion.Version2
+          ? RemoveUnusedComponentsOas2({})
+          : RemoveUnusedComponentsOas3({}),
+    });
   }
 
   const resolvedRefMap = await resolveDocument({
@@ -137,12 +138,12 @@ export async function bundleDocument(opts: {
           skipRedoclyRegistryRefs,
           document,
           resolvedRefMap,
-          keepUrlRefs,
+          keepUrlRefs
         ),
       },
       ...decorators,
     ] as any,
-    types,
+    types
   );
 
   walkDocument({
@@ -210,7 +211,7 @@ function makeBundleVisitor(
   skipRedoclyRegistryRefs: boolean,
   rootDocument: Document,
   resolvedRefMap: ResolvedRefMap,
-  keepUrlRefs: boolean,
+  keepUrlRefs: boolean
 ) {
   let components: Record<string, Record<string, any>>;
 
@@ -287,7 +288,7 @@ function makeBundleVisitor(
   }
 
   function resolveBundledComponent(node: OasRef, resolved: ResolveResult<any>, ctx: UserContext) {
-    const newRefId = makeRefId(ctx.location.source.absoluteRef, node.$ref)
+    const newRefId = makeRefId(ctx.location.source.absoluteRef, node.$ref);
     resolvedRefMap.set(newRefId, {
       document: rootDocument,
       isRemote: false,
@@ -301,16 +302,19 @@ function makeBundleVisitor(
     if (!isPlainObject(resolved.node)) {
       ctx.parent[ctx.key] = resolved.node;
     } else {
+      // TODO: why $ref isn't optional in OasRef?
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
       // @ts-ignore
       delete ref.$ref;
-      Object.assign(ref, resolved.node);
+      const obj = Object.assign({}, resolved.node, ref);
+      Object.assign(ref, obj); // assign ref itself again so ref fields take precedence
     }
   }
 
   function saveComponent(
     componentType: string,
     target: { node: any; location: Location },
-    ctx: UserContext,
+    ctx: UserContext
   ) {
     components[componentType] = components[componentType] || {};
     const name = getComponentName(target, componentType, ctx);
@@ -325,7 +329,7 @@ function makeBundleVisitor(
   function isEqualOrEqualRef(
     node: any,
     target: { node: any; location: Location },
-    ctx: UserContext,
+    ctx: UserContext
   ) {
     if (
       isRef(node) &&
@@ -340,14 +344,14 @@ function makeBundleVisitor(
   function getComponentName(
     target: { node: any; location: Location },
     componentType: string,
-    ctx: UserContext,
+    ctx: UserContext
   ) {
     const [fileRef, pointer] = [target.location.source.absoluteRef, target.location.pointer];
     const componentsGroup = components[componentType];
 
     let name = '';
 
-    const refParts = pointer.slice(2).split('/').filter(Boolean); // slice(2) removes "#/"
+    const refParts = pointer.slice(2).split('/').filter(isTruthy); // slice(2) removes "#/"
     while (refParts.length > 0) {
       name = refParts.pop() + (name ? `-${name}` : '');
       if (