@abdokouta/react-config 1.0.0 → 1.0.1

package/.examples/01-basic-usage.ts

@@ -1,12 +1,12 @@
 /**
  * Basic Config Usage Example
- * 
+ *
  * This example demonstrates the fundamental configuration operations:
  * - Environment variable access
  * - Type-safe getters
  * - Default values
  * - Nested configuration
- * 
+ *
  * @example
  * Run this example:
  * ```bash
@@ -193,10 +193,12 @@ function getAllConfig(config: ConfigService) {
   console.log('\n=== Example 8: Get All Configuration ===\n');
 
   const allConfig = config.all();
-  const keys = Object.keys(allConfig).filter(k => k.startsWith('APP_') || k.startsWith('ALLOWED_'));
-  
+  const keys = Object.keys(allConfig).filter(
+    (k) => k.startsWith('APP_') || k.startsWith('ALLOWED_')
+  );
+
   console.log('✓ All APP_* and ALLOWED_* configuration:');
-  keys.forEach(key => {
+  keys.forEach((key) => {
     console.log(`  - ${key}: ${allConfig[key]}`);
   });
 }

package/.examples/02-env-helper.ts

@@ -1,9 +1,9 @@
 /**
  * Env Helper Example
- * 
+ *
  * This example demonstrates the standalone Env utility for quick
  * environment variable access without dependency injection.
- * 
+ *
  * @example
  * Run this example:
  * ```bash
@@ -115,10 +115,10 @@ function getAllEnv() {
   console.log('\n=== Example 5: Get All Environment Variables ===\n');
 
   const allEnv = Env.all();
-  const appVars = Object.keys(allEnv).filter(k => k.startsWith('APP_'));
-  
+  const appVars = Object.keys(allEnv).filter((k) => k.startsWith('APP_'));
+
   console.log('✓ All APP_* environment variables:');
-  appVars.forEach(key => {
+  appVars.forEach((key) => {
     console.log(`  - ${key}: ${allEnv[key]}`);
   });
 }

package/.examples/README.md

@@ -1,12 +1,14 @@
 # Config Examples
 
-This folder contains examples demonstrating how to use `@abdokouta/config` in various scenarios.
+This folder contains examples demonstrating how to use `@abdokouta/config` in
+various scenarios.
 
 ## Examples Overview
 
 ### 1. Basic Usage (`01-basic-usage.ts`)
 
 Learn the fundamental configuration operations:
+
 - ✅ Environment variable access
 - ✅ Type-safe getters (getString, getNumber, getBool)
 - ✅ Default values
@@ -15,6 +17,7 @@ Learn the fundamental configuration operations:
 - ✅ Array values
 
 **Run:**
+
 ```bash
 ts-node examples/01-basic-usage.ts
 ```
@@ -22,6 +25,7 @@ ts-node examples/01-basic-usage.ts
 ### 2. Multiple Drivers (`02-multiple-drivers.ts`)
 
 Work with different configuration drivers:
+
 - ✅ Environment driver (dotenv)
 - ✅ File driver (TypeScript/JSON)
 - ✅ Switching between drivers
@@ -29,6 +33,7 @@ Work with different configuration drivers:
 - ✅ Configuration merging
 
 **Run:**
+
 ```bash
 ts-node examples/02-multiple-drivers.ts
 ```
@@ -36,6 +41,7 @@ ts-node examples/02-multiple-drivers.ts
 ### 3. Env Helper (`03-env-helper.ts`)
 
 Use the standalone Env utility:
+
 - ✅ Direct environment access
 - ✅ Type conversions
 - ✅ No service injection needed
@@ -43,6 +49,7 @@ Use the standalone Env utility:
 - ✅ Quick access patterns
 
 **Run:**
+
 ```bash
 ts-node examples/03-env-helper.ts
 ```
@@ -120,7 +127,9 @@ const features = {
 ### 4. Array Configuration
 
 ```typescript
-const allowedOrigins = config.getArray('CORS_ORIGINS', ['http://localhost:3000']);
+const allowedOrigins = config.getArray('CORS_ORIGINS', [
+  'http://localhost:3000',
+]);
 const trustedProxies = config.getArray('TRUSTED_PROXIES', []);
 ```
 
@@ -194,7 +203,7 @@ const logLevel = config.getString(
 ```typescript
 function validateConfig(config: ConfigService) {
   const required = ['DB_HOST', 'DB_USER', 'DB_PASSWORD', 'API_KEY'];
-  
+
   for (const key of required) {
     if (!config.has(key)) {
       throw new Error(`Missing required configuration: ${key}`);
@@ -214,7 +223,7 @@ ConfigModule.forRoot({
   ignoreEnvFile: false,
   expandVariables: true,
   isGlobal: true,
-})
+});
 ```
 
 ### File Driver
@@ -232,7 +241,7 @@ ConfigModule.forRoot({
     },
   },
   isGlobal: true,
-})
+});
 ```
 
 ### Custom Configuration
@@ -248,7 +257,7 @@ ConfigModule.forRoot({
     },
   },
   isGlobal: true,
-})
+});
 ```
 
 ## Troubleshooting
@@ -277,9 +286,12 @@ ConfigModule.forRoot({
 ## Additional Resources
 
 - [Main README](../README.md) - Package documentation
-- [NestJS Config Documentation](https://docs.nestjs.com/techniques/configuration) - Inspiration
-- [dotenv Documentation](https://github.com/motdotla/dotenv) - Environment variables
+- [NestJS Config Documentation](https://docs.nestjs.com/techniques/configuration) -
+  Inspiration
+- [dotenv Documentation](https://github.com/motdotla/dotenv) - Environment
+  variables
 
 ## Contributing
 
-Found an issue or have a suggestion? Please open an issue or submit a pull request!
+Found an issue or have a suggestion? Please open an issue or submit a pull
+request!

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Refine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,7 @@
 # @abdokouta/config
 
-NestJS-inspired configuration management with multiple drivers (Env, File, Firebase) for Refine applications.
+NestJS-inspired configuration management with multiple drivers (Env, File,
+Firebase) for Refine applications.
 
 ## Features
 

package/__tests__/config.module.test.ts

@@ -1,24 +1,24 @@
 /**
  * @fileoverview Tests for ConfigModule
- * 
+ *
  * This test suite verifies the ConfigModule functionality including:
  * - Module registration (forRoot, forRootAsync)
  * - Driver creation and configuration
  * - Custom config merging
  * - Provider setup
- * 
+ *
  * @module @abdokouta/config
  * @category Tests
  */
 
-import { describe, it, expect, beforeEach } from "vitest";
-import { ConfigModule } from "@/config.module";
-import { EnvDriver } from "@/drivers/env.driver";
-import { FileDriver } from "@/drivers/file.driver";
+import { describe, it, expect, beforeEach } from 'vitest';
+import { ConfigModule } from '@/config.module';
+import { EnvDriver } from '@/drivers/env.driver';
+import { FileDriver } from '@/drivers/file.driver';
 
-describe("ConfigModule", () => {
-  describe("forRoot", () => {
-    it("should create a dynamic module with default configuration", () => {
+describe('ConfigModule', () => {
+  describe('forRoot', () => {
+    it('should create a dynamic module with default configuration', () => {
       // Act: Create module with default config
       const module = ConfigModule.forRoot();
 
@@ -29,11 +29,11 @@ describe("ConfigModule", () => {
       expect(module.exports).toBeDefined();
     });
 
-    it("should create module with env driver", () => {
+    it('should create module with env driver', () => {
       // Arrange: Configure env driver
       const options = {
-        driver: "env" as const,
-        envFilePath: ".env.test",
+        driver: 'env' as const,
+        envFilePath: '.env.test',
       };
 
       // Act: Create module
@@ -44,11 +44,11 @@ describe("ConfigModule", () => {
       expect(module.providers).toBeDefined();
     });
 
-    it("should create module with file driver", () => {
+    it('should create module with file driver', () => {
       // Arrange: Configure file driver
       const options = {
-        driver: "file" as const,
-        configPath: "./config",
+        driver: 'file' as const,
+        configPath: './config',
       };
 
       // Act: Create module
@@ -59,17 +59,17 @@ describe("ConfigModule", () => {
       expect(module.providers).toBeDefined();
     });
 
-    it("should merge custom configuration", () => {
+    it('should merge custom configuration', () => {
       // Arrange: Custom config
       const customConfig = {
         app: {
-          name: "Test App",
-          version: "1.0.0",
+          name: 'Test App',
+          version: '1.0.0',
         },
       };
 
       const options = {
-        driver: "env" as const,
+        driver: 'env' as const,
         config: customConfig,
       };
 
@@ -80,10 +80,10 @@ describe("ConfigModule", () => {
       expect(module).toBeDefined();
     });
 
-    it("should set global flag when specified", () => {
+    it('should set global flag when specified', () => {
       // Arrange: Global module config
       const options = {
-        driver: "env" as const,
+        driver: 'env' as const,
         isGlobal: true,
       };
 
@@ -95,12 +95,12 @@ describe("ConfigModule", () => {
     });
   });
 
-  describe("forRootAsync", () => {
-    it("should create async dynamic module", async () => {
+  describe('forRootAsync', () => {
+    it('should create async dynamic module', async () => {
       // Arrange: Async factory
       const useFactory = async () => ({
-        driver: "env" as const,
-        envFilePath: ".env",
+        driver: 'env' as const,
+        envFilePath: '.env',
       });
 
       // Act: Create async module
@@ -113,16 +113,16 @@ describe("ConfigModule", () => {
       expect(module.module).toBe(ConfigModule);
     });
 
-    it("should handle async factory with dependencies", async () => {
+    it('should handle async factory with dependencies', async () => {
       // Arrange: Factory with inject
       const useFactory = async (dep: any) => ({
-        driver: "env" as const,
+        driver: 'env' as const,
       });
 
       // Act: Create async module
       const module = await ConfigModule.forRootAsync({
         useFactory,
-        inject: ["SOME_DEPENDENCY"],
+        inject: ['SOME_DEPENDENCY'],
       });
 
       // Assert: Module is created
@@ -130,8 +130,8 @@ describe("ConfigModule", () => {
     });
   });
 
-  describe("Driver Creation", () => {
-    it("should create EnvDriver by default", () => {
+  describe('Driver Creation', () => {
+    it('should create EnvDriver by default', () => {
       // Act: Create module with no driver specified
       const module = ConfigModule.forRoot({});
 
@@ -139,11 +139,11 @@ describe("ConfigModule", () => {
       expect(module).toBeDefined();
     });
 
-    it("should create FileDriver when specified", () => {
+    it('should create FileDriver when specified', () => {
       // Arrange: File driver config
       const options = {
-        driver: "file" as const,
-        configPath: "./config",
+        driver: 'file' as const,
+        configPath: './config',
       };
 
       // Act: Create module
@@ -153,11 +153,11 @@ describe("ConfigModule", () => {
       expect(module).toBeDefined();
     });
 
-    it("should pass driver options correctly", () => {
+    it('should pass driver options correctly', () => {
       // Arrange: Driver with options
       const options = {
-        driver: "env" as const,
-        envFilePath: ".env.custom",
+        driver: 'env' as const,
+        envFilePath: '.env.custom',
         expandVariables: true,
       };
 
@@ -169,21 +169,21 @@ describe("ConfigModule", () => {
     });
   });
 
-  describe("Configuration Merging", () => {
-    it("should merge multiple config sources", () => {
+  describe('Configuration Merging', () => {
+    it('should merge multiple config sources', () => {
       // Arrange: Multiple configs
       const customConfig = {
         database: {
-          host: "localhost",
+          host: 'localhost',
           port: 5432,
         },
         cache: {
-          driver: "redis",
+          driver: 'redis',
         },
       };
 
       const options = {
-        driver: "env" as const,
+        driver: 'env' as const,
         config: customConfig,
       };
 
@@ -194,15 +194,15 @@ describe("ConfigModule", () => {
       expect(module).toBeDefined();
     });
 
-    it("should handle nested configuration objects", () => {
+    it('should handle nested configuration objects', () => {
       // Arrange: Nested config
       const customConfig = {
         app: {
-          name: "Test",
+          name: 'Test',
           features: {
             auth: true,
             api: {
-              version: "v1",
+              version: 'v1',
               timeout: 5000,
             },
           },
@@ -221,8 +221,8 @@ describe("ConfigModule", () => {
     });
   });
 
-  describe("Module Exports", () => {
-    it("should export ConfigService", () => {
+  describe('Module Exports', () => {
+    it('should export ConfigService', () => {
       // Act: Create module
       const module = ConfigModule.forRoot();
 
@@ -231,7 +231,7 @@ describe("ConfigModule", () => {
       expect(Array.isArray(module.exports)).toBe(true);
     });
 
-    it("should provide all necessary providers", () => {
+    it('should provide all necessary providers', () => {
       // Act: Create module
       const module = ConfigModule.forRoot();