@redocly/openapi-core 1.0.0-beta.100

package/lib/config/types.d.ts

@@ -0,0 +1,113 @@
+import type { ProblemSeverity } from '../walk';
+import type { Oas3PreprocessorsSet, OasMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, OasVersion } from '../oas-types';
+import type { NodeType } from '../types';
+export declare type RuleConfig = ProblemSeverity | 'off' | ({
+    severity?: ProblemSeverity;
+} & Record<string, any>);
+export declare type PreprocessorConfig = ProblemSeverity | 'off' | 'on' | ({
+    severity?: ProblemSeverity;
+} & Record<string, any>);
+export declare type DecoratorConfig = PreprocessorConfig;
+export declare type LintRawConfig = {
+    plugins?: (string | Plugin)[];
+    extends?: string[];
+    doNotResolveExamples?: boolean;
+    recommendedFallback?: boolean;
+    rules?: Record<string, RuleConfig>;
+    oas2Rules?: Record<string, RuleConfig>;
+    oas3_0Rules?: Record<string, RuleConfig>;
+    oas3_1Rules?: Record<string, RuleConfig>;
+    preprocessors?: Record<string, PreprocessorConfig>;
+    oas2Preprocessors?: Record<string, PreprocessorConfig>;
+    oas3_0Preprocessors?: Record<string, PreprocessorConfig>;
+    oas3_1Preprocessors?: Record<string, PreprocessorConfig>;
+    decorators?: Record<string, DecoratorConfig>;
+    oas2Decorators?: Record<string, DecoratorConfig>;
+    oas3_0Decorators?: Record<string, DecoratorConfig>;
+    oas3_1Decorators?: Record<string, DecoratorConfig>;
+};
+export declare type ResolvedLintConfig = PluginLintConfig & {
+    plugins?: Plugin[];
+    recommendedFallback?: boolean;
+    extends?: void | never;
+    extendPaths?: string[];
+    pluginPaths?: string[];
+};
+export declare type PreprocessorsConfig = {
+    oas3?: Oas3PreprocessorsSet;
+    oas2?: Oas2PreprocessorsSet;
+};
+export declare type DecoratorsConfig = {
+    oas3?: Oas3DecoratorsSet;
+    oas2?: Oas2DecoratorsSet;
+};
+export declare type TypesExtensionFn = (types: Record<string, NodeType>, oasVersion: OasVersion) => Record<string, NodeType>;
+export declare type TypeExtensionsConfig = Partial<Record<OasMajorVersion, TypesExtensionFn>>;
+export declare type CustomRulesConfig = {
+    oas3?: Oas3RuleSet;
+    oas2?: Oas2RuleSet;
+};
+export declare type Plugin = {
+    id: string;
+    configs?: Record<string, PluginLintConfig>;
+    rules?: CustomRulesConfig;
+    preprocessors?: PreprocessorsConfig;
+    decorators?: DecoratorsConfig;
+    typeExtension?: TypeExtensionsConfig;
+};
+export declare type PluginLintConfig = Omit<LintRawConfig, 'plugins' | 'extends'>;
+export declare type ResolveHeader = {
+    name: string;
+    envVariable?: undefined;
+    value: string;
+    matches: string;
+} | {
+    name: string;
+    value?: undefined;
+    envVariable: string;
+    matches: string;
+};
+export declare type RawResolveConfig = {
+    http?: Partial<HttpResolveConfig>;
+};
+export declare type HttpResolveConfig = {
+    headers: ResolveHeader[];
+    customFetch?: Function;
+};
+export declare type ResolveConfig = {
+    http: HttpResolveConfig;
+};
+export declare type Region = 'us' | 'eu';
+export declare type AccessTokens = {
+    [region in Region]?: string;
+};
+export declare type DeprecatedRawConfig = {
+    apiDefinitions?: Record<string, string>;
+    lint?: LintRawConfig;
+    resolve?: RawResolveConfig;
+    region?: Region;
+    referenceDocs?: Record<string, any>;
+};
+export declare type Api = {
+    root: string;
+    lint?: Omit<LintRawConfig, 'plugins'>;
+    'features.openapi'?: Record<string, any>;
+    'features.mockServer'?: Record<string, any>;
+};
+export declare type ResolvedApi = Omit<Api, 'lint'> & {
+    lint: Omit<ResolvedLintConfig, 'plugins'>;
+};
+export declare type RawConfig = {
+    apis?: Record<string, Api>;
+    lint?: LintRawConfig;
+    resolve?: RawResolveConfig;
+    region?: Region;
+    'features.openapi'?: Record<string, any>;
+    'features.mockServer'?: Record<string, any>;
+    organization?: string;
+};
+export declare type ResolvedConfig = Omit<RawConfig, 'lint' | 'apis'> & {
+    lint: ResolvedLintConfig;
+    apis: Record<string, ResolvedApi>;
+};
+export declare type RulesFields = 'rules' | 'oas2Rules' | 'oas3_0Rules' | 'oas3_1Rules' | 'preprocessors' | 'oas2Preprocessors' | 'oas3_0Preprocessors' | 'oas3_1Preprocessors' | 'decorators' | 'oas2Decorators' | 'oas3_0Decorators' | 'oas3_1Decorators';

package/lib/config/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/config/utils.d.ts

@@ -0,0 +1,13 @@
+import { Config } from './config';
+import type { Api, DeprecatedRawConfig, Plugin, RawConfig, RawResolveConfig, ResolveConfig, ResolvedLintConfig, RulesFields } from './types';
+export declare function parsePresetName(presetName: string): {
+    pluginId: string;
+    configName: string;
+};
+export declare function transformApiDefinitionsToApis(apiDefinitions?: Record<string, string>): Record<string, Api>;
+export declare function prefixRules<T extends Record<string, any>>(rules: T, prefix: string): any;
+export declare function mergeExtends(rulesConfList: ResolvedLintConfig[]): Omit<ResolvedLintConfig, RulesFields> & Required<Pick<ResolvedLintConfig, RulesFields>>;
+export declare function getMergedConfig(config: Config, entrypointAlias?: string): Config;
+export declare function transformConfig(rawConfig: DeprecatedRawConfig | RawConfig): RawConfig;
+export declare function getResolveConfig(resolve?: RawResolveConfig): ResolveConfig;
+export declare function getUniquePlugins(plugins: Plugin[]): Plugin[];

package/lib/config/utils.js

@@ -0,0 +1,160 @@
+"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.getUniquePlugins = exports.getResolveConfig = exports.transformConfig = exports.getMergedConfig = exports.mergeExtends = exports.prefixRules = exports.transformApiDefinitionsToApis = exports.parsePresetName = void 0;
+const colorette_1 = require("colorette");
+const utils_1 = require("../utils");
+const config_1 = require("./config");
+function parsePresetName(presetName) {
+    if (presetName.indexOf('/') > -1) {
+        const [pluginId, configName] = presetName.split('/');
+        return { pluginId, configName };
+    }
+    else {
+        return { pluginId: '', configName: presetName };
+    }
+}
+exports.parsePresetName = parsePresetName;
+function transformApiDefinitionsToApis(apiDefinitions = {}) {
+    let apis = {};
+    for (const [apiName, apiPath] of Object.entries(apiDefinitions)) {
+        apis[apiName] = { root: apiPath };
+    }
+    return apis;
+}
+exports.transformApiDefinitionsToApis = transformApiDefinitionsToApis;
+function prefixRules(rules, prefix) {
+    if (!prefix)
+        return rules;
+    const res = {};
+    for (const name of Object.keys(rules)) {
+        res[`${prefix}/${name}`] = rules[name];
+    }
+    return res;
+}
+exports.prefixRules = prefixRules;
+function mergeExtends(rulesConfList) {
+    const result = {
+        rules: {},
+        oas2Rules: {},
+        oas3_0Rules: {},
+        oas3_1Rules: {},
+        preprocessors: {},
+        oas2Preprocessors: {},
+        oas3_0Preprocessors: {},
+        oas3_1Preprocessors: {},
+        decorators: {},
+        oas2Decorators: {},
+        oas3_0Decorators: {},
+        oas3_1Decorators: {},
+        plugins: [],
+        pluginPaths: [],
+        extendPaths: [],
+    };
+    for (let rulesConf of rulesConfList) {
+        if (rulesConf.extends) {
+            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);
+        utils_1.assignExisting(result.oas2Rules, rulesConf.rules || {});
+        Object.assign(result.oas3_0Rules, rulesConf.oas3_0Rules);
+        utils_1.assignExisting(result.oas3_0Rules, rulesConf.rules || {});
+        Object.assign(result.oas3_1Rules, rulesConf.oas3_1Rules);
+        utils_1.assignExisting(result.oas3_1Rules, rulesConf.rules || {});
+        Object.assign(result.preprocessors, rulesConf.preprocessors);
+        Object.assign(result.oas2Preprocessors, rulesConf.oas2Preprocessors);
+        utils_1.assignExisting(result.oas2Preprocessors, rulesConf.preprocessors || {});
+        Object.assign(result.oas3_0Preprocessors, rulesConf.oas3_0Preprocessors);
+        utils_1.assignExisting(result.oas3_0Preprocessors, rulesConf.preprocessors || {});
+        Object.assign(result.oas3_1Preprocessors, rulesConf.oas3_1Preprocessors);
+        utils_1.assignExisting(result.oas3_1Preprocessors, rulesConf.preprocessors || {});
+        Object.assign(result.decorators, rulesConf.decorators);
+        Object.assign(result.oas2Decorators, rulesConf.oas2Decorators);
+        utils_1.assignExisting(result.oas2Decorators, rulesConf.decorators || {});
+        Object.assign(result.oas3_0Decorators, rulesConf.oas3_0Decorators);
+        utils_1.assignExisting(result.oas3_0Decorators, rulesConf.decorators || {});
+        Object.assign(result.oas3_1Decorators, rulesConf.oas3_1Decorators);
+        utils_1.assignExisting(result.oas3_1Decorators, rulesConf.decorators || {});
+        result.plugins.push(...(rulesConf.plugins || []));
+        result.pluginPaths.push(...(rulesConf.pluginPaths || []));
+        result.extendPaths.push(...new Set(rulesConf.extendPaths));
+    }
+    return result;
+}
+exports.mergeExtends = mergeExtends;
+function getMergedConfig(config, entrypointAlias) {
+    var _a, _b, _c, _d, _e, _f;
+    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,
+    ]
+        .flat()
+        .filter(Boolean);
+    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,
+    ]
+        .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)
+        : config;
+}
+exports.getMergedConfig = getMergedConfig;
+function transformConfig(rawConfig) {
+    if (rawConfig.apis && rawConfig.apiDefinitions) {
+        throw new Error("Do not use 'apiDefinitions' field. Use 'apis' instead.\n");
+    }
+    if (rawConfig['features.openapi'] &&
+        rawConfig.referenceDocs) {
+        throw new Error("Do not use 'referenceDocs' field. Use 'features.openapi' instead.\n");
+    }
+    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 (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`);
+    }
+    return Object.assign({ 'features.openapi': referenceDocs, apis: transformApiDefinitionsToApis(apiDefinitions) }, rest);
+}
+exports.transformConfig = transformConfig;
+function getResolveConfig(resolve) {
+    var _a, _b;
+    return {
+        http: {
+            headers: (_b = (_a = resolve === null || resolve === void 0 ? void 0 : resolve.http) === null || _a === void 0 ? void 0 : _a.headers) !== null && _b !== void 0 ? _b : [],
+            customFetch: undefined,
+        },
+    };
+}
+exports.getResolveConfig = getResolveConfig;
+function getUniquePlugins(plugins) {
+    const seen = new Set();
+    const results = [];
+    for (const p of plugins) {
+        if (!seen.has(p.id)) {
+            results.push(p);
+            seen.add(p.id);
+        }
+        else if (p.id) {
+            process.stderr.write(`Duplicate plugin id "${colorette_1.yellow(p.id)}".\n`);
+        }
+    }
+    return results;
+}
+exports.getUniquePlugins = getUniquePlugins;

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

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

package/lib/decorators/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/decorators/common/operation-description-override.d.ts

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

package/lib/decorators/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/decorators/common/registry-dependencies.d.ts

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

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

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegistryDependencies = void 0;
+const redocly_1 = require("../../redocly");
+const RegistryDependencies = () => {
+    let registryDependencies = new Set();
+    return {
+        DefinitionRoot: {
+            leave(_, ctx) {
+                const data = ctx.getVisitorData();
+                data.links = Array.from(registryDependencies);
+            },
+        },
+        ref(node) {
+            if (node.$ref) {
+                const link = node.$ref.split('#/')[0];
+                if (redocly_1.isRedoclyRegistryURL(link)) {
+                    registryDependencies.add(link);
+                }
+            }
+        },
+    };
+};
+exports.RegistryDependencies = RegistryDependencies;

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

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

package/lib/decorators/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/decorators/common/tag-description-override.d.ts

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

package/lib/decorators/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/decorators/oas2/index.d.ts

@@ -0,0 +1,8 @@
+import { Oas2Decorator } from '../../visitors';
+export declare const decorators: {
+    'registry-dependencies': Oas2Decorator;
+    'operation-description-override': Oas2Decorator;
+    'tag-description-override': Oas2Decorator;
+    'info-description-override': Oas2Decorator;
+    'remove-x-internal': Oas2Decorator;
+};

package/lib/decorators/oas2/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decorators = void 0;
+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 remove_x_internal_1 = require("../common/remove-x-internal");
+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
+};

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

@@ -0,0 +1,8 @@
+import { Oas3Decorator } from '../../visitors';
+export declare const decorators: {
+    'registry-dependencies': Oas3Decorator;
+    'operation-description-override': Oas3Decorator;
+    'tag-description-override': Oas3Decorator;
+    'info-description-override': Oas3Decorator;
+    'remove-x-internal': Oas3Decorator;
+};

package/lib/decorators/oas3/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decorators = void 0;
+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 remove_x_internal_1 = require("../common/remove-x-internal");
+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
+};

package/lib/format/codeframes.d.ts

@@ -0,0 +1,22 @@
+import * as yamlAst from 'yaml-ast-parser';
+import { LineColLocationObject, LocationObject } from '../walk';
+declare type YAMLMapping = yamlAst.YAMLMapping & {
+    kind: yamlAst.Kind.MAPPING;
+};
+declare type YAMLMap = yamlAst.YamlMap & {
+    kind: yamlAst.Kind.MAP;
+};
+declare type YAMLAnchorReference = yamlAst.YAMLAnchorReference & {
+    kind: yamlAst.Kind.ANCHOR_REF;
+};
+declare type YAMLSequence = yamlAst.YAMLSequence & {
+    kind: yamlAst.Kind.SEQ;
+};
+declare type YAMLScalar = yamlAst.YAMLScalar & {
+    kind: yamlAst.Kind.SCALAR;
+};
+declare type YAMLNode = YAMLMapping | YAMLMap | YAMLAnchorReference | YAMLSequence | YAMLScalar;
+export declare function getCodeframe(location: LineColLocationObject, color: boolean): string;
+export declare function getLineColLocation(location: LocationObject): LineColLocationObject;
+export declare function getAstNodeByPointer(root: YAMLNode, pointer: string, reportOnKey: boolean): yamlAst.YAMLScalar | YAMLMapping | YAMLMap | YAMLAnchorReference | YAMLSequence | undefined;
+export {};