feat(ns-asyncapi-2-0): add support for OperationTrait Object

char0n · char0n · commit 8e72347d798e · 2021-05-31T20:08:42.000+02:00
Refs #387
diff --git a/apidom/packages/apidom-ns-asyncapi-2-0/README.md b/apidom/packages/apidom-ns-asyncapi-2-0/README.md
@@ -151,7 +151,7 @@ Only fully implemented specification objects should be checked here.
 - [x] [Channels Object](https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#channelsObject)
 - [x] [Channel Item Object](https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#channelItemObject)
 - [ ] [Operation Object](https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#operationObject) (partial)
-- [ ] [Operation Trait Object](https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#operationTraitObject)
+- [x] [Operation Trait Object](https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#operationTraitObject)
 - [x] [Message Object](https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#messageObject)
 - [x] [Message Trait Object](https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#messageTraitObject)
 - [x] [Tags Object](https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#tagsObject)
diff --git a/apidom/packages/apidom-ns-asyncapi-2-0/src/elements/OperationTrait.ts b/apidom/packages/apidom-ns-asyncapi-2-0/src/elements/OperationTrait.ts
@@ -0,0 +1,63 @@
+import { Attributes, Meta, ObjectElement, StringElement } from 'minim';
+
+import TagsElement from './Tags';
+import ExternalDocumentationElement from './ExternalDocumentation';
+import OperationBindingsElement from './OperationBindings';
+import ReferenceElement from './Reference';
+
+class OperationTrait extends ObjectElement {
+  constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
+    super(content, meta, attributes);
+    this.element = 'operationTrait';
+  }
+
+  get operationId(): StringElement {
+    return this.get('operationId');
+  }
+
+  set operationId(operationId: StringElement) {
+    this.set('operationId', operationId);
+  }
+
+  get summary(): StringElement {
+    return this.get('summary');
+  }
+
+  set summary(summary: StringElement) {
+    this.set('summary', summary);
+  }
+
+  get description(): StringElement {
+    return this.get('description');
+  }
+
+  set description(description: StringElement) {
+    this.set('description', description);
+  }
+
+  get tags(): TagsElement | undefined {
+    return this.get('tags');
+  }
+
+  set tags(tags: TagsElement | undefined) {
+    this.set('tags', tags);
+  }
+
+  get externalDocs(): ExternalDocumentationElement | undefined {
+    return this.get('externalDocs');
+  }
+
+  set externalDocs(externalDocs: ExternalDocumentationElement | undefined) {
+    this.set('externalDocs', externalDocs);
+  }
+
+  get bindings(): OperationBindingsElement | ReferenceElement | undefined {
+    return this.get('bindings');
+  }
+
+  set bindings(bindings: OperationBindingsElement | ReferenceElement | undefined) {
+    this.set('bindings', bindings);
+  }
+}
+
+export default OperationTrait;
diff --git a/apidom/packages/apidom-ns-asyncapi-2-0/src/index.ts b/apidom/packages/apidom-ns-asyncapi-2-0/src/index.ts
@@ -74,6 +74,7 @@ export { default as OAuthFlowElement } from './elements/OAuthFlow';
 export { default as OAuthFlowsElement } from './elements/OAuthFlows';
 export { default as OperationElement } from './elements/Operation';
 export { default as OperationBindingsElement } from './elements/OperationBindings';
+export { default as OperationTraitElement } from './elements/OperationTrait';
 export { default as ParameterElement } from './elements/Parameter';
 export { default as ParametersElement } from './elements/Parameters';
 export { default as ReferenceElement } from './elements/Reference';
diff --git a/apidom/packages/apidom-ns-asyncapi-2-0/src/namespace.ts b/apidom/packages/apidom-ns-asyncapi-2-0/src/namespace.ts
@@ -23,6 +23,7 @@ import OAuthFlowElement from './elements/OAuthFlow';
 import OAuthFlowsElement from './elements/OAuthFlows';
 import OperationElement from './elements/Operation';
 import OperationBindingsElement from './elements/OperationBindings';
+import OperationTraitElement from './elements/OperationTrait';
 import ParameterElement from './elements/Parameter';
 import ParametersElement from './elements/Parameters';
 import ReferenceElement from './elements/Reference';
@@ -136,6 +137,7 @@ const asyncApi2_0 = {
     base.register('oAuthFlows', OAuthFlowsElement);
     base.register('operation', OperationElement);
     base.register('operationBindings', OperationBindingsElement);
+    base.register('operationTrait', OperationTraitElement);
     base.register('parameter', ParameterElement);
     base.register('parameters', ParametersElement);
     base.register('reference', ReferenceElement);
diff --git a/apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/registration.ts b/apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/registration.ts
@@ -22,6 +22,7 @@ import OAuthFlowElement from '../elements/OAuthFlow';
 import OAuthFlowsElement from '../elements/OAuthFlows';
 import OperationElement from '../elements/Operation';
 import OperationBindingsElement from '../elements/OperationBindings';
+import OperationTraitElement from '../elements/OperationTrait';
 import ParameterElement from '../elements/Parameter';
 import ParametersElement from '../elements/Parameters';
 import ReferenceElement from '../elements/Reference';
@@ -245,6 +246,13 @@ OperationBindingsElement.refract = createRefractor([
   'OperationBindings',
   '$visitor',
 ]);
+OperationTraitElement.refract = createRefractor([
+  'visitors',
+  'document',
+  'objects',
+  'OperationTrait',
+  '$visitor',
+]);
 ParameterElement.refract = createRefractor([
   'visitors',
   'document',
diff --git a/apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/specification.ts b/apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/specification.ts
@@ -99,6 +99,12 @@ import MessageDescriptionVisitor from './visitors/async-api-2-0/message/Descript
 import MessageBindingsVisitor_ from './visitors/async-api-2-0/message/BindingsVisitor';
 import MessageExamplesVisitor from './visitors/async-api-2-0/message/ExamplesVisitor';
 import MessageTraitsVisitor from './visitors/async-api-2-0/message/TraitsVisitor';
+import OperationBindingsVisitor from './visitors/async-api-2-0/operation-bindings';
+import OperationTraitVisitor from './visitors/async-api-2-0/operation-trait';
+import OperationTraitOperationIdVisitor from './visitors/async-api-2-0/operation-trait/OperationIdVisitor';
+import OperationTraitSummaryVisitor from './visitors/async-api-2-0/operation-trait/SummaryVisitor';
+import OperationTraitDescriptionVisitor from './visitors/async-api-2-0/operation-trait/DescriptionVisitor';
+import OperationTraitBindingsVisitor from './visitors/async-api-2-0/operation-trait/BindingsVisitor';
 /**
  * Binding elements.
  */
@@ -207,7 +213,6 @@ import WebSocketChannelBindingBindingVersionVisitor from './visitors/async-api-2
 import WebSocketMessageBindingVisitor from './visitors/async-api-2-0/bindings/ws/message-binding';
 import WebSocketOperationBindingVisitor from './visitors/async-api-2-0/bindings/ws/operation-binding';
 import WebSocketServerBindingVisitor from './visitors/async-api-2-0/bindings/ws/server-binding';
-import OperationBindingsVisitor from './visitors/async-api-2-0/operation-bindings';
 
 /**
  * Specification object allows us to have complete control over visitors
@@ -342,6 +347,21 @@ const specification = {
           $visitor: OperationVisitor,
           fixedFields: {},
         },
+        OperationTrait: {
+          $visitor: OperationTraitVisitor,
+          fixedFields: {
+            operationId: OperationTraitOperationIdVisitor,
+            summary: OperationTraitSummaryVisitor,
+            description: OperationTraitDescriptionVisitor,
+            tags: {
+              $ref: '#/visitors/document/objects/Tags',
+            },
+            externalDocs: {
+              $ref: '#/visitors/document/objects/ExternalDocumentation',
+            },
+            bindings: OperationTraitBindingsVisitor,
+          },
+        },
         Message: {
           $visitor: MessageVisitor,
           fixedFields: {
diff --git a/apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/visitors/async-api-2-0/operation-trait/BindingsVisitor.ts b/apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/visitors/async-api-2-0/operation-trait/BindingsVisitor.ts
@@ -0,0 +1,32 @@
+import stampit from 'stampit';
+import { T as stubTrue } from 'ramda';
+import { ObjectElement } from 'apidom';
+
+import ReferenceElement from '../../../../elements/Reference';
+import AlternatingVisitor from '../../generics/AlternatingVisitor';
+import FallbackVisitor from '../../FallbackVisitor';
+import { isReferenceLikeElement } from '../../../predicates';
+import { isReferenceElement } from '../../../../predicates';
+
+const BindingsVisitor = stampit(AlternatingVisitor, FallbackVisitor, {
+  props: {
+    alternator: [
+      { predicate: isReferenceLikeElement, specPath: ['document', 'objects', 'Reference'] },
+      { predicate: stubTrue, specPath: ['document', 'objects', 'OperationBindings'] },
+    ],
+  },
+  methods: {
+    ObjectElement(objectElement: ObjectElement) {
+      // @ts-ignore
+      const result = AlternatingVisitor.compose.methods.ObjectElement.call(this, objectElement);
+
+      this.element.filter(isReferenceElement).forEach((referenceElement: ReferenceElement) => {
+        referenceElement.setMetaProperty('referenced-element', 'operationBindings');
+      });
+
+      return result;
+    },
+  },
+});
+
+export default BindingsVisitor;
diff --git a/apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/visitors/async-api-2-0/operation-trait/DescriptionVisitor.ts b/apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/visitors/async-api-2-0/operation-trait/DescriptionVisitor.ts
@@ -0,0 +1,5 @@
+import FallbackVisitor from '../../FallbackVisitor';
+
+const DescriptionVisitor = FallbackVisitor;
+
+export default DescriptionVisitor;
diff --git a/apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/visitors/async-api-2-0/operation-trait/OperationIdVisitor.ts b/apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/visitors/async-api-2-0/operation-trait/OperationIdVisitor.ts
@@ -0,0 +1,5 @@
+import FallbackVisitor from '../../FallbackVisitor';
+
+const OperationIdVisitor = FallbackVisitor;
+
+export default OperationIdVisitor;
diff --git a/apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/visitors/async-api-2-0/operation-trait/SummaryVisitor.ts b/apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/visitors/async-api-2-0/operation-trait/SummaryVisitor.ts
@@ -0,0 +1,5 @@
+import FallbackVisitor from '../../FallbackVisitor';
+
+const SummaryVisitor = FallbackVisitor;
+
+export default SummaryVisitor;
diff --git a/apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/visitors/async-api-2-0/operation-trait/index.ts b/apidom/packages/apidom-ns-asyncapi-2-0/src/refractor/visitors/async-api-2-0/operation-trait/index.ts
@@ -0,0 +1,18 @@
+import stampit from 'stampit';
+import { always } from 'ramda';
+
+import OperationTraitElement from '../../../../elements/OperationTrait';
+import FallbackVisitor from '../../FallbackVisitor';
+import FixedFieldsVisitor from '../../generics/FixedFieldsVisitor';
+
+const OperationTraitVisitor = stampit(FixedFieldsVisitor, FallbackVisitor, {
+  props: {
+    specPath: always(['document', 'objects', 'OperationTrait']),
+    canSupportSpecificationExtensions: true,
+  },
+  init() {
+    this.element = new OperationTraitElement();
+  },
+});
+
+export default OperationTraitVisitor;
diff --git a/apidom/packages/apidom-ns-asyncapi-2-0/src/traversal/visitor.ts b/apidom/packages/apidom-ns-asyncapi-2-0/src/traversal/visitor.ts
@@ -31,6 +31,7 @@ export const keyMap = {
   OAuthFlowsElement: ['content'],
   OperationElement: ['content'],
   OperationBindingsElement: ['content'],
+  OperationTraitElement: ['content'],
   ParameterElement: ['content'],
   ParametersElement: ['content'],
   ReferenceElement: ['content'],
