@redocly/openapi-core 1.0.0-beta.99 → 1.0.0-rc.2

package/lib/config/load.js

@@ -9,29 +9,26 @@ 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 loadConfig(configPath = findConfig(), customExtends) {
+function addConfigMetadata({ rawConfig, customExtends, configPath, tokens, files, region, }) {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
-        const rawConfig = yield getConfig(configPath);
         if (customExtends !== undefined) {
-            rawConfig.lint = rawConfig.lint || {};
-            rawConfig.lint.extends = customExtends;
+            rawConfig.styleguide = rawConfig.styleguide || {};
+            rawConfig.styleguide.extends = customExtends;
         }
         else if (utils_1.isEmptyObject(rawConfig)) {
-            // TODO: check if we can add recommended here. add message here?
-            // rawConfig.lint = { extends: ['recommended'], recommendedFallback: true };
+            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)
@@ -58,7 +55,23 @@ function loadConfig(configPath = findConfig(), customExtends) {
                     : []));
             }
         }
-        return config_resolvers_1.resolveConfig(rawConfig, configPath);
+        return config_resolvers_1.resolveConfig(Object.assign(Object.assign({}, rawConfig), { files: files !== null && files !== void 0 ? files : rawConfig.files, region: region !== null && region !== void 0 ? region : rawConfig.region }), configPath);
+    });
+}
+function loadConfig(options = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { configPath = findConfig(), customExtends, processRawConfig, files, region } = options;
+        const rawConfig = yield getConfig(configPath, processRawConfig);
+        const redoclyClient = new redocly_1.RedoclyClient();
+        const tokens = yield redoclyClient.getTokens();
+        return addConfigMetadata({
+            rawConfig,
+            customExtends,
+            configPath,
+            tokens,
+            files,
+            region,
+        });
     });
 }
 exports.loadConfig = loadConfig;
@@ -77,12 +90,15 @@ function findConfig(dir) {
     return existingConfigFiles[0];
 }
 exports.findConfig = findConfig;
-function getConfig(configPath = findConfig()) {
+function getConfig(configPath = findConfig(), processRawConfig) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!configPath)
+        if (!configPath || !utils_1.doesYamlFileExist(configPath))
             return {};
         try {
-            const rawConfig = ((yield utils_1.loadYaml(configPath)) || {});
+            const rawConfig = (yield utils_1.loadYaml(configPath)) || {};
+            if (typeof processRawConfig === 'function') {
+                yield processRawConfig(rawConfig);
+            }
             return utils_2.transformConfig(rawConfig);
         }
         catch (e) {
@@ -91,3 +107,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.d.ts

@@ -1,3 +1,3 @@
-import type { PluginLintConfig } from './types';
-declare const _default: PluginLintConfig;
+import type { PluginStyleguideConfig } from './types';
+declare const _default: PluginStyleguideConfig;
 export default _default;

package/lib/config/minimal.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     rules: {
-        'info-description': 'warn',
         'info-contact': 'off',
         'info-license': 'off',
         'info-license-url': 'off',
@@ -18,13 +17,13 @@ exports.default = {
         'operation-description': 'off',
         'operation-2xx-response': 'warn',
         'operation-4xx-response': 'off',
-        'assertions': 'warn',
+        assertions: 'warn',
         'operation-operationId': 'warn',
         'operation-summary': 'warn',
         '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',
@@ -32,11 +31,13 @@ exports.default = {
         'boolean-parameter-prefixes': 'off',
         'paths-kebab-case': 'off',
         spec: 'error',
+        'spec-strict-refs': 'off',
+        'component-name-unique': 'off',
     },
     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 +45,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.d.ts

@@ -1,3 +1,3 @@
-import type { PluginLintConfig } from './types';
-declare const _default: PluginLintConfig;
+import type { PluginStyleguideConfig } from './types';
+declare const _default: PluginStyleguideConfig;
 export default _default;

package/lib/config/recommended.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     rules: {
-        'info-description': 'warn',
         'info-contact': 'off',
         'info-license': 'warn',
         'info-license-url': 'warn',
@@ -17,7 +16,7 @@ exports.default = {
         'path-parameters-defined': 'error',
         'operation-description': 'off',
         'operation-2xx-response': 'warn',
-        'assertions': 'warn',
+        assertions: 'warn',
         'operation-4xx-response': 'warn',
         'operation-operationId': 'warn',
         'operation-summary': 'error',
@@ -25,18 +24,20 @@ 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',
         'boolean-parameter-prefixes': 'off',
         'paths-kebab-case': 'off',
         spec: 'error',
+        'spec-strict-refs': 'off',
+        'component-name-unique': 'off',
     },
     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 +45,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,10 @@
 import { RuleSet, OasVersion } from '../oas-types';
-import { LintConfig } from './config';
-export declare function initRules<T extends Function, P extends RuleSet<T>>(rules: P[], config: LintConfig, type: 'rules' | 'preprocessors' | 'decorators', oasVersion: OasVersion): {
-    severity: import("..").ProblemSeverity | "off";
+import { StyleguideConfig } from './config';
+import type { ProblemSeverity } from '../walk';
+declare type InitializedRule = {
+    severity: ProblemSeverity;
     ruleId: string;
     visitor: any;
-}[];
+};
+export declare function initRules<T extends Function, P extends RuleSet<T>>(rules: P[], config: StyleguideConfig, type: 'rules' | 'preprocessors' | 'decorators', oasVersion: OasVersion): InitializedRule[];
+export {};

package/lib/config/rules.js

@@ -14,21 +14,22 @@ function initRules(rules, config, type, oasVersion) {
         if (ruleSettings.severity === 'off') {
             return undefined;
         }
+        const severity = ruleSettings.severity;
         const visitors = rule(ruleSettings);
         if (Array.isArray(visitors)) {
             return visitors.map((visitor) => ({
-                severity: ruleSettings.severity,
+                severity,
                 ruleId,
                 visitor: visitor,
             }));
         }
         return {
-            severity: ruleSettings.severity,
+            severity,
             ruleId,
             visitor: visitors, // note: actually it is only one visitor object
         };
     }))
-        .flatMap(visitor => visitor)
-        .filter(utils_1.notUndefined);
+        .flatMap((visitor) => visitor)
+        .filter(utils_1.isDefined);
 }
 exports.initRules = initRules;

package/lib/config/types.d.ts

@@ -1,14 +1,21 @@
-import type { ProblemSeverity } from '../walk';
+import type { ProblemSeverity, UserContext } from '../walk';
 import type { Oas3PreprocessorsSet, OasMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, OasVersion } from '../oas-types';
 import type { NodeType } from '../types';
-export declare type RuleConfig = ProblemSeverity | 'off' | ({
+import { Location } from '../ref-utils';
+import type { SkipFunctionContext } from '../visitors';
+export declare type RuleSeverity = ProblemSeverity | 'off';
+export declare type RuleSettings = {
+    severity: RuleSeverity;
+};
+export declare type PreprocessorSeverity = RuleSeverity | 'on';
+export declare type RuleConfig = RuleSeverity | ({
     severity?: ProblemSeverity;
 } & Record<string, any>);
-export declare type PreprocessorConfig = ProblemSeverity | 'off' | 'on' | ({
+export declare type PreprocessorConfig = PreprocessorSeverity | ({
     severity?: ProblemSeverity;
 } & Record<string, any>);
 export declare type DecoratorConfig = PreprocessorConfig;
-export declare type LintRawConfig = {
+export declare type StyleguideRawConfig = {
     plugins?: (string | Plugin)[];
     extends?: string[];
     doNotResolveExamples?: boolean;
@@ -26,7 +33,8 @@ export declare type LintRawConfig = {
     oas3_0Decorators?: Record<string, DecoratorConfig>;
     oas3_1Decorators?: Record<string, DecoratorConfig>;
 };
-export declare type ResolvedLintConfig = PluginLintConfig & {
+export declare type ApiStyleguideRawConfig = Omit<StyleguideRawConfig, 'plugins'>;
+export declare type ResolvedStyleguideConfig = PluginStyleguideConfig & {
     plugins?: Plugin[];
     recommendedFallback?: boolean;
     extends?: void | never;
@@ -47,15 +55,25 @@ export declare type CustomRulesConfig = {
     oas3?: Oas3RuleSet;
     oas2?: Oas2RuleSet;
 };
+export declare type AssertionContext = Partial<UserContext> & SkipFunctionContext & {
+    node: any;
+};
+export declare type AssertResult = {
+    message?: string;
+    location?: Location;
+};
+export declare type CustomFunction = (value: any, options: unknown, baseLocation: Location) => AssertResult[];
+export declare type AssertionsConfig = Record<string, CustomFunction>;
 export declare type Plugin = {
     id: string;
-    configs?: Record<string, PluginLintConfig>;
+    configs?: Record<string, PluginStyleguideConfig>;
     rules?: CustomRulesConfig;
     preprocessors?: PreprocessorsConfig;
     decorators?: DecoratorsConfig;
     typeExtension?: TypeExtensionsConfig;
+    assertions?: AssertionsConfig;
 };
-export declare type PluginLintConfig = Omit<LintRawConfig, 'plugins' | 'extends'>;
+export declare type PluginStyleguideConfig = Omit<StyleguideRawConfig, 'plugins' | 'extends'>;
 export declare type ResolveHeader = {
     name: string;
     envVariable?: undefined;
@@ -69,6 +87,7 @@ export declare type ResolveHeader = {
 };
 export declare type RawResolveConfig = {
     http?: Partial<HttpResolveConfig>;
+    doNotResolveExamples?: boolean;
 };
 export declare type HttpResolveConfig = {
     headers: ResolveHeader[];
@@ -78,36 +97,66 @@ 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;
 };
-export declare type DeprecatedRawConfig = {
+export declare type DeprecatedInRawConfig = {
     apiDefinitions?: Record<string, string>;
-    lint?: LintRawConfig;
-    resolve?: RawResolveConfig;
-    region?: Region;
+    lint?: StyleguideRawConfig;
+    styleguide?: StyleguideRawConfig;
     referenceDocs?: Record<string, any>;
-};
+    apis?: Record<string, Api & DeprecatedInApi>;
+} & DeprecatedFeaturesConfig;
 export declare type Api = {
     root: string;
-    lint?: Omit<LintRawConfig, 'plugins'>;
-    'features.openapi'?: Record<string, any>;
-    'features.mockServer'?: Record<string, any>;
-};
-export declare type ResolvedApi = Omit<Api, 'lint'> & {
-    lint: Omit<ResolvedLintConfig, 'plugins'>;
+    styleguide?: ApiStyleguideRawConfig;
+} & ThemeConfig;
+export declare type DeprecatedInApi = {
+    lint?: ApiStyleguideRawConfig;
+} & DeprecatedFeaturesConfig;
+export declare type ResolvedApi = Omit<Api, 'styleguide'> & {
+    styleguide: ResolvedStyleguideConfig;
+    files?: string[];
 };
 export declare type RawConfig = {
     apis?: Record<string, Api>;
-    lint?: LintRawConfig;
+    styleguide?: StyleguideRawConfig;
     resolve?: RawResolveConfig;
     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'> & {
+    resolve?: RawResolveConfig;
+    apis?: Record<string, FlatApi>;
+} & ThemeRawConfig;
+export declare type ResolvedConfig = Omit<RawConfig, 'apis' | 'styleguide'> & {
+    apis: Record<string, ResolvedApi>;
+    styleguide: ResolvedStyleguideConfig;
+};
+declare type DeprecatedFeaturesConfig = {
     'features.openapi'?: Record<string, any>;
     'features.mockServer'?: Record<string, any>;
-    organization?: string;
 };
-export declare type ResolvedConfig = Omit<RawConfig, 'lint' | 'apis'> & {
-    lint: ResolvedLintConfig;
-    apis: Record<string, ResolvedApi>;
+export declare type ThemeConfig = {
+    theme?: ThemeRawConfig;
+};
+export declare type ThemeRawConfig = {
+    openapi?: Record<string, any>;
+    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.d.ts

@@ -1,13 +1,14 @@
 import { Config } from './config';
-import type { Api, DeprecatedRawConfig, Plugin, RawConfig, RawResolveConfig, ResolveConfig, ResolvedLintConfig, 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;
 };
-export declare function transformApiDefinitionsToApis(apiDefinitions?: Record<string, string>): Record<string, Api>;
+export declare function transformApiDefinitionsToApis(apiDefinitions?: DeprecatedInRawConfig['apiDefinitions']): Record<string, Api> | undefined;
 export declare function prefixRules<T extends Record<string, any>>(rules: T, prefix: string): any;
-export declare function mergeExtends(rulesConfList: ResolvedLintConfig[]): Omit<ResolvedLintConfig, RulesFields> & Required<Pick<ResolvedLintConfig, RulesFields>>;
-export declare function getMergedConfig(config: Config, entrypointAlias?: string): Config;
-export declare function transformConfig(rawConfig: DeprecatedRawConfig | RawConfig): RawConfig;
+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 checkForDeprecatedFields(deprecatedField: keyof (DeprecatedInRawConfig & RawConfig), updatedField: keyof FlatRawConfig | undefined, rawConfig: DeprecatedInRawConfig & RawConfig & FlatRawConfig, updatedObject: keyof FlatRawConfig | undefined): void;
+export declare function transformConfig(rawConfig: DeprecatedInRawConfig & RawConfig & FlatRawConfig): RawConfig;
 export declare function getResolveConfig(resolve?: RawResolveConfig): ResolveConfig;
 export declare function getUniquePlugins(plugins: Plugin[]): Plugin[];