@itgorillaz/configify 1.3.1 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itgorillaz/configify",
-  "version": "1.3.1",
+  "version": "2.0.0",
   "description": "NestJS Config on Steroids",
   "author": "tommelo",
   "private": false,
@@ -44,7 +44,7 @@
     "@nestjs/testing": "^10.3.7",
     "@types/jest": "29.5.14",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "22.10.1",
+    "@types/node": "22.10.2",
     "@types/supertest": "^6.0.2",
     "@typescript-eslint/eslint-plugin": "^8.1.0",
     "@typescript-eslint/parser": "^8.1.0",

package/src/configify.module.ts

@@ -1,18 +1,14 @@
-import { SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
-import { SSMClient } from '@aws-sdk/client-ssm';
 import { DynamicModule, Module, Provider } from '@nestjs/common';
 import { validateSync } from 'class-validator';
 import * as fs from 'fs';
 import { resolve } from 'path';
 import {
-  AwsSecretsManagerConfigurationResolver,
   ConfigifyModuleOptions,
   ConfigurationParserFactory,
   ConfigurationProviders,
   ConfigurationRegistry,
   DefaultConfigifyModuleOptions,
 } from './configuration';
-import { AwsParameterStoreConfigurationResolver } from './configuration/resolvers/aws/parameter-store-configuration.resolver';
 import { Variables } from './interpolation/variables';
 
 /**
@@ -26,7 +22,7 @@ import { Variables } from './interpolation/variables';
  * - Reading configuration files
  * - Resolving remote secrets
  * - Expanding variables
- * - Creating object instances decored with Configuration and assigning its values
+ * - Creating object instances decorated with Configuration and assigning its values
  * - Validating the configuration instance
  *
  * All the configuration set to the configuration files will be assigned to the process.env object
@@ -45,28 +41,11 @@ export class ConfigifyModule {
     resolve(process.cwd(), 'application.json'),
   ];
 
-  /**
-   * The remote secrets resolvers pipeline.
-   * This module currently supports resolving secrets on
-   * AWS Secrets Manager and AWS Parameters Store.
-   */
-  private static readonly SECRETS_RESOLVER_PIPELINE = [
-    (options: ConfigifyModuleOptions) =>
-      new AwsSecretsManagerConfigurationResolver(
-        options.secretsManagerClient || new SecretsManagerClient(),
-      ),
-
-    (options: ConfigifyModuleOptions) =>
-      new AwsParameterStoreConfigurationResolver(
-        options.ssmClient || new SSMClient(),
-      ),
-  ];
-
   /**
    * Creates the configfy dynamic module.
    *
    * The module will manage the instance of all classes decorated the Configuration decorator,
-   * meaning, the module will instanciate and associate the value to attributes according to the
+   * meaning, the module will create the instance and associate the value to attributes according to the
    * keys provided by the Value decorator.
    *
    * The configuration key pair values will also be available on process.env object.
@@ -118,10 +97,11 @@ export class ConfigifyModule {
     options: ConfigifyModuleOptions,
   ): Promise<Record<string, any>> {
     const secrets = {};
-    for (const buildResolver of this.SECRETS_RESOLVER_PIPELINE) {
-      const resolver = buildResolver(options);
-      const result = await resolver.resolve(config);
-      Object.assign(secrets, result);
+    if (options.secretsResolverStrategies?.length) {
+      for (const resolver of options.secretsResolverStrategies) {
+        const result = await resolver.resolve(config);
+        Object.assign(secrets, result);
+      }
     }
     return secrets;
   }
@@ -134,7 +114,7 @@ export class ConfigifyModule {
    * @returns {ConfigurationProviders} the module configuration providers
    */
   private static buildConfigurationProviders(): ConfigurationProviders {
-    const exports = [];
+    const exports: unknown[] = [];
     const providers: Provider[] = [];
 
     const registry = ConfigurationRegistry.getRegistry();

package/src/configuration/configuration-options.interface.ts

@@ -1,5 +1,4 @@
-import { SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
-import { SSMClient } from '@aws-sdk/client-ssm';
+import { ConfigurationResolver } from './resolvers';
 
 /**
  * The configuration options interface
@@ -29,16 +28,9 @@ export interface ConfigifyModuleOptions {
   expandConfig?: boolean;
 
   /**
-   * The AWS Secrets Manager Client
-   * If no client is provided, the module will create one.
+   * The secrets resolvers strategies
    */
-  secretsManagerClient?: SecretsManagerClient;
-
-  /**
-   * The AWS Systems Manager Client
-   * If no client is provided, the module will create one.
-   */
-  ssmClient?: SSMClient;
+  secretsResolverStrategies?: ConfigurationResolver[];
 }
 
 /**

package/src/configuration/configuration-parser.interface.ts

@@ -1,5 +1,5 @@
 /**
- * The configuraion parser interface.
+ * The configuration parser interface.
  * This interface is implemented by all
  * the supported configuration parsers.
  */

package/src/configuration/resolvers/aws/aws-secrets-resolver.factory.ts

@@ -0,0 +1,32 @@
+import { SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
+import { SSMClient } from '@aws-sdk/client-ssm';
+import { ConfigurationResolver } from '../configuration-resolver.interface';
+import { AwsParameterStoreConfigurationResolver } from './parameter-store-configuration.resolver';
+import { AwsSecretsManagerConfigurationResolver } from './secrets-manager-configuration.resolver';
+
+/**
+ * The AWS secrets resolver factory.
+ * This class provides the default secrets resolvers for the module.
+ * The default secrets resolvers are:
+ * - Parameter Store
+ * - Secrets Manager
+ */
+export class AwsSecretsResolverFactory {
+  /**
+   * The default parameter store secrets resolver
+   * @returns {ConfigurationResolver} the default parameter store secrets resolver
+   */
+  static defaultParameterStoreResolver(): ConfigurationResolver {
+    return new AwsParameterStoreConfigurationResolver(new SSMClient());
+  }
+
+  /**
+   * The default secrets manager secrets resolver
+   * @returns {ConfigurationResolver} the default secrets manager secrets resolver
+   */
+  static defaultSecretsManagerResolver(): ConfigurationResolver {
+    return new AwsSecretsManagerConfigurationResolver(
+      new SecretsManagerClient(),
+    );
+  }
+}

package/src/configuration/resolvers/aws/index.ts

@@ -1,2 +1,3 @@
+export * from './aws-secrets-resolver.factory';
 export * from './parameter-store-configuration.resolver';
 export * from './secrets-manager-configuration.resolver';

package/src/configuration/resolvers/aws/parameter-store-configuration.resolver.ts

@@ -106,7 +106,7 @@ export class AwsParameterStoreConfigurationResolver
   private buildBulkRequest(
     config: Record<string, any>,
   ): Promise<ResolvedValue>[] {
-    const promises = [];
+    const promises: Promise<ResolvedValue>[] = [];
     for (const [key, value] of Object.entries(config)) {
       promises.push(this.resolveSecretValue(key, value));
     }

package/src/configuration/resolvers/aws/secrets-manager-configuration.resolver.ts

@@ -108,7 +108,7 @@ export class AwsSecretsManagerConfigurationResolver
   private buildBulkRequest(
     config: Record<string, any>,
   ): Promise<ResolvedValue>[] {
-    const promises = [];
+    const promises: Promise<ResolvedValue>[] = [];
     for (const [key, value] of Object.entries(config)) {
       promises.push(this.resolveSecretValue(key, value));
     }

package/src/index.ts

@@ -1,2 +1,3 @@
 export * from './configify.module';
+export * from './configuration';
 export * from './decorators';