@3sixty/api-processors 0.0.0-stage → 0.20.0-next.0

package/dist/es/identity/staticContextIdProcessor.js

@@ -0,0 +1,60 @@
+import { Guards, Is } from "@3sixty/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.
+     * @returns A promise that resolves when the static context ID has been injected into the request.
+     */
+    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,cAAc,CAAC;AAK1C;;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;;;;;;;;OAQG;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 \"@3sixty/api-models\";\nimport type { IContextIds } from \"@3sixty/context\";\nimport { Guards, Is } from \"@3sixty/core\";\nimport { nameof } from \"@3sixty/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 * @returns A promise that resolves when the static context ID has been injected into the request.\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,217 @@
+import { Coerce, ComponentFactory, Is, ObjectHelper } from "@3sixty/core";
+import { HeaderTypes, HttpStatusCode, MimeTypes } from "@3sixty/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;
+    /**
+     * Request URL path prefixes to skip logging, defaults to ["/logging"].
+     * @internal
+     */
+    _excludePaths;
+    /**
+     * Create a new instance of LoggingProcessor.
+     * @param options Options for the processor.
+     */
+    constructor(options) {
+        this._logging = ComponentFactory.getIfExists(options?.loggingComponentType);
+        this._includeBody = options?.config?.includeBody ?? false;
+        this._fullBase64 = options?.config?.fullBase64 ?? false;
+        this._obfuscateProperties = options?.config?.obfuscateProperties ?? ["password"];
+        this._excludePaths = options?.config?.excludePaths ?? ["/logging"];
+    }
+    /**
+     * 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.
+     * @returns A promise that resolves when the pre-processing log entry has been written.
+     */
+    async pre(request, response, route, contextIds, processorState) {
+        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;
+            }
+        }
+        if (this._excludePaths.some(p => requestUrl.startsWith(p))) {
+            return;
+        }
+        const now = process.hrtime.bigint();
+        processorState.requestStart = now;
+        const contentType = request.headers?.[HeaderTypes.ContentType];
+        const isJson = this.isMimeJson(contentType);
+        await this._logging?.log({
+            level: "info",
+            source: LoggingProcessor.CLASS_NAME,
+            ts: Date.now(),
+            message: "requestMessage",
+            data: {
+                method: request.method,
+                requestUrl,
+                body: 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.
+     * @returns A promise that resolves when the post-processing log entry has been written.
+     */
+    async post(request, response, route, contextIds, processorState) {
+        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;
+            }
+        }
+        if (this._excludePaths.some(p => requestUrl.startsWith(p))) {
+            return;
+        }
+        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);
+        if (Is.number(response.statusCode) && response.statusCode >= HttpStatusCode.badRequest) {
+            await this._logging?.log({
+                level: "error",
+                source: LoggingProcessor.CLASS_NAME,
+                ts: Date.now(),
+                message: "responseMessage",
+                data: {
+                    statusCode: response.statusCode,
+                    method: request.method,
+                    requestUrl: requestUrl ?? "",
+                    elapsedMicroSeconds,
+                    ...data
+                }
+            });
+        }
+        else {
+            await this._logging?.log({
+                level: "info",
+                source: LoggingProcessor.CLASS_NAME,
+                ts: Date.now(),
+                message: "responseMessage",
+                data: {
+                    statusCode: response.statusCode,
+                    method: request.method,
+                    requestUrl: requestUrl ?? "",
+                    elapsedMicroSeconds,
+                    ...data
+                }
+            });
+        }
+    }
+    /**
+     * Process the JSON.
+     * @param propName The property name to process.
+     * @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

package/dist/es/logging/loggingProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loggingProcessor.js","sourceRoot":"","sources":["../../../src/logging/loggingProcessor.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAG1E,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGrE;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAC5B;;OAEG;IACI,MAAM,CAAU,UAAU,sBAAsC;IAEvE;;;OAGG;IACc,QAAQ,CAAqB;IAE9C;;;OAGG;IACc,YAAY,CAAU;IAEvC;;;OAGG;IACc,WAAW,CAAU;IAEtC;;;OAGG;IACc,oBAAoB,CAAW;IAEhD;;;OAGG;IACc,aAAa,CAAW;IAEzC;;;OAGG;IACH,YAAY,OAA6C;QACxD,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;QAC5E,IAAI,CAAC,YAAY,GAAG,OAAO,EAAE,MAAM,EAAE,WAAW,IAAI,KAAK,CAAC;QAC1D,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,MAAM,EAAE,UAAU,IAAI,KAAK,CAAC;QACxD,IAAI,CAAC,oBAAoB,GAAG,OAAO,EAAE,MAAM,EAAE,mBAAmB,IAAI,CAAC,UAAU,CAAC,CAAC;QACjF,IAAI,CAAC,aAAa,GAAG,OAAO,EAAE,MAAM,EAAE,YAAY,IAAI,CAAC,UAAU,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,gBAAgB,CAAC,UAAU,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,GAAG,CACf,OAA2B,EAC3B,QAAuB,EACvB,KAA6B,EAC7B,UAAuB,EACvB,cAAyC;QAEzC,IAAI,UAAU,GAAG,EAAE,CAAC;QACpB,IAAI,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACjC,+DAA+D;YAC/D,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBACpC,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;YAC5C,CAAC;iBAAM,CAAC;gBACP,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC;YAC1B,CAAC;QACF,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5D,OAAO;QACR,CAAC;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACpC,cAAc,CAAC,YAAY,GAAG,GAAG,CAAC;QAElC,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QAC/D,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAE5C,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;YACxB,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,gBAAgB,CAAC,UAAU;YACnC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE;gBACL,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,UAAU;gBACV,IAAI,EACH,IAAI,CAAC,YAAY,IAAI,MAAM;oBAC1B,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;oBAC7D,CAAC,CAAC,SAAS;aACb;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,IAAI,CAChB,OAA2B,EAC3B,QAAuB,EACvB,KAA6B,EAC7B,UAAuB,EACvB,cAAyC;QAEzC,IAAI,UAAU,GAAG,EAAE,CAAC;QACpB,IAAI,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACjC,+DAA+D;YAC/D,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBACpC,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;YAC5C,CAAC;iBAAM,CAAC;gBACP,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC;YAC1B,CAAC;QACF,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5D,OAAO;QACR,CAAC;QAED,IAAI,IAA2C,CAAC;QAChD,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YAChE,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YAC5C,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;YACpE,IAAI,MAAM,EAAE,CAAC;gBACZ,IAAI,GAAG;oBACN,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;iBACjE,CAAC;YACH,CAAC;iBAAM,CAAC;gBACP,MAAM,SAAS,GAA6B,EAAE,CAAC;gBAC/C,IAAI,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;oBACjC,SAAS,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC;gBACzC,CAAC;gBACD,IAAI,EAAE,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC;oBACnC,SAAS,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;gBAC7C,CAAC;gBACD,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACvC,IAAI,GAAG;wBACN,OAAO,EAAE,SAAS;qBAClB,CAAC;gBACH,CAAC;YACF,CAAC;QACF,CAAC;QACD,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC;QAChE,MAAM,OAAO,GAAG,GAAG,GAAG,KAAK,CAAC;QAC5B,MAAM,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;QAE/D,IAAI,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,UAAU,IAAI,cAAc,CAAC,UAAU,EAAE,CAAC;YACxF,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;gBACxB,KAAK,EAAE,OAAO;gBACd,MAAM,EAAE,gBAAgB,CAAC,UAAU;gBACnC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,iBAAiB;gBAC1B,IAAI,EAAE;oBACL,UAAU,EAAE,QAAQ,CAAC,UAAU;oBAC/B,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,UAAU,EAAE,UAAU,IAAI,EAAE;oBAC5B,mBAAmB;oBACnB,GAAG,IAAI;iBACP;aACD,CAAC,CAAC;QACJ,CAAC;aAAM,CAAC;YACP,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;gBACxB,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,gBAAgB,CAAC,UAAU;gBACnC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,iBAAiB;gBAC1B,IAAI,EAAE;oBACL,UAAU,EAAE,QAAQ,CAAC,UAAU;oBAC/B,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,UAAU,EAAE,UAAU,IAAI,EAAE;oBAC5B,mBAAmB;oBACnB,GAAG,IAAI;iBACP;aACD,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACK,WAAW,CAAC,QAAgB,EAAE,SAAkB;QACvD,IAAI,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;YACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC3C,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;YACvD,CAAC;QACF,CAAC;aAAM,IAAI,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YACjC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC1C,SAAS,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;YACxD,CAAC;QACF,CAAC;aAAM,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YACtF,SAAS,GAAG,UAAU,CAAC;QACxB,CAAC;aAAM,IACN,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC;YACpB,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAClE,CAAC;YACF,SAAS,GAAG,gBAAgB,CAAC;QAC9B,CAAC;QAED,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACK,UAAU,CAAC,WAA0C;QAC5D,OAAO,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC;YACjC,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC;YAChF,CAAC,CAAC,KAAK,CAAC;IACV,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 \"@3sixty/api-models\";\nimport type { IContextIds } from \"@3sixty/context\";\nimport { Coerce, ComponentFactory, Is, ObjectHelper } from \"@3sixty/core\";\nimport type { ILoggingComponent } from \"@3sixty/logging-models\";\nimport { nameof } from \"@3sixty/nameof\";\nimport { HeaderTypes, HttpStatusCode, MimeTypes } from \"@3sixty/web\";\nimport type { ILoggingProcessorConstructorOptions } from \"../models/ILoggingProcessorConstructorOptions.js\";\n\n/**\n * Process the REST request and log its information.\n */\nexport class LoggingProcessor implements IBaseRouteProcessor {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<LoggingProcessor>();\n\n\t/**\n\t * The component for logging the information.\n\t * @internal\n\t */\n\tprivate readonly _logging?: ILoggingComponent;\n\n\t/**\n\t * Include the body objects when logging the information.\n\t * @internal\n\t */\n\tprivate readonly _includeBody: boolean;\n\n\t/**\n\t * Show the full base64 content for data, default to abbreviate.\n\t * @internal\n\t */\n\tprivate readonly _fullBase64: boolean;\n\n\t/**\n\t * List of property names to obfuscate, defaults to \"password\".\n\t * @internal\n\t */\n\tprivate readonly _obfuscateProperties: string[];\n\n\t/**\n\t * Request URL path prefixes to skip logging, defaults to [\"/logging\"].\n\t * @internal\n\t */\n\tprivate readonly _excludePaths: string[];\n\n\t/**\n\t * Create a new instance of LoggingProcessor.\n\t * @param options Options for the processor.\n\t */\n\tconstructor(options?: ILoggingProcessorConstructorOptions) {\n\t\tthis._logging = ComponentFactory.getIfExists(options?.loggingComponentType);\n\t\tthis._includeBody = options?.config?.includeBody ?? false;\n\t\tthis._fullBase64 = options?.config?.fullBase64 ?? false;\n\t\tthis._obfuscateProperties = options?.config?.obfuscateProperties ?? [\"password\"];\n\t\tthis._excludePaths = options?.config?.excludePaths ?? [\"/logging\"];\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 LoggingProcessor.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 * @returns A promise that resolves when the pre-processing log entry has been written.\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\tlet requestUrl = \"\";\n\t\tif (Is.stringValue(request.url)) {\n\t\t\t// Socket paths do not have a prefix so just use the whole url.\n\t\t\tif (request.url.startsWith(\"http\")) {\n\t\t\t\trequestUrl = new URL(request.url).pathname;\n\t\t\t} else {\n\t\t\t\trequestUrl = request.url;\n\t\t\t}\n\t\t}\n\n\t\tif (this._excludePaths.some(p => requestUrl.startsWith(p))) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst now = process.hrtime.bigint();\n\t\tprocessorState.requestStart = now;\n\n\t\tconst contentType = request.headers?.[HeaderTypes.ContentType];\n\t\tconst isJson = this.isMimeJson(contentType);\n\n\t\tawait this._logging?.log({\n\t\t\tlevel: \"info\",\n\t\t\tsource: LoggingProcessor.CLASS_NAME,\n\t\t\tts: Date.now(),\n\t\t\tmessage: \"requestMessage\",\n\t\t\tdata: {\n\t\t\t\tmethod: request.method,\n\t\t\t\trequestUrl,\n\t\t\t\tbody:\n\t\t\t\t\tthis._includeBody && isJson\n\t\t\t\t\t\t? this.processJson(\"body\", ObjectHelper.clone(request?.body))\n\t\t\t\t\t\t: undefined\n\t\t\t}\n\t\t});\n\t}\n\n\t/**\n\t * Post 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 * @returns A promise that resolves when the post-processing log entry has been written.\n\t */\n\tpublic async post(\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\tlet requestUrl = \"\";\n\t\tif (Is.stringValue(request.url)) {\n\t\t\t// Socket paths do not have a prefix so just use the whole url.\n\t\t\tif (request.url.startsWith(\"http\")) {\n\t\t\t\trequestUrl = new URL(request.url).pathname;\n\t\t\t} else {\n\t\t\t\trequestUrl = request.url;\n\t\t\t}\n\t\t}\n\n\t\tif (this._excludePaths.some(p => requestUrl.startsWith(p))) {\n\t\t\treturn;\n\t\t}\n\n\t\tlet data: { [id: string]: unknown } | undefined;\n\t\tif (this._includeBody) {\n\t\t\tconst contentType = response.headers?.[HeaderTypes.ContentType];\n\t\t\tconst isJson = this.isMimeJson(contentType);\n\t\t\tconst contentLength = response.headers?.[HeaderTypes.ContentLength];\n\t\t\tif (isJson) {\n\t\t\t\tdata = {\n\t\t\t\t\tbody: this.processJson(\"body\", ObjectHelper.clone(response.body))\n\t\t\t\t};\n\t\t\t} else {\n\t\t\t\tconst dataParts: { [id: string]: string } = {};\n\t\t\t\tif (Is.stringValue(contentType)) {\n\t\t\t\t\tdataParts[\"Content Type\"] = contentType;\n\t\t\t\t}\n\t\t\t\tif (Is.stringValue(contentLength)) {\n\t\t\t\t\tdataParts[\"Content Length\"] = contentLength;\n\t\t\t\t}\n\t\t\t\tif (Object.keys(dataParts).length > 0) {\n\t\t\t\t\tdata = {\n\t\t\t\t\t\theaders: dataParts\n\t\t\t\t\t};\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tconst now = process.hrtime.bigint();\n\t\tconst start = Coerce.bigint(processorState.requestStart) ?? now;\n\t\tconst elapsed = now - start;\n\t\tconst elapsedMicroSeconds = Math.floor(Number(elapsed) / 1000);\n\n\t\tif (Is.number(response.statusCode) && response.statusCode >= HttpStatusCode.badRequest) {\n\t\t\tawait this._logging?.log({\n\t\t\t\tlevel: \"error\",\n\t\t\t\tsource: LoggingProcessor.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"responseMessage\",\n\t\t\t\tdata: {\n\t\t\t\t\tstatusCode: response.statusCode,\n\t\t\t\t\tmethod: request.method,\n\t\t\t\t\trequestUrl: requestUrl ?? \"\",\n\t\t\t\t\telapsedMicroSeconds,\n\t\t\t\t\t...data\n\t\t\t\t}\n\t\t\t});\n\t\t} else {\n\t\t\tawait this._logging?.log({\n\t\t\t\tlevel: \"info\",\n\t\t\t\tsource: LoggingProcessor.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"responseMessage\",\n\t\t\t\tdata: {\n\t\t\t\t\tstatusCode: response.statusCode,\n\t\t\t\t\tmethod: request.method,\n\t\t\t\t\trequestUrl: requestUrl ?? \"\",\n\t\t\t\t\telapsedMicroSeconds,\n\t\t\t\t\t...data\n\t\t\t\t}\n\t\t\t});\n\t\t}\n\t}\n\n\t/**\n\t * Process the JSON.\n\t * @param propName The property name to process.\n\t * @param propValue The property to process.\n\t * @returns The processed property.\n\t * @internal\n\t */\n\tprivate processJson(propName: string, propValue: unknown): unknown {\n\t\tif (Is.array(propValue)) {\n\t\t\tfor (let i = 0; i < propValue.length; i++) {\n\t\t\t\tpropValue[i] = this.processJson(`${i}`, propValue[i]);\n\t\t\t}\n\t\t} else if (Is.object(propValue)) {\n\t\t\tfor (const key of Object.keys(propValue)) {\n\t\t\t\tpropValue[key] = this.processJson(key, propValue[key]);\n\t\t\t}\n\t\t} else if (!this._fullBase64 && Is.stringBase64(propValue) && propValue.length > 256) {\n\t\t\tpropValue = \"<base64>\";\n\t\t} else if (\n\t\t\tIs.string(propValue) &&\n\t\t\tthis._obfuscateProperties.some(op => new RegExp(op).test(propName))\n\t\t) {\n\t\t\tpropValue = \"**************\";\n\t\t}\n\n\t\treturn propValue;\n\t}\n\n\t/**\n\t * Check if the content type is JSON.\n\t * @param contentType The content type to check.\n\t * @returns True if the content type is JSON, false otherwise.\n\t * @internal\n\t */\n\tprivate isMimeJson(contentType: string | string[] | undefined): boolean {\n\t\treturn Is.stringValue(contentType)\n\t\t\t? contentType.includes(MimeTypes.Json) || contentType.includes(MimeTypes.JsonLd)\n\t\t\t: false;\n\t}\n}\n"]}

package/dist/es/mimeType/jsonLdMimeTypeProcessor.js

@@ -0,0 +1,38 @@
+import { GeneralError, Is, ObjectHelper } from "@3sixty/core";
+import { MimeTypes } from "@3sixty/web";
+/**
+ * Process the JSON-LD mime type.
+ */
+export class JsonLdMimeTypeProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "JsonLdMimeTypeProcessor";
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return JsonLdMimeTypeProcessor.CLASS_NAME;
+    }
+    /**
+     * Get the MIME types that this handler can handle.
+     * @returns The MIME types that this handler can handle.
+     */
+    getTypes() {
+        return [MimeTypes.JsonLd];
+    }
+    /**
+     * Handle content.
+     * @param body The body to process.
+     * @returns The processed body.
+     */
+    async handle(body) {
+        const json = ObjectHelper.fromBytes(body);
+        if (Is.empty(json) || Is.empty(json["@context"])) {
+            throw new GeneralError(JsonLdMimeTypeProcessor.CLASS_NAME, "invalidJsonLd");
+        }
+        return json;
+    }
+}
+//# sourceMappingURL=jsonLdMimeTypeProcessor.js.map

package/dist/es/mimeType/jsonLdMimeTypeProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonLdMimeTypeProcessor.js","sourceRoot":"","sources":["../../../src/mimeType/jsonLdMimeTypeProcessor.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE9D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;GAEG;AACH,MAAM,OAAO,uBAAuB;IACnC;;OAEG;IACI,MAAM,CAAU,UAAU,6BAA6C;IAE9E;;;OAGG;IACI,SAAS;QACf,OAAO,uBAAuB,CAAC,UAAU,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACI,QAAQ;QACd,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,IAAgB;QACnC,MAAM,IAAI,GAAG,YAAY,CAAC,SAAS,CAA0B,IAAI,CAAC,CAAC;QAEnE,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YAClD,MAAM,IAAI,YAAY,CAAC,uBAAuB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;QAC7E,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IMimeTypeProcessor } from \"@3sixty/api-models\";\nimport { GeneralError, Is, ObjectHelper } from \"@3sixty/core\";\nimport { nameof } from \"@3sixty/nameof\";\nimport { MimeTypes } from \"@3sixty/web\";\n\n/**\n * Process the JSON-LD mime type.\n */\nexport class JsonLdMimeTypeProcessor implements IMimeTypeProcessor {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<JsonLdMimeTypeProcessor>();\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 JsonLdMimeTypeProcessor.CLASS_NAME;\n\t}\n\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\tpublic getTypes(): string[] {\n\t\treturn [MimeTypes.JsonLd];\n\t}\n\n\t/**\n\t * Handle content.\n\t * @param body The body to process.\n\t * @returns The processed body.\n\t */\n\tpublic async handle(body: Uint8Array): Promise<unknown> {\n\t\tconst json = ObjectHelper.fromBytes<{ \"@context\"?: string }>(body);\n\n\t\tif (Is.empty(json) || Is.empty(json[\"@context\"])) {\n\t\t\tthrow new GeneralError(JsonLdMimeTypeProcessor.CLASS_NAME, \"invalidJsonLd\");\n\t\t}\n\n\t\treturn json;\n\t}\n}\n"]}

package/dist/es/mimeType/jwtMimeTypeProcessor.js

@@ -0,0 +1,34 @@
+import { Converter } from "@3sixty/core";
+import { MimeTypes } from "@3sixty/web";
+/**
+ * Process the JWT mime type.
+ */
+export class JwtMimeTypeProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "JwtMimeTypeProcessor";
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return JwtMimeTypeProcessor.CLASS_NAME;
+    }
+    /**
+     * Get the MIME types that this handler can handle.
+     * @returns The MIME types that this handler can handle.
+     */
+    getTypes() {
+        return [MimeTypes.Jwt];
+    }
+    /**
+     * Handle content.
+     * @param body The body to process.
+     * @returns The processed body.
+     */
+    async handle(body) {
+        return Converter.bytesToUtf8(body);
+    }
+}
+//# sourceMappingURL=jwtMimeTypeProcessor.js.map

package/dist/es/mimeType/jwtMimeTypeProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jwtMimeTypeProcessor.js","sourceRoot":"","sources":["../../../src/mimeType/jwtMimeTypeProcessor.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAChC;;OAEG;IACI,MAAM,CAAU,UAAU,0BAA0C;IAE3E;;;OAGG;IACI,SAAS;QACf,OAAO,oBAAoB,CAAC,UAAU,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,QAAQ;QACd,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,IAAgB;QACnC,OAAO,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IMimeTypeProcessor } from \"@3sixty/api-models\";\nimport { Converter } from \"@3sixty/core\";\nimport { nameof } from \"@3sixty/nameof\";\nimport { MimeTypes } from \"@3sixty/web\";\n\n/**\n * Process the JWT mime type.\n */\nexport class JwtMimeTypeProcessor implements IMimeTypeProcessor {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<JwtMimeTypeProcessor>();\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 JwtMimeTypeProcessor.CLASS_NAME;\n\t}\n\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\tpublic getTypes(): string[] {\n\t\treturn [MimeTypes.Jwt];\n\t}\n\n\t/**\n\t * Handle content.\n\t * @param body The body to process.\n\t * @returns The processed body.\n\t */\n\tpublic async handle(body: Uint8Array): Promise<unknown> {\n\t\treturn Converter.bytesToUtf8(body);\n\t}\n}\n"]}

package/dist/es/models/IContextIdProcessorConfig.js

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

package/dist/es/models/IContextIdProcessorConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IContextIdProcessorConfig.js","sourceRoot":"","sources":["../../../src/models/IContextIdProcessorConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Configuration for the context id processor.\n */\nexport interface IContextIdProcessorConfig {\n\t/**\n\t * The fixed identity key for request context.\n\t */\n\tkey: string;\n\n\t/**\n\t * Only add the identity if the request is authenticated.\n\t */\n\tauthOnly?: boolean;\n}\n"]}

package/dist/es/models/IContextIdProcessorConstructorOptions.js

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

package/dist/es/models/IContextIdProcessorConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IContextIdProcessorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IContextIdProcessorConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IContextIdProcessorConfig } from \"./IContextIdProcessorConfig.js\";\n\n/**\n * Options for the ContextIdProcessor constructor.\n */\nexport interface IContextIdProcessorConstructorOptions {\n\t/**\n\t * The configuration for the processor.\n\t */\n\tconfig: IContextIdProcessorConfig;\n}\n"]}

package/dist/es/models/ILoggingProcessorConfig.js

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

package/dist/es/models/ILoggingProcessorConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ILoggingProcessorConfig.js","sourceRoot":"","sources":["../../../src/models/ILoggingProcessorConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Configuration for the request logging processor.\n */\nexport interface ILoggingProcessorConfig {\n\t/**\n\t * Include the body objects when logging the information.\n\t */\n\tincludeBody?: boolean;\n\n\t/**\n\t * Show the full base64 content for data, default to abbreviate.\n\t */\n\tfullBase64?: boolean;\n\n\t/**\n\t * List of property names to obfuscate, can be regex, defaults to \"password\".\n\t */\n\tobfuscateProperties?: string[];\n\n\t/**\n\t * Request URL path prefixes to exclude from logging, defaults to [\"/logging\"].\n\t * Use this to prevent the logging endpoint itself from appearing in its own output.\n\t */\n\texcludePaths?: string[];\n}\n"]}

package/dist/es/models/ILoggingProcessorConstructorOptions.js

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

package/dist/es/models/ILoggingProcessorConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ILoggingProcessorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/ILoggingProcessorConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ILoggingProcessorConfig } from \"./ILoggingProcessorConfig.js\";\n\n/**\n * Options for the LoggingProcessor constructor.\n */\nexport interface ILoggingProcessorConstructorOptions {\n\t/**\n\t * The type for the logging component.\n\t */\n\tloggingComponentType?: string;\n\n\t/**\n\t * The configuration for the logging processor.\n\t */\n\tconfig?: ILoggingProcessorConfig;\n}\n"]}

package/dist/es/models/IRestRouteProcessorConstructorOptions.js

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

package/dist/es/models/IRestRouteProcessorConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRouteProcessorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IRestRouteProcessorConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRouteProcessorConfig } from \"../models/IRouteProcessorConfig.js\";\n\n/**\n * Options for the RestRouteProcessor constructor.\n */\nexport interface IRestRouteProcessorConstructorOptions {\n\t/**\n\t * The configuration for the processor.\n\t */\n\tconfig?: IRouteProcessorConfig;\n}\n"]}

package/dist/es/models/IRouteProcessorConfig.js

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

package/dist/es/models/IRouteProcessorConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRouteProcessorConfig.js","sourceRoot":"","sources":["../../../src/models/IRouteProcessorConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Configuration for the route processor.\n */\nexport interface IRouteProcessorConfig {\n\t/**\n\t * Include the stack with errors.\n\t */\n\tincludeErrorStack?: boolean;\n}\n"]}

package/dist/es/models/ISocketRouteProcessorConstructorOptions.js

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

package/dist/es/models/ISocketRouteProcessorConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISocketRouteProcessorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/ISocketRouteProcessorConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRouteProcessorConfig } from \"./IRouteProcessorConfig.js\";\n\n/**\n * Options for the SocketRouteProcessor constructor.\n */\nexport interface ISocketRouteProcessorConstructorOptions {\n\t/**\n\t * The configuration for the processor.\n\t */\n\tconfig?: IRouteProcessorConfig;\n}\n"]}

package/dist/es/models/IStaticContextIdProcessorConfig.js

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

package/dist/es/models/IStaticContextIdProcessorConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IStaticContextIdProcessorConfig.js","sourceRoot":"","sources":["../../../src/models/IStaticContextIdProcessorConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Configuration for the static id processor.\n */\nexport interface IStaticContextIdProcessorConfig {\n\t/**\n\t * The fixed identity key for request context.\n\t */\n\tkey: string;\n\n\t/**\n\t * The fixed identity value for request context.\n\t */\n\tvalue: string;\n\n\t/**\n\t * Only add the identity if the request is authenticated.\n\t */\n\tauthOnly?: boolean;\n}\n"]}

package/dist/es/models/IStaticContextIdProcessorConstructorOptions.js

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

package/dist/es/models/IStaticContextIdProcessorConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IStaticContextIdProcessorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IStaticContextIdProcessorConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IStaticContextIdProcessorConfig } from \"./IStaticContextIdProcessorConfig.js\";\n\n/**\n * Options for the StaticContextIdProcessor constructor.\n */\nexport interface IStaticContextIdProcessorConstructorOptions {\n\t/**\n\t * The configuration for the processor.\n\t */\n\tconfig: IStaticContextIdProcessorConfig;\n}\n"]}

package/dist/types/data/restRouteProcessor.d.ts

@@ -0,0 +1,36 @@
+import { type IHttpResponse, type IHttpServerRequest, type IRestRoute, type IRestRouteProcessor } from "@3sixty/api-models";
+import type { IRestRouteProcessorConstructorOptions } from "../models/IRestRouteProcessorConstructorOptions.js";
+/**
+ * Process the REST request and hands it on to the route handler.
+ */
+export declare class RestRouteProcessor implements IRestRouteProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of RouteProcessor.
+     * @param options Options for the processor.
+     */
+    constructor(options?: IRestRouteProcessorConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * 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 componentTypes The component types for the request.
+     * @param componentTypes.loggingComponentType The logging component type.
+     * @returns A promise that resolves when the request has been processed and the response populated.
+     */
+    process(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, processorState: {
+        [id: string]: unknown;
+    }, componentTypes?: {
+        loggingComponentType?: string;
+    }): Promise<void>;
+}

package/dist/types/data/socketRouteProcessor.d.ts

@@ -0,0 +1,50 @@
+import { type IHttpResponse, type ISocketRoute, type ISocketRouteProcessor, type ISocketServerRequest } from "@3sixty/api-models";
+import type { ISocketRouteProcessorConstructorOptions } from "../models/ISocketRouteProcessorConstructorOptions.js";
+/**
+ * Process the socket request and hands it on to the route handler.
+ */
+export declare class SocketRouteProcessor implements ISocketRouteProcessor {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of SocketRouteProcessor.
+     * @param options Options for the processor.
+     */
+    constructor(options?: ISocketRouteProcessorConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * 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.
+     */
+    connected(request: ISocketServerRequest, route: ISocketRoute | undefined, loggingComponentType?: string): Promise<void>;
+    /**
+     * 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.
+     */
+    disconnected(request: ISocketServerRequest, route: ISocketRoute | undefined, loggingComponentType?: string): Promise<void>;
+    /**
+     * 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.
+     * @returns A promise that resolves when the request has been processed and the response emitted.
+     */
+    process(request: ISocketServerRequest, response: IHttpResponse, route: ISocketRoute | undefined, processorState: {
+        [id: string]: unknown;
+    }, responseEmitter: (topic: string, response: IHttpResponse) => Promise<void>, loggingComponentType?: string): Promise<void>;
+}