feat: add reference related metadata to namespaces

Author: frantuma

apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/visitors/async-api-2-0/channel-item/$RefVisitor.ts

@@ -1,5 +1,17 @@
+import stampit from 'stampit';
+import { StringElement, BREAK } from 'apidom';
+
 import FallbackVisitor from '../../FallbackVisitor';
 
-const $RefVisitor = FallbackVisitor;
+const $RefVisitor = stampit(FallbackVisitor, {
+  methods: {
+    StringElement(stringElement: StringElement) {
+      this.element = stringElement.clone();
+      this.element.classes.push('reference-value');
+
+      return BREAK;
+    },
+  },
+});
 
 export default $RefVisitor;

apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/visitors/async-api-2-0/reference/$RefVisitor.ts

@@ -1,5 +1,17 @@
+import stampit from 'stampit';
+import { StringElement, BREAK } from 'apidom';
+
 import FallbackVisitor from '../../FallbackVisitor';
 
-const $RefVisitor = FallbackVisitor;
+const $RefVisitor = stampit(FallbackVisitor, {
+  methods: {
+    StringElement(stringElement: StringElement) {
+      this.element = stringElement.clone();
+      this.element.classes.push('reference-value');
+
+      return BREAK;
+    },
+  },
+});
 
 export default $RefVisitor;

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

@@ -13,6 +13,7 @@ const ServersVisitor = stampit(PatternedFieldsVisitor, FallbackVisitor, {
   },
   init() {
     this.element = new ServersElement();
+    this.element.classes.push('servers');
   },
 });
 

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

@@ -136,7 +136,7 @@ import ExampleVisitor from './visitors/open-api-3-1/example';
 import ExampleSummaryVisitor from './visitors/open-api-3-1/example/SummaryVisitor';
 import ExampleDescriptionVisitor from './visitors/open-api-3-1/example/DescriptionVisitor';
 import ExampleValueVisitor from './visitors/open-api-3-1/example/ValueVisitor';
-import ExampleExternalValueVisitor from './visitors/open-api-3-1/example/ExaternalValueVisitor';
+import ExampleExternalValueVisitor from './visitors/open-api-3-1/example/ExternalValueVisitor';
 import ExternalDocumentationVisitor from './visitors/open-api-3-1/external-documentation';
 import ExternalDocumentationDescriptionVisitor from './visitors/open-api-3-1/external-documentation/DescriptionVisitor';
 import ExternalDocumentationUrlVisitor from './visitors/open-api-3-1/external-documentation/UrlVisitor';

apidom/packages/apidom-ns-openapi-3-1/src/refractor/specification.ts

@@ -0,0 +1,17 @@
+import stampit from 'stampit';
+import { StringElement, BREAK } from 'apidom';
+
+import FallbackVisitor from '../../FallbackVisitor';
+
+const ExternalValueVisitor = stampit(FallbackVisitor, {
+  methods: {
+    StringElement(stringElement: StringElement) {
+      this.element = stringElement.clone();
+      this.element.classes.push('reference-value');
+
+      return BREAK;
+    },
+  },
+});
+
+export default ExternalValueVisitor;

apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/example/ExaternalValueVisitor.ts

@@ -1,5 +1,17 @@
+import stampit from 'stampit';
+import { StringElement, BREAK } from 'apidom';
+
 import FallbackVisitor from '../../FallbackVisitor';
 
-const OperationRefVisitor = FallbackVisitor;
+const OperationRefVisitor = stampit(FallbackVisitor, {
+  methods: {
+    StringElement(stringElement: StringElement) {
+      this.element = stringElement.clone();
+      this.element.classes.push('reference-value');
+
+      return BREAK;
+    },
+  },
+});
 
 export default OperationRefVisitor;

apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/example/ExternalValueVisitor.ts

@@ -1,5 +1,17 @@
+import stampit from 'stampit';
+import { StringElement, BREAK } from 'apidom';
+
 import FallbackVisitor from '../../FallbackVisitor';
 
-const $RefVisitor = FallbackVisitor;
+const $RefVisitor = stampit(FallbackVisitor, {
+  methods: {
+    StringElement(stringElement: StringElement) {
+      this.element = stringElement.clone();
+      this.element.classes.push('reference-value');
+
+      return BREAK;
+    },
+  },
+});
 
 export default $RefVisitor;

apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/link/OperationRefVisitor.ts

@@ -1,5 +1,17 @@
+import stampit from 'stampit';
+import { StringElement, BREAK } from 'apidom';
+
 import FallbackVisitor from '../../FallbackVisitor';
 
-const $RefVisitor = FallbackVisitor;
+const $RefVisitor = stampit(FallbackVisitor, {
+  methods: {
+    StringElement(stringElement: StringElement) {
+      this.element = stringElement.clone();
+      this.element.classes.push('reference-value');
+
+      return BREAK;
+    },
+  },
+});
 
 export default $RefVisitor;

apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/path-item/$RefVisitor.ts

@@ -1,5 +1,17 @@
+import stampit from 'stampit';
+import { StringElement, BREAK } from 'apidom';
+
 import FallbackVisitor from '../../FallbackVisitor';
 
-const $refVisitor = FallbackVisitor;
+const $refVisitor = stampit(FallbackVisitor, {
+  methods: {
+    StringElement(stringElement: StringElement) {
+      this.element = stringElement.clone();
+      this.element.classes.push('reference-value');
+
+      return BREAK;
+    },
+  },
+});
 
 export default $refVisitor;

apidom/packages/apidom-ns-openapi-3-1/src/refractor/visitors/open-api-3-1/reference/$RefVisitor.ts

@@ -79,13 +79,22 @@ const SchemaVisitor = stampit(FixedFieldsVisitor, ParentSchemaAwareVisitor, Fall
       this.element.setMetaProperty('inherited$id', inherited$id);
     };
 
+    const appendReferenceMetadata = (objectElement: ObjectElement) => {
+      const $ref = objectElement.get('$ref')?.toValue();
+
+      if (isNonEmptyString($ref)) {
+        this.element.classes.push('reference-element');
+      }
+    };
+
     /**
      * Public Api.
      */
     this.ObjectElement = function _ObjectElement(objectElement: ObjectElement) {
       this.element = new SchemaElement();
       handle$schema(objectElement);
       handle$id(objectElement);
+      appendReferenceMetadata(objectElement);
 
       // for further processing consider this Schema Element as parent for all embedded Schema Elements
       this.parent = this.element;