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

package/lib/types/redocly-yaml.js

@@ -11,6 +11,7 @@ const builtInRulesList = [
     'info-license-url',
     'operation-2xx-response',
     'operation-4xx-response',
+    'operation-4xx-problem-details-rfc7807',
     'assertions',
     'operation-operationId-unique',
     'operation-parameters-unique',
@@ -34,7 +35,7 @@ const builtInRulesList = [
     'path-params-defined',
     'parameter-description',
     'operation-singular-tag',
-    'operation-security-defined',
+    'security-defined',
     'no-unresolved-refs',
     'paths-kebab-case',
     'boolean-parameter-prefixes',
@@ -54,31 +55,38 @@ const builtInRulesList = [
     'response-contains-header',
     'response-contains-property',
     'scalar-property-missing-example',
+    'spec-components-invalid-map-name',
 ];
 const nodeTypesList = [
-    'DefinitionRoot',
+    'Root',
     'Tag',
     'ExternalDocs',
     'Server',
     'ServerVariable',
+    'ServerVariablesMap',
     'SecurityRequirement',
     'Info',
     'Contact',
     'License',
-    'PathMap',
+    'PathsMap',
     'PathItem',
     'Parameter',
     'Operation',
     'Callback',
+    'CallbacksMap',
     'RequestBody',
-    'MediaTypeMap',
+    'MediaTypesMap',
     'MediaType',
     'Example',
+    'ExamplesMap',
     'Encoding',
+    'EncodingsMap',
     'Header',
+    'HeadersMap',
     'ResponsesMap',
     'Response',
     'Link',
+    'LinksMap',
     'Schema',
     'Xml',
     'SchemaProperties',
@@ -103,86 +111,79 @@ const nodeTypesList = [
     'XCodeSample',
     'WebhooksMap',
 ];
-const ConfigRoot = {
+const ConfigStyleguide = {
     properties: {
-        organization: { type: 'string' },
-        apis: 'ConfigApis',
-        apiDefinitions: {
+        extends: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        },
+        rules: 'Rules',
+        oas2Rules: 'Rules',
+        oas3_0Rules: 'Rules',
+        oas3_1Rules: 'Rules',
+        preprocessors: { type: 'object' },
+        oas2Preprocessors: { type: 'object' },
+        oas3_0Preprocessors: { type: 'object' },
+        oas3_1Preprocessors: { type: 'object' },
+        decorators: { type: 'object' },
+        oas2Decorators: { type: 'object' },
+        oas3_0Decorators: { type: 'object' },
+        oas3_1Decorators: { type: 'object' },
+    },
+};
+const RootConfigStyleguide = {
+    properties: Object.assign({ plugins: {
+            type: 'array',
+            items: { type: 'string' },
+        } }, ConfigStyleguide.properties),
+};
+const ConfigRoot = {
+    properties: Object.assign(Object.assign({ organization: { type: 'string' }, apis: 'ConfigApis', apiDefinitions: {
             type: 'object',
             properties: {},
             additionalProperties: { properties: { type: 'string' } },
-        },
-        styleguide: 'RootConfigStyleguide',
-        lint: 'RootConfigStyleguide',
-        'features.openapi': 'ConfigReferenceDocs',
-        referenceDocs: 'ConfigReferenceDocs',
-        'features.mockServer': 'ConfigMockServer',
-        region: { enum: ['us', 'eu'] },
-        resolve: {
+        } }, RootConfigStyleguide.properties), { styleguide: 'RootConfigStyleguide', lint: 'RootConfigStyleguide', 'features.openapi': 'ConfigReferenceDocs', referenceDocs: 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer', region: { enum: ['us', 'eu'] }, resolve: {
             properties: {
                 http: 'ConfigHTTP',
+                doNotResolveExamples: { type: 'boolean' },
             },
-        },
-    },
+        }, files: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        } }),
 };
 const ConfigApis = {
     properties: {},
     additionalProperties: 'ConfigApisProperties',
 };
 const ConfigApisProperties = {
-    properties: {
-        root: { type: 'string' },
-        labels: {
+    properties: Object.assign(Object.assign({ root: { type: 'string' }, labels: {
             type: 'array',
             items: {
                 type: 'string',
             },
-        },
-        styleguide: 'ConfigStyleguide',
-        'features.openapi': 'ConfigReferenceDocs',
-        'features.mockServer': 'ConfigMockServer',
-    },
-    required: ['root'],
-};
-const ConfigHTTP = {
-    properties: {
-        headers: {
+        }, lint: 'ConfigStyleguide', styleguide: 'ConfigStyleguide' }, ConfigStyleguide.properties), { 'features.openapi': 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer', files: {
             type: 'array',
             items: {
                 type: 'string',
             },
-        },
-    },
+        } }),
+    required: ['root'],
 };
-const ConfigStyleguide = {
+const ConfigHTTP = {
     properties: {
-        extends: {
+        headers: {
             type: 'array',
             items: {
                 type: 'string',
             },
         },
-        doNotResolveExamples: { type: 'boolean' },
-        rules: 'Rules',
-        oas2Rules: 'Rules',
-        oas3_0Rules: 'Rules',
-        oas3_1Rules: 'Rules',
-        preprocessors: { type: 'object' },
-        oas2Preprocessors: { type: 'object' },
-        oas3_0Preprocessors: { type: 'object' },
-        oas3_1Preprocessors: { type: 'object' },
-        decorators: { type: 'object' },
-        oas2Decorators: { type: 'object' },
-        oas3_0Decorators: { type: 'object' },
-        oas3_1Decorators: { type: 'object' },
     },
 };
-const RootConfigStyleguide = {
-    properties: Object.assign({ plugins: {
-            type: 'array',
-            items: { type: 'string' },
-        } }, ConfigStyleguide.properties),
-};
 const Rules = {
     properties: {},
     additionalProperties: (value, key) => {
@@ -258,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/lib/utils.d.ts

@@ -14,7 +14,7 @@ export declare function pushStack<T, P extends Stack<T> = Stack<T>>(head: P, val
 export declare function popStack<T, P extends Stack<T>>(head: P): StackFrame<T> | null;
 export declare type BundleOutputFormat = 'json' | 'yml' | 'yaml';
 export declare function loadYaml<T>(filename: string): Promise<T>;
-export declare function notUndefined<T>(x: T | undefined): x is T;
+export declare function isDefined<T>(x: T | undefined): x is T;
 export declare function isPlainObject(value: any): value is object;
 export declare function isEmptyObject(value: any): value is object;
 export declare function isEmptyArray(value: any): boolean;
@@ -41,8 +41,8 @@ export declare function assignExisting<T>(target: Record<string, T>, obj: Record
 export declare function getMatchingStatusCodeRange(code: number | string): string;
 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 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,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+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");
@@ -37,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);
 }
@@ -190,11 +190,11 @@ function doesYamlFileExist(filePath) {
 }
 exports.doesYamlFileExist = doesYamlFileExist;
 function showWarningForDeprecatedField(deprecatedField, updatedField) {
-    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`);
+    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. Use '${updatedField}' instead.\n`);
+    throw new Error(`Do not use '${deprecatedField}' field. ${updatedField ? `Use '${updatedField}' instead. ` : ''}\n`);
 }
 exports.showErrorForDeprecatedField = showErrorForDeprecatedField;
 function isTruthy(value) {

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;
@@ -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 = {
@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.0-beta.108",
+  "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__/__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
+
+      "
+    `);
+  });
+});