chore: revisit utility types (#1223)

Author: dreamorosi

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

@@ -65,7 +65,6 @@ abstract class BaseProvider implements BaseProviderInterface {
       this.addToCache(key, value, configs.maxAge);
     }
 
-    // TODO: revisit return type once providers are implemented, it might be missing binary when not transformed
     return value;
   }
 
@@ -94,7 +93,6 @@ abstract class BaseProvider implements BaseProviderInterface {
       this.addToCache(key, values, configs.maxAge);
     }
 
-    // TODO: revisit return type once providers are implemented, it might be missing something
     return values;
   }
 

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

@@ -21,7 +21,7 @@ import type {
   SSMGetParametersByNameOptionsInterface,
   SSMSplitBatchAndDecryptParametersOutputType,
   SSMGetParametersByNameFromCacheOutputType,
-} from 'types/SSMProvider';
+} from '../types/SSMProvider';
 import type { PaginationConfiguration } from '@aws-sdk/types';
 
 class SSMProvider extends BaseProvider {

Diff for: packages/parameters/src/ssm/getParametersByName.ts

@@ -1,10 +1,12 @@
 import { SSMProvider, DEFAULT_PROVIDERS } from './SSMProvider';
-import type { SSMGetParametersByNameOptionsInterface } from '../types/SSMProvider';
+import type {
+  SSMGetParametersByNameOptionsInterface
+} from '../types/SSMProvider';
 
 const getParametersByName = (
   parameters: Record<string, SSMGetParametersByNameOptionsInterface>,
   options?: SSMGetParametersByNameOptionsInterface
-): Promise<Record<string, unknown>> => {
+): Promise<Record<string, unknown> & { _errors?: string[] }> => {
   if (!DEFAULT_PROVIDERS.hasOwnProperty('ssm')) {
     DEFAULT_PROVIDERS.ssm = new SSMProvider();
   }

Diff for: packages/parameters/src/ssm/index.ts

@@ -1,4 +1,5 @@
 export * from './SSMProvider';
 export * from './getParameter';
 export * from './getParameters';
-export * from './getParametersByName';
+export * from './getParametersByName';
+export * from '../types/SSMProvider';

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

@@ -43,7 +43,7 @@ interface GetAppConfigCombinedInterface
   extends Omit<AppConfigProviderOptions, 'clientConfig'>,
   AppConfigGetOptionsInterface {}
 
-export {
+export type {
   AppConfigProviderOptions,
   AppConfigGetOptionsInterface,
   GetAppConfigCombinedInterface,

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

@@ -21,7 +21,7 @@ interface BaseProviderInterface {
   getMultiple(path: string, options?: GetMultipleOptionsInterface): Promise<void | Record<string, unknown>>
 }
 
-export {
+export type {
   GetOptionsInterface,
   GetMultipleOptionsInterface,
   BaseProviderInterface,

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

@@ -3,7 +3,11 @@ import type {
   GetParameterCommandInput,
   GetParametersByPathCommandInput
 } from '@aws-sdk/client-ssm';
-import type { GetOptionsInterface, GetMultipleOptionsInterface, TransformOptions } from './BaseProvider';
+import type {
+  GetOptionsInterface,
+  GetMultipleOptionsInterface,
+  TransformOptions
+} from './BaseProvider';
 
 interface SSMProviderOptionsInterface {
   clientConfig: SSMClientConfig
@@ -51,7 +55,7 @@ type SSMGetParametersByNameFromCacheOutputType = {
   toFetch: Record<string, SSMGetParametersByNameOptionsInterface>
 };
 
-export {
+export type {
   SSMProviderOptionsInterface,
   SSMGetOptionsInterface,
   SSMGetMultipleOptionsInterface,

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

@@ -1 +1,5 @@
-export * from './BaseProvider';
+export * from './BaseProvider';
+export * from './AppConfigProvider';
+export * from './SSMProvider';
+export * from './SecretsProvider';
+export * from './DynamoDBProvider';

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

@@ -4,15 +4,14 @@
  * @group unit/parameters/AppConfigProvider/class
  */
 import { AppConfigProvider } from '../../src/appconfig/index';
-
+import { AppConfigProviderOptions } from '../../src/types/AppConfigProvider';
 import {
   AppConfigDataClient,
   StartConfigurationSessionCommand,
   GetLatestConfigurationCommand,
 } from '@aws-sdk/client-appconfigdata';
 import { mockClient } from 'aws-sdk-client-mock';
 import 'aws-sdk-client-mock-jest';
-import { AppConfigProviderOptions } from '../../src/types/AppConfigProvider';
 
 describe('Class: AppConfigProvider', () => {
   const client = mockClient(AppConfigDataClient);

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

@@ -3,8 +3,12 @@
  *
  * @group unit/parameters/baseProvider/class
  */
-
-import { BaseProvider, ExpirableValue, GetParameterError, TransformParameterError } from '../../src';
+import {
+  BaseProvider,
+  ExpirableValue,
+  GetParameterError,
+  TransformParameterError
+} from '../../src';
 import { toBase64 } from '@aws-sdk/util-base64';
 
 const encoder = new TextEncoder();

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

@@ -5,6 +5,7 @@
  */
 import { DEFAULT_PROVIDERS } from '../../src/BaseProvider';
 import { SSMProvider, getParametersByName } from '../../src/ssm';
+import type { SSMGetParametersByNameOptionsInterface } from '../../src/types/SSMProvider';
 
 describe('Function: getParametersByName', () => {
 
@@ -15,12 +16,13 @@ describe('Function: getParametersByName', () => {
   test('when called and a default provider doesn\'t exist, it instantiates one and returns the value', async () => {
 
     // Prepare
-    const parameters = {
+    const parameters: Record<string, SSMGetParametersByNameOptionsInterface> = {
       '/foo/bar': {
         maxAge: 1000,
       },
       '/foo/baz': {
         maxAge: 2000,
+        transform: 'json',
       }
     };
     const getParametersByNameSpy = jest.spyOn(SSMProvider.prototype, 'getParametersByName').mockImplementation();