@speclynx/apidom-reference 1.12.1

package/types/index.d.ts

@@ -0,0 +1,75 @@
+import { ParseResultElement, Element } from '@speclynx/apidom-core';
+import File from './File.ts';
+import ReferenceSet from './ReferenceSet.ts';
+import * as url from './util/url.ts';
+export { url };
+export { default as Parser } from './parse/parsers/Parser.ts';
+export type { ParserOptions } from './parse/parsers/Parser.ts';
+export { default as Resolver } from './resolve/resolvers/Resolver.ts';
+export { default as HTTPResolver } from './resolve/resolvers/HTTPResolver.ts';
+export type { HTTPResolverOptions } from './resolve/resolvers/HTTPResolver.ts';
+export { default as ResolveStrategy } from './resolve/strategies/ResolveStrategy.ts';
+export type { ResolverOptions } from './resolve/resolvers/Resolver.ts';
+export type { ResolveStrategyOptions } from './resolve/strategies/ResolveStrategy.ts';
+export { default as DereferenceStrategy } from './dereference/strategies/DereferenceStrategy.ts';
+export type { DereferenceStrategyOptions } from './dereference/strategies/DereferenceStrategy.ts';
+export { AncestorLineage as DereferenceAncestorLineage } from './dereference/util.ts';
+export { default as BundleStrategy } from './bundle/strategies/BundleStrategy.ts';
+export type { BundleStrategyOptions } from './bundle/strategies/BundleStrategy.ts';
+export { default as options } from './options/index.ts';
+export { merge as mergeOptions } from './options/util.ts';
+export type { ReferenceOptions as ApiDOMReferenceOptions, ReferenceBundleOptions as ApiDOMReferenceBundleOptions, ReferenceDereferenceOptions as ApiDOMReferenceDereferenceOptions, ReferenceParseOptions as ApiDOMReferenceParseOptions, ReferenceResolveOptions as ApiDOMReferenceResolveOptions, } from './options/index.ts';
+export { File };
+export { default as Reference } from './Reference.ts';
+export { ReferenceSet };
+export type { FileOptions } from './File.ts';
+export type { ReferenceOptions } from './Reference.ts';
+export type { ReferenceSetOptions } from './ReferenceSet.ts';
+export { default as BundleError } from './errors/BundleError.ts';
+export { default as MaximumBundleDepthError } from './errors/MaximumBundleDepthError.ts';
+export { default as UnmatchedBundleStrategyError } from './errors/UnmatchedBundleStrategyError.ts';
+export { default as DereferenceError } from './errors/DereferenceError.ts';
+export { default as EvaluationElementIdError } from './errors/EvaluationElementIdError.ts';
+export { default as EvaluationJsonSchema$anchorError } from './errors/EvaluationJsonSchema$anchorError.ts';
+export { default as EvaluationJsonSchemaUriError } from './errors/EvaluationJsonSchemaUriError.ts';
+export { default as InvalidJsonSchema$anchorError } from './errors/InvalidJsonSchema$anchorError.ts';
+export { default as JsonSchema$anchorError } from './errors/JsonSchema$anchorError.ts';
+export { default as JsonSchemaURIError } from './errors/JsonSchemaUriError.ts';
+export { default as MaximumDereferenceDepthError } from './errors/MaximumDereferenceDepthError.ts';
+export { default as MaximumResolveDepthError } from './errors/MaximumResolveDepthError.ts';
+export { default as ParseError } from './errors/ParseError.ts';
+export { default as ParserError } from './errors/ParserError.ts';
+export { default as PluginError } from './errors/PluginError.ts';
+export { default as ResolveError } from './errors/ResolveError.ts';
+export { default as ResolverError } from './errors/ResolverError.ts';
+export { default as UnmatchedDereferenceStrategyError } from './errors/UnmatchedDereferenceStrategyError.ts';
+export { default as UnmatchedResolveStrategyError } from './errors/UnmatchedResolveStrategyError.ts';
+export { default as UnmatchedResolverError } from './errors/UnmatchedResolverError.ts';
+/**
+ * @public
+ */
+export declare const readFile: (uri: string, options?: {}) => Promise<Buffer>;
+/**
+ * @public
+ */
+export declare const parse: (uri: string, options?: {}) => Promise<ParseResultElement>;
+/**
+ * @public
+ */
+export declare const resolve: (uri: string, options?: {}) => Promise<ReferenceSet>;
+/**
+ * @public
+ */
+export declare const resolveApiDOM: <T extends Element>(element: T, options?: {}) => Promise<ReferenceSet>;
+/**
+ * @public
+ */
+export declare const dereference: (uri: string, options?: {}) => Promise<ParseResultElement>;
+/**
+ * @public
+ */
+export declare const dereferenceApiDOM: <T extends Element>(element: T, options?: {}) => Promise<T>;
+/**
+ * @public
+ */
+export declare const bundle: (uri: string, options?: {}) => Promise<ParseResultElement>;

package/types/options/index.d.ts

@@ -0,0 +1,62 @@
+import { RefElement } from 'minim';
+import type Parser from '../parse/parsers/Parser.ts';
+import type Resolver from '../resolve/resolvers/Resolver.ts';
+import type ResolveStrategy from '../resolve/strategies/ResolveStrategy.ts';
+import type DereferenceStrategy from '../dereference/strategies/DereferenceStrategy.ts';
+import type ReferenceSet from '../ReferenceSet.ts';
+import type BundleStrategy from '../bundle/strategies/BundleStrategy.ts';
+/**
+ * @public
+ */
+export interface ReferenceParseOptions {
+    mediaType: string;
+    parsers: Array<Parser>;
+    parserOpts: Record<string, any>;
+}
+/**
+ * @public
+ */
+export interface ReferenceResolveOptions {
+    baseURI: string;
+    resolvers: Array<Resolver>;
+    resolverOpts: Record<string, any>;
+    strategies: Array<ResolveStrategy>;
+    strategyOpts: Record<string, any>;
+    internal: boolean;
+    external: boolean;
+    maxDepth: number;
+}
+/**
+ * @public
+ */
+export interface ReferenceDereferenceOptions {
+    strategies: Array<DereferenceStrategy>;
+    strategyOpts: Record<string, any>;
+    refSet: null | ReferenceSet;
+    maxDepth: number;
+    circular: 'ignore' | 'replace' | 'error';
+    circularReplacer: (ref: RefElement) => unknown;
+    immutable: boolean;
+}
+/**
+ * @public
+ */
+export interface ReferenceBundleOptions {
+    strategies: Array<BundleStrategy>;
+    refSet: null | ReferenceSet;
+    maxDepth: number;
+}
+/**
+ * @public
+ */
+export interface ReferenceOptions {
+    readonly parse: ReferenceParseOptions;
+    readonly resolve: ReferenceResolveOptions;
+    readonly dereference: ReferenceDereferenceOptions;
+    readonly bundle: ReferenceBundleOptions;
+}
+/**
+ * @public
+ */
+declare const defaultOptions: ReferenceOptions;
+export default defaultOptions;

package/types/options/util.d.ts

@@ -0,0 +1,5 @@
+import type { ReferenceOptions } from './index.ts';
+/**
+ * @public
+ */
+export declare const merge: (lObj: ReferenceOptions, rObj: Record<string, any>) => ReferenceOptions;

package/types/parse/index.d.ts

@@ -0,0 +1,7 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import type { ReferenceOptions } from '../options/index.ts';
+/**
+ * Parses a file into ApiDOM.
+ */
+declare const parse: (uri: string, options: ReferenceOptions) => Promise<ParseResultElement>;
+export default parse;

package/types/parse/parsers/Parser.d.ts

@@ -0,0 +1,38 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import File from '../../File.ts';
+/**
+ * @public
+ */
+export interface ParserOptions {
+    readonly name: string;
+    readonly allowEmpty?: boolean;
+    readonly sourceMap?: boolean;
+    readonly fileExtensions?: string[];
+    readonly mediaTypes?: string[];
+}
+/**
+ * @public
+ */
+declare abstract class Parser {
+    readonly name: string;
+    /**
+     * Whether to allow "empty" files. This includes zero-byte files.
+     */
+    allowEmpty: boolean;
+    /**
+     * Whether to generate source map during parsing.
+     */
+    sourceMap: boolean;
+    /**
+     * List of supported file extensions.
+     */
+    fileExtensions: string[];
+    /**
+     * List of supported media types.
+     */
+    mediaTypes: string[];
+    constructor({ name, allowEmpty, sourceMap, fileExtensions, mediaTypes, }: ParserOptions);
+    abstract canParse(file: File): boolean | Promise<boolean>;
+    abstract parse(file: File): ParseResultElement | Promise<ParseResultElement>;
+}
+export default Parser;

package/types/parse/parsers/api-design-systems-json/index.d.ts

@@ -0,0 +1,21 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface APIDesignSystemsJSONParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class APIDesignSystemsJSONParser extends Parser {
+    syntacticAnalysis?: 'direct' | 'indirect';
+    refractorOpts: object;
+    constructor(options?: APIDesignSystemsJSONParserOptions);
+    canParse(file: File): Promise<boolean>;
+    parse(file: File): Promise<ParseResultElement>;
+}
+export default APIDesignSystemsJSONParser;

package/types/parse/parsers/api-design-systems-yaml/index.d.ts

@@ -0,0 +1,20 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface APIDesignSystemsYAMLParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class APIDesignSystemsYAMLParser extends Parser {
+    refractorOpts: object;
+    constructor(options?: APIDesignSystemsYAMLParserOptions);
+    canParse(file: File): Promise<boolean>;
+    parse(file: File): Promise<ParseResultElement>;
+}
+export default APIDesignSystemsYAMLParser;

package/types/parse/parsers/apidom-json/index.d.ts

@@ -0,0 +1,24 @@
+import { Namespace, ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface ApiDOMJSONParserOptions extends Omit<ParserOptions, 'name'> {
+    readonly namespace?: Namespace;
+}
+/**
+ * @public
+ */
+declare class ApiDOMJSONParser extends Parser {
+    namespace: Namespace;
+    ['apidom-json']: {
+        namespace?: Namespace;
+    };
+    constructor(options?: ApiDOMJSONParserOptions);
+    canParse(file: File): boolean;
+    parse(file: File): ParseResultElement;
+}
+export default ApiDOMJSONParser;

package/types/parse/parsers/arazzo-json-1/index.d.ts

@@ -0,0 +1,21 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface ArazzoJSON1ParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class ArazzoJSON1Parser extends Parser {
+    syntacticAnalysis?: 'direct' | 'indirect';
+    refractorOpts: object;
+    constructor(options?: ArazzoJSON1ParserOptions);
+    canParse(file: File): Promise<boolean>;
+    parse(file: File): Promise<ParseResultElement>;
+}
+export default ArazzoJSON1Parser;

package/types/parse/parsers/arazzo-yaml-1/index.d.ts

@@ -0,0 +1,20 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface ArazzoYAML1ParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class ArazzoYAML1Parser extends Parser {
+    refractorOpts: object;
+    constructor(options?: ArazzoYAML1ParserOptions);
+    canParse(file: File): Promise<boolean>;
+    parse(file: File): Promise<ParseResultElement>;
+}
+export default ArazzoYAML1Parser;

package/types/parse/parsers/asyncapi-json-2/index.d.ts

@@ -0,0 +1,21 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface AsyncAPIJSON2ParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class AsyncAPIJSON2Parser extends Parser {
+    syntacticAnalysis?: 'direct' | 'indirect';
+    refractorOpts: object;
+    constructor(options?: AsyncAPIJSON2ParserOptions);
+    canParse(file: File): Promise<boolean>;
+    parse(file: File): Promise<ParseResultElement>;
+}
+export default AsyncAPIJSON2Parser;

package/types/parse/parsers/asyncapi-yaml-2/index.d.ts

@@ -0,0 +1,20 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface AsyncAPIYAML2ParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class AsyncAPIYAML2Parser extends Parser {
+    refractorOpts: object;
+    constructor(options?: AsyncAPIYAML2ParserOptions);
+    canParse(file: File): Promise<boolean>;
+    parse(file: File): Promise<ParseResultElement>;
+}
+export default AsyncAPIYAML2Parser;

package/types/parse/parsers/binary/index-browser.d.ts

@@ -0,0 +1,21 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * Everything that is not recognized by other parsers will be considered by this parser
+ * as a binary data and will be encoded to Base64 format.
+ * @public
+ */
+export interface BinaryParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class BinaryParser extends Parser {
+    constructor(options?: BinaryParserOptions);
+    canParse(file: File): boolean;
+    parse(file: File): ParseResultElement;
+}
+export default BinaryParser;

package/types/parse/parsers/binary/index-node.d.ts

@@ -0,0 +1,21 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * Everything that is not recognized by other parsers will be considered by this parser
+ * as a binary data and will be encoded to Base64 format.
+ * @public
+ */
+export interface BinaryParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class BinaryParser extends Parser {
+    constructor(options?: BinaryParserOptions);
+    canParse(file: File): boolean;
+    parse(file: File): ParseResultElement;
+}
+export default BinaryParser;

package/types/parse/parsers/json/index.d.ts

@@ -0,0 +1,20 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface JSONParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class JSONParser extends Parser {
+    syntacticAnalysis?: 'direct' | 'indirect';
+    constructor(options?: JSONParserOptions);
+    canParse(file: File): Promise<boolean>;
+    parse(file: File): Promise<ParseResultElement>;
+}
+export default JSONParser;

package/types/parse/parsers/openapi-json-2/index.d.ts

@@ -0,0 +1,21 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface OpenAPIJSON2ParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class OpenAPIJSON2Parser extends Parser {
+    syntacticAnalysis?: 'direct' | 'indirect';
+    refractorOpts: object;
+    constructor(options?: OpenAPIJSON2ParserOptions);
+    canParse(file: File): Promise<boolean>;
+    parse(file: File): Promise<ParseResultElement>;
+}
+export default OpenAPIJSON2Parser;

package/types/parse/parsers/openapi-json-3-0/index.d.ts

@@ -0,0 +1,21 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface OpenAPIJSON3_0ParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class OpenAPIJSON3_0Parser extends Parser {
+    syntacticAnalysis?: 'direct' | 'indirect';
+    refractorOpts: object;
+    constructor(options?: OpenAPIJSON3_0ParserOptions);
+    canParse(file: File): Promise<boolean>;
+    parse(file: File): Promise<ParseResultElement>;
+}
+export default OpenAPIJSON3_0Parser;

package/types/parse/parsers/openapi-json-3-1/index.d.ts

@@ -0,0 +1,21 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface OpenAPIJSON3_1ParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class OpenAPIJSON3_1Parser extends Parser {
+    syntacticAnalysis?: 'direct' | 'indirect';
+    refractorOpts: object;
+    constructor(options?: OpenAPIJSON3_1ParserOptions);
+    canParse(file: File): Promise<boolean>;
+    parse(file: File): Promise<ParseResultElement>;
+}
+export default OpenAPIJSON3_1Parser;

package/types/parse/parsers/openapi-yaml-2/index.d.ts

@@ -0,0 +1,20 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface OpenAPIYAML2ParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class OpenAPIYAML2Parser extends Parser {
+    refractorOpts: object;
+    constructor(options?: OpenAPIYAML2ParserOptions);
+    canParse(file: File): Promise<boolean>;
+    parse(file: File): Promise<ParseResultElement>;
+}
+export default OpenAPIYAML2Parser;

package/types/parse/parsers/openapi-yaml-3-0/index.d.ts

@@ -0,0 +1,20 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface OpenAPIYAML3_0ParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class OpenAPIYAML3_0Parser extends Parser {
+    refractorOpts: object;
+    constructor(options?: OpenAPIYAML3_0ParserOptions);
+    canParse(file: File): Promise<boolean>;
+    parse(file: File): Promise<ParseResultElement>;
+}
+export default OpenAPIYAML3_0Parser;

package/types/parse/parsers/openapi-yaml-3-1/index.d.ts

@@ -0,0 +1,20 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface OpenAPIYAML3_1ParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class OpenAPIYAML3_1Parser extends Parser {
+    refractorOpts: object;
+    constructor(options?: OpenAPIYAML3_1ParserOptions);
+    canParse(file: File): Promise<boolean>;
+    parse(file: File): Promise<ParseResultElement>;
+}
+export default OpenAPIYAML3_1Parser;

package/types/parse/parsers/yaml-1-2/index.d.ts

@@ -0,0 +1,20 @@
+import { ParseResultElement } from '@speclynx/apidom-core';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface YAMLParserOptions extends Omit<ParserOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class YAML1Parser extends Parser {
+    refractorOpts: object;
+    constructor(options?: YAMLParserOptions);
+    canParse(file: File): Promise<boolean>;
+    parse(file: File): Promise<ParseResultElement>;
+}
+export default YAML1Parser;

package/types/resolve/index.d.ts

@@ -0,0 +1,12 @@
+import { Element } from '@speclynx/apidom-core';
+import ReferenceSet from '../ReferenceSet.ts';
+import type { ReferenceOptions } from '../options/index.ts';
+/**
+ * Resolves ApiDOM with all its external references.
+ */
+export declare const resolveApiDOM: <T extends Element>(element: T, options: ReferenceOptions) => Promise<ReferenceSet>;
+/**
+ * Resolves a file with all its external references.
+ */
+declare const resolve: (uri: string, options: ReferenceOptions) => Promise<ReferenceSet>;
+export default resolve;

package/types/resolve/resolvers/HTTPResolver.d.ts

@@ -0,0 +1,22 @@
+import Resolver, { ResolverOptions } from './Resolver.ts';
+import File from '../../File.ts';
+/**
+ * @public
+ */
+export interface HTTPResolverOptions extends ResolverOptions {
+    readonly timeout?: number;
+    readonly redirects?: number;
+    readonly withCredentials?: boolean;
+}
+/**
+ * @public
+ */
+declare abstract class HTTPResolver extends Resolver {
+    protected readonly timeout: number;
+    protected readonly redirects: number;
+    protected readonly withCredentials: boolean;
+    constructor(options?: HTTPResolverOptions);
+    canRead(file: File): boolean;
+    abstract getHttpClient(): unknown;
+}
+export default HTTPResolver;

package/types/resolve/resolvers/Resolver.d.ts

@@ -0,0 +1,17 @@
+import File from '../../File.ts';
+/**
+ * @public
+ */
+export interface ResolverOptions {
+    readonly name: string;
+}
+/**
+ * @public
+ */
+declare abstract class Resolver {
+    readonly name: string;
+    constructor({ name }: ResolverOptions);
+    abstract canRead(file: File): boolean;
+    abstract read(file: File): Promise<Buffer>;
+}
+export default Resolver;

package/types/resolve/resolvers/file/index-browser.d.ts

@@ -0,0 +1,12 @@
+import Resolver from '../Resolver.ts';
+export type { default as Resolver, ResolverOptions } from '../Resolver.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+declare class FileResolver extends Resolver {
+    constructor();
+    canRead(): boolean;
+    read(): Promise<Buffer>;
+}
+export default FileResolver;

package/types/resolve/resolvers/file/index-node.d.ts

@@ -0,0 +1,20 @@
+import File from '../../../File.ts';
+import Resolver, { ResolverOptions } from '../Resolver.ts';
+export type { default as Resolver, ResolverOptions } from '../Resolver.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+/**
+ * @public
+ */
+export interface FileResolverOptions extends Omit<ResolverOptions, 'name'> {
+    readonly fileAllowList?: string[] | RegExp[];
+}
+/**
+ * @public
+ */
+declare class FileResolver extends Resolver {
+    fileAllowList: string[] | RegExp[];
+    constructor(options?: FileResolverOptions);
+    canRead(file: File): boolean;
+    read(file: File): Promise<Buffer>;
+}
+export default FileResolver;