@twin.org/api-processors 0.0.2-next.9 → 0.0.3-next.2

package/dist/es/data/restRouteProcessor.js

@@ -0,0 +1,115 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { HttpErrorHelper } from "@twin.org/api-models";
+import { Is, NotFoundError } from "@twin.org/core";
+import { HeaderTypes, HttpStatusCode, MimeTypes } from "@twin.org/web";
+/**
+ * Process the REST request and hands it on to the route handler.
+ */
+export class RestRouteProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "RestRouteProcessor";
+    /**
+     * Include the stack with errors.
+     * @internal
+     */
+    _includeErrorStack;
+    /**
+     * Create a new instance of RouteProcessor.
+     * @param options Options for the processor.
+     */
+    constructor(options) {
+        this._includeErrorStack = options?.config?.includeErrorStack ?? false;
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return RestRouteProcessor.CLASS_NAME;
+    }
+    /**
+     * Process the REST request for the specified route.
+     * @param request The incoming request.
+     * @param response The outgoing response.
+     * @param route The route to process.
+     * @param processorState The state handed through the processors.
+     * @param loggingComponentType The logging component type for the request.
+     */
+    async process(request, response, route, processorState, loggingComponentType) {
+        // Don't handle the route if another processor has already set the response
+        // status code e.g. from an auth processor
+        if (Is.empty(response.statusCode)) {
+            if (Is.empty(route)) {
+                HttpErrorHelper.buildResponse(response, {
+                    name: NotFoundError.CLASS_NAME,
+                    message: `${RestRouteProcessor.CLASS_NAME}.routeNotFound`,
+                    properties: {
+                        notFoundId: request.url
+                    }
+                }, HttpStatusCode.notFound);
+            }
+            else {
+                try {
+                    const req = {
+                        pathParams: request.pathParams,
+                        query: request.query,
+                        body: request.body
+                    };
+                    const restRouteResponse = await route.handler({
+                        serverRequest: request,
+                        processorState,
+                        loggingComponentType
+                    }, req);
+                    let statusCode = restRouteResponse.statusCode ?? response.statusCode ?? HttpStatusCode.ok;
+                    const headers = restRouteResponse?.headers ?? {};
+                    if (Is.empty(restRouteResponse?.body)) {
+                        // If there is no custom status code and the body is empty
+                        // use the no content response and set the length to 0
+                        headers[HeaderTypes.ContentLength] = "0";
+                        // Only change to no content if the status code is ok
+                        // This could be something like a created status code
+                        // which is successful but has no content
+                        if (statusCode === HttpStatusCode.ok) {
+                            statusCode = HttpStatusCode.noContent;
+                        }
+                    }
+                    else {
+                        // Only set the content type if there is a body
+                        // If there are custom response types for the route then use them
+                        // instead of the default application/json
+                        headers[HeaderTypes.ContentType] =
+                            restRouteResponse?.attachment?.mimeType ??
+                                restRouteResponse.headers?.[HeaderTypes.ContentType] ??
+                                `${MimeTypes.Json}; charset=utf-8`;
+                        // If there are filename or inline options set then add the content disposition
+                        if (Is.stringValue(restRouteResponse?.attachment?.filename) ||
+                            Is.boolean(restRouteResponse?.attachment?.inline)) {
+                            let filename = "";
+                            if (Is.stringValue(restRouteResponse?.attachment?.filename)) {
+                                filename = `; filename="${restRouteResponse?.attachment?.filename}"`;
+                            }
+                            headers[HeaderTypes.ContentDisposition] =
+                                `${restRouteResponse?.attachment?.inline ? "inline" : "attachment"}${filename}`;
+                        }
+                        // If this is a binary response then set the content length
+                        if (Is.uint8Array(restRouteResponse?.body)) {
+                            const contentLength = restRouteResponse.body.length;
+                            headers[HeaderTypes.ContentLength] = contentLength.toString();
+                        }
+                        response.body = restRouteResponse?.body;
+                    }
+                    response.headers = headers;
+                    response.statusCode = statusCode;
+                }
+                catch (err) {
+                    const { error, httpStatusCode } = HttpErrorHelper.processError(err, this._includeErrorStack);
+                    HttpErrorHelper.buildResponse(response, error, httpStatusCode);
+                }
+            }
+        }
+    }
+}
+//# sourceMappingURL=restRouteProcessor.js.map

package/dist/es/data/restRouteProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"restRouteProcessor.js","sourceRoot":"","sources":["../../../src/data/restRouteProcessor.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EACN,eAAe,EAOf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,EAAE,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEnD,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAGvE;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAC9B;;OAEG;IACI,MAAM,CAAU,UAAU,wBAAwC;IAEzE;;;OAGG;IACc,kBAAkB,CAAU;IAE7C;;;OAGG;IACH,YAAY,OAA+C;QAC1D,IAAI,CAAC,kBAAkB,GAAG,OAAO,EAAE,MAAM,EAAE,iBAAiB,IAAI,KAAK,CAAC;IACvE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,kBAAkB,CAAC,UAAU,CAAC;IACtC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO,CACnB,OAA2B,EAC3B,QAAuB,EACvB,KAA6B,EAC7B,cAAyC,EACzC,oBAA6B;QAE7B,2EAA2E;QAC3E,0CAA0C;QAC1C,IAAI,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACnC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,eAAe,CAAC,aAAa,CAC5B,QAAQ,EACR;oBACC,IAAI,EAAE,aAAa,CAAC,UAAU;oBAC9B,OAAO,EAAE,GAAG,kBAAkB,CAAC,UAAU,gBAAgB;oBACzD,UAAU,EAAE;wBACX,UAAU,EAAE,OAAO,CAAC,GAAG;qBACvB;iBACD,EACD,cAAc,CAAC,QAAQ,CACvB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACP,IAAI,CAAC;oBACJ,MAAM,GAAG,GAAiB;wBACzB,UAAU,EAAE,OAAO,CAAC,UAAU;wBAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;wBACpB,IAAI,EAAE,OAAO,CAAC,IAAI;qBAClB,CAAC;oBAEF,MAAM,iBAAiB,GAA8C,MAAM,KAAK,CAAC,OAAO,CACvF;wBACC,aAAa,EAAE,OAAO;wBACtB,cAAc;wBACd,oBAAoB;qBACpB,EACD,GAAG,CACH,CAAC;oBAEF,IAAI,UAAU,GACb,iBAAiB,CAAC,UAAU,IAAI,QAAQ,CAAC,UAAU,IAAI,cAAc,CAAC,EAAE,CAAC;oBAE1E,MAAM,OAAO,GAAG,iBAAiB,EAAE,OAAO,IAAI,EAAE,CAAC;oBAEjD,IAAI,EAAE,CAAC,KAAK,CAAC,iBAAiB,EAAE,IAAI,CAAC,EAAE,CAAC;wBACvC,0DAA0D;wBAC1D,sDAAsD;wBACtD,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC,GAAG,GAAG,CAAC;wBACzC,qDAAqD;wBACrD,qDAAqD;wBACrD,yCAAyC;wBACzC,IAAI,UAAU,KAAK,cAAc,CAAC,EAAE,EAAE,CAAC;4BACtC,UAAU,GAAG,cAAc,CAAC,SAAS,CAAC;wBACvC,CAAC;oBACF,CAAC;yBAAM,CAAC;wBACP,+CAA+C;wBAC/C,iEAAiE;wBACjE,0CAA0C;wBAC1C,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC;4BAC/B,iBAAiB,EAAE,UAAU,EAAE,QAAQ;gCACvC,iBAAiB,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC;gCACpD,GAAG,SAAS,CAAC,IAAI,iBAAiB,CAAC;wBAEpC,+EAA+E;wBAC/E,IACC,EAAE,CAAC,WAAW,CAAC,iBAAiB,EAAE,UAAU,EAAE,QAAQ,CAAC;4BACvD,EAAE,CAAC,OAAO,CAAC,iBAAiB,EAAE,UAAU,EAAE,MAAM,CAAC,EAChD,CAAC;4BACF,IAAI,QAAQ,GAAG,EAAE,CAAC;4BAClB,IAAI,EAAE,CAAC,WAAW,CAAC,iBAAiB,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,CAAC;gCAC7D,QAAQ,GAAG,eAAe,iBAAiB,EAAE,UAAU,EAAE,QAAQ,GAAG,CAAC;4BACtE,CAAC;4BACD,OAAO,CAAC,WAAW,CAAC,kBAAkB,CAAC;gCACtC,GAAG,iBAAiB,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,GAAG,QAAQ,EAAE,CAAC;wBAClF,CAAC;wBAED,2DAA2D;wBAC3D,IAAI,EAAE,CAAC,UAAU,CAAC,iBAAiB,EAAE,IAAI,CAAC,EAAE,CAAC;4BAC5C,MAAM,aAAa,GAAG,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC;4BACpD,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAC;wBAC/D,CAAC;wBAED,QAAQ,CAAC,IAAI,GAAG,iBAAiB,EAAE,IAAI,CAAC;oBACzC,CAAC;oBAED,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;oBAC3B,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC;gBAClC,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACd,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,eAAe,CAAC,YAAY,CAC7D,GAAG,EACH,IAAI,CAAC,kBAAkB,CACvB,CAAC;oBAEF,eAAe,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;gBAChE,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\tHttpErrorHelper,\n\ttype IHttpRequest,\n\ttype IHttpResponse,\n\ttype IHttpServerRequest,\n\ttype IRestRoute,\n\ttype IRestRouteProcessor,\n\ttype IRestRouteResponseOptions\n} from \"@twin.org/api-models\";\nimport { Is, NotFoundError } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { HeaderTypes, HttpStatusCode, MimeTypes } from \"@twin.org/web\";\nimport type { IRestRouteProcessorConstructorOptions } from \"../models/IRestRouteProcessorConstructorOptions.js\";\n\n/**\n * Process the REST request and hands it on to the route handler.\n */\nexport class RestRouteProcessor implements IRestRouteProcessor {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<RestRouteProcessor>();\n\n\t/**\n\t * Include the stack with errors.\n\t * @internal\n\t */\n\tprivate readonly _includeErrorStack: boolean;\n\n\t/**\n\t * Create a new instance of RouteProcessor.\n\t * @param options Options for the processor.\n\t */\n\tconstructor(options?: IRestRouteProcessorConstructorOptions) {\n\t\tthis._includeErrorStack = options?.config?.includeErrorStack ?? false;\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn RestRouteProcessor.CLASS_NAME;\n\t}\n\n\t/**\n\t * Process the REST request for the specified route.\n\t * @param request The incoming request.\n\t * @param response The outgoing response.\n\t * @param route The route to process.\n\t * @param processorState The state handed through the processors.\n\t * @param loggingComponentType The logging component type for the request.\n\t */\n\tpublic async process(\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\t\t// Don't handle the route if another processor has already set the response\n\t\t// status code e.g. from an auth processor\n\t\tif (Is.empty(response.statusCode)) {\n\t\t\tif (Is.empty(route)) {\n\t\t\t\tHttpErrorHelper.buildResponse(\n\t\t\t\t\tresponse,\n\t\t\t\t\t{\n\t\t\t\t\t\tname: NotFoundError.CLASS_NAME,\n\t\t\t\t\t\tmessage: `${RestRouteProcessor.CLASS_NAME}.routeNotFound`,\n\t\t\t\t\t\tproperties: {\n\t\t\t\t\t\t\tnotFoundId: request.url\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\tHttpStatusCode.notFound\n\t\t\t\t);\n\t\t\t} else {\n\t\t\t\ttry {\n\t\t\t\t\tconst req: IHttpRequest = {\n\t\t\t\t\t\tpathParams: request.pathParams,\n\t\t\t\t\t\tquery: request.query,\n\t\t\t\t\t\tbody: request.body\n\t\t\t\t\t};\n\n\t\t\t\t\tconst restRouteResponse: IHttpResponse & IRestRouteResponseOptions = await route.handler(\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tserverRequest: request,\n\t\t\t\t\t\t\tprocessorState,\n\t\t\t\t\t\t\tloggingComponentType\n\t\t\t\t\t\t},\n\t\t\t\t\t\treq\n\t\t\t\t\t);\n\n\t\t\t\t\tlet statusCode: HttpStatusCode =\n\t\t\t\t\t\trestRouteResponse.statusCode ?? response.statusCode ?? HttpStatusCode.ok;\n\n\t\t\t\t\tconst headers = restRouteResponse?.headers ?? {};\n\n\t\t\t\t\tif (Is.empty(restRouteResponse?.body)) {\n\t\t\t\t\t\t// If there is no custom status code and the body is empty\n\t\t\t\t\t\t// use the no content response and set the length to 0\n\t\t\t\t\t\theaders[HeaderTypes.ContentLength] = \"0\";\n\t\t\t\t\t\t// Only change to no content if the status code is ok\n\t\t\t\t\t\t// This could be something like a created status code\n\t\t\t\t\t\t// which is successful but has no content\n\t\t\t\t\t\tif (statusCode === HttpStatusCode.ok) {\n\t\t\t\t\t\t\tstatusCode = HttpStatusCode.noContent;\n\t\t\t\t\t\t}\n\t\t\t\t\t} else {\n\t\t\t\t\t\t// Only set the content type if there is a body\n\t\t\t\t\t\t// If there are custom response types for the route then use them\n\t\t\t\t\t\t// instead of the default application/json\n\t\t\t\t\t\theaders[HeaderTypes.ContentType] =\n\t\t\t\t\t\t\trestRouteResponse?.attachment?.mimeType ??\n\t\t\t\t\t\t\trestRouteResponse.headers?.[HeaderTypes.ContentType] ??\n\t\t\t\t\t\t\t`${MimeTypes.Json}; charset=utf-8`;\n\n\t\t\t\t\t\t// If there are filename or inline options set then add the content disposition\n\t\t\t\t\t\tif (\n\t\t\t\t\t\t\tIs.stringValue(restRouteResponse?.attachment?.filename) ||\n\t\t\t\t\t\t\tIs.boolean(restRouteResponse?.attachment?.inline)\n\t\t\t\t\t\t) {\n\t\t\t\t\t\t\tlet filename = \"\";\n\t\t\t\t\t\t\tif (Is.stringValue(restRouteResponse?.attachment?.filename)) {\n\t\t\t\t\t\t\t\tfilename = `; filename=\"${restRouteResponse?.attachment?.filename}\"`;\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\theaders[HeaderTypes.ContentDisposition] =\n\t\t\t\t\t\t\t\t`${restRouteResponse?.attachment?.inline ? \"inline\" : \"attachment\"}${filename}`;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\t// If this is a binary response then set the content length\n\t\t\t\t\t\tif (Is.uint8Array(restRouteResponse?.body)) {\n\t\t\t\t\t\t\tconst contentLength = restRouteResponse.body.length;\n\t\t\t\t\t\t\theaders[HeaderTypes.ContentLength] = contentLength.toString();\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\tresponse.body = restRouteResponse?.body;\n\t\t\t\t\t}\n\n\t\t\t\t\tresponse.headers = headers;\n\t\t\t\t\tresponse.statusCode = statusCode;\n\t\t\t\t} catch (err) {\n\t\t\t\t\tconst { error, httpStatusCode } = HttpErrorHelper.processError(\n\t\t\t\t\t\terr,\n\t\t\t\t\t\tthis._includeErrorStack\n\t\t\t\t\t);\n\n\t\t\t\t\tHttpErrorHelper.buildResponse(response, error, httpStatusCode);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n"]}

package/dist/es/data/socketRouteProcessor.js

@@ -0,0 +1,126 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { HttpErrorHelper } from "@twin.org/api-models";
+import { Is, NotFoundError } from "@twin.org/core";
+import { HttpStatusCode } from "@twin.org/web";
+/**
+ * Process the socket request and hands it on to the route handler.
+ */
+export class SocketRouteProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "SocketRouteProcessor";
+    /**
+     * Include the stack with errors.
+     * @internal
+     */
+    _includeErrorStack;
+    /**
+     * Create a new instance of SocketRouteProcessor.
+     * @param options Options for the processor.
+     */
+    constructor(options) {
+        this._includeErrorStack = options?.config?.includeErrorStack ?? false;
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return SocketRouteProcessor.CLASS_NAME;
+    }
+    /**
+     * Process the connected event.
+     * @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 loggingComponentType The logging component type for the request.
+     * @returns Promise that resolves when the request is processed.
+     */
+    async connected(request, route, loggingComponentType) {
+        if (route?.connected) {
+            try {
+                const socketRequestContext = {
+                    socketId: request.socketId,
+                    serverRequest: request,
+                    processorState: {},
+                    loggingComponentType
+                };
+                route.connected(socketRequestContext);
+            }
+            catch { }
+        }
+    }
+    /**
+     * Process the disconnected event.
+     * @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 loggingComponentType The logging component type for the request.
+     * @returns Promise that resolves when the request is processed.
+     */
+    async disconnected(request, route, loggingComponentType) {
+        if (route?.disconnected) {
+            try {
+                const socketRequestContext = {
+                    socketId: request.socketId,
+                    serverRequest: request,
+                    processorState: {},
+                    loggingComponentType
+                };
+                route.disconnected(socketRequestContext);
+            }
+            catch { }
+        }
+    }
+    /**
+     * Process the socket request for the specified route.
+     * @param request The incoming request.
+     * @param response The outgoing response.
+     * @param route The route to process.
+     * @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.
+     */
+    async process(request, response, route, processorState, responseEmitter, loggingComponentType) {
+        // Don't handle the route if another processor has already set the response
+        // status code e.g. from an auth processor
+        if (Is.empty(response.statusCode)) {
+            if (Is.empty(route)) {
+                HttpErrorHelper.buildResponse(response, {
+                    name: NotFoundError.CLASS_NAME,
+                    message: `${SocketRouteProcessor.CLASS_NAME}.routeNotFound`,
+                    properties: {
+                        notFoundId: request.url
+                    }
+                }, HttpStatusCode.notFound);
+            }
+            else {
+                try {
+                    const req = {
+                        pathParams: request.pathParams,
+                        query: request.query,
+                        body: request.body
+                    };
+                    const socketRequestContext = {
+                        socketId: request.socketId,
+                        serverRequest: request,
+                        processorState,
+                        loggingComponentType
+                    };
+                    route.handler(socketRequestContext, req, async (topic, socketRouteResponse) => {
+                        response.headers = socketRouteResponse?.headers;
+                        response.body = socketRouteResponse?.body;
+                        response.statusCode =
+                            socketRouteResponse.statusCode ?? response.statusCode ?? HttpStatusCode.ok;
+                        await responseEmitter(topic, response);
+                    });
+                }
+                catch (err) {
+                    const { error, httpStatusCode } = HttpErrorHelper.processError(err, this._includeErrorStack);
+                    HttpErrorHelper.buildResponse(response, error, httpStatusCode);
+                }
+            }
+        }
+    }
+}
+//# sourceMappingURL=socketRouteProcessor.js.map

package/dist/es/data/socketRouteProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"socketRouteProcessor.js","sourceRoot":"","sources":["../../../src/data/socketRouteProcessor.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EACN,eAAe,EAOf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,EAAE,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEnD,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAG/C;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAChC;;OAEG;IACI,MAAM,CAAU,UAAU,0BAA0C;IAE3E;;;OAGG;IACc,kBAAkB,CAAU;IAE7C;;;OAGG;IACH,YAAY,OAAiD;QAC5D,IAAI,CAAC,kBAAkB,GAAG,OAAO,EAAE,MAAM,EAAE,iBAAiB,IAAI,KAAK,CAAC;IACvE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,oBAAoB,CAAC,UAAU,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CACrB,OAA6B,EAC7B,KAA+B,EAC/B,oBAA6B;QAE7B,IAAI,KAAK,EAAE,SAAS,EAAE,CAAC;YACtB,IAAI,CAAC;gBACJ,MAAM,oBAAoB,GAA0B;oBACnD,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,aAAa,EAAE,OAAO;oBACtB,cAAc,EAAE,EAAE;oBAClB,oBAAoB;iBACpB,CAAC;gBAEF,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;YACvC,CAAC;YAAC,MAAM,CAAC,CAAA,CAAC;QACX,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,YAAY,CACxB,OAA6B,EAC7B,KAA+B,EAC/B,oBAA6B;QAE7B,IAAI,KAAK,EAAE,YAAY,EAAE,CAAC;YACzB,IAAI,CAAC;gBACJ,MAAM,oBAAoB,GAA0B;oBACnD,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,aAAa,EAAE,OAAO;oBACtB,cAAc,EAAE,EAAE;oBAClB,oBAAoB;iBACpB,CAAC;gBAEF,KAAK,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC;YAC1C,CAAC;YAAC,MAAM,CAAC,CAAA,CAAC;QACX,CAAC;IACF,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,OAAO,CACnB,OAA6B,EAC7B,QAAuB,EACvB,KAA+B,EAC/B,cAAyC,EACzC,eAA0E,EAC1E,oBAA6B;QAE7B,2EAA2E;QAC3E,0CAA0C;QAC1C,IAAI,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACnC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,eAAe,CAAC,aAAa,CAC5B,QAAQ,EACR;oBACC,IAAI,EAAE,aAAa,CAAC,UAAU;oBAC9B,OAAO,EAAE,GAAG,oBAAoB,CAAC,UAAU,gBAAgB;oBAC3D,UAAU,EAAE;wBACX,UAAU,EAAE,OAAO,CAAC,GAAG;qBACvB;iBACD,EACD,cAAc,CAAC,QAAQ,CACvB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACP,IAAI,CAAC;oBACJ,MAAM,GAAG,GAAiB;wBACzB,UAAU,EAAE,OAAO,CAAC,UAAU;wBAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;wBACpB,IAAI,EAAE,OAAO,CAAC,IAAI;qBAClB,CAAC;oBAEF,MAAM,oBAAoB,GAA0B;wBACnD,QAAQ,EAAE,OAAO,CAAC,QAAQ;wBAC1B,aAAa,EAAE,OAAO;wBACtB,cAAc;wBACd,oBAAoB;qBACpB,CAAC;oBAEF,KAAK,CAAC,OAAO,CAAC,oBAAoB,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,mBAAmB,EAAE,EAAE;wBAC7E,QAAQ,CAAC,OAAO,GAAG,mBAAmB,EAAE,OAAO,CAAC;wBAChD,QAAQ,CAAC,IAAI,GAAG,mBAAmB,EAAE,IAAI,CAAC;wBAC1C,QAAQ,CAAC,UAAU;4BAClB,mBAAmB,CAAC,UAAU,IAAI,QAAQ,CAAC,UAAU,IAAI,cAAc,CAAC,EAAE,CAAC;wBAC5E,MAAM,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;oBACxC,CAAC,CAAC,CAAC;gBACJ,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACd,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,eAAe,CAAC,YAAY,CAC7D,GAAG,EACH,IAAI,CAAC,kBAAkB,CACvB,CAAC;oBAEF,eAAe,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;gBAChE,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\tHttpErrorHelper,\n\ttype IHttpRequest,\n\ttype IHttpResponse,\n\ttype ISocketRequestContext,\n\ttype ISocketRoute,\n\ttype ISocketRouteProcessor,\n\ttype ISocketServerRequest\n} from \"@twin.org/api-models\";\nimport { Is, NotFoundError } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { HttpStatusCode } from \"@twin.org/web\";\nimport type { ISocketRouteProcessorConstructorOptions } from \"../models/ISocketRouteProcessorConstructorOptions.js\";\n\n/**\n * Process the socket request and hands it on to the route handler.\n */\nexport class SocketRouteProcessor implements ISocketRouteProcessor {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<SocketRouteProcessor>();\n\n\t/**\n\t * Include the stack with errors.\n\t * @internal\n\t */\n\tprivate readonly _includeErrorStack: boolean;\n\n\t/**\n\t * Create a new instance of SocketRouteProcessor.\n\t * @param options Options for the processor.\n\t */\n\tconstructor(options?: ISocketRouteProcessorConstructorOptions) {\n\t\tthis._includeErrorStack = options?.config?.includeErrorStack ?? false;\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn SocketRouteProcessor.CLASS_NAME;\n\t}\n\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\tpublic async connected(\n\t\trequest: ISocketServerRequest,\n\t\troute: ISocketRoute | undefined,\n\t\tloggingComponentType?: string\n\t): Promise<void> {\n\t\tif (route?.connected) {\n\t\t\ttry {\n\t\t\t\tconst socketRequestContext: ISocketRequestContext = {\n\t\t\t\t\tsocketId: request.socketId,\n\t\t\t\t\tserverRequest: request,\n\t\t\t\t\tprocessorState: {},\n\t\t\t\t\tloggingComponentType\n\t\t\t\t};\n\n\t\t\t\troute.connected(socketRequestContext);\n\t\t\t} catch {}\n\t\t}\n\t}\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\tpublic async disconnected(\n\t\trequest: ISocketServerRequest,\n\t\troute: ISocketRoute | undefined,\n\t\tloggingComponentType?: string\n\t): Promise<void> {\n\t\tif (route?.disconnected) {\n\t\t\ttry {\n\t\t\t\tconst socketRequestContext: ISocketRequestContext = {\n\t\t\t\t\tsocketId: request.socketId,\n\t\t\t\t\tserverRequest: request,\n\t\t\t\t\tprocessorState: {},\n\t\t\t\t\tloggingComponentType\n\t\t\t\t};\n\n\t\t\t\troute.disconnected(socketRequestContext);\n\t\t\t} catch {}\n\t\t}\n\t}\n\n\t/**\n\t * Process the socket request for the specified route.\n\t * @param request The incoming request.\n\t * @param response The outgoing response.\n\t * @param route The route to process.\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 */\n\tpublic async process(\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\t\t// Don't handle the route if another processor has already set the response\n\t\t// status code e.g. from an auth processor\n\t\tif (Is.empty(response.statusCode)) {\n\t\t\tif (Is.empty(route)) {\n\t\t\t\tHttpErrorHelper.buildResponse(\n\t\t\t\t\tresponse,\n\t\t\t\t\t{\n\t\t\t\t\t\tname: NotFoundError.CLASS_NAME,\n\t\t\t\t\t\tmessage: `${SocketRouteProcessor.CLASS_NAME}.routeNotFound`,\n\t\t\t\t\t\tproperties: {\n\t\t\t\t\t\t\tnotFoundId: request.url\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\tHttpStatusCode.notFound\n\t\t\t\t);\n\t\t\t} else {\n\t\t\t\ttry {\n\t\t\t\t\tconst req: IHttpRequest = {\n\t\t\t\t\t\tpathParams: request.pathParams,\n\t\t\t\t\t\tquery: request.query,\n\t\t\t\t\t\tbody: request.body\n\t\t\t\t\t};\n\n\t\t\t\t\tconst socketRequestContext: ISocketRequestContext = {\n\t\t\t\t\t\tsocketId: request.socketId,\n\t\t\t\t\t\tserverRequest: request,\n\t\t\t\t\t\tprocessorState,\n\t\t\t\t\t\tloggingComponentType\n\t\t\t\t\t};\n\n\t\t\t\t\troute.handler(socketRequestContext, req, async (topic, socketRouteResponse) => {\n\t\t\t\t\t\tresponse.headers = socketRouteResponse?.headers;\n\t\t\t\t\t\tresponse.body = socketRouteResponse?.body;\n\t\t\t\t\t\tresponse.statusCode =\n\t\t\t\t\t\t\tsocketRouteResponse.statusCode ?? response.statusCode ?? HttpStatusCode.ok;\n\t\t\t\t\t\tawait responseEmitter(topic, response);\n\t\t\t\t\t});\n\t\t\t\t} catch (err) {\n\t\t\t\t\tconst { error, httpStatusCode } = HttpErrorHelper.processError(\n\t\t\t\t\t\terr,\n\t\t\t\t\t\tthis._includeErrorStack\n\t\t\t\t\t);\n\n\t\t\t\t\tHttpErrorHelper.buildResponse(response, error, httpStatusCode);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n"]}

package/dist/es/identity/contextIdProcessor.js

@@ -0,0 +1,68 @@
+import { ContextIdStore, ContextIdHelper } from "@twin.org/context";
+import { Guards, Is } from "@twin.org/core";
+/**
+ * Adds an id to the request context ids.
+ */
+export class ContextIdProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "ContextIdProcessor";
+    /**
+     * The fixed identity key for request context.
+     * @internal
+     */
+    _key;
+    /**
+     * Only add the identity if the request is authenticated.
+     * @internal
+     */
+    _authOnly;
+    /**
+     * The identity value for request context.
+     * @internal
+     */
+    _value;
+    /**
+     * Create a new instance of ContextIdProcessor.
+     * @param options Options for the processor.
+     */
+    constructor(options) {
+        Guards.object(ContextIdProcessor.CLASS_NAME, "options", options);
+        Guards.object(ContextIdProcessor.CLASS_NAME, "options.config", options.config);
+        Guards.stringValue(ContextIdProcessor.CLASS_NAME, "options.config.key", options.config.key);
+        this._key = options.config.key;
+        this._authOnly = options.config.authOnly ?? false;
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return ContextIdProcessor.CLASS_NAME;
+    }
+    /**
+     * The service needs to be started when the application is initialized.
+     * @param nodeLoggingComponentType The node logging component type.
+     * @returns Nothing.
+     */
+    async start(nodeLoggingComponentType) {
+        const contextIds = await ContextIdStore.getContextIds();
+        ContextIdHelper.guard(contextIds, this._key);
+        this._value = contextIds[this._key];
+    }
+    /**
+     * Pre process the REST request for the specified route.
+     * @param request The incoming request.
+     * @param response The outgoing response.
+     * @param route The route to process.
+     * @param contextIds The context IDs of the request.
+     * @param processorState The state handed through the processors.
+     */
+    async pre(request, response, route, contextIds, processorState) {
+        if (!this._authOnly || (!Is.empty(route) && !(route.skipAuth ?? false))) {
+            contextIds[this._key] = this._value;
+        }
+    }
+}
+//# sourceMappingURL=contextIdProcessor.js.map

package/dist/es/identity/contextIdProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contextIdProcessor.js","sourceRoot":"","sources":["../../../src/identity/contextIdProcessor.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAoB,MAAM,mBAAmB,CAAC;AACtF,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAK5C;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAC9B;;OAEG;IACI,MAAM,CAAU,UAAU,wBAAwC;IAEzE;;;OAGG;IACc,IAAI,CAAS;IAE9B;;;OAGG;IACc,SAAS,CAAU;IAEpC;;;OAGG;IACK,MAAM,CAAU;IAExB;;;OAGG;IACH,YAAY,OAA8C;QACzD,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QACvE,MAAM,CAAC,MAAM,CACZ,kBAAkB,CAAC,UAAU,oBAE7B,OAAO,CAAC,MAAM,CACd,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,kBAAkB,CAAC,UAAU,wBAE7B,OAAO,CAAC,MAAM,CAAC,GAAG,CAClB,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,IAAI,KAAK,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,kBAAkB,CAAC,UAAU,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,KAAK,CAAC,wBAAiC;QACnD,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;QACxD,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,GAAG,CACf,OAA2B,EAC3B,QAAuB,EACvB,KAA6B,EAC7B,UAAuB,EACvB,cAAyC;QAEzC,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC;YACzE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QACrC,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIBaseRoute,\n\tIBaseRouteProcessor,\n\tIHttpResponse,\n\tIHttpServerRequest\n} from \"@twin.org/api-models\";\nimport { ContextIdStore, ContextIdHelper, type IContextIds } from \"@twin.org/context\";\nimport { Guards, Is } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IContextIdProcessorConfig } from \"../models/IContextIdProcessorConfig.js\";\nimport type { IContextIdProcessorConstructorOptions } from \"../models/IContextIdProcessorConstructorOptions.js\";\n\n/**\n * Adds an id to the request context ids.\n */\nexport class ContextIdProcessor implements IBaseRouteProcessor {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ContextIdProcessor>();\n\n\t/**\n\t * The fixed identity key for request context.\n\t * @internal\n\t */\n\tprivate readonly _key: string;\n\n\t/**\n\t * Only add the identity if the request is authenticated.\n\t * @internal\n\t */\n\tprivate readonly _authOnly: boolean;\n\n\t/**\n\t * The identity value for request context.\n\t * @internal\n\t */\n\tprivate _value?: string;\n\n\t/**\n\t * Create a new instance of ContextIdProcessor.\n\t * @param options Options for the processor.\n\t */\n\tconstructor(options: IContextIdProcessorConstructorOptions) {\n\t\tGuards.object(ContextIdProcessor.CLASS_NAME, nameof(options), options);\n\t\tGuards.object<IContextIdProcessorConfig>(\n\t\t\tContextIdProcessor.CLASS_NAME,\n\t\t\tnameof(options.config),\n\t\t\toptions.config\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tContextIdProcessor.CLASS_NAME,\n\t\t\tnameof(options.config.key),\n\t\t\toptions.config.key\n\t\t);\n\t\tthis._key = options.config.key;\n\t\tthis._authOnly = options.config.authOnly ?? false;\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn ContextIdProcessor.CLASS_NAME;\n\t}\n\n\t/**\n\t * The service needs to be started when the application is initialized.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns Nothing.\n\t */\n\tpublic async start(nodeLoggingComponentType?: string): Promise<void> {\n\t\tconst contextIds = await ContextIdStore.getContextIds();\n\t\tContextIdHelper.guard(contextIds, this._key);\n\t\tthis._value = contextIds[this._key];\n\t}\n\n\t/**\n\t * Pre process the REST request for the specified route.\n\t * @param request The incoming request.\n\t * @param response The outgoing response.\n\t * @param route The route to process.\n\t * @param contextIds The context IDs of the request.\n\t * @param processorState The state handed through the processors.\n\t */\n\tpublic async pre(\n\t\trequest: IHttpServerRequest,\n\t\tresponse: IHttpResponse,\n\t\troute: IBaseRoute | undefined,\n\t\tcontextIds: IContextIds,\n\t\tprocessorState: { [id: string]: unknown }\n\t): Promise<void> {\n\t\tif (!this._authOnly || (!Is.empty(route) && !(route.skipAuth ?? false))) {\n\t\t\tcontextIds[this._key] = this._value;\n\t\t}\n\t}\n}\n"]}

package/dist/es/identity/staticContextIdProcessor.js

@@ -0,0 +1,59 @@
+import { Guards, Is } from "@twin.org/core";
+/**
+ * Adds a static context id to the request context.
+ */
+export class StaticContextIdProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "StaticContextIdProcessor";
+    /**
+     * The fixed identity key for request context.
+     * @internal
+     */
+    _key;
+    /**
+     * The fixed identity value for request context.
+     * @internal
+     */
+    _value;
+    /**
+     * Only add the identity if the request is authenticated.
+     * @internal
+     */
+    _authOnly;
+    /**
+     * Create a new instance of StaticContextIdProcessor.
+     * @param options Options for the processor.
+     */
+    constructor(options) {
+        Guards.object(StaticContextIdProcessor.CLASS_NAME, "options", options);
+        Guards.object(StaticContextIdProcessor.CLASS_NAME, "options.config", options.config);
+        Guards.stringValue(StaticContextIdProcessor.CLASS_NAME, "options.config.key", options.config.key);
+        Guards.stringValue(StaticContextIdProcessor.CLASS_NAME, "options.config.value", options.config.value);
+        this._key = options.config.key;
+        this._value = options.config.value;
+        this._authOnly = options.config.authOnly ?? false;
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return StaticContextIdProcessor.CLASS_NAME;
+    }
+    /**
+     * Pre process the REST request for the specified route.
+     * @param request The incoming request.
+     * @param response The outgoing response.
+     * @param route The route to process.
+     * @param contextIds The context IDs of the request.
+     * @param processorState The state handed through the processors.
+     */
+    async pre(request, response, route, contextIds, processorState) {
+        if (!this._authOnly || (!Is.empty(route) && !(route.skipAuth ?? false))) {
+            contextIds[this._key] = this._value;
+        }
+    }
+}
+//# sourceMappingURL=staticContextIdProcessor.js.map

package/dist/es/identity/staticContextIdProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"staticContextIdProcessor.js","sourceRoot":"","sources":["../../../src/identity/staticContextIdProcessor.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAK5C;;GAEG;AACH,MAAM,OAAO,wBAAwB;IACpC;;OAEG;IACI,MAAM,CAAU,UAAU,8BAA8C;IAE/E;;;OAGG;IACc,IAAI,CAAS;IAE9B;;;OAGG;IACc,MAAM,CAAS;IAEhC;;;OAGG;IACc,SAAS,CAAU;IAEpC;;;OAGG;IACH,YAAY,OAAoD;QAC/D,MAAM,CAAC,MAAM,CAAC,wBAAwB,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QAC7E,MAAM,CAAC,MAAM,CACZ,wBAAwB,CAAC,UAAU,oBAEnC,OAAO,CAAC,MAAM,CACd,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,wBAAwB,CAAC,UAAU,wBAEnC,OAAO,CAAC,MAAM,CAAC,GAAG,CAClB,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,wBAAwB,CAAC,UAAU,0BAEnC,OAAO,CAAC,MAAM,CAAC,KAAK,CACpB,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,IAAI,KAAK,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,wBAAwB,CAAC,UAAU,CAAC;IAC5C,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,GAAG,CACf,OAA2B,EAC3B,QAAuB,EACvB,KAA6B,EAC7B,UAAuB,EACvB,cAAyC;QAEzC,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC;YACzE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QACrC,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIBaseRoute,\n\tIBaseRouteProcessor,\n\tIHttpResponse,\n\tIHttpServerRequest\n} from \"@twin.org/api-models\";\nimport type { IContextIds } from \"@twin.org/context\";\nimport { Guards, Is } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IStaticContextIdProcessorConfig } from \"../models/IStaticContextIdProcessorConfig.js\";\nimport type { IStaticContextIdProcessorConstructorOptions } from \"../models/IStaticContextIdProcessorConstructorOptions.js\";\n\n/**\n * Adds a static context id to the request context.\n */\nexport class StaticContextIdProcessor implements IBaseRouteProcessor {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<StaticContextIdProcessor>();\n\n\t/**\n\t * The fixed identity key for request context.\n\t * @internal\n\t */\n\tprivate readonly _key: string;\n\n\t/**\n\t * The fixed identity value for request context.\n\t * @internal\n\t */\n\tprivate readonly _value: string;\n\n\t/**\n\t * Only add the identity if the request is authenticated.\n\t * @internal\n\t */\n\tprivate readonly _authOnly: boolean;\n\n\t/**\n\t * Create a new instance of StaticContextIdProcessor.\n\t * @param options Options for the processor.\n\t */\n\tconstructor(options: IStaticContextIdProcessorConstructorOptions) {\n\t\tGuards.object(StaticContextIdProcessor.CLASS_NAME, nameof(options), options);\n\t\tGuards.object<IStaticContextIdProcessorConfig>(\n\t\t\tStaticContextIdProcessor.CLASS_NAME,\n\t\t\tnameof(options.config),\n\t\t\toptions.config\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tStaticContextIdProcessor.CLASS_NAME,\n\t\t\tnameof(options.config.key),\n\t\t\toptions.config.key\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tStaticContextIdProcessor.CLASS_NAME,\n\t\t\tnameof(options.config.value),\n\t\t\toptions.config.value\n\t\t);\n\t\tthis._key = options.config.key;\n\t\tthis._value = options.config.value;\n\t\tthis._authOnly = options.config.authOnly ?? false;\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn StaticContextIdProcessor.CLASS_NAME;\n\t}\n\n\t/**\n\t * Pre process the REST request for the specified route.\n\t * @param request The incoming request.\n\t * @param response The outgoing response.\n\t * @param route The route to process.\n\t * @param contextIds The context IDs of the request.\n\t * @param processorState The state handed through the processors.\n\t */\n\tpublic async pre(\n\t\trequest: IHttpServerRequest,\n\t\tresponse: IHttpResponse,\n\t\troute: IBaseRoute | undefined,\n\t\tcontextIds: IContextIds,\n\t\tprocessorState: { [id: string]: unknown }\n\t): Promise<void> {\n\t\tif (!this._authOnly || (!Is.empty(route) && !(route.skipAuth ?? false))) {\n\t\t\tcontextIds[this._key] = this._value;\n\t\t}\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,19 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./data/restRouteProcessor.js";
+export * from "./data/socketRouteProcessor.js";
+export * from "./identity/contextIdProcessor.js";
+export * from "./identity/staticContextIdProcessor.js";
+export * from "./logging/loggingProcessor.js";
+export * from "./mimeType/jsonLdMimeTypeProcessor.js";
+export * from "./mimeType/jwtMimeTypeProcessor.js";
+export * from "./models/IContextIdProcessorConfig.js";
+export * from "./models/IContextIdProcessorConstructorOptions.js";
+export * from "./models/ILoggingProcessorConfig.js";
+export * from "./models/ILoggingProcessorConstructorOptions.js";
+export * from "./models/IRestRouteProcessorConstructorOptions.js";
+export * from "./models/IRouteProcessorConfig.js";
+export * from "./models/ISocketRouteProcessorConstructorOptions.js";
+export * from "./models/IStaticContextIdProcessorConfig.js";
+export * from "./models/IStaticContextIdProcessorConstructorOptions.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,uCAAuC,CAAC;AACtD,cAAc,oCAAoC,CAAC;AACnD,cAAc,uCAAuC,CAAC;AACtD,cAAc,mDAAmD,CAAC;AAClE,cAAc,qCAAqC,CAAC;AACpD,cAAc,iDAAiD,CAAC;AAChE,cAAc,mDAAmD,CAAC;AAClE,cAAc,mCAAmC,CAAC;AAClD,cAAc,qDAAqD,CAAC;AACpE,cAAc,6CAA6C,CAAC;AAC5D,cAAc,yDAAyD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./data/restRouteProcessor.js\";\nexport * from \"./data/socketRouteProcessor.js\";\nexport * from \"./identity/contextIdProcessor.js\";\nexport * from \"./identity/staticContextIdProcessor.js\";\nexport * from \"./logging/loggingProcessor.js\";\nexport * from \"./mimeType/jsonLdMimeTypeProcessor.js\";\nexport * from \"./mimeType/jwtMimeTypeProcessor.js\";\nexport * from \"./models/IContextIdProcessorConfig.js\";\nexport * from \"./models/IContextIdProcessorConstructorOptions.js\";\nexport * from \"./models/ILoggingProcessorConfig.js\";\nexport * from \"./models/ILoggingProcessorConstructorOptions.js\";\nexport * from \"./models/IRestRouteProcessorConstructorOptions.js\";\nexport * from \"./models/IRouteProcessorConfig.js\";\nexport * from \"./models/ISocketRouteProcessorConstructorOptions.js\";\nexport * from \"./models/IStaticContextIdProcessorConfig.js\";\nexport * from \"./models/IStaticContextIdProcessorConstructorOptions.js\";\n"]}

package/dist/es/logging/loggingProcessor.js

@@ -0,0 +1,177 @@
+import { Coerce, ComponentFactory, Is, ObjectHelper } from "@twin.org/core";
+import { HeaderTypes, HttpStatusCode, MimeTypes } from "@twin.org/web";
+/**
+ * Process the REST request and log its information.
+ */
+export class LoggingProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "LoggingProcessor";
+    /**
+     * The component for logging the information.
+     * @internal
+     */
+    _logging;
+    /**
+     * Include the body objects when logging the information.
+     * @internal
+     */
+    _includeBody;
+    /**
+     * Show the full base64 content for data, default to abbreviate.
+     * @internal
+     */
+    _fullBase64;
+    /**
+     * List of property names to obfuscate, defaults to "password".
+     * @internal
+     */
+    _obfuscateProperties;
+    /**
+     * Create a new instance of LoggingProcessor.
+     * @param options Options for the processor.
+     */
+    constructor(options) {
+        this._logging = ComponentFactory.getIfExists(options?.loggingComponentType ?? "logging");
+        this._includeBody = options?.config?.includeBody ?? false;
+        this._fullBase64 = options?.config?.fullBase64 ?? false;
+        this._obfuscateProperties = options?.config?.obfuscateProperties ?? ["password"];
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return LoggingProcessor.CLASS_NAME;
+    }
+    /**
+     * Pre process the REST request for the specified route.
+     * @param request The incoming request.
+     * @param response The outgoing response.
+     * @param route The route to process.
+     * @param contextIds The context IDs of the request.
+     * @param processorState The state handed through the processors.
+     */
+    async pre(request, response, route, contextIds, processorState) {
+        const now = process.hrtime.bigint();
+        processorState.requestStart = now;
+        const contentType = request.headers?.[HeaderTypes.ContentType];
+        const isJson = this.isMimeJson(contentType);
+        let requestUrl = "";
+        if (Is.stringValue(request.url)) {
+            // Socket paths do not have a prefix so just use the whole url.
+            if (request.url.startsWith("http")) {
+                requestUrl = new URL(request.url).pathname;
+            }
+            else {
+                requestUrl = request.url;
+            }
+        }
+        await this._logging?.log({
+            level: "info",
+            source: LoggingProcessor.CLASS_NAME,
+            ts: Date.now(),
+            message: `===> ${request.method} ${requestUrl}`,
+            data: this._includeBody && isJson
+                ? this.processJson("body", ObjectHelper.clone(request?.body))
+                : undefined
+        });
+    }
+    /**
+     * Post process the REST request for the specified route.
+     * @param request The incoming request.
+     * @param response The outgoing response.
+     * @param route The route to process.
+     * @param contextIds The context IDs of the request.
+     * @param processorState The state handed through the processors.
+     */
+    async post(request, response, route, contextIds, processorState) {
+        let data;
+        if (this._includeBody) {
+            const contentType = response.headers?.[HeaderTypes.ContentType];
+            const isJson = this.isMimeJson(contentType);
+            const contentLength = response.headers?.[HeaderTypes.ContentLength];
+            if (isJson) {
+                data = {
+                    body: this.processJson("body", ObjectHelper.clone(response.body))
+                };
+            }
+            else {
+                const dataParts = {};
+                if (Is.stringValue(contentType)) {
+                    dataParts["Content Type"] = contentType;
+                }
+                if (Is.stringValue(contentLength)) {
+                    dataParts["Content Length"] = contentLength;
+                }
+                if (Object.keys(dataParts).length > 0) {
+                    data = {
+                        headers: dataParts
+                    };
+                }
+            }
+        }
+        const now = process.hrtime.bigint();
+        const start = Coerce.bigint(processorState.requestStart) ?? now;
+        const elapsed = now - start;
+        const elapsedMicroSeconds = Math.floor(Number(elapsed) / 1000);
+        let requestUrl = "";
+        if (Is.stringValue(request.url)) {
+            // Socket paths do not have a prefix so just use the whole url.
+            if (request.url.startsWith("http")) {
+                requestUrl = new URL(request.url).pathname;
+            }
+            else {
+                requestUrl = request.url;
+            }
+        }
+        await this._logging?.log({
+            level: Is.number(response.statusCode) && response.statusCode >= HttpStatusCode.badRequest
+                ? "error"
+                : "info",
+            source: LoggingProcessor.CLASS_NAME,
+            ts: Date.now(),
+            message: `<=== ${response.statusCode ?? ""} ${request.method} ${requestUrl} duration: ${elapsedMicroSeconds}µs`,
+            data
+        });
+    }
+    /**
+     * Process the JSON.
+     * @param propValue The property to process.
+     * @returns The processed property.
+     * @internal
+     */
+    processJson(propName, propValue) {
+        if (Is.array(propValue)) {
+            for (let i = 0; i < propValue.length; i++) {
+                propValue[i] = this.processJson(`${i}`, propValue[i]);
+            }
+        }
+        else if (Is.object(propValue)) {
+            for (const key of Object.keys(propValue)) {
+                propValue[key] = this.processJson(key, propValue[key]);
+            }
+        }
+        else if (!this._fullBase64 && Is.stringBase64(propValue) && propValue.length > 256) {
+            propValue = "<base64>";
+        }
+        else if (Is.string(propValue) &&
+            this._obfuscateProperties.some(op => new RegExp(op).test(propName))) {
+            propValue = "**************";
+        }
+        return propValue;
+    }
+    /**
+     * Check if the content type is JSON.
+     * @param contentType The content type to check.
+     * @returns True if the content type is JSON, false otherwise.
+     * @internal
+     */
+    isMimeJson(contentType) {
+        return Is.stringValue(contentType)
+            ? contentType.includes(MimeTypes.Json) || contentType.includes(MimeTypes.JsonLd)
+            : false;
+    }
+}
+//# sourceMappingURL=loggingProcessor.js.map