@dmptool/utils 1.0.35 → 1.0.36

package/dist/ssm.d.ts

@@ -1,15 +1,19 @@
 import { EnvironmentEnum } from "./general";
 import { Logger } from 'pino';
+export interface SsmConnectionParams {
+    logger: Logger;
+    region: string;
+    useTLS?: boolean;
+    endpoint?: string;
+}
 /**
  * Retrieve a variable from the SSM Parameter store.
  *
- * @param logger The logger to use for logging.
+ * @param connectionParams The connection parameters to use for the SSM client.
  * @param key The name of the variable to retrieve.
  * @param env The environment to retrieve the variable from. Defaults to `EnvironmentEnum.DEV`.
- * @param region The region to retrieve the variable from. Defaults to 'us-west-2'.
- * @param useTLS Whether to use TLS when connecting to the SSM Parameter store. Defaults to true.
  * Should be false when running in a local development environment.
  * @returns The value of the variable, or undefined if the variable could not be found.
  * @throws
  */
-export declare const getSSMParameter: (logger: Logger, key: string, env?: EnvironmentEnum, endpoint?: string, region?: string, useTLS?: boolean) => Promise<string | undefined>;
+export declare const getSSMParameter: (connectionParams: SsmConnectionParams, key: string, env?: EnvironmentEnum, endpoint?: string) => Promise<string | undefined>;

package/dist/ssm.js

@@ -6,24 +6,22 @@ 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 connectionParams The connection parameters to use for the SSM client.
  * @param key The name of the variable to retrieve.
  * @param env The environment to retrieve the variable from. Defaults to `EnvironmentEnum.DEV`.
- * @param region The region to retrieve the variable from. Defaults to 'us-west-2'.
- * @param useTLS Whether to use TLS when connecting to the SSM Parameter store. Defaults to true.
  * Should be false when running in a local development environment.
  * @returns The value of the variable, or undefined if the variable could not be found.
  * @throws
  */
-const getSSMParameter = async (logger, key, env = general_1.EnvironmentEnum.DEV, endpoint, region = 'us-west-2', useTLS = true) => {
+const getSSMParameter = async (connectionParams, key, env = general_1.EnvironmentEnum.DEV, endpoint) => {
     var _a;
-    if (logger && key && key.trim() !== '') {
+    if (connectionParams.logger && key && key.trim() !== '') {
         // Create an SSM client (use the endpoint if we are not using TLS - local dev)
-        const client = useTLS
+        const client = connectionParams.useTLS
             ? new client_ssm_1.SSMClient()
-            : new client_ssm_1.SSMClient({ endpoint, region, tls: false });
+            : new client_ssm_1.SSMClient(connectionParams);
         const keyPrefix = `/uc3/dmp/tool/${env.toLowerCase()}/`;
-        logger.debug(`Fetching parameter ${keyPrefix}${key}`);
+        connectionParams.logger.debug(`Fetching parameter ${keyPrefix}${key}`);
         try {
             const command = new client_ssm_1.GetParameterCommand({
                 Name: `${keyPrefix}${key}`,
@@ -33,10 +31,10 @@ const getSSMParameter = async (logger, key, env = general_1.EnvironmentEnum.DEV,
             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.`);
+            connectionParams.logger.warn(`Parameter ${keyPrefix}${key} not found.`);
         }
         catch (error) {
-            logger.fatal(`Error fetching parameter ${keyPrefix}${key}: ${error}`);
+            connectionParams.logger.fatal(`Error fetching parameter ${keyPrefix}${key}: ${error}`);
         }
     }
     return undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dmptool/utils",
-  "version": "1.0.35",
+  "version": "1.0.36",
   "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",
@@ -41,14 +41,14 @@
     "pino-lambda": "^4.4.1"
   },
   "peerDependencies": {
-    "@aws-sdk/client-cloudformation": "^3.966.0",
-    "@aws-sdk/client-dynamodb": "^3.966.0",
-    "@aws-sdk/client-sqs": "^3.968.0",
-    "@aws-sdk/client-s3": "^3.966.0",
-    "@aws-sdk/client-sns": "^3.967.0",
-    "@aws-sdk/client-ssm": "^3.966.0",
-    "@aws-sdk/s3-request-presigner": "^3.966.0",
-    "@aws-sdk/util-dynamodb": "^3.966.0"
+    "@aws-sdk/client-cloudformation": "^3.980.0",
+    "@aws-sdk/client-dynamodb": "^3.980.0",
+    "@aws-sdk/client-sqs": "^3.980.0",
+    "@aws-sdk/client-s3": "^3.980.0",
+    "@aws-sdk/client-sns": "^3.980.0",
+    "@aws-sdk/client-ssm": "^3.980.0",
+    "@aws-sdk/s3-request-presigner": "^3.980.0",
+    "@aws-sdk/util-dynamodb": "^3.980.0"
   },
   "devDependencies": {
     "@aws-sdk/util-stream-node": "^3.370.0",