@8ms/helpers 1.0.7 → 1.0.11

package/dist/api/types.d.ts

@@ -2,5 +2,6 @@ import { ApiStatus } from './constants';
 export declare type ApiResponseType = {
     body: any | null;
     error: string | null;
-    status: typeof ApiStatus.ERROR | typeof ApiStatus.IDLE | typeof ApiStatus.PENDING | typeof ApiStatus.SUCCESS | typeof ApiStatus.VALIDATION_ERROR;
+    status: ApiStatusType;
 };
+export declare type ApiStatusType = typeof ApiStatus.ERROR | typeof ApiStatus.IDLE | typeof ApiStatus.PENDING | typeof ApiStatus.SUCCESS | typeof ApiStatus.VALIDATION_ERROR;

package/dist/aws/athenaExpress/getClient.js

@@ -1,5 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+var getConfig_1 = __importDefault(require("../getConfig"));
 var athenaClient = undefined;
 /**
  * Initialise the database using manually provided credentials.
@@ -7,8 +11,9 @@ var athenaClient = undefined;
 var getClient = function (_a) {
     var AthenaExpress = _a.AthenaExpress, AwsSdk = _a.AwsSdk, athenaS3 = _a.athenaS3, config = _a.config, database = _a.database;
     if (!global.awsAthenaClient) {
+        var formattedConfig = (0, getConfig_1.default)({ config: config, isAthenaExpress: true });
         // Set the aws authentication
-        AwsSdk.config.update(config);
+        AwsSdk.config.update(formattedConfig);
         global.awsAthenaClient = new AthenaExpress.AthenaExpress({
             aws: AwsSdk,
             s3: athenaS3,

package/dist/aws/getConfig.d.ts

@@ -0,0 +1,9 @@
+import { AwsConfigType } from './types';
+/**
+ * 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: AwsConfigType;
+    isAthenaExpress: boolean;
+}) => object;
+export default getConfig;

package/dist/aws/getConfig.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * 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).
+ */
+var getConfig = function (_a) {
+    var config = _a.config, isAthenaExpress = _a.isAthenaExpress;
+    var response = {
+        region: config.region,
+    };
+    // 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) {
+            response['accessKeyId'] = config.accessKeyId;
+            response['secretAccessKey'] = config.secretAccessKey;
+        }
+        // AWS services are under credentials
+        else {
+            response['credentials'] = {
+                accessKeyId: config.accessKeyId,
+                secretAccessKey: config.secretAccessKey,
+            };
+        }
+    }
+    return response;
+};
+exports.default = getConfig;

package/dist/aws/glue/getClient.js

@@ -1,5 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+var getConfig_1 = __importDefault(require("../getConfig"));
 var glueClient = undefined;
 /**
  * Shorthand function to get the Glue Client.
@@ -9,7 +13,8 @@ var getClient = function (_a) {
     var GlueLib = _a.GlueLib, config = _a.config;
     if (!global.awsGlueClient) {
         var GlueClient = GlueLib.GlueClient;
-        global.awsGlueClient = new GlueClient(config);
+        var formattedConfig = (0, getConfig_1.default)({ config: config, isAthenaExpress: false });
+        global.awsGlueClient = new GlueClient(formattedConfig);
     }
     glueClient = global.awsGlueClient;
     return glueClient;

package/dist/aws/lambda/getClient.js

@@ -1,5 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+var getConfig_1 = __importDefault(require("../getConfig"));
 var lambdaClient = undefined;
 /**
  * Shorthand function to get the Lambda Client.
@@ -9,7 +13,8 @@ var getClient = function (_a) {
     var LambdaLib = _a.LambdaLib, config = _a.config;
     if (!global.awsLambdaClient) {
         var LambdaClient = LambdaLib.LambdaClient;
-        global.awsLambdaClient = new LambdaClient(config);
+        var formattedConfig = (0, getConfig_1.default)({ config: config, isAthenaExpress: false });
+        global.awsLambdaClient = new LambdaClient(formattedConfig);
     }
     lambdaClient = global.awsLambdaClient;
     return lambdaClient;

package/dist/aws/s3/getClient.js

@@ -1,5 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+var getConfig_1 = __importDefault(require("../getConfig"));
 var s3Client = undefined;
 /**
  * Shorthand function to get the S3 Client.
@@ -9,7 +13,8 @@ var getClient = function (_a) {
     var S3Lib = _a.S3Lib, config = _a.config;
     if (!global.awsS3Client) {
         var S3Client = S3Lib.S3Client;
-        global.awsS3Client = new S3Client(config);
+        var formattedConfig = (0, getConfig_1.default)({ config: config, isAthenaExpress: false });
+        global.awsS3Client = new S3Client(formattedConfig);
     }
     s3Client = global.awsS3Client;
     return s3Client;

package/dist/aws/ses/getClient.js

@@ -1,5 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+var getConfig_1 = __importDefault(require("../getConfig"));
 var sesClient = undefined;
 /**
  * Shorthand function to get the SES Client.
@@ -9,7 +13,8 @@ var getClient = function (_a) {
     var SesLib = _a.SesLib, config = _a.config;
     if (!global.awsSesClient) {
         var SESClient = SesLib.SESClient;
-        global.sesClient = new SESClient(config);
+        var formattedConfig = (0, getConfig_1.default)({ config: config, isAthenaExpress: false });
+        global.sesClient = new SESClient(formattedConfig);
     }
     sesClient = global.awsSesClient;
     return sesClient;

package/dist/aws/ssm/getClient.js

@@ -1,5 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+var getConfig_1 = __importDefault(require("../getConfig"));
 var ssmClient = undefined;
 /**
  * Shorthand function to get the Lambda Client.
@@ -9,7 +13,8 @@ var getClient = function (_a) {
     var SsmLib = _a.SsmLib, config = _a.config;
     if (!global.awsSsmClient) {
         var SSMClient = SsmLib.SSMClient;
-        global.awsSsmClient = new SSMClient(config);
+        var formattedConfig = (0, getConfig_1.default)({ config: config, isAthenaExpress: false });
+        global.awsSsmClient = new SSMClient(formattedConfig);
     }
     ssmClient = global.awsSsmClient;
     return ssmClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name":            "@8ms/helpers",
-  "version":         "1.0.7",
+  "version":         "1.0.11",
   "repository":      {
 	"type": "git",
 	"url":  "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"
@@ -11,7 +11,7 @@
 	"dist/**/*"
   ],
   "scripts":         {
-	"build": "rimraf dist && tsc"
+	"build":   "rimraf dist && tsc"
   },
   "dependencies":    {
 	"axios":    "0.25.0",