ts-ip2region2 1.0.0 → 1.0.1

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

@@ -1,4 +1,4 @@
-# ip2region Node.js Addon (TypeScript)
+# ip2region Node.js (TypeScript)
 
 [English](README.md) | [中文](README_CN.md)
 
@@ -9,7 +9,7 @@ High-performance Node.js native addon for ip2region xdb query with IPv4/IPv6 sup
 ## Features
 
 - 🚀 **High Performance** - Native C++ implementation with microsecond-level response
-- 🌐 **IPv4 & IPv6** - Full support for both IPv4 and IPv6 address queries  
+- 🌐 **IPv4 & IPv6** - Full support for both IPv4 and IPv6 address queries
 - 💾 **Multiple Cache Strategies** - file/vectorIndex/content caching options
 - 🔒 **Memory Safe** - Automatic resource management prevents memory leaks
 - 📝 **TypeScript** - Complete TypeScript type definitions included
@@ -18,8 +18,11 @@ High-performance Node.js native addon for ip2region xdb query with IPv4/IPv6 sup
 ## Installation
 
 ```bash
-npm install
-npm run build:all
+npm install ts-ip2region2
+# or
+pnpm add ts-ip2region2
+# or
+yarn add ts-ip2region2
 ```
 
 > **Database Required**: Download the xdb database files from [ip2region data](https://github.com/lionsoul2014/ip2region/tree/master/data) before using.
@@ -27,18 +30,18 @@ npm run build:all
 ## Quick Start
 
 ```typescript
-import Ip2Region from 'ip2region-nodejs';
+import { Ip2Region } from 'ts-ip2region2';
 
 // Create searcher instance
 const searcher = new Ip2Region('./data/ip2region_v4.xdb', {
-    cachePolicy: 'vectorIndex',  // file/vectorIndex/content
-    ipVersion: 'v4'              // v4/v6
+  cachePolicy: 'vectorIndex', // file/vectorIndex/content
+  ipVersion: 'v4', // v4/v6
 });
 
 // Query IP address
-const result = searcher.search('8.8.8.8');
+const result = searcher.search('120.229.45.2');
 console.log(result);
-// Output: { region: 'United States|0|0|Level3', ioCount: 3, took: 1000 }
+// Output: { region: '中国|0|江苏省|苏州市|电信', ioCount: 3, took: 1000 }
 
 // Clean up
 searcher.close();
@@ -47,68 +50,81 @@ searcher.close();
 ## API Reference
 
 ### Constructor
+
 ```typescript
 new Ip2Region(dbPath: string, options?: Ip2RegionOptions)
 ```
 
 ### Methods
+
 - `search(ip: string): SearchResult` - Query IP address location
 - `close(): void` - Release resources
 
 ### Static Methods
+
 - `Ip2Region.verify(dbPath: string): boolean` - Verify xdb file
 - `Ip2Region.verifyDetailed(dbPath: string): VerifyResult` - Verify with detailed info
 
 ### Types
+
 ```typescript
 interface SearchResult {
-    region: string;    // Geographic location
-    ioCount: number;   // IO operation count
-    took: number;      // Query time in microseconds
+  region: string; // Geographic location
+  ioCount: number; // IO operation count
+  took: number; // Query time in microseconds
 }
 
 interface Ip2RegionOptions {
-    cachePolicy?: 'file' | 'vectorIndex' | 'content';
-    ipVersion?: 'v4' | 'v6';
+  cachePolicy?: 'file' | 'vectorIndex' | 'content';
+  ipVersion?: 'v4' | 'v6';
 }
 ```
 
 ## Cache Strategies
 
-| Strategy | Memory | Performance | Use Case |
-|----------|--------|-------------|----------|
-| `file` | Minimal | Good | Memory-constrained |
-| `vectorIndex` | Medium | Better | General use (recommended) |
-| `content` | High | Best | High-concurrency |
+| Strategy      | Memory  | Performance | Use Case                  |
+| ------------- | ------- | ----------- | ------------------------- |
+| `file`        | Minimal | Good        | Memory-constrained        |
+| `vectorIndex` | Medium  | Better      | General use (recommended) |
+| `content`     | High    | Best        | High-concurrency          |
 
 ## Examples
 
 ```bash
-# Run TypeScript example
+# Build and run example
 npm run example
 
-# Run TypeScript tests  
+# Build and run tests
 npm test
+
+# Build native addon
+npm run build
+
+# Compile TypeScript
+npm run compile
 ```
 
 ## Project Structure
 
 ```
-ip2region-nodejs/
+ts-ip2region2/
 ├── src/                       # TypeScript source code
-│   ├── index.ts              # Main TypeScript API
-│   ├── example.ts            # TypeScript example
-│   └── test.ts               # TypeScript tests
+│   └── index.ts              # Main TypeScript API
 ├── dist/                      # Compiled JavaScript output
 │   ├── index.js
 │   ├── index.d.ts
 │   └── ...
+├── data/                      # Sample xdb database files
+│   ├── ip2region_v4.xdb
+│   └── ip2region_v6.xdb
 ├── ip2region/                 # Original ip2region C source code
 │   ├── xdb_api.h
 │   ├── xdb_util.c
 │   └── xdb_searcher.c
 ├── addon.cpp                  # Node.js addon implementation
 ├── binding.gyp                # Build configuration
+├── example.js                 # JavaScript example
+├── test.js                    # JavaScript tests
 ├── tsconfig.json              # TypeScript configuration
 ├── package.json
 └── README.md
@@ -117,4 +133,3 @@ ip2region-nodejs/
 ## License
 
 Apache-2.0
-

package/README_CN.md

@@ -1,10 +1,10 @@
-# ip2region Node.js Addon (TypeScript)
+# ip2region Node.js (TypeScript)
 
 [English](README.md) | [中文](README_CN.md)
 
 高性能的 ip2region xdb 查询 Node.js 原生扩展，支持 IPv4/IPv6。使用 TypeScript 编写，包含完整的类型定义。
 
-> **说明**: 本项目基于官方 [ip2region C语言客户端](https://github.com/lionsoul2014/ip2region/tree/master/binding/c) 改造，并增强了 TypeScript 支持。
+> **说明**: 本项目基于官方 [ip2region C 语言客户端](https://github.com/lionsoul2014/ip2region/tree/master/binding/c) 改造，并增强了 TypeScript 支持。
 
 ## 特性
 
@@ -18,8 +18,11 @@
 ## 安装
 
 ```bash
-npm install
-npm run build:all
+npm install ts-ip2region2
+# or
+pnpm add ts-ip2region2
+# or
+yarn add ts-ip2region2
 ```
 
 > **需要数据库**: 使用前请从 [ip2region data](https://github.com/lionsoul2014/ip2region/tree/master/data) 下载 xdb 数据库文件。
@@ -27,18 +30,18 @@ npm run build:all
 ## 快速开始
 
 ```typescript
-import Ip2Region from 'ip2region-nodejs';
+import { Ip2Region } from 'ts-ip2region2';
 
 // 创建查询器实例
 const searcher = new Ip2Region('./data/ip2region_v4.xdb', {
-    cachePolicy: 'vectorIndex',  // file/vectorIndex/content
-    ipVersion: 'v4'              // v4/v6
+  cachePolicy: 'vectorIndex', // file/vectorIndex/content
+  ipVersion: 'v4', // v4/v6
 });
 
 // 查询IP地址
-const result = searcher.search('8.8.8.8');
+const result = searcher.search('120.229.45.2');
 console.log(result);
-// 输出: { region: 'United States|0|0|Level3', ioCount: 3, took: 1000 }
+// 输出: { region: '中国|0|江苏省|苏州市|电信', ioCount: 3, took: 1000 }
 
 // 清理资源
 searcher.close();
@@ -47,68 +50,81 @@ searcher.close();
 ## API 参考
 
 ### 构造函数
+
 ```typescript
 new Ip2Region(dbPath: string, options?: Ip2RegionOptions)
 ```
 
 ### 方法
-- `search(ip: string): SearchResult` - 查询IP地址位置
+
+- `search(ip: string): SearchResult` - 查询 IP 地址位置
 - `close(): void` - 释放资源
 
 ### 静态方法
-- `Ip2Region.verify(dbPath: string): boolean` - 验证xdb文件
+
+- `Ip2Region.verify(dbPath: string): boolean` - 验证 xdb 文件
 - `Ip2Region.verifyDetailed(dbPath: string): VerifyResult` - 验证并返回详细信息
 
 ### 类型定义
+
 ```typescript
 interface SearchResult {
-    region: string;    // 地理位置
-    ioCount: number;   // IO操作次数
-    took: number;      // 查询耗时(微秒)
+  region: string; // 地理位置
+  ioCount: number; // IO操作次数
+  took: number; // 查询耗时(微秒)
 }
 
 interface Ip2RegionOptions {
-    cachePolicy?: 'file' | 'vectorIndex' | 'content';
-    ipVersion?: 'v4' | 'v6';
+  cachePolicy?: 'file' | 'vectorIndex' | 'content';
+  ipVersion?: 'v4' | 'v6';
 }
 ```
 
 ## 缓存策略
 
-| 策略 | 内存占用 | 性能 | 使用场景 |
-|------|----------|------|----------|
-| `file` | 最小 | 良好 | 内存受限环境 |
-| `vectorIndex` | 中等 | 更好 | 一般使用(推荐) |
-| `content` | 较高 | 最佳 | 高并发场景 |
+| 策略          | 内存占用 | 性能 | 使用场景       |
+| ------------- | -------- | ---- | -------------- |
+| `file`        | 最小     | 良好 | 内存受限环境   |
+| `vectorIndex` | 中等     | 更好 | 一般使用(推荐) |
+| `content`     | 较高     | 最佳 | 高并发场景     |
 
 ## 示例
 
 ```bash
-# 运行 TypeScript 示例
+# 构建并运行示例
 npm run example
 
-# 运行 TypeScript 测试
+# 构建并运行测试
 npm test
+
+# 构建原生扩展
+npm run build
+
+# 编译 TypeScript
+npm run compile
 ```
 
 ## 项目结构
 
 ```
-ip2region-nodejs/
+ts-ip2region2/
 ├── src/                       # TypeScript 源代码
-│   ├── index.ts              # 主要 TypeScript API
-│   ├── example.ts            # TypeScript 示例
-│   └── test.ts               # TypeScript 测试
+│   └── index.ts              # 主要 TypeScript API
 ├── dist/                      # 编译后的 JavaScript 输出
 │   ├── index.js
 │   ├── index.d.ts
 │   └── ...
+├── data/                      # 示例 xdb 数据库文件
+│   ├── ip2region_v4.xdb
+│   └── ip2region_v6.xdb
 ├── ip2region/                 # 原始 ip2region C 源代码
 │   ├── xdb_api.h
 │   ├── xdb_util.c
 │   └── xdb_searcher.c
 ├── addon.cpp                  # Node.js 扩展实现
 ├── binding.gyp                # 构建配置
+├── example.js                 # JavaScript 示例
+├── test.js                    # JavaScript 测试
 ├── tsconfig.json              # TypeScript 配置
 ├── package.json
 └── README.md
@@ -116,4 +132,4 @@ ip2region-nodejs/
 
 ## 许可证
 
-Apache-2.0
+Apache-2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-ip2region2",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "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",
@@ -37,19 +37,19 @@
   },
   "homepage": "https://github.com/Steven-Qiang/ts-ip2region2#readme",
   "dependencies": {
-    "node-addon-api": "^7.0.0"
+    "node-addon-api": "^8.5.0"
   },
   "devDependencies": {
-    "@types/node": "^20.19.19",
-    "node-gyp": "^10.0.0",
-    "typescript": "^5.9.3",
-    "semantic-release": "^22.0.0",
-    "@semantic-release/changelog": "^6.0.0",
-    "@semantic-release/commit-analyzer": "^11.0.0",
-    "@semantic-release/git": "^10.0.0",
-    "@semantic-release/github": "^9.0.0",
-    "@semantic-release/npm": "^11.0.0",
-    "@semantic-release/release-notes-generator": "^12.0.0"
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^11.0.6",
+    "@semantic-release/npm": "^12.0.2",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "@types/node": "^24.7.0",
+    "node-gyp": "^11.4.2",
+    "semantic-release": "^24.2.9",
+    "typescript": "^5.9.3"
   },
   "engines": {
     "node": ">=16.0.0"
@@ -73,6 +73,7 @@
   ],
   "gypfile": true,
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   }
-}
+}