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

package/lib/rules/oas3/no-unused-components.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NoUnusedComponents = void 0;
 const NoUnusedComponents = () => {
-    let components = new Map();
+    const components = new Map();
     function registerComponent(location, name) {
         var _a;
         components.set(location.absolutePointer, {

package/lib/rules/oas3/remove-unused-components.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RemoveUnusedComponents = void 0;
 const utils_1 = require("../../utils");
 const RemoveUnusedComponents = () => {
-    let components = new Map();
+    const components = new Map();
     function registerComponent(location, componentType, name) {
         var _a;
         components.set(location.absolutePointer, {
@@ -32,8 +32,8 @@ const RemoveUnusedComponents = () => {
                 data.removedCount = 0;
                 components.forEach((usageInfo) => {
                     const { used, componentType, name } = usageInfo;
-                    if (!used && componentType) {
-                        let componentChild = root.components[componentType];
+                    if (!used && componentType && root.components) {
+                        const componentChild = root.components[componentType];
                         delete componentChild[name];
                         data.removedCount++;
                         if (utils_1.isEmptyObject(componentChild)) {

package/lib/rules/utils.d.ts

@@ -1,7 +1,7 @@
 import { UserContext } from '../walk';
 import { Location } from '../ref-utils';
 import { Oas3Schema, Referenced } from '../typings/openapi';
-export declare function oasTypeOf(value: unknown): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "integer" | "array" | "null";
+export declare function oasTypeOf(value: unknown): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "null" | "integer" | "array";
 /**
  * Checks if value matches specified JSON schema type
  *

package/lib/rules/utils.js

@@ -90,7 +90,7 @@ function validateExample(example, schema, dataLoc, { resolve, location, report }
     try {
         const { valid, errors } = ajv_1.validateJsonSchema(example, schema, location.child('schema'), dataLoc.pointer, resolve, allowAdditionalProperties);
         if (!valid) {
-            for (let error of errors) {
+            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' }),

package/lib/types/redocly-yaml.js

@@ -43,7 +43,7 @@ const builtInRulesList = [
     'no-identical-paths',
     'no-ambiguous-paths',
     'no-undefined-server-variable',
-    'no-servers-empty-enum',
+    'no-server-variables-empty-enum',
     'no-http-verbs-in-paths',
     'path-excludes-patterns',
     'request-mime-type',

package/lib/utils.d.ts

@@ -43,3 +43,6 @@ export declare function isCustomRuleId(id: string): boolean;
 export declare function doesYamlFileExist(filePath: string): boolean;
 export declare function showWarningForDeprecatedField(deprecatedField: string, updatedField: string): void;
 export declare function showErrorForDeprecatedField(deprecatedField: string, updatedField: string): void;
+export declare type Falsy = undefined | null | false | '' | 0;
+export declare function isTruthy<Truthy>(value: Truthy | Falsy): value is Truthy;
+export declare function identity<T>(value: T): T;

package/lib/utils.js

@@ -9,15 +9,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.showErrorForDeprecatedField = exports.showWarningForDeprecatedField = exports.doesYamlFileExist = exports.isCustomRuleId = exports.getMatchingStatusCodeRange = exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
+exports.identity = exports.isTruthy = exports.showErrorForDeprecatedField = exports.showWarningForDeprecatedField = exports.doesYamlFileExist = exports.isCustomRuleId = exports.getMatchingStatusCodeRange = exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
 const fs = require("fs");
 const path_1 = require("path");
 const minimatch = require("minimatch");
 const node_fetch_1 = require("node-fetch");
 const pluralize = require("pluralize");
 const js_yaml_1 = require("./js-yaml");
-const config_1 = require("./config");
-const colorette_1 = require("colorette");
+const env_1 = require("./env");
+const logger_1 = require("./logger");
 var js_yaml_2 = require("./js-yaml");
 Object.defineProperty(exports, "parseYaml", { enumerable: true, get: function () { return js_yaml_2.parseYaml; } });
 Object.defineProperty(exports, "stringifyYaml", { enumerable: true, get: function () { return js_yaml_2.stringifyYaml; } });
@@ -59,7 +59,7 @@ function readFileFromUrl(url, config) {
         for (const header of config.headers) {
             if (match(url, header.matches)) {
                 headers[header.name] =
-                    header.envVariable !== undefined ? config_1.env[header.envVariable] || '' : header.value;
+                    header.envVariable !== undefined ? env_1.env[header.envVariable] || '' : header.value;
             }
         }
         const req = yield (config.customFetch || node_fetch_1.default)(url, {
@@ -90,7 +90,7 @@ exports.omitObjectProps = omitObjectProps;
 function splitCamelCaseIntoWords(str) {
     const camel = str
         .split(/(?:[-._])|([A-Z][a-z]+)/)
-        .filter(Boolean)
+        .filter(isTruthy)
         .map((item) => item.toLocaleLowerCase());
     const caps = str
         .split(/([A-Z]{2,})/)
@@ -168,7 +168,7 @@ function isNotString(value) {
 }
 exports.isNotString = isNotString;
 function assignExisting(target, obj) {
-    for (let k of Object.keys(obj)) {
+    for (const k of Object.keys(obj)) {
         if (target.hasOwnProperty(k)) {
             target[k] = obj[k];
         }
@@ -190,10 +190,18 @@ function doesYamlFileExist(filePath) {
 }
 exports.doesYamlFileExist = doesYamlFileExist;
 function showWarningForDeprecatedField(deprecatedField, updatedField) {
-    process.stderr.write(`The ${colorette_1.yellow(deprecatedField)} field is deprecated. Use ${colorette_1.green(updatedField)} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`);
+    logger_1.logger.warn(`The ${logger_1.colorize.red(deprecatedField)} field is deprecated. Use ${logger_1.colorize.green(updatedField)} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`);
 }
 exports.showWarningForDeprecatedField = showWarningForDeprecatedField;
 function showErrorForDeprecatedField(deprecatedField, updatedField) {
     throw new Error(`Do not use '${deprecatedField}' field. Use '${updatedField}' instead.\n`);
 }
 exports.showErrorForDeprecatedField = showErrorForDeprecatedField;
+function isTruthy(value) {
+    return !!value;
+}
+exports.isTruthy = isTruthy;
+function identity(value) {
+    return value;
+}
+exports.identity = identity;

package/lib/visitors.d.ts

@@ -16,7 +16,7 @@ declare type VisitObject<T> = {
 };
 declare type NestedVisitObject<T, P> = VisitObject<T> & NestedVisitor<P>;
 declare type VisitFunctionOrObject<T> = VisitFunction<T> | VisitObject<T>;
-declare type VisitorNode<T extends any> = {
+declare type VisitorNode<T> = {
     ruleId: string;
     severity: ProblemSeverity;
     context: VisitorLevelContext | VisitorSkippedLevelContext;

package/lib/visitors.js

@@ -30,7 +30,7 @@ function normalizeVisitors(visitorsConfig, types) {
             return;
         stack = [...stack, from];
         const possibleChildren = new Set();
-        for (let type of Object.values(from.properties)) {
+        for (const type of Object.values(from.properties)) {
             if (type === to) {
                 addWeakFromStack(ruleConf, stack);
                 continue;
@@ -55,7 +55,7 @@ function normalizeVisitors(visitorsConfig, types) {
                 possibleChildren.add(from.items);
             }
         }
-        for (let fromType of Array.from(possibleChildren.values())) {
+        for (const fromType of Array.from(possibleChildren.values())) {
             addWeakNodes(ruleConf, fromType, to, parentContext, stack);
         }
         function addWeakFromStack(ruleConf, stack) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.0-beta.107",
+  "version": "1.0.0-beta.108",
   "description": "",
   "main": "lib/index.js",
   "engines": {

package/src/__tests__/logger-browser.test.ts

@@ -0,0 +1,53 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import * as colorette from 'colorette';
+import { logger, colorize } from '../logger';
+
+describe('Logger in Browser', () => {
+  it('should call "console.error"', () => {
+    const error = jest.spyOn(console, 'error').mockImplementation();
+
+    logger.error('error');
+
+    expect(error).toBeCalledTimes(1);
+    expect(error).toBeCalledWith('error');
+
+    error.mockRestore();
+  });
+
+  it('should call "console.log"', () => {
+    const log = jest.spyOn(console, 'log').mockImplementation();
+
+    logger.info('info');
+
+    expect(log).toBeCalledTimes(1);
+    expect(log).toBeCalledWith('info');
+
+    log.mockRestore();
+  });
+
+  it('should call "console.warn"', () => {
+    const warn = jest.spyOn(console, 'warn').mockImplementation();
+
+    logger.warn('warn');
+
+    expect(warn).toBeCalledTimes(1);
+    expect(warn).toBeCalledWith('warn');
+
+    warn.mockRestore();
+  });
+});
+
+describe('colorize in Browser', () => {
+  it('should not call original colorette lib', () => {
+    const color = 'cyan';
+    const spyingCyan = jest.spyOn(colorette, color);
+
+    const colorized = colorize.cyan(color);
+
+    expect(spyingCyan).not.toBeCalled();
+    expect(colorized).toEqual(color);
+  });
+});

package/src/__tests__/logger.test.ts

@@ -0,0 +1,47 @@
+import * as colorette from 'colorette';
+import { logger, colorize } from '../logger';
+
+describe('Logger in nodejs', () => {
+  let spyingStderr: jest.SpyInstance;
+
+  beforeEach(() => {
+    spyingStderr = jest.spyOn(process.stderr, 'write').mockImplementation();
+  });
+
+  afterEach(() => {
+    spyingStderr.mockRestore();
+  });
+
+  it('should call "process.stderr.write" for error severity', () => {
+    logger.error('error');
+
+    expect(spyingStderr).toBeCalledTimes(1);
+    expect(spyingStderr).toBeCalledWith(colorette.red('error'));
+  });
+
+  it('should call "process.stderr.write" for warn severity', () => {
+    logger.warn('warn');
+
+    expect(spyingStderr).toBeCalledTimes(1);
+    expect(spyingStderr).toBeCalledWith(colorette.yellow('warn'));
+  });
+
+  it('should call "process.stderr.write" for info severity', () => {
+    logger.info('info');
+
+    expect(spyingStderr).toBeCalledTimes(1);
+    expect(spyingStderr).toBeCalledWith('info');
+  });
+});
+
+describe('colorize in nodejs', () => {
+  it('should call original colorette lib', () => {
+    const color = 'cyan';
+    const spyingCyan = jest.spyOn(colorette, color);
+
+    const colorized = colorize.cyan(color);
+
+    expect(spyingCyan).toBeCalledWith(color);
+    expect(colorized).toEqual(colorette[color](color));
+  });
+});

package/src/__tests__/output-browser.test.ts

@@ -0,0 +1,18 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import { output } from '../output';
+
+describe('output', () => {
+  it('should ignore all parsable data in browser', () => {
+    const spyingStdout = jest.spyOn(process.stdout, 'write').mockImplementation();
+    const data = '{ "errors" : [] }';
+
+    output.write(data);
+
+    expect(spyingStdout).not.toBeCalled();
+
+    spyingStdout.mockRestore();
+  });
+});

package/src/__tests__/output.test.ts

@@ -0,0 +1,15 @@
+import { output } from '../output';
+
+describe('output', () => {
+  it('should write all parsable data to stdout', () => {
+    const spyingStdout = jest.spyOn(process.stdout, 'write').mockImplementation();
+    const data = '{ "errors" : [] }';
+
+    output.write(data);
+
+    expect(spyingStdout).toBeCalledTimes(1);
+    expect(spyingStdout).toBeCalledWith(data);
+
+    spyingStdout.mockRestore();
+  });
+});

package/src/__tests__/utils-browser.test.ts

@@ -0,0 +1,11 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import { isBrowser } from '../env';
+
+describe('isBrowser', () => {
+  it('should be browser', () => {
+    expect(isBrowser).toBe(true);
+  });
+});

package/src/__tests__/utils.test.ts

@@ -5,6 +5,7 @@ import {
   getMatchingStatusCodeRange,
   doesYamlFileExist,
 } from '../utils';
+import { isBrowser } from '../env';
 import * as fs from 'fs';
 import * as path from 'path';
 
@@ -122,5 +123,11 @@ describe('utils', () => {
         expect(doesYamlFileExist('redocly.yam')).toBe(false);
       });
     });
+
+    describe('isBrowser', () => {
+      it('should not be browser', () => {
+        expect(isBrowser).toBe(false);
+      });
+    });
   });
 });

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/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';
@@ -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,7 +15,7 @@ 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",
   },
@@ -27,7 +27,7 @@ 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",
   },
@@ -86,7 +86,7 @@ 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",
   },
@@ -98,7 +98,7 @@ 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",
   },

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__/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, RawConfig } from './../types';
+import { Config } from '../config';
 
 const fs = require('fs');
 const path = require('path');
@@ -87,3 +89,79 @@ describe('getConfig', () => {
     expect(getConfig()).toEqual(Promise.resolve({}));
   });
 });
+
+describe('createConfig', () => {
+  it('should create config from string', async () => {
+    const config = await createConfig(`
+      styleguide:
+        extends:
+          - recommended
+        rules:
+          info-license: off
+    `);
+
+    verifyExtendedConfig(config, {
+      extendsRuleSet: 'recommended',
+      overridesRules: { 'info-license': 'off' },
+    });
+  });
+
+  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 config = await createConfig(rawConfig);
+
+    verifyExtendedConfig(config, {
+      extendsRuleSet: 'minimal',
+      overridesRules: rawConfig.styleguide!.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/all.ts

@@ -51,7 +51,7 @@ export default {
     'no-example-value-and-externalValue': 'error',
     'no-unused-components': 'error',
     'no-undefined-server-variable': 'error',
-    'no-servers-empty-enum': 'error',
+    'no-server-variables-empty-enum': 'error',
   },
   oas3_1Rules: {
     'no-server-example.com': 'error',
@@ -60,6 +60,6 @@ export default {
     'no-example-value-and-externalValue': 'error',
     'no-unused-components': 'error',
     'no-undefined-server-variable': 'error',
-    'no-servers-empty-enum': 'error',
+    'no-server-variables-empty-enum': 'error',
   },
 } as PluginStyleguideConfig;