jimpex 10.0.2 → 11.0.0

package/src/controllers/common/statics.ts

@@ -1,4 +1,4 @@
-import * as path from 'path';
+import * as path from 'node:path';
 import type mime from 'mime';
 import { deepAssignWithOverwrite } from '@homer0/deep-assign';
 import {
@@ -6,10 +6,15 @@ import {
   removeSlashes,
   notUndefined,
   type MiddlewareLike,
-} from '../../utils';
-import type { SendFile } from '../../services';
-import type { Jimpex } from '../../app';
-import type { DeepPartial, ExpressMiddleware, Router, RouterMethod } from '../../types';
+} from '../../utils/index.js';
+import type { SendFile } from '../../services/index.js';
+import type { Jimpex } from '../../app/index.js';
+import type {
+  DeepPartial,
+  ExpressMiddleware,
+  Router,
+  RouterMethod,
+} from '../../types/index.js';
 
 type Mime = typeof mime;
 
@@ -91,7 +96,7 @@ export type StaticsControllerConstructorOptions =
     };
   };
 /**
- * A function to generate a list of middlewares that can be executed before the tontroller
+ * A function to generate a list of middlewares that can be executed before the controller
  * main middleware.
  *
  * @group Controllers/Statics
@@ -105,7 +110,7 @@ export type StaticsControllerGetMiddlewaresFn = (app: Jimpex) => MiddlewareLike[
 export type StaticsControllerCreatorOptions = DeepPartial<StaticsControllerOptions> & {
   /**
    * A function to generate a list of middlewares that can be executed before the
-   * tontroller main middleware.
+   * controller main middleware.
    */
   getMiddlewares?: StaticsControllerGetMiddlewaresFn;
 };

package/src/controllers/index.ts

@@ -1,2 +1,2 @@
-export * from './common';
-export * from './utils';
+export * from './common/index.js';
+export * from './utils/index.js';

package/src/controllers/utils/gateway.ts

@@ -8,9 +8,9 @@ import {
   removeSlashes,
   notUndefined,
   type MiddlewareLike,
-} from '../../utils';
-import type { HTTP, HTTPFetchOptions } from '../../services';
-import type { Jimpex } from '../../app';
+} from '../../utils/index.js';
+import type { HTTP, HTTPFetchOptions } from '../../services/index.js';
+import type { Jimpex } from '../../app/index.js';
 import {
   RouterMethod,
   DeepPartial,
@@ -21,7 +21,7 @@ import {
   Router,
   ExpressMiddleware,
   AsyncExpressMiddleware,
-} from '../../types';
+} from '../../types/index.js';
 /**
  * The extended definition for endpoints.
  *
@@ -95,7 +95,7 @@ export type GatewayConfig = {
    */
   url: string;
   /**
-   * The dictionary of enpoints the gateway will make available.
+   * The dictionary of endpoints the gateway will make available.
    */
   gateway: GatewayConfigEndpoints;
 };
@@ -227,7 +227,7 @@ export type GatewayHelperServiceBaseFnOptions = {
    */
   endpoint: GatewayControllerEndpointInfo;
   /**
-   * The request recived by the application.
+   * The request received by the application.
    */
   req: Request;
   /**
@@ -1054,7 +1054,7 @@ export class GatewayController {
   }
 }
 /**
- * A function to generate a list of middlewares that can be executed before the tontroller
+ * A function to generate a list of middlewares that can be executed before the controller
  * main middleware.
  *
  * @group Controllers/Gateway
@@ -1075,7 +1075,7 @@ export type GatewayControllerCreatorOptions =
      * If this is overwritten, the creator will ensure that the name ends with `Gateway`;
      * and if overwritten, but it doesn't include `Gateway` at the end, and no
      * `gatewaySettingName` was defined, the creator will use the custom name (without
-     * `Gatway`) for `gatewaySettingName`.
+     * `Gateway`) for `gatewaySettingName`.
      *
      * @default 'apiGateway'
      */

package/src/controllers/utils/index.ts

@@ -1 +1 @@
-export * from './gateway';
+export * from './gateway.js';

package/src/index.ts

@@ -1,6 +1,6 @@
-export * from './app';
-export * from './types';
-export * from './controllers';
-export * from './middlewares';
-export * from './services';
-export * from './utils';
+export * from './app/index.js';
+export * from './types/index.js';
+export * from './controllers/index.js';
+export * from './middlewares/index.js';
+export * from './services/index.js';
+export * from './utils/index.js';

package/src/middlewares/common/errorHandler.ts

@@ -1,7 +1,11 @@
 import { deepAssignWithOverwrite } from '@homer0/deep-assign';
-import { middlewareCreator, type Statuses } from '../../utils';
-import type { DeepPartial, Logger, ExpressErrorHandler } from '../../types';
-import { AppError, type HTTPErrorClass, type ResponsesBuilder } from '../../services';
+import { middlewareCreator, type Statuses } from '../../utils/index.js';
+import type { DeepPartial, Logger, ExpressErrorHandler } from '../../types/index.js';
+import {
+  AppError,
+  type HTTPErrorClass,
+  type ResponsesBuilder,
+} from '../../services/index.js';
 /**
  * The options for the responses the middleware will create.
  *
@@ -33,7 +37,7 @@ export type ErrorHandlerOptions = {
    * if `true`, it will not only show all kind of errors but it will also show the error
    * stack.
    *
-   * By "uknown errors", it means that are not `AppError` nor `HTTPError`.
+   * By "unknown errors", it means that are not `AppError` nor `HTTPError`.
    */
   showErrors: boolean;
   /**
@@ -81,7 +85,7 @@ export class ErrorHandler {
    */
   protected readonly _responsesBuilder: ResponsesBuilder;
   /**
-   * The uility service to get HTTP status codes.
+   * The utility service to get HTTP status codes.
    */
   protected readonly _statuses: Statuses;
   /**

package/src/middlewares/common/forceHTTPS.ts

@@ -1,5 +1,5 @@
-import { middlewareCreator } from '../../utils';
-import { ExpressMiddleware } from '../../types';
+import { middlewareCreator } from '../../utils/index.js';
+import { ExpressMiddleware } from '../../types/index.js';
 /**
  * The customization options for the middleware.
  *

package/src/middlewares/common/hsts.ts

@@ -1,5 +1,5 @@
-import { middlewareCreator } from '../../utils';
-import { ExpressMiddleware } from '../../types';
+import { middlewareCreator } from '../../utils/index.js';
+import { ExpressMiddleware } from '../../types/index.js';
 /**
  * The options to customize the HSTS header value.
  *

package/src/middlewares/common/index.ts

@@ -1,3 +1,3 @@
-export * from './errorHandler';
-export * from './forceHTTPS';
-export * from './hsts';
+export * from './errorHandler.js';
+export * from './forceHTTPS.js';
+export * from './hsts.js';

package/src/middlewares/html/fastHTML.ts

@@ -1,6 +1,15 @@
-import { createRouteExpression, middlewareCreator, removeSlashes } from '../../utils';
-import type { HTMLGenerator, SendFile } from '../../services';
-import type { AsyncExpressMiddleware, Response, NextFunction, Events } from '../../types';
+import {
+  createRouteExpression,
+  middlewareCreator,
+  removeSlashes,
+} from '../../utils/index.js';
+import type { HTMLGenerator, SendFile } from '../../services/index.js';
+import type {
+  AsyncExpressMiddleware,
+  Response,
+  NextFunction,
+  Events,
+} from '../../types/index.js';
 /**
  * The options to customize the behavior of the middleware.
  *
@@ -9,7 +18,7 @@ import type { AsyncExpressMiddleware, Response, NextFunction, Events } from '../
 export type FastHTMLOptions = {
   /**
    * The name of the file the middleware will serve. If the {@link HTMLGenerator} service
-   * is available, it will be overriden by the service.
+   * is available, it will be overridden by the service.
    *
    * @default 'index.html'
    */
@@ -89,7 +98,7 @@ export class FastHTML {
    */
   protected readonly _sendFile: SendFile;
   /**
-   * The application envent bus, to listen and get the list of "controlled routes" after
+   * The application event bus, to listen and get the list of "controlled routes" after
    * the application is started.
    */
   protected readonly _events: Events;

package/src/middlewares/html/index.ts

@@ -1,2 +1,2 @@
-export * from './fastHTML';
-export * from './showHTML';
+export * from './fastHTML.js';
+export * from './showHTML.js';

package/src/middlewares/html/showHTML.ts

@@ -1,6 +1,10 @@
-import { middlewareCreator } from '../../utils';
-import type { HTMLGenerator, SendFile } from '../../services';
-import type { AsyncExpressMiddleware, Response, NextFunction } from '../../types';
+import { middlewareCreator } from '../../utils/index.js';
+import type { HTMLGenerator, SendFile } from '../../services/index.js';
+import type {
+  AsyncExpressMiddleware,
+  Response,
+  NextFunction,
+} from '../../types/index.js';
 /**
  * The options to customize the behavior of the middleware.
  *
@@ -9,7 +13,7 @@ import type { AsyncExpressMiddleware, Response, NextFunction } from '../../types
 export type ShowHTMLOptions = {
   /**
    * The name of the file the middleware will serve. If the {@link HTMLGenerator} service
-   * is available, it will be overriden by the service.
+   * is available, it will be overridden by the service.
    *
    * @default 'index.html'
    */

package/src/middlewares/index.ts

@@ -1,3 +1,3 @@
-export * from './common';
-export * from './html';
-export * from './utils';
+export * from './common/index.js';
+export * from './html/index.js';
+export * from './utils/index.js';

package/src/middlewares/utils/index.ts

@@ -1 +1 @@
-export * from './versionValidator';
+export * from './versionValidator.js';

package/src/middlewares/utils/versionValidator.ts

@@ -1,7 +1,7 @@
 import { deepAssignWithOverwrite } from '@homer0/deep-assign';
-import { middlewareCreator, type Statuses } from '../../utils';
-import { DeepPartial, Request, ExpressMiddleware } from '../../types';
-import type { HTTPErrorClass, ResponsesBuilder } from '../../services';
+import { middlewareCreator, type Statuses } from '../../utils/index.js';
+import { DeepPartial, Request, ExpressMiddleware } from '../../types/index.js';
+import type { HTTPErrorClass, ResponsesBuilder } from '../../services/index.js';
 /**
  * The options for how the middleware should behave if the requested version is `latest`.
  *
@@ -30,7 +30,7 @@ export type VersionValidatorLatestOptions = {
  */
 export type VersionValidatorPopupOptions = {
   /**
-   * The name of the query string variable the middleware will check in order to indentify
+   * The name of the query string variable the middleware will check in order to identify
    * whether the request comes from a popup or not. The variable must have `'true'` as its
    * value.
    *
@@ -146,7 +146,7 @@ export class VersionValidator {
    */
   protected readonly _responsesBuilder: ResponsesBuilder;
   /**
-   * The uility service to get HTTP status codes.
+   * The utility service to get HTTP status codes.
    */
   protected readonly _statuses: Statuses;
   /**
@@ -171,7 +171,7 @@ export class VersionValidator {
         popup: {
           variable: 'popup',
           title: 'Conflict',
-          message: 'vesion:conflict',
+          message: 'version:conflict',
         },
         version,
       },

package/src/services/common/appError.ts

@@ -1,4 +1,4 @@
-import { provider, statuses as statusesFn, type Statuses } from '../../utils';
+import { provider, statuses as statusesFn, type Statuses } from '../../utils/index.js';
 /**
  * A dictionary with some context information that can be provided to {@link AppError}.
  *

package/src/services/common/httpError.ts

@@ -1,5 +1,5 @@
-import { provider, statuses as statusesFn, type Statuses } from '../../utils';
-import { AppError, type AppErrorContext } from './appError';
+import { provider, statuses as statusesFn, type Statuses } from '../../utils/index.js';
+import { AppError, type AppErrorContext } from './appError.js';
 /**
  * A type of error to be used on HTTP requests. This is the most common type of error used
  * by Jimpex.

package/src/services/common/index.ts

@@ -1,7 +1,7 @@
-import { providers } from '../../utils';
-import { appErrorProvider } from './appError';
-import { httpErrorProvider } from './httpError';
-import { sendFileProvider } from './sendFile';
+import { providers } from '../../utils/index.js';
+import { appErrorProvider } from './appError.js';
+import { httpErrorProvider } from './httpError.js';
+import { sendFileProvider } from './sendFile.js';
 /**
  * Registers all the common services on the container.
  *
@@ -24,6 +24,6 @@ export const commonServicesProvider = providers({
   sendFileProvider,
 });
 
-export * from './appError';
-export * from './httpError';
-export * from './sendFile';
+export * from './appError.js';
+export * from './httpError.js';
+export * from './sendFile.js';

package/src/services/common/sendFile.ts

@@ -1,5 +1,5 @@
-import { provider } from '../../utils';
-import type { Response, NextFunction, PathUtils } from '../../types';
+import { provider } from '../../utils/index.js';
+import type { Response, NextFunction, PathUtils } from '../../types/index.js';
 /**
  * The options to create a {@link SendFile} function.
  *

package/src/services/frontend/frontendFs.ts

@@ -1,6 +1,6 @@
-import fs from 'fs/promises';
-import { provider } from '../../utils';
-import type { PathUtils } from '../../types';
+import fs from 'node:fs/promises';
+import { provider } from '../../utils/index.js';
+import type { PathUtils } from '../../types/index.js';
 /**
  * The options to construct a {@link FrontendFs}.
  *

package/src/services/frontend/index.ts

@@ -1,5 +1,5 @@
-import { providers } from '../../utils';
-import { frontendFsProvider } from './frontendFs';
+import { providers } from '../../utils/index.js';
+import { frontendFsProvider } from './frontendFs.js';
 /**
  * Registers all the frontend services on the container.
  *
@@ -18,4 +18,4 @@ export const frontendServicesProvider = providers({
   frontendFsProvider,
 });
 
-export * from './frontendFs';
+export * from './frontendFs.js';

package/src/services/html/htmlGenerator.ts

@@ -1,9 +1,9 @@
 import { get } from '@homer0/object-utils';
 import { deepAssignWithOverwrite } from '@homer0/deep-assign';
 import { deferred, type DeferredPromise } from '@homer0/deferred';
-import { providerCreator } from '../../utils';
-import type { Config, Logger } from '../../types';
-import type { FrontendFs } from '../frontend';
+import { providerCreator } from '../../utils/index.js';
+import type { Config, Logger } from '../../types/index.js';
+import type { FrontendFs } from '../frontend/index.js';
 /**
  * The options to customize a {@link HTMLGenerator} instance.
  *
@@ -29,7 +29,7 @@ export type HTMLGeneratorOptions = {
    */
   silent: boolean;
   /**
-   * Whether or not to delete the tempalte after generating the file.
+   * Whether or not to delete the template after generating the file.
    *
    * @default true
    */
@@ -37,7 +37,7 @@ export type HTMLGeneratorOptions = {
   /**
    * The placeholder string where the information will be written.
    *
-   * @default /\{\{appConfi(?:guration)?\}\}/
+   * @default /\{\{appConfig(?:uration)?\}\}/
    */
   replacePlaceholder: string | RegExp;
   /**
@@ -153,7 +153,7 @@ export class HTMLGenerator {
   protected _fileReady: boolean = false;
   /**
    * 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
+   * generated. Once this service finishes generating the file, the promise will be
    * resolved for all implementations that hold a reference to this deferred.
    */
   protected _fileDeferred?: DeferredPromise<void>;
@@ -279,13 +279,11 @@ export class HTMLGenerator {
     const matches: Array<{ string: string; value: string }> = [];
     let match = placeholderExpression.exec(code);
     while (match) {
-      const [string, value] = match;
-      if (string && value) {
-        matches.push({
-          string,
-          value,
-        });
-      }
+      const [string, value] = match as RegExpExecArray;
+      matches.push({
+        string,
+        value: value!,
+      });
 
       match = placeholderExpression.exec(code);
     }

package/src/services/html/index.ts

@@ -1,5 +1,5 @@
-import { providers } from '../../utils';
-import { htmlGeneratorProvider } from './htmlGenerator';
+import { providers } from '../../utils/index.js';
+import { htmlGeneratorProvider } from './htmlGenerator.js';
 /**
  * Registers all the HTML services on the container.
  *
@@ -18,4 +18,4 @@ export const htmlServicesProvider = providers({
   htmlGeneratorProvider,
 });
 
-export * from './htmlGenerator';
+export * from './htmlGenerator.js';

package/src/services/http/apiClient.ts

@@ -5,9 +5,9 @@ import {
   type FetchClient,
 } from '@homer0/api-utils';
 import { deepAssignWithOverwrite } from '@homer0/deep-assign';
-import { providerCreator } from '../../utils';
-import type { HTTP } from './http';
-import type { HTTPErrorClass } from '../common';
+import { providerCreator } from '../../utils/index.js';
+import type { HTTP } from './http.js';
+import type { HTTPErrorClass } from '../common/index.js';
 
 export type { ErrorResponse };
 /**

package/src/services/http/http.ts

@@ -1,8 +1,8 @@
 import urijs from 'urijs';
 import type { RequestInit, BodyInit } from 'node-fetch';
 import { deepAssignWithOverwrite } from '@homer0/deep-assign';
-import { provider } from '../../utils';
-import { Logger, Request, HTTPResponse, NodeFetch } from '../../types';
+import { provider } from '../../utils/index.js';
+import { Logger, Request, HTTPResponse, NodeFetch } from '../../types/index.js';
 
 /**
  * The options to customize the service.
@@ -20,7 +20,7 @@ export type HTTPOptions = {
  *
  * @group Services/HTTP
  */
-export type HTTPContructorOptions = Partial<HTTPOptions> & {
+export type HTTPConstructorOptions = Partial<HTTPOptions> & {
   /**
    * A dictionary with the dependencies to inject.
    */
@@ -103,7 +103,7 @@ export class HTTP {
   /**
    * @param options  The options to construct the class.
    */
-  constructor({ inject: { logger, nodeFetch }, ...options }: HTTPContructorOptions) {
+  constructor({ inject: { logger, nodeFetch }, ...options }: HTTPConstructorOptions) {
     this._logger = logger;
     this._nodeFetch = nodeFetch;
     this._options = deepAssignWithOverwrite(
@@ -200,7 +200,7 @@ export class HTTP {
    * 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.
+   * come transformed into lower case.
    *
    * @param headers  The dictionary of headers to normalize.
    */

package/src/services/http/index.ts

@@ -1,7 +1,7 @@
-import { providers } from '../../utils';
-import { apiClientProvider } from './apiClient';
-import { httpProvider } from './http';
-import { responsesBuilderProvider } from './responsesBuilder';
+import { providers } from '../../utils/index.js';
+import { apiClientProvider } from './apiClient.js';
+import { httpProvider } from './http.js';
+import { responsesBuilderProvider } from './responsesBuilder.js';
 /**
  * Registers all the HTTP services on the container.
  *
@@ -24,6 +24,6 @@ export const httpServicesProvider = providers({
   responsesBuilderProvider,
 });
 
-export * from './apiClient';
-export * from './http';
-export * from './responsesBuilder';
+export * from './apiClient.js';
+export * from './http.js';
+export * from './responsesBuilder.js';

package/src/services/http/responsesBuilder.ts

@@ -1,5 +1,5 @@
-import type { Config, Response } from '../../types';
-import { provider, type Statuses } from '../../utils';
+import type { Config, Response } from '../../types/index.js';
+import { provider, type Statuses } from '../../utils/index.js';
 /**
  * The options to construct a {@link ResponsesBuilder}.
  *
@@ -59,7 +59,7 @@ export type HTMLPostMessageResponseOptions = {
   closeDelay?: number;
 };
 /**
- * The options to build a reponse for JSON.
+ * The options to build a response for JSON.
  *
  * @group Services/ResponsesBuilder
  */
@@ -99,7 +99,7 @@ export class ResponsesBuilder {
    */
   protected readonly _config: Config;
   /**
-   * The uility service to get HTTP status codes.
+   * The utility service to get HTTP status codes.
    */
   protected readonly _statuses: Statuses;
   /**
@@ -215,7 +215,7 @@ export class ResponsesBuilder {
     `;
   }
   /**
-   * Utility method used to make sure a recevied status is a valid status code. If the
+   * Utility method used to make sure a received 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.

package/src/services/index.ts

@@ -1,5 +1,5 @@
-export * from './common';
-export * from './frontend';
-export * from './html';
-export * from './http';
-export * from './utils';
+export * from './common/index.js';
+export * from './frontend/index.js';
+export * from './html/index.js';
+export * from './http/index.js';
+export * from './utils/index.js';

package/src/services/utils/ensureBearerToken.ts

@@ -1,9 +1,9 @@
 import { deepAssignWithOverwrite } from '@homer0/deep-assign';
-import { providerCreator, type Statuses } from '../../utils';
-import type { HTTPErrorClass } from '../common';
-import type { DeepPartial, ExpressMiddleware } from '../../types';
+import { providerCreator, type Statuses } from '../../utils/index.js';
+import type { HTTPErrorClass } from '../common/index.js';
+import type { DeepPartial, ExpressMiddleware } from '../../types/index.js';
 /**
- * The options for the error the middleare can generate.
+ * The options for the error the middleware can generate.
  *
  * @group Services/EnsureBearerToken
  */

package/src/services/utils/index.ts

@@ -1,5 +1,5 @@
-import { providers } from '../../utils';
-import { ensureBearerTokenProvider } from './ensureBearerToken';
+import { providers } from '../../utils/index.js';
+import { ensureBearerTokenProvider } from './ensureBearerToken.js';
 /**
  * Registers all the utility services on the container.
  *
@@ -18,4 +18,4 @@ export const utilsServicesProvider = providers({
   ensureBearerTokenProvider,
 });
 
-export * from './ensureBearerToken';
+export * from './ensureBearerToken.js';

package/src/types/events.ts

@@ -1,6 +1,6 @@
-import type { Router, ExpressMiddlewareLike } from './express';
-import type { Controller, Middleware } from '../utils';
-import type { Jimpex } from '../app/jimpex';
+import type { Router, ExpressMiddlewareLike } from './express.js';
+import type { Controller, Middleware } from '../utils/index.js';
+import type { Jimpex } from '../app/jimpex.js';
 /**
  * The base payload the events emitted by the application send.
  *
@@ -145,11 +145,11 @@ export type JimpexEventListener<EventName extends JimpexEventNameLike> =
   EventName extends JimpexEventName
     ? (payload: JimpexEventPayload<EventName>) => void
     : EventName extends JimpexReducerEventName
-    ? (
-        target: JimpexReducerEventTarget<EventName>,
-        payload: JimpexReducerEventPayload<EventName>,
-      ) => JimpexReducerEventTarget<EventName>
-    : never;
+      ? (
+          target: JimpexReducerEventTarget<EventName>,
+          payload: JimpexReducerEventPayload<EventName>,
+        ) => JimpexReducerEventTarget<EventName>
+      : never;
 /**
  * The `events` service Jimpex uses.
  * This is an alternative declaration of the `EventsHub` class that uses the interfaces

package/src/types/http.ts

@@ -2,7 +2,7 @@ import type { Server as HTTPSServer } from 'https';
 import type { Server as HTTPServer } from 'http';
 import type { ServerOptions as SpdyServerOptions } from 'spdy';
 import type NodeFetchFn from 'node-fetch';
-import type { Express } from './express';
+import type { Express } from './express.js';
 
 export type { Response as HTTPResponse } from 'node-fetch';