fix(reference): allow resolution on other elements than ParseResult

Refs #476

Author: char0n

apidom/packages/apidom-reference/src/resolve/index.ts

@@ -1,5 +1,5 @@
 import { isEmpty } from 'ramda';
-import { Element } from 'apidom';
+import { Element, isParseResultElement, ParseResultElement } from 'apidom';
 
 import { merge as mergeOptions } from '../options/util';
 import { ReferenceOptions as IReferenceOptions, ReferenceSet as IReferenceSet } from '../types';
@@ -15,16 +15,28 @@ export const resolveApiDOM = async <T extends Element>(
   element: T,
   options: IReferenceOptions,
 ): Promise<IReferenceSet> => {
+  let parseResult: ParseResultElement;
+
+  // wrap element into parse result and temporary mutate it with `result` metadata
+  if (!isParseResultElement(element)) {
+    element.classes.push('result');
+    parseResult = new ParseResultElement([element]);
+  } else {
+    // @ts-ignore
+    parseResult = element;
+  }
+
   const file = File({
     uri: options.resolve.baseURI,
-    parseResult: element,
+    parseResult,
     mediaType: options.parse.mediaType,
   });
 
   const resolveStrategies = plugins.filter('canResolve', file, options.resolve.strategies);
 
   // we couldn't find any resolver for this File
   if (isEmpty(resolveStrategies)) {
+    element.classes.content.pop();
     throw new UnmatchedResolveStrategyError(file.uri);
   }
 
@@ -33,6 +45,8 @@ export const resolveApiDOM = async <T extends Element>(
     return result;
   } catch (error) {
     throw new ResolverError(`Error while resolving file "${file.uri}"`, error);
+  } finally {
+    element.classes.content.pop();
   }
 };
 

apidom/packages/apidom-reference/src/resolve/strategies/openapi-3-1/index.ts

@@ -35,7 +35,7 @@ const OpenApi3_1ResolveStrategy: stampit.Stamp<IResolveStrategy> = stampit(Resol
       }
 
       // assert by inspecting ApiDOM
-      return isOpenApi3_1Element(file.parseResult?.api);
+      return isOpenApi3_1Element(file.parseResult?.result);
     },
 
     async resolve(file: IFile, options: IReferenceOptions) {

apidom/packages/apidom-reference/test/dereference/index.ts

@@ -48,7 +48,6 @@ describe('dereference', function () {
 
           // @ts-ignore
           const actual = await dereferenceApiDOM(api, {
-            parse: { mediaType: 'application/vnd.oai.openapi+json;version=3.1.0' },
             resolve: { baseURI: rootFilePath },
           });
 

apidom/packages/apidom-reference/test/resolve/index.ts

@@ -29,15 +29,31 @@ describe('resolve', function () {
     });
 
     context('resolveApiDOM', function () {
-      specify('should resolve an ApiDOM fragment', async function () {
-        const fragment = await parse(rootFilePath, {
-          parse: { mediaType: 'application/vnd.oai.openapi+json;version=3.1.0' },
-        });
-        const refSet = await resolveApiDOM(fragment, {
-          resolve: { baseURI: rootFilePath },
+      context('given fragment is instance of ParseResultElement', function () {
+        specify('should resolve an ApiDOM fragment', async function () {
+          const fragment = await parse(rootFilePath, {
+            parse: { mediaType: 'application/vnd.oai.openapi+json;version=3.1.0' },
+          });
+          const refSet = await resolveApiDOM(fragment, {
+            resolve: { baseURI: rootFilePath },
+          });
+
+          assert.strictEqual(refSet.size, 2);
         });
+      });
 
-        assert.strictEqual(refSet.size, 2);
+      context("given fragment isn't instance of ParseResultElement", function () {
+        specify('should resolve an ApiDOM fragment', async function () {
+          const { api } = await parse(rootFilePath, {
+            parse: { mediaType: 'application/vnd.oai.openapi+json;version=3.1.0' },
+          });
+          // @ts-ignore
+          const refSet = await resolveApiDOM(api, {
+            resolve: { baseURI: rootFilePath },
+          });
+
+          assert.strictEqual(refSet.size, 2);
+        });
       });
     });
   });