jimpex 10.0.2 → 11.0.0

package/dist/services/common/sendFile.d.mts

@@ -1,102 +0,0 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
-import { Response, NextFunction } from 'express';
-import { PathUtils } from '@homer0/path-utils';
-import '../../types/express.mjs';
-import '../../types/http.mjs';
-import 'https';
-import 'http';
-import 'spdy';
-import 'node-fetch';
-import '../../types/utils.mjs';
-import '@homer0/simple-logger';
-import '@homer0/simple-config';
-import '@homer0/events-hub';
-
-/**
- * The options to create a {@link SendFile} function.
- *
- * @group Services/SendFile
- */
-type SendFileGeneratorOptions = {
-    /**
-     * A dictionary with the dependencies to inject.
-     */
-    inject: {
-        pathUtils: PathUtils;
-    };
-};
-/**
- * The options for the function that actually serves a file.
- *
- * @group Services/SendFile
- */
-type SendFileOptions = {
-    /**
-     * The response object sent by the application. Necessary to write the file.
-     */
-    res: Response;
-    /**
-     * The path of the file to serve. Depending on the `from` option, it will be either
-     * relative to the project root, or the application executable.
-     */
-    filepath: string;
-    /**
-     * The name of a location on the `pathUtils` service from where the `filepath` is
-     * relative to. It can be `app` for the directory containing the application executable,
-     * or `project` for the project root. It could also be any other location that the
-     * implementation may have registered.
-     *
-     * @default 'app'
-     */
-    from?: string;
-    /**
-     * The function to move to the next middleware. It can be used to report an error in
-     * case the file can't be served.
-     *
-     * @default {() => {}}
-     */
-    next?: NextFunction;
-};
-/**
- * The type of the function that serves a file.
- * This is exported to make it easy to type the dependency injection.
- *
- * @group Services/SendFile
- */
-type SendFile = (options: SendFileOptions) => void;
-/**
- * Generates a function to send files on the application response.
- *
- * @param options  To inject the required dependencies.
- * @example
- *
- * <caption>Basic usage</caption>
- *
- *   // Let's say this is inside an Express middleware.
- *   // Get the function
- *   const send = sendFile(pathUtils);
- *   send({ res, filepath: 'some-file.html', next });
- *   // If your app is on "/app/index.js", this will send "/app/some-file.html".
- *
- * @group Services
- * @group Services/SendFile
- */
-declare const sendFile: ({ inject: { pathUtils } }: SendFileGeneratorOptions) => SendFile;
-/**
- * The service provider that once registered on the container will set the result of
- * {@link sendFile} as the `sendFile` service.
- *
- * @example
- *
- *   // Register it on the container
- *   container.register(sendFileProvider);
- *   // Getting access to the service instance
- *   const sendFile = container.get<SendFile>('sendFile');
- *
- * @group Providers
- * @group Services/SendFile
- */
-declare const sendFileProvider: _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>;
-
-export { type SendFile, type SendFileGeneratorOptions, type SendFileOptions, sendFile, sendFileProvider };

package/dist/services/frontend/frontendFs.d.mts

@@ -1,96 +0,0 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
-import { PathUtils } from '@homer0/path-utils';
-import fs from 'fs/promises';
-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/simple-logger';
-import '@homer0/simple-config';
-import '@homer0/events-hub';
-
-/**
- * The options to construct a {@link FrontendFs}.
- *
- * @group Services/FrontendFs
- */
-type FrontendFsOptions = {
-    /**
-     * A dictionary with the dependencies to inject.
-     */
-    inject: {
-        pathUtils: PathUtils;
-    };
-};
-/**
- * This service allows the application to easily work with the filesystem. The idea behind
- * centralizing this functionalities into a service is that is pretty common to have
- * bundling tools to generate the frontend, and on that process files can have different
- * paths or not even be generated all. The service can be extended/overwritten to
- * accommodate any requirements and avoid having to update or add `if`s to every `fs` call
- * the application does.
- * Another _'feature'_ of this service is that all the paths are relative to the directory
- * where the app executable is located, so you don't have to remember the relative path
- * from the place you are accessing a file to the place where it's located.
- *
- * @group Services
- * @group Services/FrontendFs
- */
-declare class FrontendFs {
-    /**
-     * The service that generates the relative paths.
-     */
-    protected readonly _pathUtils: PathUtils;
-    /**
-     * @param options  The options to construct the service.
-     */
-    constructor({ inject: { pathUtils } }: FrontendFsOptions);
-    /**
-     * Deletes a file from the file system.
-     *
-     * @param filepath  The path to the file.
-     */
-    delete(filepath: string): Promise<void>;
-    /**
-     * Reads a file from the file system.
-     *
-     * @param filepath  The path to the file.
-     * @param encoding  The text encoding in which the file should be read.
-     */
-    read(filepath: string, encoding?: BufferEncoding): Promise<string>;
-    /**
-     * Writes a file on the file system.
-     *
-     * @param filepath  The path to the file.
-     * @param content   The contents of the file.
-     */
-    write(filepath: string, content: Parameters<typeof fs.writeFile>[1]): Promise<void>;
-    /**
-     * Utility method to get the path of a file relative to the application executable.
-     *
-     * @param filepath  The path to the file.
-     */
-    protected getAppPath(filepath: string): string;
-}
-/**
- * The service provider that once registered on the container will set an instance of
- * {@link FrontendFs} as the `frontendFs` service.
- *
- * @example
- *
- *   // Register it on the container
- *   container.register(frontendFsProvider);
- *   // Getting access to the service instance
- *   const frontendFs = container.get<FrontendFs>('frontendFs');
- *
- * @group Providers
- * @group Services/FrontendFs
- */
-declare const frontendFsProvider: _homer0_jimple.Resource<"provider", "register", _homer0_jimple.ProviderRegisterFn<Jimpex>>;
-
-export { FrontendFs, type FrontendFsOptions, frontendFsProvider };

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

@@ -1,40 +0,0 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
-export { FrontendFs, FrontendFsOptions, frontendFsProvider } from './frontendFs.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 'fs/promises';
-
-/**
- * Registers all the frontend services on the container.
- *
- * - {@link FrontendFs | frontendFs}
- *
- * @example
- *
- *   // Register the collection on the container
- *   container.register(frontendServicesProvider);
- *   // Getting access to one the services instance
- *   const frontendFs = container.get<FrontendFs>('frontendFs');
- *
- * @group Providers
- */
-declare const frontendServicesProvider: {
-    frontendFsProvider: _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 { frontendServicesProvider };

package/dist/services/html/htmlGenerator.d.mts

@@ -1,237 +0,0 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
-import { SimpleLogger } from '@homer0/simple-logger';
-import { SimpleConfig } from '@homer0/simple-config';
-import { FrontendFs } from '../frontend/frontendFs.mjs';
-import { DeferredPromise } from '@homer0/deferred';
-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/events-hub';
-import 'fs/promises';
-
-/**
- * The options to customize a {@link HTMLGenerator} instance.
- *
- * @group Services/HTMLGenerator
- */
-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;
-    /**
-     * If `true`, it won't log messages on the terminal when generating the file.
-     *
-     * @default false
-     */
-    silent: boolean;
-    /**
-     * 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 /\{\{appConfi(?:guration)?\}\}/
-     */
-    replacePlaceholder: string | RegExp;
-    /**
-     * A regular expression for dynamic placeholders that will be replaced by values when
-     * the file is generated.
-     *
-     * @default /\{\{(.*?)\}\}/gi
-     */
-    placeholderExpression: RegExp;
-    /**
-     * The name of the variable that will have the information on the file.
-     *
-     * @default 'appConfig'
-     */
-    variableName: 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']
-     */
-    configKeys: string[];
-};
-/**
- * An external service that can be used to provide the values the generator will replace
- * in the template.
- *
- * @group Services/HTMLGenerator
- */
-type HTMLGeneratorValuesService = {
-    /**
-     * A function that will be called to get the values to replace in the template.
-     *
-     * @param options  The service customization options.
-     */
-    getValues: (options: HTMLGeneratorOptions) => Promise<Record<string, unknown>>;
-};
-/**
- * The options to construct a {@link HTMLGenerator}.
- *
- * @group Services/HTMLGenerator
- */
-type HTMLGeneratorConstructorOptions = Partial<HTMLGeneratorOptions> & {
-    /**
-     * A dictionary with the dependencies to inject.
-     */
-    inject: {
-        config: SimpleConfig;
-        logger: SimpleLogger;
-        frontendFs: FrontendFs;
-        /**
-         * A service that can provide the values to replace in the template. If specified, the
-         * values from `configKeys` will be ignored.
-         */
-        valuesService?: HTMLGeneratorValuesService;
-    };
-};
-/**
- * Custom options for the provider that will register an instance of {@link HTMLGenerator}
- * as a service.
- *
- * @group Services/HTMLGenerator
- */
-type HTMLGeneratorProviderOptions = Partial<HTMLGeneratorOptions> & {
-    /**
-     * 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 'htmlGenerator'
-     */
-    serviceName?: string;
-    /**
-     * The name of a service that the generator will use in order to read the values that
-     * will be replaced on the template. If the service is available, the values from
-     * `configKeys` will be ignored.
-     *
-     * @default 'htmlGeneratorValues'
-     */
-    valuesServiceName?: string;
-};
-/**
- * This is a utility service that generates an HTML file with custom information when the
- * application is started.
- *
- * @group Services
- * @group Services/HTMLGenerator
- */
-declare class HTMLGenerator {
-    /**
-     * The service customization options.
-     */
-    protected readonly _options: HTMLGeneratorOptions;
-    /**
-     * The application configuration service, to get the settings specified by the
-     * `configKeys` option.
-     */
-    protected readonly _config: SimpleConfig;
-    /**
-     * The service that logs messages on the terminal, in case the `silent` option is `false`.
-     */
-    protected readonly _logger: SimpleLogger;
-    /**
-     * The service that interacts with the filesystem.
-     */
-    protected readonly _frontendFs: FrontendFs;
-    /**
-     * A service that can provide values to be replaced in the template.
-     */
-    protected readonly _valuesService?: HTMLGeneratorValuesService;
-    /**
-     * Whether or not the file was already generated.
-     */
-    protected _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 for all implementations that hold a reference to this deferred.
-     */
-    protected _fileDeferred?: DeferredPromise<void>;
-    /**
-     * @param options  The options to construct the class.
-     * @throws If `valuesService` is specified but it doesn't have a `getValues`
-     *         method.
-     */
-    constructor({ inject: { config, logger, frontendFs, valuesService }, ...options }: HTMLGeneratorConstructorOptions);
-    /**
-     * Gets a promise that will be resolved when the file has been generated.
-     */
-    whenReady(): Promise<void>;
-    /**
-     * Generates the HTML file.
-     */
-    generateHTML(): Promise<void>;
-    /**
-     * Gets the customization options.
-     */
-    get options(): Readonly<HTMLGeneratorOptions>;
-    /**
-     * Helper method to get the values that will be replaced in the template. If a "values
-     * service" was specified in the constructor, it will get the values from there,
-     * otherwise, it will use the `configKeys` option to get the values from the
-     * application configuration.
-     */
-    protected _getValues(): Promise<Record<string, unknown>>;
-    /**
-     * Processes the HTML template by replacing the placeholders with the actual values.
-     *
-     * @param template  The template for the HTML file.
-     * @param values    The values dictionary that should be replaced in the template.
-     */
-    protected _processHTML(template: string, values: Record<string, unknown>): string;
-}
-/**
- * The service provider that once registered on the container will set an instance of
- * {@link HTMLGenerator} as the `htmlGenerator` service. it will also hook itself to the
- * `after-start` event of the application in order to trigger the generator of the HTML
- * file.
- *
- * @example
- *
- * <caption>Basic usage</caption>
- *
- *   // Register it on the container
- *   container.register(htmlGeneratorProvider);
- *   // Getting access to the service instance
- *   const htmlGenerator = container.get<HTMLGenerator>('htmlGenerator');
- *
- * @example
- *
- * <caption>Using with custom options</caption>
- *
- *   container.register(
- *     htmlGeneratorProvider({
- *       serviceName: 'myHtmlGenerator',
- *       valuesServiceName: 'myValuesService',
- *       template: 'my-template.tpl.html',
- *     }),
- *   );
- *
- * @group Providers
- * @group Services/HTMLGenerator
- */
-declare const htmlGeneratorProvider: _homer0_jimple.ResourceCreator<"provider", "register", (options?: HTMLGeneratorProviderOptions) => (app: Jimpex) => void, _homer0_jimple.ProviderRegisterFn<Jimpex>>;
-
-export { HTMLGenerator, type HTMLGeneratorConstructorOptions, type HTMLGeneratorOptions, type HTMLGeneratorProviderOptions, type HTMLGeneratorValuesService, htmlGeneratorProvider };

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

@@ -1,43 +0,0 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
-import { HTMLGeneratorProviderOptions } from './htmlGenerator.mjs';
-export { HTMLGenerator, HTMLGeneratorConstructorOptions, HTMLGeneratorOptions, HTMLGeneratorValuesService, htmlGeneratorProvider } from './htmlGenerator.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 '../frontend/frontendFs.mjs';
-import 'fs/promises';
-import '@homer0/deferred';
-
-/**
- * Registers all the HTML services on the container.
- *
- * - {@link HTMLGenerator | htmlGenerator}
- *
- * @example
- *
- *   // Register the collection on the container
- *   container.register(htmlServicesProvider);
- *   // Getting access to one the services instance
- *   const htmlGenerator = container.get<HTMLGenerator>('htmlGenerator');
- *
- * @group Providers
- */
-declare const htmlServicesProvider: {
-    htmlGeneratorProvider: _homer0_jimple.ResourceCreator<"provider", "register", (options?: HTMLGeneratorProviderOptions) => (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 { HTMLGeneratorProviderOptions, htmlServicesProvider };

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

@@ -1,170 +0,0 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex } from '../../index-Bwf7JHu9.mjs';
-import { HTTPErrorClass } from '../common/httpError.mjs';
-import { HTTP } from './http.mjs';
-import { APIClientOptions, APIClient as APIClient$1, ErrorResponse } from '@homer0/api-utils';
-export { ErrorResponse } from '@homer0/api-utils';
-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/appError.mjs';
-
-/**
- * The required settings needed to create the an API client.
- *
- * @group Services/APIClient
- */
-type APIClientConfig = Pick<APIClientOptions, 'url' | 'endpoints'>;
-/**
- * A dictionary of endpoints for the API client.
- * This is declared as standalone because it needs to reference them multiple times.
- *
- * @group Services/APIClient
- */
-type EndpointsType = APIClientOptions['endpoints'];
-/**
- * The format the settings needs to have in the application configuration in order to
- * create a valid API client.
- * The settings may include the endpoints dictionary in the `endpoints` property, or the
- * gateway `property`, with `endpoints` always having priority if both exists.
- * The reason for the `gateway` property to be valid, is in case the application also
- * implements a {@link GatewayController}, using the same property for both things will
- * help reduce the amount of duplicated definitions.
- *
- * @group Services/APIClient
- */
-type APIClientSettings = Omit<APIClientConfig, 'endpoints'> & ({
-    endpoints: EndpointsType;
-    gateway?: EndpointsType;
-} | {
-    endpoints?: EndpointsType;
-    gateway: EndpointsType;
-});
-/**
- * The options to construct a {@link APIClient}.
- *
- * @group Services/APIClient
- */
-type APIClientConstructorOptions = APIClientSettings & {
-    /**
-     * A dictionary with the dependencies to inject.
-     */
-    inject: {
-        http: HTTP;
-        HTTPError: HTTPErrorClass;
-    };
-};
-/**
- * An API client for the application to use. What makes this service special is that it
- * formats received errors using the {@link _HTTPError} class, and as fetch client, it
- * uses the {@link HTTP} service, allowing the application to to internally handle all the
- * requests and responses.
- *
- * The only reason to use the class directly is if you want to subclass it, as you would
- * normally just register the {@link apiClientProvider}.
- *
- * @group Services
- * @group Services/APIClient
- */
-declare class APIClient extends APIClient$1 {
-    /**
-     * The service that makes the requests to the API.
-     */
-    protected readonly _http: HTTP;
-    /**
-     * The class to generate possible errors in the requests.
-     */
-    protected readonly _HTTPError: HTTPErrorClass;
-    /**
-     * The configuration of the API it uses.
-     */
-    protected readonly _apiConfig: APIClientConfig;
-    /**
-     * @param options  The options to construct the class.
-     */
-    constructor({ inject: { http, HTTPError }, ...rest }: APIClientConstructorOptions);
-    /**
-     * The configuration for the API.
-     */
-    get apiConfig(): Readonly<APIClientConfig>;
-    /**
-     * Tries to obtain a message from an error caused on a failed request.
-     *
-     * @param response  The response from the failed request.
-     */
-    protected _getErrorMessageFromResponse(response: unknown): string;
-    /**
-     * Generates an {@link _HTTPError} from the response of a failed request.
-     *
-     * @param response  The response from the failed request.
-     * @param status    The status code of the response.
-     */
-    protected formatError<ResponseType extends ErrorResponse>(response: ResponseType, status: number): Error;
-}
-/**
- * The options for the provider creator that registers an {@link APIClient} in the
- * container.
- * These options allow the application to register multiple instances for different APIs.
- *
- * @group Services/APIClient
- */
-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'
-     */
-    configSetting?: string;
-    /**
-     * The class the service will instantiate. It has to extend {@link APIClient}.
-     *
-     * @default APIClient
-     */
-    clientClass?: typeof APIClient;
-};
-/**
- * The provider creator to register an instance of {@link APIClient} on the container.
- *
- * @example
- *
- * <caption>Basic usage</caption>
- *
- *   // Register it on the container
- *   container.register(apiClientProvider);
- *   // Getting access to the service instance
- *   const apiClient = container.get<APIClient>('apiClient');
- *
- * @example
- *
- * <caption>With custom options</caption>
- *
- *   container.register(
- *     apiClientProvider({
- *       serviceName: 'myApiClient',
- *       configSetting: 'myApi',
- *     }),
- *   );
- *
- * @group Providers
- * @group Services/APIClient
- */
-declare const apiClientProvider: _homer0_jimple.ResourceCreator<"provider", "register", (options?: APIClientProviderOptions) => (app: Jimpex) => void, _homer0_jimple.ProviderRegisterFn<Jimpex>>;
-
-export { APIClient, type APIClientConfig, type APIClientConstructorOptions, type APIClientProviderOptions, type APIClientSettings, type EndpointsType, apiClientProvider };