envapt 1.0.0

package/LICENSE

@@ -0,0 +1,197 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2025 Dhruv Jain (materwelonDhruv)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+### Third-Party Components
+
+This project includes code originally developed and licensed under the MIT License:
+
+- Portions derived from envuments (c) 2020 Mason Rogers
+  See `envuments.license` for full license text.

package/NOTICE

@@ -0,0 +1,2 @@
+This product includes software originally developed by Mason Rogers.
+Fully rewritten under the MIT License by Dhruv Jain.

package/README.md

@@ -0,0 +1,445 @@
+# Envapt - The apt way to handle env
+
+A powerful TypeScript-first environment configuration library that provides type detection, template variable resolution, and decorator-based class property configuration by extending dotenv.
+
+## Features
+
+- 🔧 **Automatic Type Detection** - Types inferred from fallback values
+- 🔗 **Template Variables** - `${VAR}` syntax with circular reference protection
+- 🎯 **Class Properties** - Decorator-based configuration for class members
+- 🏷️ **Built-in & Custom Converters** - Ready-to-use converters for common patterns + custom transformations
+- 🌍 **Environment Detection** - Built-in development/staging/production handling
+- 📂 **Multiple .env Files** - Load from multiple sources
+- 💪 **Edge Case Handling** - Robust parsing for all scenarios
+- 🛡️ **Type Safety** - Full TypeScript support with proper type inference
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Quick Start](#quick-start)
+  - [Installation](#installation)
+  - [Basic Usage](#basic-usage)
+- [API Reference](#api-reference)
+  - [Decorator API](#decorator-api)
+  - [Built-in Converters](#built-in-converters)
+  - [Custom Array Converters](#custom-array-converters)
+  - [Custom Converters](#custom-converters)
+  - [Handling Missing Values](#handling-missing-values)
+  - [Functional API](#functional-api)
+- [Environment Detection](#environment-detection)
+- [Template Variables](#template-variables)
+- [Advanced Examples](#advanced-examples)
+
+## Requirements
+
+- **Node.js**: v18 or later (recommended for ESM and nodenext support)
+- **TypeScript**: v5.8 or later
+- **Dependencies**:
+  - `dotenv` (runtime dependency | bundled)
+  - `reflect-metadata` (peer dependency, required for decorators)
+- **TypeScript Compiler Options**:
+  - `experimentalDecorators: true`
+  - `emitDecoratorMetadata: true`
+  - `module: nodenext`
+  - `moduleResolution: nodenext`
+  - `target: esnext`
+  - `lib: ESNext`
+- **ESM Support**: Project uses ESM (`nodenext`), so your environment and tooling should support ES modules.
+
+## Quick Start
+
+### Installation
+
+```bash
+# npm
+npm install envapt reflect-metadata
+
+# pnpm
+pnpm add envapt reflect-metadata
+
+# yarn
+yarn add envapt reflect-metadata
+```
+
+### Basic Usage
+
+Create a `.env` file:
+
+```env
+APP_PORT=8443
+APP_URL=http://localhost:${APP_PORT}
+DATABASE_URL=postgres://localhost:5432/mydb
+IS_PRODUCTION=false
+MAX_CONNECTIONS=100
+ALLOWED_ORIGINS=https://app.com,https://admin.com
+```
+
+Use with decorators (recommended):
+
+```ts
+import { Envapt, Envapter } from 'envapt';
+
+// Global app configuration (static properties)
+class AppConfig extends Envapter {
+  @Envapt('APP_PORT', 3000)
+  static readonly port: number;
+
+  @Envapt('APP_URL', 'http://localhost:3000', 'url')
+  static readonly url: URL;
+
+  @Envapt('ALLOWED_ORIGINS', {
+    fallback: ['http://localhost:3000'],
+    converter: 'array'
+  })
+  static readonly allowedOrigins: string[];
+}
+
+// Service configuration (instance properties)
+class DatabaseService {
+  @Envapt('DATABASE_URL', 'sqlite://memory')
+  declare readonly databaseUrl: string;
+
+  @Envapt('MAX_CONNECTIONS', { converter: 'number', fallback: 10 })
+  declare readonly maxConnections: number;
+
+  @Envapt('REQUEST_TIMEOUT', { converter: 'time', fallback: 5000 })
+  declare readonly timeout: number; // Converts "5s" to 5000ms
+
+  async connect() {
+    console.log(`Connecting to ${this.databaseUrl}`);
+    // Connection logic here
+  }
+}
+
+// Usage
+console.log(AppConfig.port); // 8443 (number)
+console.log(AppConfig.url.href); // "http://localhost:8443" (templated!)
+
+const dbService = new DatabaseService();
+await dbService.connect();
+```
+
+Or use functionally:\
+<sub>Limited to primitives, String, Number, Boolean, Symbol, and BigInt. Does not support converters.</sub>
+
+```ts
+import { Envapter } from 'envapt';
+
+const port = Envapter.getNumber('APP_PORT', 3000);
+const url = Envapter.get('APP_URL', 'http://localhost:3000');
+const isProduction = Envapter.getBoolean('IS_PRODUCTION', false);
+```
+
+## API Reference
+
+### Decorator API
+
+The `@Envapt` decorator can be used on both **static** and **instance** class properties:
+
+- **Static properties**: Use for global configuration that's shared across your entire application (e.g., app port, global features, environment settings)
+- **Instance properties**: Use for service-specific configuration that may vary per service or when you want the configuration tied to a specific class instance (e.g., database connections, service endpoints, per-service settings)
+
+**Important**: Instance properties must be declared with `declare` keyword or `!` assertion since they're populated by the decorator rather than set in a constructor.
+
+#### Modern Syntax (Recommended)
+
+```ts
+@Envapt('ENV_VAR', { fallback?: T, converter?: EnvConverter<T> })
+```
+
+#### Classic Syntax
+
+```ts
+@Envapt('ENV_VAR', fallback?, converter?)
+```
+
+#### Automatic Type Detection
+
+Types are automatically inferred from fallback values. Use static properties for app-wide config and instance properties for service-specific config:
+
+```ts
+class Config extends Envapter {
+  // Static properties for global settings
+  @Envapt('APP_NAME', 'MyApp') // string
+  static readonly appName: string;
+
+  @Envapt('APP_PORT', 3000) // number
+  static readonly port: number;
+
+  @Envapt('DEBUG_MODE', false) // boolean
+  static readonly debugMode: boolean;
+
+  // Instance properties for service-specific settings
+  @Envapt('SMTP_HOST', 'localhost') // string
+  declare readonly smtpHost: string;
+
+  @Envapt('SMTP_PORT', 587) // number
+  declare readonly smtpPort: number;
+
+  @Envapt('SMTP_SECURE', true) // boolean
+  declare readonly smtpSecure: boolean;
+
+  sendEmail(to: string, subject: string) {
+    console.log(`Sending via ${this.smtpHost}:${this.smtpPort}`);
+  }
+}
+```
+
+#### Built-in Converters
+
+Envapt provides many built-in converters for common patterns:
+
+```ts
+class Config extends Envapter {
+  // Basic types
+  @Envapt('APP_NAME', { converter: 'string', fallback: 'MyApp' })
+  static readonly appName: string;
+
+  @Envapt('PORT', { converter: 'number', fallback: 3000 })
+  static readonly port: number;
+
+  @Envapt('PRODUCTION_MODE', { converter: 'boolean', fallback: false })
+  static readonly productionMode: boolean;
+
+  // Advanced types
+  @Envapt('CORS_ORIGINS', { converter: 'array', fallback: [] })
+  static readonly corsOrigins: string[];
+
+  @Envapt('CONFIG_JSON', { converter: 'json', fallback: {} })
+  static readonly config: object;
+
+  @Envapt('API_URL', { converter: 'url', fallback: new URL('http://localhost') })
+  static readonly apiUrl: URL;
+
+  @Envapt('TIMEOUT', { converter: 'time', fallback: 5000 })
+  static readonly timeout: number; // Converts "30s" to 30000ms
+
+  // Instance properties work the same way
+  @Envapt('CACHE_TTL', { converter: 'time', fallback: 3600000 })
+  declare readonly cacheTtl: number; // "1h" becomes 3600000ms
+}
+```
+
+**Available Built-in Converters:**
+
+- `'string'` - String values
+- `'number'` - Numeric values (integers and floats)
+- `'integer'` - Integer values only
+- `'float'` - Float values only
+- `'boolean'` - Boolean values (true/false, yes/no, on/off, 1/0)
+- `'bigint'` - BigInt values for large integers
+- `'symbol'` - Symbol values (creates symbols from string descriptions)
+- `'time'` - Time values (converts "5s", "30m", "2h" to milliseconds)
+- `'json'` - JSON objects/arrays (safe parsing with fallback)
+- `'array'` - Comma-separated string arrays
+- `'url'` - URL objects
+- `'regexp'` - Regular expressions (supports `/pattern/flags` syntax)
+- `'date'` - Date objects (supports ISO strings and timestamps)
+- `'time'` - Values denoting time. Such as 100, 30ms, 5s, 10m, 1.5h. (parsed to ms)
+
+#### Custom Array Converters
+
+For more control over array parsing:
+
+```ts
+class Config extends Envapter {
+  // Basic array (comma-separated strings)
+  @Envapt('TAGS', { converter: 'array', fallback: [] })
+  static readonly tags: string[];
+
+  // Custom delimiter
+  @Envapt('ALLOWED_METHODS', { converter: { delimiter: '|' }, fallback: ['GET'] })
+  declare readonly allowedMethods: string[];
+
+  // Custom delimiter with type conversion
+  @Envapt('RATE_LIMITS', { converter: { delimiter: ',', type: 'number' }, fallback: [100] })
+  declare readonly rateLimits: number[];
+
+  @Envapt('FEATURE_FLAGS', { converter: { delimiter: ';', type: 'boolean' }, fallback: [false] })
+  declare readonly featureFlags: boolean[];
+}
+```
+
+**ArrayConverter Interface:**
+
+- `delimiter: string` - The string used to split array elements
+- `type?: BuiltInConverter` - Optional type to convert each element to (excludes 'array', 'json', and 'regexp')
+
+#### Custom Converters
+
+Transform environment values to any type:
+
+```ts
+class Config extends Envapter {
+  @Envapt('TAGS', {
+    fallback: new Set(['default']),
+    converter: (raw, fallback) => {
+      if (!raw) return fallback;
+      return new Set(raw.split(',').map((s) => s.trim()));
+    }
+  })
+  static readonly tags: Set<string>;
+
+  @Envapt('NOTIFICATION_CHANNELS', {
+    fallback: new Map([['email', 'enabled']]),
+    converter: (raw, fallback) => {
+      if (!raw) return fallback;
+      const map = new Map();
+      raw.split(',').forEach((pair) => {
+        const [key, value] = pair.split(':');
+        map.set(key?.trim(), value?.trim() || 'enabled');
+      });
+      return map;
+    }
+  })
+  declare readonly channels: Map<string, string>;
+}
+```
+
+#### Handling Missing Values
+
+Control what happens when environment variables don't exist:
+
+```ts
+class Config extends Envapter {
+  // Returns undefined if not found
+  @Envapt('OPTIONAL_FEATURE', { fallback: undefined })
+  static readonly optionalFeature: string | undefined;
+
+  // Returns null if not found (no fallback provided)
+  @Envapt('MISSING_CONFIG', { converter: 'string' })
+  static readonly missingConfig: string | null;
+
+  // Uses fallback if not found
+  @Envapt('DEFAULT_THEME', { fallback: 'light' })
+  static readonly defaultTheme: string;
+
+  // Instance properties work the same way
+  @Envapt('LOG_FILE_PATH', { fallback: undefined })
+  declare readonly logFilePath: string | undefined;
+}
+```
+
+### Functional API
+
+```ts
+import { Envapter } from 'envapt';
+
+// Type-specific getters
+const str = Envapter.get('STRING_VAR', 'default');
+const num = Envapter.getNumber('NUMBER_VAR', 42);
+const bool = Envapter.getBoolean('BOOLEAN_VAR', false);
+
+// Instance methods (same API)
+const envapter = new Envapter();
+const value = envapter.get('VAR', 'default');
+```
+
+## Environment Detection
+
+Envapt automatically detects your environment from these variables (in order):
+
+1. `ENVIRONMENT`
+2. `ENV`
+3. `NODE_ENV`
+
+Supported values: `development`, `staging`, `production` (case-sensitive)
+
+### Environment Management
+
+```ts
+import { Envapter, EnvaptEnvironment } from 'envapt';
+
+// Check current environment
+console.log(Envapter.environment); // Environment.Development
+console.log(Envapter.isProduction); // false
+console.log(Envapter.isDevelopment); // true
+console.log(Envapter.isStaging); // false
+
+// Set environment
+Envapter.environment = EnvaptEnvironment.Production;
+Envapter.environment = 'staging'; // string also works
+```
+
+### Multiple .env Files
+
+```ts
+import { resolve } from 'node:path';
+import { Envapter } from 'envapt';
+
+// Load from multiple files
+Envapter.envPaths = [resolve(__dirname, '.env.local'), resolve(__dirname, '.env.production')];
+
+// Or single file
+Envapter.envPaths = resolve(__dirname, '.env.production');
+
+// Or just don't set a path for it to default to .env at the root of your project
+```
+
+## Template Variables
+
+Envapt supports variable interpolation with `${VARIABLE}` syntax:
+
+```env
+DATABASE_HOST=localhost
+DATABASE_PORT=5432
+DATABASE_URL=postgres://${DATABASE_HOST}:${DATABASE_PORT}/mydb
+
+API_VERSION=v1
+API_BASE=https://api.example.com
+API_ENDPOINT=${API_BASE}/${API_VERSION}/users
+```
+
+### Circular Reference Protection
+
+```env
+CIRCULAR_A=${CIRCULAR_B}
+CIRCULAR_B=${CIRCULAR_A}
+```
+
+Circular references are detected and preserved as-is rather than causing infinite loops.
+
+## Advanced Examples
+
+### Complex Configuration
+
+```ts
+import { Envapt, Envapter } from 'envapt';
+
+class AppConfig extends Envapter {
+  // Global settings (static)
+  @Envapt('PORT', 3000)
+  static readonly port: number;
+
+  @Envapt('REQUEST_TIMEOUT', { converter: 'time', fallback: 10000 })
+  static readonly requestTimeout: number; // "5s" -> 5000ms (if env is set to "5s")
+
+  @Envapt('FEATURE_FLAGS', {
+    fallback: new Set(['basic']),
+    converter: (raw, fallback) => {
+      if (!raw) return fallback;
+      return new Set(raw.split(',').map((s) => s.trim()));
+    }
+  })
+  static readonly featureFlags: Set<string>;
+
+  // Service settings (instance)
+  @Envapt('DB_URL', 'sqlite://memory')
+  declare readonly databaseUrl: string;
+
+  @Envapt('CACHE_TTL', { converter: 'time', fallback: 3600000 })
+  declare readonly cacheTtl: number; // "1h" -> 3600000ms
+
+  @Envapt('REDIS_URLS', {
+    fallback: [new URL('redis://localhost:6379')],
+    converter: (raw, fallback) => (raw ? raw.split(',').map((s) => new URL(s)) : fallback)
+  })
+  declare readonly redisUrls: URL[];
+
+  async initialize() {
+    console.log(`App running on port ${AppConfig.port}`);
+    console.log(`Database: ${this.databaseUrl}`);
+    console.log(`Cache TTL: ${this.cacheTtl}ms`);
+  }
+}
+```