@redocly/openapi-core 0.0.0-snapshot.1744362365 → 0.0.0-snapshot.1744801622

package/lib/bundle.js

@@ -1,22 +1,31 @@
-import { BaseResolver, resolveDocument, makeRefId, makeDocumentFromString } from './resolve.js';
-import { normalizeVisitors } from './visitors.js';
-import { normalizeTypes } from './types/index.js';
-import { walkDocument } from './walk.js';
-import { detectSpec, getTypes, getMajorSpecVersion, SpecMajorVersion, SpecVersion, } from './oas-types.js';
-import { isAbsoluteUrl, isExternalValue, isRef, refBaseName } from './ref-utils.js';
-import { initRules } from './config/rules.js';
-import { reportUnresolvedRef } from './rules/no-unresolved-refs.js';
-import { dequal, isPlainObject, isTruthy } from './utils.js';
-import { RemoveUnusedComponents as RemoveUnusedComponentsOas2 } from './decorators/oas2/remove-unused-components.js';
-import { RemoveUnusedComponents as RemoveUnusedComponentsOas3 } from './decorators/oas3/remove-unused-components.js';
-import { NormalizedConfigTypes } from './types/redocly-yaml.js';
-export var OasVersion;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OasVersion = void 0;
+exports.bundleConfig = bundleConfig;
+exports.bundle = bundle;
+exports.bundleFromString = bundleFromString;
+exports.bundleDocument = bundleDocument;
+exports.mapTypeToComponent = mapTypeToComponent;
+const resolve_1 = require("./resolve");
+const visitors_1 = require("./visitors");
+const types_1 = require("./types");
+const walk_1 = require("./walk");
+const oas_types_1 = require("./oas-types");
+const ref_utils_1 = require("./ref-utils");
+const rules_1 = require("./config/rules");
+const no_unresolved_refs_1 = require("./rules/no-unresolved-refs");
+const utils_1 = require("./utils");
+const domains_1 = require("./redocly/domains");
+const remove_unused_components_1 = require("./decorators/oas2/remove-unused-components");
+const remove_unused_components_2 = require("./decorators/oas3/remove-unused-components");
+const redocly_yaml_1 = require("./types/redocly-yaml");
+var OasVersion;
 (function (OasVersion) {
     OasVersion["Version2"] = "oas2";
     OasVersion["Version3_0"] = "oas3_0";
     OasVersion["Version3_1"] = "oas3_1";
-})(OasVersion || (OasVersion = {}));
-const bundleVisitor = normalizeVisitors([
+})(OasVersion || (exports.OasVersion = OasVersion = {}));
+const bundleVisitor = (0, visitors_1.normalizeVisitors)([
     {
         severity: 'error',
         ruleId: 'configBundler',
@@ -28,25 +37,25 @@ const bundleVisitor = normalizeVisitors([
             },
         },
     },
-], NormalizedConfigTypes);
-export async function bundleConfig(document, resolvedRefMap) {
+], redocly_yaml_1.NormalizedConfigTypes);
+async function bundleConfig(document, resolvedRefMap) {
     const ctx = {
         problems: [],
-        oasVersion: SpecVersion.OAS3_0,
+        oasVersion: oas_types_1.SpecVersion.OAS3_0,
         refTypes: new Map(),
         visitorsData: {},
     };
-    walkDocument({
+    (0, walk_1.walkDocument)({
         document,
-        rootType: NormalizedConfigTypes.ConfigRoot,
+        rootType: redocly_yaml_1.NormalizedConfigTypes.ConfigRoot,
         normalizedVisitors: bundleVisitor,
         resolvedRefMap,
         ctx,
     });
     return document.parsed ?? {};
 }
-export async function bundle(opts) {
-    const { ref, doc, externalRefResolver = new BaseResolver(opts.config.resolve), base = null, } = opts;
+async function bundle(opts) {
+    const { ref, doc, externalRefResolver = new resolve_1.BaseResolver(opts.config.resolve), base = null, } = opts;
     if (!(ref || doc)) {
         throw new Error('Document or reference is required.\n');
     }
@@ -62,9 +71,9 @@ export async function bundle(opts) {
         externalRefResolver,
     });
 }
-export async function bundleFromString(opts) {
-    const { source, absoluteRef, externalRefResolver = new BaseResolver(opts.config.resolve) } = opts;
-    const document = makeDocumentFromString(source, absoluteRef || '/');
+async function bundleFromString(opts) {
+    const { source, absoluteRef, externalRefResolver = new resolve_1.BaseResolver(opts.config.resolve) } = opts;
+    const document = (0, resolve_1.makeDocumentFromString)(source, absoluteRef || '/');
     return bundleDocument({
         document,
         ...opts,
@@ -72,14 +81,14 @@ export async function bundleFromString(opts) {
         config: opts.config.styleguide,
     });
 }
-export async function bundleDocument(opts) {
-    const { document, config, customTypes, externalRefResolver, dereference = false, removeUnusedComponents = false, keepUrlRefs = false, } = opts;
-    const specVersion = detectSpec(document.parsed);
-    const specMajorVersion = getMajorSpecVersion(specVersion);
+async function bundleDocument(opts) {
+    const { document, config, customTypes, externalRefResolver, dereference = false, skipRedoclyRegistryRefs = false, removeUnusedComponents = false, keepUrlRefs = false, } = opts;
+    const specVersion = (0, oas_types_1.detectSpec)(document.parsed);
+    const specMajorVersion = (0, oas_types_1.getMajorSpecVersion)(specVersion);
     const rules = config.getRulesForSpecVersion(specMajorVersion);
-    const types = normalizeTypes(config.extendTypes(customTypes ?? getTypes(specVersion), specVersion), config);
-    const preprocessors = initRules(rules, config, 'preprocessors', specVersion);
-    const decorators = initRules(rules, config, 'decorators', specVersion);
+    const types = (0, types_1.normalizeTypes)(config.extendTypes(customTypes ?? (0, oas_types_1.getTypes)(specVersion), specVersion), config);
+    const preprocessors = (0, rules_1.initRules)(rules, config, 'preprocessors', specVersion);
+    const decorators = (0, rules_1.initRules)(rules, config, 'decorators', specVersion);
     const ctx = {
         problems: [],
         oasVersion: specVersion,
@@ -90,40 +99,40 @@ export async function bundleDocument(opts) {
         decorators.push({
             severity: 'error',
             ruleId: 'remove-unused-components',
-            visitor: specMajorVersion === SpecMajorVersion.OAS2
-                ? RemoveUnusedComponentsOas2({})
-                : RemoveUnusedComponentsOas3({}),
+            visitor: specMajorVersion === oas_types_1.SpecMajorVersion.OAS2
+                ? (0, remove_unused_components_1.RemoveUnusedComponents)({})
+                : (0, remove_unused_components_2.RemoveUnusedComponents)({}),
         });
     }
-    let resolvedRefMap = await resolveDocument({
+    let resolvedRefMap = await (0, resolve_1.resolveDocument)({
         rootDocument: document,
         rootType: types.Root,
         externalRefResolver,
     });
     if (preprocessors.length > 0) {
         // Make additional pass to resolve refs defined in preprocessors.
-        walkDocument({
+        (0, walk_1.walkDocument)({
             document,
             rootType: types.Root,
-            normalizedVisitors: normalizeVisitors(preprocessors, types),
+            normalizedVisitors: (0, visitors_1.normalizeVisitors)(preprocessors, types),
             resolvedRefMap,
             ctx,
         });
-        resolvedRefMap = await resolveDocument({
+        resolvedRefMap = await (0, resolve_1.resolveDocument)({
             rootDocument: document,
             rootType: types.Root,
             externalRefResolver,
         });
     }
-    const bundleVisitor = normalizeVisitors([
+    const bundleVisitor = (0, visitors_1.normalizeVisitors)([
         {
             severity: 'error',
             ruleId: 'bundler',
-            visitor: makeBundleVisitor(specMajorVersion, dereference, document, resolvedRefMap, keepUrlRefs),
+            visitor: makeBundleVisitor(specMajorVersion, dereference, skipRedoclyRegistryRefs, document, resolvedRefMap, keepUrlRefs),
         },
         ...decorators,
     ], types);
-    walkDocument({
+    (0, walk_1.walkDocument)({
         document,
         rootType: types.Root,
         normalizedVisitors: bundleVisitor,
@@ -139,9 +148,9 @@ export async function bundleDocument(opts) {
         visitorsData: ctx.visitorsData,
     };
 }
-export function mapTypeToComponent(typeName, version) {
+function mapTypeToComponent(typeName, version) {
     switch (version) {
-        case SpecMajorVersion.OAS3:
+        case oas_types_1.SpecMajorVersion.OAS3:
             switch (typeName) {
                 case 'Schema':
                     return 'schemas';
@@ -164,7 +173,7 @@ export function mapTypeToComponent(typeName, version) {
                 default:
                     return null;
             }
-        case SpecMajorVersion.OAS2:
+        case oas_types_1.SpecMajorVersion.OAS2:
             switch (typeName) {
                 case 'Schema':
                     return 'definitions';
@@ -175,7 +184,7 @@ export function mapTypeToComponent(typeName, version) {
                 default:
                     return null;
             }
-        case SpecMajorVersion.Async2:
+        case oas_types_1.SpecMajorVersion.Async2:
             switch (typeName) {
                 case 'Schema':
                     return 'schemas';
@@ -184,7 +193,7 @@ export function mapTypeToComponent(typeName, version) {
                 default:
                     return null;
             }
-        case SpecMajorVersion.Async3:
+        case oas_types_1.SpecMajorVersion.Async3:
             switch (typeName) {
                 case 'Schema':
                     return 'schemas';
@@ -193,7 +202,7 @@ export function mapTypeToComponent(typeName, version) {
                 default:
                     return null;
             }
-        case SpecMajorVersion.Arazzo1:
+        case oas_types_1.SpecMajorVersion.Arazzo1:
             switch (typeName) {
                 case 'Root.workflows_items.parameters_items':
                 case 'Root.workflows_items.steps_items.parameters_items':
@@ -201,7 +210,7 @@ export function mapTypeToComponent(typeName, version) {
                 default:
                     return null;
             }
-        case SpecMajorVersion.Overlay1:
+        case oas_types_1.SpecMajorVersion.Overlay1:
             switch (typeName) {
                 default:
                     return null;
@@ -209,7 +218,7 @@ export function mapTypeToComponent(typeName, version) {
     }
 }
 function replaceRef(ref, resolved, ctx) {
-    if (!isPlainObject(resolved.node)) {
+    if (!(0, utils_1.isPlainObject)(resolved.node)) {
         ctx.parent[ctx.key] = resolved.node;
     }
     else {
@@ -221,14 +230,14 @@ function replaceRef(ref, resolved, ctx) {
     }
 }
 // function oas3Move
-function makeBundleVisitor(version, dereference, rootDocument, resolvedRefMap, keepUrlRefs) {
+function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDocument, resolvedRefMap, keepUrlRefs) {
     let components;
     let rootLocation;
     const visitor = {
         ref: {
             leave(node, ctx, resolved) {
                 if (!resolved.location || resolved.node === undefined) {
-                    reportUnresolvedRef(resolved, ctx.report, ctx.location);
+                    (0, no_unresolved_refs_1.reportUnresolvedRef)(resolved, ctx.report, ctx.location);
                     return;
                 }
                 if (resolved.location.source === rootDocument.source &&
@@ -237,7 +246,11 @@ function makeBundleVisitor(version, dereference, rootDocument, resolvedRefMap, k
                     !dereference) {
                     return;
                 }
-                if (keepUrlRefs && isAbsoluteUrl(node.$ref)) {
+                // do not bundle registry URL before push, otherwise we can't record dependencies
+                if (skipRedoclyRegistryRefs && (0, domains_1.isRedoclyRegistryURL)(node.$ref)) {
+                    return;
+                }
+                if (keepUrlRefs && (0, ref_utils_1.isAbsoluteUrl)(node.$ref)) {
                     return;
                 }
                 const componentType = mapTypeToComponent(ctx.type.name, version);
@@ -258,13 +271,13 @@ function makeBundleVisitor(version, dereference, rootDocument, resolvedRefMap, k
         },
         Example: {
             leave(node, ctx) {
-                if (isExternalValue(node) && node.value === undefined) {
+                if ((0, ref_utils_1.isExternalValue)(node) && node.value === undefined) {
                     const resolved = ctx.resolve({ $ref: node.externalValue });
                     if (!resolved.location || resolved.node === undefined) {
-                        reportUnresolvedRef(resolved, ctx.report, ctx.location);
+                        (0, no_unresolved_refs_1.reportUnresolvedRef)(resolved, ctx.report, ctx.location);
                         return;
                     }
-                    if (keepUrlRefs && isAbsoluteUrl(node.externalValue)) {
+                    if (keepUrlRefs && (0, ref_utils_1.isAbsoluteUrl)(node.externalValue)) {
                         return;
                     }
                     node.value = ctx.resolve({ $ref: node.externalValue }).node;
@@ -275,32 +288,32 @@ function makeBundleVisitor(version, dereference, rootDocument, resolvedRefMap, k
         Root: {
             enter(root, ctx) {
                 rootLocation = ctx.location;
-                if (version === SpecMajorVersion.OAS3) {
+                if (version === oas_types_1.SpecMajorVersion.OAS3) {
                     components = root.components = root.components || {};
                 }
-                else if (version === SpecMajorVersion.OAS2) {
+                else if (version === oas_types_1.SpecMajorVersion.OAS2) {
                     components = root;
                 }
-                else if (version === SpecMajorVersion.Async2) {
+                else if (version === oas_types_1.SpecMajorVersion.Async2) {
                     components = root.components = root.components || {};
                 }
-                else if (version === SpecMajorVersion.Async3) {
+                else if (version === oas_types_1.SpecMajorVersion.Async3) {
                     components = root.components = root.components || {};
                 }
-                else if (version === SpecMajorVersion.Arazzo1) {
+                else if (version === oas_types_1.SpecMajorVersion.Arazzo1) {
                     components = root.components = root.components || {};
                 }
             },
         },
     };
-    if (version === SpecMajorVersion.OAS3) {
+    if (version === oas_types_1.SpecMajorVersion.OAS3) {
         visitor.DiscriminatorMapping = {
             leave(mapping, ctx) {
                 for (const name of Object.keys(mapping)) {
                     const $ref = mapping[name];
                     const resolved = ctx.resolve({ $ref });
                     if (!resolved.location || resolved.node === undefined) {
-                        reportUnresolvedRef(resolved, ctx.report, ctx.location.child(name));
+                        (0, no_unresolved_refs_1.reportUnresolvedRef)(resolved, ctx.report, ctx.location.child(name));
                         return;
                     }
                     const componentType = mapTypeToComponent('Schema', version);
@@ -310,7 +323,7 @@ function makeBundleVisitor(version, dereference, rootDocument, resolvedRefMap, k
         };
     }
     function resolveBundledComponent(node, resolved, ctx) {
-        const newRefId = makeRefId(ctx.location.source.absoluteRef, node.$ref);
+        const newRefId = (0, resolve_1.makeRefId)(ctx.location.source.absoluteRef, node.$ref);
         resolvedRefMap.set(newRefId, {
             document: rootDocument,
             isRemote: false,
@@ -323,9 +336,9 @@ function makeBundleVisitor(version, dereference, rootDocument, resolvedRefMap, k
         components[componentType] = components[componentType] || {};
         const name = getComponentName(target, componentType, ctx);
         components[componentType][name] = target.node;
-        if (version === SpecMajorVersion.OAS3 ||
-            version === SpecMajorVersion.Async2 ||
-            version === SpecMajorVersion.Async3) {
+        if (version === oas_types_1.SpecMajorVersion.OAS3 ||
+            version === oas_types_1.SpecMajorVersion.Async2 ||
+            version === oas_types_1.SpecMajorVersion.Async3) {
             return `#/components/${componentType}/${name}`;
         }
         else {
@@ -333,18 +346,18 @@ function makeBundleVisitor(version, dereference, rootDocument, resolvedRefMap, k
         }
     }
     function isEqualOrEqualRef(node, target, ctx) {
-        if (isRef(node) &&
+        if ((0, ref_utils_1.isRef)(node) &&
             ctx.resolve(node, rootLocation.absolutePointer).location?.absolutePointer ===
                 target.location.absolutePointer) {
             return true;
         }
-        return dequal(node, target.node);
+        return (0, utils_1.dequal)(node, target.node);
     }
     function getComponentName(target, componentType, ctx) {
         const [fileRef, pointer] = [target.location.source.absoluteRef, target.location.pointer];
         const componentsGroup = components[componentType];
         let name = '';
-        const refParts = pointer.slice(2).split('/').filter(isTruthy); // 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 ||
@@ -353,7 +366,7 @@ function makeBundleVisitor(version, dereference, rootDocument, resolvedRefMap, k
                 return name;
             }
         }
-        name = refBaseName(fileRef) + (name ? `_${name}` : '');
+        name = (0, ref_utils_1.refBaseName)(fileRef) + (name ? `_${name}` : '');
         if (!componentsGroup[name] || isEqualOrEqualRef(componentsGroup[name], target, ctx)) {
             return name;
         }
@@ -374,4 +387,3 @@ function makeBundleVisitor(version, dereference, rootDocument, resolvedRefMap, k
     }
     return visitor;
 }
-//# sourceMappingURL=bundle.js.map

package/lib/config/all.d.ts

@@ -1,4 +1,3 @@
-import type { PluginStyleguideConfig } from './types.js';
+import type { PluginStyleguideConfig } from './types';
 declare const all: PluginStyleguideConfig<'built-in'>;
 export default all;
-//# sourceMappingURL=all.d.ts.map

package/lib/config/all.js

@@ -1,3 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 const all = {
     rules: {
         struct: 'error',
@@ -228,5 +230,4 @@ const all = {
         'info-contact': 'error',
     },
 };
-export default all;
-//# sourceMappingURL=all.js.map
+exports.default = all;

package/lib/config/builtIn.d.ts

@@ -1,4 +1,3 @@
-import type { StyleguideRawConfig, Plugin } from './types.js';
+import type { StyleguideRawConfig, Plugin } from './types';
 export declare const builtInConfigs: Record<string, StyleguideRawConfig>;
 export declare const defaultPlugin: Plugin<'built-in'>;
-//# sourceMappingURL=builtIn.d.ts.map

package/lib/config/builtIn.js

@@ -1,53 +1,58 @@
-import recommended from './recommended.js';
-import recommendedStrict from './recommended-strict.js';
-import all from './all.js';
-import minimal from './minimal.js';
-import spec from './spec.js';
-import { rules as oas3Rules, preprocessors as oas3Preprocessors } from '../rules/oas3/index.js';
-import { rules as oas2Rules, preprocessors as oas2Preprocessors } from '../rules/oas2/index.js';
-import { rules as async2Rules, preprocessors as async2Preprocessors, } from '../rules/async2/index.js';
-import { rules as async3Rules, preprocessors as async3Preprocessors, } from '../rules/async3/index.js';
-import { rules as arazzo1Rules, preprocessors as arazzoPreprocessors, } from '../rules/arazzo/index.js';
-import { rules as overlay1Rules, preprocessors as overlay1Preprocessors, } from '../rules/overlay1/index.js';
-import { decorators as oas3Decorators } from '../decorators/oas3/index.js';
-import { decorators as oas2Decorators } from '../decorators/oas2/index.js';
-import { decorators as async2Decorators } from '../decorators/async2/index.js';
-import { decorators as async3Decorators } from '../decorators/async3/index.js';
-import { decorators as arazzo1Decorators } from '../decorators/arazzo/index.js';
-import { decorators as overlay1Decorators } from '../decorators/overlay1/index.js';
-export const builtInConfigs = {
-    recommended,
-    'recommended-strict': recommendedStrict,
-    minimal,
-    all,
-    spec,
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultPlugin = exports.builtInConfigs = void 0;
+const recommended_1 = require("./recommended");
+const recommended_strict_1 = require("./recommended-strict");
+const all_1 = require("./all");
+const minimal_1 = require("./minimal");
+const spec_1 = require("./spec");
+const oas3_1 = require("../rules/oas3");
+const oas2_1 = require("../rules/oas2");
+const async2_1 = require("../rules/async2");
+const async3_1 = require("../rules/async3");
+const arazzo_1 = require("../rules/arazzo");
+const overlay1_1 = require("../rules/overlay1");
+const oas3_2 = require("../decorators/oas3");
+const oas2_2 = require("../decorators/oas2");
+const async2_2 = require("../decorators/async2");
+const async3_2 = require("../decorators/async3");
+const arazzo_2 = require("../decorators/arazzo");
+const overlay1_2 = require("../decorators/overlay1");
+exports.builtInConfigs = {
+    recommended: recommended_1.default,
+    'recommended-strict': recommended_strict_1.default,
+    minimal: minimal_1.default,
+    all: all_1.default,
+    spec: spec_1.default,
+    'redocly-registry': {
+        decorators: { 'registry-dependencies': 'on' },
+    },
 };
-export const defaultPlugin = {
+exports.defaultPlugin = {
     id: '', // default plugin doesn't have id
     rules: {
-        oas3: oas3Rules,
-        oas2: oas2Rules,
-        async2: async2Rules,
-        async3: async3Rules,
-        arazzo1: arazzo1Rules,
-        overlay1: overlay1Rules,
+        oas3: oas3_1.rules,
+        oas2: oas2_1.rules,
+        async2: async2_1.rules,
+        async3: async3_1.rules,
+        arazzo1: arazzo_1.rules,
+        overlay1: overlay1_1.rules,
     },
     preprocessors: {
-        oas3: oas3Preprocessors,
-        oas2: oas2Preprocessors,
-        async2: async2Preprocessors,
-        async3: async3Preprocessors,
-        arazzo1: arazzoPreprocessors,
-        overlay1: overlay1Preprocessors,
+        oas3: oas3_1.preprocessors,
+        oas2: oas2_1.preprocessors,
+        async2: async2_1.preprocessors,
+        async3: async3_1.preprocessors,
+        arazzo1: arazzo_1.preprocessors,
+        overlay1: overlay1_1.preprocessors,
     },
     decorators: {
-        oas3: oas3Decorators,
-        oas2: oas2Decorators,
-        async2: async2Decorators,
-        async3: async3Decorators,
-        arazzo1: arazzo1Decorators,
-        overlay1: overlay1Decorators,
+        oas3: oas3_2.decorators,
+        oas2: oas2_2.decorators,
+        async2: async2_2.decorators,
+        async3: async3_2.decorators,
+        arazzo1: arazzo_2.decorators,
+        overlay1: overlay1_2.decorators,
     },
-    configs: builtInConfigs,
+    configs: exports.builtInConfigs,
 };
-//# sourceMappingURL=builtIn.js.map

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

@@ -1,8 +1,8 @@
-import { BaseResolver } from '../resolve.js';
-import { Config } from './config.js';
-import type { StyleguideRawConfig, Plugin, RawConfig, ResolvedApi, ResolvedStyleguideConfig } from './types.js';
-import type { BundleOptions } from '../bundle.js';
-import type { Document, ResolvedRefMap } from '../resolve.js';
+import { BaseResolver } from '../resolve';
+import { Config } from './config';
+import type { StyleguideRawConfig, Plugin, RawConfig, ResolvedApi, ResolvedStyleguideConfig } from './types';
+import type { BundleOptions } from '../bundle';
+import type { Document, ResolvedRefMap } from '../resolve';
 export declare function resolveConfigFileAndRefs({ configPath, externalRefResolver, base, }: Omit<BundleOptions, 'config'> & {
     configPath?: string;
 }): Promise<{
@@ -28,4 +28,3 @@ export declare function resolveStyleguideConfig(opts: {
     extendPaths?: string[];
 }): Promise<ResolvedStyleguideConfig>;
 export declare function resolvePreset(presetName: string, plugins: Plugin[]): ResolvedStyleguideConfig;
-//# sourceMappingURL=config-resolvers.d.ts.map