@dmptool/utils 1.0.3 → 1.0.5

package/README.md

@@ -764,21 +764,20 @@ if (response) {
 
 This code provides a simple `getSSMParameter` function which can be used to fetch an SSM Parameter.
 
-Environment variable requirements:
-- `AWS_REGION` - The AWS region where the Lambda Function is running
-- `NODE_ENV` - The environment the Lambda Function is running in (e.g. `production`, `staging` or `development`)
-
 The code will use that value to construct the appropriate prefix for the key. For example if you are running in the AWS development environment it will use `/uc3/dmp/tool/dev/` as the prefix.
 
 ### Example usage
 ```typescript
-import { getSSMParameter } from '@dmptool/utils';
+import { logger, EnvironmentEnum, getSSMParameter, LogLevelEnum } from '@dmptool/utils';
 
 process.env.AWS_REGION = 'us-west-2';
 
+// Initialize the logger
+const logger: Logger = initializeLogger('exampleSSM', LogLevelEnum.DEBUG);
+
 const paramName = 'RdsDatabase';
 
-const response = await getSSMParameter(paramName);
+const response = await getSSMParameter(logger, paramName, EnvironmentEnum.DEV);
 
 if (response) {
   console.log('SSM Parameter fetched successfully', response);

package/dist/general.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Possible environments for the application.
+ */
+export declare enum EnvironmentEnum {
+    DEV = "dev",
+    STG = "stg",
+    PRD = "prd"
+}
 /**
  * Convert an error to a string
  *

package/dist/general.js

@@ -1,6 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.areEqual = exports.removeNullAndUndefinedFromObject = exports.isNullOrUndefined = exports.randomHex = exports.convertMySQLDateTimeToRFC3339 = exports.currentDateAsString = exports.normaliseHttpProtocol = exports.toErrorMessage = void 0;
+exports.areEqual = exports.removeNullAndUndefinedFromObject = exports.isNullOrUndefined = exports.randomHex = exports.convertMySQLDateTimeToRFC3339 = exports.currentDateAsString = exports.normaliseHttpProtocol = exports.toErrorMessage = exports.EnvironmentEnum = void 0;
+/**
+ * Possible environments for the application.
+ */
+var EnvironmentEnum;
+(function (EnvironmentEnum) {
+    EnvironmentEnum["DEV"] = "dev";
+    EnvironmentEnum["STG"] = "stg";
+    EnvironmentEnum["PRD"] = "prd";
+})(EnvironmentEnum || (exports.EnvironmentEnum = EnvironmentEnum = {}));
 /**
  * Convert an error to a string
  *

package/dist/logger.d.ts

@@ -1,17 +1,17 @@
 import { Logger } from 'pino';
-export declare enum LogLevel {
-    trace = "trace",
-    debug = "debug",
-    info = "info",
-    warn = "warn",
-    error = "error",
-    fatal = "fatal"
+export declare enum LogLevelEnum {
+    TRACE = "trace",
+    DEBUG = "debug",
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error",
+    FATAL = "fatal"
 }
 /**
  * Initialize a Pino logger with ECS formatting for the Lambda function.
  *
  * @param lambdaName Name of the function, used as the module name in the logs
- * @param logLevel Log level to use, defaults to 'info'
+ * @param logLevel Log level to use, defaults to 'LogLevelEnum.INFO'
  * @returns A Pino logger instance
  */
-export declare const initializeLogger: (lambdaName: string, logLevel: LogLevel) => Logger;
+export declare const initializeLogger: (lambdaName: string, logLevel?: LogLevelEnum) => Logger;

package/dist/logger.js

@@ -3,32 +3,32 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initializeLogger = exports.LogLevel = void 0;
+exports.initializeLogger = exports.LogLevelEnum = void 0;
 const pino_1 = __importDefault(require("pino"));
 const pino_lambda_1 = require("pino-lambda");
 const ecs_pino_format_1 = require("@elastic/ecs-pino-format");
 // The available log levels
-var LogLevel;
-(function (LogLevel) {
-    LogLevel["trace"] = "trace";
-    LogLevel["debug"] = "debug";
-    LogLevel["info"] = "info";
-    LogLevel["warn"] = "warn";
-    LogLevel["error"] = "error";
-    LogLevel["fatal"] = "fatal";
-})(LogLevel || (exports.LogLevel = LogLevel = {}));
+var LogLevelEnum;
+(function (LogLevelEnum) {
+    LogLevelEnum["TRACE"] = "trace";
+    LogLevelEnum["DEBUG"] = "debug";
+    LogLevelEnum["INFO"] = "info";
+    LogLevelEnum["WARN"] = "warn";
+    LogLevelEnum["ERROR"] = "error";
+    LogLevelEnum["FATAL"] = "fatal";
+})(LogLevelEnum || (exports.LogLevelEnum = LogLevelEnum = {}));
 /**
  * Initialize a Pino logger with ECS formatting for the Lambda function.
  *
  * @param lambdaName Name of the function, used as the module name in the logs
- * @param logLevel Log level to use, defaults to 'info'
+ * @param logLevel Log level to use, defaults to 'LogLevelEnum.INFO'
  * @returns A Pino logger instance
  */
-const initializeLogger = (lambdaName, logLevel) => {
+const initializeLogger = (lambdaName, logLevel = LogLevelEnum.INFO) => {
     const destination = (0, pino_lambda_1.pinoLambdaDestination)();
     const logger = (0, pino_1.default)(Object.assign({ 
         // Set the minimum log level
-        level: logLevel || 'info' }, ecs_pino_format_1.ecsFormat), destination);
+        level: logLevel || LogLevelEnum.INFO }, ecs_pino_format_1.ecsFormat), destination);
     // Define a standardized module name
     logger.child({ module: lambdaName });
     return logger;

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,31 +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() !== '') {
-        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.3",
+  "version": "1.0.5",
   "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",