jimpex 10.0.2 → 11.0.0

package/src/types/index.ts

@@ -1,6 +1,6 @@
-export * from './events';
-export * from './express';
-export * from './http';
-export * from './options';
-export * from './utils';
-export * from './wootils';
+export * from './events.js';
+export * from './express.js';
+export * from './http.js';
+export * from './options.js';
+export * from './utils.js';
+export * from './wootils.js';

package/src/types/options.ts

@@ -1,5 +1,5 @@
-import type { Config } from './wootils';
-import type { Jimpex } from '../app';
+import type { Config } from './wootils.js';
+import type { Jimpex } from '../app/index.js';
 /**
  * The options for the application's configuration service.
  *

package/src/types/utils.ts

@@ -14,8 +14,8 @@ export type DeepPartial<T> = {
   [P in keyof T]?: T[P] extends (infer U)[]
     ? DeepPartial<U>[]
     : T[P] extends object
-    ? DeepPartial<T[P]>
-    : T[P];
+      ? DeepPartial<T[P]>
+      : T[P];
 };
 /**
  * Utility to make a deep "readonly" of an existing type.
@@ -27,8 +27,8 @@ export type DeepReadonly<T> = {
   readonly [P in keyof T]: T[P] extends (infer U)[]
     ? DeepReadonly<U>[]
     : T[P] extends object
-    ? DeepReadonly<T[P]>
-    : T[P];
+      ? DeepReadonly<T[P]>
+      : T[P];
 };
 /**
  * Utility to remove string indexes from types.

package/src/utils/fns/index.ts

@@ -1,4 +1,4 @@
-export * from './others';
-export * from './routes';
-export * from './statuses';
-export * from './text';
+export * from './others.js';
+export * from './routes.js';
+export * from './statuses.js';
+export * from './text.js';

package/src/utils/fns/routes.ts

@@ -1,4 +1,4 @@
-import { escapeForRegExp } from './text';
+import { escapeForRegExp } from './text.js';
 
 /**
  * Removes any leading slash from a URL.

package/src/utils/index.ts

@@ -1,2 +1,2 @@
-export * from './fns';
-export * from './wrappers';
+export * from './fns/index.js';
+export * from './wrappers.js';

package/src/utils/wrappers.ts

@@ -7,8 +7,8 @@ import {
   type GenericCurriedFn,
   resourceCreatorFactory,
 } from '@homer0/jimple';
-import type { Jimpex } from '../app';
-import type { Router, ExpressMiddlewareLike, NoStringIndex } from '../types';
+import type { Jimpex } from '../app/index.js';
+import type { Router, ExpressMiddlewareLike, NoStringIndex } from '../types/index.js';
 /**
  * The function a provider uses to configure a resource in the container.
  *
@@ -303,9 +303,9 @@ export type ControllerProviderCreator = ReturnType<typeof controllerProviderCrea
  *
  * @param container  The reference to the Jimpex container.
  * @param route      This is optional because the implementation can use it as a
- *                   "global widdleware", or for a specific route.
- * @returns The resource can choose to be enabled or not by returning the function, or
- *          `undefined`.
+ *                   "global middleware", or for a specific route.
+ * @returns The resource can choose to be enabled or not by returning the function,
+ *          or `undefined`.
  * @group Wrappers
  */
 export type MiddlewareConnectFn = <ContainerType extends Jimpex = Jimpex>(
@@ -399,7 +399,7 @@ export type MiddlewareCreator = ReturnType<typeof middlewareCreator>;
 
 // --
 /**
- * The function a middelware provider uses to configure/extend the container before
+ * The function a middleware provider uses to configure/extend the container before
  * returning an actual middleware.
  *
  * @param container  The reference to the Jimpex container.

package/tsconfig.json

@@ -1,9 +1,14 @@
 {
   "extends": "@homer0/tsconfig/tsconfig.node.json",
   "compilerOptions": {
-    "outDir": "dist",
-    "emitDecoratorMetadata": false,
-    "incremental": false
+    "outDir": "dist"
   },
-  "include": ["src/**/*.ts", "examples/**/*.ts", "tsup.config.ts"]
+  "include": [
+    "src/**/*.ts",
+    "examples/**/*.ts",
+    "tsup.config.ts",
+    "vitest.config.ts",
+    ".prettierrc.js",
+    "eslint.config.js"
+  ]
 }

package/tsup.config.ts

@@ -3,8 +3,7 @@ import { defineConfig } from 'tsup';
 export default defineConfig({
   sourcemap: true,
   clean: true,
-  format: ['esm', 'cjs'],
-  legacyOutput: true,
+  format: ['esm'],
   dts: true,
   bundle: false,
 });

package/vitest.config.ts

@@ -0,0 +1,24 @@
+import { resolve } from 'node:path';
+import { defineConfig, type Plugin } from 'vitest/config';
+import swc from 'unplugin-swc';
+import tsconfigPaths from 'vite-tsconfig-paths';
+
+export default defineConfig({
+  plugins: [
+    tsconfigPaths(),
+    swc.vite({
+      module: { type: 'es6' },
+    }) as Plugin,
+  ],
+  test: {
+    environment: 'node',
+    include: ['tests/**/*.test.ts'],
+    globals: true,
+    coverage: {
+      provider: 'istanbul',
+      reportsDirectory: resolve('./coverage'),
+      reporter: ['text', 'lcov'],
+      exclude: ['tests/mocks/**', 'utils/scripts/**'],
+    },
+  },
+});

package/dist/app/index.d.mts

@@ -1,14 +0,0 @@
-export { J as Jimpex, j as jimpex } from '../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 '@homer0/jimple';

package/dist/app/jimpex.d.mts

@@ -1,14 +0,0 @@
-import '@homer0/jimple';
-import '@homer0/events-hub';
-export { J as Jimpex, j as jimpex } from '../index-Bwf7JHu9.mjs';
-import 'express';
-import '../types/http.mjs';
-import '../types/utils.mjs';
-import '@homer0/simple-logger';
-import '@homer0/simple-config';
-import '../types/express.mjs';
-import '@homer0/path-utils';
-import 'node-fetch';
-import 'https';
-import 'http';
-import 'spdy';

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

@@ -1,79 +0,0 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { C as ControllerConnectFn } from '../../index-Bwf7JHu9.mjs';
-import { ExpressMiddleware, AsyncExpressMiddleware } from '../../types/express.mjs';
-import { SimpleConfig } from '@homer0/simple-config';
-import { ResponsesBuilder } from '../../services/http/responsesBuilder.mjs';
-import { Response } from '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/events-hub';
-import '../../utils/fns/statuses.mjs';
-import 'statuses';
-
-/**
- * The options to contruct a {@link ConfigController}.
- *
- * @group Controllers/Config
- */
-type ConfigControllerOptions = {
-    /**
-     * A dictionary with the dependencies to inject.
-     */
-    inject: {
-        responsesBuilder: ResponsesBuilder;
-        config: SimpleConfig;
-    };
-};
-/**
- * The controller class that allows to show and switch the application configuration.
- *
- * @group Controller Classes
- * @group Controllers/Config
- * @prettierignore
- */
-declare class ConfigController {
-    /**
-     * The service in charge or building the responses.
-     */
-    protected readonly _responsesBuilder: ResponsesBuilder;
-    /**
-     * The service in charge of the configuration.
-     */
-    protected readonly _config: SimpleConfig;
-    /**
-     * @param options  The options to construct the controller.
-     */
-    constructor({ inject }: ConfigControllerOptions);
-    /**
-     * Creates the middleware the shows the current configuration.
-     */
-    showConfig(): ExpressMiddleware;
-    /**
-     * Creates the middleware the allows to switch the configuration.
-     */
-    switchConfig(): AsyncExpressMiddleware;
-    /**
-     * Utility to respond with the current configuration.
-     */
-    protected respondWithConfig(res: Response): void;
-}
-/**
- * This controller is kind of special as it will only mount the routes if the
- * `debug.configController` setting of the app configuration is set to `true`.
- *
- * It provides routes for:
- * - `/`: Showing the current configuration.
- * - `/switch/:name`: Switching the configuration, but only if the service allows it.
- *
- * @group Controllers
- * @group Controllers/Config
- */
-declare const configController: _homer0_jimple.Resource<"controller", "connect", ControllerConnectFn>;
-
-export { ConfigController, type ConfigControllerOptions, configController };

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

@@ -1,83 +0,0 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { Statuses } from '../../utils/fns/statuses.mjs';
-import { r as JimpexHealthStatus, C as ControllerConnectFn } from '../../index-Bwf7JHu9.mjs';
-import { AsyncExpressMiddleware } from '../../types/express.mjs';
-import { SimpleConfig } from '@homer0/simple-config';
-import { ResponsesBuilder } from '../../services/http/responsesBuilder.mjs';
-import 'statuses';
-import '../../types/http.mjs';
-import 'https';
-import 'http';
-import 'spdy';
-import 'node-fetch';
-import 'express';
-import '../../types/utils.mjs';
-import '@homer0/path-utils';
-import '@homer0/simple-logger';
-import '@homer0/events-hub';
-
-/**
- * A function that will return the health status of the application.
- *
- * @group Controllers/Health
- */
-type GetHealthStatus = () => Promise<JimpexHealthStatus>;
-/**
- * The options to contruct a {@link HealthController}.
- *
- * @group Controllers/Health
- */
-type HealthControllerOptions = {
-    /**
-     * A dictionary with the dependencies to inject.
-     */
-    inject: {
-        getHealthStatus: GetHealthStatus;
-        responsesBuilder: ResponsesBuilder;
-        config: SimpleConfig;
-        statuses: Statuses;
-    };
-};
-/**
- * The controller class that shows the application health status.
- *
- * @group Controller Classes
- * @group Controllers/Health
- * @prettierignore
- */
-declare class HealthController {
-    /**
-     * The function that returns the health status of the application.
-     */
-    protected readonly _getHealthStatus: GetHealthStatus;
-    /**
-     * The service in charge or building the responses.
-     */
-    protected readonly _responsesBuilder: ResponsesBuilder;
-    /**
-     * The service in charge of the configuration.
-     */
-    protected readonly _config: SimpleConfig;
-    /**
-     * The uility service to get HTTP status codes.
-     */
-    protected readonly _statuses: Statuses;
-    /**
-     * @param options  The options to construct the controller.
-     */
-    constructor({ inject }: HealthControllerOptions);
-    /**
-     * Creates the middleware the shows the application health status.
-     */
-    showHealth(): AsyncExpressMiddleware;
-}
-/**
- * The controller that once mounted, it will add an endpoint to show the application
- * health status.
- *
- * @group Controllers
- * @group Controllers/Health
- */
-declare const healthController: _homer0_jimple.Resource<"controller", "connect", ControllerConnectFn>;
-
-export { type GetHealthStatus, HealthController, type HealthControllerOptions, healthController };

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

@@ -1,22 +0,0 @@
-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-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 '../../services/http/responsesBuilder.mjs';
-import '../../utils/fns/statuses.mjs';
-import 'statuses';
-import 'mime';
-import '../../services/common/sendFile.mjs';

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

@@ -1,223 +0,0 @@
-import * as _homer0_jimple from '@homer0/jimple';
-import { J as Jimpex, a1 as MiddlewareLike, C as ControllerConnectFn } from '../../index-Bwf7JHu9.mjs';
-import mime from 'mime';
-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';
-
-type Mime = typeof mime;
-/**
- * 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;
-        mime: Mime;
-    };
-};
-/**
- * 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 MIME type library. Since it's an ESM only module, Jimpex loads it on boot and makes
-     * it available on the container.
-     */
-    protected readonly _mime: Mime;
-    /**
-     * 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 { type AddStaticRouteOptions, StaticsController, type StaticsControllerConstructorOptions, type StaticsControllerCreatorOptions, type StaticsControllerFile, type StaticsControllerGetMiddlewaresFn, type StaticsControllerOptions, type StaticsControllerPathsOptions, staticsController };

package/dist/controllers/index.d.mts

@@ -1,25 +0,0 @@
-export { ConfigController, ConfigControllerOptions, configController } from './common/config.mjs';
-export { GetHealthStatus, HealthController, HealthControllerOptions, healthController } from './common/health.mjs';
-export { AddStaticRouteOptions, StaticsController, StaticsControllerConstructorOptions, StaticsControllerCreatorOptions, StaticsControllerFile, StaticsControllerGetMiddlewaresFn, StaticsControllerOptions, StaticsControllerPathsOptions, staticsController } from './common/statics.mjs';
-export { AddGatewayRouteOptions, GatewayConfig, GatewayConfigEndpointDefinition, GatewayConfigEndpointProps, GatewayConfigEndpoints, GatewayController, GatewayControllerAPIConfig, GatewayControllerAPIConfigOptions, GatewayControllerConstructorOptions, GatewayControllerCreatorOptions, GatewayControllerEndpointInfo, GatewayControllerExtraOptions, GatewayControllerGetMiddlewaresFn, GatewayControllerHeaderOptions, GatewayControllerHelperOptions, GatewayControllerOptions, GatewayControllerRequest, GatewayControllerRoute, GatewayControllerRouteMethod, GatewayHelperService, GatewayHelperServiceBaseFnOptions, GatewayHelperServiceErrorHandler, GatewayHelperServiceErrorHandlerOptions, GatewayHelperServiceRequestReducer, GatewayHelperServiceRequestReducerOptions, GatewayHelperServiceResponseHandler, GatewayHelperServiceResponseReducer, GatewayHelperServiceResponseReducerOptions, GatewayHelperServiceStreamVerification, gatewayController } from './utils/gateway.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 '../services/http/responsesBuilder.mjs';
-import '../utils/fns/statuses.mjs';
-import 'statuses';
-import 'mime';
-import '../services/common/sendFile.mjs';
-import '@homer0/api-utils';
-import '../services/http/http.mjs';