@twin.org/api-processors 0.0.1-next.10 → 0.0.1-next.12

package/dist/cjs/index.cjs

@@ -113,29 +113,27 @@ class RouteProcessor {
 }
 
 /**
- * Adds a static user identity to the request context.
+ * Adds a node identity to the request identity.
  */
-class StaticUserIdentityProcessor {
+class NodeIdentityProcessor {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "StaticUserIdentityProcessor";
+    CLASS_NAME = "NodeIdentityProcessor";
     /**
-     * The fixed identity for request context.
+     * The node identity for request context.
      * @internal
      */
-    _userIdentity;
+    _nodeIdentity;
     /**
-     * Create a new instance of StaticIdentityProcessor.
-     * @param options Options for the processor.
-     * @param options.config The configuration for the processor.
-     * @returns Promise that resolves when the processor is initialized.
+     * The service needs to be started when the application is initialized.
+     * @param nodeIdentity The identity of the node.
+     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @returns Nothing.
      */
-    constructor(options) {
-        core.Guards.object(this.CLASS_NAME, "options", options);
-        core.Guards.object(this.CLASS_NAME, "options.config", options.config);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.userIdentity", options.config.userIdentity);
-        this._userIdentity = options.config.userIdentity;
+    async start(nodeIdentity, nodeLoggingConnectorType) {
+        core.Guards.string(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
+        this._nodeIdentity = nodeIdentity;
     }
     /**
      * Pre process the REST request for the specified route.
@@ -146,34 +144,34 @@ class StaticUserIdentityProcessor {
      * @param processorState The state handed through the processors.
      */
     async pre(request, response, route, requestIdentity, processorState) {
-        if (!core.Is.empty(route) && !(route.skipAuth ?? false)) {
-            requestIdentity.userIdentity = this._userIdentity;
-        }
+        requestIdentity.nodeIdentity = this._nodeIdentity;
     }
 }
 
 /**
- * Adds a node identity to the request identity.
+ * Adds a static user identity to the request context.
  */
-class NodeIdentityProcessor {
+class StaticUserIdentityProcessor {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "NodeIdentityProcessor";
+    CLASS_NAME = "StaticUserIdentityProcessor";
     /**
-     * The node identity for request context.
+     * The fixed identity for request context.
      * @internal
      */
-    _nodeIdentity;
+    _userIdentity;
     /**
-     * The service needs to be started when the application is initialized.
-     * @param nodeIdentity The identity of the node.
-     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
-     * @returns Nothing.
+     * Create a new instance of StaticIdentityProcessor.
+     * @param options Options for the processor.
+     * @param options.config The configuration for the processor.
+     * @returns Promise that resolves when the processor is initialized.
      */
-    async start(nodeIdentity, nodeLoggingConnectorType) {
-        core.Guards.string(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-        this._nodeIdentity = nodeIdentity;
+    constructor(options) {
+        core.Guards.object(this.CLASS_NAME, "options", options);
+        core.Guards.object(this.CLASS_NAME, "options.config", options.config);
+        core.Guards.stringValue(this.CLASS_NAME, "options.config.userIdentity", options.config.userIdentity);
+        this._userIdentity = options.config.userIdentity;
     }
     /**
      * Pre process the REST request for the specified route.
@@ -184,7 +182,9 @@ class NodeIdentityProcessor {
      * @param processorState The state handed through the processors.
      */
     async pre(request, response, route, requestIdentity, processorState) {
-        requestIdentity.nodeIdentity = this._nodeIdentity;
+        if (!core.Is.empty(route) && !(route.skipAuth ?? false)) {
+            requestIdentity.userIdentity = this._userIdentity;
+        }
     }
 }
 
@@ -321,7 +321,7 @@ class LoggingProcessor {
                 propValue[key] = this.processJson(key, propValue[key]);
             }
         }
-        else if (core.Is.stringBase64(propValue) && !this._fullBase64) {
+        else if (!this._fullBase64 && core.Is.stringBase64(propValue) && propValue.length > 256) {
             propValue = "<base64>";
         }
         else if (core.Is.string(propValue) &&
@@ -332,6 +332,28 @@ class LoggingProcessor {
     }
 }
 
+/**
+ * Process the REST request and log its information.
+ */
+class JwtMimeTypeProcessor {
+    /**
+     * Get the MIME types that this handler can handle.
+     * @returns The MIME types that this handler can handle.
+     */
+    getTypes() {
+        return [web.MimeTypes.Jwt];
+    }
+    /**
+     * Handle content.
+     * @param body The body to process.
+     * @returns The processed body.
+     */
+    async handle(body) {
+        return core.Converter.bytesToUtf8(body);
+    }
+}
+
+exports.JwtMimeTypeProcessor = JwtMimeTypeProcessor;
 exports.LoggingProcessor = LoggingProcessor;
 exports.NodeIdentityProcessor = NodeIdentityProcessor;
 exports.RouteProcessor = RouteProcessor;

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
 import { HttpErrorHelper } from '@twin.org/api-models';
-import { Is, NotFoundError, Guards, ObjectHelper, Coerce } from '@twin.org/core';
+import { Is, NotFoundError, Guards, ObjectHelper, Coerce, Converter } from '@twin.org/core';
 import { HttpStatusCode, HeaderTypes, MimeTypes } from '@twin.org/web';
 import { LoggingConnectorFactory } from '@twin.org/logging-models';
 
@@ -111,29 +111,27 @@ class RouteProcessor {
 }
 
 /**
- * Adds a static user identity to the request context.
+ * Adds a node identity to the request identity.
  */
-class StaticUserIdentityProcessor {
+class NodeIdentityProcessor {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "StaticUserIdentityProcessor";
+    CLASS_NAME = "NodeIdentityProcessor";
     /**
-     * The fixed identity for request context.
+     * The node identity for request context.
      * @internal
      */
-    _userIdentity;
+    _nodeIdentity;
     /**
-     * Create a new instance of StaticIdentityProcessor.
-     * @param options Options for the processor.
-     * @param options.config The configuration for the processor.
-     * @returns Promise that resolves when the processor is initialized.
+     * The service needs to be started when the application is initialized.
+     * @param nodeIdentity The identity of the node.
+     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @returns Nothing.
      */
-    constructor(options) {
-        Guards.object(this.CLASS_NAME, "options", options);
-        Guards.object(this.CLASS_NAME, "options.config", options.config);
-        Guards.stringValue(this.CLASS_NAME, "options.config.userIdentity", options.config.userIdentity);
-        this._userIdentity = options.config.userIdentity;
+    async start(nodeIdentity, nodeLoggingConnectorType) {
+        Guards.string(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
+        this._nodeIdentity = nodeIdentity;
     }
     /**
      * Pre process the REST request for the specified route.
@@ -144,34 +142,34 @@ class StaticUserIdentityProcessor {
      * @param processorState The state handed through the processors.
      */
     async pre(request, response, route, requestIdentity, processorState) {
-        if (!Is.empty(route) && !(route.skipAuth ?? false)) {
-            requestIdentity.userIdentity = this._userIdentity;
-        }
+        requestIdentity.nodeIdentity = this._nodeIdentity;
     }
 }
 
 /**
- * Adds a node identity to the request identity.
+ * Adds a static user identity to the request context.
  */
-class NodeIdentityProcessor {
+class StaticUserIdentityProcessor {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "NodeIdentityProcessor";
+    CLASS_NAME = "StaticUserIdentityProcessor";
     /**
-     * The node identity for request context.
+     * The fixed identity for request context.
      * @internal
      */
-    _nodeIdentity;
+    _userIdentity;
     /**
-     * The service needs to be started when the application is initialized.
-     * @param nodeIdentity The identity of the node.
-     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
-     * @returns Nothing.
+     * Create a new instance of StaticIdentityProcessor.
+     * @param options Options for the processor.
+     * @param options.config The configuration for the processor.
+     * @returns Promise that resolves when the processor is initialized.
      */
-    async start(nodeIdentity, nodeLoggingConnectorType) {
-        Guards.string(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-        this._nodeIdentity = nodeIdentity;
+    constructor(options) {
+        Guards.object(this.CLASS_NAME, "options", options);
+        Guards.object(this.CLASS_NAME, "options.config", options.config);
+        Guards.stringValue(this.CLASS_NAME, "options.config.userIdentity", options.config.userIdentity);
+        this._userIdentity = options.config.userIdentity;
     }
     /**
      * Pre process the REST request for the specified route.
@@ -182,7 +180,9 @@ class NodeIdentityProcessor {
      * @param processorState The state handed through the processors.
      */
     async pre(request, response, route, requestIdentity, processorState) {
-        requestIdentity.nodeIdentity = this._nodeIdentity;
+        if (!Is.empty(route) && !(route.skipAuth ?? false)) {
+            requestIdentity.userIdentity = this._userIdentity;
+        }
     }
 }
 
@@ -319,7 +319,7 @@ class LoggingProcessor {
                 propValue[key] = this.processJson(key, propValue[key]);
             }
         }
-        else if (Is.stringBase64(propValue) && !this._fullBase64) {
+        else if (!this._fullBase64 && Is.stringBase64(propValue) && propValue.length > 256) {
             propValue = "<base64>";
         }
         else if (Is.string(propValue) &&
@@ -330,4 +330,25 @@ class LoggingProcessor {
     }
 }
 
-export { LoggingProcessor, NodeIdentityProcessor, RouteProcessor, StaticUserIdentityProcessor };
+/**
+ * Process the REST request and log its information.
+ */
+class JwtMimeTypeProcessor {
+    /**
+     * 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);
+    }
+}
+
+export { JwtMimeTypeProcessor, LoggingProcessor, NodeIdentityProcessor, RouteProcessor, StaticUserIdentityProcessor };

package/dist/types/index.d.ts

@@ -1,7 +1,8 @@
 export * from "./data/routeProcessor";
-export * from "./identity/staticUserIdentityProcessor";
 export * from "./identity/nodeIdentityProcessor";
+export * from "./identity/staticUserIdentityProcessor";
 export * from "./logging/loggingProcessor";
+export * from "./mimeType/jwtMimeTypeProcessor";
 export * from "./models/IRequestLoggingProcessorConfig";
 export * from "./models/IResponseLoggingProcessorConfig";
 export * from "./models/IRouteProcessorConfig";

package/dist/types/mimeType/jwtMimeTypeProcessor.d.ts

@@ -0,0 +1,17 @@
+import type { IMimeTypeProcessor } from "@twin.org/api-models";
+/**
+ * Process the REST request and log its information.
+ */
+export declare class JwtMimeTypeProcessor implements IMimeTypeProcessor {
+    /**
+     * Get the MIME types that this handler can handle.
+     * @returns The MIME types that this handler can handle.
+     */
+    getTypes(): string[];
+    /**
+     * Handle content.
+     * @param body The body to process.
+     * @returns The processed body.
+     */
+    handle(body: Uint8Array): Promise<unknown>;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/api-processors - Changelog
 
-## v0.0.1-next.10
+## v0.0.1-next.12
 
 - Initial Release

package/docs/reference/classes/JwtMimeTypeProcessor.md

@@ -0,0 +1,59 @@
+# Class: JwtMimeTypeProcessor
+
+Process the REST request and log its information.
+
+## Implements
+
+- `IMimeTypeProcessor`
+
+## Constructors
+
+### new JwtMimeTypeProcessor()
+
+> **new JwtMimeTypeProcessor**(): [`JwtMimeTypeProcessor`](JwtMimeTypeProcessor.md)
+
+#### Returns
+
+[`JwtMimeTypeProcessor`](JwtMimeTypeProcessor.md)
+
+## Methods
+
+### getTypes()
+
+> **getTypes**(): `string`[]
+
+Get the MIME types that this handler can handle.
+
+#### Returns
+
+`string`[]
+
+The MIME types that this handler can handle.
+
+#### Implementation of
+
+`IMimeTypeProcessor.getTypes`
+
+***
+
+### handle()
+
+> **handle**(`body`): `Promise`\<`unknown`\>
+
+Handle content.
+
+#### Parameters
+
+• **body**: `Uint8Array`
+
+The body to process.
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+The processed body.
+
+#### Implementation of
+
+`IMimeTypeProcessor.handle`

package/docs/reference/index.md

@@ -6,6 +6,7 @@
 - [NodeIdentityProcessor](classes/NodeIdentityProcessor.md)
 - [StaticUserIdentityProcessor](classes/StaticUserIdentityProcessor.md)
 - [LoggingProcessor](classes/LoggingProcessor.md)
+- [JwtMimeTypeProcessor](classes/JwtMimeTypeProcessor.md)
 
 ## Interfaces
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-processors",
-	"version": "0.0.1-next.10",
+	"version": "0.0.1-next.12",
 	"description": "Route processors for use with API servers",
 	"repository": {
 		"type": "git",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "0.0.1-next.10",
+		"@twin.org/api-models": "0.0.1-next.12",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",