@dvsa/appdev-api-common 0.9.1 → 0.9.3-canary.0

package/package.json

@@ -1,7 +1,11 @@
 {
 	"name": "@dvsa/appdev-api-common",
-	"version": "0.9.1",
-	"keywords": ["dvsa", "nodejs", "typescript"],
+	"version": "0.9.3-canary.0",
+	"keywords": [
+		"dvsa",
+		"nodejs",
+		"typescript"
+	],
 	"author": "DVSA",
 	"description": "Utils library for common API functionality",
 	"publishConfig": {
@@ -40,7 +44,7 @@
 		"jest": "^29.7.0",
 		"lint-staged": "^15.2.10",
 		"rimraf": "^6.0.1",
-		"routing-controllers": "^0.11.2",
+		"routing-controllers": "^0.11.3",
 		"ts-jest": "^29.2.5",
 		"ts-node": "^10.9.2",
 		"typescript": "^5.5.2"

package/utils/decode-payload-middleware.d.ts

@@ -0,0 +1,2 @@
+import type { NextFunction, Response, Request } from 'express';
+export declare const DecodeBase64GzipPayload: (request: Request, response: Response, next: NextFunction) => Response<any, Record<string, any>> | undefined;

package/utils/decode-payload-middleware.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DecodeBase64GzipPayload = void 0;
+const compression_1 = require("./compression");
+const http_status_codes_1 = require("../api/http-status-codes");
+const DecodeBase64GzipPayload = (request, response, next) => {
+    const compressionHeaderValue = 'base64+gzip';
+    try {
+        if (typeof request.body === 'string' && request.header('X-Payload-Encoding') === compressionHeaderValue) {
+            request.body = compression_1.DataCompression.decompress(request.body);
+        }
+    }
+    catch (err) {
+        return response.status(http_status_codes_1.HttpStatus.BAD_REQUEST).send({ message: 'Failed to decode payload' });
+    }
+    next();
+};
+exports.DecodeBase64GzipPayload = DecodeBase64GzipPayload;

package/utils/encode-payload-interceptor.d.ts

@@ -0,0 +1,7 @@
+import type { Request, Response } from 'express';
+import type { APIGatewayProxyResult } from 'aws-lambda';
+import type { Logger } from '@aws-lambda-powertools/logger';
+export declare const EncodePayloadInterceptor: ({ response, request }: {
+    response: Response;
+    request: Request;
+}, content: Partial<APIGatewayProxyResult>, logger: Logger) => Response<any, Record<string, any>>;

package/utils/encode-payload-interceptor.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EncodePayloadInterceptor = void 0;
+const http_status_codes_1 = require("../api/http-status-codes");
+const compression_1 = require("./compression");
+const EncodePayloadInterceptor = ({ response, request }, content, logger) => {
+    const compressionHeaderValue = 'base64+gzip';
+    for (const [header, value] of Object.entries(content?.headers || {})) {
+        response.setHeader(header, value);
+    }
+    if (content.statusCode) {
+        response.status(content.statusCode);
+    }
+    // if there's no-body, return the response
+    if (!content.body) {
+        return response;
+    }
+    const didRequestCompressed = request?.headers?.['x-accept-encoding'] === compressionHeaderValue;
+    const shouldCompress = didRequestCompressed && content.statusCode === http_status_codes_1.HttpStatus.OK;
+    // Parse the body if it's a string
+    const bodyData = typeof content.body === 'string' ? JSON.parse(content.body) : content.body;
+    if (shouldCompress) {
+        logger.debug('Compressing response data');
+        try {
+            const compressedData = compression_1.DataCompression.compress(bodyData);
+            // Check if compressed data is actually smaller
+            const originalSize = Buffer.byteLength(JSON.stringify(bodyData), 'utf8');
+            const compressedSize = Buffer.byteLength(JSON.stringify(compressedData), 'utf8');
+            if (compressedSize >= originalSize) {
+                logger.debug('Compression not beneficial, using original data');
+                response.json(bodyData);
+            }
+            else {
+                // Set the content encoding headers
+                response.setHeader('Access-Control-Expose-Headers', 'content-encoding');
+                response.setHeader('content-encoding', compressionHeaderValue);
+                response.json(compressedData);
+            }
+        }
+        catch (err) {
+            logger.error('Error compressing response data', { err });
+            response.json(bodyData);
+        }
+    }
+    else {
+        response.json(bodyData);
+    }
+    return response;
+};
+exports.EncodePayloadInterceptor = EncodePayloadInterceptor;