@uruhalushia/rule-converter-napi 0.1.3 → 0.3.0

package/README.md

@@ -14,10 +14,15 @@ pnpm --dir napi build
 ```js
 import { writeFileSync } from 'node:fs'
 import {
-  convertPayloadStringToMrs,
-  convertPayloadStringToString,
-  convertFileToBuffer,
-  convertFileToPath,
+  fileToBuf,
+  detectFile,
+  listAsnNumbers,
+  listGeoipCountries,
+  listGeoipDatCountries,
+  listGeositeCodes,
+  matchFile,
+  strToBuf,
+  strToStr,
 } from '@uruhalushia/rule-converter-napi'
 
 const payload = `
@@ -27,7 +32,7 @@ payload:
   - IP-CIDR,192.168.1.0/24,no-resolve
 `
 
-const result = convertPayloadStringToMrs(payload, {
+const mrs = strToBuf(payload, {
   inputTarget: 'mihomo',
   inputFormat: 'yaml',
   inputBehavior: 'classical',
@@ -36,11 +41,9 @@ const result = convertPayloadStringToMrs(payload, {
   outputBehavior: 'domain',
 })
 
-for (const output of result.outputs) {
-  writeFileSync(`${output.behavior}.mrs`, output.bytes)
-}
+writeFileSync('domain.mrs', mrs.outputs.domain)
 
-const text = convertPayloadStringToString(payload, {
+const text = strToStr(payload, {
   inputTarget: 'mihomo',
   inputFormat: 'yaml',
   inputBehavior: 'classical',
@@ -49,71 +52,122 @@ const text = convertPayloadStringToString(payload, {
   outputBehavior: 'classical',
 })
 
-console.log(text.outputs[0].text)
+console.log(text.outputs.classical)
 
-const srs = convertFileToBuffer('rules.yaml', {
+const srs = fileToBuf('rules.yaml', {
   outputTarget: 'sing-box',
   outputFormat: 'srs',
   outputBehavior: 'classical',
 })
 
-writeFileSync('rules.srs', srs.outputs[0].buffer)
+writeFileSync('classical.srs', srs.outputs.classical)
 
-const written = convertFileToPath('rules.yaml', 'dist/rules.list', {
+const geoip = fileToBuf('country.mmdb', {
+  inputTarget: 'geoip',
   outputTarget: 'general',
-  outputFormat: 'ruleset',
-  outputBehavior: 'classical',
+  outputFormat: 'ipset',
+  countries: ['cn'],
 })
 
-console.log(written.outputs)
-```
+writeFileSync('cn.list', geoip.outputs.cn)
+
+const singDb = fileToBuf('country.mmdb', {
+  inputTarget: 'geoip',
+  outputTarget: 'geoip',
+  outputFormat: 'sing-db',
+})
+
+writeFileSync('country.sing.db', singDb.outputs.db)
 
-Multiple files can be merged by passing a path array, a directory path, or a final-component `*` wildcard:
+console.log(listGeoipCountries('country.mmdb'))
+console.log(listGeoipDatCountries('geoip.dat'))
+console.log(listGeositeCodes('geosite.dat'))
+console.log(listAsnNumbers('GeoLite2-ASN.mmdb'))
+console.log(detectFile('geosite.dat'))
+```
 
 ```js
-convertFileToPath(['/path/rules-a.yaml', '/path/rules-b.yaml'], 'dist/ad.mrs', {
-  outputTarget: 'mihomo',
-  outputFormat: 'mrs',
-  outputBehavior: 'domain',
+const match = matchFile('rules.list', 'ads.example.com', {
+  inputTarget: 'general',
+  inputFormat: 'text',
+  inputBehavior: 'classical',
 })
+console.log(match.matched, match.rules)
+
+const route = matchFile('config.yaml', 'github.com')
+console.log(route.matched, route.rules)
 ```
 
+`outputs` is a name-keyed object. Rule output keys are usually behavior names such as `domain`, `ip`, or `classical`. DB export keys are country codes, ASN numbers, or `db` for a generated database.
+
 ## API
 
-- `convertPayloadToMrs(payload, options?)`: accepts `Uint8Array` and returns generated MRS files in memory.
-- `convertPayloadStringToMrs(payload, options?)`: accepts a string and returns generated MRS files in memory.
-- `convertFileToMrs(input, options?)`: reads one file, directory, wildcard, or path array and returns generated MRS files in memory.
-- `convertPayloadToBuffer(payload, options?)`: accepts `Uint8Array` and returns generated files as Node.js `Buffer` objects in memory.
-- `convertPayloadStringToBuffer(payload, options?)`: accepts a string and returns generated files as Node.js `Buffer` objects in memory.
-- `convertFileToBuffer(input, options?)`: reads one file, directory, wildcard, or path array and returns generated files as Node.js `Buffer` objects in memory.
-- `convertPayloadToString(payload, options?)`: accepts `Uint8Array` and returns generated text output as strings.
-- `convertPayloadStringToString(payload, options?)`: accepts a string and returns generated text output as strings.
-- `convertFileToString(input, options?)`: reads one file, directory, wildcard, or path array and returns generated text output as strings.
-- `convertFileToPath(input, output, options?)`: writes converted outputs to disk.
+- `bufToBuf(input, options?)`: converts a `Uint8Array` payload and returns byte outputs.
+- `strToBuf(input, options?)`: converts a string payload and returns byte outputs.
+- `fileToBuf(input, options?)`: converts one input file path and returns byte outputs.
+- `bufToStr(input, options?)`: converts a `Uint8Array` payload and returns UTF-8 text outputs.
+- `strToStr(input, options?)`: converts a string payload and returns UTF-8 text outputs.
+- `fileToStr(input, options?)`: converts one input file path and returns UTF-8 text outputs.
+- `detectBuf(input)` / `detectStr(input)` / `detectFile(input)`: returns `{ kind, target, format, behavior }` without converting input.
+- `listGeoipCountries(input)`: reads a GeoIP MMDB file path and returns sorted country codes.
+- `listGeoipCountriesFromBuffer(input)`: reads GeoIP MMDB bytes and returns sorted country codes.
+- `listGeoipDatCountries(input)` / `listGeoipDatCountriesFromBuffer(input)`: reads V2Ray `geoip.dat` and returns sorted country codes.
+- `listGeositeCodes(input)` / `listGeositeCodesFromBuffer(input)`: reads V2Ray `geosite.dat` or sing-geosite DB and returns sorted site codes.
+- `listAsnNumbers(input)`: reads an ASN MMDB file path and returns sorted ASN numbers.
+- `listAsnNumbersFromBuffer(input)`: reads ASN MMDB bytes and returns sorted ASN numbers.
+- `matchBuf(input, query, options?)` / `matchStr(input, query, options?)` / `matchFile(input, query, options?)`: matches a domain or IP against rules and returns `{ matched, query, kind, rules }`. Mihomo config input is supported for provider `path`, `file://`, and HTTP(S) `url`. HTTP providers are downloaded into memory for matching.
 
 ```ts
-interface ConvertOptions {
-  inputTarget?: 'mihomo' | 'general' | 'egern' | 'sing-box'
-  inputFormat?: 'yaml' | 'mrs' | 'text' | 'json' | 'srs'
+interface AnyConvertOptions {
+  inputTarget?: 'mihomo' | 'general' | 'egern' | 'sing-box' | 'geoip' | 'geosite' | 'asn'
+  inputFormat?: 'yaml' | 'mrs' | 'text' | 'json' | 'srs' | 'domainset' | 'ruleset' | 'ipset' | 'mmdb' | 'sing-db' | 'metadb' | 'dat' | 'sing-geosite'
   inputBehavior?: 'auto' | 'domain' | 'ip' | 'classical'
-  outputTarget?: 'mihomo' | 'general' | 'egern' | 'sing-box'
-  outputFormat?: 'mrs' | 'text' | 'yaml' | 'json' | 'srs' | 'domainset' | 'ruleset' | 'ipset'
-  outputBehavior?: 'domain' | 'ip' | 'classical'
+  outputTarget?: 'mihomo' | 'general' | 'egern' | 'sing-box' | 'geoip' | 'geosite' | 'asn'
+  outputFormat?: 'mrs' | 'text' | 'yaml' | 'json' | 'srs' | 'domainset' | 'ruleset' | 'ipset' | 'mmdb' | 'sing-db' | 'metadb' | 'dat' | 'sing-geosite'
+  outputBehavior?: 'auto' | 'domain' | 'ip' | 'classical'
+  countries?: string[]
+  codes?: string[]
+  asns?: number[]
+  split?: boolean
+  country?: string
+  code?: string
+  asn?: number
+}
+
+interface AnyBufferResult {
+  kind: 'rules' | 'db'
+  outputs: Record<string, Uint8Array>
+  info: Record<string, AnyOutputInfo>
+  skipped: SkippedRule[]
+}
+
+interface AnyStringResult {
+  kind: 'rules' | 'db'
+  outputs: Record<string, string>
+  info: Record<string, AnyOutputInfo>
+  skipped: SkippedRule[]
 }
 ```
 
 Defaults:
 
-- `inputTarget`: auto-detected
+- `inputTarget`: auto-detected rule input unless set to `geoip`, `geosite`, or `asn`
 - `inputFormat`: auto-detected
 - `inputBehavior`: `auto`
-- `outputTarget`: `mihomo`
-- `outputFormat`: `mrs`
-- `outputBehavior`: `domain`
-
-mihomo MRS output supports only `domain` and `ip`. sing-box JSON/SRS is available with `outputTarget: 'sing-box'` and `outputFormat: 'json' | 'srs'`.
-
-String output supports text formats only: `text`, `yaml`, `json`, `domainset`, `ruleset`, and `ipset`. Use the buffer functions for binary `mrs` and `srs` output.
+- `outputTarget`: `mihomo` for rule input, `general` for DB-to-rules export, or the same DB target for DB conversion
+- `outputFormat`: `mrs` for rule input, `ipset` for DB-to-rules export, or `mmdb` for DB conversion
+- `outputBehavior`: selected from the target/format default
+- `split`: `true` for DB-to-rules export
+
+DB conversions use the same functions as rule conversions:
+
+- `inputTarget: 'geoip'`, `outputTarget: 'general' | 'mihomo' | 'egern' | 'sing-box'` exports GeoIP contents as rule sets.
+- `inputTarget: 'asn'`, `outputTarget: 'general' | 'mihomo' | 'egern' | 'sing-box'` exports ASN contents as rule sets.
+- `inputTarget: 'geoip'`, `outputTarget: 'geoip'` converts GeoIP DB bytes between `mmdb`, `sing-db`, `metadb`, and V2Ray `dat`.
+- `inputTarget: 'geosite'`, `outputTarget: 'general' | 'mihomo' | 'egern' | 'sing-box'` exports V2Ray `geosite.dat` or sing-geosite DB as rule sets.
+- `inputTarget: 'geosite'`, `outputTarget: 'geosite'` converts and filters geosite DB between `dat` and `sing-geosite`.
+- `inputTarget: 'asn'`, `outputTarget: 'asn'` normalizes ASN MMDB bytes. ASN DB output only supports `mmdb`.
+- Rule input can build DB output with `outputTarget: 'geoip'` plus `country`, `outputTarget: 'geosite'` plus `code`, or `outputTarget: 'asn'` plus `asn`.
 
 `mihomo + text/yaml + domain` uses mihomo/Clash domain wildcard syntax such as `+.example.com`; `general + domainset + domain` uses domain-set syntax where `.example.com` means the domain itself and all subdomains.
 

package/index.d.ts

@@ -1,79 +1,118 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
-export interface ConvertBufferOutput {
-  behavior: 'domain' | 'ip'
+export interface AnyBufferResult {
+  kind: 'rules' | 'db'
+  outputs: Record<string, Uint8Array>
+  info: Record<string, AnyOutputInfo>
+  skipped: Array<SkippedRule>
+}
+
+export interface AnyConvertOptions {
+  inputTarget?: 'mihomo' | 'general' | 'egern' | 'sing-box' | 'geoip' | 'geosite' | 'asn'
+  inputFormat?: 'yaml' | 'mrs' | 'text' | 'json' | 'srs' | 'domainset' | 'ruleset' | 'ipset' | 'mmdb' | 'sing-db' | 'metadb' | 'dat' | 'sing-geosite'
+  inputBehavior?: 'auto' | 'domain' | 'ip' | 'classical'
+  outputTarget?: 'mihomo' | 'general' | 'egern' | 'sing-box' | 'geoip' | 'geosite' | 'asn'
+  outputFormat?: 'mrs' | 'text' | 'yaml' | 'json' | 'srs' | 'domainset' | 'ruleset' | 'ipset' | 'mmdb' | 'sing-db' | 'metadb' | 'dat' | 'sing-geosite'
+  outputBehavior?: 'auto' | 'domain' | 'ip' | 'classical'
+  countries?: Array<string>
+  codes?: Array<string>
+  asns?: Array<number>
+  split?: boolean
+  country?: string
+  code?: string
+  asn?: number
+}
+
+export interface AnyOutputInfo {
+  behavior?: string
+  format: string
   count: number
-  buffer: Uint8Array
 }
 
-export interface ConvertBufferResult {
-  outputs: Array<ConvertBufferOutput>
+export interface AnyStringResult {
+  kind: 'rules' | 'db'
+  outputs: Record<string, string>
+  info: Record<string, AnyOutputInfo>
   skipped: Array<SkippedRule>
 }
 
-export declare function convertFileToBuffer(input: string | string[], options?: ConvertOptions | undefined | null): ConvertBufferResult
+export declare function bufToBuf(input: Uint8Array, options?: AnyConvertOptions | undefined | null): AnyBufferResult
 
-export declare function convertFileToMrs(input: string | string[], options?: ConvertOptions | undefined | null): ConvertResult
+export declare function bufToStr(input: Uint8Array, options?: AnyConvertOptions | undefined | null): AnyStringResult
 
-export declare function convertFileToPath(input: string | string[], output: string, options?: ConvertOptions | undefined | null): WriteResult
+export declare function detectBuf(input: Uint8Array): DetectResult
 
-export declare function convertFileToString(input: string | string[], options?: ConvertOptions | undefined | null): ConvertStringResult
+export declare function detectFile(input: string): DetectResult
 
-export interface ConvertOptions {
-  inputTarget?: 'mihomo' | 'general' | 'egern' | 'sing-box'
-  inputFormat?: 'yaml' | 'mrs' | 'text' | 'json' | 'srs'
-  inputBehavior?: 'auto' | 'domain' | 'ip' | 'classical'
-  outputTarget?: 'mihomo' | 'general' | 'egern' | 'sing-box'
-  outputFormat?: 'mrs' | 'text' | 'yaml' | 'json' | 'srs' | 'domainset' | 'ruleset' | 'ipset'
-  outputBehavior?: 'auto' | 'domain' | 'ip' | 'classical'
+export interface DetectResult {
+  kind: 'rules' | 'db'
+  target: 'mihomo' | 'general' | 'egern' | 'sing-box' | 'geoip' | 'geosite' | 'asn'
+  format: string
+  behavior?: string
 }
 
-export interface ConvertOutput {
-  behavior: 'domain' | 'ip'
-  count: number
-  bytes: Uint8Array
+export declare function detectStr(input: string): DetectResult
+
+export declare function fileToBuf(input: string, options?: AnyConvertOptions | undefined | null): AnyBufferResult
+
+export declare function fileToStr(input: string, options?: AnyConvertOptions | undefined | null): AnyStringResult
+
+export interface IndexSection {
+  title: string
+  items: Array<string>
 }
 
-export declare function convertPayloadStringToBuffer(payload: string, options?: ConvertOptions | undefined | null): ConvertBufferResult
+export declare function listAsnNumbers(input: string): Array<number>
 
-export declare function convertPayloadStringToMrs(payload: string, options?: ConvertOptions | undefined | null): ConvertResult
+export declare function listAsnNumbersFromBuffer(input: Uint8Array): Array<number>
 
-export declare function convertPayloadStringToString(payload: string, options?: ConvertOptions | undefined | null): ConvertStringResult
+export declare function listGeoipCountries(input: string): Array<string>
 
-export declare function convertPayloadToBuffer(payload: Uint8Array, options?: ConvertOptions | undefined | null): ConvertBufferResult
+export declare function listGeoipCountriesFromBuffer(input: Uint8Array): Array<string>
 
-export declare function convertPayloadToMrs(payload: Uint8Array, options?: ConvertOptions | undefined | null): ConvertResult
+export declare function listGeoipDatCountries(input: string): Array<string>
 
-export declare function convertPayloadToString(payload: Uint8Array, options?: ConvertOptions | undefined | null): ConvertStringResult
+export declare function listGeoipDatCountriesFromBuffer(input: Uint8Array): Array<string>
 
-export interface ConvertResult {
-  outputs: Array<ConvertOutput>
-  skipped: Array<SkippedRule>
+export declare function listGeositeCodes(input: string): Array<string>
+
+export declare function listGeositeCodesFromBuffer(input: Uint8Array): Array<string>
+
+export declare function listIndexes(input: string): Array<IndexSection>
+
+export declare function listIndexesFromBuffer(input: Uint8Array): Array<IndexSection>
+
+export declare function matchBuf(input: Uint8Array, query: string, options?: MatchOptions | undefined | null): MatchResult
+
+export declare function matchFile(input: string, query: string, options?: MatchOptions | undefined | null): MatchResult
+
+export interface MatchOptions {
+  inputTarget?: 'mihomo' | 'general' | 'egern' | 'sing-box' | 'geoip' | 'geosite' | 'asn'
+  inputFormat?: 'yaml' | 'mrs' | 'text' | 'json' | 'srs' | 'domainset' | 'ruleset' | 'ipset' | 'dat' | 'sing-geosite' | 'mmdb' | 'sing-db' | 'metadb'
+  inputBehavior?: 'auto' | 'domain' | 'ip' | 'classical'
 }
 
-export interface ConvertStringOutput {
-  behavior: 'domain' | 'ip'
-  count: number
-  text: string
+export interface MatchResult {
+  matched: boolean
+  query: string
+  kind: string
+  rules: Array<MatchRule>
 }
 
-export interface ConvertStringResult {
-  outputs: Array<ConvertStringOutput>
-  skipped: Array<SkippedRule>
+export interface MatchRule {
+  behavior: string
+  rule: string
+  source?: string
+  set?: string
 }
 
+export declare function matchStr(input: string, query: string, options?: MatchOptions | undefined | null): MatchResult
+
 export interface SkippedRule {
   rule: string
   reason: string
 }
 
-export interface WriteResult {
-  outputs: Array<WrittenOutput>
-  skipped: Array<SkippedRule>
-}
+export declare function strToBuf(input: string, options?: AnyConvertOptions | undefined | null): AnyBufferResult
 
-export interface WrittenOutput {
-  behavior: 'domain' | 'ip'
-  count: number
-  path: string
-}
+export declare function strToStr(input: string, options?: AnyConvertOptions | undefined | null): AnyStringResult

package/index.js

@@ -92,13 +92,22 @@ if (!nativeBinding) {
 }
 
 export default nativeBinding
-export const convertPayloadToMrs = nativeBinding.convertPayloadToMrs
-export const convertPayloadStringToMrs = nativeBinding.convertPayloadStringToMrs
-export const convertPayloadToBuffer = nativeBinding.convertPayloadToBuffer
-export const convertPayloadStringToBuffer = nativeBinding.convertPayloadStringToBuffer
-export const convertPayloadToString = nativeBinding.convertPayloadToString
-export const convertPayloadStringToString = nativeBinding.convertPayloadStringToString
-export const convertFileToMrs = nativeBinding.convertFileToMrs
-export const convertFileToBuffer = nativeBinding.convertFileToBuffer
-export const convertFileToString = nativeBinding.convertFileToString
-export const convertFileToPath = nativeBinding.convertFileToPath
+export const bufToBuf = nativeBinding.bufToBuf
+export const strToBuf = nativeBinding.strToBuf
+export const fileToBuf = nativeBinding.fileToBuf
+export const bufToStr = nativeBinding.bufToStr
+export const strToStr = nativeBinding.strToStr
+export const fileToStr = nativeBinding.fileToStr
+export const listIndexes = nativeBinding.listIndexes
+export const listIndexesFromBuffer = nativeBinding.listIndexesFromBuffer
+export const listGeoipCountries = nativeBinding.listGeoipCountries
+export const listGeoipCountriesFromBuffer = nativeBinding.listGeoipCountriesFromBuffer
+export const listGeoipDatCountries = nativeBinding.listGeoipDatCountries
+export const listGeoipDatCountriesFromBuffer = nativeBinding.listGeoipDatCountriesFromBuffer
+export const listGeositeCodes = nativeBinding.listGeositeCodes
+export const listGeositeCodesFromBuffer = nativeBinding.listGeositeCodesFromBuffer
+export const listAsnNumbers = nativeBinding.listAsnNumbers
+export const listAsnNumbersFromBuffer = nativeBinding.listAsnNumbersFromBuffer
+export const matchBuf = nativeBinding.matchBuf
+export const matchStr = nativeBinding.matchStr
+export const matchFile = nativeBinding.matchFile

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uruhalushia/rule-converter-napi",
-  "version": "0.1.3",
+  "version": "0.3.0",
   "description": "Node.js bindings for converting mihomo, sing-box, Egern, and generic rule sets.",
   "type": "module",
   "main": "index.js",
@@ -51,17 +51,17 @@
     "@napi-rs/cli": "^3"
   },
   "optionalDependencies": {
-    "@uruhalushia/rule-converter-napi-linux-x64-gnu": "0.1.3",
-    "@uruhalushia/rule-converter-napi-linux-arm64-gnu": "0.1.3",
-    "@uruhalushia/rule-converter-napi-linux-riscv64-gnu": "0.1.3",
-    "@uruhalushia/rule-converter-napi-linux-loong64-gnu": "0.1.3",
-    "@uruhalushia/rule-converter-napi-linux-x64-musl": "0.1.3",
-    "@uruhalushia/rule-converter-napi-linux-arm64-musl": "0.1.3",
-    "@uruhalushia/rule-converter-napi-linux-riscv64-musl": "0.1.3",
-    "@uruhalushia/rule-converter-napi-linux-loong64-musl": "0.1.3",
-    "@uruhalushia/rule-converter-napi-darwin-x64": "0.1.3",
-    "@uruhalushia/rule-converter-napi-darwin-arm64": "0.1.3",
-    "@uruhalushia/rule-converter-napi-win32-x64-msvc": "0.1.3",
-    "@uruhalushia/rule-converter-napi-win32-arm64-msvc": "0.1.3"
+    "@uruhalushia/rule-converter-napi-linux-x64-gnu": "0.3.0",
+    "@uruhalushia/rule-converter-napi-linux-arm64-gnu": "0.3.0",
+    "@uruhalushia/rule-converter-napi-linux-riscv64-gnu": "0.3.0",
+    "@uruhalushia/rule-converter-napi-linux-loong64-gnu": "0.3.0",
+    "@uruhalushia/rule-converter-napi-linux-x64-musl": "0.3.0",
+    "@uruhalushia/rule-converter-napi-linux-arm64-musl": "0.3.0",
+    "@uruhalushia/rule-converter-napi-linux-riscv64-musl": "0.3.0",
+    "@uruhalushia/rule-converter-napi-linux-loong64-musl": "0.3.0",
+    "@uruhalushia/rule-converter-napi-darwin-x64": "0.3.0",
+    "@uruhalushia/rule-converter-napi-darwin-arm64": "0.3.0",
+    "@uruhalushia/rule-converter-napi-win32-x64-msvc": "0.3.0",
+    "@uruhalushia/rule-converter-napi-win32-arm64-msvc": "0.3.0"
   }
 }