@redocly/openapi-core 0.0.0-snapshot.1737554067

package/lib/index.js

@@ -0,0 +1,98 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.getTypes = exports.detectSpec = exports.SpecVersion = exports.getMajorSpecVersion = exports.SpecMajorVersion = exports.isAbsoluteUrl = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.RedoclyClient = exports.createConfig = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.AsyncApi3Types = exports.AsyncApi2Types = exports.Oas2Types = exports.Oas3Types = exports.Arazzo1Types = exports.Oas3_1Types = exports.pause = exports.getProxyAgent = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
+exports.bundleFromString = exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = exports.lintDocument = void 0;
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "readFileFromUrl", { enumerable: true, get: function () { return utils_1.readFileFromUrl; } });
+Object.defineProperty(exports, "slash", { enumerable: true, get: function () { return utils_1.slash; } });
+Object.defineProperty(exports, "doesYamlFileExist", { enumerable: true, get: function () { return utils_1.doesYamlFileExist; } });
+Object.defineProperty(exports, "isTruthy", { enumerable: true, get: function () { return utils_1.isTruthy; } });
+Object.defineProperty(exports, "getProxyAgent", { enumerable: true, get: function () { return utils_1.getProxyAgent; } });
+Object.defineProperty(exports, "pause", { enumerable: true, get: function () { return utils_1.pause; } });
+var oas3_1_1 = require("./types/oas3_1");
+Object.defineProperty(exports, "Oas3_1Types", { enumerable: true, get: function () { return oas3_1_1.Oas3_1Types; } });
+var arazzo_1 = require("./types/arazzo");
+Object.defineProperty(exports, "Arazzo1Types", { enumerable: true, get: function () { return arazzo_1.Arazzo1Types; } });
+var oas3_1 = require("./types/oas3");
+Object.defineProperty(exports, "Oas3Types", { enumerable: true, get: function () { return oas3_1.Oas3Types; } });
+var oas2_1 = require("./types/oas2");
+Object.defineProperty(exports, "Oas2Types", { enumerable: true, get: function () { return oas2_1.Oas2Types; } });
+var asyncapi2_1 = require("./types/asyncapi2");
+Object.defineProperty(exports, "AsyncApi2Types", { enumerable: true, get: function () { return asyncapi2_1.AsyncApi2Types; } });
+var asyncapi3_1 = require("./types/asyncapi3");
+Object.defineProperty(exports, "AsyncApi3Types", { enumerable: true, get: function () { return asyncapi3_1.AsyncApi3Types; } });
+var redocly_yaml_1 = require("./types/redocly-yaml");
+Object.defineProperty(exports, "ConfigTypes", { enumerable: true, get: function () { return redocly_yaml_1.ConfigTypes; } });
+var types_1 = require("./types");
+Object.defineProperty(exports, "normalizeTypes", { enumerable: true, get: function () { return types_1.normalizeTypes; } });
+var stats_1 = require("./rules/other/stats");
+Object.defineProperty(exports, "Stats", { enumerable: true, get: function () { return stats_1.Stats; } });
+var config_1 = require("./config");
+Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
+Object.defineProperty(exports, "StyleguideConfig", { enumerable: true, get: function () { return config_1.StyleguideConfig; } });
+Object.defineProperty(exports, "IGNORE_FILE", { enumerable: true, get: function () { return config_1.IGNORE_FILE; } });
+Object.defineProperty(exports, "getMergedConfig", { enumerable: true, get: function () { return config_1.getMergedConfig; } });
+Object.defineProperty(exports, "transformConfig", { enumerable: true, get: function () { return config_1.transformConfig; } });
+Object.defineProperty(exports, "loadConfig", { enumerable: true, get: function () { return config_1.loadConfig; } });
+Object.defineProperty(exports, "getConfig", { enumerable: true, get: function () { return config_1.getConfig; } });
+Object.defineProperty(exports, "findConfig", { enumerable: true, get: function () { return config_1.findConfig; } });
+Object.defineProperty(exports, "CONFIG_FILE_NAMES", { enumerable: true, get: function () { return config_1.CONFIG_FILE_NAMES; } });
+Object.defineProperty(exports, "createConfig", { enumerable: true, get: function () { return config_1.createConfig; } });
+var redocly_1 = require("./redocly");
+Object.defineProperty(exports, "RedoclyClient", { enumerable: true, get: function () { return redocly_1.RedoclyClient; } });
+__exportStar(require("./redocly/domains"), exports);
+var resolve_1 = require("./resolve");
+Object.defineProperty(exports, "Source", { enumerable: true, get: function () { return resolve_1.Source; } });
+Object.defineProperty(exports, "BaseResolver", { enumerable: true, get: function () { return resolve_1.BaseResolver; } });
+Object.defineProperty(exports, "resolveDocument", { enumerable: true, get: function () { return resolve_1.resolveDocument; } });
+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; } });
+Object.defineProperty(exports, "isRef", { enumerable: true, get: function () { return ref_utils_1.isRef; } });
+Object.defineProperty(exports, "isAbsoluteUrl", { enumerable: true, get: function () { return ref_utils_1.isAbsoluteUrl; } });
+var oas_types_1 = require("./oas-types");
+Object.defineProperty(exports, "SpecMajorVersion", { enumerable: true, get: function () { return oas_types_1.SpecMajorVersion; } });
+Object.defineProperty(exports, "getMajorSpecVersion", { enumerable: true, get: function () { return oas_types_1.getMajorSpecVersion; } });
+Object.defineProperty(exports, "SpecVersion", { enumerable: true, get: function () { return oas_types_1.SpecVersion; } });
+Object.defineProperty(exports, "detectSpec", { enumerable: true, get: function () { return oas_types_1.detectSpec; } });
+Object.defineProperty(exports, "getTypes", { enumerable: true, get: function () { return oas_types_1.getTypes; } });
+var visitors_1 = require("./visitors");
+Object.defineProperty(exports, "normalizeVisitors", { enumerable: true, get: function () { return visitors_1.normalizeVisitors; } });
+var walk_1 = require("./walk");
+Object.defineProperty(exports, "walkDocument", { enumerable: true, get: function () { return walk_1.walkDocument; } });
+var codeframes_1 = require("./format/codeframes");
+Object.defineProperty(exports, "getAstNodeByPointer", { enumerable: true, get: function () { return codeframes_1.getAstNodeByPointer; } });
+Object.defineProperty(exports, "getLineColLocation", { enumerable: true, get: function () { return codeframes_1.getLineColLocation; } });
+var format_1 = require("./format/format");
+Object.defineProperty(exports, "formatProblems", { enumerable: true, get: function () { return format_1.formatProblems; } });
+Object.defineProperty(exports, "getTotals", { enumerable: true, get: function () { return format_1.getTotals; } });
+var lint_1 = require("./lint");
+Object.defineProperty(exports, "lint", { enumerable: true, get: function () { return lint_1.lint; } });
+Object.defineProperty(exports, "validate", { enumerable: true, get: function () { return lint_1.lint; } });
+Object.defineProperty(exports, "lintDocument", { enumerable: true, get: function () { return lint_1.lintDocument; } });
+Object.defineProperty(exports, "lintFromString", { enumerable: true, get: function () { return lint_1.lintFromString; } });
+Object.defineProperty(exports, "lintConfig", { enumerable: true, get: function () { return lint_1.lintConfig; } });
+var bundle_1 = require("./bundle");
+Object.defineProperty(exports, "bundle", { enumerable: true, get: function () { return bundle_1.bundle; } });
+Object.defineProperty(exports, "bundleDocument", { enumerable: true, get: function () { return bundle_1.bundleDocument; } });
+Object.defineProperty(exports, "mapTypeToComponent", { enumerable: true, get: function () { return bundle_1.mapTypeToComponent; } });
+Object.defineProperty(exports, "bundleFromString", { enumerable: true, get: function () { return bundle_1.bundleFromString; } });

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

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

package/lib/js-yaml/index.js

@@ -0,0 +1,15 @@
+"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
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @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) => (0, js_yaml_1.load)(str, { schema: DEFAULT_SCHEMA_WITHOUT_TIMESTAMP, ...opts });
+exports.parseYaml = parseYaml;
+const stringifyYaml = (obj, opts) => (0, js_yaml_1.dump)(obj, opts);
+exports.stringifyYaml = stringifyYaml;

package/lib/lint.d.ts

@@ -0,0 +1,32 @@
+import { BaseResolver } from './resolve';
+import type { StyleguideConfig, Config } from './config';
+import type { Document, ResolvedRefMap } from './resolve';
+import type { ProblemSeverity } from './walk';
+import type { NodeType } from './types';
+import type { CollectFn } from './utils';
+export declare function lint(opts: {
+    ref: string;
+    config: Config;
+    externalRefResolver?: BaseResolver;
+    collectSpecData?: CollectFn;
+}): Promise<import("./walk").NormalizedProblem[]>;
+export declare function lintFromString(opts: {
+    source: string;
+    absoluteRef?: string;
+    config: Config;
+    externalRefResolver?: BaseResolver;
+}): Promise<import("./walk").NormalizedProblem[]>;
+export declare function lintDocument(opts: {
+    document: Document;
+    config: StyleguideConfig;
+    customTypes?: Record<string, NodeType>;
+    externalRefResolver: BaseResolver;
+}): Promise<import("./walk").NormalizedProblem[]>;
+export declare function lintConfig(opts: {
+    document: Document;
+    config: Config;
+    resolvedRefMap?: ResolvedRefMap;
+    severity?: ProblemSeverity;
+    externalRefResolver?: BaseResolver;
+    externalConfigTypes?: Record<string, NodeType>;
+}): Promise<import("./walk").NormalizedProblem[]>;

package/lib/lint.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lint = lint;
+exports.lintFromString = lintFromString;
+exports.lintDocument = lintDocument;
+exports.lintConfig = lintConfig;
+const config_1 = require("@redocly/config");
+const resolve_1 = require("./resolve");
+const visitors_1 = require("./visitors");
+const walk_1 = require("./walk");
+const config_2 = require("./config");
+const types_1 = require("./types");
+const ajv_1 = require("./rules/ajv");
+const oas_types_1 = require("./oas-types");
+const redocly_yaml_1 = require("./types/redocly-yaml");
+const struct_1 = require("./rules/common/struct");
+const no_unresolved_refs_1 = require("./rules/no-unresolved-refs");
+async function lint(opts) {
+    const { ref, externalRefResolver = new resolve_1.BaseResolver(opts.config.resolve) } = opts;
+    const document = (await externalRefResolver.resolveDocument(null, ref, true));
+    opts.collectSpecData?.(document.parsed);
+    return lintDocument({
+        document,
+        ...opts,
+        externalRefResolver,
+        config: opts.config.styleguide,
+    });
+}
+async function lintFromString(opts) {
+    const { source, absoluteRef, externalRefResolver = new resolve_1.BaseResolver(opts.config.resolve) } = opts;
+    const document = (0, resolve_1.makeDocumentFromString)(source, absoluteRef || '/');
+    return lintDocument({
+        document,
+        ...opts,
+        externalRefResolver,
+        config: opts.config.styleguide,
+    });
+}
+async function lintDocument(opts) {
+    (0, ajv_1.releaseAjvInstance)(); // FIXME: preprocessors can modify nodes which are then cached to ajv-instance by absolute path
+    const { document, customTypes, externalRefResolver, config } = opts;
+    const specVersion = (0, oas_types_1.detectSpec)(document.parsed);
+    const specMajorVersion = (0, oas_types_1.getMajorSpecVersion)(specVersion);
+    const rules = config.getRulesForSpecVersion(specMajorVersion);
+    const types = (0, types_1.normalizeTypes)(config.extendTypes(customTypes ?? (0, oas_types_1.getTypes)(specVersion), specVersion), config);
+    const ctx = {
+        problems: [],
+        oasVersion: specVersion,
+        visitorsData: {},
+    };
+    const preprocessors = (0, config_2.initRules)(rules, config, 'preprocessors', specVersion);
+    const regularRules = (0, config_2.initRules)(rules, config, 'rules', specVersion);
+    let resolvedRefMap = await (0, resolve_1.resolveDocument)({
+        rootDocument: document,
+        rootType: types.Root,
+        externalRefResolver,
+    });
+    if (preprocessors.length > 0) {
+        // Make additional pass to resolve refs defined in preprocessors.
+        (0, walk_1.walkDocument)({
+            document,
+            rootType: types.Root,
+            normalizedVisitors: (0, visitors_1.normalizeVisitors)(preprocessors, types),
+            resolvedRefMap,
+            ctx,
+        });
+        resolvedRefMap = await (0, resolve_1.resolveDocument)({
+            rootDocument: document,
+            rootType: types.Root,
+            externalRefResolver,
+        });
+    }
+    const normalizedVisitors = (0, visitors_1.normalizeVisitors)(regularRules, types);
+    (0, walk_1.walkDocument)({
+        document,
+        rootType: types.Root,
+        normalizedVisitors,
+        resolvedRefMap,
+        ctx,
+    });
+    return ctx.problems.map((problem) => config.addProblemToIgnore(problem));
+}
+async function lintConfig(opts) {
+    const { document, severity, externalRefResolver = new resolve_1.BaseResolver(), config } = opts;
+    const ctx = {
+        problems: [],
+        oasVersion: oas_types_1.SpecVersion.OAS3_0,
+        visitorsData: {},
+    };
+    const types = (0, types_1.normalizeTypes)(opts.externalConfigTypes || (0, redocly_yaml_1.createConfigTypes)(config_1.rootRedoclyConfigSchema, config), { doNotResolveExamples: config.styleguide.doNotResolveExamples });
+    const rules = [
+        {
+            severity: severity || 'error',
+            ruleId: 'configuration spec',
+            visitor: (0, struct_1.Struct)({ severity: 'error' }),
+        },
+        {
+            severity: severity || 'error',
+            ruleId: 'configuration no-unresolved-refs',
+            visitor: (0, no_unresolved_refs_1.NoUnresolvedRefs)({ severity: 'error' }),
+        },
+    ];
+    const normalizedVisitors = (0, visitors_1.normalizeVisitors)(rules, types);
+    const resolvedRefMap = opts.resolvedRefMap ||
+        (await (0, resolve_1.resolveDocument)({
+            rootDocument: document,
+            rootType: types.ConfigRoot,
+            externalRefResolver,
+        }));
+    (0, walk_1.walkDocument)({
+        document,
+        rootType: types.ConfigRoot,
+        normalizedVisitors,
+        resolvedRefMap,
+        ctx,
+    });
+    return ctx.problems;
+}

package/lib/logger.d.ts

@@ -0,0 +1,10 @@
+import * as colorette from 'colorette';
+export { options as colorOptions } from 'colorette';
+export declare const colorize: typeof colorette;
+declare class Logger {
+    protected stderr(str: string): boolean;
+    info(str: string): boolean | void;
+    warn(str: string): boolean | void;
+    error(str: string): boolean | void;
+}
+export declare const logger: Logger;

package/lib/logger.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = exports.colorize = exports.colorOptions = void 0;
+const colorette = require("colorette");
+const env_1 = require("./env");
+const utils_1 = require("./utils");
+var colorette_1 = require("colorette");
+Object.defineProperty(exports, "colorOptions", { enumerable: true, get: function () { return colorette_1.options; } });
+exports.colorize = new Proxy(colorette, {
+    get(target, prop) {
+        if (env_1.isBrowser) {
+            return utils_1.identity;
+        }
+        return target[prop];
+    },
+});
+class Logger {
+    stderr(str) {
+        return process.stderr.write(str);
+    }
+    info(str) {
+        return env_1.isBrowser ? console.log(str) : this.stderr(str);
+    }
+    warn(str) {
+        return env_1.isBrowser ? console.warn(str) : this.stderr(exports.colorize.yellow(str));
+    }
+    error(str) {
+        return env_1.isBrowser ? console.error(str) : this.stderr(exports.colorize.red(str));
+    }
+}
+exports.logger = new Logger();

package/lib/oas-types.d.ts

@@ -0,0 +1,36 @@
+import type { BuiltInAsync2RuleId, BuiltInAsync3RuleId, BuiltInArazzo1RuleId, BuiltInOAS2RuleId, BuiltInOAS3RuleId } from './types/redocly-yaml';
+import type { Oas3Rule, Oas3Preprocessor, Oas2Rule, Oas2Preprocessor, Async2Preprocessor, Async2Rule, Async3Preprocessor, Async3Rule, Arazzo1Preprocessor, Arazzo1Rule } from './visitors';
+export declare enum SpecVersion {
+    OAS2 = "oas2",
+    OAS3_0 = "oas3_0",
+    OAS3_1 = "oas3_1",
+    Async2 = "async2",
+    Async3 = "async3",
+    Arazzo1 = "arazzo1"
+}
+export declare enum SpecMajorVersion {
+    OAS2 = "oas2",
+    OAS3 = "oas3",
+    Async2 = "async2",
+    Async3 = "async3",
+    Arazzo1 = "arazzo1"
+}
+export type RuleMap<Key extends string, RuleConfig, T> = Record<T extends 'built-in' ? Key : string, RuleConfig>;
+export type Oas3RuleSet<T = undefined> = RuleMap<BuiltInOAS3RuleId | 'struct' | 'assertions', Oas3Rule, T>;
+export type Oas2RuleSet<T = undefined> = RuleMap<BuiltInOAS2RuleId | 'struct' | 'assertions', Oas2Rule, T>;
+export type Async2RuleSet<T = undefined> = RuleMap<BuiltInAsync2RuleId | 'struct' | 'assertions', Async2Rule, T>;
+export type Async3RuleSet<T = undefined> = RuleMap<BuiltInAsync3RuleId | 'struct' | 'assertions', Async3Rule, T>;
+export type Arazzo1RuleSet<T = undefined> = RuleMap<BuiltInArazzo1RuleId | 'struct' | 'assertions', Arazzo1Rule, T>;
+export type Oas3PreprocessorsSet = Record<string, Oas3Preprocessor>;
+export type Oas2PreprocessorsSet = Record<string, Oas2Preprocessor>;
+export type Async2PreprocessorsSet = Record<string, Async2Preprocessor>;
+export type Async3PreprocessorsSet = Record<string, Async3Preprocessor>;
+export type Arazzo1PreprocessorsSet = Record<string, Arazzo1Preprocessor>;
+export type Oas3DecoratorsSet = Record<string, Oas3Preprocessor>;
+export type Oas2DecoratorsSet = Record<string, Oas2Preprocessor>;
+export type Async2DecoratorsSet = Record<string, Async2Preprocessor>;
+export type Async3DecoratorsSet = Record<string, Async3Preprocessor>;
+export type Arazzo1DecoratorsSet = Record<string, Arazzo1Preprocessor>;
+export declare function detectSpec(root: unknown): SpecVersion;
+export declare function getMajorSpecVersion(version: SpecVersion): SpecMajorVersion;
+export declare function getTypes(spec: SpecVersion): Record<string, import("./types").NodeType> | Record<"Root" | "Tag" | "TagList" | "ExternalDocs" | "SecurityRequirement" | "SecurityRequirementList" | "Info" | "Contact" | "License" | "Paths" | "PathItem" | "Parameter" | "ParameterList" | "ParameterItems" | "Operation" | "Example" | "ExamplesMap" | "Examples" | "Header" | "Responses" | "Response" | "Schema" | "Xml" | "SchemaProperties" | "NamedSchemas" | "NamedResponses" | "NamedParameters" | "NamedSecuritySchemes" | "SecurityScheme" | "TagGroup" | "TagGroups" | "EnumDescriptions" | "Logo" | "XCodeSample" | "XCodeSampleList" | "XServer" | "XServerList", import("./types").NodeType> | Record<"Root" | "Tag" | "TagList" | "ExternalDocs" | "SecurityRequirement" | "SecurityRequirementList" | "Info" | "Contact" | "License" | "Paths" | "PathItem" | "Parameter" | "ParameterList" | "Operation" | "Example" | "ExamplesMap" | "Header" | "Responses" | "Response" | "Schema" | "Xml" | "SchemaProperties" | "NamedSchemas" | "NamedResponses" | "NamedParameters" | "NamedSecuritySchemes" | "SecurityScheme" | "TagGroup" | "TagGroups" | "EnumDescriptions" | "Logo" | "XCodeSample" | "XCodeSampleList" | "Server" | "ServerList" | "ServerVariable" | "ServerVariablesMap" | "Callback" | "CallbacksMap" | "RequestBody" | "MediaTypesMap" | "MediaType" | "Encoding" | "EncodingMap" | "HeadersMap" | "Link" | "LinksMap" | "DiscriminatorMapping" | "Discriminator" | "Components" | "NamedExamples" | "NamedRequestBodies" | "NamedHeaders" | "NamedLinks" | "NamedCallbacks" | "ImplicitFlow" | "PasswordFlow" | "ClientCredentials" | "AuthorizationCode" | "OAuth2Flows" | "XUsePkce" | "WebhooksMap", import("./types").NodeType> | Record<"Root" | "Info" | "License" | "Operation" | "Schema" | "SchemaProperties" | "SecurityScheme" | "Components" | "PatternProperties" | "NamedPathItems" | "DependentRequired", import("./types").NodeType>;

package/lib/oas-types.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpecMajorVersion = exports.SpecVersion = void 0;
+exports.detectSpec = detectSpec;
+exports.getMajorSpecVersion = getMajorSpecVersion;
+exports.getTypes = getTypes;
+const oas2_1 = require("./types/oas2");
+const oas3_1 = require("./types/oas3");
+const oas3_1_1 = require("./types/oas3_1");
+const asyncapi2_1 = require("./types/asyncapi2");
+const asyncapi3_1 = require("./types/asyncapi3");
+const arazzo_1 = require("./types/arazzo");
+const utils_1 = require("./utils");
+const arazzo_2 = require("./typings/arazzo");
+var SpecVersion;
+(function (SpecVersion) {
+    SpecVersion["OAS2"] = "oas2";
+    SpecVersion["OAS3_0"] = "oas3_0";
+    SpecVersion["OAS3_1"] = "oas3_1";
+    SpecVersion["Async2"] = "async2";
+    SpecVersion["Async3"] = "async3";
+    SpecVersion["Arazzo1"] = "arazzo1";
+})(SpecVersion || (exports.SpecVersion = SpecVersion = {}));
+var SpecMajorVersion;
+(function (SpecMajorVersion) {
+    SpecMajorVersion["OAS2"] = "oas2";
+    SpecMajorVersion["OAS3"] = "oas3";
+    SpecMajorVersion["Async2"] = "async2";
+    SpecMajorVersion["Async3"] = "async3";
+    SpecMajorVersion["Arazzo1"] = "arazzo1";
+})(SpecMajorVersion || (exports.SpecMajorVersion = SpecMajorVersion = {}));
+const typesMap = {
+    [SpecVersion.OAS2]: oas2_1.Oas2Types,
+    [SpecVersion.OAS3_0]: oas3_1.Oas3Types,
+    [SpecVersion.OAS3_1]: oas3_1_1.Oas3_1Types,
+    [SpecVersion.Async2]: asyncapi2_1.AsyncApi2Types,
+    [SpecVersion.Async3]: asyncapi3_1.AsyncApi3Types,
+    [SpecVersion.Arazzo1]: arazzo_1.Arazzo1Types,
+};
+function detectSpec(root) {
+    if (!(0, utils_1.isPlainObject)(root)) {
+        throw new Error(`Document must be JSON object, got ${typeof root}`);
+    }
+    if (root.openapi && typeof root.openapi !== 'string') {
+        throw new Error(`Invalid OpenAPI version: should be a string but got "${typeof root.openapi}"`);
+    }
+    if (typeof root.openapi === 'string' && root.openapi.startsWith('3.0')) {
+        return SpecVersion.OAS3_0;
+    }
+    if (typeof root.openapi === 'string' && root.openapi.startsWith('3.1')) {
+        return SpecVersion.OAS3_1;
+    }
+    if (root.swagger && root.swagger === '2.0') {
+        return SpecVersion.OAS2;
+    }
+    if (root.openapi || root.swagger) {
+        throw new Error(`Unsupported OpenAPI version: ${root.openapi || root.swagger}`);
+    }
+    if (typeof root.asyncapi === 'string' && root.asyncapi.startsWith('2.')) {
+        return SpecVersion.Async2;
+    }
+    if (typeof root.asyncapi === 'string' && root.asyncapi.startsWith('3.')) {
+        return SpecVersion.Async3;
+    }
+    if (root.asyncapi) {
+        throw new Error(`Unsupported AsyncAPI version: ${root.asyncapi}`);
+    }
+    if (typeof root.arazzo === 'string' && arazzo_2.VERSION_PATTERN.test(root.arazzo)) {
+        return SpecVersion.Arazzo1;
+    }
+    throw new Error(`Unsupported specification`);
+}
+function getMajorSpecVersion(version) {
+    if (version === SpecVersion.OAS2) {
+        return SpecMajorVersion.OAS2;
+    }
+    else if (version === SpecVersion.Async2) {
+        return SpecMajorVersion.Async2;
+    }
+    else if (version === SpecVersion.Async3) {
+        return SpecMajorVersion.Async3;
+    }
+    else if (version === SpecVersion.Arazzo1) {
+        return SpecMajorVersion.Arazzo1;
+    }
+    else {
+        return SpecMajorVersion.OAS3;
+    }
+}
+function getTypes(spec) {
+    return typesMap[spec];
+}

package/lib/output.d.ts

@@ -0,0 +1,3 @@
+export declare const output: {
+    write(str: string): boolean | undefined;
+};

package/lib/output.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.output = void 0;
+const env_1 = require("./env");
+exports.output = {
+    write(str) {
+        return env_1.isBrowser ? undefined : process.stdout.write(str);
+    },
+};

package/lib/redocly/domains.d.ts

@@ -0,0 +1,14 @@
+import type { Region } from '../config/types';
+export declare const DEFAULT_REGION = "us";
+export declare const DOMAINS: {
+    us: string;
+    eu: string;
+};
+export declare const AVAILABLE_REGIONS: Region[];
+export declare function getDomains(): {
+    us: string;
+    eu: string;
+};
+export declare function setRedoclyDomain(domain: string): void;
+export declare function getRedoclyDomain(): string;
+export declare function isRedoclyRegistryURL(link: string): boolean;

package/lib/redocly/domains.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AVAILABLE_REGIONS = exports.DOMAINS = exports.DEFAULT_REGION = void 0;
+exports.getDomains = getDomains;
+exports.setRedoclyDomain = setRedoclyDomain;
+exports.getRedoclyDomain = getRedoclyDomain;
+exports.isRedoclyRegistryURL = isRedoclyRegistryURL;
+let redoclyDomain = 'redocly.com';
+exports.DEFAULT_REGION = 'us';
+exports.DOMAINS = getDomains();
+exports.AVAILABLE_REGIONS = Object.keys(exports.DOMAINS);
+function getDomains() {
+    const domains = {
+        us: 'redocly.com',
+        eu: 'eu.redocly.com',
+    };
+    // FIXME: temporary fix for our lab environments
+    const domain = redoclyDomain;
+    if (domain?.endsWith('.redocly.host')) {
+        domains[domain.split('.')[0]] = domain;
+    }
+    if (domain === 'redoc.online') {
+        domains[domain] = domain;
+    }
+    return domains;
+}
+function setRedoclyDomain(domain) {
+    redoclyDomain = domain;
+}
+function getRedoclyDomain() {
+    return redoclyDomain;
+}
+function isRedoclyRegistryURL(link) {
+    const domain = getRedoclyDomain() || exports.DOMAINS[exports.DEFAULT_REGION];
+    const legacyDomain = domain === 'redocly.com' ? 'redoc.ly' : domain;
+    if (!link.startsWith(`https://api.${domain}/registry/`) &&
+        !link.startsWith(`https://api.${legacyDomain}/registry/`)) {
+        return false;
+    }
+    return true;
+}

package/lib/redocly/index.d.ts

@@ -0,0 +1,30 @@
+import { RegistryApi } from './registry-api';
+import type { RegionalToken, RegionalTokenWithValidity } from './redocly-client-types';
+import type { AccessTokens, Region } from '../config/types';
+export declare const TOKEN_FILENAME = ".redocly-config.json";
+export declare class RedoclyClient {
+    private accessTokens;
+    private region;
+    domain: string;
+    registryApi: RegistryApi;
+    constructor(region?: Region);
+    loadRegion(region?: Region): Region;
+    getRegion(): Region;
+    hasTokens(): boolean;
+    hasToken(): boolean;
+    getAuthorizationHeader(): Promise<string | undefined>;
+    setAccessTokens(accessTokens: AccessTokens): void;
+    loadTokens(): void;
+    getAllTokens(): RegionalToken[];
+    getValidTokens(): Promise<RegionalTokenWithValidity[]>;
+    getTokens(): Promise<RegionalTokenWithValidity[]>;
+    isAuthorizedWithRedoclyByRegion(): Promise<boolean>;
+    isAuthorizedWithRedocly(): Promise<boolean>;
+    readCredentialsFile(credentialsPath: string): any;
+    verifyToken(accessToken: string, verbose?: boolean): Promise<{
+        viewerId: string;
+        organizations: string[];
+    }>;
+    login(accessToken: string, verbose?: boolean): Promise<void>;
+    logout(): void;
+}