@rapidrest/service-core 1.0.0-rc.7 → 1.0.0

package/docs/reference/classes/HttpRouter.md

@@ -1,343 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / HttpRouter
-
-# Class: HttpRouter
-
-Defined in: [src/http/Router.ts:222](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L222)
-
-Thin Express-compatible wrapper over `uWS.TemplatedApp`.
-
-Provides the same `app.get()`, `app.post()`, `app.use()`, etc. API that
-`RouteUtils.registerRoute()` uses, so no changes are needed in route registration
-code. Global middleware registered via `use()` is prepended to every route's chain.
-
-Also supports:
-- `ws(path, handlers)` — native uWS WebSocket routing
-- `static(basePath)` — basic static file serving
-- `listen(host, port)` / `close()` — server lifecycle
-
-## Indexable
-
-> \[`key`: `string`\]: `any`
-
-## Constructors
-
-### Constructor
-
-> **new HttpRouter**(`uwsApp`): `HttpRouter`
-
-Defined in: [src/http/Router.ts:234](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L234)
-
-#### Parameters
-
-##### uwsApp
-
-`TemplatedApp`
-
-#### Returns
-
-`HttpRouter`
-
-## Properties
-
-### listenPort
-
-> **listenPort**: `number` = `0`
-
-Defined in: [src/http/Router.ts:232](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L232)
-
-The port the server is currently listening on (set after a successful `listen()` call).
-
-## Accessors
-
-### isListening
-
-#### Get Signature
-
-> **get** **isListening**(): `boolean`
-
-Defined in: [src/http/Router.ts:239](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L239)
-
-Returns `true` if the server is currently listening.
-
-##### Returns
-
-`boolean`
-
-## Methods
-
-### close()
-
-> **close**(): `void`
-
-Defined in: [src/http/Router.ts:479](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L479)
-
-Closes the listen socket, stopping the server from accepting new connections.
-
-#### Returns
-
-`void`
-
-***
-
-### delete()
-
-> **delete**(`routePath`, ...`handlers`): `this`
-
-Defined in: [src/http/Router.ts:283](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L283)
-
-#### Parameters
-
-##### routePath
-
-`string`
-
-##### handlers
-
-...[`RequestHandler`](../type-aliases/RequestHandler.md)[]
-
-#### Returns
-
-`this`
-
-***
-
-### get()
-
-> **get**(`routePath`, ...`handlers`): `this`
-
-Defined in: [src/http/Router.ts:265](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L265)
-
-#### Parameters
-
-##### routePath
-
-`string`
-
-##### handlers
-
-...[`RequestHandler`](../type-aliases/RequestHandler.md)[]
-
-#### Returns
-
-`this`
-
-***
-
-### head()
-
-> **head**(`routePath`, ...`handlers`): `this`
-
-Defined in: [src/http/Router.ts:295](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L295)
-
-#### Parameters
-
-##### routePath
-
-`string`
-
-##### handlers
-
-...[`RequestHandler`](../type-aliases/RequestHandler.md)[]
-
-#### Returns
-
-`this`
-
-***
-
-### listen()
-
-> **listen**(`host`, `port`): `Promise`\<`void`\>
-
-Defined in: [src/http/Router.ts:458](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L458)
-
-Starts listening on the given host and port.
-Resolves when the server is ready; rejects if the port cannot be bound.
-
-#### Parameters
-
-##### host
-
-`string`
-
-##### port
-
-`number`
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### options()
-
-> **options**(`routePath`, ...`handlers`): `this`
-
-Defined in: [src/http/Router.ts:302](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L302)
-
-#### Parameters
-
-##### routePath
-
-`string`
-
-##### handlers
-
-...[`RequestHandler`](../type-aliases/RequestHandler.md)[]
-
-#### Returns
-
-`this`
-
-***
-
-### patch()
-
-> **patch**(`routePath`, ...`handlers`): `this`
-
-Defined in: [src/http/Router.ts:289](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L289)
-
-#### Parameters
-
-##### routePath
-
-`string`
-
-##### handlers
-
-...[`RequestHandler`](../type-aliases/RequestHandler.md)[]
-
-#### Returns
-
-`this`
-
-***
-
-### post()
-
-> **post**(`routePath`, ...`handlers`): `this`
-
-Defined in: [src/http/Router.ts:271](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L271)
-
-#### Parameters
-
-##### routePath
-
-`string`
-
-##### handlers
-
-...[`RequestHandler`](../type-aliases/RequestHandler.md)[]
-
-#### Returns
-
-`this`
-
-***
-
-### put()
-
-> **put**(`routePath`, ...`handlers`): `this`
-
-Defined in: [src/http/Router.ts:277](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L277)
-
-#### Parameters
-
-##### routePath
-
-`string`
-
-##### handlers
-
-...[`RequestHandler`](../type-aliases/RequestHandler.md)[]
-
-#### Returns
-
-`this`
-
-***
-
-### static()
-
-> **static**(`basePath`): `this`
-
-Defined in: [src/http/Router.ts:428](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L428)
-
-Serves static files from a directory via a wildcard GET route.
-Files not found on disk return 404.
-
-#### Parameters
-
-##### basePath
-
-`string`
-
-#### Returns
-
-`this`
-
-***
-
-### use()
-
-> **use**(...`handlers`): `this`
-
-Defined in: [src/http/Router.ts:244](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L244)
-
-Register global middleware that runs before every route handler.
-
-#### Parameters
-
-##### handlers
-
-...[`RequestHandler`](../type-aliases/RequestHandler.md)[]
-
-#### Returns
-
-`this`
-
-***
-
-### ws()
-
-> **ws**(`routePath`, `handlers`, `wsOptions?`, `upgradeAuth?`): `this`
-
-Defined in: [src/http/Router.ts:320](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/http/Router.ts#L320)
-
-Registers a WebSocket route. Handlers follow the same `(req, res, next)` pattern
-as HTTP routes; they receive `req.websocket` containing the uWS WebSocket handle.
-
-`upgradeAuth` is an optional pre-upgrade auth function. When provided it runs synchronously
-inside the uWS `upgrade` callback before the handshake. If it returns `{ reject: true }`,
-an HTTP 401 is sent and the upgrade is aborted. If it returns `{ user, ... }`, those
-credentials are attached to the request so downstream middleware sees an authenticated user.
-If it returns `{}`, auth falls through to the post-upgrade message-based LOGIN flow.
-
-Both `path` and `path + "/"` are registered to avoid trailing-slash mismatch.
-
-#### Parameters
-
-##### routePath
-
-`string`
-
-##### handlers
-
-[`RequestHandler`](../type-aliases/RequestHandler.md)[]
-
-##### wsOptions?
-
-`Partial`\<`WebSocketBehavior`\<`any`\>\>
-
-##### upgradeAuth?
-
-[`WsUpgradeAuth`](../type-aliases/WsUpgradeAuth.md)
-
-#### Returns
-
-`this`

package/docs/reference/classes/JWTStrategy.md

@@ -1,100 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / JWTStrategy
-
-# Class: JWTStrategy
-
-Defined in: [src/auth/JWTStrategy.ts:63](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/JWTStrategy.ts#L63)
-
-JWT authentication strategy. Performs JWT verification and searches for a token by one of the
-following methods (in order of precedence):
-* Query Parameter
-* Authorization Header
-* Cookie
-
-This class no longer extends `passport-strategy`; it is used directly by route middleware
-and returns a plain result object instead of calling Passport callbacks.
-
-## Author
-
-Jean-Philippe Steinmetz
-
-## Constructors
-
-### Constructor
-
-> **new JWTStrategy**(`options?`): `JWTStrategy`
-
-Defined in: [src/auth/JWTStrategy.ts:72](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/JWTStrategy.ts#L72)
-
-#### Parameters
-
-##### options?
-
-[`JWTStrategyOptions`](JWTStrategyOptions.md) = `...`
-
-#### Returns
-
-`JWTStrategy`
-
-## Properties
-
-### name
-
-> `readonly` **name**: `string` = `"jwt"`
-
-Defined in: [src/auth/JWTStrategy.ts:67](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/JWTStrategy.ts#L67)
-
-## Methods
-
-### authenticate()
-
-> **authenticate**(`req`, `res`, `required?`): `Promise`\<[`JWTAuthResult`](../interfaces/JWTAuthResult.md) \| `undefined`\>
-
-Defined in: [src/auth/JWTStrategy.ts:136](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/JWTStrategy.ts#L136)
-
-#### Parameters
-
-##### req
-
-[`HttpRequest`](../interfaces/HttpRequest.md)
-
-##### res
-
-[`HttpResponse`](../interfaces/HttpResponse.md)
-
-##### required?
-
-`boolean`
-
-#### Returns
-
-`Promise`\<[`JWTAuthResult`](../interfaces/JWTAuthResult.md) \| `undefined`\>
-
-***
-
-### authenticateSync()
-
-> **authenticateSync**(`req`, `res`, `required?`): [`JWTAuthResult`](../interfaces/JWTAuthResult.md) \| `undefined`
-
-Defined in: [src/auth/JWTStrategy.ts:171](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/JWTStrategy.ts#L171)
-
-#### Parameters
-
-##### req
-
-[`HttpRequest`](../interfaces/HttpRequest.md)
-
-##### res
-
-[`HttpResponse`](../interfaces/HttpResponse.md)
-
-##### required?
-
-`boolean`
-
-#### Returns
-
-[`JWTAuthResult`](../interfaces/JWTAuthResult.md) \| `undefined`

package/docs/reference/classes/JWTStrategyOptions.md

@@ -1,97 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / JWTStrategyOptions
-
-# Class: JWTStrategyOptions
-
-Defined in: [src/auth/JWTStrategy.ts:19](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/JWTStrategy.ts#L19)
-
-Describes the configuration options that can be used to initialize JWTStrategy.
-
-## Author
-
-Jean-Philippe Steinmetz
-
-## Constructors
-
-### Constructor
-
-> **new JWTStrategyOptions**(): `JWTStrategyOptions`
-
-#### Returns
-
-`JWTStrategyOptions`
-
-## Properties
-
-### allowQueryParam
-
-> **allowQueryParam**: `boolean` = `false`
-
-Defined in: [src/auth/JWTStrategy.ts:37](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/JWTStrategy.ts#L37)
-
-Set to `true` to allow tokens to be supplied via the `queryKey` URL parameter.
-Disabled by default — query parameters appear in server logs, browser history, and
-Referer headers, which permanently exposes tokens outside the application.
-
-***
-
-### config?
-
-> `optional` **config?**: `JWTUtilsConfig`
-
-Defined in: [src/auth/JWTStrategy.ts:21](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/JWTStrategy.ts#L21)
-
-The configuration options to pass to the JWTUtils library during token verification.
-
-***
-
-### cookieName
-
-> **cookieName**: `string` = `"jwt"`
-
-Defined in: [src/auth/JWTStrategy.ts:27](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/JWTStrategy.ts#L27)
-
-The name of the cookie to retrieve the token from when using cookie based authentication. Default value is `jwt`.
-
-***
-
-### cookieSecure
-
-> **cookieSecure**: `boolean` = `false`
-
-Defined in: [src/auth/JWTStrategy.ts:29](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/JWTStrategy.ts#L29)
-
-The name of the secured cookie to retreive the token from when using cookie based authentication.
-
-***
-
-### headerKey
-
-> **headerKey**: `string` = `"authorization"`
-
-Defined in: [src/auth/JWTStrategy.ts:23](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/JWTStrategy.ts#L23)
-
-The name of the header to look for when performing header based authentication. Default value is `Authorization`.
-
-***
-
-### headerScheme
-
-> **headerScheme**: `string` = "(jwt\|bearer)"
-
-Defined in: [src/auth/JWTStrategy.ts:25](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/JWTStrategy.ts#L25)
-
-The authorization scheme type when using header based authentication. Default value is `jwt`.
-
-***
-
-### queryKey
-
-> **queryKey**: `string` = `"auth_token"`
-
-Defined in: [src/auth/JWTStrategy.ts:31](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/auth/JWTStrategy.ts#L31)
-
-The name of the request query parameter to retrieve the token from when using query based authentication. Default value is `auth_token`.

package/docs/reference/classes/MetricsRoute.md

@@ -1,27 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / MetricsRoute
-
-# Class: MetricsRoute
-
-Defined in: [src/routes/MetricsRoute.ts:19](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/MetricsRoute.ts#L19)
-
-Handles all REST API requests for the endpoint `/metrics'. This route handler produces Prometheus compatible metrics
-for use with a Prometheus based server.
-
-Services that wish to provide metrics to be exposed via this route can register them using the global registry
-from the provided `prom-client` dependency. See the `prom-client` documentation for more details.
-
-## Constructors
-
-### Constructor
-
-> **new MetricsRoute**(): `MetricsRoute`
-
-Defined in: [src/routes/MetricsRoute.ts:30](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/MetricsRoute.ts#L30)
-
-#### Returns
-
-`MetricsRoute`