@speclynx/apidom-reference 2.7.0 → 2.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-reference",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "Advanced algorithms for semantic ApiDOM manipulations like dereferencing or resolution.",
   "publishConfig": {
     "access": "public",
@@ -231,29 +231,29 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.28.4",
-    "@speclynx/apidom-core": "^2.7.0",
-    "@speclynx/apidom-datamodel": "^2.7.0",
-    "@speclynx/apidom-error": "^2.7.0",
-    "@speclynx/apidom-json-pointer": "^2.7.0",
-    "@speclynx/apidom-ns-arazzo-1": "^2.7.0",
-    "@speclynx/apidom-ns-asyncapi-2": "^2.7.0",
-    "@speclynx/apidom-ns-json-schema-2020-12": "^2.7.0",
-    "@speclynx/apidom-ns-openapi-2": "^2.7.0",
-    "@speclynx/apidom-ns-openapi-3-0": "^2.7.0",
-    "@speclynx/apidom-ns-openapi-3-1": "^2.7.0",
-    "@speclynx/apidom-parser-adapter-arazzo-json-1": "^2.7.0",
-    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "^2.7.0",
-    "@speclynx/apidom-parser-adapter-asyncapi-json-2": "^2.7.0",
-    "@speclynx/apidom-parser-adapter-asyncapi-yaml-2": "^2.7.0",
-    "@speclynx/apidom-parser-adapter-json": "^2.7.0",
-    "@speclynx/apidom-parser-adapter-openapi-json-2": "^2.7.0",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "^2.7.0",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "^2.7.0",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "^2.7.0",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "^2.7.0",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "^2.7.0",
-    "@speclynx/apidom-parser-adapter-yaml-1-2": "^2.7.0",
-    "@speclynx/apidom-traverse": "^2.7.0",
+    "@speclynx/apidom-core": "^2.8.0",
+    "@speclynx/apidom-datamodel": "^2.8.0",
+    "@speclynx/apidom-error": "^2.8.0",
+    "@speclynx/apidom-json-pointer": "^2.8.0",
+    "@speclynx/apidom-ns-arazzo-1": "^2.8.0",
+    "@speclynx/apidom-ns-asyncapi-2": "^2.8.0",
+    "@speclynx/apidom-ns-json-schema-2020-12": "^2.8.0",
+    "@speclynx/apidom-ns-openapi-2": "^2.8.0",
+    "@speclynx/apidom-ns-openapi-3-0": "^2.8.0",
+    "@speclynx/apidom-ns-openapi-3-1": "^2.8.0",
+    "@speclynx/apidom-parser-adapter-arazzo-json-1": "^2.8.0",
+    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "^2.8.0",
+    "@speclynx/apidom-parser-adapter-asyncapi-json-2": "^2.8.0",
+    "@speclynx/apidom-parser-adapter-asyncapi-yaml-2": "^2.8.0",
+    "@speclynx/apidom-parser-adapter-json": "^2.8.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-2": "^2.8.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "^2.8.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "^2.8.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "^2.8.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "^2.8.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "^2.8.0",
+    "@speclynx/apidom-parser-adapter-yaml-1-2": "^2.8.0",
+    "@speclynx/apidom-traverse": "^2.8.0",
     "@swaggerexpert/arazzo-runtime-expression": "^2.0.2",
     "axios": "^1.13.0",
     "minimatch": "^7.4.6",
@@ -274,5 +274,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "82ac9430aa882d0a5c63a17f7da8f5c0dcbca737"
+  "gitHead": "467e34a8f8a9d56622faf0794e4ef9c1fe86b849"
 }

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

@@ -7,7 +7,8 @@ var _ramda = require("ramda");
 var _apidomParserAdapterArazzoJson = require("@speclynx/apidom-parser-adapter-arazzo-json-1");
 var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
 var _Parser = _interopRequireDefault(require("../Parser.cjs"));
-var _sourceDescription = require("./source-description.cjs");
+var _sourceDescriptions = require("./source-descriptions.cjs");
+exports.parseSourceDescriptions = _sourceDescriptions.parseSourceDescriptions;
 /**
  * @public
  */
@@ -47,7 +48,7 @@ class ArazzoJSON1Parser extends _Parser.default {
       const parseResult = await (0, _apidomParserAdapterArazzoJson.parse)(source, parserOpts);
       const shouldParseSourceDescriptions = options?.parse?.parserOpts?.[this.name]?.sourceDescriptions ?? options?.parse?.parserOpts?.sourceDescriptions;
       if (shouldParseSourceDescriptions) {
-        const sourceDescriptions = await (0, _sourceDescription.parseSourceDescriptions)(this.name, parseResult.api, file, options);
+        const sourceDescriptions = await (0, _sourceDescriptions.parseSourceDescriptions)(parseResult, file.uri, options, this.name);
         parseResult.push(...sourceDescriptions);
       }
       return parseResult;

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

@@ -2,7 +2,7 @@ import { pick } from 'ramda';
 import { parse, mediaTypes as ArazzoJSON1MediaTypes, detect } from '@speclynx/apidom-parser-adapter-arazzo-json-1';
 import ParserError from "../../../errors/ParserError.mjs";
 import Parser from "../Parser.mjs";
-import { parseSourceDescriptions } from "./source-description.mjs";
+import { parseSourceDescriptions } from "./source-descriptions.mjs";
 /**
  * @public
  */
@@ -41,7 +41,7 @@ class ArazzoJSON1Parser 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(this.name, parseResult.api, file, options);
+        const sourceDescriptions = await parseSourceDescriptions(parseResult, file.uri, options, this.name);
         parseResult.push(...sourceDescriptions);
       }
       return parseResult;
@@ -52,4 +52,5 @@ class ArazzoJSON1Parser extends Parser {
     }
   }
 }
+export { parseSourceDescriptions } from "./source-descriptions.mjs";
 export default ArazzoJSON1Parser;

package/src/parse/parsers/arazzo-json-1/{source-description.cjs → source-descriptions.cjs}

@@ -1,7 +1,7 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
 exports.parseSourceDescriptions = parseSourceDescriptions;
 var _apidomDatamodel = require("@speclynx/apidom-datamodel");
@@ -10,6 +10,7 @@ var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-2");
 var _apidomNsOpenapi2 = require("@speclynx/apidom-ns-openapi-3-0");
 var _apidomNsOpenapi3 = require("@speclynx/apidom-ns-openapi-3-1");
 var _apidomCore = require("@speclynx/apidom-core");
+var _File = _interopRequireDefault(require("../../../File.cjs"));
 var url = _interopRequireWildcard(require("../../../util/url.cjs"));
 var _util = require("../../../options/util.cjs");
 var _index = _interopRequireDefault(require("../../index.cjs"));
@@ -50,7 +51,7 @@ async function parseSourceDescription(sourceDescription, ctx) {
   }
   ctx.visitedUrls.add(retrievalURI);
   try {
-    const sdParseResult = await (0, _index.default)(retrievalURI, (0, _util.merge)(ctx.options, {
+    const sourceDescriptionParseResult = await (0, _index.default)(retrievalURI, (0, _util.merge)(ctx.options, {
       parse: {
         mediaType: 'text/plain',
         // allow parser plugin detection
@@ -63,7 +64,7 @@ async function parseSourceDescription(sourceDescription, ctx) {
       }
     }));
     // merge parsed result into our parse result
-    for (const item of sdParseResult) {
+    for (const item of sourceDescriptionParseResult) {
       parseResult.push(item);
     }
   } catch (error) {
@@ -105,10 +106,40 @@ async function parseSourceDescription(sourceDescription, ctx) {
 }
 
 /**
- * Shared function for parsing source descriptions.
+ * Parses source descriptions from an Arazzo document's ParseResult.
+ *
+ * @param parseResult - ParseResult containing an Arazzo specification
+ * @param parseResultRetrievalURI - URI from which the parseResult was retrieved
+ * @param options - Full ReferenceOptions (caller responsibility to construct)
+ * @param parserName - Parser name for options lookup (defaults to 'arazzo-json-1')
+ * @returns Array of ParseResultElements. On success, returns one ParseResultElement per
+ *   source description (each with class 'source-description' and name/type metadata).
+ *   May return early with a single-element array containing a warning annotation when:
+ *   - The API is not an Arazzo specification
+ *   - The sourceDescriptions field is missing or not an array
+ *   - Maximum parse depth is exceeded (error annotation)
+ *   Returns an empty array when sourceDescriptions option is disabled or no names match.
+ *
+ * @example
+ * ```typescript
+ * import { options, mergeOptions } from '@speclynx/apidom-reference';
+ * import { parseSourceDescriptions } from '@speclynx/apidom-reference/parse/parsers/arazzo-json-1';
+ *
+ * const fullOptions = mergeOptions(options, {
+ *   parse: { parserOpts: { sourceDescriptions: true } }
+ * });
+ * const results = await parseSourceDescriptions(parseResult, uri, fullOptions);
+ * ```
+ *
  * @public
  */
-async function parseSourceDescriptions(parserName, api, file, options) {
+async function parseSourceDescriptions(parseResult, parseResultRetrievalURI, options, parserName = 'arazzo-json-1') {
+  const {
+    api
+  } = parseResult;
+  const file = new _File.default({
+    uri: url.sanitize(url.stripHash(parseResultRetrievalURI))
+  });
   const results = [];
 
   /**

package/src/parse/parsers/arazzo-json-1/{source-description.mjs → source-descriptions.mjs}

@@ -4,6 +4,7 @@ import { isSwaggerElement } from '@speclynx/apidom-ns-openapi-2';
 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 File from "../../../File.mjs";
 import * as url from "../../../util/url.mjs";
 import { merge as mergeOptions } from "../../../options/util.mjs";
 import parse from "../../index.mjs"; // shared key for recursion state (works across JSON/YAML parsers)
@@ -43,7 +44,7 @@ async function parseSourceDescription(sourceDescription, ctx) {
   }
   ctx.visitedUrls.add(retrievalURI);
   try {
-    const sdParseResult = await parse(retrievalURI, mergeOptions(ctx.options, {
+    const sourceDescriptionParseResult = await parse(retrievalURI, mergeOptions(ctx.options, {
       parse: {
         mediaType: 'text/plain',
         // allow parser plugin detection
@@ -56,7 +57,7 @@ async function parseSourceDescription(sourceDescription, ctx) {
       }
     }));
     // merge parsed result into our parse result
-    for (const item of sdParseResult) {
+    for (const item of sourceDescriptionParseResult) {
       parseResult.push(item);
     }
   } catch (error) {
@@ -98,10 +99,40 @@ async function parseSourceDescription(sourceDescription, ctx) {
 }
 
 /**
- * Shared function for parsing source descriptions.
+ * Parses source descriptions from an Arazzo document's ParseResult.
+ *
+ * @param parseResult - ParseResult containing an Arazzo specification
+ * @param parseResultRetrievalURI - URI from which the parseResult was retrieved
+ * @param options - Full ReferenceOptions (caller responsibility to construct)
+ * @param parserName - Parser name for options lookup (defaults to 'arazzo-json-1')
+ * @returns Array of ParseResultElements. On success, returns one ParseResultElement per
+ *   source description (each with class 'source-description' and name/type metadata).
+ *   May return early with a single-element array containing a warning annotation when:
+ *   - The API is not an Arazzo specification
+ *   - The sourceDescriptions field is missing or not an array
+ *   - Maximum parse depth is exceeded (error annotation)
+ *   Returns an empty array when sourceDescriptions option is disabled or no names match.
+ *
+ * @example
+ * ```typescript
+ * import { options, mergeOptions } from '@speclynx/apidom-reference';
+ * import { parseSourceDescriptions } from '@speclynx/apidom-reference/parse/parsers/arazzo-json-1';
+ *
+ * const fullOptions = mergeOptions(options, {
+ *   parse: { parserOpts: { sourceDescriptions: true } }
+ * });
+ * const results = await parseSourceDescriptions(parseResult, uri, fullOptions);
+ * ```
+ *
  * @public
  */
-export async function parseSourceDescriptions(parserName, api, file, options) {
+export async function parseSourceDescriptions(parseResult, parseResultRetrievalURI, options, parserName = 'arazzo-json-1') {
+  const {
+    api
+  } = parseResult;
+  const file = new File({
+    uri: url.sanitize(url.stripHash(parseResultRetrievalURI))
+  });
   const results = [];
 
   /**

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

@@ -7,7 +7,8 @@ var _ramda = require("ramda");
 var _apidomParserAdapterArazzoYaml = require("@speclynx/apidom-parser-adapter-arazzo-yaml-1");
 var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
 var _Parser = _interopRequireDefault(require("../Parser.cjs"));
-var _sourceDescription = require("../arazzo-json-1/source-description.cjs");
+var _sourceDescriptions = require("./source-descriptions.cjs");
+exports.parseSourceDescriptions = _sourceDescriptions.parseSourceDescriptions;
 /**
  * @public
  */
@@ -47,7 +48,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 (0, _sourceDescription.parseSourceDescriptions)(this.name, parseResult.api, file, options);
+        const sourceDescriptions = await (0, _sourceDescriptions.parseSourceDescriptions)(parseResult, file.uri, options, this.name);
         parseResult.push(...sourceDescriptions);
       }
       return parseResult;

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

@@ -2,7 +2,7 @@ import { pick } from 'ramda';
 import { parse, mediaTypes as ArazzoYAML1MediaTypes, detect } from '@speclynx/apidom-parser-adapter-arazzo-yaml-1';
 import ParserError from "../../../errors/ParserError.mjs";
 import Parser from "../Parser.mjs";
-import { parseSourceDescriptions } from "../arazzo-json-1/source-description.mjs";
+import { parseSourceDescriptions } from "./source-descriptions.mjs";
 /**
  * @public
  */
@@ -41,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(this.name, parseResult.api, file, options);
+        const sourceDescriptions = await parseSourceDescriptions(parseResult, file.uri, options, this.name);
         parseResult.push(...sourceDescriptions);
       }
       return parseResult;
@@ -52,4 +52,5 @@ class ArazzoYAML1Parser extends Parser {
     }
   }
 }
+export { parseSourceDescriptions } from "./source-descriptions.mjs";
 export default ArazzoYAML1Parser;

package/src/parse/parsers/arazzo-yaml-1/source-descriptions.cjs

@@ -0,0 +1,12 @@
+"use strict";
+
+exports.__esModule = true;
+exports.parseSourceDescriptions = void 0;
+var _sourceDescriptions = require("../arazzo-json-1/source-descriptions.cjs");
+/**
+ * @public
+ */
+const parseSourceDescriptions = (parseResult, parseResultRetrievalURI, options, parserName = 'arazzo-yaml-1') => {
+  return (0, _sourceDescriptions.parseSourceDescriptions)(parseResult, parseResultRetrievalURI, options, parserName);
+};
+exports.parseSourceDescriptions = parseSourceDescriptions;

package/src/parse/parsers/arazzo-yaml-1/source-descriptions.mjs

@@ -0,0 +1,7 @@
+import { parseSourceDescriptions as parseSourceDescriptionsBase } from "../arazzo-json-1/source-descriptions.mjs";
+/**
+ * @public
+ */
+export const parseSourceDescriptions = (parseResult, parseResultRetrievalURI, options, parserName = 'arazzo-yaml-1') => {
+  return parseSourceDescriptionsBase(parseResult, parseResultRetrievalURI, options, parserName);
+};

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

@@ -18,4 +18,5 @@ declare class ArazzoJSON1Parser extends Parser {
     canParse(file: File): Promise<boolean>;
     parse(file: File, options?: ReferenceOptions): Promise<ParseResultElement>;
 }
+export { parseSourceDescriptions } from './source-descriptions.ts';
 export default ArazzoJSON1Parser;

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

@@ -0,0 +1,31 @@
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
+import type { ReferenceOptions } from '../../../options/index.ts';
+/**
+ * Parses source descriptions from an Arazzo document's ParseResult.
+ *
+ * @param parseResult - ParseResult containing an Arazzo specification
+ * @param parseResultRetrievalURI - URI from which the parseResult was retrieved
+ * @param options - Full ReferenceOptions (caller responsibility to construct)
+ * @param parserName - Parser name for options lookup (defaults to 'arazzo-json-1')
+ * @returns Array of ParseResultElements. On success, returns one ParseResultElement per
+ *   source description (each with class 'source-description' and name/type metadata).
+ *   May return early with a single-element array containing a warning annotation when:
+ *   - The API is not an Arazzo specification
+ *   - The sourceDescriptions field is missing or not an array
+ *   - Maximum parse depth is exceeded (error annotation)
+ *   Returns an empty array when sourceDescriptions option is disabled or no names match.
+ *
+ * @example
+ * ```typescript
+ * import { options, mergeOptions } from '@speclynx/apidom-reference';
+ * import { parseSourceDescriptions } from '@speclynx/apidom-reference/parse/parsers/arazzo-json-1';
+ *
+ * const fullOptions = mergeOptions(options, {
+ *   parse: { parserOpts: { sourceDescriptions: true } }
+ * });
+ * const results = await parseSourceDescriptions(parseResult, uri, fullOptions);
+ * ```
+ *
+ * @public
+ */
+export declare function parseSourceDescriptions(parseResult: ParseResultElement, parseResultRetrievalURI: string, options: ReferenceOptions, parserName?: string): Promise<ParseResultElement[]>;

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

@@ -18,4 +18,5 @@ declare class ArazzoYAML1Parser extends Parser {
     canParse(file: File): Promise<boolean>;
     parse(file: File, options?: ReferenceOptions): Promise<ParseResultElement>;
 }
+export { parseSourceDescriptions } from './source-descriptions.ts';
 export default ArazzoYAML1Parser;

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

@@ -0,0 +1,6 @@
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
+import type { ReferenceOptions } from '../../../options/index.ts';
+/**
+ * @public
+ */
+export declare const parseSourceDescriptions: (parseResult: ParseResultElement, parseResultRetrievalURI: string, options: ReferenceOptions, parserName?: string) => Promise<ParseResultElement[]>;

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

@@ -1,8 +0,0 @@
-import { Element, ParseResultElement } from '@speclynx/apidom-datamodel';
-import File from '../../../File.ts';
-import type { ReferenceOptions } from '../../../options/index.ts';
-/**
- * Shared function for parsing source descriptions.
- * @public
- */
-export declare function parseSourceDescriptions(parserName: string, api: Element | undefined, file: File, options: ReferenceOptions): Promise<ParseResultElement[]>;