feat(AsyncApi2.0): add support for ChannelItem object

Refs #67
swagger-api · Sep 10, 2020 · 2a06d98 · 2a06d98
1 parent a86241a
commit 2a06d98
Show file tree

Hide file tree

Showing 15 changed files with 297 additions and 2 deletions.
diff --git a/apidom/packages/apidom-ns-asyncapi2-0/src/elements/ChannelBindings.ts b/apidom/packages/apidom-ns-asyncapi2-0/src/elements/ChannelBindings.ts
@@ -0,0 +1,10 @@
+import { Attributes, Meta, ObjectElement } from 'minim';
+
+class ChannelBindings extends ObjectElement {
+  constructor(content?: Array<unknown>, meta?: Meta, attributes?: Attributes) {
+    super(content, meta, attributes);
+    this.element = 'channelBindings';
+  }
+}
+
+export default ChannelBindings;
diff --git a/apidom/packages/apidom-ns-asyncapi2-0/src/elements/ChannelItem.ts b/apidom/packages/apidom-ns-asyncapi2-0/src/elements/ChannelItem.ts
@@ -1,5 +1,9 @@
 import { Attributes, Meta, ObjectElement, StringElement } from 'minim';
 
+import OperationElement from './Operation';
+import ParametersElement from './Parameters';
+import ChannelBindingsElement from './ChannelBindings';
+
 class ChannelItem extends ObjectElement {
   constructor(content?: Array<unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);
@@ -21,6 +25,38 @@ class ChannelItem extends ObjectElement {
   set description(description: StringElement) {
     this.set('description', description);
   }
+
+  get subscribe(): OperationElement {
+    return this.get('subscribe');
+  }
+
+  set subscribe(subscribe: OperationElement) {
+    this.set('subscribe', subscribe);
+  }
+
+  get publish(): OperationElement {
+    return this.get('publish');
+  }
+
+  set publish(publish: OperationElement) {
+    this.set('publish', publish);
+  }
+
+  get parameters(): ParametersElement {
+    return this.get('parameters');
+  }
+
+  set parameters(parameters: ParametersElement) {
+    this.set('parameters', parameters);
+  }
+
+  get bindings(): ChannelBindingsElement {
+    return this.get('bindings');
+  }
+
+  set bindings(bindings: ChannelBindingsElement) {
+    this.set('bindings', bindings);
+  }
 }
 
 export default ChannelItem;
diff --git a/apidom/packages/apidom-ns-asyncapi2-0/src/elements/Operation.ts b/apidom/packages/apidom-ns-asyncapi2-0/src/elements/Operation.ts
@@ -0,0 +1,10 @@
+import { Attributes, Meta, ObjectElement } from 'minim';
+
+class Operation extends ObjectElement {
+  constructor(content?: Array<unknown>, meta?: Meta, attributes?: Attributes) {
+    super(content, meta, attributes);
+    this.element = 'operation';
+  }
+}
+
+export default Operation;
diff --git a/apidom/packages/apidom-ns-asyncapi2-0/src/elements/Parameters.ts b/apidom/packages/apidom-ns-asyncapi2-0/src/elements/Parameters.ts
@@ -0,0 +1,10 @@
+import { Attributes, Meta, ObjectElement } from 'minim';
+
+class Parameters extends ObjectElement {
+  constructor(content?: Array<unknown>, meta?: Meta, attributes?: Attributes) {
+    super(content, meta, attributes);
+    this.element = 'parameters';
+  }
+}
+
+export default Parameters;
diff --git a/apidom/packages/apidom-ns-asyncapi2-0/src/index.ts b/apidom/packages/apidom-ns-asyncapi2-0/src/index.ts
@@ -23,6 +23,7 @@ export {
   isLicenseElement,
   isSchemaElement,
   isChannelsElement,
+  isChannelItemElement,
 } from './predicates';
 
 export { default as AsyncapiElement } from './elements/Asyncapi';
@@ -34,4 +35,7 @@ export { default as InfoElement } from './elements/Info';
 export { default as LicenseElement } from './elements/License';
 export { default as SchemaElement } from './elements/Schema';
 export { default as ChannelsElement } from './elements/Channels';
-export { default as ChannelItem } from './elements/ChannelItem';
+export { default as ChannelItemElement } from './elements/ChannelItem';
+export { default as OperationElement } from './elements/Operation';
+export { default as ParametersElement } from './elements/Parameters';
+export { default as ChannelBindingsElement } from './elements/ChannelBindings';
diff --git a/apidom/packages/apidom-ns-asyncapi2-0/src/namespace.ts b/apidom/packages/apidom-ns-asyncapi2-0/src/namespace.ts
@@ -9,6 +9,9 @@ import Components from './elements/Components';
 import Schema from './elements/Schema';
 import Channels from './elements/Channels';
 import ChannelItem from './elements/ChannelItem';
+import Operation from './elements/Operation';
+import Parameters from './elements/Parameters';
+import ChannelBindings from './elements/ChannelBindings';
 
 const asyncApi2_0 = {
   namespace: (options: NamespacePluginOptions) => {
@@ -24,6 +27,9 @@ const asyncApi2_0 = {
     base.register('schema', Schema);
     base.register('channels', Channels);
     base.register('channelItem', ChannelItem);
+    base.register('operation', Operation);
+    base.register('parameters', Parameters);
+    base.register('channelBindings', ChannelBindings);
 
     return base;
   },

diff --git a/apidom/packages/apidom-ns-asyncapi2-0/src/predicates.ts b/apidom/packages/apidom-ns-asyncapi2-0/src/predicates.ts
@@ -10,6 +10,7 @@ import ContactElement from './elements/Contact';
 import ComponentsElement from './elements/Components';
 import SchemaElement from './elements/Schema';
 import ChannelsElement from './elements/Channels';
+import ChannelItemElement from './elements/ChannelItem';
 
 export const isAsycApi2_0Element = createPredicate(
   ({ hasBasicElementProps, isElementType, primitiveEq, hasGetter, hasClass }) => {
@@ -167,3 +168,31 @@ export const isChannelsElement = createPredicate(
     );
   },
 );
+
+export const isChannelItemElement = createPredicate(
+  ({ hasBasicElementProps, isElementType, primitiveEq, hasGetter }) => {
+    const isElementTypeChannelItem = isElementType('channelItem');
+    const primitiveEqObject = primitiveEq('object');
+    const hasGetter$Ref = hasGetter('$ref');
+    const hasGetterDescription = hasGetter('description');
+    const hasGetterSubscribe = hasGetter('subscribe');
+    const hasGetterPublish = hasGetter('publish');
+    const hasGetterParameters = hasGetter('parameters');
+    const hasGetterBindings = hasGetter('bindings');
+
+    return either(
+      is(ChannelItemElement),
+      allPass([
+        hasBasicElementProps,
+        isElementTypeChannelItem,
+        primitiveEqObject,
+        hasGetter$Ref,
+        hasGetterDescription,
+        hasGetterSubscribe,
+        hasGetterPublish,
+        hasGetterParameters,
+        hasGetterBindings,
+      ]),
+    );
+  },
+);
diff --git a/apidom/packages/apidom-ns-asyncapi2-0/test/predicates.ts b/apidom/packages/apidom-ns-asyncapi2-0/test/predicates.ts
@@ -11,6 +11,7 @@ import {
   isAsycapiElement,
   isAsycApi2_0Element,
   isChannelsElement,
+  isChannelItemElement,
   AsyncApi2_0Element,
   AsyncapiElement,
   SchemaElement,
@@ -20,6 +21,7 @@ import {
   LicenseElement,
   ContactElement,
   ChannelsElement,
+  ChannelItemElement,
 } from '../src';
 
 describe('predicates', function () {
@@ -527,4 +529,72 @@ describe('predicates', function () {
       assert.isFalse(isChannelsElement(channelsElementSwan));
     });
   });
+
+  context('isChannelItemElement', function () {
+    context('given ChannelItem instance value', function () {
+      specify('should return true', function () {
+        const element = new ChannelItemElement();
+
+        assert.isTrue(isChannelItemElement(element));
+      });
+    });
+
+    context('given subtype instance value', function () {
+      specify('should return true', function () {
+        class ChannelItemSubElement extends ChannelItemElement {}
+
+        assert.isTrue(isChannelItemElement(new ChannelItemSubElement()));
+      });
+    });
+
+    context('given non ChannelItem instance value', function () {
+      specify('should return false', function () {
+        assert.isFalse(isChannelItemElement(1));
+        assert.isFalse(isChannelItemElement(null));
+        assert.isFalse(isChannelItemElement(undefined));
+        assert.isFalse(isChannelItemElement({}));
+        assert.isFalse(isChannelItemElement([]));
+        assert.isFalse(isChannelItemElement('string'));
+      });
+    });
+
+    specify('should support duck-typing', function () {
+      const channelItemElementDuck = {
+        element: 'channelItem',
+        content: [],
+        primitive() {
+          return 'object';
+        },
+        get $ref() {
+          return '$ref';
+        },
+        get description() {
+          return 'description';
+        },
+        get subscribe() {
+          return 'subscribe';
+        },
+        get publish() {
+          return 'publish';
+        },
+        get parameters() {
+          return 'parameters';
+        },
+        get bindings() {
+          return 'bindings';
+        },
+      };
+
+      const channelItemElementSwan = {
+        element: undefined,
+        content: undefined,
+        primitive() {
+          return 'swan';
+        },
+      };
+
+      assert.isTrue(isChannelItemElement(channelItemElementDuck));
+      assert.isFalse(isChannelItemElement(channelItemElementSwan));
+    });
+  });
 });
diff --git a/apidom/packages/apidom-parser-adapter-asyncapi2-0-json/src/parser/specification.ts b/apidom/packages/apidom-parser-adapter-asyncapi2-0-json/src/parser/specification.ts
@@ -23,6 +23,11 @@ import ComponentsVisitor from './visitors/async-api-2-0/components';
 import SchemasVisitor from './visitors/async-api-2-0/components/SchemasVisitor';
 import ChannelsVisitor from './visitors/async-api-2-0/channels';
 import ChannelItemVisitor from './visitors/async-api-2-0/channel-item';
+import ChannelItem$RefVisitor from './visitors/async-api-2-0/channel-item/$RefVisitor';
+import ChannelItemDescriptionVisitor from './visitors/async-api-2-0/channel-item/DescriptionVisitor';
+import ChannelBindingsVisitor from './visitors/async-api-2-0/channel-bindings';
+import OperationVisitor from './visitors/async-api-2-0/operation';
+import ParametersVisitor from './visitors/async-api-2-0/parameters';
 
 /**
  * Specification object allows us to have complete control over visitors
@@ -96,8 +101,34 @@ const specification = {
         },
         ChannelItem: {
           $visitor: ChannelItemVisitor,
+          fields: {
+            $ref: ChannelItem$RefVisitor,
+            description: ChannelItemDescriptionVisitor,
+            subscribe: {
+              $ref: '#/visitors/document/objects/Operation',
+            },
+            publish: {
+              $ref: '#/visitors/document/objects/Operation',
+            },
+            parameters: {
+              $ref: '#/visitors/document/objects/Parameters',
+            },
+            bindings: {
+              $ref: '#/visitors/document/objects/ChannelBindings',
+            },
+          },
+        },
+        ChannelBindings: {
+          $visitor: ChannelBindingsVisitor,
           fields: {},
         },
+        Operation: {
+          $visitor: OperationVisitor,
+          fields: {},
+        },
+        Parameters: {
+          $visitor: ParametersVisitor,
+        },
         Components: {
           $visitor: ComponentsVisitor,
           fields: {

diff --git a/...rser-adapter-asyncapi2-0-json/src/parser/visitors/async-api-2-0/channel-bindings/index.ts b/...rser-adapter-asyncapi2-0-json/src/parser/visitors/async-api-2-0/channel-bindings/index.ts
@@ -0,0 +1,15 @@
+import stampit from 'stampit';
+import { always } from 'ramda';
+
+import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
+
+const ChannelBindingsVisitor = stampit(FixedFieldsJsonObjectVisitor, {
+  props: {
+    specPath: always(['document', 'objects', 'ChannelBindings']),
+  },
+  init() {
+    this.element = new this.namespace.elements.ChannelBindings();
+  },
+});
+
+export default ChannelBindingsVisitor;
diff --git a/...er-adapter-asyncapi2-0-json/src/parser/visitors/async-api-2-0/channel-item/$RefVisitor.ts b/...er-adapter-asyncapi2-0-json/src/parser/visitors/async-api-2-0/channel-item/$RefVisitor.ts
@@ -0,0 +1,18 @@
+import stampit from 'stampit';
+
+import SpecificationVisitor from '../../SpecificationVisitor';
+import { BREAK } from '../..';
+
+const $RefVisitor = stampit(SpecificationVisitor, {
+  methods: {
+    string(stringNode) {
+      const refElement = new this.namespace.elements.Ref(stringNode.value);
+      refElement.path = stringNode.value;
+      this.element = this.maybeAddSourceMap(stringNode, refElement);
+
+      return BREAK;
+    },
+  },
+});
+
+export default $RefVisitor;
diff --git a/...ter-asyncapi2-0-json/src/parser/visitors/async-api-2-0/channel-item/DescriptionVisitor.ts b/...ter-asyncapi2-0-json/src/parser/visitors/async-api-2-0/channel-item/DescriptionVisitor.ts
@@ -0,0 +1,6 @@
+import stampit from 'stampit';
+import JsonStringVisitor from '../../generics/JsonStringVisitor';
+
+const DescriptionVisitor = stampit(JsonStringVisitor);
+
+export default DescriptionVisitor;
diff --git a/...idom-parser-adapter-asyncapi2-0-json/src/parser/visitors/async-api-2-0/operation/index.ts b/...idom-parser-adapter-asyncapi2-0-json/src/parser/visitors/async-api-2-0/operation/index.ts
@@ -0,0 +1,15 @@
+import stampit from 'stampit';
+import { always } from 'ramda';
+
+import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
+
+const OperationVisitor = stampit(FixedFieldsJsonObjectVisitor, {
+  props: {
+    specPath: always(['document', 'objects', 'Operation']),
+  },
+  init() {
+    this.element = new this.namespace.elements.Operation();
+  },
+});
+
+export default OperationVisitor;
diff --git a/...dom-parser-adapter-asyncapi2-0-json/src/parser/visitors/async-api-2-0/parameters/index.ts b/...dom-parser-adapter-asyncapi2-0-json/src/parser/visitors/async-api-2-0/parameters/index.ts
@@ -0,0 +1,12 @@
+import stampit from 'stampit';
+import { test } from 'ramda';
+
+import PatternedFieldsJsonObjectVisitor from '../../generics/PatternedFieldsJsonObjectVisitor';
+
+const ParametersVisitor = stampit(PatternedFieldsJsonObjectVisitor, {
+  props: {
+    fieldPatternPredicate: test(/^[A-Za-z0-9_\\-]+$/),
+  },
+});
+
+export default ParametersVisitor;
diff --git a/apidom/packages/apidom-parser-adapter-asyncapi2-0-json/test/fixtures/sample-api.json b/apidom/packages/apidom-parser-adapter-asyncapi2-0-json/test/fixtures/sample-api.json
@@ -18,8 +18,31 @@
   },
   "channels": {
     "user/signup": {
+      "description": "This channel is used to exchange messages about users signing up",
       "subscribe": {
-        "$ref": "#/components/messages/userSignUp"
+        "summary": "A user signed up.",
+        "message": {
+          "description": "A longer description of the message",
+          "payload": {
+            "type": "object",
+            "properties": {
+              "user": {
+                "$ref": "#/components/schemas/user"
+              },
+              "signup": {
+                "$ref": "#/components/schemas/signup"
+              }
+            }
+          }
+        }
+      },
+      "bindings": {
+        "amqp": {
+          "is": "queue",
+          "queue": {
+            "exclusive": true
+          }
+        }
       }
     }
   },