@speclynx/apidom-reference 2.7.0 → 2.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +197 -0
  3. package/dist/apidom-reference.browser.js +221 -83
  4. package/dist/apidom-reference.browser.min.js +1 -1
  5. package/package.json +25 -25
  6. package/src/dereference/strategies/arazzo-1/index.cjs +3 -2
  7. package/src/dereference/strategies/arazzo-1/index.mjs +3 -2
  8. package/src/dereference/strategies/arazzo-1/{source-description.cjs → source-descriptions.cjs} +94 -29
  9. package/src/dereference/strategies/arazzo-1/{source-description.mjs → source-descriptions.mjs} +95 -28
  10. package/src/parse/parsers/arazzo-json-1/index.cjs +3 -2
  11. package/src/parse/parsers/arazzo-json-1/index.mjs +3 -2
  12. package/src/parse/parsers/arazzo-json-1/{source-description.cjs → source-descriptions.cjs} +58 -12
  13. package/src/parse/parsers/arazzo-json-1/{source-description.mjs → source-descriptions.mjs} +57 -11
  14. package/src/parse/parsers/arazzo-yaml-1/index.cjs +3 -2
  15. package/src/parse/parsers/arazzo-yaml-1/index.mjs +3 -2
  16. package/src/parse/parsers/arazzo-yaml-1/source-descriptions.cjs +12 -0
  17. package/src/parse/parsers/arazzo-yaml-1/source-descriptions.mjs +7 -0
  18. package/types/dereference/strategies/arazzo-1/index.d.ts +1 -0
  19. package/types/dereference/strategies/arazzo-1/source-descriptions.d.ts +41 -0
  20. package/types/parse/parsers/arazzo-json-1/index.d.ts +1 -0
  21. package/types/parse/parsers/arazzo-json-1/source-descriptions.d.ts +44 -0
  22. package/types/parse/parsers/arazzo-yaml-1/index.d.ts +1 -0
  23. package/types/parse/parsers/arazzo-yaml-1/source-descriptions.d.ts +6 -0
  24. package/types/dereference/strategies/arazzo-1/source-description.d.ts +0 -8
  25. package/types/parse/parsers/arazzo-json-1/source-description.d.ts +0 -8
@@ -816,6 +816,7 @@ __webpack_require__.r(__webpack_exports__);
816
816
  /* harmony export */ __webpack_require__.d(__webpack_exports__, {
817
817
  /* harmony export */ Arazzo1DereferenceVisitor: () => (/* reexport safe */ _visitor_ts__WEBPACK_IMPORTED_MODULE_9__["default"]),
818
818
  /* harmony export */ "default": () => (__WEBPACK_DEFAULT_EXPORT__),
819
+ /* harmony export */ dereferenceSourceDescriptions: () => (/* reexport safe */ _source_descriptions_ts__WEBPACK_IMPORTED_MODULE_10__.dereferenceSourceDescriptions),
819
820
  /* harmony export */ maybeRefractToJSONSchemaElement: () => (/* reexport safe */ _util_ts__WEBPACK_IMPORTED_MODULE_11__.maybeRefractToJSONSchemaElement),
820
821
  /* harmony export */ resolveSchema$idField: () => (/* reexport safe */ _util_ts__WEBPACK_IMPORTED_MODULE_12__.resolveSchema$idField),
821
822
  /* harmony export */ resolveSchema$refField: () => (/* reexport safe */ _util_ts__WEBPACK_IMPORTED_MODULE_12__.resolveSchema$refField)
@@ -830,7 +831,7 @@ __webpack_require__.r(__webpack_exports__);
830
831
  /* harmony import */ var _Reference_ts__WEBPACK_IMPORTED_MODULE_7__ = __webpack_require__(98979);
831
832
  /* harmony import */ var _ReferenceSet_ts__WEBPACK_IMPORTED_MODULE_8__ = __webpack_require__(24131);
832
833
  /* harmony import */ var _visitor_ts__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(31843);
833
- /* harmony import */ var _source_description_ts__WEBPACK_IMPORTED_MODULE_10__ = __webpack_require__(99371);
834
+ /* harmony import */ var _source_descriptions_ts__WEBPACK_IMPORTED_MODULE_10__ = __webpack_require__(12586);
834
835
  /* harmony import */ var _util_ts__WEBPACK_IMPORTED_MODULE_11__ = __webpack_require__(91005);
835
836
  /* harmony import */ var _util_ts__WEBPACK_IMPORTED_MODULE_12__ = __webpack_require__(60888);
836
837
 
@@ -908,7 +909,7 @@ class Arazzo1DereferenceStrategy extends _DereferenceStrategy_ts__WEBPACK_IMPORT
908
909
  */
909
910
  const shouldDereferenceSourceDescriptions = options?.dereference?.strategyOpts?.[this.name]?.sourceDescriptions ?? options?.dereference?.strategyOpts?.sourceDescriptions;
910
911
  if (shouldDereferenceSourceDescriptions) {
911
- const sourceDescriptions = await (0,_source_description_ts__WEBPACK_IMPORTED_MODULE_10__.dereferenceSourceDescriptions)(dereferencedElement, reference, options);
912
+ const sourceDescriptions = await (0,_source_descriptions_ts__WEBPACK_IMPORTED_MODULE_10__.dereferenceSourceDescriptions)(dereferencedElement, reference.uri, options, this.name);
912
913
  dereferencedElement.push(...sourceDescriptions);
913
914
  }
914
915
 
@@ -935,11 +936,12 @@ class Arazzo1DereferenceStrategy extends _DereferenceStrategy_ts__WEBPACK_IMPORT
935
936
  }
936
937
 
937
938
 
939
+
938
940
  /* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = (Arazzo1DereferenceStrategy);
939
941
 
940
942
  /***/ },
941
943
 
942
- /***/ 99371
944
+ /***/ 12586
943
945
  (__unused_webpack_module, __webpack_exports__, __webpack_require__) {
944
946
 
945
947
  "use strict";
@@ -949,17 +951,17 @@ __webpack_require__.r(__webpack_exports__);
949
951
  /* harmony export */ });
950
952
  /* harmony import */ var _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(25162);
951
953
  /* harmony import */ var _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(12111);
952
- /* harmony import */ var _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(84660);
953
- /* harmony import */ var _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(4823);
954
- /* harmony import */ var _speclynx_apidom_ns_arazzo_1__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(28839);
955
- /* harmony import */ var _speclynx_apidom_ns_openapi_2__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(26365);
956
- /* harmony import */ var _speclynx_apidom_ns_openapi_3_0__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(32131);
957
- /* harmony import */ var _speclynx_apidom_ns_openapi_3_1__WEBPACK_IMPORTED_MODULE_7__ = __webpack_require__(76332);
958
- /* harmony import */ var _speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_8__ = __webpack_require__(44673);
959
- /* harmony import */ var _util_url_ts__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(30658);
960
- /* harmony import */ var _options_util_ts__WEBPACK_IMPORTED_MODULE_10__ = __webpack_require__(86547);
961
- /* harmony import */ var _index_ts__WEBPACK_IMPORTED_MODULE_11__ = __webpack_require__(42037);
962
-
954
+ /* harmony import */ var _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(96911);
955
+ /* harmony import */ var _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(84660);
956
+ /* harmony import */ var _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(4823);
957
+ /* harmony import */ var _speclynx_apidom_ns_arazzo_1__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(28839);
958
+ /* harmony import */ var _speclynx_apidom_ns_openapi_2__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(26365);
959
+ /* harmony import */ var _speclynx_apidom_ns_openapi_3_0__WEBPACK_IMPORTED_MODULE_7__ = __webpack_require__(32131);
960
+ /* harmony import */ var _speclynx_apidom_ns_openapi_3_1__WEBPACK_IMPORTED_MODULE_8__ = __webpack_require__(76332);
961
+ /* harmony import */ var _speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(44673);
962
+ /* harmony import */ var _util_url_ts__WEBPACK_IMPORTED_MODULE_10__ = __webpack_require__(30658);
963
+ /* harmony import */ var _options_util_ts__WEBPACK_IMPORTED_MODULE_11__ = __webpack_require__(86547);
964
+ /* harmony import */ var _index_ts__WEBPACK_IMPORTED_MODULE_12__ = __webpack_require__(42037);
963
965
 
964
966
 
965
967
 
@@ -969,16 +971,14 @@ __webpack_require__.r(__webpack_exports__);
969
971
 
970
972
 
971
973
 
972
- // shared key for recursion state (works across JSON/YAML documents)
973
- const ARAZZO_DEREFERENCE_RECURSION_KEY = 'arazzo-1';
974
974
  /**
975
975
  * Dereferences a single source description element.
976
976
  * Returns ParseResultElement on success, or with annotation if skipped.
977
977
  */
978
978
  async function dereferenceSourceDescription(sourceDescription, ctx) {
979
- const parseResult = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"]();
980
- if (!(0,_speclynx_apidom_ns_arazzo_1__WEBPACK_IMPORTED_MODULE_4__.isSourceDescriptionElement)(sourceDescription)) {
981
- const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"]('Element is not a valid SourceDescriptionElement. Skipping');
979
+ const parseResult = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_4__["default"]();
980
+ if (!(0,_speclynx_apidom_ns_arazzo_1__WEBPACK_IMPORTED_MODULE_5__.isSourceDescriptionElement)(sourceDescription)) {
981
+ const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"]('Element is not a valid SourceDescriptionElement. Skipping');
982
982
  annotation.classes.push('warning');
983
983
  parseResult.push(annotation);
984
984
  return parseResult;
@@ -988,37 +988,73 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
988
988
  parseResult.classes.push('source-description');
989
989
  if ((0,_speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_0__.isStringElement)(sourceDescription.name)) parseResult.setMetaProperty('name', (0,_speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_1__.cloneDeep)(sourceDescription.name));
990
990
  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));
991
- const sourceDescriptionURI = (0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_8__["default"])(sourceDescription.url);
991
+ const sourceDescriptionURI = (0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_9__["default"])(sourceDescription.url);
992
992
  if (typeof sourceDescriptionURI !== 'string') {
993
- const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"]('Source description URL is missing or not a string. Skipping');
993
+ const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"]('Source description URL is missing or not a string. Skipping');
994
994
  annotation.classes.push('warning');
995
995
  parseResult.push(annotation);
996
996
  return parseResult;
997
997
  }
998
- const retrievalURI = _util_url_ts__WEBPACK_IMPORTED_MODULE_9__.resolve(ctx.baseURI, sourceDescriptionURI);
998
+
999
+ // normalize URI for consistent cycle detection and refSet cache key matching
1000
+ const retrievalURI = _util_url_ts__WEBPACK_IMPORTED_MODULE_10__.sanitize(_util_url_ts__WEBPACK_IMPORTED_MODULE_10__.stripHash(_util_url_ts__WEBPACK_IMPORTED_MODULE_10__.resolve(ctx.baseURI, sourceDescriptionURI)));
999
1001
 
1000
1002
  // skip if already visited (cycle detection)
1001
1003
  if (ctx.visitedUrls.has(retrievalURI)) {
1002
- const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"](`Source description "${retrievalURI}" has already been visited. Skipping to prevent cycle`);
1004
+ const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"](`Source description "${retrievalURI}" has already been visited. Skipping to prevent cycle`);
1003
1005
  annotation.classes.push('warning');
1004
1006
  parseResult.push(annotation);
1005
1007
  return parseResult;
1006
1008
  }
1007
1009
  ctx.visitedUrls.add(retrievalURI);
1010
+
1011
+ // check if source description was already parsed (e.g., during parse phase with sourceDescriptions: true)
1012
+ const existingParseResult = sourceDescription.meta.get('parseResult');
1008
1013
  try {
1009
- const sourceDescriptionDereferenced = await (0,_index_ts__WEBPACK_IMPORTED_MODULE_11__["default"])(retrievalURI, (0,_options_util_ts__WEBPACK_IMPORTED_MODULE_10__.merge)(ctx.options, {
1010
- parse: {
1011
- mediaType: 'text/plain' // allow parser plugin detection
1012
- },
1013
- dereference: {
1014
- strategyOpts: {
1015
- [ARAZZO_DEREFERENCE_RECURSION_KEY]: {
1016
- sourceDescriptionsDepth: ctx.currentDepth + 1,
1017
- sourceDescriptionsVisitedUrls: ctx.visitedUrls
1014
+ let sourceDescriptionDereferenced;
1015
+ if ((0,_speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__.isParseResultElement)(existingParseResult)) {
1016
+ // use existing parsed result - just dereference it (no re-fetch/re-parse)
1017
+ sourceDescriptionDereferenced = await (0,_index_ts__WEBPACK_IMPORTED_MODULE_12__.dereferenceApiDOM)(existingParseResult, (0,_options_util_ts__WEBPACK_IMPORTED_MODULE_11__.merge)(ctx.options, {
1018
+ parse: {
1019
+ mediaType: 'text/plain' // allow dereference strategy detection via ApiDOM inspection
1020
+ },
1021
+ resolve: {
1022
+ baseURI: retrievalURI
1023
+ },
1024
+ dereference: {
1025
+ strategyOpts: {
1026
+ // nested documents should dereference all their source descriptions
1027
+ // (parent's name filter doesn't apply to nested documents)
1028
+ // set at strategy-specific level to override any inherited filters
1029
+ [ctx.strategyName]: {
1030
+ sourceDescriptions: true,
1031
+ sourceDescriptionsDepth: ctx.currentDepth + 1,
1032
+ sourceDescriptionsVisitedUrls: ctx.visitedUrls
1033
+ }
1018
1034
  }
1019
1035
  }
1020
- }
1021
- }));
1036
+ }));
1037
+ } else {
1038
+ // no existing parse result - fetch, parse, and dereference
1039
+ sourceDescriptionDereferenced = await (0,_index_ts__WEBPACK_IMPORTED_MODULE_12__["default"])(retrievalURI, (0,_options_util_ts__WEBPACK_IMPORTED_MODULE_11__.merge)(ctx.options, {
1040
+ parse: {
1041
+ mediaType: 'text/plain' // allow parser plugin detection
1042
+ },
1043
+ dereference: {
1044
+ strategyOpts: {
1045
+ // nested documents should dereference all their source descriptions
1046
+ // (parent's name filter doesn't apply to nested documents)
1047
+ // set at strategy-specific level to override any inherited filters
1048
+ [ctx.strategyName]: {
1049
+ sourceDescriptions: true,
1050
+ sourceDescriptionsDepth: ctx.currentDepth + 1,
1051
+ sourceDescriptionsVisitedUrls: ctx.visitedUrls
1052
+ }
1053
+ }
1054
+ }
1055
+ }));
1056
+ }
1057
+
1022
1058
  // merge dereferenced result into our parse result
1023
1059
  for (const item of sourceDescriptionDereferenced) {
1024
1060
  parseResult.push(item);
@@ -1026,7 +1062,7 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
1026
1062
  } catch (error) {
1027
1063
  // create error annotation instead of failing entire dereference
1028
1064
  const message = error instanceof Error ? error.message : String(error);
1029
- const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"](`Error dereferencing source description "${retrievalURI}": ${message}`);
1065
+ const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"](`Error dereferencing source description "${retrievalURI}": ${message}`);
1030
1066
  annotation.classes.push('error');
1031
1067
  parseResult.push(annotation);
1032
1068
  return parseResult;
@@ -1036,24 +1072,24 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
1036
1072
  const {
1037
1073
  api: sourceDescriptionAPI
1038
1074
  } = parseResult;
1039
- 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);
1040
- const isArazzo = (0,_speclynx_apidom_ns_arazzo_1__WEBPACK_IMPORTED_MODULE_4__.isArazzoSpecification1Element)(sourceDescriptionAPI);
1075
+ const isOpenApi = (0,_speclynx_apidom_ns_openapi_2__WEBPACK_IMPORTED_MODULE_6__.isSwaggerElement)(sourceDescriptionAPI) || (0,_speclynx_apidom_ns_openapi_3_0__WEBPACK_IMPORTED_MODULE_7__.isOpenApi3_0Element)(sourceDescriptionAPI) || (0,_speclynx_apidom_ns_openapi_3_1__WEBPACK_IMPORTED_MODULE_8__.isOpenApi3_1Element)(sourceDescriptionAPI);
1076
+ const isArazzo = (0,_speclynx_apidom_ns_arazzo_1__WEBPACK_IMPORTED_MODULE_5__.isArazzoSpecification1Element)(sourceDescriptionAPI);
1041
1077
  if (!isOpenApi && !isArazzo) {
1042
- const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"](`Source description "${retrievalURI}" is not an OpenAPI or Arazzo document`);
1078
+ const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"](`Source description "${retrievalURI}" is not an OpenAPI or Arazzo document`);
1043
1079
  annotation.classes.push('warning');
1044
1080
  parseResult.push(annotation);
1045
1081
  return parseResult;
1046
1082
  }
1047
1083
 
1048
1084
  // validate declared type matches actual dereferenced type
1049
- const declaredType = (0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_8__["default"])(sourceDescription.type);
1085
+ const declaredType = (0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_9__["default"])(sourceDescription.type);
1050
1086
  if (typeof declaredType === 'string') {
1051
1087
  if (declaredType === 'openapi' && !isOpenApi) {
1052
- const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"](`Source description "${retrievalURI}" declared as "openapi" but dereferenced as Arazzo document`);
1088
+ const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"](`Source description "${retrievalURI}" declared as "openapi" but dereferenced as Arazzo document`);
1053
1089
  annotation.classes.push('warning');
1054
1090
  parseResult.push(annotation);
1055
1091
  } else if (declaredType === 'arazzo' && !isArazzo) {
1056
- const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"](`Source description "${retrievalURI}" declared as "arazzo" but dereferenced as OpenAPI document`);
1092
+ const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"](`Source description "${retrievalURI}" declared as "arazzo" but dereferenced as OpenAPI document`);
1057
1093
  annotation.classes.push('warning');
1058
1094
  parseResult.push(annotation);
1059
1095
  }
@@ -1063,11 +1099,45 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
1063
1099
 
1064
1100
  /**
1065
1101
  * Dereferences source descriptions from an Arazzo document.
1102
+ *
1103
+ * Each source description result is attached to its corresponding
1104
+ * SourceDescriptionElement's meta as 'parseResult' for easy access,
1105
+ * regardless of success or failure. On failure, the ParseResultElement
1106
+ * contains annotations explaining what went wrong.
1107
+ *
1108
+ * @param parseResult - ParseResult containing a parsed (optionally dereferenced) Arazzo specification
1109
+ * @param parseResultRetrievalURI - URI from which the parseResult was retrieved
1110
+ * @param options - Full ReferenceOptions. Pass `sourceDescriptions` as an array of names
1111
+ * in `dereference.strategyOpts` to filter which source descriptions to process.
1112
+ * @param strategyName - Strategy name for options lookup (defaults to 'arazzo-1')
1113
+ * @returns Array of ParseResultElements. Returns one ParseResultElement per source description
1114
+ * (each with class 'source-description' and name/type metadata).
1115
+ * May return early with a single-element array containing a warning annotation when:
1116
+ * - The API is not an Arazzo specification
1117
+ * - The sourceDescriptions field is missing or not an array
1118
+ * - Maximum dereference depth is exceeded (error annotation)
1119
+ * Returns an empty array when no source description names match the filter.
1120
+ *
1121
+ * @example
1122
+ * ```typescript
1123
+ * // Dereference all source descriptions
1124
+ * await dereferenceSourceDescriptions(parseResult, uri, options);
1125
+ *
1126
+ * // Filter by name
1127
+ * await dereferenceSourceDescriptions(parseResult, uri, mergeOptions(options, {
1128
+ * dereference: { strategyOpts: { sourceDescriptions: ['petStore'] } },
1129
+ * }));
1130
+ *
1131
+ * // Access dereferenced document from source description element
1132
+ * const sourceDesc = parseResult.api.sourceDescriptions.get(0);
1133
+ * const dereferencedDoc = sourceDesc.meta.get('parseResult');
1134
+ * ```
1135
+ *
1066
1136
  * @public
1067
1137
  */
1068
- async function dereferenceSourceDescriptions(parseResult, reference, options) {
1138
+ async function dereferenceSourceDescriptions(parseResult, parseResultRetrievalURI, options, strategyName = 'arazzo-1') {
1139
+ const baseURI = _util_url_ts__WEBPACK_IMPORTED_MODULE_10__.sanitize(_util_url_ts__WEBPACK_IMPORTED_MODULE_10__.stripHash(parseResultRetrievalURI));
1069
1140
  const results = [];
1070
- const strategyName = 'arazzo-1';
1071
1141
 
1072
1142
  // get API from dereferenced parse result
1073
1143
  const {
@@ -1078,57 +1148,55 @@ async function dereferenceSourceDescriptions(parseResult, reference, options) {
1078
1148
  * Validate prerequisites for dereferencing source descriptions.
1079
1149
  * Return warning annotations if validation fails.
1080
1150
  */
1081
- if (!(0,_speclynx_apidom_ns_arazzo_1__WEBPACK_IMPORTED_MODULE_4__.isArazzoSpecification1Element)(api)) {
1082
- const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"]('Cannot dereference source descriptions: API is not an Arazzo specification');
1151
+ if (!(0,_speclynx_apidom_ns_arazzo_1__WEBPACK_IMPORTED_MODULE_5__.isArazzoSpecification1Element)(api)) {
1152
+ const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"]('Cannot dereference source descriptions: API is not an Arazzo specification');
1083
1153
  annotation.classes.push('warning');
1084
- return [new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"]([annotation])];
1154
+ return [new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_4__["default"]([annotation])];
1085
1155
  }
1086
1156
  if (!(0,_speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_0__.isArrayElement)(api.sourceDescriptions)) {
1087
- const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"]('Cannot dereference source descriptions: sourceDescriptions field is missing or not an array');
1157
+ const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"]('Cannot dereference source descriptions: sourceDescriptions field is missing or not an array');
1088
1158
  annotation.classes.push('warning');
1089
- return [new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"]([annotation])];
1159
+ return [new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_4__["default"]([annotation])];
1090
1160
  }
1091
1161
 
1092
1162
  // user config: strategy-specific options take precedence over global strategyOpts
1093
1163
  const maxDepth = options?.dereference?.strategyOpts?.[strategyName]?.sourceDescriptionsMaxDepth ?? options?.dereference?.strategyOpts?.sourceDescriptionsMaxDepth ?? +Infinity;
1094
1164
 
1095
- // recursion state comes from shared key (works across JSON/YAML)
1096
- const sharedOpts = options?.dereference?.strategyOpts?.[ARAZZO_DEREFERENCE_RECURSION_KEY] ?? {};
1165
+ // recursion state comes from strategy-specific options
1166
+ const sharedOpts = options?.dereference?.strategyOpts?.[strategyName] ?? {};
1097
1167
  const currentDepth = sharedOpts.sourceDescriptionsDepth ?? 0;
1098
1168
  const visitedUrls = sharedOpts.sourceDescriptionsVisitedUrls ?? new Set();
1099
1169
 
1100
1170
  // add current file to visited URLs to prevent cycles
1101
- visitedUrls.add(reference.uri);
1171
+ visitedUrls.add(baseURI);
1102
1172
  if (currentDepth >= maxDepth) {
1103
- const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_2__["default"](`Maximum dereference depth of ${maxDepth} has been exceeded by file "${reference.uri}"`);
1173
+ const annotation = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"](`Maximum dereference depth of ${maxDepth} has been exceeded by file "${baseURI}"`);
1104
1174
  annotation.classes.push('error');
1105
- const parseResult = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_3__["default"]([annotation]);
1175
+ const parseResult = new _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_4__["default"]([annotation]);
1106
1176
  parseResult.classes.push('source-description');
1107
1177
  return [parseResult];
1108
1178
  }
1109
1179
  const ctx = {
1110
- baseURI: reference.uri,
1180
+ baseURI,
1111
1181
  options,
1182
+ strategyName,
1112
1183
  currentDepth,
1113
1184
  visitedUrls
1114
1185
  };
1115
1186
 
1116
- // determine which source descriptions to dereference
1187
+ // determine which source descriptions to dereference (array filters by name)
1117
1188
  const sourceDescriptionsOption = options?.dereference?.strategyOpts?.[strategyName]?.sourceDescriptions ?? options?.dereference?.strategyOpts?.sourceDescriptions;
1118
-
1119
- // handle false or other falsy values - no source descriptions should be dereferenced
1120
- if (!sourceDescriptionsOption) {
1121
- return results;
1122
- }
1123
1189
  const sourceDescriptions = Array.isArray(sourceDescriptionsOption) ? api.sourceDescriptions.filter(sd => {
1124
- if (!(0,_speclynx_apidom_ns_arazzo_1__WEBPACK_IMPORTED_MODULE_4__.isSourceDescriptionElement)(sd)) return false;
1125
- const name = (0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_8__["default"])(sd.name);
1190
+ if (!(0,_speclynx_apidom_ns_arazzo_1__WEBPACK_IMPORTED_MODULE_5__.isSourceDescriptionElement)(sd)) return false;
1191
+ const name = (0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_9__["default"])(sd.name);
1126
1192
  return typeof name === 'string' && sourceDescriptionsOption.includes(name);
1127
1193
  }) : api.sourceDescriptions;
1128
1194
 
1129
1195
  // process sequentially to ensure proper cycle detection with shared visitedUrls
1130
1196
  for (const sourceDescription of sourceDescriptions) {
1131
1197
  const sourceDescriptionDereferenceResult = await dereferenceSourceDescription(sourceDescription, ctx);
1198
+ // always attach result (even on failure - contains annotations)
1199
+ sourceDescription.meta.set('parseResult', sourceDescriptionDereferenceResult);
1132
1200
  results.push(sourceDescriptionDereferenceResult);
1133
1201
  }
1134
1202
  return results;
@@ -5704,14 +5772,15 @@ class ApiDOMJSONParser extends _Parser_ts__WEBPACK_IMPORTED_MODULE_4__["default"
5704
5772
  "use strict";
5705
5773
  __webpack_require__.r(__webpack_exports__);
5706
5774
  /* harmony export */ __webpack_require__.d(__webpack_exports__, {
5707
- /* harmony export */ "default": () => (__WEBPACK_DEFAULT_EXPORT__)
5775
+ /* harmony export */ "default": () => (__WEBPACK_DEFAULT_EXPORT__),
5776
+ /* harmony export */ parseSourceDescriptions: () => (/* reexport safe */ _source_descriptions_ts__WEBPACK_IMPORTED_MODULE_5__.parseSourceDescriptions)
5708
5777
  /* harmony export */ });
5709
5778
  /* harmony import */ var ramda__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(14494);
5710
5779
  /* harmony import */ var _speclynx_apidom_parser_adapter_arazzo_json_1__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(6017);
5711
5780
  /* harmony import */ var _speclynx_apidom_parser_adapter_arazzo_json_1__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(29028);
5712
5781
  /* harmony import */ var _errors_ParserError_ts__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(89371);
5713
5782
  /* harmony import */ var _Parser_ts__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(13166);
5714
- /* harmony import */ var _source_description_ts__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(69848);
5783
+ /* harmony import */ var _source_descriptions_ts__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(61407);
5715
5784
 
5716
5785
 
5717
5786
 
@@ -5757,7 +5826,7 @@ class ArazzoJSON1Parser extends _Parser_ts__WEBPACK_IMPORTED_MODULE_4__["default
5757
5826
  const parseResult = await (0,_speclynx_apidom_parser_adapter_arazzo_json_1__WEBPACK_IMPORTED_MODULE_1__.parse)(source, parserOpts);
5758
5827
  const shouldParseSourceDescriptions = options?.parse?.parserOpts?.[this.name]?.sourceDescriptions ?? options?.parse?.parserOpts?.sourceDescriptions;
5759
5828
  if (shouldParseSourceDescriptions) {
5760
- const sourceDescriptions = await (0,_source_description_ts__WEBPACK_IMPORTED_MODULE_5__.parseSourceDescriptions)(this.name, parseResult.api, file, options);
5829
+ const sourceDescriptions = await (0,_source_descriptions_ts__WEBPACK_IMPORTED_MODULE_5__.parseSourceDescriptions)(parseResult, file.uri, options, this.name);
5761
5830
  parseResult.push(...sourceDescriptions);
5762
5831
  }
5763
5832
  return parseResult;
@@ -5768,11 +5837,12 @@ class ArazzoJSON1Parser extends _Parser_ts__WEBPACK_IMPORTED_MODULE_4__["default
5768
5837
  }
5769
5838
  }
5770
5839
  }
5840
+
5771
5841
  /* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = (ArazzoJSON1Parser);
5772
5842
 
5773
5843
  /***/ },
5774
5844
 
5775
- /***/ 69848
5845
+ /***/ 61407
5776
5846
  (__unused_webpack_module, __webpack_exports__, __webpack_require__) {
5777
5847
 
5778
5848
  "use strict";
@@ -5789,9 +5859,11 @@ __webpack_require__.r(__webpack_exports__);
5789
5859
  /* harmony import */ var _speclynx_apidom_ns_openapi_3_0__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(32131);
5790
5860
  /* harmony import */ var _speclynx_apidom_ns_openapi_3_1__WEBPACK_IMPORTED_MODULE_7__ = __webpack_require__(76332);
5791
5861
  /* harmony import */ var _speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_8__ = __webpack_require__(44673);
5792
- /* harmony import */ var _util_url_ts__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(30658);
5793
- /* harmony import */ var _options_util_ts__WEBPACK_IMPORTED_MODULE_10__ = __webpack_require__(86547);
5794
- /* harmony import */ var _index_ts__WEBPACK_IMPORTED_MODULE_11__ = __webpack_require__(35014);
5862
+ /* harmony import */ var _File_ts__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(10682);
5863
+ /* harmony import */ var _util_url_ts__WEBPACK_IMPORTED_MODULE_10__ = __webpack_require__(30658);
5864
+ /* harmony import */ var _options_util_ts__WEBPACK_IMPORTED_MODULE_11__ = __webpack_require__(86547);
5865
+ /* harmony import */ var _index_ts__WEBPACK_IMPORTED_MODULE_12__ = __webpack_require__(35014);
5866
+
5795
5867
 
5796
5868
 
5797
5869
 
@@ -5828,7 +5900,9 @@ async function parseSourceDescription(sourceDescription, ctx) {
5828
5900
  parseResult.push(annotation);
5829
5901
  return parseResult;
5830
5902
  }
5831
- const retrievalURI = _util_url_ts__WEBPACK_IMPORTED_MODULE_9__.resolve(ctx.baseURI, sourceDescriptionURI);
5903
+
5904
+ // normalize URI for consistent cycle detection and cache key matching
5905
+ const retrievalURI = _util_url_ts__WEBPACK_IMPORTED_MODULE_10__.sanitize(_util_url_ts__WEBPACK_IMPORTED_MODULE_10__.stripHash(_util_url_ts__WEBPACK_IMPORTED_MODULE_10__.resolve(ctx.baseURI, sourceDescriptionURI)));
5832
5906
 
5833
5907
  // skip if already visited (cycle detection)
5834
5908
  if (ctx.visitedUrls.has(retrievalURI)) {
@@ -5839,11 +5913,14 @@ async function parseSourceDescription(sourceDescription, ctx) {
5839
5913
  }
5840
5914
  ctx.visitedUrls.add(retrievalURI);
5841
5915
  try {
5842
- const sdParseResult = await (0,_index_ts__WEBPACK_IMPORTED_MODULE_11__["default"])(retrievalURI, (0,_options_util_ts__WEBPACK_IMPORTED_MODULE_10__.merge)(ctx.options, {
5916
+ const sourceDescriptionParseResult = await (0,_index_ts__WEBPACK_IMPORTED_MODULE_12__["default"])(retrievalURI, (0,_options_util_ts__WEBPACK_IMPORTED_MODULE_11__.merge)(ctx.options, {
5843
5917
  parse: {
5844
5918
  mediaType: 'text/plain',
5845
5919
  // allow parser plugin detection
5846
5920
  parserOpts: {
5921
+ // nested documents should parse all their source descriptions
5922
+ // (parent's name filter doesn't apply to nested documents)
5923
+ sourceDescriptions: true,
5847
5924
  [ARAZZO_RECURSION_KEY]: {
5848
5925
  sourceDescriptionsDepth: ctx.currentDepth + 1,
5849
5926
  sourceDescriptionsVisitedUrls: ctx.visitedUrls
@@ -5852,7 +5929,7 @@ async function parseSourceDescription(sourceDescription, ctx) {
5852
5929
  }
5853
5930
  }));
5854
5931
  // merge parsed result into our parse result
5855
- for (const item of sdParseResult) {
5932
+ for (const item of sourceDescriptionParseResult) {
5856
5933
  parseResult.push(item);
5857
5934
  }
5858
5935
  } catch (error) {
@@ -5894,10 +5971,53 @@ async function parseSourceDescription(sourceDescription, ctx) {
5894
5971
  }
5895
5972
 
5896
5973
  /**
5897
- * Shared function for parsing source descriptions.
5974
+ * Parses source descriptions from an Arazzo document's ParseResult.
5975
+ *
5976
+ * Each source description result is attached to its corresponding
5977
+ * SourceDescriptionElement's meta as 'parseResult' for easy access,
5978
+ * regardless of success or failure. On failure, the ParseResultElement
5979
+ * contains annotations explaining what went wrong.
5980
+ *
5981
+ * @param parseResult - ParseResult containing an Arazzo specification
5982
+ * @param parseResultRetrievalURI - URI from which the parseResult was retrieved
5983
+ * @param options - Full ReferenceOptions. Pass `sourceDescriptions` as an array of names
5984
+ * in `parse.parserOpts` to filter which source descriptions to process.
5985
+ * @param parserName - Parser name for options lookup (defaults to 'arazzo-json-1')
5986
+ * @returns Array of ParseResultElements. Returns one ParseResultElement per source description
5987
+ * (each with class 'source-description' and name/type metadata).
5988
+ * May return early with a single-element array containing a warning annotation when:
5989
+ * - The API is not an Arazzo specification
5990
+ * - The sourceDescriptions field is missing or not an array
5991
+ * - Maximum parse depth is exceeded (error annotation)
5992
+ * Returns an empty array when no source description names match the filter.
5993
+ *
5994
+ * @example
5995
+ * ```typescript
5996
+ * import { options, mergeOptions } from '@speclynx/apidom-reference';
5997
+ * import { parseSourceDescriptions } from '@speclynx/apidom-reference/parse/parsers/arazzo-json-1';
5998
+ *
5999
+ * // Parse all source descriptions
6000
+ * const results = await parseSourceDescriptions(parseResult, uri, options);
6001
+ *
6002
+ * // Filter by name
6003
+ * const filtered = await parseSourceDescriptions(parseResult, uri, mergeOptions(options, {
6004
+ * parse: { parserOpts: { sourceDescriptions: ['petStore'] } }
6005
+ * }));
6006
+ *
6007
+ * // Access parsed document from source description element
6008
+ * const sourceDesc = parseResult.api.sourceDescriptions.get(0);
6009
+ * const parsedDoc = sourceDesc.meta.get('parseResult');
6010
+ * ```
6011
+ *
5898
6012
  * @public
5899
6013
  */
5900
- async function parseSourceDescriptions(parserName, api, file, options) {
6014
+ async function parseSourceDescriptions(parseResult, parseResultRetrievalURI, options, parserName = 'arazzo-json-1') {
6015
+ const {
6016
+ api
6017
+ } = parseResult;
6018
+ const file = new _File_ts__WEBPACK_IMPORTED_MODULE_9__["default"]({
6019
+ uri: _util_url_ts__WEBPACK_IMPORTED_MODULE_10__.sanitize(_util_url_ts__WEBPACK_IMPORTED_MODULE_10__.stripHash(parseResultRetrievalURI))
6020
+ });
5901
6021
  const results = [];
5902
6022
 
5903
6023
  /**
@@ -5939,13 +6059,8 @@ async function parseSourceDescriptions(parserName, api, file, options) {
5939
6059
  visitedUrls
5940
6060
  };
5941
6061
 
5942
- // determine which source descriptions to parse
6062
+ // determine which source descriptions to parse (array filters by name)
5943
6063
  const sourceDescriptionsOption = options?.parse?.parserOpts?.[parserName]?.sourceDescriptions ?? options?.parse?.parserOpts?.sourceDescriptions;
5944
-
5945
- // handle false or other falsy values - no source descriptions should be parsed
5946
- if (!sourceDescriptionsOption) {
5947
- return results;
5948
- }
5949
6064
  const sourceDescriptions = Array.isArray(sourceDescriptionsOption) ? api.sourceDescriptions.filter(sd => {
5950
6065
  if (!(0,_speclynx_apidom_ns_arazzo_1__WEBPACK_IMPORTED_MODULE_4__.isSourceDescriptionElement)(sd)) return false;
5951
6066
  const name = (0,_speclynx_apidom_core__WEBPACK_IMPORTED_MODULE_8__["default"])(sd.name);
@@ -5955,6 +6070,8 @@ async function parseSourceDescriptions(parserName, api, file, options) {
5955
6070
  // process sequentially to ensure proper cycle detection with shared visitedUrls
5956
6071
  for (const sourceDescription of sourceDescriptions) {
5957
6072
  const sourceDescriptionParseResult = await parseSourceDescription(sourceDescription, ctx);
6073
+ // always attach result (even on failure - contains annotations)
6074
+ sourceDescription.meta.set('parseResult', sourceDescriptionParseResult);
5958
6075
  results.push(sourceDescriptionParseResult);
5959
6076
  }
5960
6077
  return results;
@@ -5968,14 +6085,15 @@ async function parseSourceDescriptions(parserName, api, file, options) {
5968
6085
  "use strict";
5969
6086
  __webpack_require__.r(__webpack_exports__);
5970
6087
  /* harmony export */ __webpack_require__.d(__webpack_exports__, {
5971
- /* harmony export */ "default": () => (__WEBPACK_DEFAULT_EXPORT__)
6088
+ /* harmony export */ "default": () => (__WEBPACK_DEFAULT_EXPORT__),
6089
+ /* harmony export */ parseSourceDescriptions: () => (/* reexport safe */ _source_descriptions_ts__WEBPACK_IMPORTED_MODULE_5__.parseSourceDescriptions)
5972
6090
  /* harmony export */ });
5973
6091
  /* harmony import */ var ramda__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(14494);
5974
6092
  /* harmony import */ var _speclynx_apidom_parser_adapter_arazzo_yaml_1__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(16206);
5975
6093
  /* harmony import */ var _speclynx_apidom_parser_adapter_arazzo_yaml_1__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(43195);
5976
6094
  /* harmony import */ var _errors_ParserError_ts__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(89371);
5977
6095
  /* harmony import */ var _Parser_ts__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(13166);
5978
- /* harmony import */ var _arazzo_json_1_source_description_ts__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(69848);
6096
+ /* harmony import */ var _source_descriptions_ts__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(97782);
5979
6097
 
5980
6098
 
5981
6099
 
@@ -6021,7 +6139,7 @@ class ArazzoYAML1Parser extends _Parser_ts__WEBPACK_IMPORTED_MODULE_4__["default
6021
6139
  const parseResult = await (0,_speclynx_apidom_parser_adapter_arazzo_yaml_1__WEBPACK_IMPORTED_MODULE_1__.parse)(source, parserOpts);
6022
6140
  const shouldParseSourceDescriptions = options?.parse?.parserOpts?.[this.name]?.sourceDescriptions ?? options?.parse?.parserOpts?.sourceDescriptions;
6023
6141
  if (shouldParseSourceDescriptions) {
6024
- const sourceDescriptions = await (0,_arazzo_json_1_source_description_ts__WEBPACK_IMPORTED_MODULE_5__.parseSourceDescriptions)(this.name, parseResult.api, file, options);
6142
+ const sourceDescriptions = await (0,_source_descriptions_ts__WEBPACK_IMPORTED_MODULE_5__.parseSourceDescriptions)(parseResult, file.uri, options, this.name);
6025
6143
  parseResult.push(...sourceDescriptions);
6026
6144
  }
6027
6145
  return parseResult;
@@ -6032,10 +6150,30 @@ class ArazzoYAML1Parser extends _Parser_ts__WEBPACK_IMPORTED_MODULE_4__["default
6032
6150
  }
6033
6151
  }
6034
6152
  }
6153
+
6035
6154
  /* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = (ArazzoYAML1Parser);
6036
6155
 
6037
6156
  /***/ },
6038
6157
 
6158
+ /***/ 97782
6159
+ (__unused_webpack_module, __webpack_exports__, __webpack_require__) {
6160
+
6161
+ "use strict";
6162
+ __webpack_require__.r(__webpack_exports__);
6163
+ /* harmony export */ __webpack_require__.d(__webpack_exports__, {
6164
+ /* harmony export */ parseSourceDescriptions: () => (/* binding */ parseSourceDescriptions)
6165
+ /* harmony export */ });
6166
+ /* harmony import */ var _arazzo_json_1_source_descriptions_ts__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(61407);
6167
+
6168
+ /**
6169
+ * @public
6170
+ */
6171
+ const parseSourceDescriptions = (parseResult, parseResultRetrievalURI, options, parserName = 'arazzo-yaml-1') => {
6172
+ return (0,_arazzo_json_1_source_descriptions_ts__WEBPACK_IMPORTED_MODULE_0__.parseSourceDescriptions)(parseResult, parseResultRetrievalURI, options, parserName);
6173
+ };
6174
+
6175
+ /***/ },
6176
+
6039
6177
  /***/ 35844
6040
6178
  (__unused_webpack_module, __webpack_exports__, __webpack_require__) {
6041
6179