jimpex 7.0.2 → 8.0.0

package/src/controllers/utils/index.js

@@ -1,3 +0,0 @@
-const { gatewayController } = require('./gateway');
-
-module.exports.gatewayController = gatewayController;

package/src/index.js

@@ -1,30 +0,0 @@
-const { Jimpex, jimpex } = require('./app');
-const controllers = require('./controllers');
-const middlewares = require('./middlewares');
-const services = require('./services');
-const { eventNames } = require('./constants');
-const {
-  provider,
-  providerCreator,
-  providers,
-  controller,
-  controllerCreator,
-  middleware,
-  middlewareCreator,
-} = require('./utils/wrappers');
-const utils = require('./utils/functions');
-
-module.exports.controller = controller;
-module.exports.controllerCreator = controllerCreator;
-module.exports.controllers = controllers;
-module.exports.middleware = middleware;
-module.exports.middlewareCreator = middlewareCreator;
-module.exports.middlewares = middlewares;
-module.exports.provider = provider;
-module.exports.providerCreator = providerCreator;
-module.exports.providers = providers;
-module.exports.services = services;
-module.exports.eventNames = eventNames;
-module.exports.utils = utils;
-module.exports.Jimpex = Jimpex;
-module.exports.jimpex = jimpex;

package/src/middlewares/common/errorHandler.js

@@ -1,185 +0,0 @@
-const ObjectUtils = require('wootils/shared/objectUtils');
-const { code: statuses } = require('statuses');
-const { middlewareCreator } = require('../../utils/wrappers');
-
-/**
- * @typedef {import('../../types').ExpressMiddleware} ExpressMiddleware
- * @typedef {import('../../types').Logger} Logger
- * @typedef {import('../../services/http/responsesBuilder').ResponsesBuilder} ResponsesBuilder
- * @prettierignore
- */
-
-/**
- * @typedef {import('../../types').MiddlewareCreator<O>} MiddlewareCreator<O>
- * @template O
- */
-
-/**
- * Before reading the recevied information, these will be the settings for the response.
- *
- * @typedef {Object} ErrorHandlerDefaultOptions
- * @property {string} message  The error message the response will show. Default `'Oops!
- *                             Something went wrong, please try again'`.
- * @property {number} status   The HTTP status code for the response. Default `500`.
- * @parent module:middlewares
- */
-
-/**
- * The options for how to build the middleware responses.
- *
- * @typedef {Object} ErrorHandlerOptions
- * @property {ErrorHandlerDefaultOptions} default  The options to build the default
- *                                                 response,
- *                                                 before the middleware analyzes the
- *                                                 recevied error.
- * @parent module:middlewares
- */
-
-/**
- * Provides the middleware to handle error responses for the app.
- *
- * @parent module:middlewares
- */
-class ErrorHandler {
-  /**
-   * @param {Logger}              appLogger         To log the received errors.
-   * @param {ResponsesBuilder}    responsesBuilder  To generate the JSON response.
-   * @param {boolean}             showErrors        If `false`, unknown errors will show a
-   *                                                generic message instead of real
-   *                                                message. And if `true`,
-   *                                                it will not only show all kind of
-   *                                                errors but it will also show the error
-   *                                                stack.
-   * @param {ClassAppError}       AppError          To validate if the received errors are
-   *                                                known or not.
-   * @param {ErrorHandlerOptions} [options={}]      Custom options to modify the
-   *                                                middleware behavior.
-   */
-  constructor(appLogger, responsesBuilder, showErrors, AppError, options = {}) {
-    /**
-     * A local reference for the `appLogger` service.
-     *
-     * @type {Logger}
-     * @access protected
-     * @ignore
-     */
-    this._appLogger = appLogger;
-    /**
-     * A local reference for the `responsesBuilder` service.
-     *
-     * @type {ResponsesBuilder}
-     * @access protected
-     * @ignore
-     */
-    this._responsesBuilder = responsesBuilder;
-    /**
-     * Whether or not to show unknown errors real messages.
-     *
-     * @type {boolean}
-     * @access protected
-     * @ignore
-     */
-    this._showErrors = showErrors;
-    /**
-     * A local reference for the class the app uses to generate errors.
-     *
-     * @type {ClassAppError}
-     * @access protected
-     * @ignore
-     */
-    this._AppError = AppError;
-    /**
-     * These are the "settings" the middleware will use in order to display the errors.
-     *
-     * @type {ErrorHandlerOptions}
-     * @access protected
-     * @ignore
-     */
-    this._options = ObjectUtils.merge(
-      {
-        default: {
-          message: 'Oops! Something went wrong, please try again',
-          status: statuses['internal server error'],
-        },
-      },
-      options,
-    );
-  }
-  /**
-   * Returns the Express middleware that shows the errors.
-   *
-   * @returns {ExpressMiddleware}
-   */
-  middleware() {
-    return (err, req, res, next) => {
-      // If the middleware received an error...
-      if (err) {
-        // Define the error response basic template.
-        let data = {
-          error: true,
-          message: this._options.default.message,
-        };
-        // Define the error response default status.
-        let { status } = this._options.default;
-        // Validate if the error is known or not.
-        const knownError = err instanceof this._AppError;
-        // If the `showErrors` flag is enabled or the error is a known error...
-        if (this._showErrors || knownError) {
-          // ...set the error real message on the response.
-          data.message = err.message;
-          // If the error type is known...
-          if (knownError) {
-            // Try to get any extra information that should be included on the response.
-            data = Object.assign(data, err.response);
-            // Try to obtain the response status from the error
-            status = err.status || statuses['bad request'];
-          }
-          // If the `showErrors` flag is enabled...
-          if (this._showErrors) {
-            // Get the error stack and format it into an `Array`.
-            const stack = err.stack.split('\n').map((line) => line.trim());
-            //  Add the stack to the response.
-            data.stack = stack;
-            // Remove the first item of the stack, since it's the same as the message.
-            stack.splice(0, 1);
-            // Log the error.
-            this._appLogger.error(`ERROR: ${err.message}`);
-            this._appLogger.info(stack);
-          }
-        }
-        // Send the response.
-        this._responsesBuilder.json(res, data, status);
-      } else {
-        // ...otherwise, move to the next middleware.
-        next();
-      }
-    };
-  }
-  /**
-   * The options used to customize the middleware behavior.
-   *
-   * @returns {ErrorHandlerOptions}
-   */
-  get options() {
-    return this._options;
-  }
-}
-/**
- * Generates a middleware that show responses for unhandled errors thrown by the app.
- *
- * @type {MiddlewareCreator<ErrorHandlerOptions>}
- * @parent module:middlewares
- */
-const errorHandler = middlewareCreator((options) => (app) => {
-  const showErrors = app.get('appConfiguration').get('debug.showErrors') === true;
-  return new ErrorHandler(
-    app.get('appLogger'),
-    app.get('responsesBuilder'),
-    showErrors,
-    app.get('AppError'),
-    options,
-  ).middleware();
-});
-
-module.exports.ErrorHandler = ErrorHandler;
-module.exports.errorHandler = errorHandler;

package/src/middlewares/common/forceHTTPS.js

@@ -1,80 +0,0 @@
-const { middlewareCreator } = require('../../utils/wrappers');
-
-/**
- * @typedef {import('../../types').ExpressMiddleware} ExpressMiddleware
- */
-
-/**
- * @typedef {import('../../types').MiddlewareCreator<O>} MiddlewareCreator<O>
- * @template O
- */
-
-/**
- * @typedef {Object} ForceHTTPSMiddlewareOptions
- * @property {RegExp[]} ignoredRoutes  A list of regular expressions to match routes that
- *                                     should be ignored.
- * @parent module:middlewares
- */
-
-/**
- * Force all the app traffice to be through HTTPS.
- *
- * @parent module:middlewares
- */
-class ForceHTTPS {
-  /**
-   * @param {RegExp[]} [ignoredRoutes=[/^\/service\//]]
-   * A list of regular expressions to match routes that should be ignored.
-   */
-  constructor(ignoredRoutes = [/^\/service\//]) {
-    /**
-     * A list of regular expressions to match routes that should be ignored.
-     *
-     * @type {RegExp[]}
-     * @access protected
-     * @ignore
-     */
-    this._ignoredRoutes = ignoredRoutes;
-  }
-  /**
-   * Returns the Express middleware that forces the redirection to HTTPS.
-   *
-   * @returns {ExpressMiddleware}
-   */
-  middleware() {
-    return (req, res, next) => {
-      if (
-        !req.secure &&
-        req.get('X-Forwarded-Proto') !== 'https' &&
-        !this._ignoredRoutes.some((expression) => expression.test(req.originalUrl))
-      ) {
-        const host = req.get('Host');
-        res.redirect(`https://${host}${req.url}`);
-      } else {
-        next();
-      }
-    };
-  }
-  /**
-   * A list of regular expressions to match routes that should be ignored.
-   *
-   * @type {RegExp[]}
-   */
-  get ignoredRoutes() {
-    return this._ignoredRoutes.slice();
-  }
-}
-/**
- * A middleware to force HTTPS redirections to all the routes.
- *
- * @type {MiddlewareCreator<ForceHTTPSMiddlewareOptions>}
- * @parent module:middlewares
- */
-const forceHTTPS = middlewareCreator((options = {}) => (app) =>
-  app.get('appConfiguration').get('forceHTTPS')
-    ? new ForceHTTPS(options.ignoredRoutes).middleware()
-    : null,
-);
-
-module.exports.ForceHTTPS = ForceHTTPS;
-module.exports.forceHTTPS = forceHTTPS;

package/src/middlewares/common/hsts.js

@@ -1,122 +0,0 @@
-const { middlewareCreator } = require('../../utils/wrappers');
-
-/**
- * @typedef {import('../../types').ExpressMiddleware} ExpressMiddleware
- */
-
-/**
- * @typedef {import('../../types').MiddlewareCreator<O>} MiddlewareCreator<O>
- * @template O
- */
-
-/**
- * The options to customize the HSTS header value.
- *
- * @typedef {Object} HSTSOptions
- * @property {number}  [maxAge=31536000]         The time, in seconds, that the browser
- *                                               should remember that a site is only to be
- *                                               accessed using HTTPS.
- * @property {boolean} [includeSubDomains=true]  Whether or not the rule should apply to
- *                                               all sub domains.
- * @property {boolean} [preload=false]           Whether or not to include on the major
- *                                               browsers'
- *                                               preload list. This directive is not part
- *                                               of the specification, for more
- *                                               information about it, you should check
- *                                               the MDN documentation for the header.
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security
- * @parent module:middlewares
- */
-
-/**
- * It configures a `Strict-Transport-Security` header and includes it on every response.
- *
- * @see https://tools.ietf.org/html/rfc6797
- * @parent module:middlewares
- */
-class HSTS {
-  /**
-   * @param {Partial<HSTSOptions>} [options={}]  The options to customize the header
-   *                                             value.
-   */
-  constructor(options = {}) {
-    /**
-     * The value of the header that will be included on every response.
-     *
-     * @type {string}
-     * @access protected
-     * @ignore
-     */
-    this._header = this._buildHeader({
-      maxAge: 31536000,
-      includeSubDomains: true,
-      preload: false,
-      ...options,
-    });
-  }
-  /**
-   * Returns the Express middleware that includes the header on the response.
-   *
-   * @returns {ExpressMiddleware}
-   */
-  middleware() {
-    return (req, res, next) => {
-      res.setHeader('Strict-Transport-Security', this._header);
-      next();
-    };
-  }
-  /**
-   * The value of the header that will be included on every response.
-   *
-   * @type {string}
-   */
-  get header() {
-    return this._header;
-  }
-  /**
-   * Creates the value for the header.
-   *
-   * @param {HSTSOptions} options  The options to customize the header value.
-   * @returns {string}
-   * @access protected
-   * @ignore
-   */
-  _buildHeader(options) {
-    const directives = [`max-age=${options.maxAge}`];
-    if (options.includeSubDomains) {
-      directives.push('includeSubDomains');
-    }
-
-    if (options.preload) {
-      directives.push('preload');
-    }
-
-    return directives.join('; ');
-  }
-}
-/**
- * A middleware that creates and includes a `Strict-Transport-Security` header on every
- * response.
- * If the `options` parameter doesn't include the value for `maxAge`, the middleware will
- * ask the {@link AppConfiguration} service for the `hsts` settings as a fallback. You can
- * take advantage of that fallback to use the middleware and manage its settings from your
- * project configuration.
- * Both the `options` parameter and the `hsts` can include a `enabled` (boolean) flag to
- * either disable or enable the middleware.
- *
- * @type {MiddlewareCreator<HSTSOptions>}
- * @parent module:middlewares
- */
-const hsts = middlewareCreator((options = {}) => (app) => {
-  const useOptions =
-    typeof options.maxAge !== 'undefined'
-      ? options
-      : app.get('appConfiguration').get('hsts') || {};
-
-  return typeof useOptions.enabled === 'undefined' || useOptions.enabled
-    ? new HSTS(useOptions).middleware()
-    : null;
-});
-
-module.exports.HSTS = HSTS;
-module.exports.hsts = hsts;

package/src/middlewares/common/index.js

@@ -1,7 +0,0 @@
-const { errorHandler } = require('./errorHandler');
-const { forceHTTPS } = require('./forceHTTPS');
-const { hsts } = require('./hsts');
-
-module.exports.errorHandler = errorHandler;
-module.exports.forceHTTPS = forceHTTPS;
-module.exports.hsts = hsts;