@redocly/openapi-core 1.0.0-beta.98 → 1.0.0-rc.1

package/README.md

@@ -9,9 +9,9 @@ See https://github.com/Redocly/redocly-cli
 ```js
 import { formatProblems, lint, loadConfig } from '@redocly/openapi-core';
 
-const pathToEntryPoint = 'openapi.yaml';
-const config = loadConfig('optional/path/to/.redocly.yaml');
-const lintResults = await lint({ ref: pathToEntryPoint, config });
+const pathToApi = 'openapi.yaml';
+const config = loadConfig({ configPath: 'optional/path/to/.redocly.yaml' });
+const lintResults = await lint({ ref: pathToApi, config });
 ```
 
 ### Bundle
@@ -19,7 +19,7 @@ const lintResults = await lint({ ref: pathToEntryPoint, config });
 ```js
 import { formatProblems, bundle, loadConfig } from '@redocly/openapi-core';
 
-const pathToEntryPoint = 'openapi.yaml';
-const config = loadConfig('optional/path/to/.redocly.yaml');
-const { bundle, problems } = await bundle({ ref: pathToEntryPoint, config });
+const pathToApi = 'openapi.yaml';
+const config = loadConfig({ configPath: 'optional/path/to/.redocly.yaml' });
+const { bundle, problems } = await bundle({ ref: pathToApi, config });
 ```

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/recommended-oas3.bench.js

@@ -15,7 +15,7 @@ function measureAsync() {
     return lint_1.lintDocument({
         externalRefResolver: new resolve_1.BaseResolver(),
         document: rebillyDocument,
-        config: new config_1.LintConfig(config_1.resolvePreset('recommended', [config_1.defaultPlugin])),
+        config: new config_1.StyleguideConfig(config_1.resolvePreset('recommended', [config_1.defaultPlugin])),
     });
 }
 exports.measureAsync = measureAsync;

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/benchmark/utils.d.ts

@@ -1,6 +1,6 @@
 import { Document } from '../resolve';
 import { Oas3RuleSet } from '../oas-types';
-import { LintConfig } from '../config';
+import { StyleguideConfig } from '../config';
 import type { Plugin } from '../config/types';
 export declare function parseYamlToDocument(body: string, absoluteRef?: string): Document;
-export declare function makeConfigForRuleset(rules: Oas3RuleSet, plugin?: Partial<Plugin>): LintConfig;
+export declare function makeConfigForRuleset(rules: Oas3RuleSet, plugin?: Partial<Plugin>): StyleguideConfig;

package/lib/benchmark/utils.js

@@ -25,7 +25,7 @@ function makeConfigForRuleset(rules, plugin) {
     if (rules) {
         extendConfigs.push({ rules });
     }
-    const lint = config_1.mergeExtends(extendConfigs);
-    return new config_1.LintConfig(lint);
+    const styleguide = config_1.mergeExtends(extendConfigs);
+    return new config_1.StyleguideConfig(styleguide);
 }
 exports.makeConfigForRuleset = makeConfigForRuleset;

package/lib/bundle.d.ts

@@ -1,8 +1,9 @@
 import { BaseResolver, Document } from './resolve';
 import { Oas3Rule } from './visitors';
 import { NormalizedNodeType, NodeType } from './types';
+import { NormalizedProblem } from './walk';
 import { OasMajorVersion } from './oas-types';
-import type { Config, LintConfig } from './config';
+import type { Config, StyleguideConfig } from './config';
 export declare type Oas3RuleSet = Record<string, Oas3Rule>;
 export declare enum OasVersion {
     Version2 = "oas2",
@@ -18,28 +19,24 @@ export declare function bundle(opts: {
     base?: string;
     skipRedoclyRegistryRefs?: boolean;
     removeUnusedComponents?: boolean;
-}): Promise<{
+    keepUrlRefs?: boolean;
+}): Promise<BundleResult>;
+export declare type BundleResult = {
     bundle: Document;
-    problems: import("./walk").NormalizedProblem[];
+    problems: NormalizedProblem[];
     fileDependencies: Set<string>;
     rootType: NormalizedNodeType;
-    refTypes: Map<string, NormalizedNodeType> | undefined;
+    refTypes?: Map<string, NormalizedNodeType>;
     visitorsData: Record<string, Record<string, unknown>>;
-}>;
+};
 export declare function bundleDocument(opts: {
     document: Document;
-    config: LintConfig;
+    config: StyleguideConfig;
     customTypes?: Record<string, NodeType>;
     externalRefResolver: BaseResolver;
     dereference?: boolean;
     skipRedoclyRegistryRefs?: boolean;
     removeUnusedComponents?: boolean;
-}): Promise<{
-    bundle: Document;
-    problems: import("./walk").NormalizedProblem[];
-    fileDependencies: Set<string>;
-    rootType: NormalizedNodeType;
-    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;
+    keepUrlRefs?: boolean;
+}): Promise<BundleResult>;
+export declare function mapTypeToComponent(typeName: string, version: OasMajorVersion): "headers" | "definitions" | "parameters" | "examples" | "schemas" | "responses" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | null;

package/lib/bundle.js

@@ -42,13 +42,13 @@ function bundle(opts) {
         if (document instanceof Error) {
             throw document;
         }
-        return bundleDocument(Object.assign(Object.assign({ document }, opts), { config: opts.config.lint, externalRefResolver }));
+        return bundleDocument(Object.assign(Object.assign({ document }, opts), { config: opts.config.styleguide, externalRefResolver }));
     });
 }
 exports.bundle = bundle;
 function bundleDocument(opts) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { document, config, customTypes, externalRefResolver, dereference = false, skipRedoclyRegistryRefs = false, removeUnusedComponents = false, } = opts;
+        const { document, config, customTypes, externalRefResolver, dereference = false, skipRedoclyRegistryRefs = false, removeUnusedComponents = false, keepUrlRefs = false, } = opts;
         const oasVersion = oas_types_1.detectOpenAPI(document.parsed);
         const oasMajorVersion = oas_types_1.openAPIMajor(oasVersion);
         const rules = config.getRulesForOasVersion(oasMajorVersion);
@@ -71,26 +71,40 @@ function bundleDocument(opts) {
                 ruleId: 'remove-unused-components',
                 visitor: oasMajorVersion === oas_types_1.OasMajorVersion.Version2
                     ? remove_unused_components_1.RemoveUnusedComponents({})
-                    : remove_unused_components_2.RemoveUnusedComponents({})
+                    : remove_unused_components_2.RemoveUnusedComponents({}),
             });
         }
-        const resolvedRefMap = yield resolve_1.resolveDocument({
+        let resolvedRefMap = yield resolve_1.resolveDocument({
             rootDocument: document,
-            rootType: types.DefinitionRoot,
+            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',
-                visitor: makeBundleVisitor(oasMajorVersion, dereference, skipRedoclyRegistryRefs, document, resolvedRefMap),
+                visitor: makeBundleVisitor(oasMajorVersion, dereference, skipRedoclyRegistryRefs, document, resolvedRefMap, keepUrlRefs),
             },
             ...decorators,
         ], types);
         walk_1.walkDocument({
             document,
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             normalizedVisitors: bundleVisitor,
             resolvedRefMap,
             ctx,
@@ -99,7 +113,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,
         };
@@ -146,8 +160,9 @@ function mapTypeToComponent(typeName, version) {
 }
 exports.mapTypeToComponent = mapTypeToComponent;
 // function oas3Move
-function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDocument, resolvedRefMap) {
+function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDocument, resolvedRefMap, keepUrlRefs) {
     let components;
+    let rootLocation;
     const visitor = {
         ref: {
             leave(node, ctx, resolved) {
@@ -165,6 +180,9 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
                 if (skipRedoclyRegistryRefs && redocly_1.isRedoclyRegistryURL(node.$ref)) {
                     return;
                 }
+                if (keepUrlRefs && ref_utils_1.isAbsoluteUrl(node.$ref)) {
+                    return;
+                }
                 const componentType = mapTypeToComponent(ctx.type.name, version);
                 if (!componentType) {
                     replaceRef(node, resolved, ctx);
@@ -181,8 +199,9 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
                 }
             },
         },
-        DefinitionRoot: {
-            enter(root) {
+        Root: {
+            enter(root, ctx) {
+                rootLocation = ctx.location;
                 if (version === oas_types_1.OasMajorVersion.Version3) {
                     components = root.components = root.components || {};
                 }
@@ -228,9 +247,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) {
@@ -247,7 +269,8 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
     function isEqualOrEqualRef(node, target, ctx) {
         var _a;
         if (ref_utils_1.isRef(node) &&
-            ((_a = ctx.resolve(node).location) === null || _a === void 0 ? void 0 : _a.absolutePointer) === target.location.absolutePointer) {
+            ((_a = ctx.resolve(node, rootLocation.absolutePointer).location) === null || _a === void 0 ? void 0 : _a.absolutePointer) ===
+                target.location.absolutePointer) {
             return true;
         }
         return isEqual(node, target.node);
@@ -256,7 +279,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.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/all.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     rules: {
-        'info-description': 'error',
         'info-contact': 'error',
         'info-license': 'error',
         'info-license-url': 'error',
@@ -19,14 +18,14 @@ exports.default = {
         'operation-description': 'error',
         'operation-2xx-response': 'error',
         'operation-4xx-response': 'error',
-        'assertions': 'error',
+        assertions: 'error',
         'operation-operationId': 'error',
         'operation-summary': 'error',
         'operation-operationId-unique': 'error',
         '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',
@@ -37,10 +36,20 @@ exports.default = {
             severity: 'error',
             patterns: [],
         },
-        'request-mime-type': 'error',
+        'request-mime-type': {
+            severity: 'error',
+            allowedValues: ['application/json'],
+        },
+        'response-mime-type': {
+            severity: 'error',
+            allowedValues: ['application/json'],
+        },
         spec: 'error',
         'no-invalid-schema-examples': 'error',
         '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',
@@ -50,7 +59,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',
@@ -59,6 +69,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/builtIn.d.ts

@@ -1,3 +1,3 @@
-import type { LintRawConfig, Plugin } from './types';
-export declare const builtInConfigs: Record<string, LintRawConfig>;
+import type { StyleguideRawConfig, Plugin } from './types';
+export declare const builtInConfigs: Record<string, StyleguideRawConfig>;
 export declare const defaultPlugin: Plugin;

package/lib/config/builtIn.js

@@ -15,8 +15,8 @@ exports.builtInConfigs = {
     minimal: minimal_1.default,
     all: all_1.default,
     'redocly-registry': {
-        decorators: { 'registry-dependencies': 'on' }
-    }
+        decorators: { 'registry-dependencies': 'on' },
+    },
 };
 exports.defaultPlugin = {
     id: '',

package/lib/config/config-resolvers.d.ts

@@ -1,5 +1,5 @@
 import { BaseResolver } from '../resolve';
-import type { LintRawConfig, Plugin, RawConfig, ResolvedApi, ResolvedLintConfig } from './types';
+import type { StyleguideRawConfig, Plugin, RawConfig, ResolvedApi, ResolvedStyleguideConfig } from './types';
 import { Config } from './config';
 export declare function resolveConfig(rawConfig: RawConfig, configPath?: string): Promise<Config>;
 export declare function resolvePlugins(plugins: (string | Plugin)[] | null, configPath?: string): Plugin[];
@@ -8,9 +8,9 @@ export declare function resolveApis({ rawConfig, configPath, resolver, }: {
     configPath?: string;
     resolver?: BaseResolver;
 }): Promise<Record<string, ResolvedApi>>;
-export declare function resolveLint(lintOpts: {
-    lintConfig?: LintRawConfig;
+export declare function resolveStyleguideConfig(opts: {
+    styleguideConfig?: StyleguideRawConfig;
     configPath?: string;
     resolver?: BaseResolver;
-}, parentConfigPaths?: string[], extendPaths?: string[]): Promise<ResolvedLintConfig>;
-export declare function resolvePreset(presetName: string, plugins: Plugin[]): ResolvedLintConfig;
+}, parentConfigPaths?: string[], extendPaths?: string[]): Promise<ResolvedStyleguideConfig>;
+export declare function resolvePreset(presetName: string, plugins: Plugin[]): ResolvedStyleguideConfig;