@streamr/geoip-location 100.2.4

package/.eslintignore

@@ -0,0 +1,4 @@
+node_modules/**
+dist/**
+.idea/**
+src/proto/**

package/.eslintrc

@@ -0,0 +1,3 @@
+{
+    "extends": "../../.eslintrc.js"
+}

package/LICENSE

@@ -0,0 +1,174 @@
+                                Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

package/README.md

@@ -0,0 +1,72 @@
+# geoip-location
+
+@streamr/geoip-location is a package that provides a way to detect the latitude and longitude of an IP address using
+the [mmdb-lib reader package](https://www.npmjs.com/package/mmdb-lib) and the MaxMind GeoLite2 City database resdistributed by [GitSquared/node-geolite2-redist](https://github.com/GitSquared/node-geolite2-redist). The library complies with the
+[MaxMind GeoLite2 End User License Agreement] (https://www.maxmind.com/en/geolite2/eula) by keeping the database up-to-date by periodically downloading the fresh database from the GitSquared/node-geolite2-redist repository. 
+
+## Differences to the node-geolite2-redist package
+
+* The period between checks for the updates of the GeoLite2 City database is configurable
+* Distributed as commonjs module for greater compatibility with other packages
+* Better error handling and focus on clean shutdown without lingering timers or memory leaks
+* Fewer dependencies: uses 'fetch' instead of 'got' for downloading the database
+* Only supports the GeoLite2 City database
+* Only returns the latitude and longitude of the IP address
+
+# Getting started
+
+## Installation
+
+```bash
+npm install @streamr/geoip-location
+```
+
+## Usage
+
+```typescript
+import { GeoIpLocator } from '@streamr/geoip-location'
+
+(async () => {
+    
+        // Creates a new GeoIpLocator object with the following parameters:
+        // geoiIpDatabasePath: string - the path to the directory for the GeoLite2 City database
+        // the disrectory will be created if it does not exist. 
+        // dbCheckInterval?: number - the interval in milliseconds between the checks 
+        // for the updates of the GeoLite2 City database (default: 28 days)
+        // dbCheckErrorInterval?: number - the interval in milliseconds between the checks 
+        // for the updates of the GeoLite2 City database in case of a failed update (default: 1 day)
+         
+        const locator = new GeoIpLocator('~/geoipdatabases', 15 * 24 * 60 * 60 * 1000, 60 * 60 * 1000)
+        
+        // Downloads the GeoLite2 City database if it is not found in the geoiIpDatabasePath 
+        // or if the database is outdated. Also starts the db update timer. 
+
+        await locator.start()
+  
+        // Returns the { latitude, longitude } of the IP address 
+        // or undefined if the location cannot be found
+        
+        const location = locator!.lookup('62.241.198.245')
+        
+        console.log(location.latitude)         // 60.1695
+        console.log(location.longitude)        // 24.9354
+        
+        // Stops the db update timer, does not delete the GeoLite2 City database
+
+        locator.stop()
+
+        // (optional) Deletes the GeoLite2 City database
+       
+        fs.unlinkSync(dbDir + '~/geoipdatabases/GeoLite2-City.mmdb')
+
+})()
+```
+
+## License
+
+This package is licensed under the Apache-2.0 license (see [LICENSE](./LICENSE)).
+The databases themselves are provided by MaxMind under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) and redistributed by [GitSquared/node-geolite2-redist](https://github.com/GitSquared/node-geolite2-redist)
+
+
+**This software package uses GeoLite2 data created by MaxMind, available from [https://www.maxmind.com](https://www.maxmind.com).**
+

package/dist/src/GeoIpLocator.d.ts

@@ -0,0 +1,20 @@
+interface GeoIpLookupResult {
+    latitude: number;
+    longitude: number;
+}
+export declare class GeoIpLocator {
+    private abortController;
+    private readonly geoIpDatabaseFolder;
+    private readonly dbCheckInterval;
+    private readonly dbCheckErrorInterval;
+    private readonly mirrorUrl?;
+    private reader?;
+    private dbCheckTimeout?;
+    constructor(geoIpDatabaseFolder: string, dbCheckInterval?: number, dbCheckErrorInterval?: number, mirrorUrl?: string);
+    private checkDatabase;
+    private scheduleCheck;
+    start(): Promise<void>;
+    stop(): void;
+    lookup(ip: string): GeoIpLookupResult | undefined;
+}
+export {};

package/dist/src/GeoIpLocator.js

@@ -0,0 +1,98 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeoIpLocator = void 0;
+const utils_1 = require("@streamr/utils");
+const long_timeout_1 = __importDefault(require("long-timeout"));
+const downloadGeoIpDatabase_1 = require("./downloadGeoIpDatabase");
+const logger = new utils_1.Logger(module);
+// 30 days in milliseconds
+const DEFAULT_DB_CHECK_INTERVAL = 30 * 24 * 60 * 60 * 1000;
+// 24 hours in milliseconds
+const DEFAULT_DB_CHECK_ERROR_INTERVAL = 24 * 60 * 60 * 1000;
+class GeoIpLocator {
+    abortController;
+    geoIpDatabaseFolder;
+    dbCheckInterval;
+    dbCheckErrorInterval;
+    mirrorUrl;
+    reader;
+    dbCheckTimeout;
+    constructor(geoIpDatabaseFolder, dbCheckInterval = DEFAULT_DB_CHECK_INTERVAL, dbCheckErrorInterval = DEFAULT_DB_CHECK_ERROR_INTERVAL, mirrorUrl) {
+        this.abortController = new AbortController();
+        this.dbCheckInterval = dbCheckInterval;
+        this.dbCheckErrorInterval = dbCheckErrorInterval;
+        if (!geoIpDatabaseFolder.endsWith('/')) {
+            geoIpDatabaseFolder += '/';
+        }
+        this.geoIpDatabaseFolder = (0, utils_1.filePathToNodeFormat)(geoIpDatabaseFolder);
+        this.mirrorUrl = mirrorUrl;
+    }
+    checkDatabase = async () => {
+        if (this.reader === undefined) {
+            // if we do not have a reader, create a new one in any case
+            this.reader = await (0, downloadGeoIpDatabase_1.downloadGeoIpDatabase)(this.geoIpDatabaseFolder, true, this.abortController.signal, this.mirrorUrl);
+        }
+        else {
+            // if we already have a reader, create a new one only if db has changed
+            const newReader = await (0, downloadGeoIpDatabase_1.downloadGeoIpDatabase)(this.geoIpDatabaseFolder, false, this.abortController.signal, this.mirrorUrl);
+            if (newReader !== undefined) {
+                this.reader = newReader;
+            }
+        }
+    };
+    scheduleCheck = async (timeout) => {
+        if (this.abortController.signal.aborted) {
+            return;
+        }
+        this.dbCheckTimeout = long_timeout_1.default.setTimeout(async () => {
+            try {
+                await this.checkDatabase();
+                this.scheduleCheck(this.dbCheckInterval);
+            }
+            catch (err) {
+                logger.warn('GeoIpLocator: GeoIP database check failed', { err });
+                this.scheduleCheck(this.dbCheckErrorInterval);
+            }
+        }, timeout);
+    };
+    async start() {
+        if (this.dbCheckTimeout !== undefined) {
+            return;
+        }
+        await this.checkDatabase();
+        this.scheduleCheck(this.dbCheckInterval);
+    }
+    stop() {
+        if (this.dbCheckTimeout !== undefined) {
+            long_timeout_1.default.clearTimeout(this.dbCheckTimeout);
+        }
+        this.abortController.abort();
+    }
+    lookup(ip) {
+        if (this.reader === undefined) {
+            logger.warn('GeoIpLocator: lookup called before database is ready (maybe start() was not called?');
+            return undefined;
+        }
+        // If ip is falsy, the library will crash
+        // this might happen despite the ts typings because the ip address 
+        // comes from the ws server socket and is not under our control
+        if (!ip) {
+            return undefined;
+        }
+        const result = this.reader.get(ip);
+        if (!result || !result.location || !result.location.latitude || !result.location.longitude) {
+            return undefined;
+        }
+        else {
+            return {
+                latitude: result.location.latitude,
+                longitude: result.location.longitude
+            };
+        }
+    }
+}
+exports.GeoIpLocator = GeoIpLocator;
+//# sourceMappingURL=GeoIpLocator.js.map

package/dist/src/GeoIpLocator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GeoIpLocator.js","sourceRoot":"","sources":["../../src/GeoIpLocator.ts"],"names":[],"mappings":";;;;;;AAAA,0CAA6D;AAE7D,gEAAsC;AACtC,mEAA+D;AAE/D,MAAM,MAAM,GAAG,IAAI,cAAM,CAAC,MAAM,CAAC,CAAA;AAOjC,0BAA0B;AAC1B,MAAM,yBAAyB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;AAC1D,2BAA2B;AAC3B,MAAM,+BAA+B,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;AAE3D,MAAa,YAAY;IACb,eAAe,CAAiB;IACvB,mBAAmB,CAAQ;IAC3B,eAAe,CAAQ;IACvB,oBAAoB,CAAQ;IAC5B,SAAS,CAAS;IAC3B,MAAM,CAAuB;IAC7B,cAAc,CAAsB;IAE5C,YACI,mBAA2B,EAC3B,eAAe,GAAG,yBAAyB,EAC3C,oBAAoB,GAAG,+BAA+B,EACtD,SAAkB;QAElB,IAAI,CAAC,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC5C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAA;QACtC,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAA;QAChD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACrC,mBAAmB,IAAI,GAAG,CAAA;QAC9B,CAAC;QACD,IAAI,CAAC,mBAAmB,GAAG,IAAA,4BAAoB,EAAC,mBAAmB,CAAC,CAAA;QACpE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC9B,CAAC;IAEO,aAAa,GAAwB,KAAK,IAAI,EAAE;QACpD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5B,2DAA2D;YAC3D,IAAI,CAAC,MAAM,GAAG,MAAM,IAAA,6CAAqB,EAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;QAC1H,CAAC;aAAM,CAAC;YACJ,uEAAuE;YACvE,MAAM,SAAS,GAAG,MAAM,IAAA,6CAAqB,EAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;YAC3H,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC1B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;YAC3B,CAAC;QACL,CAAC;IACL,CAAC,CAAA;IAEO,aAAa,GAA8B,KAAK,EAAE,OAAe,EAAE,EAAE;QACzE,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACtC,OAAM;QACV,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,sBAAW,CAAC,UAAU,CAAC,KAAK,IAAI,EAAE;YACpD,IAAI,CAAC;gBACD,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;gBAC1B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;YAC5C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,MAAM,CAAC,IAAI,CAAC,2CAA2C,EAAE,EAAE,GAAG,EAAE,CAAC,CAAA;gBACjE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;YACjD,CAAC;QACL,CAAC,EAAE,OAAO,CAAC,CAAA;IACf,CAAC,CAAA;IAED,KAAK,CAAC,KAAK;QACP,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACpC,OAAM;QACV,CAAC;QACD,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QAC1B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IAC5C,CAAC;IAED,IAAI;QACA,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACpC,sBAAW,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QACjD,CAAC;QACD,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAA;IAChC,CAAC;IAED,MAAM,CAAC,EAAU;QACb,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,CAAC,IAAI,CAAC,qFAAqF,CAAC,CAAA;YAClG,OAAO,SAAS,CAAA;QACpB,CAAC;QAED,yCAAyC;QACzC,mEAAmE;QACnE,+DAA+D;QAC/D,IAAI,CAAC,EAAE,EAAE,CAAC;YACN,OAAO,SAAS,CAAA;QACpB,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QAClC,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;YACzF,OAAO,SAAS,CAAA;QACpB,CAAC;aAAM,CAAC;YACJ,OAAO;gBACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ;gBAClC,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;aACvC,CAAA;QACL,CAAC;IACL,CAAC;CACJ;AA3FD,oCA2FC"}

package/dist/src/downloadGeoIpDatabase.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="node" />
+import { CityResponse, Reader } from 'mmdb-lib';
+export declare const downloadGeoIpDatabase: (dbFolder: string, forceReturnReader: boolean, abortSignal: AbortSignal, mirrorUrl?: string) => Promise<Reader<CityResponse> | undefined>;

package/dist/src/downloadGeoIpDatabase.js

@@ -0,0 +1,169 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadGeoIpDatabase = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+const fs_1 = __importDefault(require("fs"));
+const mmdb_lib_1 = require("mmdb-lib");
+const tarHelper_1 = require("./tarHelper");
+const uuid_1 = require("uuid");
+const utils_1 = require("@streamr/utils");
+const GEOIP_MIRROR_URL = 'https://raw.githubusercontent.com/GitSquared/node-geolite2-redist/master/redist/';
+const DB_NAME = 'GeoLite2-City';
+const TAR_SUFFFIX = '.tar.gz';
+const DB_SUFFIX = '.mmdb';
+const HASH_SUFFIX = '.mmdb.sha384';
+const logger = new utils_1.Logger(module);
+const downloadNewDb = async (url, dbFolder, remoteHash, abortSignal) => {
+    // make a unique name for the temporary download folder
+    // in case there are multiple downloads happening at the same time
+    const uniqueName = (0, uuid_1.v4)();
+    const downloadFolder = dbFolder + '.download' + uniqueName;
+    const dbFileName = DB_NAME + DB_SUFFIX;
+    const dbFileInDownloadFolder = downloadFolder + '/' + dbFileName;
+    const dbFileInDbFolder = dbFolder + dbFileName;
+    let response;
+    try {
+        logger.debug('Downloading GeoIP database from: ' + url);
+        response = await fetch(url, { keepalive: false, signal: abortSignal });
+    }
+    catch (e) {
+        // Catching and re-throwing as async exception 
+        // here is necessary, synch exceptions cannot be caught by the caller
+        throw new Error('Fetch error when downloading ' + url + ', error: ' + e);
+    }
+    if (!response.ok) {
+        throw new Error('HTTP error when downloading ' + url + ', status: ' + response.status);
+    }
+    // extract the tarball to a temporary folder
+    try {
+        fs_1.default.mkdirSync(downloadFolder, { recursive: true });
+    }
+    catch (e) {
+        throw new Error('Error creating temporary folder ' + downloadFolder + ', error: ' + e);
+    }
+    try {
+        await (0, tarHelper_1.extractFileFromTarStream)(dbFileName, response.body, downloadFolder);
+    }
+    catch (e) {
+        try {
+            fs_1.default.rmSync(downloadFolder, { recursive: true });
+        }
+        catch (e2) {
+            // ignore error when removing the temporary folder
+        }
+        throw e;
+    }
+    // check the hash of the extracted file
+    if (!isDbFileValid(dbFileInDownloadFolder, remoteHash)) {
+        try {
+            fs_1.default.rmSync(downloadFolder, { recursive: true });
+        }
+        catch (e2) {
+            // ignore error when removing the temporary folder
+        }
+        throw new Error('Downloaded database hash does not match the expected hash');
+    }
+    try {
+        // move the extracted file to the correct location
+        fs_1.default.renameSync(dbFileInDownloadFolder, dbFileInDbFolder);
+    }
+    catch (e) {
+        throw new Error('Error moving ' + dbFileInDownloadFolder + ' to ' + dbFileInDbFolder + ', error: ' + e);
+    }
+    finally {
+        try {
+            fs_1.default.rmSync(downloadFolder, { recursive: true });
+        }
+        catch (e2) {
+            // ignore error when removing the temporary folder
+        }
+    }
+    // set the db file permissions to rw only for the owner
+    try {
+        fs_1.default.chmodSync(dbFileInDbFolder, 0o600);
+    }
+    catch (err) {
+        throw new Error('Error setting permissions on ' + dbFileInDbFolder + ', error: ' + err);
+    }
+    logger.debug('Downloaded GeoIP database to: ' + dbFileInDbFolder);
+};
+const downloadRemoteHash = async (remoteHashUrl, abortSignal) => {
+    // download the hash of the latest GeoIP database using fetch as text and trim it
+    let response;
+    try {
+        logger.debug('Downloading GeoIP database hash from: ' + remoteHashUrl);
+        response = await fetch(remoteHashUrl, { signal: abortSignal });
+    }
+    catch (e) {
+        // Catching and re-throwing as async exception 
+        // here is necessary, synch exceptions cannot be caught by the caller
+        throw new Error('Fetch error when downloading ' + remoteHashUrl + ', error: ' + e);
+    }
+    if (!response.ok) {
+        throw new Error('HTTP error when downloading ' + remoteHashUrl + ', status: ' + response.status);
+    }
+    return (await response.text()).trim();
+};
+const isDbFileValid = async (dbFile, remoteHash) => {
+    // check if the local db exists and calculate its hash
+    try {
+        const db = fs_1.default.readFileSync(dbFile);
+        const localHash = crypto_1.default.createHash('sha384').update(db).digest('hex');
+        // if the hashes are different, download the latest database
+        if (localHash !== remoteHash) {
+            return false;
+        }
+        else {
+            return true;
+        }
+    }
+    catch (e) {
+        // if the local db does not exist, or some other exception occurres db is not considered valid
+        return false;
+    }
+};
+// returns a Reader if a new db was downloaded, or if the caller wants to force return a reader
+// also if there was no need to download a new db
+const downloadGeoIpDatabase = async (dbFolder, forceReturnReader, abortSignal, mirrorUrl) => {
+    // This will throw if the download folder is not readable
+    if (!fs_1.default.existsSync(dbFolder)) {
+        // This will throw if the download folder is not writable
+        fs_1.default.mkdirSync(dbFolder, { recursive: true });
+    }
+    if (!dbFolder.endsWith('/')) {
+        dbFolder += '/';
+    }
+    let geoIpMirrorUrl = GEOIP_MIRROR_URL;
+    if (mirrorUrl !== undefined) {
+        if (!mirrorUrl.endsWith('/')) {
+            mirrorUrl += '/';
+        }
+        geoIpMirrorUrl = mirrorUrl;
+    }
+    const remoteHashUrl = geoIpMirrorUrl + DB_NAME + HASH_SUFFIX;
+    const dbDownloadUrl = geoIpMirrorUrl + DB_NAME + TAR_SUFFFIX;
+    const dbFileInDbFolder = dbFolder + DB_NAME + DB_SUFFIX;
+    const remoteHash = await downloadRemoteHash(remoteHashUrl, abortSignal);
+    const dbValid = await isDbFileValid(dbFileInDbFolder, remoteHash);
+    if (dbValid === false) {
+        await downloadNewDb(dbDownloadUrl, dbFolder, remoteHash, abortSignal);
+        // return new reader if db was downloaded
+        return new mmdb_lib_1.Reader(fs_1.default.readFileSync(dbFileInDbFolder));
+    }
+    else {
+        logger.debug('The hash of the local GeoIP database matches the remote hash, no need to download a new database');
+    }
+    if (forceReturnReader) {
+        // return reader also for old db the caller wants it
+        return new mmdb_lib_1.Reader(fs_1.default.readFileSync(dbFileInDbFolder));
+    }
+    else {
+        // return undefined if the db is already up to date
+        return undefined;
+    }
+};
+exports.downloadGeoIpDatabase = downloadGeoIpDatabase;
+//# sourceMappingURL=downloadGeoIpDatabase.js.map

package/dist/src/downloadGeoIpDatabase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"downloadGeoIpDatabase.js","sourceRoot":"","sources":["../../src/downloadGeoIpDatabase.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA2B;AAC3B,4CAAmB;AACnB,uCAA+C;AAC/C,2CAAsD;AACtD,+BAAyB;AACzB,0CAAuC;AAEvC,MAAM,gBAAgB,GAAG,kFAAkF,CAAA;AAC3G,MAAM,OAAO,GAAG,eAAe,CAAA;AAC/B,MAAM,WAAW,GAAG,SAAS,CAAA;AAC7B,MAAM,SAAS,GAAG,OAAO,CAAA;AACzB,MAAM,WAAW,GAAG,cAAc,CAAA;AAElC,MAAM,MAAM,GAAG,IAAI,cAAM,CAAC,MAAM,CAAC,CAAA;AAEjC,MAAM,aAAa,GAAG,KAAK,EACvB,GAAW,EACX,QAAgB,EAChB,UAAkB,EAClB,WAAwB,EACX,EAAE;IACf,uDAAuD;IACvD,kEAAkE;IAElE,MAAM,UAAU,GAAG,IAAA,SAAE,GAAE,CAAA;IACvB,MAAM,cAAc,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,CAAA;IAC1D,MAAM,UAAU,GAAG,OAAO,GAAG,SAAS,CAAA;IACtC,MAAM,sBAAsB,GAAG,cAAc,GAAG,GAAG,GAAG,UAAU,CAAA;IAChE,MAAM,gBAAgB,GAAG,QAAQ,GAAG,UAAU,CAAA;IAE9C,IAAI,QAAkB,CAAA;IAEtB,IAAI,CAAC;QACD,MAAM,CAAC,KAAK,CAAC,mCAAmC,GAAG,GAAG,CAAC,CAAA;QACvD,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAA;IAC1E,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,+CAA+C;QAC/C,qEAAqE;QACrE,MAAM,IAAI,KAAK,CAAC,+BAA+B,GAAG,GAAG,GAAG,WAAW,GAAG,CAAC,CAAC,CAAA;IAC5E,CAAC;IAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,GAAG,GAAG,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAA;IAC1F,CAAC;IAED,4CAA4C;IAE5C,IAAI,CAAC;QACD,YAAE,CAAC,SAAS,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IACrD,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,kCAAkC,GAAG,cAAc,GAAG,WAAW,GAAG,CAAC,CAAC,CAAA;IAC1F,CAAC;IAED,IAAI,CAAC;QACD,MAAM,IAAA,oCAAwB,EAAC,UAAU,EAAE,QAAQ,CAAC,IAAK,EAAE,cAAc,CAAC,CAAA;IAC9E,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,IAAI,CAAC;YACD,YAAE,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAClD,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACV,kDAAkD;QACtD,CAAC;QACD,MAAM,CAAC,CAAA;IACX,CAAC;IAED,uCAAuC;IAEvC,IAAI,CAAC,aAAa,CAAC,sBAAsB,EAAE,UAAU,CAAC,EAAE,CAAC;QACrD,IAAI,CAAC;YACD,YAAE,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAClD,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACV,kDAAkD;QACtD,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAA;IAChF,CAAC;IAED,IAAI,CAAC;QACD,kDAAkD;QAClD,YAAE,CAAC,UAAU,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,CAAA;IAC3D,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,eAAe,GAAG,sBAAsB,GAAG,MAAM,GAAG,gBAAgB,GAAG,WAAW,GAAG,CAAC,CAAC,CAAA;IAC3G,CAAC;YAAS,CAAC;QACP,IAAI,CAAC;YACD,YAAE,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAClD,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACV,kDAAkD;QACtD,CAAC;IACL,CAAC;IAED,uDAAuD;IAEvD,IAAI,CAAC;QACD,YAAE,CAAC,SAAS,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAA;IACzC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,+BAA+B,GAAG,gBAAgB,GAAG,WAAW,GAAG,GAAG,CAAC,CAAA;IAC3F,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,gCAAgC,GAAG,gBAAgB,CAAC,CAAA;AAErE,CAAC,CAAA;AAED,MAAM,kBAAkB,GAAG,KAAK,EAAE,aAAqB,EAAE,WAAwB,EAAmB,EAAE;IAClG,iFAAiF;IACjF,IAAI,QAAkB,CAAA;IAEtB,IAAI,CAAC;QACD,MAAM,CAAC,KAAK,CAAC,wCAAwC,GAAG,aAAa,CAAC,CAAA;QACtE,QAAQ,GAAG,MAAM,KAAK,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAA;IAClE,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,+CAA+C;QAC/C,qEAAqE;QACrE,MAAM,IAAI,KAAK,CAAC,+BAA+B,GAAG,aAAa,GAAG,WAAW,GAAG,CAAC,CAAC,CAAA;IACtF,CAAC;IAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,aAAa,GAAG,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAA;IACpG,CAAC;IAED,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAA;AACzC,CAAC,CAAA;AAED,MAAM,aAAa,GAAG,KAAK,EAAE,MAAc,EAAE,UAAkB,EAAoB,EAAE;IACjF,sDAAsD;IAEtD,IAAI,CAAC;QACD,MAAM,EAAE,GAAG,YAAE,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAClC,MAAM,SAAS,GAAG,gBAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAEtE,4DAA4D;QAC5D,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAA;QAChB,CAAC;aAAM,CAAC;YACJ,OAAO,IAAI,CAAA;QACf,CAAC;IACL,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,8FAA8F;QAC9F,OAAO,KAAK,CAAA;IAChB,CAAC;AACL,CAAC,CAAA;AAED,+FAA+F;AAC/F,iDAAiD;AAE1C,MAAM,qBAAqB,GAAG,KAAK,EACtC,QAAgB,EAChB,iBAA0B,EAC1B,WAAwB,EACxB,SAAkB,EACuB,EAAE;IAC3C,yDAAyD;IACzD,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3B,yDAAyD;QACzD,YAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IAC/C,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,QAAQ,IAAI,GAAG,CAAA;IACnB,CAAC;IACD,IAAI,cAAc,GAAG,gBAAgB,CAAA;IACrC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3B,SAAS,IAAI,GAAG,CAAA;QACpB,CAAC;QACD,cAAc,GAAG,SAAS,CAAA;IAC9B,CAAC;IACD,MAAM,aAAa,GAAG,cAAc,GAAG,OAAO,GAAG,WAAW,CAAA;IAC5D,MAAM,aAAa,GAAG,cAAc,GAAG,OAAO,GAAG,WAAW,CAAA;IAC5D,MAAM,gBAAgB,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAA;IAEvD,MAAM,UAAU,GAAG,MAAM,kBAAkB,CAAC,aAAa,EAAE,WAAW,CAAC,CAAA;IACvE,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAA;IACjE,IAAI,OAAO,KAAK,KAAK,EAAE,CAAC;QACpB,MAAM,aAAa,CAAC,aAAa,EAAE,QAAQ,EAAE,UAAU,EAAE,WAAW,CAAC,CAAA;QACrE,yCAAyC;QACzC,OAAO,IAAI,iBAAM,CAAe,YAAE,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAA;IACtE,CAAC;SAAM,CAAC;QACJ,MAAM,CAAC,KAAK,CAAC,kGAAkG,CAAC,CAAA;IACpH,CAAC;IACD,IAAI,iBAAiB,EAAE,CAAC;QACpB,oDAAoD;QACpD,OAAO,IAAI,iBAAM,CAAe,YAAE,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAA;IACtE,CAAC;SAAM,CAAC;QACJ,mDAAmD;QACnD,OAAO,SAAS,CAAA;IACpB,CAAC;AACL,CAAC,CAAA;AAzCY,QAAA,qBAAqB,yBAyCjC"}

package/dist/src/exports.d.ts

@@ -0,0 +1 @@
+export { GeoIpLocator } from './GeoIpLocator';

package/dist/src/exports.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeoIpLocator = void 0;
+var GeoIpLocator_1 = require("./GeoIpLocator");
+Object.defineProperty(exports, "GeoIpLocator", { enumerable: true, get: function () { return GeoIpLocator_1.GeoIpLocator; } });
+//# sourceMappingURL=exports.js.map

package/dist/src/exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.js","sourceRoot":"","sources":["../../src/exports.ts"],"names":[],"mappings":";;;AAAA,+CAA6C;AAApC,4GAAA,YAAY,OAAA"}

package/dist/src/tarHelper.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="node" />
+import { ReadableStream } from 'stream/web';
+export declare const extractFileFromTarStream: (fileName: string, stream: ReadableStream<any>, downloadFolder: string) => Promise<void>;

package/dist/src/tarHelper.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractFileFromTarStream = void 0;
+const stream_1 = require("stream");
+const tar_1 = __importDefault(require("tar"));
+const path_1 = __importDefault(require("path")); // use NodePath to avoid conflict with other 'path' symbols
+const fs_1 = __importDefault(require("fs"));
+const doExtractFileFromTarStream = (fileName, stream, downloadFolder) => {
+    return new Promise((resolve, reject) => {
+        try {
+            const nodeStream = stream_1.Readable.fromWeb(stream);
+            (0, stream_1.pipeline)(nodeStream, tar_1.default.x({
+                cwd: downloadFolder,
+                filter: (entryPath) => path_1.default.basename(entryPath) === fileName,
+                strip: 1
+            }), (err) => {
+                if (err) {
+                    reject(new Error('Error extracting tarball to ' + downloadFolder + ', error: ' + err));
+                }
+                else {
+                    resolve();
+                }
+            });
+        }
+        catch (e) {
+            reject(new Error('Failed to create nodejs Readable from web stream: ' + e));
+        }
+    });
+};
+const extractFileFromTarStream = async (fileName, stream, downloadFolder) => {
+    await doExtractFileFromTarStream(fileName, stream, downloadFolder);
+    if (!fs_1.default.existsSync(path_1.default.join(downloadFolder, fileName))) {
+        throw new Error('File not found in tarball: ' + fileName);
+    }
+};
+exports.extractFileFromTarStream = extractFileFromTarStream;
+//# sourceMappingURL=tarHelper.js.map

package/dist/src/tarHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tarHelper.js","sourceRoot":"","sources":["../../src/tarHelper.ts"],"names":[],"mappings":";;;;;;AAAA,mCAA2C;AAC3C,8CAAqB;AAErB,gDAA2B,CAAK,2DAA2D;AAC3F,4CAAmB;AAEnB,MAAM,0BAA0B,GAAG,CAAC,QAAgB,EAAE,MAA2B,EAAE,cAAsB,EAAiB,EAAE;IACxH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACnC,IAAI,CAAC;YACD,MAAM,UAAU,GAAG,iBAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;YAC3C,IAAA,iBAAQ,EAAC,UAAU,EACf,aAAG,CAAC,CAAC,CAAC;gBACF,GAAG,EAAE,cAAc;gBACnB,MAAM,EAAE,CAAC,SAAiB,EAAW,EAAE,CAAC,cAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,QAAQ;gBACjF,KAAK,EAAE,CAAC;aACX,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE;gBACR,IAAI,GAAG,EAAE,CAAC;oBACN,MAAM,CAAC,IAAI,KAAK,CAAC,8BAA8B,GAAG,cAAc,GAAG,WAAW,GAAG,GAAG,CAAC,CAAC,CAAA;gBAC1F,CAAC;qBAAM,CAAC;oBACJ,OAAO,EAAE,CAAA;gBACb,CAAC;YACL,CAAC,CAAC,CAAA;QACV,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,MAAM,CAAC,IAAI,KAAK,CAAC,oDAAoD,GAAG,CAAC,CAAC,CAAC,CAAA;QAC/E,CAAC;IACL,CAAC,CAAC,CAAA;AACN,CAAC,CAAA;AAEM,MAAM,wBAAwB,GAAG,KAAK,EAAE,QAAgB,EAAE,MAA2B,EAAE,cAAsB,EAAiB,EAAE;IACnI,MAAM,0BAA0B,CAAC,QAAQ,EAAE,MAAM,EAAE,cAAc,CAAC,CAAA;IAClE,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,cAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,QAAQ,CAAC,CAAA;IAC7D,CAAC;AACL,CAAC,CAAA;AALY,QAAA,wBAAwB,4BAKpC"}

package/jest.config.js

@@ -0,0 +1,2 @@
+const rootConfig = require('../../jest.config')
+module.exports = rootConfig