@dcl/abgen-node 0.0.1 → 0.15.0

package/README.md

@@ -0,0 +1,23 @@
+# @dcl/abgen-node
+
+[abgen](https://github.com/decentraland/abgen)'s asset-bundle conversion as a
+Node native addon: glTF/GLB and textures in, Unity AssetBundles out, in-process
+— no sidecar, no port, no proxy.
+
+```js
+const { convert } = require('@dcl/abgen-node')
+
+const { code, bundles, events, manifest } = await convert({
+  files: [{ name: 'model.glb', data: glbBuffer }],
+  platform: 'windows'
+})
+```
+
+Conversion runs on the blocking pool rather than the libuv event loop; it is
+CPU-bound for seconds at a time. A model that fails to convert is **not** a
+rejected promise — it comes back as a `file-error` entry in `events` and a
+non-zero `exitCode` in `manifest`, with `code` still 0.
+
+`platform` is `"windows"`, `"mac"`, `"linux"` or `"webgl"`.
+
+Prebuilt for linux x64/arm64, darwin x64/arm64 and win32 x64. AGPL-3.0-or-later.

package/index.d.ts

@@ -0,0 +1,63 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+/** One content file. `name` is the entity's content path. */
+export interface AbgenFile {
+  name: string
+  data: Buffer
+}
+export interface AbgenContentEntry {
+  file: string
+  hash: string
+}
+/** One produced bundle, named `<hash>_<deps>_<platform>`. */
+export interface AbgenBundle {
+  name: string
+  data: Buffer
+}
+/** A conversion job. */
+export interface AbgenConvertOptions {
+  files: Array<AbgenFile>
+  /** `"windows"` (default), `"mac"`, `"linux"` or `"webgl"`. */
+  platform?: string
+  /** Omit to detect from the files. */
+  entityType?: string
+  /** 0 convert (default), 1 scan, 2 convert one model, 3 LOD only. */
+  mode?: number
+  magentaMissing?: boolean
+  bakeLod?: boolean
+  crop?: boolean
+  /** 0 leaves the LOD uncapped. */
+  triangleCap?: number
+  /** Names the LOD (mode 3). Omit to derive from the content table. */
+  entityHash?: string
+  /** In mode 2, which file to convert. */
+  onlyGlb?: string
+  /**
+   * The entity's full table, so cross-file dependency hashes resolve even
+   * when `files` carries only a shard.
+   */
+  contentTable?: Array<AbgenContentEntry>
+}
+/** Everything one conversion produced. */
+export interface AbgenConvertResult {
+  /** 0 on success; 1 malformed request; 2 conversion failed. */
+  code: number
+  bundles: Array<AbgenBundle>
+  /** Raw JSON progress events, in order. */
+  events: Array<string>
+  errors: Array<string>
+  manifest?: string
+}
+export declare function version(): string
+/**
+ * Converts one entity on the blocking pool, not the libuv event loop:
+ * conversion is CPU-bound for seconds at a time.
+ *
+ * A model that fails is **not** a rejected promise — it comes back as a
+ * `file-error` in `events` and a non-zero `exitCode` in `manifest`, `code`
+ * still 0.
+ */
+export declare function convert(options: AbgenConvertOptions): Promise<AbgenConvertResult>

package/index.js

@@ -0,0 +1,316 @@
+/* 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, 'abgen-node.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./abgen-node.android-arm64.node')
+          } else {
+            nativeBinding = require('@dcl/abgen-node-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'abgen-node.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./abgen-node.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('@dcl/abgen-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, 'abgen-node.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./abgen-node.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('@dcl/abgen-node-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'abgen-node.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./abgen-node.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('@dcl/abgen-node-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'abgen-node.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./abgen-node.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('@dcl/abgen-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, 'abgen-node.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./abgen-node.darwin-universal.node')
+      } else {
+        nativeBinding = require('@dcl/abgen-node-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'abgen-node.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./abgen-node.darwin-x64.node')
+          } else {
+            nativeBinding = require('@dcl/abgen-node-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'abgen-node.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./abgen-node.darwin-arm64.node')
+          } else {
+            nativeBinding = require('@dcl/abgen-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, 'abgen-node.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./abgen-node.freebsd-x64.node')
+      } else {
+        nativeBinding = require('@dcl/abgen-node-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'abgen-node.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./abgen-node.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('@dcl/abgen-node-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'abgen-node.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./abgen-node.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('@dcl/abgen-node-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'abgen-node.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./abgen-node.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('@dcl/abgen-node-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'abgen-node.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./abgen-node.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('@dcl/abgen-node-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'abgen-node.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./abgen-node.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('@dcl/abgen-node-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'abgen-node.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./abgen-node.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('@dcl/abgen-node-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'abgen-node.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./abgen-node.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('@dcl/abgen-node-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'abgen-node.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./abgen-node.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('@dcl/abgen-node-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'abgen-node.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./abgen-node.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('@dcl/abgen-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 { version, convert } = nativeBinding
+
+module.exports.version = version
+module.exports.convert = convert

package/package.json

@@ -1,5 +1,55 @@
 {
   "name": "@dcl/abgen-node",
-  "version": "0.0.1",
-  "description": "Placeholder to bootstrap Trusted Publishing; superseded by the first CI release."
-}
+  "version": "0.15.0",
+  "description": "Decentraland asset-bundle conversion in-process for Node (Rust + napi-rs) — the same abgen core the server and the Unity plugin run",
+  "license": "AGPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/decentraland/abgen.git"
+  },
+  "main": "index.js",
+  "types": "index.d.ts",
+  "napi": {
+    "name": "abgen-node",
+    "triples": {
+      "defaults": false,
+      "additional": [
+        "x86_64-unknown-linux-gnu",
+        "aarch64-unknown-linux-gnu",
+        "x86_64-apple-darwin",
+        "aarch64-apple-darwin",
+        "x86_64-pc-windows-msvc"
+      ]
+    }
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "napi build --platform --release",
+    "build:debug": "napi build --platform",
+    "artifacts": "napi artifacts",
+    "prepublishOnly": "napi prepublish -t npm --skip-gh-release",
+    "version": "napi version",
+    "test": "node test/smoke.mjs"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^2.18.4"
+  },
+  "engines": {
+    "node": ">= 18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "optionalDependencies": {
+    "@dcl/abgen-node-linux-x64-gnu": "0.15.0",
+    "@dcl/abgen-node-linux-arm64-gnu": "0.15.0",
+    "@dcl/abgen-node-darwin-x64": "0.15.0",
+    "@dcl/abgen-node-darwin-arm64": "0.15.0",
+    "@dcl/abgen-node-win32-x64-msvc": "0.15.0"
+  }
+}