@litko/yara-x 0.1.2 → 0.2.1

package/README.md

@@ -1,7 +1,5 @@
 # @litko/yara-x
 
-**v0.1.1**
-
 ## Features
 
 - High Performance: Built with [napi-rs](https://napi-rs.com) and [VirusTotal/yara-x](https://github.com/VirusTotal/yara-x)
@@ -363,31 +361,42 @@ if (warnings.length > 0) {
 
 ## Performance Benchmarks
 
-**Test Setup:**
+`node-yara-x` delivers exceptional performance through intelligent scanner caching and optimized Rust implementation.
+
+### Benchmark Results
+
+Test Environment: MacBook Pro M3 Max, 36GB RAM, Release build with LTO
+Methodology: Statistical analysis across multiple iterations with percentile reporting
+
+#### Scanner Creation Performance
 
-- **Hardware:** MacBook Pro (M3 Max, 36GB RAM)
-- **Test Data:** Generated data of varying sizes (small: 64 bytes, medium: 100KB, large: 10MB). See `__test__/benchmark.mjs` for data generation and benchmarking code.
-- The Large test file (10MB) is auto-generated, to prevent bloating the size of the repository.
+| Rule Type      | Mean   | p50    | p95    | p99    |
+| -------------- | ------ | ------ | ------ | ------ |
+| Simple Rule    | 2.44ms | 2.42ms | 2.67ms | 3.00ms |
+| Complex Rule   | 2.79ms | 2.78ms | 3.00ms | 3.26ms |
+| Regex Rule     | 8.63ms | 8.63ms | 8.91ms | 9.34ms |
+| Multiple Rules | 2.42ms | 2.39ms | 2.69ms | 3.07ms |
 
-**Key Metrics (Averages):**
+#### Scanning Performance by Data Size
 
-| Operation                                       | Average Time | Iterations |      p50 |      p95 |      p99 |
-| :---------------------------------------------- | -----------: | ---------: | -------: | -------: | -------: |
-| Scanner Creation (Simple Rule)                  |     1.675 ms |        100 | 1.547 ms | 2.318 ms | 2.657 ms |
-| Scanner Creation (Complex Rule)                 |     1.878 ms |        100 | 1.848 ms | 2.005 ms | 2.865 ms |
-| Scanner Creation (Regex Rule)                   |     2.447 ms |        100 | 2.444 ms | 2.473 ms | 2.569 ms |
-| Scanner Creation (Multiple Rules)               |     1.497 ms |        100 | 1.488 ms | 1.547 ms | 1.819 ms |
-| Scanning Small Data (64 bytes, Simple Rule)     |     0.145 ms |       1000 | 0.143 ms | 0.156 ms | 0.169 ms |
-| Scanning Medium Data (100KB, Simple Rule)       |     0.151 ms |        100 | 0.146 ms | 0.179 ms | 0.205 ms |
-| Scanning Large Data (10MB, Simple Rule)         |     0.347 ms |         10 | 0.340 ms | 0.394 ms | 0.394 ms |
-| Scanning Medium Data (100KB, Complex Rule)      |     0.219 ms |        100 | 0.215 ms | 0.254 ms | 0.269 ms |
-| Scanning Medium Data (100KB, Regex Rule)        |     0.156 ms |        100 | 0.152 ms | 0.182 ms | 0.210 ms |
-| Scanning Medium Data (100KB, Multiple Rules)    |     0.218 ms |        100 | 0.212 ms | 0.261 ms | 0.353 ms |
-| Async Scanning Medium Data (100KB, Simple Rule) |     0.012 ms |        100 | 0.011 ms | 0.016 ms |  0.027ms |
-| Scanning with Variables                         |     0.143 ms |       1000 | 0.140 ms | 0.155 ms | 0.166 ms |
-| Scanning with Variables (Override at Scan Time) |     0.144 ms |       1000 | 0.142 ms | 0.158 ms | 0.175 ms |
+| Data Size | Rule Type      | Mean  | Throughput |
+| --------- | -------------- | ----- | ---------- |
+| 64 bytes  | Simple         | 3μs   | ~21 MB/s   |
+| 100KB     | Simple         | 6μs   | ~16.7 GB/s |
+| 100KB     | Complex        | 71μs  | ~1.4 GB/s  |
+| 100KB     | Regex          | 7μs   | ~14.3 GB/s |
+| 100KB     | Multiple Rules | 71μs  | ~1.4 GB/s  |
+| 10MB      | Simple         | 196μs | ~51 GB/s   |
 
-# API Reference
+#### Advanced Features Performance
+
+| Feature           | Mean | Notes                      |
+| ----------------- | ---- | -------------------------- |
+| Variable Scanning | 1μs  | Pre-compiled variables     |
+| Runtime Variables | 2μs  | Variables set at scan time |
+| Async Scanning    | 12μs | Non-blocking operations    |
+
+## API Reference
 
 ### Functions
 
@@ -395,7 +404,7 @@ if (warnings.length > 0) {
 - `compileToWasm(ruleSource: string, outputPath: string, options?: CompilerOptions)` - Compiles yara rules from a string to WASM file.
 - `compileFileToWasm(rulesPath: string, outputPath: string, options?: CompilerOptions)` - Compiles yara rules from a file to WASM file.
 - `validate(ruleSource: string, options?: CompilerOptions)` - Validates yara rules without executing them.
-- `create(options?: CompilerOptions)` - Creates an empty rules scanner to add rules incrementally.
+- `create()` - Creates an empty rules scanner to add rules incrementally.
 - `fromFile(rulePath: string, options?: CompilerOptions)` - Compiles yara rules from a file.
 
 ### yarax Methods
@@ -409,10 +418,7 @@ if (warnings.length > 0) {
 - `emitWasmFileAsync(filePath: string)` - Emit compiled rules to WASM file asynchronously.
 - `addRuleSource(rules: string)` - Add rules from a string to an existing scanner.
 - `addRuleFile(filePath: string)` - Add rules from a file to an existing scanner.
-
-### Rule Validation
-
-- `validate(rules: string, options?: CompilerOptions)` - Validate yara rules without executing them.
+- `defineVariable(name: string, value: string)` - Define a variable for the YARA compiler.
 
 ## Licenses
 

package/index.d.ts

@@ -1,42 +1,67 @@
-/* tslint:disable */
+/* auto-generated by NAPI-RS */
 /* eslint-disable */
+/** YaraX struct represents the YARA rules and their associated data. */
+export declare class YaraX {
+  getWarnings(): Array<CompilerWarning>
+  /** Scans the provided data using the compiled YARA rules. */
+  scan(data: Buffer, variables?: Record<string, string | number>): Array<RuleMatch>
+  /** Scans a file using the compiled YARA rules. */
+  scanFile(filePath: string, variables?: Record<string, string | number>): Array<RuleMatch>
+  /** Emits a WASM file from the compiled YARA rules. */
+  emitWasmFile(outputPath: string): void
+  /** Scans the provided data asynchronously using the compiled YARA rules. */
+  scanAsync(data: Buffer, variables?: object | undefined | null): Promise<unknown>
+  /** Scans a file asynchronously using the compiled YARA rules. */
+  scanFileAsync(filePath: string, variables?: object | undefined | null): Promise<unknown>
+  /** Emits a WASM file asynchronously from the compiled YARA rules. */
+  emitWasmFileAsync(outputPath: string): Promise<unknown>
+  /** Adds a rule source to the YARA compiler. */
+  addRuleSource(ruleSource: string): void
+  /** Adds a rule file to the YARA compiler. */
+  addRuleFile(filePath: string): void
+  /** Defines a variable for the YARA compiler. */
+  defineVariable(name: string, value: string): void
+}
 
-/* auto-generated by NAPI-RS */
+/** BannedModule struct represents a module that is banned from being used in YARA rules. */
+export interface BannedModule {
+  /** The name of the banned module. */
+  name: string
+  /** The title of the error message if the module is used. */
+  errorTitle: string
+  /** The error message if the module is used. */
+  errorMessage: string
+}
 
-/** MatchData struct represents a match found by a YARA rule. */
-export interface MatchData {
-  /** The offset of the match in the scanned data. */
-  offset: number
-  /** The length of the matched data. */
-  length: number
-  /** The matched data as a string. */
-  data: string
-  /** The identifier of the pattern that matched. */
-  identifier: string
+/** Compiles a YARA rule source string and returns a YaraX instance with the compiled rules. */
+export declare function compile(ruleSource: string, options?: CompilerOptions | undefined | null): YaraX
+
+/** Compiles a YARA rule file to a WASM file. */
+export declare function compileFileToWasm(rulePath: string, outputPath: string, options?: CompilerOptions | undefined | null): void
+
+/** CompilerError struct represents an error generated by the YARA compiler. */
+export interface CompilerError {
+  /** The code of the error. */
+  code: string
+  /** The message of the error. */
+  message: string
+  /** The source of the error, if available. */
+  source?: string
+  /** The line number where the error occurred, if available. */
+  line?: number
+  /** The column number where the error occurred, if available. */
+  column?: number
 }
-/**
- * RuleMatch struct represents a matching rule found during scanning.
- *
- * See [yara_::Match](https://docs.rs/yara-x/latest/yara_x/struct.Match.html) for more details.
- */
-export interface RuleMatch {
-  /** The identifier of the rule that matched. */
-  ruleIdentifier: string
-  /** The namespace of the rule that matched. */
-  namespace: string
-  /** The metadata associated with the rule that matched. */
-  meta: object
-  /** The tags associated with the rule that matched. */
-  tags: Array<string>
-  /** The matches found by the rule. */
-  matches: Array<MatchData>
+
+/** CompileResult struct represents the result of compiling YARA rules. */
+export interface CompileResult {
+  /** Any warnings generated during the compilation process. */
+  warnings: Array<CompilerWarning>
+  /** Any errors generated during the compilation process. */
+  errors: Array<CompilerError>
 }
-/**
- * CompilerOptions struct represents the options for the YARA compiler.
- *
- * See [yara_x::Compiler](https://docs.rs/yara-x/latest/yara_x/struct.Compiler.html) for more
- * details.
- */
+
+/** CompilerOptions struct represents the options for the YARA compiler. */
 export interface CompilerOptions {
   /** Defines global variables for the YARA rules. */
   defineVariables?: object
@@ -55,21 +80,8 @@ export interface CompilerOptions {
   /** Whether to raise an error on slow loops. */
   errorOnSlowLoop?: boolean
 }
-/** BannedModule struct represents a module that is banned from being used in YARA rules. */
-export interface BannedModule {
-  /** The name of the banned module. */
-  name: string
-  /** The title of the error message if the module is used. */
-  errorTitle: string
-  /** The error message if the module is used. */
-  errorMessage: string
-}
-/**
- * CompilerWarning struct represents a warning generated by the YARA compiler.
- *
- * See [yara_x::CompilerWarning](https://docs.rs/yara-x/latest/yara_x/warnings/enum.Warning.html)
- * for more details.
- */
+
+/** CompilerWarning struct represents a warning generated by the YARA compiler. */
 export interface CompilerWarning {
   /** The code of the warning. */
   code: string
@@ -82,187 +94,44 @@ export interface CompilerWarning {
   /** The column number where the warning occurred, if available. */
   column?: number
 }
-/**
- * CompilerError struct represents an error generated by the YARA compiler.
- *
- * See
- * [yara_x::CompileError](https://docs.rs/yara-x/latest/yara_x/errors/enum.CompileError.html)
- * for more details.
- */
-export interface CompilerError {
-  /** The code of the error. */
-  code: string
-  /** The message of the error. */
-  message: string
-  /** The source of the error, if available. */
-  source?: string
-  /** The line number where the error occurred, if available. */
-  line?: number
-  /** The column number where the error occurred, if available. */
-  column?: number
+
+/** Compiles a YARA rule source string to a WASM file. */
+export declare function compileToWasm(ruleSource: string, outputPath: string, options?: CompilerOptions | undefined | null): void
+
+/** Creates a new YaraX instance with empty rules and no source code. */
+export declare function create(): YaraX
+
+/** Creates a new YaraX instance from a file containing YARA rules. */
+export declare function fromFile(rulePath: string, options?: CompilerOptions | undefined | null): YaraX
+
+/** MatchData struct represents a match found by a YARA rule. */
+export interface MatchData {
+  /** The offset of the match in the scanned data. */
+  offset: number
+  /** The length of the matched data. */
+  length: number
+  /** The matched data as a string. */
+  data: string
+  /** The identifier of the pattern that matched. */
+  identifier: string
 }
-/**
- * CompileResult struct represents the result of compiling YARA rules.
- * It contains any warnings or errors generated during the compilation process.
- */
-export interface CompileResult {
-  /** Any warnings generated during the compilation process. */
-  warnings: Array<CompilerWarning>
-  /** Any errors generated during the compilation process. */
-  errors: Array<CompilerError>
+
+/** RuleMatch struct represents a matching rule found during scanning. */
+export interface RuleMatch {
+  /** The identifier of the rule that matched. */
+  ruleIdentifier: string
+  /** The namespace of the rule that matched. */
+  namespace: string
+  /** The metadata associated with the rule that matched. */
+  meta: object
+  /** The tags associated with the rule that matched. */
+  tags: Array<string>
+  /** The matches found by the rule. */
+  matches: Array<MatchData>
 }
+
 /**
  * Compiles a YARA rule source string and returns any warnings or errors generated during the
  * compilation process.
- *
- * Exported as `validate` in the NAPI interface.
- *
- * Example
- *
- * ```javascript
- * const { validate } = require('your_yara_module');
- * const result = validate('rule example { strings: $a = "example" condition: $a }');
- * ```
  */
 export declare function validate(ruleSource: string, options?: CompilerOptions | undefined | null): CompileResult
-/**
- * Compiles a YARA rule source string and returns a YaraX instance with the compiled rules.
- *
- * Exported as `compile` in the NAPI interface.
- *
- * Example
- *
- * ```javascript
- * const { compile } = require('your_yara_module');
- * const yarax = compile('rule example { strings: $a = "example" condition: $a }');
- * ```
- */
-export declare function compile(ruleSource: string, options?: CompilerOptions | undefined | null): YaraX
-/**
- * Creates a new YaraX instance with empty rules and no source code.
- *
- * Exported as `create` in the NAPI interface.
- *
- * Example
- *
- * ```javascript
- * const { create } = require('your_yara_module');
- * const yarax = create();
- *
- * // Now you can add rules or compile them later
- *
- * yarax.addRuleSource('rule example { strings: $a = "example" condition: $a }');
- * yarax.addRuleFile('path/to/rule_file.yar');
- * yarax.defineVariable('myVar', 'myValue');
- * ```
- */
-export declare function create(): YaraX
-/**
- * Creates a new YaraX instance from a file containing YARA rules.
- *
- * Exported as `fromFile` in the NAPI interface.
- *
- * Example
- *
- * ```javascript
- * const { fromFile } = require('your_yara_module');
- * const yarax = fromFile('path/to/rule_file.yar');
- * ```
- */
-export declare function fromFile(rulePath: string, options?: CompilerOptions | undefined | null): YaraX
-/**
- * Compiles a YARA rule source string to a WASM file.
- *
- * Exported as `compileToWasm` in the NAPI interface.
- *
- * Example
- *
- * ```javascript
- * const { compileToWasm } = require('your_yara_module');
- * compileToWasm('rule example { strings: $a = "example" condition: $a }', 'output.wasm');
- * ```
- */
-export declare function compileToWasm(ruleSource: string, outputPath: string, options?: CompilerOptions | undefined | null): void
-/**
- * Compiles a YARA rule file to a WASM file.
- *
- * Exported as `compileFileToWasm` in the NAPI interface.
- *
- * Example
- *
- * ```javascript
- * const { compileFileToWasm } = require('your_yara_module');
- * compileFileToWasm('path/to/rule_file.yar', 'output.wasm');
- * ```
- */
-export declare function compileFileToWasm(rulePath: string, outputPath: string, options?: CompilerOptions | undefined | null): void
-/**
- * YaraX struct represents the YARA rules and their associated data.
- * It contains the compiled rules, source code, warnings, and variables.
- *
- * See [yara_x::Rules](https://docs.rs/yara-x/latest/yara_x/struct.Rules.html) for more details.
- */
-export declare class YaraX {
-  getWarnings(): Array<CompilerWarning>
-  /**
-   * Scans the provided data using the compiled YARA rules.
-   * This function takes the scanned data and an optional object of variables,
-   * and returns a vector of RuleMatch representing the matching rules found during the scan.
-   */
-  scan(data: Buffer, variables?: Record<string, string | number>): Array<RuleMatch>
-  /**
-   * Scans a file using the compiled YARA rules.
-   * This function takes the file path and an optional object of variables,
-   * and returns a vector of RuleMatch representing the matching rules found during the scan.
-   */
-  scanFile(filePath: string, variables?: Record<string, string | number>): Array<RuleMatch>
-  /**
-   * Emits a WASM file from the compiled YARA rules.
-   * This function takes the output path and writes the compiled rules to a WASM file.
-   */
-  emitWasmFile(outputPath: string): void
-  /**
-   * Scans the provided data asynchronously using the compiled YARA rules.
-   * This function takes the scanned data and an optional object of variables,
-   * and returns an AsyncTask that will resolve to a vector of RuleMatch representing the matching
-   * rules found during the scan.
-   *
-   * This allows for non-blocking scanning of data, which can be useful for large datasets or
-   * performance-critical applications.
-   */
-  scanAsync(data: Buffer, variables?: object | undefined | null): Promise<unknown>
-  /**
-   * Scans a file asynchronously using the compiled YARA rules.
-   * This function takes the file path and an optional object of variables,
-   * and returns an AsyncTask that will resolve to a vector of RuleMatch representing the matching
-   * rules found during the scan.
-   *
-   * This allows for non-blocking scanning of files, which can be useful for large files or
-   * performance-critical applications.
-   */
-  scanFileAsync(filePath: string, variables?: object | undefined | null): Promise<unknown>
-  /**
-   * Emits a WASM file asynchronously from the compiled YARA rules.
-   * This function takes the output path
-   * and returns an AsyncTask that will resolve when the WASM file is successfully emitted.
-   */
-  emitWasmFileAsync(outputPath: string): Promise<unknown>
-  /**
-   * Adds a rule source to the YARA compiler.
-   * This function takes a rule source string,
-   * compiles it, and updates the YaraX instance with the new rules.
-   */
-  addRuleSource(ruleSource: string): void
-  /**
-   * Adds a rule file to the YARA compiler.
-   * This function takes a file path,
-   * reads the file content, and adds it to the YaraX instance.
-   */
-  addRuleFile(filePath: string): void
-  /**
-   * Defines a variable for the YARA compiler.
-   * This function takes a variable name and value,
-   * and adds it to the YaraX instance.
-   */
-  defineVariable(name: string, value: string): void
-}

package/index.js

@@ -1,321 +1,402 @@
-/* tslint:disable */
+// prettier-ignore
 /* eslint-disable */
-/* prettier-ignore */
-
+// @ts-nocheck
 /* auto-generated by NAPI-RS */
 
-const { existsSync, readFileSync } = require('fs')
-const { join } = require('path')
-
-const { platform, arch } = process
+const { createRequire } = require('node:module')
+require = createRequire(__filename)
 
+const { readFileSync } = require('node:fs')
 let nativeBinding = null
-let localFileExisted = false
-let loadError = null
+const loadErrors = []
 
-function isMusl() {
-  // For Node 10
-  if (!process.report || typeof process.report.getReport !== 'function') {
-    try {
-      const lddPath = require('child_process').execSync('which ldd').toString().trim()
-      return readFileSync(lddPath, 'utf8').includes('musl')
-    } catch (e) {
+const isMusl = () => {
+  let musl = false
+  if (process.platform === 'linux') {
+    musl = isMuslFromFilesystem()
+    if (musl === null) {
+      musl = isMuslFromReport()
+    }
+    if (musl === null) {
+      musl = isMuslFromChildProcess()
+    }
+  }
+  return musl
+}
+
+const isFileMusl = (f) => f.includes('libc.musl-') || f.includes('ld-musl-')
+
+const isMuslFromFilesystem = () => {
+  try {
+    return readFileSync('/usr/bin/ldd', 'utf-8').includes('musl')
+  } catch {
+    return null
+  }
+}
+
+const isMuslFromReport = () => {
+  let report = null
+  if (typeof process.report?.getReport === 'function') {
+    process.report.excludeNetwork = true
+    report = process.report.getReport()
+  }
+  if (!report) {
+    return null
+  }
+  if (report.header && report.header.glibcVersionRuntime) {
+    return false
+  }
+  if (Array.isArray(report.sharedObjects)) {
+    if (report.sharedObjects.some(isFileMusl)) {
       return true
     }
-  } else {
-    const { glibcVersionRuntime } = process.report.getReport().header
-    return !glibcVersionRuntime
   }
+  return false
 }
 
-switch (platform) {
-  case 'android':
-    switch (arch) {
-      case 'arm64':
-        localFileExisted = existsSync(join(__dirname, 'yara-x.android-arm64.node'))
+const isMuslFromChildProcess = () => {
+  try {
+    return require('child_process').execSync('ldd --version', { encoding: 'utf8' }).includes('musl')
+  } catch (e) {
+    // If we reach this case, we don't know if the system is musl or not, so is better to just fallback to false
+    return false
+  }
+}
+
+function requireNative() {
+  if (process.env.NAPI_RS_NATIVE_LIBRARY_PATH) {
+    try {
+      nativeBinding = require(process.env.NAPI_RS_NATIVE_LIBRARY_PATH);
+    } catch (err) {
+      loadErrors.push(err)
+    }
+  } else if (process.platform === 'android') {
+    if (process.arch === 'arm64') {
+      try {
+        return require('./yara-x.android-arm64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@litko/yara-x-android-arm64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else if (process.arch === 'arm') {
+      try {
+        return require('./yara-x.android-arm-eabi.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@litko/yara-x-android-arm-eabi')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on Android ${process.arch}`))
+    }
+  } else if (process.platform === 'win32') {
+    if (process.arch === 'x64') {
+      try {
+        return require('./yara-x.win32-x64-msvc.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@litko/yara-x-win32-x64-msvc')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else if (process.arch === 'ia32') {
+      try {
+        return require('./yara-x.win32-ia32-msvc.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@litko/yara-x-win32-ia32-msvc')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else if (process.arch === 'arm64') {
+      try {
+        return require('./yara-x.win32-arm64-msvc.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@litko/yara-x-win32-arm64-msvc')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on Windows: ${process.arch}`))
+    }
+  } else if (process.platform === 'darwin') {
+    try {
+      return require('./yara-x.darwin-universal.node')
+    } catch (e) {
+      loadErrors.push(e)
+    }
+    try {
+      return require('@litko/yara-x-darwin-universal')
+    } catch (e) {
+      loadErrors.push(e)
+    }
+    if (process.arch === 'x64') {
+      try {
+        return require('./yara-x.darwin-x64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@litko/yara-x-darwin-x64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else if (process.arch === 'arm64') {
+      try {
+        return require('./yara-x.darwin-arm64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@litko/yara-x-darwin-arm64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on macOS: ${process.arch}`))
+    }
+  } else if (process.platform === 'freebsd') {
+    if (process.arch === 'x64') {
+      try {
+        return require('./yara-x.freebsd-x64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@litko/yara-x-freebsd-x64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else if (process.arch === 'arm64') {
+      try {
+        return require('./yara-x.freebsd-arm64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@litko/yara-x-freebsd-arm64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on FreeBSD: ${process.arch}`))
+    }
+  } else if (process.platform === 'linux') {
+    if (process.arch === 'x64') {
+      if (isMusl()) {
         try {
-          if (localFileExisted) {
-            nativeBinding = require('./yara-x.android-arm64.node')
-          } else {
-            nativeBinding = require('@litko/yara-x-android-arm64')
-          }
+          return require('./yara-x.linux-x64-musl.node')
         } catch (e) {
-          loadError = e
+          loadErrors.push(e)
         }
-        break
-      case 'arm':
-        localFileExisted = existsSync(join(__dirname, 'yara-x.android-arm-eabi.node'))
         try {
-          if (localFileExisted) {
-            nativeBinding = require('./yara-x.android-arm-eabi.node')
-          } else {
-            nativeBinding = require('@litko/yara-x-android-arm-eabi')
-          }
+          return require('@litko/yara-x-linux-x64-musl')
         } catch (e) {
-          loadError = e
+          loadErrors.push(e)
         }
-        break
-      default:
-        throw new Error(`Unsupported architecture on Android ${arch}`)
-    }
-    break
-  case 'win32':
-    switch (arch) {
-      case 'x64':
-        localFileExisted = existsSync(
-          join(__dirname, 'yara-x.win32-x64-msvc.node')
-        )
+      } else {
         try {
-          if (localFileExisted) {
-            nativeBinding = require('./yara-x.win32-x64-msvc.node')
-          } else {
-            nativeBinding = require('@litko/yara-x-win32-x64-msvc')
-          }
+          return require('./yara-x.linux-x64-gnu.node')
         } catch (e) {
-          loadError = e
+          loadErrors.push(e)
         }
-        break
-      case 'ia32':
-        localFileExisted = existsSync(
-          join(__dirname, 'yara-x.win32-ia32-msvc.node')
-        )
         try {
-          if (localFileExisted) {
-            nativeBinding = require('./yara-x.win32-ia32-msvc.node')
-          } else {
-            nativeBinding = require('@litko/yara-x-win32-ia32-msvc')
-          }
+          return require('@litko/yara-x-linux-x64-gnu')
         } catch (e) {
-          loadError = e
+          loadErrors.push(e)
         }
-        break
-      case 'arm64':
-        localFileExisted = existsSync(
-          join(__dirname, 'yara-x.win32-arm64-msvc.node')
-        )
+      }
+    } else if (process.arch === 'arm64') {
+      if (isMusl()) {
         try {
-          if (localFileExisted) {
-            nativeBinding = require('./yara-x.win32-arm64-msvc.node')
-          } else {
-            nativeBinding = require('@litko/yara-x-win32-arm64-msvc')
-          }
+          return require('./yara-x.linux-arm64-musl.node')
         } catch (e) {
-          loadError = e
+          loadErrors.push(e)
+        }
+        try {
+          return require('@litko/yara-x-linux-arm64-musl')
+        } catch (e) {
+          loadErrors.push(e)
         }
-        break
-      default:
-        throw new Error(`Unsupported architecture on Windows: ${arch}`)
-    }
-    break
-  case 'darwin':
-    localFileExisted = existsSync(join(__dirname, 'yara-x.darwin-universal.node'))
-    try {
-      if (localFileExisted) {
-        nativeBinding = require('./yara-x.darwin-universal.node')
       } else {
-        nativeBinding = require('@litko/yara-x-darwin-universal')
+        try {
+          return require('./yara-x.linux-arm64-gnu.node')
+        } catch (e) {
+          loadErrors.push(e)
+        }
+        try {
+          return require('@litko/yara-x-linux-arm64-gnu')
+        } catch (e) {
+          loadErrors.push(e)
+        }
       }
-      break
-    } catch {}
-    switch (arch) {
-      case 'x64':
-        localFileExisted = existsSync(join(__dirname, 'yara-x.darwin-x64.node'))
+    } else if (process.arch === 'arm') {
+      if (isMusl()) {
         try {
-          if (localFileExisted) {
-            nativeBinding = require('./yara-x.darwin-x64.node')
-          } else {
-            nativeBinding = require('@litko/yara-x-darwin-x64')
-          }
+          return require('./yara-x.linux-arm-musleabihf.node')
         } catch (e) {
-          loadError = e
+          loadErrors.push(e)
         }
-        break
-      case 'arm64':
-        localFileExisted = existsSync(
-          join(__dirname, 'yara-x.darwin-arm64.node')
-        )
         try {
-          if (localFileExisted) {
-            nativeBinding = require('./yara-x.darwin-arm64.node')
-          } else {
-            nativeBinding = require('@litko/yara-x-darwin-arm64')
-          }
+          return require('@litko/yara-x-linux-arm-musleabihf')
         } catch (e) {
-          loadError = e
+          loadErrors.push(e)
         }
-        break
-      default:
-        throw new Error(`Unsupported architecture on macOS: ${arch}`)
-    }
-    break
-  case 'freebsd':
-    if (arch !== 'x64') {
-      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
-    }
-    localFileExisted = existsSync(join(__dirname, 'yara-x.freebsd-x64.node'))
-    try {
-      if (localFileExisted) {
-        nativeBinding = require('./yara-x.freebsd-x64.node')
       } else {
-        nativeBinding = require('@litko/yara-x-freebsd-x64')
-      }
-    } catch (e) {
-      loadError = e
-    }
-    break
-  case 'linux':
-    switch (arch) {
-      case 'x64':
-        if (isMusl()) {
-          localFileExisted = existsSync(
-            join(__dirname, 'yara-x.linux-x64-musl.node')
-          )
-          try {
-            if (localFileExisted) {
-              nativeBinding = require('./yara-x.linux-x64-musl.node')
-            } else {
-              nativeBinding = require('@litko/yara-x-linux-x64-musl')
-            }
-          } catch (e) {
-            loadError = e
-          }
-        } else {
-          localFileExisted = existsSync(
-            join(__dirname, 'yara-x.linux-x64-gnu.node')
-          )
-          try {
-            if (localFileExisted) {
-              nativeBinding = require('./yara-x.linux-x64-gnu.node')
-            } else {
-              nativeBinding = require('@litko/yara-x-linux-x64-gnu')
-            }
-          } catch (e) {
-            loadError = e
-          }
+        try {
+          return require('./yara-x.linux-arm-gnueabihf.node')
+        } catch (e) {
+          loadErrors.push(e)
         }
-        break
-      case 'arm64':
-        if (isMusl()) {
-          localFileExisted = existsSync(
-            join(__dirname, 'yara-x.linux-arm64-musl.node')
-          )
-          try {
-            if (localFileExisted) {
-              nativeBinding = require('./yara-x.linux-arm64-musl.node')
-            } else {
-              nativeBinding = require('@litko/yara-x-linux-arm64-musl')
-            }
-          } catch (e) {
-            loadError = e
-          }
-        } else {
-          localFileExisted = existsSync(
-            join(__dirname, 'yara-x.linux-arm64-gnu.node')
-          )
-          try {
-            if (localFileExisted) {
-              nativeBinding = require('./yara-x.linux-arm64-gnu.node')
-            } else {
-              nativeBinding = require('@litko/yara-x-linux-arm64-gnu')
-            }
-          } catch (e) {
-            loadError = e
-          }
+        try {
+          return require('@litko/yara-x-linux-arm-gnueabihf')
+        } catch (e) {
+          loadErrors.push(e)
         }
-        break
-      case 'arm':
-        if (isMusl()) {
-          localFileExisted = existsSync(
-            join(__dirname, 'yara-x.linux-arm-musleabihf.node')
-          )
-          try {
-            if (localFileExisted) {
-              nativeBinding = require('./yara-x.linux-arm-musleabihf.node')
-            } else {
-              nativeBinding = require('@litko/yara-x-linux-arm-musleabihf')
-            }
-          } catch (e) {
-            loadError = e
-          }
-        } else {
-          localFileExisted = existsSync(
-            join(__dirname, 'yara-x.linux-arm-gnueabihf.node')
-          )
-          try {
-            if (localFileExisted) {
-              nativeBinding = require('./yara-x.linux-arm-gnueabihf.node')
-            } else {
-              nativeBinding = require('@litko/yara-x-linux-arm-gnueabihf')
-            }
-          } catch (e) {
-            loadError = e
-          }
+      }
+    } else if (process.arch === 'riscv64') {
+      if (isMusl()) {
+        try {
+          return require('./yara-x.linux-riscv64-musl.node')
+        } catch (e) {
+          loadErrors.push(e)
         }
-        break
-      case 'riscv64':
-        if (isMusl()) {
-          localFileExisted = existsSync(
-            join(__dirname, 'yara-x.linux-riscv64-musl.node')
-          )
-          try {
-            if (localFileExisted) {
-              nativeBinding = require('./yara-x.linux-riscv64-musl.node')
-            } else {
-              nativeBinding = require('@litko/yara-x-linux-riscv64-musl')
-            }
-          } catch (e) {
-            loadError = e
-          }
-        } else {
-          localFileExisted = existsSync(
-            join(__dirname, 'yara-x.linux-riscv64-gnu.node')
-          )
-          try {
-            if (localFileExisted) {
-              nativeBinding = require('./yara-x.linux-riscv64-gnu.node')
-            } else {
-              nativeBinding = require('@litko/yara-x-linux-riscv64-gnu')
-            }
-          } catch (e) {
-            loadError = e
-          }
+        try {
+          return require('@litko/yara-x-linux-riscv64-musl')
+        } catch (e) {
+          loadErrors.push(e)
         }
-        break
-      case 's390x':
-        localFileExisted = existsSync(
-          join(__dirname, 'yara-x.linux-s390x-gnu.node')
-        )
+      } else {
         try {
-          if (localFileExisted) {
-            nativeBinding = require('./yara-x.linux-s390x-gnu.node')
-          } else {
-            nativeBinding = require('@litko/yara-x-linux-s390x-gnu')
-          }
+          return require('./yara-x.linux-riscv64-gnu.node')
         } catch (e) {
-          loadError = e
+          loadErrors.push(e)
         }
-        break
-      default:
-        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+        try {
+          return require('@litko/yara-x-linux-riscv64-gnu')
+        } catch (e) {
+          loadErrors.push(e)
+        }
+      }
+    } else if (process.arch === 'ppc64') {
+      try {
+        return require('./yara-x.linux-ppc64-gnu.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@litko/yara-x-linux-ppc64-gnu')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else if (process.arch === 's390x') {
+      try {
+        return require('./yara-x.linux-s390x-gnu.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@litko/yara-x-linux-s390x-gnu')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on Linux: ${process.arch}`))
+    }
+  } else if (process.platform === 'openharmony') {
+    if (process.arch === 'arm64') {
+      try {
+        return require('./yara-x.linux-arm64-ohos.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@litko/yara-x-linux-arm64-ohos')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else if (process.arch === 'x64') {
+      try {
+        return require('./yara-x.linux-x64-ohos.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@litko/yara-x-linux-x64-ohos')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else if (process.arch === 'arm') {
+      try {
+        return require('./yara-x.linux-arm-ohos.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@litko/yara-x-linux-arm-ohos')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on OpenHarmony: ${process.arch}`))
     }
-    break
-  default:
-    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+  } else {
+    loadErrors.push(new Error(`Unsupported OS: ${process.platform}, architecture: ${process.arch}`))
+  }
+}
+
+nativeBinding = requireNative()
+
+if (!nativeBinding || process.env.NAPI_RS_FORCE_WASI) {
+  try {
+    nativeBinding = require('./yara-x.wasi.cjs')
+  } catch (err) {
+    if (process.env.NAPI_RS_FORCE_WASI) {
+      loadErrors.push(err)
+    }
+  }
+  if (!nativeBinding) {
+    try {
+      nativeBinding = require('@litko/yara-x-wasm32-wasi')
+    } catch (err) {
+      if (process.env.NAPI_RS_FORCE_WASI) {
+        loadErrors.push(err)
+      }
+    }
+  }
 }
 
 if (!nativeBinding) {
-  if (loadError) {
-    throw loadError
+  if (loadErrors.length > 0) {
+    throw new Error(
+      `Cannot find native binding. ` +
+        `npm has a bug related to optional dependencies (https://github.com/npm/cli/issues/4828). ` +
+        'Please try `npm i` again after removing both package-lock.json and node_modules directory.',
+      { cause: loadErrors }
+    )
   }
   throw new Error(`Failed to load native binding`)
 }
 
-const { YaraX, validate, compile, create, fromFile, compileToWasm, compileFileToWasm } = nativeBinding
-
-module.exports.YaraX = YaraX
-module.exports.validate = validate
-module.exports.compile = compile
-module.exports.create = create
-module.exports.fromFile = fromFile
-module.exports.compileToWasm = compileToWasm
-module.exports.compileFileToWasm = compileFileToWasm
+module.exports = nativeBinding
+module.exports.YaraX = nativeBinding.YaraX
+module.exports.compile = nativeBinding.compile
+module.exports.compileFileToWasm = nativeBinding.compileFileToWasm
+module.exports.compileToWasm = nativeBinding.compileToWasm
+module.exports.create = nativeBinding.create
+module.exports.fromFile = nativeBinding.fromFile
+module.exports.validate = nativeBinding.validate

package/package.json

@@ -1,40 +1,50 @@
 {
   "name": "@litko/yara-x",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "main": "index.js",
   "types": "index.d.ts",
+  "packageManager": "pnpm@10.13.1",
   "napi": {
-    "name": "yara-x",
-    "triples": {
-      "additional": [
-        "x86_64-apple-darwin",
-        "aarch64-apple-darwin",
-        "x86_64-unknown-linux-gnu",
-        "aarch64-unknown-linux-gnu"
-      ]
-    }
+    "binaryName": "yara-x",
+    "targets": [
+      "x86_64-apple-darwin",
+      "aarch64-apple-darwin",
+      "x86_64-unknown-linux-gnu"
+    ]
   },
   "license": "MIT",
   "devDependencies": {
-    "@napi-rs/cli": "^2.18.4",
-    "@napi-rs/package-template": "^1.0.0",
+    "@napi-rs/cli": "^3.0.0",
+    "@napi-rs/wasm-runtime": "^1.0.0",
     "@types/node": "^22.13.10"
   },
   "engines": {
     "node": ">= 20"
   },
+  "homepage": "https://github.com/cawalch/node-yara-x",
+  "bugs": {
+    "url": "https://github.com/cawalch/node-yara-x/issues"
+  },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cawalch/node-yara-x.git"
+  },
   "scripts": {
     "artifacts": "napi artifacts",
     "build": "napi build --platform --release",
     "build:debug": "napi build --platform",
+    "prepublishOnly": "napi prepublish -t npm",
     "universal": "napi universal",
     "version": "napi version",
     "test": "node --test __test__/index.spec.mjs",
-    "benchmark": "node __test__/benchmark.mjs"
+    "benchmark": "node __test__/benchmark.mjs",
+    "profile": "node --expose-gc __test__/run-profiling.mjs",
+    "profile:baseline": "node --expose-gc __test__/run-profiling.mjs --baseline",
+    "profile:compare": "node --expose-gc __test__/run-profiling.mjs --compare __test__/baseline-performance.json"
   },
   "files": [
     "index.js",
@@ -49,10 +59,8 @@
     "rust"
   ],
   "optionalDependencies": {
-    "@litko/yara-x-win32-x64-msvc": "0.1.2",
-    "@litko/yara-x-darwin-x64": "0.1.2",
-    "@litko/yara-x-linux-x64-gnu": "0.1.2",
-    "@litko/yara-x-darwin-arm64": "0.1.2",
-    "@litko/yara-x-linux-arm64-gnu": "0.1.2"
+    "@litko/yara-x-darwin-x64": "0.2.1",
+    "@litko/yara-x-darwin-arm64": "0.2.1",
+    "@litko/yara-x-linux-x64-gnu": "0.2.1"
   }
-}
+}