node-ipdox 1.0.3 → 1.0.5

package/README.md

@@ -18,7 +18,7 @@ import { IPDox } from "node-ipdox";
 const ipdox = new IPDox({
 	cacheMaxItems: 5000,
 	cacheMaxAge: 43200000,
-	maxRetries: 10,
+	maxRetries: 10
 });
 
 ipdox
@@ -69,6 +69,7 @@ export interface IPDOXResponse {
 		isTOR: boolean; // Boolean indicating if the IP address is a TOR node (might be undefined)
 		isProxy: boolean; // Boolean indicating if the IP address is a proxy (might be undefined)
 	};
+	timeZone?: string; // Time zone
 	source: string; // Source API
 }
 ```

package/dist/integration/ipdox.providers.int.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/integration/ipdox.providers.int.test.js

@@ -0,0 +1,50 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const index_1 = require("../index");
+const RUN = process.env.RUN_INTEGRATION === "1";
+const TEST_IP = process.env.TEST_IP || "8.8.8.8";
+// Run only when explicitly enabled
+(RUN ? vitest_1.describe : vitest_1.describe.skip)("Integration: real providers", () => {
+    (0, vitest_1.it)("ipwho.is", () => __awaiter(void 0, void 0, void 0, function* () {
+        const ipdox = new index_1.IPDox({ maxRetries: 1 });
+        // @ts-expect-error call provider directly to avoid randomness
+        const r = yield ipdox.fetchIPWhoDotIs(TEST_IP);
+        (0, vitest_1.expect)(r).toBeTruthy();
+        (0, vitest_1.expect)(r.source).toBe("ipwho.is");
+        (0, vitest_1.expect)(r.ip).toBeTypeOf("string");
+    }), 20000);
+    (0, vitest_1.it)("ip-api.com", () => __awaiter(void 0, void 0, void 0, function* () {
+        const ipdox = new index_1.IPDox({ maxRetries: 1 });
+        // @ts-expect-error call provider directly to avoid randomness
+        const r = yield ipdox.fetchIPHyphenAPIDotCom(TEST_IP);
+        (0, vitest_1.expect)(r).toBeTruthy();
+        (0, vitest_1.expect)(r.source).toBe("ip-api.com");
+        (0, vitest_1.expect)(r.ip).toBeTypeOf("string");
+    }), 20000);
+    (0, vitest_1.it)("freeipapi.com", () => __awaiter(void 0, void 0, void 0, function* () {
+        const ipdox = new index_1.IPDox({ maxRetries: 1 });
+        // @ts-expect-error call provider directly to avoid randomness
+        const r = yield ipdox.fetchFreeIPAPIDotCom(TEST_IP);
+        (0, vitest_1.expect)(r).toBeTruthy();
+        (0, vitest_1.expect)(r.source).toBe("freeipapi.com");
+        (0, vitest_1.expect)(r.ip).toBeTypeOf("string");
+    }), 20000);
+    (0, vitest_1.it)("ipapi.co", () => __awaiter(void 0, void 0, void 0, function* () {
+        const ipdox = new index_1.IPDox({ maxRetries: 1 });
+        // @ts-expect-error call provider directly to avoid randomness
+        const r = yield ipdox.fetchIPAPIDotCo(TEST_IP);
+        (0, vitest_1.expect)(r).toBeTruthy();
+        (0, vitest_1.expect)(r.source).toBe("ipapi.co");
+        (0, vitest_1.expect)(r.ip).toBeTypeOf("string");
+    }), 20000);
+});

package/dist/ipdox.js

@@ -115,6 +115,7 @@ class IPDox {
                     isp: response.data.isp,
                     proxy: response.data.proxy,
                     isHosting: response.data.hosting,
+                    timeZone: response.data.timezone,
                     source: "ip-api.com"
                 };
                 this.cacheResponse(ip, formattedResponse);
@@ -141,6 +142,7 @@ class IPDox {
                     isp: response.data.isp,
                     proxy: response.data.proxy,
                     isHosting: response.data.hosting,
+                    timeZone: response.data.timeZones[0],
                     source: "freeipapi.com"
                 };
                 this.cacheResponse(ip, formattedResponse);
@@ -167,6 +169,7 @@ class IPDox {
                     isp: response.data.connection.isp,
                     proxy: false,
                     isHosting: false,
+                    timeZone: response.data.timezone.id,
                     source: "ipwho.is"
                 };
                 this.cacheResponse(ip, formattedResponse);
@@ -191,6 +194,7 @@ class IPDox {
                     longitude: response.data.longitude,
                     zip: response.data.postal,
                     isp: response.data.org,
+                    timeZone: response.data.timezone,
                     source: "ipapi.co"
                 };
                 this.cacheResponse(ip, formattedResponse);

package/dist/ipdox.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/ipdox.test.js

@@ -0,0 +1,86 @@
+"use strict";
+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 });
+const vitest_1 = require("vitest");
+const axios_1 = __importDefault(require("axios"));
+const index_1 = require("./index");
+vitest_1.vi.mock("axios");
+const mockedAxios = axios_1.default;
+(0, vitest_1.describe)("IPDox", () => {
+    (0, vitest_1.beforeEach)(() => {
+        vitest_1.vi.clearAllMocks();
+    });
+    (0, vitest_1.it)("returns undefined for empty ip", () => __awaiter(void 0, void 0, void 0, function* () {
+        const ipdox = new index_1.IPDox();
+        const res = yield ipdox.doxIP({ ip: "" });
+        (0, vitest_1.expect)(res).toBeUndefined();
+    }));
+    (0, vitest_1.it)("formats response from ipwho.is provider", () => __awaiter(void 0, void 0, void 0, function* () {
+        const ipdox = new index_1.IPDox({ maxRetries: 1 });
+        mockedAxios.get = vitest_1.vi.fn().mockResolvedValue({
+            data: {
+                success: true,
+                ip: "8.8.8.8",
+                country_code: "US",
+                city: "Mountain View",
+                continent_code: "NA",
+                latitude: 37.386,
+                longitude: -122.0838,
+                postal: "94039",
+                connection: { isp: "Google LLC" },
+                timezone: { id: "America/Los_Angeles" }
+            }
+        });
+        // Call provider directly to avoid randomness
+        // @ts-expect-error Accessing class method for test
+        const r = yield ipdox.fetchIPWhoDotIs("8.8.8.8");
+        (0, vitest_1.expect)(r).toMatchObject({
+            ip: "8.8.8.8",
+            country: "US",
+            city: "Mountain View",
+            continent: "NA",
+            latitude: 37.386,
+            longitude: -122.0838,
+            zip: "94039",
+            isp: "Google LLC",
+            timeZone: "America/Los_Angeles",
+            source: "ipwho.is"
+        });
+    }));
+    (0, vitest_1.it)("caches responses by ip", () => __awaiter(void 0, void 0, void 0, function* () {
+        const ipdox = new index_1.IPDox({ maxRetries: 1 });
+        mockedAxios.get = vitest_1.vi.fn().mockResolvedValue({
+            data: {
+                success: true,
+                ip: "1.1.1.1",
+                country_code: "AU",
+                city: "Sydney",
+                continent_code: "OC",
+                latitude: -33.86,
+                longitude: 151.21,
+                postal: "2000",
+                connection: { isp: "Cloudflare" },
+                timezone: { id: "Australia/Sydney" }
+            }
+        });
+        // @ts-expect-error Accessing class method for test
+        const r1 = yield ipdox.fetchIPWhoDotIs("1.1.1.1");
+        (0, vitest_1.expect)(r1).toBeTruthy();
+        // Second call should be served from cache; axios.get should not be called again if provider is called through cache path
+        // @ts-expect-error Use cache via public doxIP path
+        ipdox.cache.set("1.1.1.1", r1);
+        const r2 = yield ipdox.doxIP({ ip: "1.1.1.1" });
+        (0, vitest_1.expect)(r2).toEqual(r1);
+    }));
+});

package/dist/types/IPDOXResponse.d.ts

@@ -16,6 +16,7 @@
  * @property {boolean} proxyInfo.isVPN Is the IP address a VPN?
  * @property {boolean} proxyInfo.isTOR Is the IP address a TOR node?
  * @property {boolean} proxyInfo.isProxy Is the IP address a proxy?
+ * @property {string} timeZone The time zone
  * @property {string} source The source of the data
  */
 export interface IPDOXResponse {
@@ -34,5 +35,6 @@ export interface IPDOXResponse {
         isTOR: boolean;
         isProxy: boolean;
     };
+    timeZone?: string;
     source: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "node-ipdox",
-	"version": "1.0.3",
+	"version": "1.0.5",
 	"description": "node-ipdox is a Node.js library for GeoIP lookup, leveraging various free GeoIP APIs. It provides a unified response format and incorporates local caching to minimize duplicate requests.",
 	"author": "Mikel Calvo <contact@mikecalvo.net> (www.mikelcalvo.net)",
 	"keywords": [
@@ -15,28 +15,26 @@
 	"license": "ISC",
 	"readmeFilename": "README.md",
 	"homepage": "https://github.com/mikelcalvo/ipdox#readme",
-	"bugs": {
-		"url": "https://github.com/mikelcalvo/ipdox/issues"
-	},
+	"bugs": { "url": "https://github.com/mikelcalvo/ipdox/issues" },
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
 	"files": ["dist"],
 	"scripts": {
-		"test": "echo \"Error: no test specified\" && exit 1",
-		"format": "prettier --write \"**/*.ts\" \"**/*.js\" \"**/*.json\"",
+		"test": "vitest run",
+		"test:watch": "vitest",
+		"test:integration": "RUN_INTEGRATION=1 vitest run src/integration/ipdox.providers.int.test.ts",
+		"format": "prettier --write \"**/*.ts\" \"**/*.js\" \"**/*.json\" --ignore-path .prettierignore",
 		"build": "tsc"
 	},
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/mikelcalvo/node-ipdox.git"
 	},
-	"dependencies": {
-		"axios": "1.6.8",
-		"lru-cache": "^10.2.0"
-	},
+	"dependencies": { "axios": "1.11.0", "lru-cache": "^11.1.0" },
 	"devDependencies": {
-		"@types/node": "20.12.7",
-		"prettier": "3.2.5",
-		"typescript": "^5.4.5"
+		"@types/node": "24.3.0",
+		"prettier": "3.6.2",
+		"typescript": "^5.9.2",
+		"vitest": "3.2.4"
 	}
 }