Merge pull request #1228 from opencomponents/routes-helpers-ts

move routes helpers to TS

Author: ricardo-devis-agullo

src/cli/domain/registry.js

@@ -101,6 +101,7 @@ module.exports = function(opts) {
           const parsed = urlParser.parse(res);
           callback(
             null,
+            // @ts-ignore
             urlBuilder.componentPreview(parsed, parsed.registryUrl)
           );
         }

src/registry/domain/url-builder.js

@@ -0,0 +1,77 @@
+import querystring from 'querystring';
+import url from 'url';
+
+type Component = {
+  name: string;
+  version?: string;
+  parameters?: Dictionary<string>;
+};
+
+function componentForType(
+  component: Component | string,
+  baseUrl: string,
+  type: string
+): string {
+  if (typeof component === 'string') {
+    component = { name: component };
+  }
+
+  let href = url.resolve(baseUrl, component.name) + '/';
+
+  if (component.version) {
+    href += component.version + '/';
+  }
+
+  href += '~' + type;
+
+  return href;
+}
+
+export function component(component: Component | string, baseUrl: string) {
+  if (typeof component === 'string') {
+    component = { name: component };
+  }
+
+  let componentUrl = url.resolve(baseUrl, component.name);
+
+  if (component.version) {
+    componentUrl += '/' + component.version;
+  }
+
+  componentUrl += queryString(component.parameters);
+
+  return componentUrl;
+}
+export function componentInfo(component: Component, baseUrl: string): string {
+  return componentForType(component, baseUrl, 'info');
+}
+export function componentPreview(
+  component: Component,
+  baseUrl: string
+): string {
+  let href = componentForType(component, baseUrl, 'preview');
+  if (!!component.parameters && Object.keys(component.parameters).length) {
+    href += '/?' + querystring.stringify(component.parameters);
+  } else {
+    href += '/';
+  }
+
+  return href;
+}
+export function queryString(parameters: Dictionary<string> = {}): string {
+  let qs = '';
+
+  if (Object.keys(parameters).length > 0) {
+    qs += '?';
+
+    for (const [key, parameter] of Object.entries(parameters)) {
+      qs += key + '=' + encodeURIComponent(parameter) + '&';
+    }
+
+    if (Object.keys(parameters).length > 0) {
+      qs = qs.slice(0, -1);
+    }
+  }
+
+  return qs;
+}

src/registry/domain/url-builder.ts

@@ -5,7 +5,7 @@ const _ = require('lodash');
 
 const getComponentFallback = require('./helpers/get-component-fallback');
 const infoView = require('../views/info');
-const isUrlDiscoverable = require('./helpers/is-url-discoverable');
+const isUrlDiscoverable = require('./helpers/is-url-discoverable').default;
 const urlBuilder = require('../domain/url-builder');
 
 function getParams(component) {
@@ -65,6 +65,7 @@ function componentInfo(err, req, res, component) {
           href,
           parsedAuthor,
           repositoryUrl,
+          // @ts-ignore
           sandBoxDefaultQs: urlBuilder.queryString(params),
           title: 'Component Info'
         })

src/registry/routes/component-info.js

@@ -0,0 +1,21 @@
+import { OcParameter } from '../../../types';
+
+export default function applyDefaultValues(
+  requestParameters: Dictionary<string | number | boolean> = {},
+  expectedParameters: Dictionary<OcParameter> = {}
+): Dictionary<string | number | boolean> {
+  const optionalParametersWithDefaults = Object.entries(
+    expectedParameters
+  ).filter(([, p]) => !p.mandatory && typeof p.default !== 'undefined');
+
+  optionalParametersWithDefaults.forEach(
+    ([expectedParameterName, expectedParameter]) => {
+      const param = requestParameters[expectedParameterName];
+      if (param === null || param === undefined) {
+        requestParameters[expectedParameterName] = expectedParameter.default!;
+      }
+    }
+  );
+
+  return requestParameters;
+}

src/registry/routes/helpers/apply-default-values.js

@@ -0,0 +1,31 @@
+interface Options {
+  headers: Dictionary<string>;
+  name: string;
+  parameters: Dictionary<string>;
+  version: string;
+}
+
+export default function getComponentRetrievingInfo(options: Options) {
+  let eventData = {
+    headers: options.headers,
+    name: options.name,
+    parameters: options.parameters,
+    requestVersion: options.version || '',
+    duration: 0
+  };
+
+  const start = process.hrtime();
+
+  return {
+    extend(obj: Dictionary<string>) {
+      Object.assign(eventData, obj);
+    },
+    getData() {
+      const delta = process.hrtime(start);
+      const nanosec = delta[0] * 1e9 + delta[1];
+      eventData.duration = nanosec / 1e3;
+
+      return eventData;
+    }
+  };
+}

src/registry/routes/helpers/apply-default-values.ts

@@ -8,9 +8,10 @@ const emptyResponseHandler = require('oc-empty-response-handler');
 const vm = require('vm');
 const _ = require('lodash');
 
-const applyDefaultValues = require('./apply-default-values');
+const applyDefaultValues = require('./apply-default-values').default;
 const eventsHandler = require('../../domain/events-handler');
-const GetComponentRetrievingInfo = require('./get-component-retrieving-info');
+const GetComponentRetrievingInfo = require('./get-component-retrieving-info')
+  .default;
 const getComponentFallback = require('./get-component-fallback');
 const isTemplateLegacy = require('../../../utils/is-template-legacy').default;
 const NestedRenderer = require('../../domain/nested-renderer');
@@ -188,6 +189,7 @@ module.exports = function(conf, repository) {
             {
               name: component.name,
               version: requestedComponent.version,
+              // @ts-ignore
               parameters: params
             },
             conf.baseUrl