@revolugo/common 7.4.2-alpha.0 → 7.4.2-alpha.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revolugo/common",
-  "version": "7.4.2-alpha.0",
+  "version": "7.4.2-alpha.10",
   "private": false,
   "description": "Revolugo common",
   "author": "Revolugo",

package/src/utils/get-user-ip-address.test.ts

@@ -0,0 +1,62 @@
+import { describe, expect, test } from 'vitest'
+
+import { getUserIpAddress } from './get-user-ip-address.ts'
+
+describe('getUserIpAddress', () => {
+  test('UT-1a: extracts first IP from x-forwarded-for (comma-separated)', () => {
+    const headers = new Headers({
+      'x-forwarded-for': '203.0.113.1, 70.41.3.18, 150.172.238.178',
+    })
+    expect(getUserIpAddress(headers)).toBe('203.0.113.1')
+  })
+
+  test('UT-1a: extracts single IP from x-forwarded-for', () => {
+    const headers = new Headers({ 'x-forwarded-for': '203.0.113.1' })
+    expect(getUserIpAddress(headers)).toBe('203.0.113.1')
+  })
+
+  test('UT-1b: extracts IP from cf-connecting-ip', () => {
+    const headers = new Headers({ 'cf-connecting-ip': '198.51.100.1' })
+    expect(getUserIpAddress(headers)).toBe('198.51.100.1')
+  })
+
+  test('UT-1c: extracts IP from x-real-ip', () => {
+    const headers = new Headers({ 'x-real-ip': '198.51.100.2' })
+    expect(getUserIpAddress(headers)).toBe('198.51.100.2')
+  })
+
+  test('UT-1c: extracts IP from true-client-ip', () => {
+    const headers = new Headers({ 'true-client-ip': '198.51.100.3' })
+    expect(getUserIpAddress(headers)).toBe('198.51.100.3')
+  })
+
+  test('UT-1c: extracts IP from x-client-ip', () => {
+    const headers = new Headers({ 'x-client-ip': '198.51.100.4' })
+    expect(getUserIpAddress(headers)).toBe('198.51.100.4')
+  })
+
+  test('UT-1a: x-forwarded-for takes priority over other headers', () => {
+    const headers = new Headers({
+      'cf-connecting-ip': '198.51.100.1',
+      'x-forwarded-for': '203.0.113.1',
+    })
+    expect(getUserIpAddress(headers)).toBe('203.0.113.1')
+  })
+
+  test('UT-1d: returns null when no IP headers present', () => {
+    const headers = new Headers({ 'content-type': 'application/json' })
+    expect(getUserIpAddress(headers)).toBeNull()
+  })
+
+  test('UT-1e: extracts IP from Forwarded header (RFC 7239)', () => {
+    const headers = new Headers({
+      forwarded: 'for=192.0.2.60;proto=http;by=203.0.113.43',
+    })
+    expect(getUserIpAddress(headers)).toBe('192.0.2.60')
+  })
+
+  test('UT-1e: extracts quoted IP from Forwarded header', () => {
+    const headers = new Headers({ forwarded: 'for="192.0.2.60"' })
+    expect(getUserIpAddress(headers)).toBe('192.0.2.60')
+  })
+})

package/src/utils/get-user-ip-address.ts

@@ -0,0 +1,28 @@
+const IP_HEADERS = [
+  'x-forwarded-for',
+  'cf-connecting-ip',
+  'x-real-ip',
+  'true-client-ip',
+  'x-client-ip',
+] as const
+
+export function getUserIpAddress(headers: Headers): string | null {
+  for (const header of IP_HEADERS) {
+    const value = headers.get(header)
+    if (value) {
+      return header === 'x-forwarded-for'
+        ? (value.split(',')[0]?.trim() ?? null)
+        : value
+    }
+  }
+
+  const forwarded = headers.get('forwarded')
+  if (forwarded) {
+    const match = /for=["']?([^;"',\s]+)/u.exec(forwarded)
+    if (match?.[1]) {
+      return match[1]
+    }
+  }
+
+  return null
+}

package/src/utils/index.ts

@@ -26,6 +26,7 @@ export * from './get-random-element-from-array.ts'
 export * from './get-random-hex-color.ts'
 export * from './get-random-int.ts'
 export * from './get-sanitized-room-count.ts'
+export * from './get-user-ip-address.ts'
 export * from './group-by.ts'
 export * from './images.ts'
 export * from './is-empty.ts'