@dreamyoungs/trex-node 0.1.0

package/README.md

@@ -0,0 +1,43 @@
+# TREX NAPI-RS Node.js Bindings
+
+Native Node.js bindings powered by NAPI-RS.
+
+## Build
+
+```bash
+cd bindings/node
+npm install
+npm run build
+```
+
+## Smoke test
+
+```bash
+cd bindings/node
+npm test
+```
+
+## Use
+
+```js
+const trex = require("./index.js");
+
+const tables = trex.extract("../../tests/pdfs/twotables.pdf", {
+  mode: "Auto",
+});
+
+console.log(tables.length);
+```
+
+## Exported APIs
+
+- `extract(pdfPath, options?)`
+- `extractCsv(pdfPath, options?)`
+- `extractFromBuffer(pdfBuffer, options?)`
+- `extractCsvFromBuffer(pdfBuffer, options?)`
+
+## Notes
+
+- This package is native and requires build tooling on unsupported platforms.
+- The existing CLI-wrapper package is still available at `npm/trex`.
+- Release checklist and v0.1.0 notes are in `RELEASE_NOTES.md`.

package/index.d.ts

@@ -0,0 +1,33 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+export const enum ParseModeOption {
+  Auto = 'Auto',
+  Lattice = 'Lattice',
+  Stream = 'Stream',
+  Dl = 'Dl'
+}
+export const enum DlFallbackOption {
+  Auto = 'Auto',
+  Lattice = 'Lattice',
+  Stream = 'Stream'
+}
+export interface ExtractOptions {
+  pages?: Array<number>
+  mode?: ParseModeOption
+  dlModel?: string
+  dlMinConfidence?: number
+  dlFallback?: DlFallbackOption
+}
+export interface Table {
+  page: number
+  tableIndex: number
+  headers: Array<string>
+  rows: Array<Array<string>>
+}
+export declare function extract(pdfPath: string, options?: ExtractOptions | undefined | null): Array<Table>
+export declare function extractCsv(pdfPath: string, options?: ExtractOptions | undefined | null): string
+export declare function extractFromBuffer(pdfBuffer: Buffer, options?: ExtractOptions | undefined | null): Array<Table>
+export declare function extractCsvFromBuffer(pdfBuffer: Buffer, options?: ExtractOptions | undefined | null): string

package/index.js

@@ -0,0 +1,320 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+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) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'trex_node.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./trex_node.android-arm64.node')
+          } else {
+            nativeBinding = require('@dreamyoungs/trex-node-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'trex_node.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./trex_node.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('@dreamyoungs/trex-node-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'trex_node.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./trex_node.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('@dreamyoungs/trex-node-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'trex_node.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./trex_node.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('@dreamyoungs/trex-node-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'trex_node.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./trex_node.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('@dreamyoungs/trex-node-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'trex_node.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./trex_node.darwin-universal.node')
+      } else {
+        nativeBinding = require('@dreamyoungs/trex-node-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'trex_node.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./trex_node.darwin-x64.node')
+          } else {
+            nativeBinding = require('@dreamyoungs/trex-node-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'trex_node.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./trex_node.darwin-arm64.node')
+          } else {
+            nativeBinding = require('@dreamyoungs/trex-node-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = 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, 'trex_node.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./trex_node.freebsd-x64.node')
+      } else {
+        nativeBinding = require('@dreamyoungs/trex-node-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'trex_node.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./trex_node.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('@dreamyoungs/trex-node-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'trex_node.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./trex_node.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('@dreamyoungs/trex-node-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'trex_node.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./trex_node.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('@dreamyoungs/trex-node-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'trex_node.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./trex_node.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('@dreamyoungs/trex-node-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'trex_node.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./trex_node.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('@dreamyoungs/trex-node-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'trex_node.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./trex_node.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('@dreamyoungs/trex-node-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'trex_node.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./trex_node.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('@dreamyoungs/trex-node-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'trex_node.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./trex_node.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('@dreamyoungs/trex-node-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'trex_node.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./trex_node.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('@dreamyoungs/trex-node-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { ParseModeOption, DlFallbackOption, extract, extractCsv, extractFromBuffer, extractCsvFromBuffer } = nativeBinding
+
+module.exports.ParseModeOption = ParseModeOption
+module.exports.DlFallbackOption = DlFallbackOption
+module.exports.extract = extract
+module.exports.extractCsv = extractCsv
+module.exports.extractFromBuffer = extractFromBuffer
+module.exports.extractCsvFromBuffer = extractCsvFromBuffer

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@dreamyoungs/trex-node",
+  "version": "0.1.0",
+  "description": "NAPI-RS native Node.js bindings for TREX",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "license": "MIT OR Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dreamyoungs/trex.git",
+    "directory": "bindings/node"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "napi": {
+    "name": "trex_node",
+    "triples": {
+      "defaults": true
+    }
+  },
+  "scripts": {
+    "build": "napi build --platform --release",
+    "build:debug": "napi build --platform",
+    "test:smoke": "node smoke-test.js",
+    "test": "npm run build:debug && npm run test:smoke",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^2.18.4"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "*.node"
+  ]
+}