mmdb-lib 2.1.0 → 2.1.1

package/README.md

@@ -63,4 +63,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.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;
     }

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/utils.d.ts

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

package/lib/utils.js

@@ -13,7 +13,13 @@ 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 = {
+    assert,
     concat2,
     concat3,
     concat4,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mmdb-lib",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "homepage": "https://github.com/runk/mmdb-lib",
   "description": "Maxmind DB (MMDB) Library",
   "keywords": [
@@ -16,20 +16,17 @@
     "Uman Shahzad @UmanShahzad"
   ],
   "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",
+    "@types/node": "20.12.8",
+    "@types/sinon": "17.0.3",
     "ip-address": "9.0.5",
     "mocha": "^10.2.0",
     "prettier": "^3.0.0",
-    "semantic-release": "^21.0.0",
+    "semantic-release": "^23.0.0",
     "sinon": "17.0.1",
     "ts-node": "^10.4.0",
-    "typescript": "5.3.2"
+    "typescript": "5.4.5"
   },
   "repository": {
     "type": "git",
@@ -51,8 +48,7 @@
   "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",
     "format": "prettier --write src",