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

package/lib/rules/common/assertions/utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.regexFromString = exports.isOrdered = exports.getIntersectionLength = exports.buildSubjectVisitor = exports.buildVisitorObject = void 0;
+const logger_1 = require("../../../logger");
 const ref_utils_1 = require("../../../ref-utils");
 const asserts_1 = require("./asserts");
 function buildVisitorObject(subject, context, subjectVisitor) {
@@ -44,14 +45,15 @@ function buildVisitorObject(subject, context, subjectVisitor) {
     return visitor;
 }
 exports.buildVisitorObject = buildVisitorObject;
-function buildSubjectVisitor(properties, asserts, context) {
+function buildSubjectVisitor(assertId, assertion, asserts) {
     return (node, { report, location, rawLocation, key, type, resolve, rawNode }) => {
         var _a;
+        let properties = assertion.property;
         // We need to check context's last node if it has the same type as subject node;
         // if yes - that means we didn't create context's last node visitor,
         // so we need to handle 'matchParentKeys' and 'excludeParentKeys' conditions here;
-        if (context) {
-            const lastContextNode = context[context.length - 1];
+        if (assertion.context) {
+            const lastContextNode = assertion.context[assertion.context.length - 1];
             if (lastContextNode.type === type.name) {
                 const matchParentKeys = lastContextNode.matchParentKeys;
                 const excludeParentKeys = lastContextNode.excludeParentKeys;
@@ -66,35 +68,55 @@ function buildSubjectVisitor(properties, asserts, context) {
         if (properties) {
             properties = Array.isArray(properties) ? properties : [properties];
         }
+        const defaultMessage = `${logger_1.colorize.blue(assertId)} failed because the ${logger_1.colorize.blue(assertion.subject)}${logger_1.colorize.blue(properties ? ` ${properties.join(', ')}` : '')} didn't meet the assertions: {{problems}}`;
+        const assertResults = [];
         for (const assert of asserts) {
             const currentLocation = assert.name === 'ref' ? rawLocation : location;
             if (properties) {
                 for (const property of properties) {
                     // we can have resolvable scalar so need to resolve value here.
                     const value = ref_utils_1.isRef(node[property]) ? (_a = resolve(node[property])) === null || _a === void 0 ? void 0 : _a.node : node[property];
-                    runAssertion({
+                    assertResults.push(runAssertion({
                         values: value,
                         rawValues: rawNode[property],
                         assert,
                         location: currentLocation.child(property),
-                        report,
-                    });
+                    }));
                 }
             }
             else {
                 const value = assert.name === 'ref' ? rawNode : Object.keys(node);
-                runAssertion({
+                assertResults.push(runAssertion({
                     values: Object.keys(node),
                     rawValues: value,
                     assert,
                     location: currentLocation,
-                    report,
-                });
+                }));
             }
         }
+        const problems = assertResults.flat();
+        if (problems.length) {
+            const message = assertion.message || defaultMessage;
+            report({
+                message: message.replace('{{problems}}', getProblemsMessage(problems)),
+                location: getProblemsLocation(problems) || location,
+                forceSeverity: assertion.severity || 'error',
+                suggest: assertion.suggest || [],
+                ruleId: assertId,
+            });
+        }
     };
 }
 exports.buildSubjectVisitor = buildSubjectVisitor;
+function getProblemsLocation(problems) {
+    return problems.length ? problems[0].location : undefined;
+}
+function getProblemsMessage(problems) {
+    var _a;
+    return problems.length === 1
+        ? (_a = problems[0].message) !== null && _a !== void 0 ? _a : ''
+        : problems.map((problem) => { var _a; return `\n- ${(_a = problem.message) !== null && _a !== void 0 ? _a : ''}`; }).join('');
+}
 function getIntersectionLength(keys, properties) {
     const props = new Set(properties);
     let count = 0;
@@ -127,17 +149,8 @@ function isOrdered(value, options) {
     return true;
 }
 exports.isOrdered = isOrdered;
-function runAssertion({ values, rawValues, assert, location, report }) {
-    const lintResult = asserts_1.asserts[assert.name](values, assert.conditions, location, rawValues);
-    if (!lintResult.isValid) {
-        report({
-            message: assert.message || `The ${assert.assertId} doesn't meet required conditions`,
-            location: lintResult.location || location,
-            forceSeverity: assert.severity,
-            suggest: assert.suggest,
-            ruleId: assert.assertId,
-        });
-    }
+function runAssertion({ values, rawValues, assert, location }) {
+    return asserts_1.asserts[assert.name](values, assert.conditions, location, rawValues);
 }
 function regexFromString(input) {
     const matches = input.match(/^\/(.*)\/(.*)|(.*)/);

package/lib/rules/utils.js

@@ -93,7 +93,7 @@ function validateExample(example, schema, dataLoc, { resolve, location, report }
             for (const error of errors) {
                 report({
                     message: `Example value must conform to the schema: ${error.message}.`,
-                    location: Object.assign(Object.assign({}, new ref_utils_1.Location(dataLoc.source, error.instancePath)), { reportOnKey: error.keyword === 'additionalProperties' }),
+                    location: Object.assign(Object.assign({}, new ref_utils_1.Location(dataLoc.source, error.instancePath)), { reportOnKey: error.keyword === 'unevaluatedProperties' || error.keyword === 'additionalProperties' }),
                     from: location,
                     suggest: error.suggest,
                 });

package/lib/types/redocly-yaml.js

@@ -149,6 +149,11 @@ const ConfigRoot = {
                 http: 'ConfigHTTP',
                 doNotResolveExamples: { type: 'boolean' },
             },
+        }, files: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
         } }),
 };
 const ConfigApis = {
@@ -161,7 +166,12 @@ const ConfigApisProperties = {
             items: {
                 type: 'string',
             },
-        }, lint: 'ConfigStyleguide', styleguide: 'ConfigStyleguide' }, ConfigStyleguide.properties), { 'features.openapi': 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer' }),
+        }, lint: 'ConfigStyleguide', styleguide: 'ConfigStyleguide' }, ConfigStyleguide.properties), { 'features.openapi': 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer', files: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        } }),
     required: ['root'],
 };
 const ConfigHTTP = {
@@ -249,6 +259,11 @@ const Assert = {
         maxLength: { type: 'integer' },
         ref: (value) => typeof value === 'string' ? { type: 'string' } : { type: 'boolean' },
     },
+    additionalProperties: (_value, key) => {
+        if (/^\w+\/\w+$/.test(key))
+            return { type: 'object' };
+        return;
+    },
     required: ['subject'],
 };
 const Context = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.0-beta.109",
+  "version": "1.0.0-beta.110",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -29,12 +29,10 @@
     "oas"
   ],
   "contributors": [
-    "Sergey Dubovyk <serhii@redoc.ly> (https://redoc.ly/)",
-    "Roman Hotsiy <roman@redoc.ly> (https://redoc.ly/)",
-    "Andriy Leliv <andriy@redoc.ly> (https://redoc.ly/)"
+    "Roman Hotsiy <roman@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/ajv": "^8.6.5",
+    "@redocly/ajv": "^8.11.0",
     "@types/node": "^14.11.8",
     "colorette": "^1.2.0",
     "js-levenshtein": "^1.1.6",

package/src/__tests__/lint.test.ts

@@ -60,6 +60,22 @@ describe('lint', () => {
           no-invalid-media-type-examples: error
           path-http-verbs-order: error
           boolean-parameter-prefixes: off
+          assert/operation-summary-length:
+            subject: Operation
+            property: summary
+            message: Operation summary should start with an active verb
+            local/checkWordsCount: 
+              min: 3
+      features.openapi:
+        showConsole: true
+        layout:
+          scope: section
+        routingStrategy: browser
+        theme:
+          rightPanel:
+            backgroundColor: '#263238'
+          links:
+            color: '#6CC496'
         features.openapi:
           showConsole: true
           layout:
@@ -77,6 +93,78 @@ describe('lint', () => {
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/atures.openapi",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`atures.openapi\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [
+            "features.openapi",
+          ],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/showConsole",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`showConsole\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/layout",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`layout\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/routingStrategy",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`routingStrategy\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/theme",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`theme\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
         Object {
           "from": undefined,
           "location": Array [

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/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-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/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__/load.test.ts

@@ -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();
   });
 });

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/config-resolvers.ts

@@ -24,6 +24,7 @@ import { isBrowser } from '../env';
 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,6 +176,10 @@ export function resolvePlugins(
         }
       }
 
+      if (pluginModule.assertions) {
+        plugin.assertions = pluginModule.assertions;
+      }
+
       return plugin;
     })
     .filter(isDefined);
@@ -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/', ''),

package/src/config/config.ts

@@ -306,6 +306,7 @@ export class Config {
   'features.openapi': Record<string, any>;
   'features.mockServer'?: Record<string, any>;
   organization?: string;
+  files: string[];
   constructor(public rawConfig: ResolvedConfig, public configFile?: string) {
     this.apis = rawConfig.apis || {};
     this.styleguide = new StyleguideConfig(rawConfig.styleguide || {}, configFile);
@@ -314,5 +315,6 @@ export class Config {
     this.resolve = getResolveConfig(rawConfig?.resolve);
     this.region = rawConfig.region;
     this.organization = rawConfig.organization;
+    this.files = rawConfig.files || [];
   }
 }

package/src/config/load.ts

@@ -62,11 +62,17 @@ async function addConfigMetadata({
 }
 
 export async function loadConfig(
-  configPath: string | undefined = findConfig(),
-  customExtends?: string[],
-  processRawConfig?: (rawConfig: RawConfig) => void | Promise<void>
+  options: {
+    configPath?: string;
+    customExtends?: string[];
+    processRawConfig?: (rawConfig: RawConfig) => void | Promise<void>;
+    files?: string[];
+    region?: Region;
+  } = {}
 ): Promise<Config> {
-  const rawConfig = await getConfig(configPath);
+  const { configPath = findConfig(), customExtends, processRawConfig, files, region } = options;
+  const config = await getConfig(configPath);
+  const rawConfig = { ...config, files: files ?? config.files, region: region ?? config.region };
   if (typeof processRawConfig === 'function') {
     await processRawConfig(rawConfig);
   }

package/src/config/types.ts

@@ -10,6 +10,7 @@ import type {
   OasVersion,
 } from '../oas-types';
 import type { NodeType } from '../types';
+import { Location } from '../ref-utils';
 
 export type RuleSeverity = ProblemSeverity | 'off';
 
@@ -83,6 +84,15 @@ export type CustomRulesConfig = {
   oas2?: Oas2RuleSet;
 };
 
+export type AssertResult = { message?: string; location?: Location };
+export type CustomFunction = (
+  value: any,
+  options: unknown,
+  baseLocation: Location
+) => AssertResult[];
+
+export type AssertionsConfig = Record<string, CustomFunction>;
+
 export type Plugin = {
   id: string;
   configs?: Record<string, PluginStyleguideConfig>;
@@ -90,6 +100,7 @@ export type Plugin = {
   preprocessors?: PreprocessorsConfig;
   decorators?: DecoratorsConfig;
   typeExtension?: TypeExtensionsConfig;
+  assertions?: AssertionsConfig;
 };
 
 export type PluginStyleguideConfig = Omit<StyleguideRawConfig, 'plugins' | 'extends'>;
@@ -145,6 +156,7 @@ export type DeprecatedInApi = {
 
 export type ResolvedApi = Omit<Api, 'styleguide'> & {
   styleguide: ResolvedStyleguideConfig;
+  files?: string[];
 };
 
 export type RawConfig = {
@@ -153,6 +165,7 @@ export type RawConfig = {
   resolve?: RawResolveConfig;
   region?: Region;
   organization?: string;
+  files?: string[];
 } & FeaturesConfig;
 
 export type FlatApi = Omit<Api, 'styleguide'> &

package/src/config/utils.ts

@@ -233,6 +233,7 @@ export function getMergedConfig(config: Config, apiName?: string): Config {
             ...config['features.mockServer'],
             ...config.apis[apiName]?.['features.mockServer'],
           },
+          files: [...config.files, ...(config.apis?.[apiName]?.files ?? [])],
           // TODO: merge everything else here
         },
         config.configFile

package/src/rules/ajv.ts

@@ -1,4 +1,4 @@
-import Ajv, { ValidateFunction, ErrorObject } from '@redocly/ajv';
+import Ajv, { ValidateFunction, ErrorObject } from '@redocly/ajv/dist/2020';
 import { Location, escapePointer } from '../ref-utils';
 import { ResolveFn } from '../walk';
 
@@ -20,7 +20,7 @@ function getAjv(resolve: ResolveFn, allowAdditionalProperties: boolean) {
       discriminator: true,
       allowUnionTypes: true,
       validateFormats: false, // TODO: fix it
-      defaultAdditionalProperties: allowAdditionalProperties,
+      defaultUnevaluatedProperties: allowAdditionalProperties,
       loadSchemaSync(base: string, $ref: string) {
         const resolvedRef = resolve({ $ref }, base.split('#')[0]);
         if (!resolvedRef || !resolvedRef.location) return false;
@@ -87,8 +87,8 @@ export function validateJsonSchema(
     if (propName) {
       message = `\`${propName}\` property ${message}`;
     }
-    if (error.keyword === 'additionalProperties') {
-      const property = error.params.additionalProperty;
+    if (error.keyword === 'additionalProperties' || error.keyword === 'unevaluatedProperties') {
+      const property = error.params.additionalProperty || error.params.unevaluatedProperty;
       message = `${message} \`${property}\``;
       error.instancePath += '/' + escapePointer(property);
     }