style(parameters): apply stricter linting

Author: dreamorosi

packages/parameters/src/appconfig/AppConfigProvider.ts

@@ -1,8 +1,5 @@
 import { getServiceName } from '@aws-lambda-powertools/commons/utils/env';
-import type {
-  AppConfigDataClientConfig,
-  StartConfigurationSessionCommandInput,
-} from '@aws-sdk/client-appconfigdata';
+import type { StartConfigurationSessionCommandInput } from '@aws-sdk/client-appconfigdata';
 import {
   AppConfigDataClient,
   GetLatestConfigurationCommand,
@@ -190,26 +187,20 @@ class AppConfigProvider extends BaseProvider {
   private readonly application?: string;
   private readonly environment: string;
 
-  /**
-   * initializes an `AppConfigProvider` class instance.
-   *
-   * @param options - The configuration object.
-   * @param options.environment - The environment ID or the environment name.
-   * @param options.application - Optional application ID or the application name.
-   * @param options.clientConfig - Optional configuration to pass during client initialization, e.g. AWS region. Mutually exclusive with `awsSdkV3Client`. Accepts the same configuration object as the AWS SDK v3 client ({@link AppConfigDataClientConfig | `AppConfigDataClientConfig`}).
-   * @param options.awsSdkV3Client - Optional ({@link AppConfigDataClient | `AppConfigDataClient`}) instance to pass during `AppConfigProvider` class instantiation. Mutually exclusive with `clientConfig`.
-   *
-   */
-  public constructor(options: AppConfigProviderOptions) {
+  public constructor({
+    application,
+    environment,
+    clientConfig,
+    awsSdkV3Client,
+  }: AppConfigProviderOptions) {
     super({
       awsSdkV3ClientPrototype: AppConfigDataClient as new (
         config?: unknown
       ) => AppConfigDataClient,
-      clientConfig: options.clientConfig,
-      awsSdkV3Client: options.awsSdkV3Client,
+      clientConfig,
+      awsSdkV3Client,
     });
 
-    const { application, environment } = options;
     this.application = application ?? getServiceName();
     if (!this.application || this.application.trim().length === 0) {
       throw new Error(
@@ -254,7 +245,7 @@ class AppConfigProvider extends BaseProvider {
       | undefined = AppConfigGetOptions,
   >(
     name: string,
-    options?: InferredFromOptionsType & AppConfigGetOptions
+    options?: NonNullable<InferredFromOptionsType & AppConfigGetOptions>
   ): Promise<
     | AppConfigGetOutput<ExplicitUserProvidedType, InferredFromOptionsType>
     | undefined
@@ -296,7 +287,7 @@ class AppConfigProvider extends BaseProvider {
    */
   protected async _get(
     name: string,
-    options?: AppConfigGetOptions
+    options?: NonNullable<AppConfigGetOptions>
   ): Promise<Uint8Array | undefined> {
     if (
       !this.configurationTokenStore.has(name) ||

packages/parameters/src/appconfig/getAppConfig.ts

@@ -6,39 +6,30 @@ import type {
 import { AppConfigProvider } from './AppConfigProvider.js';
 
 /**
- * ## Intro
- * The Parameters utility provides an AppConfigProvider that allows to retrieve configuration profiles from AWS AppConfig.
+ * The Parameters utility provides an `AppConfigProvider` that allows to retrieve configuration profiles from AWS AppConfig.
  *
- * ## Getting started
- *
- * This utility supports AWS SDK v3 for JavaScript only. This allows the utility to be modular, and you to install only
+ * This utility supports AWS SDK v3 for JavaScript only (`@aws-sdk/client-appconfigdata`). This allows the utility to be modular, and you to install only
  * the SDK packages you need and keep your bundle size small.
  *
- * To use the provider, you must install the Parameters utility and the AWS SDK v3 for JavaScript for AppConfig:
- *
- * ```sh
- * npm install @aws-lambda-powertools/parameters @aws-sdk/client-appconfigdata
- * ```
- *
- * ## Basic usage
+ * **Basic usage**
  *
  * @example
  * ```typescript
  * import { getAppConfig } from '@aws-lambda-powertools/parameters/appconfig';
  *
+ * const encodedConfig = await getAppConfig('my-config', {
+ *   application: 'my-app',
+ *   environment: 'prod',
+ * });
+ * const config = new TextDecoder('utf-8').decode(encodedConfig);
+ *
  * export const handler = async (): Promise<void> => {
- *   // Retrieve a configuration profile
- *   const encodedConfig = await getAppConfig('my-config', {
- *     application: 'my-app',
- *     environment: 'prod',
- *   });
- *   const config = new TextDecoder('utf-8').decode(encodedConfig);
+ *   // Use the config variable as needed
+ *   console.log(config);
  * };
  * ```
  *
- * ## Advanced usage
- *
- * ### Caching
+ * **Caching**
  *
  * By default, the provider will cache parameters retrieved in-memory for 5 seconds.
  * You can adjust how long values should be kept in cache by using the `maxAge` parameter.
@@ -47,13 +38,15 @@ import { AppConfigProvider } from './AppConfigProvider.js';
  * ```typescript
  * import { getAppConfig } from '@aws-lambda-powertools/parameters/appconfig';
  *
+ * const encodedConfig = await getAppConfig('my-config', {
+ *   application: 'my-app',
+ *   environment: 'prod',
+ *   maxAge: 10, // Cache for 10 seconds
+ * });
+ * const config = new TextDecoder('utf-8').decode(encodedConfig);
+ *
  * export const handler = async (): Promise<void> => {
- *   // Retrieve a configuration profile and cache it for 10 seconds
- *   const encodedConfig = await getAppConfig('my-config', {
- *     application: 'my-app',
- *     environment: 'prod',
- *   });
- *   const config = new TextDecoder('utf-8').decode(encodedConfig);
+ *   // Use the config variable as needed
  * };
  * ```
  *
@@ -63,32 +56,37 @@ import { AppConfigProvider } from './AppConfigProvider.js';
  * ```typescript
  * import { getAppConfig } from '@aws-lambda-powertools/parameters/appconfig';
  *
+ * const encodedConfig = await getAppConfig('my-config', {
+ *   application: 'my-app',
+ *   environment: 'prod',
+ *   forceFetch: true, // Always fetch the latest value
+ * });
+ * const config = new TextDecoder('utf-8').decode(encodedConfig);
+ *
  * export const handler = async (): Promise<void> => {
- *   // Retrieve a config and always fetch the latest value
- *   const config = await getAppConfig('my-config', {
- *     application: 'my-app',
- *     environment: 'prod',
- *     forceFetch: true,
- *   });
- *   const config = new TextDecoder('utf-8').decode(encodedConfig);
+ *   // Use the config variable as needed
+ *   console.log
  * };
  * ```
  *
- * ### Transformations
+ * **Transformations**
  *
  * For configurations stored as freeform JSON, Freature Flag, you can use the transform argument for deserialization. This will return a JavaScript object instead of a string.
  *
  * @example
  * ```typescript
  * import { getAppConfig } from '@aws-lambda-powertools/parameters/appconfig';
  *
+ * // Retrieve a JSON config and parse it as JSON
+ * const encodedConfig = await getAppConfig('my-config', {
+ *   application: 'my-app',
+ *   environment: 'prod',
+ *   transform: 'json'
+ * });
+ *
  * export const handler = async (): Promise<void> => {
- *   // Retrieve a JSON config or Feature Flag and parse it as JSON
- *   const config = await getAppConfig('my-config', {
- *     application: 'my-app',
- *     environment: 'prod',
- *     transform: 'json'
- *   });
+ *   // Use the config variable as needed
+ *   console.log(config);
  * };
  * ```
  *
@@ -108,7 +106,7 @@ import { AppConfigProvider } from './AppConfigProvider.js';
  * };
  * ```
  *
- * ### Extra SDK options
+ * **Extra SDK options**
  *
  * When retrieving a configuration profile, you can pass extra options to the AWS SDK v3 for JavaScript client by using the `sdkOptions` parameter.
  *
@@ -131,15 +129,18 @@ import { AppConfigProvider } from './AppConfigProvider.js';
  *
  * This object accepts the same options as the [AWS SDK v3 for JavaScript AppConfigData client](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-appconfigdata/interfaces/startconfigurationsessioncommandinput.html).
  *
- * ### Built-in provider class
+ * For greater flexibility such as configuring the underlying SDK client used by built-in providers, you can use the {@link AppConfigProvider | `AppConfigProvider`} class.
  *
- * For greater flexibility such as configuring the underlying SDK client used by built-in providers, you can use the {@link AppConfigProvider} class.
- *
- * For more usage examples, see [our documentation](https://docs.powertools.aws.dev/lambda/typescript/latest/features/parameters/).
- *
- * @param {string} name - The name of the configuration profile or its ID
- * @param {GetAppConfigOptions} options - Options to configure the provider
  * @see https://docs.powertools.aws.dev/lambda/typescript/latest/features/parameters/
+ *
+ * @param name - The name of the configuration profile or its ID
+ * @param options - Options to configure the provider
+ * @param options.application - The application ID or the application name.
+ * @param options.environment - The environment ID or the environment name.
+ * @param options.maxAge - The maximum age (in seconds) to keep values in cache. Default: 5 seconds.
+ * @param options.forceFetch - Whether to skip the cache and always fetch the latest value from the store. Default: `false`.
+ * @param options.transform - Optional transformation to apply to the retrieved value. Supported options are: 'json' and 'binary'.
+ * @param options.sdkOptions - Optional extra options to pass to the AWS SDK v3 for JavaScript client when retrieving the configuration profile.
  */
 const getAppConfig = <
   ExplicitUserProvidedType = undefined,
@@ -148,7 +149,7 @@ const getAppConfig = <
     | undefined = GetAppConfigOptions,
 >(
   name: string,
-  options: InferredFromOptionsType & GetAppConfigOptions
+  options: NonNullable<InferredFromOptionsType & GetAppConfigOptions>
 ): Promise<
   | AppConfigGetOutput<ExplicitUserProvidedType, InferredFromOptionsType>
   | undefined

packages/parameters/src/dynamodb/DynamoDBProvider.ts

@@ -234,17 +234,6 @@ class DynamoDBProvider extends BaseProvider {
   protected tableName: string;
   protected valueAttr = 'value';
 
-  /**
-   * Initialize a DynamoDBProvider class instance.
-   *
-   * @param config - The configuration object.
-   * @param config.tableName - The DynamoDB table name.
-   * @param config.keyAttr - Optional DynamoDB table key attribute name. Defaults to 'id'.
-   * @param config.sortAttr - Optional DynamoDB table sort attribute name. Defaults to 'sk'.
-   * @param config.valueAttr - Optional DynamoDB table value attribute name. Defaults to 'value'.
-   * @param config.clientConfig - Optional configuration to pass during client initialization, e.g. AWS region. Mutually exclusive with `awsSdkV3Client`, accepts the same options as the AWS SDK v3 client ({@link DynamoDBClient | `DynamoDBClient`}).
-   * @param config.awsSdkV3Client - Optional AWS SDK v3 client to pass during DynamoDBProvider class instantiation. Mutually exclusive with `clientConfig`, should be an instance of {@link DynamoDBClient | `DynamoDBClient`}.
-   */
   public constructor(config: DynamoDBProviderOptions) {
     super({
       awsSdkV3ClientPrototype: DynamoDBClient as new (
@@ -293,7 +282,7 @@ class DynamoDBProvider extends BaseProvider {
       | undefined = DynamoDBGetOptions,
   >(
     name: string,
-    options?: InferredFromOptionsType & DynamoDBGetOptions
+    options?: NonNullable<InferredFromOptionsType & DynamoDBGetOptions>
   ): Promise<
     | DynamoDBGetOutput<ExplicitUserProvidedType, InferredFromOptionsType>
     | undefined
@@ -338,7 +327,7 @@ class DynamoDBProvider extends BaseProvider {
       | undefined = DynamoDBGetMultipleOptions,
   >(
     path: string,
-    options?: InferredFromOptionsType & DynamoDBGetMultipleOptions
+    options?: NonNullable<InferredFromOptionsType & DynamoDBGetMultipleOptions>
   ): Promise<
     | DynamoDBGetMultipleOutput<
         ExplicitUserProvidedType,
@@ -362,12 +351,12 @@ class DynamoDBProvider extends BaseProvider {
    * @param options - Options to customize the retrieval
    * @param options.maxAge - Maximum age of the value in the cache, in seconds.
    * @param options.sdkOptions - Additional options to pass to the AWS SDK v3 client, supports all options from {@link GetItemCommandInput | `GetItemCommandInput`} except `Key`, `TableName`, and `ProjectionExpression`.
-   * @param params.forceFetch - Force fetch the value from the parameter store, ignoring the cache.
+   * @param options.forceFetch - Force fetch the value from the parameter store, ignoring the cache.
    * @param options.transform - Transform to be applied, can be 'json' or 'binary'.
    */
   protected async _get(
     name: string,
-    options?: DynamoDBGetOptions
+    options?: NonNullable<DynamoDBGetOptions>
   ): Promise<JSONValue | undefined> {
     const sdkOptions: GetItemCommandInput = {
       ...(options?.sdkOptions || {}),
@@ -396,7 +385,7 @@ class DynamoDBProvider extends BaseProvider {
    */
   protected async _getMultiple(
     path: string,
-    options?: DynamoDBGetMultipleOptions
+    options?: NonNullable<DynamoDBGetMultipleOptions>
   ): Promise<Record<string, JSONValue>> {
     const sdkOptions: QueryCommandInput = {
       ...(options?.sdkOptions || {}),

packages/parameters/src/secrets/SecretsProvider.ts

@@ -140,14 +140,7 @@ import type {
 class SecretsProvider extends BaseProvider {
   public declare client: SecretsManagerClient;
 
-  /**
-   * Initialize a `SecretsProvider` class.
-   *
-   * @param config - The configuration object.
-   * @param config.clientConfig - Optional configuration to pass during client initialization, e.g. AWS region. Mutually exclusive with `awsSdkV3Client`.
-   * @param config.awsSdkV3Client - Optional AWS SDK v3 client to pass during {@link SecretsProvider | `SecretsProvider`} class instantiation. Mutually exclusive with `clientConfig`.
-   */
-  public constructor(config?: SecretsProviderOptions) {
+  public constructor(config?: NonNullable<SecretsProviderOptions>) {
     super({
       awsSdkV3ClientPrototype: SecretsManagerClient as new (
         config?: unknown
@@ -187,7 +180,7 @@ class SecretsProvider extends BaseProvider {
       | undefined = SecretsGetOptions,
   >(
     name: string,
-    options?: InferredFromOptionsType & SecretsGetOptions
+    options?: NonNullable<InferredFromOptionsType & SecretsGetOptions>
   ): Promise<
     | SecretsGetOutput<ExplicitUserProvidedType, InferredFromOptionsType>
     | undefined
@@ -217,7 +210,7 @@ class SecretsProvider extends BaseProvider {
    */
   protected async _get(
     name: string,
-    options?: SecretsGetOptions
+    options?: NonNullable<SecretsGetOptions>
   ): Promise<string | Uint8Array | undefined> {
     const sdkOptions: GetSecretValueCommandInput = {
       ...(options?.sdkOptions || {}),

packages/parameters/src/secrets/getSecret.ts

@@ -97,7 +97,6 @@ import { SecretsProvider } from './SecretsProvider.js';
  * @param options.forceFetch - Whether to always fetch a new value from the store regardless if already available in cache (default: `false`)
  * @param options.transform - Whether to transform the value before returning it. Supported values: `json`, `binary`
  * @param options.sdkOptions - Extra options to pass to the AWS SDK v3 for JavaScript client, accepts the same configuration object as the AWS SDK v3 client ({@link SecretsManagerClientConfig | `SecretsManagerClientConfig`}).
- * @param options.decrypt - Whether to decrypt the value before returning it. (default: `false`)
  */
 const getSecret = <
   ExplicitUserProvidedType = undefined,
@@ -106,7 +105,7 @@ const getSecret = <
     | undefined = SecretsGetOptions,
 >(
   name: string,
-  options?: InferredFromOptionsType & SecretsGetOptions
+  options?: NonNullable<InferredFromOptionsType & SecretsGetOptions>
 ): Promise<
   | SecretsGetOutput<ExplicitUserProvidedType, InferredFromOptionsType>
   | undefined