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

package/lib/utils.js

@@ -9,14 +9,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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.isDefined = 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 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; } });
@@ -36,10 +37,10 @@ function loadYaml(filename) {
     });
 }
 exports.loadYaml = loadYaml;
-function notUndefined(x) {
+function isDefined(x) {
     return x !== undefined;
 }
-exports.notUndefined = notUndefined;
+exports.isDefined = isDefined;
 function isPlainObject(value) {
     return value !== null && typeof value === 'object' && !Array.isArray(value);
 }
@@ -58,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, {
@@ -89,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,})/)
@@ -167,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];
         }
@@ -188,3 +189,19 @@ function doesYamlFileExist(filePath) {
         fs.existsSync(filePath));
 }
 exports.doesYamlFileExist = doesYamlFileExist;
+function showWarningForDeprecatedField(deprecatedField, updatedField) {
+    logger_1.logger.warn(`The '${logger_1.colorize.red(deprecatedField)}' field is deprecated. ${updatedField ? `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. ${updatedField ? `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

@@ -1,9 +1,9 @@
 import type { Oas3Definition, Oas3ExternalDocs, Oas3Info, Oas3Contact, Oas3Components, Oas3License, Oas3Schema, Oas3Header, Oas3Parameter, Oas3Operation, Oas3PathItem, Oas3ServerVariable, Oas3Server, Oas3MediaType, Oas3Response, Oas3Example, Oas3RequestBody, Oas3Tag, OasRef, Oas3SecurityScheme, Oas3SecurityRequirement, Oas3Encoding, Oas3Link, Oas3Xml, Oas3Discriminator, Oas3Callback } from './typings/openapi';
-import { Oas2Definition, Oas2Tag, Oas2ExternalDocs, Oas2SecurityRequirement, Oas2Info, Oas2Contact, Oas2License, Oas2PathItem, Oas2Operation, Oas2Header, Oas2Response, Oas2Schema, Oas2Xml, Oas2Parameter, Oas2SecurityScheme } from './typings/swagger';
-import { NormalizedNodeType } from './types';
-import { Stack } from './utils';
-import { UserContext, ResolveResult, ProblemSeverity } from './walk';
-import { Location } from './ref-utils';
+import type { Oas2Definition, Oas2Tag, Oas2ExternalDocs, Oas2SecurityRequirement, Oas2Info, Oas2Contact, Oas2License, Oas2PathItem, Oas2Operation, Oas2Header, Oas2Response, Oas2Schema, Oas2Xml, Oas2Parameter, Oas2SecurityScheme } from './typings/swagger';
+import type { NormalizedNodeType } from './types';
+import type { Stack } from './utils';
+import type { UserContext, ResolveResult, ProblemSeverity } from './walk';
+import type { Location } from './ref-utils';
 export declare type VisitFunction<T> = (node: T, ctx: UserContext & {
     ignoreNextVisitorsOnNode: () => void;
 }, parents?: any, context?: any) => void;
@@ -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;
@@ -61,7 +61,7 @@ export declare type BaseVisitor = {
     } | VisitRefFunction;
 };
 declare type Oas3FlatVisitor = {
-    DefinitionRoot?: VisitFunctionOrObject<Oas3Definition>;
+    Root?: VisitFunctionOrObject<Oas3Definition>;
     Tag?: VisitFunctionOrObject<Oas3Tag>;
     ExternalDocs?: VisitFunctionOrObject<Oas3ExternalDocs>;
     Server?: VisitFunctionOrObject<Oas3Server>;
@@ -70,13 +70,13 @@ declare type Oas3FlatVisitor = {
     Info?: VisitFunctionOrObject<Oas3Info>;
     Contact?: VisitFunctionOrObject<Oas3Contact>;
     License?: VisitFunctionOrObject<Oas3License>;
-    PathMap?: VisitFunctionOrObject<Record<string, Oas3PathItem>>;
+    PathsMap?: VisitFunctionOrObject<Record<string, Oas3PathItem>>;
     PathItem?: VisitFunctionOrObject<Oas3PathItem>;
     Callback?: VisitFunctionOrObject<Record<string, Oas3PathItem>>;
     Parameter?: VisitFunctionOrObject<Oas3Parameter>;
     Operation?: VisitFunctionOrObject<Oas3Operation>;
     RequestBody?: VisitFunctionOrObject<Oas3RequestBody>;
-    MediaTypeMap?: VisitFunctionOrObject<Record<string, Oas3MediaType>>;
+    MediaTypesMap?: VisitFunctionOrObject<Record<string, Oas3MediaType>>;
     MediaType?: VisitFunctionOrObject<Oas3MediaType>;
     Example?: VisitFunctionOrObject<Oas3Example>;
     Encoding?: VisitFunctionOrObject<Oas3Encoding>;
@@ -107,14 +107,14 @@ declare type Oas3FlatVisitor = {
     SecurityScheme?: VisitFunctionOrObject<Oas3SecurityScheme>;
 };
 declare type Oas2FlatVisitor = {
-    DefinitionRoot?: VisitFunctionOrObject<Oas2Definition>;
+    Root?: VisitFunctionOrObject<Oas2Definition>;
     Tag?: VisitFunctionOrObject<Oas2Tag>;
     ExternalDocs?: VisitFunctionOrObject<Oas2ExternalDocs>;
     SecurityRequirement?: VisitFunctionOrObject<Oas2SecurityRequirement>;
     Info?: VisitFunctionOrObject<Oas2Info>;
     Contact?: VisitFunctionOrObject<Oas2Contact>;
     License?: VisitFunctionOrObject<Oas2License>;
-    PathMap?: VisitFunctionOrObject<Record<string, Oas2PathItem>>;
+    PathsMap?: VisitFunctionOrObject<Record<string, Oas2PathItem>>;
     PathItem?: VisitFunctionOrObject<Oas2PathItem>;
     Parameter?: VisitFunctionOrObject<any>;
     Operation?: VisitFunctionOrObject<Oas2Operation>;
@@ -140,7 +140,7 @@ export declare type Oas3Visitor = BaseVisitor & Oas3NestedVisitor & Record<strin
 export declare type Oas2Visitor = BaseVisitor & Oas2NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Oas2NestedVisitor>>;
 export declare type Oas3TransformVisitor = BaseVisitor & Oas3FlatVisitor & Record<string, VisitFunction<any> | VisitObject<any>>;
 export declare type Oas2TransformVisitor = BaseVisitor & Oas2FlatVisitor & Record<string, VisitFunction<any> | VisitObject<any>>;
-export declare type NestedVisitor<T> = Exclude<T, 'any' | 'ref' | 'DefinitionRoot'>;
+export declare type NestedVisitor<T> = Exclude<T, 'any' | 'ref' | 'Root'>;
 export declare type NormalizedOasVisitors<T extends BaseVisitor> = {
     [V in keyof T]-?: {
         enter: Array<NormalizeVisitor<T[V]>>;

package/lib/visitors.js

@@ -1,6 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizeVisitors = void 0;
+const legacyTypesMap = {
+    Root: 'DefinitionRoot',
+    ServerVariablesMap: 'ServerVariableMap',
+    PathsMap: 'PathMap',
+    CallbacksMap: 'CallbackMap',
+    MediaTypesMap: 'MediaTypeMap',
+    ExamplesMap: 'ExampleMap',
+    EncodingsMap: 'EncodingMap',
+    HeadersMap: 'HeaderMap',
+    LinksMap: 'LinkMap',
+};
 function normalizeVisitors(visitorsConfig, types) {
     const normalizedVisitors = {};
     normalizedVisitors.any = {
@@ -30,7 +41,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 +66,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) {
@@ -89,7 +100,8 @@ function normalizeVisitors(visitorsConfig, types) {
             }
         }
         for (const typeName of visitorKeys) {
-            const typeVisitor = visitor[typeName];
+            const typeVisitor = (visitor[typeName] ||
+                visitor[legacyTypesMap[typeName]]);
             const normalizedTypeVisitor = normalizedVisitors[typeName];
             if (!typeVisitor)
                 continue;

package/lib/walk.d.ts

@@ -4,6 +4,7 @@ import { NormalizedOasVisitors } from './visitors';
 import { ResolvedRefMap, Document, ResolveError, YamlParseError, Source } from './resolve';
 import { OasVersion } from './oas-types';
 import { NormalizedNodeType } from './types';
+import type { RuleSeverity } from './config';
 declare type NonUndefined = string | number | boolean | symbol | bigint | object | Record<string, any>;
 export declare type ResolveResult<T extends NonUndefined> = {
     node: T;
@@ -49,7 +50,7 @@ export declare type Problem = {
     suggest?: string[];
     location?: Partial<LocationObject> | Array<Partial<LocationObject>>;
     from?: LocationObject;
-    forceSeverity?: ProblemSeverity;
+    forceSeverity?: RuleSeverity;
     ruleId?: string;
 };
 export declare type NormalizedProblem = {

package/lib/walk.js

@@ -249,9 +249,12 @@ function walkDocument(opts) {
                     ? opts.location
                     : [opts.location]
                 : [Object.assign(Object.assign({}, currentLocation), { reportOnKey: false })];
-            ctx.problems.push(Object.assign(Object.assign({ ruleId: opts.ruleId || ruleId, severity: opts.forceSeverity || severity }, opts), { suggest: opts.suggest || [], location: loc.map((loc) => {
-                    return Object.assign(Object.assign(Object.assign({}, currentLocation), { reportOnKey: false }), loc);
-                }) }));
+            const ruleSeverity = opts.forceSeverity || severity;
+            if (ruleSeverity !== 'off') {
+                ctx.problems.push(Object.assign(Object.assign({ ruleId: opts.ruleId || ruleId, severity: ruleSeverity }, opts), { suggest: opts.suggest || [], location: loc.map((loc) => {
+                        return Object.assign(Object.assign(Object.assign({}, currentLocation), { reportOnKey: false }), loc);
+                    }) }));
+            }
         }
         function getVisitorDataFn(ruleId) {
             ctx.visitorsData[ruleId] = ctx.visitorsData[ruleId] || {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.0-beta.106",
+  "version": "1.0.0-beta.109",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -34,7 +34,7 @@
     "Andriy Leliv <andriy@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/ajv": "^8.6.4",
+    "@redocly/ajv": "^8.6.5",
     "@types/node": "^14.11.8",
     "colorette": "^1.2.0",
     "js-levenshtein": "^1.1.6",

package/src/__tests__/__snapshots__/bundle.test.ts.snap

@@ -47,7 +47,7 @@ rootType:
           description:
             type: string
           variables:
-            name: ServerVariableMap
+            name: ServerVariablesMap
             properties: {}
         required:
           - url
@@ -94,7 +94,7 @@ rootType:
       name: ExternalDocs
     paths:
       properties: {}
-      name: PathMap
+      name: PathsMap
     components:
       properties:
         parameters:
@@ -132,7 +132,7 @@ rootType:
     - openapi
     - paths
     - info
-  name: DefinitionRoot
+  name: Root
 refTypes: {}
 visitorsData:
   registry-dependencies:

package/src/__tests__/fixtures/extension.js

@@ -9,10 +9,10 @@ function oas3_0(types) {
         parameters: listOf('Parameter'),
       },
     },
-    DefinitionRoot: {
-      ...types.DefinitionRoot,
+    Root: {
+      ...types.Root,
       properties: {
-        ...types.DefinitionRoot.properties,
+        ...types.Root.properties,
         'x-webhooks': 'XWebHooks',
       },
     },

package/src/__tests__/format.test.ts

@@ -0,0 +1,76 @@
+import { outdent } from 'outdent';
+
+import { formatProblems, getTotals } from '../format/format';
+
+describe('format', () => {
+  function replaceColors(log: string) {
+    return log
+      .replace(/\x1b\[33m(.*?)\x1b\[39m/g, '<o>$1</o>') // orange
+      .replace(/\x1b\[31m(.*?)\x1b\[39m/g, '<r>$1</r>'); // red
+  }
+
+  const problems = [
+    {
+      ruleId: 'spec',
+      location: [],
+      severity: 'error' as const,
+      message: 'message',
+      suggest: [],
+    },
+    {
+      ruleId: 'spec',
+      location: [],
+      severity: 'error' as const,
+      message: 'message 2',
+      suggest: [],
+    },
+    {
+      ruleId: 'other-rule',
+      location: [],
+      severity: 'warn' as const,
+      message: 'message',
+      suggest: [],
+    },
+  ];
+
+  let output = '';
+  beforeEach(() => {
+    output = '';
+    jest.spyOn(process.stderr, 'write').mockImplementation((str: string | Uint8Array) => {
+      output += str;
+      return true;
+    });
+  });
+
+  it('should correctly format summary output', () => {
+    formatProblems(problems, {
+      format: 'summary',
+      version: '1.0.0',
+      totals: getTotals(problems),
+      color: false,
+    });
+
+    expect(output).toMatchInlineSnapshot(`
+      "error   spec: 2
+      warning other-rule: 1
+
+      "
+    `);
+  });
+
+  it('should correctly format summary output in color mode', () => {
+    formatProblems(problems, {
+      format: 'summary',
+      version: '1.0.0',
+      totals: getTotals(problems),
+      color: true,
+    });
+
+    expect(replaceColors(output)).toMatchInlineSnapshot(`
+      "<r>error  </r> spec: 2
+      <o>warning</o> other-rule: 1
+
+      "
+    `);
+  });
+});