@redocly/openapi-core 1.0.0-beta.76 → 1.0.0-beta.80

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 = {};

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,17 +210,15 @@ 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))
                 return { location, node: ref };
-            const refId = from + '::' + ref.$ref;
+            const refId = resolve_1.makeRefId(from, ref.$ref);
             const resolvedRef = resolvedRefMap.get(refId);
             if (!resolvedRef) {
                 return {

package/package.json

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

package/src/__tests__/js-yaml.test.ts

@@ -1,3 +1,4 @@
+import { outdent } from 'outdent';
 import { parseYaml, stringifyYaml } from '../js-yaml';
 
 const yaml = `
@@ -7,7 +8,8 @@ const yaml = `
   number: 1000
   decimal: 12.34
   boolean: true
-  date: 2020-01-01
+  dateWithoutQuotes: 2020-01-01
+  dateWithQuotes: '2020-01-01'
   array:
     - 1
     - 2
@@ -16,6 +18,16 @@ const yaml = `
     key2: 2
 `;
 
+const yamlToDump = outdent`
+  date: '2022-01-21T11:29:56.694Z'
+  dateWithoutQuotes: 2020-01-01
+  dateWithQuotes: '2020-01-01'
+  dateImplicit: !!str 2020-01-01
+  string: test
+  stringWithQuotes: 'test'
+  stringWithDoubleQuotes: "test"
+`;
+
 const jsObject = {
   emptyValue: null,
   'spaces in keys': 'spaces in keys',
@@ -23,7 +35,8 @@ const jsObject = {
   number: 1000,
   decimal: 12.34,
   boolean: true,
-  date: '2020-01-01',
+  dateWithoutQuotes: '2020-01-01',
+  dateWithQuotes: '2020-01-01',
   array: [1, 2],
   object: { key1: 1, key2: 2 },
 };
@@ -33,14 +46,25 @@ describe('js-yaml', () => {
     expect(parseYaml(yaml)).toEqual(jsObject);
   });
 
+  test('should correctly dump date and string', () => {
+    expect(stringifyYaml(parseYaml(yamlToDump))).toMatchInlineSnapshot(
+    `
+    "date: '2022-01-21T11:29:56.694Z'
+    dateWithoutQuotes: '2020-01-01'
+    dateWithQuotes: '2020-01-01'
+    dateImplicit: '2020-01-01'
+    string: test
+    stringWithQuotes: test
+    stringWithDoubleQuotes: test
+    "
+    `);
+  });
+
   test('parse and stringify', () => {
     expect(parseYaml(stringifyYaml(jsObject))).toEqual(jsObject);
   });
 
   test('should throw an error for unsupported types', () => {
-    expect(() => stringifyYaml({ date: new Date() }))
-      .toThrow('unacceptable kind of an object to dump [object Date]');
-
     expect(() => stringifyYaml({ foo: () => {} }))
       .toThrow('unacceptable kind of an object to dump [object Function]');
   });

package/src/__tests__/lint.test.ts

@@ -3,9 +3,7 @@ import { outdent } from 'outdent';
 import { lintFromString, lintConfig, lintDocument } from '../lint';
 import { BaseResolver } from '../resolve';
 import { loadConfig } from '../config/load';
-import { parseYamlToDocument, replaceSourceWithRef } from '../../__tests__/utils';
-// todo create general utils for tests and move this config.
-import { makeConfig } from '../rules/__tests__/config';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../__tests__/utils';
 
 describe('lint', () => {
   it('lintFromString should work', async () => {

package/src/bundle.ts

@@ -1,5 +1,5 @@
 import isEqual = require('lodash.isequal');
-import { BaseResolver, resolveDocument, Document } from './resolve';
+import { BaseResolver, resolveDocument, Document, ResolvedRefMap, makeRefId } from './resolve';
 import { Oas3Rule, normalizeVisitors, Oas3Visitor, Oas2Visitor } from './visitors';
 import { Oas3Types } from './types/oas3';
 import { Oas2Types } from './types/oas2';
@@ -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,25 +105,35 @@ export async function bundleDocument(opts: {
     visitorsData: {},
   };
 
+  if (removeUnusedComponents) {
+    decorators.push({
+      severity: 'error',
+      ruleId: 'remove-unused-components',
+      visitor: oasMajorVersion === OasMajorVersion.Version2
+        ? RemoveUnusedComponentsOas2({})
+        : RemoveUnusedComponentsOas3({})
+    })
+  }
+
+  const resolvedRefMap = await resolveDocument({
+    rootDocument: document,
+    rootType: types.DefinitionRoot,
+    externalRefResolver,
+  });
+
   const bundleVisitor = normalizeVisitors(
     [
       ...preprocessors,
       {
         severity: 'error',
         ruleId: 'bundler',
-        visitor: makeBundleVisitor(oasMajorVersion, dereference, skipRedoclyRegistryRefs, document),
+        visitor: makeBundleVisitor(oasMajorVersion, dereference, skipRedoclyRegistryRefs, document, resolvedRefMap),
       },
       ...decorators,
     ],
     types,
   );
 
-  const resolvedRefMap = await resolveDocument({
-    rootDocument: document,
-    rootType: types.DefinitionRoot,
-    externalRefResolver,
-  });
-
   walkDocument({
     document,
     rootType: types.DefinitionRoot as NormalizedNodeType,
@@ -182,6 +198,7 @@ function makeBundleVisitor(
   dereference: boolean,
   skipRedoclyRegistryRefs: boolean,
   rootDocument: Document,
+  resolvedRefMap: ResolvedRefMap
 ) {
   let components: Record<string, Record<string, any>>;
 
@@ -214,6 +231,7 @@ function makeBundleVisitor(
             replaceRef(node, resolved, ctx);
           } else {
             node.$ref = saveComponent(componentType, resolved, ctx);
+            resolveBundledComponent(node, resolved, ctx);
           }
         }
       },
@@ -251,6 +269,17 @@ function makeBundleVisitor(
     };
   }
 
+  function resolveBundledComponent(node: OasRef, resolved: ResolveResult<any>, ctx: UserContext) {
+    const newRefId = 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: OasRef, resolved: ResolveResult<any>, ctx: UserContext) {
     if (!isPlainObject(resolved.node)) {
       ctx.parent[ctx.key] = resolved.node;

package/src/config/builtIn.ts

@@ -1,9 +1,13 @@
 import recommended from './recommended';
 import all from './all';
 import minimal from './minimal';
-import { LintRawConfig, Plugin } from './config';
-
-import * as builtinRules from '../rules/builtin';
+import { CustomRulesConfig, LintRawConfig, Plugin } from './config';
+import { rules as oas3Rules } from '../rules/oas3';
+import { rules as oas2Rules } from '../rules/oas2';
+import { preprocessors as oas3Preprocessors } from '../rules/oas3';
+import { preprocessors as oas2Preprocessors } from '../rules/oas2';
+import { decorators as oas3Decorators } from '../decorators/oas3';
+import { decorators as oas2Decorators } from '../decorators/oas2';
 
 export const builtInConfigs: Record<string, LintRawConfig> = {
   recommended,
@@ -16,8 +20,17 @@ export const builtInConfigs: Record<string, LintRawConfig> = {
 
 export const defaultPlugin: Plugin = {
   id: '', // default plugin doesn't have id
-  rules: builtinRules.rules,
-  preprocessors: builtinRules.preprocessors,
-  decorators: builtinRules.decorators,
+  rules: {
+    oas3: oas3Rules,
+    oas2: oas2Rules,
+  } as CustomRulesConfig,
+  preprocessors: {
+    oas3: oas3Preprocessors,
+    oas2: oas2Preprocessors,
+  },
+  decorators: {
+    oas3: oas3Decorators,
+    oas2: oas2Decorators,
+  },
   configs: builtInConfigs,
-}
+}

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;