Feature request: improve return types for Secrets Manager Parameters

[dreamorosi]

Use case

Note
This is a follow up issue to #1386 and aims at continuing the work started in #1387

Currently when retrieving parameter values from Secrets Manager, the Parameter utility has somewhat generic return types.

For example, when calling the getSecret function the current return type is a Promise that can resolve to undefined | string | Uint8Array | Record<string, unknown>. These types were chosen because they map to the following cases:

• string applies when a SecretString value is retrieved and no transform is applied - this also applies when a base64 encoded value stored in a SecretString is retrieved and a binary transform is applied
• Uint8Array applies when retrieving a SecretBinary value is retrieved an no transform is applied
• Record<string, unknown> applies whenever a transform: 'json' is applied - in this case Parameters parses the value and returns an object
• undefined is returned whenever a parameter is not found

Given that the utility knows both the types returned by the API and the transformation to be applied, there's an opportunity to improve the return types by applying some heuristics.

Solution/User Experience

TBD

Alternative solutions

N/A

Acknowledgment

• This feature request meets Lambda Powertools Tenets
• Should this be considered in other Lambda Powertools languages? i.e. Python, Java, and .NET

Future readers

Please react with 👍 and your use case to help us understand customer demand.

[dreamorosi]

After looking into options I have found that the solution and types for this provider will be very similar to the one already introduced for the SSMProvider.

I will open a PR shortly.

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.