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

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;
-  }
-}

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

@@ -1,117 +0,0 @@
-import {
-  GetSecretValueCommand,
-  SecretsManagerClient,
-} from '@aws-sdk/client-secrets-manager';
-import { ConfigurationResolver } from '../configuration-resolver.interface';
-import { ResolvedValue } from '../resolved-value.interface';
-
-/**
- * AWS Secrets Manager configuration resolver.
- */
-export class AwsSecretsManagerConfigurationResolver
-  implements ConfigurationResolver
-{
-  private readonly AWS_SECRETS_AMANGER_YAML_KEY = 'aws-secrets-manager';
-  private readonly AWS_SECRETS_MANAGER_ENV_PREFIX = 'AWS_SECRETS_MANAGER';
-
-  /**
-   * Creates a new instance of secrets manager configuration resolver
-   *
-   * @param {SecretsManagerClient} secretsManager secrets manager client
-   */
-  constructor(private readonly secretsManager: SecretsManagerClient) {}
-
-  /**
-   * Fetches secrets 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 secrets = this.filterConfiguration(config);
-    const promises = this.buildBulkRequest(secrets);
-
-    const results = await Promise.all(promises);
-
-    const errors = results.filter((r) => !r.success);
-    if (errors && errors.length) {
-      throw new Error(
-        `Unable to resolve secrets:\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 secrets manager 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_SECRETS_AMANGER_YAML_KEY) ||
-          key.startsWith(this.AWS_SECRETS_MANAGER_ENV_PREFIX),
-      ),
-    );
-  }
-
-  /**
-   * Resolves secret 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 command = new GetSecretValueCommand({ SecretId: id });
-      const response = await this.secretsManager.send(command);
-      return {
-        id,
-        key,
-        value: response.SecretString,
-        success: true,
-      };
-    } catch (e) {
-      return {
-        id,
-        key,
-        error: e as Error,
-        success: false,
-      };
-    }
-  }
-
-  /**
-   * Creates a list of promises to get secret values.
-   *
-   * @param   {Record<string, any>}      config the configuration object
-   * @returns {Promise<ResolvedValue>[]}        the get secret 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;
-  }
-}

package/src/configuration/resolvers/configuration-resolver.interface.ts

@@ -1,11 +0,0 @@
-/**
- * The configuration resolver interface
- */
-export interface ConfigurationResolver {
-  /**
-   * Resolves a remote configuration
-   *
-   * @param {Record<string, any>} configuration the configuration obejct
-   */
-  resolve(configuration: Record<string, any>): Promise<Record<string, any>>;
-}

package/src/configuration/resolvers/index.ts

@@ -1,2 +0,0 @@
-export * from './configuration-resolver.interface';
-export * from './resolved-value.interface';

package/src/configuration/resolvers/resolved-value.interface.ts

@@ -1,10 +0,0 @@
-/**
- * The resolved value interface
- */
-export interface ResolvedValue {
-  id: string;
-  success: boolean;
-  key: string;
-  value?: string;
-  error?: Error;
-}

package/src/decorators/configuration.decorator.ts

@@ -1,26 +0,0 @@
-import { ConfigurationRegistry } from '../configuration/configuration.registry';
-
-/**
- * The configuration metadata
- */
-export const CONFIGURATION_METADATA = Symbol.for('__configuration__');
-
-/**
- * The configuration decorator.
- *
- * Decorating a class with this decorator will make it
- * visible for the module to manage its instance and assign
- * values to the class attributes based on configuration files.
- *
- * @returns {ClassDecorator} the class decorator
- */
-export const Configuration = (): ClassDecorator => {
-  return (target: object) => {
-    ConfigurationRegistry.registerTarget(target);
-    Reflect.defineMetadata(
-      CONFIGURATION_METADATA,
-      target.constructor.name,
-      target,
-    );
-  };
-};

package/src/decorators/index.ts

@@ -1,2 +0,0 @@
-export * from './configuration.decorator';
-export * from './value.decorator';

package/src/decorators/value.decorator.ts

@@ -1,57 +0,0 @@
-import { ConfigurationRegistry } from '../configuration/configuration.registry';
-
-/**
- * The value metadata.
- */
-export const VALUE_METADATA = Symbol.for('__value__');
-
-/**
- * The value properties metadata.
- */
-export const VALUE_PROPERTIES_METADATA = Symbol.for('__properties__');
-
-/**
- * The value options.
- * Allows custom parsing to configuration values
- */
-export interface ValueOptions {
-  /**
-   * Parses the configuration value.
-   * @param value
-   * @returns parsed value
-   */
-  parse?: (value: any) => unknown;
-
-  /**
-   * Sets a default value if the configuration key is not found.
-   */
-  default?: any;
-}
-
-/**
- * The value decorated key interface.
- */
-export interface ValueDecoratedKey {
-  key: string;
-  options?: ValueOptions;
-}
-
-/**
- * The value decorator.
- *
- * This decorator defines which configuration key should
- * be assined to the class attribute.
- *
- * @param   {string}            key     the configuration key
- * @param   {ValueOptions}      options custom options
- * @returns {PropertyDecorator}         the property decorator
- */
-export const Value = (
-  key: string,
-  options?: ValueOptions,
-): PropertyDecorator => {
-  return (target: object, property: string | symbol) => {
-    ConfigurationRegistry.registerAttribute(target, property);
-    Reflect.defineMetadata(VALUE_METADATA, { key, options }, target, property);
-  };
-};

package/src/index.ts

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