feat: added decrypt option to get param

Author: dreamorosi

Diff for: packages/parameters/src/BaseProvider.ts

@@ -5,6 +5,8 @@ import { ExpirableValue } from './ExpirableValue';
 import { TRANSFORM_METHOD_BINARY, TRANSFORM_METHOD_JSON } from './constants';
 import { GetParameterError, TransformParameterError } from './Exceptions';
 import type { BaseProviderInterface, GetMultipleOptionsInterface, GetOptionsInterface, TransformOptions } from './types';
+import { isSSMGetOptionsInterface } from './types/SSMProvider';
+import type { SSMGetOptionsInterface } from './types/SSMProvider';
 
 abstract class BaseProvider implements BaseProviderInterface {
   protected store: Map<string, ExpirableValue>;
@@ -35,8 +37,9 @@ abstract class BaseProvider implements BaseProviderInterface {
    * this should be an acceptable tradeoff.
    * 
    * @param {string} name - Parameter name
-   * @param {GetOptionsInterface} options - Options to configure maximum age, trasformation, AWS SDK options, or force fetch
+   * @param {GetOptionsInterface|SSMGetOptionsInterface} options - Options to configure maximum age, trasformation, AWS SDK options, or force fetch
    */
+  public async get(name: string, options?: SSMGetOptionsInterface): Promise<undefined | string | Record<string, unknown>>;
   public async get(name: string, options?: GetOptionsInterface): Promise<undefined | string | Record<string, unknown>> {
     const configs = new GetOptions(options);
     const key = [ name, configs.transform ].toString();
@@ -49,6 +52,11 @@ abstract class BaseProvider implements BaseProviderInterface {
 
     let value;
     try {
+      // Type assertion is needed because the SSM provider has a different signature for the get method
+      if (options && isSSMGetOptionsInterface(options) && options.decrypt) {
+        options.sdkOptions = options.sdkOptions || {};
+        options.sdkOptions.WithDecryption = true;
+      }
       value = await this._get(name, options?.sdkOptions);
     } catch (error) {
       throw new GetParameterError((error as Error).message);

Diff for: packages/parameters/src/types/SSMProvider.ts

@@ -0,0 +1,25 @@
+import type { GetParameterCommandInput } from '@aws-sdk/client-ssm';
+import type { TransformOptions } from 'types/BaseProvider';
+
+/**
+ * Options for the SSMProvider get method.
+ * 
+ * @interface SSMGetOptionsInterface
+ * @extends {GetOptionsInterface}
+ * @property {boolean} decrypt - If true, the parameter will be decrypted.
+ * @property {Partial<GetParameterCommandInput>} sdkOptions - Options for the AWS SDK.
+ */
+interface SSMGetOptionsInterface {
+  maxAge?: number
+  sdkOptions?: Partial<GetParameterCommandInput>
+  forceFetch?: boolean
+  decrypt?: boolean
+  transform?: TransformOptions
+}
+
+const isSSMGetOptionsInterface = (options: unknown): options is SSMGetOptionsInterface => (options as SSMGetOptionsInterface).decrypt !== undefined;
+
+export {
+  SSMGetOptionsInterface,
+  isSSMGetOptionsInterface,
+};

Diff for: packages/parameters/tests/unit/BaseProvider.test.ts

@@ -111,7 +111,7 @@ describe('Class: BaseProvider', () => {
 
     });
 
-    test('when called and values cached are expired, it returns the remote values', async () => {
+    test('when called and cached value is expired, it returns the remote value', async () => {
 
       // Prepare
       const mockData = 'my-remote-value';

Diff for: packages/parameters/tests/unit/SSMProvider.test.ts

@@ -57,6 +57,24 @@ describe('Class: SSMProvider', () => {
 
     });
 
+    test('when called with the decrypt option, the WithDecryption parameter is passed to the sdk client', async () => {
+
+      // Prepare
+      const provider = new SSMProvider();
+      const client = mockClient(SSMClient).on(GetParameterCommand).resolves({});
+      const parameterName = 'foo';
+
+      // Act
+      provider.get(parameterName, { decrypt: true });
+
+      // Assess
+      expect(client).toReceiveCommandWith(GetParameterCommand, {
+        Name: parameterName,
+        WithDecryption: true,
+      });
+
+    });
+
   });
 
   describe('Method: _getMultiple', () => {