@hazeljs/config 0.2.0-beta.55 → 0.2.0-beta.56

package/dist/config.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=config.test.d.ts.map

package/dist/config.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.test.d.ts","sourceRoot":"","sources":["../src/config.test.ts"],"names":[],"mappings":""}

package/dist/config.test.js

@@ -0,0 +1,287 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+/// <reference types="jest" />
+const fs = __importStar(require("fs"));
+const dotenv = __importStar(require("dotenv"));
+const config_service_1 = require("./config.service");
+const config_module_1 = require("./config.module");
+jest.mock('fs');
+jest.mock('dotenv');
+// Use __esModule: true so default import (`import logger from`) resolves correctly
+jest.mock('@hazeljs/core', () => ({
+    __esModule: true,
+    Service: () => () => undefined,
+    HazelModule: () => () => undefined,
+    logger: { info: jest.fn(), debug: jest.fn(), warn: jest.fn(), error: jest.fn() },
+    default: { info: jest.fn(), debug: jest.fn(), warn: jest.fn(), error: jest.fn() },
+}));
+const mockedFs = fs;
+const mockedDotenv = dotenv;
+describe('ConfigService', () => {
+    beforeEach(() => {
+        // Reset static options between tests
+        config_service_1.ConfigService.setOptions({});
+        // Clear mock call history
+        jest.clearAllMocks();
+        // Default: fs.existsSync returns false (no .env files)
+        mockedFs.existsSync.mockReturnValue(false);
+        // Default: dotenv.config returns empty parsed
+        mockedDotenv.config.mockReturnValue({ parsed: {} });
+    });
+    describe('get()', () => {
+        it('returns undefined for missing key', () => {
+            const svc = new config_service_1.ConfigService();
+            expect(svc.get('MISSING_KEY_HAZEL_TEST')).toBeUndefined();
+        });
+        it('returns default value for missing key', () => {
+            const svc = new config_service_1.ConfigService();
+            expect(svc.get('MISSING_KEY_HAZEL_TEST', 'default')).toBe('default');
+        });
+        it('returns value for existing env var', () => {
+            process.env.__HAZEL_TEST_VAR__ = 'hello';
+            const svc = new config_service_1.ConfigService();
+            expect(svc.get('__HAZEL_TEST_VAR__')).toBe('hello');
+            delete process.env.__HAZEL_TEST_VAR__;
+        });
+    });
+    describe('set()', () => {
+        it('sets a configuration value', () => {
+            const svc = new config_service_1.ConfigService();
+            svc.set('myKey', 'myValue');
+            expect(svc.get('myKey')).toBe('myValue');
+        });
+        it('overwrites existing value', () => {
+            const svc = new config_service_1.ConfigService();
+            svc.set('myKey', 'first');
+            svc.set('myKey', 'second');
+            expect(svc.get('myKey')).toBe('second');
+        });
+    });
+    describe('has()', () => {
+        it('returns false for missing key', () => {
+            const svc = new config_service_1.ConfigService();
+            expect(svc.has('NO_SUCH_KEY_XYZ')).toBe(false);
+        });
+        it('returns true for existing key', () => {
+            const svc = new config_service_1.ConfigService();
+            svc.set('existingKey', 'val');
+            expect(svc.has('existingKey')).toBe(true);
+        });
+    });
+    describe('getAll()', () => {
+        it('returns all configuration values', () => {
+            const svc = new config_service_1.ConfigService();
+            svc.set('k1', 'v1');
+            svc.set('k2', 'v2');
+            const all = svc.getAll();
+            expect(all.k1).toBe('v1');
+            expect(all.k2).toBe('v2');
+        });
+        it('returns a copy, not a reference', () => {
+            const svc = new config_service_1.ConfigService();
+            svc.set('k', 'v');
+            const all = svc.getAll();
+            all.k = 'mutated';
+            expect(svc.get('k')).toBe('v');
+        });
+    });
+    describe('getOrThrow()', () => {
+        it('returns value when key exists', () => {
+            const svc = new config_service_1.ConfigService();
+            svc.set('req', 'present');
+            expect(svc.getOrThrow('req')).toBe('present');
+        });
+        it('throws when key is missing', () => {
+            const svc = new config_service_1.ConfigService();
+            expect(() => svc.getOrThrow('DEFINITELY_NOT_SET_HAZEL')).toThrow('Configuration key "DEFINITELY_NOT_SET_HAZEL" is required but not found');
+        });
+    });
+    describe('dot-notation nested keys', () => {
+        it('resolves nested config via dot notation', () => {
+            config_service_1.ConfigService.setOptions({
+                ignoreEnvVars: true,
+                ignoreEnvFile: true,
+                load: [() => ({ database: { host: 'localhost', port: 5432 } })],
+            });
+            const svc = new config_service_1.ConfigService();
+            expect(svc.get('database.host')).toBe('localhost');
+            expect(svc.get('database.port')).toBe(5432);
+        });
+        it('returns undefined for missing nested key', () => {
+            config_service_1.ConfigService.setOptions({
+                ignoreEnvVars: true,
+                ignoreEnvFile: true,
+                load: [() => ({ database: { host: 'localhost' } })],
+            });
+            const svc = new config_service_1.ConfigService();
+            expect(svc.get('database.missing')).toBeUndefined();
+        });
+        it('returns undefined when parent key does not exist', () => {
+            config_service_1.ConfigService.setOptions({ ignoreEnvVars: true, ignoreEnvFile: true });
+            const svc = new config_service_1.ConfigService();
+            expect(svc.get('no.such.path')).toBeUndefined();
+        });
+    });
+    describe('custom loaders', () => {
+        it('merges custom loader config', () => {
+            config_service_1.ConfigService.setOptions({
+                ignoreEnvVars: true,
+                ignoreEnvFile: true,
+                load: [() => ({ APP_NAME: 'hazel' }), () => ({ APP_VERSION: '1.0.0' })],
+            });
+            const svc = new config_service_1.ConfigService();
+            expect(svc.get('APP_NAME')).toBe('hazel');
+            expect(svc.get('APP_VERSION')).toBe('1.0.0');
+        });
+    });
+    describe('ignoreEnvVars', () => {
+        it('skips loading process.env when ignoreEnvVars is true', () => {
+            process.env.__HAZEL_IGNORE_TEST__ = 'should-not-appear';
+            config_service_1.ConfigService.setOptions({ ignoreEnvVars: true, ignoreEnvFile: true });
+            const svc = new config_service_1.ConfigService();
+            expect(svc.get('__HAZEL_IGNORE_TEST__')).toBeUndefined();
+            delete process.env.__HAZEL_IGNORE_TEST__;
+        });
+    });
+    describe('ignoreEnvFile', () => {
+        it('skips .env loading when ignoreEnvFile is true', () => {
+            config_service_1.ConfigService.setOptions({ ignoreEnvFile: true });
+            new config_service_1.ConfigService();
+            expect(mockedFs.existsSync).not.toHaveBeenCalled();
+        });
+    });
+    describe('.env file loading', () => {
+        it('loads values from an existing .env file', () => {
+            mockedFs.existsSync.mockReturnValue(true);
+            mockedDotenv.config.mockReturnValue({ parsed: { FROM_ENV_FILE: 'env-value' } });
+            config_service_1.ConfigService.setOptions({ ignoreEnvVars: true, envFilePath: '/custom/.env' });
+            const svc = new config_service_1.ConfigService();
+            expect(mockedDotenv.config).toHaveBeenCalled();
+            expect(svc.get('FROM_ENV_FILE')).toBe('env-value');
+        });
+        it('handles multiple env file paths', () => {
+            mockedFs.existsSync.mockReturnValue(true);
+            mockedDotenv.config
+                .mockReturnValueOnce({ parsed: { KEY_A: 'a' } })
+                .mockReturnValueOnce({ parsed: { KEY_B: 'b' } });
+            config_service_1.ConfigService.setOptions({
+                ignoreEnvVars: true,
+                envFilePath: ['/path/one.env', '/path/two.env'],
+            });
+            const svc = new config_service_1.ConfigService();
+            expect(mockedDotenv.config).toHaveBeenCalledTimes(2);
+            expect(svc.get('KEY_A')).toBe('a');
+            expect(svc.get('KEY_B')).toBe('b');
+        });
+        it('handles dotenv parse errors gracefully', () => {
+            mockedFs.existsSync.mockReturnValue(true);
+            mockedDotenv.config.mockReturnValue({ error: new Error('parse error') });
+            // Should not throw
+            config_service_1.ConfigService.setOptions({ ignoreEnvVars: true, envFilePath: '/bad.env' });
+            expect(() => new config_service_1.ConfigService()).not.toThrow();
+        });
+        it('skips non-existent env files gracefully', () => {
+            mockedFs.existsSync.mockReturnValue(false);
+            config_service_1.ConfigService.setOptions({ ignoreEnvVars: true, envFilePath: '/missing.env' });
+            expect(() => new config_service_1.ConfigService()).not.toThrow();
+            expect(mockedDotenv.config).not.toHaveBeenCalled();
+        });
+    });
+    describe('validation schema', () => {
+        it('uses validated config value when validation passes', () => {
+            const schema = {
+                validate: (config) => ({
+                    value: { ...config, EXTRA_KEY: 'added-by-schema' },
+                }),
+            };
+            config_service_1.ConfigService.setOptions({
+                ignoreEnvVars: true,
+                ignoreEnvFile: true,
+                validationSchema: schema,
+            });
+            const svc = new config_service_1.ConfigService();
+            expect(svc.get('EXTRA_KEY')).toBe('added-by-schema');
+        });
+        it('throws when validation fails and abortEarly is not set', () => {
+            const schema = {
+                validate: () => ({
+                    error: new Error('validation failed'),
+                    value: {},
+                }),
+            };
+            config_service_1.ConfigService.setOptions({
+                ignoreEnvVars: true,
+                ignoreEnvFile: true,
+                validationSchema: schema,
+            });
+            expect(() => new config_service_1.ConfigService()).toThrow('Configuration validation error: validation failed');
+        });
+        it('does not throw when validation fails and abortEarly is true', () => {
+            const schema = {
+                validate: () => ({
+                    error: new Error('validation failed'),
+                    value: {},
+                }),
+            };
+            config_service_1.ConfigService.setOptions({
+                ignoreEnvVars: true,
+                ignoreEnvFile: true,
+                validationSchema: schema,
+                validationOptions: { abortEarly: true },
+            });
+            expect(() => new config_service_1.ConfigService()).not.toThrow();
+        });
+    });
+});
+describe('ConfigModule', () => {
+    beforeEach(() => {
+        config_service_1.ConfigService.setOptions({});
+    });
+    it('forRoot returns ConfigModule', () => {
+        const result = config_module_1.ConfigModule.forRoot();
+        expect(result).toBe(config_module_1.ConfigModule);
+    });
+    it('forRoot sets options on ConfigService', () => {
+        config_module_1.ConfigModule.forRoot({ ignoreEnvFile: true, ignoreEnvVars: true });
+        // If options were set, a new ConfigService should not try loading env files
+        mockedFs.existsSync.mockReturnValue(false);
+        expect(() => new config_service_1.ConfigService()).not.toThrow();
+    });
+    it('forRoot without options returns ConfigModule', () => {
+        const result = config_module_1.ConfigModule.forRoot();
+        expect(result).toBe(config_module_1.ConfigModule);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hazeljs/config",
-  "version": "0.2.0-beta.55",
+  "version": "0.2.0-beta.56",
   "description": "Configuration module for HazelJS framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -49,5 +49,5 @@
   "peerDependencies": {
     "@hazeljs/core": ">=0.2.0-beta.0"
   },
-  "gitHead": "f2e54f346eea552595a44607999454a9e388cb9e"
+  "gitHead": "c2737e90974458a8438eee623726f0a453b66b8b"
 }