fix(parser): fix sync/async inconsistencies

Closes #310

Author: char0n

apidom/packages/apidom-parser/README.md

@@ -43,7 +43,7 @@ const parser = ApiDOMParser();
 parser.use(jsonParserAdapter);
 parser.use(yamlParserAdapter);
 
-const namespace = parser.findNamespace('{"prop", "value"}', { mediaType: 'application/json' });
+const namespace = await parser.findNamespace('{"prop", "value"}', { mediaType: 'application/json' });
 ```
 
 ## Parsing

apidom/packages/apidom-parser/src/parser.ts

@@ -26,15 +26,20 @@ interface ApiDOMParser {
 const ApiDOMParser: stampit.Stamp<ApiDOMParser> = stampit().init(function ApiDOMParser() {
   const adapters: ApiDOMParserAdapter[] = [];
 
-  const detectAdapterCandidates = (source: string) => {
-    return adapters.filter((adapter) => {
-      if (!isFunction(adapter.detect)) return false;
+  const detectAdapterCandidates = async (source: string) => {
+    const candidates = [];
+
+    for (const adapter of adapters) {
+      // eslint-disable-next-line no-await-in-loop
+      if (isFunction(adapter.detect) && (await adapter.detect(source))) {
+        candidates.push(adapter);
+      }
+    }
 
-      return adapter.detect(source);
-    });
+    return candidates;
   };
 
-  const findAdapter = (source: string, mediaType: string | undefined) => {
+  const findAdapter = async (source: string, mediaType: string | undefined) => {
     if (isString(mediaType)) {
       return adapters.find((adapter) => {
         if (!isArray(adapter.mediaTypes)) return false;
@@ -43,25 +48,27 @@ const ApiDOMParser: stampit.Stamp<ApiDOMParser> = stampit().init(function ApiDOM
       });
     }
 
-    return head(detectAdapterCandidates(source));
+    const candidates = await detectAdapterCandidates(source);
+
+    return head(candidates);
   };
 
   this.use = function use(adapter: ApiDOMParserAdapter) {
     adapters.push(adapter);
     return this;
   };
 
-  this.findNamespace = function findNamespace(source: string, options: ParserOptions = {}) {
-    const adapter = findAdapter(source, options.mediaType);
+  this.findNamespace = async function findNamespace(source: string, options: ParserOptions = {}) {
+    const adapter = await findAdapter(source, options.mediaType);
 
     return adapter?.namespace;
   };
 
   this.parse = async function parse(source: string, options: ParserOptions = {}) {
-    const adapter = findAdapter(source, options.mediaType);
+    const adapter = await findAdapter(source, options.mediaType);
 
     if (isUndefined(adapter)) {
-      return Promise.reject(new Error('Document did not match any registered parsers'));
+      throw new Error('Document did not match any registered parsers');
     }
 
     return adapter.parse(source, options);

experiments/apidom-playground/src/features/app/apidom.worker.js

@@ -25,7 +25,7 @@ const parser = ApiDOMParser()
 /* eslint-disable */
 const service = {
   async parse(source, { mediaType }) {
-    const namespace = parser.findNamespace(source, { sourceMap: true, mediaType });
+    const namespace = await parser.findNamespace(source, { sourceMap: true, mediaType });
     const parseResult = await parser.parse(source, { sourceMap: true, mediaType });
     const refract = dehydrate(parseResult, namespace);
 
@@ -38,14 +38,14 @@ const service = {
   },
 
   async resolveApiDOM(apiDOM, { source, mediaType, baseURI }) {
-    const namespace = parser.findNamespace(source, { mediaType });
+    const namespace = await parser.findNamespace(source, { mediaType });
     const parseResult = from(apiDOM, namespace);
 
     return resolveApiDOMReferences(parseResult, { parse: { mediaType }, resolve: { baseURI } });
   },
 
   async dereferenceApiDOM(apiDOM, { source, mediaType, baseURI }) {
-    const namespace = parser.findNamespace(source, { mediaType });
+    const namespace = await parser.findNamespace(source, { mediaType });
     const parseResult = from(apiDOM, namespace);
     const dereferenced = await derefereceApiDOMReferences(parseResult.api, {
       parse: { mediaType },
@@ -56,8 +56,8 @@ const service = {
     return JSON.stringify(refract, undefined, 2);
   },
 
-  humanizeDereferenced(dereferenced, { source, mediaType }) {
-    const namespace = parser.findNamespace(source, { mediaType });
+  async humanizeDereferenced(dereferenced, { source, mediaType }) {
+    const namespace = await parser.findNamespace(source, { mediaType });
     const element = from(dereferenced, namespace);
     const pojo = toValue(element, namespace);
 

experiments/apidom-playground/src/features/app/slice.js

@@ -142,7 +142,7 @@ export const dereferenceApiDOM = createAsyncThunk(
 
 export const humanizeDereferencedApiDOM = createAsyncThunk(
   'humanizeDereferencedApiDOMStatus',
-  ({ source, mediaType, dereferenced }, { extra: { apiDOMService } }) => {
+  async ({ source, mediaType, dereferenced }, { extra: { apiDOMService } }) => {
     return apiDOMService.humanizeDereferenced(dereferenced, { source, mediaType });
   }
 );