geoip-lite2 2.2.7 → 2.2.8-beta.10

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">maxmind.com</a>.
+        This library 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,26 +18,18 @@
 
 
 # 🚀 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), carefully designed to meet the latest programming standards.
+This module is an optimized version of [geoip-lite](https://github.com/geoip-lite/node-geoip) and runs slightly faster.
+The project has been migrated to the [Jest](https://www.npmjs.com/package/jest) testing library.
 
-All components have been thoroughly updated to ensure optimal performance and functionality.
-The module now runs even faster, thanks to file minification!
-
-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).
+> I am not the primary creator of this project! All copyright rights belong to the original [authors](AUTHORS).
 
 
 ## ⚠️ Important
-Remember to regularly update the Maxmind database. You'll need the token for this.
-
+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 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!
+## ✨ API
+You can see this module in action using my [official API](https://api.sefinek.net). The `/api/v2/geoip` endpoint should not be used in production environments.
 
 - Specific IP: https://api.sefinek.net/api/v2/geoip/109.207.159.255
 - Client's IP: https://api.sefinek.net/api/v2/geoip/me
@@ -259,7 +251,6 @@ console.log(process.memoryUsage());
 
 ## 👥 Copyright
 `GeoIP-Lite` is Copyright 2011-2018 **Philip Tellis** <philip@bluesmoon.info>  
-`GeoIP-Lite2` is Copyright 2023-2024 **Sefinek** <contact@sefinek.net> (https://sefinek.net)
 
 
 ## 🔐 License

package/data/city.checksum

@@ -1 +1 @@
-9477be6926b39db95dcf6664e36bddd5900425ddb9952840ec5491d5c6ad6bdd  GeoLite2-City-CSV_20250905.zip
+72c73fdb61f3118464d513df4eac91075f8457767d172b8317c705ad3a575ef3  GeoLite2-City-CSV_20251217.zip

package/data/country.checksum

@@ -1 +1 @@
-952a602f47c26afc46782e468b2464fcc7a6a44418bff3819a5d1e63481de5ec  GeoLite2-Country-CSV_20250905.zip
+f4194c8a422f1d5c5f784737c8c59fce058d58ba90c22e9fbf061a0f6d1d1ba8  GeoLite2-Country-CSV_20251216.zip

package/fsWatcher.js

@@ -0,0 +1,85 @@
+// ============================================================================
+// File System Watcher for Auto-Reloading GeoIP Data
+// ============================================================================
+
+const { access, constants, watch } = require('node:fs');
+const { join } = require('node:path');
+const FSWatcher = {};
+
+// ============================================================================
+// Watcher Management
+// ============================================================================
+
+/**
+ * Takes an FSWatcher object and closes it.
+ * @param {string} name - The name of the watcher to close.
+ */
+const stopWatching = name => FSWatcher[name].close();
+
+// ============================================================================
+// File System Watch with Debounce
+// ============================================================================
+
+/**
+ * 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);
+};
+
+// ============================================================================
+// Exports
+// ============================================================================
+
+module.exports = { makeFsWatchFilter, stopWatching };

package/index.d.ts

@@ -2,12 +2,12 @@ interface GeoIp2Location {
     range: [number | null, number | null];
     country: string;
     region: string;
-    eu: '0' | '1';
+    eu: '0' | '1' | '';
     timezone: string;
     city: string;
     ll: [number | null, number | null];
-    metro: number;
-    area: number;
+    metro: number | null;
+    area: number | null;
 }
 
 export function lookup(ip: string | number): GeoIp2Location | null;