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

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, {
@@ -26,14 +26,14 @@ const RemoveUnusedComponents = () => {
                 }
             },
         },
-        DefinitionRoot: {
+        Root: {
             leave(root, ctx) {
                 const data = ctx.getVisitorData();
                 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/oas3/request-mime-type.js

@@ -4,7 +4,7 @@ exports.RequestMimeType = void 0;
 const utils_1 = require("../../utils");
 const RequestMimeType = ({ allowedValues }) => {
     return {
-        PathMap: {
+        PathsMap: {
             RequestBody: {
                 leave(requestBody, ctx) {
                     utils_1.validateMimeTypeOAS3({ type: 'consumes', value: requestBody }, ctx, allowedValues);

package/lib/rules/oas3/response-mime-type.js

@@ -4,7 +4,7 @@ exports.ResponseMimeType = void 0;
 const utils_1 = require("../../utils");
 const ResponseMimeType = ({ allowedValues }) => {
     return {
-        PathMap: {
+        PathsMap: {
             Response: {
                 leave(response, ctx) {
                     utils_1.validateMimeTypeOAS3({ type: 'produces', value: response }, ctx, allowedValues);

package/lib/rules/oas3/spec-components-invalid-map-name.d.ts

@@ -0,0 +1,2 @@
+import { Oas3Rule } from '../../visitors';
+export declare const SpecComponentsInvalidMapName: Oas3Rule;

package/lib/rules/oas3/spec-components-invalid-map-name.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpecComponentsInvalidMapName = void 0;
+const SpecComponentsInvalidMapName = () => {
+    const KEYS_REGEX = '^[a-zA-Z0-9\\.\\-_]+$';
+    function validateKey(key, report, location, component) {
+        if (!new RegExp(KEYS_REGEX).test(key)) {
+            report({
+                message: `The map key in ${component} "${key}" does not match the regular expression "${KEYS_REGEX}"`,
+                location: location.key(),
+            });
+        }
+    }
+    return {
+        Components: {
+            Parameter(_node, { key, report, location }) {
+                validateKey(key, report, location, 'parameters');
+            },
+            Response(_node, { key, report, location }) {
+                validateKey(key, report, location, 'responses');
+            },
+            Schema(_node, { key, report, location }) {
+                validateKey(key, report, location, 'schemas');
+            },
+            Example(_node, { key, report, location }) {
+                validateKey(key, report, location, 'examples');
+            },
+            RequestBody(_node, { key, report, location }) {
+                validateKey(key, report, location, 'requestBodies');
+            },
+            Header(_node, { key, report, location }) {
+                validateKey(key, report, location, 'headers');
+            },
+            SecurityScheme(_node, { key, report, location }) {
+                validateKey(key, report, location, 'securitySchemas');
+            },
+            Link(_node, { key, report, location }) {
+                validateKey(key, report, location, 'links');
+            },
+            Callback(_node, { key, report, location }) {
+                validateKey(key, report, location, 'callbacks');
+            },
+        },
+    };
+};
+exports.SpecComponentsInvalidMapName = SpecComponentsInvalidMapName;

package/lib/rules/other/stats.d.ts

@@ -14,7 +14,7 @@ export declare const Stats: (statsAccumulator: StatsAccumulator) => {
     Link: {
         leave(link: any): void;
     };
-    DefinitionRoot: {
+    Root: {
         leave(): void;
     };
     WebhooksMap: {
@@ -22,7 +22,7 @@ export declare const Stats: (statsAccumulator: StatsAccumulator) => {
             leave(operation: any): void;
         };
     };
-    PathMap: {
+    PathsMap: {
         PathItem: {
             leave(): void;
             Operation: {

package/lib/rules/other/stats.js

@@ -23,7 +23,7 @@ const Stats = (statsAccumulator) => {
                 statsAccumulator.links.items.add(link.operationId);
             },
         },
-        DefinitionRoot: {
+        Root: {
             leave() {
                 statsAccumulator.parameters.total = statsAccumulator.parameters.items.size;
                 statsAccumulator.refs.total = statsAccumulator.refs.items.size;
@@ -40,7 +40,7 @@ const Stats = (statsAccumulator) => {
                 },
             },
         },
-        PathMap: {
+        PathsMap: {
             PathItem: {
                 leave() {
                     statsAccumulator.pathItems.total++;

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
  *
@@ -14,4 +14,5 @@ export declare function missingRequiredField(type: string, field: string): strin
 export declare function fieldNonEmpty(type: string, field: string): string;
 export declare function validateDefinedAndNonEmpty(fieldName: string, value: any, ctx: UserContext): void;
 export declare function getSuggest(given: string, variants: string[]): string[];
-export declare function validateExample(example: any, schema: Referenced<Oas3Schema>, dataLoc: Location, { resolve, location, report }: UserContext, disallowAdditionalProperties: boolean): void;
+export declare function validateExample(example: any, schema: Referenced<Oas3Schema>, dataLoc: Location, { resolve, location, report }: UserContext, allowAdditionalProperties: boolean): void;
+export declare function getAdditionalPropertiesOption(opts: Record<string, any>): boolean;

package/lib/rules/utils.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateExample = exports.getSuggest = exports.validateDefinedAndNonEmpty = exports.fieldNonEmpty = exports.missingRequiredField = exports.matchesJsonSchemaType = exports.oasTypeOf = void 0;
+exports.getAdditionalPropertiesOption = exports.validateExample = exports.getSuggest = exports.validateDefinedAndNonEmpty = exports.fieldNonEmpty = exports.missingRequiredField = exports.matchesJsonSchemaType = exports.oasTypeOf = void 0;
 const levenshtein = require("js-levenshtein");
 const ref_utils_1 = require("../ref-utils");
 const ajv_1 = require("./ajv");
+const utils_1 = require("../utils");
 function oasTypeOf(value) {
     if (Array.isArray(value)) {
         return 'array';
@@ -85,11 +86,11 @@ function getSuggest(given, variants) {
     return distances.map((d) => d.variant);
 }
 exports.getSuggest = getSuggest;
-function validateExample(example, schema, dataLoc, { resolve, location, report }, disallowAdditionalProperties) {
+function validateExample(example, schema, dataLoc, { resolve, location, report }, allowAdditionalProperties) {
     try {
-        const { valid, errors } = ajv_1.validateJsonSchema(example, schema, location.child('schema'), dataLoc.pointer, resolve, disallowAdditionalProperties);
+        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' }),
@@ -108,3 +109,14 @@ function validateExample(example, schema, dataLoc, { resolve, location, report }
     }
 }
 exports.validateExample = validateExample;
+function getAdditionalPropertiesOption(opts) {
+    if (opts.disallowAdditionalProperties === undefined) {
+        return opts.allowAdditionalProperties;
+    }
+    if (opts.allowAdditionalProperties !== undefined) {
+        utils_1.showErrorForDeprecatedField('disallowAdditionalProperties', 'allowAdditionalProperties');
+    }
+    utils_1.showWarningForDeprecatedField('disallowAdditionalProperties', 'allowAdditionalProperties');
+    return !opts.disallowAdditionalProperties;
+}
+exports.getAdditionalPropertiesOption = getAdditionalPropertiesOption;

package/lib/types/oas2.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Oas2Types = void 0;
 const _1 = require(".");
 const responseCodeRegexp = /^[0-9][0-9Xx]{2}$/;
-const DefinitionRoot = {
+const Root = {
     properties: {
         swagger: { type: 'string' },
         info: 'Info',
@@ -12,7 +12,7 @@ const DefinitionRoot = {
         schemes: { type: 'array', items: { type: 'string' } },
         consumes: { type: 'array', items: { type: 'string' } },
         produces: { type: 'array', items: { type: 'string' } },
-        paths: 'PathMap',
+        paths: 'PathsMap',
         definitions: 'NamedSchemas',
         parameters: 'NamedParameters',
         responses: 'NamedResponses',
@@ -48,7 +48,7 @@ const License = {
     },
     required: ['name'],
 };
-const PathMap = {
+const PathsMap = {
     properties: {},
     additionalProperties: (_value, key) => key.startsWith('/') ? 'PathItem' : undefined,
 };
@@ -352,14 +352,14 @@ const SecurityRequirement = {
     additionalProperties: { type: 'array', items: { type: 'string' } },
 };
 exports.Oas2Types = {
-    DefinitionRoot,
+    Root,
     Tag,
     ExternalDocs,
     SecurityRequirement,
     Info,
     Contact,
     License,
-    PathMap,
+    PathsMap,
     PathItem,
     Parameter,
     ParameterItems,

package/lib/types/oas3.js

@@ -4,7 +4,7 @@ exports.Oas3Types = void 0;
 const _1 = require(".");
 const ref_utils_1 = require("../ref-utils");
 const responseCodeRegexp = /^[0-9][0-9Xx]{2}$/;
-const DefinitionRoot = {
+const Root = {
     properties: {
         openapi: null,
         info: 'Info',
@@ -12,7 +12,7 @@ const DefinitionRoot = {
         security: _1.listOf('SecurityRequirement'),
         tags: _1.listOf('Tag'),
         externalDocs: 'ExternalDocs',
-        paths: 'PathMap',
+        paths: 'PathsMap',
         components: 'Components',
         'x-webhooks': 'WebhooksMap',
     },
@@ -37,7 +37,7 @@ const Server = {
     properties: {
         url: { type: 'string' },
         description: { type: 'string' },
-        variables: _1.mapOf('ServerVariable'),
+        variables: 'ServerVariablesMap',
     },
     required: ['url'],
 };
@@ -81,7 +81,7 @@ const License = {
     },
     required: ['name'],
 };
-const PathMap = {
+const PathsMap = {
     properties: {},
     additionalProperties: (_value, key) => key.startsWith('/') ? 'PathItem' : undefined,
 };
@@ -121,8 +121,8 @@ const Parameter = {
         allowReserved: { type: 'boolean' },
         schema: 'Schema',
         example: { isExample: true },
-        examples: _1.mapOf('Example'),
-        content: 'MediaTypeMap',
+        examples: 'ExamplesMap',
+        content: 'MediaTypesMap',
     },
     required: ['name', 'in'],
     requiredOneOf: ['schema', 'content'],
@@ -143,7 +143,7 @@ const Operation = {
         requestBody: 'RequestBody',
         responses: 'ResponsesMap',
         deprecated: { type: 'boolean' },
-        callbacks: _1.mapOf('Callback'),
+        callbacks: 'CallbacksMap',
         'x-codeSamples': _1.listOf('XCodeSample'),
         'x-code-samples': _1.listOf('XCodeSample'),
         'x-hideTryItPanel': { type: 'boolean' },
@@ -161,11 +161,11 @@ const RequestBody = {
     properties: {
         description: { type: 'string' },
         required: { type: 'boolean' },
-        content: 'MediaTypeMap',
+        content: 'MediaTypesMap',
     },
     required: ['content'],
 };
-const MediaTypeMap = {
+const MediaTypesMap = {
     properties: {},
     additionalProperties: 'MediaType',
 };
@@ -173,8 +173,8 @@ const MediaType = {
     properties: {
         schema: 'Schema',
         example: { isExample: true },
-        examples: _1.mapOf('Example'),
-        encoding: _1.mapOf('Encoding'),
+        examples: 'ExamplesMap',
+        encoding: 'EncodingsMap',
     },
 };
 const Example = {
@@ -188,7 +188,7 @@ const Example = {
 const Encoding = {
     properties: {
         contentType: { type: 'string' },
-        headers: _1.mapOf('Header'),
+        headers: 'HeadersMap',
         style: {
             enum: ['form', 'simple', 'label', 'matrix', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
         },
@@ -209,9 +209,10 @@ const Header = {
         allowReserved: { type: 'boolean' },
         schema: 'Schema',
         example: { isExample: true },
-        examples: _1.mapOf('Example'),
-        content: 'MediaTypeMap',
+        examples: 'ExamplesMap',
+        content: 'MediaTypesMap',
     },
+    requiredOneOf: ['schema', 'content'],
 };
 const ResponsesMap = {
     properties: { default: 'Response' },
@@ -220,9 +221,9 @@ const ResponsesMap = {
 const Response = {
     properties: {
         description: { type: 'string' },
-        headers: _1.mapOf('Header'),
-        content: 'MediaTypeMap',
-        links: _1.mapOf('Link'),
+        headers: 'HeadersMap',
+        content: 'MediaTypesMap',
+        links: 'LinksMap',
     },
     required: ['description'],
 };
@@ -427,26 +428,31 @@ const SecurityScheme = {
     extensionsPrefix: 'x-',
 };
 exports.Oas3Types = {
-    DefinitionRoot,
+    Root,
     Tag,
     ExternalDocs,
     Server,
     ServerVariable,
+    ServerVariablesMap: _1.mapOf('ServerVariable'),
     SecurityRequirement,
     Info,
     Contact,
     License,
-    PathMap,
+    PathsMap,
     PathItem,
     Parameter,
     Operation,
     Callback: _1.mapOf('PathItem'),
+    CallbacksMap: _1.mapOf('Callback'),
     RequestBody,
-    MediaTypeMap,
+    MediaTypesMap,
     MediaType,
     Example,
+    ExamplesMap: _1.mapOf('Example'),
     Encoding,
+    EncodingsMap: _1.mapOf('Encoding'),
     Header,
+    HeadersMap: _1.mapOf('Header'),
     ResponsesMap,
     Response,
     Link,
@@ -456,6 +462,7 @@ exports.Oas3Types = {
     DiscriminatorMapping,
     Discriminator,
     Components,
+    LinksMap: _1.mapOf('Link'),
     NamedSchemas: _1.mapOf('Schema'),
     NamedResponses: _1.mapOf('Response'),
     NamedParameters: _1.mapOf('Parameter'),

package/lib/types/oas3_1.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Oas3_1Types = void 0;
 const _1 = require(".");
 const oas3_1 = require("./oas3");
-const DefinitionRoot = {
+const Root = {
     properties: {
         openapi: null,
         info: 'Info',
@@ -11,7 +11,7 @@ const DefinitionRoot = {
         security: _1.listOf('SecurityRequirement'),
         tags: _1.listOf('Tag'),
         externalDocs: 'ExternalDocs',
-        paths: 'PathMap',
+        paths: 'PathsMap',
         webhooks: 'WebhooksMap',
         components: 'Components',
         jsonSchemaDialect: { type: 'string' },
@@ -237,7 +237,7 @@ const SecurityScheme = {
     extensionsPrefix: 'x-',
 };
 exports.Oas3_1Types = Object.assign(Object.assign({}, oas3_1.Oas3Types), { Info,
-    DefinitionRoot,
+    Root,
     Schema,
     License,
     Components, NamedPathItems: _1.mapOf('PathItem'), SecurityScheme,

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',
@@ -43,7 +44,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',
@@ -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,45 +111,57 @@ 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' },
             },
-        },
-    },
+        } }),
 };
 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',
-    },
+        }, lint: 'ConfigStyleguide', styleguide: 'ConfigStyleguide' }, ConfigStyleguide.properties), { 'features.openapi': 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer' }),
     required: ['root'],
 };
 const ConfigHTTP = {
@@ -154,35 +174,6 @@ const ConfigHTTP = {
         },
     },
 };
-const ConfigStyleguide = {
-    properties: {
-        extends: {
-            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) => {

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,3 +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 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;