@redocly/openapi-core 1.0.0-beta.99 → 1.0.0-rc.2

package/lib/config/utils.js

@@ -11,10 +11,10 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUniquePlugins = exports.getResolveConfig = exports.transformConfig = exports.getMergedConfig = exports.mergeExtends = exports.prefixRules = exports.transformApiDefinitionsToApis = exports.parsePresetName = void 0;
-const colorette_1 = require("colorette");
+exports.getUniquePlugins = exports.getResolveConfig = exports.transformConfig = exports.checkForDeprecatedFields = exports.getMergedConfig = exports.mergeExtends = exports.prefixRules = exports.transformApiDefinitionsToApis = exports.parsePresetName = void 0;
 const utils_1 = require("../utils");
 const config_1 = require("./config");
+const logger_1 = require("../logger");
 function parsePresetName(presetName) {
     if (presetName.indexOf('/') > -1) {
         const [pluginId, configName] = presetName.split('/');
@@ -25,14 +25,59 @@ function parsePresetName(presetName) {
     }
 }
 exports.parsePresetName = parsePresetName;
-function transformApiDefinitionsToApis(apiDefinitions = {}) {
-    let apis = {};
+function transformApiDefinitionsToApis(apiDefinitions) {
+    if (!apiDefinitions)
+        return undefined;
+    const apis = {};
     for (const [apiName, apiPath] of Object.entries(apiDefinitions)) {
         apis[apiName] = { root: apiPath };
     }
     return apis;
 }
 exports.transformApiDefinitionsToApis = transformApiDefinitionsToApis;
+function extractFlatConfig(_a) {
+    var _b;
+    var { plugins, extends: _extends, rules, oas2Rules, oas3_0Rules, oas3_1Rules, preprocessors, oas2Preprocessors, oas3_0Preprocessors, oas3_1Preprocessors, decorators, oas2Decorators, oas3_0Decorators, oas3_1Decorators } = _a, rawConfigRest = __rest(_a, ["plugins", "extends", "rules", "oas2Rules", "oas3_0Rules", "oas3_1Rules", "preprocessors", "oas2Preprocessors", "oas3_0Preprocessors", "oas3_1Preprocessors", "decorators", "oas2Decorators", "oas3_0Decorators", "oas3_1Decorators"]);
+    const styleguideConfig = {
+        plugins,
+        extends: _extends,
+        rules,
+        oas2Rules,
+        oas3_0Rules,
+        oas3_1Rules,
+        preprocessors,
+        oas2Preprocessors,
+        oas3_0Preprocessors,
+        oas3_1Preprocessors,
+        decorators,
+        oas2Decorators,
+        oas3_0Decorators,
+        oas3_1Decorators,
+        doNotResolveExamples: (_b = rawConfigRest.resolve) === null || _b === void 0 ? void 0 : _b.doNotResolveExamples,
+    };
+    if ((rawConfigRest.lint && rawConfigRest.styleguide) ||
+        (Object.values(styleguideConfig).some(utils_1.isDefined) &&
+            (rawConfigRest.lint || rawConfigRest.styleguide))) {
+        throw new Error(`Do not use 'lint', 'styleguide' and flat syntax together. \nSee more about the configuration in the docs: https://redocly.com/docs/cli/configuration/ \n`);
+    }
+    return {
+        styleguideConfig: Object.values(styleguideConfig).some(utils_1.isDefined)
+            ? styleguideConfig
+            : undefined,
+        rawConfigRest,
+    };
+}
+function transformApis(legacyApis) {
+    if (!legacyApis)
+        return undefined;
+    const apis = {};
+    for (let _a of Object.entries(legacyApis)) {
+        const [apiName, _b] = _a, { lint } = _b, apiContent = __rest(_b, ["lint"]);
+        const { styleguideConfig, rawConfigRest } = extractFlatConfig(apiContent);
+        apis[apiName] = Object.assign({ styleguide: styleguideConfig || lint }, rawConfigRest);
+    }
+    return apis;
+}
 function prefixRules(rules, prefix) {
     if (!prefix)
         return rules;
@@ -61,9 +106,9 @@ function mergeExtends(rulesConfList) {
         pluginPaths: [],
         extendPaths: [],
     };
-    for (let rulesConf of rulesConfList) {
+    for (const rulesConf of rulesConfList) {
         if (rulesConf.extends) {
-            throw new Error(`\`extends\` is not supported in shared configs yet: ${JSON.stringify(rulesConf, null, 2)}.`);
+            throw new Error(`'extends' is not supported in shared configs yet: ${JSON.stringify(rulesConf, null, 2)}.`);
         }
         Object.assign(result.rules, rulesConf.rules);
         Object.assign(result.oas2Rules, rulesConf.oas2Rules);
@@ -93,46 +138,79 @@ function mergeExtends(rulesConfList) {
     return result;
 }
 exports.mergeExtends = mergeExtends;
-function getMergedConfig(config, entrypointAlias) {
-    var _a, _b, _c, _d, _e, _f;
+function getMergedConfig(config, apiName) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
     const extendPaths = [
-        ...Object.values(config.apis).map((api) => { var _a; return (_a = api === null || api === void 0 ? void 0 : api.lint) === null || _a === void 0 ? void 0 : _a.extendPaths; }),
-        (_b = (_a = config.rawConfig) === null || _a === void 0 ? void 0 : _a.lint) === null || _b === void 0 ? void 0 : _b.extendPaths,
+        ...Object.values(config.apis).map((api) => { var _a; return (_a = api === null || api === void 0 ? void 0 : api.styleguide) === null || _a === void 0 ? void 0 : _a.extendPaths; }),
+        (_b = (_a = config.rawConfig) === null || _a === void 0 ? void 0 : _a.styleguide) === null || _b === void 0 ? void 0 : _b.extendPaths,
     ]
         .flat()
-        .filter(Boolean);
+        .filter(utils_1.isTruthy);
     const pluginPaths = [
-        ...Object.values(config.apis).map((api) => { var _a; return (_a = api === null || api === void 0 ? void 0 : api.lint) === null || _a === void 0 ? void 0 : _a.pluginPaths; }),
-        (_d = (_c = config.rawConfig) === null || _c === void 0 ? void 0 : _c.lint) === null || _d === void 0 ? void 0 : _d.pluginPaths,
+        ...Object.values(config.apis).map((api) => { var _a; return (_a = api === null || api === void 0 ? void 0 : api.styleguide) === null || _a === void 0 ? void 0 : _a.pluginPaths; }),
+        (_d = (_c = config.rawConfig) === null || _c === void 0 ? void 0 : _c.styleguide) === null || _d === void 0 ? void 0 : _d.pluginPaths,
     ]
         .flat()
-        .filter(Boolean);
-    return entrypointAlias
-        ? new config_1.Config(Object.assign(Object.assign({}, config.rawConfig), { lint: Object.assign(Object.assign({}, (config.apis[entrypointAlias]
-                ? config.apis[entrypointAlias].lint
-                : config.rawConfig.lint)), { extendPaths,
-                pluginPaths }), 'features.openapi': Object.assign(Object.assign({}, config['features.openapi']), (_e = config.apis[entrypointAlias]) === null || _e === void 0 ? void 0 : _e['features.openapi']), 'features.mockServer': Object.assign(Object.assign({}, config['features.mockServer']), (_f = config.apis[entrypointAlias]) === null || _f === void 0 ? void 0 : _f['features.mockServer']) }), config.configFile)
+        .filter(utils_1.isTruthy);
+    return apiName
+        ? new config_1.Config(Object.assign(Object.assign({}, config.rawConfig), { styleguide: Object.assign(Object.assign({}, (config.apis[apiName]
+                ? config.apis[apiName].styleguide
+                : config.rawConfig.styleguide)), { extendPaths,
+                pluginPaths }), theme: Object.assign(Object.assign({}, config.rawConfig.theme), (_e = config.apis[apiName]) === null || _e === void 0 ? void 0 : _e.theme), files: [...config.files, ...((_h = (_g = (_f = config.apis) === null || _f === void 0 ? void 0 : _f[apiName]) === null || _g === void 0 ? void 0 : _g.files) !== null && _h !== void 0 ? _h : [])] }), config.configFile)
         : config;
 }
 exports.getMergedConfig = getMergedConfig;
-function transformConfig(rawConfig) {
-    if (rawConfig.apis && rawConfig.apiDefinitions) {
-        throw new Error("Do not use 'apiDefinitions' field. Use 'apis' instead.\n");
+function checkForDeprecatedFields(deprecatedField, updatedField, rawConfig, updatedObject) {
+    const isDeprecatedFieldInApis = rawConfig.apis &&
+        Object.values(rawConfig.apis).some((api) => api[deprecatedField]);
+    if (rawConfig[deprecatedField] && updatedField === null) {
+        utils_1.showWarningForDeprecatedField(deprecatedField);
     }
-    if (rawConfig['features.openapi'] &&
-        rawConfig.referenceDocs) {
-        throw new Error("Do not use 'referenceDocs' field. Use 'features.openapi' instead.\n");
+    if (rawConfig[deprecatedField] && updatedField && rawConfig[updatedField]) {
+        utils_1.showErrorForDeprecatedField(deprecatedField, updatedField);
     }
-    const _a = rawConfig, { apiDefinitions, referenceDocs } = _a, rest = __rest(_a, ["apiDefinitions", "referenceDocs"]);
-    if (apiDefinitions) {
-        process.stderr.write(`The ${colorette_1.yellow('apiDefinitions')} field is deprecated. Use ${colorette_1.green('apis')} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`);
+    if (rawConfig[deprecatedField] && updatedObject && rawConfig[updatedObject]) {
+        utils_1.showErrorForDeprecatedField(deprecatedField, updatedField, updatedObject);
     }
-    if (referenceDocs) {
-        process.stderr.write(`The ${colorette_1.yellow('referenceDocs')} field is deprecated. Use ${colorette_1.green('features.openapi')} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`);
+    if (rawConfig[deprecatedField] || isDeprecatedFieldInApis) {
+        utils_1.showWarningForDeprecatedField(deprecatedField, updatedField, updatedObject);
     }
-    return Object.assign({ 'features.openapi': referenceDocs, apis: transformApiDefinitionsToApis(apiDefinitions) }, rest);
+}
+exports.checkForDeprecatedFields = checkForDeprecatedFields;
+function transformConfig(rawConfig) {
+    var _a, _b;
+    const migratedFields = [
+        ['apiDefinitions', 'apis', undefined],
+        ['referenceDocs', 'openapi', 'theme'],
+        ['lint', undefined, undefined],
+        ['styleguide', undefined, undefined],
+        ['features.openapi', 'openapi', 'theme'],
+    ];
+    for (const [deprecatedField, updatedField, updatedObject] of migratedFields) {
+        checkForDeprecatedFields(deprecatedField, updatedField, rawConfig, updatedObject);
+    }
+    const { apis, apiDefinitions, referenceDocs, lint } = rawConfig, rest = __rest(rawConfig, ["apis", "apiDefinitions", "referenceDocs", "lint"]);
+    const { styleguideConfig, rawConfigRest } = extractFlatConfig(rest);
+    const transformedConfig = Object.assign({ theme: {
+            openapi: Object.assign(Object.assign(Object.assign({}, referenceDocs), rawConfig['features.openapi']), (_a = rawConfig.theme) === null || _a === void 0 ? void 0 : _a.openapi),
+            mockServer: Object.assign(Object.assign({}, rawConfig['features.mockServer']), (_b = rawConfig.theme) === null || _b === void 0 ? void 0 : _b.mockServer),
+        }, apis: transformApis(apis) || transformApiDefinitionsToApis(apiDefinitions), styleguide: styleguideConfig || lint }, rawConfigRest);
+    showDeprecationMessages(transformedConfig);
+    return transformedConfig;
 }
 exports.transformConfig = transformConfig;
+function showDeprecationMessages(config) {
+    var _a, _b;
+    let allRules = Object.assign({}, (_a = config.styleguide) === null || _a === void 0 ? void 0 : _a.rules);
+    for (const api of Object.values(config.apis || {})) {
+        allRules = Object.assign(Object.assign({}, allRules), (_b = api === null || api === void 0 ? void 0 : api.styleguide) === null || _b === void 0 ? void 0 : _b.rules);
+    }
+    for (const ruleKey of Object.keys(allRules)) {
+        if (ruleKey.startsWith('assert/')) {
+            logger_1.logger.warn(`\nThe 'assert/' syntax in ${ruleKey} is deprecated. Update your configuration to use 'rule/' instead. Examples and more information: https://redocly.com/docs/cli/rules/configurable-rules/\n`);
+        }
+    }
+}
 function getResolveConfig(resolve) {
     var _a, _b;
     return {
@@ -152,7 +230,7 @@ function getUniquePlugins(plugins) {
             seen.add(p.id);
         }
         else if (p.id) {
-            process.stderr.write(`Duplicate plugin id "${colorette_1.yellow(p.id)}".\n`);
+            logger_1.logger.warn(`Duplicate plugin id "${logger_1.colorize.red(p.id)}".\n`);
         }
     }
     return results;

package/lib/decorators/common/filters/filter-helper.d.ts

@@ -0,0 +1,3 @@
+import { UserContext } from '../../../walk';
+export declare function filter(node: any, ctx: UserContext, criteria: (item: any) => boolean): void;
+export declare function checkIfMatchByStrategy(nodeValue: any, decoratorValue: any, strategy: 'all' | 'any'): boolean;

package/lib/decorators/common/filters/filter-helper.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkIfMatchByStrategy = exports.filter = void 0;
+const ref_utils_1 = require("../../../ref-utils");
+const utils_1 = require("../../../utils");
+function filter(node, ctx, criteria) {
+    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 (criteria(resolved.node)) {
+                    node.splice(i, 1);
+                    didDelete = true;
+                    i--;
+                }
+            }
+            if (criteria(node[i])) {
+                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 (criteria(resolved.node)) {
+                    delete node[key];
+                    didDelete = true;
+                }
+            }
+            if (criteria(node[key])) {
+                delete node[key];
+                didDelete = true;
+            }
+        }
+    }
+    if (didDelete && (utils_1.isEmptyObject(node) || utils_1.isEmptyArray(node))) {
+        delete parent[key];
+    }
+}
+exports.filter = filter;
+function checkIfMatchByStrategy(nodeValue, decoratorValue, strategy) {
+    if (nodeValue === undefined || decoratorValue === undefined) {
+        return false;
+    }
+    if (!Array.isArray(decoratorValue) && !Array.isArray(nodeValue)) {
+        return nodeValue === decoratorValue;
+    }
+    decoratorValue = toArrayIfNeeded(decoratorValue);
+    nodeValue = toArrayIfNeeded(nodeValue);
+    if (strategy === 'any') {
+        return decoratorValue.some((item) => nodeValue.includes(item));
+    }
+    if (strategy === 'all') {
+        return decoratorValue.every((item) => nodeValue.includes(item));
+    }
+    return false;
+}
+exports.checkIfMatchByStrategy = checkIfMatchByStrategy;
+function toArrayIfNeeded(value) {
+    return Array.isArray(value) ? value : [value];
+}

package/lib/decorators/common/filters/filter-in.d.ts

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

package/lib/decorators/common/filters/filter-in.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilterIn = void 0;
+const filter_helper_1 = require("./filter-helper");
+const DEFAULT_STRATEGY = 'any';
+const FilterIn = ({ property, value, matchStrategy }) => {
+    const strategy = matchStrategy || DEFAULT_STRATEGY;
+    const filterInCriteria = (item) => (item === null || item === void 0 ? void 0 : item[property]) && !filter_helper_1.checkIfMatchByStrategy(item === null || item === void 0 ? void 0 : item[property], value, strategy);
+    return {
+        any: {
+            enter: (node, ctx) => {
+                filter_helper_1.filter(node, ctx, filterInCriteria);
+            },
+        },
+    };
+};
+exports.FilterIn = FilterIn;

package/lib/decorators/common/filters/filter-out.d.ts

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

package/lib/decorators/common/filters/filter-out.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilterOut = void 0;
+const filter_helper_1 = require("./filter-helper");
+const DEFAULT_STRATEGY = 'any';
+const FilterOut = ({ property, value, matchStrategy }) => {
+    const strategy = matchStrategy || DEFAULT_STRATEGY;
+    const filterOutCriteria = (item) => filter_helper_1.checkIfMatchByStrategy(item === null || item === void 0 ? void 0 : item[property], value, strategy);
+    return {
+        any: {
+            enter: (node, ctx) => {
+                filter_helper_1.filter(node, ctx, filterOutCriteria);
+            },
+        },
+    };
+};
+exports.FilterOut = FilterOut;

package/lib/decorators/common/info-override.d.ts

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

package/lib/decorators/common/info-override.js

@@ -0,0 +1,28 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InfoOverride = void 0;
+const InfoOverride = (newInfo) => {
+    return {
+        Info: {
+            leave(info) {
+                if (typeof newInfo !== 'object' || Array.isArray(newInfo) || newInfo === null) {
+                    throw new Error(`"info-override" decorator should be called with an object`);
+                }
+                const { severity: _ } = newInfo, rest = __rest(newInfo, ["severity"]);
+                Object.assign(info, rest);
+            },
+        },
+    };
+};
+exports.InfoOverride = InfoOverride;

package/lib/decorators/common/media-type-examples-override.d.ts

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

package/lib/decorators/common/media-type-examples-override.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MediaTypeExamplesOverride = void 0;
+const utils_1 = require("../../utils");
+const ref_utils_1 = require("../../ref-utils");
+const MediaTypeExamplesOverride = ({ operationIds }) => {
+    return {
+        Operation: {
+            enter(operation, ctx) {
+                const operationId = operation.operationId;
+                if (!operationId) {
+                    return;
+                }
+                const properties = operationIds[operationId];
+                if (!properties) {
+                    return;
+                }
+                if (properties.responses && operation.responses) {
+                    for (const responseCode of Object.keys(properties.responses)) {
+                        const resolvedResponse = checkAndResolveRef(operation.responses[responseCode], ctx.resolve);
+                        if (!resolvedResponse) {
+                            continue;
+                        }
+                        resolvedResponse.content = resolvedResponse.content ? resolvedResponse.content : {};
+                        Object.keys(properties.responses[responseCode]).forEach((mimeType) => {
+                            resolvedResponse.content[mimeType] = Object.assign(Object.assign({}, resolvedResponse.content[mimeType]), { examples: utils_1.yamlAndJsonSyncReader(properties.responses[responseCode][mimeType]) });
+                        });
+                        operation.responses[responseCode] = resolvedResponse;
+                    }
+                }
+                if (properties.request && operation.requestBody) {
+                    const resolvedRequest = checkAndResolveRef(operation.requestBody, ctx.resolve);
+                    if (!resolvedRequest) {
+                        return;
+                    }
+                    resolvedRequest.content = resolvedRequest.content ? resolvedRequest.content : {};
+                    Object.keys(properties.request).forEach((mimeType) => {
+                        resolvedRequest.content[mimeType] = Object.assign(Object.assign({}, resolvedRequest.content[mimeType]), { examples: utils_1.yamlAndJsonSyncReader(properties.request[mimeType]) });
+                    });
+                    operation.requestBody = resolvedRequest;
+                }
+            },
+        },
+    };
+};
+exports.MediaTypeExamplesOverride = MediaTypeExamplesOverride;
+function checkAndResolveRef(node, resolver) {
+    if (!ref_utils_1.isRef(node)) {
+        return node;
+    }
+    const resolved = resolver(node);
+    return resolved.error ? undefined : JSON.parse(JSON.stringify(resolved.node));
+}

package/lib/decorators/common/registry-dependencies.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RegistryDependencies = void 0;
 const redocly_1 = require("../../redocly");
 const RegistryDependencies = () => {
-    let registryDependencies = new Set();
+    const registryDependencies = new Set();
     return {
-        DefinitionRoot: {
+        Root: {
             leave(_, ctx) {
                 const data = ctx.getVisitorData();
                 data.links = Array.from(registryDependencies);

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

@@ -51,8 +51,8 @@ const RemoveXInternal = ({ internalFlagProperty }) => {
         any: {
             enter: (node, ctx) => {
                 removeInternal(node, ctx);
-            }
-        }
+            },
+        },
     };
 };
 exports.RemoveXInternal = RemoveXInternal;

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

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

package/lib/decorators/oas2/index.js

@@ -5,11 +5,17 @@ const registry_dependencies_1 = require("../common/registry-dependencies");
 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 info_override_1 = require("../common/info-override");
 const remove_x_internal_1 = require("../common/remove-x-internal");
+const filter_in_1 = require("../common/filters/filter-in");
+const filter_out_1 = require("../common/filters/filter-out");
 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,
-    'remove-x-internal': remove_x_internal_1.RemoveXInternal
+    'info-override': info_override_1.InfoOverride,
+    'remove-x-internal': remove_x_internal_1.RemoveXInternal,
+    'filter-in': filter_in_1.FilterIn,
+    'filter-out': filter_out_1.FilterOut,
 };

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

@@ -4,5 +4,9 @@ export declare const decorators: {
     'operation-description-override': Oas3Decorator;
     'tag-description-override': Oas3Decorator;
     'info-description-override': Oas3Decorator;
+    'info-override': Oas3Decorator;
     'remove-x-internal': Oas3Decorator;
+    'filter-in': Oas3Decorator;
+    'filter-out': Oas3Decorator;
+    'media-type-examples-override': Oas3Decorator;
 };

package/lib/decorators/oas3/index.js

@@ -5,11 +5,19 @@ const registry_dependencies_1 = require("../common/registry-dependencies");
 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 info_override_1 = require("../common/info-override");
 const remove_x_internal_1 = require("../common/remove-x-internal");
+const filter_in_1 = require("../common/filters/filter-in");
+const filter_out_1 = require("../common/filters/filter-out");
+const media_type_examples_override_1 = require("../common/media-type-examples-override");
 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,
-    'remove-x-internal': remove_x_internal_1.RemoveXInternal
+    'info-override': info_override_1.InfoOverride,
+    'remove-x-internal': remove_x_internal_1.RemoveXInternal,
+    'filter-in': filter_in_1.FilterIn,
+    'filter-out': filter_out_1.FilterOut,
+    'media-type-examples-override': media_type_examples_override_1.MediaTypeExamplesOverride,
 };

package/lib/env.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="node" />
+export declare const isBrowser: boolean;
+export declare const env: NodeJS.ProcessEnv;

package/lib/env.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.env = exports.isBrowser = void 0;
+exports.isBrowser = 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+typeof window !== 'undefined' || typeof self !== 'undefined' || typeof process === 'undefined'; // main and worker thread
+exports.env = exports.isBrowser ? {} : process.env || {};

package/lib/format/codeframes.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAstNodeByPointer = exports.getLineColLocation = exports.getCodeframe = void 0;
-const colorette_1 = require("colorette");
 const yamlAst = require("yaml-ast-parser");
 const ref_utils_1 = require("../ref-utils");
+const logger_1 = require("../logger");
 const MAX_LINE_LENGTH = 150;
 const MAX_CODEFRAME_LINES = 3;
 // TODO: temporary
@@ -11,7 +11,7 @@ function parsePointer(pointer) {
     return pointer.substr(2).split('/').map(ref_utils_1.unescapePointer);
 }
 function getCodeframe(location, color) {
-    colorette_1.options.enabled = color;
+    logger_1.colorOptions.enabled = color;
     const { start, end = { line: start.line, col: start.col + 1 }, source } = location;
     const lines = source.getLines();
     const startLineNum = start.line;
@@ -28,16 +28,22 @@ function getCodeframe(location, color) {
         const line = lines[i - 1] || '';
         if (line !== '')
             currentPad = padSize(line);
-        let startIdx = i === startLineNum ? start.col - 1 : currentPad;
-        let endIdx = i === endLineNum ? end.col - 1 : line.length;
-        prefixedLines.push([`${i}`, markLine(line, startIdx, endIdx, colorette_1.red)]);
+        const startIdx = i === startLineNum ? start.col - 1 : currentPad;
+        const endIdx = i === endLineNum ? end.col - 1 : line.length;
+        prefixedLines.push([`${i}`, markLine(line, startIdx, endIdx, logger_1.colorize.red)]);
         if (!color)
             prefixedLines.push(['', underlineLine(line, startIdx, endIdx)]);
     }
     if (skipLines > 0) {
-        prefixedLines.push([`…`, `${whitespace(currentPad)}${colorette_1.gray(`< ${skipLines} more lines >`)}`]);
+        prefixedLines.push([
+            `…`,
+            `${whitespace(currentPad)}${logger_1.colorize.gray(`< ${skipLines} more lines >`)}`,
+        ]);
         // print last line
-        prefixedLines.push([`${endLineNum}`, markLine(lines[endLineNum - 1], -1, end.col - 1, colorette_1.red)]);
+        prefixedLines.push([
+            `${endLineNum}`,
+            markLine(lines[endLineNum - 1], -1, end.col - 1, logger_1.colorize.red),
+        ]);
         if (!color)
             prefixedLines.push(['', underlineLine(lines[endLineNum - 1], -1, end.col - 1)]);
     }
@@ -48,7 +54,7 @@ function getCodeframe(location, color) {
         [`${endLineNum + 1}`, markLine(lines[endLineNum - 1 + 1])],
         [`${endLineNum + 2}`, markLine(lines[endLineNum - 1 + 2])],
     ]);
-    function markLine(line, startIdx = -1, endIdx = +Infinity, variant = colorette_1.gray) {
+    function markLine(line, startIdx = -1, endIdx = +Infinity, variant = logger_1.colorize.gray) {
         if (!color)
             return line;
         if (!line)
@@ -66,14 +72,14 @@ function printPrefixedLines(lines) {
     const padLen = Math.max(...existingLines.map(([prefix]) => prefix.length));
     const dedentLen = Math.min(...existingLines.map(([_, line]) => (line === '' ? Infinity : padSize(line))));
     return existingLines
-        .map(([prefix, line]) => colorette_1.gray(leftPad(padLen, prefix) + ' |') +
+        .map(([prefix, line]) => logger_1.colorize.gray(leftPad(padLen, prefix) + ' |') +
         (line ? ' ' + limitLineLength(line.substring(dedentLen)) : ''))
         .join('\n');
 }
 function limitLineLength(line, maxLen = MAX_LINE_LENGTH) {
     const overflowLen = line.length - maxLen;
     if (overflowLen > 0) {
-        const charsMoreText = colorette_1.gray(`...<${overflowLen} chars>`);
+        const charsMoreText = logger_1.colorize.gray(`...<${overflowLen} chars>`);
         return line.substring(0, maxLen - charsMoreText.length) + charsMoreText;
     }
     else {

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' | 'checkstyle' | 'codeclimate';
+export declare type OutputFormat = 'codeframe' | 'stylish' | 'json' | 'checkstyle' | 'codeclimate' | 'summary';
 export declare function getTotals(problems: (NormalizedProblem & {
     ignored?: boolean;
 })[]): Totals;