jimpex 10.0.2 → 11.0.1

package/dist/services/http/http.d.mts

@@ -1,182 +0,0 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
-import { Request } from 'express';
-import { NodeFetch } from '../../types/http.mjs';
-import { SimpleLogger } from '@homer0/simple-logger';
-import { BodyInit, Response, RequestInit } from 'node-fetch';
-import '../../types/express.mjs';
-import '../../types/utils.mjs';
-import '@homer0/path-utils';
-import '@homer0/simple-config';
-import '@homer0/events-hub';
-import 'https';
-import 'http';
-import 'spdy';
-
-/**
- * The options to customize the service.
- *
- * @group Services/HTTP
- */
-type HTTPOptions = {
-    /**
-     * Whether or not the service should log the requests and their responses.
-     */
-    logRequests?: boolean;
-};
-/**
- * The options to construct a {@link HTTP}.
- *
- * @group Services/HTTP
- */
-type HTTPContructorOptions = Partial<HTTPOptions> & {
-    /**
-     * A dictionary with the dependencies to inject.
-     */
-    inject: {
-        logger: SimpleLogger;
-        nodeFetch: NodeFetch;
-    };
-};
-/**
- * The allowed formats for the body of a request.
- *
- * @group Services/HTTP
- */
-type HTTPFetchBody = string | Record<string | number, unknown> | BodyInit;
-/**
- * The options for a request.
- *
- * @group Services/HTTP
- */
-type HTTPFetchOptions = {
-    /**
-     * The HTTP method.
-     *
-     * @default 'GET'
-     */
-    method?: string;
-    /**
-     * The headers dictionary.
-     */
-    headers?: Record<string, string>;
-    /**
-     * The body of the request.
-     */
-    body?: HTTPFetchBody;
-    /**
-     * A dictionary of query string parameters.
-     */
-    qs?: Record<string, unknown>;
-    /**
-     * A request object generated by the application. This can be used to copy information
-     * like custom headers or the IP (for the X-Forwarded-For header).
-     */
-    req?: Request;
-};
-/**
- * The options for the method that extracts custom headers from a request.
- *
- * @group Services/HTTP
- */
-type GetCustomHeadersFromRequestOptions = {
-    /**
-     * Since the method considers all headers that start with `x-` as custom headers,
-     * setting this to `false` is the only way to exclude `x-forwarded-` headers from the
-     * list.
-     *
-     * @default false
-     */
-    includeXForwardedHeaders?: boolean;
-};
-/**
- * A set of utilities to work with HTTP requests and responses.
- *
- * @group Services
- * @group Services/HTTP
- */
-declare class HTTP {
-    /**
-     * The service used to log information in the terminal.
-     */
-    protected readonly _logger: SimpleLogger;
-    /**
-     * The node-fetch library. Since it's an ESM only module, Jimpex loads it on boot and makes
-     * it available on the container.
-     */
-    protected readonly _nodeFetch: NodeFetch;
-    /**
-     * The service customization options.
-     */
-    protected readonly _options: HTTPOptions;
-    /**
-     * @param options  The options to construct the class.
-     */
-    constructor({ inject: { logger, nodeFetch }, ...options }: HTTPContructorOptions);
-    /**
-     * Makes a fetch request.
-     *
-     * @param url      The URL to fetch.
-     * @param options  The custom options for the request.
-     */
-    fetch(url: string, options?: HTTPFetchOptions): Promise<Response>;
-    /**
-     * Tries to get the IP address from a given request.
-     *
-     * @param req  The request from which it will try to obtain the IP address.
-     */
-    getIPFromRequest(req: Request): string | undefined;
-    /**
-     * Creates a dictionary with all the custom headers a request has. By custom header it
-     * means all the headers which name start with `x-`.
-     *
-     * @param req      The request from which it will try to get the headers.
-     * @param options  The options to customize the behavior with certain headers.
-     */
-    getCustomHeadersFromRequest(req: Request, options?: GetCustomHeadersFromRequestOptions): Record<string, string>;
-    /**
-     * It takes a dictionary of headers and normalize the names so each word will start with
-     * an upper case character. This is helpful in case you added custom headers and didn't
-     * care about the casing, or when copying headers from a server request, as they all
-     * come tranformed into lower case.
-     *
-     * @param headers  The dictionary of headers to normalize.
-     */
-    normalizeHeaders(headers: Record<string, string>): Record<string, string>;
-    /**
-     * The customization options.
-     */
-    get options(): Readonly<HTTPOptions>;
-    /**
-     * Logs a request information into the terminal.
-     *
-     * @param url      The request URL.
-     * @param options  The options for the request.
-     */
-    protected _logRequest(url: string, options: RequestInit): void;
-    /**
-     * Logs a response information into the terminal.
-     *
-     * @param response  The response to log.
-     */
-    protected _logResponse(response: Response): void;
-}
-/**
- * The service provider that once registered on the container will set an instance of
- * {@link HTTP} as the `http` service. The provider also checks the `debug.logRequests`
- * setting on the application configuration in order to enable or not the logging of
- * requests/responses.
- *
- * @example
- *
- *   // Register it on the container
- *   container.register(httpProvider);
- *   // Getting access to the service instance
- *   const http = container.get<HTTP>('http');
- *
- * @group Providers
- * @group Services/HTTP
- */
-declare const httpProvider: _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>;
-
-export { type GetCustomHeadersFromRequestOptions, HTTP, type HTTPContructorOptions, type HTTPFetchBody, type HTTPFetchOptions, type HTTPOptions, httpProvider };

package/dist/services/http/index.d.mts

@@ -1,51 +0,0 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
-export { ErrorResponse } from '@homer0/api-utils';
-import { APIClientProviderOptions } from './apiClient.mjs';
-export { APIClient, APIClientConfig, APIClientConstructorOptions, APIClientSettings, EndpointsType, apiClientProvider } from './apiClient.mjs';
-export { GetCustomHeadersFromRequestOptions, HTTP, HTTPContructorOptions, HTTPFetchBody, HTTPFetchOptions, HTTPOptions, httpProvider } from './http.mjs';
-export { HTMLPostMessageResponseOptions, JSONResponseOptions, ResponsesBuilder, ResponsesBuilderConstructorOptions, responsesBuilderProvider } from './responsesBuilder.mjs';
-import '../../types/express.mjs';
-import 'express';
-import '../../types/http.mjs';
-import 'https';
-import 'http';
-import 'spdy';
-import 'node-fetch';
-import '../../types/utils.mjs';
-import '@homer0/path-utils';
-import '@homer0/simple-logger';
-import '@homer0/simple-config';
-import '@homer0/events-hub';
-import '../common/httpError.mjs';
-import '../../utils/fns/statuses.mjs';
-import 'statuses';
-import '../common/appError.mjs';
-
-/**
- * Registers all the HTTP services on the container.
- *
- * - {@link APIClient | apiClient}
- * - {@link HTTP | http}
- * - {@link ResponsesBuilder | responsesBuilder}
- *
- * @example
- *
- *   // Register the collection on the container
- *   container.register(httpServicesProvider);
- *   // Getting access to one the services instance
- *   const apiClient = container.get<APIClient>('apiClient');
- *
- * @group Providers
- */
-declare const httpServicesProvider: {
-    apiClientProvider: _homer0_jimple.ResourceCreator<"provider", "register", (options?: APIClientProviderOptions) => (app: Jimpex) => void, _homer0_jimple.ProviderRegisterFn<Jimpex>>;
-    httpProvider: _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>;
-    responsesBuilderProvider: _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>;
-} & Record<string, _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>> & {
-    provider: true;
-} & {
-    register: _homer0_jimple.ProviderRegisterFn<Jimpex>;
-} & Record<string, unknown>;
-
-export { APIClientProviderOptions, httpServicesProvider };

package/dist/services/http/responsesBuilder.d.mts

@@ -1,179 +0,0 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
-import { Response } from 'express';
-import { Statuses } from '../../utils/fns/statuses.mjs';
-import { SimpleConfig } from '@homer0/simple-config';
-import '../../types/express.mjs';
-import '../../types/http.mjs';
-import 'https';
-import 'http';
-import 'spdy';
-import 'node-fetch';
-import '../../types/utils.mjs';
-import '@homer0/path-utils';
-import '@homer0/simple-logger';
-import '@homer0/events-hub';
-import 'statuses';
-
-/**
- * The options to construct a {@link ResponsesBuilder}.
- *
- * @group Services/ResponsesBuilder
- */
-type ResponsesBuilderConstructorOptions = {
-    /**
-     * A dictionary with the dependencies to inject.
-     */
-    inject: {
-        config: SimpleConfig;
-        statuses: Statuses;
-    };
-};
-/**
- * The options to build a response for a post message.
- *
- * @group Services/ResponsesBuilder
- */
-type HTMLPostMessageResponseOptions = {
-    /**
-     * The response object generated by the application.
-     */
-    res: Response;
-    /**
-     * The title for the HTML.
-     */
-    title: string;
-    /**
-     * The contents of the post message.
-     */
-    message: string;
-    /**
-     * The status code for the response.
-     *
-     * @default 200
-     */
-    status?: number | string;
-    /**
-     * From which object will the `postMessage` method called from.
-     *
-     * @default 'window.opener'
-     */
-    target?: string;
-    /**
-     * Whether or not to call `window.close` after sending the message.
-     *
-     * @default true
-     */
-    close?: boolean;
-    /**
-     * In case `close` is set to `true`, this option is to specify how many milliseconds
-     * should be waited before closing the window.
-     *
-     * @default 700
-     */
-    closeDelay?: number;
-};
-/**
- * The options to build a reponse for JSON.
- *
- * @group Services/ResponsesBuilder
- */
-type JSONResponseOptions = {
-    /**
-     * The response object generated by the application.
-     */
-    res: Response;
-    /**
-     * The actual data for the response. It will be added in a `data` property.
-     */
-    data: unknown;
-    /**
-     * The status code for the response.
-     *
-     * @default 200
-     */
-    status?: number | string;
-    /**
-     * Extra information to include inside the `metadata` object.
-     */
-    metadata?: object;
-};
-/**
- * A utility service to build responses.
- *
- * @group Services
- * @group Services/ResponsesBuilder
- */
-declare class ResponsesBuilder {
-    /**
-     * The application configuration, to get the `version` and the `postMessagesPrefix`.
-     */
-    protected readonly _config: SimpleConfig;
-    /**
-     * The uility service to get HTTP status codes.
-     */
-    protected readonly _statuses: Statuses;
-    /**
-     * @param options  The options to construct the service.
-     */
-    constructor({ inject: { config, statuses } }: ResponsesBuilderConstructorOptions);
-    /**
-     * 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 options  The options to customize how the HTML is generated.
-     */
-    htmlPostMessage(options: HTMLPostMessageResponseOptions): void;
-    /**
-     * Generates and sends a JSON response.
-     *
-     * @param options  The options to customize how the JSON is generated.
-     * @example
-     *
-     * <caption>The generated looks like this.</caption>
-     *
-     * {
-     *   metadata: {
-     *     version: 'dev',
-     *     status: 200,
-     *   },
-     *   data: { foo: 'bar' },
-     * }
-     *
-     */
-    json(options: JSONResponseOptions): void;
-    /**
-     * Generates a basic HTML template for the service to use when generating a post message
-     * response.
-     *
-     * @param title  The HTML `<title />` attribute.
-     * @param code   Javascript code to be wrapped on a `<script />` tag.
-     */
-    protected _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 status  The status to normalize.
-     * @returns If `status` is a string, but there's no valid code, it will return 200.
-     */
-    protected _normalizeStatus(status: number | string): number;
-}
-/**
- * The service provider that once registered on the container will set an instance of
- * {@link ResponsesBuilder} as the `responsesBuilder` service.
- *
- * @example
- *
- *   // Register it on the container
- *   container.register(responsesBuilderProvider);
- *   // Getting access to the service instance
- *   const responsesBuilder = container.get<ResponsesBuilder>('responsesBuilder');
- *
- * @group Providers
- * @group Services/ResponsesBuilder
- */
-declare const responsesBuilderProvider: _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>;
-
-export { type HTMLPostMessageResponseOptions, type JSONResponseOptions, ResponsesBuilder, type ResponsesBuilderConstructorOptions, responsesBuilderProvider };

package/dist/services/index.d.mts

@@ -1,33 +0,0 @@
-export { commonServicesProvider } from './common/index.mjs';
-export { frontendServicesProvider } from './frontend/index.mjs';
-export { htmlServicesProvider } from './html/index.mjs';
-export { httpServicesProvider } from './http/index.mjs';
-export { utilsServicesProvider } from './utils/index.mjs';
-export { AppError, AppErrorClass, AppErrorContext, CreateAppErrorFn, appErrorProvider, createAppError } from './common/appError.mjs';
-export { CreateHTTPErrorFn, HTTPError, HTTPErrorClass, createHTTPError, httpErrorProvider } from './common/httpError.mjs';
-export { SendFile, SendFileGeneratorOptions, SendFileOptions, sendFile, sendFileProvider } from './common/sendFile.mjs';
-export { FrontendFs, FrontendFsOptions, frontendFsProvider } from './frontend/frontendFs.mjs';
-export { HTMLGenerator, HTMLGeneratorConstructorOptions, HTMLGeneratorOptions, HTMLGeneratorProviderOptions, HTMLGeneratorValuesService, htmlGeneratorProvider } from './html/htmlGenerator.mjs';
-export { ErrorResponse } from '@homer0/api-utils';
-export { APIClient, APIClientConfig, APIClientConstructorOptions, APIClientProviderOptions, APIClientSettings, EndpointsType, apiClientProvider } from './http/apiClient.mjs';
-export { GetCustomHeadersFromRequestOptions, HTTP, HTTPContructorOptions, HTTPFetchBody, HTTPFetchOptions, HTTPOptions, httpProvider } from './http/http.mjs';
-export { HTMLPostMessageResponseOptions, JSONResponseOptions, ResponsesBuilder, ResponsesBuilderConstructorOptions, responsesBuilderProvider } from './http/responsesBuilder.mjs';
-export { EnsureBearerConstructorOptions, EnsureBearerToken, EnsureBearerTokenErrorOptions, EnsureBearerTokenOptions, EnsureBearerTokenProviderOptions, ensureBearerTokenProvider } from './utils/ensureBearerToken.mjs';
-import '@homer0/jimple';
-import '../index-Bwf7JHu9.mjs';
-import '../types/express.mjs';
-import 'express';
-import '../types/http.mjs';
-import 'https';
-import 'http';
-import 'spdy';
-import 'node-fetch';
-import '../types/utils.mjs';
-import '@homer0/path-utils';
-import '@homer0/simple-logger';
-import '@homer0/simple-config';
-import '@homer0/events-hub';
-import '../utils/fns/statuses.mjs';
-import 'statuses';
-import 'fs/promises';
-import '@homer0/deferred';

package/dist/services/utils/ensureBearerToken.d.mts

@@ -1,158 +0,0 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
-import { ExpressMiddleware } from '../../types/express.mjs';
-import { Statuses } from '../../utils/fns/statuses.mjs';
-import { DeepPartial } from '../../types/utils.mjs';
-import { HTTPErrorClass } from '../common/httpError.mjs';
-import '../../types/http.mjs';
-import 'https';
-import 'http';
-import 'spdy';
-import 'node-fetch';
-import 'express';
-import '@homer0/path-utils';
-import '@homer0/simple-logger';
-import '@homer0/simple-config';
-import '@homer0/events-hub';
-import 'statuses';
-import '../common/appError.mjs';
-
-/**
- * The options for the error the middleare can generate.
- *
- * @group Services/EnsureBearerToken
- */
-type EnsureBearerTokenErrorOptions = {
-    /**
-     * The error message for the response.
-     *
-     * @default 'Unauthorized'
-     */
-    message: string;
-    /**
-     * The HTTP status that will be added to the error context.
-     *
-     * @default 401
-     */
-    status: number;
-    /**
-     * Context information for the error handler and that can be added to the actual
-     * response.
-     */
-    response: unknown;
-};
-/**
- * The options to customize the service/middleware.
- *
- * @group Services/EnsureBearerToken
- */
-type EnsureBearerTokenOptions = {
-    error: EnsureBearerTokenErrorOptions;
-    expression: RegExp;
-    local: string;
-};
-/**
- * The options to construct a {@link EnsureBearerToken}.
- *
- * @group Services/EnsureBearerToken
- */
-type EnsureBearerConstructorOptions = DeepPartial<EnsureBearerTokenOptions> & {
-    /**
-     * A dictionary with the dependencies to inject.
-     */
-    inject: {
-        HTTPError: HTTPErrorClass;
-        statuses: Statuses;
-    };
-};
-/**
- * Custom options for the provider that will register an instance of
- * {@link EnsureBearerToken}
- * as a service.
- *
- * @group Services/EnsureBearerToken
- */
-type EnsureBearerTokenProviderOptions = DeepPartial<EnsureBearerTokenOptions> & {
-    /**
-     * The name that will be used to register the service on the container. This is to allow
-     * multiple "instances" of the service to be created.
-     *
-     * @default 'ensureBearerToken'
-     */
-    serviceName?: string;
-};
-/**
- * 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.
- *
- * This is a "service middleware" to allow certain flexibility: you can have controllers
- * where some routes are protected and others are not. For those cases, you get the
- * service from the container, and include it only in the routes that need it.
- *
- * @group Services
- * @group Services/EnsureBearerToken
- */
-declare class EnsureBearerToken {
-    /**
-     * To generate the errors when the validation fails.
-     */
-    protected readonly _HTTPError: HTTPErrorClass;
-    /**
-     * The customization options for the service.
-     */
-    protected readonly _options: EnsureBearerTokenOptions;
-    /**
-     * @param options  The options to construct the class.
-     */
-    constructor({ inject: { HTTPError, statuses }, ...options }: EnsureBearerConstructorOptions);
-    /**
-     * Generates the middleware that verifies if a request has an `Authorization` header
-     * with a bearer token.
-     */
-    getMiddleware(): ExpressMiddleware;
-    /**
-     * The customization options.
-     */
-    get options(): Readonly<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.
- *
- * The registered service is an instance of {@link EnsureBearerToken}, and it uses the key
- * `ensureBearerToken`.
- *
- * Since it's a "provider creator", when registering it, you can pass custom options.
- *
- * @example
- *
- * <caption>Basic usage</caption>
- *
- *   // Register it on the container
- *   container.register(ensureBearerTokenProvider);
- *
- *   // Let's assume we are in a controller now...
- *   // Getting access to the middleware.
- *   const ensureBearerToken = container.get<ExpressMiddleware>('ensureBearerToken');
- *
- * @example
- *
- * <caption>Customizing the service</caption>
- *
- *   // Register it on the container
- *   container.register(
- *     ensureBearerTokenProvider({
- *       serviceName: 'ensureBearerTokenCustom',
- *       error: {
- *         message: 'Missing token!',
- *       },
- *     }),
- *   );
- *
- * @group Providers
- * @group Services/EnsureBearerToken
- */
-declare const ensureBearerTokenProvider: _homer0_jimple.ResourceCreator<"provider", "register", (options?: EnsureBearerTokenProviderOptions) => (app: Jimpex) => void, _homer0_jimple.ProviderRegisterFn<Jimpex>>;
-
-export { type EnsureBearerConstructorOptions, EnsureBearerToken, type EnsureBearerTokenErrorOptions, type EnsureBearerTokenOptions, type EnsureBearerTokenProviderOptions, ensureBearerTokenProvider };

package/dist/services/utils/index.d.mts

@@ -1,44 +0,0 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
-import { EnsureBearerTokenProviderOptions } from './ensureBearerToken.mjs';
-export { EnsureBearerConstructorOptions, EnsureBearerToken, EnsureBearerTokenErrorOptions, EnsureBearerTokenOptions, ensureBearerTokenProvider } from './ensureBearerToken.mjs';
-import '../../types/express.mjs';
-import 'express';
-import '../../types/http.mjs';
-import 'https';
-import 'http';
-import 'spdy';
-import 'node-fetch';
-import '../../types/utils.mjs';
-import '@homer0/path-utils';
-import '@homer0/simple-logger';
-import '@homer0/simple-config';
-import '@homer0/events-hub';
-import '../../utils/fns/statuses.mjs';
-import 'statuses';
-import '../common/httpError.mjs';
-import '../common/appError.mjs';
-
-/**
- * Registers all the utility services on the container.
- *
- * - {@link EnsureBearerToken | ensureBearerToken}
- *
- * @example
- *
- *   // Register the collection on the container
- *   container.register(utilsServicesProvider);
- *   // Getting access to one the services instance
- *   const ensureBearerToken = container.get<EnsureBearerToken>('ensureBearerToken');
- *
- * @group Providers
- */
-declare const utilsServicesProvider: {
-    ensureBearerTokenProvider: _homer0_jimple.ResourceCreator<"provider", "register", (options?: EnsureBearerTokenProviderOptions) => (app: Jimpex) => void, _homer0_jimple.ProviderRegisterFn<Jimpex>>;
-} & Record<string, _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>> & {
-    provider: true;
-} & {
-    register: _homer0_jimple.ProviderRegisterFn<Jimpex>;
-} & Record<string, unknown>;
-
-export { EnsureBearerTokenProviderOptions, utilsServicesProvider };

package/dist/types/events.d.mts

@@ -1,14 +0,0 @@
-import './express.mjs';
-export { E as EventPayload, l as Events, k as JimpexEventListener, b as JimpexEventName, i as JimpexEventNameLike, c as JimpexEventPayload, a as JimpexEvents, f as JimpexReducerEventName, h as JimpexReducerEventPayload, e as JimpexReducerEventPayloads, g as JimpexReducerEventTarget, d as JimpexReducerEventTargets } from '../index-Bwf7JHu9.mjs';
-import 'express';
-import './http.mjs';
-import 'https';
-import 'http';
-import 'spdy';
-import 'node-fetch';
-import './utils.mjs';
-import '@homer0/path-utils';
-import '@homer0/simple-logger';
-import '@homer0/simple-config';
-import '@homer0/events-hub';
-import '@homer0/jimple';

package/dist/types/express.d.mts

@@ -1,10 +0,0 @@
-import { RequestHandler, ErrorRequestHandler } from 'express';
-export { Express, NextFunction, Request, Response, Router } from 'express';
-
-type ExpressMiddlewareLike = RequestHandler | ErrorRequestHandler;
-type ExpressMiddleware = RequestHandler;
-type AsyncExpressMiddleware = (...args: Parameters<ExpressMiddleware>) => Promise<void>;
-type ExpressErrorHandler = ErrorRequestHandler;
-type RouterMethod = 'all' | 'get' | 'head' | 'post' | 'patch' | 'put' | 'delete' | 'connect' | 'options' | 'trace';
-
-export type { AsyncExpressMiddleware, ExpressErrorHandler, ExpressMiddleware, ExpressMiddlewareLike, RouterMethod };