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

package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.js

@@ -13,7 +13,6 @@ const rebillyDocument = utils_1.parseYamlToDocument(fs_1.readFileSync(rebillyDef
 const config = utils_1.makeConfigForRuleset({
     test: () => {
         return {
-            // @ts-ignore
             Schema(schema, ctx) {
                 if (schema.type === 'number') {
                     ctx.report({

package/lib/benchmark/benches/resolve-with-no-external.bench.js

@@ -16,7 +16,7 @@ function measureAsync() {
     return resolve_1.resolveDocument({
         rootDocument: rebillyDocument,
         externalRefResolver,
-        rootType: types_1.normalizeTypes(oas3_1.Oas3Types).DefinitionRoot,
+        rootType: types_1.normalizeTypes(oas3_1.Oas3Types).Root,
     });
 }
 exports.measureAsync = measureAsync;

package/lib/bundle.d.ts

@@ -44,4 +44,4 @@ export declare function bundleDocument(opts: {
     refTypes: Map<string, NormalizedNodeType> | undefined;
     visitorsData: Record<string, Record<string, unknown>>;
 }>;
-export declare function mapTypeToComponent(typeName: string, version: OasMajorVersion): "headers" | "definitions" | "parameters" | "examples" | "responses" | "schemas" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | null;
+export declare function mapTypeToComponent(typeName: string, version: OasMajorVersion): "headers" | "definitions" | "parameters" | "examples" | "responses" | "schemas" | "requestBodies" | "links" | "callbacks" | "securitySchemes" | null;

package/lib/bundle.js

@@ -76,7 +76,7 @@ function bundleDocument(opts) {
         }
         const resolvedRefMap = yield resolve_1.resolveDocument({
             rootDocument: document,
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             externalRefResolver,
         });
         const bundleVisitor = visitors_1.normalizeVisitors([
@@ -90,7 +90,7 @@ function bundleDocument(opts) {
         ], types);
         walk_1.walkDocument({
             document,
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             normalizedVisitors: bundleVisitor,
             resolvedRefMap,
             ctx,
@@ -99,7 +99,7 @@ function bundleDocument(opts) {
             bundle: document,
             problems: ctx.problems.map((problem) => config.addProblemToIgnore(problem)),
             fileDependencies: externalRefResolver.getFiles(),
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             refTypes: ctx.refTypes,
             visitorsData: ctx.visitorsData,
         };
@@ -184,7 +184,7 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
                 }
             },
         },
-        DefinitionRoot: {
+        Root: {
             enter(root) {
                 if (version === oas_types_1.OasMajorVersion.Version3) {
                     components = root.components = root.components || {};
@@ -231,9 +231,12 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
             ctx.parent[ctx.key] = resolved.node;
         }
         else {
+            // TODO: why $ref isn't optional in OasRef?
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
             // @ts-ignore
             delete ref.$ref;
-            Object.assign(ref, resolved.node);
+            const obj = Object.assign({}, resolved.node, ref);
+            Object.assign(ref, obj); // assign ref itself again so ref fields take precedence
         }
     }
     function saveComponent(componentType, target, ctx) {
@@ -259,7 +262,7 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
         const [fileRef, pointer] = [target.location.source.absoluteRef, target.location.pointer];
         const componentsGroup = components[componentType];
         let name = '';
-        const refParts = pointer.slice(2).split('/').filter(Boolean); // slice(2) removes "#/"
+        const refParts = pointer.slice(2).split('/').filter(utils_1.isTruthy); // slice(2) removes "#/"
         while (refParts.length > 0) {
             name = refParts.pop() + (name ? `-${name}` : '');
             if (!componentsGroup ||

package/lib/config/all.js

@@ -26,7 +26,7 @@ exports.default = {
         'operation-operationId-url-safe': 'error',
         'operation-parameters-unique': 'error',
         'operation-tag-defined': 'error',
-        'operation-security-defined': 'error',
+        'security-defined': 'error',
         'operation-singular-tag': 'error',
         'no-unresolved-refs': 'error',
         'no-enum-type-mismatch': 'error',
@@ -51,7 +51,8 @@ exports.default = {
         'no-example-value-and-externalValue': 'error',
         'no-unused-components': 'error',
         'no-undefined-server-variable': 'error',
-        'no-servers-empty-enum': 'error',
+        'no-server-variables-empty-enum': 'error',
+        'operation-4xx-problem-details-rfc7807': 'error',
     },
     oas3_1Rules: {
         'no-server-example.com': 'error',
@@ -60,6 +61,7 @@ exports.default = {
         'no-example-value-and-externalValue': 'error',
         'no-unused-components': 'error',
         'no-undefined-server-variable': 'error',
-        'no-servers-empty-enum': 'error',
+        'no-server-variables-empty-enum': 'error',
+        'operation-4xx-problem-details-rfc7807': 'error',
     },
 };

package/lib/config/config-resolvers.js

@@ -22,13 +22,14 @@ var __rest = (this && this.__rest) || function (s, e) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolvePreset = exports.resolveStyleguideConfig = exports.resolveApis = exports.resolvePlugins = exports.resolveConfig = void 0;
 const path = require("path");
-const colorette_1 = require("colorette");
 const ref_utils_1 = require("../ref-utils");
 const resolve_1 = require("../resolve");
 const builtIn_1 = require("./builtIn");
 const utils_1 = require("./utils");
+const env_1 = require("../env");
 const utils_2 = require("../utils");
 const config_1 = require("./config");
+const logger_1 = require("../logger");
 function resolveConfig(rawConfig, configPath) {
     var _a, _b, _c, _d, _e;
     return __awaiter(this, void 0, void 0, function* () {
@@ -57,25 +58,42 @@ exports.resolveConfig = resolveConfig;
 function resolvePlugins(plugins, configPath = '') {
     if (!plugins)
         return [];
-    // @ts-ignore
-    const requireFunc = typeof __webpack_require__ === 'function' ? __non_webpack_require__ : require;
+    // TODO: implement or reuse Resolver approach so it will work in node and browser envs
+    const requireFunc = (plugin) => {
+        if (env_1.isBrowser && utils_2.isString(plugin)) {
+            logger_1.logger.error(`Cannot load ${plugin}. Plugins aren't supported in browser yet.`);
+            return undefined;
+        }
+        if (utils_2.isString(plugin)) {
+            const absoltePluginPath = path.resolve(path.dirname(configPath), plugin);
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            return typeof __webpack_require__ === 'function'
+                ? // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    // @ts-ignore
+                    __non_webpack_require__(absoltePluginPath)
+                : require(absoltePluginPath);
+        }
+        return plugin;
+    };
     const seenPluginIds = new Map();
     return plugins
         .map((p) => {
         if (utils_2.isString(p) && ref_utils_1.isAbsoluteUrl(p)) {
-            throw new Error(colorette_1.red(`We don't support remote plugins yet.`));
+            throw new Error(logger_1.colorize.red(`We don't support remote plugins yet.`));
         }
         // TODO: resolve npm packages similar to eslint
-        const pluginModule = utils_2.isString(p)
-            ? requireFunc(path.resolve(path.dirname(configPath), p))
-            : p;
+        const pluginModule = requireFunc(p);
+        if (!pluginModule) {
+            return;
+        }
         const id = pluginModule.id;
         if (typeof id !== 'string') {
-            throw new Error(colorette_1.red(`Plugin must define \`id\` property in ${colorette_1.blue(p.toString())}.`));
+            throw new Error(logger_1.colorize.red(`Plugin must define \`id\` property in ${logger_1.colorize.blue(p.toString())}.`));
         }
         if (seenPluginIds.has(id)) {
             const pluginPath = seenPluginIds.get(id);
-            throw new Error(colorette_1.red(`Plugin "id" must be unique. Plugin ${colorette_1.blue(p.toString())} uses id "${colorette_1.blue(id)}" already seen in ${colorette_1.blue(pluginPath)}`));
+            throw new Error(logger_1.colorize.red(`Plugin "id" must be unique. Plugin ${logger_1.colorize.blue(p.toString())} uses id "${logger_1.colorize.blue(id)}" already seen in ${logger_1.colorize.blue(pluginPath)}`));
         }
         seenPluginIds.set(id, p.toString());
         const plugin = Object.assign(Object.assign({ id }, (pluginModule.configs ? { configs: pluginModule.configs } : {})), (pluginModule.typeExtension ? { typeExtension: pluginModule.typeExtension } : {}));
@@ -117,14 +135,14 @@ function resolvePlugins(plugins, configPath = '') {
         }
         return plugin;
     })
-        .filter(utils_2.notUndefined);
+        .filter(utils_2.isDefined);
 }
 exports.resolvePlugins = resolvePlugins;
 function resolveApis({ rawConfig, configPath = '', resolver, }) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         const { apis = {}, styleguide: styleguideConfig = {} } = rawConfig;
-        let resolvedApis = {};
+        const resolvedApis = {};
         for (const [apiName, apiContent] of Object.entries(apis || {})) {
             if ((_b = (_a = apiContent.styleguide) === null || _a === void 0 ? void 0 : _a.extends) === null || _b === void 0 ? void 0 : _b.some(utils_2.isNotString)) {
                 throw new Error(`Error configuration format not detected in extends value must contain strings`);
@@ -188,13 +206,13 @@ function resolvePreset(presetName, plugins) {
     const { pluginId, configName } = utils_1.parsePresetName(presetName);
     const plugin = plugins.find((p) => p.id === pluginId);
     if (!plugin) {
-        throw new Error(`Invalid config ${colorette_1.red(presetName)}: plugin ${pluginId} is not included.`);
+        throw new Error(`Invalid config ${logger_1.colorize.red(presetName)}: plugin ${pluginId} is not included.`);
     }
     const preset = (_a = plugin.configs) === null || _a === void 0 ? void 0 : _a[configName];
     if (!preset) {
         throw new Error(pluginId
-            ? `Invalid config ${colorette_1.red(presetName)}: plugin ${pluginId} doesn't export config with name ${configName}.`
-            : `Invalid config ${colorette_1.red(presetName)}: there is no such built-in config.`);
+            ? `Invalid config ${logger_1.colorize.red(presetName)}: plugin ${pluginId} doesn't export config with name ${configName}.`
+            : `Invalid config ${logger_1.colorize.red(presetName)}: there is no such built-in config.`);
     }
     return preset;
 }

package/lib/config/config.d.ts

@@ -1,9 +1,7 @@
-/// <reference types="node" />
 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 } from './types';
-export declare const env: NodeJS.ProcessEnv;
 export declare const IGNORE_FILE = ".redocly.lint-ignore.yaml";
 export declare const DEFAULT_REGION = "us";
 export declare const DOMAINS: {
@@ -32,13 +30,13 @@ export declare class StyleguideConfig {
     addProblemToIgnore(problem: NormalizedProblem): NormalizedProblem;
     extendTypes(types: Record<string, NodeType>, version: OasVersion): Record<string, NodeType>;
     getRuleSettings(ruleId: string, oasVersion: OasVersion): {
-        severity: import("./types").RuleSeverity;
+        severity: string;
     };
     getPreprocessorSettings(ruleId: string, oasVersion: OasVersion): {
-        severity: import("./types").RuleSeverity;
+        severity: string;
     };
     getDecoratorSettings(ruleId: string, oasVersion: OasVersion): {
-        severity: import("./types").RuleSeverity;
+        severity: string;
     };
     getUnusedRules(): {
         rules: string[];

package/lib/config/config.js

@@ -1,14 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Config = exports.StyleguideConfig = exports.AVAILABLE_REGIONS = exports.DOMAINS = exports.DEFAULT_REGION = exports.IGNORE_FILE = exports.env = void 0;
+exports.Config = exports.StyleguideConfig = exports.AVAILABLE_REGIONS = exports.DOMAINS = exports.DEFAULT_REGION = exports.IGNORE_FILE = void 0;
 const fs = require("fs");
 const path = require("path");
 const js_yaml_1 = require("../js-yaml");
 const utils_1 = require("../utils");
 const oas_types_1 = require("../oas-types");
+const env_1 = require("../env");
 const utils_2 = require("./utils");
-// Alias environment here so this file can work in browser environments too.
-exports.env = typeof process !== 'undefined' ? process.env || {} : {};
 exports.IGNORE_FILE = '.redocly.lint-ignore.yaml';
 const IGNORE_BANNER = `# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.\n` +
     `# See https://redoc.ly/docs/cli/ for more information.\n`;
@@ -19,7 +18,7 @@ function getDomains() {
         eu: 'eu.redocly.com',
     };
     // FIXME: temporary fix for our lab environments
-    const domain = exports.env.REDOCLY_DOMAIN;
+    const domain = env_1.env.REDOCLY_DOMAIN;
     if (domain === null || domain === void 0 ? void 0 : domain.endsWith('.redocly.host')) {
         domains[domain.split('.')[0]] = domain;
     }
@@ -125,10 +124,12 @@ class StyleguideConfig {
                         if (!plugin.typeExtension.oas3)
                             continue;
                         extendedTypes = plugin.typeExtension.oas3(extendedTypes, version);
+                        break;
                     case oas_types_1.OasVersion.Version2:
                         if (!plugin.typeExtension.oas2)
                             continue;
                         extendedTypes = plugin.typeExtension.oas2(extendedTypes, version);
+                        break;
                     default:
                         throw new Error('Not implemented');
                 }
@@ -193,12 +194,14 @@ class StyleguideConfig {
     getRulesForOasVersion(version) {
         switch (version) {
             case oas_types_1.OasMajorVersion.Version3:
+                // eslint-disable-next-line no-case-declarations
                 const oas3Rules = []; // default ruleset
                 this.plugins.forEach((p) => { var _a; return ((_a = p.preprocessors) === null || _a === void 0 ? void 0 : _a.oas3) && oas3Rules.push(p.preprocessors.oas3); });
                 this.plugins.forEach((p) => { var _a; return ((_a = p.rules) === null || _a === void 0 ? void 0 : _a.oas3) && oas3Rules.push(p.rules.oas3); });
                 this.plugins.forEach((p) => { var _a; return ((_a = p.decorators) === null || _a === void 0 ? void 0 : _a.oas3) && oas3Rules.push(p.decorators.oas3); });
                 return oas3Rules;
             case oas_types_1.OasMajorVersion.Version2:
+                // eslint-disable-next-line no-case-declarations
                 const oas2Rules = []; // default ruleset
                 this.plugins.forEach((p) => { var _a; return ((_a = p.preprocessors) === null || _a === void 0 ? void 0 : _a.oas2) && oas2Rules.push(p.preprocessors.oas2); });
                 this.plugins.forEach((p) => { var _a; return ((_a = p.rules) === null || _a === void 0 ? void 0 : _a.oas2) && oas2Rules.push(p.rules.oas2); });

package/lib/config/load.d.ts

@@ -1,6 +1,13 @@
 import { Config } from './config';
 import type { RawConfig } from './types';
+import { RegionalTokenWithValidity } from '../redocly/redocly-client-types';
 export declare function loadConfig(configPath?: string | undefined, customExtends?: string[], processRawConfig?: (rawConfig: RawConfig) => void | Promise<void>): Promise<Config>;
 export declare const CONFIG_FILE_NAMES: string[];
 export declare function findConfig(dir?: string): string | undefined;
 export declare function getConfig(configPath?: string | undefined): Promise<RawConfig>;
+declare type CreateConfigOptions = {
+    extends?: string[];
+    tokens?: RegionalTokenWithValidity[];
+};
+export declare function createConfig(config: string | RawConfig, options?: CreateConfigOptions): Promise<Config>;
+export {};

package/lib/config/load.js

@@ -9,15 +9,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getConfig = exports.findConfig = exports.CONFIG_FILE_NAMES = exports.loadConfig = void 0;
+exports.createConfig = exports.getConfig = exports.findConfig = exports.CONFIG_FILE_NAMES = exports.loadConfig = void 0;
 const fs = require("fs");
 const path = require("path");
 const redocly_1 = require("../redocly");
 const utils_1 = require("../utils");
+const js_yaml_1 = require("../js-yaml");
 const config_1 = require("./config");
 const utils_2 = require("./utils");
 const config_resolvers_1 = require("./config-resolvers");
-function addConfigMetadata({ rawConfig, customExtends, configPath, }) {
+function addConfigMetadata({ rawConfig, customExtends, configPath, tokens, }) {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
         if (customExtends !== undefined) {
@@ -28,9 +29,7 @@ function addConfigMetadata({ rawConfig, customExtends, configPath, }) {
             // TODO: check if we can add recommended here. add message here?
             // rawConfig.styleguide = { extends: ['recommended'], recommendedFallback: true };
         }
-        const redoclyClient = new redocly_1.RedoclyClient();
-        const tokens = yield redoclyClient.getTokens();
-        if (tokens.length) {
+        if (tokens === null || tokens === void 0 ? void 0 : tokens.length) {
             if (!rawConfig.resolve)
                 rawConfig.resolve = {};
             if (!rawConfig.resolve.http)
@@ -66,10 +65,13 @@ function loadConfig(configPath = findConfig(), customExtends, processRawConfig)
         if (typeof processRawConfig === 'function') {
             yield processRawConfig(rawConfig);
         }
-        return yield addConfigMetadata({
+        const redoclyClient = new redocly_1.RedoclyClient();
+        const tokens = yield redoclyClient.getTokens();
+        return addConfigMetadata({
             rawConfig,
             customExtends,
             configPath,
+            tokens,
         });
     });
 }
@@ -103,3 +105,9 @@ function getConfig(configPath = findConfig()) {
     });
 }
 exports.getConfig = getConfig;
+function createConfig(config, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return addConfigMetadata(Object.assign({ rawConfig: utils_2.transformConfig(typeof config === 'string' ? js_yaml_1.parseYaml(config) : config) }, options));
+    });
+}
+exports.createConfig = createConfig;

package/lib/config/minimal.js

@@ -24,7 +24,7 @@ exports.default = {
         'operation-operationId-unique': 'warn',
         'operation-parameters-unique': 'warn',
         'operation-tag-defined': 'off',
-        'operation-security-defined': 'warn',
+        'security-defined': 'warn',
         'operation-operationId-url-safe': 'warn',
         'operation-singular-tag': 'off',
         'no-unresolved-refs': 'error',
@@ -36,7 +36,7 @@ exports.default = {
     oas3_0Rules: {
         'no-invalid-media-type-examples': {
             severity: 'warn',
-            disallowAdditionalProperties: true,
+            allowAdditionalProperties: false,
         },
         'no-server-example.com': 'warn',
         'no-server-trailing-slash': 'error',
@@ -44,15 +44,18 @@ exports.default = {
         'no-example-value-and-externalValue': 'warn',
         'no-unused-components': 'warn',
         'no-undefined-server-variable': 'warn',
-        'no-servers-empty-enum': 'error',
+        'no-server-variables-empty-enum': 'error',
+        'spec-components-invalid-map-name': 'warn',
     },
     oas3_1Rules: {
+        'no-invalid-media-type-examples': 'warn',
         'no-server-example.com': 'warn',
         'no-server-trailing-slash': 'error',
         'no-empty-servers': 'warn',
         'no-example-value-and-externalValue': 'warn',
         'no-unused-components': 'warn',
         'no-undefined-server-variable': 'warn',
-        'no-servers-empty-enum': 'error',
+        'no-server-variables-empty-enum': 'error',
+        'spec-components-invalid-map-name': 'warn',
     },
 };

package/lib/config/recommended.js

@@ -25,7 +25,7 @@ exports.default = {
         'operation-operationId-url-safe': 'error',
         'operation-parameters-unique': 'error',
         'operation-tag-defined': 'off',
-        'operation-security-defined': 'error',
+        'security-defined': 'error',
         'operation-singular-tag': 'off',
         'no-unresolved-refs': 'error',
         'no-enum-type-mismatch': 'error',
@@ -36,7 +36,7 @@ exports.default = {
     oas3_0Rules: {
         'no-invalid-media-type-examples': {
             severity: 'warn',
-            disallowAdditionalProperties: true,
+            allowAdditionalProperties: false,
         },
         'no-server-example.com': 'warn',
         'no-server-trailing-slash': 'error',
@@ -44,15 +44,18 @@ exports.default = {
         'no-example-value-and-externalValue': 'error',
         'no-unused-components': 'warn',
         'no-undefined-server-variable': 'error',
-        'no-servers-empty-enum': 'error',
+        'no-server-variables-empty-enum': 'error',
+        'spec-components-invalid-map-name': 'error',
     },
     oas3_1Rules: {
+        'no-invalid-media-type-examples': 'warn',
         'no-server-example.com': 'warn',
         'no-server-trailing-slash': 'error',
         'no-empty-servers': 'error',
         'no-example-value-and-externalValue': 'error',
         'no-unused-components': 'warn',
         'no-undefined-server-variable': 'error',
-        'no-servers-empty-enum': 'error',
+        'no-server-variables-empty-enum': 'error',
+        'spec-components-invalid-map-name': 'error',
     },
 };

package/lib/config/rules.d.ts

@@ -1,7 +1,7 @@
 import { RuleSet, OasVersion } from '../oas-types';
 import { StyleguideConfig } from './config';
 export declare function initRules<T extends Function, P extends RuleSet<T>>(rules: P[], config: StyleguideConfig, type: 'rules' | 'preprocessors' | 'decorators', oasVersion: OasVersion): {
-    severity: import("./types").RuleSeverity;
+    severity: string;
     ruleId: string;
     visitor: any;
 }[];

package/lib/config/rules.js

@@ -29,6 +29,6 @@ function initRules(rules, config, type, oasVersion) {
         };
     }))
         .flatMap((visitor) => visitor)
-        .filter(utils_1.notUndefined);
+        .filter(utils_1.isDefined);
 }
 exports.initRules = initRules;

package/lib/config/types.d.ts

@@ -72,6 +72,7 @@ export declare type ResolveHeader = {
 };
 export declare type RawResolveConfig = {
     http?: Partial<HttpResolveConfig>;
+    doNotResolveExamples?: boolean;
 };
 export declare type HttpResolveConfig = {
     headers: ResolveHeader[];
@@ -87,6 +88,7 @@ export declare type AccessTokens = {
 export declare type DeprecatedInRawConfig = {
     apiDefinitions?: Record<string, string>;
     lint?: StyleguideRawConfig;
+    styleguide?: StyleguideRawConfig;
     referenceDocs?: Record<string, any>;
     apis?: Record<string, Api & DeprecatedInApi>;
 };
@@ -107,6 +109,11 @@ export declare type RawConfig = {
     region?: Region;
     organization?: string;
 } & FeaturesConfig;
+export declare type FlatApi = Omit<Api, 'styleguide'> & Omit<ApiStyleguideRawConfig, 'doNotResolveExamples'>;
+export declare type FlatRawConfig = Omit<RawConfig, 'styleguide' | 'resolve' | 'apis'> & Omit<StyleguideRawConfig, 'doNotResolveExamples'> & {
+    resolve?: RawResolveConfig;
+    apis?: Record<string, FlatApi>;
+};
 export declare type ResolvedConfig = Omit<RawConfig, 'apis' | 'styleguide'> & {
     apis: Record<string, ResolvedApi>;
     styleguide: ResolvedStyleguideConfig;

package/lib/config/utils.d.ts

@@ -1,5 +1,5 @@
 import { Config } from './config';
-import type { Api, DeprecatedInRawConfig, Plugin, RawConfig, RawResolveConfig, ResolveConfig, ResolvedStyleguideConfig, RulesFields } from './types';
+import type { Api, DeprecatedInRawConfig, FlatRawConfig, Plugin, RawConfig, RawResolveConfig, ResolveConfig, ResolvedStyleguideConfig, RulesFields } from './types';
 export declare function parsePresetName(presetName: string): {
     pluginId: string;
     configName: string;
@@ -8,6 +8,6 @@ export declare function transformApiDefinitionsToApis(apiDefinitions?: Deprecate
 export declare function prefixRules<T extends Record<string, any>>(rules: T, prefix: string): any;
 export declare function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]): Omit<ResolvedStyleguideConfig, RulesFields> & Required<Pick<ResolvedStyleguideConfig, RulesFields>>;
 export declare function getMergedConfig(config: Config, apiName?: string): Config;
-export declare function transformConfig(rawConfig: DeprecatedInRawConfig & RawConfig): RawConfig;
+export declare function transformConfig(rawConfig: DeprecatedInRawConfig & RawConfig & FlatRawConfig): RawConfig;
 export declare function getResolveConfig(resolve?: RawResolveConfig): ResolveConfig;
 export declare function getUniquePlugins(plugins: Plugin[]): Plugin[];

package/lib/config/utils.js

@@ -12,9 +12,9 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUniquePlugins = exports.getResolveConfig = exports.transformConfig = exports.getMergedConfig = exports.mergeExtends = exports.prefixRules = exports.transformApiDefinitionsToApis = exports.parsePresetName = void 0;
-const colorette_1 = require("colorette");
 const utils_1 = require("../utils");
 const config_1 = require("./config");
+const logger_1 = require("../logger");
 function parsePresetName(presetName) {
     if (presetName.indexOf('/') > -1) {
         const [pluginId, configName] = presetName.split('/');
@@ -35,13 +35,46 @@ function transformApiDefinitionsToApis(apiDefinitions) {
     return apis;
 }
 exports.transformApiDefinitionsToApis = transformApiDefinitionsToApis;
+function extractFlatConfig(_a) {
+    var _b;
+    var { plugins, extends: _extends, rules, oas2Rules, oas3_0Rules, oas3_1Rules, preprocessors, oas2Preprocessors, oas3_0Preprocessors, oas3_1Preprocessors, decorators, oas2Decorators, oas3_0Decorators, oas3_1Decorators } = _a, rawConfigRest = __rest(_a, ["plugins", "extends", "rules", "oas2Rules", "oas3_0Rules", "oas3_1Rules", "preprocessors", "oas2Preprocessors", "oas3_0Preprocessors", "oas3_1Preprocessors", "decorators", "oas2Decorators", "oas3_0Decorators", "oas3_1Decorators"]);
+    const styleguideConfig = {
+        plugins,
+        extends: _extends,
+        rules,
+        oas2Rules,
+        oas3_0Rules,
+        oas3_1Rules,
+        preprocessors,
+        oas2Preprocessors,
+        oas3_0Preprocessors,
+        oas3_1Preprocessors,
+        decorators,
+        oas2Decorators,
+        oas3_0Decorators,
+        oas3_1Decorators,
+        doNotResolveExamples: (_b = rawConfigRest.resolve) === null || _b === void 0 ? void 0 : _b.doNotResolveExamples,
+    };
+    if ((rawConfigRest.lint && rawConfigRest.styleguide) ||
+        (Object.values(styleguideConfig).some(utils_1.isDefined) &&
+            (rawConfigRest.lint || rawConfigRest.styleguide))) {
+        throw new Error(`Do not use 'lint', 'styleguide' and flat syntax together. \nSee more about the configuration in the docs: https://redocly.com/docs/cli/configuration/ \n`);
+    }
+    return {
+        styleguideConfig: Object.values(styleguideConfig).some(utils_1.isDefined)
+            ? styleguideConfig
+            : undefined,
+        rawConfigRest,
+    };
+}
 function transformApis(legacyApis) {
     if (!legacyApis)
         return undefined;
     const apis = {};
     for (let _a of Object.entries(legacyApis)) {
         const [apiName, _b] = _a, { lint } = _b, apiContent = __rest(_b, ["lint"]);
-        apis[apiName] = Object.assign({ styleguide: lint }, apiContent);
+        const { styleguideConfig, rawConfigRest } = extractFlatConfig(apiContent);
+        apis[apiName] = Object.assign({ styleguide: styleguideConfig || lint }, rawConfigRest);
     }
     return apis;
 }
@@ -73,7 +106,7 @@ function mergeExtends(rulesConfList) {
         pluginPaths: [],
         extendPaths: [],
     };
-    for (let rulesConf of rulesConfList) {
+    for (const rulesConf of rulesConfList) {
         if (rulesConf.extends) {
             throw new Error(`'extends' is not supported in shared configs yet: ${JSON.stringify(rulesConf, null, 2)}.`);
         }
@@ -112,13 +145,13 @@ function getMergedConfig(config, apiName) {
         (_b = (_a = config.rawConfig) === null || _a === void 0 ? void 0 : _a.styleguide) === null || _b === void 0 ? void 0 : _b.extendPaths,
     ]
         .flat()
-        .filter(Boolean);
+        .filter(utils_1.isTruthy);
     const pluginPaths = [
         ...Object.values(config.apis).map((api) => { var _a; return (_a = api === null || api === void 0 ? void 0 : api.styleguide) === null || _a === void 0 ? void 0 : _a.pluginPaths; }),
         (_d = (_c = config.rawConfig) === null || _c === void 0 ? void 0 : _c.styleguide) === null || _d === void 0 ? void 0 : _d.pluginPaths,
     ]
         .flat()
-        .filter(Boolean);
+        .filter(utils_1.isTruthy);
     return apiName
         ? new config_1.Config(Object.assign(Object.assign({}, config.rawConfig), { styleguide: Object.assign(Object.assign({}, (config.apis[apiName]
                 ? config.apis[apiName].styleguide
@@ -130,24 +163,29 @@ exports.getMergedConfig = getMergedConfig;
 function checkForDeprecatedFields(deprecatedField, updatedField, rawConfig) {
     const isDeprecatedFieldInApis = rawConfig.apis &&
         Object.values(rawConfig.apis).some((api) => api[deprecatedField]);
-    if (rawConfig[deprecatedField] && rawConfig[updatedField]) {
-        throw new Error(`Do not use '${deprecatedField}' field. Use '${updatedField}' instead.\n`);
+    if (rawConfig[deprecatedField] && updatedField === null) {
+        utils_1.showWarningForDeprecatedField(deprecatedField);
+    }
+    if (rawConfig[deprecatedField] && updatedField && rawConfig[updatedField]) {
+        utils_1.showErrorForDeprecatedField(deprecatedField, updatedField);
     }
     if (rawConfig[deprecatedField] || isDeprecatedFieldInApis) {
-        process.stderr.write(`The ${colorette_1.yellow(deprecatedField)} field is deprecated. Use ${colorette_1.green(updatedField)} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`);
+        utils_1.showWarningForDeprecatedField(deprecatedField, updatedField);
     }
 }
 function transformConfig(rawConfig) {
     const migratedFields = [
         ['apiDefinitions', 'apis'],
         ['referenceDocs', 'features.openapi'],
-        ['lint', 'styleguide'], // TODO: update docs
+        ['lint', undefined],
+        ['styleguide', undefined],
     ];
     for (const [deprecatedField, updatedField] of migratedFields) {
         checkForDeprecatedFields(deprecatedField, updatedField, rawConfig);
     }
     const { apis, apiDefinitions, referenceDocs, lint } = rawConfig, rest = __rest(rawConfig, ["apis", "apiDefinitions", "referenceDocs", "lint"]);
-    return Object.assign({ 'features.openapi': referenceDocs, apis: transformApis(apis) || transformApiDefinitionsToApis(apiDefinitions), styleguide: lint }, rest);
+    const { styleguideConfig, rawConfigRest } = extractFlatConfig(rest);
+    return Object.assign({ 'features.openapi': referenceDocs, apis: transformApis(apis) || transformApiDefinitionsToApis(apiDefinitions), styleguide: styleguideConfig || lint }, rawConfigRest);
 }
 exports.transformConfig = transformConfig;
 function getResolveConfig(resolve) {
@@ -169,7 +207,7 @@ function getUniquePlugins(plugins) {
             seen.add(p.id);
         }
         else if (p.id) {
-            process.stderr.write(`Duplicate plugin id "${colorette_1.yellow(p.id)}".\n`);
+            logger_1.logger.warn(`Duplicate plugin id "${logger_1.colorize.red(p.id)}".\n`);
         }
     }
     return results;