refactor: moved SSM specific logic from BaseProvider to SSMProvider

Author: dreamorosi

packages/parameters/src/BaseProvider.ts

@@ -5,7 +5,6 @@ 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, isSSMGetMultipleOptionsInterface } from './types/SSMProvider';
 import type { SSMGetOptionsInterface, SSMGetMultipleOptionsInterface } from './types/SSMProvider';
 
 // These providers will be dynamically initialized on first use of the helper functions
@@ -55,12 +54,7 @@ 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);
+      value = await this._get(name, options);
     } catch (error) {
       throw new GetParameterError((error as Error).message);
     }
@@ -90,13 +84,7 @@ abstract class BaseProvider implements BaseProviderInterface {
 
     let values: Record<string, unknown> = {};
     try {
-      // Type assertion is needed because the SSM provider has a different signature for the get method
-      if (options && isSSMGetMultipleOptionsInterface(options)) {
-        options.sdkOptions = options.sdkOptions || {};
-        if (options.hasOwnProperty('decrypt')) options.sdkOptions.WithDecryption = options.decrypt;
-        if (options.hasOwnProperty('recursive')) options.sdkOptions.Recursive = options.recursive;
-      }
-      values = await this._getMultiple(path, options?.sdkOptions);
+      values = await this._getMultiple(path, options);
     } catch (error) {
       throw new GetParameterError((error as Error).message);
     }

packages/parameters/src/SSMProvider.ts

@@ -12,34 +12,41 @@ class SSMProvider extends BaseProvider {
     this.client = new SSMClient(config);
   }
 
-  protected async _get(name: string, sdkOptions?: Partial<GetParameterCommandInput>): Promise<string | undefined> {
-    const options: GetParameterCommandInput = {
+  protected async _get(name: string, options?: SSMGetOptionsInterface): Promise<string | undefined> {
+    const sdkOptions: GetParameterCommandInput = {
       Name: name,
     };
-    if (sdkOptions) {
-      Object.assign(options, sdkOptions);
+    if (options) {
+      if (options.hasOwnProperty('decrypt')) sdkOptions.WithDecryption = options.decrypt;
+      if (options.hasOwnProperty('sdkOptions')) {
+        Object.assign(sdkOptions, options.sdkOptions);
+      }
     }
-    const result = await this.client.send(new GetParameterCommand(options));
+    const result = await this.client.send(new GetParameterCommand(sdkOptions));
 
     return result.Parameter?.Value;
   }
 
-  protected async _getMultiple(path: string, sdkOptions?: Partial<GetParametersByPathCommandInput>): Promise<Record<string, string | undefined>> {
-    const options: GetParametersByPathCommandInput = {
+  protected async _getMultiple(path: string, options?: SSMGetMultipleOptionsInterface): Promise<Record<string, string | undefined>> {
+    const sdkOptions: GetParametersByPathCommandInput = {
       Path: path,
     };
     const paginationOptions: PaginationConfiguration = {
       client: this.client
     };
-    if (sdkOptions) {
-      Object.assign(options, sdkOptions);
-      if (sdkOptions.MaxResults) {
-        paginationOptions.pageSize = sdkOptions.MaxResults;
+    if (options) {
+      if (options.hasOwnProperty('decrypt')) sdkOptions.WithDecryption = options.decrypt;
+      if (options.hasOwnProperty('recursive')) sdkOptions.Recursive = options.recursive;
+      if (options.hasOwnProperty('sdkOptions')) {
+        Object.assign(sdkOptions, options.sdkOptions);
+        if (sdkOptions.MaxResults) {
+          paginationOptions.pageSize = sdkOptions.MaxResults;
+        }
       }
     }
-
+    
     const parameters: Record<string, string | undefined> = {};
-    for await (const page of paginateGetParametersByPath(paginationOptions, options)) {
+    for await (const page of paginateGetParametersByPath(paginationOptions, sdkOptions)) {
       for (const parameter of page.Parameters || []) {
         /**
          * Standardize the parameter name

packages/parameters/src/types/SSMProvider.ts

@@ -17,8 +17,6 @@ interface SSMGetOptionsInterface {
   transform?: TransformOptions
 }
 
-const isSSMGetOptionsInterface = (options: unknown): options is SSMGetOptionsInterface => (options as SSMGetOptionsInterface).decrypt !== undefined;
-
 interface SSMGetMultipleOptionsInterface {
   maxAge?: number
   forceFetch?: boolean
@@ -29,14 +27,7 @@ interface SSMGetMultipleOptionsInterface {
   throwOnTransformError?: boolean
 }
 
-const isSSMGetMultipleOptionsInterface = 
-  (options: unknown): options is SSMGetMultipleOptionsInterface => 
-    (options as SSMGetMultipleOptionsInterface).decrypt !== undefined || 
-    (options as SSMGetMultipleOptionsInterface).recursive !== undefined;
-
 export {
   SSMGetOptionsInterface,
-  isSSMGetOptionsInterface,
   SSMGetMultipleOptionsInterface,
-  isSSMGetMultipleOptionsInterface,
 };