mmdb-lib 2.1.0 → 2.2.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Dmitry Shirokov
+Copyright (c) 2025 Dmitry Shirokov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

package/README.md

@@ -30,6 +30,7 @@ Supported response types:
 - CountryResponse
 - CityResponse
 - AnonymousIPResponse
+- AnonymousPlusResponse
 - AsnResponse
 - ConnectionTypeResponse
 - DomainResponse
@@ -63,4 +64,16 @@ MIT
 
 ## Contributing
 
-add a link
+All contributions are welcome. Please make sure to add tests for your changes.
+
+You need to initialise the repository with the following command:
+
+```shell
+git submodule update --init --recursive
+```
+
+Then you can run tests with:
+
+```shell
+npm test
+```

package/lib/decoder.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Cache } from './types';
 interface Cursor {
     value: any;

package/lib/decoder.js

@@ -3,9 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const assert_1 = __importDefault(require("assert"));
 const utils_1 = __importDefault(require("./utils"));
-(0, assert_1.default)(typeof BigInt !== 'undefined', 'Apparently you are using old version of node. Please upgrade to node 10.4.x or above.');
+utils_1.default.assert(typeof BigInt !== 'undefined', 'Apparently you are using old version of node. Please upgrade to node 10.4.x or above.');
 var DataType;
 (function (DataType) {
     DataType[DataType["Extended"] = 0] = "Extended";
@@ -34,7 +33,8 @@ const cursor = (value, offset) => ({ value, offset });
 class Decoder {
     constructor(db, baseOffset = 0, cache = noCache) {
         this.telemetry = {};
-        (0, assert_1.default)((this.db = db), 'Database buffer is required');
+        utils_1.default.assert(Boolean(db), 'Database buffer is required');
+        this.db = db;
         this.baseOffset = baseOffset;
         this.cache = cache;
     }
@@ -137,11 +137,10 @@ class Decoder {
         // At this point `size` is always 31.
         // If the value is 31, then the size is 65,821 + *the next three bytes after the
         // type specifying bytes as a single unsigned integer*.
-        return cursor(65821 +
-            utils_1.default.concat3(this.db[offset], this.db[offset + 1], this.db[offset + 2]), offset + 3);
+        return cursor(65821 + this.db.readUIntBE(offset, 3), offset + 3);
     }
     decodeBytes(offset, size) {
-        return this.db.slice(offset, offset + size);
+        return this.db.subarray(offset, offset + size);
     }
     decodePointer(ctrlByte, offset) {
         // Pointers use the last five bits in the control byte to calculate the pointer value.
@@ -156,17 +155,17 @@ class Decoder {
         // If the size is 0, the pointer is built by appending the next byte to the last
         // three bits to produce an 11-bit value.
         if (pointerSize === 0) {
-            packed = utils_1.default.concat2(ctrlByte & 7, this.db[offset]);
+            packed = ((ctrlByte & 7) << 8) | this.db[offset];
             // If the size is 1, the pointer is built by appending the next two bytes to the
             // last three bits to produce a 19-bit value + 2048.
         }
         else if (pointerSize === 1) {
-            packed = utils_1.default.concat3(ctrlByte & 7, this.db[offset], this.db[offset + 1]);
+            packed = ((ctrlByte & 7) << 16) | this.db.readUInt16BE(offset);
             // If the size is 2, the pointer is built by appending the next three bytes to the
             // last three bits to produce a 27-bit value + 526336.
         }
         else if (pointerSize === 2) {
-            packed = utils_1.default.concat4(ctrlByte & 7, this.db[offset], this.db[offset + 1], this.db[offset + 2]);
+            packed = ((ctrlByte & 7) << 24) | this.db.readUIntBE(offset, 3);
             // At next point `size` is always 3.
             // Finally, if the size is 3, the pointer's value is contained in the next four
             // bytes as a 32-bit value. In this case, the last three bits of the control byte
@@ -180,11 +179,11 @@ class Decoder {
     }
     decodeArray(size, offset) {
         let tmp;
-        const array = [];
+        const array = new Array(size);
         for (let i = 0; i < size; i++) {
             tmp = this.decode(offset);
             offset = tmp.offset;
-            array.push(tmp.value);
+            array[i] = tmp.value;
         }
         return cursor(array, offset);
     }
@@ -214,29 +213,28 @@ class Decoder {
         if (size === 0) {
             return 0;
         }
+        if (size < 4) {
+            return this.db.readUIntBE(offset, size);
+        }
         return this.db.readInt32BE(offset);
     }
     decodeUint(offset, size) {
-        switch (size) {
-            case 0:
-                return 0;
-            case 1:
-                return this.db[offset];
-            case 2:
-                return utils_1.default.concat2(this.db[offset + 0], this.db[offset + 1]);
-            case 3:
-                return utils_1.default.concat3(this.db[offset + 0], this.db[offset + 1], this.db[offset + 2]);
-            case 4:
-                return utils_1.default.concat4(this.db[offset + 0], this.db[offset + 1], this.db[offset + 2], this.db[offset + 3]);
-            case 8:
-                return this.decodeBigUint(offset, size);
-            case 16:
-                return this.decodeBigUint(offset, size);
-        }
-        return 0;
+        if (size === 0) {
+            return 0;
+        }
+        if (size <= 6) {
+            return this.db.readUIntBE(offset, size);
+        }
+        if (size == 8) {
+            return this.db.readBigInt64BE(offset).toString();
+        }
+        if (size > 16) {
+            return 0;
+        }
+        return this.decodeBigUint(offset, size);
     }
     decodeString(offset, size) {
-        return this.db.slice(offset, offset + size).toString();
+        return this.db.toString('utf8', offset, offset + size);
     }
     decodeBigUint(offset, size) {
         const buffer = Buffer.alloc(size);

package/lib/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Metadata } from './metadata';
 import { Response } from './reader/response';
 import { ReaderOptions } from './types';

package/lib/ip.d.ts

@@ -1,6 +1,5 @@
-/// <reference types="node" />
 declare const _default: {
-    bitAt: (rawAddress: number[] | Buffer, idx: number) => number;
+    bitAt: (rawAddress: Buffer | number[], idx: number) => number;
     parse: (ip: string) => number[];
     validate: (ip: string) => boolean;
 };

package/lib/metadata.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 export interface Metadata {
     readonly binaryFormatMajorVersion: number;
     readonly binaryFormatMinorVersion: number;

package/lib/metadata.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isLegacyFormat = exports.parseMetadata = void 0;
-const assert_1 = __importDefault(require("assert"));
 const decoder_1 = __importDefault(require("./decoder"));
 const utils_1 = __importDefault(require("./utils"));
 const METADATA_START_MARKER = Buffer.from('ABCDEF4D61784D696E642E636F6D', 'hex');
@@ -17,7 +16,7 @@ const parseMetadata = (db) => {
             ? utils_1.default.legacyErrorMessage
             : 'Cannot parse binary database');
     }
-    (0, assert_1.default)([24, 28, 32].indexOf(metadata.record_size) > -1, 'Unsupported record size');
+    utils_1.default.assert([24, 28, 32].indexOf(metadata.record_size) > -1, 'Unsupported record size');
     return {
         binaryFormatMajorVersion: metadata.binary_format_major_version,
         binaryFormatMinorVersion: metadata.binary_format_minor_version,

package/lib/reader/response.d.ts

@@ -96,6 +96,11 @@ export interface AnonymousIPResponse {
     readonly is_residential_proxy?: boolean;
     readonly is_tor_exit_node?: boolean;
 }
+export interface AnonymousPlusResponse extends AnonymousIPResponse {
+    readonly anonymizer_confidence?: number;
+    readonly network_last_seen?: string;
+    readonly provider_name?: string;
+}
 export interface AsnResponse {
     readonly autonomous_system_number: number;
     readonly autonomous_system_organization: string;
@@ -115,5 +120,5 @@ export interface IspResponse extends AsnResponse {
     readonly mobile_network_code?: string;
     readonly organization: string;
 }
-export type Response = CountryResponse | CityResponse | AnonymousIPResponse | AsnResponse | ConnectionTypeResponse | DomainResponse | IspResponse;
+export type Response = CountryResponse | CityResponse | AnonymousIPResponse | AnonymousPlusResponse | AsnResponse | ConnectionTypeResponse | DomainResponse | IspResponse;
 export {};

package/lib/reader/walker.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 type NodeReader = (offset: number) => number;
 export interface Walker {
     left: NodeReader;

package/lib/reader/walker.js

@@ -1,13 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = __importDefault(require("../utils"));
-const readNodeRight24 = (db) => (offset) => utils_1.default.concat3(db[offset + 3], db[offset + 4], db[offset + 5]);
-const readNodeLeft24 = (db) => (offset) => utils_1.default.concat3(db[offset], db[offset + 1], db[offset + 2]);
-const readNodeLeft28 = (db) => (offset) => utils_1.default.concat4(db[offset + 3] >> 4, db[offset], db[offset + 1], db[offset + 2]);
-const readNodeRight28 = (db) => (offset) => utils_1.default.concat4(db[offset + 3] & 0x0f, db[offset + 4], db[offset + 5], db[offset + 6]);
+const readNodeRight24 = (db) => (offset) => db.readUIntBE(offset + 3, 3);
+const readNodeLeft24 = (db) => (offset) => db.readUIntBE(offset, 3);
+const readNodeLeft28 = (db) => (offset) => ((db[offset + 3] & 0xf0) << 20) | db.readUIntBE(offset, 3);
+const readNodeRight28 = (db) => (offset) => ((db[offset + 3] & 0x0f) << 24) | db.readUIntBE(offset + 4, 3);
 const readNodeLeft32 = (db) => (offset) => db.readUInt32BE(offset);
 const readNodeRight32 = (db) => (offset) => db.readUInt32BE(offset + 4);
 exports.default = (db, recordSize) => {

package/lib/utils.d.ts

@@ -1,7 +1,5 @@
 declare const _default: {
-    concat2: (a: number, b: number) => number;
-    concat3: (a: number, b: number, c: number) => number;
-    concat4: (a: number, b: number, c: number, d: number) => number;
+    assert: (condition: boolean, message: string) => void;
     legacyErrorMessage: string;
 };
 export default _default;

package/lib/utils.js

@@ -1,21 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const concat2 = (a, b) => {
-    return (a << 8) | b;
-};
-const concat3 = (a, b, c) => {
-    return (a << 16) | (b << 8) | c;
-};
-const concat4 = (a, b, c, d) => {
-    return (a << 24) | (b << 16) | (c << 8) | d;
-};
 const legacyErrorMessage = `Maxmind v2 module has changed API.\n\
 Upgrade instructions can be found here: \
 https://github.com/runk/node-maxmind/wiki/Migration-guide\n\
 If you want to use legacy library then explicitly install maxmind@1`;
+const assert = (condition, message) => {
+    if (!condition) {
+        throw new Error(message);
+    }
+};
 exports.default = {
-    concat2,
-    concat3,
-    concat4,
+    assert,
     legacyErrorMessage,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mmdb-lib",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "homepage": "https://github.com/runk/mmdb-lib",
   "description": "Maxmind DB (MMDB) Library",
   "keywords": [
@@ -13,23 +13,21 @@
   "author": "Dmitry Shirokov <deadrunk@gmail.com>",
   "contributors": [
     "William Storey @horgh",
-    "Uman Shahzad @UmanShahzad"
+    "Uman Shahzad @UmanShahzad",
+    "Gregory Oschwald @oschwald"
   ],
   "devDependencies": {
-    "@types/ip-address": "6.0.0",
+    "@types/ip-address": "7.0.0",
     "@types/mocha": "^10.0.1",
-    "@types/node": "20.10.3",
-    "@types/sinon": "17.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
-    "@typescript-eslint/parser": "^5.0.0",
-    "eslint": "^8.0.0",
-    "ip-address": "9.0.5",
-    "mocha": "^10.2.0",
-    "prettier": "^3.0.0",
-    "semantic-release": "^21.0.0",
-    "sinon": "17.0.1",
+    "@types/node": "22.14.0",
+    "@types/sinon": "17.0.4",
+    "ip-address": "10.0.1",
+    "mocha": "^11.0.0",
+    "prettier": "^3.5.3",
+    "semantic-release": "^24.0.0",
+    "sinon": "20.0.0",
     "ts-node": "^10.4.0",
-    "typescript": "5.3.2"
+    "typescript": "5.8.2"
   },
   "repository": {
     "type": "git",
@@ -51,11 +49,11 @@
   "license": "MIT",
   "scripts": {
     "build": "rm -rf lib/* && tsc",
-    "lint": "eslint . --ext .ts",
-    "lint:types": "tsc --noEmit",
+    "typecheck": "tsc --noEmit",
     "test": "mocha",
-    "test-imports": "node test/imports/commonjs.js && node test/imports/esm.mjs && ts-node test/imports/typescript.ts",
+    "test:imports": "node test/imports/commonjs.js && node test/imports/esm.mjs && ts-node test/imports/typescript.ts",
     "format": "prettier --write src",
+    "format:check": "prettier --check src",
     "prepublish": "npm run build",
     "semantic-release": "semantic-release"
   }