@dmptool/utils 1.0.4 → 1.0.6

package/dist/rds.js

@@ -38,19 +38,20 @@ const mysql = __importStar(require("mysql2/promise"));
 const date_fns_1 = require("date-fns");
 /**
  * Connect to the MySQL database and run a query.
+ *
+ * @param params Connection parameters to use for the connection.
  * @returns A new connection to the MySQL database.
  */
-const createConnection = async () => {
-    var _a, _b, _c, _d;
-    const args = {
-        host: (_a = process.env.RDS_HOST) !== null && _a !== void 0 ? _a : 'localhost',
-        port: process.env.RDS_PORT ? Number.parseInt(process.env.RDS_PORT) : 3306,
-        user: (_b = process.env.RDS_USER) !== null && _b !== void 0 ? _b : 'root',
-        password: (_c = process.env.RDS_PASSWORD) !== null && _c !== void 0 ? _c : 'password',
-        database: (_d = process.env.RDS_DATABASE) !== null && _d !== void 0 ? _d : 'dmp',
-        multipleStatements: false,
-    };
-    return mysql.createConnection(args);
+const createConnection = async (params) => {
+    const { host, port, user, password, database } = params;
+    return mysql.createConnection({
+        host,
+        port,
+        user,
+        password,
+        database,
+        multipleStatements: false
+    });
 };
 /**
  * Function to convert the incoming value into an appropriate type for insertion
@@ -90,19 +91,30 @@ const prepareValue = (val, type) => {
  * Function to run a SQL query against the MySQL database.
  *
  * @param query the SQL query to run
+ * @param connectionParams the connection parameters to use for the connection
  * @param params the parameters to use in the query
  * @returns the results of the query
  */
 // Runs the provided SQL query and returns the results
-const queryTable = async (query, params = []) => {
-    const connection = await createConnection();
-    // Remove all tabs and new lines
-    const sql = query.split(/[\s\t\n]+/).join(' ');
-    // Prepare the values for the query
-    const vals = params.map((val) => prepareValue(val, typeof val));
-    // Run the query and then close the connection
-    const [results, fields] = await connection.query(sql, vals);
-    await connection.end();
-    return { results: results, fields: fields };
+const queryTable = async (connectionParams, query, params = []) => {
+    try {
+        if (!connectionParams || !connectionParams || !query || query.trim() === '') {
+            throw new Error('Missing connectionParameters or query');
+        }
+        const connection = await createConnection(connectionParams);
+        // Remove all tabs and new lines
+        const sql = query.split(/[\s\t\n]+/).join(' ');
+        // Prepare the values for the query
+        const vals = params.map((val) => prepareValue(val, typeof val));
+        // Run the query and then close the connection
+        connectionParams.logger.debug({ query, params }, 'Running MySQL query');
+        const [results, fields] = await connection.query(sql, vals);
+        await connection.end();
+        return { results: results, fields: fields };
+    }
+    catch (error) {
+        connectionParams.logger.fatal({ query, params, error }, 'Error running MySQL query');
+        return { results: [], fields: [] };
+    }
 };
 exports.queryTable = queryTable;

package/dist/s3.d.ts

@@ -1,3 +1,4 @@
+import { Logger } from 'pino';
 import { GetObjectCommandOutput, PutObjectCommandOutput } from "@aws-sdk/client-s3";
 export interface DMPToolListObjectsOutput {
     key: string;
@@ -7,38 +8,46 @@ export interface DMPToolListObjectsOutput {
 /**
  * List the contents of a bucket that match a key prefix.
  *
+ * @param logger The logger to use for logging.
  * @param bucket The name of the bucket to list.
  * @param keyPrefix The prefix to filter the results by.
+ * @param region The region to generate the URL in. Defaults to 'us-west-2'.
  * @returns A list of objects that match the key prefix, or undefined if the
  * bucket or key prefix are invalid.
  */
-export declare const listObjects: (bucket: string, keyPrefix: string) => Promise<DMPToolListObjectsOutput[] | []>;
+export declare const listObjects: (logger: Logger, bucket: string, keyPrefix: string, region?: string) => Promise<DMPToolListObjectsOutput[] | []>;
 /**
  * Get an object from the specified bucket.
  *
+ * @param logger The logger to use for logging.
  * @param bucket The name of the bucket to get the object from.
  * @param key The key of the object to get.
+ * @param region The region to generate the URL in. Defaults to 'us-west-2'.
  * @returns The object, or undefined if the bucket or key are invalid.
  */
-export declare const getObject: (bucket: string, key: string) => Promise<GetObjectCommandOutput | undefined>;
+export declare const getObject: (logger: Logger, bucket: string, key: string, region?: string) => Promise<GetObjectCommandOutput | undefined>;
 /**
  * Put an object into the specified bucket.
  *
+ * @param logger The logger to use for logging.
  * @param bucket The name of the bucket to put the object into.
  * @param key The key of the object to put.
  * @param body The object to put.
  * @param contentType The content type of the object.
  * @param contentEncoding The content encoding of the object.
+ * @param region The region to generate the URL in. Defaults to 'us-west-2'.
  * @returns The response from the S3 putObject operation, or undefined if the
  * bucket or key are invalid.
  */
-export declare const putObject: (bucket: string, key: string, body: any, contentType?: string, contentEncoding?: string) => Promise<PutObjectCommandOutput | undefined>;
+export declare const putObject: (logger: Logger, bucket: string, key: string, body: any, contentType?: string, contentEncoding?: string, region?: string) => Promise<PutObjectCommandOutput | undefined>;
 /**
  * Generate a Pre-signed URL for an S3 object.
  *
+ * @param logger The logger to use for logging.
  * @param bucket The name of the bucket to generate the URL for.
  * @param key The key of the object to generate the URL for.
  * @param usePutMethod Whether to use the PUT method for the URL. Defaults to false.
+ * @param region The region to generate the URL in. Defaults to 'us-west-2'.
  * @returns The Pre-signed URL, or undefined if the bucket or key are invalid.
  */
-export declare const getPresignedURL: (bucket: string, key: string, usePutMethod?: boolean) => Promise<string | undefined>;
+export declare const getPresignedURL: (logger: Logger, bucket: string, key: string, usePutMethod?: boolean, region?: string) => Promise<string | undefined>;

package/dist/s3.js

@@ -3,34 +3,44 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPresignedURL = exports.putObject = exports.getObject = exports.listObjects = void 0;
 const s3_request_presigner_1 = require("@aws-sdk/s3-request-presigner");
 const client_s3_1 = require("@aws-sdk/client-s3");
-const s3Client = new client_s3_1.S3Client({});
 /**
  * List the contents of a bucket that match a key prefix.
  *
+ * @param logger The logger to use for logging.
  * @param bucket The name of the bucket to list.
  * @param keyPrefix The prefix to filter the results by.
+ * @param region The region to generate the URL in. Defaults to 'us-west-2'.
  * @returns A list of objects that match the key prefix, or undefined if the
  * bucket or key prefix are invalid.
  */
-const listObjects = async (bucket, keyPrefix) => {
-    if (bucket && bucket.trim() !== '') {
-        const listObjectsCommand = new client_s3_1.ListObjectsV2Command({
-            Bucket: bucket,
-            Prefix: keyPrefix
-        });
-        const response = await s3Client.send(listObjectsCommand);
-        if (Array.isArray(response.Contents) && response.Contents.length > 0) {
-            const objects = [];
-            for (const obj of response.Contents) {
-                if (obj && obj.Key && obj.LastModified && obj.Size) {
-                    objects.push({
-                        key: obj.Key,
-                        lastModified: obj.LastModified,
-                        size: obj.Size
-                    });
+const listObjects = async (logger, bucket, keyPrefix, region = 'us-west-2') => {
+    if (logger && bucket && bucket.trim() !== '') {
+        const s3Client = new client_s3_1.S3Client({ region });
+        try {
+            const listObjectsCommand = new client_s3_1.ListObjectsV2Command({
+                Bucket: bucket,
+                Prefix: keyPrefix
+            });
+            logger.debug({ bucket, keyPrefix }, 'Listing objects in bucket');
+            const response = await s3Client.send(listObjectsCommand);
+            if (Array.isArray(response.Contents) && response.Contents.length > 0) {
+                const objects = [];
+                for (const obj of response.Contents) {
+                    if (obj && obj.Key && obj.LastModified && obj.Size) {
+                        objects.push({
+                            key: obj.Key,
+                            lastModified: obj.LastModified,
+                            size: obj.Size
+                        });
+                    }
                 }
+                logger.debug({ objects }, 'Found objects in bucket');
+                return objects;
             }
-            return objects;
+        }
+        catch (error) {
+            logger.fatal({ bucket, error }, 'Error listing objects in bucket');
+            throw error;
         }
     }
     return [];
@@ -39,14 +49,24 @@ exports.listObjects = listObjects;
 /**
  * Get an object from the specified bucket.
  *
+ * @param logger The logger to use for logging.
  * @param bucket The name of the bucket to get the object from.
  * @param key The key of the object to get.
+ * @param region The region to generate the URL in. Defaults to 'us-west-2'.
  * @returns The object, or undefined if the bucket or key are invalid.
  */
-const getObject = async (bucket, key) => {
-    if (bucket && key && bucket.trim() !== '' && key.trim() !== '') {
-        const command = new client_s3_1.GetObjectCommand({ Bucket: bucket, Key: key });
-        return await s3Client.send(command);
+const getObject = async (logger, bucket, key, region = 'us-west-2') => {
+    if (logger && bucket && key && bucket.trim() !== '' && key.trim() !== '') {
+        try {
+            const s3Client = new client_s3_1.S3Client({ region });
+            const command = new client_s3_1.GetObjectCommand({ Bucket: bucket, Key: key });
+            logger.debug({ bucket, key }, 'Getting object from bucket');
+            return await s3Client.send(command);
+        }
+        catch (error) {
+            logger.fatal({ bucket, key, error }, 'Error getting object from bucket');
+            throw error;
+        }
     }
     return undefined;
 };
@@ -54,24 +74,34 @@ exports.getObject = getObject;
 /**
  * Put an object into the specified bucket.
  *
+ * @param logger The logger to use for logging.
  * @param bucket The name of the bucket to put the object into.
  * @param key The key of the object to put.
  * @param body The object to put.
  * @param contentType The content type of the object.
  * @param contentEncoding The content encoding of the object.
+ * @param region The region to generate the URL in. Defaults to 'us-west-2'.
  * @returns The response from the S3 putObject operation, or undefined if the
  * bucket or key are invalid.
  */
-const putObject = async (bucket, key, body, contentType = 'application/json', contentEncoding = 'utf-8') => {
-    if (bucket && key && bucket.trim() !== '' && key.trim() !== '') {
-        const command = new client_s3_1.PutObjectCommand({
-            Bucket: bucket,
-            Key: key,
-            Body: body,
-            ContentType: contentType,
-            ContentEncoding: contentEncoding,
-        });
-        return await s3Client.send(command);
+const putObject = async (logger, bucket, key, body, contentType = 'application/json', contentEncoding = 'utf-8', region = 'us-west-2') => {
+    if (logger && bucket && key && bucket.trim() !== '' && key.trim() !== '') {
+        try {
+            const s3Client = new client_s3_1.S3Client({ region });
+            const command = new client_s3_1.PutObjectCommand({
+                Bucket: bucket,
+                Key: key,
+                Body: body,
+                ContentType: contentType,
+                ContentEncoding: contentEncoding,
+            });
+            logger.debug({ bucket, key }, 'Putting object into bucket');
+            return await s3Client.send(command);
+        }
+        catch (error) {
+            logger.fatal({ bucket, key, error }, 'Error putting object into bucket');
+            throw error;
+        }
     }
     return undefined;
 };
@@ -79,19 +109,29 @@ exports.putObject = putObject;
 /**
  * Generate a Pre-signed URL for an S3 object.
  *
+ * @param logger The logger to use for logging.
  * @param bucket The name of the bucket to generate the URL for.
  * @param key The key of the object to generate the URL for.
  * @param usePutMethod Whether to use the PUT method for the URL. Defaults to false.
+ * @param region The region to generate the URL in. Defaults to 'us-west-2'.
  * @returns The Pre-signed URL, or undefined if the bucket or key are invalid.
  */
-const getPresignedURL = async (bucket, key, usePutMethod = false) => {
-    if (bucket && key && bucket.trim() !== '' && key.trim() !== '') {
+const getPresignedURL = async (logger, bucket, key, usePutMethod = false, region = 'us-west-2') => {
+    if (logger && bucket && key && bucket.trim() !== '' && key.trim() !== '') {
+        const s3Client = new client_s3_1.S3Client({ region });
         const params = { Bucket: bucket, Key: key };
-        const command = usePutMethod
-            ? new client_s3_1.PutObjectCommand(params)
-            : new client_s3_1.GetObjectCommand(params);
-        return await (0, s3_request_presigner_1.getSignedUrl)(s3Client, command, { expiresIn: 900 });
-        ;
+        try {
+            const command = usePutMethod
+                ? new client_s3_1.PutObjectCommand(params)
+                : new client_s3_1.GetObjectCommand(params);
+            logger.debug(Object.assign(Object.assign({}, params), { usePutMethod }), 'Generating presigned URL');
+            return await (0, s3_request_presigner_1.getSignedUrl)(s3Client, command, { expiresIn: 900 });
+            ;
+        }
+        catch (error) {
+            logger.fatal(Object.assign(Object.assign({}, params), { usePutMethod, error }), 'Error generating a presigned URL');
+            throw error;
+        }
     }
     return undefined;
 };

package/dist/ssm.d.ts

@@ -1,8 +1,12 @@
+import { EnvironmentEnum } from "./general";
+import { Logger } from 'pino';
 /**
  * Retrieve a variable from the SSM Parameter store.
  *
+ * @param logger The logger to use for logging.
  * @param key The name of the variable to retrieve.
+ * @param env The environment to retrieve the variable from. Defaults to `EnvironmentEnum.DEV`.
  * @returns The value of the variable, or undefined if the variable could not be found.
  * @throws
  */
-export declare const getSSMParameter: (key: string) => Promise<string | undefined>;
+export declare const getSSMParameter: (logger: Logger, key: string, env?: EnvironmentEnum) => Promise<string | undefined>;

package/dist/ssm.js

@@ -1,32 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSSMParameter = void 0;
-const client_ssm_1 = require("@aws-sdk/client-ssm");
 const general_1 = require("./general");
-// Create an SSM client
-const client = new client_ssm_1.SSMClient();
-const ENV = process.env.NODE_ENV === 'production'
-    ? 'prd' : (process.env.NODE_ENV === 'staging'
-    ? 'stg' : 'dev');
-const KEY_PREFIX = `/uc3/dmp/tool/${ENV}/`;
+const client_ssm_1 = require("@aws-sdk/client-ssm");
 /**
  * Retrieve a variable from the SSM Parameter store.
  *
+ * @param logger The logger to use for logging.
  * @param key The name of the variable to retrieve.
+ * @param env The environment to retrieve the variable from. Defaults to `EnvironmentEnum.DEV`.
  * @returns The value of the variable, or undefined if the variable could not be found.
  * @throws
  */
-const getSSMParameter = async (key) => {
+const getSSMParameter = async (logger, key, env = general_1.EnvironmentEnum.DEV) => {
     var _a;
-    if (key && key.trim() !== '') {
-        console.log(`Fetching parameter ${KEY_PREFIX}${key}`);
-        const command = new client_ssm_1.GetParameterCommand({
-            Name: `${KEY_PREFIX}${key}`,
-            WithDecryption: true
-        });
-        const response = await client.send(command);
-        if (!(0, general_1.isNullOrUndefined)(response) && !(0, general_1.isNullOrUndefined)(response.Parameter)) {
-            return (_a = response.Parameter) === null || _a === void 0 ? void 0 : _a.Value;
+    if (logger && key && key.trim() !== '') {
+        // Create an SSM client
+        const client = new client_ssm_1.SSMClient();
+        const keyPrefix = `/uc3/dmp/tool/${env.toLowerCase()}/`;
+        logger.debug(`Fetching parameter ${keyPrefix}${key}`);
+        try {
+            const command = new client_ssm_1.GetParameterCommand({
+                Name: `${keyPrefix}${key}`,
+                WithDecryption: true
+            });
+            const response = await client.send(command);
+            if (!(0, general_1.isNullOrUndefined)(response) && !(0, general_1.isNullOrUndefined)(response.Parameter)) {
+                return (_a = response.Parameter) === null || _a === void 0 ? void 0 : _a.Value;
+            }
+            logger.warn(`Parameter ${keyPrefix}${key} not found.`);
+        }
+        catch (error) {
+            logger.fatal(`Error fetching parameter ${keyPrefix}${key}: ${error}`);
         }
     }
     return undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dmptool/utils",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Helper/Utility functions for use in the DMP Tool services. Particularly AWS tooling and maDMP serialization",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -51,6 +51,7 @@
     "@aws-sdk/util-dynamodb": "^3.966.0"
   },
   "devDependencies": {
+    "@aws-sdk/util-stream-node": "^3.370.0",
     "@eslint/js": "^9.26.0",
     "@types/jest": "^29.5.14",
     "@types/node": "^20.4.3",