jimpex 7.0.2 → 9.0.0

package/dist/controllers/common/index.d.mts

@@ -0,0 +1,21 @@
+export { ConfigController, ConfigControllerOptions, configController } from './config.mjs';
+export { GetHealthStatus, HealthController, HealthControllerOptions, healthController } from './health.mjs';
+export { AddStaticRouteOptions, StaticsController, StaticsControllerConstructorOptions, StaticsControllerCreatorOptions, StaticsControllerFile, StaticsControllerGetMiddlewaresFn, StaticsControllerOptions, StaticsControllerPathsOptions, staticsController } from './statics.mjs';
+import '@homer0/jimple';
+import '../../index-efeb437e.js';
+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 '../../services/http/responsesBuilder.mjs';
+import '../../utils/fns/statuses.mjs';
+import 'statuses';
+import '../../services/common/sendFile.mjs';

package/dist/controllers/common/index.d.ts

@@ -0,0 +1,21 @@
+export { ConfigController, ConfigControllerOptions, configController } from './config.js';
+export { GetHealthStatus, HealthController, HealthControllerOptions, healthController } from './health.js';
+export { AddStaticRouteOptions, StaticsController, StaticsControllerConstructorOptions, StaticsControllerCreatorOptions, StaticsControllerFile, StaticsControllerGetMiddlewaresFn, StaticsControllerOptions, StaticsControllerPathsOptions, staticsController } from './statics.js';
+import '@homer0/jimple';
+import '../../index-b2a04c78.js';
+import '../../types/express.js';
+import 'express';
+import '../../types/http.js';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '../../types/utils.js';
+import '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+import '../../services/http/responsesBuilder.js';
+import '../../utils/fns/statuses.js';
+import 'statuses';
+import '../../services/common/sendFile.js';

package/dist/controllers/common/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var common_exports = {};
+module.exports = __toCommonJS(common_exports);
+__reExport(common_exports, require("./config"), module.exports);
+__reExport(common_exports, require("./health"), module.exports);
+__reExport(common_exports, require("./statics"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./config"),
+  ...require("./health"),
+  ...require("./statics")
+});
+//# sourceMappingURL=index.js.map

package/dist/controllers/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/controllers/common/index.ts"],"sourcesContent":["export * from './config';\nexport * from './health';\nexport * from './statics';\n"],"mappings":";;;;;;;;;;;;;;;AAAA;AAAA;AAAA,2BAAc,qBAAd;AACA,2BAAc,qBADd;AAEA,2BAAc,sBAFd;","names":[]}

package/dist/controllers/common/statics.d.mts

@@ -0,0 +1,215 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex, a1 as MiddlewareLike, C as ControllerConnectFn } from '../../index-efeb437e.js';
+import { RouterMethod, ExpressMiddleware } from '../../types/express.mjs';
+import { DeepPartial } from '../../types/utils.mjs';
+import { SendFile } from '../../services/common/sendFile.mjs';
+import { Router } from 'express';
+import '../../types/http.mjs';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+
+/**
+ * The definition for each file the controller handles.
+ *
+ * @group Controllers/Statics
+ */
+type StaticsControllerFile = {
+    /**
+     * The route, relative to the controller root, to the file.
+     */
+    route: string;
+    /**
+     * The path to the file in the filesystem. Since the file is served using the
+     * {@link SendFile} service, whether the file is relative to the project root or the
+     * application executable depends on how the service is configured (relative to the
+     * executable by default).
+     */
+    path: string;
+    /**
+     * A dictionary of headers for the response.
+     */
+    headers?: Record<string, string>;
+};
+/**
+ * These are like "master paths" that get prepended to all the file paths and routes the
+ * controller use.
+ *
+ * @group Controllers/Statics
+ */
+type StaticsControllerPathsOptions = {
+    /**
+     * A custom route to prefix all the file routes with.
+     */
+    route: string;
+    /**
+     * A custom path to prefix all the file paths with.
+     */
+    source: string;
+};
+/**
+ * The options to customize the controller.
+ *
+ * @group Controllers/Statics
+ */
+type StaticsControllerOptions = {
+    /**
+     * A list of filenames, or definitions for the files to handle.
+     */
+    files: Array<string | StaticsControllerFile>;
+    /**
+     * A dictionary with the allowed router (HTTP) methods the controller can use to serve
+     * the files. If `all` is set to `true`, the rest of the values will be ignored.
+     *
+     * @default {get: true, all: false}
+     */
+    methods: Partial<Record<RouterMethod, boolean>>;
+    /**
+     * The "master paths" the controller can use to prefix the file paths and routes.
+     *
+     * @default {route: '', source: './',}
+     */
+    paths: StaticsControllerPathsOptions;
+};
+/**
+ * The options to construct a {@link StaticsController}.
+ *
+ * @group Controllers/Statics
+ */
+type StaticsControllerConstructorOptions = DeepPartial<StaticsControllerOptions> & {
+    /**
+     * A dictionary with the dependencies to inject.
+     */
+    inject: {
+        sendFile: SendFile;
+    };
+};
+/**
+ * A function to generate a list of middlewares that can be executed before the tontroller
+ * main middleware.
+ *
+ * @group Controllers/Statics
+ */
+type StaticsControllerGetMiddlewaresFn = (app: Jimpex) => MiddlewareLike[];
+/**
+ * The options for the controller creator that mounts {@link StaticsController}.
+ *
+ * @group Controllers/Statics
+ */
+type StaticsControllerCreatorOptions = DeepPartial<StaticsControllerOptions> & {
+    /**
+     * A function to generate a list of middlewares that can be executed before the
+     * tontroller main middleware.
+     */
+    getMiddlewares?: StaticsControllerGetMiddlewaresFn;
+};
+/**
+ * The options for {@link StaticsController._addRoute}.
+ *
+ * @access protected
+ * @group Controllers/Statics
+ */
+type AddStaticRouteOptions = {
+    /**
+     * The reference for the router in which the middlewares will be added.
+     */
+    router: Router;
+    /**
+     * The router method in which the middlewares will be added.
+     */
+    method: RouterMethod;
+    /**
+     * The definition of the file to serve.
+     */
+    file: StaticsControllerFile;
+    /**
+     * The middleware created by {@link StaticsController}, that will serve the file.
+     */
+    fileMiddleware: ExpressMiddleware;
+    /**
+     * A list of extra middlewares to execute before the file middleware.
+     */
+    middlewares: ExpressMiddleware[];
+};
+/**
+ * The controller class that allows the application to serve specific files from any
+ * folder to any route without the need of mounting directories as "static".
+ *
+ * @group Controller Classes
+ * @group Controllers/Statics
+ * @prettierignore
+ */
+declare class StaticsController {
+    /**
+     * The service that serves static files.
+     */
+    protected readonly _sendFile: SendFile;
+    /**
+     * The controller customization options.
+     */
+    protected _options: StaticsControllerOptions;
+    /**
+     * A dictionary with the formatted definitions of the files that will be served.
+     * It uses the files' routes as keys, for easy access in the middleware.
+     */
+    protected files: Record<string, StaticsControllerFile>;
+    /**
+     * @param options  The options to construct the controller.
+     */
+    constructor({ inject, ...options }: StaticsControllerConstructorOptions);
+    /**
+     * Mounts the middlewares in the router in order to serve the files.
+     *
+     * @param router       A reference to the application router.
+     * @param middlewares  A list of extra middlewares to execute before the file
+     *                     middleware.
+     */
+    addRoutes(router: Router, middlewares?: ExpressMiddleware[]): Router;
+    /**
+     * The controller options.
+     */
+    get options(): Readonly<StaticsControllerOptions>;
+    /**
+     * Generates the middleware that will serve the file.
+     *
+     * @param file  The definition of the file to serve.
+     */
+    protected _getMiddleware(file: StaticsControllerFile): ExpressMiddleware;
+    /**
+     * Mounts the middleware(s) for a file in the router.
+     *
+     * @param options  The information of the file and how it needs to be added.
+     */
+    protected _addRoute({ router, method, file, fileMiddleware, middlewares, }: AddStaticRouteOptions): void;
+    /**
+     * Validates and formats the options sent to the constructor in order to get the final
+     * set that will be stored in the controller.
+     *
+     * @param options  The options to validate.
+     * @throws If no files are specified.
+     * @throws If methods is not defined.
+     * @throws If no methods are enabled.
+     * @throws If there's an invalid HTTP method.
+     */
+    protected _validateOptions(options: StaticsControllerOptions): StaticsControllerOptions;
+    /**
+     * Parses the files received from the constructor's options, and formats them into
+     * proper definitions the controller can use.
+     */
+    protected _createFiles(): Record<string, StaticsControllerFile>;
+}
+/**
+ * A controller that allows the application to server specific files from any folder to
+ * any route without the need of mounting directories as "static" folders.
+ *
+ * @group Controllers
+ * @group Controllers/Statics
+ */
+declare const staticsController: _homer0_jimple.ResourceCreator<"controller", "connect", ({ getMiddlewares, ...options }?: StaticsControllerCreatorOptions) => <ContainerType extends Jimpex = Jimpex>(app: ContainerType) => Router, ControllerConnectFn>;
+
+export { AddStaticRouteOptions, StaticsController, StaticsControllerConstructorOptions, StaticsControllerCreatorOptions, StaticsControllerFile, StaticsControllerGetMiddlewaresFn, StaticsControllerOptions, StaticsControllerPathsOptions, staticsController };

package/dist/controllers/common/statics.d.ts

@@ -0,0 +1,215 @@
+import * as _homer0_jimple from '@homer0/jimple';
+import { J as Jimpex, a1 as MiddlewareLike, C as ControllerConnectFn } from '../../index-b2a04c78.js';
+import { RouterMethod, ExpressMiddleware } from '../../types/express.js';
+import { DeepPartial } from '../../types/utils.js';
+import { SendFile } from '../../services/common/sendFile.js';
+import { Router } from 'express';
+import '../../types/http.js';
+import 'https';
+import 'http';
+import 'spdy';
+import 'node-fetch';
+import '@homer0/path-utils';
+import '@homer0/simple-logger';
+import '@homer0/simple-config';
+import '@homer0/events-hub';
+
+/**
+ * The definition for each file the controller handles.
+ *
+ * @group Controllers/Statics
+ */
+type StaticsControllerFile = {
+    /**
+     * The route, relative to the controller root, to the file.
+     */
+    route: string;
+    /**
+     * The path to the file in the filesystem. Since the file is served using the
+     * {@link SendFile} service, whether the file is relative to the project root or the
+     * application executable depends on how the service is configured (relative to the
+     * executable by default).
+     */
+    path: string;
+    /**
+     * A dictionary of headers for the response.
+     */
+    headers?: Record<string, string>;
+};
+/**
+ * These are like "master paths" that get prepended to all the file paths and routes the
+ * controller use.
+ *
+ * @group Controllers/Statics
+ */
+type StaticsControllerPathsOptions = {
+    /**
+     * A custom route to prefix all the file routes with.
+     */
+    route: string;
+    /**
+     * A custom path to prefix all the file paths with.
+     */
+    source: string;
+};
+/**
+ * The options to customize the controller.
+ *
+ * @group Controllers/Statics
+ */
+type StaticsControllerOptions = {
+    /**
+     * A list of filenames, or definitions for the files to handle.
+     */
+    files: Array<string | StaticsControllerFile>;
+    /**
+     * A dictionary with the allowed router (HTTP) methods the controller can use to serve
+     * the files. If `all` is set to `true`, the rest of the values will be ignored.
+     *
+     * @default {get: true, all: false}
+     */
+    methods: Partial<Record<RouterMethod, boolean>>;
+    /**
+     * The "master paths" the controller can use to prefix the file paths and routes.
+     *
+     * @default {route: '', source: './',}
+     */
+    paths: StaticsControllerPathsOptions;
+};
+/**
+ * The options to construct a {@link StaticsController}.
+ *
+ * @group Controllers/Statics
+ */
+type StaticsControllerConstructorOptions = DeepPartial<StaticsControllerOptions> & {
+    /**
+     * A dictionary with the dependencies to inject.
+     */
+    inject: {
+        sendFile: SendFile;
+    };
+};
+/**
+ * A function to generate a list of middlewares that can be executed before the tontroller
+ * main middleware.
+ *
+ * @group Controllers/Statics
+ */
+type StaticsControllerGetMiddlewaresFn = (app: Jimpex) => MiddlewareLike[];
+/**
+ * The options for the controller creator that mounts {@link StaticsController}.
+ *
+ * @group Controllers/Statics
+ */
+type StaticsControllerCreatorOptions = DeepPartial<StaticsControllerOptions> & {
+    /**
+     * A function to generate a list of middlewares that can be executed before the
+     * tontroller main middleware.
+     */
+    getMiddlewares?: StaticsControllerGetMiddlewaresFn;
+};
+/**
+ * The options for {@link StaticsController._addRoute}.
+ *
+ * @access protected
+ * @group Controllers/Statics
+ */
+type AddStaticRouteOptions = {
+    /**
+     * The reference for the router in which the middlewares will be added.
+     */
+    router: Router;
+    /**
+     * The router method in which the middlewares will be added.
+     */
+    method: RouterMethod;
+    /**
+     * The definition of the file to serve.
+     */
+    file: StaticsControllerFile;
+    /**
+     * The middleware created by {@link StaticsController}, that will serve the file.
+     */
+    fileMiddleware: ExpressMiddleware;
+    /**
+     * A list of extra middlewares to execute before the file middleware.
+     */
+    middlewares: ExpressMiddleware[];
+};
+/**
+ * The controller class that allows the application to serve specific files from any
+ * folder to any route without the need of mounting directories as "static".
+ *
+ * @group Controller Classes
+ * @group Controllers/Statics
+ * @prettierignore
+ */
+declare class StaticsController {
+    /**
+     * The service that serves static files.
+     */
+    protected readonly _sendFile: SendFile;
+    /**
+     * The controller customization options.
+     */
+    protected _options: StaticsControllerOptions;
+    /**
+     * A dictionary with the formatted definitions of the files that will be served.
+     * It uses the files' routes as keys, for easy access in the middleware.
+     */
+    protected files: Record<string, StaticsControllerFile>;
+    /**
+     * @param options  The options to construct the controller.
+     */
+    constructor({ inject, ...options }: StaticsControllerConstructorOptions);
+    /**
+     * Mounts the middlewares in the router in order to serve the files.
+     *
+     * @param router       A reference to the application router.
+     * @param middlewares  A list of extra middlewares to execute before the file
+     *                     middleware.
+     */
+    addRoutes(router: Router, middlewares?: ExpressMiddleware[]): Router;
+    /**
+     * The controller options.
+     */
+    get options(): Readonly<StaticsControllerOptions>;
+    /**
+     * Generates the middleware that will serve the file.
+     *
+     * @param file  The definition of the file to serve.
+     */
+    protected _getMiddleware(file: StaticsControllerFile): ExpressMiddleware;
+    /**
+     * Mounts the middleware(s) for a file in the router.
+     *
+     * @param options  The information of the file and how it needs to be added.
+     */
+    protected _addRoute({ router, method, file, fileMiddleware, middlewares, }: AddStaticRouteOptions): void;
+    /**
+     * Validates and formats the options sent to the constructor in order to get the final
+     * set that will be stored in the controller.
+     *
+     * @param options  The options to validate.
+     * @throws If no files are specified.
+     * @throws If methods is not defined.
+     * @throws If no methods are enabled.
+     * @throws If there's an invalid HTTP method.
+     */
+    protected _validateOptions(options: StaticsControllerOptions): StaticsControllerOptions;
+    /**
+     * Parses the files received from the constructor's options, and formats them into
+     * proper definitions the controller can use.
+     */
+    protected _createFiles(): Record<string, StaticsControllerFile>;
+}
+/**
+ * A controller that allows the application to server specific files from any folder to
+ * any route without the need of mounting directories as "static" folders.
+ *
+ * @group Controllers
+ * @group Controllers/Statics
+ */
+declare const staticsController: _homer0_jimple.ResourceCreator<"controller", "connect", ({ getMiddlewares, ...options }?: StaticsControllerCreatorOptions) => <ContainerType extends Jimpex = Jimpex>(app: ContainerType) => Router, ControllerConnectFn>;
+
+export { AddStaticRouteOptions, StaticsController, StaticsControllerConstructorOptions, StaticsControllerCreatorOptions, StaticsControllerFile, StaticsControllerGetMiddlewaresFn, StaticsControllerOptions, StaticsControllerPathsOptions, staticsController };