add more info

Author: mattiaerre

__tests__/__snapshots__/index.test.js.snap

@@ -12,7 +12,7 @@ Array [
 exports[`expect res setHeader and end to match snapshot 2`] = `
 Array [
   Array [
-    "{\\"data\\":{\\"registry\\":{\\"href\\":\\"http://mock:3000/\\",\\"ocVersion\\":\\"1.2.3\\",\\"type\\":\\"mock-registry\\"},\\"components\\":[{\\"name\\":\\"oc-a-component\\",\\"description\\":\\"Awesome OpenComponent\\",\\"version\\":\\"4.5.6\\"}],\\"component\\":{\\"name\\":\\"oc-a-component\\",\\"description\\":\\"Awesome OpenComponent\\",\\"version\\":\\"4.5.6\\"}}}",
+    "{\\"data\\":{\\"registry\\":{\\"href\\":\\"http://mock:3000/\\",\\"ocVersion\\":\\"1.2.3\\",\\"type\\":\\"mock-registry\\"},\\"components\\":[{\\"name\\":\\"oc-a-component\\",\\"description\\":\\"Awesome OpenComponent\\",\\"version\\":\\"4.5.6\\",\\"allVersions\\":[\\"4.5.4\\",\\"4.5.5\\",\\"4.5.6\\"],\\"author\\":null,\\"repository\\":null,\\"parameters\\":[{\\"key\\":\\"id\\",\\"type\\":\\"string\\",\\"mandatory\\":true,\\"example\\":\\"815\\",\\"description\\":\\"The Id\\"}]}],\\"component\\":{\\"name\\":\\"oc-a-component\\",\\"description\\":\\"Awesome OpenComponent\\",\\"version\\":\\"4.5.6\\",\\"allVersions\\":[\\"4.5.4\\",\\"4.5.5\\",\\"4.5.6\\"],\\"author\\":null,\\"repository\\":null,\\"parameters\\":[{\\"key\\":\\"id\\",\\"type\\":\\"string\\",\\"mandatory\\":true,\\"example\\":\\"815\\",\\"description\\":\\"The Id\\"}]}}}",
   ],
 ]
 `;

__tests__/index.test.js

@@ -8,11 +8,64 @@ const options = {
 
 const middleware = factory(options);
 
+const query = `
+{
+  registry {
+    href
+    ocVersion
+    type
+  }
+  components {
+    name
+    description
+    version
+    allVersions
+    author {
+      name
+      email
+    }
+    repository {
+      type
+      url
+    }
+    parameters {
+      key
+      type
+      mandatory
+      example
+      description
+    }
+  }
+  component(name: "oc-apod") {
+    name
+    description
+    version
+    allVersions
+    author {
+      name
+      email
+    }
+    repository {
+      type
+      url
+    }
+    parameters {
+      key
+      type
+      mandatory
+      example
+      description
+    }
+  }
+}
+`;
+
 test('expect type of middleware to be function', () => {
   expect(typeof middleware).toBe('function');
 });
 
 test('expect res setHeader and end to match snapshot', async () => {
+  // todo: change mockResponse
   fetch.mockResponse(JSON.stringify({
     href: options.baseUrl,
     ocVersion: '1.2.3',
@@ -22,31 +75,24 @@ test('expect res setHeader and end to match snapshot', async () => {
     ],
     name: 'oc-a-component',
     description: 'Awesome OpenComponent',
-    version: '4.5.6'
+    version: '4.5.6',
+    allVersions: ['4.5.4', '4.5.5', '4.5.6'],
+    oc: {
+      parameters: {
+        id: {
+          type: 'string',
+          mandatory: true,
+          example: '815',
+          description: 'The Id'
+        }
+      }
+    }
   }));
 
   const req = {
     method: 'GET',
     headers: {},
-    url: `?query=
-    {
-      registry {
-        href
-        ocVersion
-        type
-      }
-      components {
-        name
-        description
-        version
-      }
-      component(name: "oc-a-component") {
-        name
-        description
-        version
-      }
-    }
-    `
+    url: `?query=${query}`
   };
 
   const res = { setHeader: jest.fn(), end: jest.fn() };

dist/index.js

@@ -1,5 +1,7 @@
 'use strict';
 
+var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
+
 function _asyncToGenerator(fn) { return function () { var gen = fn.apply(this, arguments); return new Promise(function (resolve, reject) { function step(key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { return Promise.resolve(value).then(function (value) { step("next", value); }, function (err) { step("throw", err); }); } } return step("next"); }); }; }
 
 /* eslint-disable arrow-body-style */
@@ -11,7 +13,7 @@ var _require = require('graphql'),
 
 var fetch = require('node-fetch');
 
-var schema = buildSchema('\n  type Registry {\n    href: String\n    ocVersion: String\n    type: String\n  }\n\n  type Component {\n    name: String\n    description: String\n    version: String\n  }\n\n  type Query {\n    registry: Registry\n    component(name: String): Component\n    components: [Component]\n  }\n');
+var schema = buildSchema('\n  type Registry {\n    href: String\n    ocVersion: String\n    type: String\n  }\n\n  type Person {\n    name: String\n    email: String\n  }\n\n  type Repository {\n    type: String\n    url: String\n  }\n\n  type Parameter {\n    key: String\n    type: String\n    mandatory: Boolean\n    example: String\n    description: String\n  }\n\n  type Component {\n    name: String\n    description: String\n    version: String\n    allVersions: [String]\n    author: Person\n    repository: Repository\n    parameters: [Parameter]\n  }\n\n  type Query {\n    registry: Registry\n    component(name: String): Component\n    components: [Component]\n  }\n');
 
 var fetchComponent = function () {
   var _ref = _asyncToGenerator(regeneratorRuntime.mark(function _callee(url) {
@@ -40,7 +42,7 @@ var fetchComponent = function () {
 
 var makeComponent = function () {
   var _ref2 = _asyncToGenerator(regeneratorRuntime.mark(function _callee2(baseUrl, name) {
-    var url, info, copy;
+    var url, info, parameters, copy;
     return regeneratorRuntime.wrap(function _callee2$(_context2) {
       while (1) {
         switch (_context2.prev = _context2.next) {
@@ -51,10 +53,18 @@ var makeComponent = function () {
 
           case 3:
             info = _context2.sent;
-            copy = Object.assign({}, info);
+            parameters = [];
+
+            if (info.oc.parameters) {
+              parameters = Object.keys(info.oc.parameters).map(function (key) {
+                return _extends({ key: key }, info.oc.parameters[key]);
+              });
+            }
+
+            copy = Object.assign({}, info, { parameters: parameters });
             return _context2.abrupt('return', copy);
 
-          case 6:
+          case 8:
           case 'end':
             return _context2.stop();
         }

src/index.js

@@ -11,10 +11,32 @@ const schema = buildSchema(`
     type: String
   }
 
+  type Person {
+    name: String
+    email: String
+  }
+
+  type Repository {
+    type: String
+    url: String
+  }
+
+  type Parameter {
+    key: String
+    type: String
+    mandatory: Boolean
+    example: String
+    description: String
+  }
+
   type Component {
     name: String
     description: String
     version: String
+    allVersions: [String]
+    author: Person
+    repository: Repository
+    parameters: [Parameter]
   }
 
   type Query {
@@ -35,7 +57,14 @@ const fetchComponent = async (url) => {
 const makeComponent = async (baseUrl, name) => {
   const url = `${baseUrl}${name}/~info`;
   const info = await fetchComponent(url);
-  const copy = Object.assign({}, info);
+
+  let parameters = [];
+  if (info.oc.parameters) {
+    parameters = Object.keys(info.oc.parameters)
+      .map(key => ({ key, ...info.oc.parameters[key] }));
+  }
+
+  const copy = Object.assign({}, info, { parameters });
   return copy;
 };