Merge pull request #1229 from opencomponents/mocks-auth-clean-require-ts

move mocks, authentication and clean-require to TS

Author: ricardo-devis-agullo

package.json

@@ -44,75 +44,75 @@
     "oc"
   ],
   "devDependencies": {
-    "@types/errorhandler": "^1.5.0",
-    "@types/express": "^4.17.13",
-    "@types/morgan": "^1.9.3",
-    "@types/multer": "^1.4.7",
-    "@types/colors": "^1.2.1",
-    "@types/node": "^16.9.6",
-    "@types/semver": "^7.3.8",
-    "@types/yargs": "^17.0.3",
-    "@typescript-eslint/eslint-plugin": "^4.31.2",
-    "@typescript-eslint/parser": "^4.31.2",
+    "@types/errorhandler": "1.5.0",
+    "@types/express": "4.17.13",
+    "@types/morgan": "1.9.3",
+    "@types/multer": "1.4.7",
+    "@types/colors": "1.2.1",
+    "@types/node": "16.10.1",
+    "@types/semver": "7.3.8",
+    "@types/yargs": "17.0.3",
+    "@typescript-eslint/eslint-plugin": "4.32.0",
+    "@typescript-eslint/parser": "4.32.0",
     "chai": "4.3.4",
     "chalk": "4.1.2",
     "glob": "7.2.0",
     "husky": "7.0.2",
     "injectr": "0.5.1",
     "lint-staged": "11.1.2",
     "minimist": "1.2.5",
-    "mocha": "9.1.1",
+    "mocha": "9.1.2",
     "node-emoji": "1.11.0",
     "oc-template-es6-compiler": "1.1.10",
     "prettier-eslint-cli": "5.0.1",
     "semver-sort": "0.0.4",
     "simple-git": "2.45.1",
     "sinon": "11.1.2",
-    "ts-node": "^10.2.1",
-    "typescript": "^4.4.3"
+    "ts-node": "10.2.1",
+    "typescript": "4.4.3"
   },
   "dependencies": {
     "accept-language-parser": "1.5.0",
     "async": "3.2.1",
-    "basic-auth-connect": "^1.0.0",
+    "basic-auth-connect": "1.0.0",
     "body-parser": "1.19.0",
-    "builtin-modules": "^3.0.0",
-    "chokidar": "^3.5.2",
+    "builtin-modules": "3.2.0",
+    "chokidar": "3.5.2",
     "colors": "1.4.0",
     "cross-spawn": "7.0.3",
     "dependency-graph": "0.11.0",
-    "errorhandler": "^1.5.0",
+    "errorhandler": "1.5.1",
     "express": "4.17.1",
     "form-data": "4.0.0",
     "fs-extra": "10.0.0",
-    "getport": "^0.1.0",
+    "getport": "0.1.0",
     "livereload": "0.9.3",
-    "lodash": "^4.17.15",
+    "lodash": "4.17.21",
     "minimal-request": "3.0.0",
     "morgan": "1.10.0",
-    "multer": "^1.3.0",
+    "multer": "1.4.3",
     "nice-cache": "0.0.5",
-    "oc-client": "3.2.12",
-    "oc-client-browser": "1.5.3",
+    "oc-client": "4.0.0",
+    "oc-client-browser": "1.5.4",
     "oc-empty-response-handler": "1.0.1",
     "oc-get-unix-utc-timestamp": "1.0.3",
     "oc-s3-storage-adapter": "1.1.6",
     "oc-storage-adapters-utils": "1.0.3",
     "oc-template-es6": "1.0.3",
     "oc-template-handlebars": "6.0.21",
-    "oc-template-handlebars-compiler": "6.2.13",
+    "oc-template-handlebars-compiler": "6.2.15",
     "oc-template-jade": "7.0.2",
     "oc-template-jade-compiler": "7.0.3",
     "open": "8.2.1",
     "parse-author": "2.0.0",
     "read": "1.0.7",
     "require-package-name": "2.0.1",
-    "response-time": "^2.3.2",
+    "response-time": "2.3.2",
     "semver": "7.3.5",
     "semver-extra": "3.0.0",
     "serialize-error": "8.1.0",
     "targz": "1.0.1",
-    "try-require": "^1.2.1",
-    "yargs": "17.2.0"
+    "try-require": "1.2.1",
+    "yargs": "17.2.1"
   }
 }

src/cli/domain/handle-dependencies/get-compiler.js

@@ -2,7 +2,7 @@
 
 const path = require('path');
 
-const cleanRequire = require('../../../utils/clean-require');
+const cleanRequire = require('../../../utils/clean-require').default;
 const installCompiler = require('./install-compiler');
 
 module.exports = (options, cb) => {

src/cli/domain/handle-dependencies/install-compiler.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const cleanRequire = require('../../../utils/clean-require');
+const cleanRequire = require('../../../utils/clean-require').default;
 const isTemplateValid = require('../../../utils/is-template-valid').default;
 const npm = require('../../../utils/npm-utils');
 const strings = require('../../../resources/index').default;

src/cli/domain/handle-dependencies/require-template.js

@@ -2,7 +2,7 @@
 
 const path = require('path');
 
-const cleanRequire = require('../../../utils/clean-require');
+const cleanRequire = require('../../../utils/clean-require').default;
 const isTemplateLegacy = require('../../../utils/is-template-legacy').default;
 const isTemplateValid = require('../../../utils/is-template-valid').default;
 const strings = require('../../../resources').default;

src/cli/domain/local.js

@@ -8,7 +8,7 @@ const clean = require('./clean');
 const getComponentsByDir = require('./get-components-by-dir').default;
 const initTemplate = require('./init-template');
 const isTemplateLegacy = require('../../utils/is-template-legacy').default;
-const mock = require('./mock');
+const mock = require('./mock').default;
 const packageComponents = require('./package-components');
 const strings = require('../../resources').default;
 const validator = require('../../registry/domain/validators');

src/cli/domain/mock.js renamed to src/cli/domain/mock.ts

@@ -1,12 +1,13 @@
-'use strict';
+import fs from 'fs-extra';
+import path from 'path';
 
-const fs = require('fs-extra');
-const path = require('path');
+import settings from '../../resources/settings';
 
-const settings = require('../../resources/settings').default;
-
-module.exports = function() {
-  return function(params, callback) {
+export default function mock() {
+  return function(
+    params: { targetType: string; targetValue: string; targetName: string },
+    callback: Callback
+  ) {
     fs.readJson(settings.configFile.src, (err, localConfig) => {
       localConfig = localConfig || {};
 
@@ -40,4 +41,4 @@ module.exports = function() {
       );
     });
   };
-};
+}

src/registry/domain/authentication.js

@@ -0,0 +1,68 @@
+import basicAuth from 'basic-auth-connect';
+import path from 'path';
+
+import strings from '../../resources/';
+
+type Validate<T = unknown> = (
+  config: T
+) => { isValid: boolean; message: string };
+type Middleware<T> = (config: T) => any;
+
+type Authentication<T = any> = {
+  validate: Validate<T>;
+  middleware: Middleware<T>;
+};
+
+const basicAuthentication: Authentication<{
+  username: string;
+  password: string;
+}> = {
+  validate(authConfig) {
+    const isValid = !!authConfig.username && !!authConfig.password;
+
+    return {
+      isValid,
+      message: isValid
+        ? ''
+        : strings.errors.registry
+            .CONFIGURATION_PUBLISH_BASIC_AUTH_CREDENTIALS_MISSING
+    };
+  },
+  middleware(authConfig) {
+    return basicAuth(authConfig.username, authConfig.password);
+  }
+};
+
+const builtin: Dictionary<Authentication> = {
+  basic: basicAuthentication
+};
+
+let scheme: Authentication;
+
+export function validate(authConfig: { type: string }) {
+  if (builtin[authConfig.type]) {
+    scheme = builtin[authConfig.type];
+  } else {
+    const cwd = process.cwd();
+    module.paths.push(cwd, path.join(cwd, 'node_modules'));
+
+    const moduleName = `oc-auth-${authConfig.type}`;
+
+    try {
+      scheme = require(moduleName);
+    } catch (err) {
+      return {
+        isValid: false,
+        message: strings.errors.registry.CONFIGURATION_PUBLISH_AUTH_MODULE_NOT_FOUND(
+          moduleName
+        )
+      };
+    }
+  }
+
+  return scheme.validate(authConfig);
+}
+
+export function middleware(authConfig: any) {
+  return scheme.middleware(authConfig);
+}

src/registry/domain/authentication.ts

@@ -1,9 +1,11 @@
-'use strict';
+import tryRequire from 'try-require';
 
-const tryRequire = require('try-require');
-
-module.exports = (path, { justTry = false, resolve = false }) => {
+export default function cleanRequire(
+  path: string,
+  { justTry = false, resolve = false }
+) {
   const shouldThrow = !justTry;
+
   if (require.cache && !!require.cache[path]) {
     delete require.cache[path];
   }
@@ -14,4 +16,4 @@ module.exports = (path, { justTry = false, resolve = false }) => {
   }
 
   return action(path);
-};
+}

src/utils/clean-require.js renamed to src/utils/clean-require.ts

@@ -26,7 +26,7 @@ describe('cli : domain : handle-dependencies : get-compiler', () => {
       '../../dist/cli/domain/handle-dependencies/get-compiler.js',
       {
         path: { join: (...args) => args.join('/') },
-        '../../../utils/clean-require': cleanRequireStub,
+        '../../../utils/clean-require': { default: cleanRequireStub },
         './install-compiler': installCompilerStub
       }
     );