@speclynx/apidom-reference 1.12.1

package/types/resolve/resolvers/http-axios/index.d.ts

@@ -0,0 +1,30 @@
+import { Axios, AxiosInstance, CreateAxiosDefaults } from 'axios';
+import HTTPResolver, { HTTPResolverOptions } from '../HTTPResolver.ts';
+import File from '../../../File.ts';
+export type { default as HTTPResolver, HTTPResolverOptions } from '../HTTPResolver.ts';
+export type { default as Resolver, ResolverOptions } from '../Resolver.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface HTTPResolverAxiosConfig extends CreateAxiosDefaults {
+    interceptors?: Axios['interceptors'];
+}
+/**
+ * @public
+ */
+export interface HTTPResolverAxiosOptions extends Omit<HTTPResolverOptions, 'name'> {
+    readonly axiosConfig?: HTTPResolverAxiosConfig;
+}
+/**
+ * @public
+ */
+declare class HTTPResolverAxios extends HTTPResolver {
+    axiosConfig: HTTPResolverAxiosConfig;
+    protected axiosInstance: AxiosInstance;
+    protected previousAxiosConfig: HTTPResolverAxiosConfig;
+    constructor(options?: HTTPResolverAxiosOptions);
+    getHttpClient(): AxiosInstance;
+    read(file: File): Promise<Buffer>;
+}
+export default HTTPResolverAxios;

package/types/resolve/strategies/ResolveStrategy.d.ts

@@ -0,0 +1,19 @@
+import File from '../../File.ts';
+import ReferenceSet from '../../ReferenceSet.ts';
+import type { ReferenceOptions } from '../../options/index.ts';
+/**
+ * @public
+ */
+export interface ResolveStrategyOptions {
+    readonly name: string;
+}
+/**
+ * @public
+ */
+declare abstract class ResolveStrategy {
+    readonly name: string;
+    constructor({ name }: ResolveStrategyOptions);
+    abstract canResolve(file: File, options: ReferenceOptions): boolean;
+    abstract resolve(file: File, options: ReferenceOptions): Promise<ReferenceSet>;
+}
+export default ResolveStrategy;

package/types/resolve/strategies/apidom/index.d.ts

@@ -0,0 +1,27 @@
+import ResolveStrategy, { ResolveStrategyOptions } from '../ResolveStrategy.ts';
+import ReferenceSet from '../../../ReferenceSet.ts';
+import File from '../../../File.ts';
+import type { ReferenceOptions } from '../../../options/index.ts';
+export type { default as ResolveStrategy, ResolveStrategyOptions } from '../ResolveStrategy.ts';
+export type { default as ReferenceSet, ReferenceSetOptions } from '../../../ReferenceSet.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+export type { ReferenceOptions as ApiDOMReferenceOptions, ReferenceBundleOptions as ApiDOMReferenceBundleOptions, ReferenceDereferenceOptions as ApiDOMReferenceDereferenceOptions, ReferenceParseOptions as ApiDOMReferenceParseOptions, ReferenceResolveOptions as ApiDOMReferenceResolveOptions, } from '../../../options/index.ts';
+export type { default as Parser, ParserOptions } from '../../../parse/parsers/Parser.ts';
+export type { default as Resolver, ResolverOptions } from '../../resolvers/Resolver.ts';
+export type { default as DereferenceStrategy, DereferenceStrategyOptions, } from '../../../dereference/strategies/DereferenceStrategy.ts';
+export type { default as BundleStrategy, BundleStrategyOptions, } from '../../../bundle/strategies/BundleStrategy.ts';
+export type { default as Reference, ReferenceOptions } from '../../../Reference.ts';
+/**
+ * @public
+ */
+export interface ApiDOMResolveStrategyOptions extends Omit<ResolveStrategyOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class ApiDOMResolveStrategy extends ResolveStrategy {
+    constructor(options?: ApiDOMResolveStrategyOptions);
+    canResolve(file: File, options: ReferenceOptions): boolean;
+    resolve(file: File, options: ReferenceOptions): Promise<ReferenceSet>;
+}
+export default ApiDOMResolveStrategy;

package/types/resolve/strategies/asyncapi-2/index.d.ts

@@ -0,0 +1,27 @@
+import ResolveStrategy, { ResolveStrategyOptions } from '../ResolveStrategy.ts';
+import ReferenceSet from '../../../ReferenceSet.ts';
+import File from '../../../File.ts';
+import type { ReferenceOptions } from '../../../options/index.ts';
+export type { default as ResolveStrategy, ResolveStrategyOptions } from '../ResolveStrategy.ts';
+export type { default as ReferenceSet, ReferenceSetOptions } from '../../../ReferenceSet.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+export type { ReferenceOptions as ApiDOMReferenceOptions, ReferenceBundleOptions as ApiDOMReferenceBundleOptions, ReferenceDereferenceOptions as ApiDOMReferenceDereferenceOptions, ReferenceParseOptions as ApiDOMReferenceParseOptions, ReferenceResolveOptions as ApiDOMReferenceResolveOptions, } from '../../../options/index.ts';
+export type { default as Parser, ParserOptions } from '../../../parse/parsers/Parser.ts';
+export type { default as Resolver, ResolverOptions } from '../../resolvers/Resolver.ts';
+export type { default as DereferenceStrategy, DereferenceStrategyOptions, } from '../../../dereference/strategies/DereferenceStrategy.ts';
+export type { default as BundleStrategy, BundleStrategyOptions, } from '../../../bundle/strategies/BundleStrategy.ts';
+export type { default as Reference, ReferenceOptions } from '../../../Reference.ts';
+/**
+ * @public
+ */
+export interface AsyncAPI2ResolveStrategyOptions extends Omit<ResolveStrategyOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class AsyncAPI2ResolveStrategy extends ResolveStrategy {
+    constructor(options?: AsyncAPI2ResolveStrategyOptions);
+    canResolve(file: File, options: ReferenceOptions): boolean;
+    resolve(file: File, options: ReferenceOptions): Promise<ReferenceSet>;
+}
+export default AsyncAPI2ResolveStrategy;

package/types/resolve/strategies/openapi-2/index.d.ts

@@ -0,0 +1,27 @@
+import ResolveStrategy, { ResolveStrategyOptions } from '../ResolveStrategy.ts';
+import ReferenceSet from '../../../ReferenceSet.ts';
+import File from '../../../File.ts';
+import type { ReferenceOptions } from '../../../options/index.ts';
+export type { default as ResolveStrategy, ResolveStrategyOptions } from '../ResolveStrategy.ts';
+export type { default as ReferenceSet, ReferenceSetOptions } from '../../../ReferenceSet.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+export type { ReferenceOptions as ApiDOMReferenceOptions, ReferenceBundleOptions as ApiDOMReferenceBundleOptions, ReferenceDereferenceOptions as ApiDOMReferenceDereferenceOptions, ReferenceParseOptions as ApiDOMReferenceParseOptions, ReferenceResolveOptions as ApiDOMReferenceResolveOptions, } from '../../../options/index.ts';
+export type { default as Parser, ParserOptions } from '../../../parse/parsers/Parser.ts';
+export type { default as Resolver, ResolverOptions } from '../../resolvers/Resolver.ts';
+export type { default as DereferenceStrategy, DereferenceStrategyOptions, } from '../../../dereference/strategies/DereferenceStrategy.ts';
+export type { default as BundleStrategy, BundleStrategyOptions, } from '../../../bundle/strategies/BundleStrategy.ts';
+export type { default as Reference, ReferenceOptions } from '../../../Reference.ts';
+/**
+ * @public
+ */
+export interface OpenAPI2ResolveStrategyOptions extends Omit<ResolveStrategyOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class OpenAPI2ResolveStrategy extends ResolveStrategy {
+    constructor(options?: OpenAPI2ResolveStrategyOptions);
+    canResolve(file: File, options: ReferenceOptions): boolean;
+    resolve(file: File, options: ReferenceOptions): Promise<ReferenceSet>;
+}
+export default OpenAPI2ResolveStrategy;

package/types/resolve/strategies/openapi-3-0/index.d.ts

@@ -0,0 +1,27 @@
+import ResolveStrategy, { ResolveStrategyOptions } from '../ResolveStrategy.ts';
+import ReferenceSet from '../../../ReferenceSet.ts';
+import File from '../../../File.ts';
+import type { ReferenceOptions } from '../../../options/index.ts';
+export type { default as ResolveStrategy, ResolveStrategyOptions } from '../ResolveStrategy.ts';
+export type { default as ReferenceSet, ReferenceSetOptions } from '../../../ReferenceSet.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+export type { ReferenceOptions as ApiDOMReferenceOptions, ReferenceBundleOptions as ApiDOMReferenceBundleOptions, ReferenceDereferenceOptions as ApiDOMReferenceDereferenceOptions, ReferenceParseOptions as ApiDOMReferenceParseOptions, ReferenceResolveOptions as ApiDOMReferenceResolveOptions, } from '../../../options/index.ts';
+export type { default as Parser, ParserOptions } from '../../../parse/parsers/Parser.ts';
+export type { default as Resolver, ResolverOptions } from '../../resolvers/Resolver.ts';
+export type { default as DereferenceStrategy, DereferenceStrategyOptions, } from '../../../dereference/strategies/DereferenceStrategy.ts';
+export type { default as BundleStrategy, BundleStrategyOptions, } from '../../../bundle/strategies/BundleStrategy.ts';
+export type { default as Reference, ReferenceOptions } from '../../../Reference.ts';
+/**
+ * @public
+ */
+export interface OpenAPI3_0ResolveStrategyOptions extends Omit<ResolveStrategyOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class OpenAPI3_0ResolveStrategy extends ResolveStrategy {
+    constructor(options?: OpenAPI3_0ResolveStrategyOptions);
+    canResolve(file: File, options: ReferenceOptions): boolean;
+    resolve(file: File, options: ReferenceOptions): Promise<ReferenceSet>;
+}
+export default OpenAPI3_0ResolveStrategy;

package/types/resolve/strategies/openapi-3-1/index.d.ts

@@ -0,0 +1,27 @@
+import ResolveStrategy, { ResolveStrategyOptions } from '../ResolveStrategy.ts';
+import ReferenceSet from '../../../ReferenceSet.ts';
+import File from '../../../File.ts';
+import type { ReferenceOptions } from '../../../options/index.ts';
+export type { default as ResolveStrategy, ResolveStrategyOptions } from '../ResolveStrategy.ts';
+export type { default as ReferenceSet, ReferenceSetOptions } from '../../../ReferenceSet.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+export type { ReferenceOptions as ApiDOMReferenceOptions, ReferenceBundleOptions as ApiDOMReferenceBundleOptions, ReferenceDereferenceOptions as ApiDOMReferenceDereferenceOptions, ReferenceParseOptions as ApiDOMReferenceParseOptions, ReferenceResolveOptions as ApiDOMReferenceResolveOptions, } from '../../../options/index.ts';
+export type { default as Parser, ParserOptions } from '../../../parse/parsers/Parser.ts';
+export type { default as Resolver, ResolverOptions } from '../../resolvers/Resolver.ts';
+export type { default as DereferenceStrategy, DereferenceStrategyOptions, } from '../../../dereference/strategies/DereferenceStrategy.ts';
+export type { default as BundleStrategy, BundleStrategyOptions, } from '../../../bundle/strategies/BundleStrategy.ts';
+export type { default as Reference, ReferenceOptions } from '../../../Reference.ts';
+/**
+ * @public
+ */
+export interface OpenAPI3_1ResolveStrategyOptions extends Omit<ResolveStrategyOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class OpenAPI3_1ResolveStrategy extends ResolveStrategy {
+    constructor(options?: OpenAPI3_1ResolveStrategyOptions);
+    canResolve(file: File, options: ReferenceOptions): boolean;
+    resolve(file: File, options: ReferenceOptions): Promise<ReferenceSet>;
+}
+export default OpenAPI3_1ResolveStrategy;

package/types/resolve/util.d.ts

@@ -0,0 +1,6 @@
+import File from '../File.ts';
+import type { ReferenceOptions } from '../options/index.ts';
+/**
+ * Reads the given file, using the configured resolver plugins.
+ */
+export declare const readFile: (file: File, options: ReferenceOptions) => Promise<Buffer>;

package/types/util/plugins.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Filters the given plugins, returning only the ones return `true` for the given method.
+ */
+export declare const filter: (method: string, parameters: any[], plugins: Array<any>) => Promise<Array<any>>;
+/**
+ * Runs the specified method of the given plugins, in order,
+ * until one of them returns a successful result.
+ * Each method can return a synchronous value or a Promise.
+ * If the promise resolves successfully then the result
+ * is immediately returned and no further plugins are called.
+ * If the promise rejects then the next plugin is called.
+ * If ALL plugins fail, then the last error is thrown.
+ */
+export declare const run: (method: string, parameters: any[], plugins: any[]) => Promise<any>;

package/types/util/url.d.ts

@@ -0,0 +1,106 @@
+/**
+ * SPDX-FileCopyrightText: Copyright (c) 2015 James Messinger
+ *
+ * SPDX-License-Identifier: MIT
+ */
+/**
+ * @public
+ */
+export type WindowsPredicate = () => boolean;
+/**
+ * Returns the protocol of the given URL, or `undefined` if it has no protocol.
+ * @public
+ */
+export declare const getProtocol: (url: string) => string | undefined;
+/**
+ * Returns true if given URL has protocol.
+ * @public
+ */
+export declare const hasProtocol: (url: string) => boolean;
+/**
+ * Returns the lower-cased file extension of the given URL,
+ * or an empty string if it has no extension.
+ * @public
+ */
+export declare const getExtension: (url: string) => string;
+/**
+ * Determines whether the given path is a filesystem path.
+ * This includes "file://" URLs.
+ * @public
+ */
+export declare const isFileSystemPath: (uri: string) => boolean;
+/**
+ * Determines whether the given URI is an HTTP(S) URL.
+ * @public
+ */
+export declare const isHttpUrl: (url: string) => boolean;
+/**
+ * Determines whether the given URI
+ * @public
+ */
+export declare const isURI: (uri: string) => boolean;
+/**
+ * @public
+ */
+export interface ToFileSystemPathOptions {
+    keepFileProtocol?: boolean;
+    isWindows?: WindowsPredicate;
+}
+/**
+ * Converts a URL to a local filesystem path.
+ * @public
+ */
+export declare const toFileSystemPath: (uri: string, options?: ToFileSystemPathOptions) => string;
+/**
+ * Converts a filesystem path to a properly-encoded URL.
+ *
+ * This is intended to handle situations where resolver is called
+ * with a filesystem path that contains characters which are not allowed in URLs.
+ *
+ * @example
+ * The following filesystem paths would be converted to the following URLs:
+ *```
+ *    <"!@#$%^&*+=?'>.json              ==>   %3C%22!@%23$%25%5E&*+=%3F\'%3E.json
+ *    C:\\My Documents\\File (1).json   ==>   C:/My%20Documents/File%20(1).json
+ *    file://Project #42/file.json      ==>   file://Project%20%2342/file.json
+ * ```
+ * @public
+ */
+export declare const fromFileSystemPath: (uri: string) => string;
+/**
+ * Returns the hash (URL fragment), of the given path.
+ * If there is no hash, then the root hash ("#") is returned.
+ * @public
+ */
+export declare const getHash: (uri: string) => string;
+/**
+ * Removes the hash (URL fragment), if any, from the given path.
+ * @public
+ */
+export declare const stripHash: (uri: string) => string;
+/**
+ * Returns the current working directory (in Node) or the current page URL (in browsers).
+ * @public
+ */
+export declare const cwd: () => string;
+/**
+ * Resolves a target URI relative to a base URI in a manner similar to that of a Web browser resolving an anchor tag HREF.
+ * @public
+ */
+export declare const resolve: (from: string, to: string) => string;
+/**
+ * Sanitizes/Encodes URI to it's url encoded form.
+ *
+ * The functional will compensate with the usecase when
+ * already sanitized URI is passed to it,
+ * by first unsatizing it and then performing sanitization again.
+ * @public
+ */
+export declare const sanitize: (uri: string) => string;
+/**
+ * Unsanitizes/Decodes URI to it's url encoded form.
+ * This function already assumes that hash part of the URI
+ * has been removed prior to transforming it to it's sanitized form.
+ * @public
+ */
+export declare const unsanitize: (uri: string) => string;