npm - @abdokouta/react-config - Versions diffs - 1.0.0 → 1.0.2 - Mend

@abdokouta/react-config 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (43) hide show

package/LICENSE +21 -0
package/README.md +2 -1
package/config/config.config.ts +9 -9
package/dist/{index.d.mts → index.d.cts} +34 -2
package/dist/index.d.ts +34 -2
package/dist/index.js +28 -11
package/dist/index.js.map +1 -1
package/dist/index.mjs +28 -11
package/dist/index.mjs.map +1 -1
package/package.json +55 -25
package/.examples/01-basic-usage.ts +0 -289
package/.examples/02-env-helper.ts +0 -282
package/.examples/README.md +0 -285
package/.prettierrc.js +0 -1
package/__tests__/config.module.test.ts +0 -244
package/__tests__/drivers/env.driver.test.ts +0 -259
package/__tests__/services/config.service.test.ts +0 -328
package/__tests__/setup.d.ts +0 -11
package/__tests__/vitest.setup.ts +0 -30
package/eslint.config.js +0 -13
package/src/config.module.ts +0 -154
package/src/constants/index.ts +0 -5
package/src/constants/tokens.constant.ts +0 -38
package/src/drivers/env.driver.ts +0 -194
package/src/drivers/file.driver.ts +0 -81
package/src/drivers/index.ts +0 -6
package/src/index.ts +0 -92
package/src/interfaces/config-driver.interface.ts +0 -30
package/src/interfaces/config-module-options.interface.ts +0 -84
package/src/interfaces/config-service.interface.ts +0 -71
package/src/interfaces/index.ts +0 -8
package/src/interfaces/vite-config-plugin-options.interface.ts +0 -56
package/src/plugins/index.ts +0 -5
package/src/plugins/vite.plugin.ts +0 -115
package/src/services/config.service.ts +0 -172
package/src/services/index.ts +0 -5
package/src/utils/get-nested-value.util.ts +0 -56
package/src/utils/index.ts +0 -6
package/src/utils/load-config-file.util.ts +0 -37
package/src/utils/scan-config-files.util.ts +0 -40
package/tsconfig.json +0 -28
package/tsup.config.ts +0 -105
package/vitest.config.ts +0 -66

package/src/plugins/vite.plugin.ts DELETED Viewed

@@ -1,115 +0,0 @@
-/**
- * Vite Plugin for Config Package
- *
- * Simple plugin that receives env from Vite's loadEnv and injects it into the browser.
- * Does NOT apply any business logic - that's handled by ConfigService.
- *
- * Responsibilities:
- * 1. Receive environment variables from Vite's loadEnv (passed via options)
- * 2. Inject them into window.__APP_CONFIG__ (or custom global name)
- * 3. Optionally scan and collect .config.ts files
- *
- * ConfigService will then query from window.__APP_CONFIG__ and apply:
- * - Prefix stripping
- * - Type conversion
- * - Validation
- * - Defaults
- *
- * Usage:
- * ```ts
- * import { defineConfig, loadEnv } from 'vite'
- * import { viteConfigPlugin } from '@abdokouta/config/vite-plugin'
- *
- * export default defineConfig(({ mode }) => {
- *   const env = loadEnv(mode, 'environments', '')
- *
- *   return {
- *     plugins: [
- *       viteConfigPlugin({ env })
- *     ]
- *   }
- * })
- * ```
- */
-import path from 'path';
-import type { Plugin } from 'vite';
-import type { ViteConfigPluginOptions } from '@/interfaces/vite-config-plugin-options.interface';
-import { scanConfigFiles } from '@/utils/scan-config-files.util';
-import { loadConfigFile } from '@/utils/load-config-file.util';
-/**
- * Vite plugin that injects environment variables into the browser
- *
- * This plugin is DUMB - it just receives env and injects it.
- * ConfigService is SMART - it queries and applies business logic.
- */
-export function viteConfigPlugin(options: ViteConfigPluginOptions = {}): Plugin {
-  const {
-    env = {},
-    includeAll = true,
-    include = [],
-    scanConfigFiles: shouldScanConfigFiles = false,
-    globalName = '__APP_CONFIG__',
-  } = options;
-  let collectedConfig: Record<string, any> = {};
-  return {
-    name: 'vite-plugin-config',
-    async configResolved(config) {
-      // Scan and collect config files (optional, disabled by default)
-      if (shouldScanConfigFiles) {
-        const configFiles = await scanConfigFiles({
-          ...options,
-          root: config.root,
-        });
-        console.log('[vite-plugin-config] Found config files:', configFiles.length);
-        // Load all config files and merge them
-        for (const file of configFiles) {
-          const fileConfig = await loadConfigFile(file);
-          collectedConfig = { ...collectedConfig, ...fileConfig };
-          console.log('[vite-plugin-config] Loaded config from:', path.relative(config.root, file));
-        }
-      }
-    },
-    transformIndexHtml(html) {
-      // Build the config object from provided env
-      const processEnv: Record<string, any> = {};
-      for (const [key, value] of Object.entries(env)) {
-        // Filter by include list if not including all
-        if (!includeAll && !include.includes(key)) {
-          continue;
-        }
-        // Just copy the value as-is (NO prefix stripping here)
-        processEnv[key] = value;
-      }
-      // Merge with collected config from .config.ts files
-      const finalConfig = { ...processEnv, ...collectedConfig };
-      console.log('[vite-plugin-config] Injecting environment variables into HTML');
-      console.log('[vite-plugin-config] Total variables:', Object.keys(finalConfig).length);
-      console.log('[vite-plugin-config] Sample keys:', Object.keys(finalConfig).filter(k => k.includes('APP') || k.includes('VITE')));
-      console.log('[vite-plugin-config] Global name:', globalName);
-      // Inject script into HTML head
-      const script = `
-        <script>
-          window.${globalName} = ${JSON.stringify(finalConfig)};
-          // Also set process.env for backward compatibility
-          window.process = window.process || {};
-          window.process.env = window.${globalName};
-        </script>
-      `;
-      return html.replace('<head>', `<head>${script}`);
-    },
-  };
-}

package/src/services/config.service.ts DELETED Viewed

@@ -1,172 +0,0 @@
-import { Inject, Injectable } from "@abdokouta/react-di";
-import { CONFIG_DRIVER } from "@/constants/tokens.constant";
-import type { ConfigDriver } from "@/interfaces/config-driver.interface";
-import type { ConfigServiceInterface } from "@/interfaces/config-service.interface";
-/**
- * Configuration Service
- *
- * Provides type-safe access to configuration values with various getter methods.
- * Similar to NestJS ConfigService.
- *
- * @example
- * ```typescript
- * class MyService {
- *   constructor(private config: ConfigService) {}
- *
- *   getDbConfig() {
- *     return {
- *       host: this.config.getString('DB_HOST', 'localhost'),
- *       port: this.config.getNumber('DB_PORT', 5432),
- *       ssl: this.config.getBool('DB_SSL', false),
- *     };
- *   }
- * }
- * ```
- */
-@Injectable()
-export class ConfigService implements ConfigServiceInterface {
-  constructor(
-    @Inject(CONFIG_DRIVER)
-    private driver: ConfigDriver,
-  ) {}
-  /**
-   * Get configuration value
-   */
-  get<T = any>(key: string, defaultValue?: T): T | undefined {
-    return this.driver.get<T>(key, defaultValue);
-  }
-  /**
-   * Get configuration value or throw if not found
-   */
-  getOrThrow<T = any>(key: string): T {
-    const value = this.get<T>(key);
-    if (value === undefined) {
-      throw new Error(`Configuration key "${key}" is required but not set`);
-    }
-    return value;
-  }
-  /**
-   * Get string value
-   */
-  getString(key: string, defaultValue?: string): string | undefined {
-    const value = this.get(key, defaultValue);
-    return value !== undefined ? String(value) : undefined;
-  }
-  /**
-   * Get string value or throw
-   */
-  getStringOrThrow(key: string): string {
-    return String(this.getOrThrow(key));
-  }
-  /**
-   * Get number value
-   */
-  getNumber(key: string, defaultValue?: number): number | undefined {
-    const value = this.get(key, defaultValue);
-    if (value === undefined) {
-      return undefined;
-    }
-    const parsed = Number(value);
-    return isNaN(parsed) ? defaultValue : parsed;
-  }
-  /**
-   * Get number value or throw
-   */
-  getNumberOrThrow(key: string): number {
-    const value = this.getNumber(key);
-    if (value === undefined) {
-      throw new Error(`Configuration key "${key}" is required but not set`);
-    }
-    return value;
-  }
-  /**
-   * Get boolean value
-   * Treats 'true', '1', 'yes', 'on' as true
-   */
-  getBool(key: string, defaultValue?: boolean): boolean | undefined {
-    const value = this.get(key, defaultValue);
-    if (value === undefined) {
-      return undefined;
-    }
-    if (typeof value === "boolean") {
-      return value;
-    }
-    return ["true", "1", "yes", "on"].includes(String(value).toLowerCase());
-  }
-  /**
-   * Get boolean value or throw
-   */
-  getBoolOrThrow(key: string): boolean {
-    const value = this.getBool(key);
-    if (value === undefined) {
-      throw new Error(`Configuration key "${key}" is required but not set`);
-    }
-    return value;
-  }
-  /**
-   * Get array value (comma-separated string or actual array)
-   */
-  getArray(key: string, defaultValue?: string[]): string[] | undefined {
-    const value = this.get(key, defaultValue);
-    if (value === undefined) {
-      return undefined;
-    }
-    if (Array.isArray(value)) {
-      return value.map(String);
-    }
-    return String(value)
-      .split(",")
-      .map((v) => v.trim())
-      .filter(Boolean);
-  }
-  /**
-   * Get JSON value
-   */
-  getJson<T = any>(key: string, defaultValue?: T): T | undefined {
-    const value = this.get(key, defaultValue);
-    if (value === undefined) {
-      return undefined;
-    }
-    if (typeof value === "object") {
-      return value as T;
-    }
-    try {
-      return JSON.parse(String(value)) as T;
-    } catch {
-      return defaultValue;
-    }
-  }
-  /**
-   * Check if configuration key exists
-   */
-  has(key: string): boolean {
-    return this.driver.has(key);
-  }
-  /**
-   * Get all configuration values
-   */
-  all(): Record<string, any> {
-    return this.driver.all();
-  }
-  /**
-   * Clear cache (no-op since we don't cache in ConfigService)
-   */
-  clearCache(): void {
-    // No-op - caching should be done at a higher level if needed
-  }
-}

package/src/services/index.ts DELETED Viewed

@@ -1,5 +0,0 @@
-/**
- * Services
- */
-export { ConfigService } from './config.service';

package/src/utils/get-nested-value.util.ts DELETED Viewed

@@ -1,56 +0,0 @@
-/**
- * Get nested value from object using dot notation
- *
- * @param obj - Source object
- * @param path - Dot-notated path (e.g., 'database.host')
- * @param defaultValue - Default value if path not found
- * @returns Value at path or default value
- *
- * @example
- * ```typescript
- * const config = { database: { host: 'localhost' } };
- * getNestedValue(config, 'database.host'); // 'localhost'
- * getNestedValue(config, 'database.port', 5432); // 5432
- * ```
- */
-export function getNestedValue<T = any>(
-  obj: Record<string, any>,
-  path: string,
-  defaultValue?: T
-): T | undefined {
-  const keys = path.split('.');
-  let current: any = obj;
-  for (const key of keys) {
-    if (current === null || current === undefined) {
-      return defaultValue;
-    }
-    current = current[key];
-  }
-  return current !== undefined ? current : defaultValue;
-}
-/**
- * Check if nested path exists in object
- *
- * @param obj - Source object
- * @param path - Dot-notated path
- * @returns True if path exists
- */
-export function hasNestedValue(
-  obj: Record<string, any>,
-  path: string
-): boolean {
-  const keys = path.split('.');
-  let current: any = obj;
-  for (const key of keys) {
-    if (current === null || current === undefined || !(key in current)) {
-      return false;
-    }
-    current = current[key];
-  }
-  return true;
-}

package/src/utils/index.ts DELETED Viewed

@@ -1,6 +0,0 @@
-/**
- * Utils
- */
-export { getNestedValue, hasNestedValue } from './get-nested-value.util';
-export { loadConfigFile } from './load-config-file.util';

package/src/utils/load-config-file.util.ts DELETED Viewed

@@ -1,37 +0,0 @@
-/**
- * Load Config File Utility
- *
- * Dynamically loads and parses a config file.
- */
-/**
- * Load and parse config file
- *
- * @param filePath - Absolute path to the config file
- * @returns Parsed config object
- */
-export async function loadConfigFile(
-  filePath: string
-): Promise<Record<string, any>> {
-  try {
-    // Dynamic import of the config file
-    // @ts-ignore - Dynamic import path
-    const module = await import(/* @vite-ignore */ filePath);
-    // Extract config object (could be default export or named export)
-    const config = module.default || module;
-    // If it's a function, call it
-    if (typeof config === 'function') {
-      return await config();
-    }
-    return config;
-  } catch (error) {
-    console.warn(
-      `[vite-plugin-config] Failed to load config file: ${filePath}`,
-      error
-    );
-    return {};
-  }
-}

package/src/utils/scan-config-files.util.ts DELETED Viewed

@@ -1,40 +0,0 @@
-/**
- * Scan Config Files Utility
- *
- * Scans and collects all .config.ts files based on the provided options.
- */
-import { glob } from 'glob';
-import type { ViteConfigPluginOptions } from '@/interfaces/vite-config-plugin-options.interface';
-/**
- * Scan and collect all .config.ts files
- *
- * @param options - Plugin options containing scan configuration
- * @returns Array of absolute file paths to config files
- */
-export async function scanConfigFiles(
-  options: ViteConfigPluginOptions
-): Promise<string[]> {
-  const {
-    configFilePattern = 'src/**/*.config.ts',
-    excludeDirs = ['node_modules', 'dist', 'build', '.git'],
-    root = process.cwd(),
-  } = options;
-  const patterns = Array.isArray(configFilePattern)
-    ? configFilePattern
-    : [configFilePattern];
-  const configFiles: string[] = [];
-  for (const pattern of patterns) {
-    const files = await glob(pattern, {
-      cwd: root,
-      absolute: true,
-      ignore: excludeDirs.map((dir) => `**/${dir}/**`),
-    });
-    configFiles.push(...files);
-  }
-  return configFiles;
-}

package/tsconfig.json DELETED Viewed

@@ -1,28 +0,0 @@
-{
-  "extends": "@nesvel/typescript-config/base.json",
-  "compilerOptions": {
-    "outDir": "./dist",
-    "rootDir": ".",
-    /* Silence TypeScript deprecation warnings */
-    "ignoreDeprecations": "6.0",
-    /* Module resolution - Override Nesvel's NodeNext for compatibility */
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    /* Decorators - Required for DI container */
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    /* Build options */
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "jsx": "react-jsx",
-    /* Testing */
-    "types": ["vitest/globals", "node"],
-    "baseUrl": ".",
-    "paths": {
-      "@/*": ["./src/*"]
-    }
-  },
-  "include": ["src/**/*", "__tests__/**/*"],
-  "exclude": ["node_modules", "dist", "config"]
-}

package/tsup.config.ts DELETED Viewed

@@ -1,105 +0,0 @@
-import { defineConfig } from "tsup";
-/**
- * tsup Configuration for @abdokouta/logger Package
- *
- * Builds the logger package with dual format output (ESM + CJS).
- * Provides a flexible logging system with multiple transporters
- * (console, storage, silent) and formatters (pretty, json, simple).
- *
- * @see https://tsup.egoist.dev/
- */
-export default defineConfig({
-  /**
-   * Entry point for the build.
-   *
-   * Exports the logger service, transporters, formatters, and hooks.
-   */
-  entry: ["src/index.ts"],
-  /**
-   * Dual format output (ESM + CJS).
-   *
-   * - ESM: Modern module format for tree-shaking
-   * - CJS: CommonJS for Node.js compatibility
-   */
-  format: ["esm", "cjs"],
-  /**
-   * Generate TypeScript declaration files.
-   *
-   * Provides full type safety for consumers.
-   */
-  dts: true,
-  /**
-   * Generate source maps for debugging.
-   *
-   * Helps developers debug issues in production.
-   */
-  sourcemap: true,
-  /**
-   * Clean output directory before each build.
-   *
-   * Prevents stale files from previous builds.
-   */
-  clean: true,
-  /**
-   * Consumers will minify during their own build.
-   *
-   * Library code should not be pre-minified to allow
-   * better tree-shaking and debugging.
-   */
-  minify: false,
-  /**
-   * Target ES2020 for broad compatibility.
-   *
-   * Supports modern browsers and Node.js 14+.
-   * Includes optional chaining, nullish coalescing, and other ES2020 features.
-   */
-  target: "es2020",
-  /**
-   * Platform-neutral build.
-   *
-   * Works in both browser and Node.js environments.
-   */
-  platform: "neutral",
-  /**
-   * External dependencies that should not be bundled.
-   *
-   * - @abdokouta/react-di: DI system (peer dependency)
-   * - react: React library (optional peer dependency for hooks)
-   */
-  external: ["@abdokouta/react-di", "react"],
-  /**
-   * Disable code splitting for library builds.
-   *
-   * Libraries should be single-file outputs for easier consumption.
-   */
-  splitting: false,
-  /**
-   * Skip node_modules from being processed.
-   *
-   * Improves build performance by not processing dependencies.
-   */
-  skipNodeModulesBundle: true,
-  /**
-   * Ensure proper file extensions for each format.
-   *
-   * - .mjs for ESM (explicit module format)
-   * - .js for CJS (CommonJS format)
-   *
-   * This ensures proper module resolution in all environments.
-   */
-  outExtension({ format }) {
-    return { js: format === "esm" ? ".mjs" : ".js" };
-  },
-});

package/vitest.config.ts DELETED Viewed

@@ -1,66 +0,0 @@
-/**
- * @fileoverview Vitest configuration for @abdokouta/react-di package
- *
- * This configuration sets up the testing environment for the container package,
- * including test globals, jsdom environment, coverage reporting, and path aliases.
- *
- * Configuration Features:
- * - Globals: Enables global test functions (describe, it, expect)
- * - Environment: Uses jsdom for React component testing
- * - Setup Files: Runs vitest.setup.ts before tests
- * - Coverage: Configures v8 coverage provider with HTML/JSON/text reports
- * - Path Aliases: Resolves @ to ./src for consistent imports
- *
- * @module @abdokouta/react-di
- * @category Configuration
- */
-import { fileURLToPath } from "url";
-import { resolve, dirname } from "path";
-import { defineConfig } from "vitest/config";
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-export default defineConfig({
-  test: {
-    // Enable global test functions (describe, it, expect, etc.)
-    globals: true,
-    // Use jsdom environment for React testing
-    environment: "jsdom",
-    // Run setup file before tests
-    setupFiles: ["./__tests__/vitest.setup.ts"],
-    // Only include __tests__ directory
-    include: ["__tests__/**/*.{test,spec}.{ts,tsx}"],
-    // Coverage configuration
-    coverage: {
-      // Use v8 coverage provider (faster than istanbul)
-      provider: "v8",
-      // Generate multiple report formats
-      reporter: ["text", "json", "html"],
-      // Exclude files from coverage
-      exclude: [
-        "node_modules/",
-        "dist/",
-        "test/",
-        "**/*.test.ts",
-        "**/*.test.tsx",
-        "**/*.config.ts",
-      ],
-    },
-  },
-  // Resolve path aliases
-  resolve: {
-    alias: {
-      // Map @ to ./src for consistent imports
-      "@": resolve(__dirname, "./src"),
-    },
-  },
-});