Class GatewayController

A utility controller that generates routes that act as a gateway for a specific API.

Prettierignore

Constructors

constructor

new GatewayController(options): GatewayController
Parameters
- options: GatewayControllerConstructorOptions
  The options to construct the controller.
Returns GatewayController
- Defined in src/controllers/utils/gateway.ts:548

Properties

`Protected` `Readonly` _apiConfigEndpoints

_apiConfigEndpoints: EndpointsDict

The generated endpoints for the API client configuration the controller can generate.

`Protected` `Readonly` _apiConfigUrl

_apiConfigUrl: string

The entry URL for the API client configuration the controller can generate.

`Protected` `Readonly` _endpoints

_endpoints: Record<string, GatewayConfigEndpointDefinition>

A flat dictionary with the endpoints information.

`Protected` `Readonly` _gatewayConfig

_gatewayConfig: GatewayConfig

The information, url and endpoints, for the gateway the controller will make requests to.

`Protected` `Readonly` _getHelperService

_getHelperService: (() => undefined | Partial<{
    handleEndpointError: GatewayHelperServiceErrorHandler;
    handleEndpointResponse: GatewayHelperServiceResponseHandler;
    reduceEndpointRequest: GatewayHelperServiceRequestReducer;
    reduceEndpointResponse: GatewayHelperServiceResponseReducer;
    shouldStreamEndpointResponse: GatewayHelperServiceStreamVerification;
}>)

A function to get a possible helper service. This is injected as a "getter" to not interrupt the DIC "lifecycle": controllers are initialized right when the app starts, and injecting a reference would force the service to be initialized too, even if a request is not being made.

Type declaration

- (): undefined | Partial<{
      handleEndpointError: GatewayHelperServiceErrorHandler;
      handleEndpointResponse: GatewayHelperServiceResponseHandler;
      reduceEndpointRequest: GatewayHelperServiceRequestReducer;
      reduceEndpointResponse: GatewayHelperServiceResponseReducer;
      shouldStreamEndpointResponse: GatewayHelperServiceStreamVerification;
  }>
- Returns undefined | Partial<{
      handleEndpointError: GatewayHelperServiceErrorHandler;
      handleEndpointResponse: GatewayHelperServiceResponseHandler;
      reduceEndpointRequest: GatewayHelperServiceRequestReducer;
      reduceEndpointResponse: GatewayHelperServiceResponseReducer;
      shouldStreamEndpointResponse: GatewayHelperServiceStreamVerification;
  }>

`Protected` `Readonly` _options

_options: GatewayControllerExtraOptions

The controller customization options.

`Protected` `Readonly` _route

_route: string

The route in which the controller is mounted.

`Protected` `Readonly` _routeExpression

_routeExpression: RegExp

A regular expression that will be used to remove the controller route from a request path. This will allow the main middleware to extract the path to where the request should be made.

`Protected` `Readonly` _routes

_routes: GatewayControllerRoute[]

The list of routes the controller can handle.

`Protected` `Readonly` http

http: HTTP

The service that makes HTTP requests.

Accessors

gatewayConfig

get gatewayConfig(): Readonly<GatewayConfig>
The configuration for the gateway the controller will make requests to.

Returns Readonly<GatewayConfig>
- Defined in src/controllers/utils/gateway.ts:646

options

get options(): Readonly<GatewayControllerExtraOptions>
The customization options.

Returns Readonly<GatewayControllerExtraOptions>
- Defined in src/controllers/utils/gateway.ts:640

Methods

`Protected` _addRoute

_addRoute(options): void
Mounts the middleware(s) for an endpoint in the router.
Parameters
- options: AddGatewayRouteOptions
  The information of the endpoint and how it needs to be added.
Returns void
- Defined in src/controllers/utils/gateway.ts:782

`Protected` _createAPIConfig

_createAPIConfig(): GatewayControllerAPIConfig
Creates the API client configuration based on the controller routes.

Returns GatewayControllerAPIConfig
- Defined in src/controllers/utils/gateway.ts:1023

`Protected` _createGatewayMiddleware

_createGatewayMiddleware(endpoint): AsyncExpressMiddleware
Generates a middleware that will make the request to an endpoint and stream the response.
Parameters
- endpoint: GatewayControllerEndpointInfo
  The information of the endpoint the middleware will handle.
Returns AsyncExpressMiddleware
- Defined in src/controllers/utils/gateway.ts:655

`Protected` _createRoutes

_createRoutes(): GatewayControllerRoute[]
Based on the information from the endpoints, this method will create the routes the controller will later add on a router.

Returns GatewayControllerRoute[]
Throws
If there's more than one endpoint using the same path with the same HTTP method.
- Defined in src/controllers/utils/gateway.ts:810

`Protected` _formatEndpoints

_formatEndpoints(): Record<string, GatewayConfigEndpointDefinition>
Formats the endpoints for the gateway into a flat dictionary without nesting.

Returns Record<string, GatewayConfigEndpointDefinition>
- Defined in src/controllers/utils/gateway.ts:794

`Protected` _formatOptions

_formatOptions(options): GatewayControllerExtraOptions
Validates and formats the customization options sent to the controller.
Parameters
- options: GatewayControllerExtraOptions
  The options sent to the constructor.
Returns GatewayControllerExtraOptions
- Defined in src/controllers/utils/gateway.ts:988

`Protected` _handleEndpointError

_handleEndpointError(options): void
This is a "proxy method" to call the helper service's function that handles an error on an endpoint request.

The reason this is a "proxy method" is in case the controller gets subclassed and "used itself as a helper" instead of relying on a difference one.

If the helper doesn't implement handleEndpointError, it will just send the error to the next middleware/error handler.
Parameters
- options: GatewayControllerHelperOptions<GatewayHelperServiceErrorHandlerOptions>
  The information of the response and the reference to the helper.
Returns void
- Defined in src/controllers/utils/gateway.ts:973

`Protected` _handleEndpointResponse

_handleEndpointResponse(options): Promise<void>
This is a "proxy method" to call the helper service's function that handles a response in case it already said that a response shouldn't be streamed.

The reason this is a "proxy method" is in case the controller gets subclassed and "used itself as a helper" instead of relying on a difference one.

If the helper doesn't implement shouldStreamEndpointResponse, it will throw an error.
Parameters
- options: GatewayControllerHelperOptions<GatewayHelperServiceResponseReducerOptions>
  The information of the response and the reference to the helper.
Returns Promise<void>
Throws
If the helper doesn't implement handleEndpointResponse.
- Defined in src/controllers/utils/gateway.ts:951

`Protected` _reduceEndpointRequest

_reduceEndpointRequest(options): Promise<GatewayControllerRequest>
This is a "proxy method" to call the helper service's function that can modify an endpoint request before it gets made.

The reason this is a "proxy method" is in case the controller gets subclassed and "used itself as a helper" instead of relying on a difference one.

If the helper doesn't implement reduceEndpointRequest, it will just return information for the request.
Parameters
- options: GatewayControllerHelperOptions<GatewayHelperServiceRequestReducerOptions>
  The information of the request and the reference to the helper.
Returns Promise<GatewayControllerRequest>
- Defined in src/controllers/utils/gateway.ts:884

`Protected` _reduceEndpointResponse

_reduceEndpointResponse(options): Promise<Response>
This is a "proxy method" to call the helper service's function that can modify an endpoint response before it gets processed.

The reason this is a "proxy method" is in case the controller gets subclassed and "used itself as a helper" instead of relying on a difference one.

If the helper doesn't implement reduceEndpointResponse, it will just return information for the response.
Parameters
- options: GatewayControllerHelperOptions<GatewayHelperServiceResponseReducerOptions>
  The information of the response and the reference to the helper.
Returns Promise<Response>
- Defined in src/controllers/utils/gateway.ts:906

`Protected` _shouldStreamEndpointResponse

_shouldStreamEndpointResponse(options): Promise<boolean>
This is a "proxy method" to call the helper service's function that can decide if an endpoint response should be streamed or not.

The reason this is a "proxy method" is in case the controller gets subclassed and "used itself as a helper" instead of relying on a difference one.

If the helper doesn't implement shouldStreamEndpointResponse, it will just return true.
Parameters
- options: GatewayControllerHelperOptions<GatewayHelperServiceResponseReducerOptions>
  The information of the response and the reference to the helper.
Returns Promise<boolean>
- Defined in src/controllers/utils/gateway.ts:928

`Protected` _validateHTTPMethod

_validateHTTPMethod(method): RouterMethod
Validates a router/HTTP method that the controller intends to use for an endpoint. If it's not valid, it will return all.
Parameters
- method: string
  The HTTP method for the endpoint.
Returns RouterMethod
- Defined in src/controllers/utils/gateway.ts:1004

addRoutes

addRoutes(router, middlewares?): Router
Mounts the middlewares in the router in order to make the requests.
Parameters
- router: Router
  A reference to the application router.
- middlewares: ExpressMiddleware[] = []
  A list of extra middlewares to execute before the gateway middleware.
Returns Router
- Defined in src/controllers/utils/gateway.ts:622

getAPIConfig

getAPIConfig(options?): Readonly<GatewayControllerAPIConfig>
Generates an API client configuration based on the controller routes.
Parameters
- options: GatewayControllerAPIConfigOptions = {}
  The options to customize the generated configuration.
Returns Readonly<GatewayControllerAPIConfig>
- Defined in src/controllers/utils/gateway.ts:592

Class GatewayController

Prettierignore

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GatewayController

Properties

Protected Readonly _apiConfigEndpoints

Protected Readonly _apiConfigUrl

Protected Readonly _endpoints

Protected Readonly _gatewayConfig

Protected Readonly _getHelperService

Type declaration

Protected Readonly _options

Protected Readonly _route

Protected Readonly _routeExpression

Protected Readonly _routes

Protected Readonly http

Accessors

gatewayConfig

Returns Readonly<GatewayConfig>

options

Returns Readonly<GatewayControllerExtraOptions>

Methods

Protected _addRoute

Parameters

Returns void

Protected _createAPIConfig

Returns GatewayControllerAPIConfig

Protected _createGatewayMiddleware

Parameters

Returns AsyncExpressMiddleware

Protected _createRoutes

Returns GatewayControllerRoute[]

Throws

Protected _formatEndpoints

Returns Record<string, GatewayConfigEndpointDefinition>

Protected _formatOptions

Parameters

Returns GatewayControllerExtraOptions

Protected _handleEndpointError

Parameters

Returns void

Protected _handleEndpointResponse

Parameters

Returns Promise<void>

Throws

Protected _reduceEndpointRequest

Parameters

Returns Promise<GatewayControllerRequest>

Protected _reduceEndpointResponse

Parameters

Returns Promise<Response>

Protected _shouldStreamEndpointResponse

Parameters

Returns Promise<boolean>

Protected _validateHTTPMethod

Parameters

Returns RouterMethod

addRoutes

Parameters

Returns Router

getAPIConfig

Parameters

Returns Readonly<GatewayControllerAPIConfig>

Settings

Member Visibility

Theme

On This Page

`Protected` `Readonly` _apiConfigEndpoints

`Protected` `Readonly` _apiConfigUrl

`Protected` `Readonly` _endpoints

`Protected` `Readonly` _gatewayConfig

`Protected` `Readonly` _getHelperService

`Protected` `Readonly` _options

`Protected` `Readonly` _route

`Protected` `Readonly` _routeExpression

`Protected` `Readonly` _routes

`Protected` `Readonly` http

`Protected` _addRoute

`Protected` _createAPIConfig

`Protected` _createGatewayMiddleware

`Protected` _createRoutes

`Protected` _formatEndpoints

`Protected` _formatOptions

`Protected` _handleEndpointError

`Protected` _handleEndpointResponse

`Protected` _reduceEndpointRequest

`Protected` _reduceEndpointResponse

`Protected` _shouldStreamEndpointResponse

`Protected` _validateHTTPMethod