ts-ip2region2 1.2.0 → 1.2.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -69,6 +69,35 @@ new Ip2Region(dbPath: string, options?: Ip2RegionOptions)
 - `Ip2Region.verify(dbPath: string): boolean` - Verify xdb file
 - `Ip2Region.verifyDetailed(dbPath: string): VerifyResult` - Verify with detailed info
 
+## Performance Benchmark
+
+Benchmark results on Windows x64 with Node.js v22.14.0 (10,000 iterations):
+
+| Cache Strategy | Avg Time (μs/op) | QPS |
+|---------------|------------------|-----|
+| file | ~31 | ~32,000 |
+| vectorIndex | ~22 | ~45,000 |
+| content | ~1.3 | ~750,000 |
+
+**Performance Improvements:**
+- vectorIndex is ~40% faster than file mode
+- content is ~95% faster than vectorIndex mode
+- content is ~96% faster than file mode
+
+**Comparison with Native C:**
+- Native C (vectorIndex): ~5 μs/op
+- Node.js Addon (vectorIndex): ~22 μs/op
+- Overhead: ~4.4x (mainly from N-API call overhead)
+
+Despite the N-API overhead, the performance is still excellent for most use cases, achieving 45,000+ QPS with vectorIndex mode.
+
+**Recommendation:** Use `vectorIndex` for most scenarios as it provides excellent performance with moderate memory usage.
+
+Run benchmark yourself:
+```bash
+npm run benchmark
+```
+
 ## License
 
 Apache-2.0

package/addon.cpp

@@ -10,6 +10,33 @@ extern "C" {
 #include "ip2region/xdb_api.h"
 }
 
+#ifdef XDB_WINDOWS
+// Windows UTF-8 path support
+extern "C" {
+    __declspec(dllimport) int __stdcall MultiByteToWideChar(unsigned int, unsigned long, const char*, int, wchar_t*, int);
+}
+#define CP_UTF8 65001
+
+static FILE* fopen_utf8(const char* path, const char* mode) {
+    int path_len = MultiByteToWideChar(CP_UTF8, 0, path, -1, nullptr, 0);
+    if (path_len == 0) return nullptr;
+    
+    wchar_t* wpath = new wchar_t[path_len];
+    MultiByteToWideChar(CP_UTF8, 0, path, -1, wpath, path_len);
+    
+    int mode_len = MultiByteToWideChar(CP_UTF8, 0, mode, -1, nullptr, 0);
+    wchar_t* wmode = new wchar_t[mode_len];
+    MultiByteToWideChar(CP_UTF8, 0, mode, -1, wmode, mode_len);
+    
+    FILE* file = _wfopen(wpath, wmode);
+    delete[] wpath;
+    delete[] wmode;
+    return file;
+}
+#else
+#define fopen_utf8 fopen
+#endif
+
 class Ip2RegionSearcher : public Napi::ObjectWrap<Ip2RegionSearcher> {
 public:
     static Napi::Object Init(Napi::Env env, Napi::Object exports);
@@ -26,10 +53,59 @@ private:
     xdb_vector_index_t* v_index;
     xdb_content_t* c_buffer;
     bool is_initialized;
+    
+    static xdb_vector_index_t* load_vector_index_utf8(const char* path);
+    static xdb_content_t* load_content_utf8(const char* path);
+    static int new_with_file_only_utf8(xdb_version_t* version, xdb_searcher_t* searcher, const char* path);
+    static int new_with_vector_index_utf8(xdb_version_t* version, xdb_searcher_t* searcher, const char* path, const xdb_vector_index_t* v_index);
 };
 
 Napi::FunctionReference Ip2RegionSearcher::constructor;
 
+xdb_vector_index_t* Ip2RegionSearcher::load_vector_index_utf8(const char* path) {
+    FILE* file = fopen_utf8(path, "rb");
+    if (!file) return nullptr;
+    xdb_vector_index_t* v_index = xdb_load_vector_index(file);
+    fclose(file);
+    return v_index;
+}
+
+xdb_content_t* Ip2RegionSearcher::load_content_utf8(const char* path) {
+    FILE* file = fopen_utf8(path, "rb");
+    if (!file) return nullptr;
+    xdb_content_t* content = xdb_load_content(file);
+    fclose(file);
+    return content;
+}
+
+int Ip2RegionSearcher::new_with_file_only_utf8(xdb_version_t* version, xdb_searcher_t* searcher, const char* path) {
+    FILE* file = fopen_utf8(path, "rb");
+    if (!file) return -1;
+    
+    memset(searcher, 0, sizeof(xdb_searcher_t));
+    searcher->version = version;
+    searcher->handle = file;
+    searcher->v_index = nullptr;
+    searcher->content = nullptr;
+    searcher->io_count = 0;
+    
+    return 0;
+}
+
+int Ip2RegionSearcher::new_with_vector_index_utf8(xdb_version_t* version, xdb_searcher_t* searcher, const char* path, const xdb_vector_index_t* v_index) {
+    FILE* file = fopen_utf8(path, "rb");
+    if (!file) return -1;
+    
+    memset(searcher, 0, sizeof(xdb_searcher_t));
+    searcher->version = version;
+    searcher->handle = file;
+    searcher->v_index = v_index;
+    searcher->content = nullptr;
+    searcher->io_count = 0;
+    
+    return 0;
+}
+
 Napi::Object Ip2RegionSearcher::Init(Napi::Env env, Napi::Object exports) {
     Napi::HandleScope scope(env);
 
@@ -91,17 +167,17 @@ Ip2RegionSearcher::Ip2RegionSearcher(const Napi::CallbackInfo& info)
 
     // Initialize searcher based on cache strategy
     if (cache_policy == "file") {
-        err = xdb_new_with_file_only(version, &searcher, db_path.c_str());
+        err = new_with_file_only_utf8(version, &searcher, db_path.c_str());
     } else if (cache_policy == "vectorIndex") {
-        v_index = xdb_load_vector_index_from_file(db_path.c_str());
+        v_index = load_vector_index_utf8(db_path.c_str());
         if (!v_index) {
             xdb_clean_winsock();
             Napi::Error::New(env, "Failed to load vector index from database file").ThrowAsJavaScriptException();
             return;
         }
-        err = xdb_new_with_vector_index(version, &searcher, db_path.c_str(), v_index);
+        err = new_with_vector_index_utf8(version, &searcher, db_path.c_str(), v_index);
     } else if (cache_policy == "content") {
-        c_buffer = xdb_load_content_from_file(db_path.c_str());
+        c_buffer = load_content_utf8(db_path.c_str());
         if (!c_buffer) {
             xdb_clean_winsock();
             Napi::Error::New(env, "Failed to load database content into memory").ThrowAsJavaScriptException();
@@ -213,7 +289,12 @@ Napi::Value VerifyXdb(const Napi::CallbackInfo& info) {
     
     const std::string db_path = info[0].As<Napi::String>().Utf8Value();
     
-    int error_code = xdb_verify_from_file(db_path.c_str());
+    FILE* file = fopen_utf8(db_path.c_str(), "rb");
+    int error_code = -1;
+    if (file) {
+        error_code = xdb_verify(file);
+        fclose(file);
+    }
     
     Napi::Object result = Napi::Object::New(env);
     result.Set("valid", Napi::Boolean::New(env, error_code == 0));

package/ip2region/xdb_api.h

@@ -24,13 +24,16 @@
 #include <ws2tcpip.h>
 #include <windows.h>
 #pragma comment(lib, "ws2_32.lib")
-#elif ( defined(linux) || defined(_UNIX) || defined(__APPLE__) )
+#elif (defined(linux) || defined(_UNIX) || defined(__APPLE__) || defined(unix) || defined(__unix) || defined(__unix__) || defined(__linux__) || defined(linux) || defined(__linux))
 #   define XDB_PUBLIC(type)    extern type
 #   define XDB_PRIVATE(type)   static inline type
 #   define XDB_LINUX
 #include <sys/socket.h>
 #include <netinet/in.h>
 #include <arpa/inet.h>
+#else
+#   define XDB_PUBLIC(type) type
+#   define XDB_PRIVATE(type) static type
 #endif
 
 #define xdb_calloc( _blocks, _bytes )  calloc( _blocks, _bytes )

package/ip2region/xdb_util.c

@@ -245,9 +245,14 @@ XDB_PUBLIC(int) xdb_verify_from_header(FILE *handle, xdb_header_t *header) {
     }
 
     long int fileBytes = ftell(handle);
-    long int maxFilePtr = (1L << (runtime_ptr_bytes * 8)) - 1;
-    // printf("fileBytes: %ld, maxFilePtr: %ld\n", fileBytes, maxFilePtr);
-    if (fileBytes > maxFilePtr) {
+    if (fileBytes < 0) {
+        return 3;
+    }
+    
+    // Use unsigned long long for maxFilePtr to avoid overflow
+    unsigned long long maxFilePtr = (1ULL << (runtime_ptr_bytes * 8)) - 1;
+    // printf("fileBytes: %ld, maxFilePtr: %llu\n", fileBytes, maxFilePtr);
+    if ((unsigned long long)fileBytes > maxFilePtr) {
         return 4;
     }
 

package/package.json

@@ -1,19 +1,9 @@
 {
   "name": "ts-ip2region2",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "TypeScript-first ip2region implementation with native Node.js addon. Ultra-fast IPv4/IPv6 geolocation queries.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "node-gyp rebuild",
-    "compile": "tsc",
-    "build:all": "npm run build && npm run compile",
-    "rebuild": "node-gyp rebuild",
-    "clean": "node-gyp clean",
-    "test": "npm run build:all && node test.js",
-    "example": "npm run build:all && node example.js",
-    "prepublishOnly": "npm run build:all"
-  },
   "keywords": [
     "typescript",
     "ip2region",
@@ -29,7 +19,7 @@
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/Steven-Qiang/ts-ip2region2.git",
+    "url": "git+https://github.com/Steven-Qiang/ts-ip2region2.git",
     "directory": "packages/ts-ip2region2"
   },
   "bugs": {
@@ -38,11 +28,11 @@
   "homepage": "https://github.com/Steven-Qiang/ts-ip2region2#readme",
   "dependencies": {
     "node-addon-api": "^8.5.0",
-    "ts-ip2region2-data": "*"
+    "ts-ip2region2-data": "1.1.1"
   },
   "devDependencies": {
-    "@types/node": "^24.8.1",
-    "node-gyp": "^11.5.0",
+    "@types/node": "^25.2.2",
+    "node-gyp": "^12.2.0",
     "typescript": "^5.9.3"
   },
   "engines": {
@@ -67,6 +57,17 @@
   "gypfile": true,
   "publishConfig": {
     "access": "public",
+    "registry": "https://registry.npmjs.org/",
     "provenance": true
+  },
+  "scripts": {
+    "build": "node-gyp rebuild",
+    "compile": "tsc",
+    "build:all": "pnpm run build && pnpm run compile",
+    "rebuild": "node-gyp rebuild",
+    "clean": "node-gyp clean",
+    "test": "pnpm run build:all && node test.js",
+    "benchmark": "node benchmark.js",
+    "example": "pnpm run build:all && node example.js"
   }
-}
+}