@namigbit/config 0.0.1

package/README.md

@@ -0,0 +1,82 @@
+# @namig/config
+
+Конфигурация через декораторы с валидацией.
+
+## Установка
+
+```bash
+npm install @namig/config class-validator reflect-metadata dotenv
+```
+
+## Использование
+
+```typescript
+import 'reflect-metadata';
+import { Env, getConfig } from '@namig/config';
+import { IsString, IsNumber, Min, Max } from 'class-validator';
+
+class AppConfig {
+  @Env('PORT', { type: 'number', default: 3000 })
+  @IsNumber()
+  @Min(1000)
+  @Max(65535)
+  port: number;
+
+  @Env('DATABASE_URL')
+  @IsString()
+  databaseUrl: string;
+
+  @Env('DEBUG', { type: 'boolean', default: false })
+  debug: boolean;
+
+  @Env('REDIS_CONFIG', { type: 'json', default: { host: 'localhost', port: 6379 } })
+  redis: { host: string; port: number };
+
+  @Env('ALLOWED_ORIGINS', { type: 'array', default: ['http://localhost:3000'] })
+  allowedOrigins: string[];
+
+  @Env('OPTIONAL_KEY', { optional: true })
+  optionalKey?: string;
+}
+
+export const config = getConfig(AppConfig);
+```
+
+## API
+
+### `@Env(key, options?)`
+
+Декоратор для маппинга env переменной на свойство класса.
+
+**Options:**
+
+| Параметр | Тип | По умолчанию | Описание |
+|----------|-----|--------------|----------|
+| `type` | `'string' \| 'number' \| 'boolean' \| 'json' \| 'array'` | `'string'` | Тип преобразования |
+| `default` | `any` | `undefined` | Значение по умолчанию |
+| `optional` | `boolean` | `false` | Опциональная переменная |
+
+### `getConfig<T>(ConfigClass)`
+
+Создаёт и валидирует инстанс конфига.
+
+- Читает `.env` файл через dotenv
+- Трансформирует значения согласно `type`
+- Валидирует через class-validator
+- Выбрасывает ошибку если обязательная переменная отсутствует или валидация не прошла
+
+## Типы преобразования
+
+| Тип | ENV значение | Результат |
+|-----|--------------|-----------|
+| `string` | `"hello"` | `"hello"` |
+| `number` | `"3000"` | `3000` |
+| `boolean` | `"true"` / `"false"` | `true` / `false` |
+| `json` | `'{"host":"localhost"}'` | `{ host: "localhost" }` |
+| `array` | `"a, b, c"` | `["a", "b", "c"]` |
+
+## Peer Dependencies
+
+- `class-validator` ^0.14.0
+- `dotenv` ^16.0.0
+- `reflect-metadata` ^0.2.0

package/dist/Env.d.ts

@@ -0,0 +1,14 @@
+import 'reflect-metadata';
+export type EnvType = 'string' | 'number' | 'boolean' | 'json' | 'array';
+export interface EnvOptions {
+    type?: EnvType;
+    default?: any;
+    optional?: boolean;
+}
+export interface EnvMetadata {
+    key: string;
+    propertyKey: string;
+    options: Required<EnvOptions>;
+}
+export declare const ENV_METADATA_KEY: unique symbol;
+export declare function Env(key: string, options?: EnvOptions): (target: any, propertyKey: string) => void;

package/dist/Env.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENV_METADATA_KEY = void 0;
+exports.Env = Env;
+require("reflect-metadata");
+exports.ENV_METADATA_KEY = Symbol('env');
+function Env(key, options = {}) {
+    return function (target, propertyKey) {
+        const metadata = Reflect.getMetadata(exports.ENV_METADATA_KEY, target) || [];
+        metadata.push({
+            key,
+            propertyKey,
+            options: {
+                type: options.type || 'string',
+                default: options.default,
+                optional: options.optional || false,
+            },
+        });
+        Reflect.defineMetadata(exports.ENV_METADATA_KEY, metadata, target);
+    };
+}

package/dist/getConfig.d.ts

@@ -0,0 +1,2 @@
+import 'reflect-metadata';
+export declare function getConfig<T extends object>(ConfigClass: new () => T): T;

package/dist/getConfig.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfig = getConfig;
+require("reflect-metadata");
+const class_validator_1 = require("class-validator");
+const Env_1 = require("./Env");
+const transformValue_1 = require("./transformValue");
+const dotenv_1 = require("dotenv");
+(0, dotenv_1.config)();
+function getConfig(ConfigClass) {
+    const instance = new ConfigClass();
+    const metadata = Reflect.getMetadata(Env_1.ENV_METADATA_KEY, instance) || [];
+    for (const { key, propertyKey, options } of metadata) {
+        const value = process.env[key];
+        try {
+            const transformedValue = value ? (0, transformValue_1.transformValue)(value, options.type) : undefined;
+            if (!options.optional && !value && options.default === undefined) {
+                throw new Error(`Required env ${key} is missing`);
+            }
+            instance[propertyKey] = transformedValue ?? options.default;
+        }
+        catch (error) {
+            throw new Error(`Error processing ${key}: ${error.message}`);
+        }
+    }
+    const errors = (0, class_validator_1.validateSync)(instance, {
+        skipMissingProperties: false,
+        forbidUnknownValues: false,
+    });
+    if (errors.length > 0) {
+        throw new Error(errors.map((error) => Object.values(error.constraints).join(', ')).join('\n'));
+    }
+    return instance;
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Env';
+export * from './getConfig';

package/dist/index.js

@@ -0,0 +1,18 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Env"), exports);
+__exportStar(require("./getConfig"), exports);

package/dist/transformValue.d.ts

@@ -0,0 +1,2 @@
+import { EnvType } from './Env';
+export declare function transformValue(value: string | undefined, type: EnvType): any;

package/dist/transformValue.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformValue = transformValue;
+function transformValue(value, type) {
+    if (!value)
+        return undefined;
+    try {
+        switch (type) {
+            case 'number':
+                const num = Number(value);
+                if (isNaN(num))
+                    throw new Error('Invalid number');
+                return num;
+            case 'boolean':
+                return value.toLowerCase() === 'true';
+            case 'json':
+                return JSON.parse(value);
+            case 'array':
+                return value.split(',').map((item) => item.trim());
+            default:
+                return value;
+        }
+    }
+    catch (error) {
+        throw new Error(`Failed to transform value: ${error.message}`);
+    }
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@namigbit/config",
+  "version": "0.0.1",
+  "description": "Configuration module with validation",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch"
+  },
+  "peerDependencies": {
+    "class-validator": "^0.14.0",
+    "dotenv": "^16.0.0",
+    "reflect-metadata": "^0.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "class-validator": "^0.14.0",
+    "dotenv": "^16.0.0",
+    "reflect-metadata": "^0.2.0",
+    "typescript": "^5.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/namig/namig-libs.git",
+    "directory": "packages/config"
+  },
+  "keywords": [
+    "config",
+    "configuration",
+    "env",
+    "validation"
+  ],
+  "author": "namig",
+  "license": "MIT"
+}