@abdokouta/react-config 1.0.1 → 1.0.2

package/src/config.module.ts

@@ -1,152 +0,0 @@
-import { Module, DynamicModule } from '@abdokouta/react-di';
-
-import { EnvDriver } from './drivers/env.driver';
-import { FileDriver } from './drivers/file.driver';
-import { ConfigService } from './services/config.service';
-import type { ConfigDriver } from './interfaces/config-driver.interface';
-import type { ConfigModuleOptions } from './interfaces/config-module-options.interface';
-import { CONFIG_DRIVER, CONFIG_OPTIONS, CONFIG_SERVICE } from './constants/tokens.constant';
-
-/**
- * Configuration Module
- *
- * Provides configuration management with multiple drivers.
- * Similar to NestJS ConfigModule.
- *
- * @example
- * ```typescript
- * // Using environment variables (default)
- * @Module({
- *   imports: [
- *     ConfigModule.forRoot({
- *       envFilePath: '.env',
- *       isGlobal: true,
- *     }),
- *   ],
- * })
- * export class AppModule {}
- * ```
- *
- * @example
- * ```typescript
- * // Using file-based configuration
- * @Module({
- *   imports: [
- *     ConfigModule.forRoot({
- *       driver: 'file',
- *       filePattern: 'config/**\/*.config.ts',
- *       isGlobal: true,
- *     }),
- *   ],
- * })
- * export class AppModule {}
- * ```
- */
-@Module({})
-export class ConfigModule {
-  /**
-   * Register configuration module with options
-   *
-   * @param options - Configuration options
-   * @returns Dynamic module
-   */
-  static forRoot(options: ConfigModuleOptions = {}): DynamicModule {
-    const driver = this.createDriver(options);
-
-    const isGlobal = options.isGlobal ?? false;
-
-    const providers = [
-      {
-        provide: CONFIG_OPTIONS,
-        useValue: options,
-        isGlobal,
-      },
-      {
-        provide: CONFIG_DRIVER,
-        useValue: driver,
-        isGlobal,
-      },
-      ConfigService,
-      {
-        provide: CONFIG_SERVICE,
-        useExisting: ConfigService,
-        isGlobal,
-      },
-    ];
-
-    return {
-      module: ConfigModule,
-      providers: providers as any,
-      exports: [ConfigService],
-    };
-  }
-
-  /**
-   * Register configuration module asynchronously
-   *
-   * @param options - Async configuration options
-   * @returns Dynamic module
-   */
-  static async forRootAsync(
-    options: ConfigModuleOptions & {
-      useFactory?: () => Promise<ConfigModuleOptions> | ConfigModuleOptions;
-    }
-  ): Promise<DynamicModule> {
-    const resolvedOptions = options.useFactory ? await options.useFactory() : options;
-
-    return this.forRoot(resolvedOptions);
-  }
-
-  /**
-   * Create configuration driver based on options
-   */
-  private static createDriver(options: ConfigModuleOptions): ConfigDriver {
-    const driverType = options.driver || 'env';
-
-    switch (driverType) {
-      case 'env':
-        const envDriver = new EnvDriver({
-          envFilePath: options.envFilePath,
-          ignoreEnvFile: options.ignoreEnvFile,
-          expandVariables: options.expandVariables,
-          envPrefix: options.envPrefix,
-          globalName: options.globalName,
-        });
-        envDriver.load();
-
-        // Merge custom load function if provided
-        if (options.load) {
-          this.mergeCustomConfig(envDriver, options.load);
-        }
-
-        return envDriver;
-
-      case 'file':
-        const fileDriver = new FileDriver({
-          config: typeof options.load === 'object' ? options.load : undefined,
-        });
-        return fileDriver;
-
-      default:
-        throw new Error(`Unknown configuration driver: ${driverType}`);
-    }
-  }
-
-  /**
-   * Merge custom configuration into driver
-   */
-  private static mergeCustomConfig(
-    driver: ConfigDriver,
-    load: Record<string, any> | (() => Record<string, any> | Promise<Record<string, any>>)
-  ): void {
-    const customConfig = typeof load === 'function' ? load() : load;
-
-    if (customConfig instanceof Promise) {
-      customConfig.then((config) => {
-        Object.assign(driver.all(), config);
-      });
-    } else {
-      Object.assign(driver.all(), customConfig);
-    }
-  }
-}

package/src/constants/index.ts

@@ -1,5 +0,0 @@
-/**
- * Constants
- */
-
-export { CONFIG_TOKENS } from './tokens.constant';

package/src/constants/tokens.constant.ts

@@ -1,38 +0,0 @@
-/**
- * Dependency Injection Tokens
- *
- * Used for injecting configuration dependencies.
- */
-
-/**
- * Configuration driver token
- *
- * @example
- * ```typescript
- * @Inject(CONFIG_DRIVER)
- * private driver: ConfigDriver
- * ```
- */
-export const CONFIG_DRIVER = Symbol('CONFIG_DRIVER');
-
-/**
- * Configuration options token
- *
- * @example
- * ```typescript
- * @Inject(CONFIG_OPTIONS)
- * private options: ConfigModuleOptions
- * ```
- */
-export const CONFIG_OPTIONS = Symbol('CONFIG_OPTIONS');
-
-/**
- * Configuration service token
- *
- * @example
- * ```typescript
- * @Inject(CONFIG_SERVICE)
- * private config: ConfigService
- * ```
- */
-export const CONFIG_SERVICE = Symbol('CONFIG_SERVICE');

package/src/drivers/env.driver.ts

@@ -1,208 +0,0 @@
-import type { ConfigDriver } from '../interfaces/config-driver.interface';
-import { getNestedValue, hasNestedValue } from '../utils/get-nested-value.util';
-
-/**
- * Environment Variable Configuration Driver
- *
- * Loads configuration from environment variables (process.env).
- * Supports .env files via dotenv.
- */
-export class EnvDriver implements ConfigDriver {
-  private config: Record<string, any> = {};
-  private loaded = false;
-
-  constructor(
-    private options: {
-      envFilePath?: string | string[];
-      ignoreEnvFile?: boolean;
-      expandVariables?: boolean;
-      envPrefix?: string | false;
-      globalName?: string; // Custom global variable name
-    } = {}
-  ) {}
-
-  /**
-   * Load environment variables
-   */
-  load(): Record<string, any> {
-    if (this.loaded) {
-      console.log('[EnvDriver] Already loaded, returning cached config');
-      return this.config;
-    }
-
-    console.log('[EnvDriver] Loading environment variables...');
-    console.log('[EnvDriver] Options:', { ...this.options });
-
-    // Load .env file if not ignored
-    if (!this.options.ignoreEnvFile) {
-      this.loadDotEnv();
-    }
-
-    // Get global config name (default: __APP_CONFIG__)
-    const globalName = this.options.globalName || '__APP_CONFIG__';
-
-    // Try to load from custom global variable first (browser environment)
-    if (typeof window !== 'undefined' && (window as any)[globalName]) {
-      this.config = { ...(window as any)[globalName] };
-      console.log(
-        `[EnvDriver] Loaded config from window.${globalName}:`,
-        Object.keys(this.config).length,
-        'keys'
-      );
-    }
-    // Fallback to process.env (Node.js environment or backward compatibility)
-    else if (typeof process !== 'undefined' && process.env) {
-      this.config = { ...process.env };
-      console.log(
-        '[EnvDriver] Loaded config from process.env:',
-        Object.keys(this.config).length,
-        'keys'
-      );
-    }
-    // No config source available
-    else {
-      console.warn(
-        '[EnvDriver] No config source available (neither window.' + globalName + ' nor process.env)'
-      );
-      this.config = {};
-    }
-
-    console.log('[EnvDriver] Initial config keys:', [
-      ...Object.keys(this.config).filter((k) => k.includes('APP') || k.includes('VITE')),
-    ]);
-
-    // Strip prefix if configured
-    if (this.options.envPrefix !== false) {
-      console.log('[EnvDriver] Stripping prefix...');
-      this.stripPrefix();
-      console.log('[EnvDriver] After stripPrefix, config keys:', [
-        ...Object.keys(this.config).filter((k) => k.includes('APP') || k.includes('VITE')),
-      ]);
-    }
-
-    // Expand variables if enabled
-    if (this.options.expandVariables) {
-      this.expandEnvVariables();
-    }
-
-    this.loaded = true;
-    console.log('[EnvDriver] Load complete. Sample values:', {
-      APP_NAME: this.config.APP_NAME,
-      VITE_APP_NAME: this.config.VITE_APP_NAME,
-    });
-    return this.config;
-  }
-
-  /**
-   * Get configuration value
-   */
-  get<T = any>(key: string, defaultValue?: T): T | undefined {
-    if (!this.loaded) {
-      this.load();
-    }
-    const value = getNestedValue(this.config, key, defaultValue);
-    console.log(`[EnvDriver] get("${key}", "${defaultValue}") = "${value}"`);
-    return value;
-  }
-
-  /**
-   * Check if key exists
-   */
-  has(key: string): boolean {
-    if (!this.loaded) {
-      this.load();
-    }
-    return hasNestedValue(this.config, key);
-  }
-
-  /**
-   * Get all configuration
-   */
-  all(): Record<string, any> {
-    if (!this.loaded) {
-      this.load();
-    }
-    return { ...this.config };
-  }
-
-  /**
-   * Load .env file using dotenv
-   */
-  private loadDotEnv(): void {
-    try {
-      // Try to load dotenv
-      const dotenv = require('dotenv');
-      const paths = Array.isArray(this.options.envFilePath)
-        ? this.options.envFilePath
-        : [this.options.envFilePath || '.env'];
-
-      for (const path of paths) {
-        dotenv.config({ path });
-      }
-    } catch (error) {
-      // dotenv not installed, skip
-    }
-  }
-
-  /**
-   * Expand environment variables (e.g., ${VAR_NAME})
-   */
-  private expandEnvVariables(): void {
-    const regex = /\$\{([^}]+)\}/g;
-
-    const expand = (value: string): string => {
-      return value.replace(regex, (_, key) => {
-        return this.config[key] || '';
-      });
-    };
-
-    for (const [key, value] of Object.entries(this.config)) {
-      if (typeof value === 'string' && value.includes('${')) {
-        this.config[key] = expand(value);
-      }
-    }
-  }
-
-  /**
-   * Strip environment variable prefix
-   * Auto-detects framework (Vite, Next.js) or uses custom prefix
-   */
-  private stripPrefix(): void {
-    let prefix = this.options.envPrefix;
-
-    // Auto-detect framework prefix
-    if (prefix === 'auto' || prefix === undefined) {
-      // Check for Vite (import.meta.env exists or VITE_ variables present)
-      const hasViteVars = Object.keys(this.config).some((key) => key.startsWith('VITE_'));
-      if (hasViteVars || typeof import.meta !== 'undefined') {
-        prefix = 'VITE_';
-      }
-      // Check for Next.js (NEXT_PUBLIC_ variables present)
-      else if (Object.keys(this.config).some((key) => key.startsWith('NEXT_PUBLIC_'))) {
-        prefix = 'NEXT_PUBLIC_';
-      }
-      // No framework detected, don't strip
-      else {
-        return;
-      }
-    }
-
-    // Strip the prefix from all matching keys
-    if (typeof prefix === 'string' && prefix.length > 0) {
-      const newConfig: Record<string, any> = {};
-
-      for (const [key, value] of Object.entries(this.config)) {
-        if (key.startsWith(prefix)) {
-          // Add both prefixed and unprefixed versions
-          const unprefixedKey = key.substring(prefix.length);
-          newConfig[unprefixedKey] = value;
-          newConfig[key] = value; // Keep original too
-        } else {
-          newConfig[key] = value;
-        }
-      }
-
-      this.config = newConfig;
-    }
-  }
-}

package/src/drivers/file.driver.ts

@@ -1,82 +0,0 @@
-import type { ConfigDriver } from '@/interfaces/config-driver.interface';
-import { getNestedValue, hasNestedValue } from '@/utils/get-nested-value.util';
-
-/**
- * File-based Configuration Driver
- *
- * Loads configuration from TypeScript/JavaScript files.
- * This is a server-side only driver. For client-side, use the Vite plugin.
- *
- * @see packages/pixielity/config/src/plugins/vite-config.plugin.ts
- */
-export class FileDriver implements ConfigDriver {
-  private config: Record<string, any> = {};
-  private loaded = false;
-
-  constructor(
-    options: {
-      config?: Record<string, any>;
-    } = {}
-  ) {
-    // Pre-loaded config from Vite plugin or server
-    if (options.config) {
-      this.config = options.config;
-      this.loaded = true;
-    }
-  }
-
-  /**
-   * Load configuration
-   * Config should be pre-loaded via Vite plugin or passed in constructor
-   */
-  async load(): Promise<Record<string, any>> {
-    if (this.loaded) {
-      return this.config;
-    }
-
-    // If running on server (Node.js), throw error
-    const isServer =
-      typeof globalThis !== 'undefined' &&
-      typeof (globalThis as typeof globalThis & { window?: any }).window === 'undefined';
-
-    if (isServer) {
-      throw new Error(
-        'FileDriver requires pre-loaded configuration. ' +
-          'Use Vite plugin for client-side or pass config in constructor for server-side.'
-      );
-    }
-
-    this.loaded = true;
-    return this.config;
-  }
-
-  /**
-   * Get configuration value
-   */
-  get<T = any>(key: string, defaultValue?: T): T | undefined {
-    if (!this.loaded) {
-      throw new Error('Configuration not loaded. Call load() first or use async initialization.');
-    }
-    return getNestedValue(this.config, key, defaultValue);
-  }
-
-  /**
-   * Check if key exists
-   */
-  has(key: string): boolean {
-    if (!this.loaded) {
-      throw new Error('Configuration not loaded. Call load() first or use async initialization.');
-    }
-    return hasNestedValue(this.config, key);
-  }
-
-  /**
-   * Get all configuration
-   */
-  all(): Record<string, any> {
-    if (!this.loaded) {
-      throw new Error('Configuration not loaded. Call load() first or use async initialization.');
-    }
-    return { ...this.config };
-  }
-}

package/src/drivers/index.ts

@@ -1,6 +0,0 @@
-/**
- * Drivers
- */
-
-export { EnvDriver } from './env.driver';
-export { FileDriver } from './file.driver';

package/src/index.ts

@@ -1,93 +0,0 @@
-/**
- * @abdokouta/config
- *
- * NestJS-inspired configuration management with multiple drivers for loading
- * configuration from various sources (environment variables, files, etc.).
- * Provides type-safe access to configuration values with support for nested
- * properties and default values.
- *
- * @example
- * Basic usage with environment variables:
- * ```typescript
- * import { ConfigModule, ConfigService, EnvDriver } from '@abdokouta/config';
- * import { Module, Injectable, Inject } from '@abdokouta/react-di';
- *
- * @Module({
- *   imports: [
- *     ConfigModule.forRoot({
- *       driver: new EnvDriver(),
- *     }),
- *   ],
- * })
- * export class AppModule {}
- *
- * @Injectable()
- * class DatabaseService {
- *   constructor(@Inject(ConfigService) private config: ConfigService) {}
- *
- *   connect() {
- *     const host = this.config.get('DATABASE_HOST', 'localhost');
- *     const port = this.config.get('DATABASE_PORT', 5432);
- *     // Connect to database...
- *   }
- * }
- * ```
- *
- * @example
- * Using file-based configuration:
- * ```typescript
- * import { ConfigModule, FileDriver } from '@abdokouta/config';
- *
- * @Module({
- *   imports: [
- *     ConfigModule.forRoot({
- *       driver: new FileDriver({
- *         path: './config/app.json',
- *       }),
- *     }),
- *   ],
- * })
- * export class AppModule {}
- * ```
- *
- * @example
- * Accessing nested configuration:
- * ```typescript
- * // config.json: { "database": { "host": "localhost", "port": 5432 } }
- * const host = config.get('database.host');
- * const port = config.get('database.port', 3306);
- * ```
- *
- * @module @abdokouta/config
- */
-
-// ============================================================================
-// Module (DI Configuration)
-// ============================================================================
-export { ConfigModule } from './config.module';
-
-// ============================================================================
-// Core Service
-// ============================================================================
-export { ConfigService } from './services/config.service';
-
-// ============================================================================
-// Drivers
-// ============================================================================
-export { EnvDriver } from './drivers/env.driver';
-export { FileDriver } from './drivers/file.driver';
-
-// ============================================================================
-// Interfaces
-// ============================================================================
-export type { ConfigDriver } from './interfaces/config-driver.interface';
-export type { ConfigModuleOptions } from './interfaces/config-module-options.interface';
-export type { ConfigServiceInterface } from './interfaces/config-service.interface';
-export type { ViteConfigPluginOptions } from './interfaces/vite-config-plugin-options.interface';
-
-// ============================================================================
-// Utilities
-// ============================================================================
-export { defineConfig } from './utils/define-config.util';
-export { getNestedValue, hasNestedValue } from './utils/get-nested-value.util';
-export { loadConfigFile } from './utils/load-config-file.util';

package/src/interfaces/config-driver.interface.ts

@@ -1,30 +0,0 @@
-/**
- * Configuration Driver Interface
- *
- * Defines the contract for configuration drivers (env, file, firebase, etc.)
- */
-export interface ConfigDriver {
-  /**
-   * Load configuration from the driver source
-   * @returns Configuration object
-   */
-  load(): Promise<Record<string, any>> | Record<string, any>;
-
-  /**
-   * Get a configuration value by key
-   * @param key - Configuration key (supports dot notation)
-   * @param defaultValue - Default value if key not found
-   */
-  get<T = any>(key: string, defaultValue?: T): T | undefined;
-
-  /**
-   * Check if a configuration key exists
-   * @param key - Configuration key
-   */
-  has(key: string): boolean;
-
-  /**
-   * Get all configuration values
-   */
-  all(): Record<string, any>;
-}

package/src/interfaces/config-module-options.interface.ts

@@ -1,84 +0,0 @@
-/**
- * Configuration Module Options
- */
-export interface ConfigModuleOptions {
-  /**
-   * Configuration driver to use
-   * @default 'env'
-   */
-  driver?: 'env' | 'file' | 'firebase' | string;
-
-  /**
-   * Path to .env file (for env driver)
-   * @default '.env'
-   */
-  envFilePath?: string | string[];
-
-  /**
-   * Path pattern to scan for config files (for file driver)
-   * @example 'config/**\/*.config.ts'
-   */
-  filePattern?: string | string[];
-
-  /**
-   * Whether to ignore .env file
-   * @default false
-   */
-  ignoreEnvFile?: boolean;
-
-  /**
-   * Whether to expand environment variables
-   * @default false
-   */
-  expandVariables?: boolean;
-
-  /**
-   * Custom configuration object to merge
-   */
-  load?: Record<string, any> | (() => Record<string, any> | Promise<Record<string, any>>);
-
-  /**
-   * Whether configuration is global
-   * @default false
-   */
-  isGlobal?: boolean;
-
-  /**
-   * Cache configuration values
-   * @default true
-   */
-  cache?: boolean;
-
-  /**
-   * Validate configuration on load
-   */
-  validate?: (config: Record<string, any>) => void | Promise<void>;
-
-  /**
-   * Firebase configuration (for firebase driver)
-   */
-  firebase?: {
-    projectId: string;
-    configPath?: string;
-  };
-
-  /**
-   * Environment variable prefix to strip
-   * Set to 'auto' to auto-detect (VITE_ for Vite, NEXT_PUBLIC_ for Next.js)
-   * Set to 'VITE_' or 'NEXT_PUBLIC_' for specific framework
-   * Set to a custom string to strip that prefix
-   * Set to false to disable prefix stripping
-   * @default 'auto'
-   * @example 'VITE_' - strips VITE_ prefix, so VITE_APP_NAME becomes APP_NAME
-   * @example 'NEXT_PUBLIC_' - strips NEXT_PUBLIC_ prefix, so NEXT_PUBLIC_API_URL becomes API_URL
-   * @example 'auto' - auto-detects framework and strips appropriate prefix
-   */
-  envPrefix?: 'auto' | 'VITE_' | 'NEXT_PUBLIC_' | string | false;
-
-  /**
-   * Global variable name to read config from in browser
-   * @default '__APP_CONFIG__'
-   * @example '__APP_CONFIG__' - reads from window.__APP_CONFIG__
-   */
-  globalName?: string;
-}