feat(core): added grantType helper to authScheme

Author: pksunkara

packages/api-elements/lib/elements/AuthScheme.js

@@ -18,7 +18,7 @@ class AuthScheme extends ArrayElement {
   /**
    * @name transitions
    * @type ArraySlice
-   * @memberof HttpMessagePayload.prototype
+   * @memberof AuthScheme.prototype
    */
   get transitions() {
     return this.children.filter(item => item.element === 'transition');
@@ -27,11 +27,25 @@ class AuthScheme extends ArrayElement {
   /**
    * @name members
    * @type ArraySlice
-   * @memberof HttpMessagePayload.prototype
+   * @memberof AuthScheme.prototype
    */
   get members() {
     return this.children.filter(item => item.element === 'member');
   }
+
+  /**
+   * @name grantTypeValue
+   * @memberof AuthScheme.prototype
+   */
+  get grantTypeValue() {
+    const grantType = this.members.find(item => item.key.toValue() === 'grantType');
+
+    if (grantType && grantType.value) {
+      return grantType.value.toValue();
+    }
+
+    return undefined;
+  }
 }
 
 module.exports = AuthScheme;

packages/api-elements/test/api-description-test.js

@@ -1003,6 +1003,19 @@ describe('API description namespace', () => {
               },
             },
           },
+          {
+            element: 'member',
+            content: {
+              key: {
+                element: 'string',
+                content: 'grantType',
+              },
+              value: {
+                element: 'string',
+                content: 'token',
+              },
+            },
+          },
           {
             element: 'transition',
             attributes: {
@@ -1039,7 +1052,7 @@ describe('API description namespace', () => {
 
     it('should contain members', () => {
       const { members } = authScheme;
-      expect(members).to.have.length(1);
+      expect(members).to.have.length(2);
       members.forEach((item) => {
         expect(item).to.be.an.instanceof(MemberElement);
       });
@@ -1052,6 +1065,56 @@ describe('API description namespace', () => {
         expect(item).to.be.an.instanceof(Transition);
       });
     });
+
+    it('should retrieve grant type', () => {
+      expect(authScheme.grantTypeValue).to.equal('token');
+    });
+
+    it('without grant type should return undefined', () => {
+      const refracted = {
+        element: 'Token Auth Scheme',
+        meta: {
+          id: {
+            element: 'string',
+            content: 'Custom Token Auth',
+          },
+        },
+        content: [],
+      };
+
+      const element = namespace.fromRefract(refracted);
+      const authScheme = new AuthScheme(element.content, element.meta, element.attributes);
+
+      expect(authScheme.grantTypeValue).to.be.undefined;
+    });
+
+    it('without grant type value should return undefined', () => {
+      const refracted = {
+        element: 'Token Auth Scheme',
+        meta: {
+          id: {
+            element: 'string',
+            content: 'Custom Token Auth',
+          },
+        },
+        content: [
+          {
+            element: 'member',
+            content: {
+              key: {
+                element: 'string',
+                content: 'grantType',
+              },
+            },
+          },
+        ],
+      };
+
+      const element = namespace.fromRefract(refracted);
+      const authScheme = new AuthScheme(element.content, element.meta, element.attributes);
+
+      expect(authScheme.grantTypeValue).to.be.undefined;
+    });
   });
 
   context('HTTP transaction element', () => {