@speclynx/apidom-reference 2.6.0 → 2.7.0

package/src/resolve/strategies/openapi-3-0/index.cjs

@@ -31,7 +31,7 @@ class OpenAPI3_0ResolveStrategy extends _ResolveStrategy.default {
   async resolve(file, options) {
     const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-3-0');
     if (dereferenceStrategy === undefined) {
-      throw new _UnmatchedDereferenceStrategyError.default('"openapi-3-0" dereference strategy is not available.');
+      throw new _UnmatchedDereferenceStrategyError.default(`"openapi-3-0" resolve strategy requires "openapi-3-0" dereference strategy to be configured for file "${file.uri}"`);
     }
     const refSet = new _ReferenceSet.default();
     const mergedOptions = (0, _util.merge)(options, {

package/src/resolve/strategies/openapi-3-0/index.mjs

@@ -25,7 +25,7 @@ class OpenAPI3_0ResolveStrategy extends ResolveStrategy {
   async resolve(file, options) {
     const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-3-0');
     if (dereferenceStrategy === undefined) {
-      throw new UnmatchedDereferenceStrategyError('"openapi-3-0" dereference strategy is not available.');
+      throw new UnmatchedDereferenceStrategyError(`"openapi-3-0" resolve strategy requires "openapi-3-0" dereference strategy to be configured for file "${file.uri}"`);
     }
     const refSet = new ReferenceSet();
     const mergedOptions = mergeOptions(options, {

package/src/resolve/strategies/openapi-3-1/index.cjs

@@ -31,7 +31,7 @@ class OpenAPI3_1ResolveStrategy extends _ResolveStrategy.default {
   async resolve(file, options) {
     const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-3-1');
     if (dereferenceStrategy === undefined) {
-      throw new _UnmatchedDereferenceStrategyError.default('"openapi-3-1" dereference strategy is not available.');
+      throw new _UnmatchedDereferenceStrategyError.default(`"openapi-3-1" resolve strategy requires "openapi-3-1" dereference strategy to be configured for file "${file.uri}"`);
     }
     const refSet = new _ReferenceSet.default();
     const mergedOptions = (0, _util.merge)(options, {

package/src/resolve/strategies/openapi-3-1/index.mjs

@@ -25,7 +25,7 @@ class OpenAPI3_1ResolveStrategy extends ResolveStrategy {
   async resolve(file, options) {
     const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-3-1');
     if (dereferenceStrategy === undefined) {
-      throw new UnmatchedDereferenceStrategyError('"openapi-3-1" dereference strategy is not available.');
+      throw new UnmatchedDereferenceStrategyError(`"openapi-3-1" resolve strategy requires "openapi-3-1" dereference strategy to be configured for file "${file.uri}"`);
     }
     const refSet = new ReferenceSet();
     const mergedOptions = mergeOptions(options, {

package/src/resolve/util.cjs

@@ -21,7 +21,7 @@ const readFile = async (file, options) => {
 
   // we couldn't find any resolver for this File
   if ((0, _ramda.isEmpty)(resolvers)) {
-    throw new _UnmatchedResolverError.default(file.uri);
+    throw new _UnmatchedResolverError.default(`Could not find a resolver that can read the file "${file.uri}"`);
   }
   try {
     const {

package/src/resolve/util.mjs

@@ -15,7 +15,7 @@ export const readFile = async (file, options) => {
 
   // we couldn't find any resolver for this File
   if (isEmpty(resolvers)) {
-    throw new UnmatchedResolverError(file.uri);
+    throw new UnmatchedResolverError(`Could not find a resolver that can read the file "${file.uri}"`);
   }
   try {
     const {

package/types/apidom-reference.d.ts

@@ -533,6 +533,12 @@ export declare class UnmatchedBundleStrategyError extends BundleError {
 export declare class UnmatchedDereferenceStrategyError extends DereferenceError {
 }
 
+/**
+ * @public
+ */
+export declare class UnmatchedParserError extends ParserError {
+}
+
 /**
  * @public
  */

package/types/dereference/strategies/arazzo-1/source-description.d.ts

@@ -0,0 +1,8 @@
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
+import Reference from '../../../Reference.ts';
+import type { ReferenceOptions } from '../../../options/index.ts';
+/**
+ * Dereferences source descriptions from an Arazzo document.
+ * @public
+ */
+export declare function dereferenceSourceDescriptions(parseResult: ParseResultElement, reference: Reference, options: ReferenceOptions): Promise<ParseResultElement[]>;

package/types/errors/UnmatchedParserError.d.ts

@@ -0,0 +1,7 @@
+import ParserError from './ParserError.ts';
+/**
+ * @public
+ */
+declare class UnmatchedParserError extends ParserError {
+}
+export default UnmatchedParserError;

package/types/index.d.ts

@@ -45,6 +45,7 @@ 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';
+export { default as UnmatchedParserError } from './errors/UnmatchedParserError.ts';
 /**
  * @public
  */

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

@@ -2,21 +2,18 @@ import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 import type { ReferenceOptions } from '../../../options/index.ts';
-import type ParseFn from '../../index.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'> {
-    readonly parseFn?: typeof ParseFn;
 }
 /**
  * @public
  */
 declare class ArazzoJSON1Parser extends Parser {
     refractorOpts: object;
-    parseFn?: typeof ParseFn;
     constructor(options?: ArazzoJSON1ParserOptions);
     canParse(file: File): Promise<boolean>;
     parse(file: File, options?: ReferenceOptions): Promise<ParseResultElement>;

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

@@ -1,13 +1,8 @@
 import { Element, ParseResultElement } from '@speclynx/apidom-datamodel';
 import File from '../../../File.ts';
 import type { ReferenceOptions } from '../../../options/index.ts';
-import type ParseFn from '../../index.ts';
 /**
  * Shared function for parsing source descriptions.
- * Call with `.call(this, ...)` where `this` has `name` and `parseFn` properties.
  * @public
  */
-export declare function parseSourceDescriptions(this: {
-    name: string;
-    parseFn?: typeof ParseFn;
-}, api: Element | undefined, file: File, options: ReferenceOptions): Promise<ParseResultElement[]>;
+export declare function parseSourceDescriptions(parserName: string, api: Element | undefined, file: File, options: ReferenceOptions): Promise<ParseResultElement[]>;

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

@@ -2,21 +2,18 @@ import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 import type { ReferenceOptions } from '../../../options/index.ts';
-import type ParseFn from '../../index.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'> {
-    readonly parseFn?: typeof ParseFn;
 }
 /**
  * @public
  */
 declare class ArazzoYAML1Parser extends Parser {
     refractorOpts: object;
-    parseFn?: typeof ParseFn;
     constructor(options?: ArazzoYAML1ParserOptions);
     canParse(file: File): Promise<boolean>;
     parse(file: File, options?: ReferenceOptions): Promise<ParseResultElement>;