jimpex 7.0.2 → 8.0.0

package/types/services/html/htmlGenerator.d.ts

@@ -1,298 +0,0 @@
-export type AppConfiguration = import('../../types').AppConfiguration;
-export type Logger = import('../../types').Logger;
-export type FrontendFs = import('../frontend/frontendFs').FrontendFs;
-/**
- * <O>
- */
-export type ProviderCreator<O> = import('../../types').ProviderCreator<O>;
-/**
- * The options to customize the an `HTMLGenerator` service.
- */
-export type HTMLGeneratorOptions = {
-    /**
-     * The name of the file it should use as
-     * template.
-     * Default `'index.tpl.html'`.
-     */
-    template: string;
-    /**
-     * The name of the generated file. Default
-     * `'index.html'`.
-     */
-    file: string;
-    /**
-     * Whether or not to delete the tempalte after
-     * generating the file. Default `true`.
-     */
-    deleteTemplateAfter: boolean;
-    /**
-     * The placeholder string where the information
-     * will be written. Default
-     * `'{{appConfiguration}}'`.
-     */
-    replacePlaceholder: string;
-    /**
-     * A regular expression for dynamic placeholders
-     * that will be replaced by values when the file
-     * is generated.
-     * Default `'{{(.*?)}}'`.
-     */
-    valuesExpression: RegExp;
-    /**
-     * The name of the variable that will have the
-     * information on the file. Default
-     * `'appConfiguration'`.
-     */
-    variable: string;
-    /**
-     * A list of settings from the app configuration
-     * that will be used as the information to
-     * inject on the file.
-     * Default `['features', 'version',
-     * 'postMessagesPrefix']`.
-     */
-    configurationKeys: string[];
-};
-export type HTMLGeneratorProviderOptions = HTMLGeneratorOptions & HTMLGeneratorProviderOptionsProperties;
-export type HTMLGeneratorProviderOptionsProperties = {
-    /**
-     * The name that will be used to register the service on the app container. This is to
-     * allow multiple "instances" of the service to be created.
-     */
-    serviceName?: string;
-    /**
-     * The name of a service that the generator will use in order to read the values that will
-     * be injected on the template. If the service is available, the values from
-     * `configurationKeys`
-     * will be ignored.
-     */
-    valuesService?: string | null;
-};
-export type HTMLGeneratorValuesServiceGetValues = () => Promise<any>;
-/**
- * A service to provide the information value to an `HTMLGenerator` service to use on the
- * generated file.
- */
-export type HTMLGeneratorValuesService = {
-    /**
-     * This is the method an `HTMLGenerator` service will call in order to retrieve the values
-     * that should be injected on the generated file.
-     */
-    getValues: HTMLGeneratorValuesServiceGetValues;
-};
-/**
- * @typedef {import('../../types').AppConfiguration} AppConfiguration
- * @typedef {import('../../types').Logger} Logger
- * @typedef {import('../frontend/frontendFs').FrontendFs} FrontendFs
- */
-/**
- * @typedef {import('../../types').ProviderCreator<O>} ProviderCreator<O>
- * @template O
- */
-/**
- * The options to customize the an `HTMLGenerator` service.
- *
- * @typedef {Object} HTMLGeneratorOptions
- * @property {string}   template             The name of the file it should use as
- *                                           template.
- *                                           Default `'index.tpl.html'`.
- * @property {string}   file                 The name of the generated file. Default
- *                                           `'index.html'`.
- * @property {boolean}  deleteTemplateAfter  Whether or not to delete the tempalte after
- *                                           generating the file. Default `true`.
- * @property {string}   replacePlaceholder   The placeholder string where the information
- *                                           will be written. Default
- *                                           `'{{appConfiguration}}'`.
- * @property {RegExp}   valuesExpression     A regular expression for dynamic placeholders
- *                                           that will be replaced by values when the file
- *                                           is generated.
- *                                           Default `'{{(.*?)}}'`.
- * @property {string}   variable             The name of the variable that will have the
- *                                           information on the file. Default
- *                                           `'appConfiguration'`.
- * @property {string[]} configurationKeys    A list of settings from the app configuration
- *                                           that will be used as the information to
- *                                           inject on the file.
- *                                           Default `['features', 'version',
- *                                           'postMessagesPrefix']`.
- * @parent module:services
- */
-/**
- * @typedef {HTMLGeneratorOptions & HTMLGeneratorProviderOptionsProperties} HTMLGeneratorProviderOptions
- * @parent module:services
- * @prettierignore
- */
-/**
- * @typedef {Object} HTMLGeneratorProviderOptionsProperties
- * @property {string} [serviceName='htmlGenerator']
- * The name that will be used to register the service on the app container. This is to
- * allow multiple "instances" of the service to be created.
- * @property {?string} [valuesService='htmlGeneratorValues']
- * The name of a service that the generator will use in order to read the values that will
- * be injected on the template. If the service is available, the values from
- * `configurationKeys`
- * will be ignored.
- * @parent module:services
- */
-/**
- * @callback HTMLGeneratorValuesServiceGetValues
- * @returns {Promise<Object>}
- * @parent module:services
- */
-/**
- * A service to provide the information value to an `HTMLGenerator` service to use on the
- * generated file.
- *
- * @typedef {Object} HTMLGeneratorValuesService
- * @property {HTMLGeneratorValuesServiceGetValues} getValues
- * This is the method an `HTMLGenerator` service will call in order to retrieve the values
- * that should be injected on the generated file.
- * @parent module:services
- */
-/**
- * This is a utility sever that generates an HTML file with custom information when the
- * app server is started.
- *
- * @parent module:services
- */
-export class HTMLGenerator {
-    /**
-     * @param {AppConfiguration} appConfiguration
-     * To read the values of the settings that are going to be send to the file.
-     * @param {Logger} appLogger
-     * To log messages when the file is generated, when the template is removed, and if it
-     * happens,
-     * when an error is thrown.
-     * @param {FrontendFs} frontendFs
-     * To read the contents of the template.
-     * @param {Partial<HTMLGeneratorOptions>} [options={}]
-     * To customize the service.
-     * @param {?HTMLGeneratorValuesService} [valuesService=null]
-     * If specified, instead of getting the values from the app configuration, they'll be
-     * retrieved from this service `getValues` method.
-     * @throws {Error}
-     * If `valuesService` is specified but it doesn't have a `getValues` method.
-     */
-    constructor(appConfiguration: AppConfiguration, appLogger: Logger, frontendFs: FrontendFs, options?: Partial<HTMLGeneratorOptions>, valuesService?: HTMLGeneratorValuesService | null);
-    /**
-     * The service options.
-     *
-     * @type {HTMLGeneratorOptions}
-     * @access protected
-     * @ignore
-     */
-    _options: HTMLGeneratorOptions;
-    /**
-     * A local reference for the `appConfiguration` service.
-     *
-     * @type {AppConfiguration}
-     * @access protected
-     * @ignore
-     */
-    _appConfiguration: AppConfiguration;
-    /**
-     * A local reference for the `appLogger` service.
-     *
-     * @type {Logger}
-     * @access protected
-     * @ignore
-     */
-    _appLogger: Logger;
-    /**
-     * A local reference for the `frontendFs` service.
-     *
-     * @type {FrontendFs}
-     * @access protected
-     * @ignore
-     */
-    _frontendFs: FrontendFs;
-    /**
-     * A local reference for the recieved `valuesService` service.
-     *
-     * @type {?HTMLGeneratorValuesService}
-     * @access protected
-     * @ignore
-     */
-    _valuesService: HTMLGeneratorValuesService | null;
-    /**
-     * Whether or not the file has been generated.
-     *
-     * @type {boolean}
-     * @access protected
-     * @ignore
-     */
-    _fileReady: boolean;
-    /**
-     * A deferred promise to return when another service asks if the file has been
-     * generated. Once this sevice finishes generating the file, the promise will be
-     * resolved.
-     *
-     * @type {Object}
-     * @access protected
-     * @ignore
-     */
-    _fileDeferred: any;
-    /**
-     * Generate the HTML file.
-     *
-     * @returns {Promise}
-     */
-    generateHTML(): Promise<any>;
-    /**
-     * Get the name of the file the service generates.
-     *
-     * @returns {string}
-     */
-    getFile(): string;
-    /**
-     * Get the values that are going to be injected on the file.
-     *
-     * @returns {Promise<Object>}
-     */
-    getValues(): Promise<any>;
-    /**
-     * Returns a promise that will be resolved when the file has been generated.
-     *
-     * @returns {Promise}
-     */
-    whenReady(): Promise<any>;
-    /**
-     * The service options.
-     *
-     * @type {HTMLGeneratorOptions}
-     * @todo Remove Object.freeze.
-     */
-    get options(): HTMLGeneratorOptions;
-    /**
-     * Get a value from an object dictionary using a string _"object path"_
-     * (`prop.sub.otherProp`).
-     * If the property doesn't exist or the path is invalid, it will return `null`.
-     *
-     * @param {Object} values     The dictionary from where the value will be read.
-     * @param {string} valuePath  The path to the value.
-     * @returns {*}
-     * @access protected
-     * @ignore
-     * @todo Use ObjectUtils.get for this.
-     */
-    _getFromValues(values: any, valuePath: string): any;
-    /**
-     * Creates the code for the HTML file.
-     *
-     * @param {string} template  The template code where the values are going to be
-     *                           injected.
-     * @param {Object} values    The dictionary of values to inject.
-     * @returns {string}
-     * @access protected
-     * @ignore
-     */
-    _processHTML(template: string, values: any): string;
-}
-/**
- * A service that hooks itself to the `after-start` event of the app server in order to
- * trigger the generation an the html file when the server starts.
- *
- * @type {ProviderCreator<HTMLGeneratorProviderOptions>}
- * @parent module:services
- */
-export const htmlGenerator: ProviderCreator<HTMLGeneratorProviderOptions>;

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

@@ -1,3 +0,0 @@
-declare const _exports: Provider;
-export = _exports;
-export type Provider = import('../../types').Provider;

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

@@ -1,141 +0,0 @@
-export type APIClientBase = import('../../types').APIClientBase;
-export type APIClientEndpoints = import('../../types').APIClientEndpoints;
-export type HTTP = import('./http').HTTP;
-export type HTTPError = import('../common/httpError').HTTPError;
-/**
- * <O>
- */
-export type ProviderCreator<O> = import('../../types').ProviderCreator<O>;
-/**
- * The options to customize how the service gets registered.
- */
-export type APIClientProviderOptions = {
-    /**
-     * The name of the service that will be
-     * registered into the app. Default
-     * `'apiClient'`.
-     */
-    serviceName: string;
-    /**
-     * The name of the configuration
-     * setting that has the API
-     * information. Default `'api'`.
-     */
-    configurationSetting: string;
-    /**
-     * The class the service will
-     * instantiate. It has to extend from
-     * {@link APIClient }, which is the
-     * default value.
-     */
-    clientClass: typeof APIClient;
-};
-/**
- * The configuration for the API the client will make requests to.
- */
-export type APIClientConfiguration = {
-    /**
-     * The API entry point.
-     */
-    url: string;
-    /**
-     * A dictionary of named endpoints relative to
-     * the API entry point.
-     */
-    endpoints: APIClientEndpoints;
-};
-/**
- * @typedef {import('../../types').APIClientBase} APIClientBase
- * @typedef {import('../../types').APIClientEndpoints} APIClientEndpoints
- * @typedef {import('./http').HTTP} HTTP
- * @typedef {import('../common/httpError').HTTPError} HTTPError
- */
-/**
- * @typedef {import('../../types').ProviderCreator<O>} ProviderCreator<O>
- * @template O
- */
-/**
- * The options to customize how the service gets registered.
- *
- * @typedef {Object} APIClientProviderOptions
- * @property {string}           serviceName           The name of the service that will be
- *                                                    registered into the app. Default
- *                                                    `'apiClient'`.
- * @property {string}           configurationSetting  The name of the configuration
- *                                                    setting that has the API
- *                                                    information. Default `'api'`.
- * @property {typeof APIClient} clientClass           The class the service will
- *                                                    instantiate. It has to extend from
- *                                                    {@link APIClient}, which is the
- *                                                    default value.
- * @parent module:services
- */
-/**
- * The configuration for the API the client will make requests to.
- *
- * @typedef {Object} APIClientConfiguration
- * @property {string}             url        The API entry point.
- * @property {APIClientEndpoints} endpoints  A dictionary of named endpoints relative to
- *                                           the API entry point.
- * @parent module:services
- */
-/**
- * An API client for the app to use. What makes this service special is that its that it
- * formats the received errors using the `AppError` service class and as fetch function it
- * uses the `http` service, allowing the app to to internally handle all the requests and
- * responses.
- *
- * @augments APIClientBase
- * @parent module:services
- */
-export class APIClient extends APIClientBase {
-    /**
-     * @param {APIClientConfiguration} apiConfig  The configuration for the API the client
-     *                                            will make requests to.
-     * @param {HTTP}                   http       To get the `fetch` function for this
-     *                                            service to use on all the requests.
-     * @param {ClassHTTPError}         HTTPError  To format the received errors.
-     */
-    constructor(apiConfig: APIClientConfiguration, http: HTTP, HTTPError: any);
-    /**
-     * The configuration for the API the client will make requests to.
-     *
-     * @type {APIClientConfiguration}
-     * @access protected
-     * @ignore
-     */
-    _apiConfig: APIClientConfiguration;
-    /**
-     * A local reference for the class the app uses to generate HTTP errors.
-     *
-     * @type {ClassHTTPError}
-     * @access protected
-     * @ignore
-     */
-    _HTTPError: any;
-    /**
-     * Helper method that tries to get an error message from a given response.
-     *
-     * @param {Object} response                       A received response from a request.
-     * @param {string} [fallback='Unexpected error']  A fallback message in case the method
-     *                                                doesn't found one on the response.
-     * @returns {string}
-     */
-    getErrorMessageFromResponse(response: any, fallback?: string): string;
-    /**
-     * The configuration for the API the client will make requests to.
-     *
-     * @type {APIClientConfiguration}
-     * @todo Remove Object.freeze.
-     */
-    get apiConfig(): APIClientConfiguration;
-}
-/**
- * An API Client service to make requests to an API using endpoints defined on the app
- * configuration.
- *
- * @type {ProviderCreator<APIClientProviderOptions>}
- * @parent module:services
- */
-export const apiClient: ProviderCreator<APIClientProviderOptions>;
-import APIClientBase = require("wootils/shared/apiClient");

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

@@ -1,159 +0,0 @@
-export type Logger = import('../../types').Logger;
-export type Provider = import('../../types').Provider;
-export type Response = any;
-export type ExpressRequest = import('../../types').ExpressRequest;
-export type HTTPFetchOptions = {
-    /**
-     * The request method.
-     */
-    method: string | null;
-    /**
-     * The request headers.
-     */
-    headers: {
-        [x: string]: string;
-    } | null;
-    /**
-     * The request body.
-     */
-    body: string | null;
-    /**
-     * The request query string parameters.
-     */
-    qs: {
-        [x: string]: string;
-    } | null;
-    /**
-     * An Express request object used to get
-     * extra infromation (like headers and the
-     * IP).
-     */
-    req: ExpressRequest | null;
-};
-/**
- * @typedef {import('../../types').Logger} Logger
- * @typedef {import('../../types').Provider} Provider
- * @typedef {import('node-fetch').Response} Response
- * @typedef {import('../../types').ExpressRequest} ExpressRequest
- */
-/**
- * @typedef {Object} HTTPFetchOptions
- * @property {?string}                  method   The request method.
- * @property {?Object.<string, string>} headers  The request headers.
- * @property {?string}                  body     The request body.
- * @property {?Object.<string, string>} qs       The request query string parameters.
- * @property {?ExpressRequest}          req      An Express request object used to get
- *                                               extra infromation (like headers and the
- *                                               IP).
- * @parent module:services
- */
-/**
- * A set of utilities to work with HTTP requests and responses.
- *
- * @parent module:services
- */
-export class HTTP {
-    /**
-     * @param {boolean} logRequests  Whether or not to log the requests and their responses.
-     * @param {Logger}  appLogger    If `logRequests` is `true`, this will be used to log
-     *                               the requests and responses information.
-     */
-    constructor(logRequests: boolean, appLogger: Logger);
-    /**
-     * Whether or not to log the requests and their responses.
-     *
-     * @type {boolean}
-     * @access protected
-     * @ignore
-     */
-    _logRequests: boolean;
-    /**
-     * A local reference for the `appLogger` service.
-     *
-     * @type {Logger}
-     * @access protected
-     * @ignore
-     */
-    _appLogger: Logger;
-    /**
-     * Make a request.
-     *
-     * @param {string}                    url           The request URL.
-     * @param {Partial<HTTPFetchOptions>} [options={}]  The request options.
-     * @returns {Promise<Response>}
-     */
-    fetch(url: string, options?: Partial<HTTPFetchOptions>): Promise<Response>;
-    /**
-     * Creates a dictionary with all the custom headers a request has. By custom header it
-     * means all the headers which name start with `x-`.
-     * This method doesn't copy `x-forwarded-for` as the `fetch` method generates it by
-     * calling `getIPFromRequest`.
-     *
-     * @param {ExpressRequest} req  The request from which it will try to get the headers.
-     * @returns {Object.<string, string>}
-     */
-    getCustomHeadersFromRequest(req: ExpressRequest): {
-        [x: string]: string;
-    };
-    /**
-     * Try to get the IP from a given request.
-     *
-     * @param {ExpressRequest} req  The request from which it will try to obtain the IP
-     *                              address.
-     * @returns {?string}
-     */
-    getIPFromRequest(req: ExpressRequest): string | null;
-    /**
-     * 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, in which case
-     * they are all tranformed to lower case.
-     *
-     * @param {Object.<string, string>} headers  The dictionary of headers to normalize.
-     * @returns {Object.<string, string>}
-     */
-    normalizeHeaders(headers: {
-        [x: string]: string;
-    }): {
-        [x: string]: string;
-    };
-    /**
-     * Whether or not to log the requests and their responses.
-     *
-     * @type {boolean}
-     */
-    get logRequests(): boolean;
-    /**
-     * Log a a request information using the `appLogger` service.
-     *
-     * @param {string}           url      The request URL.
-     * @param {HTTPFetchOptions} options  The options generated by the `fetch` method.
-     * @access protected
-     * @ignore
-     */
-    _logRequest(url: string, options: HTTPFetchOptions): void;
-    /**
-     * Log a a response information using the `appLogger` service.
-     *
-     * @param {Response} response  The response object returned by `node-fetch`.
-     * @access protected
-     * @ignore
-     */
-    _logResponse(response: any): void;
-}
-/**
- * The service provider that once registered on the app container will set an instance of
- * `HTTP` as the `http` service. The provider also checks the `debug.logRequests` setting
- * on the app configuration in order to enable or not the logging of requests.
- *
- * @type {Provider}
- * @example
- *
- *   // Register it on the container
- *   container.register(http);
- *   // Getting access to the service instance
- *   const http = container.get('http');
- *
- * @parent module:services
- */
-export const http: Provider;

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

@@ -1,18 +0,0 @@
-export = httpServices;
-/**
- * @typedef {import('../../types').Provider} Provider
- */
-/**
- * The providers collection for the HTTP services.
- *
- * @type {Provider}
- * @property {Provider} apiClient         The provider for {@link APIClient}.
- * @property {Provider} http              The provider for {@link HTTP}.
- * @property {Provider} responsesBuilder  The provider for {@link ResponsesBuilder}.
- * @parent module:services
- */
-declare const httpServices: Provider;
-declare namespace httpServices {
-    export { Provider };
-}
-type Provider = import('../../types').Provider;