@jentic/arazzo-parser 1.0.0-alpha.8 → 1.0.0-alpha.9

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.0.0-alpha.9](https://github.com/jentic/jentic-arazzo-tools/compare/v1.0.0-alpha.8...v1.0.0-alpha.9) (2026-02-05)
+
+### Features
+
+- **resolver:** add dereferencing support for Arazzo Source Descriptions ([#43](https://github.com/jentic/jentic-arazzo-tools/issues/43)) ([091610b](https://github.com/jentic/jentic-arazzo-tools/commit/091610be81b32540845c7f1cb60dd68348ee282b))
+
 # [1.0.0-alpha.8](https://github.com/jentic/jentic-arazzo-tools/compare/v1.0.0-alpha.7...v1.0.0-alpha.8) (2026-02-05)
 
 **Note:** Version bump only for package @jentic/arazzo-parser

package/dist/jentic-arazzo-parser.browser.js

@@ -89,12 +89,10 @@ const defaultOptions = {
   parse: {
     parsers: [new _speclynx_apidom_reference_parse_parsers_arazzo_json_1__WEBPACK_IMPORTED_MODULE_3__["default"]({
       allowEmpty: false,
-      fileExtensions: ['.json'],
-      parseFn: _speclynx_apidom_reference_configuration_empty__WEBPACK_IMPORTED_MODULE_0__.parse
+      fileExtensions: ['.json']
     }), new _speclynx_apidom_reference_parse_parsers_arazzo_yaml_1__WEBPACK_IMPORTED_MODULE_4__["default"]({
       allowEmpty: false,
-      fileExtensions: ['.yaml', '.yml'],
-      parseFn: _speclynx_apidom_reference_configuration_empty__WEBPACK_IMPORTED_MODULE_0__.parse
+      fileExtensions: ['.yaml', '.yml']
     }), new _speclynx_apidom_reference_parse_parsers_openapi_json_2__WEBPACK_IMPORTED_MODULE_5__["default"]({
       allowEmpty: false,
       fileExtensions: ['.json']
@@ -43775,10 +43773,8 @@ __webpack_require__.r(__webpack_exports__);
  */
 class ArazzoJSON1Parser extends _Parser_mjs__WEBPACK_IMPORTED_MODULE_4__["default"] {
   refractorOpts;
-  parseFn;
   constructor(options) {
     const {
-      parseFn,
       fileExtensions = [],
       mediaTypes = _speclynx_apidom_parser_adapter_arazzo_json_1__WEBPACK_IMPORTED_MODULE_2__["default"],
       ...rest
@@ -43789,7 +43785,6 @@ class ArazzoJSON1Parser extends _Parser_mjs__WEBPACK_IMPORTED_MODULE_4__["defaul
       fileExtensions,
       mediaTypes
     });
-    this.parseFn = parseFn;
   }
   async canParse(file) {
     const hasSupportedFileExtension = this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
@@ -43808,7 +43803,7 @@ class ArazzoJSON1Parser extends _Parser_mjs__WEBPACK_IMPORTED_MODULE_4__["defaul
       const parseResult = await (0,_speclynx_apidom_parser_adapter_arazzo_json_1__WEBPACK_IMPORTED_MODULE_1__.parse)(source, parserOpts);
       const shouldParseSourceDescriptions = options?.parse?.parserOpts?.[this.name]?.sourceDescriptions ?? options?.parse?.parserOpts?.sourceDescriptions;
       if (shouldParseSourceDescriptions) {
-        const sourceDescriptions = await _source_description_mjs__WEBPACK_IMPORTED_MODULE_5__.parseSourceDescriptions.call(this, parseResult.api, file, options);
+        const sourceDescriptions = await (0,_source_description_mjs__WEBPACK_IMPORTED_MODULE_5__.parseSourceDescriptions)(this.name, parseResult.api, file, options);
         parseResult.push(...sourceDescriptions);
       }
       return parseResult;
@@ -43842,6 +43837,8 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_8__ = __webpack_require__(7456);
 /* harmony import */ var _util_url_mjs__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(30698);
 /* harmony import */ var _options_util_mjs__WEBPACK_IMPORTED_MODULE_10__ = __webpack_require__(8841);
+/* harmony import */ var _index_mjs__WEBPACK_IMPORTED_MODULE_11__ = __webpack_require__(62792);
+
 
 
 
@@ -43858,7 +43855,7 @@ const ARAZZO_RECURSION_KEY = 'arazzo-1';
 async function parseSourceDescription(sourceDescription, ctx) {
   const parseResult = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"]();
   if (!(0,_speclynx_apidom_ns_arazzo_1__WEBPACK_IMPORTED_MODULE_4__.isSourceDescriptionElement)(sourceDescription)) {
-    const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"]('Element is not a valid SourceDescriptionElement. Skipping.');
+    const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"]('Element is not a valid SourceDescriptionElement. Skipping');
     annotation.classes.push('warning');
     parseResult.push(annotation);
     return parseResult;
@@ -43870,7 +43867,7 @@ async function parseSourceDescription(sourceDescription, ctx) {
   if ((0,_speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_0__.isStringElement)(sourceDescription.type)) parseResult.setMetaProperty('type', (0,_speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_1__.cloneDeep)(sourceDescription.type));
   const sourceDescriptionURI = (0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_8__["default"])(sourceDescription.url);
   if (typeof sourceDescriptionURI !== 'string') {
-    const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"]('Source description URL is missing or not a string. Skipping.');
+    const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"]('Source description URL is missing or not a string. Skipping');
     annotation.classes.push('warning');
     parseResult.push(annotation);
     return parseResult;
@@ -43879,14 +43876,14 @@ async function parseSourceDescription(sourceDescription, ctx) {
 
   // skip if already visited (cycle detection)
   if (ctx.visitedUrls.has(retrievalURI)) {
-    const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"](`Source description "${retrievalURI}" has already been visited. Skipping to prevent cycle.`);
+    const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"](`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,_options_util_mjs__WEBPACK_IMPORTED_MODULE_10__.merge)(ctx.options, {
+    const sdParseResult = await (0,_index_mjs__WEBPACK_IMPORTED_MODULE_11__["default"])(retrievalURI, (0,_options_util_mjs__WEBPACK_IMPORTED_MODULE_10__.merge)(ctx.options, {
       parse: {
         mediaType: 'text/plain',
         // allow parser plugin detection
@@ -43918,7 +43915,7 @@ async function parseSourceDescription(sourceDescription, ctx) {
   const isOpenApi = (0,_speclynx_apidom_ns_openapi_2__WEBPACK_IMPORTED_MODULE_5__.isSwaggerElement)(sourceDescriptionAPI) || (0,_speclynx_apidom_ns_openapi_3_0__WEBPACK_IMPORTED_MODULE_6__.isOpenApi3_0Element)(sourceDescriptionAPI) || (0,_speclynx_apidom_ns_openapi_3_1__WEBPACK_IMPORTED_MODULE_7__.isOpenApi3_1Element)(sourceDescriptionAPI);
   const isArazzo = (0,_speclynx_apidom_ns_arazzo_1__WEBPACK_IMPORTED_MODULE_4__.isArazzoSpecification1Element)(sourceDescriptionAPI);
   if (!isOpenApi && !isArazzo) {
-    const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"](`Source description "${retrievalURI}" is not an OpenAPI or Arazzo document. Skipping.`);
+    const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"](`Source description "${retrievalURI}" is not an OpenAPI or Arazzo document`);
     annotation.classes.push('warning');
     parseResult.push(annotation);
     return parseResult;
@@ -43928,11 +43925,11 @@ async function parseSourceDescription(sourceDescription, ctx) {
   const declaredType = (0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_8__["default"])(sourceDescription.type);
   if (typeof declaredType === 'string') {
     if (declaredType === 'openapi' && !isOpenApi) {
-      const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"](`Source description "${retrievalURI}" declared as "openapi" but parsed as Arazzo document.`);
+      const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"](`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 _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"](`Source description "${retrievalURI}" declared as "arazzo" but parsed as OpenAPI document.`);
+      const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"](`Source description "${retrievalURI}" declared as "arazzo" but parsed as OpenAPI document`);
       annotation.classes.push('warning');
       parseResult.push(annotation);
     }
@@ -43942,10 +43939,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 = [];
 
   /**
@@ -43953,23 +43949,18 @@ async function parseSourceDescriptions(api, file, options) {
    * Return warning annotations if validation fails.
    */
   if (!(0,_speclynx_apidom_ns_arazzo_1__WEBPACK_IMPORTED_MODULE_4__.isArazzoSpecification1Element)(api)) {
-    const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"]('Cannot parse source descriptions: API is not an Arazzo specification.');
+    const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"]('Cannot parse source descriptions: API is not an Arazzo specification');
     annotation.classes.push('warning');
     return [new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"]([annotation])];
   }
   if (!(0,_speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_0__.isArrayElement)(api.sourceDescriptions)) {
-    const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"]('Cannot parse source descriptions: sourceDescriptions field is missing or not an array.');
+    const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"]('Cannot parse source descriptions: sourceDescriptions field is missing or not an array');
     annotation.classes.push('warning');
     return [new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"]([annotation])];
   }
-  if (typeof this.parseFn !== 'function') {
-    const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"]('Source descriptions found but parseFn is not configured. Skipping source description parsing.');
-    annotation.classes.push('error');
-    return [new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"]([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] ?? {};
@@ -43986,7 +43977,6 @@ async function parseSourceDescriptions(api, file, options) {
     return [parseResult];
   }
   const ctx = {
-    parseFn: this.parseFn,
     baseURI: file.uri,
     options,
     currentDepth,
@@ -43994,7 +43984,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) {
@@ -44043,10 +44033,8 @@ __webpack_require__.r(__webpack_exports__);
  */
 class ArazzoYAML1Parser extends _Parser_mjs__WEBPACK_IMPORTED_MODULE_4__["default"] {
   refractorOpts;
-  parseFn;
   constructor(options) {
     const {
-      parseFn,
       fileExtensions = [],
       mediaTypes = _speclynx_apidom_parser_adapter_arazzo_yaml_1__WEBPACK_IMPORTED_MODULE_2__["default"],
       ...rest
@@ -44057,7 +44045,6 @@ class ArazzoYAML1Parser extends _Parser_mjs__WEBPACK_IMPORTED_MODULE_4__["defaul
       fileExtensions,
       mediaTypes
     });
-    this.parseFn = parseFn;
   }
   async canParse(file) {
     const hasSupportedFileExtension = this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
@@ -44076,7 +44063,7 @@ class ArazzoYAML1Parser extends _Parser_mjs__WEBPACK_IMPORTED_MODULE_4__["defaul
       const parseResult = await (0,_speclynx_apidom_parser_adapter_arazzo_yaml_1__WEBPACK_IMPORTED_MODULE_1__.parse)(source, parserOpts);
       const shouldParseSourceDescriptions = options?.parse?.parserOpts?.[this.name]?.sourceDescriptions ?? options?.parse?.parserOpts?.sourceDescriptions;
       if (shouldParseSourceDescriptions) {
-        const sourceDescriptions = await _arazzo_json_1_source_description_mjs__WEBPACK_IMPORTED_MODULE_5__.parseSourceDescriptions.call(this, parseResult.api, file, options);
+        const sourceDescriptions = await (0,_arazzo_json_1_source_description_mjs__WEBPACK_IMPORTED_MODULE_5__.parseSourceDescriptions)(this.name, parseResult.api, file, options);
         parseResult.push(...sourceDescriptions);
       }
       return parseResult;
@@ -44654,7 +44641,7 @@ class FileResolver extends _Resolver_mjs__WEBPACK_IMPORTED_MODULE_0__["default"]
     return false;
   }
   read() {
-    throw new _errors_ResolverError_mjs__WEBPACK_IMPORTED_MODULE_1__["default"]('FileResolver is not intended to be used in browser context.');
+    throw new _errors_ResolverError_mjs__WEBPACK_IMPORTED_MODULE_1__["default"]('FileResolver is not intended to be used in browser context');
   }
 }
 /* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = (FileResolver);