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

package/src/bundle.ts

@@ -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 || {};

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

@@ -18,6 +18,7 @@ Object {
     "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 {},
@@ -30,6 +31,7 @@ Object {
     "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,
@@ -54,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",
@@ -64,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",
@@ -89,6 +91,7 @@ Object {
     "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 {},
@@ -101,6 +104,7 @@ Object {
     "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,
@@ -142,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",
@@ -151,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-resolvers.test.ts

@@ -1,3 +1,5 @@
+import { colorize } from '../../logger';
+import { asserts } from '../../rules/common/assertions/asserts';
 import { resolveStyleguideConfig, resolveApis, resolveConfig } from '../config-resolvers';
 const path = require('path');
 
@@ -130,6 +132,40 @@ describe('resolveStyleguideConfig', () => {
     expect(styleguide).toMatchSnapshot();
   });
 
+  it('should resolve custom assertion from plugin', async () => {
+    const styleguideConfig = {
+      extends: ['local-config-with-custom-function.yaml'],
+    };
+    const { plugins } = await resolveStyleguideConfig({
+      styleguideConfig,
+      configPath,
+    });
+
+    expect(plugins).toBeDefined();
+    expect(plugins?.length).toBe(2);
+    expect(asserts['test-plugin/checkWordsCount']).toBeDefined();
+  });
+
+  it('should throw error when custom assertion load not exist plugin', async () => {
+    const styleguideConfig = {
+      extends: ['local-config-with-wrong-custom-function.yaml'],
+    };
+    try {
+      await resolveStyleguideConfig({
+        styleguideConfig,
+        configPath,
+      });
+    } catch (e) {
+      expect(e.message.toString()).toContain(
+        `Plugin ${colorize.red(
+          'test-plugin'
+        )} doesn't export assertions function with name ${colorize.red('checkWordsCount2')}.`
+      );
+    }
+
+    expect(asserts['test-plugin/checkWordsCount']).toBeDefined();
+  });
+
   it('should correctly merge assertions from nested config', async () => {
     const styleguideConfig = {
       extends: ['local-config-with-file.yaml'],
@@ -165,7 +201,7 @@ describe('resolveStyleguideConfig', () => {
     const styleguideConfig = {
       // This points to ./fixtures/resolve-remote-configs/remote-config.yaml
       extends: [
-        'https://raw.githubusercontent.com/Redocly/redocly-cli/master/packages/core/src/config/__tests__/fixtures/resolve-remote-configs/remote-config.yaml',
+        'https://raw.githubusercontent.com/Redocly/redocly-cli/main/packages/core/src/config/__tests__/fixtures/resolve-remote-configs/remote-config.yaml',
       ],
     };
 

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

@@ -48,6 +48,7 @@ const testConfig: Config = {
   'features.mockServer': {},
   resolve: { http: { headers: [] } },
   organization: 'redocly-test',
+  files: [],
 };
 
 describe('getMergedConfig', () => {
@@ -67,6 +68,7 @@ describe('getMergedConfig', () => {
         "configFile": "redocly.yaml",
         "features.mockServer": Object {},
         "features.openapi": Object {},
+        "files": Array [],
         "organization": "redocly-test",
         "rawConfig": Object {
           "apis": Object {
@@ -81,6 +83,7 @@ describe('getMergedConfig', () => {
           },
           "features.mockServer": Object {},
           "features.openapi": Object {},
+          "files": Array [],
           "organization": "redocly-test",
           "styleguide": Object {
             "extendPaths": Array [],
@@ -163,6 +166,7 @@ describe('getMergedConfig', () => {
         "configFile": "redocly.yaml",
         "features.mockServer": Object {},
         "features.openapi": Object {},
+        "files": Array [],
         "organization": "redocly-test",
         "rawConfig": Object {
           "apis": Object {
@@ -177,6 +181,7 @@ describe('getMergedConfig', () => {
           },
           "features.mockServer": Object {},
           "features.openapi": Object {},
+          "files": Array [],
           "organization": "redocly-test",
           "styleguide": Object {
             "extendPaths": Array [],

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-custom-function.yaml

@@ -0,0 +1,16 @@
+lint:
+  rules:
+    no-invalid-media-type-examples: warn
+    operation-4xx-response: off
+    assert/tag-description:
+      subject: Tag
+      property: description
+      message: Tag description must have at least 3 words.
+      severity: error
+      test-plugin/checkWordsCount:
+        min: 3
+  plugins:
+    - plugin.js
+  extends:
+    - recommended
+    - test-plugin/all

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-with-wrong-custom-function.yaml

@@ -0,0 +1,16 @@
+lint:
+  rules:
+    no-invalid-media-type-examples: warn
+    operation-4xx-response: off
+    assert/tag-description:
+      subject: Tag
+      property: description
+      message: Tag description must have at least 3 words.
+      severity: error
+      test-plugin/checkWordsCount2:
+        min: 3
+  plugins:
+    - plugin.js
+  extends:
+    - recommended
+    - 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-config/plugin.js

@@ -51,6 +51,16 @@ const decorators = {
   },
 };
 
+const assertions = {
+  checkWordsCount: (value, opts, location) => {
+    const words = value.split(' ');
+    if (words.length >= opts.min) {
+      return { isValid: true };
+    }
+    return { isValid: false, location };
+  },
+};
+
 const configs = {
   all: {
     rules: {
@@ -66,4 +76,5 @@ module.exports = {
   rules,
   decorators,
   configs,
+  assertions,
 };

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,6 +1,6 @@
 import { loadConfig, findConfig, getConfig, createConfig } from '../load';
 import { RedoclyClient } from '../../redocly';
-import { RuleConfig, RawConfig } from './../types';
+import { RuleConfig, FlatRawConfig } from './../types';
 import { Config } from '../config';
 
 const fs = require('fs');
@@ -49,7 +49,7 @@ describe('loadConfig', () => {
 
   it('should call callback if such passed', async () => {
     const mockFn = jest.fn();
-    await loadConfig(undefined, undefined, mockFn);
+    await loadConfig({ processRawConfig: mockFn });
     expect(mockFn).toHaveBeenCalled();
   });
 });
@@ -93,11 +93,10 @@ describe('getConfig', () => {
 describe('createConfig', () => {
   it('should create config from string', async () => {
     const config = await createConfig(`
-      styleguide:
-        extends:
-          - recommended
-        rules:
-          info-license: off
+      extends:
+      - recommended
+      rules:
+        info-license: off
     `);
 
     verifyExtendedConfig(config, {
@@ -107,21 +106,19 @@ describe('createConfig', () => {
   });
 
   it('should create config from object', async () => {
-    const rawConfig: RawConfig = {
-      styleguide: {
-        extends: ['minimal'],
-        rules: {
-          'info-license': 'off',
-          'tag-description': 'off',
-          'operation-2xx-response': 'off',
-        },
+    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.styleguide!.rules as Record<string, RuleConfig>,
+      overridesRules: rawConfig.rules as Record<string, RuleConfig>,
     });
   });
 });

package/src/config/__tests__/resolve-plugins.test.ts

@@ -5,21 +5,21 @@ describe('resolving a plugin', () => {
   const configPath = path.join(__dirname, 'fixtures/plugin-config.yaml');
 
   it('should prefix rule names with the plugin id', async () => {
-    const config = await loadConfig(configPath);
+    const config = await loadConfig({ configPath });
     const plugin = config.styleguide.plugins[0];
 
     expect(plugin.rules?.oas3).toHaveProperty('test-plugin/openid-connect-url-well-known');
   });
 
   it('should prefix preprocessor names with the plugin id', async () => {
-    const config = await loadConfig(configPath);
+    const config = await loadConfig({ configPath });
     const plugin = config.styleguide.plugins[0];
 
     expect(plugin.preprocessors?.oas2).toHaveProperty('test-plugin/description-preprocessor');
   });
 
   it('should prefix decorator names with the plugin id', async () => {
-    const config = await loadConfig(configPath);
+    const config = await loadConfig({ configPath });
     const plugin = config.styleguide.plugins[0];
 
     expect(plugin.decorators?.oas3).toHaveProperty('test-plugin/inject-x-stats');

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`
     );
   });
 });

package/src/config/all.ts

@@ -26,7 +26,7 @@ export default {
     'operation-operationId-url-safe': 'error',
     'operation-parameters-unique': 'error',
     'operation-tag-defined': 'error',
-    'operation-security-defined': 'error',
+    'security-defined': 'error',
     'operation-singular-tag': 'error',
     'no-unresolved-refs': 'error',
     'no-enum-type-mismatch': 'error',
@@ -52,6 +52,7 @@ export default {
     'no-unused-components': 'error',
     'no-undefined-server-variable': 'error',
     'no-server-variables-empty-enum': 'error',
+    'operation-4xx-problem-details-rfc7807': 'error',
   },
   oas3_1Rules: {
     'no-server-example.com': 'error',
@@ -61,5 +62,6 @@ export default {
     'no-unused-components': 'error',
     'no-undefined-server-variable': 'error',
     'no-server-variables-empty-enum': 'error',
+    'operation-4xx-problem-details-rfc7807': 'error',
   },
 } as PluginStyleguideConfig;

package/src/config/config-resolvers.ts

@@ -21,9 +21,10 @@ import type {
   DeprecatedInRawConfig,
 } from './types';
 import { isBrowser } from '../env';
-import { isNotString, isString, notUndefined, parseYaml } from '../utils';
+import { isNotString, isString, isDefined, parseYaml } from '../utils';
 import { Config } from './config';
 import { colorize, logger } from '../logger';
+import { asserts, buildAssertCustomFunction } from '../rules/common/assertions/asserts';
 
 export async function resolveConfig(rawConfig: RawConfig, configPath?: string): Promise<Config> {
   if (rawConfig.styleguide?.extends?.some(isNotString)) {
@@ -175,9 +176,13 @@ export function resolvePlugins(
         }
       }
 
+      if (pluginModule.assertions) {
+        plugin.assertions = pluginModule.assertions;
+      }
+
       return plugin;
     })
-    .filter(notUndefined);
+    .filter(isDefined);
 }
 
 export async function resolveApis({
@@ -299,8 +304,7 @@ export async function resolveStyleguideConfig(
   return {
     ...resolvedStyleguideConfig,
     rules:
-      resolvedStyleguideConfig.rules &&
-      groupStyleguideAssertionRules(resolvedStyleguideConfig.rules),
+      resolvedStyleguideConfig.rules && groupStyleguideAssertionRules(resolvedStyleguideConfig),
   };
 }
 
@@ -392,9 +396,10 @@ function getMergedRawStyleguideConfig(
   return resultLint;
 }
 
-function groupStyleguideAssertionRules(
-  rules: Record<string, RuleConfig> | undefined
-): Record<string, RuleConfig> | undefined {
+function groupStyleguideAssertionRules({
+  rules,
+  plugins,
+}: ResolvedStyleguideConfig): Record<string, RuleConfig> | undefined {
   if (!rules) {
     return rules;
   }
@@ -407,6 +412,24 @@ function groupStyleguideAssertionRules(
   for (const [ruleKey, rule] of Object.entries(rules)) {
     if (ruleKey.startsWith('assert/') && typeof rule === 'object' && rule !== null) {
       const assertion = rule;
+      if (plugins) {
+        for (const field of Object.keys(assertion)) {
+          const [pluginId, fn] = field.split('/');
+          if (!pluginId || !fn) continue;
+          const plugin = plugins.find((plugin) => plugin.id === pluginId);
+          if (!plugin) {
+            throw Error(colorize.red(`Plugin ${colorize.blue(pluginId)} isn't found.`));
+          }
+          if (!plugin.assertions || !plugin.assertions[fn]) {
+            throw Error(
+              `Plugin ${colorize.red(
+                pluginId
+              )} doesn't export assertions function with name ${colorize.red(fn)}.`
+            );
+          }
+          asserts[field] = buildAssertCustomFunction(plugin.assertions[fn]);
+        }
+      }
       assertions.push({
         ...assertion,
         assertionId: ruleKey.replace('assert/', ''),