jimpex 7.0.1 → 8.0.0

package/dist/esm/controllers/utils/gateway.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/controllers/utils/gateway.ts"],"sourcesContent":["import { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { flat, unflat } from '@homer0/object-utils';\nimport type { APIClientOptions } from '@homer0/api-utils';\nimport {\n  controllerProviderCreator,\n  controller,\n  createRouteExpression,\n  removeSlashes,\n  notUndefined,\n  type MiddlewareLike,\n} from '../../utils';\nimport type { HTTP, HTTPFetchOptions } from '../../services';\nimport type { Jimpex } from '../../app';\nimport {\n  RouterMethod,\n  DeepPartial,\n  Request,\n  Response,\n  NextFunction,\n  HTTPResponse,\n  Router,\n  ExpressMiddleware,\n  AsyncExpressMiddleware,\n} from '../../types';\n/**\n * The extended definition for endpoints.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayConfigEndpointProps = {\n  /**\n   * The path to the endpoint relative to the entry point. It can include placeholders for\n   * parameters like `/:parameter/`.\n   */\n  path: string;\n  /**\n   * The router (HTTP) method for the endpoint.\n   *\n   * @default 'all'\n   */\n  method?: RouterMethod;\n};\n/**\n * The definition of an endpoint: it can be just the path, relative to the entry point, or\n * an object in which you can also specify things like the method.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayConfigEndpointDefinition = string | GatewayConfigEndpointProps;\n/**\n * The dictionary of endpoints the controller uses. The reason for this type is that this\n * could be a flat dictionary, or a nested one.\n *\n * @example\n *\n * <caption>A flat dictionary</caption>\n *\n * {\n *   random: '/random',\n *   users: '/users',\n *   userById: {\n *     path: '/users/:id',\n *     method: 'get',\n *   },\n * }\n *\n * @example\n *\n * <caption>A nested dictionary</caption>\n *\n * {\n *   random: '/random',\n *   users: {\n *     list: '/users',\n *     byId: {\n *       path: '/users/:id',\n *       method: 'get',\n *     },\n *   },\n * }\n *\n * @group Controllers/Gateway\n */\nexport type GatewayConfigEndpoints = {\n  [key: string]: GatewayConfigEndpointDefinition | GatewayConfigEndpoints;\n};\n/**\n * The configuration for the gateway the controller uses.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayConfig = {\n  /**\n   * The entry point to the API the controller will make the requests to.\n   */\n  url: string;\n  /**\n   * The dictionary of enpoints the gateway will make available.\n   */\n  gateway: GatewayConfigEndpoints;\n};\n/**\n * The options for how the gateway will handle the headers from the requests and the\n * responses.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerHeaderOptions = {\n  /**\n   * Whether or not to include the header with the request's IP address.\n   *\n   * @default true\n   */\n  useXForwardedFor: boolean;\n  /**\n   * Whether or not to copy all custom headers from the request. By custom header, it\n   * means all the headers which names start with `x-`.\n   *\n   * @default true\n   */\n  copyCustomHeaders: boolean;\n  /**\n   * A list of \"known\" headers the gateway will try to copy from the incoming request.\n   *\n   * @default ['authorization','content-type', 'referer', 'user-agent']\n   */\n  copy: string[];\n  /**\n   * A list of \"known\" headers the gateway will try to remove the response.\n   *\n   * @default ['server', 'x-powered-by']\n   */\n  remove: string[];\n};\n/**\n * The extra options for the gateway controller. They are \"extra\" because they are mostly\n * helpers for when used with an API client, or for optional features.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerExtraOptions = {\n  /**\n   * This is really a helper for when the gateway is used with an API client. The idea is\n   * that, by default, the routes are mounted on the controller route, but with this\n   * option, you can specify another sub path. For example: The controller is mounted on\n   * `/routes`, and if you set `root` to `gateway`, all the routes will be on\n   * `/routes/gateway`.\n   *\n   * This become important (and useful) when you get the API client configuration (with\n   * `getAPIConfig`): The `url` will be the controller route, but all the endpoints will\n   * be modified and prefixed with the `root`, that way, you can have multiple gateways in\n   * the same \"base route\".\n   *\n   * It can also includes placeholders for parameters like `/:parameter/`, that will be\n   * replaced with the `placeholders` option when `getAPIConfig` gets called.\n   *\n   * @default ''\n   */\n  root: string;\n  /**\n   * This is another option for when the gateway is used with an API client. When calling\n   * `getAPIConfig`, all the endpoints will be wrapped inside an object named after this\n   * option. For example: `{ url: '...', endpoints: { api: { ... } } }`.\n   *\n   * @default 'api'\n   */\n  apiConfigSetting: string;\n  /**\n   * The options for how the gateway will handle the headers from the requests and the\n   * responses.\n   */\n  headers: GatewayControllerHeaderOptions;\n};\n/**\n * The required options for the gateway controller.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerOptions = {\n  /**\n   * The configuration for the API the gateway will make the requests to.\n   */\n  gatewayConfig: GatewayConfig;\n  /**\n   * The route where the controller is mounted.\n   */\n  route: string;\n} & DeepPartial<GatewayControllerExtraOptions>;\n/**\n * The information for a request the controller will make.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerRequest = {\n  /**\n   * The URL for the request.\n   */\n  url: string;\n  /**\n   * The options for the fetch client that will make the requests.\n   */\n  options: HTTPFetchOptions;\n};\n/**\n * The information for an endpoint the gateway is calling.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerEndpointInfo = {\n  /**\n   * The name of the endpoint in the configuration.\n   */\n  name: string;\n  /**\n   * The properties (path and method) of the endpoint.\n   */\n  definition: GatewayConfigEndpointDefinition;\n};\n/**\n * These are the base options sent to all the helper service functions.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceBaseFnOptions = {\n  /**\n   * The information of the endpoint the gateway is calling.\n   */\n  endpoint: GatewayControllerEndpointInfo;\n  /**\n   * The request recived by the application.\n   */\n  req: Request;\n  /**\n   * The response object created by the application.\n   */\n  res: Response;\n  /**\n   * The function to call the next middleware in the chain.\n   */\n  next: NextFunction;\n};\n/**\n * The information sent to the helper service in order to modify, or not, a request before\n * it is sent.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceRequestReducerOptions =\n  GatewayHelperServiceBaseFnOptions & {\n    /**\n     * The options the controller created for the fetch client.\n     */\n    endpointReq: GatewayControllerRequest;\n  };\n/**\n * A function that can be used to modify the information of an endpoint before making a\n * request.\n *\n * @param options  The information of the request.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceRequestReducer = (\n  options: GatewayHelperServiceRequestReducerOptions,\n) => Promise<GatewayControllerRequest>;\n/**\n * The information sent to the helper service in order to modify a response before\n * processing it, decide if it should be streamed or not, and even handle it.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceResponseReducerOptions =\n  GatewayHelperServiceBaseFnOptions & {\n    /**\n     * The response from the endpoint request.\n     */\n    endpointRes: HTTPResponse;\n  };\n/**\n * A function that can be used to modify the response of an endpoint before the controller\n * processes it.\n *\n * @param options  The information of the response.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceResponseReducer = (\n  options: GatewayHelperServiceResponseReducerOptions,\n) => Promise<HTTPResponse>;\n/**\n * A function that can be used to tell the controller to stream the response of an\n * endpoint or not.\n * If it returns `false`, the function to handle responses should be defined, otherwise,\n * an error will be generated.\n *\n * @param options  The information of the response.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceStreamVerification = (\n  options: GatewayHelperServiceResponseReducerOptions,\n) => Promise<boolean>;\n/**\n * A function to handle the response of an endpoint. This is called when the helper\n * service tells the controller that the endpoint shouldn't be streamed, so this method\n * should handle the response.\n *\n * @param options  The information of the response.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceResponseHandler = (\n  options: GatewayHelperServiceResponseReducerOptions,\n) => Promise<void>;\n/**\n * The information sent to the helper service in order to handle a failed request for an\n * endpoint.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceErrorHandlerOptions =\n  GatewayHelperServiceBaseFnOptions & {\n    /**\n     * The error generated during the request.\n     */\n    error: Error;\n  };\n/**\n * A function to handle the error of an endpoint request.\n *\n * @param options  The information of the error.\n * @group Controllers/Gateway\n */\nexport type GatewayHelperServiceErrorHandler = (\n  options: GatewayHelperServiceErrorHandlerOptions,\n) => void;\n/**\n * The interface of a helper service that can intercept/modify the requests and responses\n * the gateway makes.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayHelperService = Partial<{\n  /**\n   * A function that is called before an endpoint request is made.\n   */\n  reduceEndpointRequest: GatewayHelperServiceRequestReducer;\n  /**\n   * A function that is called with the response of an endpoint request.\n   */\n  reduceEndpointResponse: GatewayHelperServiceResponseReducer;\n  /**\n   * A function called in order to validate if an endpoint response should be streamed or\n   * not. If the function returns `false`, `handleEndpointResponse` will be called.\n   */\n  shouldStreamEndpointResponse: GatewayHelperServiceStreamVerification;\n  /**\n   * A function called when `shouldStreamEndpointResponse` returns `false`. The function\n   * should handle the response for the application.\n   */\n  handleEndpointResponse: GatewayHelperServiceResponseHandler;\n  /**\n   * A function called when an error is generated during an endpoint request/processing.\n   */\n  handleEndpointError: GatewayHelperServiceErrorHandler;\n}>;\n/**\n * Utility type for the options object sent to the \"proxy methods\" the controller has for\n * the helper service.\n *\n * @template T  The type of the options for a specific helper service function.\n * @access protected\n * @group Controllers/Gateway\n */\nexport type GatewayControllerHelperOptions<T> = T & {\n  /**\n   * The reference for the helper service.\n   */\n  helper: GatewayHelperService;\n};\n/**\n * The information for a single HTTP method an endpoint can handle.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerRouteMethod = {\n  /**\n   * The method for the route.\n   */\n  method: RouterMethod;\n  /**\n   * The information of the endpoint.\n   */\n  endpoint: GatewayControllerEndpointInfo;\n};\n/**\n * The information for all the HTTP methods that can be handled for an endpoint.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerRoute = {\n  /**\n   * The path to the endpoint, relative to the entry point.\n   */\n  path: string;\n  /**\n   * The path for the route in the controller. This is different from `path` as it's possible for\n   * the gateway to be implemented using the `root` option.\n   */\n  route: string;\n  /**\n   * A list with all the methods the controller uses on the route.\n   */\n  methods: GatewayControllerRouteMethod[];\n};\n/**\n * The API client configuration the gateway can generate for its endpoints.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerAPIConfig = {\n  /**\n   * The base URL for the API.\n   */\n  url: string;\n  /**\n   * The dictionary of endpoints the controller handles.\n   */\n  endpoints: APIClientOptions['endpoints'];\n};\n/**\n * The options sent to {@link GatewayController.getAPIConfig}.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerAPIConfigOptions = {\n  /**\n   * This can be used to overwrite the gateway's `apiConfigSetting` option, and set a new\n   * setting as a wrapper for the endpoints.\n   */\n  setting?: string;\n  /**\n   * A dictionary of values for possible placeholders that were sent using the `root`\n   * option.\n   */\n  placeholders?: Record<string, string>;\n};\n/**\n * The options to construct a {@link GatewayController}.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerConstructorOptions = GatewayControllerOptions & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    http: HTTP;\n    /**\n     * A function to get a possible helper service. This is injected as a \"getter\" to not\n     * interrupt the DIC \"lifecycle\": controllers are initialized right when the app\n     * starts, and injecting a reference would force the service to be initialized too,\n     * even if a request is not being made.\n     */\n    getHelperService?: () => GatewayHelperService | undefined;\n  };\n};\n/**\n * The options for {@link GatewayController._addRoute}.\n *\n * @access protected\n * @group Controllers/Gateway\n */\nexport type AddGatewayRouteOptions = {\n  /**\n   * The reference for the router in which the middlewares will be added.\n   */\n  router: Router;\n  /**\n   * The router method in which the middlewares will be added.\n   */\n  method: RouterMethod;\n  /**\n   * The route in which the middlewares will be added.\n   */\n  route: string;\n  /**\n   * The middleware created by {@link GatewayController}, that makes the request.\n   */\n  gatewayMiddleware: AsyncExpressMiddleware;\n  /**\n   * A list of extra middlewares to prepend to the gateway middleware.\n   */\n  middlewares: ExpressMiddleware[];\n};\n/**\n * A utility controller that generates routes that act as a gateway for a specific API.\n *\n * @group Controller Classes\n * @group Controllers/Gateway\n * @prettierignore\n */\nexport class GatewayController {\n  /**\n   * The service that makes HTTP requests.\n   */\n  protected readonly http: HTTP;\n  /**\n   * A function to get a possible helper service. This is injected as a \"getter\" to not\n   * interrupt the DIC \"lifecycle\": controllers are initialized right when the app\n   * starts, and injecting a reference would force the service to be initialized too,\n   * even if a request is not being made.\n   */\n  protected readonly _getHelperService: () => GatewayHelperService | undefined;\n  /**\n   * The information, url and endpoints, for the gateway the controller will make requests to.\n   */\n  protected readonly _gatewayConfig: GatewayConfig;\n  /**\n   * The route in which the controller is mounted.\n   */\n  protected readonly _route: string;\n  /**\n   * A regular expression that will be used to remove the controller route from a\n   * request path. This will allow the main middleware to extract the path to where the\n   * request should be made.\n   */\n  protected readonly _routeExpression: RegExp;\n  /**\n   * The controller customization options.\n   */\n  protected readonly _options: GatewayControllerExtraOptions;\n  /**\n   * A flat dictionary with the endpoints information.\n   */\n  protected readonly _endpoints: Record<string, GatewayConfigEndpointDefinition>;\n  /**\n   * The entry URL for the API client configuration the controller can generate.\n   */\n  protected readonly _apiConfigUrl: string;\n  /**\n   * The generated endpoints for the API client configuration the controller can generate.\n   */\n  protected readonly _apiConfigEndpoints: APIClientOptions['endpoints'];\n  /**\n   * The list of routes the controller can handle.\n   */\n  protected readonly _routes: GatewayControllerRoute[];\n  /**\n   * @param options  The options to construct the controller.\n   */\n  constructor({\n    inject,\n    route,\n    gatewayConfig,\n    ...options\n  }: GatewayControllerConstructorOptions) {\n    this.http = inject.http;\n    this._getHelperService = inject.getHelperService || (() => undefined);\n    this._route = removeSlashes(route);\n    this._options = this._formatOptions(\n      deepAssignWithOverwrite(\n        {\n          root: '',\n          apiConfigSetting: 'api',\n          headers: {\n            useXForwardedFor: true,\n            copyCustomHeaders: true,\n            copy: ['authorization', 'content-type', 'referer', 'user-agent'],\n            remove: ['server', 'x-powered-by', 'content-encoding'],\n          },\n        },\n        options,\n      ),\n    );\n    this._gatewayConfig = {\n      ...gatewayConfig,\n      url: removeSlashes(gatewayConfig.url, false, true),\n    };\n    this._routeExpression = createRouteExpression(\n      this._options.root ? `${this._route}/${this._options.root}` : this._route,\n      true,\n      true,\n    );\n    this._endpoints = this._formatEndpoints();\n    this._routes = this._createRoutes();\n    const { url, endpoints } = this._createAPIConfig();\n    this._apiConfigUrl = url;\n    this._apiConfigEndpoints = endpoints;\n  }\n  /**\n   * Generates an API client configuration based on the controller routes.\n   *\n   * @param options  The options to customize the generated configuration.\n   */\n  getAPIConfig({\n    setting,\n    placeholders = {},\n  }: GatewayControllerAPIConfigOptions = {}): Readonly<GatewayControllerAPIConfig> {\n    const useSetting = setting || this._options.apiConfigSetting;\n    let url: string;\n    const placeholdersEntries = Object.entries(placeholders);\n    if (placeholdersEntries.length) {\n      url = placeholdersEntries.reduce<string>(\n        (acc, [key, value]) => acc.replace(`:${key}`, value),\n        this._apiConfigUrl,\n      );\n    } else {\n      url = this._apiConfigUrl;\n    }\n\n    return {\n      url,\n      endpoints: {\n        [useSetting]: this._apiConfigEndpoints,\n      },\n    };\n  }\n  /**\n   * Mounts the middlewares in the router in order to make the requests.\n   *\n   * @param router       A reference to the application router.\n   * @param middlewares  A list of extra middlewares to execute before the gateway\n   *                     middleware.\n   */\n  addRoutes(router: Router, middlewares: ExpressMiddleware[] = []): Router {\n    this._routes.forEach((route) => {\n      route.methods.forEach((info) => {\n        this._addRoute({\n          router,\n          method: info.method,\n          route: route.route,\n          gatewayMiddleware: this._createGatewayMiddleware(info.endpoint),\n          middlewares,\n        });\n      });\n    });\n\n    return router;\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<GatewayControllerExtraOptions> {\n    return { ...this._options };\n  }\n  /**\n   * The configuration for the gateway the controller will make requests to.\n   */\n  get gatewayConfig(): Readonly<GatewayConfig> {\n    return { ...this._gatewayConfig };\n  }\n  /**\n   * Generates a middleware that will make the request to an endpoint and stream the\n   * response.\n   *\n   * @param endpoint  The information of the endpoint the middleware will handle.\n   */\n  protected _createGatewayMiddleware(\n    endpoint: GatewayControllerEndpointInfo,\n  ): AsyncExpressMiddleware {\n    return async (req, res, next) => {\n      const {\n        _options: { headers: headersOptions },\n        _gatewayConfig: { url: gatewayUrl },\n        _routeExpression: routeExpression,\n      } = this;\n      // Remove the controller route from the requested URL.\n      const reqPath = req.originalUrl.replace(routeExpression, '');\n      // Process the headers for the request.\n      let headers: Record<string, string> = {};\n      // - Copy the headers from the incoming request.\n      headersOptions.copy.forEach((name) => {\n        if (req.headers[name]) {\n          headers[name] = req.headers[name] as string;\n        }\n      });\n      // - Copy the custom headers.\n      if (headersOptions.copyCustomHeaders) {\n        headers = deepAssignWithOverwrite<Record<string, string>>(\n          headers,\n          this.http.getCustomHeadersFromRequest(req),\n        );\n      }\n      // - Include the IP on the X-Forwarded-For header, if enabled.\n      if (headersOptions.useXForwardedFor) {\n        const ip = this.http.getIPFromRequest(req);\n        if (ip) {\n          headers['x-forwarded-for'] = ip;\n        }\n      }\n\n      const method = req.method.toUpperCase();\n      // If the request has a body and the method is not `GET`, stringify it.\n      let body: string | undefined;\n      if (method !== 'GET' && typeof req.body === 'object') {\n        body = JSON.stringify(req.body);\n        // If there's no `content-type`, let's assume it's JSON.\n        if (!headers['content-type']) {\n          headers['content-type'] = 'application/json';\n        }\n      }\n\n      /**\n       * Get the helper service, if there's one, and define the base options for its\n       * methods.\n       */\n      const helper = this._getHelperService() || {};\n      const helperBasePayload = {\n        endpoint,\n        req,\n        res,\n        next,\n        helper,\n      };\n\n      try {\n        // Reduce the request information before using it.\n        const request = await this._reduceEndpointRequest({\n          endpointReq: {\n            url: `${gatewayUrl}/${reqPath}`,\n            options: {\n              method,\n              headers,\n              body,\n            },\n          },\n          ...helperBasePayload,\n        });\n        // Make the actual request.\n        const responseRaw = await this.http.fetch(request.url, request.options);\n        // Reduce the response information before using it.\n        const response = await this._reduceEndpointResponse({\n          endpointRes: responseRaw,\n          ...helperBasePayload,\n        });\n        // Validate if the response should be streamed.\n        const shouldStream = await this._shouldStreamEndpointResponse({\n          endpointRes: responseRaw,\n          ...helperBasePayload,\n        });\n\n        if (shouldStream) {\n          /**\n           * If the response should be streamed, set the status, remove unwanted headers,\n           * and pipe it to the application response object.\n           */\n          res.status(response.status);\n          response.headers.forEach((value, name) => {\n            if (!headersOptions.remove.includes(name)) {\n              res.setHeader(name, value);\n            }\n          });\n\n          response.body.pipe(res).on('error', (error) => {\n            next(error);\n          });\n        } else {\n          /**\n           * If the response should not be streamed, send it to the helper method to\n           * handle it.\n           */\n          await this._handleEndpointResponse({\n            endpointRes: response,\n            ...helperBasePayload,\n          });\n        }\n      } catch (error) {\n        // Something failed, so let's pass the error to the helper service.\n        this._handleEndpointError({\n          error: error as Error,\n          ...helperBasePayload,\n        });\n      }\n    };\n  }\n  /**\n   * Mounts the middleware(s) for an endpoint in the router.\n   *\n   * @param options  The information of the endpoint and how it needs to be added.\n   */\n  protected _addRoute({\n    router,\n    method,\n    route,\n    gatewayMiddleware,\n    middlewares,\n  }: AddGatewayRouteOptions): void {\n    router[method](route, [...middlewares, gatewayMiddleware]);\n  }\n  /**\n   * Formats the endpoints for the gateway into a flat dictionary without nesting.\n   */\n  protected _formatEndpoints(): Record<string, GatewayConfigEndpointDefinition> {\n    return flat({\n      target: this._gatewayConfig.gateway,\n      shouldFlatten: (_, value) => {\n        const useValue = value as { path?: string };\n        return typeof useValue.path === 'undefined';\n      },\n    });\n  }\n  /**\n   * Based on the information from the endpoints, this method will create the routes the\n   * controller will later add on a router.\n   *\n   * @throws If there's more than one endpoint using the same path with the same HTTP\n   *         method.\n   */\n  protected _createRoutes(): GatewayControllerRoute[] {\n    const routes: Record<\n      string,\n      {\n        path: string;\n        methods: Partial<Record<RouterMethod, string>>;\n      }\n    > = {};\n    Object.keys(this._endpoints).forEach((name) => {\n      const endpoint = this._endpoints[name]!;\n      let endpointPath: string;\n      let endpointMethod: RouterMethod;\n      if (typeof endpoint === 'string') {\n        endpointPath = endpoint;\n        endpointMethod = 'all';\n      } else {\n        endpointPath = endpoint.path;\n        endpointMethod = endpoint.method\n          ? this._validateHTTPMethod(endpoint.method)\n          : 'all';\n      }\n\n      endpointPath = removeSlashes(endpointPath);\n      if (!routes[endpointPath]) {\n        routes[endpointPath] = {\n          path: endpointPath,\n          methods: {},\n        };\n      }\n\n      if (routes[endpointPath]!.methods[endpointMethod]) {\n        const repeatedEndpoint = routes[endpointPath]!.methods[endpointMethod];\n        throw new Error(\n          \"You can't have two gateway endpoints to the same path and with the same \" +\n            `HTTP method: '${repeatedEndpoint}' and '${name}'`,\n        );\n      }\n\n      routes[endpointPath]!.methods[endpointMethod] = name;\n    });\n\n    const routePrefixes = this._options.root ? `/${this._options.root}/` : '/';\n    return Object.keys(routes).map((endpointPath) => {\n      const info = routes[endpointPath]!;\n      return {\n        path: info.path,\n        route: `${routePrefixes}${info.path}`,\n        methods: Object.keys(info.methods).map((methodNameRaw) => {\n          const methodName = methodNameRaw as RouterMethod;\n          const endpointName = info.methods[methodName]!;\n          const endpointDefinition = this._endpoints[endpointName]!;\n          return {\n            method: methodName,\n            endpoint: {\n              name: endpointName,\n              definition: endpointDefinition,\n            },\n          };\n        }),\n      };\n    });\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that can modify an\n   * endpoint request before it gets made.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `reduceEndpointRequest`, it will just return\n   * information for the request.\n   *\n   * @param options  The information of the request and the reference to the helper.\n   */\n  protected _reduceEndpointRequest({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceRequestReducerOptions>): Promise<GatewayControllerRequest> {\n    if (helper.reduceEndpointRequest) {\n      return helper.reduceEndpointRequest(options);\n    }\n\n    return Promise.resolve(options.endpointReq);\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that can modify an\n   * endpoint response before it gets processed.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `reduceEndpointResponse`, it will just return\n   * information for the response.\n   *\n   * @param options  The information of the response and the reference to the helper.\n   */\n  protected _reduceEndpointResponse({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceResponseReducerOptions>): Promise<HTTPResponse> {\n    if (helper.reduceEndpointResponse) {\n      return helper.reduceEndpointResponse(options);\n    }\n\n    return Promise.resolve(options.endpointRes);\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that can decide if an\n   * endpoint response should be streamed or not.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `shouldStreamEndpointResponse`, it will just return\n   * `true`.\n   *\n   * @param options  The information of the response and the reference to the helper.\n   */\n  protected _shouldStreamEndpointResponse({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceResponseReducerOptions>): Promise<boolean> {\n    if (helper.shouldStreamEndpointResponse) {\n      return helper.shouldStreamEndpointResponse(options);\n    }\n\n    return Promise.resolve(true);\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that handles a\n   * response in case it already said that a response shouldn't be streamed.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `shouldStreamEndpointResponse`, it will throw an\n   * error.\n   *\n   * @param options  The information of the response and the reference to the helper.\n   * @throws If the helper doesn't implement `handleEndpointResponse`.\n   */\n  protected _handleEndpointResponse({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceResponseReducerOptions>): Promise<void> {\n    if (!helper.handleEndpointResponse) {\n      throw new Error('You must implement handleEndpointResponse');\n    }\n\n    return helper.handleEndpointResponse(options);\n  }\n  /**\n   * This is a \"proxy method\" to call the helper service's function that handles an error\n   * on an endpoint request.\n   *\n   * The reason this is a \"proxy method\" is in case the controller gets subclassed and\n   * \"used itself as a helper\" instead of relying on a difference one.\n   *\n   * If the helper doesn't implement `handleEndpointError`, it will just send the error to\n   * the next middleware/error handler.\n   *\n   * @param options  The information of the response and the reference to the helper.\n   */\n  protected _handleEndpointError({\n    helper,\n    ...options\n  }: GatewayControllerHelperOptions<GatewayHelperServiceErrorHandlerOptions>): void {\n    if (helper.handleEndpointError) {\n      return helper.handleEndpointError(options);\n    }\n\n    return options.next(options.error);\n  }\n  /**\n   * Validates and formats the customization options sent to the controller.\n   *\n   * @param options  The options sent to the constructor.\n   */\n  protected _formatOptions(\n    options: GatewayControllerExtraOptions,\n  ): GatewayControllerExtraOptions {\n    if (options.root) {\n      const root = removeSlashes(options.root).trim();\n      return { ...options, root };\n    }\n\n    return options;\n  }\n  /**\n   * Validates a router/HTTP method that the controller intends to use for an endpoint. If\n   * it's not valid, it will return `all`.\n   *\n   * @param method  The HTTP method for the endpoint.\n   */\n  protected _validateHTTPMethod(method: string): RouterMethod {\n    const newMethod = method.toLowerCase();\n    return [\n      'get',\n      'head',\n      'post',\n      'patch',\n      'put',\n      'delete',\n      'connect',\n      'options',\n      'trace',\n    ].includes(newMethod)\n      ? (newMethod as RouterMethod)\n      : 'all';\n  }\n  /**\n   * Creates the API client configuration based on the controller routes.\n   */\n  protected _createAPIConfig(): GatewayControllerAPIConfig {\n    let endpoints: APIClientOptions['endpoints'];\n    const { root } = this._options;\n    if (root) {\n      endpoints = Object.keys(this._endpoints).reduce<\n        Record<string, GatewayConfigEndpointDefinition>\n      >((acc, name) => {\n        const endpoint = this._endpoints[name]!;\n        let newEndpoint;\n        if (typeof endpoint === 'string') {\n          newEndpoint = removeSlashes(endpoint);\n          newEndpoint = `${root}/${newEndpoint}`;\n        } else {\n          const endpointPath = removeSlashes(endpoint.path);\n          newEndpoint = {\n            ...endpoint,\n            path: `${root}/${endpointPath}`,\n          };\n        }\n\n        acc[name] = newEndpoint;\n        return acc;\n      }, {});\n    } else {\n      endpoints = this._endpoints;\n    }\n\n    return {\n      url: `/${this._route}`,\n      endpoints: unflat({ target: endpoints }),\n    };\n  }\n}\n/**\n * A function to generate a list of middlewares that can be executed before the tontroller\n * main middleware.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerGetMiddlewaresFn = (app: Jimpex) => MiddlewareLike[];\n/**\n * The options for the controller creator that mounts the {@link GatewayController}.\n *\n * @group Controllers/Gateway\n */\nexport type GatewayControllerCreatorOptions =\n  DeepPartial<GatewayControllerExtraOptions> & {\n    /**\n     * The name the creator will use to register the controller in the container. No,\n     * this is not a typo. The creator will register the controller so other services can\n     * access the `getAPIConfig` method. The service will be available after the app\n     * routes are mounted.\n     * If this is overwritten, the creator will ensure that the name ends with `Gateway`;\n     * and if overwritten, but it doesn't include `Gateway` at the end, and no\n     * `gatewaySettingName` was defined, the creator will use the custom name (without\n     * `Gatway`) for `gatewaySettingName`.\n     *\n     * @default 'apiGateway'\n     */\n    serviceName?: string;\n    /**\n     * The name of the helper service the creator will try to obtain from the container.\n     * If `serviceName` is overwritten, the default for this will be\n     * `${serviceName}Helper`.\n     *\n     * @default 'apiGatewayHelper'\n     */\n    helperServiceName?: string;\n    /**\n     * The name of the configuration setting where the gateway configuration is stored. If\n     * not overwritten, check the description of `serviceName` to understand which will be\n     * its default value.\n     *\n     * @default 'api'\n     */\n    gatewaySettingName?: string;\n    /**\n     * The class the creator will instantiate. Similar to the API Client, this allows for\n     * extra customization as you can send a custom subclass of the\n     * {@link GatewayController}.\n     *\n     * @default GatewayController\n     */\n    gatewayClass?: typeof GatewayController;\n    /**\n     * A function to generate a list of middlewares that can be executed before the\n     * controller main middleware.\n     */\n    getMiddlewares?: GatewayControllerGetMiddlewaresFn;\n  };\n/**\n * Creates a controller that allows the application to mount routes that will work like\n * gateway to a specific API.\n *\n * @group Controllers\n * @group Controllers/Gateway\n */\nexport const gatewayController = controllerProviderCreator(\n  (options: GatewayControllerCreatorOptions = {}) =>\n    (app, route) => {\n      /**\n       * Formats the name in order to keep consistency with the helper service and the\n       * configuration setting: If the `serviceName` is different from the default, make\n       * sure it ends with `Gateway`, set the default helper service name to\n       * `${serviceName}Helper`, and the default configuration setting to the same as the\n       * service name (without the `Gateway`).\n       * This way, if you just use `myApi`, the service name will be `myApiGateway`, the\n       * helper name will be `myApiGatewayHelper` and the configuration setting `myApi`.\n       */\n      const defaultServiceName = 'apiGateway';\n      let defaultHelperServiceName = 'apiGatewayHelper';\n      let defaultConfigSetting = 'api';\n      let { serviceName = defaultServiceName } = options;\n      if (serviceName !== defaultServiceName) {\n        defaultConfigSetting = serviceName;\n        if (!serviceName.match(/gateway$/i)) {\n          serviceName = `${serviceName}Gateway`;\n        }\n        defaultHelperServiceName = `${serviceName}Helper`;\n      }\n      // Register the service.\n      app.set(serviceName, () => {\n        const {\n          helperServiceName = defaultHelperServiceName,\n          gatewaySettingName = defaultConfigSetting,\n          gatewayClass: GatewayClass = GatewayController,\n        } = options;\n\n        const gtConfig = app.getConfig<GatewayConfig>(gatewaySettingName);\n\n        return new GatewayClass({\n          ...options,\n          apiConfigSetting: gatewaySettingName,\n          gatewayConfig: gtConfig,\n          route,\n          inject: {\n            http: app.get('http'),\n            getHelperService: () => app.try(helperServiceName),\n          },\n        });\n      });\n\n      return controller(() => {\n        // Get the controller.\n        const ctrl = app.get<GatewayController>(serviceName);\n        /**\n         * Check if there are actual middlewares to be included, and in case there are\n         * Jimpex middlewares, connect them.\n         */\n        let useMiddlewares: ExpressMiddleware[] | undefined;\n        if (options.getMiddlewares) {\n          useMiddlewares = options\n            .getMiddlewares(app)\n            .map((middleware) => {\n              if ('middleware' in middleware) {\n                return middleware.connect(app) as ExpressMiddleware | undefined;\n              }\n\n              return middleware as ExpressMiddleware;\n            })\n            .filter(notUndefined);\n        }\n\n        // Add the routes to the router and return it.\n        return ctrl.addRoutes(app.get('router'), useMiddlewares);\n      });\n    },\n);\n"],"mappings":";;;AAAA,SAAS,+BAA+B;AACxC,SAAS,MAAM,cAAc;AAE7B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AAweA,MAAM,kBAAkB;AAAA,EAiD7B,YAAY;AAAA,IACV;AAAA,IACA;AAAA,IACA;AAAA,OACG;AAAA,EACL,GAAwC;AAlDxC,wBAAmB;AAOnB,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAMnB,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAUjB,SAAK,OAAO,OAAO;AACnB,SAAK,oBAAoB,OAAO,qBAAqB,MAAM;AAC3D,SAAK,SAAS,cAAc,KAAK;AACjC,SAAK,WAAW,KAAK;AAAA,MACnB;AAAA,QACE;AAAA,UACE,MAAM;AAAA,UACN,kBAAkB;AAAA,UAClB,SAAS;AAAA,YACP,kBAAkB;AAAA,YAClB,mBAAmB;AAAA,YACnB,MAAM,CAAC,iBAAiB,gBAAgB,WAAW,YAAY;AAAA,YAC/D,QAAQ,CAAC,UAAU,gBAAgB,kBAAkB;AAAA,UACvD;AAAA,QACF;AAAA,QACA;AAAA,MACF;AAAA,IACF;AACA,SAAK,iBAAiB;AAAA,MACpB,GAAG;AAAA,MACH,KAAK,cAAc,cAAc,KAAK,OAAO,IAAI;AAAA,IACnD;AACA,SAAK,mBAAmB;AAAA,MACtB,KAAK,SAAS,OAAO,GAAG,KAAK,UAAU,KAAK,SAAS,SAAS,KAAK;AAAA,MACnE;AAAA,MACA;AAAA,IACF;AACA,SAAK,aAAa,KAAK,iBAAiB;AACxC,SAAK,UAAU,KAAK,cAAc;AAClC,UAAM,EAAE,KAAK,UAAU,IAAI,KAAK,iBAAiB;AACjD,SAAK,gBAAgB;AACrB,SAAK,sBAAsB;AAAA,EAC7B;AAAA,EAMA,aAAa;AAAA,IACX;AAAA,IACA,eAAe,CAAC;AAAA,EAClB,IAAuC,CAAC,GAAyC;AAC/E,UAAM,aAAa,WAAW,KAAK,SAAS;AAC5C,QAAI;AACJ,UAAM,sBAAsB,OAAO,QAAQ,YAAY;AACvD,QAAI,oBAAoB,QAAQ;AAC9B,YAAM,oBAAoB;AAAA,QACxB,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM,IAAI,QAAQ,IAAI,OAAO,KAAK;AAAA,QACnD,KAAK;AAAA,MACP;AAAA,IACF,OAAO;AACL,YAAM,KAAK;AAAA,IACb;AAEA,WAAO;AAAA,MACL;AAAA,MACA,WAAW;AAAA,QACT,CAAC,aAAa,KAAK;AAAA,MACrB;AAAA,IACF;AAAA,EACF;AAAA,EAQA,UAAU,QAAgB,cAAmC,CAAC,GAAW;AACvE,SAAK,QAAQ,QAAQ,CAAC,UAAU;AAC9B,YAAM,QAAQ,QAAQ,CAAC,SAAS;AAC9B,aAAK,UAAU;AAAA,UACb;AAAA,UACA,QAAQ,KAAK;AAAA,UACb,OAAO,MAAM;AAAA,UACb,mBAAmB,KAAK,yBAAyB,KAAK,QAAQ;AAAA,UAC9D;AAAA,QACF,CAAC;AAAA,MACH,CAAC;AAAA,IACH,CAAC;AAED,WAAO;AAAA,EACT;AAAA,EAIA,IAAI,UAAmD;AACrD,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AAAA,EAIA,IAAI,gBAAyC;AAC3C,WAAO,EAAE,GAAG,KAAK,eAAe;AAAA,EAClC;AAAA,EAOU,yBACR,UACwB;AACxB,WAAO,OAAO,KAAK,KAAK,SAAS;AAC/B,YAAM;AAAA,QACJ,UAAU,EAAE,SAAS,eAAe;AAAA,QACpC,gBAAgB,EAAE,KAAK,WAAW;AAAA,QAClC,kBAAkB;AAAA,MACpB,IAAI;AAEJ,YAAM,UAAU,IAAI,YAAY,QAAQ,iBAAiB,EAAE;AAE3D,UAAI,UAAkC,CAAC;AAEvC,qBAAe,KAAK,QAAQ,CAAC,SAAS;AACpC,YAAI,IAAI,QAAQ,OAAO;AACrB,kBAAQ,QAAQ,IAAI,QAAQ;AAAA,QAC9B;AAAA,MACF,CAAC;AAED,UAAI,eAAe,mBAAmB;AACpC,kBAAU;AAAA,UACR;AAAA,UACA,KAAK,KAAK,4BAA4B,GAAG;AAAA,QAC3C;AAAA,MACF;AAEA,UAAI,eAAe,kBAAkB;AACnC,cAAM,KAAK,KAAK,KAAK,iBAAiB,GAAG;AACzC,YAAI,IAAI;AACN,kBAAQ,qBAAqB;AAAA,QAC/B;AAAA,MACF;AAEA,YAAM,SAAS,IAAI,OAAO,YAAY;AAEtC,UAAI;AACJ,UAAI,WAAW,SAAS,OAAO,IAAI,SAAS,UAAU;AACpD,eAAO,KAAK,UAAU,IAAI,IAAI;AAE9B,YAAI,CAAC,QAAQ,iBAAiB;AAC5B,kBAAQ,kBAAkB;AAAA,QAC5B;AAAA,MACF;AAMA,YAAM,SAAS,KAAK,kBAAkB,KAAK,CAAC;AAC5C,YAAM,oBAAoB;AAAA,QACxB;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAEA,UAAI;AAEF,cAAM,UAAU,MAAM,KAAK,uBAAuB;AAAA,UAChD,aAAa;AAAA,YACX,KAAK,GAAG,cAAc;AAAA,YACtB,SAAS;AAAA,cACP;AAAA,cACA;AAAA,cACA;AAAA,YACF;AAAA,UACF;AAAA,UACA,GAAG;AAAA,QACL,CAAC;AAED,cAAM,cAAc,MAAM,KAAK,KAAK,MAAM,QAAQ,KAAK,QAAQ,OAAO;AAEtE,cAAM,WAAW,MAAM,KAAK,wBAAwB;AAAA,UAClD,aAAa;AAAA,UACb,GAAG;AAAA,QACL,CAAC;AAED,cAAM,eAAe,MAAM,KAAK,8BAA8B;AAAA,UAC5D,aAAa;AAAA,UACb,GAAG;AAAA,QACL,CAAC;AAED,YAAI,cAAc;AAKhB,cAAI,OAAO,SAAS,MAAM;AAC1B,mBAAS,QAAQ,QAAQ,CAAC,OAAO,SAAS;AACxC,gBAAI,CAAC,eAAe,OAAO,SAAS,IAAI,GAAG;AACzC,kBAAI,UAAU,MAAM,KAAK;AAAA,YAC3B;AAAA,UACF,CAAC;AAED,mBAAS,KAAK,KAAK,GAAG,EAAE,GAAG,SAAS,CAAC,UAAU;AAC7C,iBAAK,KAAK;AAAA,UACZ,CAAC;AAAA,QACH,OAAO;AAKL,gBAAM,KAAK,wBAAwB;AAAA,YACjC,aAAa;AAAA,YACb,GAAG;AAAA,UACL,CAAC;AAAA,QACH;AAAA,MACF,SAAS,OAAP;AAEA,aAAK,qBAAqB;AAAA,UACxB;AAAA,UACA,GAAG;AAAA,QACL,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA,EAMU,UAAU;AAAA,IAClB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAAiC;AAC/B,WAAO,QAAQ,OAAO,CAAC,GAAG,aAAa,iBAAiB,CAAC;AAAA,EAC3D;AAAA,EAIU,mBAAoE;AAC5E,WAAO,KAAK;AAAA,MACV,QAAQ,KAAK,eAAe;AAAA,MAC5B,eAAe,CAAC,GAAG,UAAU;AAC3B,cAAM,WAAW;AACjB,eAAO,OAAO,SAAS,SAAS;AAAA,MAClC;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAQU,gBAA0C;AAClD,UAAM,SAMF,CAAC;AACL,WAAO,KAAK,KAAK,UAAU,EAAE,QAAQ,CAAC,SAAS;AAC7C,YAAM,WAAW,KAAK,WAAW;AACjC,UAAI;AACJ,UAAI;AACJ,UAAI,OAAO,aAAa,UAAU;AAChC,uBAAe;AACf,yBAAiB;AAAA,MACnB,OAAO;AACL,uBAAe,SAAS;AACxB,yBAAiB,SAAS,SACtB,KAAK,oBAAoB,SAAS,MAAM,IACxC;AAAA,MACN;AAEA,qBAAe,cAAc,YAAY;AACzC,UAAI,CAAC,OAAO,eAAe;AACzB,eAAO,gBAAgB;AAAA,UACrB,MAAM;AAAA,UACN,SAAS,CAAC;AAAA,QACZ;AAAA,MACF;AAEA,UAAI,OAAO,cAAe,QAAQ,iBAAiB;AACjD,cAAM,mBAAmB,OAAO,cAAe,QAAQ;AACvD,cAAM,IAAI;AAAA,UACR,yFACmB,0BAA0B;AAAA,QAC/C;AAAA,MACF;AAEA,aAAO,cAAe,QAAQ,kBAAkB;AAAA,IAClD,CAAC;AAED,UAAM,gBAAgB,KAAK,SAAS,OAAO,IAAI,KAAK,SAAS,UAAU;AACvE,WAAO,OAAO,KAAK,MAAM,EAAE,IAAI,CAAC,iBAAiB;AAC/C,YAAM,OAAO,OAAO;AACpB,aAAO;AAAA,QACL,MAAM,KAAK;AAAA,QACX,OAAO,GAAG,gBAAgB,KAAK;AAAA,QAC/B,SAAS,OAAO,KAAK,KAAK,OAAO,EAAE,IAAI,CAAC,kBAAkB;AACxD,gBAAM,aAAa;AACnB,gBAAM,eAAe,KAAK,QAAQ;AAClC,gBAAM,qBAAqB,KAAK,WAAW;AAC3C,iBAAO;AAAA,YACL,QAAQ;AAAA,YACR,UAAU;AAAA,cACR,MAAM;AAAA,cACN,YAAY;AAAA,YACd;AAAA,UACF;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAaU,uBAAuB;AAAA,IAC/B;AAAA,OACG;AAAA,EACL,GAAiH;AAC/G,QAAI,OAAO,uBAAuB;AAChC,aAAO,OAAO,sBAAsB,OAAO;AAAA,IAC7C;AAEA,WAAO,QAAQ,QAAQ,QAAQ,WAAW;AAAA,EAC5C;AAAA,EAaU,wBAAwB;AAAA,IAChC;AAAA,OACG;AAAA,EACL,GAAsG;AACpG,QAAI,OAAO,wBAAwB;AACjC,aAAO,OAAO,uBAAuB,OAAO;AAAA,IAC9C;AAEA,WAAO,QAAQ,QAAQ,QAAQ,WAAW;AAAA,EAC5C;AAAA,EAaU,8BAA8B;AAAA,IACtC;AAAA,OACG;AAAA,EACL,GAAiG;AAC/F,QAAI,OAAO,8BAA8B;AACvC,aAAO,OAAO,6BAA6B,OAAO;AAAA,IACpD;AAEA,WAAO,QAAQ,QAAQ,IAAI;AAAA,EAC7B;AAAA,EAcU,wBAAwB;AAAA,IAChC;AAAA,OACG;AAAA,EACL,GAA8F;AAC5F,QAAI,CAAC,OAAO,wBAAwB;AAClC,YAAM,IAAI,MAAM,2CAA2C;AAAA,IAC7D;AAEA,WAAO,OAAO,uBAAuB,OAAO;AAAA,EAC9C;AAAA,EAaU,qBAAqB;AAAA,IAC7B;AAAA,OACG;AAAA,EACL,GAAkF;AAChF,QAAI,OAAO,qBAAqB;AAC9B,aAAO,OAAO,oBAAoB,OAAO;AAAA,IAC3C;AAEA,WAAO,QAAQ,KAAK,QAAQ,KAAK;AAAA,EACnC;AAAA,EAMU,eACR,SAC+B;AAC/B,QAAI,QAAQ,MAAM;AAChB,YAAM,OAAO,cAAc,QAAQ,IAAI,EAAE,KAAK;AAC9C,aAAO,EAAE,GAAG,SAAS,KAAK;AAAA,IAC5B;AAEA,WAAO;AAAA,EACT;AAAA,EAOU,oBAAoB,QAA8B;AAC1D,UAAM,YAAY,OAAO,YAAY;AACrC,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,EAAE,SAAS,SAAS,IACf,YACD;AAAA,EACN;AAAA,EAIU,mBAA+C;AACvD,QAAI;AACJ,UAAM,EAAE,KAAK,IAAI,KAAK;AACtB,QAAI,MAAM;AACR,kBAAY,OAAO,KAAK,KAAK,UAAU,EAAE,OAEvC,CAAC,KAAK,SAAS;AACf,cAAM,WAAW,KAAK,WAAW;AACjC,YAAI;AACJ,YAAI,OAAO,aAAa,UAAU;AAChC,wBAAc,cAAc,QAAQ;AACpC,wBAAc,GAAG,QAAQ;AAAA,QAC3B,OAAO;AACL,gBAAM,eAAe,cAAc,SAAS,IAAI;AAChD,wBAAc;AAAA,YACZ,GAAG;AAAA,YACH,MAAM,GAAG,QAAQ;AAAA,UACnB;AAAA,QACF;AAEA,YAAI,QAAQ;AACZ,eAAO;AAAA,MACT,GAAG,CAAC,CAAC;AAAA,IACP,OAAO;AACL,kBAAY,KAAK;AAAA,IACnB;AAEA,WAAO;AAAA,MACL,KAAK,IAAI,KAAK;AAAA,MACd,WAAW,OAAO,EAAE,QAAQ,UAAU,CAAC;AAAA,IACzC;AAAA,EACF;AACF;AAiEO,MAAM,oBAAoB;AAAA,EAC/B,CAAC,UAA2C,CAAC,MAC3C,CAAC,KAAK,UAAU;AAUd,UAAM,qBAAqB;AAC3B,QAAI,2BAA2B;AAC/B,QAAI,uBAAuB;AAC3B,QAAI,EAAE,cAAc,mBAAmB,IAAI;AAC3C,QAAI,gBAAgB,oBAAoB;AACtC,6BAAuB;AACvB,UAAI,CAAC,YAAY,MAAM,WAAW,GAAG;AACnC,sBAAc,GAAG;AAAA,MACnB;AACA,iCAA2B,GAAG;AAAA,IAChC;AAEA,QAAI,IAAI,aAAa,MAAM;AACzB,YAAM;AAAA,QACJ,oBAAoB;AAAA,QACpB,qBAAqB;AAAA,QACrB,cAAc,eAAe;AAAA,MAC/B,IAAI;AAEJ,YAAM,WAAW,IAAI,UAAyB,kBAAkB;AAEhE,aAAO,IAAI,aAAa;AAAA,QACtB,GAAG;AAAA,QACH,kBAAkB;AAAA,QAClB,eAAe;AAAA,QACf;AAAA,QACA,QAAQ;AAAA,UACN,MAAM,IAAI,IAAI,MAAM;AAAA,UACpB,kBAAkB,MAAM,IAAI,IAAI,iBAAiB;AAAA,QACnD;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAED,WAAO,WAAW,MAAM;AAEtB,YAAM,OAAO,IAAI,IAAuB,WAAW;AAKnD,UAAI;AACJ,UAAI,QAAQ,gBAAgB;AAC1B,yBAAiB,QACd,eAAe,GAAG,EAClB,IAAI,CAAC,eAAe;AACnB,cAAI,gBAAgB,YAAY;AAC9B,mBAAO,WAAW,QAAQ,GAAG;AAAA,UAC/B;AAEA,iBAAO;AAAA,QACT,CAAC,EACA,OAAO,YAAY;AAAA,MACxB;AAGA,aAAO,KAAK,UAAU,IAAI,IAAI,QAAQ,GAAG,cAAc;AAAA,IACzD,CAAC;AAAA,EACH;AACJ;","names":[]}

package/dist/esm/controllers/utils/index.js

@@ -0,0 +1,2 @@
+export * from "./gateway";
+//# sourceMappingURL=index.js.map

package/dist/esm/controllers/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/controllers/utils/index.ts"],"sourcesContent":["export * from './gateway';\n"],"mappings":"AAAA,cAAc;","names":[]}

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+export * from "./app";
+export * from "./types";
+export * from "./controllers";
+export * from "./middlewares";
+export * from "./services";
+export * from "./utils";
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './app';\nexport * from './types';\nexport * from './controllers';\nexport * from './middlewares';\nexport * from './services';\nexport * from './utils';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}

package/dist/esm/middlewares/common/errorHandler.js

@@ -0,0 +1,92 @@
+import {
+  __publicField
+} from "../../chunk-T2T6Q22Z.js";
+import { deepAssignWithOverwrite } from "@homer0/deep-assign";
+import { middlewareCreator } from "../../utils";
+import { AppError } from "../../services";
+class ErrorHandler {
+  constructor({
+    inject: { logger, responsesBuilder, statuses, HTTPError },
+    ...options
+  }) {
+    __publicField(this, "_logger");
+    __publicField(this, "_responsesBuilder");
+    __publicField(this, "_statuses");
+    __publicField(this, "_HTTPError");
+    __publicField(this, "_options");
+    this._logger = logger;
+    this._responsesBuilder = responsesBuilder;
+    this._statuses = statuses;
+    this._HTTPError = HTTPError;
+    this._options = deepAssignWithOverwrite(
+      {
+        showErrors: false,
+        response: {
+          message: "Unexpected error",
+          status: this._statuses("internal server error")
+        }
+      },
+      options
+    );
+  }
+  getMiddleware() {
+    return (err, _, res, next) => {
+      if (!err) {
+        next();
+        return;
+      }
+      const { response, showErrors } = this._options;
+      let { status } = response;
+      let data = {
+        error: true,
+        message: response.message
+      };
+      const knownError = err instanceof AppError;
+      if (showErrors || knownError) {
+        data.message = err.message;
+        if (knownError) {
+          data = {
+            ...data,
+            ...err.getResponse()
+          };
+          status = err.status || this._statuses("bad request");
+        }
+        if (showErrors && err instanceof Error && err.stack) {
+          const stack = err.stack.split("\n").map((line) => line.trim());
+          data.stack = stack;
+          stack.splice(0, 1);
+          this._logger.error(`ERROR: ${err.message}`);
+          this._logger.info(stack);
+        }
+      }
+      this._responsesBuilder.json({
+        res,
+        data,
+        status
+      });
+    };
+  }
+  get options() {
+    return deepAssignWithOverwrite({}, this._options);
+  }
+}
+const errorHandlerMiddleware = middlewareCreator(
+  (options = {}) => (app) => {
+    const showErrors = app.getConfig("debug.showErrors") === true;
+    return new ErrorHandler({
+      inject: {
+        logger: app.get("logger"),
+        responsesBuilder: app.get("responsesBuilder"),
+        statuses: app.get("statuses"),
+        HTTPError: app.get("HTTPError")
+      },
+      showErrors,
+      ...options
+    }).getMiddleware();
+  }
+);
+export {
+  ErrorHandler,
+  errorHandlerMiddleware
+};
+//# sourceMappingURL=errorHandler.js.map

package/dist/esm/middlewares/common/errorHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/middlewares/common/errorHandler.ts"],"sourcesContent":["import { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { middlewareCreator, type Statuses } from '../../utils';\nimport type { DeepPartial, Logger, ExpressErrorHandler } from '../../types';\nimport { AppError, type HTTPErrorClass, type ResponsesBuilder } from '../../services';\n/**\n * The options for the responses the middleware will create.\n *\n * @group Middlewares/ErrorHandler\n */\nexport type ErrorHandlerResponseOptions = {\n  /**\n   * The message to show in case `showErrors` is set to `false`.\n   *\n   * @default 'Oops! Something went wrong, please try again'\n   * @prettierignore\n   */\n  message: string;\n  /**\n   * The default status code for the responses.\n   *\n   * @default 500\n   */\n  status: number;\n};\n/**\n * The customization options for the middleware.\n *\n * @group Middlewares/ErrorHandler\n */\nexport type ErrorHandlerOptions = {\n  /**\n   * If `false`, unknown errors will show a generic message instead of real message. And\n   * if `true`, it will not only show all kind of errors but it will also show the error\n   * stack.\n   *\n   * By \"uknown errors\", it means that are not `AppError` nor `HTTPError`.\n   */\n  showErrors: boolean;\n  /**\n   * The options for the default response the middleware will create.\n   */\n  response: ErrorHandlerResponseOptions;\n};\n/**\n * A partial version of the {@link ErrorHandlerOptions}, to be used in the constructor and\n * the middleware creator.\n *\n * @group Middlewares/ErrorHandler\n */\nexport type ErrorHandlerPartialOptions = DeepPartial<ErrorHandlerOptions>;\n/**\n * The options to construct a {@link ErrorHandler}.\n *\n * @group Middlewares/ErrorHandler\n */\nexport type ErrorHandlerConstructorOptions = ErrorHandlerPartialOptions & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    logger: Logger;\n    responsesBuilder: ResponsesBuilder;\n    statuses: Statuses;\n    HTTPError: HTTPErrorClass;\n  };\n};\n/**\n * Creates a middleware that handles errors and generates the responses.\n *\n * @group Middleware Classes\n * @group Middlewares/ErrorHandler\n * @prettierignore\n */\nexport class ErrorHandler {\n  /**\n   * The service that will log the messages in the console.\n   */\n  protected readonly _logger: Logger;\n  /**\n   * The service to generate the responses.\n   */\n  protected readonly _responsesBuilder: ResponsesBuilder;\n  /**\n   * The uility service to get HTTP status codes.\n   */\n  protected readonly _statuses: Statuses;\n  /**\n   * The Error class used by the \"known errors\".\n   */\n  protected readonly _HTTPError: HTTPErrorClass;\n  /**\n   * The customization options.\n   */\n  protected readonly _options: ErrorHandlerOptions;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor({\n    inject: { logger, responsesBuilder, statuses, HTTPError },\n    ...options\n  }: ErrorHandlerConstructorOptions) {\n    this._logger = logger;\n    this._responsesBuilder = responsesBuilder;\n    this._statuses = statuses;\n    this._HTTPError = HTTPError;\n    this._options = deepAssignWithOverwrite(\n      {\n        showErrors: false,\n        response: {\n          message: 'Unexpected error',\n          status: this._statuses('internal server error'),\n        },\n      },\n      options,\n    );\n  }\n  /**\n   * Generates the middleware that handles the errors.\n   */\n  getMiddleware(): ExpressErrorHandler {\n    return (err, _, res, next) => {\n      // If there wasn't any error, continue the execution.\n      if (!err) {\n        next();\n        return;\n      }\n\n      const { response, showErrors } = this._options;\n\n      // Define the base status and response.\n      let { status } = response;\n      let data: {\n        error: boolean;\n        message: string;\n        stack?: string[];\n      } & Record<string, unknown> = {\n        error: true,\n        message: response.message,\n      };\n\n      const knownError = err instanceof AppError;\n      // If it's a \"known error\" or the `showErrors` flag is set to `true`...\n      if (showErrors || knownError) {\n        // Get the real message.\n        data.message = err.message;\n        // If it's a \"known error\"...\n        if (knownError) {\n          // Try to extract information for the response.\n          data = {\n            ...data,\n            ...err.getResponse(),\n          };\n          status = err.status || (this._statuses('bad request') as number);\n        }\n        /**\n         * If the flag is set to `true`, and it's a \"valid error\", try to extract the\n         * stack, format it, and include it in the response.\n         */\n        if (showErrors && err instanceof Error && err.stack) {\n          const stack = err.stack.split('\\n').map((line) => line.trim());\n          data.stack = stack;\n          stack.splice(0, 1);\n          this._logger.error(`ERROR: ${err.message}`);\n          this._logger.info(stack);\n        }\n      }\n\n      this._responsesBuilder.json({\n        res,\n        data,\n        status,\n      });\n    };\n  }\n  /**\n   * The handler customization options.\n   */\n  get options(): Readonly<ErrorHandlerOptions> {\n    return deepAssignWithOverwrite({}, this._options);\n  }\n}\n/**\n * Creates the middleware that handles errors.\n *\n * @group Middlewares\n * @group Middlewares/ErrorHandler\n */\nexport const errorHandlerMiddleware = middlewareCreator(\n  (options: ErrorHandlerPartialOptions = {}) =>\n    (app) => {\n      const showErrors = app.getConfig<boolean | undefined>('debug.showErrors') === true;\n      return new ErrorHandler({\n        inject: {\n          logger: app.get('logger'),\n          responsesBuilder: app.get('responsesBuilder'),\n          statuses: app.get('statuses'),\n          HTTPError: app.get('HTTPError'),\n        },\n        showErrors,\n        ...options,\n      }).getMiddleware();\n    },\n);\n"],"mappings":";;;AAAA,SAAS,+BAA+B;AACxC,SAAS,yBAAwC;AAEjD,SAAS,gBAA4D;AAsE9D,MAAM,aAAa;AAAA,EAwBxB,YAAY;AAAA,IACV,QAAQ,EAAE,QAAQ,kBAAkB,UAAU,UAAU;AAAA,OACrD;AAAA,EACL,GAAmC;AAvBnC,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAInB,wBAAmB;AAQjB,SAAK,UAAU;AACf,SAAK,oBAAoB;AACzB,SAAK,YAAY;AACjB,SAAK,aAAa;AAClB,SAAK,WAAW;AAAA,MACd;AAAA,QACE,YAAY;AAAA,QACZ,UAAU;AAAA,UACR,SAAS;AAAA,UACT,QAAQ,KAAK,UAAU,uBAAuB;AAAA,QAChD;AAAA,MACF;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAIA,gBAAqC;AACnC,WAAO,CAAC,KAAK,GAAG,KAAK,SAAS;AAE5B,UAAI,CAAC,KAAK;AACR,aAAK;AACL;AAAA,MACF;AAEA,YAAM,EAAE,UAAU,WAAW,IAAI,KAAK;AAGtC,UAAI,EAAE,OAAO,IAAI;AACjB,UAAI,OAI0B;AAAA,QAC5B,OAAO;AAAA,QACP,SAAS,SAAS;AAAA,MACpB;AAEA,YAAM,aAAa,eAAe;AAElC,UAAI,cAAc,YAAY;AAE5B,aAAK,UAAU,IAAI;AAEnB,YAAI,YAAY;AAEd,iBAAO;AAAA,YACL,GAAG;AAAA,YACH,GAAG,IAAI,YAAY;AAAA,UACrB;AACA,mBAAS,IAAI,UAAW,KAAK,UAAU,aAAa;AAAA,QACtD;AAKA,YAAI,cAAc,eAAe,SAAS,IAAI,OAAO;AACnD,gBAAM,QAAQ,IAAI,MAAM,MAAM,IAAI,EAAE,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC;AAC7D,eAAK,QAAQ;AACb,gBAAM,OAAO,GAAG,CAAC;AACjB,eAAK,QAAQ,MAAM,UAAU,IAAI,SAAS;AAC1C,eAAK,QAAQ,KAAK,KAAK;AAAA,QACzB;AAAA,MACF;AAEA,WAAK,kBAAkB,KAAK;AAAA,QAC1B;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAIA,IAAI,UAAyC;AAC3C,WAAO,wBAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AACF;AAOO,MAAM,yBAAyB;AAAA,EACpC,CAAC,UAAsC,CAAC,MACtC,CAAC,QAAQ;AACP,UAAM,aAAa,IAAI,UAA+B,kBAAkB,MAAM;AAC9E,WAAO,IAAI,aAAa;AAAA,MACtB,QAAQ;AAAA,QACN,QAAQ,IAAI,IAAI,QAAQ;AAAA,QACxB,kBAAkB,IAAI,IAAI,kBAAkB;AAAA,QAC5C,UAAU,IAAI,IAAI,UAAU;AAAA,QAC5B,WAAW,IAAI,IAAI,WAAW;AAAA,MAChC;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IACL,CAAC,EAAE,cAAc;AAAA,EACnB;AACJ;","names":[]}

package/dist/esm/middlewares/common/forceHTTPS.js

@@ -0,0 +1,41 @@
+import {
+  __publicField
+} from "../../chunk-T2T6Q22Z.js";
+import { middlewareCreator } from "../../utils";
+class ForceHTTPS {
+  constructor(options = {}) {
+    __publicField(this, "_options");
+    this._options = {
+      ignoredRoutes: [/^\/service\//],
+      ...options
+    };
+  }
+  getMiddleware() {
+    return (req, res, next) => {
+      if (!req.secure && req.get("X-Forwarded-Proto") !== "https" && !this._options.ignoredRoutes.some(
+        (expression) => expression.test(req.originalUrl)
+      )) {
+        const host = req.get("Host");
+        res.redirect(`https://${host}${req.url}`);
+      } else {
+        next();
+      }
+    };
+  }
+  get options() {
+    return { ...this._options };
+  }
+}
+const forceHTTPSMiddleware = middlewareCreator(
+  (options = {}) => (app) => {
+    const enabled = app.getConfig("forceHTTPS");
+    if (!enabled)
+      return void 0;
+    return new ForceHTTPS(options).getMiddleware();
+  }
+);
+export {
+  ForceHTTPS,
+  forceHTTPSMiddleware
+};
+//# sourceMappingURL=forceHTTPS.js.map

package/dist/esm/middlewares/common/forceHTTPS.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/middlewares/common/forceHTTPS.ts"],"sourcesContent":["import { middlewareCreator } from '../../utils';\nimport { ExpressMiddleware } from '../../types';\n/**\n * The customization options for the middleware.\n *\n * @group Middlewares/ForceHTTPS\n */\nexport type ForceHTTPSOptions = {\n  /**\n   * A list of regular expressions to match routes that should be ignored.\n   *\n   * @default [/^\\/service\\//]\n   */\n  ignoredRoutes: RegExp[];\n};\n/**\n * A partial version of the {@link ForceHTTPSOptions}, to be used in the constructor and\n * the middleware creator.\n *\n * @group Middlewares/ForceHTTPS\n */\nexport type ForceHTTPSPartialOptions = Partial<ForceHTTPSOptions>;\n/**\n * Creates a middleware that forces all the traffic to be through HTTPS.\n *\n * @group Middleware Classes\n * @group Middlewares/ForceHTTPS\n * @prettierignore\n */\nexport class ForceHTTPS {\n  /**\n   * The customization options.\n   */\n  protected readonly _options: ForceHTTPSOptions;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor(options: ForceHTTPSPartialOptions = {}) {\n    this._options = {\n      ignoredRoutes: [/^\\/service\\//],\n      ...options,\n    };\n  }\n  /**\n   * Generates the middleware that redirects the traffic.\n   */\n  getMiddleware(): ExpressMiddleware {\n    return (req, res, next) => {\n      if (\n        !req.secure &&\n        req.get('X-Forwarded-Proto') !== 'https' &&\n        !this._options.ignoredRoutes.some((expression) =>\n          expression.test(req.originalUrl),\n        )\n      ) {\n        const host = req.get('Host');\n        res.redirect(`https://${host}${req.url}`);\n      } else {\n        next();\n      }\n    };\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<ForceHTTPSOptions> {\n    return { ...this._options };\n  }\n}\n/**\n * Creates the middleware that redirects the traffic to HTTPS.\n *\n * @group Middlewares\n * @group Middlewares/ForceHTTPS\n */\nexport const forceHTTPSMiddleware = middlewareCreator(\n  (options: ForceHTTPSPartialOptions = {}) =>\n    (app) => {\n      const enabled = app.getConfig<boolean | undefined>('forceHTTPS');\n      if (!enabled) return undefined;\n      return new ForceHTTPS(options).getMiddleware();\n    },\n);\n"],"mappings":";;;AAAA,SAAS,yBAAyB;AA6B3B,MAAM,WAAW;AAAA,EAQtB,YAAY,UAAoC,CAAC,GAAG;AAJpD,wBAAmB;AAKjB,SAAK,WAAW;AAAA,MACd,eAAe,CAAC,cAAc;AAAA,MAC9B,GAAG;AAAA,IACL;AAAA,EACF;AAAA,EAIA,gBAAmC;AACjC,WAAO,CAAC,KAAK,KAAK,SAAS;AACzB,UACE,CAAC,IAAI,UACL,IAAI,IAAI,mBAAmB,MAAM,WACjC,CAAC,KAAK,SAAS,cAAc;AAAA,QAAK,CAAC,eACjC,WAAW,KAAK,IAAI,WAAW;AAAA,MACjC,GACA;AACA,cAAM,OAAO,IAAI,IAAI,MAAM;AAC3B,YAAI,SAAS,WAAW,OAAO,IAAI,KAAK;AAAA,MAC1C,OAAO;AACL,aAAK;AAAA,MACP;AAAA,IACF;AAAA,EACF;AAAA,EAIA,IAAI,UAAuC;AACzC,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AACF;AAOO,MAAM,uBAAuB;AAAA,EAClC,CAAC,UAAoC,CAAC,MACpC,CAAC,QAAQ;AACP,UAAM,UAAU,IAAI,UAA+B,YAAY;AAC/D,QAAI,CAAC;AAAS,aAAO;AACrB,WAAO,IAAI,WAAW,OAAO,EAAE,cAAc;AAAA,EAC/C;AACJ;","names":[]}

package/dist/esm/middlewares/common/hsts.js

@@ -0,0 +1,53 @@
+import {
+  __publicField
+} from "../../chunk-T2T6Q22Z.js";
+import { middlewareCreator } from "../../utils";
+class HSTS {
+  constructor(options = {}) {
+    __publicField(this, "_options");
+    __publicField(this, "_header");
+    this._options = {
+      maxAge: 31536e3,
+      includeSubDomains: true,
+      preload: false,
+      ...options
+    };
+    this._header = this._buildHeader();
+  }
+  getMiddleware() {
+    return (_, res, next) => {
+      res.setHeader("Strict-Transport-Security", this._header);
+      next();
+    };
+  }
+  get options() {
+    return { ...this._options };
+  }
+  get header() {
+    return this._header;
+  }
+  _buildHeader() {
+    const { maxAge, includeSubDomains, preload } = this._options;
+    const directives = [`max-age=${maxAge}`];
+    if (includeSubDomains) {
+      directives.push("includeSubDomains");
+    }
+    if (preload) {
+      directives.push("preload");
+    }
+    return directives.join("; ");
+  }
+}
+const hstsMiddleware = middlewareCreator(
+  (options = {}) => (app) => {
+    const setting = app.getConfig("hsts");
+    if (!setting?.enabled || typeof options.enabled !== "undefined" && !options.enabled)
+      return void 0;
+    return new HSTS(options).getMiddleware();
+  }
+);
+export {
+  HSTS,
+  hstsMiddleware
+};
+//# sourceMappingURL=hsts.js.map

package/dist/esm/middlewares/common/hsts.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/middlewares/common/hsts.ts"],"sourcesContent":["import { middlewareCreator } from '../../utils';\nimport { ExpressMiddleware } from '../../types';\n/**\n * The options to customize the HSTS header value.\n *\n * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security}\n * @group Middlewares/HSTS\n */\nexport type HSTSMiddlewareOptions = {\n  /**\n   * The time, in seconds, that the browser should remember that a site is only to be\n   * accessed using HTTPS.\n   *\n   * @default 31536000\n   */\n  maxAge: number;\n  /**\n   * Whether or not the rule should apply to all sub domains.\n   *\n   * @default true\n   */\n  includeSubDomains: boolean;\n  /**\n   * Whether or not to include on the major browsers'\n   * preload list. This directive is not part of the specification, for more information\n   * about it, you should check the MDN documentation for the header.\n   *\n   * @default false\n   */\n  preload: boolean;\n};\n/**\n * A partial version of the {@link HSTSMiddlewareOptions}, to be used in the constructor\n * and the middleware creator.\n *\n * @group Middlewares/HSTS\n */\nexport type HSTSMiddlewarePartialOptions = Partial<HSTSMiddlewareOptions>;\n/**\n * The options for the middleware creator that will create the middleware, or not,\n * depending on the `enabled` option.\n *\n * @group Middlewares/HSTS\n */\nexport type HSTSMiddlewareSettings = HSTSMiddlewarePartialOptions & {\n  /**\n   * If it's not `true`, it won't return the middleware.\n   */\n  enabled?: boolean;\n};\n/**\n * Generates a middleware that includes the HSTS header on the responses.\n *\n * @see {@link https://tools.ietf.org/html/rfc6797}\n * @group Middleware Classes\n * @group Middlewares/HSTS\n * @prettierignore\n */\nexport class HSTS {\n  /**\n   * The customization options for the header.\n   */\n  protected readonly _options: HSTSMiddlewareOptions;\n  /**\n   * The value of the header that will be included in the responses.\n   */\n  protected readonly _header: string;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor(options: HSTSMiddlewarePartialOptions = {}) {\n    this._options = {\n      maxAge: 31536000,\n      includeSubDomains: true,\n      preload: false,\n      ...options,\n    };\n    this._header = this._buildHeader();\n  }\n  /**\n   * Generates the middleware that includes the HSTS header on the responses.\n   */\n  getMiddleware(): ExpressMiddleware {\n    return (_, res, next) => {\n      res.setHeader('Strict-Transport-Security', this._header);\n      next();\n    };\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<HSTSMiddlewareOptions> {\n    return { ...this._options };\n  }\n  /**\n   * The value of the header that will be included in the responses.\n   */\n  get header(): string {\n    return this._header;\n  }\n  /**\n   * Creates the header value based on the customization options.\n   */\n  protected _buildHeader(): string {\n    const { maxAge, includeSubDomains, preload } = this._options;\n    const directives = [`max-age=${maxAge}`];\n    if (includeSubDomains) {\n      directives.push('includeSubDomains');\n    }\n\n    if (preload) {\n      directives.push('preload');\n    }\n\n    return directives.join('; ');\n  }\n}\n/**\n * Creates the middleware that includes the HSTS header on the responses.\n *\n * @group Middlewares\n * @group Middlewares/HSTS\n */\nexport const hstsMiddleware = middlewareCreator(\n  (options: HSTSMiddlewareSettings = {}) =>\n    (app) => {\n      const setting = app.getConfig<HSTSMiddlewareSettings | undefined>('hsts');\n      if (\n        !setting?.enabled ||\n        (typeof options.enabled !== 'undefined' && !options.enabled)\n      )\n        return undefined;\n      return new HSTS(options).getMiddleware();\n    },\n);\n"],"mappings":";;;AAAA,SAAS,yBAAyB;AA0D3B,MAAM,KAAK;AAAA,EAYhB,YAAY,UAAwC,CAAC,GAAG;AARxD,wBAAmB;AAInB,wBAAmB;AAKjB,SAAK,WAAW;AAAA,MACd,QAAQ;AAAA,MACR,mBAAmB;AAAA,MACnB,SAAS;AAAA,MACT,GAAG;AAAA,IACL;AACA,SAAK,UAAU,KAAK,aAAa;AAAA,EACnC;AAAA,EAIA,gBAAmC;AACjC,WAAO,CAAC,GAAG,KAAK,SAAS;AACvB,UAAI,UAAU,6BAA6B,KAAK,OAAO;AACvD,WAAK;AAAA,IACP;AAAA,EACF;AAAA,EAIA,IAAI,UAA2C;AAC7C,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AAAA,EAIA,IAAI,SAAiB;AACnB,WAAO,KAAK;AAAA,EACd;AAAA,EAIU,eAAuB;AAC/B,UAAM,EAAE,QAAQ,mBAAmB,QAAQ,IAAI,KAAK;AACpD,UAAM,aAAa,CAAC,WAAW,QAAQ;AACvC,QAAI,mBAAmB;AACrB,iBAAW,KAAK,mBAAmB;AAAA,IACrC;AAEA,QAAI,SAAS;AACX,iBAAW,KAAK,SAAS;AAAA,IAC3B;AAEA,WAAO,WAAW,KAAK,IAAI;AAAA,EAC7B;AACF;AAOO,MAAM,iBAAiB;AAAA,EAC5B,CAAC,UAAkC,CAAC,MAClC,CAAC,QAAQ;AACP,UAAM,UAAU,IAAI,UAA8C,MAAM;AACxE,QACE,CAAC,SAAS,WACT,OAAO,QAAQ,YAAY,eAAe,CAAC,QAAQ;AAEpD,aAAO;AACT,WAAO,IAAI,KAAK,OAAO,EAAE,cAAc;AAAA,EACzC;AACJ;","names":[]}

package/dist/esm/middlewares/common/index.js

@@ -0,0 +1,4 @@
+export * from "./errorHandler";
+export * from "./forceHTTPS";
+export * from "./hsts";
+//# sourceMappingURL=index.js.map

package/dist/esm/middlewares/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/middlewares/common/index.ts"],"sourcesContent":["export * from './errorHandler';\nexport * from './forceHTTPS';\nexport * from './hsts';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}

package/dist/esm/middlewares/html/fastHTML.js

@@ -0,0 +1,104 @@
+import {
+  __publicField
+} from "../../chunk-T2T6Q22Z.js";
+import { createRouteExpression, middlewareCreator, removeSlashes } from "../../utils";
+class FastHTML {
+  constructor({ inject, ...options }) {
+    __publicField(this, "_sendFile");
+    __publicField(this, "_events");
+    __publicField(this, "_getHTMLGenerator");
+    __publicField(this, "_options");
+    __publicField(this, "_fileReady", false);
+    __publicField(this, "_routeExpressions", []);
+    this._sendFile = inject.sendFile;
+    this._events = inject.events;
+    this._getHTMLGenerator = inject.getHTMLGenerator || (() => void 0);
+    this._options = {
+      file: "index.html",
+      ignoredRoutes: [/\.ico$/i],
+      useAppRoutes: true,
+      ...options
+    };
+    if (!this._options.ignoredRoutes.length && !this._options.useAppRoutes) {
+      throw new Error("You must provide either `ignoredRoutes` or `useAppRoutes`");
+    }
+    if (this._options.useAppRoutes) {
+      this._setupEvents();
+    }
+  }
+  getMiddleware() {
+    return async (req, res, next) => {
+      if (this._shouldIgnoreRoute(req.originalUrl)) {
+        next();
+        return;
+      }
+      if (this._fileReady) {
+        this._sendResponse(res, next);
+        return;
+      }
+      const htmlGenerator = this._getHTMLGenerator();
+      if (!htmlGenerator) {
+        this._fileReady = true;
+        this._sendResponse(res, next);
+        return;
+      }
+      try {
+        await htmlGenerator.whenReady();
+        this._options.file = htmlGenerator.options.file;
+        this._fileReady = true;
+        this._sendResponse(res, next);
+      } catch (error) {
+        next(error);
+      }
+    };
+  }
+  get options() {
+    return { ...this._options };
+  }
+  _sendResponse(res, next) {
+    res.setHeader("Content-Type", "text/html");
+    this._sendFile({
+      res,
+      next,
+      filepath: this._options.file
+    });
+  }
+  _setupEvents() {
+    this._events.once("afterStart", ({ app }) => {
+      const [routeExpressions] = app.routes.reduce(
+        (acc, route) => {
+          const [expressions, processed] = acc;
+          const clean = removeSlashes(route).trim();
+          if (!clean || processed.includes(clean))
+            return acc;
+          expressions.push(createRouteExpression(clean));
+          processed.push(clean);
+          return acc;
+        },
+        [[], []]
+      );
+      this._routeExpressions.push(...routeExpressions);
+    });
+  }
+  _shouldIgnoreRoute(route) {
+    return this._options.ignoredRoutes.some((expression) => route.match(expression)) || this._routeExpressions.some((expression) => route.match(expression));
+  }
+}
+const fastHTMLMiddleware = middlewareCreator(
+  (options = {}) => (app) => {
+    const { htmlGeneratorServiceName = "htmlGenerator", ...rest } = options;
+    return new FastHTML({
+      inject: {
+        events: app.get("events"),
+        sendFile: app.get("sendFile"),
+        getHTMLGenerator: () => app.try(htmlGeneratorServiceName)
+      },
+      ...rest
+    }).getMiddleware();
+  }
+);
+export {
+  FastHTML,
+  fastHTMLMiddleware
+};
+//# sourceMappingURL=fastHTML.js.map

package/dist/esm/middlewares/html/fastHTML.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/middlewares/html/fastHTML.ts"],"sourcesContent":["import { createRouteExpression, middlewareCreator, removeSlashes } from '../../utils';\nimport type { HTMLGenerator, SendFile } from '../../services';\nimport type { AsyncExpressMiddleware, Response, NextFunction, Events } from '../../types';\n/**\n * The options to customize the behavior of the middleware.\n *\n * @group Middlewares/FastHTML\n */\nexport type FastHTMLOptions = {\n  /**\n   * The name of the file the middleware will serve. If the {@link HTMLGenerator} service\n   * is available, it will be overriden by the service.\n   *\n   * @default 'index.html'\n   */\n  file: string;\n  /**\n   * A list of regular expressions to match request paths that should be ignored by the\n   * middleware.\n   *\n   * @default [/\\.ico$/i]\n   */\n  ignoredRoutes: RegExp[];\n  /**\n   * If `true`, {@link FastHTML} will get the list of all the routes controlled by the\n   * application, and will use them to validate the incoming requests (in addition to the\n   * `ignore` list): If a request URL doesn't match with any of the \"controlled routes\",\n   * it will serve the HTML file.\n   *\n   * @default true\n   */\n  useAppRoutes: boolean;\n};\n/**\n * The options to construct a {@link FastHTML}.\n *\n * @group Middlewares/FastHTML\n */\nexport type FastHTMLConstructorOptions = Partial<FastHTMLOptions> & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    sendFile: SendFile;\n    events: Events;\n    /**\n     * A function to get a possible {@link HTMLGenerator}. This is injected as a \"getter\"\n     * to not interrupt the DIC \"lifecycle\": middlewares are initialized right when the\n     * app starts, and injecting a reference would force the service to be initialized\n     * too, even if a request is not being made.\n     */\n    getHTMLGenerator?: () => HTMLGenerator | undefined;\n  };\n};\n/**\n * The options for the middleware creator that will mount an instance of {@link FastHTML}.\n *\n * @group Middlewares/FastHTML\n */\nexport type FastHTMLMiddlewareOptions = Partial<FastHTMLOptions> & {\n  /**\n   * The name of an {@link HTMLGenerator} service already available in the application.\n   *\n   * @default 'htmlGenerator'\n   */\n  htmlGeneratorServiceName?: string;\n};\n/**\n * It's common for an app to show an HTML view when no route was able to handle a request,\n * so the idea behind this middleware is to avoid going to every middleware and controller\n * and just specify that if the request is not for a route handled by a controller, just\n * serve the HTML and avoid processing unnecessary data.\n *\n * A simple example: The app has a route `/backend` that a frontend uses to get\n * information.\n * This middleware can be used to only allow the execution of middlewares and controllers\n * when the request route is for `/backend`.\n *\n * **Disclaimer**: Managing statics files with Express is not a best practice, but there\n * are scenarios where there is not other choice.\n *\n * @group Middleware Classes\n * @group Middlewares/FastHTML\n * @prettierignore\n */\nexport class FastHTML {\n  /**\n   * The service that serves a file.\n   */\n  protected readonly _sendFile: SendFile;\n  /**\n   * The application envent bus, to listen and get the list of \"controlled routes\" after\n   * the application is started.\n   */\n  protected readonly _events: Events;\n  /**\n   * A function to get a possible {@link HTMLGenerator}. This is injected as a \"getter\"\n   * to not interrupt the DIC \"lifecycle\": middlewares are initialized right when the\n   * app starts, and injecting a reference would force the service to be initialized\n   * too, even if a request is not being made.\n   */\n  protected readonly _getHTMLGenerator: () => HTMLGenerator | undefined;\n  /**\n   * The customization options for the middleware.\n   */\n  protected _options: FastHTMLOptions;\n  /**\n   * Whether or not the file is ready to be served. In case the middleware uses an\n   * {@link HTMLGenerator} service, the file needs to be generated before being available,\n   * and that's why this flag exists.\n   */\n  protected _fileReady: boolean = false;\n  /**\n   * A list of regular expression that match the routes controlled by the application.\n   * This is in case the `useAppRoutes` option is set to `true`; when the application gets\n   * started, an event listener will obtain all the top controlled routes, create regular\n   * expressions, and save them on this property.\n   */\n  protected _routeExpressions: RegExp[] = [];\n  /**\n   * @param options  The options to construct the class.\n   * @throws If `ignoredRoutes` is empty and `useAppRoutes` is set to `false`.\n   */\n  constructor({ inject, ...options }: FastHTMLConstructorOptions) {\n    this._sendFile = inject.sendFile;\n    this._events = inject.events;\n    this._getHTMLGenerator = inject.getHTMLGenerator || (() => undefined);\n    this._options = {\n      file: 'index.html',\n      ignoredRoutes: [/\\.ico$/i],\n      useAppRoutes: true,\n      ...options,\n    };\n\n    if (!this._options.ignoredRoutes.length && !this._options.useAppRoutes) {\n      throw new Error('You must provide either `ignoredRoutes` or `useAppRoutes`');\n    }\n\n    if (this._options.useAppRoutes) {\n      this._setupEvents();\n    }\n  }\n  /**\n   * Generates the middleware that serves the HTML file.\n   */\n  getMiddleware(): AsyncExpressMiddleware {\n    return async (req, res, next) => {\n      // If the route should be ignored, move to the next middleware.\n      if (this._shouldIgnoreRoute(req.originalUrl)) {\n        next();\n        return;\n      }\n\n      // If the file is ready to be served, serve it.\n      if (this._fileReady) {\n        this._sendResponse(res, next);\n        return;\n      }\n\n      const htmlGenerator = this._getHTMLGenerator();\n      // If there's no generator, switch the flag and just serve the file.\n      if (!htmlGenerator) {\n        this._fileReady = true;\n        this._sendResponse(res, next);\n        return;\n      }\n\n      try {\n        // Wait for the HTML to be generated.\n        await htmlGenerator.whenReady();\n        // Update the local option.\n        this._options.file = htmlGenerator.options.file;\n        // Switch the flag and serve the file.\n        this._fileReady = true;\n        this._sendResponse(res, next);\n      } catch (error) {\n        next(error);\n      }\n    };\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<FastHTMLOptions> {\n    return { ...this._options };\n  }\n  /**\n   * Serves the HTML file to the response.\n   *\n   * @param res   The response object generated by the application.\n   * @param next  The function to call the next middleware.\n   */\n  protected _sendResponse(res: Response, next: NextFunction): void {\n    res.setHeader('Content-Type', 'text/html');\n    this._sendFile({\n      res,\n      next,\n      filepath: this._options.file,\n    });\n  }\n  /**\n   * Adds the event listener that obtains the list of \"controlled routes\" when\n   * `useAppRoutes` is set to `true`.\n   */\n  protected _setupEvents() {\n    this._events.once('afterStart', ({ app }) => {\n      const [routeExpressions] = app.routes.reduce<[RegExp[], string[]]>(\n        (acc, route) => {\n          const [expressions, processed] = acc;\n          const clean = removeSlashes(route).trim();\n          if (!clean || processed.includes(clean)) return acc;\n          expressions.push(createRouteExpression(clean));\n          processed.push(clean);\n          return acc;\n        },\n        [[], []],\n      );\n      this._routeExpressions.push(...routeExpressions);\n    });\n  }\n  /**\n   * Validates whether a route should be ignored or not. The method checks first against\n   * the `ignore` option, and then against the list of \"controlled routes\" if\n   * `useAppRoutes` is set to `true`.\n   *\n   * @param route  The route to validate.\n   */\n  protected _shouldIgnoreRoute(route: string): boolean {\n    return (\n      this._options.ignoredRoutes.some((expression) => route.match(expression)) ||\n      this._routeExpressions.some((expression) => route.match(expression))\n    );\n  }\n}\n/**\n * Creates the middleware that filters the routes and serves an HTML before the\n * application gets to evaluate whether there's a controller for the request or not.\n *\n * @group Middlewares\n * @group Middlewares/FastHTML\n */\nexport const fastHTMLMiddleware = middlewareCreator(\n  (options: FastHTMLMiddlewareOptions = {}) =>\n    (app) => {\n      const { htmlGeneratorServiceName = 'htmlGenerator', ...rest } = options;\n      return new FastHTML({\n        inject: {\n          events: app.get('events'),\n          sendFile: app.get('sendFile'),\n          getHTMLGenerator: () => app.try(htmlGeneratorServiceName),\n        },\n        ...rest,\n      }).getMiddleware();\n    },\n);\n"],"mappings":";;;AAAA,SAAS,uBAAuB,mBAAmB,qBAAqB;AAqFjE,MAAM,SAAS;AAAA,EAsCpB,YAAY,EAAE,WAAW,QAAQ,GAA+B;AAlChE,wBAAmB;AAKnB,wBAAmB;AAOnB,wBAAmB;AAInB,wBAAU;AAMV,wBAAU,cAAsB;AAOhC,wBAAU,qBAA8B,CAAC;AAMvC,SAAK,YAAY,OAAO;AACxB,SAAK,UAAU,OAAO;AACtB,SAAK,oBAAoB,OAAO,qBAAqB,MAAM;AAC3D,SAAK,WAAW;AAAA,MACd,MAAM;AAAA,MACN,eAAe,CAAC,SAAS;AAAA,MACzB,cAAc;AAAA,MACd,GAAG;AAAA,IACL;AAEA,QAAI,CAAC,KAAK,SAAS,cAAc,UAAU,CAAC,KAAK,SAAS,cAAc;AACtE,YAAM,IAAI,MAAM,2DAA2D;AAAA,IAC7E;AAEA,QAAI,KAAK,SAAS,cAAc;AAC9B,WAAK,aAAa;AAAA,IACpB;AAAA,EACF;AAAA,EAIA,gBAAwC;AACtC,WAAO,OAAO,KAAK,KAAK,SAAS;AAE/B,UAAI,KAAK,mBAAmB,IAAI,WAAW,GAAG;AAC5C,aAAK;AACL;AAAA,MACF;AAGA,UAAI,KAAK,YAAY;AACnB,aAAK,cAAc,KAAK,IAAI;AAC5B;AAAA,MACF;AAEA,YAAM,gBAAgB,KAAK,kBAAkB;AAE7C,UAAI,CAAC,eAAe;AAClB,aAAK,aAAa;AAClB,aAAK,cAAc,KAAK,IAAI;AAC5B;AAAA,MACF;AAEA,UAAI;AAEF,cAAM,cAAc,UAAU;AAE9B,aAAK,SAAS,OAAO,cAAc,QAAQ;AAE3C,aAAK,aAAa;AAClB,aAAK,cAAc,KAAK,IAAI;AAAA,MAC9B,SAAS,OAAP;AACA,aAAK,KAAK;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAAA,EAIA,IAAI,UAAqC;AACvC,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AAAA,EAOU,cAAc,KAAe,MAA0B;AAC/D,QAAI,UAAU,gBAAgB,WAAW;AACzC,SAAK,UAAU;AAAA,MACb;AAAA,MACA;AAAA,MACA,UAAU,KAAK,SAAS;AAAA,IAC1B,CAAC;AAAA,EACH;AAAA,EAKU,eAAe;AACvB,SAAK,QAAQ,KAAK,cAAc,CAAC,EAAE,IAAI,MAAM;AAC3C,YAAM,CAAC,gBAAgB,IAAI,IAAI,OAAO;AAAA,QACpC,CAAC,KAAK,UAAU;AACd,gBAAM,CAAC,aAAa,SAAS,IAAI;AACjC,gBAAM,QAAQ,cAAc,KAAK,EAAE,KAAK;AACxC,cAAI,CAAC,SAAS,UAAU,SAAS,KAAK;AAAG,mBAAO;AAChD,sBAAY,KAAK,sBAAsB,KAAK,CAAC;AAC7C,oBAAU,KAAK,KAAK;AACpB,iBAAO;AAAA,QACT;AAAA,QACA,CAAC,CAAC,GAAG,CAAC,CAAC;AAAA,MACT;AACA,WAAK,kBAAkB,KAAK,GAAG,gBAAgB;AAAA,IACjD,CAAC;AAAA,EACH;AAAA,EAQU,mBAAmB,OAAwB;AACnD,WACE,KAAK,SAAS,cAAc,KAAK,CAAC,eAAe,MAAM,MAAM,UAAU,CAAC,KACxE,KAAK,kBAAkB,KAAK,CAAC,eAAe,MAAM,MAAM,UAAU,CAAC;AAAA,EAEvE;AACF;AAQO,MAAM,qBAAqB;AAAA,EAChC,CAAC,UAAqC,CAAC,MACrC,CAAC,QAAQ;AACP,UAAM,EAAE,2BAA2B,oBAAoB,KAAK,IAAI;AAChE,WAAO,IAAI,SAAS;AAAA,MAClB,QAAQ;AAAA,QACN,QAAQ,IAAI,IAAI,QAAQ;AAAA,QACxB,UAAU,IAAI,IAAI,UAAU;AAAA,QAC5B,kBAAkB,MAAM,IAAI,IAAI,wBAAwB;AAAA,MAC1D;AAAA,MACA,GAAG;AAAA,IACL,CAAC,EAAE,cAAc;AAAA,EACnB;AACJ;","names":[]}

package/dist/esm/middlewares/html/index.js

@@ -0,0 +1,3 @@
+export * from "./fastHTML";
+export * from "./showHTML";
+//# sourceMappingURL=index.js.map

package/dist/esm/middlewares/html/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/middlewares/html/index.ts"],"sourcesContent":["export * from './fastHTML';\nexport * from './showHTML';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;","names":[]}

package/dist/esm/middlewares/html/showHTML.js

@@ -0,0 +1,68 @@
+import {
+  __publicField
+} from "../../chunk-T2T6Q22Z.js";
+import { middlewareCreator } from "../../utils";
+class ShowHTML {
+  constructor({ inject, ...options }) {
+    __publicField(this, "_sendFile");
+    __publicField(this, "_getHTMLGenerator");
+    __publicField(this, "_options");
+    __publicField(this, "_fileReady", false);
+    this._sendFile = inject.sendFile;
+    this._getHTMLGenerator = inject.getHTMLGenerator || (() => void 0);
+    this._options = {
+      file: "index.html",
+      ...options
+    };
+  }
+  getMiddleware() {
+    return async (_, res, next) => {
+      if (this._fileReady) {
+        this._sendResponse(res, next);
+        return;
+      }
+      const htmlGenerator = this._getHTMLGenerator();
+      if (!htmlGenerator) {
+        this._fileReady = true;
+        this._sendResponse(res, next);
+        return;
+      }
+      try {
+        await htmlGenerator.whenReady();
+        this._options.file = htmlGenerator.options.file;
+        this._fileReady = true;
+        this._sendResponse(res, next);
+      } catch (error) {
+        next(error);
+      }
+    };
+  }
+  get options() {
+    return { ...this._options };
+  }
+  _sendResponse(res, next) {
+    res.setHeader("Content-Type", "text/html");
+    this._sendFile({
+      res,
+      next,
+      filepath: this._options.file
+    });
+  }
+}
+const showHTMLMiddleware = middlewareCreator(
+  (options = {}) => (app) => {
+    const { htmlGeneratorServiceName = "htmlGenerator", ...rest } = options;
+    return new ShowHTML({
+      inject: {
+        sendFile: app.get("sendFile"),
+        getHTMLGenerator: () => app.try(htmlGeneratorServiceName)
+      },
+      ...rest
+    }).getMiddleware();
+  }
+);
+export {
+  ShowHTML,
+  showHTMLMiddleware
+};
+//# sourceMappingURL=showHTML.js.map

package/dist/esm/middlewares/html/showHTML.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/middlewares/html/showHTML.ts"],"sourcesContent":["import { middlewareCreator } from '../../utils';\nimport type { HTMLGenerator, SendFile } from '../../services';\nimport type { AsyncExpressMiddleware, Response, NextFunction } from '../../types';\n/**\n * The options to customize the behavior of the middleware.\n *\n * @group Middlewares/ShowHTML\n */\nexport type ShowHTMLOptions = {\n  /**\n   * The name of the file the middleware will serve. If the {@link HTMLGenerator} service\n   * is available, it will be overriden by the service.\n   *\n   * @default 'index.html'\n   */\n  file: string;\n};\n/**\n * The options to construct a {@link ShowHTML}.\n *\n * @group Middlewares/ShowHTML\n */\nexport type ShowHTMLConstructorOptions = Partial<ShowHTMLOptions> & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    sendFile: SendFile;\n    /**\n     * A function to get a possible {@link HTMLGenerator}. This is injected as a \"getter\"\n     * to not interrupt the DIC \"lifecycle\": middlewares are initialized right when the\n     * app starts, and injecting a reference would force the service to be initialized\n     * too, even if a request is not being made.\n     */\n    getHTMLGenerator?: () => HTMLGenerator | undefined;\n  };\n};\n/**\n * The options for the middleware creator that will mount an instance of {@link ShowHTML}.\n *\n * @group Middlewares/ShowHTML\n */\nexport type ShowHTMLMiddlewareOptions = Partial<ShowHTMLOptions> & {\n  /**\n   * The name of an {@link HTMLGenerator} service already available in the application.\n   *\n   * @default 'htmlGenerator'\n   */\n  htmlGeneratorServiceName?: string;\n};\n\n/**\n * A very simple middleware service to send an HTML on a server response. The special\n * _'feature'_ of this service is that it can be hooked up to an {@link HTMLGenerator}\n * service and it will automatically server the file generated by it.\n *\n * @group Middleware Classes\n * @group Middlewares/ShowHTML\n * @prettierignore\n */\nexport class ShowHTML {\n  /**\n   * The service that serves a file.\n   */\n  protected readonly _sendFile: SendFile;\n  /**\n   * A function to get a possible {@link HTMLGenerator}. This is injected as a \"getter\"\n   * to not interrupt the DIC \"lifecycle\": middlewares are initialized right when the\n   * app starts, and injecting a reference would force the service to be initialized\n   * too, even if a request is not being made.\n   */\n  protected readonly _getHTMLGenerator: () => HTMLGenerator | undefined;\n  /**\n   * The customization options for the middleware.\n   */\n  protected _options: ShowHTMLOptions;\n  /**\n   * Whether or not the file is ready to be served. In case the middleware uses an\n   * {@link HTMLGenerator} service, the file needs to be generated before being available,\n   * and that's why this flag exists.\n   */\n  protected _fileReady: boolean = false;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor({ inject, ...options }: ShowHTMLConstructorOptions) {\n    this._sendFile = inject.sendFile;\n    this._getHTMLGenerator = inject.getHTMLGenerator || (() => undefined);\n    this._options = {\n      file: 'index.html',\n      ...options,\n    };\n  }\n  /**\n   * Generates the middleware that serves the HTML file.\n   */\n  getMiddleware(): AsyncExpressMiddleware {\n    return async (_, res, next) => {\n      // If the file is ready to be served, serve it.\n      if (this._fileReady) {\n        this._sendResponse(res, next);\n        return;\n      }\n\n      const htmlGenerator = this._getHTMLGenerator();\n      // If there's no generator, switch the flag and just serve the file.\n      if (!htmlGenerator) {\n        this._fileReady = true;\n        this._sendResponse(res, next);\n        return;\n      }\n\n      try {\n        // Wait for the HTML to be generated.\n        await htmlGenerator.whenReady();\n        // Update the local option.\n        this._options.file = htmlGenerator.options.file;\n        // Switch the flag and serve the file.\n        this._fileReady = true;\n        this._sendResponse(res, next);\n      } catch (error) {\n        next(error);\n      }\n    };\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<ShowHTMLOptions> {\n    return { ...this._options };\n  }\n  /**\n   * Serves the HTML file to the response.\n   *\n   * @param res   The response object generated by the application.\n   * @param next  The function to call the next middleware.\n   */\n  protected _sendResponse(res: Response, next: NextFunction): void {\n    res.setHeader('Content-Type', 'text/html');\n    this._sendFile({\n      res,\n      next,\n      filepath: this._options.file,\n    });\n  }\n}\n/**\n * Creates the middleware that serves an HTML file in the response.\n *\n * @group Middlewares\n * @group Middlewares/ShowHTML\n */\nexport const showHTMLMiddleware = middlewareCreator(\n  (options: ShowHTMLMiddlewareOptions = {}) =>\n    (app) => {\n      const { htmlGeneratorServiceName = 'htmlGenerator', ...rest } = options;\n      return new ShowHTML({\n        inject: {\n          sendFile: app.get('sendFile'),\n          getHTMLGenerator: () => app.try(htmlGeneratorServiceName),\n        },\n        ...rest,\n      }).getMiddleware();\n    },\n);\n"],"mappings":";;;AAAA,SAAS,yBAAyB;AA4D3B,MAAM,SAAS;AAAA,EAyBpB,YAAY,EAAE,WAAW,QAAQ,GAA+B;AArBhE,wBAAmB;AAOnB,wBAAmB;AAInB,wBAAU;AAMV,wBAAU,cAAsB;AAK9B,SAAK,YAAY,OAAO;AACxB,SAAK,oBAAoB,OAAO,qBAAqB,MAAM;AAC3D,SAAK,WAAW;AAAA,MACd,MAAM;AAAA,MACN,GAAG;AAAA,IACL;AAAA,EACF;AAAA,EAIA,gBAAwC;AACtC,WAAO,OAAO,GAAG,KAAK,SAAS;AAE7B,UAAI,KAAK,YAAY;AACnB,aAAK,cAAc,KAAK,IAAI;AAC5B;AAAA,MACF;AAEA,YAAM,gBAAgB,KAAK,kBAAkB;AAE7C,UAAI,CAAC,eAAe;AAClB,aAAK,aAAa;AAClB,aAAK,cAAc,KAAK,IAAI;AAC5B;AAAA,MACF;AAEA,UAAI;AAEF,cAAM,cAAc,UAAU;AAE9B,aAAK,SAAS,OAAO,cAAc,QAAQ;AAE3C,aAAK,aAAa;AAClB,aAAK,cAAc,KAAK,IAAI;AAAA,MAC9B,SAAS,OAAP;AACA,aAAK,KAAK;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAAA,EAIA,IAAI,UAAqC;AACvC,WAAO,EAAE,GAAG,KAAK,SAAS;AAAA,EAC5B;AAAA,EAOU,cAAc,KAAe,MAA0B;AAC/D,QAAI,UAAU,gBAAgB,WAAW;AACzC,SAAK,UAAU;AAAA,MACb;AAAA,MACA;AAAA,MACA,UAAU,KAAK,SAAS;AAAA,IAC1B,CAAC;AAAA,EACH;AACF;AAOO,MAAM,qBAAqB;AAAA,EAChC,CAAC,UAAqC,CAAC,MACrC,CAAC,QAAQ;AACP,UAAM,EAAE,2BAA2B,oBAAoB,KAAK,IAAI;AAChE,WAAO,IAAI,SAAS;AAAA,MAClB,QAAQ;AAAA,QACN,UAAU,IAAI,IAAI,UAAU;AAAA,QAC5B,kBAAkB,MAAM,IAAI,IAAI,wBAAwB;AAAA,MAC1D;AAAA,MACA,GAAG;AAAA,IACL,CAAC,EAAE,cAAc;AAAA,EACnB;AACJ;","names":[]}

package/dist/esm/middlewares/index.js

@@ -0,0 +1,4 @@
+export * from "./common";
+export * from "./html";
+export * from "./utils";
+//# sourceMappingURL=index.js.map

package/dist/esm/middlewares/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/middlewares/index.ts"],"sourcesContent":["export * from './common';\nexport * from './html';\nexport * from './utils';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}

package/dist/esm/middlewares/utils/index.js

@@ -0,0 +1,2 @@
+export * from "./versionValidator";
+//# sourceMappingURL=index.js.map

package/dist/esm/middlewares/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/middlewares/utils/index.ts"],"sourcesContent":["export * from './versionValidator';\n"],"mappings":"AAAA,cAAc;","names":[]}