@speclynx/apidom-reference 4.2.0 → 4.3.1

package/types/dereference/strategies/overlay-1/index.d.ts

@@ -0,0 +1,28 @@
+import { Element } from '@speclynx/apidom-datamodel';
+import DereferenceStrategy, { DereferenceStrategyOptions } from '../DereferenceStrategy.ts';
+import File from '../../../File.ts';
+import type { ReferenceOptions } from '../../../options/index.ts';
+export type { default as DereferenceStrategy, DereferenceStrategyOptions, } from '../DereferenceStrategy.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+export type { default as Reference, ReferenceOptions } from '../../../Reference.ts';
+export type { default as ReferenceSet, ReferenceSetOptions } from '../../../ReferenceSet.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 '../../../resolve/resolvers/Resolver.ts';
+export type { default as ResolveStrategy, ResolveStrategyOptions, } from '../../../resolve/strategies/ResolveStrategy.ts';
+export type { default as BundleStrategy, BundleStrategyOptions, } from '../../../bundle/strategies/BundleStrategy.ts';
+/**
+ * @public
+ */
+export interface Overlay1DereferenceStrategyOptions extends Omit<DereferenceStrategyOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class Overlay1DereferenceStrategy extends DereferenceStrategy {
+    constructor(options?: Overlay1DereferenceStrategyOptions);
+    canDereference(file: File): boolean;
+    dereference(file: File, options: ReferenceOptions): Promise<Element>;
+}
+export { dereferenceExtends } from './extends.ts';
+export default Overlay1DereferenceStrategy;

package/types/parse/parsers/overlay-json-1/extends.d.ts

@@ -0,0 +1,16 @@
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
+import type { ReferenceOptions } from '../../../options/index.ts';
+/**
+ * Parses the `extends` target document from an Overlay document's ParseResult.
+ *
+ * The parsed extends document is pushed directly into the overlay's ParseResult
+ * and always attached to the extends element's meta as 'parseResult',
+ * regardless of success or failure.
+ *
+ * @param parseResult - ParseResult containing an Overlay specification
+ * @param parseResultRetrievalURI - URI from which the parseResult was retrieved
+ * @param options - Full ReferenceOptions
+ *
+ * @public
+ */
+export declare function parseExtends(parseResult: ParseResultElement, parseResultRetrievalURI: string, options: ReferenceOptions): Promise<void>;

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

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

package/types/parse/parsers/overlay-yaml-1/extends.d.ts

@@ -0,0 +1 @@
+export { parseExtends } from '../overlay-json-1/extends.ts';

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

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

package/types/resolve/strategies/arazzo-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 Arazzo1ResolveStrategyOptions extends Omit<ResolveStrategyOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class Arazzo1ResolveStrategy extends ResolveStrategy {
+    constructor(options?: Arazzo1ResolveStrategyOptions);
+    canResolve(file: File, options: ReferenceOptions): boolean;
+    resolve(file: File, options: ReferenceOptions): Promise<ReferenceSet>;
+}
+export default Arazzo1ResolveStrategy;

package/types/resolve/strategies/overlay-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 Overlay1ResolveStrategyOptions extends Omit<ResolveStrategyOptions, 'name'> {
+}
+/**
+ * @public
+ */
+declare class Overlay1ResolveStrategy extends ResolveStrategy {
+    constructor(options?: Overlay1ResolveStrategyOptions);
+    canResolve(file: File, options: ReferenceOptions): boolean;
+    resolve(file: File, options: ReferenceOptions): Promise<ReferenceSet>;
+}
+export default Overlay1ResolveStrategy;