fix(asyncapi): allow replace Schema for Reference in Message.payload

Refs #427

Author: char0n

apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/visitors/async-api-2-0/message/index.ts

@@ -5,6 +5,7 @@ import { ObjectElement, isObjectElement, Element } from 'apidom';
 import MessageElement from '../../../../elements/Message';
 import FallbackVisitor from '../../FallbackVisitor';
 import FixedFieldsVisitor from '../../generics/FixedFieldsVisitor';
+import { isReferenceLikeElement } from '../../../predicates';
 
 const MessageVisitor = stampit(FixedFieldsVisitor, FallbackVisitor, {
   props: {
@@ -31,14 +32,22 @@ const MessageVisitor = stampit(FixedFieldsVisitor, FallbackVisitor, {
     ObjectElement(objectElement: ObjectElement) {
       // @ts-ignore
       const result = FixedFieldsVisitor.compose.methods.ObjectElement.call(this, objectElement);
-
-      // refract payload according to `schemaFormat`
-      const schemaFormat = defaultTo(
-        'application/vnd.aai.asyncapi;version=2.0.0',
-        objectElement.get('schemaFormat')?.toValue(),
-      );
       const payload = this.element.get('payload');
-      this.refractPayload(schemaFormat, payload);
+
+      if (isReferenceLikeElement(payload)) {
+        // refract to ReferenceElement
+        this.element.payload = this.toRefractedElement(
+          ['document', 'objects', 'Reference'],
+          payload,
+        );
+      } else {
+        // refract payload according to `schemaFormat`
+        const schemaFormat = defaultTo(
+          'application/vnd.aai.asyncapi;version=2.0.0',
+          objectElement.get('schemaFormat')?.toValue(),
+        );
+        this.refractPayload(schemaFormat, payload);
+      }
 
       return result;
     },

apidom/packages/apidom-ns-asyncapi-2-0/test/refractor/elements/Message/__snapshots__/index.ts.snap

@@ -93,6 +93,16 @@ exports[`refractor elements given payload field of other type should refract to
     (BooleanElement)))
 `;
 
+exports[`refractor elements given payload field of type ReferenceElement should refract to semantic ApiDOM tree 1`] = `
+(MessageElement
+  (MemberElement
+    (StringElement)
+    (ReferenceElement
+      (MemberElement
+        (StringElement)
+        (StringElement)))))
+`;
+
 exports[`refractor elements given payload field of type SchemaElement should refract to semantic ApiDOM tree 1`] = `
 (MessageElement
   (MemberElement

apidom/packages/apidom-ns-asyncapi-2-0/test/refractor/elements/Message/index.ts

@@ -55,6 +55,18 @@ describe('refractor', function () {
       });
     });
 
+    context('given payload field of type ReferenceElement', function () {
+      specify('should refract to semantic ApiDOM tree', function () {
+        const messageElement = MessageElement.refract({
+          payload: {
+            $ref: '#/json-pointer',
+          },
+        });
+
+        expect(sexprs(messageElement)).toMatchSnapshot();
+      });
+    });
+
     context('given payload field of other type', function () {
       specify('should refract to semantic ApiDOM tree', function () {
         const messageElement = MessageElement.refract({

apidom/packages/apidom-reference/test/dereference/strategies/asyncapi-2-0/reference-object/fixtures/referencing-schema-object/dereferenced.json

@@ -0,0 +1,41 @@
+[
+  {
+    "asyncapi": "2.0.0",
+    "components": {
+      "messages": {
+        "UserSignedUp": {
+          "name": "userSignedUp",
+          "title": "User signed up event",
+          "summary": "Inform about a new user",
+          "contentType": "application/json",
+          "payload": {
+            "type": "object",
+            "title": "User signed up event",
+            "summary": "Inform about a new user",
+            "contentType": "application/json",
+            "properties": {
+              "firstName": {
+                "type": "string",
+                "description": "foo"
+              }
+            }
+          }
+        }
+      },
+      "schemas": {
+        "userSignedUpPayload": {
+          "type": "object",
+          "title": "User signed up event",
+          "summary": "Inform about a new user",
+          "contentType": "application/json",
+          "properties": {
+            "firstName": {
+              "type": "string",
+              "description": "foo"
+            }
+          }
+        }
+      }
+    }
+  }
+]

apidom/packages/apidom-reference/test/dereference/strategies/asyncapi-2-0/reference-object/fixtures/referencing-schema-object/root.json

@@ -0,0 +1,30 @@
+{
+  "asyncapi": "2.0.0",
+  "components": {
+    "messages": {
+      "UserSignedUp": {
+        "name": "userSignedUp",
+        "title": "User signed up event",
+        "summary": "Inform about a new user",
+        "contentType": "application/json",
+        "payload": {
+          "$ref": "#/components/schemas/userSignedUpPayload"
+        }
+      }
+    },
+    "schemas": {
+      "userSignedUpPayload": {
+        "type": "object",
+        "title": "User signed up event",
+        "summary": "Inform about a new user",
+        "contentType": "application/json",
+        "properties": {
+          "firstName": {
+            "type": "string",
+            "description": "foo"
+          }
+        }
+      }
+    }
+  }
+}

apidom/packages/apidom-reference/test/dereference/strategies/asyncapi-2-0/reference-object/index.ts

@@ -1,6 +1,6 @@
 import path from 'path';
 import { assert } from 'chai';
-import { toValue } from 'apidom';
+import { toValue, sexprs } from 'apidom';
 import { isParameterElement } from 'apidom-ns-asyncapi-2-0';
 
 import { loadJsonFile } from '../../../../helpers';
@@ -261,6 +261,21 @@ describe('dereference', function () {
           });
         });
 
+        context('given Reference Objects referencing Schema Object', function () {
+          const fixturePath = path.join(rootFixturePath, 'referencing-schema-object');
+
+          specify('should dereference', async function () {
+            const rootFilePath = path.join(fixturePath, 'root.json');
+            const actual = await dereference(rootFilePath, {
+              parse: { mediaType: 'application/vnd.aai.asyncapi+json;version=2.0.0' },
+            });
+            console.dir(sexprs(actual));
+            const expected = loadJsonFile(path.join(fixturePath, 'dereferenced.json'));
+
+            assert.deepEqual(toValue(actual), expected);
+          });
+        });
+
         context('given Reference Objects and maxDepth of dereference', function () {
           const fixturePath = path.join(rootFixturePath, 'max-depth');