@dcl/abgen 0.0.1 → 0.14.1

package/README.md

@@ -0,0 +1,44 @@
+# @dcl/abgen
+
+Prebuilt binaries for [abgen](https://github.com/decentraland/abgen): the standalone Decentraland
+asset-bundle converter + ab-cdn-compatible JIT server. Installing this package pulls the binary for
+your platform through an `optionalDependency`:
+
+| Platform | Package |
+|---|---|
+| Linux x64 (glibc >= 2.35) | `@dcl/abgen-linux-x64` |
+| Linux arm64 (glibc >= 2.35) | `@dcl/abgen-linux-arm64` |
+| Windows x64 | `@dcl/abgen-win32-x64` |
+| Windows arm64 | `@dcl/abgen-win32-arm64` |
+| macOS arm64 (Apple Silicon) | `@dcl/abgen-darwin-arm64` |
+| macOS x64 (Intel) | `@dcl/abgen-darwin-x64` |
+
+Each platform package carries the binary plus the `template/` and `shader/` runtime assets it
+resolves from its own directory - no configuration needed. The binaries are the same reproducible
+artifacts attached to the GitHub release of the matching tag.
+
+## Run the server
+
+```bash
+npx @dcl/abgen             # ab-cdn-compatible server on 127.0.0.1:5147
+ABGEN_CATALYST_URL=https://peer.decentraland.org/content npx @dcl/abgen
+```
+
+All configuration is environment variables - see the
+[repository README](https://github.com/decentraland/abgen#environment-variables).
+
+## Embed in a tool
+
+```js
+const { binPath } = require('@dcl/abgen')
+// spawn binPath() with the ABGEN_* environment you need
+```
+
+`binPath()` returns the absolute path of the platform binary, and throws with an actionable
+message on unsupported platforms or when the optional platform package was omitted at install
+time. `@dcl/sdk-commands` uses this to boot the asset-bundle preview sidecar.
+
+## License
+
+AGPL-3.0-or-later. Full text and vendored third-party notices in the
+[repository](https://github.com/decentraland/abgen).

package/bin/abgen.js

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+const { spawn } = require('child_process')
+const { binPath } = require('../index.js')
+
+const child = spawn(binPath(), process.argv.slice(2), { stdio: 'inherit' })
+child.on('error', (error) => {
+  console.error(`@dcl/abgen: ${error.message}`)
+  process.exit(1)
+})
+for (const signal of ['SIGINT', 'SIGTERM', 'SIGHUP']) {
+  process.on(signal, () => child.kill(signal))
+}
+child.on('exit', (code) => {
+  process.exit(code === null ? 1 : code)
+})

package/index.d.ts

@@ -0,0 +1,2 @@
+export function binPath(): string
+export const PLATFORM_PACKAGES: Record<string, readonly [pkg: string, bin: string]>

package/index.js

@@ -0,0 +1,36 @@
+const PLATFORM_PACKAGES = {
+  'linux-x64': ['@dcl/abgen-linux-x64', 'abgen'],
+  'linux-arm64': ['@dcl/abgen-linux-arm64', 'abgen'],
+  'win32-x64': ['@dcl/abgen-win32-x64', 'abgen.exe'],
+  'win32-arm64': ['@dcl/abgen-win32-arm64', 'abgen.exe'],
+  'darwin-arm64': ['@dcl/abgen-darwin-arm64', 'abgen'],
+  'darwin-x64': ['@dcl/abgen-darwin-x64', 'abgen']
+}
+
+function binPath() {
+  const key = `${process.platform}-${process.arch}`
+  const entry = PLATFORM_PACKAGES[key]
+  if (!entry) {
+    throw new Error(
+      `@dcl/abgen: no prebuilt binary for ${key} (available: ${Object.keys(PLATFORM_PACKAGES).join(', ')}). ` +
+        'Build abgen from source (https://github.com/decentraland/abgen) and put it on the PATH instead.'
+    )
+  }
+  const [pkg, bin] = entry
+  try {
+    return require.resolve(`${pkg}/${bin}`)
+  } catch {
+    // file:/link installs resolve this module to its realpath, where the platform
+    // package is not a sibling - fall back to the consumer's working directory.
+    try {
+      return require.resolve(`${pkg}/${bin}`, { paths: [process.cwd()] })
+    } catch {
+      throw new Error(
+        `@dcl/abgen: ${pkg} is missing. It installs as an optionalDependency of @dcl/abgen - ` +
+          'reinstall without --omit=optional / --no-optional, or add it as a direct dependency.'
+      )
+    }
+  }
+}
+
+module.exports = { binPath, PLATFORM_PACKAGES }

package/package.json

@@ -1,5 +1,31 @@
 {
   "name": "@dcl/abgen",
-  "version": "0.0.1",
-  "description": "Placeholder to bootstrap Trusted Publishing; superseded by the first CI release."
+  "version": "0.14.1",
+  "description": "Decentraland asset-bundle converter + ab-cdn-compatible JIT server. Installs the prebuilt abgen binary for your platform.",
+  "license": "AGPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/decentraland/abgen.git"
+  },
+  "main": "index.js",
+  "types": "index.d.ts",
+  "bin": {
+    "abgen": "bin/abgen.js"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "bin/abgen.js"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "optionalDependencies": {
+    "@dcl/abgen-linux-x64": "0.14.1",
+    "@dcl/abgen-linux-arm64": "0.14.1",
+    "@dcl/abgen-win32-x64": "0.14.1",
+    "@dcl/abgen-win32-arm64": "0.14.1",
+    "@dcl/abgen-darwin-arm64": "0.14.1",
+    "@dcl/abgen-darwin-x64": "0.14.1"
+  }
 }