@redocly/openapi-core 1.0.0-beta.61 → 1.0.0-beta.65

package/__tests__/lint.test.ts

@@ -0,0 +1,17 @@
+import outdent from 'outdent';
+import { detectOpenAPI } from '../src/oas-types';
+import { parseYamlToDocument } from './utils';
+
+describe.only('lint', () => {
+	it('detect OpenAPI should throw an error when version is not string', () => {
+
+	const testDocument = parseYamlToDocument(
+      outdent`
+        openapi: 3.0
+      `,
+      '',
+    );
+		expect(() => detectOpenAPI(testDocument.parsed))
+			.toThrow(`Invalid OpenAPI version: should be a string but got "number"`)
+	});
+});

package/__tests__/resolve.test.ts

@@ -192,7 +192,7 @@ describe('collect refs', () => {
 
     expect(resolvedRefs).toBeDefined();
 
-    expect(Array.from(resolvedRefs.keys()).map((ref) => ref.substring(cwd.length + 1)))
+    expect(Array.from(resolvedRefs.keys()).map((ref) => ref.substring(cwd.length + 1)).sort())
       .toMatchInlineSnapshot(`
       Array [
         "openapi-with-back.yaml::./schemas/type-a.yaml#/",
@@ -201,7 +201,15 @@ describe('collect refs', () => {
       ]
     `);
 
-    expect(Array.from(resolvedRefs.values()).map((val) => val.node)).toMatchInlineSnapshot(`
+    expect(
+      Array.from(resolvedRefs.values())
+        .map((val) => val.node)
+        .sort((firstEl, secondEl) => {
+          const getKey = (el: any): string => el?.allOf?.type || el?.type || '';
+
+          return getKey(firstEl).localeCompare(getKey(secondEl));
+        })
+    ).toMatchInlineSnapshot(`
       Array [
         Object {
           "allOf": Array [

package/__tests__/utils.ts

@@ -1,15 +1,13 @@
-import * as yaml from 'js-yaml';
 import * as path from 'path';
 
-import { Document, Source } from '../src/resolve';
-import { NormalizedProblem } from '../src/walk';
+import { Document, Source, NormalizedProblem, parseYaml, stringifyYaml } from '../src';
 import { RuleConfig, LintConfig, Plugin } from '../src/config/config';
 import { Oas3RuleSet } from '../src/oas-types';
 
 export function parseYamlToDocument(body: string, absoluteRef: string = ''): Document {
   return {
     source: new Source(absoluteRef, body),
-    parsed: yaml.safeLoad(body, { filename: absoluteRef }),
+    parsed: parseYaml(body, { filename: absoluteRef }),
   };
 }
 
@@ -41,7 +39,7 @@ export const yamlSerializer = {
     return true;
   },
   print: (val: any) => {
-    return yaml.safeDump(val);
+    return stringifyYaml(val);
   },
 };
 

package/lib/benchmark/utils.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeConfigForRuleset = exports.parseYamlToDocument = void 0;
-const yaml = require("js-yaml");
+const js_yaml_1 = require("../js-yaml");
 const resolve_1 = require("../resolve");
 const config_1 = require("../config/config");
 function parseYamlToDocument(body, absoluteRef = '') {
     return {
         source: new resolve_1.Source(absoluteRef, body),
-        parsed: yaml.safeLoad(body, { filename: absoluteRef }),
+        parsed: js_yaml_1.parseYaml(body, { filename: absoluteRef }),
     };
 }
 exports.parseYamlToDocument = parseYamlToDocument;

package/lib/config/config.d.ts

@@ -125,5 +125,6 @@ export declare class Config {
     apiDefinitions: Record<string, string>;
     lint: LintConfig;
     resolve: ResolveConfig;
+    licenseKey?: string;
     constructor(rawConfig: RawConfig, configFile?: string | undefined);
 }

package/lib/config/config.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Config = exports.LintConfig = exports.IGNORE_FILE = void 0;
 const fs = require("fs");
 const path = require("path");
-const yaml = require("js-yaml");
 const path_1 = require("path");
 const colorette_1 = require("colorette");
+const js_yaml_1 = require("../js-yaml");
 const utils_1 = require("../utils");
 const oas_types_1 = require("../oas-types");
 const recommended_1 = require("./recommended");
@@ -57,7 +57,7 @@ class LintConfig {
         if (fs.hasOwnProperty('existsSync') && fs.existsSync(ignoreFile)) {
             // TODO: parse errors
             this.ignore =
-                yaml.safeLoad(fs.readFileSync(ignoreFile, 'utf-8')) || {};
+                js_yaml_1.parseYaml(fs.readFileSync(ignoreFile, 'utf-8')) || {};
             // resolve ignore paths
             for (const fileName of Object.keys(this.ignore)) {
                 this.ignore[path.resolve(path_1.dirname(ignoreFile), fileName)] = this.ignore[fileName];
@@ -78,7 +78,7 @@ class LintConfig {
                 ignoredRules[ruleId] = Array.from(ignoredRules[ruleId]);
             }
         }
-        fs.writeFileSync(ignoreFile, IGNORE_BANNER + yaml.safeDump(mapped));
+        fs.writeFileSync(ignoreFile, IGNORE_BANNER + js_yaml_1.stringifyYaml(mapped));
     }
     addIgnore(problem) {
         const ignore = this.ignore;

package/lib/index.d.ts

@@ -12,6 +12,7 @@ export { Config, LintConfig, RawConfig, IGNORE_FILE } from './config/config';
 export { loadConfig } from './config/load';
 export { RedoclyClient } from './redocly';
 export { Source, BaseResolver, Document, resolveDocument, ResolveError, YamlParseError, makeDocumentFromString, } from './resolve';
+export { parseYaml, stringifyYaml } from './js-yaml';
 export { unescapePointer } from './ref-utils';
 export { detectOpenAPI, OasMajorVersion, openAPIMajor, OasVersion } from './oas-types';
 export { normalizeVisitors } from './visitors';

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.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.readFileFromUrl = void 0;
+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.readFileFromUrl = void 0;
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "readFileFromUrl", { enumerable: true, get: function () { return utils_1.readFileFromUrl; } });
 var oas3_1_1 = require("./types/oas3_1");
@@ -30,6 +30,9 @@ Object.defineProperty(exports, "resolveDocument", { enumerable: true, get: funct
 Object.defineProperty(exports, "ResolveError", { enumerable: true, get: function () { return resolve_1.ResolveError; } });
 Object.defineProperty(exports, "YamlParseError", { enumerable: true, get: function () { return resolve_1.YamlParseError; } });
 Object.defineProperty(exports, "makeDocumentFromString", { enumerable: true, get: function () { return resolve_1.makeDocumentFromString; } });
+var js_yaml_1 = require("./js-yaml");
+Object.defineProperty(exports, "parseYaml", { enumerable: true, get: function () { return js_yaml_1.parseYaml; } });
+Object.defineProperty(exports, "stringifyYaml", { enumerable: true, get: function () { return js_yaml_1.stringifyYaml; } });
 var ref_utils_1 = require("./ref-utils");
 Object.defineProperty(exports, "unescapePointer", { enumerable: true, get: function () { return ref_utils_1.unescapePointer; } });
 var oas_types_1 = require("./oas-types");

package/lib/js-yaml/index.d.ts

@@ -0,0 +1,3 @@
+import { LoadOptions, DumpOptions } from 'js-yaml';
+export declare const parseYaml: (str: string, opts?: LoadOptions | undefined) => unknown;
+export declare const stringifyYaml: (obj: any, opts?: DumpOptions | undefined) => string;

package/lib/js-yaml/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringifyYaml = exports.parseYaml = void 0;
+// TODO: add a type for "types" https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/js-yaml/index.d.ts
+// @ts-ignore
+const js_yaml_1 = require("js-yaml");
+const DEFAULT_SCHEMA_WITHOUT_TIMESTAMP = js_yaml_1.JSON_SCHEMA.extend({
+    implicit: [js_yaml_1.types.merge],
+    explicit: [
+        js_yaml_1.types.binary,
+        js_yaml_1.types.omap,
+        js_yaml_1.types.pairs,
+        js_yaml_1.types.set,
+    ],
+});
+const parseYaml = (str, opts) => js_yaml_1.load(str, Object.assign({ schema: DEFAULT_SCHEMA_WITHOUT_TIMESTAMP }, opts));
+exports.parseYaml = parseYaml;
+const stringifyYaml = (obj, opts) => js_yaml_1.dump(obj, Object.assign({ schema: DEFAULT_SCHEMA_WITHOUT_TIMESTAMP }, opts));
+exports.stringifyYaml = stringifyYaml;

package/lib/oas-types.js

@@ -19,6 +19,9 @@ function detectOpenAPI(root) {
     if (!(root.openapi || root.swagger)) {
         throw new Error('This doesn’t look like an OpenAPI document.\n');
     }
+    if (root.openapi && typeof root.openapi !== 'string') {
+        throw new Error(`Invalid OpenAPI version: should be a string but got "${typeof root.openapi}"`);
+    }
     if (root.openapi && root.openapi.startsWith('3.0')) {
         return OasVersion.Version3_0;
     }

package/lib/resolve.d.ts

@@ -29,7 +29,7 @@ export declare type Document = {
 };
 export declare function makeDocumentFromString(sourceString: string, absoluteRef: string): {
     source: Source;
-    parsed: string | object | undefined;
+    parsed: unknown;
 };
 export declare class BaseResolver {
     private config;

package/lib/resolve.js

@@ -13,7 +13,6 @@ exports.resolveDocument = exports.BaseResolver = exports.makeDocumentFromString
 const fs = require("fs");
 const path = require("path");
 const url = require("url");
-const yaml = require("js-yaml");
 const ref_utils_1 = require("./ref-utils");
 const types_1 = require("./types");
 const utils_1 = require("./utils");
@@ -56,7 +55,7 @@ class ResolveError extends Error {
     }
 }
 exports.ResolveError = ResolveError;
-const jsYamlErrorLineColRegexp = /at line (\d+), column (\d+):/;
+const jsYamlErrorLineColRegexp = /\((\d+):(\d+)\)$/;
 class YamlParseError extends Error {
     constructor(originalError, source) {
         super(originalError.message.split('\n')[0]);
@@ -75,7 +74,7 @@ function makeDocumentFromString(sourceString, absoluteRef) {
     try {
         return {
             source,
-            parsed: yaml.safeLoad(sourceString, { filename: absoluteRef }),
+            parsed: utils_1.parseYaml(sourceString, { filename: absoluteRef }),
         };
     }
     catch (e) {
@@ -128,7 +127,7 @@ class BaseResolver {
         try {
             return {
                 source,
-                parsed: yaml.safeLoad(source.body, { filename: source.absoluteRef }),
+                parsed: utils_1.parseYaml(source.body, { filename: source.absoluteRef }),
             };
         }
         catch (e) {

package/lib/rules/builtin.d.ts

@@ -7,8 +7,14 @@ export declare const preprocessors: {
 export declare const decorators: {
     oas3: {
         'registry-dependencies': import("../visitors").Oas3Decorator;
+        'operation-description-override': import("../visitors").Oas3Decorator;
+        'tag-description-override': import("../visitors").Oas3Decorator;
+        'info-description-override': 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;
     };
 };

package/lib/rules/common/info-description-override.d.ts

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

package/lib/rules/common/info-description-override.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InfoDescriptionOverride = void 0;
+const utils_1 = require("../../utils");
+const InfoDescriptionOverride = ({ filePath }) => {
+    return {
+        Info: {
+            leave(info, { report, location }) {
+                if (!filePath)
+                    throw new Error(`Parameter "filePath" is not provided for "info-description-override" rule`);
+                try {
+                    info.description = utils_1.readFileAsStringSync(filePath);
+                }
+                catch (e) {
+                    report({
+                        message: `Failed to read markdown override file for "info.description".\n${e.message}`,
+                        location: location.child('description'),
+                    });
+                }
+            },
+        },
+    };
+};
+exports.InfoDescriptionOverride = InfoDescriptionOverride;

package/lib/rules/common/operation-description-override.d.ts

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

package/lib/rules/common/operation-description-override.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationDescriptionOverride = void 0;
+const utils_1 = require("../../utils");
+const OperationDescriptionOverride = ({ operationIds }) => {
+    return {
+        Operation: {
+            leave(operation, { report, location }) {
+                if (!operation.operationId)
+                    return;
+                if (!operationIds)
+                    throw new Error(`Parameter "operationIds" is not provided for "operation-description-override" rule`);
+                const operationId = operation.operationId;
+                if (operationIds[operationId]) {
+                    try {
+                        operation.description = utils_1.readFileAsStringSync(operationIds[operationId]);
+                    }
+                    catch (e) {
+                        report({
+                            message: `Failed to read markdown override file for operation "${operationId}".\n${e.message}`,
+                            location: location.child('operationId').key(),
+                        });
+                    }
+                }
+            },
+        },
+    };
+};
+exports.OperationDescriptionOverride = OperationDescriptionOverride;

package/lib/rules/common/tag-description-override.d.ts

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

package/lib/rules/common/tag-description-override.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TagDescriptionOverride = void 0;
+const utils_1 = require("../../utils");
+const TagDescriptionOverride = ({ tagNames }) => {
+    return {
+        Tag: {
+            leave(tag, { report }) {
+                if (!tagNames)
+                    throw new Error(`Parameter "tagNames" is not provided for "tag-description-override" rule`);
+                if (tagNames[tag.name]) {
+                    try {
+                        tag.description = utils_1.readFileAsStringSync(tagNames[tag.name]);
+                    }
+                    catch (e) {
+                        report({
+                            message: `Failed to read markdown override file for tag "${tag.name}".\n${e.message}`,
+                        });
+                    }
+                }
+            },
+        },
+    };
+};
+exports.TagDescriptionOverride = TagDescriptionOverride;

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

@@ -34,4 +34,7 @@ export declare const rules: {
 export declare const preprocessors: {};
 export declare const decorators: {
     'registry-dependencies': Oas2Decorator;
+    'operation-description-override': Oas2Decorator;
+    'tag-description-override': Oas2Decorator;
+    'info-description-override': Oas2Decorator;
 };

package/lib/rules/oas2/index.js

@@ -31,6 +31,9 @@ const no_identical_paths_1 = require("../common/no-identical-paths");
 const operation_operationId_1 = require("../common/operation-operationId");
 const operation_summary_1 = require("../common/operation-summary");
 const no_ambiguous_paths_1 = require("../common/no-ambiguous-paths");
+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");
 exports.rules = {
     spec: spec_1.OasSpec,
     'info-description': info_description_1.InfoDescription,
@@ -66,4 +69,7 @@ exports.rules = {
 exports.preprocessors = {};
 exports.decorators = {
     'registry-dependencies': registry_dependencies_1.RegistryDependencies,
+    'operation-description-override': operation_description_override_1.OperationDescriptionOverride,
+    'tag-description-override': tag_description_override_1.TagDescriptionOverride,
+    'info-description-override': info_description_override_1.InfoDescriptionOverride,
 };

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

@@ -4,4 +4,7 @@ export declare const rules: Oas3RuleSet;
 export declare const preprocessors: {};
 export declare const decorators: {
     'registry-dependencies': Oas3Decorator;
+    'operation-description-override': Oas3Decorator;
+    'tag-description-override': Oas3Decorator;
+    'info-description-override': Oas3Decorator;
 };

package/lib/rules/oas3/index.js

@@ -39,6 +39,9 @@ const operation_operationId_1 = require("../common/operation-operationId");
 const operation_summary_1 = require("../common/operation-summary");
 const no_ambiguous_paths_1 = require("../common/no-ambiguous-paths");
 const no_servers_empty_enum_1 = require("./no-servers-empty-enum");
+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");
 exports.rules = {
     spec: spec_1.OasSpec,
     'info-description': info_description_1.InfoDescription,
@@ -77,9 +80,12 @@ exports.rules = {
     'no-identical-paths': no_identical_paths_1.NoIdenticalPaths,
     'no-ambiguous-paths': no_ambiguous_paths_1.NoAmbiguousPaths,
     'no-undefined-server-variable': no_undefined_server_variable_1.NoUndefinedServerVariable,
-    'no-servers-empty-enum': no_servers_empty_enum_1.NoEmptyEnumServers
+    'no-servers-empty-enum': no_servers_empty_enum_1.NoEmptyEnumServers,
 };
 exports.preprocessors = {};
 exports.decorators = {
     'registry-dependencies': registry_dependencies_1.RegistryDependencies,
+    'operation-description-override': operation_description_override_1.OperationDescriptionOverride,
+    'tag-description-override': tag_description_override_1.TagDescriptionOverride,
+    'info-description-override': info_description_override_1.InfoDescriptionOverride,
 };