jimpex 7.0.2 → 8.0.0

package/types/controllers/utils/index.d.ts

@@ -1,2 +0,0 @@
-export { gatewayController };
-import { gatewayController } from "./gateway";

package/types/index.d.ts

@@ -1,15 +0,0 @@
-import { controller } from "./utils/wrappers";
-import { controllerCreator } from "./utils/wrappers";
-import controllers = require("./controllers");
-import { middleware } from "./utils/wrappers";
-import { middlewareCreator } from "./utils/wrappers";
-import middlewares = require("./middlewares");
-import { provider } from "./utils/wrappers";
-import { providerCreator } from "./utils/wrappers";
-import { providers } from "./utils/wrappers";
-import services = require("./services");
-import { eventNames } from "./constants";
-import utils = require("./utils/functions");
-import { Jimpex } from "./app";
-import { jimpex } from "./app";
-export { controller, controllerCreator, controllers, middleware, middlewareCreator, middlewares, provider, providerCreator, providers, services, eventNames, utils, Jimpex, jimpex };

package/types/middlewares/common/errorHandler.d.ts

@@ -1,143 +0,0 @@
-export type ExpressMiddleware = import('../../types').ExpressMiddleware;
-export type Logger = import('../../types').Logger;
-export type ResponsesBuilder = import('../../services/http/responsesBuilder').ResponsesBuilder;
-/**
- * <O>
- */
-export type MiddlewareCreator<O> = import('../../types').MiddlewareCreator<O>;
-/**
- * Before reading the recevied information, these will be the settings for the response.
- */
-export type ErrorHandlerDefaultOptions = {
-    /**
-     * The error message the response will show. Default `'Oops!
-     * Something went wrong, please try again'`.
-     */
-    message: string;
-    /**
-     * The HTTP status code for the response. Default `500`.
-     */
-    status: number;
-};
-/**
- * The options for how to build the middleware responses.
- */
-export type ErrorHandlerOptions = {
-    /**
-     * The options to build the default
-     * response,
-     * before the middleware analyzes the
-     * recevied error.
-     */
-    default: ErrorHandlerDefaultOptions;
-};
-/**
- * @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
- */
-export 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: Logger, responsesBuilder: ResponsesBuilder, showErrors: boolean, AppError: any, options?: ErrorHandlerOptions);
-    /**
-     * A local reference for the `appLogger` service.
-     *
-     * @type {Logger}
-     * @access protected
-     * @ignore
-     */
-    _appLogger: Logger;
-    /**
-     * A local reference for the `responsesBuilder` service.
-     *
-     * @type {ResponsesBuilder}
-     * @access protected
-     * @ignore
-     */
-    _responsesBuilder: ResponsesBuilder;
-    /**
-     * Whether or not to show unknown errors real messages.
-     *
-     * @type {boolean}
-     * @access protected
-     * @ignore
-     */
-    _showErrors: boolean;
-    /**
-     * A local reference for the class the app uses to generate errors.
-     *
-     * @type {ClassAppError}
-     * @access protected
-     * @ignore
-     */
-    _AppError: any;
-    /**
-     * These are the "settings" the middleware will use in order to display the errors.
-     *
-     * @type {ErrorHandlerOptions}
-     * @access protected
-     * @ignore
-     */
-    _options: ErrorHandlerOptions;
-    /**
-     * Returns the Express middleware that shows the errors.
-     *
-     * @returns {ExpressMiddleware}
-     */
-    middleware(): ExpressMiddleware;
-    /**
-     * The options used to customize the middleware behavior.
-     *
-     * @returns {ErrorHandlerOptions}
-     */
-    get options(): ErrorHandlerOptions;
-}
-/**
- * Generates a middleware that show responses for unhandled errors thrown by the app.
- *
- * @type {MiddlewareCreator<ErrorHandlerOptions>}
- * @parent module:middlewares
- */
-export const errorHandler: MiddlewareCreator<ErrorHandlerOptions>;

package/types/middlewares/common/forceHTTPS.d.ts

@@ -1,64 +0,0 @@
-export type ExpressMiddleware = import('../../types').ExpressMiddleware;
-/**
- * <O>
- */
-export type MiddlewareCreator<O> = import('../../types').MiddlewareCreator<O>;
-export type ForceHTTPSMiddlewareOptions = {
-    /**
-     * A list of regular expressions to match routes that
-     * should be ignored.
-     */
-    ignoredRoutes: RegExp[];
-};
-/**
- * @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
- */
-export class ForceHTTPS {
-    /**
-     * @param {RegExp[]} [ignoredRoutes=[/^\/service\//]]
-     * A list of regular expressions to match routes that should be ignored.
-     */
-    constructor(ignoredRoutes?: RegExp[]);
-    /**
-     * A list of regular expressions to match routes that should be ignored.
-     *
-     * @type {RegExp[]}
-     * @access protected
-     * @ignore
-     */
-    _ignoredRoutes: RegExp[];
-    /**
-     * Returns the Express middleware that forces the redirection to HTTPS.
-     *
-     * @returns {ExpressMiddleware}
-     */
-    middleware(): ExpressMiddleware;
-    /**
-     * A list of regular expressions to match routes that should be ignored.
-     *
-     * @type {RegExp[]}
-     */
-    get ignoredRoutes(): RegExp[];
-}
-/**
- * A middleware to force HTTPS redirections to all the routes.
- *
- * @type {MiddlewareCreator<ForceHTTPSMiddlewareOptions>}
- * @parent module:middlewares
- */
-export const forceHTTPS: MiddlewareCreator<ForceHTTPSMiddlewareOptions>;

package/types/middlewares/common/hsts.d.ts

@@ -1,111 +0,0 @@
-export type ExpressMiddleware = import('../../types').ExpressMiddleware;
-/**
- * <O>
- */
-export type MiddlewareCreator<O> = import('../../types').MiddlewareCreator<O>;
-/**
- * The options to customize the HSTS header value.
- */
-export type HSTSOptions = {
-    /**
-     * The time, in seconds, that the browser
-     *          should remember that a site is only to be
-     *          accessed using HTTPS.
-     */
-    maxAge?: number;
-    /**
-     * Whether or not the rule should apply to
-     *   all sub domains.
-     */
-    includeSubDomains?: boolean;
-    /**
-     * 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.
-     */
-    preload?: boolean;
-};
-/**
- * @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
- */
-export class HSTS {
-    /**
-     * @param {Partial<HSTSOptions>} [options={}]  The options to customize the header
-     *                                             value.
-     */
-    constructor(options?: Partial<HSTSOptions>);
-    /**
-     * The value of the header that will be included on every response.
-     *
-     * @type {string}
-     * @access protected
-     * @ignore
-     */
-    _header: string;
-    /**
-     * Returns the Express middleware that includes the header on the response.
-     *
-     * @returns {ExpressMiddleware}
-     */
-    middleware(): ExpressMiddleware;
-    /**
-     * The value of the header that will be included on every response.
-     *
-     * @type {string}
-     */
-    get header(): string;
-    /**
-     * Creates the value for the header.
-     *
-     * @param {HSTSOptions} options  The options to customize the header value.
-     * @returns {string}
-     * @access protected
-     * @ignore
-     */
-    _buildHeader(options: HSTSOptions): string;
-}
-/**
- * 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
- */
-export const hsts: MiddlewareCreator<HSTSOptions>;

package/types/middlewares/common/index.d.ts

@@ -1,4 +0,0 @@
-import { errorHandler } from "./errorHandler";
-import { forceHTTPS } from "./forceHTTPS";
-import { hsts } from "./hsts";
-export { errorHandler, forceHTTPS, hsts };

package/types/middlewares/html/fastHTML.d.ts

@@ -1,238 +0,0 @@
-export type ExpressMiddleware = import('../../types').ExpressMiddleware;
-export type ExpressResponse = import('../../types').ExpressResponse;
-export type ExpressNext = import('../../types').ExpressNext;
-export type EventsHub = import('../../types').EventsHub;
-export type SendFile = import('../../services/common/sendFile').SendFile;
-export type HTMLGenerator = import('../../services/html/htmlGenerator').HTMLGenerator;
-/**
- * <O>
- */
-export type MiddlewareCreator<O> = import('../../types').MiddlewareCreator<O>;
-/**
- * The options to customize the behavior of the middleware.
- */
-export type FastHTMLOptions = {
-    /**
-     * The name of the file the middleware will serve. It
-     * can get overwritten if {@link FastHTML } receives an
-     * {@link HTMLGenerator }, in that case, the file will
-     * be obtained from that service. Default `index.html`.
-     */
-    file: string;
-    /**
-     * A list of regular expressions to match requests
-     * paths that should be ignored.
-     */
-    ignore: RegExp[];
-    /**
-     * If `true`, {@link FastHTML } will get the list of all
-     * routes controlled by {@link Jimpex } and will use
-     * them to validate the incoming requests (in addition
-     * to `ignore`): If a request URL doesn't match with
-     * any of the controlled routes, it will show the HTML
-     * file. Default `true`.
-     */
-    useAppRoutes: boolean;
-};
-export type FastHTMLMiddlewareOptions = FastHTMLOptions & FastHTMLMiddlewareOptionsProperties;
-export type FastHTMLMiddlewareOptionsProperties = {
-    /**
-     * The name of a {@link HTMLGenerator } service for the middleware to use. Default
-     * `htmlGenerator`.
-     */
-    htmlGenerator: string;
-};
-/**
- * @typedef {import('../../types').ExpressMiddleware} ExpressMiddleware
- * @typedef {import('../../types').ExpressResponse} ExpressResponse
- * @typedef {import('../../types').ExpressNext} ExpressNext
- * @typedef {import('../../types').EventsHub} EventsHub
- * @typedef {import('../../services/common/sendFile').SendFile} SendFile
- * @typedef {import('../../services/html/htmlGenerator').HTMLGenerator} HTMLGenerator
- */
-/**
- * @typedef {import('../../types').MiddlewareCreator<O>} MiddlewareCreator<O>
- * @template O
- */
-/**
- * The options to customize the behavior of the middleware.
- *
- * @typedef {Object} FastHTMLOptions
- * @property {string}   file          The name of the file the middleware will serve. It
- *                                    can get overwritten if {@link FastHTML} receives an
- *                                    {@link HTMLGenerator}, in that case, the file will
- *                                    be obtained from that service. Default `index.html`.
- * @property {RegExp[]} ignore        A list of regular expressions to match requests
- *                                    paths that should be ignored.
- * @property {boolean}  useAppRoutes  If `true`, {@link FastHTML} will get the list of all
- *                                    routes controlled by {@link Jimpex} and will use
- *                                    them to validate the incoming requests (in addition
- *                                    to `ignore`): If a request URL doesn't match with
- *                                    any of the controlled routes, it will show the HTML
- *                                    file. Default `true`.
- * @parent module:middlewares
- */
-/**
- * @typedef {FastHTMLOptions & FastHTMLMiddlewareOptionsProperties} FastHTMLMiddlewareOptions
- * @prettierignore
- */
-/**
- * @typedef {Object} FastHTMLMiddlewareOptionsProperties
- * @property {string} htmlGenerator
- * The name of a {@link HTMLGenerator} service for the middleware to use. Default
- * `htmlGenerator`.
- * @parent module:middlewares
- */
-/**
- * It's common for an app to show an HTML view when no route was able to handle a request,
- * so the idea behind this middleware is to avoid going to every middleware and controller
- * and just specify that if the request is not for a route handled by a controller, just
- * serve the HTML and avoid processing unnecessary data.
- *
- * A simple example: The app has a route `/backend` that a frontend uses to get
- * information.
- * This middleware can be used to only allow the execution of middlewares and controllers
- * when the request route is for `/backend`.
- *
- * **Disclaimer**: Managing statics files with Express is not a best practice, but there
- * are scenarios where there is not other choice.
- *
- * @parent module:middlewares
- */
-export class FastHTML {
-    /**
-     * @param {EventsHub}       events                To listen for the {@link Jimpex} event
-     *                                                triggered after the app starts. The
-     *                                                event is used to get all the
-     *                                                controlled routes, in case the
-     *                                                `useAppRoutes` option is set to true.
-     * @param {SendFile}        sendFile              To send the HTML file response.
-     * @param {FastHTMLOptions} [options={}]          To customize the middleware behavior.
-     * @param {?HTMLGenerator}  [htmlGenerator=null]  If used, the file to serve will be the
-     *                                                one generated by that service.
-     */
-    constructor(events: EventsHub, sendFile: SendFile, options?: FastHTMLOptions, htmlGenerator?: HTMLGenerator | null);
-    /**
-     * A local reference for the `events` service.
-     *
-     * @type {EventsHub}
-     * @access protected
-     * @ignore
-     */
-    _events: EventsHub;
-    /**
-     * A local reference for the `sendFile` service.
-     *
-     * @type {SendFile}
-     * @access protected
-     * @ignore
-     */
-    _sendFile: SendFile;
-    /**
-     * If specified, a reference for a service that generates HTML files.
-     *
-     * @type {?HTMLGenerator}
-     * @access protected
-     * @ignore
-     */
-    _htmlGenerator: HTMLGenerator | null;
-    /**
-     * The options that tell the middleware which routes should be ignored and which is
-     * the file to serve.
-     *
-     * @type {FastHTMLOptions}
-     */
-    _options: FastHTMLOptions;
-    /**
-     * Whether or not the file is ready to be served, in case there's an
-     * {@link HTMLGenerator}. If the service is used, the HTML is generated after the app
-     * starts,
-     * so the middleware will have to wait for it to be ready before being able to serve
-     * it.
-     *
-     * @type {boolean}
-     * @access protected
-     * @ignore
-     */
-    _ready: boolean;
-    /**
-     * A list of regular expression that match the routes controlled by the app. This is
-     * in case the `useAppRoutes` option is set to `true`; when the app gets started, an
-     * event listener will obtain all the top controlled routes, create regular
-     * expressions and save them on this property.
-     *
-     * @type {RegExp[]}
-     * @access protected
-     * @ignore
-     */
-    _routeExpressions: RegExp[];
-    /**
-     * Returns the Express middleware that validates the routes and serves the HTML file if
-     * necessary.
-     *
-     * @returns {ExpressMiddleware}
-     */
-    middleware(): ExpressMiddleware;
-    /**
-     * The options that tell the middleware which routes should be ignored and which is the
-     * file to serve.
-     *
-     * @type {FastHTMLOptions}
-     * @todo Remove Object.freeze.
-     */
-    get options(): FastHTMLOptions;
-    /**
-     * Normalizes and validates the options recevied on the constructor.
-     * If the class is using a {@link HTMLGenerator} service, the method will overwrite the
-     * `file`
-     * option with the result of the service's `getFile()` method.
-     *
-     * @param {FastHTMLOptions} options  The received options.
-     * @returns {FastHTMLOptions}
-     * @throws {Error} If no file and no {@link HTMLGenerator} service are specified.
-     * @throws {Error} If no routes to ignore are specified and `useAppRoutes` is set to
-     *                 `false`.
-     * @access protected
-     * @ignore
-     */
-    _normalizeOptions(options: FastHTMLOptions): FastHTMLOptions;
-    /**
-     * Serves the file on the response.
-     *
-     * @param {ExpressResponse} res   The server response.
-     * @param {ExpressNext}     next  The function to call the next middleware.
-     * @access protected
-     * @ignore
-     */
-    _sendHTML(res: ExpressResponse, next: ExpressNext): void;
-    /**
-     * Adds the event listener that obtains the controlled routes when `useAppRoutes` is set
-     * to `true`.
-     *
-     * @access protected
-     * @ignore
-     */
-    _setupEvents(): void;
-    /**
-     * Checks whether a route should be ignored or not. The method checks first against the
-     * `ignore`
-     * option, and then against the controlled routes (if `useAppRoutes` is `false`, the
-     * list will be empty).
-     *
-     * @param {string} route  The route to validate.
-     * @returns {boolean}
-     * @access protected
-     * @ignore
-     */
-    _shouldIgnore(route: string): boolean;
-}
-/**
- * A middleware for filtering routes so you can serve an HTML before the app gets to
- * evaluate whether there's a controller for the requested route or not. For more
- * information about the reason of this middleware, please read the description of
- * {@link FastHTML}.
- *
- * @type {MiddlewareCreator<FastHTMLMiddlewareOptions>}
- * @parent module:middlewares
- */
-export const fastHTML: MiddlewareCreator<FastHTMLMiddlewareOptions>;

package/types/middlewares/html/index.d.ts

@@ -1,3 +0,0 @@
-import { fastHTML } from "./fastHTML";
-import { showHTML } from "./showHTML";
-export { fastHTML, showHTML };