@8ms/helpers 1.3.27 → 1.3.28

package/aws/s3cache/getCache.js

@@ -6,16 +6,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const durations_1 = __importDefault(require("../../date/durations"));
 const readFile_1 = __importDefault(require("../s3/readFile"));
 const getKey_1 = __importDefault(require("./getKey"));
+const getBrotliDecompressed_1 = __importDefault(require("../../util/getBrotliDecompressed"));
 /**
  * Get the stored cache if it exists.
  */
 const getCache = async ({ bucket, cache, fileName, folder, isJson }) => {
     let response = undefined;
     // Store the cache key
-    const s3CacheKey = (0, getKey_1.default)({
-        fileName,
-        folder,
-    });
+    const s3CacheKey = (0, getKey_1.default)({ fileName, folder });
     // If a cache timeframe is provided and we're not preloading this data
     if (cache) {
         // Try to get the cache
@@ -23,7 +21,9 @@ const getCache = async ({ bucket, cache, fileName, folder, isJson }) => {
             const cached = await (0, readFile_1.default)({ bucket, key: s3CacheKey, isJson });
             // Cache exists and is still within our caching timeframe
             if (undefined !== cached.body && (durations_1.default.FOREVER === cache.timeframe || cached.modified[cache.from][cache.timeframe] < cache.duration)) {
-                response = cached.body;
+                response = await (0, getBrotliDecompressed_1.default)({
+                    input: cached.body,
+                });
             }
         }
         catch (error) {

package/aws/s3cache/getKey.js

@@ -13,6 +13,6 @@ const getEnvironment_1 = __importDefault(require("../../environment/getEnvironme
 const getKey = ({ fileName, folder }) => {
     const fileNameString = (0, getSha256_1.default)({ input: fileName });
     const folderPath = (0, trimStart_1.default)('' === folder ? '' : `${folder}/`, '/');
-    return `cache/${(0, getEnvironment_1.default)()}/${folderPath}${fileNameString}.json`;
+    return `cache/${(0, getEnvironment_1.default)()}/${folderPath}${fileNameString}.json.br`;
 };
 exports.default = getKey;

package/aws/s3cache/saveCache.js

@@ -4,10 +4,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const writeFile_1 = __importDefault(require("../s3/writeFile"));
+const getBrotliCompressed_1 = __importDefault(require("../../util/getBrotliCompressed"));
 /**
  * Save the cache.
  */
 const saveCache = async ({ bucket, data, key }) => {
-    await (0, writeFile_1.default)({ bucket, data, key });
+    const brotliData = await (0, getBrotliCompressed_1.default)({
+        input: data,
+    });
+    await (0, writeFile_1.default)({ bucket, data: brotliData, key });
 };
 exports.default = saveCache;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name":            "@8ms/helpers",
 	"license":         "UNLICENSED",
-	"version":         "1.3.27",
+	"version":         "1.3.28",
 	"repository":      {
 		"type": "git",
 		"url":  "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"

package/util/getBrotliCompressed.d.ts

@@ -0,0 +1,9 @@
+type GetBrotliCompressed = {
+    input?: any;
+    options?: object;
+};
+/**
+ * Compress a given input using Brotli.
+ */
+declare const getBrotliCompressed: ({ input, options }?: GetBrotliCompressed) => Promise<unknown>;
+export default getBrotliCompressed;

package/util/getBrotliCompressed.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Compress a given input using Brotli.
+ */
+const getBrotliCompressed = async ({ input, options } = {}) => {
+    return new Promise(async (resolve, reject) => {
+        const zlib = require('zlib');
+        zlib.brotliCompress(input || '', options || {}, (err, data) => {
+            if (err) {
+                reject(`Error compressing - ${err.code}`);
+            }
+            else {
+                resolve(data.toString('base64'));
+            }
+        });
+    });
+};
+exports.default = getBrotliCompressed;

package/util/getBrotliDecompressed.d.ts

@@ -0,0 +1,9 @@
+type GetBrotliDecompressed = {
+    input?: any;
+    options?: object;
+};
+/**
+ * Decompress a given Brotli input into a string.
+ */
+declare const getBrotliDecompressed: ({ input, options }?: GetBrotliDecompressed) => Promise<unknown>;
+export default getBrotliDecompressed;

package/util/getBrotliDecompressed.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Decompress a given Brotli input into a string.
+ */
+const getBrotliDecompressed = async ({ input, options } = {}) => {
+    return new Promise(async (resolve, reject) => {
+        const zlib = require('zlib');
+        const compressedData = Buffer.from(input || '', "base64");
+        zlib.brotliDecompress(compressedData, options || {}, (err, data) => {
+            if (err) {
+                reject(`Error decompressing - ${err.code}`);
+            }
+            else {
+                resolve(data.toString('utf8'));
+            }
+        });
+    });
+};
+exports.default = getBrotliDecompressed;