@redocly/openapi-core 1.0.0-beta.127 → 1.0.0-beta.129

package/lib/bundle.js

@@ -74,13 +74,27 @@ function bundleDocument(opts) {
                     : remove_unused_components_2.RemoveUnusedComponents({}),
             });
         }
-        const resolvedRefMap = yield resolve_1.resolveDocument({
+        let resolvedRefMap = yield resolve_1.resolveDocument({
             rootDocument: document,
             rootType: types.Root,
             externalRefResolver,
         });
+        if (preprocessors.length > 0) {
+            // Make additional pass to resolve refs defined in preprocessors.
+            walk_1.walkDocument({
+                document,
+                rootType: types.Root,
+                normalizedVisitors: visitors_1.normalizeVisitors(preprocessors, types),
+                resolvedRefMap,
+                ctx,
+            });
+            resolvedRefMap = yield resolve_1.resolveDocument({
+                rootDocument: document,
+                rootType: types.Root,
+                externalRefResolver,
+            });
+        }
         const bundleVisitor = visitors_1.normalizeVisitors([
-            ...preprocessors,
             {
                 severity: 'error',
                 ruleId: 'bundler',

package/lib/config/all.js

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

package/lib/config/config-resolvers.js

@@ -75,6 +75,9 @@ function resolvePlugins(plugins, configPath = '') {
                     : require(absoltePluginPath);
             }
             catch (e) {
+                if (e instanceof SyntaxError) {
+                    throw e;
+                }
                 throw new Error(`Failed to load plugin "${plugin}". Please provide a valid path`);
             }
         }
@@ -253,7 +256,10 @@ function groupStyleguideAssertionRules({ rules, plugins, }) {
     // Collect assertion rules
     const assertions = [];
     for (const [ruleKey, rule] of Object.entries(rules)) {
-        if (ruleKey.startsWith('assert/') && typeof rule === 'object' && rule !== null) {
+        // keep the old assert/ syntax as an alias
+        if ((ruleKey.startsWith('rule/') || ruleKey.startsWith('assert/')) &&
+            typeof rule === 'object' &&
+            rule !== null) {
             const assertion = rule;
             if (plugins) {
                 registerCustomAssertions(plugins, assertion);
@@ -262,7 +268,7 @@ function groupStyleguideAssertionRules({ rules, plugins, }) {
                     registerCustomAssertions(plugins, context);
                 }
             }
-            assertions.push(Object.assign(Object.assign({}, assertion), { assertionId: ruleKey.replace('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

@@ -31,6 +31,7 @@ exports.default = {
         'boolean-parameter-prefixes': 'off',
         'paths-kebab-case': 'off',
         spec: 'error',
+        'spec-strict-refs': 'off',
     },
     oas3_0Rules: {
         'no-invalid-media-type-examples': {

package/lib/config/recommended.js

@@ -31,6 +31,7 @@ exports.default = {
         'boolean-parameter-prefixes': 'off',
         'paths-kebab-case': 'off',
         spec: 'error',
+        'spec-strict-refs': 'off',
     },
     oas3_0Rules: {
         'no-invalid-media-type-examples': {

package/lib/config/types.d.ts

@@ -2,7 +2,7 @@ import type { ProblemSeverity, UserContext } from '../walk';
 import type { Oas3PreprocessorsSet, OasMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, OasVersion } from '../oas-types';
 import type { NodeType } from '../types';
 import { Location } from '../ref-utils';
-import { SkipFunctionContext } from '../visitors';
+import type { SkipFunctionContext } from '../visitors';
 export declare type RuleSeverity = ProblemSeverity | 'off';
 export declare type RuleSettings = {
     severity: RuleSeverity;
@@ -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/config/utils.js

@@ -191,12 +191,26 @@ function transformConfig(rawConfig) {
     }
     const { apis, apiDefinitions, referenceDocs, lint } = rawConfig, rest = __rest(rawConfig, ["apis", "apiDefinitions", "referenceDocs", "lint"]);
     const { styleguideConfig, rawConfigRest } = extractFlatConfig(rest);
-    return Object.assign({ theme: {
+    const transformedConfig = Object.assign({ theme: {
             openapi: Object.assign(Object.assign(Object.assign({}, referenceDocs), rawConfig['features.openapi']), (_a = rawConfig.theme) === null || _a === void 0 ? void 0 : _a.openapi),
             mockServer: Object.assign(Object.assign({}, rawConfig['features.mockServer']), (_b = rawConfig.theme) === null || _b === void 0 ? void 0 : _b.mockServer),
         }, apis: transformApis(apis) || transformApiDefinitionsToApis(apiDefinitions), styleguide: styleguideConfig || lint }, rawConfigRest);
+    showDeprecationMessages(transformedConfig);
+    return transformedConfig;
 }
 exports.transformConfig = transformConfig;
+function showDeprecationMessages(config) {
+    var _a, _b;
+    let allRules = Object.assign({}, (_a = config.styleguide) === null || _a === void 0 ? void 0 : _a.rules);
+    for (const api of Object.values(config.apis || {})) {
+        allRules = Object.assign(Object.assign({}, allRules), (_b = api === null || api === void 0 ? void 0 : api.styleguide) === null || _b === void 0 ? void 0 : _b.rules);
+    }
+    for (const ruleKey of Object.keys(allRules)) {
+        if (ruleKey.startsWith('assert/')) {
+            logger_1.logger.warn(`\nThe 'assert/' syntax in ${ruleKey} is deprecated. Update your configuration to use 'rule/' instead. Examples and more information: https://redocly.com/docs/cli/rules/configurable-rules/\n`);
+        }
+    }
+}
 function getResolveConfig(resolve) {
     var _a, _b;
     return {

package/lib/lint.js

@@ -57,12 +57,27 @@ function lintDocument(opts) {
         };
         const preprocessors = config_1.initRules(rules, config, 'preprocessors', oasVersion);
         const regularRules = config_1.initRules(rules, config, 'rules', oasVersion);
-        const normalizedVisitors = visitors_1.normalizeVisitors([...preprocessors, ...regularRules], types);
-        const resolvedRefMap = yield resolve_1.resolveDocument({
+        let resolvedRefMap = yield resolve_1.resolveDocument({
             rootDocument: document,
             rootType: types.Root,
             externalRefResolver,
         });
+        if (preprocessors.length > 0) {
+            // Make additional pass to resolve refs defined in preprocessors.
+            walk_1.walkDocument({
+                document,
+                rootType: types.Root,
+                normalizedVisitors: visitors_1.normalizeVisitors(preprocessors, types),
+                resolvedRefMap,
+                ctx,
+            });
+            resolvedRefMap = yield resolve_1.resolveDocument({
+                rootDocument: document,
+                rootType: types.Root,
+                externalRefResolver,
+            });
+        }
+        const normalizedVisitors = visitors_1.normalizeVisitors(regularRules, types);
         walk_1.walkDocument({
             document,
             rootType: types.Root,

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/common/spec-strict-refs.d.ts

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

package/lib/rules/common/spec-strict-refs.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpecStrictRefs = void 0;
+const ref_utils_1 = require("../../ref-utils");
+const SpecStrictRefs = () => {
+    const nodesToSkip = [
+        'Schema',
+        'Response',
+        'Parameter',
+        'RequestBody',
+        'Example',
+        'Header',
+        'SecurityScheme',
+        'Link',
+        'Callback',
+        'PathItem',
+    ];
+    return {
+        any(_node, { report, rawNode, rawLocation, type }) {
+            const shouldCheck = !nodesToSkip.includes(type.name);
+            if (shouldCheck && ref_utils_1.isRef(rawNode)) {
+                report({
+                    message: 'Field $ref is not expected here.',
+                    location: rawLocation.child('$ref').key(),
+                });
+            }
+        },
+    };
+};
+exports.SpecStrictRefs = SpecStrictRefs;

package/lib/rules/oas2/index.d.ts

@@ -42,5 +42,6 @@ export declare const rules: {
     'response-contains-property': Oas2Rule;
     'scalar-property-missing-example': import("../../visitors").Oas3Rule | Oas2Rule;
     'required-string-property-missing-min-length': import("../../visitors").Oas3Rule;
+    'spec-strict-refs': import("../../visitors").Oas3Rule | Oas2Rule;
 };
 export declare const preprocessors: {};

package/lib/rules/oas2/index.js

@@ -42,6 +42,7 @@ const response_contains_header_1 = require("../common/response-contains-header")
 const response_contains_property_1 = require("./response-contains-property");
 const scalar_property_missing_example_1 = require("../common/scalar-property-missing-example");
 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");
 exports.rules = {
     spec: spec_1.OasSpec,
     'no-invalid-schema-examples': no_invalid_schema_examples_1.NoInvalidSchemaExamples,
@@ -85,5 +86,6 @@ exports.rules = {
     'response-contains-property': response_contains_property_1.ResponseContainsProperty,
     'scalar-property-missing-example': scalar_property_missing_example_1.ScalarPropertyMissingExample,
     'required-string-property-missing-min-length': required_string_property_missing_min_length_1.RequiredStringPropertyMissingMinLength,
+    'spec-strict-refs': spec_strict_refs_1.SpecStrictRefs,
 };
 exports.preprocessors = {};

package/lib/rules/oas3/index.js

@@ -52,6 +52,7 @@ const scalar_property_missing_example_1 = require("../common/scalar-property-mis
 const spec_components_invalid_map_name_1 = require("./spec-components-invalid-map-name");
 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");
 exports.rules = {
     spec: spec_1.OasSpec,
     'info-contact': info_contact_1.InfoContact,
@@ -105,5 +106,6 @@ exports.rules = {
     'scalar-property-missing-example': scalar_property_missing_example_1.ScalarPropertyMissingExample,
     '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,
 };
 exports.preprocessors = {};

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

@@ -57,11 +57,6 @@ const SpecComponentsInvalidMapName = () => {
                 validateKey(key, report, location, 'callbacks');
             },
         },
-        ExampleMap: {
-            Example(_node, { key, report, location }) {
-                validateKey(key, report, location, 'examples');
-            },
-        },
     };
 };
 exports.SpecComponentsInvalidMapName = SpecComponentsInvalidMapName;