Added IP Validation

Author: Kathuria

README.md

@@ -15,7 +15,7 @@ npm install validate-functions
 - **Email Validation**: Ensures that email addresses conform to standard formats.
 - **SSN Validation**: Validates U.S. Social Security Numbers based on predefined rules.
 - **Aadhaar Validation**: Checks the validity of Indian Aadhaar numbers using specific patterns.
-- **Credit Card**: The credit card validation uses the Luhn algorithm to verify the validity of credit card numbers structurally.
-
+- **Credit Card Validation**: The credit card validation uses the Luhn algorithm to verify the validity of credit card numbers structurally.
+- **IP Validation**: IPv4 and IPv6 validation for specififcations. 
 
 Usage Details available at [here](./USAGE_DETAILS.md).

USAGE_DETAILS.md

@@ -35,3 +35,21 @@ import { isValid_Credit_Card } from 'validate-functions/credit-card';
 const creditCardNumber = '4539 1488 0343 6467'; // Example of a valid Visa card number
 console.log(isValid_Credit_Card(creditCardNumber)); // Output: true if valid, false otherwise
 ```
+
+- **isValid_IPv4**
+
+```typescript
+import { isValid_IPv4 } from 'validate-functions/ip';
+
+const ipv4Address = '192.168.1.1';
+console.log(isValid_IPv4(ipv4Address)); // Output: true if valid, false otherwise
+```
+
+- **isValid_IPv6**
+
+```typescript
+import { isValid_IPv6 } from 'validate-functions/ip';
+
+const ipv6Address = '2001:0db8:85a3:0000:0000:8a2e:0370:7334';
+console.log(isValid_IPv6(ipv6Address)); // Output: true if valid, false otherwise
+```

src/__tests__/ip.test.ts

@@ -0,0 +1,65 @@
+import { isValid_IPv4, isValid_IPv6 } from '../ip';
+
+describe('IPv4 Validation', () => {
+  it('should return true for a valid IPv4 address', () => {
+    const validIPv4 = '172.16.254.1';
+    expect(isValid_IPv4(validIPv4)).toBe(true);
+  });
+
+  it('should return false for an invalid IPv4 address', () => {
+    const invalidIPv4 = '256.256.256.256';
+    expect(isValid_IPv4(invalidIPv4)).toBe(false);
+  });
+
+  it('should return false for an incomplete IPv4 address', () => {
+    const incompleteIPv4 = '192.168.1';
+    expect(isValid_IPv4(incompleteIPv4)).toBe(false);
+  });
+
+  it('should return false for a non-numeric IPv4 address', () => {
+    const nonNumericIPv4 = 'abc.def.ghi.jkl';
+    expect(isValid_IPv4(nonNumericIPv4)).toBe(false);
+  });
+
+  it('should return true for edge case IPv4 address 0.0.0.0', () => {
+    const edgeCaseIPv4 = '0.0.0.0';
+    expect(isValid_IPv4(edgeCaseIPv4)).toBe(true);
+  });
+
+  it('should return true for edge case IPv4 address 255.255.255.255', () => {
+    const edgeCaseIPv4 = '255.255.255.255';
+    expect(isValid_IPv4(edgeCaseIPv4)).toBe(true);
+  });
+});
+
+describe('IPv6 Validation', () => {
+  it('should return true for a valid IPv6 address', () => {
+    const validIPv6 = '2001:0db8:85a3:0000:0000:8a2e:0370:7334';
+    expect(isValid_IPv6(validIPv6)).toBe(true);
+  });
+
+  it('should return false for an invalid IPv6 address', () => {
+    const invalidIPv6 = '2001:db8::1:2::3';
+    expect(isValid_IPv6(invalidIPv6)).toBe(false);
+  });
+
+  it('should return false for an incomplete IPv6 address', () => {
+    const incompleteIPv6 = '2001:0db8:85a3:0000:0000:8a2e:0370';
+    expect(isValid_IPv6(incompleteIPv6)).toBe(false);
+  });
+
+  it('should return false for a non-hexadecimal IPv6 address', () => {
+    const nonHexIPv6 = '2001:0db8:85a3:zzzz:0000:8a2e:0370:7334';
+    expect(isValid_IPv6(nonHexIPv6)).toBe(false);
+  });
+
+  it('should return true for edge case IPv6 address ::1 (loopback)', () => {
+    const loopbackIPv6 = '::1';
+    expect(isValid_IPv6(loopbackIPv6)).toBe(true);
+  });
+
+  it('should return true for edge case IPv6 address :: (unspecified)', () => {
+    const unspecifiedIPv6 = '::';
+    expect(isValid_IPv6(unspecifiedIPv6)).toBe(true);
+  });
+});

src/credit-card.ts

@@ -1,6 +1,6 @@
 /**
  * A credit card is essentially a means of borrowing money that is accompanied by interest and sometimes fees.
- * Validation is based on Luhn algorithm 
+ * Validation is based on Luhn algorithm
  * @param cardNumber
  * @returns
  */
@@ -9,7 +9,7 @@ export const isValid_Credit_Card = (cardNumber: string): boolean => {
   let sum = 0;
   let shouldDouble = false;
 
-  if(!sanitized) return false;
+  if (!sanitized) return false;
 
   for (let i = sanitized.length - 1; i >= 0; i--) {
     let digit = parseInt(sanitized[i], 10);

src/ip.ts

@@ -0,0 +1,21 @@
+/**
+ * Validates an IPv4 address.
+ * @param ip - The IPv4 address to validate.
+ * @returns True if the IPv4 address is valid, otherwise false.
+ */
+export const isValid_IPv4 = (ip: string): boolean => {
+  const ipv4Regex =
+    /^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/;
+  return ipv4Regex.test(ip);
+};
+
+/**
+ * Validates an IPv6 address.
+ * @param ip - The IPv6 address to validate.
+ * @returns True if the IPv6 address is valid, otherwise false.
+ */
+export const isValid_IPv6 = (ip: string): boolean => {
+  const ipv6Regex =
+    /^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]|)[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]|)[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]|)[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]|)[0-9]))$/;
+  return ipv6Regex.test(ip);
+};