@redocly/openapi-core 1.0.0-beta.106 → 1.0.0-beta.109

package/src/__tests__/walk.test.ts

@@ -16,7 +16,7 @@ import { Oas3RuleSet } from '../oas-types';
 describe('walk order', () => {
   it('should run visitors', async () => {
     const visitors = {
-      DefinitionRoot: {
+      Root: {
         enter: jest.fn(),
         leave: jest.fn(),
       },
@@ -63,6 +63,74 @@ describe('walk order', () => {
     }
   });
 
+  it('should run legacy visitors', async () => {
+    const visitors = {
+      DefinitionRoot: {
+        enter: jest.fn(),
+        leave: jest.fn(),
+      },
+      PathMap: {
+        enter: jest.fn(),
+        leave: jest.fn(),
+      },
+      ServerVariableMap: {
+        enter: jest.fn(),
+        leave: jest.fn(),
+      },
+      MediaTypeMap: {
+        enter: jest.fn(),
+        leave: jest.fn(),
+      },
+      ExampleMap: {
+        enter: jest.fn(),
+        leave: jest.fn(),
+      },
+      HeaderMap: {
+        enter: jest.fn(),
+        leave: jest.fn(),
+      },
+    };
+
+    const testRuleSet: Oas3RuleSet = {
+      test: jest.fn(() => {
+        return visitors;
+      }),
+    };
+
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        servers: 
+        - url: http://{test}.url
+          variables:
+            test: test
+        paths: 
+          /test-path: 
+            get:
+              responses:
+                200:
+                  headers: {}
+                  content:
+                    application/json:
+                      schema: {}
+                      examples: {}
+      `,
+      ''
+    );
+
+    await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: makeConfigForRuleset(testRuleSet),
+    });
+
+    expect(testRuleSet.test).toBeCalledTimes(1);
+    for (const fns of Object.values(visitors)) {
+      expect(fns.enter).toBeCalled();
+      expect(fns.leave).toBeCalled();
+    }
+  });
+
   it('should run nested visitors correctly', async () => {
     const calls: string[] = [];
 
@@ -1046,8 +1114,8 @@ describe('walk order', () => {
 
     expect(calls).toMatchInlineSnapshot(`
       Array [
-        "enter DefinitionRoot",
-        "enter PathMap",
+        "enter Root",
+        "enter PathsMap",
         "enter PathItem",
         "enter ParameterList",
         "enter Parameter",
@@ -1066,7 +1134,7 @@ describe('walk order', () => {
         "leave ParameterList",
         "leave Operation",
         "leave PathItem",
-        "leave PathMap",
+        "leave PathsMap",
         "enter Components",
         "enter NamedParameters",
         "leave NamedParameters",
@@ -1075,7 +1143,7 @@ describe('walk order', () => {
         "leave Schema",
         "leave NamedSchemas",
         "leave Components",
-        "leave DefinitionRoot",
+        "leave Root",
       ]
     `);
   });
@@ -1378,10 +1446,10 @@ describe('type extensions', () => {
                   parameters: listOf('Parameter'),
                 },
               },
-              DefinitionRoot: {
-                ...types.DefinitionRoot,
+              Root: {
+                ...types.Root,
                 properties: {
-                  ...types.DefinitionRoot.properties,
+                  ...types.Root.properties,
                   'x-webhooks': 'XWebHooks',
                 },
               },
@@ -1393,7 +1461,7 @@ describe('type extensions', () => {
 
     expect(calls).toMatchInlineSnapshot(`
       Array [
-        "enter DefinitionRoot",
+        "enter Root",
         "enter XWebHooks",
         "enter hook test",
         "enter ParameterList",
@@ -1402,7 +1470,7 @@ describe('type extensions', () => {
         "leave ParameterList",
         "leave hook test",
         "leave XWebHooks",
-        "leave DefinitionRoot",
+        "leave Root",
       ]
     `);
   });

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

@@ -15,7 +15,6 @@ const rebillyDocument = parseYamlToDocument(
 const config = makeConfigForRuleset({
   test: () => {
     return {
-      // @ts-ignore
       Schema(schema, ctx) {
         if (schema.type === 'number') {
           ctx.report({

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

@@ -18,6 +18,6 @@ export function measureAsync() {
   return resolveDocument({
     rootDocument: rebillyDocument,
     externalRefResolver,
-    rootType: normalizeTypes(Oas3Types).DefinitionRoot,
+    rootType: normalizeTypes(Oas3Types).Root,
   });
 }

package/src/bundle.ts

@@ -10,7 +10,7 @@ import { detectOpenAPI, openAPIMajor, OasMajorVersion } from './oas-types';
 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';
@@ -122,7 +122,7 @@ export async function bundleDocument(opts: {
 
   const resolvedRefMap = await resolveDocument({
     rootDocument: document,
-    rootType: types.DefinitionRoot,
+    rootType: types.Root,
     externalRefResolver,
   });
 
@@ -148,7 +148,7 @@ export async function bundleDocument(opts: {
 
   walkDocument({
     document,
-    rootType: types.DefinitionRoot as NormalizedNodeType,
+    rootType: types.Root as NormalizedNodeType,
     normalizedVisitors: bundleVisitor,
     resolvedRefMap,
     ctx,
@@ -158,7 +158,7 @@ export async function bundleDocument(opts: {
     bundle: document,
     problems: ctx.problems.map((problem) => config.addProblemToIgnore(problem)),
     fileDependencies: externalRefResolver.getFiles(),
-    rootType: types.DefinitionRoot,
+    rootType: types.Root,
     refTypes: ctx.refTypes,
     visitorsData: ctx.visitorsData,
   };
@@ -254,7 +254,7 @@ function makeBundleVisitor(
         }
       },
     },
-    DefinitionRoot: {
+    Root: {
       enter(root: any) {
         if (version === OasMajorVersion.Version3) {
           components = root.components = root.components || {};
@@ -302,9 +302,12 @@ 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
     }
   }
 
@@ -348,7 +351,7 @@ function makeBundleVisitor(
 
     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 (

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

@@ -15,20 +15,23 @@ Object {
     "no-invalid-media-type-examples": "error",
     "no-server-example.com": "warn",
     "no-server-trailing-slash": "error",
-    "no-servers-empty-enum": "error",
+    "no-server-variables-empty-enum": "error",
     "no-undefined-server-variable": "error",
     "no-unused-components": "warn",
+    "spec-components-invalid-map-name": "error",
   },
   "oas3_1Decorators": Object {},
   "oas3_1Preprocessors": Object {},
   "oas3_1Rules": Object {
     "no-empty-servers": "error",
     "no-example-value-and-externalValue": "error",
+    "no-invalid-media-type-examples": "error",
     "no-server-example.com": "warn",
     "no-server-trailing-slash": "error",
-    "no-servers-empty-enum": "error",
+    "no-server-variables-empty-enum": "error",
     "no-undefined-server-variable": "error",
     "no-unused-components": "warn",
+    "spec-components-invalid-map-name": "error",
   },
   "preprocessors": Object {},
   "recommendedFallback": false,
@@ -53,7 +56,6 @@ Object {
     "operation-operationId-unique": "error",
     "operation-operationId-url-safe": "error",
     "operation-parameters-unique": "error",
-    "operation-security-defined": "error",
     "operation-singular-tag": "off",
     "operation-summary": "error",
     "operation-tag-defined": "off",
@@ -63,6 +65,7 @@ Object {
     "path-not-include-query": "error",
     "path-parameters-defined": "error",
     "paths-kebab-case": "off",
+    "security-defined": "error",
     "spec": "error",
     "tag-description": "warn",
     "tags-alphabetical": "off",
@@ -85,20 +88,23 @@ Object {
     "no-invalid-media-type-examples": "warn",
     "no-server-example.com": "warn",
     "no-server-trailing-slash": "error",
-    "no-servers-empty-enum": "error",
+    "no-server-variables-empty-enum": "error",
     "no-undefined-server-variable": "error",
     "no-unused-components": "warn",
+    "spec-components-invalid-map-name": "error",
   },
   "oas3_1Decorators": Object {},
   "oas3_1Preprocessors": Object {},
   "oas3_1Rules": Object {
     "no-empty-servers": "error",
     "no-example-value-and-externalValue": "error",
+    "no-invalid-media-type-examples": "warn",
     "no-server-example.com": "warn",
     "no-server-trailing-slash": "error",
-    "no-servers-empty-enum": "error",
+    "no-server-variables-empty-enum": "error",
     "no-undefined-server-variable": "error",
     "no-unused-components": "warn",
+    "spec-components-invalid-map-name": "error",
   },
   "preprocessors": Object {},
   "recommendedFallback": undefined,
@@ -140,7 +146,6 @@ Object {
     "operation-operationId-unique": "error",
     "operation-operationId-url-safe": "error",
     "operation-parameters-unique": "error",
-    "operation-security-defined": "error",
     "operation-singular-tag": "off",
     "operation-summary": "error",
     "operation-tag-defined": "off",
@@ -149,6 +154,7 @@ Object {
     "path-not-include-query": "error",
     "path-parameters-defined": "error",
     "paths-kebab-case": "off",
+    "security-defined": "error",
     "spec": "error",
     "tag-description": "warn",
     "tags-alphabetical": "off",

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

@@ -1,3 +1,4 @@
+import { OasVersion } from '../../oas-types';
 import { Config, StyleguideConfig } from '../config';
 import { getMergedConfig } from '../utils';
 
@@ -242,3 +243,37 @@ describe('getMergedConfig', () => {
     `);
   });
 });
+
+describe('StyleguideConfig.extendTypes', () => {
+  let oas3 = jest.fn();
+  let oas2 = jest.fn();
+  let testRawConfigStyleguide = {
+    plugins: [
+      {
+        id: 'test-types-plugin',
+        typeExtension: {
+          oas3,
+          oas2,
+        },
+      },
+    ],
+  };
+  it('should call only oas3 types extension', () => {
+    const styleguideConfig = new StyleguideConfig(testRawConfigStyleguide);
+    styleguideConfig.extendTypes({}, OasVersion.Version3_0);
+    expect(oas3).toHaveBeenCalledTimes(1);
+    expect(oas2).toHaveBeenCalledTimes(0);
+  });
+  it('should call only oas2 types extension', () => {
+    const styleguideConfig = new StyleguideConfig(testRawConfigStyleguide);
+    styleguideConfig.extendTypes({}, OasVersion.Version2);
+    expect(oas3).toHaveBeenCalledTimes(0);
+    expect(oas2).toHaveBeenCalledTimes(1);
+  });
+  it('should throw error if for oas version different from 2 and 3', () => {
+    const styleguideConfig = new StyleguideConfig(testRawConfigStyleguide);
+    expect(() => styleguideConfig.extendTypes({}, 'something else' as OasVersion)).toThrowError(
+      'Not implemented'
+    );
+  });
+});

package/src/config/__tests__/fixtures/plugin-config.yaml

@@ -1,3 +1,2 @@
-lint:
-  plugins:
-    - './plugin.js'
+plugins:
+  - './plugin.js'

package/src/config/__tests__/fixtures/resolve-config/api/nested-config.yaml

@@ -1,12 +1,11 @@
-lint:
-  plugins:
-    - plugin.js
-  rules:
-    operation-2xx-response: error
-    assert/path-item-get-defined:
-      subject: PathItem
-      property: get
-      message: Every path item must have a GET operation.
-      defined: true
-  extends:
-    - test-plugin-nested/all
+plugins:
+  - plugin.js
+rules:
+  operation-2xx-response: error
+  assert/path-item-get-defined:
+    subject: PathItem
+    property: get
+    message: Every path item must have a GET operation.
+    defined: true
+extends:
+  - test-plugin-nested/all

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

@@ -1,8 +1,7 @@
-lint:
-  extends:
-    - local-config-with-circular.yaml
-  rules:
-    no-invalid-media-type-examples: error
-    operation-description: error
-    path-http-verbs-order: error
-    operation-2xx-response: off
+extends:
+  - local-config-with-circular.yaml
+rules:
+  no-invalid-media-type-examples: error
+  operation-description: error
+  path-http-verbs-order: error
+  operation-2xx-response: off

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

@@ -1,19 +1,18 @@
-lint:
-  rules:
-    no-invalid-media-type-examples: warn
-    operation-4xx-response: off
-    assert/tag-description:
-      subject: Tag
-      property: description
-      message: Tag description must be at least 13 characters and end with a full stop.
-      severity: error
-      minLength: 13
-      pattern: /\.$/
-  plugins:
-    - plugin.js
-    - api/plugin.js
-  extends:
-    - recommended
-    - api/nested-config.yaml
-    - test-plugin-nested/all
-    - test-plugin/all
+rules:
+  no-invalid-media-type-examples: warn
+  operation-4xx-response: off
+  assert/tag-description:
+    subject: Tag
+    property: description
+    message: Tag description must be at least 13 characters and end with a full stop.
+    severity: error
+    minLength: 13
+    pattern: /\.$/
+plugins:
+  - plugin.js
+  - api/plugin.js
+extends:
+  - recommended
+  - api/nested-config.yaml
+  - test-plugin-nested/all
+  - test-plugin/all

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

@@ -1,10 +1,9 @@
-lint:
-  plugins:
-    - plugin.js
-  extends:
-    - test-plugin/all
-  rules:
-    no-invalid-media-type-examples: error
-    operation-description: error
-    path-http-verbs-order: error
-    operation-2xx-response: off
+plugins:
+  - plugin.js
+extends:
+  - test-plugin/all
+rules:
+  no-invalid-media-type-examples: error
+  operation-description: error
+  path-http-verbs-order: error
+  operation-2xx-response: off

package/src/config/__tests__/fixtures/resolve-remote-configs/nested-remote-config.yaml

@@ -1,4 +1,3 @@
-lint:
-  rules:
-    operation-2xx-response: off
-    operation-4xx-response: error
+rules:
+  operation-2xx-response: off
+  operation-4xx-response: error

package/src/config/__tests__/fixtures/resolve-remote-configs/remote-config.yaml

@@ -1,5 +1,4 @@
-lint:
-  extends:
-    - nested-remote-config.yaml
-  rules:
-    operation-2xx-response: error
+extends:
+  - nested-remote-config.yaml
+rules:
+  operation-2xx-response: error

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

@@ -1,5 +1,7 @@
-import { loadConfig, findConfig, getConfig } from '../load';
+import { loadConfig, findConfig, getConfig, createConfig } from '../load';
 import { RedoclyClient } from '../../redocly';
+import { RuleConfig, FlatRawConfig } from './../types';
+import { Config } from '../config';
 
 const fs = require('fs');
 const path = require('path');
@@ -87,3 +89,76 @@ describe('getConfig', () => {
     expect(getConfig()).toEqual(Promise.resolve({}));
   });
 });
+
+describe('createConfig', () => {
+  it('should create config from string', async () => {
+    const config = await createConfig(`
+      extends:
+      - recommended
+      rules:
+        info-license: off
+    `);
+
+    verifyExtendedConfig(config, {
+      extendsRuleSet: 'recommended',
+      overridesRules: { 'info-license': 'off' },
+    });
+  });
+
+  it('should create config from object', async () => {
+    const rawConfig: FlatRawConfig = {
+      extends: ['minimal'],
+      rules: {
+        'info-license': 'off',
+        'tag-description': 'off',
+        'operation-2xx-response': 'off',
+      },
+    };
+    const config = await createConfig(rawConfig);
+
+    verifyExtendedConfig(config, {
+      extendsRuleSet: 'minimal',
+      overridesRules: rawConfig.rules as Record<string, RuleConfig>,
+    });
+  });
+});
+
+function verifyExtendedConfig(
+  config: Config,
+  {
+    extendsRuleSet,
+    overridesRules,
+  }: { extendsRuleSet: string; overridesRules: Record<string, RuleConfig> }
+) {
+  const defaultPlugin = config.styleguide.plugins.find((plugin) => plugin.id === '');
+  expect(defaultPlugin).toBeDefined();
+
+  const recommendedRules = defaultPlugin?.configs?.[extendsRuleSet];
+  expect(recommendedRules).toBeDefined();
+
+  verifyOasRules(config.styleguide.rules.oas2, overridesRules, recommendedRules?.rules || {});
+  verifyOasRules(
+    config.styleguide.rules.oas3_0,
+    overridesRules,
+    Object.assign({}, recommendedRules?.rules, recommendedRules?.oas3_0Rules)
+  );
+  verifyOasRules(
+    config.styleguide.rules.oas3_1,
+    overridesRules,
+    Object.assign({}, recommendedRules?.rules, recommendedRules?.oas3_1Rules)
+  );
+}
+
+function verifyOasRules(
+  finalRuleset: Record<string, RuleConfig>,
+  overridesRules: Record<string, RuleConfig>,
+  defaultRuleset: Record<string, RuleConfig>
+) {
+  Object.entries(finalRuleset).forEach(([ruleName, ruleValue]) => {
+    if (ruleName in overridesRules) {
+      expect(ruleValue).toBe(overridesRules[ruleName]);
+    } else {
+      expect(ruleValue).toBe(defaultRuleset[ruleName]);
+    }
+  });
+}

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

@@ -1,4 +1,4 @@
-import { DeprecatedInRawConfig, RawConfig } from '../types';
+import { DeprecatedInRawConfig, RawConfig, FlatRawConfig } from '../types';
 import * as utils from '../utils';
 
 const makeTestRawConfig = (
@@ -22,8 +22,54 @@ const makeTestRawConfig = (
   },
 });
 
+const rawTestConfig: RawConfig = {
+  apis: {
+    'test@v1': {
+      root: 'root.yaml',
+      styleguide: {
+        extends: ['recommended'],
+        rules: { 'operation-2xx-response': 'error' },
+      },
+    },
+  },
+  styleguide: {
+    plugins: ['test-plugin'],
+    extends: ['minimal'],
+    rules: { 'operation-4xx-response': 'warn' },
+    doNotResolveExamples: true,
+  },
+  resolve: {
+    http: { headers: [{ matches: '*', name: 'all', envVariable: 'all' }] },
+  },
+  'features.openapi': {
+    disableSidebar: true,
+  },
+};
+
+const flatTestConfig: FlatRawConfig = {
+  apis: {
+    'test@v1': {
+      root: 'root.yaml',
+      extends: ['recommended'],
+      rules: { 'operation-2xx-response': 'error' },
+    },
+  },
+  plugins: ['test-plugin'],
+  extends: ['minimal'],
+  rules: {
+    'operation-4xx-response': 'warn',
+  },
+  resolve: {
+    http: { headers: [{ matches: '*', name: 'all', envVariable: 'all' }] },
+    doNotResolveExamples: true,
+  },
+  'features.openapi': {
+    disableSidebar: true,
+  },
+};
+
 describe('transformConfig', () => {
-  it('should work for new syntax', () => {
+  it('should work for the `styleguide` syntax', () => {
     const transformedRawConfig: RawConfig = utils.transformConfig(
       makeTestRawConfig('styleguide', 'styleguide')
     );
@@ -73,11 +119,25 @@ describe('transformConfig', () => {
       }
     `);
   });
-  it('should throw an error if both new and old syntax used together', () => {
+  it('should throw an error if both `styleguide` and `lint` syntaxes used together', () => {
     const testRawConfig = makeTestRawConfig('styleguide', 'lint');
     testRawConfig.apiDefinitions = { legacyApiDefinition: 'file.yaml' };
     expect(() => utils.transformConfig(testRawConfig)).toThrowError(
-      `Do not use 'apiDefinitions' field. Use 'apis' instead.`
+      `Do not use 'apiDefinitions' field. Use 'apis' instead. `
+    );
+  });
+  it('should transform flatten config into styleguide', () => {
+    expect(utils.transformConfig(flatTestConfig)).toEqual({
+      ...rawTestConfig,
+      resolve: { ...rawTestConfig.resolve, doNotResolveExamples: true },
+    });
+  });
+  it('should transform styleguide config into styleguide identically', () => {
+    expect(utils.transformConfig(rawTestConfig)).toEqual(rawTestConfig);
+  });
+  it('should fail when there is a mixed config', () => {
+    expect(() => utils.transformConfig({ ...rawTestConfig, extends: ['recommended'] })).toThrow(
+      `Do not use 'lint', 'styleguide' and flat syntax together. \nSee more about the configuration in the docs: https://redocly.com/docs/cli/configuration/ \n`
     );
   });
 });