@twin.org/api-models 0.0.1-next.3 → 0.0.1-next.30

package/dist/cjs/index.cjs

@@ -3,6 +3,30 @@
 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 mime type processor types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const MimeTypeProcessorFactory = core.Factory.createFactory("mime-type-processor");
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating implementation of REST route processor types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const RestRouteProcessorFactory = core.Factory.createFactory("rest-route-processor");
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating implementation of socket route processor types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const SocketRouteProcessorFactory = core.Factory.createFactory("socket-route-processor");
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -65,6 +89,46 @@ class HttpErrorHelper {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class to help with handling http parameters.
+ */
+class HttpParameterHelper {
+    /**
+     * Convert list query to array.
+     * @param values The values query string.
+     * @returns The array of values.
+     */
+    static arrayFromString(values) {
+        return values?.split(",");
+    }
+    /**
+     * Convert array of values to query string.
+     * @param values The values to combine string.
+     * @returns The combined.
+     */
+    static arrayToString(values) {
+        return values?.join(",");
+    }
+    /**
+     * Convert object string to object.
+     * @param value The value query string.
+     * @returns The object.
+     */
+    static objectFromString(value) {
+        return core.Is.json(value) ? JSON.parse(value) : undefined;
+    }
+    /**
+     * Convert object to query string.
+     * @param value The value to convert to a string.
+     * @returns The converted object.
+     */
+    static objectToString(value) {
+        return core.Is.empty(value) ? undefined : JSON.stringify(value);
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -88,3 +152,7 @@ const HealthStatus = {
 
 exports.HealthStatus = HealthStatus;
 exports.HttpErrorHelper = HttpErrorHelper;
+exports.HttpParameterHelper = HttpParameterHelper;
+exports.MimeTypeProcessorFactory = MimeTypeProcessorFactory;
+exports.RestRouteProcessorFactory = RestRouteProcessorFactory;
+exports.SocketRouteProcessorFactory = SocketRouteProcessorFactory;

package/dist/esm/index.mjs

@@ -1,6 +1,30 @@
-import { BaseError, GuardError, ConflictError, NotFoundError, AlreadyExistsError, UnauthorizedError, NotImplementedError, UnprocessableError } from '@twin.org/core';
+import { Factory, BaseError, GuardError, ConflictError, NotFoundError, AlreadyExistsError, UnauthorizedError, NotImplementedError, UnprocessableError, Is } from '@twin.org/core';
 import { HttpStatusCode, HeaderTypes, MimeTypes } from '@twin.org/web';
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating implementation of mime type processor types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const MimeTypeProcessorFactory = Factory.createFactory("mime-type-processor");
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating implementation of REST route processor types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const RestRouteProcessorFactory = Factory.createFactory("rest-route-processor");
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating implementation of socket route processor types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const SocketRouteProcessorFactory = Factory.createFactory("socket-route-processor");
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -63,6 +87,46 @@ class HttpErrorHelper {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class to help with handling http parameters.
+ */
+class HttpParameterHelper {
+    /**
+     * Convert list query to array.
+     * @param values The values query string.
+     * @returns The array of values.
+     */
+    static arrayFromString(values) {
+        return values?.split(",");
+    }
+    /**
+     * Convert array of values to query string.
+     * @param values The values to combine string.
+     * @returns The combined.
+     */
+    static arrayToString(values) {
+        return values?.join(",");
+    }
+    /**
+     * Convert object string to object.
+     * @param value The value query string.
+     * @returns The object.
+     */
+    static objectFromString(value) {
+        return Is.json(value) ? JSON.parse(value) : undefined;
+    }
+    /**
+     * Convert object to query string.
+     * @param value The value to convert to a string.
+     * @returns The converted object.
+     */
+    static objectToString(value) {
+        return Is.empty(value) ? undefined : JSON.stringify(value);
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -84,4 +148,4 @@ const HealthStatus = {
     Error: "error"
 };
 
-export { HealthStatus, HttpErrorHelper };
+export { HealthStatus, HttpErrorHelper, HttpParameterHelper, MimeTypeProcessorFactory, RestRouteProcessorFactory, SocketRouteProcessorFactory };

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

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IMimeTypeProcessor } from "../models/server/IMimeTypeProcessor";
+/**
+ * Factory for creating implementation of mime type processor types.
+ */
+export declare const MimeTypeProcessorFactory: Factory<IMimeTypeProcessor>;

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

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IRestRouteProcessor } from "../models/server/IRestRouteProcessor";
+/**
+ * Factory for creating implementation of REST route processor types.
+ */
+export declare const RestRouteProcessorFactory: Factory<IRestRouteProcessor>;

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

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { ISocketRouteProcessor } from "../models/server/ISocketRouteProcessor";
+/**
+ * Factory for creating implementation of socket route processor types.
+ */
+export declare const SocketRouteProcessorFactory: Factory<ISocketRouteProcessor>;

package/dist/types/helpers/httpParameterHelper.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Class to help with handling http parameters.
+ */
+export declare class HttpParameterHelper {
+    /**
+     * Convert list query to array.
+     * @param values The values query string.
+     * @returns The array of values.
+     */
+    static arrayFromString<T = string>(values?: string): T[] | undefined;
+    /**
+     * Convert array of values to query string.
+     * @param values The values to combine string.
+     * @returns The combined.
+     */
+    static arrayToString<T = string>(values?: T[]): string | undefined;
+    /**
+     * Convert object string to object.
+     * @param value The value query string.
+     * @returns The object.
+     */
+    static objectFromString<T = unknown>(value?: string): T | undefined;
+    /**
+     * Convert object to query string.
+     * @param value The value to convert to a string.
+     * @returns The converted object.
+     */
+    static objectToString<T = unknown>(value?: T): string | undefined;
+}

package/dist/types/index.d.ts

@@ -1,4 +1,8 @@
+export * from "./factories/mimeTypeProcessorFactory";
+export * from "./factories/restRouteProcessorFactory";
+export * from "./factories/socketRouteProcessorFactory";
 export * from "./helpers/httpErrorHelper";
+export * from "./helpers/httpParameterHelper";
 export * from "./models/api/IServerHealthResponse";
 export * from "./models/api/IServerInfoResponse";
 export * from "./models/api/IServerSpecResponse";
@@ -24,13 +28,21 @@ export * from "./models/responses/success/ICreatedResponse";
 export * from "./models/responses/success/INoContentResponse";
 export * from "./models/responses/success/IOkResponse";
 export * from "./models/routes/IBaseRoute";
+export * from "./models/routes/IBaseRouteEntryPoint";
 export * from "./models/routes/IRestRoute";
 export * from "./models/routes/IRestRouteEntryPoint";
+export * from "./models/routes/IRestRouteExample";
+export * from "./models/routes/IRestRouteRequestExample";
 export * from "./models/routes/IRestRouteResponseAttachmentOptions";
+export * from "./models/routes/IRestRouteResponseExample";
 export * from "./models/routes/IRestRouteResponseOptions";
 export * from "./models/routes/ISocketRoute";
+export * from "./models/routes/ISocketRouteEntryPoint";
 export * from "./models/routes/ITag";
-export * from "./models/server/IHttpRestRouteProcessor";
+export * from "./models/server/IBaseRouteProcessor";
+export * from "./models/server/IMimeTypeProcessor";
+export * from "./models/server/IRestRouteProcessor";
+export * from "./models/server/ISocketRouteProcessor";
 export * from "./models/server/IWebServer";
 export * from "./models/server/IWebServerOptions";
 export * from "./models/services/healthStatus";

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

@@ -3,6 +3,10 @@ import type { IHttpHeaders } from "@twin.org/web";
  * Definition for the configuration of a socket service.
  */
 export interface IBaseSocketClientConfig {
+    /**
+     * Base path for the socket service, defaults to /socket.
+     */
+    basePath?: string;
     /**
      * The endpoint where the api is hosted.
      */

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

@@ -0,0 +1,22 @@
+import type { ITag } from "./ITag";
+/**
+ * Route entry points are used for exposing the routes from a package.
+ */
+export interface IBaseRouteEntryPoint<T> {
+    /**
+     * The name of the routes.
+     */
+    name: string;
+    /**
+     * The default base route name for the routes.
+     */
+    defaultBaseRoute: string;
+    /**
+     * The tags for the routes.
+     */
+    tags: ITag[];
+    /**
+     * The method to generate the routes.
+     */
+    generateRoutes: (baseRouteName: string, componentName: string) => T[];
+}

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

@@ -1,5 +1,7 @@
 import type { HttpMethod } from "@twin.org/web";
 import type { IBaseRoute } from "./IBaseRoute";
+import type { IRestRouteRequestExample } from "./IRestRouteRequestExample";
+import type { IRestRouteResponseExample } from "./IRestRouteResponseExample";
 import type { IRestRouteResponseOptions } from "./IRestRouteResponseOptions";
 import type { IHttpRequest } from "../protocol/IHttpRequest";
 import type { IHttpRequestContext } from "../protocol/IHttpRequestContext";
@@ -47,11 +49,7 @@ export interface IRestRoute<T extends IHttpRequest = any, U extends IHttpRespons
         /**
          * Example objects for the request.
          */
-        examples?: {
-            id: string;
-            description?: string;
-            request: T;
-        }[];
+        examples?: IRestRouteRequestExample<T>[];
     };
     /**
      * The type of the response object.
@@ -68,11 +66,7 @@ export interface IRestRoute<T extends IHttpRequest = any, U extends IHttpRespons
         /**
          * Example objects of the response.
          */
-        examples?: {
-            id: string;
-            description?: string;
-            response: U;
-        }[];
+        examples?: IRestRouteResponseExample<U>[];
     }[];
     /**
      * Exclude the route from being included in the spec file.

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

@@ -1,23 +1,6 @@
+import type { IBaseRouteEntryPoint } from "./IBaseRouteEntryPoint";
 import type { IRestRoute } from "./IRestRoute";
-import type { ITag } from "./ITag";
 /**
  * Route entry points are used for exposing the REST routes from a package.
  */
-export interface IRestRouteEntryPoint {
-    /**
-     * The name of the REST routes.
-     */
-    name: string;
-    /**
-     * The default base route name for the REST routes.
-     */
-    defaultBaseRoute: string;
-    /**
-     * The tags for the REST routes.
-     */
-    tags: ITag[];
-    /**
-     * The method to generate the REST routes.
-     */
-    generateRoutes: (baseRouteName: string, componentName: string) => IRestRoute[];
-}
+export type IRestRouteEntryPoint = IBaseRouteEntryPoint<IRestRoute>;

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

@@ -0,0 +1,13 @@
+/**
+ * Interface which defines a REST route example.
+ */
+export interface IRestRouteExample {
+    /**
+     * Example objects for the request.
+     */
+    id: string;
+    /**
+     * Description of the example.
+     */
+    description?: string;
+}

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

@@ -0,0 +1,10 @@
+import type { IRestRouteExample } from "./IRestRouteExample";
+/**
+ * Interface which defines a REST route request example.
+ */
+export interface IRestRouteRequestExample<T> extends IRestRouteExample {
+    /**
+     * The example request object.
+     */
+    request: T;
+}

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

@@ -0,0 +1,10 @@
+import type { IRestRouteExample } from "./IRestRouteExample";
+/**
+ * Interface which defines a REST route response example.
+ */
+export interface IRestRouteResponseExample<T> extends IRestRouteExample {
+    /**
+     * The example response object.
+     */
+    response: T;
+}

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

@@ -1,9 +1,11 @@
 import type { IBaseRoute } from "./IBaseRoute";
+import type { IHttpRequest } from "../protocol/IHttpRequest";
 import type { IHttpRequestContext } from "../protocol/IHttpRequestContext";
+import type { IHttpResponse } from "../protocol/IHttpResponse";
 /**
  * Interface which defines a socket route.
  */
-export interface ISocketRoute extends IBaseRoute {
+export interface ISocketRoute<T extends IHttpRequest = any, U extends IHttpResponse = any> extends IBaseRoute {
     /**
      * The handler module.
      */
@@ -12,16 +14,12 @@ export interface ISocketRoute extends IBaseRoute {
      * The request context.
      */
     httpRequestContext: IHttpRequestContext, 
-    /**
-     * The id of the socket the request is arriving on.
-     */
-    socketId: string, 
     /**
      * The request object.
      */
-    request: unknown, 
+    request: T, 
     /**
-     * Method to emit data on the socket.
+     * The function to emit an event.
      */
-    emitter: (topic: string, response?: unknown) => Promise<void>) => Promise<void>;
+    emit: (event: string, response: U) => Promise<void>) => void;
 }

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

@@ -0,0 +1,6 @@
+import type { IBaseRouteEntryPoint } from "./IBaseRouteEntryPoint";
+import type { ISocketRoute } from "./ISocketRoute";
+/**
+ * Route entry points are used for exposing the socket routes from a package.
+ */
+export type ISocketRouteEntryPoint = IBaseRouteEntryPoint<ISocketRoute>;

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

@@ -0,0 +1,34 @@
+import type { IComponent } from "@twin.org/core";
+import type { IHttpRequestIdentity } from "../protocol/IHttpRequestIdentity";
+import type { IHttpResponse } from "../protocol/IHttpResponse";
+import type { IHttpServerRequest } from "../protocol/IHttpServerRequest";
+import type { IBaseRoute } from "../routes/IBaseRoute";
+/**
+ * The definition for a base processor for handling REST routes.
+ */
+export interface IBaseRouteProcessor<T = IBaseRoute> extends IComponent {
+    /**
+     * Pre process the REST request for the specified route.
+     * @param request The request to handle.
+     * @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.
+     * @returns Promise that resolves when the request is processed.
+     */
+    pre?(request: IHttpServerRequest, response: IHttpResponse, route: T | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+        [id: string]: unknown;
+    }): Promise<void>;
+    /**
+     * Post process the REST request for the specified route.
+     * @param request The request to handle.
+     * @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.
+     * @returns Promise that resolves when the request is processed.
+     */
+    post?(request: IHttpServerRequest, response: IHttpResponse, route: T | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+        [id: string]: unknown;
+    }): Promise<void>;
+}

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

@@ -0,0 +1,17 @@
+import type { IComponent } from "@twin.org/core";
+/**
+ * The definition for a handler for a specific MIME type.
+ */
+export interface IMimeTypeProcessor extends IComponent {
+    /**
+     * Get the MIME types that this handler can handle.
+     * @returns The MIME types that this handler can handle.
+     */
+    getTypes(): string[];
+    /**
+     * Handle content.
+     * @param body The body to process.
+     * @returns The processed body.
+     */
+    handle(body: Uint8Array): Promise<unknown>;
+}

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

@@ -0,0 +1,22 @@
+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 { IRestRoute } from "../routes/IRestRoute";
+/**
+ * The definition for a processor for handling REST routes.
+ */
+export interface IRestRouteProcessor extends IBaseRouteProcessor<IRestRoute> {
+    /**
+     * Process the REST request for the specified route.
+     * @param request The request to handle.
+     * @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.
+     * @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>;
+}

package/dist/types/models/server/{IHttpRestRouteProcessor.d.ts → ISocketRouteProcessor.d.ts}

@@ -1,46 +1,43 @@
-import type { IComponent } from "@twin.org/core";
+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 { IRestRoute } from "../routes/IRestRoute";
+import type { ISocketRoute } from "../routes/ISocketRoute";
 /**
- * The definition for a processor for handling REST routes.
+ * The definition for a processor for handling socket routes.
  */
-export interface IHttpRestRouteProcessor extends IComponent {
+export interface ISocketRouteProcessor extends IBaseRouteProcessor<ISocketRoute> {
     /**
-     * Pre process the REST request for the specified route.
+     * Process the connected event.
      * @param request The request to handle.
-     * @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.
      * @returns Promise that resolves when the request is processed.
      */
-    pre?(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    connected?(request: IHttpServerRequest, route: ISocketRoute | undefined, processorState: {
         [id: string]: unknown;
     }): Promise<void>;
     /**
-     * Process the REST request for the specified route.
+     * Process the disconnected event.
      * @param request The request to handle.
-     * @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.
      * @returns Promise that resolves when the request is processed.
      */
-    process?(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    disconnected?(request: IHttpServerRequest, route: ISocketRoute | undefined, processorState: {
         [id: string]: unknown;
     }): Promise<void>;
     /**
-     * Post process the REST request for the specified route.
+     * Process the REST request for the specified route.
      * @param request The request to handle.
      * @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.
      * @returns Promise that resolves when the request is processed.
      */
-    post?(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    process?(request: IHttpServerRequest, response: IHttpResponse, route: ISocketRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
         [id: string]: unknown;
-    }): Promise<void>;
+    }, responseEmitter: (topic: string, response: IHttpResponse) => Promise<void>): Promise<void>;
 }

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

@@ -1,6 +1,8 @@
-import type { IHttpRestRouteProcessor } from "./IHttpRestRouteProcessor";
+import type { IRestRouteProcessor } from "./IRestRouteProcessor";
+import type { ISocketRouteProcessor } from "./ISocketRouteProcessor";
 import type { IWebServerOptions } from "./IWebServerOptions";
 import type { IRestRoute } from "../routes/IRestRoute";
+import type { ISocketRoute } from "../routes/ISocketRoute";
 /**
  * Interface describing a web server.
  */
@@ -12,12 +14,14 @@ export interface IWebServer<T> {
     getInstance(): T;
     /**
      * Build the server.
-     * @param restRouteProcessors The hooks to process the incoming requests.
+     * @param restRouteProcessors The processors for incoming requests over REST.
      * @param restRoutes The REST routes.
+     * @param socketRouteProcessors The processors for incoming requests over Sockets.
+     * @param socketRoutes The socket routes.
      * @param options Options for building the server.
      * @returns Nothing.
      */
-    build(restRouteProcessors: IHttpRestRouteProcessor[], restRoutes: IRestRoute[], options?: IWebServerOptions): Promise<void>;
+    build(restRouteProcessors?: IRestRouteProcessor[], restRoutes?: IRestRoute[], socketRouteProcessors?: ISocketRouteProcessor[], socketRoutes?: ISocketRoute[], options?: IWebServerOptions): Promise<void>;
     /**
      * Start the server.
      * @returns Nothing.

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/api-models - Changelog
 
-## v0.0.1-next.3
+## v0.0.1-next.30
 
 - Initial Release

package/docs/reference/classes/HttpErrorHelper.md

@@ -22,11 +22,15 @@ Process the errors from the routes.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The error to process.
 
-• **includeStack?**: `boolean`
+##### includeStack?
+
+`boolean`
 
 Should the stack be included in the error.
 
@@ -54,15 +58,21 @@ Build an error response.
 
 #### Parameters
 
-• **response**: [`IHttpResponse`](../interfaces/IHttpResponse.md)\<`any`\>
+##### response
+
+[`IHttpResponse`](../interfaces/IHttpResponse.md)
 
 The response to build the error into.
 
-• **error**: `IError`
+##### error
+
+`IError`
 
 The error to build the response for.
 
-• **statusCode**: `HttpStatusCode`
+##### statusCode
+
+`HttpStatusCode`
 
 The status code to use for the error.