@8ms/helpers 1.1.49 → 1.1.52

package/.github/workflows/deploy_npmjs.yml

@@ -1,4 +1,6 @@
-on: push
+on:
+  push:
+    branches: [ main ]
 
 jobs:
   publish:
@@ -7,9 +9,9 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 12
-      - run: npm install
-      - run: npm test
+          node-version: 16
+      - run: yarn
+      - run: yarn build
       - uses: JS-DevTools/npm-publish@v1
         with:
           token: ${{ secrets.NPM_TOKEN }}

package/api/response.d.ts

@@ -0,0 +1,8 @@
+import { State } from './states';
+export declare type Response = {
+    body: any | null;
+    error: string | null;
+    state: State;
+};
+declare const response: Response;
+export default response;

package/{dist/boolean/index.js → api/response.js}

@@ -3,6 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBoolean = void 0;
-var getBoolean_1 = __importDefault(require("./getBoolean"));
-exports.getBoolean = getBoolean_1.default;
+var states_1 = __importDefault(require("./states"));
+var response = {
+    body: null,
+    error: null,
+    state: states_1.default.IDLE,
+};
+exports.default = response;

package/api/states.d.ts

@@ -0,0 +1,9 @@
+declare const states: {
+    ERROR: string;
+    IDLE: string;
+    PENDING: string;
+    SUCCESS: string;
+    VALIDATION_ERROR: string;
+};
+export declare type State = typeof states.ERROR | typeof states.IDLE | typeof states.PENDING | typeof states.SUCCESS | typeof states.VALIDATION_ERROR;
+export default states;

package/{dist/api → api}/states.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.states = void 0;
-exports.states = {
+var states = {
     ERROR: 'error',
     IDLE: 'idle',
     PENDING: 'pending',
     SUCCESS: 'success',
     VALIDATION_ERROR: 'validationError',
 };
+exports.default = states;

package/api/unexpectedError.d.ts

@@ -0,0 +1,2 @@
+declare const unexpectedError: string;
+export default unexpectedError;

package/api/unexpectedError.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var unexpectedError = 'An unexpected error occurred, please try again.';
+exports.default = unexpectedError;

package/{dist/atInternet → atInternet}/request.d.ts

@@ -1,7 +1,7 @@
 /**
  * The request in the structure required by AT Internet.
  */
-export declare type RequestType = {
+export declare type Request = {
     columns: string[];
     evo?: {
         [evoKey: string]: object;

package/aws/athenaExpress/initClient.d.ts

@@ -0,0 +1,10 @@
+import { Config } from '../config';
+/**
+ * Initialise the database using manually provided credentials.
+ */
+declare const initClient: ({ athenaS3, config, database }: {
+    athenaS3?: string;
+    config?: Config;
+    database?: string;
+}) => void;
+export default initClient;

package/{dist/aws/athenaExpress/getClient.js → aws/athenaExpress/initClient.js}

@@ -4,18 +4,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var getConfig_1 = __importDefault(require("../getConfig"));
-var athenaClient = undefined;
+global.awsAthenaExpressClient = null;
 /**
  * Initialise the database using manually provided credentials.
  */
-var getClient = function (_a) {
-    var AthenaExpress = _a.AthenaExpress, AwsSdk = _a.AwsSdk, athenaS3 = _a.athenaS3, config = _a.config, database = _a.database;
-    if (!global.awsAthenaClient) {
+var initClient = function (_a) {
+    var athenaS3 = _a.athenaS3, config = _a.config, database = _a.database;
+    if (!global.awsAthenaExpressClient) {
+        var athenaExpress = require('athena-express');
+        var awsSdk = require('aws-sdk');
         var formattedConfig = (0, getConfig_1.default)({ config: config, isAthenaExpress: true });
         // Set the aws authentication
-        AwsSdk.config.update(formattedConfig);
-        global.awsAthenaClient = new AthenaExpress.AthenaExpress({
-            aws: AwsSdk,
+        awsSdk.config.update(formattedConfig);
+        global.awsAthenaExpressClient = new athenaExpress.AthenaExpress({
+            aws: awsSdk,
             s3: athenaS3,
             db: database,
             formatJson: true,
@@ -23,7 +25,5 @@ var getClient = function (_a) {
             getStats: false,
         });
     }
-    athenaClient = global.awsAthenaClient;
-    return athenaClient;
 };
-exports.default = getClient;
+exports.default = initClient;

package/aws/athenaExpress/request.d.ts

@@ -0,0 +1,12 @@
+import { Config } from '../config';
+declare type Request = {
+    athenaS3?: string;
+    config?: Config;
+    database?: string;
+    query: string;
+};
+/**
+ * Build the query and return the data.
+ */
+declare const request: ({ athenaS3, config, database, query }: Request) => Promise<any>;
+export default request;

package/{dist/aws → aws}/athenaExpress/request.js

@@ -35,17 +35,23 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+var initClient_1 = __importDefault(require("./initClient"));
 /**
  * Build the query and return the data.
  */
 var request = function (_a) {
-    var client = _a.client, query = _a.query;
+    var athenaS3 = _a.athenaS3, config = _a.config, database = _a.database, query = _a.query;
     return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_b) {
             switch (_b.label) {
-                case 0: return [4 /*yield*/, client.query(query)
-                        .then(function (data) { return undefined === data['Items'] ? [] : data['Items']; })];
+                case 0:
+                    (0, initClient_1.default)({ athenaS3: athenaS3, config: config, database: database });
+                    return [4 /*yield*/, global.awsAthenaExpressClient.query(query)
+                            .then(function (data) { return undefined === data['Items'] ? [] : data['Items']; })];
                 case 1: return [2 /*return*/, _b.sent()];
             }
         });

package/{dist/aws → aws}/config.d.ts

@@ -1,4 +1,4 @@
-export declare type ConfigType = {
+export declare type Config = {
     accessKeyId: string;
     region: string;
     secretAccessKey: string;

package/{dist/aws → aws}/getConfig.d.ts

@@ -1,9 +1,9 @@
-import { ConfigType } from './config';
+import { Config } from './config';
 /**
  * The config must be in a specific structure, if the properties aren't defined don't specify them as they could be inferred (e.g. Lambda).
  */
 declare const getConfig: ({ config, isAthenaExpress }: {
-    config: ConfigType;
-    isAthenaExpress: boolean;
+    config: Config;
+    isAthenaExpress?: boolean;
 }) => object;
 export default getConfig;

package/{dist/aws → aws}/getConfig.js

@@ -11,7 +11,7 @@ var getConfig = function (_a) {
     // Set the key id and access key if its defined (not required for AWS SAM)
     if ('' !== config.accessKeyId && '' !== config.secretAccessKey) {
         // Athena is a flat structure
-        if (isAthenaExpress) {
+        if (true === isAthenaExpress) {
             response['accessKeyId'] = config.accessKeyId;
             response['secretAccessKey'] = config.secretAccessKey;
         }

package/aws/glue/initClient.d.ts

@@ -0,0 +1,9 @@
+import { Config } from '../config';
+/**
+ * Shorthand function to get the Glue Client.
+ * Library: @aws-sdk/client-glue
+ */
+declare const initClient: ({ config }: {
+    config?: Config;
+}) => void;
+export default initClient;

package/{dist/aws/glue/getClient.js → aws/glue/initClient.js}

@@ -4,19 +4,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var getConfig_1 = __importDefault(require("../getConfig"));
-var glueClient = undefined;
+global.awsGlueClient = null;
 /**
  * Shorthand function to get the Glue Client.
  * Library: @aws-sdk/client-glue
  */
-var getClient = function (_a) {
-    var GlueLib = _a.GlueLib, config = _a.config;
+var initClient = function (_a) {
+    var config = _a.config;
     if (!global.awsGlueClient) {
-        var GlueClient = GlueLib.GlueClient;
-        var formattedConfig = (0, getConfig_1.default)({ config: config, isAthenaExpress: false });
+        var GlueClient = require('@aws-sdk/client-glue').GlueClient;
+        var formattedConfig = (0, getConfig_1.default)({ config: config });
         global.awsGlueClient = new GlueClient(formattedConfig);
     }
-    glueClient = global.awsGlueClient;
-    return glueClient;
 };
-exports.default = getClient;
+exports.default = initClient;

package/aws/glue/invoke.d.ts

@@ -0,0 +1,11 @@
+import { Config } from '../config';
+declare type Invoke = {
+    config?: Config;
+    crawler: string;
+};
+/**
+ * Invoke an AWS Glue Crawler by passing in the name of the Crawler.
+ * Library: @aws-sdk/client-glue
+ */
+declare const invoke: ({ config, crawler }: Invoke) => Promise<boolean>;
+export default invoke;

package/{dist/aws → aws}/glue/invoke.js

@@ -40,23 +40,27 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var isResponse200_1 = __importDefault(require("../isResponse200"));
+var initClient_1 = __importDefault(require("./initClient"));
 /**
  * Invoke an AWS Glue Crawler by passing in the name of the Crawler.
  * Library: @aws-sdk/client-glue
  */
 var invoke = function (_a) {
-    var GlueLib = _a.GlueLib, client = _a.client, crawler = _a.crawler;
+    var config = _a.config, crawler = _a.crawler;
     return __awaiter(void 0, void 0, void 0, function () {
         var params, StartCrawlerCommand, command, apiResponse;
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
+                    // Ensure the client has been initialised
+                    (0, initClient_1.default)({ config: config });
                     params = {
                         Name: crawler,
                     };
-                    StartCrawlerCommand = GlueLib.StartCrawlerCommand;
+                    StartCrawlerCommand = require('@aws-sdk/client-glue').StartCrawlerCommand;
+                    ;
                     command = new StartCrawlerCommand(params);
-                    return [4 /*yield*/, client.send(command)];
+                    return [4 /*yield*/, global.awsGlueClient.send(command)];
                 case 1:
                     apiResponse = _b.sent();
                     // Success

package/aws/isResponse200.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var defaultTo_1 = __importDefault(require("../util/defaultTo"));
+/**
+ * Was the API response a 200?
+ */
+var isResponse200 = function (_a) {
+    var apiResponse = _a.apiResponse;
+    var response = false;
+    var responseCode = (0, defaultTo_1.default)({
+        defaultValue: 0,
+        instance: apiResponse,
+        keys: ['$metadata', 'httpStatusCode'],
+    });
+    if (200 === responseCode) {
+        response = true;
+    }
+    return response;
+};
+exports.default = isResponse200;

package/aws/lambda/initClient.d.ts

@@ -0,0 +1,9 @@
+import { Config } from '../config';
+/**
+ * Shorthand function to get the Lambda Client.
+ * Library: @aws-sdk/client-lambda
+ */
+declare const initClient: ({ config }: {
+    config?: Config;
+}) => void;
+export default initClient;

package/{dist/aws/lambda/getClient.js → aws/lambda/initClient.js}

@@ -4,19 +4,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var getConfig_1 = __importDefault(require("../getConfig"));
-var lambdaClient = undefined;
+global.awsLambdaClient = null;
 /**
  * Shorthand function to get the Lambda Client.
  * Library: @aws-sdk/client-lambda
  */
-var getClient = function (_a) {
-    var LambdaLib = _a.LambdaLib, config = _a.config;
+var initClient = function (_a) {
+    var config = _a.config;
     if (!global.awsLambdaClient) {
-        var LambdaClient = LambdaLib.LambdaClient;
-        var formattedConfig = (0, getConfig_1.default)({ config: config, isAthenaExpress: false });
-        global.awsLambdaClient = new LambdaClient(formattedConfig);
+        var S3Client = require('@aws-sdk/client-lambda').S3Client;
+        var formattedConfig = (0, getConfig_1.default)({ config: config });
+        global.awsLambdaClient = new S3Client(formattedConfig);
     }
-    lambdaClient = global.awsLambdaClient;
-    return lambdaClient;
 };
-exports.default = getClient;
+exports.default = initClient;

package/{dist/aws → aws}/lambda/invoke.d.ts

@@ -1,6 +1,6 @@
-declare type InvokeType = {
-    LambdaLib: any;
-    client: any;
+import { Config } from '../config';
+declare type Invoke = {
+    config?: Config;
     functionName: string;
     payload?: object;
     response?: boolean;
@@ -10,11 +10,5 @@ declare type InvokeType = {
  * Runs asynchronously, doesn't wait for function to fully end.
  * Library: @aws-sdk/client-lambda
  */
-declare const invoke: {
-    ({ LambdaLib, client, functionName, payload, response }: InvokeType): Promise<any>;
-    defaultProps: {
-        payload: any;
-        response: any;
-    };
-};
+declare const invoke: ({ config, functionName, payload, response }: Invoke) => Promise<any>;
 export default invoke;

package/{dist/aws → aws}/lambda/invoke.js

@@ -40,18 +40,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var isResponse200_1 = __importDefault(require("../isResponse200"));
+var initClient_1 = __importDefault(require("./initClient"));
 /**
  * Invoke a AWS Lambda function by passing in the Function name and optional Payload data.
  * Runs asynchronously, doesn't wait for function to fully end.
  * Library: @aws-sdk/client-lambda
  */
 var invoke = function (_a) {
-    var LambdaLib = _a.LambdaLib, client = _a.client, functionName = _a.functionName, payload = _a.payload, response = _a.response;
+    var config = _a.config, functionName = _a.functionName, payload = _a.payload, response = _a.response;
     return __awaiter(void 0, void 0, void 0, function () {
         var params, InvokeCommand, command, apiResponse, asciiDecoder, decoded, decodedJson;
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
+                    // Ensure the client has been initialised
+                    (0, initClient_1.default)({ config: config });
                     params = {
                         FunctionName: functionName,
                         InvocationType: true === response ? 'RequestResponse' : 'Event',
@@ -60,9 +63,9 @@ var invoke = function (_a) {
                     if (undefined !== payload) {
                         params['Payload'] = new Uint8Array(Buffer.from(JSON.stringify(payload)));
                     }
-                    InvokeCommand = LambdaLib.InvokeCommand;
+                    InvokeCommand = require('@aws-sdk/client-lambda').InvokeCommand;
                     command = new InvokeCommand(params);
-                    return [4 /*yield*/, client.send(command)];
+                    return [4 /*yield*/, global.awsLambdaClient.send(command)];
                 case 1:
                     apiResponse = _b.sent();
                     // Success
@@ -84,8 +87,4 @@ var invoke = function (_a) {
         });
     });
 };
-invoke.defaultProps = {
-    payload: undefined,
-    response: undefined,
-};
 exports.default = invoke;

package/aws/s3/copyFile.d.ts

@@ -0,0 +1,13 @@
+export declare type File = {
+    bucket: string;
+    key: string;
+};
+declare type CopyFile = {
+    from: File;
+    to: File;
+};
+/**
+ * Copy a file from one bucket/path to another bucket/path.
+ */
+declare const copyFile: ({ from, to }: CopyFile) => Promise<void>;
+export default copyFile;

package/{dist/aws → aws}/s3/copyFile.js

@@ -40,14 +40,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Copy a file from one bucket/path to another bucket/path.
  */
 var copyFile = function (_a) {
-    var S3Lib = _a.S3Lib, client = _a.client, from = _a.from, to = _a.to;
+    var from = _a.from, to = _a.to;
     return __awaiter(void 0, void 0, void 0, function () {
         var CopyObjectCommand;
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
-                    CopyObjectCommand = S3Lib.CopyObjectCommand;
-                    return [4 /*yield*/, client.send(new CopyObjectCommand({
+                    CopyObjectCommand = require('@aws-sdk/client-s3').CopyObjectCommand;
+                    return [4 /*yield*/, global.awsS3Client.send(new CopyObjectCommand({
                             Bucket: to.bucket,
                             CopySource: encodeURIComponent("".concat(from.bucket, "/").concat(from.key)),
                             Key: to.key,

package/aws/s3/deleteFile.d.ts

@@ -0,0 +1,9 @@
+declare type DeleteFile = {
+    bucket: string;
+    key: string;
+};
+/**
+ * Delete a single file.
+ */
+declare const deleteFile: ({ bucket, key }: DeleteFile) => Promise<void>;
+export default deleteFile;

package/{dist/aws → aws}/s3/deleteFile.js

@@ -40,14 +40,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Delete a single file.
  */
 var deleteFile = function (_a) {
-    var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, key = _a.key;
+    var bucket = _a.bucket, key = _a.key;
     return __awaiter(void 0, void 0, void 0, function () {
         var DeleteObjectCommand;
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
-                    DeleteObjectCommand = S3Lib.DeleteObjectCommand;
-                    return [4 /*yield*/, client.send(new DeleteObjectCommand({
+                    DeleteObjectCommand = require('@aws-sdk/client-s3').DeleteObjectCommand;
+                    return [4 /*yield*/, global.awsS3Client.send(new DeleteObjectCommand({
                             Bucket: bucket,
                             Key: key,
                         }))];

package/{dist/aws → aws}/s3/deleteFiles.js

@@ -46,8 +46,8 @@ var deleteFiles = function (_a) {
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
-                    DeleteObjectsCommand = S3Lib.DeleteObjectsCommand;
-                    return [4 /*yield*/, client.send(new DeleteObjectsCommand({
+                    DeleteObjectsCommand = require('@aws-sdk/client-s3').DeleteObjectsCommand;
+                    return [4 /*yield*/, global.awsS3Client.send(new DeleteObjectsCommand({
                             Bucket: bucket,
                             Delete: {
                                 Objects: keys.map(function (key) { return ({

package/{dist/aws → aws}/s3/deleteFolder.js

@@ -35,33 +35,36 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var string_1 = require("../../string");
+var getCleanFolder_1 = __importDefault(require("../../string/getCleanFolder"));
 /**
  * Iteratively delete all the files within a directory and delete the directory.
  */
 var deleteFolder = function (_a) {
     var S3Lib = _a.S3Lib, bucket = _a.bucket, client = _a.client, folder = _a.folder;
     return __awaiter(void 0, void 0, void 0, function () {
-        var cleanFolder, ListObjectsV2Command, DeleteObjectsCommand, apiResponse, keys;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
+        var cleanFolder, _b, ListObjectsV2Command, DeleteObjectsCommand, apiResponse, keys;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
                 case 0:
-                    cleanFolder = (0, string_1.getCleanFolder)({ input: folder });
-                    ListObjectsV2Command = S3Lib.ListObjectsV2Command, DeleteObjectsCommand = S3Lib.DeleteObjectsCommand;
-                    return [4 /*yield*/, client.send(new ListObjectsV2Command({
+                    cleanFolder = (0, getCleanFolder_1.default)({ input: folder });
+                    _b = require('@aws-sdk/client-s3'), ListObjectsV2Command = _b.ListObjectsV2Command, DeleteObjectsCommand = _b.DeleteObjectsCommand;
+                    return [4 /*yield*/, global.awsS3Client.send(new ListObjectsV2Command({
                             Bucket: bucket,
                             Prefix: ('' === cleanFolder ? '' : cleanFolder + '/'),
                         }))];
                 case 1:
-                    apiResponse = _b.sent();
+                    apiResponse = _c.sent();
                     // No files to be deleted
                     if (apiResponse.Contents.length === 0) {
                         return [2 /*return*/];
                     }
                     keys = apiResponse.Contents.map(function (file) { return ({ Key: file.Key }); });
                     // Delete the files
-                    return [4 /*yield*/, client.send(new DeleteObjectsCommand({
+                    return [4 /*yield*/, global.awsS3Client.send(new DeleteObjectsCommand({
                             Bucket: bucket,
                             Delete: {
                                 Objects: keys,
@@ -69,12 +72,12 @@ var deleteFolder = function (_a) {
                         }))];
                 case 2:
                     // Delete the files
-                    _b.sent();
+                    _c.sent();
                     if (!apiResponse.IsTruncated) return [3 /*break*/, 4];
                     return [4 /*yield*/, deleteFolder({ S3Lib: S3Lib, bucket: bucket, client: client, folder: folder })];
                 case 3:
-                    _b.sent();
-                    _b.label = 4;
+                    _c.sent();
+                    _c.label = 4;
                 case 4: return [2 /*return*/];
             }
         });

package/{dist/aws → aws}/s3/getPresignedPost.js

@@ -48,8 +48,8 @@ var getPresignedPost = function (_a) {
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
-                    createPresignedPost = S3Lib.createPresignedPost;
-                    return [4 /*yield*/, createPresignedPost(client, {
+                    createPresignedPost = require('@aws-sdk/client-s3').createPresignedPost;
+                    return [4 /*yield*/, createPresignedPost(global.awsS3Client, {
                             Bucket: bucket,
                             Key: key,
                             Conditions: undefined === conditions ? [] : conditions,

package/aws/s3/getSignedUrl.d.ts

@@ -0,0 +1,12 @@
+import { Response } from '../../api/response';
+declare type GetSignedUrl = {
+    bucket: string;
+    expires: number;
+    key: string;
+};
+/**
+ * Returns a signed for URL to allow download of private buckets for a given duration.
+ * Library: @aws-sdk/s3-request-presigner
+ */
+declare const getSignedUrl: ({ bucket, expires, key }: GetSignedUrl) => Promise<Response>;
+export default getSignedUrl;