@speclynx/apidom-reference 2.3.0 → 2.5.0

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

@@ -0,0 +1,411 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("ramda");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _apidomCore = require("@speclynx/apidom-core");
+var _apidomError = require("@speclynx/apidom-error");
+var _apidomTraverse = require("@speclynx/apidom-traverse");
+var _apidomJsonPointer = require("@speclynx/apidom-json-pointer");
+var _apidomNsArazzo = require("@speclynx/apidom-ns-arazzo-1");
+var _arazzoRuntimeExpression = require("@swaggerexpert/arazzo-runtime-expression");
+var _$anchor = require("./selectors/$anchor.cjs");
+var _uri = require("./selectors/uri.cjs");
+var _util = require("../openapi-3-1/util.cjs");
+var _util2 = require("./util.cjs");
+var _MaximumDereferenceDepthError = _interopRequireDefault(require("../../../errors/MaximumDereferenceDepthError.cjs"));
+var _MaximumResolveDepthError = _interopRequireDefault(require("../../../errors/MaximumResolveDepthError.cjs"));
+var url = _interopRequireWildcard(require("../../../util/url.cjs"));
+var _index = _interopRequireDefault(require("../../../parse/index.cjs"));
+var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
+var _File = _interopRequireDefault(require("../../../File.cjs"));
+var _util3 = require("../../util.cjs");
+var _EvaluationJsonSchemaUriError = _interopRequireDefault(require("../../../errors/EvaluationJsonSchemaUriError.cjs"));
+// initialize element identity manager
+const identityManager = new _apidomCore.IdentityManager();
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class Arazzo1DereferenceVisitor {
+  indirections;
+  namespace;
+  reference;
+  options;
+  ancestors;
+  constructor({
+    reference,
+    namespace,
+    options,
+    indirections = [],
+    ancestors = new _util3.AncestorLineage()
+  }) {
+    this.indirections = indirections;
+    this.namespace = namespace;
+    this.reference = reference;
+    this.options = options;
+    this.ancestors = new _util3.AncestorLineage(...ancestors);
+  }
+  toBaseURI(uri) {
+    return url.resolve(this.reference.uri, url.sanitize(url.stripHash(uri)));
+  }
+  async toReference(uri) {
+    // detect maximum depth of resolution
+    if (this.reference.depth >= this.options.resolve.maxDepth) {
+      throw new _MaximumResolveDepthError.default(`Maximum resolution depth of ${this.options.resolve.maxDepth} has been exceeded by file "${this.reference.uri}"`);
+    }
+    const baseURI = this.toBaseURI(uri);
+    const {
+      refSet
+    } = this.reference;
+
+    // we've already processed this Reference in past
+    if (refSet.has(baseURI)) {
+      return refSet.find((0, _ramda.propEq)(baseURI, 'uri'));
+    }
+    const parseResult = await (0, _index.default)(url.unsanitize(baseURI), {
+      ...this.options,
+      parse: {
+        ...this.options.parse,
+        mediaType: 'text/plain'
+      }
+    });
+
+    // register new mutable reference with a refSet
+    const mutableReference = new _Reference.default({
+      uri: baseURI,
+      value: (0, _apidomDatamodel.cloneDeep)(parseResult),
+      depth: this.reference.depth + 1
+    });
+    refSet.add(mutableReference);
+    if (this.options.dereference.immutable) {
+      // register new immutable reference with a refSet
+      const immutableReference = new _Reference.default({
+        uri: `immutable://${baseURI}`,
+        value: parseResult,
+        depth: this.reference.depth + 1
+      });
+      refSet.add(immutableReference);
+    }
+    return mutableReference;
+  }
+  toAncestorLineage(path) {
+    /**
+     * Compute full ancestors lineage.
+     * Ancestors are flatten to unwrap all Element instances.
+     */
+    const ancestorNodes = path.getAncestorNodes();
+    const directAncestors = new Set(ancestorNodes.filter(_apidomDatamodel.isElement));
+    const ancestorsLineage = new _util3.AncestorLineage(...this.ancestors, directAncestors);
+    return [ancestorsLineage, directAncestors];
+  }
+  ReusableElement(path) {
+    const referencingElement = path.node;
+
+    // skip current Reusable Object if reference field is not defined as a string
+    if (!(0, _apidomDatamodel.isStringElement)(referencingElement.reference)) {
+      path.skip();
+      return;
+    }
+
+    // ignore if resolve.internal is false (Reusable Objects are internal references only)
+    if (!this.options.resolve.internal) {
+      path.skip();
+      return;
+    }
+    const runtimeExpression = (0, _apidomCore.toValue)(referencingElement.reference);
+
+    // parse the runtime expression
+    const {
+      result,
+      tree
+    } = (0, _arazzoRuntimeExpression.parse)(runtimeExpression);
+    if (!result.success) {
+      throw new _apidomError.ApiDOMError(`Invalid Reusable Object reference format: "${runtimeExpression}"`);
+    }
+
+    // ReusableElement can only reference components
+    if (tree.type !== 'ComponentsExpression') {
+      throw new _apidomError.ApiDOMError(`Reusable Object reference "${runtimeExpression}" must be a components expression`);
+    }
+
+    // evaluate runtime expression as JSON Pointer to get the referenced element
+    const jsonPointer = (0, _apidomJsonPointer.compile)(['components', tree.field, tree.subField]);
+    let referencedElement;
+    try {
+      referencedElement = (0, _apidomJsonPointer.evaluate)(this.reference.value.result, jsonPointer);
+    } catch {
+      throw new _apidomError.ApiDOMError(`Reusable Object reference "${runtimeExpression}" cannot be resolved`);
+    }
+
+    /**
+     * Create a shallow clone of the referenced element to avoid modifying the original.
+     */
+    const mergedElement = (0, _apidomDatamodel.cloneShallow)(referencedElement);
+    // assign unique id to merged element
+    mergedElement.meta.set('id', identityManager.generateId());
+    // annotate with info about original referencing element
+    mergedElement.meta.set('ref-fields', {
+      reference: runtimeExpression,
+      value: (0, _apidomCore.toValue)(referencingElement.value)
+    });
+    // annotate with info about origin
+    mergedElement.meta.set('ref-origin', this.reference.uri);
+    // annotate with info about referencing element
+    mergedElement.meta.set('ref-referencing-element-id', identityManager.identify(referencingElement));
+
+    // override value field if present for Parameter Objects
+    if ((0, _apidomNsArazzo.isParameterElement)(mergedElement) && referencingElement.hasKey('value')) {
+      mergedElement.remove('value');
+      mergedElement.set('value', referencingElement.get('value'));
+    }
+
+    /**
+     * Transclude referencing element with merged referenced element.
+     */
+    path.replaceWith(mergedElement);
+  }
+  async JSONSchemaElement(path) {
+    const referencingElement = path.node;
+
+    // skip current referencing schema as $ref keyword was not defined
+    if (!(0, _apidomDatamodel.isStringElement)(referencingElement.$ref)) {
+      return;
+    }
+
+    // skip current referencing element as it's already been accessed
+    if (this.indirections.includes(referencingElement)) {
+      path.skip();
+      return;
+    }
+    const [ancestorsLineage, directAncestors] = this.toAncestorLineage(path);
+
+    // compute baseURI using rules around $id and $ref keywords
+    let reference = await this.toReference(url.unsanitize(this.reference.uri));
+    let {
+      uri: retrievalURI
+    } = reference;
+    const $refBaseURI = (0, _util.resolveSchema$refField)(retrievalURI, 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;
+    let isInternalReference = url.stripHash(this.reference.uri) === $refBaseURI;
+    let isExternalReference = !isInternalReference;
+
+    // determining reference, proper evaluation and selection mechanism
+    let referencedElement;
+    try {
+      if (isUnknownURI || isURL) {
+        // we're dealing with canonical URI or URL with possible fragment
+        retrievalURI = this.toBaseURI($refBaseURI);
+        const selector = $refBaseURI;
+        const referenceAsSchema = (0, _util2.maybeRefractToJSONSchemaElement)(reference.value.result);
+        referencedElement = (0, _uri.evaluate)(selector, referenceAsSchema);
+        referencedElement = (0, _util2.maybeRefractToJSONSchemaElement)(referencedElement);
+        referencedElement.id = identityManager.identify(referencedElement);
+
+        // ignore resolving internal Schema Objects
+        if (!this.options.resolve.internal && isInternalReference) {
+          // skip traversing this schema element but traverse all its child elements
+          return;
+        }
+        // ignore resolving external Schema Objects
+        if (!this.options.resolve.external && isExternalReference) {
+          // skip traversing this schema element but traverse all its child elements
+          return;
+        }
+      } else {
+        // we're assuming here that we're dealing with JSON Pointer here
+        retrievalURI = this.toBaseURI($refBaseURI);
+        isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
+        isExternalReference = !isInternalReference;
+
+        // ignore resolving internal Schema Objects
+        if (!this.options.resolve.internal && isInternalReference) {
+          // skip traversing this schema element but traverse all its child elements
+          return;
+        }
+        // ignore resolving external Schema Objects
+        if (!this.options.resolve.external && isExternalReference) {
+          // skip traversing this schema element but traverse all its child elements
+          return;
+        }
+        reference = await this.toReference(url.unsanitize($refBaseURI));
+        const selector = _apidomJsonPointer.URIFragmentIdentifier.fromURIReference($refBaseURI);
+        const referenceAsSchema = (0, _util2.maybeRefractToJSONSchemaElement)(reference.value.result);
+        referencedElement = (0, _apidomJsonPointer.evaluate)(referenceAsSchema, selector);
+        referencedElement = (0, _util2.maybeRefractToJSONSchemaElement)(referencedElement);
+        referencedElement.id = identityManager.identify(referencedElement);
+      }
+    } catch (error) {
+      /**
+       * JSONSchemaElement($id=URL) was not found, so we're going to try to resolve
+       * the URL and assume the returned response is a JSON Schema.
+       */
+      if (isURL && error instanceof _EvaluationJsonSchemaUriError.default) {
+        if ((0, _$anchor.isAnchor)((0, _$anchor.uriToAnchor)($refBaseURI))) {
+          // we're dealing with JSON Schema $anchor here
+          isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
+          isExternalReference = !isInternalReference;
+
+          // ignore resolving internal Schema Objects
+          if (!this.options.resolve.internal && isInternalReference) {
+            // skip traversing this schema element but traverse all its child elements
+            return;
+          }
+          // ignore resolving external Schema Objects
+          if (!this.options.resolve.external && isExternalReference) {
+            // skip traversing this schema element but traverse all its child elements
+            return;
+          }
+          reference = await this.toReference(url.unsanitize($refBaseURI));
+          const selector = (0, _$anchor.uriToAnchor)($refBaseURI);
+          const referenceAsSchema = (0, _util2.maybeRefractToJSONSchemaElement)(reference.value.result);
+          referencedElement = (0, _$anchor.evaluate)(selector, referenceAsSchema);
+          referencedElement = (0, _util2.maybeRefractToJSONSchemaElement)(referencedElement);
+          referencedElement.id = identityManager.identify(referencedElement);
+        } else {
+          // we're assuming here that we're dealing with JSON Pointer here
+          retrievalURI = this.toBaseURI($refBaseURI);
+          isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
+          isExternalReference = !isInternalReference;
+
+          // ignore resolving internal Schema Objects
+          if (!this.options.resolve.internal && isInternalReference) {
+            // skip traversing this schema element but traverse all its child elements
+            return;
+          }
+          // ignore resolving external Schema Objects
+          if (!this.options.resolve.external && isExternalReference) {
+            // skip traversing this schema element but traverse all its child elements
+            return;
+          }
+          reference = await this.toReference(url.unsanitize($refBaseURI));
+          const selector = _apidomJsonPointer.URIFragmentIdentifier.fromURIReference($refBaseURI);
+          const referenceAsSchema = (0, _util2.maybeRefractToJSONSchemaElement)(reference.value.result);
+          referencedElement = (0, _apidomJsonPointer.evaluate)(referenceAsSchema, selector);
+          referencedElement = (0, _util2.maybeRefractToJSONSchemaElement)(referencedElement);
+          referencedElement.id = identityManager.identify(referencedElement);
+        }
+      } else {
+        throw error;
+      }
+    }
+    this.indirections.push(referencingElement);
+
+    // detect direct or indirect reference
+    if (referencingElement === referencedElement) {
+      throw new _apidomError.ApiDOMError('Recursive JSON Schema reference detected');
+    }
+
+    // detect maximum depth of dereferencing
+    if (this.indirections.length > this.options.dereference.maxDepth) {
+      throw new _MaximumDereferenceDepthError.default(`Maximum dereference depth of "${this.options.dereference.maxDepth}" has been exceeded in file "${this.reference.uri}"`);
+    }
+
+    // detect second deep dive into the same fragment and avoid it
+    if (ancestorsLineage.includes(referencedElement)) {
+      reference.refSet.circular = true;
+      if (this.options.dereference.circular === 'error') {
+        throw new _apidomError.ApiDOMError('Circular reference detected');
+      } else if (this.options.dereference.circular === 'replace') {
+        const refElement = new _apidomDatamodel.RefElement(referencedElement.id, {
+          type: 'json-schema',
+          uri: reference.uri,
+          $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
+        });
+        const replacer = this.options.dereference.strategyOpts['arazzo-1']?.circularReplacer ?? this.options.dereference.circularReplacer;
+        const replacement = replacer(refElement);
+        this.indirections.pop();
+        path.replaceWith(replacement);
+        return;
+      }
+    }
+
+    /**
+     * Dive deep into the fragment.
+     *
+     * Cases to consider:
+     *  1. We're crossing document boundary
+     *  2. Fragment is from non-root document
+     *  3. Fragment is a JSON Schema with $ref field. We need to follow it to get the eventual value
+     *  4. We are dereferencing the fragment lazily/eagerly depending on circular mode
+     */
+    const isNonRootDocument = url.stripHash(reference.refSet.rootRef.uri) !== reference.uri;
+    const shouldDetectCircular = ['error', 'replace'].includes(this.options.dereference.circular);
+    if ((isExternalReference || isNonRootDocument || (0, _apidomNsArazzo.isJSONSchemaElement)(referencedElement) && (0, _apidomDatamodel.isStringElement)(referencedElement.$ref) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
+      // append referencing reference to ancestors lineage
+      directAncestors.add(referencingElement);
+      const visitor = new Arazzo1DereferenceVisitor({
+        reference,
+        namespace: this.namespace,
+        indirections: [...this.indirections],
+        options: this.options,
+        ancestors: ancestorsLineage
+      });
+      referencedElement = await (0, _apidomTraverse.traverseAsync)(referencedElement, visitor, {
+        mutable: true
+      });
+
+      // remove referencing reference from ancestors lineage
+      directAncestors.delete(referencingElement);
+    }
+    this.indirections.pop();
+
+    // Boolean JSON Schemas
+    if ((0, _apidomNsArazzo.isBooleanJSONSchemaElement)(referencedElement)) {
+      const booleanJsonSchemaElement = (0, _apidomDatamodel.cloneDeep)(referencedElement);
+      // assign unique id to merged element
+      booleanJsonSchemaElement.meta.set('id', identityManager.generateId());
+      // annotate referenced element with info about original referencing element
+      booleanJsonSchemaElement.meta.set('ref-fields', {
+        $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
+      });
+      // annotate referenced element with info about origin
+      booleanJsonSchemaElement.meta.set('ref-origin', reference.uri);
+      // annotate fragment with info about referencing element
+      booleanJsonSchemaElement.meta.set('ref-referencing-element-id', (0, _apidomDatamodel.cloneDeep)(identityManager.identify(referencingElement)));
+      path.replaceWith(booleanJsonSchemaElement);
+      return;
+    }
+
+    /**
+     * Creating a new version of JSON Schema by merging fields from referenced Schema with referencing one.
+     */
+    if ((0, _apidomNsArazzo.isJSONSchemaElement)(referencedElement)) {
+      const mergedElement = (0, _apidomDatamodel.cloneShallow)(referencedElement);
+      // assign unique id to merged element
+      mergedElement.meta.set('id', identityManager.generateId());
+      // existing keywords from referencing schema overrides ones from referenced schema
+      referencingElement.forEach((value, keyElement, item) => {
+        mergedElement.remove((0, _apidomCore.toValue)(keyElement));
+        mergedElement.content.push(item);
+      });
+      mergedElement.remove('$ref');
+      // annotate referenced element with info about original referencing element
+      mergedElement.meta.set('ref-fields', {
+        $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
+      });
+      // annotate fragment with info about origin
+      mergedElement.meta.set('ref-origin', reference.uri);
+      // annotate fragment with info about referencing element
+      mergedElement.meta.set('ref-referencing-element-id', (0, _apidomDatamodel.cloneDeep)(identityManager.identify(referencingElement)));
+      referencedElement = mergedElement;
+    }
+    /**
+     * Transclude referencing element with merged referenced element.
+     */
+    path.replaceWith(referencedElement);
+  }
+}
+var _default = exports.default = Arazzo1DereferenceVisitor;