mybase 1.1.15 → 1.1.17

package/mybase.js

@@ -14,8 +14,10 @@ const ip6addr = require('ip6addr')
 const private_network_cidrs = [ip6addr.createCIDR('10.0.0.0/8')
             ,ip6addr.createCIDR('172.16.0.0/12')
             ,ip6addr.createCIDR('192.168.0.0/16')
-            ,ip6addr.createCIDR('fd00::/8')
+            ,ip6addr.createCIDR('fd00::/8'), // Reserved by IETF for future use, but not currently in active use.
+            ,ip6addr.createCIDR('fc00::/8'), // The range currently in use for local communications within a site or organization.
         ]
+
 const local_network_cidrs = [ip6addr.createCIDR('127.0.0.0/8')
         ,ip6addr.createCIDR('::1/128')]
 
@@ -47,7 +49,7 @@ function normalizeIp(ip) {
 }
 
 
-function isLoopbackIP(ip) {
+function isLoopbackIP(ip) { // ported
     ip=normalizeIp(ip)
     if (net.isIP(ip) === 0) return false
     try {
@@ -66,13 +68,14 @@ function isLoopbackIP(ip) {
     return false
 }
 
-function isLANIp(ip) {
+function isLANIp(ip) { // ported
     ip=normalizeIp(ip)
     if (net.isIP(ip) === 0) return false
     try {
         // speed optimized
         let ipVersion = net.isIPv4(ip) ? 'ipv4' : 'ipv6'
         for (let cidr of private_network_cidrs) {
+            if (!cidr) continue
             let first = cidr.first()
             if (first.kind() !== ipVersion) continue
             if (cidr.contains(ip))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mybase",
-  "version": "1.1.15",
+  "version": "1.1.17",
   "description": "",
   "main": "mybase.js",
   "scripts": {
@@ -17,6 +17,8 @@
     "ip6": "=0.2.7",
     "ip6addr": "^0.2.5",
     "js-sha512": "^0.8.0",
+    "mysql": "^2.18.1",
+    "mysql2": "^3.9.1",
     "node-vault": "^0.10.2",
     "psl": "^1.9.0",
     "punycode": "^2.1.1",
@@ -27,6 +29,7 @@
     "@types/debug": "^4.1.12",
     "@types/ip6addr": "^0.2.6",
     "@types/jest": "^29.5.11",
+    "@types/mysql": "^2.15.25",
     "@types/node": "^20.11.5",
     "@types/validator": "^13.11.8",
     "chai": "^4.2.0",

package/ts/funcs/getMysql1.d.ts

@@ -0,0 +1,8 @@
+export type Mysql1ServerConfiguration = {
+    host: string;
+    port: number;
+    login: string;
+    password: string;
+    db: string;
+};
+export declare function getMysql1(config: Mysql1ServerConfiguration, pingInterval?: number): Promise<unknown>;

package/ts/funcs/getMysql1.js

@@ -0,0 +1,72 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMysql1 = void 0;
+const mysql1 = __importStar(require("mysql"));
+const debug_1 = __importDefault(require("debug"));
+const dbg = (0, debug_1.default)("getMysql1");
+function getMysql1(config, pingInterval = 0) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return new Promise((resolve, reject) => {
+            const mysql_client = mysql1.createConnection({
+                host: config.host,
+                port: config.port ? config.port : 3306,
+                user: config.login,
+                password: config.password,
+                database: config.db
+            });
+            mysql_client.connect((err, res) => {
+                if (err) {
+                    dbg(`mysql connection has failed to ${config.host}@${config.db}`, err);
+                    return reject(err);
+                }
+                dbg(`mysql connection has been established to ${config.host}@${config.db}`);
+                // install a pinger every 30 seconds to keep the connection alive
+                if (pingInterval > 0)
+                    setInterval(() => {
+                        mysql_client.ping(function (err) {
+                            if (err)
+                                return console.log(`could not ping mysql ${config.host}@${config.db}`, err.code);
+                            dbg(`mysql ${config.host}@${config.db} is pinging properly`);
+                        });
+                    }, pingInterval);
+                resolve(mysql_client);
+            });
+        });
+    });
+}
+exports.getMysql1 = getMysql1;

package/ts/funcs/getMysql1.ts

@@ -0,0 +1,41 @@
+import * as mysql1 from "mysql"
+import { MysqlError } from "mysql"
+import debug from "debug"
+const dbg = debug("getMysql1")
+
+export type Mysql1ServerConfiguration = {
+    host: string,
+    port: number,
+    login: string,
+    password: string,
+    db: string
+}
+
+export async function getMysql1(config: Mysql1ServerConfiguration, pingInterval: number = 0) {
+    return new Promise((resolve, reject) => {
+        const mysql_client = mysql1.createConnection({
+            host: config.host,
+            port: config.port ? config.port : 3306,
+            user: config.login,
+            password: config.password,
+            database: config.db
+        })
+
+        mysql_client.connect((err:MysqlError, res) => {
+            if (err) {
+                dbg(`mysql connection has failed to ${config.host}@${config.db}`, err)
+                return reject(err)
+            }
+            dbg(`mysql connection has been established to ${config.host}@${config.db}`)
+            // install a pinger every 30 seconds to keep the connection alive
+            if (pingInterval > 0)
+                setInterval(() => {
+                    mysql_client.ping(function (err:MysqlError) {
+                        if (err) return console.log(`could not ping mysql ${config.host}@${config.db}`, err.code)
+                        dbg(`mysql ${config.host}@${config.db} is pinging properly`)
+                    })
+                }, pingInterval)
+            resolve(mysql_client)
+        })
+    })
+}

package/ts/funcs/getMysql2.d.ts

@@ -0,0 +1,8 @@
+export type Mysql2ServerConfiguration = {
+    host: string;
+    port: number;
+    login: string;
+    password: string;
+    db: string;
+};
+export declare function getMysql2(config: Mysql2ServerConfiguration, pingInterval?: number): Promise<unknown>;

package/ts/funcs/getMysql2.js

@@ -0,0 +1,72 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMysql2 = void 0;
+const mysql2 = __importStar(require("mysql2"));
+const debug_1 = __importDefault(require("debug"));
+const dbg = (0, debug_1.default)("getMysql2");
+function getMysql2(config, pingInterval = 0) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return new Promise((resolve, reject) => {
+            const mysql_client = mysql2.createConnection({
+                host: config.host,
+                port: config.port ? config.port : 3306,
+                user: config.login,
+                password: config.password,
+                database: config.db
+            });
+            mysql_client.connect((err) => {
+                if (err) {
+                    dbg(`mysql connection has failed to ${config.host}@${config.db}`, err);
+                    return reject(err);
+                }
+                dbg(`mysql connection has been established to ${config.host}@${config.db}`);
+                // install a pinger every 30 seconds to keep the connection alive
+                if (pingInterval > 0)
+                    setInterval(() => {
+                        mysql_client.ping(function (err) {
+                            if (err)
+                                return console.log(`could not ping mysql ${config.host}@${config.db}`, err.code);
+                            dbg(`mysql ${config.host}@${config.db} is pinging properly`);
+                        });
+                    }, pingInterval);
+                resolve(mysql_client);
+            });
+        });
+    });
+}
+exports.getMysql2 = getMysql2;

package/ts/funcs/getMysql2.ts

@@ -0,0 +1,42 @@
+import * as mysql2 from "mysql2"
+import { QueryError } from "mysql2"
+import debug from "debug"
+const dbg = debug("getMysql2")
+
+export type Mysql2ServerConfiguration = {
+    host: string,
+    port: number,
+    login: string,
+    password: string,
+    db: string
+}
+
+export async function getMysql2(config: Mysql2ServerConfiguration, pingInterval: number = 0) {
+    return new Promise((resolve, reject) => {
+        const mysql_client = mysql2.createConnection({
+            host: config.host,
+            port: config.port ? config.port : 3306,
+            user: config.login,
+            password: config.password,
+            database: config.db
+        })
+
+        mysql_client.connect((err: QueryError | null) => {
+            if (err) {
+                dbg(`mysql connection has failed to ${config.host}@${config.db}`, err)
+                return reject(err)
+            }
+            dbg(`mysql connection has been established to ${config.host}@${config.db}`)
+            // install a pinger every 30 seconds to keep the connection alive
+            if (pingInterval > 0)
+                setInterval(() => {
+                    mysql_client.ping(function (err:QueryError | null) {
+                        if (err) 
+                            return console.log(`could not ping mysql ${config.host}@${config.db}`, err.code)
+                        dbg(`mysql ${config.host}@${config.db} is pinging properly`)
+                    })
+                }, pingInterval)
+            resolve(mysql_client)
+        })
+    })
+}

package/ts/funcs/initMysql2Pool.d.ts

@@ -0,0 +1,3 @@
+import { Pool } from "mysql2";
+import { Mysql2ServerConfiguration } from "./getMysql2";
+export declare function initMysql2Pool(sqlServer: Mysql2ServerConfiguration): Pool;

package/ts/funcs/initMysql2Pool.js

@@ -0,0 +1,38 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initMysql2Pool = void 0;
+const mysql2 = __importStar(require("mysql2"));
+const debug_1 = __importDefault(require("debug"));
+const dbg = (0, debug_1.default)("initMysql2Pool");
+function initMysql2Pool(sqlServer) {
+    const connectionUri = `mysql://${sqlServer.login}:${sqlServer.password}@${sqlServer.host}`;
+    dbg(`creating mysql pool to ${sqlServer.host}@${sqlServer.db} as connectionUri=${connectionUri}`);
+    return mysql2.createPool(connectionUri);
+}
+exports.initMysql2Pool = initMysql2Pool;

package/ts/funcs/initMysql2Pool.ts

@@ -0,0 +1,11 @@
+import * as mysql2 from "mysql2"
+import { Pool } from "mysql2"
+import debug from "debug"
+import { Mysql2ServerConfiguration } from "./getMysql2"
+const dbg = debug("initMysql2Pool")
+
+export function initMysql2Pool(sqlServer: Mysql2ServerConfiguration): Pool {
+    const connectionUri = `mysql://${sqlServer.login}:${sqlServer.password}@${sqlServer.host}`
+    dbg(`creating mysql pool to ${sqlServer.host}@${sqlServer.db} as connectionUri=${connectionUri}`)
+    return mysql2.createPool(connectionUri)
+}

package/ts/funcs/isLANIp.d.ts

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

package/ts/funcs/isLANIp.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isLANIp = void 0;
+const ip6addr_1 = __importDefault(require("ip6addr"));
+const net_1 = __importDefault(require("net"));
+const private_network_cidrs = [ip6addr_1.default.createCIDR('10.0.0.0/8'),
+    ip6addr_1.default.createCIDR('172.16.0.0/12'),
+    ip6addr_1.default.createCIDR('192.168.0.0/16'),
+    ip6addr_1.default.createCIDR('fd00::/8'), // Reserved by IETF for future use, but not currently in active use.
+    ,
+    ip6addr_1.default.createCIDR('fc00::/8'), // The range currently in use for local communications within a site or organization.
+];
+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 isLANIp(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 private_network_cidrs) {
+            if (!cidr)
+                continue;
+            let first = cidr.first();
+            if (first.kind() !== ipVersion)
+                continue;
+            if (cidr.contains(ip))
+                return true;
+        }
+    }
+    catch (err) {
+        console.log(err);
+    }
+    return false;
+}
+exports.isLANIp = isLANIp;

package/ts/funcs/isLANIp.test.ts

@@ -0,0 +1,59 @@
+import { isLANIp } from './isLANIp';
+
+describe('isLANIp', () => {
+  it('should return true for LAN IP addresses', () => {
+    expect(isLANIp('192.168.0.1')).toBe(true);
+    expect(isLANIp('10.0.0.1')).toBe(true);
+    expect(isLANIp('172.16.0.1')).toBe(true);
+    
+    // Add more test cases for LAN IP addresses
+  });
+
+  it('should return false for non-LAN IP addresses', () => {
+    expect(isLANIp('8.8.8.8')).toBe(false);
+    expect(isLANIp('2001:0db8:85a3:0000:0000:8a2e:0370:7334')).toBe(false);
+    // Add more test cases for non-LAN IP addresses
+  });
+
+  it('should return false for invalid IP addresses', () => {
+    expect(isLANIp('')).toBe(false);
+    expect(isLANIp('192.168.0.')).toBe(false);
+    expect(isLANIp('256.0.0.1')).toBe(false);
+    // Add more test cases for invalid IP addresses
+  });
+
+  test('should return true for private IPv4', () => {
+    const ip = '192.168.1.1';
+    expect(isLANIp(ip)).toBe(true);
+});
+
+test('should return true for private IPv6', () => {
+    const ip = 'fd00::';
+    expect(isLANIp(ip)).toBe(true);
+});
+
+test('should return null for public IPv4', () => {
+    const ip = '8.8.8.8';
+    expect(isLANIp(ip)).toBe(false);
+});
+
+test('should return false for public IPv6', () => {
+    const ip = '2001:4860:4860::8888';
+    expect(isLANIp(ip)).toBe(false);
+});
+
+test('should return false for invalid IP', () => {
+    const ip = 'invalid';
+    expect(isLANIp(ip)).toBe(false);
+});
+
+test('should return false for invalid IP', () => {
+    const ip = '1.2.3';
+    expect(isLANIp(ip)).toBe(false);
+});
+
+test('should return null for non private IPv6', () => {
+    const ip = '::2';
+    expect(isLANIp(ip)).toBe(false);
+});
+});

package/ts/funcs/isLANIp.ts

@@ -0,0 +1,38 @@
+import ip6addr from 'ip6addr'
+import net from 'net'
+
+const private_network_cidrs = [ip6addr.createCIDR('10.0.0.0/8')
+            ,ip6addr.createCIDR('172.16.0.0/12')
+            ,ip6addr.createCIDR('192.168.0.0/16')
+            ,ip6addr.createCIDR('fd00::/8'), // Reserved by IETF for future use, but not currently in active use.
+            ,ip6addr.createCIDR('fc00::/8'), // The range currently in use for local communications within a site or organization.
+        ]
+
+
+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 isLANIp(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 private_network_cidrs) {
+            if (!cidr) continue
+            
+            let first = cidr.first()
+            if (first.kind() !== ipVersion) continue
+            if (cidr.contains(ip))
+                return true
+        }
+    } catch (err) {
+        console.log(err)
+    }
+    return false
+}

package/ts/funcs/isLoopbackIP.js

@@ -30,7 +30,6 @@ function isLoopbackIP(ip) {
             if (cidr.contains(ip))
                 return true;
         }
-        return false;
     }
     catch (err) {
         console.log(err);

package/ts/funcs/isLoopbackIP.ts

@@ -25,7 +25,6 @@ export function isLoopbackIP(ip:string) : boolean {
             if (cidr.contains(ip))
                 return true
         }
-        return false
     } catch (err) {
         console.log(err)
     }

package/ts/index.d.ts

@@ -17,3 +17,7 @@ export * from "./funcs/randomIP6";
 export * from "./funcs/randomTCPPort";
 export * from "./funcs/validEmail";
 export * from "./funcs/isLoopbackIP";
+export * from "./funcs/isLANIp";
+export * from "./funcs/getMysql1";
+export * from "./funcs/getMysql2";
+export * from "./funcs/initMysql2Pool";

package/ts/index.js

@@ -33,3 +33,7 @@ __exportStar(require("./funcs/randomIP6"), exports);
 __exportStar(require("./funcs/randomTCPPort"), exports);
 __exportStar(require("./funcs/validEmail"), exports);
 __exportStar(require("./funcs/isLoopbackIP"), exports);
+__exportStar(require("./funcs/isLANIp"), exports);
+__exportStar(require("./funcs/getMysql1"), exports);
+__exportStar(require("./funcs/getMysql2"), exports);
+__exportStar(require("./funcs/initMysql2Pool"), exports);

package/ts/index.ts

@@ -17,4 +17,7 @@ export * from "./funcs/randomIP6"
 export * from "./funcs/randomTCPPort"
 export * from "./funcs/validEmail"
 export * from "./funcs/isLoopbackIP"
-
+export * from "./funcs/isLANIp"
+export * from "./funcs/getMysql1"
+export * from "./funcs/getMysql2"
+export * from "./funcs/initMysql2Pool"