evaengine 0.11.2 → 1.0.1

package/{lib → src}/entities/index.js

@@ -1,65 +1,41 @@
-'use strict';
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = undefined;
-
-var _fs = require('fs');
-
-var _fs2 = _interopRequireDefault(_fs);
-
-var _path = require('path');
-
-var _path2 = _interopRequireDefault(_path);
-
-var _assert = require('assert');
-
-var _assert2 = _interopRequireDefault(_assert);
-
-var _cloneDeep = require('lodash/cloneDeep');
-
-var _cloneDeep2 = _interopRequireDefault(_cloneDeep);
-
-var _sequelize = require('sequelize');
-
-var _sequelize2 = _interopRequireDefault(_sequelize);
-
-var _util = require('util');
-
-var _util2 = _interopRequireDefault(_util);
-
-var _di = require('../di');
-
-var _di2 = _interopRequireDefault(_di);
-
-var _utils = require('../utils');
-
-var _exceptions = require('../exceptions');
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+import fs from 'fs';
+import path from 'path';
+import assert from 'assert';
+import cloneDeep from 'lodash/cloneDeep.js';
+import Sequelize from 'sequelize';
+import { createRequire } from 'module';
+import DI from '../di.js';
+import { getMicroTimestamp } from '../utils/index.js';
+import { StandardException } from '../exceptions/index.js';
+
+const require = createRequire(import.meta.url);
 
 //From https://github.com/angelxmoreno/sequelize-isunique-validator
-_sequelize2.default.prototype.validateIsUnique = (col, msg) => {
+Sequelize.prototype.validateIsUnique = (col, msg) => {
   const conditions = { where: {} };
   const message = msg || `${col} must be unique`;
   return function v(value, next) {
     const self = this;
-    this.Model.describe().then(schema => {
+    this.Model.describe().then((schema) => {
       conditions.where[col] = value;
-      Object.keys(schema).filter(field => schema[field].primaryKey).forEach(pk => {
-        conditions.where[pk] = { $ne: self[pk] };
-      });
-    }).then(() => self.Model.count(conditions).then(found => {
-      if (found !== 0) {
-        return next(message);
-      }
-      return next();
-    })).catch(next);
+      Object
+        .keys(schema)
+        .filter(field => schema[field].primaryKey)
+        .forEach((pk) => {
+          conditions.where[pk] = { $ne: self[pk] };
+        });
+    }).then(() =>
+      self.Model.count(conditions).then((found) => {
+        if (found !== 0) {
+          return next(message);
+        }
+        return next();
+      })).catch(next);
   };
 };
 
-let Entities = class Entities {
+
+export default class Entities {
   /**
    * @param {string} entitiesPath
    * @param {Sequelize|Function} sequelizeInstance
@@ -77,18 +53,18 @@ let Entities = class Entities {
    * @returns {*}
    */
   static addTracer(options = {}) {
-    const logger = _di2.default.get('logger');
+    const logger = DI.get('logger');
     return Object.assign(options, {
       benchmark: true,
       logging: (...args) => {
-        const tracer = _di2.default.get('namespace').get('tracer');
+        const tracer = DI.get('namespace').get('tracer');
         const [query, cost] = args;
         let pushed = false;
         if (tracer && cost > 0) {
           tracer.queries.push({
             query,
             cost: cost * 1000,
-            finishedAt: (0, _utils.getMicroTimestamp)()
+            finishedAt: getMicroTimestamp()
           });
           pushed = true;
         }
@@ -104,21 +80,28 @@ let Entities = class Entities {
    * @returns {Entities}
    */
   scan(entitiesPath, withAssociate = true) {
-    (0, _assert2.default)(this.sequelize && this.sequelize instanceof _sequelize2.default, 'Scan entities require a sequelize instance');
-
-    _fs2.default.readdirSync(entitiesPath).filter(file => {
-      const fileArray = file.split('.');
-      return file.indexOf('.') !== 0 && ['js', 'es6'].indexOf(fileArray.pop()) !== -1 && fileArray[0] !== 'index';
-    }).forEach(file => {
-      const entity = this.sequelize.import(_path2.default.join(entitiesPath, file));
-      this.entities[entity.name] = entity;
-    });
+    assert(this.sequelize && this.sequelize instanceof Sequelize, 'Scan entities require a sequelize instance');
+
+    fs
+      .readdirSync(entitiesPath)
+      .filter((file) => {
+        const fileArray = file.split('.');
+        return (file.indexOf('.') !== 0) &&
+          (['js', 'es6', 'cjs'].indexOf(fileArray.pop()) !== -1) && (fileArray[0] !== 'index');
+      })
+      .forEach((file) => {
+        const entityModule = require(path.join(entitiesPath, file));
+        const entityFactory = entityModule.default || entityModule;
+        const entity = typeof entityFactory === 'function' ?
+          entityFactory(this.sequelize, Sequelize) : entityFactory;
+        this.entities[entity.name] = entity;
+      });
 
     if (!withAssociate) {
       return this;
     }
 
-    Object.values(this.entities).forEach(entity => {
+    Object.values(this.entities).forEach((entity) => {
       if ('associate' in entity) {
         entity.associate(this.entities);
       }
@@ -136,22 +119,30 @@ let Entities = class Entities {
       return this.sequelize;
     }
 
-    const logger = _di2.default.get('logger').getInstance();
+    const logger = DI.get('logger').getInstance();
     if (!this.sequelize) {
-      const config = _di2.default.get('config').get();
-      const ns = _di2.default.get('namespace');
+      const config = DI.get('config').get();
+      const ns = DI.get('namespace');
       if (ns.isEnabled()) {
         //Inject sequelize inner namespace, refer: http://docs.sequelizejs.com/en/latest/docs/transactions/
-        _sequelize2.default.cls = ns.use().getContext();
+        const context = ns.use().getContext();
+        if (typeof Sequelize.useCLS === 'function') {
+          Sequelize.useCLS(context);
+        } else {
+          Sequelize.cls = context;
+        }
       }
 
-      const dbConfig = (0, _cloneDeep2.default)(config.db);
+      const dbConfig = cloneDeep(config.db);
       if (process.env.SEQUELIZE_REPLICATION_CONFIG_KEY) {
         dbConfig.replication = dbConfig[process.env.SEQUELIZE_REPLICATION_CONFIG_KEY];
       }
-      this.sequelize = new _sequelize2.default(config.db.database, null, null, Object.assign({}, config.sequelize, dbConfig, Entities.addTracer()));
+      this.sequelize = new Sequelize(
+        config.db.database, null, null,
+        Object.assign({}, config.sequelize, dbConfig, Entities.addTracer())
+      );
     } else {
-      this.sequelize = _util2.default.isFunction(this.sequelize) ? this.sequelize() : this.sequelize;
+      this.sequelize = typeof this.sequelize === 'function' ? this.sequelize() : this.sequelize;
     }
 
     this.scan(this.entitiesPath, withAssociate);
@@ -191,11 +182,11 @@ let Entities = class Entities {
   }, options = {}) {
     const inputObj = Object.assign({}, input);
     const typeAllowed = ['number', 'string', 'boolean'];
-    Object.entries(inputObj).forEach(p => {
+    Object.entries(inputObj).forEach((p) => {
       const valType = typeof p[1];
       //Allow null type here
       if (typeAllowed.indexOf(valType) === -1 && p[1] !== null) {
-        throw new _exceptions.StandardException(`SQL inputObj ${p[0]}:${p[1]} with unsupported type ${valType}.`);
+        throw new StandardException(`SQL inputObj ${p[0]}:${p[1]} with unsupported type ${valType}.`);
       } else if (valType === 'boolean') {
         if (p[1] === true) {
           inputObj[p[0]] = 1;
@@ -207,7 +198,8 @@ let Entities = class Entities {
     const columns = Object.keys(inputObj);
     const columnString = ['`', columns.join('`, `'), '`'].join('');
     const valueString = Object.entries(inputObj).map(([key]) => `$${key} \`${key}\``).join(' , ');
-    const uniqueString = typeof uniqueCondition === 'string' ? uniqueCondition : [`SELECT * FROM ${tableName} WHERE `, this.getInstance().dialect.QueryGenerator.getWhereConditions(uniqueCondition)].join('');
+    const uniqueString = typeof uniqueCondition === 'string' ? uniqueCondition :
+      [`SELECT * FROM ${tableName} WHERE `, this.getInstance().dialect.QueryGenerator.getWhereConditions(uniqueCondition)].join('');
     /*
      Original Example:
      entities.getInstance().query(`INSERT INTO ${tableName}
@@ -221,8 +213,8 @@ let Entities = class Entities {
      )`, { bind, transaction, type: entities.getSequelize().QueryTypes.INSERT });
      */
 
-    const sql = `INSERT INTO ${tableName} 
-      (${columnString}) 
+    const sql = `INSERT INTO ${tableName}
+      (${columnString})
       (
         SELECT *
         FROM (SELECT ${valueString}) AS tmp
@@ -233,7 +225,7 @@ let Entities = class Entities {
     return this.getInstance().query(sql, Object.assign({
       bind: inputObj,
       transaction,
-      type: _sequelize2.default.QueryTypes.INSERT
+      type: Sequelize.QueryTypes.INSERT
     }, options));
   }
 
@@ -251,7 +243,7 @@ let Entities = class Entities {
    * @returns {Sequelize}
    */
   getSequelize() {
-    return _sequelize2.default;
+    return Sequelize;
   }
 
   /**
@@ -278,6 +270,4 @@ let Entities = class Entities {
     this.init();
     return this.entities;
   }
-};
-exports.default = Entities;
-//# sourceMappingURL=index.js.map
+}

package/{lib → src}/exceptions/index.js

@@ -1,61 +1,17 @@
-'use strict';
+import * as appRoot from 'app-root-path';
+import path from 'path';
+import { format } from 'util';
+import crc32 from '../utils/crc32.js';
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.DatabaseIOException = exports.RestServiceIOException = exports.HttpRequestIOException = exports.IOException = exports.RuntimeException = exports.ResourceConflictedException = exports.OperationUnsupportedException = exports.ResourceNotFoundException = exports.OperationNotPermittedException = exports.UnauthorizedException = exports.RestServiceLogicException = exports.HttpRequestLogicException = exports.ModelInvalidateException = exports.FormInvalidateException = exports.InvalidArgumentException = exports.LogicException = exports.StandardException = undefined;
-
-var _appRootPath = require('app-root-path');
-
-var _appRootPath2 = _interopRequireDefault(_appRootPath);
-
-var _path = require('path');
-
-var _path2 = _interopRequireDefault(_path);
-
-var _util = require('util');
-
-var _crc = require('../utils/crc32');
-
-var _crc2 = _interopRequireDefault(_crc);
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _extendableBuiltin(cls) {
-  function ExtendableBuiltin() {
-    var instance = Reflect.construct(cls, Array.from(arguments));
-    Object.setPrototypeOf(instance, Object.getPrototypeOf(this));
-    return instance;
-  }
-
-  ExtendableBuiltin.prototype = Object.create(cls.prototype, {
-    constructor: {
-      value: cls,
-      enumerable: false,
-      writable: true,
-      configurable: true
-    }
-  });
-
-  if (Object.setPrototypeOf) {
-    Object.setPrototypeOf(ExtendableBuiltin, cls);
-  } else {
-    ExtendableBuiltin.__proto__ = cls;
-  }
-
-  return ExtendableBuiltin;
-}
 
 /**
  * Make Error be able to work with JSON.stringify()
  */
 if (!('toJSON' in Error.prototype)) {
-  Object.defineProperty(Error.prototype, 'toJSON', { //eslint-disable-line
+  Object.defineProperty(Error.prototype, 'toJSON', {
     value: function () {
-      //eslint-disable-line
       const alt = {};
       Object.getOwnPropertyNames(this).forEach(function (key) {
-        //eslint-disable-line
         alt[key] = this[key];
       }, this);
       return alt;
@@ -65,9 +21,11 @@ if (!('toJSON' in Error.prototype)) {
   });
 }
 
-let i18nHandler = _util.format;
 
-let factory = () => {};
+let i18nHandler = format;
+
+let factory = () => {
+};
 
 /**
  * Exception interface
@@ -78,7 +36,7 @@ let factory = () => {};
  * throw new Exception(new Exception());
  * throw (new Exception()).i18n('some %d', 123)
  */
-let StandardException = exports.StandardException = class StandardException extends _extendableBuiltin(Error) {
+export class StandardException extends Error {
   /**
    * Generate string hash by crc32
    * @param {string} str
@@ -86,7 +44,7 @@ let StandardException = exports.StandardException = class StandardException exte
    * @returns {string}
    */
   static hash(str, padstr = '0000000000') {
-    const crcstr = (0, _crc2.default)(str).toString();
+    const crcstr = crc32(str).toString();
     return padstr.substring(0, padstr.length - crcstr.length) + crcstr;
   }
 
@@ -96,9 +54,9 @@ let StandardException = exports.StandardException = class StandardException exte
    * @param {string} fileName
    * @returns {Number}
    */
-  static generateCode(className, fileName = __filename) {
-    const namespace = fileName.replace(_appRootPath2.default.path, '').split(_path2.default.sep).join('/');
-    const group = fileName === __filename ? '11111' : (0, _crc2.default)(namespace).toString().substring(0, 5);
+  static generateCode(className, fileName = import.meta.filename) {
+    const namespace = fileName.replace(appRoot.path, '').split(path.sep).join('/');
+    const group = fileName === import.meta.filename ? '11111' : crc32(namespace).toString().substring(0, 5);
     return parseInt(`${group}000${StandardException.hash(className)}`, 10);
   }
 
@@ -182,7 +140,7 @@ let StandardException = exports.StandardException = class StandardException exte
     this.details = throwingError ? exceptionOrMsg : [];
     this.prevError = {};
     this.code = null;
-    this.filename = __filename;
+    this.filename = import.meta.filename;
     this.translated = false;
     this.importance = 0;
     if (throwingError === true) {
@@ -191,7 +149,7 @@ let StandardException = exports.StandardException = class StandardException exte
   }
 
   i18n(...args) {
-    this.message = (0, _util.format)(...args);
+    this.message = format(...args);
     this.humanMessage = i18nHandler(...args);
     if (this.message !== this.humanMessage) {
       this.translated = true;
@@ -285,19 +243,24 @@ let StandardException = exports.StandardException = class StandardException exte
       humanMessage: this.getHumanMessage(),
       filename: this.getFileName(),
       prevError: this.getPrevError(),
-      errors: Array.isArray(this.getDetails()) ? this.getDetails() : [this.getDetails()],
+      errors: Array.isArray(this.getDetails()) ?
+        this.getDetails() : [this.getDetails()],
       stack: StandardException.stackBeautifier(this.stack),
       fullStack: this.stack.split('\n')
     };
   }
-};
-let LogicException = exports.LogicException = class LogicException extends StandardException {
+}
+
+export class LogicException extends StandardException {
   get statusCode() {
     return 400;
   }
-};
-let InvalidArgumentException = exports.InvalidArgumentException = class InvalidArgumentException extends LogicException {};
-let FormInvalidateException = exports.FormInvalidateException = class FormInvalidateException extends InvalidArgumentException {
+}
+
+export class InvalidArgumentException extends LogicException {
+}
+
+export class FormInvalidateException extends InvalidArgumentException {
   constructor(exceptionOrMsg) {
     super(exceptionOrMsg);
     if (this.throwingError && exceptionOrMsg.isJoi === true) {
@@ -308,16 +271,18 @@ let FormInvalidateException = exports.FormInvalidateException = class FormInvali
       this.translated = true;
     }
   }
-};
-let ModelInvalidateException = exports.ModelInvalidateException = class ModelInvalidateException extends InvalidArgumentException {
+}
+
+export class ModelInvalidateException extends InvalidArgumentException {
   constructor(exceptionOrMsg) {
     super(exceptionOrMsg);
     if (this.throwingError) {
       this.details = exceptionOrMsg.errors;
     }
   }
-};
-let HttpRequestLogicException = exports.HttpRequestLogicException = class HttpRequestLogicException extends InvalidArgumentException {
+}
+
+export class HttpRequestLogicException extends InvalidArgumentException {
   /**
    * Support request promise error
    * https://github.com/request/promise-core/blob/master/lib/errors.js
@@ -382,43 +347,54 @@ let HttpRequestLogicException = exports.HttpRequestLogicException = class HttpRe
   getBusinessCode() {
     return this.businessCode;
   }
-};
-let RestServiceLogicException = exports.RestServiceLogicException = class RestServiceLogicException extends HttpRequestLogicException {
+}
+
+export class RestServiceLogicException extends HttpRequestLogicException {
   constructor(exceptionOrMsg) {
     super(exceptionOrMsg);
     if (this.throwingError && this.response && this.response.body) {
       this.prevError = factory(this.response.body);
     }
   }
-};
-let UnauthorizedException = exports.UnauthorizedException = class UnauthorizedException extends LogicException {
+}
+
+export class UnauthorizedException extends LogicException {
   get statusCode() {
     return 401;
   }
-};
-let OperationNotPermittedException = exports.OperationNotPermittedException = class OperationNotPermittedException extends LogicException {
+}
+
+export class OperationNotPermittedException extends LogicException {
   get statusCode() {
     return 403;
   }
-};
-let ResourceNotFoundException = exports.ResourceNotFoundException = class ResourceNotFoundException extends LogicException {
+}
+
+export class ResourceNotFoundException extends LogicException {
   get statusCode() {
     return 404;
   }
-};
-let OperationUnsupportedException = exports.OperationUnsupportedException = class OperationUnsupportedException extends LogicException {
+}
+
+export class OperationUnsupportedException extends LogicException {
   get statusCode() {
     return 405;
   }
-};
-let ResourceConflictedException = exports.ResourceConflictedException = class ResourceConflictedException extends LogicException {
+}
+
+export class ResourceConflictedException extends LogicException {
   get statusCode() {
     return 409;
   }
-};
-let RuntimeException = exports.RuntimeException = class RuntimeException extends StandardException {};
-let IOException = exports.IOException = class IOException extends RuntimeException {};
-let HttpRequestIOException = exports.HttpRequestIOException = class HttpRequestIOException extends IOException {
+}
+
+export class RuntimeException extends StandardException {
+}
+
+export class IOException extends RuntimeException {
+}
+
+export class HttpRequestIOException extends IOException {
   constructor(exceptionOrMsg) {
     super(exceptionOrMsg);
     if (this.throwingError && ['StatusCodeError', 'RequestError', 'TransformError'].includes(exceptionOrMsg.name)) {
@@ -466,17 +442,19 @@ let HttpRequestIOException = exports.HttpRequestIOException = class HttpRequestI
   getBusinessCode() {
     return this.businessCode;
   }
-};
-let RestServiceIOException = exports.RestServiceIOException = class RestServiceIOException extends HttpRequestIOException {
+}
+
+export class RestServiceIOException extends HttpRequestIOException {
   constructor(exceptionOrMsg) {
     super(exceptionOrMsg);
     if (this.throwingError && this.response && this.response.body) {
       this.prevError = factory(this.response.body);
     }
   }
-};
-let DatabaseIOException = exports.DatabaseIOException = class DatabaseIOException extends IOException {};
+}
 
+export class DatabaseIOException extends IOException {
+}
 
 const exceptions = {
   StandardException,
@@ -498,7 +476,7 @@ const exceptions = {
   DatabaseIOException
 };
 
-factory = json => {
+factory = (json) => {
   const {
     code, name, statusCode, message, prevError, errors, fullStack = []
   } = json;
@@ -508,15 +486,16 @@ factory = json => {
 
   let e = null;
   if (Object.keys(exceptions).includes(name)) {
-    e = new exceptions[name](); //eslint-disable-line
+    e = new exceptions[name];
   } else if (statusCode < 500) {
     e = new LogicException(message);
   } else {
     e = new RuntimeException(message);
   }
 
-  e.setCode(code).setDetails(errors).setPrevError(prevError);
+  e.setCode(code)
+    .setDetails(errors)
+    .setPrevError(prevError);
   e.stack = fullStack.join('\n');
   return e;
 };
-//# sourceMappingURL=index.js.map

package/src/index.js

@@ -0,0 +1,57 @@
+import constitute from 'constitute';
+import * as mysql from 'mysql';
+import sequelize from 'sequelize';
+import Joi from 'joi';
+import EvaEngine, * as engine from './engine.js';
+import * as swagger from './swagger/index.js';
+import * as exceptions from './exceptions/index.js';
+import * as services from './services/index.js';
+import * as middlewares from './middlewares/index.js';
+import * as ServiceProviders from './services/providers.js';
+import * as MiddlewareProviders from './middlewares/providers.js';
+import * as utils from './utils/index.js';
+import Command, * as commands from './commands/index.js';
+import Entities from './entities/index.js';
+
+const providers = {
+  services: ServiceProviders,
+  middlewares: MiddlewareProviders
+};
+
+const { wrapper } = utils;
+
+const {
+  DI,
+  express
+} = engine;
+
+/**
+ * @typedef {Object} engineCore
+ */
+const core = {
+  EvaEngine,
+  Command,
+  DI,
+  Entities,
+  engine,
+  express,
+  commands,
+  dependencies: {
+    Joi,
+    constitute,
+    sequelize,
+    mysql
+  },
+  exceptions,
+  middlewares,
+  sequelize,
+  Joi,
+  swagger,
+  services,
+  providers,
+  wrapper,
+  utils
+};
+
+export default core;
+export { core };

package/src/middlewares/auth.js

@@ -0,0 +1,67 @@
+import constitute from 'constitute';
+import wrapper from '../utils/wrapper.js';
+import { UnauthorizedException } from '../exceptions/index.js';
+import Config from '../services/config.js';
+import Now from '../services/now.js';
+import JsonWebToken from '../services/jwt_token.js';
+
+/**
+ * @param _config {Config}
+ * @param token {JsonWebToken}
+ * @returns {function()}
+ * @constructor
+ */
+function AuthMiddleware(_config, token, now) {
+  const config = _config.get();
+  return () => wrapper(async (req, res, next) => {
+    const jwToken = req.header('X-Token') || req.query.api_key;
+    if (config.token.faker.enable === true && req.auth && req.auth.uid) {
+      res.set('X-Uid', req.auth.uid);
+      return next();
+    }
+    if (config.token.faker.enable === true && jwToken === config.token.faker.key) {
+      req.auth = {
+        type: 'fake',
+        uid: config.token.faker.uid,
+        token: config.token.faker.key
+      };
+      res.set('X-Uid', config.token.faker.uid);
+      return next();
+    }
+    if (jwToken) {
+      let parsedToken = {};
+      try {
+        parsedToken = await token.find(jwToken);
+      } catch {
+        throw new UnauthorizedException('Token not recognizable');
+      }
+      const { uid, expiredAt } = parsedToken;
+      if (!uid) {
+        throw new UnauthorizedException('User info not found in token');
+      }
+      if (typeof expiredAt !== 'number' || expiredAt <= now.getTimestamp()) {
+        throw new UnauthorizedException('Token expired');
+      }
+      req.auth = {
+        type: 'jwt',
+        uid,
+        token: jwToken
+      };
+      res.set('X-Uid', uid);
+      return next();
+    }
+
+    if (req.session && req.session.uid) {
+      req.auth = {
+        type: 'session',
+        uid: req.session.uid,
+        token: ''
+      };
+      res.set('X-Uid', req.session.uid);
+      return next();
+    }
+    throw new UnauthorizedException('No authority token found');
+  });
+}
+constitute.Dependencies(Config, JsonWebToken, Now)(AuthMiddleware);
+export default AuthMiddleware;