@twin.org/api-models 0.0.2-next.1 → 0.0.2-next.11

package/dist/cjs/index.cjs

@@ -3,6 +3,14 @@
 var core = require('@twin.org/core');
 var web = require('@twin.org/web');
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating implementation of authentication generator types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AuthenticationGeneratorFactory = core.Factory.createFactory("authentication-generator");
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -146,6 +154,7 @@ const HealthStatus = {
     Error: "error"
 };
 
+exports.AuthenticationGeneratorFactory = AuthenticationGeneratorFactory;
 exports.HealthStatus = HealthStatus;
 exports.HttpErrorHelper = HttpErrorHelper;
 exports.HttpParameterHelper = HttpParameterHelper;

package/dist/esm/index.mjs

@@ -1,6 +1,14 @@
 import { Factory, BaseError, GuardError, ValidationError, ConflictError, AlreadyExistsError, NotFoundError, UnauthorizedError, NotImplementedError, UnprocessableError, Is } from '@twin.org/core';
 import { HttpStatusCode, MimeTypes, HeaderTypes } from '@twin.org/web';
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating implementation of authentication generator types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AuthenticationGeneratorFactory = Factory.createFactory("authentication-generator");
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -144,4 +152,4 @@ const HealthStatus = {
     Error: "error"
 };
 
-export { HealthStatus, HttpErrorHelper, HttpParameterHelper, MimeTypeProcessorFactory, RestRouteProcessorFactory, SocketRouteProcessorFactory };
+export { AuthenticationGeneratorFactory, HealthStatus, HttpErrorHelper, HttpParameterHelper, MimeTypeProcessorFactory, RestRouteProcessorFactory, SocketRouteProcessorFactory };

package/dist/types/factories/authenticationGeneratorFactory.d.ts

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IAuthenticationGenerator } from "../models/client/IAuthenticationGenerator";
+/**
+ * Factory for creating implementation of authentication generator types.
+ */
+export declare const AuthenticationGeneratorFactory: Factory<IAuthenticationGenerator>;

package/dist/types/index.d.ts

@@ -1,11 +1,15 @@
+export * from "./factories/authenticationGeneratorFactory";
 export * from "./factories/mimeTypeProcessorFactory";
 export * from "./factories/restRouteProcessorFactory";
 export * from "./factories/socketRouteProcessorFactory";
 export * from "./helpers/httpErrorHelper";
 export * from "./helpers/httpParameterHelper";
+export * from "./models/api/IServerFavIconResponse";
 export * from "./models/api/IServerHealthResponse";
 export * from "./models/api/IServerInfoResponse";
+export * from "./models/api/IServerRootResponse";
 export * from "./models/api/IServerSpecResponse";
+export * from "./models/client/IAuthenticationGenerator";
 export * from "./models/config/IBaseRestClientConfig";
 export * from "./models/config/IBaseSocketClientConfig";
 export * from "./models/protocol/IHttpRequest";
@@ -15,6 +19,8 @@ export * from "./models/protocol/IHttpRequestPathParams";
 export * from "./models/protocol/IHttpRequestQuery";
 export * from "./models/protocol/IHttpResponse";
 export * from "./models/protocol/IHttpServerRequest";
+export * from "./models/protocol/ISocketRequestContext";
+export * from "./models/protocol/ISocketServerRequest";
 export * from "./models/requests/INoContentRequest";
 export * from "./models/responses/errors/IBadRequestResponse";
 export * from "./models/responses/errors/IConflictResponse";

package/dist/types/models/api/IServerFavIconResponse.d.ts

@@ -0,0 +1,23 @@
+import type { HeaderTypes, HttpStatusCode } from "@twin.org/web";
+/**
+ * The favicon for the server.
+ */
+export interface IServerFavIconResponse {
+    /**
+     * Additional response headers.
+     */
+    headers?: {
+        /**
+         * The content type for the response.
+         */
+        [HeaderTypes.ContentType]?: string;
+    };
+    /**
+     * Response status code.
+     */
+    statusCode?: HttpStatusCode;
+    /**
+     * The favicon for the server.
+     */
+    body?: Uint8Array;
+}

package/dist/types/models/api/IServerRootResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The root text for the server.
+ */
+export interface IServerRootResponse {
+    /**
+     * The root text for the server.
+     */
+    body: string;
+}

package/dist/types/models/client/IAuthenticationGenerator.d.ts

@@ -0,0 +1,14 @@
+import type { IComponent } from "@twin.org/core";
+import type { IHttpHeaders } from "@twin.org/web";
+/**
+ * Definition for the authentication generator component.
+ */
+export interface IAuthenticationGenerator extends IComponent {
+    /**
+     * Adds authentication information to the request headers.
+     * @param requestHeaders The request headers to add authentication information to.
+     * @param authData Optional authentication data passed from the request.
+     * @returns A promise that resolves when the authentication information has been added.
+     */
+    addAuthentication(requestHeaders: IHttpHeaders, authData?: unknown): Promise<void>;
+}

package/dist/types/models/config/IBaseRestClientConfig.d.ts

@@ -23,4 +23,8 @@ export interface IBaseRestClientConfig {
      * Include credentials in the request, defaults to true.
      */
     includeCredentials?: boolean;
+    /**
+     * The type of authentication generator to use.
+     */
+    authenticationGeneratorType?: string;
 }

package/dist/types/models/protocol/IHttpRequest.d.ts

@@ -21,4 +21,8 @@ export interface IHttpRequest<T = any> {
      * Data to return send as the body.
      */
     body?: T;
+    /**
+     * Used to authenticate and will be passed to the configured authentication provider for the request.
+     */
+    authentication?: unknown;
 }

package/dist/types/models/protocol/IHttpRequestContext.d.ts

@@ -14,4 +14,8 @@ export interface IHttpRequestContext extends IHttpRequestIdentity {
     processorState: {
         [id: string]: unknown;
     };
+    /**
+     * Logging component type for the request.
+     */
+    loggingComponentType?: string;
 }

package/dist/types/models/protocol/ISocketRequestContext.d.ts

@@ -0,0 +1,10 @@
+import type { IHttpRequestContext } from "./IHttpRequestContext";
+/**
+ * Context data from the socket request.
+ */
+export interface ISocketRequestContext extends IHttpRequestContext {
+    /**
+     * The id of the socket.
+     */
+    socketId: string;
+}

package/dist/types/models/protocol/ISocketServerRequest.d.ts

@@ -0,0 +1,10 @@
+import type { IHttpServerRequest } from "./IHttpServerRequest";
+/**
+ * Model for the standard parameters for an http request.
+ */
+export interface ISocketServerRequest<T = any> extends IHttpServerRequest<T> {
+    /**
+     * The socket id.
+     */
+    socketId: string;
+}

package/dist/types/models/routes/IBaseRoute.d.ts

@@ -14,4 +14,8 @@ export interface IBaseRoute {
      * Skips the authentication for this route.
      */
     skipAuth?: boolean;
+    /**
+     * The features supported by additional processors to run for this route.
+     */
+    processorFeatures?: string[];
 }

package/dist/types/models/routes/ISocketRoute.d.ts

@@ -1,7 +1,7 @@
 import type { IBaseRoute } from "./IBaseRoute";
 import type { IHttpRequest } from "../protocol/IHttpRequest";
-import type { IHttpRequestContext } from "../protocol/IHttpRequestContext";
 import type { IHttpResponse } from "../protocol/IHttpResponse";
+import type { ISocketRequestContext } from "../protocol/ISocketRequestContext";
 /**
  * Interface which defines a socket route.
  */
@@ -13,7 +13,7 @@ export interface ISocketRoute<T extends IHttpRequest = any, U extends IHttpRespo
     /**
      * The request context.
      */
-    httpRequestContext: IHttpRequestContext, 
+    socketRequestContext: ISocketRequestContext, 
     /**
      * The request object.
      */
@@ -22,4 +22,20 @@ export interface ISocketRoute<T extends IHttpRequest = any, U extends IHttpRespo
      * The function to emit an event.
      */
     emit: (event: string, response: U) => Promise<void>) => void;
+    /**
+     * The connected handler.
+     */
+    connected?: (
+    /**
+     * The request context.
+     */
+    socketRequestContext: ISocketRequestContext) => void;
+    /**
+     * The disconnected handler.
+     */
+    disconnected?: (
+    /**
+     * The request context.
+     */
+    socketRequestContext: ISocketRequestContext) => void;
 }

package/dist/types/models/server/IBaseRouteProcessor.d.ts

@@ -6,7 +6,14 @@ import type { IBaseRoute } from "../routes/IBaseRoute";
 /**
  * The definition for a base processor for handling REST routes.
  */
-export interface IBaseRouteProcessor<T = IBaseRoute> extends IComponent {
+export interface IBaseRouteProcessor<T = IBaseRoute, R = IHttpServerRequest> extends IComponent {
+    /**
+     * Features supported by this processor.
+     * If a route has any of these features listed, this processor will be run for that route.
+     * If this is not implemented, the processor will run for all routes.
+     * @returns The features supported by this processor.
+     */
+    features?(): string[];
     /**
      * Pre process the REST request for the specified route.
      * @param request The request to handle.
@@ -14,11 +21,12 @@ export interface IBaseRouteProcessor<T = IBaseRoute> extends IComponent {
      * @param route The route being requested, if a matching one was found.
      * @param requestIdentity The identity context for the request.
      * @param processorState The state handed through the processors.
+     * @param loggingComponentType The logging component type for the request.
      * @returns Promise that resolves when the request is processed.
      */
-    pre?(request: IHttpServerRequest, response: IHttpResponse, route: T | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    pre?(request: R, response: IHttpResponse, route: T | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
         [id: string]: unknown;
-    }): Promise<void>;
+    }, loggingComponentType?: string): Promise<void>;
     /**
      * Post process the REST request for the specified route.
      * @param request The request to handle.
@@ -26,9 +34,10 @@ export interface IBaseRouteProcessor<T = IBaseRoute> extends IComponent {
      * @param route The route being requested, if a matching one was found.
      * @param requestIdentity The identity context for the request.
      * @param processorState The state handed through the processors.
+     * @param loggingComponentType The logging component type for the request.
      * @returns Promise that resolves when the request is processed.
      */
-    post?(request: IHttpServerRequest, response: IHttpResponse, route: T | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    post?(request: R, response: IHttpResponse, route: T | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
         [id: string]: unknown;
-    }): Promise<void>;
+    }, loggingComponentType?: string): Promise<void>;
 }

package/dist/types/models/server/IRestRouteProcessor.d.ts

@@ -14,9 +14,10 @@ export interface IRestRouteProcessor extends IBaseRouteProcessor<IRestRoute> {
      * @param route The route being requested, if a matching one was found.
      * @param requestIdentity The identity context for the request.
      * @param processorState The state handed through the processors.
+     * @param loggingComponentType The logging component type for the request.
      * @returns Promise that resolves when the request is processed.
      */
     process?(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
         [id: string]: unknown;
-    }): Promise<void>;
+    }, loggingComponentType?: string): Promise<void>;
 }

package/dist/types/models/server/ISocketRouteProcessor.d.ts

@@ -1,43 +1,40 @@
 import type { IBaseRouteProcessor } from "./IBaseRouteProcessor";
 import type { IHttpRequestIdentity } from "../protocol/IHttpRequestIdentity";
 import type { IHttpResponse } from "../protocol/IHttpResponse";
-import type { IHttpServerRequest } from "../protocol/IHttpServerRequest";
+import type { ISocketServerRequest } from "../protocol/ISocketServerRequest";
 import type { ISocketRoute } from "../routes/ISocketRoute";
 /**
  * The definition for a processor for handling socket routes.
  */
-export interface ISocketRouteProcessor extends IBaseRouteProcessor<ISocketRoute> {
+export interface ISocketRouteProcessor extends IBaseRouteProcessor<ISocketRoute, ISocketServerRequest> {
     /**
      * Process the connected event.
-     * @param request The request to handle.
+     * @param request The server request object containing the socket id and other parameters.
      * @param route The route being requested, if a matching one was found.
-     * @param processorState The state handed through the processors.
+     * @param loggingComponentType The logging component type for the request.
      * @returns Promise that resolves when the request is processed.
      */
-    connected?(request: IHttpServerRequest, route: ISocketRoute | undefined, processorState: {
-        [id: string]: unknown;
-    }): Promise<void>;
+    connected?(request: ISocketServerRequest, route: ISocketRoute | undefined, loggingComponentType?: string): Promise<void>;
     /**
      * Process the disconnected event.
-     * @param request The request to handle.
+     * @param request The server request object containing the socket id and other parameters.
      * @param route The route being requested, if a matching one was found.
-     * @param processorState The state handed through the processors.
+     * @param loggingComponentType The logging component type for the request.
      * @returns Promise that resolves when the request is processed.
      */
-    disconnected?(request: IHttpServerRequest, route: ISocketRoute | undefined, processorState: {
-        [id: string]: unknown;
-    }): Promise<void>;
+    disconnected?(request: ISocketServerRequest, route: ISocketRoute | undefined, loggingComponentType?: string): Promise<void>;
     /**
      * Process the REST request for the specified route.
-     * @param request The request to handle.
+     * @param request The server request object containing the socket id and other parameters.
      * @param response The response data to send if any.
      * @param route The route being requested, if a matching one was found.
      * @param requestIdentity The identity context for the request.
      * @param processorState The state handed through the processors.
      * @param responseEmitter The function to emit a response.
+     * @param loggingComponentType The logging component type for the request.
      * @returns Promise that resolves when the request is processed.
      */
-    process?(request: IHttpServerRequest, response: IHttpResponse, route: ISocketRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    process?(request: ISocketServerRequest, response: IHttpResponse, route: ISocketRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
         [id: string]: unknown;
-    }, responseEmitter: (topic: string, response: IHttpResponse) => Promise<void>): Promise<void>;
+    }, responseEmitter: (topic: string, response: IHttpResponse) => Promise<void>, loggingComponentType?: string): Promise<void>;
 }

package/dist/types/models/services/IInformationComponent.d.ts

@@ -6,11 +6,21 @@ import type { IServerInfo } from "./IServerInfo";
  * The information component for the server.
  */
 export interface IInformationComponent extends IComponent {
+    /**
+     * Get the root information.
+     * @returns The root information.
+     */
+    root(): Promise<string>;
     /**
      * Get the server information.
      * @returns The service information.
      */
     info(): Promise<IServerInfo>;
+    /**
+     * Get the favicon.
+     * @returns The favicon.
+     */
+    favicon(): Promise<Uint8Array | undefined>;
     /**
      * Get the OpenAPI spec.
      * @returns The OpenAPI spec.

package/docs/changelog.md

@@ -1,5 +1,80 @@
 # @twin.org/api-models - Changelog
 
+## [0.0.2-next.11](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.10...api-models-v0.0.2-next.11) (2025-09-29)
+
+
+### Features
+
+* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+
+## [0.0.2-next.10](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.9...api-models-v0.0.2-next.10) (2025-09-23)
+
+
+### Features
+
+* add authentication generators and process features option ([a67edf1](https://github.com/twinfoundation/api/commit/a67edf1df212bd8ab94a40cddf5338551155696f))
+
+## [0.0.2-next.9](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.8...api-models-v0.0.2-next.9) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+
+## [0.0.2-next.8](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.7...api-models-v0.0.2-next.8) (2025-08-21)
+
+
+### Features
+
+* add root, favicon routes ([71da1c3](https://github.com/twinfoundation/api/commit/71da1c3a93c349588aff7084d1d8d6a29a277da8))
+
+## [0.0.2-next.7](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.6...api-models-v0.0.2-next.7) (2025-08-20)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
+## [0.0.2-next.6](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.5...api-models-v0.0.2-next.6) (2025-08-19)
+
+
+### Features
+
+* update framework core ([d8eebf2](https://github.com/twinfoundation/api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+
+## [0.0.2-next.5](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.4...api-models-v0.0.2-next.5) (2025-07-25)
+
+
+### Features
+
+* add logging component type to request contexts ([210de1b](https://github.com/twinfoundation/api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
+* add socket id, connect and disconnect ([20b0d0e](https://github.com/twinfoundation/api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* use new includeStackTrace flag for toJsonObject ([6452b15](https://github.com/twinfoundation/api/commit/6452b153af786eee14b21152420f8a2578b70593))
+* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+* validationError mapped to http status badrequest ([adc5eb1](https://github.com/twinfoundation/api/commit/adc5eb11d987abb0ab9f7e0dc8e1fdae207e436e))
+
+## [0.0.2-next.4](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.3...api-models-v0.0.2-next.4) (2025-07-25)
+
+
+### Features
+
+* add logging component type to request contexts ([210de1b](https://github.com/twinfoundation/api/commit/210de1b9e1c91079b59a2b90ddd57569668d647d))
+
+## [0.0.2-next.3](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.2...api-models-v0.0.2-next.3) (2025-07-24)
+
+
+### Features
+
+* add socket id, connect and disconnect ([20b0d0e](https://github.com/twinfoundation/api/commit/20b0d0ec279cab46141fee09de2c4a7087cdce16))
+
+## [0.0.2-next.2](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.1...api-models-v0.0.2-next.2) (2025-07-17)
+
+
+### Miscellaneous Chores
+
+* **api-models:** Synchronize repo versions
+
 ## [0.0.2-next.1](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.0...api-models-v0.0.2-next.1) (2025-07-08)
 
 

package/docs/reference/index.md

@@ -7,9 +7,12 @@
 
 ## Interfaces
 
+- [IServerFavIconResponse](interfaces/IServerFavIconResponse.md)
 - [IServerHealthResponse](interfaces/IServerHealthResponse.md)
 - [IServerInfoResponse](interfaces/IServerInfoResponse.md)
+- [IServerRootResponse](interfaces/IServerRootResponse.md)
 - [IServerSpecResponse](interfaces/IServerSpecResponse.md)
+- [IAuthenticationGenerator](interfaces/IAuthenticationGenerator.md)
 - [IBaseRestClientConfig](interfaces/IBaseRestClientConfig.md)
 - [IBaseSocketClientConfig](interfaces/IBaseSocketClientConfig.md)
 - [IHttpRequest](interfaces/IHttpRequest.md)
@@ -19,6 +22,8 @@
 - [IHttpRequestQuery](interfaces/IHttpRequestQuery.md)
 - [IHttpResponse](interfaces/IHttpResponse.md)
 - [IHttpServerRequest](interfaces/IHttpServerRequest.md)
+- [ISocketRequestContext](interfaces/ISocketRequestContext.md)
+- [ISocketServerRequest](interfaces/ISocketServerRequest.md)
 - [INoContentRequest](interfaces/INoContentRequest.md)
 - [IBadRequestResponse](interfaces/IBadRequestResponse.md)
 - [IConflictResponse](interfaces/IConflictResponse.md)
@@ -59,6 +64,7 @@
 
 ## Variables
 
+- [AuthenticationGeneratorFactory](variables/AuthenticationGeneratorFactory.md)
 - [MimeTypeProcessorFactory](variables/MimeTypeProcessorFactory.md)
 - [RestRouteProcessorFactory](variables/RestRouteProcessorFactory.md)
 - [SocketRouteProcessorFactory](variables/SocketRouteProcessorFactory.md)

package/docs/reference/interfaces/IAuthenticationGenerator.md

@@ -0,0 +1,35 @@
+# Interface: IAuthenticationGenerator
+
+Definition for the authentication generator component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### addAuthentication()
+
+> **addAuthentication**(`requestHeaders`, `authData?`): `Promise`\<`void`\>
+
+Adds authentication information to the request headers.
+
+#### Parameters
+
+##### requestHeaders
+
+`IHttpHeaders`
+
+The request headers to add authentication information to.
+
+##### authData?
+
+`unknown`
+
+Optional authentication data passed from the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the authentication information has been added.

package/docs/reference/interfaces/IBaseRestClientConfig.md

@@ -41,3 +41,11 @@ Timeout for requests in ms.
 > `optional` **includeCredentials**: `boolean`
 
 Include credentials in the request, defaults to true.
+
+***
+
+### authenticationGeneratorType?
+
+> `optional` **authenticationGeneratorType**: `string`
+
+The type of authentication generator to use.

package/docs/reference/interfaces/IBaseRoute.md

@@ -30,3 +30,11 @@ The path to use for routing.
 > `optional` **skipAuth**: `boolean`
 
 Skips the authentication for this route.
+
+***
+
+### processorFeatures?
+
+> `optional` **processorFeatures**: `string`[]
+
+The features supported by additional processors to run for this route.

package/docs/reference/interfaces/IBaseRouteProcessor.md

@@ -1,4 +1,4 @@
-# Interface: IBaseRouteProcessor\<T\>
+# Interface: IBaseRouteProcessor\<T, R\>
 
 The definition for a base processor for handling REST routes.
 
@@ -17,11 +17,31 @@ The definition for a base processor for handling REST routes.
 
 `T` = [`IBaseRoute`](IBaseRoute.md)
 
+### R
+
+`R` = [`IHttpServerRequest`](IHttpServerRequest.md)
+
 ## Methods
 
+### features()?
+
+> `optional` **features**(): `string`[]
+
+Features supported by this processor.
+If a route has any of these features listed, this processor will be run for that route.
+If this is not implemented, the processor will run for all routes.
+
+#### Returns
+
+`string`[]
+
+The features supported by this processor.
+
+***
+
 ### pre()?
 
-> `optional` **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> `optional` **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Pre process the REST request for the specified route.
 
@@ -29,7 +49,7 @@ Pre process the REST request for the specified route.
 
 ##### request
 
-[`IHttpServerRequest`](IHttpServerRequest.md)
+`R`
 
 The request to handle.
 
@@ -55,6 +75,12 @@ The identity context for the request.
 
 The state handed through the processors.
 
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -65,7 +91,7 @@ Promise that resolves when the request is processed.
 
 ### post()?
 
-> `optional` **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> `optional` **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
 
 Post process the REST request for the specified route.
 
@@ -73,7 +99,7 @@ Post process the REST request for the specified route.
 
 ##### request
 
-[`IHttpServerRequest`](IHttpServerRequest.md)
+`R`
 
 The request to handle.
 
@@ -99,6 +125,12 @@ The identity context for the request.
 
 The state handed through the processors.
 
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/interfaces/IConflictResponse.md

@@ -18,7 +18,7 @@ Response status code.
 
 The body which contains the error.
 
-#### Type declaration
+#### Type Declaration
 
 ##### conflicts
 

package/docs/reference/interfaces/IHttpRequest.md

@@ -44,3 +44,11 @@ The query parameters.
 > `optional` **body**: `T`
 
 Data to return send as the body.
+
+***
+
+### authentication?
+
+> `optional` **authentication**: `unknown`
+
+Used to authenticate and will be passed to the configured authentication provider for the request.