@periodic/titanium 1.0.0

package/dist/utils/ip.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractClientIp = extractClientIp;
+exports.normalizeIp = normalizeIp;
+exports.getDefaultIdentifier = getDefaultIdentifier;
+/**
+ * Extract client IP address from Express request
+ * Handles various proxy and load balancer scenarios
+ *
+ * Priority:
+ * 1. X-Forwarded-For header (first IP if multiple)
+ * 2. X-Real-IP header
+ * 3. Socket remote address
+ * 4. 'unknown' as fallback
+ *
+ * @param req - Express request object
+ * @returns IP address string
+ */
+function extractClientIp(req) {
+    // X-Forwarded-For can contain multiple IPs (client, proxy1, proxy2)
+    // We want the first one (the original client)
+    const forwardedFor = req.headers["x-forwarded-for"];
+    if (forwardedFor) {
+        const ips = Array.isArray(forwardedFor) ? forwardedFor[0] : forwardedFor;
+        const firstIp = ips.split(",")[0].trim();
+        if (firstIp) {
+            return firstIp;
+        }
+    }
+    // X-Real-IP is set by some proxies (nginx)
+    const realIp = req.headers["x-real-ip"];
+    if (realIp && typeof realIp === "string") {
+        return realIp.trim();
+    }
+    // Direct connection IP
+    const socketIp = req.socket.remoteAddress;
+    if (socketIp) {
+        return socketIp;
+    }
+    // Fallback
+    return "unknown";
+}
+/**
+ * Normalize IP address for consistent key generation
+ * Handles IPv6 to IPv4 mapping
+ *
+ * @param ip - IP address string
+ * @returns Normalized IP address
+ */
+function normalizeIp(ip) {
+    // Convert IPv6-mapped IPv4 address to IPv4
+    // ::ffff:192.168.1.1 -> 192.168.1.1
+    if (ip.startsWith("::ffff:")) {
+        return ip.substring(7);
+    }
+    return ip;
+}
+/**
+ * Extract and normalize client identifier from request
+ *
+ * @param req - Express request object
+ * @returns Normalized IP address
+ */
+function getDefaultIdentifier(req) {
+    const ip = extractClientIp(req);
+    return normalizeIp(ip);
+}
+//# sourceMappingURL=ip.js.map

package/dist/utils/ip.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ip.js","sourceRoot":"","sources":["../../src/utils/ip.ts"],"names":[],"mappings":";;AAeA,0CA0BC;AASD,kCAQC;AAQD,oDAGC;AAnED;;;;;;;;;;;;GAYG;AACH,SAAgB,eAAe,CAAC,GAAY;IAC1C,oEAAoE;IACpE,8CAA8C;IAC9C,MAAM,YAAY,GAAG,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACpD,IAAI,YAAY,EAAE,CAAC;QACjB,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;QACzE,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACzC,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;IAED,2CAA2C;IAC3C,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACxC,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QACzC,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;IACvB,CAAC;IAED,uBAAuB;IACvB,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC;IAC1C,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,WAAW;IACX,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,EAAU;IACpC,2CAA2C;IAC3C,oCAAoC;IACpC,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC7B,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACzB,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,GAAY;IAC/C,MAAM,EAAE,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;IAChC,OAAO,WAAW,CAAC,EAAE,CAAC,CAAC;AACzB,CAAC"}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@periodic/titanium",
+  "version": "1.0.0",
+  "description": "Production-ready Redis-backed rate limiting middleware for Express with TypeScript support, fail-safe design, and flexible configuration",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "jest",
+    "lint": "eslint src --ext .ts",
+    "format": "prettier --write \"src/**/*.ts\""
+  },
+  "keywords": [
+    "rate-limit",
+    "rate-limiting",
+    "ratelimit",
+    "express",
+    "middleware",
+    "redis",
+    "throttle",
+    "api",
+    "ddos",
+    "typescript",
+    "security"
+  ],
+  "author": "Uday Thakur <udaythakurwork@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/thaku7469/periodic-titanium.git"
+  },
+  "bugs": {
+    "url": "https://github.com/thaku7469/periodic-titanium/issues"
+  },
+  "homepage": "https://github.com/thaku7469/periodic-titanium#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "peerDependencies": {
+    "express": "^4.0.0 || ^5.0.0",
+    "redis": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.10.6",
+    "@typescript-eslint/eslint-plugin": "^6.17.0",
+    "@typescript-eslint/parser": "^6.17.0",
+    "eslint": "^8.56.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.1.1",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.3.3"
+  }
+}