jimpex 7.0.2 → 8.0.0

package/types/services/http/responsesBuilder.d.ts

@@ -1,140 +0,0 @@
-export type Provider = import('../../types').Provider;
-export type AppConfiguration = import('../../types').AppConfiguration;
-export type ExpressResponse = import('../../types').ExpressResponse;
-/**
- * It allows customization of a post message HTML template.
- */
-export type ResponsesBuilderPostMessageOptions = {
-    /**
-     * The target that will emit the `postMessage`.
-     * Default `'window.opener'`.
-     */
-    target: string | null;
-    /**
-     * Whether or not to do a `window.close` after sending the message.
-     * Default `true`.
-     */
-    close: boolean | null;
-    /**
-     * How many ms should it wait before closing the window, if `options.close` is `true`.
-     * Default `700`.
-     */
-    closeDelay: number | null;
-};
-/**
- * @typedef {import('../../types').Provider} Provider
- * @typedef {import('../../types').AppConfiguration} AppConfiguration
- * @typedef {import('../../types').ExpressResponse} ExpressResponse
- */
-/**
- * It allows customization of a post message HTML template.
- *
- * @typedef {Object} ResponsesBuilderPostMessageOptions
- * @property {?string} target
- * The target that will emit the `postMessage`.
- * Default `'window.opener'`.
- * @property {?boolean} close
- * Whether or not to do a `window.close` after sending the message.
- * Default `true`.
- * @property {?number} closeDelay
- * How many ms should it wait before closing the window, if `options.close` is `true`.
- * Default `700`.
- * @parent module:services
- */
-/**
- * A utility service to build server responses.
- *
- * @parent module:services
- */
-export class ResponsesBuilder {
-    /**
-     * @param {AppConfiguration} appConfiguration  To get the app version.
-     */
-    constructor(appConfiguration: AppConfiguration);
-    /**
-     * A local reference for the `appConfiguration` service.
-     *
-     * @type {AppConfiguration}
-     * @access protected
-     * @ignore
-     */
-    _appConfiguration: AppConfiguration;
-    /**
-     * Generates and send an HTML response that emits a post message.
-     * The post message will be prefixed with the value of the configuration setting
-     * `postMessagesPrefix`.
-     *
-     * @param {ExpressResponse} res
-     * The Express response object necessary to write the HTML.
-     * @param {string} title
-     * The title for the HTML.
-     * @param {string} message
-     * The contents of the post message.
-     * @param {number} [status=200]
-     * The HTTP status.
-     * @param {Partial<ResponsesBuilderPostMessageOptions>} [options={}]
-     * Options to customize the HTML.
-     */
-    htmlPostMessage(res: ExpressResponse, title: string, message: string, status?: number, options?: Partial<ResponsesBuilderPostMessageOptions>): void;
-    /**
-     * Generates and sends a JSON response.
-     *
-     * @example
-     *
-     * <caption>The generated looks like this.</caption>
-     *
-     * {
-     * metadata: {
-     * version: '[app-version]',
-     * status: [http-status],
-     * },
-     * data: [...],
-     * }
-     *
-     * @param {ExpressResponse} res            The Express response object necessary to
-     *                                         write the JSON.
-     * @param {Object}          data           The information for the `data` key.
-     * @param {number}          [status=200]   The HTTP status.
-     * @param {Object}          [metadata={}]  Extra information to include on the
-     *                                         `metadata` key.
-     */
-    json(res: ExpressResponse, data: any, status?: number, metadata?: any): void;
-    /**
-     * Generates a basic HTML template for other services to use.
-     *
-     * @param {string} title  The HTML `<title />` attribute.
-     * @param {string} code   Javascript code to be wrapped on a `<script />` tag.
-     * @returns {string}
-     * @access protected
-     * @ignore
-     */
-    _htmlTemplate(title: string, code: string): string;
-    /**
-     * Utility method used to make sure a recevied status is a valid status code. If the
-     * status is a string, the method will try to find the code from the `statuses` package.
-     *
-     * @param {string | number} status  The status to normalize.
-     * @returns {string | number} If `status` is a string, but there's no valid code, it
-     *                            will return it as it was received.
-     * @access protected
-     * @ignore
-     * @todo On the next breaking version, if there's no valid code, it will be
-     *       transformed to `200`.
-     */
-    _normalizeStatus(status: string | number): string | number;
-}
-/**
- * The service provider that once registered on the app container will set an instance of
- * `ResponsesBuilder` as the `responsesBuilder` service.
- *
- * @type {Provider}
- * @example
- *
- *   // Register it on the container
- *   container.register(responsesBuilder);
- *   // Getting access to the service instance
- *   const responsesBuilder = container.get('responsesBuilder');
- *
- * @parent module:services
- */
-export const responsesBuilder: Provider;

package/types/services/index.d.ts

@@ -1,6 +0,0 @@
-import common = require("./common");
-import frontend = require("./frontend");
-import html = require("./html");
-import http = require("./http");
-import utils = require("./utils");
-export { common, frontend, html, http, utils };

package/types/services/utils/ensureBearerToken.d.ts

@@ -1,137 +0,0 @@
-export type ExpressMiddleware = import('../../types').ExpressMiddleware;
-/**
- * <O>
- */
-export type ProviderCreator<O> = import('../../types').ProviderCreator<O>;
-/**
- * These options allow you to modify the error generated by the middleware when the
- * request doesn't have a valid token.
- */
-export type EnsureBearerTokenErrorOptions = {
-    /**
-     * The error message for the response. Default
-     * `'Unauthorized'`.
-     */
-    message: string;
-    /**
-     * The HTTP status that will be added to error context
-     * information.
-     * Default `401`.
-     */
-    status: number;
-    /**
-     * Context information that the error handler can read and
-     * add to the default response. Default `{}`.
-     */
-    response: any;
-};
-/**
- * The options for how to validate the token and, possibly, create the errors.
- */
-export type EnsureBearerTokenOptions = {
-    /**
-     * The options to modify the error generated by the middleware when the request doesn't
-     * have a valid token.
-     */
-    error: EnsureBearerTokenErrorOptions;
-    /**
-     * The regular expression used to extract the token from the request authorization header.
-     */
-    expression: RegExp;
-    /**
-     * The property inside the `res.locals` where the token, if found, will be saved.
-     * Default `'token'`.
-     */
-    local: string;
-};
-/**
- * @typedef {import('../../types').ExpressMiddleware} ExpressMiddleware
- */
-/**
- * @typedef {import('../../types').ProviderCreator<O>} ProviderCreator<O>
- * @template O
- */
-/**
- * These options allow you to modify the error generated by the middleware when the
- * request doesn't have a valid token.
- *
- * @typedef {Object} EnsureBearerTokenErrorOptions
- * @property {string} message   The error message for the response. Default
- *                              `'Unauthorized'`.
- * @property {number} status    The HTTP status that will be added to error context
- *                              information.
- *                              Default `401`.
- * @property {Object} response  Context information that the error handler can read and
- *                              add to the default response. Default `{}`.
- * @parent module:services
- */
-/**
- * The options for how to validate the token and, possibly, create the errors.
- *
- * @typedef {Object} EnsureBearerTokenOptions
- * @property {EnsureBearerTokenErrorOptions} error
- * The options to modify the error generated by the middleware when the request doesn't
- * have a valid token.
- * @property {RegExp} expression
- * The regular expression used to extract the token from the request authorization header.
- * @property {string} local
- * The property inside the `res.locals` where the token, if found, will be saved.
- * Default `'token'`.
- * @parent module:services
- */
-/**
- * This service gives you a middleware that verifies if a request has an `Authorization`
- * header with a bearer token; if it does, the token will be saved on the `res.locals`,
- * otherwise, it will generate an error.
- *
- * @parent module:services
- */
-export class EnsureBearerToken {
-    /**
-     * @param {ClassAppError} AppError
-     * To format the error caused when the request doesn't have a valid token.
-     * @param {Partial<EnsureBearerTokenOptions>} [options={}]
-     * The options to customize the middleware behavior: how to validate the token, how to
-     * save it and what kind of error should generate.
-     */
-    constructor(AppError: any, options?: Partial<EnsureBearerTokenOptions>);
-    /**
-     * A local reference for the class the app uses to generate errors.
-     *
-     * @type {ClassAppError}
-     * @access protected
-     * @ignore
-     */
-    _AppError: any;
-    /**
-     * The options that define how the middleware validates the token, saves it and
-     * generates the possible error.
-     *
-     * @type {EnsureBearerTokenOptions}
-     * @access protected
-     * @ignore
-     */
-    _options: EnsureBearerTokenOptions;
-    /**
-     * Creates the middleware that will validate the presence of a bearer token on the
-     * request authorization header.
-     *
-     * @returns {ExpressMiddleware}
-     */
-    middleware(): ExpressMiddleware;
-    /**
-     * The options that define how the middleware validates the token, saves it and
-     * generates the possible error.
-     *
-     * @type {EnsureBearerTokenOptions}
-     */
-    get options(): EnsureBearerTokenOptions;
-}
-/**
- * Generates a "service middleware" that can be used on route controllers in order to
- * validate the presence of a bearer token on the requests authorization header.
- *
- * @type {ProviderCreator<EnsureBearerTokenOptions>}
- * @parent module:services
- */
-export const ensureBearerToken: ProviderCreator<EnsureBearerTokenOptions>;

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

@@ -1,16 +0,0 @@
-export = utilsServices;
-/**
- * @typedef {import('../../types').Provider} Provider
- */
-/**
- * The providers collection for the utility services.
- *
- * @type {Provider}
- * @property {Provider} ensureBearerToken  The provider for {@link EnsureBearerToken}.
- * @parent module:services
- */
-declare const utilsServices: Provider;
-declare namespace utilsServices {
-    export { Provider };
-}
-type Provider = import('../../types').Provider;

package/types/types.d.ts

@@ -1,280 +0,0 @@
-export type Jimple = any;
-export type AppConfiguration = import('wootils/esm/node/appConfiguration').AppConfiguration;
-export type APIClientBase = import('wootils/esm/shared/apiClient');
-export type APIClientEndpoints = import('wootils/esm/shared/apiClient').APIClientEndpoints;
-export type PathUtils = import('wootils/esm/node/pathUtils').PathUtils;
-export type Logger = import('wootils/esm/node/logger').Logger;
-export type EnvironmentUtils = import('wootils/esm/node/environmentUtils').EnvironmentUtils;
-export type EventsHub = import('wootils/esm/shared/eventsHub');
-export type Provider = import('wootils/esm/shared/jimpleFns').Provider;
-export type Providers = import('wootils/esm/shared/jimpleFns').Providers;
-/**
- * <O>
- */
-export type ProviderCreator<O> = import('wootils/esm/shared/jimpleFns').ProviderCreator<O>;
-export type Express = import('express').Express;
-export type HTTPServer = import('http').Server;
-export type SpdyServer = import('spdy').Server;
-export type SpdyOptions = import('spdy').ServerOptions;
-export type Server = HTTPServer | SpdyServer;
-export type RequestHandler = import('express').RequestHandler;
-export type ErrorRequestHandler = import('express').ErrorRequestHandler;
-export type ExpressMiddleware = RequestHandler | ErrorRequestHandler;
-export type ExpressRequest = import('express').Request;
-export type ExpressResponse = import('express').Response;
-export type ExpressNext = import('express').NextFunction;
-export type ExpressRouter = import('express').Router;
-export type ClassHTTPError = typeof import("./services/common/httpError")['HTTPError'];
-export type ClassAppError = typeof import("./services/common/appError")['AppError'];
-export type Jimpex = import('./app').Jimpex;
-export type JimpexStartCallback = (appConfiguration: AppConfiguration) => any;
-export type JimpexConfigurationOptions = {
-    /**
-     * The app default configuration.
-     * Default `null`.
-     */
-    default: any | null;
-    /**
-     * The name of the app, used for the
-     * configuration files. Default `'app'`.
-     */
-    name: string;
-    /**
-     * The path to the configuration files
-     * directory,
-     * relative to the project root
-     * directory. Default `'config/'`.
-     */
-    path: string;
-    /**
-     * Whether the configurations are inside
-     * a sub directory or not. If `true`, a
-     * configuration path would be
-     * `config/[app-name]/[file]`.
-     * Default `true`.
-     */
-    hasFolder: boolean;
-    /**
-     * The name of the environment variable
-     * that will be used to set the active
-     * configuration.
-     * Default `'CONFIG'`.
-     */
-    environmentVariable: string;
-    /**
-     * Whether or not to check for the
-     * environment variable and load a
-     * configuration based on its value.
-     * Default `true`.
-     */
-    loadFromEnvironment: boolean;
-    /**
-     * If `true`, the app `version` will be
-     * taken from the loaded configuration,
-     * otherwise, when a configuration is
-     * loaded, the app will copy the version
-     * it has into the configuration.
-     * Default `true`.
-     */
-    loadVersionFromConfiguration: boolean;
-    /**
-     * The name format the configuration
-     * files have.
-     * Default:
-     *
-     *
-     * `[app-name].[configuration-name].config.js`.
-     */
-    filenameFormat: string;
-};
-export type JimpexStaticsOptions = {
-    /**
-     * Whether or not to include the middleware for static files.
-     * Default `true`.
-     */
-    enabled: boolean;
-    /**
-     * If `true`, the path to the statics folder will be relative
-     * to the project root directory, otherwise, it will be
-     * relative to the directory where the app executable file is
-     * located. Default `false`.
-     */
-    onHome: boolean;
-    /**
-     * The name of both the route and the folder, relative to
-     * whatever you defined with the `onHome` option. Default
-     * `'static'`.
-     */
-    route: string;
-    /**
-     * By default, the folder will be the same as the `route`,
-     * but you can use this option to define a relative path that
-     * won't affect the route. Default `''`.
-     */
-    folder: string;
-};
-export type JimpexExpressOptions = {
-    /**
-     * Whether or not to enable the `trust proxy`
-     * option.
-     * Default `true`.
-     */
-    trustProxy: boolean;
-    /**
-     * Whether or not to remove the `x-powered-by`
-     * header.
-     * Default `true`.
-     */
-    disableXPoweredBy: boolean;
-    /**
-     * Whether or not to add the `compression`
-     * middleware.
-     * Default `true`.
-     */
-    compression: boolean;
-    /**
-     * Whether or not to add the `body-parser`
-     * middleware.
-     * Default `true`.
-     */
-    bodyParser: boolean;
-    /**
-     * Whether or not to add the `multer` middleware.
-     * Default `true`.
-     */
-    multer: boolean;
-};
-export type JimpexDefaultServicesOptions = {
-    /**
-     * Whether or not to register all the `common` service
-     * providers.
-     * Default `true`.
-     */
-    common: boolean;
-    /**
-     * Whether or not to register all the `http` service
-     * providers.
-     * Default `true`.
-     */
-    http: boolean;
-    /**
-     * Whether or not to register all the `utils` service
-     * providers.
-     * Default `true`.
-     */
-    utils: boolean;
-};
-export type JimpexOptions = {
-    /**
-     * The app version. To be used on the configuration. Default `'0.0.0'`.
-     */
-    version: string;
-    /**
-     * The size limit for the requests payload. Default `'15MB'`.
-     */
-    filesizeLimit: string;
-    /**
-     * Whether or not to automatically call the `boot` method after initialization.
-     * Default `true`.
-     */
-    boot: boolean;
-    /**
-     * Whether or not to enable the proxy mode, so all providers, controllers and middlewares
-     * will receive a proxied reference of the container, in which they can set and get
-     * resources using dot notation.
-     */
-    proxy: boolean;
-    /**
-     * The options for the app configuration service.
-     */
-    configuration: JimpexConfigurationOptions;
-    /**
-     * The options for the app static `middleware`.
-     */
-    statics: JimpexStaticsOptions;
-    /**
-     * The options for the Express app.
-     */
-    express: JimpexExpressOptions;
-    /**
-     * To tell the app which services should be registered when instantiated.
-     */
-    defaultServices: JimpexDefaultServicesOptions;
-};
-/**
- * An object that when mounted on Jimpex will take care of handling a list of specific
- * routes. The method Jimpex uses to mount a controller is {@link Jimpexmount }.
- */
-export type Controller = {
-    /**
-     * The function Jimpex calls when mounting the
-     * controller.
-     */
-    connect: ControllerConnectFn;
-    /**
-     * A flag set to `true` to identify the
-     * resource as a routes controller.
-     */
-    controller: boolean;
-};
-export type ControllerProviderRegisterFn = (app: Jimpex, route: string) => Controller;
-/**
- * This is a special kind of controller that not only registers routes but also adds
- * resources to the container, and to avoid doing it during the mount process, it
- * registers the resources first and then returns the actuall controller.
- */
-export type ControllerProvider = {
-    /**
-     * The function Jimpex calls when
-     * registering the provider and the one
-     * that has to generate the controller.
-     */
-    register: ControllerProviderRegisterFn;
-};
-/**
- * The function called by the application container in order to mount a routes controller.
- */
-export type ControllerConnectFn = (app: Jimpex, route: string) => any;
-/**
- * A function called in order to generate a {@link Controller }. They usually have
- * different options that will be sent to the controller creation.
- */
-export type ControllerCreatorFn = () => ControllerConnectFn;
-/**
- * A special kind of {@link Controller } that can be used with {@link Jimpexmount } as a
- * regular controller, or it can be called as a function with custom parameters in order
- * to obtain a "configured {@link Controller }".
- */
-export type ControllerCreator<O> = (options?: Partial<O>) => Controller | ControllerProvider;
-/**
- * An object that when mounted on Jimpex add an {@link ExpressMiddleware } to the app. The
- * method Jimpex uses to mount a middleware is {@link Jimpexuse }.
- */
-export type Middleware = {
-    /**
-     * The function Jimpex calls when mounting the
-     * middleware.
-     */
-    connect: MiddlewareConnectFn;
-    /**
-     * A flag set to `true` to identify the
-     * resource as a middleware.
-     */
-    middleware: boolean;
-};
-/**
- * The function called by the application container in order to use a middleware.
- */
-export type MiddlewareConnectFn = (app: Jimpex) => ExpressMiddleware | null;
-/**
- * A function called in order to generate a {@link Middleware }. They usually have
- * different options that will be sent to the middleware creation.
- */
-export type MiddlewareCreatorFn = () => MiddlewareConnectFn;
-/**
- * A special kind of {@link Middleware } that can be used with {@link Jimpexuse } as a
- * regular middleware, or it can be called as a function with custom parameters in order
- * to obtain a "configured {@link Middleware }".
- */
-export type MiddlewareCreator<O> = (options?: Partial<O>) => Middleware;
-export type MiddlewareLike = Middleware | ExpressMiddleware;

package/types/utils/functions.d.ts

@@ -1,55 +0,0 @@
-/**
- * Given a server route definition, this function creates a regular expression to match
- * it: The expression replaces the routes parameters with placeholders so it can be
- * compared with real routes.
- *
- * @param {string}  route                  The route from which the expression will be
- *                                         created.
- * @param {boolean} [leadingSlash=true]    Whether or not the expression should match a
- *                                         leading slash.
- * @param {boolean} [trailingSlash=false]  Whether or not the expression should match a
- *                                         trailing slash. The reason this is `false` by
- *                                         default is because these expressions are often
- *                                         used to match against incoming requests, and
- *                                         they don't have a trailing slash.
- * @returns {RegExp}
- * @parent module:functions
- */
-export function createRouteExpression(route: string, leadingSlash?: boolean, trailingSlash?: boolean): RegExp;
-/**
- * Escapes a string to be used on `new RegExp(...)`.
- *
- * @param {string} text  The text to escape.
- * @returns {string}
- * @parent module:functions
- */
-export function escapeForRegExp(text: string): string;
-/**
- * @module functions
- */
-/**
- * Removes any leading slash from a URL.
- *
- * @param {string} url  The URL to format.
- * @returns {string}
- * @parent module:functions
- */
-export function removeLeadingSlash(url: string): string;
-/**
- * Remove any leading and trailing slash from a URL.
- *
- * @param {string}  url              The URL to format.
- * @param {boolean} [leading=true]   Whether or not to remove any leading slash.
- * @param {boolean} [trailing=true]  Whether or not to remove the trailing slash.
- * @returns {string}
- * @parent module:functions
- */
-export function removeSlashes(url: string, leading?: boolean, trailing?: boolean): string;
-/**
- * Removes any trailing slash from a URL.
- *
- * @param {string} url  The URL to format.
- * @returns {string}
- * @parent module:functions
- */
-export function removeTrailingSlash(url: string): string;