@redocly/openapi-core 1.0.0-beta.128 → 1.0.0-beta.130

package/lib/config/all.js

@@ -49,6 +49,7 @@ exports.default = {
         'no-invalid-parameter-examples': 'error',
         'scalar-property-missing-example': 'error',
         'spec-strict-refs': 'error',
+        'component-name-unique': 'error',
     },
     oas3_0Rules: {
         'no-invalid-media-type-examples': 'error',

package/lib/config/config-resolvers.js

@@ -268,7 +268,7 @@ function groupStyleguideAssertionRules({ rules, plugins, }) {
                     registerCustomAssertions(plugins, context);
                 }
             }
-            assertions.push(Object.assign(Object.assign({}, assertion), { assertionId: ruleKey.replace(/rule\/|assert\//, '') }));
+            assertions.push(Object.assign(Object.assign({}, assertion), { assertionId: ruleKey }));
         }
         else {
             // If it's not an assertion, keep it as is

package/lib/config/config.d.ts

@@ -1,7 +1,7 @@
 import { NormalizedProblem } from '../walk';
 import { OasVersion, OasMajorVersion, Oas2RuleSet, Oas3RuleSet } from '../oas-types';
 import type { NodeType } from '../types';
-import type { DecoratorConfig, Plugin, PreprocessorConfig, Region, ResolveConfig, ResolvedApi, ResolvedConfig, ResolvedStyleguideConfig, RuleConfig, RuleSettings, ThemeRawConfig } from './types';
+import type { DecoratorConfig, Plugin, PreprocessorConfig, Region, ResolveConfig, ResolvedApi, ResolvedConfig, ResolvedStyleguideConfig, RuleConfig, RuleSettings, Telemetry, ThemeRawConfig } from './types';
 export declare const IGNORE_FILE = ".redocly.lint-ignore.yaml";
 export declare const DEFAULT_REGION = "us";
 export declare const DOMAINS: {
@@ -53,5 +53,6 @@ export declare class Config {
     theme: ThemeRawConfig;
     organization?: string;
     files: string[];
+    telemetry?: Telemetry;
     constructor(rawConfig: ResolvedConfig, configFile?: string | undefined);
 }

package/lib/config/config.js

@@ -254,6 +254,7 @@ class Config {
         this.region = rawConfig.region;
         this.organization = rawConfig.organization;
         this.files = rawConfig.files || [];
+        this.telemetry = rawConfig.telemetry;
     }
 }
 exports.Config = Config;

package/lib/config/minimal.js

@@ -32,6 +32,7 @@ exports.default = {
         'paths-kebab-case': 'off',
         spec: 'error',
         'spec-strict-refs': 'off',
+        'component-name-unique': 'off',
     },
     oas3_0Rules: {
         'no-invalid-media-type-examples': {

package/lib/config/recommended.js

@@ -32,6 +32,7 @@ exports.default = {
         'paths-kebab-case': 'off',
         spec: 'error',
         'spec-strict-refs': 'off',
+        'component-name-unique': 'off',
     },
     oas3_0Rules: {
         'no-invalid-media-type-examples': {

package/lib/config/types.d.ts

@@ -97,6 +97,7 @@ export declare type ResolveConfig = {
     http: HttpResolveConfig;
 };
 export declare type Region = 'us' | 'eu';
+export declare type Telemetry = 'on' | 'off';
 export declare type AccessTokens = {
     [region in Region]?: string;
 };
@@ -125,6 +126,7 @@ export declare type RawConfig = {
     region?: Region;
     organization?: string;
     files?: string[];
+    telemetry?: Telemetry;
 } & ThemeConfig;
 export declare type FlatApi = Omit<Api, 'styleguide'> & Omit<ApiStyleguideRawConfig, 'doNotResolveExamples'>;
 export declare type FlatRawConfig = Omit<RawConfig, 'styleguide' | 'resolve' | 'apis'> & Omit<StyleguideRawConfig, 'doNotResolveExamples'> & {
@@ -147,4 +149,14 @@ export declare type ThemeRawConfig = {
     mockServer?: Record<string, any>;
 };
 export declare type RulesFields = 'rules' | 'oas2Rules' | 'oas3_0Rules' | 'oas3_1Rules' | 'preprocessors' | 'oas2Preprocessors' | 'oas3_0Preprocessors' | 'oas3_1Preprocessors' | 'decorators' | 'oas2Decorators' | 'oas3_0Decorators' | 'oas3_1Decorators';
+export declare enum AuthProviderType {
+    OIDC = "OIDC",
+    SAML2 = "SAML2",
+    BASIC = "BASIC"
+}
+export declare enum ApigeeDevOnboardingIntegrationAuthType {
+    SERVICE_ACCOUNT = "SERVICE_ACCOUNT",
+    OAUTH2 = "OAUTH2"
+}
+export declare const DEFAULT_TEAM_CLAIM_NAME = "https://redocly.com/sso/teams";
 export {};

package/lib/config/types.js

@@ -1,2 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_TEAM_CLAIM_NAME = exports.ApigeeDevOnboardingIntegrationAuthType = exports.AuthProviderType = void 0;
+var AuthProviderType;
+(function (AuthProviderType) {
+    AuthProviderType["OIDC"] = "OIDC";
+    AuthProviderType["SAML2"] = "SAML2";
+    AuthProviderType["BASIC"] = "BASIC";
+})(AuthProviderType = exports.AuthProviderType || (exports.AuthProviderType = {}));
+var ApigeeDevOnboardingIntegrationAuthType;
+(function (ApigeeDevOnboardingIntegrationAuthType) {
+    ApigeeDevOnboardingIntegrationAuthType["SERVICE_ACCOUNT"] = "SERVICE_ACCOUNT";
+    ApigeeDevOnboardingIntegrationAuthType["OAUTH2"] = "OAUTH2";
+})(ApigeeDevOnboardingIntegrationAuthType = exports.ApigeeDevOnboardingIntegrationAuthType || (exports.ApigeeDevOnboardingIntegrationAuthType = {}));
+exports.DEFAULT_TEAM_CLAIM_NAME = 'https://redocly.com/sso/teams';

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

@@ -11,12 +11,11 @@ const Assertions = (opts) => {
     // that is why we need to iterate through 'opts' values;
     // before - filter only object 'opts' values
     const assertions = Object.values(opts).filter((opt) => typeof opt === 'object' && opt !== null);
-    for (const [index, assertion] of assertions.entries()) {
-        const assertId = (assertion.assertionId && `${assertion.assertionId} assertion`) || `assertion #${index + 1}`;
+    for (const [_, assertion] of assertions.entries()) {
         if (!utils_2.isString(assertion.subject.type)) {
-            throw new Error(`${assertId}: 'type' (String) is required`);
+            throw new Error(`${assertion.assertionId}: 'type' (String) is required`);
         }
-        const subjectVisitor = utils_1.buildSubjectVisitor(assertId, assertion);
+        const subjectVisitor = utils_1.buildSubjectVisitor(assertion.assertionId, assertion);
         const visitorObject = utils_1.buildVisitorObject(assertion, subjectVisitor);
         visitors.push(visitorObject);
     }

package/lib/rules/oas3/component-name-unique.d.ts

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

package/lib/rules/oas3/component-name-unique.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComponentNameUnique = void 0;
+const TYPE_NAME_SCHEMA = 'Schema';
+const TYPE_NAME_PARAMETER = 'Parameter';
+const TYPE_NAME_RESPONSE = 'Response';
+const TYPE_NAME_REQUEST_BODY = 'RequestBody';
+const TYPE_NAME_TO_OPTION_COMPONENT_NAME = {
+    [TYPE_NAME_SCHEMA]: 'schemas',
+    [TYPE_NAME_PARAMETER]: 'parameters',
+    [TYPE_NAME_RESPONSE]: 'responses',
+    [TYPE_NAME_REQUEST_BODY]: 'requestBodies',
+};
+const ComponentNameUnique = (options) => {
+    const components = new Map();
+    const typeNames = [];
+    if (options.schemas !== 'off') {
+        typeNames.push(TYPE_NAME_SCHEMA);
+    }
+    if (options.parameters !== 'off') {
+        typeNames.push(TYPE_NAME_PARAMETER);
+    }
+    if (options.responses !== 'off') {
+        typeNames.push(TYPE_NAME_RESPONSE);
+    }
+    if (options.requestBodies !== 'off') {
+        typeNames.push(TYPE_NAME_REQUEST_BODY);
+    }
+    const rule = {
+        ref: {
+            leave(ref, { type, resolve }) {
+                const typeName = type.name;
+                if (typeNames.includes(typeName)) {
+                    const resolvedRef = resolve(ref);
+                    if (!resolvedRef.location)
+                        return;
+                    addComponentFromAbsoluteLocation(typeName, resolvedRef.location.absolutePointer.toString());
+                }
+            },
+        },
+        Root: {
+            leave(root, ctx) {
+                components.forEach((value, key, _) => {
+                    if (value.size > 1) {
+                        const component = getComponentFromKey(key);
+                        const optionComponentName = getOptionComponentNameForTypeName(component.typeName);
+                        const definitions = Array.from(value)
+                            .map((v) => `- ${v}`)
+                            .join('\n');
+                        const problem = {
+                            message: `Component '${optionComponentName}/${component.componentName}' is not unique. It is defined at:\n${definitions}`,
+                        };
+                        const componentSeverity = optionComponentName ? options[optionComponentName] : null;
+                        if (componentSeverity) {
+                            problem.forceSeverity = componentSeverity;
+                        }
+                        ctx.report(problem);
+                    }
+                });
+            },
+        },
+    };
+    if (options.schemas != 'off') {
+        rule.NamedSchemas = {
+            Schema(_, { location }) {
+                addComponentFromAbsoluteLocation(TYPE_NAME_SCHEMA, location.absolutePointer.toString());
+            },
+        };
+    }
+    if (options.responses != 'off') {
+        rule.NamedResponses = {
+            Response(_, { location }) {
+                addComponentFromAbsoluteLocation(TYPE_NAME_RESPONSE, location.absolutePointer.toString());
+            },
+        };
+    }
+    if (options.parameters != 'off') {
+        rule.NamedParameters = {
+            Parameter(_, { location }) {
+                addComponentFromAbsoluteLocation(TYPE_NAME_PARAMETER, location.absolutePointer.toString());
+            },
+        };
+    }
+    if (options.requestBodies != 'off') {
+        rule.NamedRequestBodies = {
+            RequestBody(_, { location }) {
+                addComponentFromAbsoluteLocation(TYPE_NAME_REQUEST_BODY, location.absolutePointer.toString());
+            },
+        };
+    }
+    return rule;
+    function getComponentNameFromAbsoluteLocation(absoluteLocation) {
+        const componentName = absoluteLocation.split('/').slice(-1)[0];
+        if (componentName.endsWith('.yml') ||
+            componentName.endsWith('.yaml') ||
+            componentName.endsWith('.json')) {
+            return componentName.slice(0, componentName.lastIndexOf('.'));
+        }
+        return componentName;
+    }
+    function addFoundComponent(typeName, componentName, absoluteLocation) {
+        var _a;
+        const key = getKeyForComponent(typeName, componentName);
+        const locations = (_a = components.get(key)) !== null && _a !== void 0 ? _a : new Set();
+        locations.add(absoluteLocation);
+        components.set(key, locations);
+    }
+    function addComponentFromAbsoluteLocation(typeName, absoluteLocation) {
+        const componentName = getComponentNameFromAbsoluteLocation(absoluteLocation);
+        addFoundComponent(typeName, componentName, absoluteLocation);
+    }
+};
+exports.ComponentNameUnique = ComponentNameUnique;
+function getOptionComponentNameForTypeName(typeName) {
+    var _a;
+    return (_a = TYPE_NAME_TO_OPTION_COMPONENT_NAME[typeName]) !== null && _a !== void 0 ? _a : null;
+}
+function getKeyForComponent(typeName, componentName) {
+    return `${typeName}/${componentName}`;
+}
+function getComponentFromKey(key) {
+    const [typeName, componentName] = key.split('/');
+    return { typeName, componentName };
+}

package/lib/rules/oas3/index.js

@@ -53,6 +53,7 @@ const spec_components_invalid_map_name_1 = require("./spec-components-invalid-ma
 const operation_4xx_problem_details_rfc7807_1 = require("./operation-4xx-problem-details-rfc7807");
 const required_string_property_missing_min_length_1 = require("../common/required-string-property-missing-min-length");
 const spec_strict_refs_1 = require("../common/spec-strict-refs");
+const component_name_unique_1 = require("./component-name-unique");
 exports.rules = {
     spec: spec_1.OasSpec,
     'info-contact': info_contact_1.InfoContact,
@@ -107,5 +108,6 @@ exports.rules = {
     'spec-components-invalid-map-name': spec_components_invalid_map_name_1.SpecComponentsInvalidMapName,
     'required-string-property-missing-min-length': required_string_property_missing_min_length_1.RequiredStringPropertyMissingMinLength,
     'spec-strict-refs': spec_strict_refs_1.SpecStrictRefs,
+    'component-name-unique': component_name_unique_1.ComponentNameUnique,
 };
 exports.preprocessors = {};

package/lib/rules/utils.js

@@ -72,6 +72,8 @@ function validateDefinedAndNonEmpty(fieldName, value, ctx) {
 }
 exports.validateDefinedAndNonEmpty = validateDefinedAndNonEmpty;
 function getSuggest(given, variants) {
+    if (given === null)
+        return variants;
     if (typeof given !== 'string' || !variants.length)
         return [];
     const distances = [];
@@ -127,7 +129,7 @@ function validateSchemaEnumType(schemaEnum, propertyValue, propName, refLocation
     if (!schemaEnum) {
         return;
     }
-    if (!schemaEnum.includes(propertyValue === null ? 'null' : propertyValue)) {
+    if (!schemaEnum.includes(propertyValue)) {
         report({
             location,
             message: `\`${propName}\` can be one of the following only: ${schemaEnum