@redocly/openapi-core 1.0.0-beta.75 → 1.0.0-beta.79

package/lib/bundle.d.ts

@@ -1,6 +1,7 @@
 import { BaseResolver, Document } from './resolve';
 import { Oas3Rule } from './visitors';
 import { NormalizedNodeType, NodeType } from './types';
+import { OasMajorVersion } from './oas-types';
 import type { Config, LintConfig } from './config/config';
 export declare type Oas3RuleSet = Record<string, Oas3Rule>;
 export declare enum OasVersion {
@@ -16,6 +17,7 @@ export declare function bundle(opts: {
     dereference?: boolean;
     base?: string;
     skipRedoclyRegistryRefs?: boolean;
+    removeUnusedComponents?: boolean;
 }): Promise<{
     bundle: Document;
     problems: import("./walk").NormalizedProblem[];
@@ -31,6 +33,7 @@ export declare function bundleDocument(opts: {
     externalRefResolver: BaseResolver;
     dereference?: boolean;
     skipRedoclyRegistryRefs?: boolean;
+    removeUnusedComponents?: boolean;
 }): Promise<{
     bundle: Document;
     problems: import("./walk").NormalizedProblem[];
@@ -39,3 +42,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" | "responses" | "definitions" | "parameters" | "schemas" | "examples" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | null;

package/lib/bundle.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.bundleDocument = exports.bundle = exports.OasVersion = void 0;
+exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.OasVersion = void 0;
 const isEqual = require("lodash.isequal");
 const resolve_1 = require("./resolve");
 const visitors_1 = require("./visitors");
@@ -24,6 +24,8 @@ const rules_1 = require("./config/rules");
 const no_unresolved_refs_1 = require("./rules/no-unresolved-refs");
 const utils_1 = require("./utils");
 const redocly_1 = require("./redocly");
+const remove_unused_components_1 = require("./rules/oas2/remove-unused-components");
+const remove_unused_components_2 = require("./rules/oas3/remove-unused-components");
 var OasVersion;
 (function (OasVersion) {
     OasVersion["Version2"] = "oas2";
@@ -46,7 +48,7 @@ function bundle(opts) {
 exports.bundle = bundle;
 function bundleDocument(opts) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { document, config, customTypes, externalRefResolver, dereference = false, skipRedoclyRegistryRefs = false, } = opts;
+        const { document, config, customTypes, externalRefResolver, dereference = false, skipRedoclyRegistryRefs = false, removeUnusedComponents = false, } = opts;
         const oasVersion = oas_types_1.detectOpenAPI(document.parsed);
         const oasMajorVersion = oas_types_1.openAPIMajor(oasVersion);
         const rules = config.getRulesForOasVersion(oasMajorVersion);
@@ -63,20 +65,29 @@ function bundleDocument(opts) {
             refTypes: new Map(),
             visitorsData: {},
         };
+        if (removeUnusedComponents) {
+            decorators.push({
+                severity: 'error',
+                ruleId: 'remove-unused-components',
+                visitor: oasMajorVersion === oas_types_1.OasMajorVersion.Version2
+                    ? remove_unused_components_1.RemoveUnusedComponents({})
+                    : remove_unused_components_2.RemoveUnusedComponents({})
+            });
+        }
+        const resolvedRefMap = yield resolve_1.resolveDocument({
+            rootDocument: document,
+            rootType: types.DefinitionRoot,
+            externalRefResolver,
+        });
         const bundleVisitor = visitors_1.normalizeVisitors([
             ...preprocessors,
             {
                 severity: 'error',
                 ruleId: 'bundler',
-                visitor: makeBundleVisitor(oasMajorVersion, dereference, skipRedoclyRegistryRefs, document),
+                visitor: makeBundleVisitor(oasMajorVersion, dereference, skipRedoclyRegistryRefs, document, resolvedRefMap),
             },
             ...decorators,
         ], types);
-        const resolvedRefMap = yield resolve_1.resolveDocument({
-            rootDocument: document,
-            rootType: types.DefinitionRoot,
-            externalRefResolver,
-        });
         walk_1.walkDocument({
             document,
             rootType: types.DefinitionRoot,
@@ -133,8 +144,9 @@ function mapTypeToComponent(typeName, version) {
             }
     }
 }
+exports.mapTypeToComponent = mapTypeToComponent;
 // function oas3Move
-function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDocument) {
+function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDocument, resolvedRefMap) {
     let components;
     const visitor = {
         ref: {
@@ -163,6 +175,7 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
                     }
                     else {
                         node.$ref = saveComponent(componentType, resolved, ctx);
+                        resolveBundledComponent(node, resolved, ctx);
                     }
                 }
             },
@@ -199,6 +212,16 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
             },
         };
     }
+    function resolveBundledComponent(node, resolved, ctx) {
+        const newRefId = resolve_1.makeRefId(ctx.location.source.absoluteRef, node.$ref);
+        resolvedRefMap.set(newRefId, {
+            document: rootDocument,
+            isRemote: false,
+            node: resolved.node,
+            nodePointer: node.$ref,
+            resolved: true,
+        });
+    }
     function replaceRef(ref, resolved, ctx) {
         if (!utils_1.isPlainObject(resolved.node)) {
             ctx.parent[ctx.key] = resolved.node;

package/lib/config/config.d.ts

@@ -5,10 +5,9 @@ export declare const IGNORE_FILE = ".redocly.lint-ignore.yaml";
 export declare type RuleConfig = ProblemSeverity | 'off' | ({
     severity?: ProblemSeverity;
 } & Record<string, any>);
-export declare type PreprocessorConfig = ProblemSeverity | 'off' | 'on' | {
+export declare type PreprocessorConfig = ProblemSeverity | 'off' | 'on' | ({
     severity?: ProblemSeverity;
-    options?: Record<string, any>;
-};
+} & Record<string, any>);
 export declare type DecoratorConfig = PreprocessorConfig;
 export declare type LintRawConfig = {
     plugins?: (string | Plugin)[];
@@ -107,15 +106,9 @@ export declare class LintConfig {
     };
     getPreprocessorSettings(ruleId: string, oasVersion: OasVersion): {
         severity: ProblemSeverity | "off";
-    } | {
-        severity: ProblemSeverity;
-        options?: Record<string, any> | undefined;
     };
     getDecoratorSettings(ruleId: string, oasVersion: OasVersion): {
         severity: ProblemSeverity | "off";
-    } | {
-        severity: ProblemSeverity;
-        options?: Record<string, any> | undefined;
     };
     getUnusedRules(): {
         rules: string[];

package/lib/format/format.d.ts

@@ -4,7 +4,7 @@ export declare type Totals = {
     warnings: number;
     ignored: number;
 };
-export declare type OutputFormat = 'codeframe' | 'stylish' | 'json';
+export declare type OutputFormat = 'codeframe' | 'stylish' | 'json' | 'checkstyle';
 export declare function getTotals(problems: (NormalizedProblem & {
     ignored?: boolean;
 })[]): Totals;

package/lib/format/format.js

@@ -66,7 +66,7 @@ function formatProblems(problems, opts) {
                 process.stderr.write(`${formatCodeframe(problem, i)}\n`);
             }
             break;
-        case 'stylish':
+        case 'stylish': {
             const groupedByFile = groupByFiles(problems);
             for (const [file, { ruleIdPad, locationPad: positionPad, fileProblems }] of Object.entries(groupedByFile)) {
                 process.stderr.write(`${colorette_1.blue(path.relative(cwd, file))}:\n`);
@@ -77,6 +77,19 @@ function formatProblems(problems, opts) {
                 process.stderr.write('\n');
             }
             break;
+        }
+        case 'checkstyle': {
+            const groupedByFile = groupByFiles(problems);
+            process.stdout.write('<?xml version="1.0" encoding="UTF-8"?>\n');
+            process.stdout.write('<checkstyle version="4.3">\n');
+            for (const [file, { fileProblems }] of Object.entries(groupedByFile)) {
+                process.stdout.write(`<file name="${xmlEscape(path.relative(cwd, file))}">\n`);
+                fileProblems.forEach(formatCheckstyle);
+                process.stdout.write(`</file>\n`);
+            }
+            process.stdout.write(`</checkstyle>\n`);
+            break;
+        }
     }
     if (totalProblems - ignoredProblems > maxProblems) {
         process.stderr.write(`< ... ${totalProblems - maxProblems} more problems hidden > ${colorette_1.gray('increase with `--max-problems N`')}\n`);
@@ -131,6 +144,13 @@ function formatProblems(problems, opts) {
         const { start } = problem.location[0];
         return `  ${`${start.line}:${start.col}`.padEnd(locationPad)}  ${severityName}  ${problem.ruleId.padEnd(ruleIdPad)}  ${problem.message}`;
     }
+    function formatCheckstyle(problem) {
+        const { line, col } = problem.location[0].start;
+        const severity = problem.severity == 'warn' ? 'warning' : 'error';
+        const message = xmlEscape(problem.message);
+        const source = xmlEscape(problem.ruleId);
+        process.stdout.write(`<error line="${line}" column="${col}" severity="${severity}" message="${message}" source="${source}" />\n`);
+    }
 }
 exports.formatProblems = formatProblems;
 function formatFrom(cwd, location) {
@@ -167,3 +187,21 @@ const groupByFiles = (problems) => {
     }
     return fileGroups;
 };
+function xmlEscape(s) {
+    return s.replace(/[<>&"'\x00-\x1F\x7F\u0080-\uFFFF]/gu, (char) => {
+        switch (char) {
+            case '<':
+                return '&lt;';
+            case '>':
+                return '&gt;';
+            case '&':
+                return '&amp;';
+            case '"':
+                return '&quot;';
+            case "'":
+                return '&apos;';
+            default:
+                return `&#${char.charCodeAt(0)};`;
+        }
+    });
+}

package/lib/index.d.ts

@@ -20,4 +20,4 @@ export { WalkContext, walkDocument, NormalizedProblem, ProblemSeverity, LineColL
 export { getAstNodeByPointer, getLineColLocation } from './format/codeframes';
 export { formatProblems, OutputFormat, getTotals, Totals } from './format/format';
 export { lint, lint as validate, lintDocument, lintFromString, lintConfig } from './lint';
-export { bundle, bundleDocument } from './bundle';
+export { bundle, bundleDocument, mapTypeToComponent } from './bundle';

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.OasVersion = exports.openAPIMajor = exports.OasMajorVersion = exports.detectOpenAPI = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.RedoclyClient = exports.loadConfig = exports.IGNORE_FILE = exports.LintConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.slash = exports.readFileFromUrl = void 0;
+exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.OasVersion = exports.openAPIMajor = exports.OasMajorVersion = exports.detectOpenAPI = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.RedoclyClient = exports.loadConfig = exports.IGNORE_FILE = exports.LintConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.slash = exports.readFileFromUrl = void 0;
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "readFileFromUrl", { enumerable: true, get: function () { return utils_1.readFileFromUrl; } });
 Object.defineProperty(exports, "slash", { enumerable: true, get: function () { return utils_1.slash; } });
@@ -60,3 +60,4 @@ Object.defineProperty(exports, "lintConfig", { enumerable: true, get: function (
 var bundle_1 = require("./bundle");
 Object.defineProperty(exports, "bundle", { enumerable: true, get: function () { return bundle_1.bundle; } });
 Object.defineProperty(exports, "bundleDocument", { enumerable: true, get: function () { return bundle_1.bundleDocument; } });
+Object.defineProperty(exports, "mapTypeToComponent", { enumerable: true, get: function () { return bundle_1.mapTypeToComponent; } });

package/lib/resolve.d.ts

@@ -27,6 +27,7 @@ export declare type Document = {
     source: Source;
     parsed: any;
 };
+export declare function makeRefId(absoluteRef: string, pointer: string): string;
 export declare function makeDocumentFromString(sourceString: string, absoluteRef: string): {
     source: Source;
     parsed: unknown;

package/lib/resolve.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveDocument = exports.BaseResolver = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.Source = void 0;
+exports.resolveDocument = exports.BaseResolver = exports.makeDocumentFromString = exports.makeRefId = exports.YamlParseError = exports.ResolveError = exports.Source = void 0;
 const fs = require("fs");
 const path = require("path");
 const url = require("url");
@@ -69,6 +69,10 @@ class YamlParseError extends Error {
     }
 }
 exports.YamlParseError = YamlParseError;
+function makeRefId(absoluteRef, pointer) {
+    return absoluteRef + '::' + pointer;
+}
+exports.makeRefId = makeRefId;
 function makeDocumentFromString(sourceString, absoluteRef) {
     const source = new Source(absoluteRef, sourceString);
     try {
@@ -255,7 +259,7 @@ function resolveDocument(opts) {
                             document: undefined,
                             error: error,
                         };
-                        const refId = document.source.absoluteRef + '::' + ref.$ref;
+                        const refId = makeRefId(document.source.absoluteRef, ref.$ref);
                         resolvedRefMap.set(refId, resolvedRef);
                         return resolvedRef;
                     }
@@ -294,7 +298,7 @@ function resolveDocument(opts) {
                     }
                     resolvedRef.node = target;
                     resolvedRef.document = targetDoc;
-                    const refId = document.source.absoluteRef + '::' + ref.$ref;
+                    const refId = makeRefId(document.source.absoluteRef, ref.$ref);
                     if (resolvedRef.document && ref_utils_1.isRef(target)) {
                         resolvedRef = yield followRef(resolvedRef.document, target, pushRef(refStack, target));
                     }

package/lib/rules/builtin.d.ts

@@ -10,11 +10,13 @@ export declare const decorators: {
         'operation-description-override': import("../visitors").Oas3Decorator;
         'tag-description-override': import("../visitors").Oas3Decorator;
         'info-description-override': import("../visitors").Oas3Decorator;
+        'remove-x-internal': import("../visitors").Oas3Decorator;
     };
     oas2: {
         'registry-dependencies': import("../visitors").Oas2Decorator;
         'operation-description-override': import("../visitors").Oas2Decorator;
         'tag-description-override': import("../visitors").Oas2Decorator;
         'info-description-override': import("../visitors").Oas2Decorator;
+        'remove-x-internal': import("../visitors").Oas2Decorator;
     };
 };

package/lib/rules/common/remove-x-internal.d.ts

@@ -0,0 +1,2 @@
+import { Oas3Decorator, Oas2Decorator } from '../../visitors';
+export declare const RemoveXInternal: Oas3Decorator | Oas2Decorator;

package/lib/rules/common/remove-x-internal.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoveXInternal = void 0;
+const utils_1 = require("../../utils");
+const ref_utils_1 = require("../../ref-utils");
+const DEFAULT_INTERNAL_PROPERTY_NAME = 'x-internal';
+const RemoveXInternal = ({ internalFlagProperty }) => {
+    const hiddenTag = internalFlagProperty || DEFAULT_INTERNAL_PROPERTY_NAME;
+    function removeInternal(node, ctx) {
+        var _a, _b, _c, _d;
+        const { parent, key } = ctx;
+        let didDelete = false;
+        if (Array.isArray(node)) {
+            for (let i = 0; i < node.length; i++) {
+                if (ref_utils_1.isRef(node[i])) {
+                    const resolved = ctx.resolve(node[i]);
+                    if ((_a = resolved.node) === null || _a === void 0 ? void 0 : _a[hiddenTag]) {
+                        node.splice(i, 1);
+                        didDelete = true;
+                        i--;
+                    }
+                }
+                if ((_b = node[i]) === null || _b === void 0 ? void 0 : _b[hiddenTag]) {
+                    node.splice(i, 1);
+                    didDelete = true;
+                    i--;
+                }
+            }
+        }
+        else if (utils_1.isPlainObject(node)) {
+            for (const key of Object.keys(node)) {
+                node = node;
+                if (ref_utils_1.isRef(node[key])) {
+                    const resolved = ctx.resolve(node[key]);
+                    if ((_c = resolved.node) === null || _c === void 0 ? void 0 : _c[hiddenTag]) {
+                        delete node[key];
+                        didDelete = true;
+                    }
+                }
+                if ((_d = node[key]) === null || _d === void 0 ? void 0 : _d[hiddenTag]) {
+                    delete node[key];
+                    didDelete = true;
+                }
+            }
+        }
+        if (didDelete && (utils_1.isEmptyObject(node) || utils_1.isEmptyArray(node))) {
+            delete parent[key];
+        }
+    }
+    return {
+        any: {
+            enter: (node, ctx) => {
+                removeInternal(node, ctx);
+            }
+        }
+    };
+};
+exports.RemoveXInternal = RemoveXInternal;

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

@@ -45,4 +45,5 @@ export declare const decorators: {
     'operation-description-override': Oas2Decorator;
     'tag-description-override': Oas2Decorator;
     'info-description-override': Oas2Decorator;
+    'remove-x-internal': Oas2Decorator;
 };

package/lib/rules/oas2/index.js

@@ -42,6 +42,7 @@ const path_segment_plural_1 = require("../common/path-segment-plural");
 const operation_description_override_1 = require("../common/operation-description-override");
 const tag_description_override_1 = require("../common/tag-description-override");
 const info_description_override_1 = require("../common/info-description-override");
+const remove_x_internal_1 = require("../common/remove-x-internal");
 exports.rules = {
     spec: spec_1.OasSpec,
     'no-invalid-schema-examples': no_invalid_schema_examples_1.NoInvalidSchemaExamples,
@@ -88,4 +89,5 @@ exports.decorators = {
     'operation-description-override': operation_description_override_1.OperationDescriptionOverride,
     'tag-description-override': tag_description_override_1.TagDescriptionOverride,
     'info-description-override': info_description_override_1.InfoDescriptionOverride,
+    'remove-x-internal': remove_x_internal_1.RemoveXInternal
 };

package/lib/rules/oas2/remove-unused-components.d.ts

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

package/lib/rules/oas2/remove-unused-components.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoveUnusedComponents = void 0;
+const utils_1 = require("../../utils");
+const RemoveUnusedComponents = () => {
+    let components = new Map();
+    function registerComponent(location, componentType, name) {
+        var _a;
+        components.set(location.absolutePointer, {
+            used: ((_a = components.get(location.absolutePointer)) === null || _a === void 0 ? void 0 : _a.used) || false,
+            componentType,
+            name,
+        });
+    }
+    return {
+        ref: {
+            leave(ref, { type, resolve, key }) {
+                if (['Schema', 'Parameter', 'Response', 'SecurityScheme'].includes(type.name)) {
+                    const resolvedRef = resolve(ref);
+                    if (!resolvedRef.location)
+                        return;
+                    components.set(resolvedRef.location.absolutePointer, {
+                        used: true,
+                        name: key.toString(),
+                    });
+                }
+            }
+        },
+        DefinitionRoot: {
+            leave(root, ctx) {
+                const data = ctx.getVisitorData();
+                data.removedCount = 0;
+                let rootComponents = new Set();
+                components.forEach(usageInfo => {
+                    const { used, name, componentType } = usageInfo;
+                    if (!used && componentType) {
+                        rootComponents.add(componentType);
+                        delete root[componentType][name];
+                        data.removedCount++;
+                    }
+                });
+                for (const component of rootComponents) {
+                    if (utils_1.isEmptyObject(root[component])) {
+                        delete root[component];
+                    }
+                }
+            },
+        },
+        NamedSchemas: {
+            Schema(schema, { location, key }) {
+                if (!schema.allOf) {
+                    registerComponent(location, 'definitions', key.toString());
+                }
+            },
+        },
+        NamedParameters: {
+            Parameter(_parameter, { location, key }) {
+                registerComponent(location, 'parameters', key.toString());
+            },
+        },
+        NamedResponses: {
+            Response(_response, { location, key }) {
+                registerComponent(location, 'responses', key.toString());
+            },
+        },
+        NamedSecuritySchemes: {
+            SecurityScheme(_securityScheme, { location, key }) {
+                registerComponent(location, 'securityDefinitions', key.toString());
+            },
+        }
+    };
+};
+exports.RemoveUnusedComponents = RemoveUnusedComponents;

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

@@ -7,4 +7,5 @@ export declare const decorators: {
     'operation-description-override': Oas3Decorator;
     'tag-description-override': Oas3Decorator;
     'info-description-override': Oas3Decorator;
+    'remove-x-internal': Oas3Decorator;
 };

package/lib/rules/oas3/index.js

@@ -50,6 +50,7 @@ const info_description_override_1 = require("../common/info-description-override
 const path_excludes_patterns_1 = require("../common/path-excludes-patterns");
 const no_invalid_schema_examples_1 = require("../common/no-invalid-schema-examples");
 const no_invalid_parameter_examples_1 = require("../common/no-invalid-parameter-examples");
+const remove_x_internal_1 = require("../common/remove-x-internal");
 exports.rules = {
     spec: spec_1.OasSpec,
     'info-description': info_description_1.InfoDescription,
@@ -104,4 +105,5 @@ exports.decorators = {
     'operation-description-override': operation_description_override_1.OperationDescriptionOverride,
     'tag-description-override': tag_description_override_1.TagDescriptionOverride,
     'info-description-override': info_description_override_1.InfoDescriptionOverride,
+    'remove-x-internal': remove_x_internal_1.RemoveXInternal
 };

package/lib/rules/oas3/remove-unused-components.d.ts

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

package/lib/rules/oas3/remove-unused-components.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoveUnusedComponents = void 0;
+const utils_1 = require("../../utils");
+const RemoveUnusedComponents = () => {
+    let components = new Map();
+    function registerComponent(location, componentType, name) {
+        var _a;
+        components.set(location.absolutePointer, {
+            used: ((_a = components.get(location.absolutePointer)) === null || _a === void 0 ? void 0 : _a.used) || false,
+            componentType,
+            name,
+        });
+    }
+    return {
+        ref: {
+            leave(ref, { type, resolve, key }) {
+                if (['Schema', 'Header', 'Parameter', 'Response', 'Example', 'RequestBody'].includes(type.name)) {
+                    const resolvedRef = resolve(ref);
+                    if (!resolvedRef.location)
+                        return;
+                    components.set(resolvedRef.location.absolutePointer, {
+                        used: true,
+                        name: key.toString(),
+                    });
+                }
+            }
+        },
+        DefinitionRoot: {
+            leave(root, ctx) {
+                const data = ctx.getVisitorData();
+                data.removedCount = 0;
+                components.forEach(usageInfo => {
+                    const { used, componentType, name } = usageInfo;
+                    if (!used && componentType) {
+                        let componentChild = root.components[componentType];
+                        delete componentChild[name];
+                        data.removedCount++;
+                        if (utils_1.isEmptyObject(componentChild)) {
+                            delete root.components[componentType];
+                        }
+                    }
+                });
+                if (utils_1.isEmptyObject(root.components)) {
+                    delete root.components;
+                }
+            },
+        },
+        NamedSchemas: {
+            Schema(schema, { location, key }) {
+                if (!schema.allOf) {
+                    registerComponent(location, 'schemas', key.toString());
+                }
+            },
+        },
+        NamedParameters: {
+            Parameter(_parameter, { location, key }) {
+                registerComponent(location, 'parameters', key.toString());
+            },
+        },
+        NamedResponses: {
+            Response(_response, { location, key }) {
+                registerComponent(location, 'responses', key.toString());
+            },
+        },
+        NamedExamples: {
+            Example(_example, { location, key }) {
+                registerComponent(location, 'examples', key.toString());
+            },
+        },
+        NamedRequestBodies: {
+            RequestBody(_requestBody, { location, key }) {
+                registerComponent(location, 'requestBodies', key.toString());
+            },
+        },
+        NamedHeaders: {
+            Header(_header, { location, key }) {
+                registerComponent(location, 'headers', key.toString());
+            },
+        },
+    };
+};
+exports.RemoveUnusedComponents = RemoveUnusedComponents;

package/lib/typings/swagger.d.ts

@@ -16,6 +16,20 @@ export interface Oas2Definition {
     tags?: Oas2Tag[];
     externalDocs?: Oas2ExternalDocs;
 }
+export interface Oas2Components {
+    definitions?: {
+        [name: string]: Record<string, Oas2Schema>;
+    };
+    securityDefinitions?: {
+        [name: string]: Record<string, Oas2SecurityScheme>;
+    };
+    responses?: {
+        [name: string]: Record<string, Oas2Response>;
+    };
+    parameters?: {
+        [name: string]: Record<string, Oas2Parameter>;
+    };
+}
 export interface Oas2Info {
     title: string;
     version: string;

package/lib/utils.d.ts

@@ -16,6 +16,8 @@ export declare type BundleOutputFormat = 'json' | 'yml' | 'yaml';
 export declare function loadYaml(filename: string): Promise<unknown>;
 export declare function notUndefined<T>(x: T | undefined): x is T;
 export declare function isPlainObject(value: any): value is object;
+export declare function isEmptyObject(value: any): value is object;
+export declare function isEmptyArray(value: any): boolean;
 export declare function readFileFromUrl(url: string, config: HttpResolveConfig): Promise<{
     body: any;
     mimeType: any;

package/lib/utils.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.match = exports.readFileFromUrl = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
+exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.match = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
 const fs = require("fs");
 const minimatch = require("minimatch");
 const node_fetch_1 = require("node-fetch");
@@ -42,6 +42,14 @@ function isPlainObject(value) {
     return value !== null && typeof value === 'object' && !Array.isArray(value);
 }
 exports.isPlainObject = isPlainObject;
+function isEmptyObject(value) {
+    return isPlainObject(value) && Object.keys(value).length === 0;
+}
+exports.isEmptyObject = isEmptyObject;
+function isEmptyArray(value) {
+    return Array.isArray(value) && value.length === 0;
+}
+exports.isEmptyArray = isEmptyArray;
 function readFileFromUrl(url, config) {
     return __awaiter(this, void 0, void 0, function* () {
         const headers = {};