@speclynx/apidom-reference 2.6.1 → 2.7.0

package/src/parse/parsers/arazzo-json-1/source-description.cjs

@@ -1,5 +1,6 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
 exports.__esModule = true;
 exports.parseSourceDescriptions = parseSourceDescriptions;
@@ -11,6 +12,7 @@ var _apidomNsOpenapi3 = require("@speclynx/apidom-ns-openapi-3-1");
 var _apidomCore = require("@speclynx/apidom-core");
 var url = _interopRequireWildcard(require("../../../util/url.cjs"));
 var _util = require("../../../options/util.cjs");
+var _index = _interopRequireDefault(require("../../index.cjs"));
 // shared key for recursion state (works across JSON/YAML parsers)
 const ARAZZO_RECURSION_KEY = 'arazzo-1';
 /**
@@ -20,7 +22,7 @@ const ARAZZO_RECURSION_KEY = 'arazzo-1';
 async function parseSourceDescription(sourceDescription, ctx) {
   const parseResult = new _apidomDatamodel.ParseResultElement();
   if (!(0, _apidomNsArazzo.isSourceDescriptionElement)(sourceDescription)) {
-    const annotation = new _apidomDatamodel.AnnotationElement('Element is not a valid SourceDescriptionElement. Skipping.');
+    const annotation = new _apidomDatamodel.AnnotationElement('Element is not a valid SourceDescriptionElement. Skipping');
     annotation.classes.push('warning');
     parseResult.push(annotation);
     return parseResult;
@@ -32,7 +34,7 @@ async function parseSourceDescription(sourceDescription, ctx) {
   if ((0, _apidomDatamodel.isStringElement)(sourceDescription.type)) parseResult.setMetaProperty('type', (0, _apidomDatamodel.cloneDeep)(sourceDescription.type));
   const sourceDescriptionURI = (0, _apidomCore.toValue)(sourceDescription.url);
   if (typeof sourceDescriptionURI !== 'string') {
-    const annotation = new _apidomDatamodel.AnnotationElement('Source description URL is missing or not a string. Skipping.');
+    const annotation = new _apidomDatamodel.AnnotationElement('Source description URL is missing or not a string. Skipping');
     annotation.classes.push('warning');
     parseResult.push(annotation);
     return parseResult;
@@ -41,14 +43,14 @@ async function parseSourceDescription(sourceDescription, ctx) {
 
   // skip if already visited (cycle detection)
   if (ctx.visitedUrls.has(retrievalURI)) {
-    const annotation = new _apidomDatamodel.AnnotationElement(`Source description "${retrievalURI}" has already been visited. Skipping to prevent cycle.`);
+    const annotation = new _apidomDatamodel.AnnotationElement(`Source description "${retrievalURI}" has already been visited. Skipping to prevent cycle`);
     annotation.classes.push('warning');
     parseResult.push(annotation);
     return parseResult;
   }
   ctx.visitedUrls.add(retrievalURI);
   try {
-    const sdParseResult = await ctx.parseFn(retrievalURI, (0, _util.merge)(ctx.options, {
+    const sdParseResult = await (0, _index.default)(retrievalURI, (0, _util.merge)(ctx.options, {
       parse: {
         mediaType: 'text/plain',
         // allow parser plugin detection
@@ -80,7 +82,7 @@ async function parseSourceDescription(sourceDescription, ctx) {
   const isOpenApi = (0, _apidomNsOpenapi.isSwaggerElement)(sourceDescriptionAPI) || (0, _apidomNsOpenapi2.isOpenApi3_0Element)(sourceDescriptionAPI) || (0, _apidomNsOpenapi3.isOpenApi3_1Element)(sourceDescriptionAPI);
   const isArazzo = (0, _apidomNsArazzo.isArazzoSpecification1Element)(sourceDescriptionAPI);
   if (!isOpenApi && !isArazzo) {
-    const annotation = new _apidomDatamodel.AnnotationElement(`Source description "${retrievalURI}" is not an OpenAPI or Arazzo document. Skipping.`);
+    const annotation = new _apidomDatamodel.AnnotationElement(`Source description "${retrievalURI}" is not an OpenAPI or Arazzo document`);
     annotation.classes.push('warning');
     parseResult.push(annotation);
     return parseResult;
@@ -90,11 +92,11 @@ async function parseSourceDescription(sourceDescription, ctx) {
   const declaredType = (0, _apidomCore.toValue)(sourceDescription.type);
   if (typeof declaredType === 'string') {
     if (declaredType === 'openapi' && !isOpenApi) {
-      const annotation = new _apidomDatamodel.AnnotationElement(`Source description "${retrievalURI}" declared as "openapi" but parsed as Arazzo document.`);
+      const annotation = new _apidomDatamodel.AnnotationElement(`Source description "${retrievalURI}" declared as "openapi" but parsed as Arazzo document`);
       annotation.classes.push('warning');
       parseResult.push(annotation);
     } else if (declaredType === 'arazzo' && !isArazzo) {
-      const annotation = new _apidomDatamodel.AnnotationElement(`Source description "${retrievalURI}" declared as "arazzo" but parsed as OpenAPI document.`);
+      const annotation = new _apidomDatamodel.AnnotationElement(`Source description "${retrievalURI}" declared as "arazzo" but parsed as OpenAPI document`);
       annotation.classes.push('warning');
       parseResult.push(annotation);
     }
@@ -104,10 +106,9 @@ async function parseSourceDescription(sourceDescription, ctx) {
 
 /**
  * Shared function for parsing source descriptions.
- * Call with `.call(this, ...)` where `this` has `name` and `parseFn` properties.
  * @public
  */
-async function parseSourceDescriptions(api, file, options) {
+async function parseSourceDescriptions(parserName, api, file, options) {
   const results = [];
 
   /**
@@ -115,23 +116,18 @@ async function parseSourceDescriptions(api, file, options) {
    * Return warning annotations if validation fails.
    */
   if (!(0, _apidomNsArazzo.isArazzoSpecification1Element)(api)) {
-    const annotation = new _apidomDatamodel.AnnotationElement('Cannot parse source descriptions: API is not an Arazzo specification.');
+    const annotation = new _apidomDatamodel.AnnotationElement('Cannot parse source descriptions: API is not an Arazzo specification');
     annotation.classes.push('warning');
     return [new _apidomDatamodel.ParseResultElement([annotation])];
   }
   if (!(0, _apidomDatamodel.isArrayElement)(api.sourceDescriptions)) {
-    const annotation = new _apidomDatamodel.AnnotationElement('Cannot parse source descriptions: sourceDescriptions field is missing or not an array.');
+    const annotation = new _apidomDatamodel.AnnotationElement('Cannot parse source descriptions: sourceDescriptions field is missing or not an array');
     annotation.classes.push('warning');
     return [new _apidomDatamodel.ParseResultElement([annotation])];
   }
-  if (typeof this.parseFn !== 'function') {
-    const annotation = new _apidomDatamodel.AnnotationElement('Source descriptions found but parseFn is not configured. Skipping source description parsing.');
-    annotation.classes.push('error');
-    return [new _apidomDatamodel.ParseResultElement([annotation])];
-  }
 
   // user config: parser-specific options take precedence over global parserOpts
-  const maxDepth = options?.parse?.parserOpts?.[this.name]?.sourceDescriptionsMaxDepth ?? options?.parse?.parserOpts?.sourceDescriptionsMaxDepth ?? +Infinity;
+  const maxDepth = options?.parse?.parserOpts?.[parserName]?.sourceDescriptionsMaxDepth ?? options?.parse?.parserOpts?.sourceDescriptionsMaxDepth ?? +Infinity;
 
   // recursion state comes from shared key (works across JSON/YAML)
   const sharedOpts = options?.parse?.parserOpts?.[ARAZZO_RECURSION_KEY] ?? {};
@@ -148,7 +144,6 @@ async function parseSourceDescriptions(api, file, options) {
     return [parseResult];
   }
   const ctx = {
-    parseFn: this.parseFn,
     baseURI: file.uri,
     options,
     currentDepth,
@@ -156,7 +151,7 @@ async function parseSourceDescriptions(api, file, options) {
   };
 
   // determine which source descriptions to parse
-  const sourceDescriptionsOption = options?.parse?.parserOpts?.[this.name]?.sourceDescriptions ?? options?.parse?.parserOpts?.sourceDescriptions;
+  const sourceDescriptionsOption = options?.parse?.parserOpts?.[parserName]?.sourceDescriptions ?? options?.parse?.parserOpts?.sourceDescriptions;
 
   // handle false or other falsy values - no source descriptions should be parsed
   if (!sourceDescriptionsOption) {

package/src/parse/parsers/arazzo-json-1/source-description.mjs

@@ -5,7 +5,8 @@ import { isOpenApi3_0Element } from '@speclynx/apidom-ns-openapi-3-0';
 import { isOpenApi3_1Element } from '@speclynx/apidom-ns-openapi-3-1';
 import { toValue } from '@speclynx/apidom-core';
 import * as url from "../../../util/url.mjs";
-import { merge as mergeOptions } from "../../../options/util.mjs"; // shared key for recursion state (works across JSON/YAML parsers)
+import { merge as mergeOptions } from "../../../options/util.mjs";
+import parse from "../../index.mjs"; // shared key for recursion state (works across JSON/YAML parsers)
 const ARAZZO_RECURSION_KEY = 'arazzo-1';
 /**
  * Parses a single source description element.
@@ -14,7 +15,7 @@ const ARAZZO_RECURSION_KEY = 'arazzo-1';
 async function parseSourceDescription(sourceDescription, ctx) {
   const parseResult = new ParseResultElement();
   if (!isSourceDescriptionElement(sourceDescription)) {
-    const annotation = new AnnotationElement('Element is not a valid SourceDescriptionElement. Skipping.');
+    const annotation = new AnnotationElement('Element is not a valid SourceDescriptionElement. Skipping');
     annotation.classes.push('warning');
     parseResult.push(annotation);
     return parseResult;
@@ -26,7 +27,7 @@ async function parseSourceDescription(sourceDescription, ctx) {
   if (isStringElement(sourceDescription.type)) parseResult.setMetaProperty('type', cloneDeep(sourceDescription.type));
   const sourceDescriptionURI = toValue(sourceDescription.url);
   if (typeof sourceDescriptionURI !== 'string') {
-    const annotation = new AnnotationElement('Source description URL is missing or not a string. Skipping.');
+    const annotation = new AnnotationElement('Source description URL is missing or not a string. Skipping');
     annotation.classes.push('warning');
     parseResult.push(annotation);
     return parseResult;
@@ -35,14 +36,14 @@ async function parseSourceDescription(sourceDescription, ctx) {
 
   // skip if already visited (cycle detection)
   if (ctx.visitedUrls.has(retrievalURI)) {
-    const annotation = new AnnotationElement(`Source description "${retrievalURI}" has already been visited. Skipping to prevent cycle.`);
+    const annotation = new AnnotationElement(`Source description "${retrievalURI}" has already been visited. Skipping to prevent cycle`);
     annotation.classes.push('warning');
     parseResult.push(annotation);
     return parseResult;
   }
   ctx.visitedUrls.add(retrievalURI);
   try {
-    const sdParseResult = await ctx.parseFn(retrievalURI, mergeOptions(ctx.options, {
+    const sdParseResult = await parse(retrievalURI, mergeOptions(ctx.options, {
       parse: {
         mediaType: 'text/plain',
         // allow parser plugin detection
@@ -74,7 +75,7 @@ async function parseSourceDescription(sourceDescription, ctx) {
   const isOpenApi = isSwaggerElement(sourceDescriptionAPI) || isOpenApi3_0Element(sourceDescriptionAPI) || isOpenApi3_1Element(sourceDescriptionAPI);
   const isArazzo = isArazzoSpecification1Element(sourceDescriptionAPI);
   if (!isOpenApi && !isArazzo) {
-    const annotation = new AnnotationElement(`Source description "${retrievalURI}" is not an OpenAPI or Arazzo document. Skipping.`);
+    const annotation = new AnnotationElement(`Source description "${retrievalURI}" is not an OpenAPI or Arazzo document`);
     annotation.classes.push('warning');
     parseResult.push(annotation);
     return parseResult;
@@ -84,11 +85,11 @@ async function parseSourceDescription(sourceDescription, ctx) {
   const declaredType = toValue(sourceDescription.type);
   if (typeof declaredType === 'string') {
     if (declaredType === 'openapi' && !isOpenApi) {
-      const annotation = new AnnotationElement(`Source description "${retrievalURI}" declared as "openapi" but parsed as Arazzo document.`);
+      const annotation = new AnnotationElement(`Source description "${retrievalURI}" declared as "openapi" but parsed as Arazzo document`);
       annotation.classes.push('warning');
       parseResult.push(annotation);
     } else if (declaredType === 'arazzo' && !isArazzo) {
-      const annotation = new AnnotationElement(`Source description "${retrievalURI}" declared as "arazzo" but parsed as OpenAPI document.`);
+      const annotation = new AnnotationElement(`Source description "${retrievalURI}" declared as "arazzo" but parsed as OpenAPI document`);
       annotation.classes.push('warning');
       parseResult.push(annotation);
     }
@@ -98,10 +99,9 @@ async function parseSourceDescription(sourceDescription, ctx) {
 
 /**
  * Shared function for parsing source descriptions.
- * Call with `.call(this, ...)` where `this` has `name` and `parseFn` properties.
  * @public
  */
-export async function parseSourceDescriptions(api, file, options) {
+export async function parseSourceDescriptions(parserName, api, file, options) {
   const results = [];
 
   /**
@@ -109,23 +109,18 @@ export async function parseSourceDescriptions(api, file, options) {
    * Return warning annotations if validation fails.
    */
   if (!isArazzoSpecification1Element(api)) {
-    const annotation = new AnnotationElement('Cannot parse source descriptions: API is not an Arazzo specification.');
+    const annotation = new AnnotationElement('Cannot parse source descriptions: API is not an Arazzo specification');
     annotation.classes.push('warning');
     return [new ParseResultElement([annotation])];
   }
   if (!isArrayElement(api.sourceDescriptions)) {
-    const annotation = new AnnotationElement('Cannot parse source descriptions: sourceDescriptions field is missing or not an array.');
+    const annotation = new AnnotationElement('Cannot parse source descriptions: sourceDescriptions field is missing or not an array');
     annotation.classes.push('warning');
     return [new ParseResultElement([annotation])];
   }
-  if (typeof this.parseFn !== 'function') {
-    const annotation = new AnnotationElement('Source descriptions found but parseFn is not configured. Skipping source description parsing.');
-    annotation.classes.push('error');
-    return [new ParseResultElement([annotation])];
-  }
 
   // user config: parser-specific options take precedence over global parserOpts
-  const maxDepth = options?.parse?.parserOpts?.[this.name]?.sourceDescriptionsMaxDepth ?? options?.parse?.parserOpts?.sourceDescriptionsMaxDepth ?? +Infinity;
+  const maxDepth = options?.parse?.parserOpts?.[parserName]?.sourceDescriptionsMaxDepth ?? options?.parse?.parserOpts?.sourceDescriptionsMaxDepth ?? +Infinity;
 
   // recursion state comes from shared key (works across JSON/YAML)
   const sharedOpts = options?.parse?.parserOpts?.[ARAZZO_RECURSION_KEY] ?? {};
@@ -142,7 +137,6 @@ export async function parseSourceDescriptions(api, file, options) {
     return [parseResult];
   }
   const ctx = {
-    parseFn: this.parseFn,
     baseURI: file.uri,
     options,
     currentDepth,
@@ -150,7 +144,7 @@ export async function parseSourceDescriptions(api, file, options) {
   };
 
   // determine which source descriptions to parse
-  const sourceDescriptionsOption = options?.parse?.parserOpts?.[this.name]?.sourceDescriptions ?? options?.parse?.parserOpts?.sourceDescriptions;
+  const sourceDescriptionsOption = options?.parse?.parserOpts?.[parserName]?.sourceDescriptions ?? options?.parse?.parserOpts?.sourceDescriptions;
 
   // handle false or other falsy values - no source descriptions should be parsed
   if (!sourceDescriptionsOption) {

package/src/parse/parsers/arazzo-yaml-1/index.cjs

@@ -17,10 +17,8 @@ var _sourceDescription = require("../arazzo-json-1/source-description.cjs");
  */
 class ArazzoYAML1Parser extends _Parser.default {
   refractorOpts;
-  parseFn;
   constructor(options) {
     const {
-      parseFn,
       fileExtensions = [],
       mediaTypes = _apidomParserAdapterArazzoYaml.mediaTypes,
       ...rest
@@ -31,7 +29,6 @@ class ArazzoYAML1Parser extends _Parser.default {
       fileExtensions,
       mediaTypes
     });
-    this.parseFn = parseFn;
   }
   async canParse(file) {
     const hasSupportedFileExtension = this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
@@ -50,7 +47,7 @@ class ArazzoYAML1Parser extends _Parser.default {
       const parseResult = await (0, _apidomParserAdapterArazzoYaml.parse)(source, parserOpts);
       const shouldParseSourceDescriptions = options?.parse?.parserOpts?.[this.name]?.sourceDescriptions ?? options?.parse?.parserOpts?.sourceDescriptions;
       if (shouldParseSourceDescriptions) {
-        const sourceDescriptions = await _sourceDescription.parseSourceDescriptions.call(this, parseResult.api, file, options);
+        const sourceDescriptions = await (0, _sourceDescription.parseSourceDescriptions)(this.name, parseResult.api, file, options);
         parseResult.push(...sourceDescriptions);
       }
       return parseResult;

package/src/parse/parsers/arazzo-yaml-1/index.mjs

@@ -11,10 +11,8 @@ import { parseSourceDescriptions } from "../arazzo-json-1/source-description.mjs
  */
 class ArazzoYAML1Parser extends Parser {
   refractorOpts;
-  parseFn;
   constructor(options) {
     const {
-      parseFn,
       fileExtensions = [],
       mediaTypes = ArazzoYAML1MediaTypes,
       ...rest
@@ -25,7 +23,6 @@ class ArazzoYAML1Parser extends Parser {
       fileExtensions,
       mediaTypes
     });
-    this.parseFn = parseFn;
   }
   async canParse(file) {
     const hasSupportedFileExtension = this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
@@ -44,7 +41,7 @@ class ArazzoYAML1Parser extends Parser {
       const parseResult = await parse(source, parserOpts);
       const shouldParseSourceDescriptions = options?.parse?.parserOpts?.[this.name]?.sourceDescriptions ?? options?.parse?.parserOpts?.sourceDescriptions;
       if (shouldParseSourceDescriptions) {
-        const sourceDescriptions = await parseSourceDescriptions.call(this, parseResult.api, file, options);
+        const sourceDescriptions = await parseSourceDescriptions(this.name, parseResult.api, file, options);
         parseResult.push(...sourceDescriptions);
       }
       return parseResult;

package/src/resolve/resolvers/file/index-browser.cjs

@@ -18,7 +18,7 @@ class FileResolver extends _Resolver.default {
     return false;
   }
   read() {
-    throw new _ResolverError.default('FileResolver is not intended to be used in browser context.');
+    throw new _ResolverError.default('FileResolver is not intended to be used in browser context');
   }
 }
 var _default = exports.default = FileResolver;

package/src/resolve/resolvers/file/index-browser.mjs

@@ -13,7 +13,7 @@ class FileResolver extends Resolver {
     return false;
   }
   read() {
-    throw new ResolverError('FileResolver is not intended to be used in browser context.');
+    throw new ResolverError('FileResolver is not intended to be used in browser context');
   }
 }
 export default FileResolver;

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/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>;