geoip-lite2 2.1.42 → 2.2.0

package/README.md

@@ -5,7 +5,7 @@
     <br>    
     <p>
         A native <a href="https://nodejs.org" target="_blank" title="Open nodejs.org">Node.js</a> API for the GeoLite data from MaxMind.<br>
-        This product includes GeoLite data created by MaxMind, available from: <a href="https://www.maxmind.com" target="_blank" title="Open www.maxmind.com">www.maxmind.com</a>
+        This product includes GeoLite data created by MaxMind, available from <a href="https://www.maxmind.com" target="_blank" title="Open www.maxmind.com">maxmind.com</a>.
     </p>
     <a href="https://www.npmjs.com/package/geoip-lite2" target="_blank" title="geoip-lite2 - npm" style="text-decoration:none">
         <img src="https://img.shields.io/npm/dt/geoip-lite2?maxAge=3600" alt="The number of downloads">
@@ -18,28 +18,30 @@
 
 
 # 🚀 Improved GeoIP Module by [Sefinek](https://sefinek.net)
-This module is an enhanced and updated version of [geoip-lite](https://github.com/geoip-lite/node-geoip), thoughtfully designed to adhere to the latest programming standards.
+This module is an enhanced and updated version of [geoip-lite](https://github.com/geoip-lite/node-geoip), carefully designed to meet the latest programming standards.
 
-All components have undergone meticulous updates to ensure peak performance and functionality.
-The module now operates even faster due to file minification!
+All components have been thoroughly updated to ensure optimal performance and functionality.
+The module now runs even faster, thanks to file minification!
 
-Additionally, the testing process has been enhanced by adopting the [Jest](https://www.npmjs.com/package/jest) testing library.
-This improvement strengthens testing and contributes to the overall reliability of the module.
+Furthermore, the testing process has been improved with the adoption of the [Jest](https://www.npmjs.com/package/jest) testing library.
 
 > I am not the primary creator of this! All copyright rights belong to the original [authors](AUTHORS).
 
 
+## ⚠️ Important
+Remember to regularly update the Maxmind database. You'll need the token for this.
+
+
 ## 🌠 Version without a Local Database
 This module requires a significant amount of RAM because geolocation data is stored in memory.
-However, you can always use the official alternative, the [geoip2-api](https://www.npmjs.com/package/geoip2-api) module, which sends a request to the API server and retrieves information about a specific IP address directly from there.
-
+However, you can always opt for the official alternative, the [geoip2-api](https://www.npmjs.com/package/geoip2-api) module, which sends requests to an API server and retrieves information about specific IP addresses directly from there.
 
 ### ✨ Demonstration
 You can see this module in action using my [official API](https://api.sefinek.net). The API interface is public and can be safely used in your projects without any limits. Happy coding!
 
-- Documentation: https://api.sefinek.net/docs/v2  
-- Specific IP: https://api.sefinek.net/api/v2/geoip/109.207.159.255?validation=false  
-- Your IP: https://api.sefinek.net/api/v2/geoip/myip
+- Specific IP: https://api.sefinek.net/api/v2/geoip/109.207.159.255
+- Client's IP: https://api.sefinek.net/api/v2/geoip/me
+- Documentation: https://api.sefinek.net/docs/v2
 
 
 ## 📑 Introduction
@@ -93,13 +95,12 @@ console.log(geo);
 
 
 ## 🛠️ Installation
-
 ### 1. Get the library
 ```cmd
 npm install geoip-lite2
 ```
 
-### 2. Update the datafiles (optional)
+### 2. Update the datafiles (recommended)
 Run `cd node_modules/geoip-lite2 && npm run updatedb license_key=YOUR_LICENSE_KEY` to update the data files. (Replace `YOUR_LICENSE_KEY` with your license key obtained from [maxmind.com](https://support.maxmind.com/hc/en-us/articles/4407111582235-Generate-a-License-Key))
 
 You can create maxmind account [here](https://www.maxmind.com/en/geolite2/signup).
@@ -180,7 +181,7 @@ npm run updatedb-force license_key=YOUR_LICENSE_KEY
 
 You can also run it by doing:
 ```shell
-node ./node_modules/geoip-lite2/scripts/updatedb.js license_key=YOUR_LICENSE_KEY
+node ./node_modules/geoip-lite2/utils/updatedb.js license_key=YOUR_LICENSE_KEY
 ```
 
 ### Ways to reload data in your app when update finished
@@ -250,10 +251,6 @@ console.log(process.memoryUsage());
 ```
 
 
-## 🔀 Alternatives
-If your use-case requires doing less than 100 queries through the lifetime of your application or if you need really fast latency on start-up, you might want to look into [fast-geoip](https://github.com/onramper/fast-geoip) a package with a compatible API that is optimized for serverless environments and provides faster boot times and lower memory consumption at the expense of longer lookup times.
-
-
 ## 🔖 References
 - [Documentation from MaxMind](https://www.maxmind.com/app/iso3166)
 - [ISO 3166 (1 & 2) codes](https://en.wikipedia.org/wiki/ISO_3166)

package/geoip-data/city.checksum

@@ -0,0 +1 @@
+86914bd2508c1dd336fc25b2e73700447ccf11bca63ea6cdec6f427314770d09  GeoLite2-City-CSV_20241018.zip

package/geoip-data/country.checksum

@@ -0,0 +1 @@
+aa9b53b486d2411cfcb92da8197a45d8aecb20f17ff4c1f6b17bd32bd2237e51  GeoLite2-Country-CSV_20241018.zip

package/index.d.ts

@@ -2,23 +2,25 @@ declare module 'geoip-lite2' {
     export const cmp: number | null;
 
     interface GeoIp2Location {
-        range: [number, number];
+        range: [number | null, number | null];
         country: string;
         region: string;
         eu: '0' | '1';
         timezone: string;
         city: string;
-        ll: [number, number];
+        ll: [number | null, number | null];
         metro: number;
         area: number;
     }
 
-    function lookup(ip: string): GeoIp2Location | null;
-    function pretty(ip: string | number): string;
+    function lookup(ip: string | number): GeoIp2Location | null;
+    function pretty(n: string | number | any[]): string;
 
     function reloadDataSync(): void;
-    function reloadData(callback: () => void): void;
-    function startWatchingDataUpdate(): void;
+    function reloadData(callback: (err?: Error | null) => void): Promise<void>;
+    function startWatchingDataUpdate(callback: () => void): void;
+    function stopWatchingDataUpdate(): void;
+    function clear(): void;
 
     export {
         lookup,
@@ -26,5 +28,7 @@ declare module 'geoip-lite2' {
         reloadDataSync,
         reloadData,
         startWatchingDataUpdate,
+        stopWatchingDataUpdate,
+        clear
     };
 }

package/lib/fsWatcher.js

@@ -1 +1,69 @@
-const{access:n,constants:t,watch:e}=require('fs'),{join:o}=require('path'),c={};function u(n){c[n].close()}exports.makeFsWatchFilter=function(l,r,i,s,f){let a=null;function p(){a=null,f()}'function'==typeof s&&(f=s,s=i,i=null),c[l]&&u(l),c[l]=e(r,(function(e,c){if(!c)return;const u=o(r,c);i&&i!==c||n(u,t.F_OK,(n=>{if(n)return console.error(n);null!==a&&(clearTimeout(a),a=null),a=setTimeout(p,s)}))}))},exports.stopWatching=u;
+const { access, constants, watch } = require('fs');
+const { join } = require('path');
+const FSWatcher = {};
+
+/**
+ * Takes an FSWatcher object and closes it.
+ * @param {string} name - The name of the watcher to close.
+ */
+const stopWatching = name => FSWatcher[name].close();
+
+/**
+ * Takes a directory/file and watch for change. Upon change, call the callback.
+ *
+ * @param {String} name - name of this watcher
+ * @param {String} directory - path to the directory to watch
+ * @param {String} [filename] - (optional) specific filename to watch for, watches for all files in the directory if unspecified
+ * @param {Number} cdDelay - delay to wait before triggering the callback
+ * @param {Function} callback - function() - called when changes are detected
+ */
+const makeFsWatchFilter = (name, directory, filename, cdDelay, callback) => {
+	let cdId = null;
+
+	// Delete the cdId and callback the outer function
+	function timeoutCallback() {
+		cdId = null;
+		callback();
+	}
+
+	// This function is called when there is a change in the data directory
+	// It sets a timer to wait for the change to be completed
+	function onWatchEvent(event, changedFile) {
+		// Check to make sure changedFile is not null
+		if (!changedFile) return;
+
+		const filePath = join(directory, changedFile);
+		if (!filename || filename === changedFile) {
+			access(filePath, constants.F_OK, err => {
+				if (err) return console.error(err);
+
+				// At this point, a new file system activity has been detected,
+				// We have to wait for file transfer to be finished before moving on.
+
+				// If a cdId already exists, we delete it
+				if (cdId !== null) {
+					clearTimeout(cdId);
+					cdId = null;
+				}
+
+				// Once the cdDelay has passed, the timeoutCallback function will be called
+				cdId = setTimeout(timeoutCallback, cdDelay);
+			});
+		}
+	}
+
+	// Manage the case where filename is missing (because it's optional)
+	if (typeof cdDelay === 'function') {
+		callback = cdDelay;
+		cdDelay = filename;
+		filename = null;
+	}
+
+	if (FSWatcher[name]) {
+		stopWatching(name);
+	}
+
+	FSWatcher[name] = watch(directory, onWatchEvent);
+};
+
+module.exports = { makeFsWatchFilter, stopWatching };