@8ms/helpers 1.5.6 → 1.5.9

package/array/contains.d.ts

@@ -1,8 +1,9 @@
+type Contains = {
+    haystack: any;
+    needle: any;
+};
 /**
  * Shorthand to check if an array or string contains a needle.
  */
-declare const contains: ({ haystack, needle }: {
-    needle: any;
-    haystack: any;
-}) => boolean;
+declare const contains: (props: Contains) => boolean;
 export default contains;

package/array/contains.js

@@ -3,5 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * Shorthand to check if an array or string contains a needle.
  */
-const contains = ({ haystack, needle }) => haystack.indexOf(needle) > -1;
+const contains = (props) => -1 !== props.haystack.indexOf(props.needle);
 exports.default = contains;

package/array/getArray.d.ts

@@ -1,7 +1,8 @@
+type GetArray = {
+    input: any;
+};
 /**
  * Convert an array into an array or return if already an array.
  */
-declare const getArray: ({ input }: {
-    input: any;
-}) => any[];
+declare const getArray: (props: GetArray) => any[];
 export default getArray;

package/array/getArray.js

@@ -7,5 +7,5 @@ const isArray_1 = __importDefault(require("lodash/isArray"));
 /**
  * Convert an array into an array or return if already an array.
  */
-const getArray = ({ input }) => (0, isArray_1.default)(input) ? input : [input];
+const getArray = (props) => (0, isArray_1.default)(props.input) ? props.input : [props.input];
 exports.default = getArray;

package/aws/athenaExpress/initClient.d.ts

@@ -8,5 +8,5 @@ type InitClient = {
 /**
  * Initialise the database using manually provided credentials.
  */
-declare const initClient: ({ config, database, s3Bucket, s3Key }: InitClient) => void;
+declare const initClient: (props: InitClient) => void;
 export default initClient;

package/aws/athenaExpress/initClient.js

@@ -8,17 +8,20 @@ global.awsAthenaExpressClient = null;
 /**
  * Initialise the database using manually provided credentials.
  */
-const initClient = ({ config, database, s3Bucket, s3Key }) => {
+const initClient = (props) => {
     if (!global.awsAthenaExpressClient) {
         const athenaExpress = require('athena-express');
         const awsSdk = require('aws-sdk');
-        const formattedConfig = (0, getConfig_1.default)({ config, isAthenaExpress: true });
+        const formattedConfig = (0, getConfig_1.default)({
+            config: props.config,
+            isAthenaExpress: true
+        });
         // Set the aws authentication
         awsSdk.config.update(formattedConfig);
         global.awsAthenaExpressClient = new athenaExpress.AthenaExpress({
             aws: awsSdk,
-            s3: `s3://${s3Bucket}/${s3Key}`,
-            db: database,
+            s3: `s3://${props.s3Bucket}/${props.s3Key}`,
+            db: props.database,
             formatJson: true,
             retry: 200,
             getStats: false,

package/aws/athenaExpress/query.d.ts

@@ -4,5 +4,5 @@ type Query = {
 /**
  * Build the query and return the data.
  */
-declare const query: ({ query }: Query) => Promise<any>;
+declare const query: (props: Query) => Promise<any>;
 export default query;

package/aws/athenaExpress/query.js

@@ -3,8 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * Build the query and return the data.
  */
-const query = async ({ query }) => {
-    return await global.awsAthenaExpressClient.query(query)
-        .then(data => undefined === data['Items'] ? [] : data['Items']);
+const query = async (props) => {
+    return await global.awsAthenaExpressClient.query(props.query)
+        .then(data => {
+        let subResponse = [];
+        if (undefined !== data['Items']) {
+            subResponse = data['Items'];
+        }
+        return subResponse;
+    });
 };
 exports.default = query;

package/aws/glue/initClient.d.ts

@@ -6,5 +6,5 @@ type InitClient = {
  * Shorthand function to get the Glue Client.
  * Library: @aws-sdk/client-glue
  */
-declare const initClient: ({ config }: InitClient) => void;
+declare const initClient: (props: InitClient) => void;
 export default initClient;

package/aws/glue/initClient.js

@@ -9,10 +9,12 @@ global.awsGlueClient = null;
  * Shorthand function to get the Glue Client.
  * Library: @aws-sdk/client-glue
  */
-const initClient = ({ config }) => {
+const initClient = (props) => {
     if (!global.awsGlueClient) {
         const { GlueClient } = require('@aws-sdk/client-glue');
-        const formattedConfig = (0, getConfig_1.default)({ config });
+        const formattedConfig = (0, getConfig_1.default)({
+            config: props.config
+        });
         global.awsGlueClient = new GlueClient(formattedConfig);
     }
 };

package/aws/glue/invoke.d.ts

@@ -5,5 +5,5 @@ type Invoke = {
  * Invoke an AWS Glue Crawler by passing in the name of the Crawler.
  * Library: @aws-sdk/client-glue
  */
-declare const invoke: ({ crawler }: Invoke) => Promise<boolean>;
+declare const invoke: (props: Invoke) => Promise<boolean>;
 export default invoke;

package/aws/glue/invoke.js

@@ -8,14 +8,16 @@ const isResponse200_1 = __importDefault(require("../isResponse200"));
  * Invoke an AWS Glue Crawler by passing in the name of the Crawler.
  * Library: @aws-sdk/client-glue
  */
-const invoke = async ({ crawler }) => {
+const invoke = async (props) => {
     const { StartCrawlerCommand } = require('@aws-sdk/client-glue');
     const command = new StartCrawlerCommand({
-        Name: crawler,
+        Name: props.crawler,
     });
     // Fire the event but don't wait for it to complete
     const apiResponse = await global.awsGlueClient.send(command);
     // Success
-    return (0, isResponse200_1.default)({ apiResponse });
+    return (0, isResponse200_1.default)({
+        apiResponse
+    });
 };
 exports.default = invoke;

package/aws/lambda/getHandlerPath.d.ts

@@ -1,5 +1,5 @@
 type GetHandlerPath = {
     input: string;
 };
-declare const getHandlerPath: ({ input }: GetHandlerPath) => string;
+declare const getHandlerPath: (props: GetHandlerPath) => string;
 export default getHandlerPath;

package/aws/lambda/getHandlerPath.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const getHandlerPath = ({ input }) => {
-    return `${input.split(process.cwd())[1].substring(1)
+const getHandlerPath = (props) => {
+    return `${props.input.split(process.cwd())[1].substring(1)
         .replace(/\\/g, '/')}`;
 };
 exports.default = getHandlerPath;

package/aws/lambda/initClient.d.ts

@@ -6,5 +6,5 @@ type InitClient = {
  * Shorthand function to get the Lambda Client.
  * Library: @aws-sdk/client-lambda
  */
-declare const initClient: ({ config }: InitClient) => void;
+declare const initClient: (props: InitClient) => void;
 export default initClient;

package/aws/lambda/initClient.js

@@ -9,10 +9,12 @@ global.awsLambdaClient = null;
  * Shorthand function to get the Lambda Client.
  * Library: @aws-sdk/client-lambda
  */
-const initClient = ({ config }) => {
+const initClient = (props) => {
     if (!global.awsLambdaClient) {
         const { LambdaClient } = require('@aws-sdk/client-lambda');
-        const formattedConfig = (0, getConfig_1.default)({ config });
+        const formattedConfig = (0, getConfig_1.default)({
+            config: props.config
+        });
         global.awsLambdaClient = new LambdaClient(formattedConfig);
     }
 };

package/aws/lambda/invoke.d.ts

@@ -9,5 +9,5 @@ type Invoke = {
  * Runs asynchronously, doesn't wait for function to fully end.
  * Library: @aws-sdk/client-lambda
  */
-declare const invoke: ({ awaitResponse, functionName, isJson, payload }: Invoke) => Promise<any>;
+declare const invoke: (props: Invoke) => Promise<any>;
 export default invoke;

package/aws/lambda/invoke.js

@@ -10,15 +10,15 @@ const ApiResponse_1 = __importDefault(require("../../api/ApiResponse"));
  * Runs asynchronously, doesn't wait for function to fully end.
  * Library: @aws-sdk/client-lambda
  */
-const invoke = async ({ awaitResponse, functionName, isJson, payload }) => {
+const invoke = async (props) => {
     let response = false;
     const params = {
-        FunctionName: functionName,
-        InvocationType: true === awaitResponse ? 'RequestResponse' : 'Event',
+        FunctionName: props.functionName,
+        InvocationType: true === props.awaitResponse ? 'RequestResponse' : 'Event',
     };
     // Payload is defined add to parameters
-    if (undefined !== payload) {
-        params['Payload'] = new Uint8Array(Buffer.from(JSON.stringify(payload)));
+    if (undefined !== props.payload) {
+        params['Payload'] = new Uint8Array(Buffer.from(JSON.stringify(props.payload)));
     }
     // Create the Lambda Command
     const { InvokeCommand } = require('@aws-sdk/client-lambda');
@@ -28,11 +28,11 @@ const invoke = async ({ awaitResponse, functionName, isJson, payload }) => {
     // Success
     if ((0, isResponse200_1.default)({ apiResponse })) {
         // Return the data
-        if (awaitResponse && undefined !== apiResponse.Payload) {
+        if (props.awaitResponse && undefined !== apiResponse.Payload) {
             const asciiDecoder = new TextDecoder('ascii');
             response = asciiDecoder.decode(apiResponse.Payload);
             // Decode string as JSON object
-            if (true === isJson) {
+            if (true === props.isJson) {
                 response = JSON.parse(response);
                 // If it's still a string, double decode it
                 if ('string' === typeof response) {

package/aws/s3/readGzip.d.ts

@@ -0,0 +1,11 @@
+import { ReadFileResponse } from "./readFile";
+type ReadBrotli = {
+    bucket: string;
+    key: string;
+    isJson?: boolean;
+};
+/**
+ * Read a file from S3 and return either null, the content or JSON decoded.
+ */
+declare const readGzip: ({ bucket, key, isJson }: ReadBrotli) => Promise<ReadFileResponse>;
+export default readGzip;

package/aws/s3/readGzip.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const readFile_1 = __importDefault(require("./readFile"));
+const getGzipDecompressed_1 = __importDefault(require("../../util/getGzipDecompressed"));
+/**
+ * Read a file from S3 and return either null, the content or JSON decoded.
+ */
+const readGzip = async ({ bucket, key, isJson }) => {
+    let response = await (0, readFile_1.default)({
+        bucket,
+        key,
+        isJson: false
+    });
+    // Cache exists and is still within our caching timeframe
+    if (undefined !== response.body) {
+        response.body = await (0, getGzipDecompressed_1.default)({
+            input: response.body,
+        });
+        if (false !== isJson) {
+            response.body = JSON.parse(response.body);
+        }
+    }
+    return response;
+};
+exports.default = readGzip;

package/aws/s3/writeGzip.d.ts

@@ -0,0 +1,12 @@
+type WriteBrotli = {
+    bucket: string;
+    data: any;
+    key: string;
+    isJson?: boolean;
+    [options: string]: any;
+};
+/**
+ * Write a gzip file to S3.
+ */
+declare const writeBrotli: ({ bucket, data, key, isJson, ...options }: WriteBrotli) => Promise<any>;
+export default writeBrotli;

package/aws/s3/writeGzip.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getGzipCompressed_1 = __importDefault(require("../../util/getGzipCompressed"));
+const writeFile_1 = __importDefault(require("./writeFile"));
+/**
+ * Write a gzip file to S3.
+ */
+const writeBrotli = async ({ bucket, data, key, isJson, ...options }) => {
+    let finalData = data;
+    if (false !== isJson) {
+        finalData = JSON.stringify(data);
+    }
+    // Compress the data
+    const brotliData = await (0, getGzipCompressed_1.default)({
+        input: finalData,
+    });
+    const apiResponse = await (0, writeFile_1.default)({
+        bucket,
+        data: brotliData,
+        key,
+        ...options,
+    });
+    return apiResponse;
+};
+exports.default = writeBrotli;

package/aws/s3cache/getCache.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const durations_1 = __importDefault(require("../../date/durations"));
 const getKey_1 = __importDefault(require("./getKey"));
-const readBrotli_1 = __importDefault(require("../s3/readBrotli"));
+const readGzip_1 = __importDefault(require("../s3/readGzip"));
 /**
  * Get the stored cache if it exists.
  */
@@ -17,7 +17,7 @@ const getCache = async ({ bucket, cache, fileName, folder }) => {
     if (cache) {
         // Try to get the cache
         try {
-            const cached = await (0, readBrotli_1.default)({
+            const cached = await (0, readGzip_1.default)({
                 bucket,
                 key: s3CacheKey,
                 isJson: true,

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.br`;
+    return `cache/${(0, getEnvironment_1.default)()}/${folderPath}${fileNameString}.json.gz`;
 };
 exports.default = getKey;

package/aws/s3cache/saveCache.js

@@ -3,12 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const writeBrotli_1 = __importDefault(require("../s3/writeBrotli"));
+const writeGzip_1 = __importDefault(require("../s3/writeGzip"));
 /**
  * Save the cache.
  */
 const saveCache = async ({ bucket, data, key }) => {
-    return await (0, writeBrotli_1.default)({
+    return await (0, writeGzip_1.default)({
         bucket,
         data,
         key,

package/google/bigQuery/query.d.ts

@@ -1,5 +1,15 @@
-type Query = {
-    input: string;
+/**
+ * https://cloud.google.com/bigquery/docs/parameterized-queries
+ */
+export type QueryInput = string | {
+    query: string;
+    location?: string;
+    params: {
+        [key: string]: any;
+    };
+};
+export type Query = {
+    input: QueryInput;
     projectId?: string;
 };
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name":            "@8ms/helpers",
 	"license":         "UNLICENSED",
-	"version":         "1.5.6",
+	"version":         "1.5.9",
 	"repository":      {
 		"type": "git",
 		"url":  "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"
@@ -14,27 +14,27 @@
 	},
 	"dependencies":    {
 		"axios":       "1.5.1",
-		"crypto-js":   "4.1.1",
+		"crypto-js":   "4.2.0",
 		"date-fns":    "2.30.0",
 		"date-fns-tz": "2.0.0",
 		"lodash":      "4.17.21",
 		"zod":         "3.22.4"
 	},
 	"devDependencies": {
-		"@aws-sdk/client-s3":            "3.425.0",
-		"@aws-sdk/client-ses":           "3.425.0",
-		"@aws-sdk/client-sqs":           "3.425.0",
-		"@aws-sdk/client-ssm":           "3.425.0",
-		"@aws-sdk/s3-request-presigner": "3.425.0",
-		"@babel/preset-env":             "7.22.20",
+		"@aws-sdk/client-s3":            "3.436.0",
+		"@aws-sdk/client-ses":           "3.436.0",
+		"@aws-sdk/client-sqs":           "3.436.0",
+		"@aws-sdk/client-ssm":           "3.436.0",
+		"@aws-sdk/s3-request-presigner": "3.436.0",
+		"@babel/preset-env":             "7.23.2",
 		"@babel/preset-flow":            "7.22.15",
-		"@babel/preset-typescript":      "7.23.0",
+		"@babel/preset-typescript":      "7.23.2",
 		"@google-cloud/bigquery":        "7.3.0",
-		"@google-cloud/storage":         "7.2.0",
-		"@prisma/client":                "5.4.1",
-		"@types/jest":                   "29.5.5",
-		"@types/lodash":                 "4.14.199",
-		"@types/node":                   "20.8.2",
+		"@google-cloud/storage":         "7.4.0",
+		"@prisma/client":                "5.5.2",
+		"@types/jest":                   "29.5.6",
+		"@types/lodash":                 "4.14.200",
+		"@types/node":                   "20.8.9",
 		"babel-jest":                    "29.7.0",
 		"jest":                          "29.7.0",
 		"node-fetch":                    "3.3.2",

package/util/defaultTo.d.ts

@@ -6,5 +6,5 @@ type DefaultTo = {
 /**
  * Function to default to a value, whilst filtering through an instance
  */
-declare const defaultTo: ({ defaultValue, instance, keys }: DefaultTo) => any;
+declare const defaultTo: (props: DefaultTo) => any;
 export default defaultTo;

package/util/defaultTo.js

@@ -8,12 +8,14 @@ const getArray_1 = __importDefault(require("../array/getArray"));
 /**
  * Function to default to a value, whilst filtering through an instance
  */
-const defaultTo = ({ defaultValue, instance, keys }) => {
-    const keysArray = (0, getArray_1.default)({ input: keys });
+const defaultTo = (props) => {
+    const keysArray = (0, getArray_1.default)({
+        input: props.keys
+    });
     let found = true;
-    let pointer = instance;
+    let pointer = props.instance;
     // Instance is undefined or is null
-    if (undefined === instance || null === pointer) {
+    if (undefined === props.instance || null === pointer) {
         found = false;
     }
     // Instance exists
@@ -36,6 +38,6 @@ const defaultTo = ({ defaultValue, instance, keys }) => {
             }
         });
     }
-    return found ? pointer : defaultValue;
+    return found ? pointer : props.defaultValue;
 };
 exports.default = defaultTo;

package/util/getGzipCompressed.d.ts

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

package/util/getGzipCompressed.js

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

package/util/getGzipDecompressed.d.ts

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

package/util/getGzipDecompressed.js

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

package/util/sleep.d.ts

@@ -1,4 +1,5 @@
-declare const sleep: ({ seconds }: {
+type Sleep = {
     seconds: number;
-}) => Promise<unknown>;
+};
+declare const sleep: (props: Sleep) => Promise<void>;
 export default sleep;

package/util/sleep.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const sleep = ({ seconds }) => {
-    return new Promise((resolve, reject) => setTimeout(resolve, seconds * 1000));
+const sleep = (props) => {
+    return new Promise(resolve => setTimeout(resolve, props.seconds * 1000));
 };
 exports.default = sleep;

package/xml/getXml.d.ts

@@ -1,4 +1,5 @@
-declare const getXml: ({ url }: {
-    url: any;
-}) => Promise<string>;
+type GetXml = {
+    url: string;
+};
+declare const getXml: (props: GetXml) => Promise<string>;
 export default getXml;

package/xml/getXml.js

@@ -4,13 +4,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const get_1 = __importDefault(require("../axios/get"));
-const getXml = async ({ url }) => {
+const getXml = async (props) => {
     let response = '';
     const apiResponse = await (0, get_1.default)({
-        url
+        url: props.url,
     });
     if (apiResponse.isSuccess()) {
-        response = apiResponse.getBody().toString();
+        response = apiResponse.getBody()
+            .toString();
         // Trim the contents
         response = response.trim();
         // Remove tabs, new lines, double spaces