@speclynx/apidom-reference 5.1.1 → 5.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-reference",
-  "version": "5.1.1",
+  "version": "5.2.2",
   "description": "Advanced algorithms for semantic ApiDOM manipulations like dereferencing or resolution.",
   "keywords": [
     "apidom",
@@ -299,35 +299,35 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^8.0.0",
-    "@speclynx/apidom-core": "5.1.1",
-    "@speclynx/apidom-datamodel": "5.1.1",
-    "@speclynx/apidom-error": "5.1.1",
-    "@speclynx/apidom-json-pointer": "5.1.1",
-    "@speclynx/apidom-ns-arazzo-1": "5.1.1",
-    "@speclynx/apidom-ns-asyncapi-2": "5.1.1",
-    "@speclynx/apidom-ns-json-schema-2020-12": "5.1.1",
-    "@speclynx/apidom-ns-openapi-2": "5.1.1",
-    "@speclynx/apidom-ns-openapi-3-0": "5.1.1",
-    "@speclynx/apidom-ns-openapi-3-1": "5.1.1",
-    "@speclynx/apidom-ns-overlay-1": "5.1.1",
-    "@speclynx/apidom-parser-adapter-arazzo-json-1": "5.1.1",
-    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "5.1.1",
-    "@speclynx/apidom-parser-adapter-asyncapi-json-2": "5.1.1",
-    "@speclynx/apidom-parser-adapter-asyncapi-yaml-2": "5.1.1",
-    "@speclynx/apidom-parser-adapter-json": "5.1.1",
-    "@speclynx/apidom-parser-adapter-openapi-json-2": "5.1.1",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "5.1.1",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "5.1.1",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "5.1.1",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "5.1.1",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "5.1.1",
-    "@speclynx/apidom-parser-adapter-overlay-json-1": "5.1.1",
-    "@speclynx/apidom-parser-adapter-overlay-yaml-1": "5.1.1",
-    "@speclynx/apidom-parser-adapter-yaml-1-2": "5.1.1",
-    "@speclynx/apidom-traverse": "5.1.1",
-    "@swaggerexpert/arazzo-runtime-expression": "^3.1.0",
-    "axios": "^1.19.0",
-    "picomatch": "^4.0.5",
+    "@speclynx/apidom-core": "5.2.2",
+    "@speclynx/apidom-datamodel": "5.2.2",
+    "@speclynx/apidom-error": "5.2.2",
+    "@speclynx/apidom-json-pointer": "5.2.2",
+    "@speclynx/apidom-ns-arazzo-1": "5.2.2",
+    "@speclynx/apidom-ns-asyncapi-2": "5.2.2",
+    "@speclynx/apidom-ns-json-schema-2020-12": "5.2.2",
+    "@speclynx/apidom-ns-openapi-2": "5.2.2",
+    "@speclynx/apidom-ns-openapi-3-0": "5.2.2",
+    "@speclynx/apidom-ns-openapi-3-1": "5.2.2",
+    "@speclynx/apidom-ns-overlay-1": "5.2.2",
+    "@speclynx/apidom-parser-adapter-arazzo-json-1": "5.2.2",
+    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "5.2.2",
+    "@speclynx/apidom-parser-adapter-asyncapi-json-2": "5.2.2",
+    "@speclynx/apidom-parser-adapter-asyncapi-yaml-2": "5.2.2",
+    "@speclynx/apidom-parser-adapter-json": "5.2.2",
+    "@speclynx/apidom-parser-adapter-openapi-json-2": "5.2.2",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "5.2.2",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "5.2.2",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "5.2.2",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "5.2.2",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "5.2.2",
+    "@speclynx/apidom-parser-adapter-overlay-json-1": "5.2.2",
+    "@speclynx/apidom-parser-adapter-overlay-yaml-1": "5.2.2",
+    "@speclynx/apidom-parser-adapter-yaml-1-2": "5.2.2",
+    "@speclynx/apidom-traverse": "5.2.2",
+    "@swaggerexpert/arazzo-runtime-expression": "^3.2.0",
+    "axios": "^1.20.0",
+    "picomatch": "^4.0.7",
     "process": "^0.11.10",
     "ramda": "~0.32.0",
     "ramda-adjunct": "^6.1.0"
@@ -346,5 +346,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "b661f6f038953d118ad09eec0d7da7927db46f5c"
+  "gitHead": "2d0e035bf82913a9870ff7b26069e784e2a0e9a3"
 }

package/src/bundle/strategies/arazzo-1/visitor.cjs

@@ -43,6 +43,13 @@ const cf = (0, _apidomCore.fixedFields)(_apidomNsArazzo.ComponentsElement, {
  */
 class Arazzo1BundleVisitor {
   reference;
+
+  /**
+   * Base URI of the current document for resolving relative references.
+   * Honors the Arazzo `$self` field when present, otherwise falls back
+   * to the retrieval URI (`this.reference.uri`).
+   */
+  baseURI;
   options;
 
   /**
@@ -81,12 +88,13 @@ class Arazzo1BundleVisitor {
     reservedNames = new Map()
   }) {
     this.reference = reference;
+    this.baseURI = (0, _util.resolveArazzo$selfField)(reference.uri, reference.value?.result);
     this.options = options;
     this.assignments = assignments;
     this.reservedNames = reservedNames;
   }
   toBaseURI(uri) {
-    return url.resolve(this.reference.uri, url.sanitize(url.stripHash(uri)));
+    return url.resolve(this.baseURI, url.sanitize(url.stripHash(uri)));
   }
   async toReference(uri) {
     // detect maximum depth of resolution
@@ -105,6 +113,12 @@ class Arazzo1BundleVisitor {
     if (refSet.has(baseURI)) {
       return refSet.find(ref => ref.uri === baseURI);
     }
+
+    // identity-based referencing: URI matches `$self` of an already processed Arazzo document
+    const referenceBy$self = refSet.find((0, _util.identifiedBy$self)(baseURI));
+    if (referenceBy$self !== undefined) {
+      return referenceBy$self;
+    }
     const parseResult = await (0, _index.default)(url.unsanitize(baseURI), {
       ...this.options,
       parse: {
@@ -279,19 +293,18 @@ class Arazzo1BundleVisitor {
     }
     const $ref = (0, _apidomCore.toValue)(referencingElement.$ref);
     try {
-      // compute baseURI using rules around $id and $ref keywords. The current
-      // document's URI is the retrieval URI — derive it directly (not via
-      // toReference) so an internal $ref needs no resolution and never trips the
+      // compute baseURI using rules around $self, $id and $ref keywords. The
+      // current document's base URI is derived directly (not via toReference)
+      // so an internal $ref needs no resolution and never trips the
       // resolve.maxDepth guard.
-      const retrievalURI = this.reference.uri;
-      const $refBaseURI = (0, _util.resolveSchema$refField)(retrievalURI, referencingElement);
+      const $refBaseURI = (0, _util.resolveSchema$refField)(this.baseURI, referencingElement);
       const $refBaseURIStrippedHash = url.stripHash($refBaseURI);
       const file = new _File.default({
         uri: $refBaseURIStrippedHash
       });
       const isUnknownURI = (0, _ramda.none)(r => r.canRead(file), this.options.resolve.resolvers);
       const isURL = !isUnknownURI;
-      const isInternalReference = url.stripHash(this.reference.uri) === $refBaseURIStrippedHash;
+      const isInternalReference = this.baseURI === $refBaseURIStrippedHash;
       const isExternalReference = !isInternalReference;
 
       // internal Schema Object $refs resolve against the in-document $id graph;
@@ -345,7 +358,10 @@ class Arazzo1BundleVisitor {
       // is internal even when its URI form (e.g. a URN or absolute $id) is not a
       // bare fragment. Leave it untouched — it resolves against the in-document
       // $id graph, and embedding the current document into itself would be wrong.
-      if (url.stripHash(schemaReference.uri) === url.stripHash(this.reference.uri)) {
+      // The same holds for a $ref resolving into the entry document (e.g. by its
+      // `$self` identity) — it's already part of the bundle.
+      const schemaReferenceURI = url.stripHash(schemaReference.uri);
+      if (schemaReferenceURI === url.stripHash(this.reference.uri) || schemaReferenceURI === url.stripHash(this.reference.refSet.rootRef.uri)) {
         return;
       }
 

package/src/bundle/strategies/arazzo-1/visitor.mjs

@@ -15,7 +15,7 @@ import Reference from "../../../Reference.mjs";
 import File from "../../../File.mjs";
 import { isAnchor, uriToAnchor, evaluate as $anchorEvaluate } from "../../../dereference/strategies/arazzo-1/selectors/$anchor.mjs";
 import { evaluate as uriEvaluate } from "../../../dereference/strategies/arazzo-1/selectors/uri.mjs";
-import { resolveSchema$refField, resolveSchema$idField, maybeRefractToJSONSchemaElement } from "../../../dereference/strategies/arazzo-1/util.mjs";
+import { resolveSchema$refField, resolveSchema$idField, maybeRefractToJSONSchemaElement, resolveArazzo$selfField, identifiedBy$self } from "../../../dereference/strategies/arazzo-1/util.mjs";
 import { toPascalCase, sanitizeComponentName, uniqueName as resolveUniqueName } from "../../util.mjs";
 /**
  * The Components Object field where embedded JSON Schema resources are hoisted.
@@ -35,6 +35,13 @@ const cf = fixedFields(ComponentsElement, {
  */
 class Arazzo1BundleVisitor {
   reference;
+
+  /**
+   * Base URI of the current document for resolving relative references.
+   * Honors the Arazzo `$self` field when present, otherwise falls back
+   * to the retrieval URI (`this.reference.uri`).
+   */
+  baseURI;
   options;
 
   /**
@@ -73,12 +80,13 @@ class Arazzo1BundleVisitor {
     reservedNames = new Map()
   }) {
     this.reference = reference;
+    this.baseURI = resolveArazzo$selfField(reference.uri, reference.value?.result);
     this.options = options;
     this.assignments = assignments;
     this.reservedNames = reservedNames;
   }
   toBaseURI(uri) {
-    return url.resolve(this.reference.uri, url.sanitize(url.stripHash(uri)));
+    return url.resolve(this.baseURI, url.sanitize(url.stripHash(uri)));
   }
   async toReference(uri) {
     // detect maximum depth of resolution
@@ -97,6 +105,12 @@ class Arazzo1BundleVisitor {
     if (refSet.has(baseURI)) {
       return refSet.find(ref => ref.uri === baseURI);
     }
+
+    // identity-based referencing: URI matches `$self` of an already processed Arazzo document
+    const referenceBy$self = refSet.find(identifiedBy$self(baseURI));
+    if (referenceBy$self !== undefined) {
+      return referenceBy$self;
+    }
     const parseResult = await parse(url.unsanitize(baseURI), {
       ...this.options,
       parse: {
@@ -271,19 +285,18 @@ class Arazzo1BundleVisitor {
     }
     const $ref = toValue(referencingElement.$ref);
     try {
-      // compute baseURI using rules around $id and $ref keywords. The current
-      // document's URI is the retrieval URI — derive it directly (not via
-      // toReference) so an internal $ref needs no resolution and never trips the
+      // compute baseURI using rules around $self, $id and $ref keywords. The
+      // current document's base URI is derived directly (not via toReference)
+      // so an internal $ref needs no resolution and never trips the
       // resolve.maxDepth guard.
-      const retrievalURI = this.reference.uri;
-      const $refBaseURI = resolveSchema$refField(retrievalURI, referencingElement);
+      const $refBaseURI = resolveSchema$refField(this.baseURI, referencingElement);
       const $refBaseURIStrippedHash = url.stripHash($refBaseURI);
       const file = new File({
         uri: $refBaseURIStrippedHash
       });
       const isUnknownURI = none(r => r.canRead(file), this.options.resolve.resolvers);
       const isURL = !isUnknownURI;
-      const isInternalReference = url.stripHash(this.reference.uri) === $refBaseURIStrippedHash;
+      const isInternalReference = this.baseURI === $refBaseURIStrippedHash;
       const isExternalReference = !isInternalReference;
 
       // internal Schema Object $refs resolve against the in-document $id graph;
@@ -337,7 +350,10 @@ class Arazzo1BundleVisitor {
       // is internal even when its URI form (e.g. a URN or absolute $id) is not a
       // bare fragment. Leave it untouched — it resolves against the in-document
       // $id graph, and embedding the current document into itself would be wrong.
-      if (url.stripHash(schemaReference.uri) === url.stripHash(this.reference.uri)) {
+      // The same holds for a $ref resolving into the entry document (e.g. by its
+      // `$self` identity) — it's already part of the bundle.
+      const schemaReferenceURI = url.stripHash(schemaReference.uri);
+      if (schemaReferenceURI === url.stripHash(this.reference.uri) || schemaReferenceURI === url.stripHash(this.reference.refSet.rootRef.uri)) {
         return;
       }
 

package/src/dereference/strategies/arazzo-1/index.cjs

@@ -17,12 +17,24 @@ Object.defineProperty(exports, "dereferenceSourceDescriptions", {
     return _sourceDescriptions.dereferenceSourceDescriptions;
   }
 });
+Object.defineProperty(exports, "identifiedBy$self", {
+  enumerable: true,
+  get: function () {
+    return _util.identifiedBy$self;
+  }
+});
 Object.defineProperty(exports, "maybeRefractToJSONSchemaElement", {
   enumerable: true,
   get: function () {
     return _util.maybeRefractToJSONSchemaElement;
   }
 });
+Object.defineProperty(exports, "resolveArazzo$selfField", {
+  enumerable: true,
+  get: function () {
+    return _util.resolveArazzo$selfField;
+  }
+});
 Object.defineProperty(exports, "resolveSchema$idField", {
   enumerable: true,
   get: function () {

package/src/dereference/strategies/arazzo-1/index.mjs

@@ -104,6 +104,6 @@ class Arazzo1DereferenceStrategy extends DereferenceStrategy {
   }
 }
 export { Arazzo1DereferenceVisitor };
-export { resolveSchema$refField, resolveSchema$idField, maybeRefractToJSONSchemaElement } from "./util.mjs";
+export { resolveSchema$refField, resolveSchema$idField, resolveArazzo$selfField, identifiedBy$self, maybeRefractToJSONSchemaElement } from "./util.mjs";
 export { dereferenceSourceDescriptions } from "./source-descriptions.mjs";
 export default Arazzo1DereferenceStrategy;

package/src/dereference/strategies/arazzo-1/source-descriptions.cjs

@@ -7,13 +7,11 @@ Object.defineProperty(exports, "__esModule", {
 exports.dereferenceSourceDescriptions = dereferenceSourceDescriptions;
 var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _apidomNsArazzo = require("@speclynx/apidom-ns-arazzo-1");
-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 url = _interopRequireWildcard(require("../../../util/url.cjs"));
 var _util = require("../../../options/util.cjs");
 var _index = _interopRequireWildcard(require("../../index.cjs"));
+var _util2 = require("./util.cjs");
 /**
  * Dereferences a single source description element.
  * Returns ParseResultElement on success, or with annotation if skipped.
@@ -43,14 +41,25 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
   const retrievalURI = url.sanitize(url.stripHash(url.resolve(ctx.baseURI, sourceDescriptionURI)));
   parseResult.setMetaProperty('retrievalURI', retrievalURI);
 
-  // skip if already visited (cycle detection)
-  if (ctx.visitedUrls.has(retrievalURI)) {
+  // skip if the document is still being dereferenced higher up the chain (cycle detection)
+  if (ctx.ancestors.includes(retrievalURI)) {
     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);
+
+  // a document reached again through a different path is a shared dependency, not a cycle;
+  // point at the result where it was dereferenced instead of dereferencing it again
+  const sharedDereferenceResult = ctx.dereferenced.get(retrievalURI);
+  if (sharedDereferenceResult !== undefined) {
+    const annotation = new _apidomDatamodel.AnnotationElement(`Source description "${retrievalURI}" has already been dereferenced. Reusing existing dereference result`);
+    annotation.classes.push('info');
+    parseResult.push(annotation);
+    parseResult.meta.set('parseResult', sharedDereferenceResult);
+    (0, _util2.validateSourceDescriptionAPI)(parseResult, sourceDescription, sharedDereferenceResult.api, retrievalURI);
+    return parseResult;
+  }
 
   // check if source description was already parsed (e.g., during parse phase with sourceDescriptions: true)
   const existingParseResult = sourceDescription.meta.get('parseResult');
@@ -73,7 +82,8 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
             [ctx.strategyName]: {
               sourceDescriptions: true,
               sourceDescriptionsDepth: ctx.currentDepth + 1,
-              sourceDescriptionsVisitedUrls: ctx.visitedUrls
+              sourceDescriptionsAncestors: ctx.ancestors,
+              sourceDescriptionsDereferenced: ctx.dereferenced
             }
           }
         }
@@ -92,7 +102,8 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
             [ctx.strategyName]: {
               sourceDescriptions: true,
               sourceDescriptionsDepth: ctx.currentDepth + 1,
-              sourceDescriptionsVisitedUrls: ctx.visitedUrls
+              sourceDescriptionsAncestors: ctx.ancestors,
+              sourceDescriptionsDereferenced: ctx.dereferenced
             }
           }
         }
@@ -112,32 +123,14 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
     return parseResult;
   }
 
-  // only allow OpenAPI and Arazzo as source descriptions
+  // register dereferenced document for later references to it
   const {
     api: sourceDescriptionAPI
   } = parseResult;
-  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`);
-    annotation.classes.push('warning');
-    parseResult.push(annotation);
-    return parseResult;
-  }
-
-  // validate declared type matches actual dereferenced type
-  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 dereferenced 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 dereferenced as OpenAPI document`);
-      annotation.classes.push('warning');
-      parseResult.push(annotation);
-    }
+  for (const documentURI of (0, _util2.arazzoDocumentURIs)(retrievalURI, sourceDescriptionAPI)) {
+    ctx.dereferenced.set(documentURI, parseResult);
   }
+  (0, _util2.validateSourceDescriptionAPI)(parseResult, sourceDescription, sourceDescriptionAPI, retrievalURI);
   return parseResult;
 }
 
@@ -149,6 +142,13 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
  * regardless of success or failure. On failure, the ParseResultElement
  * contains annotations explaining what went wrong.
  *
+ * A document referenced from more than one place is dereferenced only once.
+ * Every later source description referencing it gets its own result carrying
+ * an 'info' annotation and a 'parseResult' meta pointing at the result where
+ * the document was dereferenced; that result is also what gets attached to the
+ * SourceDescriptionElement's meta. A document referencing one of its ancestors
+ * forms a cycle and is skipped with a 'warning' annotation instead.
+ *
  * @param parseResult - ParseResult containing a parsed (optionally dereferenced) Arazzo specification
  * @param parseResultRetrievalURI - URI from which the parseResult was retrieved
  * @param options - Full ReferenceOptions. Pass `sourceDescriptions` as an array of names
@@ -183,7 +183,7 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
  * @public
  */
 async function dereferenceSourceDescriptions(parseResult, parseResultRetrievalURI, options, strategyName = 'arazzo-1') {
-  const baseURI = url.sanitize(url.stripHash(parseResultRetrievalURI));
+  const retrievalURI = url.sanitize(url.stripHash(parseResultRetrievalURI));
   const results = [];
 
   // get API from dereferenced parse result
@@ -212,23 +212,24 @@ async function dereferenceSourceDescriptions(parseResult, parseResultRetrievalUR
   // recursion state comes from strategy-specific options
   const sharedOpts = options?.dereference?.strategyOpts?.[strategyName] ?? {};
   const currentDepth = sharedOpts.sourceDescriptionsDepth ?? 0;
-  const visitedUrls = sharedOpts.sourceDescriptionsVisitedUrls ?? new Set();
-
-  // add current file to visited URLs to prevent cycles
-  visitedUrls.add(baseURI);
+  const dereferenced = sharedOpts.sourceDescriptionsDereferenced ?? new Map();
+  // current file is an ancestor of everything dereferenced below
+  const ancestors = [...(sharedOpts.sourceDescriptionsAncestors ?? []), ...(0, _util2.arazzoDocumentURIs)(retrievalURI, api)];
   if (currentDepth >= maxDepth) {
-    const annotation = new _apidomDatamodel.AnnotationElement(`Maximum dereference depth of ${maxDepth} has been exceeded by file "${baseURI}"`);
+    const annotation = new _apidomDatamodel.AnnotationElement(`Maximum dereference depth of ${maxDepth} has been exceeded by file "${retrievalURI}"`);
     annotation.classes.push('error');
     const parseResult = new _apidomDatamodel.ParseResultElement([annotation]);
     parseResult.classes.push('source-description');
     return [parseResult];
   }
   const ctx = {
-    baseURI,
+    // base URI for resolving source description URLs honors Arazzo `$self` field
+    baseURI: (0, _util2.resolveArazzo$selfField)(retrievalURI, api),
     options,
     strategyName,
     currentDepth,
-    visitedUrls
+    ancestors,
+    dereferenced
   };
 
   // determine which source descriptions to dereference (array filters by name)
@@ -239,11 +240,12 @@ async function dereferenceSourceDescriptions(parseResult, parseResultRetrievalUR
     return typeof name === 'string' && sourceDescriptionsOption.includes(name);
   }) : api.sourceDescriptions;
 
-  // process sequentially to ensure proper cycle detection with shared visitedUrls
+  // process sequentially to ensure proper cycle detection with shared state
   for (const sourceDescription of sourceDescriptions) {
     const sourceDescriptionDereferenceResult = await dereferenceSourceDescription(sourceDescription, ctx);
-    // always attach result (even on failure - contains annotations)
-    sourceDescription.meta.set('parseResult', sourceDescriptionDereferenceResult);
+    // always attach result (even on failure - contains annotations);
+    // a shared document attaches the result where it was dereferenced
+    sourceDescription.meta.set('parseResult', sourceDescriptionDereferenceResult.meta.get('parseResult') ?? sourceDescriptionDereferenceResult);
     results.push(sourceDescriptionDereferenceResult);
   }
   return results;

package/src/dereference/strategies/arazzo-1/source-descriptions.mjs

@@ -1,12 +1,10 @@
 import { ParseResultElement, AnnotationElement, isArrayElement, isStringElement, isParseResultElement } from '@speclynx/apidom-datamodel';
 import { isArazzoSpecification1Element, isSourceDescriptionElement } from '@speclynx/apidom-ns-arazzo-1';
-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 * as url from "../../../util/url.mjs";
 import { merge as mergeOptions } from "../../../options/util.mjs";
 import dereference, { dereferenceApiDOM } from "../../index.mjs";
+import { arazzoDocumentURIs, resolveArazzo$selfField, validateSourceDescriptionAPI } from "./util.mjs";
 /**
  * Dereferences a single source description element.
  * Returns ParseResultElement on success, or with annotation if skipped.
@@ -36,14 +34,25 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
   const retrievalURI = url.sanitize(url.stripHash(url.resolve(ctx.baseURI, sourceDescriptionURI)));
   parseResult.setMetaProperty('retrievalURI', retrievalURI);
 
-  // skip if already visited (cycle detection)
-  if (ctx.visitedUrls.has(retrievalURI)) {
+  // skip if the document is still being dereferenced higher up the chain (cycle detection)
+  if (ctx.ancestors.includes(retrievalURI)) {
     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);
+
+  // a document reached again through a different path is a shared dependency, not a cycle;
+  // point at the result where it was dereferenced instead of dereferencing it again
+  const sharedDereferenceResult = ctx.dereferenced.get(retrievalURI);
+  if (sharedDereferenceResult !== undefined) {
+    const annotation = new AnnotationElement(`Source description "${retrievalURI}" has already been dereferenced. Reusing existing dereference result`);
+    annotation.classes.push('info');
+    parseResult.push(annotation);
+    parseResult.meta.set('parseResult', sharedDereferenceResult);
+    validateSourceDescriptionAPI(parseResult, sourceDescription, sharedDereferenceResult.api, retrievalURI);
+    return parseResult;
+  }
 
   // check if source description was already parsed (e.g., during parse phase with sourceDescriptions: true)
   const existingParseResult = sourceDescription.meta.get('parseResult');
@@ -66,7 +75,8 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
             [ctx.strategyName]: {
               sourceDescriptions: true,
               sourceDescriptionsDepth: ctx.currentDepth + 1,
-              sourceDescriptionsVisitedUrls: ctx.visitedUrls
+              sourceDescriptionsAncestors: ctx.ancestors,
+              sourceDescriptionsDereferenced: ctx.dereferenced
             }
           }
         }
@@ -85,7 +95,8 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
             [ctx.strategyName]: {
               sourceDescriptions: true,
               sourceDescriptionsDepth: ctx.currentDepth + 1,
-              sourceDescriptionsVisitedUrls: ctx.visitedUrls
+              sourceDescriptionsAncestors: ctx.ancestors,
+              sourceDescriptionsDereferenced: ctx.dereferenced
             }
           }
         }
@@ -105,32 +116,14 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
     return parseResult;
   }
 
-  // only allow OpenAPI and Arazzo as source descriptions
+  // register dereferenced document for later references to it
   const {
     api: sourceDescriptionAPI
   } = parseResult;
-  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`);
-    annotation.classes.push('warning');
-    parseResult.push(annotation);
-    return parseResult;
-  }
-
-  // validate declared type matches actual dereferenced type
-  const declaredType = toValue(sourceDescription.type);
-  if (typeof declaredType === 'string') {
-    if (declaredType === 'openapi' && !isOpenApi) {
-      const annotation = new AnnotationElement(`Source description "${retrievalURI}" declared as "openapi" but dereferenced 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 dereferenced as OpenAPI document`);
-      annotation.classes.push('warning');
-      parseResult.push(annotation);
-    }
+  for (const documentURI of arazzoDocumentURIs(retrievalURI, sourceDescriptionAPI)) {
+    ctx.dereferenced.set(documentURI, parseResult);
   }
+  validateSourceDescriptionAPI(parseResult, sourceDescription, sourceDescriptionAPI, retrievalURI);
   return parseResult;
 }
 
@@ -142,6 +135,13 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
  * regardless of success or failure. On failure, the ParseResultElement
  * contains annotations explaining what went wrong.
  *
+ * A document referenced from more than one place is dereferenced only once.
+ * Every later source description referencing it gets its own result carrying
+ * an 'info' annotation and a 'parseResult' meta pointing at the result where
+ * the document was dereferenced; that result is also what gets attached to the
+ * SourceDescriptionElement's meta. A document referencing one of its ancestors
+ * forms a cycle and is skipped with a 'warning' annotation instead.
+ *
  * @param parseResult - ParseResult containing a parsed (optionally dereferenced) Arazzo specification
  * @param parseResultRetrievalURI - URI from which the parseResult was retrieved
  * @param options - Full ReferenceOptions. Pass `sourceDescriptions` as an array of names
@@ -176,7 +176,7 @@ async function dereferenceSourceDescription(sourceDescription, ctx) {
  * @public
  */
 export async function dereferenceSourceDescriptions(parseResult, parseResultRetrievalURI, options, strategyName = 'arazzo-1') {
-  const baseURI = url.sanitize(url.stripHash(parseResultRetrievalURI));
+  const retrievalURI = url.sanitize(url.stripHash(parseResultRetrievalURI));
   const results = [];
 
   // get API from dereferenced parse result
@@ -205,23 +205,24 @@ export async function dereferenceSourceDescriptions(parseResult, parseResultRetr
   // recursion state comes from strategy-specific options
   const sharedOpts = options?.dereference?.strategyOpts?.[strategyName] ?? {};
   const currentDepth = sharedOpts.sourceDescriptionsDepth ?? 0;
-  const visitedUrls = sharedOpts.sourceDescriptionsVisitedUrls ?? new Set();
-
-  // add current file to visited URLs to prevent cycles
-  visitedUrls.add(baseURI);
+  const dereferenced = sharedOpts.sourceDescriptionsDereferenced ?? new Map();
+  // current file is an ancestor of everything dereferenced below
+  const ancestors = [...(sharedOpts.sourceDescriptionsAncestors ?? []), ...arazzoDocumentURIs(retrievalURI, api)];
   if (currentDepth >= maxDepth) {
-    const annotation = new AnnotationElement(`Maximum dereference depth of ${maxDepth} has been exceeded by file "${baseURI}"`);
+    const annotation = new AnnotationElement(`Maximum dereference depth of ${maxDepth} has been exceeded by file "${retrievalURI}"`);
     annotation.classes.push('error');
     const parseResult = new ParseResultElement([annotation]);
     parseResult.classes.push('source-description');
     return [parseResult];
   }
   const ctx = {
-    baseURI,
+    // base URI for resolving source description URLs honors Arazzo `$self` field
+    baseURI: resolveArazzo$selfField(retrievalURI, api),
     options,
     strategyName,
     currentDepth,
-    visitedUrls
+    ancestors,
+    dereferenced
   };
 
   // determine which source descriptions to dereference (array filters by name)
@@ -232,11 +233,12 @@ export async function dereferenceSourceDescriptions(parseResult, parseResultRetr
     return typeof name === 'string' && sourceDescriptionsOption.includes(name);
   }) : api.sourceDescriptions;
 
-  // process sequentially to ensure proper cycle detection with shared visitedUrls
+  // process sequentially to ensure proper cycle detection with shared state
   for (const sourceDescription of sourceDescriptions) {
     const sourceDescriptionDereferenceResult = await dereferenceSourceDescription(sourceDescription, ctx);
-    // always attach result (even on failure - contains annotations)
-    sourceDescription.meta.set('parseResult', sourceDescriptionDereferenceResult);
+    // always attach result (even on failure - contains annotations);
+    // a shared document attaches the result where it was dereferenced
+    sourceDescription.meta.set('parseResult', sourceDescriptionDereferenceResult.meta.get('parseResult') ?? sourceDescriptionDereferenceResult);
     results.push(sourceDescriptionDereferenceResult);
   }
   return results;