@itgorillaz/configify 3.0.0-alpha.0 → 3.0.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itgorillaz/configify",
-  "version": "3.0.0-alpha.0",
+  "version": "3.0.0-alpha.1",
   "description": "NestJS Config on Steroids",
   "author": "tommelo",
   "private": false,
@@ -25,6 +25,9 @@
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "test": "jest --config ./test/jest.config.json --coverage --silent=false --verbose --runInBand"
   },
+  "files": [
+    "dist/**/*"
+  ],
   "dependencies": {
     "dotenv": "^16.3.1",
     "js-yaml": "^4.1.0"

package/.prettierrc

@@ -1,4 +0,0 @@
-{
-  "singleQuote": true,
-  "trailingComma": "all"
-}

package/index.d.ts

@@ -1 +0,0 @@
-export * from './dist';

package/index.js

@@ -1,6 +0,0 @@
-'use strict';
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
-exports.__esModule = true;
-__export(require("./dist"));

package/index.ts

@@ -1 +0,0 @@
-export * from './dist';

package/nest-cli.json

@@ -1,8 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/nest-cli",
-  "collection": "@nestjs/schematics",
-  "sourceRoot": "src",
-  "compilerOptions": {
-    "deleteOutDir": true
-  }
-}

package/src/configify.module.ts

@@ -1,223 +0,0 @@
-import { DynamicModule, Module, Provider } from '@nestjs/common';
-import { validateSync } from 'class-validator';
-import * as fs from 'fs';
-import { resolve } from 'path';
-import {
-  ConfigifyModuleOptions,
-  ConfigurationParserFactory,
-  ConfigurationProviders,
-  ConfigurationRegistry,
-  DefaultConfigifyModuleOptions,
-} from './configuration';
-import { Variables } from './interpolation/variables';
-
-/**
- * The configify module.
- * A NestJS configuration module on steroids.
- *
- * This module provides out of the box configuration files parsing,
- * remote secrets fetching, variables expansion and configuration validation.
- *
- * The lifecycle of the module consists of:
- * - Reading configuration files
- * - Resolving remote secrets
- * - Expanding variables
- * - 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
- */
-@Module({})
-export class ConfigifyModule {
-  /**
-   * The default configuration files.
-   * If no configuration files are provided this module will
-   * lookup at a .env, application.yml and an application.json files
-   * at the root path of the project.
-   */
-  private static readonly DEFAULT_CONFIG_FILES = [
-    resolve(process.cwd(), '.env'),
-    resolve(process.cwd(), 'application.yml'),
-    resolve(process.cwd(), 'application.json'),
-  ];
-
-  /**
-   * Creates the configfy dynamic module.
-   *
-   * The module will manage the instance of all classes decorated the Configuration decorator,
-   * 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.
-   *
-   * @param   { ConfigifyModuleOptions } options The module config options
-   * @returns { DynamicModule }         module  The configy module
-   */
-  static async forRootAsync(
-    options: ConfigifyModuleOptions = {},
-  ): Promise<DynamicModule> {
-    const settings = { ...options, ...DefaultConfigifyModuleOptions };
-    const files = this.resolveConfigurationFiles(settings.configFilePath);
-
-    const envVars = settings.ignoreEnvVars ? {} : process.env;
-    const fromFile = settings.ignoreConfigFile
-      ? {}
-      : this.parseConfigurationFiles(files);
-
-    const container = { ...envVars, ...fromFile };
-    const secrets = await this.runSecretsResolverPipeline(container, settings);
-    const configuration = { ...container, ...secrets };
-
-    if (settings.expandConfig) {
-      const expanded = Variables.expand(configuration);
-      Object.assign(configuration, expanded);
-    }
-
-    Object.assign(process.env, configuration);
-
-    const { exports, providers } = this.buildConfigurationProviders();
-
-    return {
-      exports,
-      providers,
-      global: true,
-      module: ConfigifyModule,
-    };
-  }
-
-  /**
-   * Runs the secrets resolver pipeline.
-   *
-   * @param   {Record<string, any>}            config the configuration object
-   * @param   {ConfigifyModuleOptions}          options the module options
-   * @returns {Promise<Record<string, any>>}   the resolved secrets
-   */
-  private static async runSecretsResolverPipeline(
-    config: Record<string, any>,
-    options: ConfigifyModuleOptions,
-  ): Promise<Record<string, any>> {
-    const secrets = {};
-    if (options.secretsResolverStrategies?.length) {
-      for (const resolver of options.secretsResolverStrategies) {
-        const result = await resolver.resolve(config);
-        Object.assign(secrets, result);
-      }
-    }
-    return secrets;
-  }
-
-  /**
-   * Creates the configuration module providers.
-   * It creates the configuration instances, assign its value
-   * and perform the object validation.
-   *
-   * @returns {ConfigurationProviders} the module configuration providers
-   */
-  private static buildConfigurationProviders(): ConfigurationProviders {
-    const exports: unknown[] = [];
-    const providers: Provider[] = [];
-
-    const registry = ConfigurationRegistry.getRegistry();
-    for (const ConfigType of registry) {
-      const instance = new ConfigType();
-
-      const attributes =
-        ConfigurationRegistry.getValueDecoratedAttributes(instance);
-
-      for (const attribute of attributes) {
-        const metadata = ConfigurationRegistry.getValueDecoratedKey(
-          instance,
-          attribute,
-        );
-
-        const parse = metadata.options?.parse;
-
-        const defaultValue =
-          process.env[metadata.key] || metadata.options?.default;
-
-        const value = parse ? parse(defaultValue) : defaultValue;
-
-        instance[attribute] = value;
-      }
-
-      const errors = validateSync(instance);
-      if (errors && errors.length) {
-        throw new Error(
-          `validation constraints violated:\n${errors
-            .map((e) =>
-              JSON.stringify(
-                { attribute: e.property, constraints: e.constraints },
-                null,
-                2,
-              ),
-            )
-            .join('\n')}`,
-        );
-      }
-
-      exports.push(ConfigType);
-      providers.push({ provide: ConfigType, useValue: instance });
-    }
-
-    return { exports, providers };
-  }
-
-  /**
-   * Flattens a nested object into an one level key value pair object
-   *
-   * @param {object}              source the source object
-   * @param {string[]}            path   the key path
-   * @param {Record<string, any>} target the target object
-   */
-  private static flattenObjectKeys(
-    source: any,
-    path: string[] = [],
-    target: Record<string, any> = {},
-  ) {
-    if (typeof source === 'object') {
-      for (const key in source) {
-        this.flattenObjectKeys(source[key], [...path, key], target);
-      }
-    } else {
-      target[path.join('.')] = source;
-    }
-  }
-
-  /**
-   * Parses configuration files and assign its contents to a configuration object.
-   *
-   * @param   {string[]} files  the configuration file paths
-   * @returns {object}          the object representation of the configuration files
-   */
-  private static parseConfigurationFiles(files: string[]): Record<string, any> {
-    const kv = {};
-    const config = {};
-
-    for (const file of files) {
-      const parser = ConfigurationParserFactory.getParser(file);
-      const parsed = parser.parse(file);
-      Object.assign(config, parsed);
-    }
-
-    this.flattenObjectKeys(config, [], kv);
-
-    return kv;
-  }
-
-  /**
-   * Resolve the path of the configuration files.
-   * It ignores files that does not exist or is not
-   * suppported by the configuration parsers.
-   *
-   * @param   {string | string[]} path  the configuration path
-   * @returns {string[]}                list of configuration files
-   */
-  private static resolveConfigurationFiles(path?: string | string[]): string[] {
-    return ([] as string[])
-      .concat(path || [], this.DEFAULT_CONFIG_FILES)
-      .filter(
-        (file) =>
-          fs.existsSync(file) && ConfigurationParserFactory.supports(file),
-      );
-  }
-}

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

@@ -1,43 +0,0 @@
-import { ConfigurationResolver } from './resolvers';
-
-/**
- * The configuration options interface
- */
-export interface ConfigifyModuleOptions {
-  /**
-   * Ignores any config file.
-   * The default value is false;
-   */
-  ignoreConfigFile?: boolean;
-
-  /**
-   * Ignores environment variables
-   * The default value is false;
-   */
-  ignoreEnvVars?: boolean;
-
-  /**
-   * The path of the configuration files
-   */
-  configFilePath?: string | string[];
-
-  /**
-   * Expands variables
-   * The default value is true
-   */
-  expandConfig?: boolean;
-
-  /**
-   * The secrets resolvers strategies
-   */
-  secretsResolverStrategies?: ConfigurationResolver[];
-}
-
-/**
- * The default module options
- */
-export const DefaultConfigifyModuleOptions: ConfigifyModuleOptions = {
-  ignoreConfigFile: false,
-  ignoreEnvVars: false,
-  expandConfig: true,
-};

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

@@ -1,15 +0,0 @@
-/**
- * The configuration parser interface.
- * This interface is implemented by all
- * the supported configuration parsers.
- */
-export interface ConfigurationParser {
-  /**
-   * Reads a file and assign its values
-   * to an object representation;
-   *
-   * @param   {string}              file the configuration file path
-   * @returns {Record<string, any>}      the object representation of the configuration file
-   */
-  parse(file: string): Record<string, any>;
-}

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

@@ -1,9 +0,0 @@
-import { Provider } from '@nestjs/common';
-
-/**
- * The configuration providers interface
- */
-export interface ConfigurationProviders {
-  exports: any[];
-  providers: Provider[];
-}

package/src/configuration/configuration.registry.ts

@@ -1,70 +0,0 @@
-import {
-  ValueDecoratedKey,
-  VALUE_METADATA,
-  VALUE_PROPERTIES_METADATA,
-} from '../decorators';
-
-/**
- * The configuration registry.
- *
- * The registry keeps track of all classes decorated
- * with Configuration decorator.
- */
-export class ConfigurationRegistry {
-  private static readonly registry: Array<unknown> = [];
-
-  /**
-   * Registers a type.
-   *
-   * @param {any} type the class type
-   */
-  static registerTarget(type: any): void {
-    this.registry.push(type);
-  }
-
-  /**
-   * Registers a class attribute.
-   *
-   * @param {any}    target    the class target
-   * @param {string} attribute the attribute name
-   */
-  static registerAttribute(target: any, attribute: string | symbol): void {
-    (
-      target[VALUE_PROPERTIES_METADATA] ||
-      (target[VALUE_PROPERTIES_METADATA] = [])
-    ).push(attribute);
-  }
-
-  /**
-   * Returns the configuration registry.
-   *
-   * @returns {any[]} the configuration registry
-   */
-  static getRegistry(): any[] {
-    return this.registry;
-  }
-
-  /**
-   * Returns the class attribute names decorated with Decorated decorator
-   *
-   * @param   {any}      target the instance target;
-   * @returns {string[]} the list of attribute names
-   */
-  static getValueDecoratedAttributes(target: any): string[] {
-    return target[VALUE_PROPERTIES_METADATA];
-  }
-
-  /**
-   * Returns the value of the decorated key.
-   *
-   * @param   {any}               instance  the target instance
-   * @param   {string}            attribute the attribute name
-   * @returns {ValueDecoratedKey}           the value decorated key
-   */
-  static getValueDecoratedKey(
-    instance: any,
-    attribute: string,
-  ): ValueDecoratedKey {
-    return Reflect.getMetadata(VALUE_METADATA, instance, attribute);
-  }
-}

package/src/configuration/index.ts

@@ -1,6 +0,0 @@
-export * from './configuration-options.interface';
-export * from './configuration-parser.interface';
-export * from './configuration-providers.interface';
-export * from './configuration.registry';
-export * from './parsers';
-export * from './resolvers';

package/src/configuration/parsers/configuration-parser.factory.ts

@@ -1,53 +0,0 @@
-import { ConfigurationParser } from '../configuration-parser.interface';
-import { DotEnvConfigurationParser } from './dotenv-configuration.parser';
-import { JsonConfigurationParser } from './json-configuration.parser';
-import { YamlConfigurationParser } from './yaml-configuration.parser';
-
-/**
- * The configuration parser factory.
- * This factory class contains all the supported
- * file configuration parsers.
- */
-export class ConfigurationParserFactory {
-  /**
-   * The supported file configuration parsers
-   */
-  private static readonly parsers: Record<string, ConfigurationParser> = {
-    env: new DotEnvConfigurationParser(),
-    yml: new YamlConfigurationParser(),
-    yaml: new YamlConfigurationParser(),
-    json: new JsonConfigurationParser(),
-  };
-
-  /**
-   * Gets the file configuration parser based
-   * on the file extension.
-   * @param   {string}              file the configuration file name
-   * @returns {ConfigurationParser}      the configuration parser
-   */
-  static getParser(file: string): ConfigurationParser {
-    const ext = this.getFileExt(file) as keyof typeof this.parsers;
-    return this.parsers[ext];
-  }
-
-  /**
-   * Checks if the given file has a parser registered.
-   *
-   * @param   {string} file the configuration file name
-   * @returns {boolean}     true if a parser is found, false otherwise
-   */
-  static supports(file: string): boolean {
-    const ext = this.getFileExt(file);
-    return ext ? this.parsers.hasOwnProperty(ext) : false;
-  }
-
-  /**
-   * Returns the file extension.
-   *
-   * @param   {string} file the file name
-   * @returns {string}      the file extension
-   */
-  private static getFileExt(file: string): string | undefined {
-    return file.split('.').pop();
-  }
-}

package/src/configuration/parsers/dotenv-configuration.parser.ts

@@ -1,18 +0,0 @@
-import * as dotenv from 'dotenv';
-import * as fs from 'fs';
-import { ConfigurationParser } from '../configuration-parser.interface';
-
-/**
- * Dotenv configuration parser.
- */
-export class DotEnvConfigurationParser implements ConfigurationParser {
-  /**
-   * Reads the configuration file and assign
-   * its contents to an object.
-   * @param   {string}              file the configuration file
-   * @returns {Record<string, any>}      an object representation of the configuration file
-   */
-  public parse(file: string): Record<string, any> {
-    return dotenv.parse(fs.readFileSync(file));
-  }
-}

package/src/configuration/parsers/index.ts

@@ -1,4 +0,0 @@
-export * from './configuration-parser.factory';
-export * from './dotenv-configuration.parser';
-export * from './json-configuration.parser';
-export * from './yaml-configuration.parser';

package/src/configuration/parsers/json-configuration.parser.ts

@@ -1,17 +0,0 @@
-import * as fs from 'fs';
-import { ConfigurationParser } from '../configuration-parser.interface';
-
-/**
- * JSON configuration parser
- */
-export class JsonConfigurationParser implements ConfigurationParser {
-  /**
-   * Reads the configuration file and assign
-   * its contents to an object.
-   * @param   {string}              file the configuration file
-   * @returns {Record<string, any>}      an object representation of the configuration file
-   */
-  public parse(file: string): Record<string, any> {
-    return JSON.parse(fs.readFileSync(file, 'utf-8'));
-  }
-}

package/src/configuration/parsers/yaml-configuration.parser.ts

@@ -1,18 +0,0 @@
-import * as fs from 'fs';
-import * as yaml from 'js-yaml';
-import { ConfigurationParser } from '../configuration-parser.interface';
-
-/**
- * YAML configuration parser
- */
-export class YamlConfigurationParser implements ConfigurationParser {
-  /**
-   * Reads the configuration file and assign
-   * its contents to an object.
-   * @param   {string}              file the configuration file
-   * @returns {Record<string, any>}      an object representation of the configuration file
-   */
-  public parse(file: string): Record<string, any> {
-    return yaml.load(fs.readFileSync(file, 'utf-8')) as Record<string, any>;
-  }
-}

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

@@ -1,32 +0,0 @@
-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,3 +0,0 @@
-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

@@ -1,115 +0,0 @@
-import { GetParameterCommand, SSMClient } from '@aws-sdk/client-ssm';
-import { ConfigurationResolver } from '../configuration-resolver.interface';
-import { ResolvedValue } from '../resolved-value.interface';
-
-/**
- * AWS Parameter Store configuration resolver.
- */
-export class AwsParameterStoreConfigurationResolver
-  implements ConfigurationResolver
-{
-  private readonly AWS_PARAMETER_STORE_YAML_KEY = 'aws-parameter-store';
-  private readonly AWS_PARAMETER_STORE_ENV_PREFIX = 'AWS_PARAMETER_STORE';
-
-  /**
-   * Creates a new instance of parameter store configuration resolver
-   *
-   * @param {SSMClient} ssm systems manager client
-   */
-  constructor(private readonly ssm: SSMClient) {}
-
-  /**
-   * Fetches parameters and assign it to an object representation
-   * of the configuration.
-   *
-   * @param   {Record<string, any>} config the configuration object
-   * @returns {Record<string, any>}        the cofiguration with secret values assigned
-   * @throws  {Error}                      if unable to fetch the secret
-   */
-  async resolve(config: Record<string, any>): Promise<Record<string, any>> {
-    const parameters = this.filterConfiguration(config);
-    const promises = this.buildBulkRequest(parameters);
-
-    const results = await Promise.all(promises);
-
-    const errors = results.filter((r) => !r.success);
-    if (errors && errors.length) {
-      throw new Error(
-        `Unable to resolve parameter:\n${errors
-          .map((e) => `${e.key}: ${e.id} - ${e.error?.message}`)
-          .join('\n')}`,
-      );
-    }
-
-    for (const result of results) {
-      config[result.key] = result.value;
-    }
-
-    return config;
-  }
-
-  /**
-   * Filters the configuration object by aws parameters store keys.
-   *
-   * @param   {Record<string, any>} config the configuration object
-   * @returns {Record<string, any>}        the filtered object
-   */
-  private filterConfiguration(
-    config: Record<string, any>,
-  ): Record<string, any> {
-    return Object.fromEntries(
-      Object.entries(config).filter(
-        ([key]) =>
-          key.startsWith(this.AWS_PARAMETER_STORE_YAML_KEY) ||
-          key.startsWith(this.AWS_PARAMETER_STORE_ENV_PREFIX),
-      ),
-    );
-  }
-
-  /**
-   * Resolves parameter values.
-   *
-   * @param {string} key the object key
-   * @param {string} id  the secret id
-   * @returns
-   */
-  private async resolveSecretValue(
-    key: string,
-    id: string,
-  ): Promise<ResolvedValue> {
-    try {
-      const payload = { Name: id, WithDecryption: true };
-      const command = new GetParameterCommand(payload);
-      const response = await this.ssm.send(command);
-      return {
-        id,
-        key,
-        value: response.Parameter?.Value,
-        success: true,
-      };
-    } catch (e) {
-      return {
-        id,
-        key,
-        error: e as Error,
-        success: false,
-      };
-    }
-  }
-
-  /**
-   * Creates a list of promises to get parameter values.
-   *
-   * @param   {Record<string, any>}      config the configuration object
-   * @returns {Promise<ResolvedValue>[]}        the get parameter value promises
-   */
-  private buildBulkRequest(
-    config: Record<string, any>,
-  ): Promise<ResolvedValue>[] {
-    const promises: Promise<ResolvedValue>[] = [];
-    for (const [key, value] of Object.entries(config)) {
-      promises.push(this.resolveSecretValue(key, value));
-    }
-    return promises;
-  }
-}