@dvsa/appdev-api-common 0.4.5 → 0.5.0

package/README.md

@@ -305,3 +305,34 @@ Example error handling:
 const invalidDate = new DateTime("invalid-date");
 console.log(invalidDate.toString()); // Returns an invalid date string
 ```
+
+
+# Compression
+
+## Overview
+`DataCompression` is a utility class to simplify the compression & decompression using Gzip and Gunzip algorithms.
+
+## Usage
+
+### Importing the `DataCompression` Class
+```ts
+import { DataCompression } from '@dvsa/appdev-api-common';
+```
+
+### Compressing Data
+This is the process of taking a plain JSON object and compressing it using Gzip.
+
+```ts
+const data = { key: 'value' };
+const compressedData = DataCompression.compress(data);
+// H4sIAAAAAAAAA6tWyk6tVLJSKkvMKU1VqgUAv5wYPw8AAAA=
+```
+
+### Decompressing Data
+This is the process of taking a compressed JSON object and decompressing it using Gunzip.
+
+```ts
+const data = "H4sIAAAAAAAAA6tWyk6tVLJSKkvMKU1VqgUAv5wYPw8AAAA=";
+const decompressedData = DataCompression.decompress(data);
+// { key: 'value' }
+```

package/index.d.ts

@@ -3,5 +3,6 @@ export * from "./auth/auth-checker";
 export * from "./auth/auth-errors";
 export * from "./auth/client-credentials";
 export * from "./auth/verify-jwt";
+export * from "./utils/compression";
 export * from "./utils/date-time";
 export * from "./validation/request-body";

package/index.js

@@ -19,5 +19,6 @@ __exportStar(require("./auth/auth-checker"), exports);
 __exportStar(require("./auth/auth-errors"), exports);
 __exportStar(require("./auth/client-credentials"), exports);
 __exportStar(require("./auth/verify-jwt"), exports);
+__exportStar(require("./utils/compression"), exports);
 __exportStar(require("./utils/date-time"), exports);
 __exportStar(require("./validation/request-body"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@dvsa/appdev-api-common",
-	"version": "0.4.5",
+	"version": "0.5.0",
 	"keywords": ["dvsa", "nodejs", "typescript"],
 	"author": "DVSA",
 	"description": "Utils library for common API functionality",

package/utils/compression.d.ts

@@ -0,0 +1,16 @@
+export declare class DataCompression {
+    /**
+     * Extracts a compressed (in base64) string using gunzip into a JSON object
+     * @template T
+     * @param {string} compressedData
+     * @returns {T}
+     */
+    static decompress<T>(compressedData: string): T;
+    /**
+     * Compresses (with gzip) a JSON object into a base64 string
+     * @template T
+     * @param {T} data
+     * @returns {string}
+     */
+    static compress<T>(data: T): string;
+}

package/utils/compression.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataCompression = void 0;
+const node_zlib_1 = require("node:zlib");
+// biome-ignore lint/complexity/noStaticOnlyClass: Valid use case for a static class
+class DataCompression {
+    /**
+     * Extracts a compressed (in base64) string using gunzip into a JSON object
+     * @template T
+     * @param {string} compressedData
+     * @returns {T}
+     */
+    static decompress(compressedData) {
+        const gzippedBytes = Buffer.from(compressedData, "base64");
+        const unzippedJson = (0, node_zlib_1.gunzipSync)(gzippedBytes).toString();
+        return JSON.parse(unzippedJson);
+    }
+    /**
+     * Compresses (with gzip) a JSON object into a base64 string
+     * @template T
+     * @param {T} data
+     * @returns {string}
+     */
+    static compress(data) {
+        const jsonString = JSON.stringify(data);
+        const gzippedData = (0, node_zlib_1.gzipSync)(Buffer.from(jsonString));
+        return gzippedData.toString("base64");
+    }
+}
+exports.DataCompression = DataCompression;