@redocly/openapi-core
Version:
See https://github.com/Redocly/redocly-cli
46 lines • 2.11 kB
TypeScript
import { BaseResolver } from './resolve.js';
import { type SpecMajorVersion } from './oas-types.js';
import { type Config } from './config/index.js';
import type { Plugin, ResolvedConfig } from './config/types.js';
import type { NormalizedNodeType, NodeType } from './types/index.js';
import type { NormalizedProblem } from './walk.js';
import type { Document, ResolvedRefMap } from './resolve.js';
import type { CollectFn } from './utils.js';
export type CoreBundleOptions = {
externalRefResolver?: BaseResolver;
config: Config;
dereference?: boolean;
base?: string | null;
removeUnusedComponents?: boolean;
keepUrlRefs?: boolean;
};
export declare function collectConfigPlugins(document: Document, resolvedRefMap: ResolvedRefMap, rootConfigDir: string): (Plugin | import("./config/config-resolvers.js").PluginResolveInfo)[];
export declare function bundleConfig(document: Document, resolvedRefMap: ResolvedRefMap, plugins: Plugin[]): ResolvedConfig;
export declare function bundle(opts: {
ref?: string;
doc?: Document;
collectSpecData?: CollectFn;
} & CoreBundleOptions): Promise<BundleResult>;
export declare function bundleFromString(opts: {
source: string;
absoluteRef?: string;
} & CoreBundleOptions): Promise<BundleResult>;
export type BundleResult = {
bundle: Document;
problems: NormalizedProblem[];
fileDependencies: Set<string>;
rootType: NormalizedNodeType;
refTypes?: Map<string, NormalizedNodeType>;
visitorsData: Record<string, Record<string, unknown>>;
};
export declare function bundleDocument(opts: {
document: Document;
config: Config;
customTypes?: Record<string, NodeType>;
externalRefResolver: BaseResolver;
dereference?: boolean;
removeUnusedComponents?: boolean;
keepUrlRefs?: boolean;
}): Promise<BundleResult>;
export declare function mapTypeToComponent(typeName: string, version: SpecMajorVersion): "responses" | "definitions" | "links" | "examples" | "parameters" | "headers" | "schemas" | "requestBodies" | "securitySchemes" | "callbacks" | null;
//# sourceMappingURL=bundle.d.ts.map