baher-dotenv 1.1.2

package/LICENSE

@@ -0,0 +1,35 @@
+MIT License
+
+Copyright (c) 2026 Baher Hamed
+
+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.
+
+---
+
+# رخصة MIT
+
+حقوق النشر © 2026 Baher Hamed
+
+يُمنح الإذن، مجانًا، لأي شخص يحصل على نسخة من هذا البرنامج والملفات التوثيقية المرتبطة به، بالتعامل مع البرنامج دون قيود، بما في ذلك على سبيل المثال لا الحصر حقوق الاستخدام، والنسخ، والتعديل، والدمج، والنشر، والتوزيع، والترخيص من الباطن، و/أو بيع نسخ من البرنامج، والسماح للأشخاص الذين يتم تزويدهم بالبرنامج بالقيام بذلك، وذلك وفقًا للشروط التالية:
+
+يجب تضمين إشعار حقوق النشر أعلاه وإشعار الإذن هذا في جميع النسخ أو الأجزاء الجوهرية من البرنامج.
+
+يتم توفير البرنامج “كما هو” دون أي ضمان من أي نوع، صريحًا كان أو ضمنيًا، بما في ذلك على سبيل المثال لا الحصر ضمانات القابلية للتسويق، والملاءمة لغرض معين، وعدم الانتهاك. ولا يتحمل المؤلفون أو أصحاب حقوق النشر في أي حال من الأحوال المسؤولية عن أي مطالبة أو أضرار أو أي مسؤولية أخرى، سواء في دعوى تعاقدية أو تقصيرية أو غير ذلك، تنشأ عن البرنامج أو ترتبط به أو باستخدامه أو أي تعاملات أخرى فيه.
+
+> هذه ترجمة عربية غير رسمية لرخصة MIT. النسخة الإنجليزية أعلاه هي النسخة الأساسية المعتمدة.

package/README.md

@@ -0,0 +1,368 @@
+<div align="center">
+
+<img src="./docs/images/logo.png" width="420" alt="Baher Hamed Enterprise Software Engineering Logo"/>
+
+# baher-dotenv
+
+Type-safe environment configuration loader for Node.js.
+
+<p dir="rtl" align="center">
+مكتبة لإدارة وتحميل متغيرات البيئة في تطبيقات Node.js بطريقة آمنة باستخدام TypeScript
+</p>
+
+![Node.js](https://img.shields.io/badge/Node.js-20%2B-green)
+![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue)
+![NX](https://img.shields.io/badge/NX-Monorepo-purple)
+![Backend](https://img.shields.io/badge/Backend-Node.js-success)
+![Package](https://img.shields.io/badge/Package-Public-success)
+![License](https://img.shields.io/badge/License-MIT-lightgrey)
+
+</div>
+
+---
+
+## 🇺🇸 English
+
+## Overview
+
+`baher-dotenv` is a TypeScript library for Node.js backend applications.
+
+It allows you to define environment variables using a typed configuration object, then load these values into `process.env`.
+
+The main goal is to make environment configuration more structured, centralized, and type-safe.
+
+---
+
+## Installation
+
+```bash
+npm install baher-dotenv
+```
+
+---
+
+## Usage
+
+```ts
+import { baherEnvConfig, baherLoadEnv, ENV_TYPE } from 'baher-dotenv';
+
+const envConfig = baherEnvConfig({
+  APP_NAME: {
+    type: ENV_TYPE.String,
+    value: 'orders-api',
+  },
+
+  APP_PORT: {
+    type: ENV_TYPE.Number,
+    value: 3000,
+  },
+
+  ENABLE_ELK: {
+    type: ENV_TYPE.Boolean,
+    value: true,
+  },
+});
+
+baherLoadEnv(envConfig);
+```
+
+After calling `baherLoadEnv`, the values will be available inside `process.env`:
+
+```ts
+process.env.APP_NAME;   // "orders-api"
+process.env.APP_PORT;   // "3000"
+process.env.ENABLE_ELK; // "true"
+```
+
+---
+
+## API
+
+### `ENV_TYPE`
+
+A constant object used to define the type of each environment variable.
+
+```ts
+ENV_TYPE.String
+ENV_TYPE.Number
+ENV_TYPE.Boolean
+```
+
+---
+
+### `baherEnvConfig(config)`
+
+Defines a typed environment configuration.
+
+```ts
+const envConfig = baherEnvConfig({
+  APP_PORT: {
+    type: ENV_TYPE.Number,
+    value: 3000,
+  },
+});
+```
+
+If the value does not match the selected type, TypeScript will show an error.
+
+Example:
+
+```ts
+const envConfig = baherEnvConfig({
+  APP_PORT: {
+    type: ENV_TYPE.Number,
+    value: '3000', // TypeScript error
+  },
+});
+```
+
+---
+
+### `baherLoadEnv(config, options?)`
+
+Loads the provided configuration into `process.env`.
+
+```ts
+baherLoadEnv(envConfig);
+```
+
+By default, existing values inside `process.env` are not overwritten.
+
+To allow overriding existing values:
+
+```ts
+baherLoadEnv(envConfig, {
+  override: true,
+});
+```
+
+---
+
+## Supported Types
+
+Currently supported types:
+
+```ts
+string
+number
+boolean
+```
+
+All values are converted to strings before being added to `process.env`, because Node.js environment variables are string-based.
+
+---
+
+## Build
+
+```bash
+npx nx build baher-dotenv
+```
+
+---
+
+## Release
+
+From the workspace root:
+
+```bash
+npm run release
+```
+
+---
+
+## Project Structure
+
+```text
+dotenv/
+  src/
+    index.ts
+    lib/
+      core/
+        constants/
+        functions/
+        types/
+  README.md
+  package.json
+```
+
+---
+
+## License
+
+MIT License.
+
+See [LICENSE](../../LICENSE).
+
+---
+
+## 🇪🇬 العربية
+
+## نظرة عامة
+
+`baher-dotenv` هي مكتبة موجهة لتطبيقات Node.js.
+
+تساعدك المكتبة على تعريف متغيرات البيئة باستخدام TypeScript بشكل منظم وآمن من ناحية الأنواع، ثم تحميل هذه القيم داخل `process.env`.
+
+الهدف الأساسي من المكتبة هو جعل إعدادات البيئة أكثر تنظيمًا ومركزية وتقليل الأخطاء الناتجة عن التعامل مع القيم كنصوص غير واضحة.
+
+---
+
+## التثبيت
+
+```bash
+npm install baher-dotenv
+```
+
+---
+
+## طريقة الاستخدام
+
+```ts
+import { baherEnvConfig, baherLoadEnv, ENV_TYPE } from 'baher-dotenv';
+
+const envConfig = baherEnvConfig({
+  APP_NAME: {
+    type: ENV_TYPE.String,
+    value: 'orders-api',
+  },
+
+  APP_PORT: {
+    type: ENV_TYPE.Number,
+    value: 3000,
+  },
+
+  ENABLE_ELK: {
+    type: ENV_TYPE.Boolean,
+    value: true,
+  },
+});
+
+baherLoadEnv(envConfig);
+```
+
+بعد تنفيذ `baherLoadEnv` سيتم إضافة القيم داخل `process.env`:
+
+```ts
+process.env.APP_NAME;   // "orders-api"
+process.env.APP_PORT;   // "3000"
+process.env.ENABLE_ELK; // "true"
+```
+
+---
+
+## الواجهة البرمجية
+
+### `ENV_TYPE`
+
+ثابت يستخدم لتحديد نوع كل متغير بيئة.
+
+```ts
+ENV_TYPE.String
+ENV_TYPE.Number
+ENV_TYPE.Boolean
+```
+
+---
+
+### `baherEnvConfig(config)`
+
+تستخدم لتعريف إعدادات البيئة بطريقة typed.
+
+```ts
+const envConfig = baherEnvConfig({
+  APP_PORT: {
+    type: ENV_TYPE.Number,
+    value: 3000,
+  },
+});
+```
+
+إذا كانت قيمة `value` لا تطابق النوع المحدد في `type`، سيظهر خطأ من TypeScript.
+
+مثال غير صحيح:
+
+```ts
+const envConfig = baherEnvConfig({
+  APP_PORT: {
+    type: ENV_TYPE.Number,
+    value: '3000', // TypeScript error
+  },
+});
+```
+
+---
+
+### `baherLoadEnv(config, options?)`
+
+تستخدم لتحميل القيم داخل `process.env`.
+
+```ts
+baherLoadEnv(envConfig);
+```
+
+بشكل افتراضي، إذا كانت القيمة موجودة مسبقًا داخل `process.env` فلن يتم استبدالها.
+
+للسماح باستبدال القيم الموجودة:
+
+```ts
+baherLoadEnv(envConfig, {
+  override: true,
+});
+```
+
+---
+
+## الأنواع المدعومة
+
+الأنواع المدعومة حاليًا:
+
+```ts
+string
+number
+boolean
+```
+
+يتم تحويل كل القيم إلى `string` قبل إضافتها إلى `process.env`، لأن متغيرات البيئة في Node.js تعتمد على النصوص.
+
+---
+
+## بناء المكتبة
+
+```bash
+npx nx build baher-dotenv
+```
+
+---
+
+## إصدار المكتبة
+
+من جذر المشروع:
+
+```bash
+npm run release
+```
+
+---
+
+## هيكل المشروع
+
+```text
+dotenv/
+  src/
+    index.ts
+    lib/
+      core/
+        constants/
+        functions/
+        types/
+  README.md
+  package.json
+```
+
+---
+
+## الترخيص
+
+رخصة MIT.
+
+راجع ملف [LICENSE](../../LICENSE).

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/index.js';
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../dotenv/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC"}

package/index.js

@@ -0,0 +1 @@
+export * from './lib/index.js';

package/lib/core/constants/constant.d.ts

@@ -0,0 +1,6 @@
+export declare const ENV_TYPE: {
+    readonly String: "string";
+    readonly Number: "number";
+    readonly Boolean: "boolean";
+};
+//# sourceMappingURL=constant.d.ts.map

package/lib/core/constants/constant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constant.d.ts","sourceRoot":"","sources":["../../../../../dotenv/src/lib/core/constants/constant.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ;;;;CAIX,CAAC"}

package/lib/core/constants/constant.js

@@ -0,0 +1,5 @@
+export const ENV_TYPE = {
+    String: 'string',
+    Number: 'number',
+    Boolean: 'boolean',
+};

package/lib/core/constants/index.d.ts

@@ -0,0 +1,2 @@
+export * from './constant.js';
+//# sourceMappingURL=index.d.ts.map

package/lib/core/constants/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../dotenv/src/lib/core/constants/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}

package/lib/core/constants/index.js

@@ -0,0 +1 @@
+export * from './constant.js';

package/lib/core/functions/baher-env-config.d.ts

@@ -0,0 +1,3 @@
+import type { EnvConfig } from '../types/index.js';
+export declare function baherEnvConfig<const T extends EnvConfig>(config: T): T;
+//# sourceMappingURL=baher-env-config.d.ts.map

package/lib/core/functions/baher-env-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"baher-env-config.d.ts","sourceRoot":"","sources":["../../../../../dotenv/src/lib/core/functions/baher-env-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAEnD,wBAAgB,cAAc,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAEtE"}

package/lib/core/functions/baher-env-config.js

@@ -0,0 +1,3 @@
+export function baherEnvConfig(config) {
+    return config;
+}

package/lib/core/functions/baher-load-env.d.ts

@@ -0,0 +1,6 @@
+import type { EnvConfig } from '../types/index.js';
+export interface LoadEnvOptions {
+    override?: boolean;
+}
+export declare function baherLoadEnv(config: EnvConfig, options?: LoadEnvOptions): void;
+//# sourceMappingURL=baher-load-env.d.ts.map

package/lib/core/functions/baher-load-env.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"baher-load-env.d.ts","sourceRoot":"","sources":["../../../../../dotenv/src/lib/core/functions/baher-load-env.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAEnD,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,wBAAgB,YAAY,CACxB,MAAM,EAAE,SAAS,EACjB,OAAO,GAAE,cAAmB,GAC7B,IAAI,CAUN"}

package/lib/core/functions/baher-load-env.js

@@ -0,0 +1,9 @@
+export function baherLoadEnv(config, options = {}) {
+    const { override = false } = options;
+    for (const [key, variable] of Object.entries(config)) {
+        if (!override && process.env[key] !== undefined) {
+            continue;
+        }
+        process.env[key] = String(variable.value);
+    }
+}

package/lib/core/functions/index.d.ts

@@ -0,0 +1,3 @@
+export * from './baher-env-config.js';
+export * from './baher-load-env.js';
+//# sourceMappingURL=index.d.ts.map

package/lib/core/functions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../dotenv/src/lib/core/functions/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC"}

package/lib/core/functions/index.js

@@ -0,0 +1,2 @@
+export * from './baher-env-config.js';
+export * from './baher-load-env.js';

package/lib/core/index.d.ts

@@ -0,0 +1,4 @@
+export * from './constants/index.js';
+export * from './types/index.js';
+export * from './functions/index.js';
+//# sourceMappingURL=index.d.ts.map

package/lib/core/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../dotenv/src/lib/core/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC"}

package/lib/core/index.js

@@ -0,0 +1,3 @@
+export * from './constants/index.js';
+export * from './types/index.js';
+export * from './functions/index.js';

package/lib/core/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/lib/core/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../dotenv/src/lib/core/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC"}

package/lib/core/types/index.js

@@ -0,0 +1 @@
+export * from './types.js';

package/lib/core/types/types.d.ts

@@ -0,0 +1,14 @@
+import { ENV_TYPE } from "../constants/index.js";
+export type EnvType = typeof ENV_TYPE[keyof typeof ENV_TYPE];
+export type EnvVariable = {
+    type: typeof ENV_TYPE.String;
+    value: string;
+} | {
+    type: typeof ENV_TYPE.Number;
+    value: number;
+} | {
+    type: typeof ENV_TYPE.Boolean;
+    value: boolean;
+};
+export type EnvConfig = Record<string, EnvVariable>;
+//# sourceMappingURL=types.d.ts.map

package/lib/core/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../dotenv/src/lib/core/types/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD,MAAM,MAAM,OAAO,GAAG,OAAO,QAAQ,CAAC,MAAM,OAAO,QAAQ,CAAC,CAAC;AAE7D,MAAM,MAAM,WAAW,GACnB;IACA,IAAI,EAAE,OAAO,QAAQ,CAAC,MAAM,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;CACf,GACC;IACA,IAAI,EAAE,OAAO,QAAQ,CAAC,MAAM,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;CACf,GACC;IACA,IAAI,EAAE,OAAO,QAAQ,CAAC,OAAO,CAAC;IAC9B,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEJ,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC"}

package/lib/core/types/types.js

@@ -0,0 +1 @@
+export {};

package/lib/dotenv.d.ts

@@ -0,0 +1,2 @@
+export declare function dotenv(): string;
+//# sourceMappingURL=dotenv.d.ts.map

package/lib/dotenv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dotenv.d.ts","sourceRoot":"","sources":["../../../dotenv/src/lib/dotenv.ts"],"names":[],"mappings":"AAAA,wBAAgB,MAAM,IAAI,MAAM,CAE/B"}

package/lib/dotenv.js

@@ -0,0 +1,3 @@
+export function dotenv() {
+    return 'dotenv';
+}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './core/index.js';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../dotenv/src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC"}

package/lib/index.js

@@ -0,0 +1 @@
+export * from './core/index.js';

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "baher-dotenv",
+  "version": "1.1.2",
+  "license": "MIT",
+  "type": "module",
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "files": [
+    "**/*.js",
+    "**/*.d.ts",
+    "**/*.d.ts.map",
+    "README.md",
+    "LICENSE",
+    "docs"
+  ],
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "description": "A lightweight TypeScript library for type-safe Node.js environment configuration.",
+  "author": "Baher Hamed",
+  "keywords": [
+    "dotenv",
+    "env",
+    "environment",
+    "environment-variables",
+    "nodejs",
+    "typescript",
+    "type-safe",
+    "configuration",
+    "config",
+    "process-env"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/baherhamed/baher-dotenv.git"
+  },
+  "bugs": {
+    "url": "https://github.com/baherhamed/baher-dotenv/issues"
+  },
+  "homepage": "https://github.com/baherhamed/baher-dotenv#readme"
+}