@redocly/openapi-core 1.0.0-beta.77 → 1.0.0-beta.78

package/lib/bundle.d.ts

@@ -17,6 +17,7 @@ export declare function bundle(opts: {
     dereference?: boolean;
     base?: string;
     skipRedoclyRegistryRefs?: boolean;
+    removeUnusedComponents?: boolean;
 }): Promise<{
     bundle: Document;
     problems: import("./walk").NormalizedProblem[];
@@ -32,6 +33,7 @@ export declare function bundleDocument(opts: {
     externalRefResolver: BaseResolver;
     dereference?: boolean;
     skipRedoclyRegistryRefs?: boolean;
+    removeUnusedComponents?: boolean;
 }): Promise<{
     bundle: Document;
     problems: import("./walk").NormalizedProblem[];
@@ -40,4 +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" | "schemas" | "parameters" | "examples" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | "definitions" | null;
+export declare function mapTypeToComponent(typeName: string, version: OasMajorVersion): "headers" | "responses" | "definitions" | "parameters" | "schemas" | "examples" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | null;

package/lib/bundle.js

@@ -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,6 +65,15 @@ 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 bundleVisitor = visitors_1.normalizeVisitors([
             ...preprocessors,
             {

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/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,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoveXInternal = void 0;
+const utils_1 = require("../../utils");
+const DEFAULT_INTERNAL_PROPERTY_NAME = 'x-internal';
+const RemoveXInternal = ({ internalFlagProperty }) => {
+    const hiddenTag = internalFlagProperty || DEFAULT_INTERNAL_PROPERTY_NAME;
+    function removeInternal(node, ctx) {
+        const { parent, key } = ctx;
+        let didDelete = false;
+        if (Array.isArray(node)) {
+            for (let i = 0; i < node.length; i++) {
+                if (node[i] && node[i][hiddenTag]) {
+                    node.splice(i, 1);
+                    didDelete = true;
+                    i--;
+                }
+            }
+        }
+        else if (utils_1.isPlainObject(node)) {
+            for (const key of Object.keys(node)) {
+                if (node[key][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,71 @@
+"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(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,81 @@
+"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(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 = {};

package/lib/walk.js

@@ -101,10 +101,9 @@ function walkDocument(opts) {
                         if (!activatedOn.skipped) {
                             visitedBySome = true;
                             enteredContexts.add(context);
-                            const ignoreNextVisitorsOnNode = visitWithContext(visit, resolvedNode, context, ruleId, severity);
-                            if (ignoreNextVisitorsOnNode) {
+                            const { ignoreNextVisitorsOnNode } = visitWithContext(visit, resolvedNode, context, ruleId, severity);
+                            if (ignoreNextVisitorsOnNode)
                                 break;
-                            }
                         }
                     }
                 }
@@ -211,12 +210,10 @@ function walkDocument(opts) {
                 key,
                 parentLocations: collectParentsLocations(context),
                 oasVersion: ctx.oasVersion,
-                ignoreNextVisitorsOnNode: () => {
-                    ignoreNextVisitorsOnNode = true;
-                },
+                ignoreNextVisitorsOnNode: () => { ignoreNextVisitorsOnNode = true; },
                 getVisitorData: getVisitorDataFn.bind(undefined, ruleId),
             }, collectParents(context), context);
-            return ignoreNextVisitorsOnNode;
+            return { ignoreNextVisitorsOnNode };
         }
         function resolve(ref, from = currentLocation.source.absoluteRef) {
             if (!ref_utils_1.isRef(ref))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.0-beta.77",
+  "version": "1.0.0-beta.78",
   "description": "",
   "main": "lib/index.js",
   "engines": {

package/src/bundle.ts

@@ -14,6 +14,8 @@ import { reportUnresolvedRef } from './rules/no-unresolved-refs';
 import { isPlainObject } from './utils';
 import { OasRef } from './typings/openapi';
 import { isRedoclyRegistryURL } from './redocly';
+import { RemoveUnusedComponents as RemoveUnusedComponentsOas2 } from './rules/oas2/remove-unused-components';
+import { RemoveUnusedComponents as RemoveUnusedComponentsOas3 } from './rules/oas3/remove-unused-components';
 
 export type Oas3RuleSet = Record<string, Oas3Rule>;
 
@@ -31,6 +33,7 @@ export async function bundle(opts: {
   dereference?: boolean;
   base?: string;
   skipRedoclyRegistryRefs?: boolean;
+  removeUnusedComponents?: boolean;
 }) {
   const {
     ref,
@@ -66,6 +69,7 @@ export async function bundleDocument(opts: {
   externalRefResolver: BaseResolver;
   dereference?: boolean;
   skipRedoclyRegistryRefs?: boolean;
+  removeUnusedComponents?: boolean;
 }) {
   const {
     document,
@@ -74,6 +78,7 @@ export async function bundleDocument(opts: {
     externalRefResolver,
     dereference = false,
     skipRedoclyRegistryRefs = false,
+    removeUnusedComponents = false,
   } = opts;
   const oasVersion = detectOpenAPI(document.parsed);
   const oasMajorVersion = openAPIMajor(oasVersion);
@@ -92,6 +97,7 @@ export async function bundleDocument(opts: {
 
   const preprocessors = initRules(rules as any, config, 'preprocessors', oasVersion);
   const decorators = initRules(rules as any, config, 'decorators', oasVersion);
+
   const ctx: BundleContext = {
     problems: [],
     oasVersion: oasVersion,
@@ -99,6 +105,16 @@ export async function bundleDocument(opts: {
     visitorsData: {},
   };
 
+  if (removeUnusedComponents) {
+    decorators.push({
+      severity: 'error',
+      ruleId: 'remove-unused-components',
+      visitor: oasMajorVersion === OasMajorVersion.Version2
+        ? RemoveUnusedComponentsOas2({})
+        : RemoveUnusedComponentsOas3({})
+    })
+  }
+
   const bundleVisitor = normalizeVisitors(
     [
       ...preprocessors,

package/src/config/config.ts

@@ -38,10 +38,9 @@ export type PreprocessorConfig =
   | ProblemSeverity
   | 'off'
   | 'on'
-  | {
+  | ({
       severity?: ProblemSeverity;
-      options?: Record<string, any>;
-    };
+    } & Record<string, any>);
 
 export type DecoratorConfig = PreprocessorConfig;
 

package/src/rules/__tests__/config.ts

@@ -1,10 +1,11 @@
-import { LintConfig, RuleConfig } from "../../config/config";
+import { DecoratorConfig, LintConfig, RuleConfig } from '../../config/config';
 import { defaultPlugin } from '../../config/builtIn';
 
-export function makeConfig(rules: Record<string, RuleConfig>) {
+export function makeConfig(rules: Record<string, RuleConfig>, decorators?:  Record<string, DecoratorConfig>) {
   return new LintConfig({
     plugins: [defaultPlugin],
     extends: [],
-    rules
+    rules,
+    decorators,
   });
-}
+}