merge master

ricardo-devis-agullo · ricardo-devis-agullo · commit 175cfe92c4f1 · 2021-10-12T12:51:32.000+02:00
diff --git a/src/registry/domain/authentication.ts b/src/registry/domain/authentication.ts
@@ -1,11 +1,15 @@
 import basicAuth from 'basic-auth-connect';
+import { RequestHandler } from 'express';
 import path from 'path';
 
 import strings from '../../resources/';
 
 type Validate<T = unknown> = (
   config: T
-) => { isValid: boolean; message: string };
+) => {
+  isValid: boolean;
+  message: string;
+};
 type Middleware<T> = (config: T) => any;
 
 type Authentication<T = any> = {
@@ -63,6 +67,6 @@ export function validate(authConfig: { type: string }) {
   return scheme.validate(authConfig);
 }
 
-export function middleware(authConfig: any) {
+export function middleware(authConfig: unknown): RequestHandler {
   return scheme.middleware(authConfig);
 }
diff --git a/src/registry/domain/events-handler.ts b/src/registry/domain/events-handler.ts
@@ -3,7 +3,7 @@ import strings from '../../resources';
 type Subscription<T = any> = (data: T) => void;
 let subscriptions: Record<string, Array<Subscription>> = {};
 
-export function fire(eventName: string, eventData: any): void {
+export function fire(eventName: string, eventData: unknown): void {
   if (subscriptions[eventName]) {
     subscriptions[eventName].forEach(callback => {
       callback(eventData);
diff --git a/src/registry/domain/require-wrapper.ts b/src/registry/domain/require-wrapper.ts
@@ -1,31 +1,31 @@
-'use strict';
+import coreModules from 'builtin-modules';
+import path from 'path';
+import requirePackageName from 'require-package-name';
+import tryRequire from 'try-require';
+import _ from 'lodash';
 
-const coreModules = require('builtin-modules');
-const path = require('path');
-const requirePackageName = require('require-package-name');
-const tryRequire = require('try-require');
-const _ = require('lodash');
+import strings from '../../resources';
 
-const strings = require('../../resources').default;
-
-const isCoreDependency = x => _.includes(coreModules, x);
-const requireCoreDependency = x =>
+const isCoreDependency = (x: string) => _.includes(coreModules, x);
+const requireCoreDependency = (x: string) =>
   (isCoreDependency(x) && tryRequire(x)) || undefined;
 
-const requireDependency = requirePath => {
+const requireDependency = (requirePath: string) => {
   const nodeModulesPath = path.resolve('.', 'node_modules');
   const modulePath = path.resolve(nodeModulesPath, requirePath);
   return tryRequire(modulePath);
 };
 
-const throwError = requirePath => {
+const throwError = (requirePath: string) => {
   throw {
     code: strings.errors.registry.DEPENDENCY_NOT_FOUND_CODE,
     missing: [requirePath]
   };
 };
 
-module.exports = injectedDependencies => requirePath => {
+export default (injectedDependencies: string[]) => <T = unknown>(
+  requirePath: string
+): T => {
   const moduleName = requirePackageName(requirePath);
   const isAllowed = _.includes(injectedDependencies, moduleName);
 
diff --git a/src/registry/domain/url-builder.ts b/src/registry/domain/url-builder.ts
@@ -27,7 +27,10 @@ function componentForType(
   return href;
 }
 
-export function component(component: Component | string, baseUrl: string) {
+export function component(
+  component: Component | string,
+  baseUrl: string
+): string {
   if (typeof component === 'string') {
     component = { name: component };
   }
diff --git a/src/registry/middleware/base-url-handler.ts b/src/registry/middleware/base-url-handler.ts
@@ -4,7 +4,7 @@ export default function baseUrlHandler(
   req: Request,
   res: Response,
   next: NextFunction
-) {
+): void {
   res.conf.baseUrlFunc =
     res.conf.baseUrlFunc ||
     (typeof res.conf.baseUrl === 'function' ? res.conf.baseUrl : undefined);
diff --git a/src/registry/middleware/cors.ts b/src/registry/middleware/cors.ts
@@ -1,6 +1,10 @@
 import { NextFunction, Request, Response } from 'express';
 
-export default function cors(req: Request, res: Response, next: NextFunction) {
+export default function cors(
+  req: Request,
+  res: Response,
+  next: NextFunction
+): void {
   res.removeHeader('X-Powered-By');
   res.header('Access-Control-Allow-Credentials', 'true');
   res.header('Access-Control-Allow-Origin', '*');
diff --git a/src/registry/middleware/discovery-handler.ts b/src/registry/middleware/discovery-handler.ts
@@ -4,7 +4,7 @@ export default function discoveryHandler(
   req: Request,
   res: Response,
   next: NextFunction
-) {
+): void {
   res.conf.discoveryFunc =
     res.conf.discoveryFunc ||
     (typeof res.conf.discovery === 'function' ? res.conf.discovery : undefined);
diff --git a/src/registry/middleware/file-uploads.ts b/src/registry/middleware/file-uploads.ts
@@ -5,7 +5,7 @@ export default function fileUpload(
   req: Request,
   res: Response,
   next: NextFunction
-) {
+): void {
   if (res.conf.local) {
     return next();
   }
diff --git a/src/registry/middleware/index.ts b/src/registry/middleware/index.ts
@@ -17,7 +17,7 @@ const bodyParserUrlEncodedArgument: { extended: boolean; limit?: number } = {
   extended: true
 };
 
-export const bind = (app: Express, options: Config) => {
+export const bind = (app: Express, options: Config): Express => {
   app.set('port', options.port);
   app.set('json spaces', 0);
 
diff --git a/src/registry/middleware/request-handler.ts b/src/registry/middleware/request-handler.ts
@@ -1,4 +1,4 @@
-import { Request, Response } from 'express';
+import { Request, RequestHandler, Response } from 'express';
 import { IncomingHttpHeaders } from 'http';
 import responseTime from 'response-time';
 
@@ -18,7 +18,7 @@ interface ResponseTimeData {
   errorCode?: string;
 }
 
-export default function requestHandler() {
+export default function requestHandler(): RequestHandler {
   return responseTime((req: Request, res: Response, time) => {
     const data: ResponseTimeData = {
       body: req.body,
diff --git a/src/registry/router.js b/src/registry/router.js
@@ -10,7 +10,7 @@ const IndexRoute = require('./routes');
 const PublishRoute = require('./routes/publish').default;
 const StaticRedirectorRoute = require('./routes/static-redirector').default;
 const PluginsRoute = require('./routes/plugins').default;
-const DependenciesRoute = require('./routes/dependencies');
+const DependenciesRoute = require('./routes/dependencies').default;
 const settings = require('../resources/settings').default;
 
 module.exports.create = function(app, conf, repository) {
diff --git a/src/registry/routes/dependencies.ts b/src/registry/routes/dependencies.ts
@@ -1,13 +1,16 @@
-'use strict';
+import { Request, Response } from 'express';
+import { Config } from '../../types';
+import getAvailableDependencies from './helpers/get-available-dependencies';
 
-const getAvailableDependencies = require('./helpers/get-available-dependencies');
-
-module.exports = function(conf) {
-  return function(req, res) {
+export default function dependencies(conf: Config) {
+  return function(req: Request, res: Response): void {
     if (conf.discovery) {
       const dependencies = getAvailableDependencies(conf.dependencies).map(
         ({ core, name, version }) => {
-          const dep = { name, core };
+          const dep: { name: string; core: boolean; versions?: string[] } = {
+            name,
+            core
+          };
           if (!core && version) {
             // In the future this could be multiple versions
             dep.versions = [version];
@@ -21,4 +24,4 @@ module.exports = function(conf) {
       res.status(401);
     }
   };
-};
+}
diff --git a/src/registry/routes/helpers/get-available-dependencies.js b/src/registry/routes/helpers/get-available-dependencies.js
diff --git a/src/registry/routes/helpers/get-available-dependencies.ts b/src/registry/routes/helpers/get-available-dependencies.ts
@@ -0,0 +1,31 @@
+import coreModules from 'builtin-modules';
+import _ from 'lodash';
+
+import RequireWrapper from '../../domain/require-wrapper';
+
+interface AvailableDependency {
+  core: boolean;
+  name: string;
+  version?: string;
+  link: string;
+}
+
+export default function getAvailableDependencies(
+  dependencies: string[]
+): AvailableDependency[] {
+  return _.map(dependencies, dependency => {
+    const requirer = RequireWrapper(dependencies);
+    const core = _.includes(coreModules, dependency);
+    const packageJson = !core
+      ? requirer<{ version: string; homepage: string }>(
+          `${dependency}/package.json`
+        )
+      : undefined;
+    const version = packageJson?.version;
+    const link = core
+      ? `https://nodejs.org/api/${dependency}.html`
+      : packageJson?.homepage ?? '';
+
+    return { core, name: dependency, version, link };
+  });
+}
diff --git a/src/registry/routes/helpers/get-component.js b/src/registry/routes/helpers/get-component.js
@@ -15,7 +15,7 @@ const GetComponentRetrievingInfo = require('./get-component-retrieving-info')
 const getComponentFallback = require('./get-component-fallback');
 const isTemplateLegacy = require('../../../utils/is-template-legacy').default;
 const NestedRenderer = require('../../domain/nested-renderer').default;
-const RequireWrapper = require('../../domain/require-wrapper');
+const RequireWrapper = require('../../domain/require-wrapper').default;
 const sanitiser = require('../../domain/sanitiser');
 const settings = require('../../../resources/settings').default;
 const strings = require('../../../resources').default;
diff --git a/src/registry/routes/helpers/get-components-history.ts b/src/registry/routes/helpers/get-components-history.ts
@@ -1,14 +1,22 @@
 import { ComponentsDetails } from '../../../types';
 import dateStringified from '../../../utils/date-stringify';
 
-interface ComponentHistory {
+interface UnformmatedComponentHistory {
   name: string;
+  version: string;
   publishDate: number;
+}
+
+interface ComponentHistory {
+  name: string;
   version: string;
+  publishDate: string;
 }
 
-export default function getComponentsHistory(history: ComponentsDetails) {
-  const result: ComponentHistory[] = [];
+export default function getComponentsHistory(
+  history: ComponentsDetails
+): ComponentHistory[] {
+  const result: UnformmatedComponentHistory[] = [];
 
   for (const [name, versions] of Object.entries(history.components)) {
     for (const [version, details] of Object.entries(versions)) {
diff --git a/src/registry/routes/helpers/is-url-discoverable.ts b/src/registry/routes/helpers/is-url-discoverable.ts
@@ -3,7 +3,7 @@ import request from 'minimal-request';
 export default function isUrlDiscoverable(
   url: string,
   callback: Callback<{ isDiscoverable: boolean }, null>
-) {
+): void {
   request(
     {
       url,
diff --git a/src/registry/routes/index.js b/src/registry/routes/index.js
@@ -7,7 +7,8 @@ const _ = require('lodash');
 const dateStringified = require('../../utils/date-stringify').default;
 const getComponentsHistory = require('./helpers/get-components-history')
   .default;
-const getAvailableDependencies = require('./helpers/get-available-dependencies');
+const getAvailableDependencies = require('./helpers/get-available-dependencies')
+  .default;
 const indexView = require('../views').default;
 // @ts-ignore
 const packageInfo = require('../../../package.json');
diff --git a/test/unit/registry-domain-require-wrapper.js b/test/unit/registry-domain-require-wrapper.js
@@ -4,7 +4,8 @@ const expect = require('chai').expect;
 const vm = require('vm');
 
 describe('registry : domain : require-wrapper', () => {
-  const RequireWrapper = require('../../dist/registry/domain/require-wrapper');
+  const RequireWrapper = require('../../dist/registry/domain/require-wrapper')
+    .default;
 
   describe('when using the require wrapper in a clear context', () => {
     let result, error;
diff --git a/test/unit/registry-routes-dependencies.js b/test/unit/registry-routes-dependencies.js
@@ -26,7 +26,7 @@ describe('registry : routes : plugins', () => {
       './helpers/get-available-dependencies': list =>
         list.map(dep => dependencyMap[dep])
     }
-  );
+  ).default;
 
   const initialise = function() {
     resJsonStub = sinon.stub();
diff --git a/test/unit/registry-routes-helpers-get-available-dependencies.js b/test/unit/registry-routes-helpers-get-available-dependencies.js
@@ -13,7 +13,7 @@ describe('registry : routes : helpers : get-available-dependencies', () => {
         homepage: `https://${pathToPackageJson.split('/')[0]}.com/`
       })
     }
-  );
+  ).default;
 
   describe('happy path', () => {
     let result;
@@ -30,7 +30,7 @@ describe('registry : routes : helpers : get-available-dependencies', () => {
         {
           core: true,
           name: 'url',
-          version: false,
+          version: undefined,
           link: 'https://nodejs.org/api/url.html'
         }
       ]);

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,10 @@ function componentForType(`
`27`	`27`	`return href;`
`28`	`28`	`}`
`29`	`29`
`30`		`-export function component(component: Component \| string, baseUrl: string) {`
	`30`	`+export function component(`
	`31`	`+ component: Component \| string,`
	`32`	`+ baseUrl: string`
	`33`	`+): string {`
`31`	`34`	`if (typeof component === 'string') {`
`32`	`35`	`component = { name: component };`
`33`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ export default function fileUpload(`
`5`	`5`	`req: Request,`
`6`	`6`	`res: Response,`
`7`	`7`	`next: NextFunction`
`8`		`-) {`
	`8`	`+): void {`
`9`	`9`	`if (res.conf.local) {`
`10`	`10`	`return next();`
`11`	`11`	`}`