Merge pull request #1481 from maxmind/greg/eng-1814

Add support for Anonymous Plus database

Author: oschwald

CHANGELOG.md

@@ -1,6 +1,13 @@
 CHANGELOG
 =========
 
+6.1.0
+------------------
+
+* Support for the GeoIP Anonymous Plus database has been added. To do a
+  lookup in this database, use the `anonymousPlus` method on the
+  database reader.
+
 6.0.0 (2025-02-18)
 ------------------
 

README.md

@@ -205,6 +205,29 @@ Reader.open('/usr/local/share/GeoIP/GeoIP2-Anonymous-IP.mmdb').then(reader => {
 });
 ```
 
+### Anonymous Plus Database Example
+
+```js
+const Reader = require('@maxmind/geoip2-node').Reader;
+// Typescript:
+// import { Reader } from '@maxmind/geoip2-node';
+
+Reader.open('/usr/local/share/GeoIP/GeoIP-Anonymous-Plus.mmdb').then(reader => {
+  const response = reader.anonymousPlus('85.25.43.84');
+
+  console.log(response.anonymizerConfidence); // 30
+  console.log(response.isAnonymous); // true
+  console.log(response.isAnonymousVpn); // false
+  console.log(response.isHostingProvider); // true
+  console.log(response.isPublicProxy); // false
+  console.log(response.isResidentialProxy); // false
+  console.log(response.isTorExitNode); // false
+  console.log(response.ipAddress); // '85.25.43.84'
+  console.log(response.networkLastSeen); // '2025-04-14'
+  console.log(response.providerName); // 'FooBar VPN'
+});
+```
+
 ### ASN Example
 
 ```js

src/models/AnonymousPlus.ts

@@ -0,0 +1,38 @@
+import * as mmdb from 'maxmind';
+import AnonymousIP from './AnonymousIP';
+
+/** Class representing the model of an "AnonymousPlus" response **/
+export default class AnonymousPlus extends AnonymousIP {
+  /**
+   * A score ranging from 1 to 99 that is our percent confidence that the
+   * network is currently part of an actively used VPN service.
+   */
+  public anonymizerConfidence?: number;
+  /**
+   * The last day that the network was sighted in our analysis of anonymized
+   * networks. This is in the ISO 8601 date format, e.g., "2025-04-21".
+   */
+  public networkLastSeen?: string;
+  /**
+   * The name of the VPN provider (e.g., NordVPN, SurfShark, etc.) associated
+   * with the network.
+   */
+  public providerName?: string;
+
+  /**
+   * Instantiates an "AnonymousPlus" using fields from the response
+   *
+   * @param response The GeoIP2 response
+   */
+  public constructor(
+    response: mmdb.AnonymousPlusResponse,
+    ipAddress?: string,
+    network?: string
+  ) {
+    super(response, ipAddress, network);
+
+    this.anonymizerConfidence = response.anonymizer_confidence;
+    this.networkLastSeen = response.network_last_seen;
+    this.providerName = response.provider_name;
+  }
+}

src/models/index.ts

@@ -1,4 +1,5 @@
 import AnonymousIP from './AnonymousIP';
+import AnonymousPlus from './AnonymousPlus';
 import Asn from './Asn';
 import City from './City';
 import ConnectionType from './ConnectionType';
@@ -10,6 +11,7 @@ import Isp from './Isp';
 
 export {
   AnonymousIP,
+  AnonymousPlus,
   Asn,
   City,
   ConnectionType,

src/readerModel.spec.ts

@@ -113,49 +113,6 @@ describe('ReaderModel', () => {
       expect(cityModel).toEqual(expected);
     });
 
-    it('returns data when record only contains city record', async () => {
-      expect.assertions(1);
-
-      const reader = await Reader.open(
-        './test/data/test-data/GeoIP2-City-Test.mmdb'
-      );
-
-      const model = reader.city('2.2.3.1');
-
-      const expected = {
-        city: {
-          geonameId: 2655045,
-          names: {
-            en: 'Boxford',
-          },
-        },
-        continent: undefined,
-        country: undefined,
-        location: undefined,
-        maxmind: undefined,
-        postal: undefined,
-        registeredCountry: undefined,
-        representedCountry: undefined,
-        subdivisions: undefined,
-        traits: {
-          ipAddress: '2.2.3.1',
-          isAnonymous: false,
-          isAnonymousProxy: false,
-          isAnonymousVpn: false,
-          isAnycast: false,
-          isHostingProvider: false,
-          isLegitimateProxy: false,
-          isPublicProxy: false,
-          isResidentialProxy: false,
-          isSatelliteProvider: false,
-          isTorExitNode: false,
-          network: '2.2.3.0/24',
-        },
-      };
-
-      expect(model).toEqual(expected);
-    });
-
     it('returns data when record only contains continent record', async () => {
       expect.assertions(1);
 
@@ -500,6 +457,34 @@ describe('ReaderModel', () => {
     });
   });
 
+  describe('anonymousPlus()', () => {
+    it('returns anonymousPlus data', async () => {
+      expect.assertions(1);
+
+      const reader = await Reader.open(
+        './test/data/test-data/GeoIP-Anonymous-Plus-Test.mmdb'
+      );
+
+      const model = reader.anonymousPlus('1.2.0.1');
+
+      const expected = {
+        anonymizerConfidence: 30,
+        ipAddress: '1.2.0.1',
+        isAnonymous: true,
+        isAnonymousVpn: true,
+        isHostingProvider: false,
+        isPublicProxy: false,
+        isResidentialProxy: false,
+        isTorExitNode: false,
+        network: '1.2.0.1/32',
+        networkLastSeen: '2025-04-14',
+        providerName: 'foo',
+      };
+
+      expect(model).toEqual(expected);
+    });
+  });
+
   describe('asn()', () => {
     it('returns asn data', async () => {
       expect.assertions(1);
@@ -690,6 +675,7 @@ describe('ReaderModel', () => {
             },
           },
           {
+            confidence: 60,
             geonameId: 3333217,
             isoCode: 'WBK',
             names: {

src/readerModel.ts

@@ -19,7 +19,7 @@ export default class ReaderModel {
   }
 
   /**
-   * Returns the AnonymousIP db data for an IP address
+   * Returns the Anonymous IP db data for an IP address
    *
    * @param ipAddress The IP Address you want to query the Anonymous IP db with
    *
@@ -36,6 +36,24 @@ export default class ReaderModel {
     );
   }
 
+  /**
+   * Returns the Anonymous Plus db data for an IP address
+   *
+   * @param ipAddress The IP Address you want to query the Anonymous Plus db with
+   *
+   * @throws {BadMethodCallError} Throws an error when the DB doesn't support Anonymous Plus queries
+   * @throws {AddressNotFoundError} Throws an error when the IP address isn't found in the database
+   * @throws {ValueError} Throws an error when the IP address isn't valid
+   */
+  public anonymousPlus(ipAddress: string): models.AnonymousPlus {
+    return this.modelFor(
+      models.AnonymousPlus,
+      'GeoIP-Anonymous-Plus',
+      ipAddress,
+      'anonymousPlus()'
+    );
+  }
+
   /**
    * Returns the City db data for an IP address
    *