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

package/dist/es/models/routes/IRestRouteRequestExample.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRouteRequestExample.js","sourceRoot":"","sources":["../../../../src/models/routes/IRestRouteRequestExample.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRouteExample } from \"./IRestRouteExample.js\";\n\n/**\n * Interface which defines a REST route request example.\n */\nexport interface IRestRouteRequestExample<T> extends IRestRouteExample {\n\t/**\n\t * The example request object.\n\t */\n\trequest: T;\n}\n"]}

package/dist/es/models/routes/IRestRouteResponseAttachmentOptions.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IRestRouteResponseAttachmentOptions.js.map

package/dist/es/models/routes/IRestRouteResponseAttachmentOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRouteResponseAttachmentOptions.js","sourceRoot":"","sources":["../../../../src/models/routes/IRestRouteResponseAttachmentOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface which defines a REST route response for attachments.\n */\nexport interface IRestRouteResponseAttachmentOptions {\n\t/**\n\t * The content type to use in the response.\n\t */\n\tmimeType?: string;\n\n\t/**\n\t * The filename to use in content disposition.\n\t */\n\tfilename?: string;\n\n\t/**\n\t * Whether to inline the content.\n\t */\n\tinline?: boolean;\n}\n"]}

package/dist/es/models/routes/IRestRouteResponseExample.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IRestRouteResponseExample.js.map

package/dist/es/models/routes/IRestRouteResponseExample.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRouteResponseExample.js","sourceRoot":"","sources":["../../../../src/models/routes/IRestRouteResponseExample.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRouteExample } from \"./IRestRouteExample.js\";\n\n/**\n * Interface which defines a REST route response example.\n */\nexport interface IRestRouteResponseExample<T> extends IRestRouteExample {\n\t/**\n\t * The example response object.\n\t */\n\tresponse: T;\n}\n"]}

package/dist/es/models/routes/IRestRouteResponseOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IRestRouteResponseOptions.js.map

package/dist/es/models/routes/IRestRouteResponseOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRouteResponseOptions.js","sourceRoot":"","sources":["../../../../src/models/routes/IRestRouteResponseOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRouteResponseAttachmentOptions } from \"./IRestRouteResponseAttachmentOptions.js\";\n\n/**\n * Interface which defines a REST route response.\n */\nexport interface IRestRouteResponseOptions {\n\t/**\n\t * Additional options that can be used to control the response.\n\t */\n\tattachment?: IRestRouteResponseAttachmentOptions;\n}\n"]}

package/dist/es/models/routes/ISocketRoute.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ISocketRoute.js.map

package/dist/es/models/routes/ISocketRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISocketRoute.js","sourceRoot":"","sources":["../../../../src/models/routes/ISocketRoute.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IBaseRoute } from \"./IBaseRoute.js\";\nimport type { IHttpRequest } from \"../protocol/IHttpRequest.js\";\nimport type { IHttpResponse } from \"../protocol/IHttpResponse.js\";\nimport type { ISocketRequestContext } from \"../protocol/ISocketRequestContext.js\";\n\n/**\n * Interface which defines a socket route.\n */\nexport interface ISocketRoute<\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tT extends IHttpRequest = any,\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tU extends IHttpResponse = any\n> extends IBaseRoute {\n\t/**\n\t * The handler module.\n\t */\n\thandler: (\n\t\t/**\n\t\t * The request context.\n\t\t */\n\t\tsocketRequestContext: ISocketRequestContext,\n\n\t\t/**\n\t\t * The request object.\n\t\t */\n\t\trequest: T,\n\n\t\t/**\n\t\t * The function to emit an event.\n\t\t */\n\t\temit: (event: string, response: U) => Promise<void>\n\t) => void;\n\n\t/**\n\t * The connected handler.\n\t */\n\tconnected?: (\n\t\t/**\n\t\t * The request context.\n\t\t */\n\t\tsocketRequestContext: ISocketRequestContext\n\t) => void;\n\n\t/**\n\t * The disconnected handler.\n\t */\n\tdisconnected?: (\n\t\t/**\n\t\t * The request context.\n\t\t */\n\t\tsocketRequestContext: ISocketRequestContext\n\t) => void;\n}\n"]}

package/dist/es/models/routes/ISocketRouteEntryPoint.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ISocketRouteEntryPoint.js.map

package/dist/es/models/routes/ISocketRouteEntryPoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISocketRouteEntryPoint.js","sourceRoot":"","sources":["../../../../src/models/routes/ISocketRouteEntryPoint.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IBaseRouteEntryPoint } from \"./IBaseRouteEntryPoint.js\";\nimport type { ISocketRoute } from \"./ISocketRoute.js\";\n\n/**\n * Route entry points are used for exposing the socket routes from a package.\n */\nexport type ISocketRouteEntryPoint = IBaseRouteEntryPoint<ISocketRoute>;\n"]}

package/dist/es/models/routes/ITag.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITag.js.map

package/dist/es/models/routes/ITag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITag.js","sourceRoot":"","sources":["../../../../src/models/routes/ITag.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Tag for routes used to generate OpenAPI information.\n */\nexport interface ITag {\n\t/**\n\t * The name of the tag.\n\t */\n\tname: string;\n\n\t/**\n\t * Description for the tag.\n\t */\n\tdescription: string;\n}\n"]}

package/dist/es/models/server/IBaseRouteProcessor.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IBaseRouteProcessor.js.map

package/dist/es/models/server/IBaseRouteProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBaseRouteProcessor.js","sourceRoot":"","sources":["../../../../src/models/server/IBaseRouteProcessor.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IContextIds } from \"@twin.org/context\";\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IHttpResponse } from \"../protocol/IHttpResponse.js\";\nimport type { IHttpServerRequest } from \"../protocol/IHttpServerRequest.js\";\nimport type { IBaseRoute } from \"../routes/IBaseRoute.js\";\n\n/**\n * The definition for a base processor for handling REST routes.\n */\nexport interface IBaseRouteProcessor<T = IBaseRoute, R = IHttpServerRequest> extends IComponent {\n\t/**\n\t * Features supported by this processor.\n\t * If a route has any of these features listed, this processor will be run for that route.\n\t * If this is not implemented, the processor will run for all routes.\n\t * @returns The features supported by this processor.\n\t */\n\tfeatures?(): string[];\n\n\t/**\n\t * Pre process the REST request for the specified route.\n\t * @param request The request to handle.\n\t * @param response The response data to send if any.\n\t * @param route The route being requested, if a matching one was found.\n\t * @param contextIds The context IDs of the request.\n\t * @param processorState The state handed through the processors.\n\t * @param loggingComponentType The logging component type for the request.\n\t * @returns Promise that resolves when the request is processed.\n\t */\n\tpre?(\n\t\trequest: R,\n\t\tresponse: IHttpResponse,\n\t\troute: T | undefined,\n\t\tcontextIds: IContextIds,\n\t\tprocessorState: { [id: string]: unknown },\n\t\tloggingComponentType?: string\n\t): Promise<void>;\n\n\t/**\n\t * Post process the REST request for the specified route.\n\t * @param request The request to handle.\n\t * @param response The response data to send if any.\n\t * @param route The route being requested, if a matching one was found.\n\t * @param contextIds The context IDs of the request.\n\t * @param processorState The state handed through the processors.\n\t * @param loggingComponentType The logging component type for the request.\n\t * @returns Promise that resolves when the request is processed.\n\t */\n\tpost?(\n\t\trequest: R,\n\t\tresponse: IHttpResponse,\n\t\troute: T | undefined,\n\t\tcontextIds: IContextIds,\n\t\tprocessorState: { [id: string]: unknown },\n\t\tloggingComponentType?: string\n\t): Promise<void>;\n}\n"]}

package/dist/es/models/server/IMimeTypeProcessor.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IMimeTypeProcessor.js.map

package/dist/es/models/server/IMimeTypeProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMimeTypeProcessor.js","sourceRoot":"","sources":["../../../../src/models/server/IMimeTypeProcessor.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\n\n/**\n * The definition for a handler for a specific MIME type.\n */\nexport interface IMimeTypeProcessor extends IComponent {\n\t/**\n\t * Get the MIME types that this handler can handle.\n\t * @returns The MIME types that this handler can handle.\n\t */\n\tgetTypes(): string[];\n\n\t/**\n\t * Handle content.\n\t * @param body The body to process.\n\t * @returns The processed body.\n\t */\n\thandle(body: Uint8Array): Promise<unknown>;\n}\n"]}

package/dist/es/models/server/IRestRouteProcessor.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IRestRouteProcessor.js.map

package/dist/es/models/server/IRestRouteProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRouteProcessor.js","sourceRoot":"","sources":["../../../../src/models/server/IRestRouteProcessor.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IBaseRouteProcessor } from \"./IBaseRouteProcessor.js\";\nimport type { IHttpResponse } from \"../protocol/IHttpResponse.js\";\nimport type { IHttpServerRequest } from \"../protocol/IHttpServerRequest.js\";\nimport type { IRestRoute } from \"../routes/IRestRoute.js\";\n\n/**\n * The definition for a processor for handling REST routes.\n */\nexport interface IRestRouteProcessor extends IBaseRouteProcessor<IRestRoute> {\n\t/**\n\t * Process the REST request for the specified route.\n\t * @param request The request to handle.\n\t * @param response The response data to send if any.\n\t * @param route The route being requested, if a matching one was found.\n\t * @param processorState The state handed through the processors.\n\t * @param loggingComponentType The logging component type for the request.\n\t * @returns Promise that resolves when the request is processed.\n\t */\n\tprocess?(\n\t\trequest: IHttpServerRequest,\n\t\tresponse: IHttpResponse,\n\t\troute: IRestRoute | undefined,\n\t\tprocessorState: { [id: string]: unknown },\n\t\tloggingComponentType?: string\n\t): Promise<void>;\n}\n"]}

package/dist/es/models/server/ISocketRouteProcessor.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ISocketRouteProcessor.js.map

package/dist/es/models/server/ISocketRouteProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISocketRouteProcessor.js","sourceRoot":"","sources":["../../../../src/models/server/ISocketRouteProcessor.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IBaseRouteProcessor } from \"./IBaseRouteProcessor.js\";\nimport type { IHttpResponse } from \"../protocol/IHttpResponse.js\";\nimport type { ISocketServerRequest } from \"../protocol/ISocketServerRequest.js\";\nimport type { ISocketRoute } from \"../routes/ISocketRoute.js\";\n\n/**\n * The definition for a processor for handling socket routes.\n */\nexport interface ISocketRouteProcessor\n\textends IBaseRouteProcessor<ISocketRoute, ISocketServerRequest> {\n\t/**\n\t * Process the connected event.\n\t * @param request The server request object containing the socket id and other parameters.\n\t * @param route The route being requested, if a matching one was found.\n\t * @param loggingComponentType The logging component type for the request.\n\t * @returns Promise that resolves when the request is processed.\n\t */\n\tconnected?(\n\t\trequest: ISocketServerRequest,\n\t\troute: ISocketRoute | undefined,\n\t\tloggingComponentType?: string\n\t): Promise<void>;\n\n\t/**\n\t * Process the disconnected event.\n\t * @param request The server request object containing the socket id and other parameters.\n\t * @param route The route being requested, if a matching one was found.\n\t * @param loggingComponentType The logging component type for the request.\n\t * @returns Promise that resolves when the request is processed.\n\t */\n\tdisconnected?(\n\t\trequest: ISocketServerRequest,\n\t\troute: ISocketRoute | undefined,\n\t\tloggingComponentType?: string\n\t): Promise<void>;\n\n\t/**\n\t * Process the REST request for the specified route.\n\t * @param request The server request object containing the socket id and other parameters.\n\t * @param response The response data to send if any.\n\t * @param route The route being requested, if a matching one was found.\n\t * @param processorState The state handed through the processors.\n\t * @param responseEmitter The function to emit a response.\n\t * @param loggingComponentType The logging component type for the request.\n\t * @returns Promise that resolves when the request is processed.\n\t */\n\tprocess?(\n\t\trequest: ISocketServerRequest,\n\t\tresponse: IHttpResponse,\n\t\troute: ISocketRoute | undefined,\n\t\tprocessorState: { [id: string]: unknown },\n\t\tresponseEmitter: (topic: string, response: IHttpResponse) => Promise<void>,\n\t\tloggingComponentType?: string\n\t): Promise<void>;\n}\n"]}

package/dist/es/models/server/IWebServer.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IWebServer.js.map

package/dist/es/models/server/IWebServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IWebServer.js","sourceRoot":"","sources":["../../../../src/models/server/IWebServer.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRouteProcessor } from \"./IRestRouteProcessor.js\";\nimport type { ISocketRouteProcessor } from \"./ISocketRouteProcessor.js\";\nimport type { IWebServerOptions } from \"./IWebServerOptions.js\";\nimport type { IRestRoute } from \"../routes/IRestRoute.js\";\nimport type { ISocketRoute } from \"../routes/ISocketRoute.js\";\n\n/**\n * Interface describing a web server.\n */\nexport interface IWebServer<T> {\n\t/**\n\t * Get the web server instance.\n\t * @returns The web server instance.\n\t */\n\tgetInstance(): T;\n\n\t/**\n\t * Build the server.\n\t * @param restRouteProcessors The processors for incoming requests over REST.\n\t * @param restRoutes The REST routes.\n\t * @param socketRouteProcessors The processors for incoming requests over Sockets.\n\t * @param socketRoutes The socket routes.\n\t * @param options Options for building the server.\n\t * @returns Nothing.\n\t */\n\tbuild(\n\t\trestRouteProcessors?: IRestRouteProcessor[],\n\t\trestRoutes?: IRestRoute[],\n\t\tsocketRouteProcessors?: ISocketRouteProcessor[],\n\t\tsocketRoutes?: ISocketRoute[],\n\t\toptions?: IWebServerOptions\n\t): Promise<void>;\n\n\t/**\n\t * Start the server.\n\t * @returns Nothing.\n\t */\n\tstart(): Promise<void>;\n\n\t/**\n\t * Stop the server.\n\t * @returns Nothing.\n\t */\n\tstop(): Promise<void>;\n}\n"]}

package/dist/es/models/server/IWebServerOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IWebServerOptions.js.map

package/dist/es/models/server/IWebServerOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IWebServerOptions.js","sourceRoot":"","sources":["../../../../src/models/server/IWebServerOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpMethod } from \"@twin.org/web\";\n\n/**\n * Options for the web server.\n */\nexport interface IWebServerOptions {\n\t/**\n\t * The port to bind the web server to.\n\t * @default 3000\n\t */\n\tport?: number;\n\n\t/**\n\t * The address to bind the web server to.\n\t * @default localhost\n\t */\n\thost?: string;\n\n\t/**\n\t * The methods that the server accepts.\n\t * @default [\"GET\", \"PUT\", \"POST\", \"DELETE\", \"OPTIONS\"]\n\t */\n\tmethods?: HttpMethod[];\n\n\t/**\n\t * Any additional allowed headers.\n\t */\n\tallowedHeaders?: string[];\n\n\t/**\n\t * And additional exposed headers.\n\t */\n\texposedHeaders?: string[];\n\n\t/**\n\t * The allowed CORS domains.\n\t * @default [\"*\"]\n\t */\n\tcorsOrigins?: string | string[];\n}\n"]}

package/dist/es/models/services/IHealthInfo.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IHealthInfo.js.map

package/dist/es/models/services/IHealthInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHealthInfo.js","sourceRoot":"","sources":["../../../../src/models/services/IHealthInfo.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HealthStatus } from \"./healthStatus.js\";\n\n/**\n * The status of the server.\n */\nexport interface IHealthInfo {\n\t/**\n\t * The status.\n\t */\n\tstatus: HealthStatus;\n\n\t/**\n\t * The status of the components.\n\t */\n\tcomponents?: {\n\t\t/**\n\t\t * The name of the component.\n\t\t */\n\t\tname: string;\n\n\t\t/**\n\t\t * The status of the component.\n\t\t */\n\t\tstatus: HealthStatus;\n\n\t\t/**\n\t\t * The details for the status.\n\t\t */\n\t\tdetails?: string;\n\t}[];\n}\n"]}

package/dist/es/models/services/IInformationComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IInformationComponent.js.map

package/dist/es/models/services/IInformationComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IInformationComponent.js","sourceRoot":"","sources":["../../../../src/models/services/IInformationComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { HealthStatus } from \"./healthStatus.js\";\nimport type { IHealthInfo } from \"./IHealthInfo.js\";\nimport type { IServerInfo } from \"./IServerInfo.js\";\n\n/**\n * The information component for the server.\n */\nexport interface IInformationComponent extends IComponent {\n\t/**\n\t * Get the root information.\n\t * @returns The root information.\n\t */\n\troot(): Promise<string>;\n\n\t/**\n\t * Get the server information.\n\t * @returns The service information.\n\t */\n\tinfo(): Promise<IServerInfo>;\n\n\t/**\n\t * Get the favicon.\n\t * @returns The favicon.\n\t */\n\tfavicon(): Promise<Uint8Array | undefined>;\n\n\t/**\n\t * Get the OpenAPI spec.\n\t * @returns The OpenAPI spec.\n\t */\n\tspec(): Promise<unknown>;\n\n\t/**\n\t * Get the server health.\n\t * @returns The service health.\n\t */\n\thealth(): Promise<IHealthInfo>;\n\n\t/**\n\t * Set the status of a component.\n\t * @param name The component name.\n\t * @param status The status of the component.\n\t * @param details The details for the status.\n\t * @returns Nothing.\n\t */\n\tsetComponentHealth(name: string, status: HealthStatus, details?: string): Promise<void>;\n\n\t/**\n\t * Remove the status of a component.\n\t * @param name The component name.\n\t * @returns Nothing.\n\t */\n\tremoveComponentHealth(name: string): Promise<void>;\n}\n"]}

package/dist/es/models/services/IServerInfo.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IServerInfo.js.map

package/dist/es/models/services/IServerInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IServerInfo.js","sourceRoot":"","sources":["../../../../src/models/services/IServerInfo.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The information about the server.\n */\nexport interface IServerInfo {\n\t/**\n\t * The application name.\n\t */\n\tname: string;\n\n\t/**\n\t * The version of the server.\n\t */\n\tversion: string;\n}\n"]}

package/dist/es/models/services/healthStatus.js

@@ -0,0 +1,21 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The health status of the component.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const HealthStatus = {
+    /**
+     * OK.
+     */
+    Ok: "ok",
+    /**
+     * Warning.
+     */
+    Warning: "warning",
+    /**
+     * Error.
+     */
+    Error: "error"
+};
+//# sourceMappingURL=healthStatus.js.map

package/dist/es/models/services/healthStatus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"healthStatus.js","sourceRoot":"","sources":["../../../../src/models/services/healthStatus.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B;;OAEG;IACH,EAAE,EAAE,IAAI;IAER;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,KAAK,EAAE,OAAO;CACL,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The health status of the component.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const HealthStatus = {\n\t/**\n\t * OK.\n\t */\n\tOk: \"ok\",\n\n\t/**\n\t * Warning.\n\t */\n\tWarning: \"warning\",\n\n\t/**\n\t * Error.\n\t */\n\tError: \"error\"\n} as const;\n\n/**\n * The health status of the component.\n */\nexport type HealthStatus = (typeof HealthStatus)[keyof typeof HealthStatus];\n"]}

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

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

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

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { IMimeTypeProcessor } from "../models/server/IMimeTypeProcessor";
+import type { IMimeTypeProcessor } from "../models/server/IMimeTypeProcessor.js";
 /**
  * Factory for creating implementation of mime type processor types.
  */

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

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { IRestRouteProcessor } from "../models/server/IRestRouteProcessor";
+import type { IRestRouteProcessor } from "../models/server/IRestRouteProcessor.js";
 /**
  * Factory for creating implementation of REST route processor types.
  */

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

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { ISocketRouteProcessor } from "../models/server/ISocketRouteProcessor";
+import type { ISocketRouteProcessor } from "../models/server/ISocketRouteProcessor.js";
 /**
  * Factory for creating implementation of socket route processor types.
  */

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

@@ -1,6 +1,6 @@
 import { type IError } from "@twin.org/core";
 import { HttpStatusCode } from "@twin.org/web";
-import type { IHttpResponse } from "../models/protocol/IHttpResponse";
+import type { IHttpResponse } from "../models/protocol/IHttpResponse.js";
 /**
  * Class to help with processing http errors.
  */

package/dist/types/index.d.ts

@@ -1,55 +1,56 @@
-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/config/IBaseRestClientConfig";
-export * from "./models/config/IBaseSocketClientConfig";
-export * from "./models/protocol/IHttpRequest";
-export * from "./models/protocol/IHttpRequestContext";
-export * from "./models/protocol/IHttpRequestIdentity";
-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";
-export * from "./models/responses/errors/IForbiddenResponse";
-export * from "./models/responses/errors/IInternalServerErrorResponse";
-export * from "./models/responses/errors/INotFoundResponse";
-export * from "./models/responses/errors/IUnauthorizedResponse";
-export * from "./models/responses/errors/IUnprocessableEntityResponse";
-export * from "./models/responses/success/IAcceptedResponse";
-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/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";
-export * from "./models/services/IHealthInfo";
-export * from "./models/services/IInformationComponent";
-export * from "./models/services/IServerInfo";
+export * from "./factories/authenticationGeneratorFactory.js";
+export * from "./factories/mimeTypeProcessorFactory.js";
+export * from "./factories/restRouteProcessorFactory.js";
+export * from "./factories/socketRouteProcessorFactory.js";
+export * from "./helpers/httpErrorHelper.js";
+export * from "./helpers/httpParameterHelper.js";
+export * from "./models/api/IServerFavIconResponse.js";
+export * from "./models/api/IServerHealthResponse.js";
+export * from "./models/api/IServerInfoResponse.js";
+export * from "./models/api/IServerRootResponse.js";
+export * from "./models/api/IServerSpecResponse.js";
+export * from "./models/client/IAuthenticationGenerator.js";
+export * from "./models/config/IBaseRestClientConfig.js";
+export * from "./models/config/IBaseSocketClientConfig.js";
+export * from "./models/protocol/IHttpRequest.js";
+export * from "./models/protocol/IHttpRequestContext.js";
+export * from "./models/protocol/IHttpRequestPathParams.js";
+export * from "./models/protocol/IHttpRequestQuery.js";
+export * from "./models/protocol/IHttpResponse.js";
+export * from "./models/protocol/IHttpServerRequest.js";
+export * from "./models/protocol/ISocketRequestContext.js";
+export * from "./models/protocol/ISocketServerRequest.js";
+export * from "./models/requests/INoContentRequest.js";
+export * from "./models/responses/errors/IBadRequestResponse.js";
+export * from "./models/responses/errors/IConflictResponse.js";
+export * from "./models/responses/errors/IForbiddenResponse.js";
+export * from "./models/responses/errors/IInternalServerErrorResponse.js";
+export * from "./models/responses/errors/INotFoundResponse.js";
+export * from "./models/responses/errors/IUnauthorizedResponse.js";
+export * from "./models/responses/errors/IUnprocessableEntityResponse.js";
+export * from "./models/responses/success/IAcceptedResponse.js";
+export * from "./models/responses/success/ICreatedResponse.js";
+export * from "./models/responses/success/INoContentResponse.js";
+export * from "./models/responses/success/IOkResponse.js";
+export * from "./models/routes/IBaseRoute.js";
+export * from "./models/routes/IBaseRouteEntryPoint.js";
+export * from "./models/routes/IRestRoute.js";
+export * from "./models/routes/IRestRouteEntryPoint.js";
+export * from "./models/routes/IRestRouteExample.js";
+export * from "./models/routes/IRestRouteRequestExample.js";
+export * from "./models/routes/IRestRouteResponseAttachmentOptions.js";
+export * from "./models/routes/IRestRouteResponseExample.js";
+export * from "./models/routes/IRestRouteResponseOptions.js";
+export * from "./models/routes/ISocketRoute.js";
+export * from "./models/routes/ISocketRouteEntryPoint.js";
+export * from "./models/routes/ITag.js";
+export * from "./models/server/IBaseRouteProcessor.js";
+export * from "./models/server/IMimeTypeProcessor.js";
+export * from "./models/server/IRestRouteProcessor.js";
+export * from "./models/server/ISocketRouteProcessor.js";
+export * from "./models/server/IWebServer.js";
+export * from "./models/server/IWebServerOptions.js";
+export * from "./models/services/healthStatus.js";
+export * from "./models/services/IHealthInfo.js";
+export * from "./models/services/IInformationComponent.js";
+export * from "./models/services/IServerInfo.js";

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

@@ -1,4 +1,4 @@
-import type { IHealthInfo } from "../services/IHealthInfo";
+import type { IHealthInfo } from "../services/IHealthInfo.js";
 /**
  * The health of the server.
  */

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

@@ -1,4 +1,4 @@
-import type { IServerInfo } from "../services/IServerInfo";
+import type { IServerInfo } from "../services/IServerInfo.js";
 /**
  * The information about the server.
  */

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/protocol/IHttpRequest.d.ts

@@ -1,6 +1,6 @@
 import type { IHttpHeaders } from "@twin.org/web";
-import type { IHttpRequestPathParams } from "./IHttpRequestPathParams";
-import type { IHttpRequestQuery } from "./IHttpRequestQuery";
+import type { IHttpRequestPathParams } from "./IHttpRequestPathParams.js";
+import type { IHttpRequestQuery } from "./IHttpRequestQuery.js";
 /**
  * Model for the standard parameters for an http request.
  */

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

@@ -1,9 +1,8 @@
-import type { IHttpRequestIdentity } from "./IHttpRequestIdentity";
-import type { IHttpServerRequest } from "./IHttpServerRequest";
+import type { IHttpServerRequest } from "./IHttpServerRequest.js";
 /**
  * Context data from the HTTP request.
  */
-export interface IHttpRequestContext extends IHttpRequestIdentity {
+export interface IHttpRequestContext {
     /**
      * The raw HTTP request.
      */

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

@@ -1,5 +1,5 @@
 import type { HttpMethod } from "@twin.org/web";
-import type { IHttpRequest } from "./IHttpRequest";
+import type { IHttpRequest } from "./IHttpRequest.js";
 /**
  * Model for the standard parameters for an http request.
  */

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

@@ -1,4 +1,4 @@
-import type { IHttpRequestContext } from "./IHttpRequestContext";
+import type { IHttpRequestContext } from "./IHttpRequestContext.js";
 /**
  * Context data from the socket request.
  */

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

@@ -1,4 +1,4 @@
-import type { IHttpServerRequest } from "./IHttpServerRequest";
+import type { IHttpServerRequest } from "./IHttpServerRequest.js";
 /**
  * Model for the standard parameters for an http request.
  */

package/dist/types/models/requests/INoContentRequest.d.ts

@@ -1,4 +1,4 @@
-import type { IHttpRequest } from "../protocol/IHttpRequest";
+import type { IHttpRequest } from "../protocol/IHttpRequest.js";
 /**
  * A REST request with no input parameters.
  */

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

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

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

@@ -1,4 +1,4 @@
-import type { ITag } from "./ITag";
+import type { ITag } from "./ITag.js";
 /**
  * Route entry points are used for exposing the routes from a package.
  */

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

@@ -1,11 +1,11 @@
 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";
-import type { IHttpResponse } from "../protocol/IHttpResponse";
+import type { IBaseRoute } from "./IBaseRoute.js";
+import type { IRestRouteRequestExample } from "./IRestRouteRequestExample.js";
+import type { IRestRouteResponseExample } from "./IRestRouteResponseExample.js";
+import type { IRestRouteResponseOptions } from "./IRestRouteResponseOptions.js";
+import type { IHttpRequest } from "../protocol/IHttpRequest.js";
+import type { IHttpRequestContext } from "../protocol/IHttpRequestContext.js";
+import type { IHttpResponse } from "../protocol/IHttpResponse.js";
 /**
  * Interface which defines a REST route.
  */

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

@@ -1,5 +1,5 @@
-import type { IBaseRouteEntryPoint } from "./IBaseRouteEntryPoint";
-import type { IRestRoute } from "./IRestRoute";
+import type { IBaseRouteEntryPoint } from "./IBaseRouteEntryPoint.js";
+import type { IRestRoute } from "./IRestRoute.js";
 /**
  * Route entry points are used for exposing the REST routes from a package.
  */

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

@@ -1,4 +1,4 @@
-import type { IRestRouteExample } from "./IRestRouteExample";
+import type { IRestRouteExample } from "./IRestRouteExample.js";
 /**
  * Interface which defines a REST route request example.
  */

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

@@ -1,4 +1,4 @@
-import type { IRestRouteExample } from "./IRestRouteExample";
+import type { IRestRouteExample } from "./IRestRouteExample.js";
 /**
  * Interface which defines a REST route response example.
  */

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

@@ -1,4 +1,4 @@
-import type { IRestRouteResponseAttachmentOptions } from "./IRestRouteResponseAttachmentOptions";
+import type { IRestRouteResponseAttachmentOptions } from "./IRestRouteResponseAttachmentOptions.js";
 /**
  * Interface which defines a REST route response.
  */

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 { IHttpResponse } from "../protocol/IHttpResponse";
-import type { ISocketRequestContext } from "../protocol/ISocketRequestContext";
+import type { IBaseRoute } from "./IBaseRoute.js";
+import type { IHttpRequest } from "../protocol/IHttpRequest.js";
+import type { IHttpResponse } from "../protocol/IHttpResponse.js";
+import type { ISocketRequestContext } from "../protocol/ISocketRequestContext.js";
 /**
  * Interface which defines a socket route.
  */

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

@@ -1,5 +1,5 @@
-import type { IBaseRouteEntryPoint } from "./IBaseRouteEntryPoint";
-import type { ISocketRoute } from "./ISocketRoute";
+import type { IBaseRouteEntryPoint } from "./IBaseRouteEntryPoint.js";
+import type { ISocketRoute } from "./ISocketRoute.js";
 /**
  * Route entry points are used for exposing the socket routes from a package.
  */

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

@@ -1,23 +1,30 @@
+import type { IContextIds } from "@twin.org/context";
 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";
+import type { IHttpResponse } from "../protocol/IHttpResponse.js";
+import type { IHttpServerRequest } from "../protocol/IHttpServerRequest.js";
+import type { IBaseRoute } from "../routes/IBaseRoute.js";
 /**
  * The definition for a base processor for handling REST routes.
  */
 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.
      * @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 contextIds The context IDs of 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: R, response: IHttpResponse, route: T | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    pre?(request: R, response: IHttpResponse, route: T | undefined, contextIds: IContextIds, processorState: {
         [id: string]: unknown;
     }, loggingComponentType?: string): Promise<void>;
     /**
@@ -25,12 +32,12 @@ export interface IBaseRouteProcessor<T = IBaseRoute, R = IHttpServerRequest> ext
      * @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 contextIds The context IDs of 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: R, response: IHttpResponse, route: T | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    post?(request: R, response: IHttpResponse, route: T | undefined, contextIds: IContextIds, processorState: {
         [id: string]: unknown;
     }, loggingComponentType?: string): Promise<void>;
 }