Runs the Whook's process
Prepare the Whook process environment
stringPick the first header value if exists
ArrayPick header values
Promise.<Object>Application monitoring service that simply log stringified contents.
Promise.<Number>Initialize the AVAILABLE_PORT service
Promise.<String>Initialize the BASE_PATH service.
Promise.<String>Initialize the BASE_URL service according to the HOST/PORT so that applications fallbacks to that default base URL.
Promise.<Number>Initialize the schema validator service for application schemas validation. This central place is aimed to compile schemas once and use them many times.
Promise.<Object>Initialize the COMMANDS service gathering the project commands.
Promise.<function()>Initialize the Whook command handlers to know which command to run for a given command name.
Promise.<function()>A simple passthrough service proxying the COMMANDS_WRAPPERS.
Promise.<Object>Initialize the CONSUMERS_DECLARATIONS service gathering the project consumers.
Promise.<function()>Initialize the Whook consumer handlers to know which consumer to run for a given consumer name.
Promise.<function()>A simple passthrough service proxying the CONSUMERS_WRAPPERS.
Promise.<Object>Initialize the CRONS_DECLARATIONS service gathering the project crons.
Promise.<function()>Initialize the Whook cron handlers used to know which cron to run for a given cron name.
Promise.<function()>A simple passthrough service proxying the CRONS_WRAPPERS.
Promise.<String>Initialize the DEFINITIONS service.
PromiseInitialize an error handler for the HTTP router
Promise.<String>Initialize the HOST service from ENV or auto-detection if none specified in ENV
PromiseInitialize an HTTP router
Promise.<HTTPServer>Initialize an HTTP server
Promise.<HTTPSServer>Initialize an HTTPS server
Promise.<WhookHTTPTransaction>Instantiate the httpTransaction service
Promise.<String>Initialize the INTERNAL_IP service
Promise.<function()>An initializer to build a single Whook handler.
Promise.<Object>Obfuscate sensible information.
Promise.<Number>Initialize the PORT service from ENV
Promise.<Object>Wrap the ENV service in order to filter ENV vars for the build
Promise.<Object>Initialize the ROUTES_DECLARATIONS service gathering the project routes definitions.
Promise.<function()>Initialize the Whook routes handlers used by the router to know which handler to run for a given route.
Promise.<function()>A simple passthrough service proxying the ROUTES_WRAPPERS.
Promise.<Number>Initialize the schema validator service for application schemas validation. This central place is aimed to compile schemas once and use them many times.
Promise.<SSLCertificates>Initialize an SSL certificate service
Promise.<Object>Initialize the TRANSFORMERS_DECLARATIONS service gathering the project transformers.
Promise.<function()>Initialize the Whook transformer handlers to know which transformer to run for a given transformer name.
Promise.<function()>A simple passthrough service proxying the TRANSFORMERS_WRAPPERS.
Promise.<string>Resolves the Whook plugins from their names
Promise.<Object>Initialize the WRAPPERS_DECLARATIONS service gathering the project wrappers.
Array.<String> | Root dependencies names to instanciate and return |
| $ | Knifecycle | The Knifecycle instance to use for the run |
## prepareEnvironment($) ⇒
Prepare the Whook process environment
**Kind**: global function
**Returns**: PromiseKnifecycle | The Knifecycle instance to set the various services |
## pickFirstHeaderValue(name, headers) ⇒ string
Pick the first header value if exists
**Kind**: global function
**Returns**: string - The value if defined.
| Param | Type | Description |
| --- | --- | --- |
| name | string | The header name |
| headers | Object | The headers map |
## pickAllHeaderValues(name, headers) ⇒ Array
Pick header values
**Kind**: global function
**Returns**: Array - The values in an array.
| Param | Type | Description |
| --- | --- | --- |
| name | string | The header name |
| headers | Object | The headers map |
## initAPM(services) ⇒ Promise.<Object>
Application monitoring service that simply log stringified contents.
**Kind**: global function
**Returns**: Promise.<Object> - A promise of the apm service.
| Param | Type | Description |
| --- | --- | --- |
| services | Object | The services to inject |
| [services.log] | function | A logging function |
## initAvailablePort(services) ⇒ Promise.<Number>
Initialize the AVAILABLE_PORT service
**Kind**: global function
**Returns**: Promise.<Number> - A promise of a number representing the available port.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.log] | Object | noop | An optional logging service |
| services.importer | Object | | A service allowing to dynamically import ES modules |
## initBasePath(services) ⇒ Promise.<String>
Initialize the BASE_PATH service.
**Kind**: global function
**Returns**: Promise.<String> - A promise of a containing the actual host.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| services.ENV | Object | | The process environment |
| services.CONFIG | Object | | The injected CONFIG value |
| [services.log] | function | noop | An optional logging service |
## initBaseURL(services) ⇒ Promise.<String>
Initialize the BASE_URL service according to the HOST/PORT
so that applications fallbacks to that default base URL.
**Kind**: global function
**Returns**: Promise.<String> - A promise of a containing the actual host.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| services.ENV | Object | | The process environment |
| services.CONFIG | Object | | The injected CONFIG value |
| [services.PROTOCOL] | Object | | The injected PROTOCOL value |
| services.HOST | Object | | The injected HOST value |
| services.PORT | Object | | The injected PORT value |
| [services.log] | function | noop | An optional logging service |
## initSchemaValidators(services) ⇒ Promise.<Number>
Initialize the schema validator service for
application schemas validation. This central
place is aimed to compile schemas once and
use them many times.
**Kind**: global function
**Returns**: Promise.<Number> - A promise of a schema validators registry
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.SCHEMA_VALIDATORS_OPTIONS] | Object | {} | Options for the schema validators registry |
| [services.ENV] | Object | {} | An optional environment object |
| [services.log] | function | noop | An optional logging service |
| services.API | Object | | A valid Open API file |
## initCommands(services) ⇒ Promise.<Object>
Initialize the COMMANDS service gathering the project commands.
**Kind**: global function
**Returns**: Promise.<Object> - A promise of a containing the actual host.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.WHOOK_PLUGINS] | Array.<String> | | The activated plugins |
| services.WHOOK_RESOLVED_PLUGINS | Array | | The resolved plugins |
| [services.DECLARATIONS_OPTIONS] | Object | | The options to load the project commands |
| [services.COMMAND_DEFINITION_FILTER] | Object | | A function to filter the project commands per definitions |
| services.importer | Object | | A service allowing to dynamically import ES modules |
| [services.log] | function | noop | An optional logging service |
## initCommandsHandlers(services) ⇒ Promise.<function()>
Initialize the Whook command handlers to know which
command to run for a given command name.
**Kind**: global function
**Returns**: Promise.<function()> - A promise of the `COMMANDS_HANDLERS` hash.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.DEFINITIONS] | Array | | The definitions that declares wrappers to wrap the commands with |
| [services.COMMANDS_WRAPPERS_ORDER] | Array | | An optional array to choose wrappers application order |
| services.COMMANDS_WRAPPERS | Array | | An optional list of wrappers to inject |
| [services.log] | function | noop | An optional logging service |
| services.COMMANDS_HANDLERS | Object | | The rest is a hash of commands handlers mapped by name |
## initCommandsWrappers(services) ⇒ Promise.<function()>
A simple passthrough service proxying the COMMANDS_WRAPPERS.
**Kind**: global function
**Returns**: Promise.<function()> - A promise of the `COMMANDS_WRAPPERS` hash.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.DEFINITIONS] | Array | | The definitions that declares wrappers to wrap the commands with |
| [services.log] | function | noop | An optional logging service |
| services.COMMANDS_WRAPPERS | Object | | The dependencies must all be injected wrappers |
## initConsumersDefinitions(services) ⇒ Promise.<Object>
Initialize the CONSUMERS_DECLARATIONS service gathering the project consumers.
**Kind**: global function
**Returns**: Promise.<Object> - A promise of a containing the actual host.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.WHOOK_PLUGINS] | Array.<String> | | The activated plugins |
| services.WHOOK_RESOLVED_PLUGINS | Array | | The resolved plugins |
| [services.DECLARATIONS_OPTIONS] | Object | | The options to load the project files |
| [services.CONSUMER_DEFINITION_FILTER] | Object | | A function to filter the project consumers per definitions |
| services.importer | Object | | A service allowing to dynamically import ES modules |
| [services.log] | function | noop | An optional logging service |
## initConsumersHandlers(services) ⇒ Promise.<function()>
Initialize the Whook consumer handlers to know which
consumer to run for a given consumer name.
**Kind**: global function
**Returns**: Promise.<function()> - A promise of the `CONSUMERS_HANDLERS` hash.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.DEFINITIONS] | Array | | The definitions that declares wrappers to wrap the consumers with |
| [services.CONSUMERS_WRAPPERS_ORDER] | Array | | An optional array to choose wrappers application order |
| services.CONSUMERS_WRAPPERS | Array | | An optional list of wrappers to inject |
| [services.log] | function | noop | An optional logging service |
| services.CONSUMERS_HANDLERS | Object | | The rest is a hash of consumers handlers mapped by name |
## initConsumersWrappers(services) ⇒ Promise.<function()>
A simple passthrough service proxying the CONSUMERS_WRAPPERS.
**Kind**: global function
**Returns**: Promise.<function()> - A promise of the `CONSUMERS_WRAPPERS` hash.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.DEFINITIONS] | Array | | The definitions that declares wrappers to wrap the consumers with |
| [services.log] | function | noop | An optional logging service |
| services.CONSUMERS_WRAPPERS | Object | | The dependencies must all be injected wrappers |
## initCronsDefinitions(services) ⇒ Promise.<Object>
Initialize the CRONS_DECLARATIONS service gathering the project crons.
**Kind**: global function
**Returns**: Promise.<Object> - A promise of a containing the actual host.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.WHOOK_PLUGINS] | Array.<String> | | The activated plugins |
| services.WHOOK_RESOLVED_PLUGINS | Array | | The resolved plugins |
| [services.DECLARATIONS_OPTIONS] | Object | | The options to load the project files |
| [services.CRON_DEFINITION_FILTER] | Object | | A function to filter the project crons per definitions |
| services.importer | Object | | A service allowing to dynamically import ES modules |
| [services.log] | function | noop | An optional logging service |
## initCronsHandlers(services) ⇒ Promise.<function()>
Initialize the Whook cron handlers used to know which
cron to run for a given cron name.
**Kind**: global function
**Returns**: Promise.<function()> - A promise of the `CRONS_HANDLERS` hash.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.DEFINITIONS] | Array | | The definitions that declares wrappers to wrap the crons with |
| [services.CRONS_WRAPPERS_ORDER] | Array | | An optional array to choose wrappers application order |
| services.CRONS_WRAPPERS | Array | | An optional list of wrappers to inject |
| [services.log] | function | noop | An optional logging service |
| services.CRONS_HANDLERS | Object | | The rest is a hash of crons handlers mapped by name |
## initCronsWrappers(services) ⇒ Promise.<function()>
A simple passthrough service proxying the CRONS_WRAPPERS.
**Kind**: global function
**Returns**: Promise.<function()> - A promise of the `CRONS_WRAPPERS` hash.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.DEFINITIONS] | Array | | The definitions that declares wrappers to wrap the crons with |
| [services.log] | function | noop | An optional logging service |
| services.CRONS_WRAPPERS | Object | | The dependencies must all be injected wrappers |
## initDefinitions(services) ⇒ Promise.<String>
Initialize the DEFINITIONS service.
**Kind**: global function
**Returns**: Promise.<String> - A promise of a containing the actual host.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.ROUTES_DECLARATIONS] | Object | | The API routes declarations |
| [services.COMMANDS_DECLARATIONS] | Object | | The commands declarations |
| [services.CRONS_DECLARATIONS] | Object | | The crons declarations |
| [services.CONSUMERS_DECLARATIONS] | Object | | The consumers declarations |
| [services.TRANSFORMERS_DECLARATIONS] | Object | | The transformers declarations |
| [services.WRAPPERS_DECLARATIONS] | Object | | The wrappers declarations |
| [services.SECURITY_DEFINITIONS] | Object | | The security definitions |
| [services.log] | function | noop | An optional logging service |
## initErrorHandler(services) ⇒ Promise
Initialize an error handler for the
HTTP router
**Kind**: global function
**Returns**: Promise - A promise of a function to handle errors
| Param | Type | Description |
| --- | --- | --- |
| services | Object | The service dependencies |
| services.ENV | Object | The app ENV |
| [services.DEBUG_NODE_ENVS] | Array | The environnement that activate debugging (prints stack trace in HTTP errors responses) |
| [services.STRINGIFIERS] | Object | The synchronous body stringifiers |
| [services.ERRORS_DESCRIPTORS] | Object | An hash of the various error descriptors |
| [services.DEFAULT_ERROR_CODE] | Object | A string giving the default error code |
### initErrorHandler~errorHandler(transactionId, responseSpec, err) ⇒ Promise
Handle an HTTP transaction error and
map it to a serializable response
**Kind**: inner method of [initErrorHandler](#initErrorHandler)
**Returns**: Promise - A promise resolving when the operation
completes
| Param | Type | Description |
| --- | --- | --- |
| transactionId | String | A raw NodeJS HTTP incoming message |
| responseSpec | Object | The response specification |
| err | YHTTPError | The encountered error |
## initHost(services) ⇒ Promise.<String>
Initialize the HOST service from ENV or auto-detection if
none specified in ENV
**Kind**: global function
**Returns**: Promise.<String> - A promise of a containing the actual host.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.ENV] | Object | {} | An optional environment object |
| [services.log] | function | noop | An optional logging service |
## initHTTPRouter(services) ⇒ Promise
Initialize an HTTP router
**Kind**: global function
**Returns**: Promise - A promise of a function to handle HTTP requests.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.BUFFER_LIMIT] | String | | The maximum bufferisation before parsing the request body |
| services.ROUTES_HANDLERS | Object | | The handlers for the operations describe by the OpenAPI API definition |
| services.API | Object | | The OpenAPI definition of the API |
| [services.PARSERS] | Object | | The synchronous body parsers (for operations that defines a request body schema) |
| [services.STRINGIFIERS] | Object | | The synchronous body stringifiers (for operations that defines a response body schema) |
| [services.ENCODERS] | Object | | A map of encoder stream constructors |
| [services.DECODERS] | Object | | A map of decoder stream constructors |
| [services.queryParserBuilder] | Object | | A query parser builder from OpenAPI parameters |
| [services.COERCION_OPTIONS] | Object | | Options for type coercion of parameters values |
| [services.log] | function | noop | A logging function |
| services.httpTransaction | function | | A function to create a new HTTP transaction |
### initHTTPRouter~httpRouter(req, res) ⇒ Promise
Handle an HTTP incoming message
**Kind**: inner method of [initHTTPRouter](#initHTTPRouter)
**Returns**: Promise - A promise resolving when the operation
completes
| Param | Type | Description |
| --- | --- | --- |
| req | HTTPRequest | A raw NodeJS HTTP incoming message |
| res | HTTPResponse | A raw NodeJS HTTP response |
## initHTTPServer(services) ⇒ [Promise.<HTTPServer>](#HTTPServer)
Initialize an HTTP server
**Kind**: global function
**Returns**: [Promise.<HTTPServer>](#HTTPServer) - A promise of an object with a NodeJS HTTP server
in its `service` property.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.ENV] | Object | | The process environment variables |
| services.ENV.DESTROY_SOCKETS | String | | Whether the server sockets would be destroyed or if the server should wait while sockets are kept alive |
| [services.HTTP_SERVER_OPTIONS] | Object | | See https://nodejs.org/docs/latest/api/http.html#class-httpserver |
| services.HOST | String | | The server host |
| services.PORT | Number | | The server port |
| services.httpRouter | function | | The function to run with the req/res tuple |
| [services.log] | function | noop | A logging function |
## initHTTPSServer(services) ⇒ [Promise.<HTTPSServer>](#HTTPSServer)
Initialize an HTTPS server
**Kind**: global function
**Returns**: [Promise.<HTTPSServer>](#HTTPSServer) - A promise of an object with a NodeJS HTTPS server
in its `service` property.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.ENV] | Object | | The process environment variables |
| services.ENV.DESTROY_SOCKETS | String | | Whether the server sockets would be destroyed or if the server should wait while sockets are kept alive |
| [services.SSL_CERTIFICATES] | Object | | An object containing the SSL certificates |
| [services.HTTPS_SERVER_OPTIONS] | Object | | See https://nodejs.org/docs/latest/api/http.html#class-httpserver |
| services.HOST | String | | The server host |
| services.PORT | Number | | The server port |
| services.httpRouter | function | | The function to run with the req/res tuple |
| [services.log] | function | noop | A logging function |
## initHTTPTransaction(services) ⇒ [Promise.<WhookHTTPTransaction>](#WhookHTTPTransaction)
Instantiate the httpTransaction service
**Kind**: global function
**Returns**: [Promise.<WhookHTTPTransaction>](#WhookHTTPTransaction) - A promise of the httpTransaction function
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.TIMEOUT] | Number | 30000 | A number indicating how many ms the transaction should take to complete before being cancelled. |
| [services.TRANSACTIONS] | Object | {} | A hash of every current transactions |
| services.delay | Object | | A delaying service |
| services.obfuscator | Object | | A service to avoid logging sensible information |
| [services.log] | function | | A logging function |
| [services.apm] | function | | An apm function |
| [services.time] | function | | A timing function |
| [services.uniqueId] | function | | A function returning unique identifiers |
**Example**
```js
import initHTTPTransaction from '@whook/whook';
import { log } from 'node:console';
const httpTransaction = await initHTTPTransaction({
log,
time: Date.now.bind(Date),
});
```
### initHTTPTransaction~httpTransaction(req, res) ⇒ Array
Create a new HTTP transaction
**Kind**: inner method of [initHTTPTransaction](#initHTTPTransaction)
**Returns**: Array - The normalized request and the HTTP
transaction created in an array.
| Param | Type | Description |
| --- | --- | --- |
| req | HTTPRequest | A raw NodeJS HTTP incoming message |
| res | HTTPResponse | A raw NodeJS HTTP response |
## initInternalIP(services) ⇒ Promise.<String>
Initialize the INTERNAL_IP service
**Kind**: global function
**Returns**: Promise.<String> - A promise of containing the actual internal IP.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.log] | Object | noop | An optional logging service |
| services.importer | Object | | A service allowing to dynamically import ES modules |
## initMainHandler(services) ⇒ Promise.<function()>
An initializer to build a single Whook handler.
**Kind**: global function
**Returns**: Promise.<function()> - A promise of the `MAIN_HANDLER` service.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.DEFINITIONS] | Array | | The definitions that declares wrappers to wrap the handler with |
| services.MAIN_DEFINITION | Object | | A definition for that handler |
| [services.MAIN_WRAPPERS_ORDER] | Array | | An optional array to choose wrappers application order |
| services.MAIN_WRAPPERS | Array | | An optional list of wrappers to inject |
| services.MAIN_WRAPPER | function | | The main handler wrapper |
| services.BASE_HANDLER | function | | The base handler |
| [services.log] | function | noop | An optional logging service |
## initObfuscator(services) ⇒ Promise.<Object>
Obfuscate sensible information.
**Kind**: global function
**Returns**: Promise.<Object> - A promise of an object containing the gathered constants.
| Param | Type | Description |
| --- | --- | --- |
| services | Object | The service dependencies |
| [services.SHIELD_CHAR] | Object | The char for replacing sensible information |
| [services.MAX_CLEAR_CHARS] | Object | The maximum clear chars to display |
| [services.MAX_CLEAR_RATIO] | Object | The maximum clear chars ratio to display |
| [services.SENSIBLE_PROPS] | Object | Sensible properties names |
| [services.SENSIBLE_HEADERS] | Object | Sensible headers names |
**Example**
```js
import { initObfuscator } from '@whook/whook';
import { alsoInject } from 'knifecycle';
import { log } from 'node:console';
const obfuscator = await initObfuscator();
log(obfuscator('my very secret information!));
// my ...on!
```
## initPort(services) ⇒ Promise.<Number>
Initialize the PORT service from ENV
**Kind**: global function
**Returns**: Promise.<Number> - A promise of a number representing the actual port.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.ENV] | Object | {} | An optional environment object |
| [services.log] | function | noop | An optional logging service |
## wrapEnvForBuild(services) ⇒ Promise.<Object>
Wrap the ENV service in order to filter ENV vars for the build
**Kind**: global function
**Returns**: Promise.<Object> - A promise of an object containing the reshaped env vars.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.PROXIED_ENV_VARS] | Object | {} | A list of environment variable names to proxy |
| [services.log] | function | noop | An optional logging service |
## initRoutesDeclarations(services) ⇒ Promise.<Object>
Initialize the ROUTES_DECLARATIONS service gathering
the project routes definitions.
**Kind**: global function
**Returns**: Promise.<Object> - A promise of a containing the actual host.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| services.APP_ENV | String | | The application environment name |
| services.BASE_PATH | String | | The API base path |
| [services.WHOOK_PLUGINS] | Array.<String> | | The activated plugins |
| services.WHOOK_RESOLVED_PLUGINS | Array | | The resolved plugins |
| [services.DECLARATIONS_OPTIONS] | Object | | The options to load the files |
| [services.ROUTE_DEFINITION_FILTER] | Object | | A function to filter the routes per definitions |
| services.importer | Object | | A service allowing to dynamically import ES modules |
| [services.log] | function | noop | An optional logging service |
## initRoutesHandlers(services) ⇒ Promise.<function()>
Initialize the Whook routes handlers used by the router
to know which handler to run for a given route.
**Kind**: global function
**Returns**: Promise.<function()> - A promise of the `ROUTES_HANDLERS` hash.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.DEFINITIONS] | Array | | The definitions that declares wrappers to wrap the routes with |
| [services.ROUTES_WRAPPERS_ORDER] | Array | | An optional array to choose wrappers application order |
| services.ROUTES_WRAPPERS | Array | | An optional list of wrappers to inject |
| [services.log] | function | noop | An optional logging service |
| services.ROUTES_HANDLERS | Object | | The rest is a hash of routesHandlers mapped by their operation id |
## initRoutesWrappers(services) ⇒ Promise.<function()>
A simple passthrough service proxying the ROUTES_WRAPPERS.
**Kind**: global function
**Returns**: Promise.<function()> - A promise of the `ROUTES_WRAPPERS` hash.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.DEFINITIONS] | Array | | The definitions that declares wrappers to wrap the routes with |
| [services.log] | function | noop | An optional logging service |
| services.ROUTES_WRAPPERS | Object | | The dependencies must all be injected wrappers |
## initSchemaValidators(services) ⇒ Promise.<Number>
Initialize the schema validator service for
application schemas validation. This central
place is aimed to compile schemas once and
use them many times.
**Kind**: global function
**Returns**: Promise.<Number> - A promise of a schema validators registry
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.SCHEMA_VALIDATORS_OPTIONS] | Object | {} | Options for the schema validators registry |
| [services.ENV] | Object | {} | An optional environment object |
| [services.log] | function | noop | An optional logging service |
| services.API | Object | | A valid Open API file |
## initSSLCertificates(services) ⇒ Promise.<SSLCertificates>
Initialize an SSL certificate service
**Kind**: global function
**Returns**: Promise.<SSLCertificates> - A promise of an object with certificates contents.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.ENV] | Object | | The process environment variables |
| [services.log] | function | noop | A logging function |
## initTransformersDeclarations(services) ⇒ Promise.<Object>
Initialize the TRANSFORMERS_DECLARATIONS service gathering the project transformers.
**Kind**: global function
**Returns**: Promise.<Object> - A promise of a containing the actual host.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.WHOOK_PLUGINS] | Array.<String> | | The activated plugins |
| services.WHOOK_RESOLVED_PLUGINS | Array | | The resolved plugins |
| [services.DECLARATIONS_OPTIONS] | Object | | The options to load the project files |
| [services.TRANSFORMER_DEFINITION_FILTER] | Object | | A function to filter the project transformers per definitions |
| services.importer | Object | | A service allowing to dynamically import ES modules |
| [services.log] | function | noop | An optional logging service |
## initTransformersHandlers(services) ⇒ Promise.<function()>
Initialize the Whook transformer handlers to know which
transformer to run for a given transformer name.
**Kind**: global function
**Returns**: Promise.<function()> - A promise of the `TRANSFORMERS_HANDLERS` hash.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| services.TRANSFORMERS_WRAPPERS | Array | | An optional list of wrappers to inject |
| [services.TRANSFORMERS_WRAPPERS_ORDER] | Array | | An optional array to choose wrappers application order |
| [services.log] | function | noop | An optional logging service |
| services.TRANSFORMERS_HANDLERS | Object | | The rest is a hash of transformers handlers mapped by name |
## initTransformersWrappers(services) ⇒ Promise.<function()>
A simple passthrough service proxying the TRANSFORMERS_WRAPPERS.
**Kind**: global function
**Returns**: Promise.<function()> - A promise of the `TRANSFORMERS_WRAPPERS` hash.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| services.DEFINITIONS | Array | | The definitions that declares wrappers to wrap the transformers with |
| [services.log] | function | noop | An optional logging service |
| services.TRANSFORMERS_WRAPPERS | Object | | The dependencies must all be injected wrappers |
## initWhookResolvedPlugins(services) ⇒ Promise.<string>
Resolves the Whook plugins from their names
**Kind**: global function
**Returns**: Promise.<string> - A promise of a number representing the actual port.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.WHOOK_PLUGINS] | Array.<String> | | The activated plugins |
| [services.log] | function | noop | An optional logging service |
## initWrappersDeclarations(services) ⇒ Promise.<Object>
Initialize the WRAPPERS_DECLARATIONS service gathering the project wrappers.
**Kind**: global function
**Returns**: Promise.<Object> - A promise of a containing the actual host.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| services | Object | | The service dependencies |
| [services.WHOOK_PLUGINS] | Array.<String> | | The activated plugins |
| services.WHOOK_RESOLVED_PLUGINS | Array | | The resolved plugins |
| [services.DECLARATIONS_OPTIONS] | Object | | The options to load the project wrappers |
| [services.WRAPPER_DEFINITION_FILTER] | Object | | A function to filter the project wrappers per definitions |
| services.importer | Object | | A service allowing to dynamically import ES modules |
| [services.log] | function | noop | An optional logging service |
## HTTPServer
**Kind**: global typedef
## HTTPSServer
**Kind**: global typedef
## WhookHTTPTransaction
**Kind**: global typedef
* [WhookHTTPTransaction](#WhookHTTPTransaction)
* [.id](#WhookHTTPTransaction.id)
* [.start](#WhookHTTPTransaction.start) ⇒ Promise.<Object>
* [.catch](#WhookHTTPTransaction.catch) ⇒ Promise
* [.end](#WhookHTTPTransaction.end) ⇒ Promise.<Object>
### WhookHTTPTransaction.id
Id of the transaction
**Kind**: static property of [WhookHTTPTransaction](#WhookHTTPTransaction)
### WhookHTTPTransaction.start ⇒ Promise.<Object>
Start the transaction
**Kind**: static property of [WhookHTTPTransaction](#WhookHTTPTransaction)
**Returns**: Promise.<Object> - A promise to be resolved with the signed token.
| Param | Type | Description |
| --- | --- | --- |
| buildResponse | function | A function that builds a response |
### WhookHTTPTransaction.catch ⇒ Promise
Catch a transaction error
**Kind**: static property of [WhookHTTPTransaction](#WhookHTTPTransaction)
**Returns**: Promise - A promise to be resolved with the signed token.
| Param | Type | Description |
| --- | --- | --- |
| err | Error | A function that builds a response |
### WhookHTTPTransaction.end ⇒ Promise.<Object>
End the transaction
**Kind**: static property of [WhookHTTPTransaction](#WhookHTTPTransaction)
**Returns**: Promise.<Object> - A promise to be resolved with the signed token.
| Param | Type | Description |
| --- | --- | --- |
| response | Object | A response for the transaction |
# Authors
- [Nicolas Froidure](http://insertafter.com/en/index.html)
# License
[MIT](https://github.com/nfroidure/whook/blob/main/packages/whook-whook/LICENSE)
---
_Source: https://npm.io/package/@whook/whook · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._