mybase 1.1.13 → 1.1.15

package/jest/isLoopbackIP.test.js

@@ -1,32 +1,31 @@
-const { isLoopbackIP } = require('./../mybase'); // adjust the path to mybase.js
+const { isLoopbackIP } = require('./../mybase') // adjust the path to mybase.js
 
 test('should return true for local IPv4', () => {
-    const ip = '127.0.0.1';
-    expect(isLoopbackIP(ip)).toBe(true);
-});
+    const ip = '127.0.0.1'
+    expect(isLoopbackIP(ip)).toBe(true)
+})
 
 test('should return true for local IPv4', () => {
-    const ip = '127.127.127.127';
-    expect(isLoopbackIP(ip)).toBe(true);
-});
-
+    const ip = '127.127.127.127'
+    expect(isLoopbackIP(ip)).toBe(true)
+})
 
 test('should return true for local IPv6', () => {
-    const ip = '::1';
-    expect(isLoopbackIP(ip)).toBe(true);
-});
+    const ip = '::1'
+    expect(isLoopbackIP(ip)).toBe(true)
+})
 
 test('should return null for non-local IPv4', () => {
-    const ip = '8.8.8.8';
-    expect(isLoopbackIP(ip)).toBe(null);
-});
+    const ip = '8.8.8.8'
+    expect(isLoopbackIP(ip)).toBe(null)
+})
 
 test('should return null for non-local IPv6', () => {
-    const ip = '2001:4860:4860::8888';
-    expect(isLoopbackIP(ip)).toBe(null);
-});
+    const ip = '2001:4860:4860::8888'
+    expect(isLoopbackIP(ip)).toBe(null)
+})
 
 test('should return false for invalid IP', () => {
-    const ip = 'invalid';
-    expect(isLoopbackIP(ip)).toBe(false);
-});
+    const ip = 'invalid'
+    expect(isLoopbackIP(ip)).toBe(false)
+})

package/jest.config.js

@@ -2,4 +2,5 @@
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
+  testTimeout: 15000,
 };

package/mybase.js

@@ -6,7 +6,6 @@ const fs = require('fs')
 const path = require('path')
 const net = require('net')
 const chalk = require('chalk')
-const punycode = require('punycode');
 const _validURL = require('@7c/validurl')
 const validator = require('validator')
 const sha512 = require('js-sha512')
@@ -91,9 +90,8 @@ function randomHPassword(length=10) {
     let plain = randomString(length)
     return sha512(plain)
 }
-function validEmail_old(email) { return (/^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$/.test(email)) }
 
-function validEmail(email) { 
+function validEmail(email) {  //! ported
     if (typeof email==='string')
         return validator.isEmail(email) // validator needs a string
     return false
@@ -637,11 +635,11 @@ function ensureProperty(target, propsString, defaultValue = false, debug = false
 
 
 
-function int2ip (ipInt) {
+function int2ip (ipInt) { // ported into IPAddress
     return ( (ipInt>>>24) +'.' + (ipInt>>16 & 255) +'.' + (ipInt>>8 & 255) +'.' + (ipInt & 255) );
 }
 
-function ip2int(ip) {
+function ip2int(ip) { // ported into IPAddress
     return ip.split('.').reduce(function(ipInt, octet) { return (ipInt<<8) + parseInt(octet, 10)}, 0) >>> 0;
 }
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "mybase",
-  "version": "1.1.13",
+  "version": "1.1.15",
   "description": "",
   "main": "mybase.js",
   "scripts": {
-    "test": "jest"
+    "test": "jest --forceExit --verbose"
   },
   "author": "",
   "license": "ISC",
@@ -25,8 +25,10 @@
   "devDependencies": {
     "@jest/globals": "^29.7.0",
     "@types/debug": "^4.1.12",
+    "@types/ip6addr": "^0.2.6",
     "@types/jest": "^29.5.11",
     "@types/node": "^20.11.5",
+    "@types/validator": "^13.11.8",
     "chai": "^4.2.0",
     "jest": "^29.7.0",
     "mocha": "^8.2.1",

package/ts/funcs/isLoopbackIP.d.ts

@@ -0,0 +1 @@
+export declare function isLoopbackIP(ip: string): boolean;

package/ts/funcs/isLoopbackIP.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isLoopbackIP = void 0;
+const ip6addr_1 = __importDefault(require("ip6addr"));
+const net_1 = __importDefault(require("net"));
+const local_network_cidrs = [ip6addr_1.default.createCIDR('127.0.0.0/8'),
+    ip6addr_1.default.createCIDR('::1/128')];
+function normalizeIp(ip) {
+    // also support ipv6
+    if (net_1.default.isIP(ip) === 0)
+        return '';
+    if (net_1.default.isIPv6(ip))
+        return ip.toLowerCase().replace(/^::ffff:/, '');
+    return ip;
+}
+function isLoopbackIP(ip) {
+    ip = normalizeIp(ip);
+    if (net_1.default.isIP(ip) === 0)
+        return false;
+    try {
+        // speed optimized
+        let ipVersion = net_1.default.isIPv4(ip) ? 'ipv4' : 'ipv6';
+        for (let cidr of local_network_cidrs) {
+            let first = cidr.first();
+            if (first.kind() !== ipVersion)
+                continue;
+            if (cidr.contains(ip))
+                return true;
+        }
+        return false;
+    }
+    catch (err) {
+        console.log(err);
+    }
+    return false;
+}
+exports.isLoopbackIP = isLoopbackIP;

package/ts/funcs/isLoopbackIP.test.ts

@@ -0,0 +1,69 @@
+import { randomIP } from './randomIP';
+import { isLoopbackIP } from './isLoopbackIP';
+
+describe('isLoopbackIP', () => {
+    test('should return true for loopback IPv4 address', () => {
+        expect(isLoopbackIP('127.0.0.1')).toBe(true);
+    });
+
+    test('should return true for loopback IPv6 address', () => {
+        expect(isLoopbackIP('::1')).toBe(true);
+    });
+
+    test('should return false for non-loopback IPv4 address', () => {
+        expect(isLoopbackIP('192.168.0.1')).toBe(false);
+    });
+
+    test('should return false for non-loopback IPv6 address', () => {
+        expect(isLoopbackIP('2001:0db8:85a3:0000:0000:8a2e:0370:7334')).toBe(false);
+    });
+
+    test('should return false for invalid IP address', () => {
+        expect(isLoopbackIP('invalid')).toBe(false);
+    });
+
+    test('should return true for local IPv4', () => {
+        const ip = '127.0.0.1'
+        expect(isLoopbackIP(ip)).toBe(true)
+    })
+
+    test('should return true for local IPv4', () => {
+        const ip = '127.2.0.1'
+        expect(isLoopbackIP(ip)).toBe(true)
+    })
+
+    test('should return true for local IPv4', () => {
+        const ip = '127.255.0.1'
+        expect(isLoopbackIP(ip)).toBe(true)
+    })
+
+    test('should return true for local IPv4', () => {
+        const ip = '127.127.127.127'
+        expect(isLoopbackIP(ip)).toBe(true)
+    })
+
+    test('should return true for local IPv6', () => {
+        const ip = '::1'
+        expect(isLoopbackIP(ip)).toBe(true)
+    })
+
+    test('should return null for non-local IPv4', () => {
+        const ip = '8.8.8.8'
+        expect(isLoopbackIP(ip)).toBe(false)
+    })
+
+    test('should return null for non-local IPv6', () => {
+        const ip = '2001:4860:4860::8888'
+        expect(isLoopbackIP(ip)).toBe(false)
+    })
+
+    test('should return false for invalid IP', () => {
+        const ip = 'invalid'
+        expect(isLoopbackIP(ip)).toBe(false)
+    })
+
+    test('random ips should not be Loopback', () => {
+        for(let i=0;i<100;i++)
+            expect(isLoopbackIP(randomIP())).toBe(false)
+    })
+});

package/ts/funcs/isLoopbackIP.ts

@@ -0,0 +1,33 @@
+import ip6addr from 'ip6addr'
+import net from 'net'
+
+const local_network_cidrs = [ip6addr.createCIDR('127.0.0.0/8')
+        ,ip6addr.createCIDR('::1/128')]
+
+
+function normalizeIp(ip:string):string {
+    // also support ipv6
+    if (net.isIP(ip) === 0) return ''
+    if (net.isIPv6(ip)) return ip.toLowerCase().replace(/^::ffff:/, '')
+    return ip
+}
+
+
+export function isLoopbackIP(ip:string) : boolean {
+    ip=normalizeIp(ip)
+    if (net.isIP(ip) === 0) return false
+    try {
+        // speed optimized
+        let ipVersion = net.isIPv4(ip) ? 'ipv4' : 'ipv6'
+        for (let cidr of local_network_cidrs) {
+            let first = cidr.first()
+            if (first.kind() !== ipVersion) continue
+            if (cidr.contains(ip))
+                return true
+        }
+        return false
+    } catch (err) {
+        console.log(err)
+    }
+    return false
+}

package/ts/funcs/randomTCPPort.test.ts

@@ -59,4 +59,4 @@ describe("randomTCPPort", () => {
     expect(port).toBe(false);
   });
 
-});
+})

package/ts/funcs/validEmail.d.ts

@@ -0,0 +1 @@
+export declare function validEmail(email: string): boolean;

package/ts/funcs/validEmail.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validEmail = void 0;
+const validator_1 = __importDefault(require("validator"));
+function validEmail(email) {
+    if (typeof email === 'string')
+        return validator_1.default.isEmail(email); // validator needs a string
+    return false;
+    // giving up old style, was not reliable
+    // taken from https://www.w3resource.com/javascript/form/email-validation.php
+    // strange looking emails might be indeed valid
+    // check https://www.w3resource.com/javascript/form/example-javascript-form-validation-email-REC-2822.html
+    if (typeof email === 'string')
+        email = email.toLowerCase().trim();
+    return (/(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])/).test(email);
+}
+exports.validEmail = validEmail;

package/ts/funcs/validEmail.test.js

@@ -0,0 +1,31 @@
+const { validEmail } = require('./validEmail')
+
+// since we use validator, we do not need to test it further
+// detailed tests with millions of emails are in tests/ folder which is .gitignored
+
+describe('validEmail', () => {
+    test('should return true for a valid email', () => {
+        const email = 'test@example.com'
+        expect(validEmail(email)).toBe(true)
+    })
+
+    test('should return false for an invalid email', () => {
+        const email = 'invalidemail'
+        expect(validEmail(email)).toBe(false)
+    })
+
+    test('should return false for an empty email', () => {
+        const email = ''
+        expect(validEmail(email)).toBe(false)
+    })
+
+    test('should return false for a null email', () => {
+        const email = null
+        expect(validEmail(email)).toBe(false)
+    })
+
+    test('should return false for a non-string email', () => {
+        const email = 12345
+        expect(validEmail(email)).toBe(false)
+    })
+})

package/ts/funcs/validEmail.ts

@@ -0,0 +1,13 @@
+import validator from 'validator'
+
+export function validEmail(email:string) { 
+    if (typeof email==='string')
+        return validator.isEmail(email) // validator needs a string
+    return false
+    // giving up old style, was not reliable
+    // taken from https://www.w3resource.com/javascript/form/email-validation.php
+    // strange looking emails might be indeed valid
+    // check https://www.w3resource.com/javascript/form/example-javascript-form-validation-email-REC-2822.html
+    if (typeof email==='string') email=email.toLowerCase().trim()
+    return (/(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])/).test(email)
+}

package/ts/index.d.ts

@@ -15,3 +15,5 @@ export * from "./funcs/ip2int";
 export * from "./funcs/int2ip";
 export * from "./funcs/randomIP6";
 export * from "./funcs/randomTCPPort";
+export * from "./funcs/validEmail";
+export * from "./funcs/isLoopbackIP";

package/ts/index.js

@@ -31,3 +31,5 @@ __exportStar(require("./funcs/ip2int"), exports);
 __exportStar(require("./funcs/int2ip"), exports);
 __exportStar(require("./funcs/randomIP6"), exports);
 __exportStar(require("./funcs/randomTCPPort"), exports);
+__exportStar(require("./funcs/validEmail"), exports);
+__exportStar(require("./funcs/isLoopbackIP"), exports);

package/ts/index.ts

@@ -15,4 +15,6 @@ export * from "./funcs/ip2int"
 export * from "./funcs/int2ip"
 export * from "./funcs/randomIP6"
 export * from "./funcs/randomTCPPort"
+export * from "./funcs/validEmail"
+export * from "./funcs/isLoopbackIP"