refactor: folder structure

Author: dreamorosi

packages/parameters/src/SSMProvider.ts renamed to packages/parameters/src/ssm/SSMProvider.ts

@@ -1,6 +1,6 @@
-import { BaseProvider, DEFAULT_PROVIDERS, transformValue } from './BaseProvider';
-import { GetParameterError } from './Exceptions';
-import { DEFAULT_MAX_AGE_SECS } from './constants';
+import { BaseProvider, DEFAULT_PROVIDERS, transformValue } from '../BaseProvider';
+import { GetParameterError } from '../Exceptions';
+import { DEFAULT_MAX_AGE_SECS } from '../constants';
 import { SSMClient, GetParameterCommand, paginateGetParametersByPath, GetParametersCommand } from '@aws-sdk/client-ssm';
 import type {
   SSMClientConfig,
@@ -339,7 +339,7 @@ class SSMProvider extends BaseProvider {
       let value;
       // NOTE: if transform is set, we do it before caching to reduce number of operations
       if (parameterValue && parameterOptions.transform) {
-        value = transformValue(parameterValue, parameterOptions.transform, throwOnError);
+        value = transformValue(parameterValue, parameterOptions.transform, throwOnError, parameterName);
       } else if (parameterValue) {
         value = parameterValue;
       }
@@ -356,33 +356,7 @@ class SSMProvider extends BaseProvider {
   }
 }
 
-const getParameter = (name: string, options?: SSMGetOptionsInterface): Promise<undefined | string | Record<string, unknown>> => {
-  if (!DEFAULT_PROVIDERS.hasOwnProperty('ssm')) {
-    DEFAULT_PROVIDERS.ssm = new SSMProvider();
-  }
-
-  return DEFAULT_PROVIDERS.ssm.get(name, options);
-};
-
-const getParameters = (path: string, options?: SSMGetMultipleOptionsInterface): Promise<undefined | Record<string, unknown>> => {
-  if (!DEFAULT_PROVIDERS.hasOwnProperty('ssm')) {
-    DEFAULT_PROVIDERS.ssm = new SSMProvider();
-  }
-
-  return DEFAULT_PROVIDERS.ssm.getMultiple(path, options);
-};
-
-const getParametersByName = (parameters: Record<string, SSMGetParametersByNameOptionsInterface>, options?: SSMGetParametersByNameOptionsInterface): Promise<Record<string, unknown>> => {
-  if (!DEFAULT_PROVIDERS.hasOwnProperty('ssm')) {
-    DEFAULT_PROVIDERS.ssm = new SSMProvider();
-  }
-
-  return (DEFAULT_PROVIDERS.ssm as SSMProvider).getParametersByName(parameters, options);
-};
-
 export {
   SSMProvider,
-  getParameter,
-  getParameters,
-  getParametersByName,
+  DEFAULT_PROVIDERS,
 };

packages/parameters/src/ssm/getParameter.ts

@@ -0,0 +1,17 @@
+import { SSMProvider, DEFAULT_PROVIDERS } from './SSMProvider';
+import type { SSMGetOptionsInterface } from 'types/SSMProvider';
+
+const getParameter = (
+  name: string,
+  options?: SSMGetOptionsInterface
+): Promise<undefined | string | Record<string, unknown>> => {
+  if (!DEFAULT_PROVIDERS.hasOwnProperty('ssm')) {
+    DEFAULT_PROVIDERS.ssm = new SSMProvider();
+  }
+
+  return DEFAULT_PROVIDERS.ssm.get(name, options);
+};
+
+export {
+  getParameter,
+};

packages/parameters/src/ssm/getParameters.ts

@@ -0,0 +1,17 @@
+import { SSMProvider, DEFAULT_PROVIDERS } from './SSMProvider';
+import type { SSMGetMultipleOptionsInterface } from 'types/SSMProvider';
+
+const getParameters = (
+  path: string,
+  options?: SSMGetMultipleOptionsInterface
+): Promise<undefined | Record<string, unknown>> => {
+  if (!DEFAULT_PROVIDERS.hasOwnProperty('ssm')) {
+    DEFAULT_PROVIDERS.ssm = new SSMProvider();
+  }
+
+  return DEFAULT_PROVIDERS.ssm.getMultiple(path, options);
+};
+
+export {
+  getParameters,
+};

packages/parameters/src/ssm/getParametersByName.ts

@@ -0,0 +1,17 @@
+import { SSMProvider, DEFAULT_PROVIDERS } from './SSMProvider';
+import type { SSMGetParametersByNameOptionsInterface } from 'types/SSMProvider';
+
+const getParametersByName = (
+  parameters: Record<string, SSMGetParametersByNameOptionsInterface>,
+  options?: SSMGetParametersByNameOptionsInterface
+): Promise<Record<string, unknown>> => {
+  if (!DEFAULT_PROVIDERS.hasOwnProperty('ssm')) {
+    DEFAULT_PROVIDERS.ssm = new SSMProvider();
+  }
+
+  return (DEFAULT_PROVIDERS.ssm as SSMProvider).getParametersByName(parameters, options);
+};
+
+export {
+  getParametersByName,
+};

packages/parameters/src/ssm/index.ts

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

packages/parameters/src/types/BaseProvider.ts

@@ -7,11 +7,7 @@ interface GetOptionsInterface {
   transform?: TransformOptions
 }
 
-interface GetMultipleOptionsInterface {
-  maxAge?: number
-  forceFetch?: boolean
-  sdkOptions?: unknown
-  transform?: string
+interface GetMultipleOptionsInterface extends GetOptionsInterface {
   throwOnTransformError?: boolean
 }
 

packages/parameters/src/types/SSMProvider.ts

@@ -1,5 +1,5 @@
 import type { GetParameterCommandInput, GetParametersByPathCommandInput } from '@aws-sdk/client-ssm';
-import type { TransformOptions } from 'types/BaseProvider';
+import type { GetOptionsInterface, GetMultipleOptionsInterface, TransformOptions } from './BaseProvider';
 
 /**
  * Options for the SSMProvider get method.
@@ -9,21 +9,15 @@ import type { TransformOptions } from 'types/BaseProvider';
  * @property {boolean} decrypt - If true, the parameter will be decrypted.
  * @property {Partial<GetParameterCommandInput>} sdkOptions - Options for the AWS SDK.
  */
-interface SSMGetOptionsInterface {
-  maxAge?: number
-  sdkOptions?: Partial<GetParameterCommandInput>
-  forceFetch?: boolean
+interface SSMGetOptionsInterface extends GetOptionsInterface {
   decrypt?: boolean
-  transform?: TransformOptions
+  sdkOptions?: Partial<GetParameterCommandInput>
 }
 
-interface SSMGetMultipleOptionsInterface {
-  maxAge?: number
-  forceFetch?: boolean
+interface SSMGetMultipleOptionsInterface extends GetMultipleOptionsInterface {
   sdkOptions?: Partial<GetParametersByPathCommandInput>
   decrypt?: boolean
   recursive?: boolean
-  transform?: TransformOptions
   throwOnTransformError?: boolean
 }
 

packages/parameters/tests/unit/SSMProvider.test.ts

@@ -1,9 +1,9 @@
 /**
-  * Test SSMProvider class
+ * Test SSMProvider class
  *
- * @group unit/parameters/SSMProvider/class
+ * @group unit/parameters/ssm/class
  */
-import { SSMProvider } from '../../src/SSMProvider';
+import { SSMProvider } from '../../src/ssm';
 import {
   SSMClient,
   GetParameterCommand,

packages/parameters/tests/unit/getParameter.test.ts

@@ -1,10 +1,10 @@
 /**
-  * Test getParameter function
+ * Test getParameter function
  *
- * @group unit/parameters/SSMProvider/getParameter/function
+ * @group unit/parameters/ssm/getParameter/function
  */
 import { DEFAULT_PROVIDERS } from '../../src/BaseProvider';
-import { SSMProvider, getParameter } from '../../src/SSMProvider';
+import { SSMProvider, getParameter } from '../../src/ssm';
 import { SSMClient, GetParameterCommand } from '@aws-sdk/client-ssm';
 import { mockClient } from 'aws-sdk-client-mock';
 import 'aws-sdk-client-mock-jest';

packages/parameters/tests/unit/getParameters.test.ts

@@ -1,10 +1,10 @@
 /**
-  * Test getParameters function
+ * Test getParameters function
  *
- * @group unit/parameters/SSMProvider/getParameters/function
+ * @group unit/parameters/ssm/getParameters/function
  */
 import { DEFAULT_PROVIDERS } from '../../src/BaseProvider';
-import { SSMProvider, getParameters } from '../../src/SSMProvider';
+import { SSMProvider, getParameters } from '../../src/ssm';
 import { SSMClient, GetParametersByPathCommand } from '@aws-sdk/client-ssm';
 import { mockClient } from 'aws-sdk-client-mock';
 import 'aws-sdk-client-mock-jest';

packages/parameters/tests/unit/getParametersByName.test.ts

@@ -1,10 +1,10 @@
 /**
-  * Test getParametersByName function
+ * Test getParametersByName function
  *
- * @group unit/parameters/SSMProvider/getParametersByName/function
+ * @group unit/parameters/ssm/getParametersByName/function
  */
 import { DEFAULT_PROVIDERS } from '../../src/BaseProvider';
-import { SSMProvider, getParametersByName } from '../../src/SSMProvider';
+import { SSMProvider, getParametersByName } from '../../src/ssm';
 
 describe('Function: getParametersByName', () => {