zero-http 0.2.4 → 0.3.1

package/lib/env/index.js

@@ -0,0 +1,440 @@
+/**
+ * @module env
+ * @description Zero-dependency typed environment variable system.
+ *              Loads `.env` files, validates against a typed schema, and
+ *              exposes a fast accessor with built-in type coercion.
+ *
+ *              Supports: string, number, boolean, integer, array, json, url, port, enum.
+ *              Multi-environment: `.env`, `.env.local`, `.env.{NODE_ENV}`, `.env.{NODE_ENV}.local`.
+ *
+ * @example
+ *   const { env } = require('zero-http');
+ *
+ *   env.load({
+ *       PORT:            { type: 'port',    default: 3000 },
+ *       DATABASE_URL:    { type: 'string',  required: true },
+ *       DEBUG:           { type: 'boolean', default: false },
+ *       ALLOWED_ORIGINS: { type: 'array',   separator: ',' },
+ *       LOG_LEVEL:       { type: 'enum',    values: ['debug','info','warn','error'], default: 'info' },
+ *   });
+ *
+ *   env.PORT          // => 3000 (number)
+ *   env('PORT')       // => 3000
+ *   env.DEBUG         // => false (boolean)
+ *   env.require('DATABASE_URL')  // throws if missing
+ */
+const fs = require('fs');
+const path = require('path');
+
+// ═══════════════════════════════════════════════════════════
+//  .env file parser
+// ═══════════════════════════════════════════════════════════
+
+/**
+ * Parse a `.env` file string into key-value pairs.
+ * Supports `#` comments, single/double/backtick quotes, multiline values,
+ * inline comments, interpolation `${VAR}`, and `export` prefix.
+ *
+ * @param {string} src - Raw file contents.
+ * @returns {Object<string, string>} Parsed key-value pairs.
+ */
+function parse(src)
+{
+    const result = {};
+    const lines = src.replace(/\r\n?/g, '\n').split('\n');
+
+    let i = 0;
+    while (i < lines.length)
+    {
+        let line = lines[i].trim();
+        i++;
+
+        // Skip comments and blank lines
+        if (!line || line.startsWith('#')) continue;
+
+        // Strip optional `export ` prefix
+        if (line.startsWith('export ')) line = line.slice(7).trim();
+
+        const eqIdx = line.indexOf('=');
+        if (eqIdx === -1) continue;
+
+        const key = line.slice(0, eqIdx).trim();
+        let value = line.slice(eqIdx + 1).trim();
+
+        // Validate key name — only word chars + dots
+        if (!/^[\w.]+$/.test(key)) continue;
+
+        // Quoted values
+        const q = value[0];
+        if ((q === '"' || q === "'" || q === '`') && value.endsWith(q) && value.length >= 2)
+        {
+            value = value.slice(1, -1);
+        }
+        else if (q === '"' || q === "'" || q === '`')
+        {
+            // Multiline — read until closing quote
+            let multiline = value.slice(1);
+            while (i < lines.length)
+            {
+                const nextLine = lines[i];
+                i++;
+                if (nextLine.trimEnd().endsWith(q))
+                {
+                    multiline += '\n' + nextLine.trimEnd().slice(0, -1);
+                    break;
+                }
+                multiline += '\n' + nextLine;
+            }
+            value = multiline;
+        }
+        else
+        {
+            // Unquoted — strip inline comment
+            const hashIdx = value.indexOf(' #');
+            if (hashIdx !== -1) value = value.slice(0, hashIdx).trim();
+        }
+
+        // Variable interpolation: ${VAR} → process.env.VAR or already-parsed value
+        value = value.replace(/\$\{([^}]+)\}/g, (_, name) =>
+        {
+            return result[name] || process.env[name] || '';
+        });
+
+        result[key] = value;
+    }
+
+    return result;
+}
+
+// ═══════════════════════════════════════════════════════════
+//  Type coercion
+// ═══════════════════════════════════════════════════════════
+
+/**
+ * Coerce a string value to the specified type.
+ *
+ * @param {string}  raw        - Raw string value.
+ * @param {object}  fieldDef   - Schema field definition.
+ * @param {string}  key        - Variable name (for error messages).
+ * @returns {*} Coerced value.
+ * @throws {Error} When the value cannot be coerced or fails validation.
+ */
+function coerce(raw, fieldDef, key)
+{
+    const type = fieldDef.type || 'string';
+
+    switch (type)
+    {
+        case 'string':
+        {
+            const val = String(raw);
+            if (fieldDef.min !== undefined && val.length < fieldDef.min)
+                throw new Error(`env "${key}" must be at least ${fieldDef.min} characters`);
+            if (fieldDef.max !== undefined && val.length > fieldDef.max)
+                throw new Error(`env "${key}" must be at most ${fieldDef.max} characters`);
+            if (fieldDef.match && !fieldDef.match.test(val))
+                throw new Error(`env "${key}" does not match pattern ${fieldDef.match}`);
+            return val;
+        }
+        case 'number':
+        {
+            const val = Number(raw);
+            if (isNaN(val)) throw new Error(`env "${key}" must be a number, got "${raw}"`);
+            if (fieldDef.min !== undefined && val < fieldDef.min)
+                throw new Error(`env "${key}" must be >= ${fieldDef.min}`);
+            if (fieldDef.max !== undefined && val > fieldDef.max)
+                throw new Error(`env "${key}" must be <= ${fieldDef.max}`);
+            return val;
+        }
+        case 'integer':
+        {
+            const val = parseInt(raw, 10);
+            if (isNaN(val)) throw new Error(`env "${key}" must be an integer, got "${raw}"`);
+            if (fieldDef.min !== undefined && val < fieldDef.min)
+                throw new Error(`env "${key}" must be >= ${fieldDef.min}`);
+            if (fieldDef.max !== undefined && val > fieldDef.max)
+                throw new Error(`env "${key}" must be <= ${fieldDef.max}`);
+            return val;
+        }
+        case 'port':
+        {
+            const val = parseInt(raw, 10);
+            if (isNaN(val) || val < 0 || val > 65535)
+                throw new Error(`env "${key}" must be a valid port (0-65535), got "${raw}"`);
+            return val;
+        }
+        case 'boolean':
+        {
+            const lower = String(raw).toLowerCase().trim();
+            if (['true', '1', 'yes', 'on'].includes(lower)) return true;
+            if (['false', '0', 'no', 'off', ''].includes(lower)) return false;
+            throw new Error(`env "${key}" must be a boolean, got "${raw}"`);
+        }
+        case 'array':
+        {
+            const sep = fieldDef.separator || ',';
+            return String(raw).split(sep).map(s => s.trim()).filter(Boolean);
+        }
+        case 'json':
+        {
+            try { return JSON.parse(raw); }
+            catch (e) { throw new Error(`env "${key}" must be valid JSON: ${e.message}`); }
+        }
+        case 'url':
+        {
+            try { new URL(raw); return raw; }
+            catch (e) { throw new Error(`env "${key}" must be a valid URL, got "${raw}"`); }
+        }
+        case 'enum':
+        {
+            const values = fieldDef.values || [];
+            if (!values.includes(raw))
+                throw new Error(`env "${key}" must be one of [${values.join(', ')}], got "${raw}"`);
+            return raw;
+        }
+        default:
+            return raw;
+    }
+}
+
+// ═══════════════════════════════════════════════════════════
+//  Env store
+// ═══════════════════════════════════════════════════════════
+
+/** @type {Object<string, *>} Typed/validated values store */
+const _store = {};
+
+/** @type {Object<string, object>} Schema definitions */
+let _schema = null;
+
+/** @type {boolean} */
+let _loaded = false;
+
+/**
+ * Load environment variables from `.env` files and validate against a typed schema.
+ *
+ * Files are loaded in precedence order (later overrides earlier):
+ * 1. `.env` — shared defaults
+ * 2. `.env.local` — local overrides (gitignored)
+ * 3. `.env.{NODE_ENV}` — environment-specific  (e.g. `.env.production`)
+ * 4. `.env.{NODE_ENV}.local` — env-specific local overrides
+ *
+ * Process environment variables (`process.env`) always take precedence.
+ *
+ * @param {Object<string, object>} [schema] - Typed schema definition.
+ * @param {object} [options]
+ * @param {string} [options.path]  - Custom directory to load from (default: `process.cwd()`).
+ * @param {boolean} [options.override=false] - Override `process.env` with file values.
+ * @returns {Object<string, *>} The validated env store.
+ *
+ * @throws {Error} On validation failures (missing required vars, bad types, etc.).
+ */
+function load(schema, options = {})
+{
+    const dir = options.path || process.cwd();
+    const nodeEnv = process.env.NODE_ENV || 'development';
+
+    // Load files in precedence order
+    const files = [
+        '.env',
+        '.env.local',
+        `.env.${nodeEnv}`,
+        `.env.${nodeEnv}.local`,
+    ];
+
+    const raw = {};
+
+    for (const file of files)
+    {
+        const filePath = path.resolve(dir, file);
+        try
+        {
+            if (fs.existsSync(filePath))
+            {
+                const content = fs.readFileSync(filePath, 'utf8');
+                Object.assign(raw, parse(content));
+            }
+        }
+        catch (e) { /* silently skip unreadable files */ }
+    }
+
+    // Process.env always wins
+    const merged = {};
+    if (schema)
+    {
+        _schema = schema;
+        for (const key of Object.keys(schema))
+        {
+            if (process.env[key] !== undefined) merged[key] = process.env[key];
+            else if (raw[key] !== undefined) merged[key] = raw[key];
+        }
+    }
+    else
+    {
+        // No schema — load everything
+        Object.assign(merged, raw);
+        for (const key of Object.keys(raw))
+        {
+            if (process.env[key] !== undefined) merged[key] = process.env[key];
+        }
+    }
+
+    // If override is true, write file values into process.env
+    if (options.override)
+    {
+        for (const [k, v] of Object.entries(raw))
+        {
+            if (process.env[k] === undefined) process.env[k] = v;
+        }
+    }
+
+    // Validate and coerce
+    const errors = [];
+
+    if (schema)
+    {
+        for (const [key, def] of Object.entries(schema))
+        {
+            const rawVal = merged[key];
+
+            if (rawVal === undefined || rawVal === '')
+            {
+                if (def.required)
+                {
+                    errors.push(`env "${key}" is required but not set`);
+                    continue;
+                }
+                if (def.default !== undefined)
+                {
+                    _store[key] = typeof def.default === 'function' ? def.default() : def.default;
+                }
+                else
+                {
+                    _store[key] = undefined;
+                }
+                continue;
+            }
+
+            try
+            {
+                _store[key] = coerce(rawVal, def, key);
+            }
+            catch (e)
+            {
+                errors.push(e.message);
+            }
+        }
+    }
+    else
+    {
+        // No schema — store raw strings
+        Object.assign(_store, merged);
+    }
+
+    if (errors.length > 0)
+    {
+        throw new Error('Environment validation failed:\n  • ' + errors.join('\n  • '));
+    }
+
+    _loaded = true;
+    return _store;
+}
+
+/**
+ * Get a typed environment variable.
+ * Can also be called as `env(key)`.
+ *
+ * @param {string} key - Variable name.
+ * @returns {*} The typed value.
+ */
+function get(key)
+{
+    if (_store.hasOwnProperty(key)) return _store[key];
+    return process.env[key];
+}
+
+/**
+ * Get a required environment variable. Throws if missing.
+ *
+ * @param {string} key - Variable name.
+ * @returns {*} The typed value.
+ * @throws {Error} If the variable is not set.
+ */
+function require_(key)
+{
+    const val = get(key);
+    if (val === undefined || val === null || val === '')
+    {
+        throw new Error(`Required environment variable "${key}" is not set`);
+    }
+    return val;
+}
+
+/**
+ * Check if a variable is set (not undefined).
+ *
+ * @param {string} key - Variable name.
+ * @returns {boolean}
+ */
+function has(key)
+{
+    return _store.hasOwnProperty(key) || process.env.hasOwnProperty(key);
+}
+
+/**
+ * Get all loaded values as a plain object.
+ *
+ * @returns {Object<string, *>}
+ */
+function all()
+{
+    return { ..._store };
+}
+
+/**
+ * Reset the env store (useful for testing).
+ */
+function reset()
+{
+    for (const k of Object.keys(_store)) delete _store[k];
+    _schema = null;
+    _loaded = false;
+}
+
+// ═══════════════════════════════════════════════════════════
+//  Proxy-based accessor — env.PORT, env('PORT'), env.get('PORT')
+// ═══════════════════════════════════════════════════════════
+
+/**
+ * The env function — callable as `env(key)` or `env.key`.
+ *
+ * @param {string} key
+ * @returns {*}
+ */
+function envFn(key)
+{
+    return get(key);
+}
+
+// Attach methods
+envFn.load = load;
+envFn.get = get;
+envFn.require = require_;
+envFn.has = has;
+envFn.all = all;
+envFn.reset = reset;
+envFn.parse = parse;
+
+// Proxy for dotenv.PORT style access
+const envProxy = new Proxy(envFn, {
+    get(target, prop)
+    {
+        // Return own methods first
+        if (prop in target) return target[prop];
+        // Then check the store
+        if (typeof prop === 'string') return get(prop);
+        return undefined;
+    },
+});
+
+module.exports = envProxy;

package/lib/errors.js

@@ -0,0 +1,231 @@
+/**
+ * @module errors
+ * @description HTTP error classes with status codes, error codes, and structured details.
+ *              Every error extends HttpError which carries a statusCode, code, and optional details.
+ */
+
+// --- Status Text Map ---------------------------------------------
+
+const STATUS_TEXT = {
+    400: 'Bad Request',
+    401: 'Unauthorized',
+    402: 'Payment Required',
+    403: 'Forbidden',
+    404: 'Not Found',
+    405: 'Method Not Allowed',
+    406: 'Not Acceptable',
+    408: 'Request Timeout',
+    409: 'Conflict',
+    410: 'Gone',
+    413: 'Payload Too Large',
+    415: 'Unsupported Media Type',
+    418: "I'm a Teapot",
+    422: 'Unprocessable Entity',
+    429: 'Too Many Requests',
+    500: 'Internal Server Error',
+    501: 'Not Implemented',
+    502: 'Bad Gateway',
+    503: 'Service Unavailable',
+    504: 'Gateway Timeout',
+};
+
+// --- Base HttpError ----------------------------------------------
+
+class HttpError extends Error
+{
+    /**
+     * @param {number} statusCode - HTTP status code.
+     * @param {string} [message]  - Human-readable message.
+     * @param {object} [opts]
+     * @param {string} [opts.code]    - Machine-readable error code (e.g. 'VALIDATION_FAILED').
+     * @param {*}      [opts.details] - Extra data (field errors, debug info, etc.).
+     */
+    constructor(statusCode, message, opts = {})
+    {
+        super(message || STATUS_TEXT[statusCode] || 'Error');
+        this.name = this.constructor.name;
+        this.statusCode = statusCode;
+        this.code = opts.code || this._defaultCode();
+        if (opts.details !== undefined) this.details = opts.details;
+        Error.captureStackTrace(this, this.constructor);
+    }
+
+    /** @private */
+    _defaultCode()
+    {
+        return (STATUS_TEXT[this.statusCode] || 'ERROR')
+            .toUpperCase()
+            .replace(/[^A-Z0-9]+/g, '_')
+            .replace(/(^_|_$)/g, '');
+    }
+
+    /**
+     * Serialize for JSON responses.
+     * @returns {{ error: string, code: string, statusCode: number, details?: * }}
+     */
+    toJSON()
+    {
+        const obj = { error: this.message, code: this.code, statusCode: this.statusCode };
+        if (this.details !== undefined) obj.details = this.details;
+        return obj;
+    }
+}
+
+// --- Specific Error Classes --------------------------------------
+
+class BadRequestError extends HttpError
+{
+    constructor(message, opts) { super(400, message, opts); }
+}
+
+class UnauthorizedError extends HttpError
+{
+    constructor(message, opts) { super(401, message, opts); }
+}
+
+class ForbiddenError extends HttpError
+{
+    constructor(message, opts) { super(403, message, opts); }
+}
+
+class NotFoundError extends HttpError
+{
+    constructor(message, opts) { super(404, message, opts); }
+}
+
+class MethodNotAllowedError extends HttpError
+{
+    constructor(message, opts) { super(405, message, opts); }
+}
+
+class ConflictError extends HttpError
+{
+    constructor(message, opts) { super(409, message, opts); }
+}
+
+class GoneError extends HttpError
+{
+    constructor(message, opts) { super(410, message, opts); }
+}
+
+class PayloadTooLargeError extends HttpError
+{
+    constructor(message, opts) { super(413, message, opts); }
+}
+
+class UnprocessableEntityError extends HttpError
+{
+    constructor(message, opts) { super(422, message, opts); }
+}
+
+/**
+ * Validation error with field-level details.
+ */
+class ValidationError extends HttpError
+{
+    /**
+     * @param {string}         [message]  - Summary message.
+     * @param {object|Array}   [errors]   - Field errors, e.g. { email: 'required', age: 'must be >= 18' }.
+     * @param {object}         [opts]
+     */
+    constructor(message, errors, opts = {})
+    {
+        super(422, message || 'Validation Failed', { code: 'VALIDATION_FAILED', ...opts, details: errors });
+        this.errors = errors || {};
+    }
+}
+
+class TooManyRequestsError extends HttpError
+{
+    constructor(message, opts) { super(429, message, opts); }
+}
+
+class InternalError extends HttpError
+{
+    constructor(message, opts) { super(500, message, opts); }
+}
+
+class NotImplementedError extends HttpError
+{
+    constructor(message, opts) { super(501, message, opts); }
+}
+
+class BadGatewayError extends HttpError
+{
+    constructor(message, opts) { super(502, message, opts); }
+}
+
+class ServiceUnavailableError extends HttpError
+{
+    constructor(message, opts) { super(503, message, opts); }
+}
+
+// --- Factory -----------------------------------------------------
+
+/**
+ * Create an HttpError by status code.
+ *
+ * @param {number} statusCode
+ * @param {string} [message]
+ * @param {object} [opts]
+ * @returns {HttpError}
+ *
+ * @example
+ *   throw createError(404, 'User not found');
+ *   throw createError(422, 'Invalid input', { details: { email: 'required' } });
+ */
+function createError(statusCode, message, opts)
+{
+    const map = {
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        405: MethodNotAllowedError,
+        409: ConflictError,
+        410: GoneError,
+        413: PayloadTooLargeError,
+        422: UnprocessableEntityError,
+        429: TooManyRequestsError,
+        500: InternalError,
+        501: NotImplementedError,
+        502: BadGatewayError,
+        503: ServiceUnavailableError,
+    };
+
+    const Cls = map[statusCode];
+    if (Cls) return new Cls(message, opts);
+    return new HttpError(statusCode, message, opts);
+}
+
+/**
+ * Check if a value is an HttpError (or duck-typed equivalent).
+ * @param {*} err
+ * @returns {boolean}
+ */
+function isHttpError(err)
+{
+    if (!err || !(err instanceof Error)) return false;
+    return err instanceof HttpError || typeof err.statusCode === 'number';
+}
+
+module.exports = {
+    HttpError,
+    BadRequestError,
+    UnauthorizedError,
+    ForbiddenError,
+    NotFoundError,
+    MethodNotAllowedError,
+    ConflictError,
+    GoneError,
+    PayloadTooLargeError,
+    UnprocessableEntityError,
+    ValidationError,
+    TooManyRequestsError,
+    InternalError,
+    NotImplementedError,
+    BadGatewayError,
+    ServiceUnavailableError,
+    createError,
+    isHttpError,
+};