node-ipdox 1.0.0 → 1.0.2

package/README.md

@@ -15,7 +15,11 @@ npm install node-ipdox --save
 ```javascript
 import { IPDox } from "node-ipdox";
 
-const ipdox = new IPDox({ cacheTimeout: 43200000, maxRetries: 10 });
+const ipdox = new IPDox({
+	cacheMaxItems: 5000,
+	cacheMaxAge: 43200000,
+	maxRetries: 10,
+});
 
 ipdox
 	.doxIP({ ip: "8.8.8.8" })
@@ -25,11 +29,12 @@ ipdox
 
 ## API
 
-### `new IPDox({ cacheTimeout, maxRetries })`
+### `new IPDox({ cacheMaxItems, cacheMaxAge, maxRetries })`
 
 Creates a new instance of IPDox.
 
-- `cacheTimeout` - The cache timeout in milliseconds (default: 43200000 (12 hours))
+- `cacheMaxItems` - The maximum number of items to store in the cache (default: 1000)
+- `cacheMaxAge` - The cache timeout in milliseconds (default: 43200000 (12 hours))
 - `maxRetries` - Maximum number of retries if an API request fails (default: 10)
 
 ### `ipdox.doxIP({ ip })`
@@ -40,6 +45,8 @@ Fetches geolocation data for the specified IP address.
 
 Returns a Promise that resolves to an `IPDOXResponse` object.
 
+If no response is found, undefined is returned.
+
 ## IPDOXResponse
 
 The `IPDOXResponse` object includes the following properties:

package/dist/ipdox.d.ts

@@ -3,21 +3,20 @@ import { IPDOXResponse } from "./types/IPDOXResponse";
 import { IPDOXConstructor } from "./types/IPDOXConstructor";
 declare class IPDox {
     private cache;
-    private cacheTimeout;
     private maxRetries;
     /**
-     * @description Creates an instance of ListSubscribers.
-     * @param {IPDOXConstructor} params - Params of the constructor
-     * @param {number} params.cacheTimeout - The cache timeout in milliseconds (default: 43200000 (12 hours))
-     *
-     *
+     * @description Creates an instance of IPDox.
+     * @param {IPDOXConstructor} params
+     * @param {number} params.cacheMaxItems - The maximum number of items in the cache (default: 1000)
+     * @param {number} params.cacheMaxAge - The cache timeout in milliseconds (default: 43200000 (12 hours))
+     * @param {number} params.maxRetries - The maximum number of retries (default: 10)
      */
-    constructor({ cacheTimeout, maxRetries }: IPDOXConstructor);
+    constructor({ cacheMaxItems, cacheMaxAge, maxRetries }?: IPDOXConstructor);
     /**
-     * @description Get all the subscribers of a list
+     * @description Get information about an IP address
      * @param {IPDOXRequest} params - Params of the request
      * @param {string} params.ip - IP address
-     * @returns {Promise<IPDOXResponse>} - Promise of the response
+     * @returns {Promise<IPDOXResponse | undefined>} - Promise of the response or undefined
      * @memberof IPDox
      */
     doxIP({ ip }: IPDOXRequest): Promise<IPDOXResponse | undefined>;

package/dist/ipdox.js

@@ -14,28 +14,39 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
 const apis_1 = require("./utils/apis");
+const lru_cache_1 = require("lru-cache");
 class IPDox {
     /**
-     * @description Creates an instance of ListSubscribers.
-     * @param {IPDOXConstructor} params - Params of the constructor
-     * @param {number} params.cacheTimeout - The cache timeout in milliseconds (default: 43200000 (12 hours))
-     *
-     *
+     * @description Creates an instance of IPDox.
+     * @param {IPDOXConstructor} params
+     * @param {number} params.cacheMaxItems - The maximum number of items in the cache (default: 1000)
+     * @param {number} params.cacheMaxAge - The cache timeout in milliseconds (default: 43200000 (12 hours))
+     * @param {number} params.maxRetries - The maximum number of retries (default: 10)
      */
-    constructor({ cacheTimeout = 43200000, maxRetries = 10 }) {
-        this.cache = new Map();
-        this.cacheTimeout = cacheTimeout;
+    constructor({ cacheMaxItems = 1000, cacheMaxAge = 43200000, maxRetries = 10 } = {
+        cacheMaxItems: 1000,
+        cacheMaxAge: 43200000,
+        maxRetries: 10
+    }) {
+        this.cache = new lru_cache_1.LRUCache({
+            max: cacheMaxItems,
+            ttl: cacheMaxAge
+        });
         this.maxRetries = maxRetries;
     }
     /**
-     * @description Get all the subscribers of a list
+     * @description Get information about an IP address
      * @param {IPDOXRequest} params - Params of the request
      * @param {string} params.ip - IP address
-     * @returns {Promise<IPDOXResponse>} - Promise of the response
+     * @returns {Promise<IPDOXResponse | undefined>} - Promise of the response or undefined
      * @memberof IPDox
      */
     doxIP({ ip }) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Check that the ip is valid
+            if (!ip || ip === "") {
+                return undefined;
+            }
             // Check if the IP is already in the cache
             if (this.cache.has(ip)) {
                 const cachedResponse = this.cache.get(ip);
@@ -87,16 +98,13 @@ class IPDox {
     }
     cacheResponse(ip, response) {
         this.cache.set(ip, response);
-        // Remove from cache after timeout
-        setTimeout(() => this.cache.delete(ip), this.cacheTimeout);
     }
     fetchIPHyphenAPIDotCom(ip) {
         return __awaiter(this, void 0, void 0, function* () {
             const requestURL = apis_1.GeoAPIs.IP_HYPHEN_API_DOT_COM + ip + "?fields=24899583";
             const response = yield axios_1.default.get(requestURL);
             if (response.data.status === "success") {
-                this.cacheResponse(ip, response.data);
-                return Promise.resolve({
+                const formattedResponse = {
                     ip: response.data.query,
                     country: response.data.countryCode,
                     city: response.data.city,
@@ -108,7 +116,9 @@ class IPDox {
                     proxy: response.data.proxy,
                     isHosting: response.data.hosting,
                     source: "ip-api.com"
-                });
+                };
+                this.cacheResponse(ip, formattedResponse);
+                return Promise.resolve(formattedResponse);
             }
             else {
                 return Promise.reject();
@@ -120,8 +130,7 @@ class IPDox {
             const requestURL = apis_1.GeoAPIs.FREE_IP_API_DOT_COM + ip;
             const response = yield axios_1.default.get(requestURL);
             if (response.data.ipVersion === 4) {
-                this.cacheResponse(ip, response.data);
-                return Promise.resolve({
+                const formattedResponse = {
                     ip: response.data.ipAddress,
                     country: response.data.countryCode,
                     city: response.data.cityName,
@@ -133,7 +142,9 @@ class IPDox {
                     proxy: response.data.proxy,
                     isHosting: response.data.hosting,
                     source: "freeipapi.com"
-                });
+                };
+                this.cacheResponse(ip, formattedResponse);
+                return Promise.resolve(formattedResponse);
             }
             else {
                 return Promise.reject();
@@ -145,8 +156,7 @@ class IPDox {
             const requestURL = apis_1.GeoAPIs.IPWHO_DOT_IS + ip;
             const response = yield axios_1.default.get(requestURL);
             if (response.data.success) {
-                this.cacheResponse(ip, response.data);
-                return Promise.resolve({
+                const formattedResponse = {
                     ip: response.data.ip,
                     country: response.data.country_code,
                     city: response.data.city,
@@ -158,7 +168,9 @@ class IPDox {
                     proxy: false,
                     isHosting: false,
                     source: "ipwho.is"
-                });
+                };
+                this.cacheResponse(ip, formattedResponse);
+                return Promise.resolve(formattedResponse);
             }
             else {
                 return Promise.reject();
@@ -170,8 +182,7 @@ class IPDox {
             const requestURL = apis_1.GeoAPIs.IPAPI_DOT_CO + ip + "/json";
             const response = yield axios_1.default.get(requestURL);
             if (response.data.ip) {
-                this.cacheResponse(ip, response.data);
-                return Promise.resolve({
+                const formattedResponse = {
                     ip: response.data.ip,
                     country: response.data.country_code,
                     city: response.data.city,
@@ -181,7 +192,9 @@ class IPDox {
                     zip: response.data.postal,
                     isp: response.data.org,
                     source: "ipapi.co"
-                });
+                };
+                this.cacheResponse(ip, formattedResponse);
+                return Promise.resolve(formattedResponse);
             }
             else {
                 return Promise.reject();

package/dist/types/IPDOXConstructor.d.ts

@@ -2,10 +2,12 @@
  * Interface for the constructor
  *
  * @interface IPDOXConstructor
- * @property {number} cacheTimeout The cache timeout in milliseconds (default: 43200000 (12 hours))
+ * @property {number} cacheMaxItems The maximum number of items in the cache (default: 1000)
+ * @property {number} cacheMaxAge The cache timeout in milliseconds (default: 43200000 (12 hours))
  * @property {number} maxRetries The maximum number of retries (default: 10)
  */
 export interface IPDOXConstructor {
-    cacheTimeout?: number;
+    cacheMaxItems?: number;
+    cacheMaxAge?: number;
     maxRetries?: number;
 }

package/package.json

@@ -1,9 +1,17 @@
 {
 	"name": "node-ipdox",
-	"version": "1.0.0",
-	"description": "",
+	"version": "1.0.2",
+	"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": ["geoip", "ip lookup", "ipdoxxing"],
+	"keywords": [
+		"geoip",
+		"ip lookup",
+		"ipdoxxing",
+		"ipdox",
+		"ip",
+		"ip address",
+		"ip address lookup"
+	],
 	"license": "ISC",
 	"readmeFilename": "README.md",
 	"homepage": "https://github.com/mikelcalvo/ipdox#readme",
@@ -23,11 +31,12 @@
 		"url": "git+https://github.com/mikelcalvo/node-ipdox.git"
 	},
 	"dependencies": {
-		"axios": "1.6.2"
+		"axios": "1.6.2",
+		"lru-cache": "^10.1.0"
 	},
 	"devDependencies": {
-		"@types/node": "20.10.1",
-		"prettier": "3.1.0",
-		"typescript": "^5.3.2"
+		"@types/node": "20.10.5",
+		"prettier": "3.1.1",
+		"typescript": "^5.3.3"
 	}
 }