fix(parameters): types in BaseProvider + added getMultiple alias to S…

…ecretsProvider (#1214)
aws-powertools · Jan 5, 2023 · 32bd7e8 · 32bd7e8
1 parent a3daba9
commit 32bd7e8
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/packages/parameters/src/BaseProvider.ts b/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 type { SecretsGetOptionsInterface } from './types/SecretsProvider';
 
 // These providers are dinamycally intialized on first use of the helper functions
 const DEFAULT_PROVIDERS: Record<string, BaseProvider> = {};
@@ -39,9 +38,8 @@ abstract class BaseProvider implements BaseProviderInterface {
    * this should be an acceptable tradeoff.
    * 
    * @param {string} name - Parameter name
-   * @param {GetOptionsInterface|SecretsGetOptionsInterface} options - Options to configure maximum age, trasformation, AWS SDK options, or force fetch
+   * @param {GetOptionsInterface} options - Options to configure maximum age, trasformation, AWS SDK options, or force fetch
    */
-  public async get(name: string, options?: SecretsGetOptionsInterface): Promise<undefined | string | Uint8Array | Record<string, unknown>>;
   public async get(name: string, options?: GetOptionsInterface): Promise<undefined | string | Uint8Array | Record<string, unknown>> {
     const configs = new GetOptions(options);
     const key = [ name, configs.transform ].toString();

diff --git a/packages/parameters/src/secrets/SecretsProvider.ts b/packages/parameters/src/secrets/SecretsProvider.ts
@@ -26,6 +26,16 @@ class SecretsProvider extends BaseProvider {
     return super.get(name, options);
   }
 
+  /**
+   * Retrieving multiple parameter values is not supported with AWS Secrets Manager.
+   */
+  public async getMultiple(
+    path: string,
+    _options?: unknown
+  ): Promise<undefined | Record<string, unknown>> {
+    return super.getMultiple(path);
+  }
+
   protected async _get(
     name: string,
     options?: SecretsGetOptionsInterface