Review Feedabck

Signed-off-by: Simon Davies <simongdavies@users.noreply.github.com>

Author: simongdavies

.github/workflows/npm-publish.yml

@@ -45,6 +45,9 @@ jobs:
           - target: x86_64-unknown-linux-gnu
             os: [self-hosted, Linux, X64, "1ES.Pool=hld-kvm-amd"]
             build_name: linux-x64-gnu
+          - target: x86_64-unknown-linux-musl
+            os: [self-hosted, Linux, X64, "1ES.Pool=hld-kvm-amd"]
+            build_name: linux-x64-musl
           - target: x86_64-pc-windows-msvc
             os: [self-hosted, Windows, X64, "1ES.Pool=hld-win2022-amd"]
             build_name: win32-x64-msvc
@@ -76,9 +79,17 @@ jobs:
         run: |
           npm version ${{ inputs.version }} --no-git-tag-version --allow-same-version
 
+      - name: Install musl tools
+        if: contains(matrix.target, 'musl')
+        run: sudo apt-get update && sudo apt-get install -y musl-tools
+
+      - name: Add musl Rust target
+        if: contains(matrix.target, 'musl')
+        run: rustup target add x86_64-unknown-linux-musl
+
       - name: Build native module
         working-directory: ${{ env.WORKING_DIR }}
-        run: npm run build
+        run: npm run build -- --target ${{ matrix.target }}
 
       - name: Upload artifact
         uses: actions/upload-artifact@v8
@@ -105,12 +116,18 @@ jobs:
         working-directory: ${{ env.WORKING_DIR }}
         run: npm ci --ignore-scripts --omit=optional
 
-      - name: Download Linux artifact
+      - name: Download Linux GNU artifact
         uses: actions/download-artifact@v8
         with:
           name: bindings-linux-x64-gnu
           path: ${{ env.WORKING_DIR }}/artifacts/linux-x64-gnu
 
+      - name: Download Linux musl artifact
+        uses: actions/download-artifact@v8
+        with:
+          name: bindings-linux-x64-musl
+          path: ${{ env.WORKING_DIR }}/artifacts/linux-x64-musl
+
       - name: Download Windows artifact
         uses: actions/download-artifact@v8
         with:
@@ -125,8 +142,10 @@ jobs:
         run: |
           # Rename artifacts to match napi-rs naming convention
           mv artifacts/linux-x64-gnu/*.node npm/linux-x64-gnu/js-host-api.linux-x64-gnu.node
+          mv artifacts/linux-x64-musl/*.node npm/linux-x64-musl/js-host-api.linux-x64-musl.node
           mv artifacts/win32-x64-msvc/*.node npm/win32-x64-msvc/js-host-api.win32-x64-msvc.node
           ls -la npm/linux-x64-gnu/
+          ls -la npm/linux-x64-musl/
           ls -la npm/win32-x64-msvc/
 
       - name: Set package versions
@@ -137,6 +156,7 @@ jobs:
           
           # Update platform package versions
           cd npm/linux-x64-gnu && npm version ${{ inputs.version }} --no-git-tag-version --allow-same-version
+          cd ../linux-x64-musl && npm version ${{ inputs.version }} --no-git-tag-version --allow-same-version
           cd ../win32-x64-msvc && npm version ${{ inputs.version }} --no-git-tag-version --allow-same-version
 
       - name: Update optionalDependencies versions
@@ -162,13 +182,20 @@ jobs:
           npx napi prepublish -t npm --skip-gh-release
           ls -la index.js index.d.ts
 
-      - name: Publish Linux package
+      - name: Publish Linux GNU package
         if: ${{ !inputs.dry-run }}
         working-directory: ${{ env.WORKING_DIR }}/npm/linux-x64-gnu
         run: npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
+      - name: Publish Linux musl package
+        if: ${{ !inputs.dry-run }}
+        working-directory: ${{ env.WORKING_DIR }}/npm/linux-x64-musl
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
       - name: Publish Windows package
         if: ${{ !inputs.dry-run }}
         working-directory: ${{ env.WORKING_DIR }}/npm/win32-x64-msvc
@@ -192,6 +219,9 @@ jobs:
           echo "--- @hyperlight/js-host-api-linux-x64-gnu ---"
           npm pack ./npm/linux-x64-gnu --dry-run
           echo ""
+          echo "--- @hyperlight/js-host-api-linux-x64-musl ---"
+          npm pack ./npm/linux-x64-musl --dry-run
+          echo ""
           echo "--- @hyperlight/js-host-api-win32-x64-msvc ---"
           npm pack ./npm/win32-x64-msvc --dry-run
           echo ""

src/js-host-api/README.md

@@ -634,10 +634,19 @@ To create an npm token:
 
 ### Package Structure
 
-The npm release consists of three packages:
+The npm release consists of the following packages:
 
 | Package | Description |
 |---------|-------------|
 | `@hyperlight/js-host-api` | Main package (installs correct binary automatically) |
-| `@hyperlight/js-host-api-linux-x64-gnu` | Linux x86_64 native binary |
+| `@hyperlight/js-host-api-linux-x64-gnu` | Linux x86_64 (glibc) native binary |
+| `@hyperlight/js-host-api-linux-x64-musl` | Linux x86_64 (musl/Alpine) native binary |
 | `@hyperlight/js-host-api-win32-x64-msvc` | Windows x86_64 native binary |
+
+### How Platform Selection Works
+
+This project uses the [napi-rs](https://napi.rs/docs/deep-dive/release#3-the-native-addon-for-different-platforms-is-distributed-through-different-npm-packages) approach for distributing native addons across platforms. Each platform-specific binary is published as a separate npm package and listed as an `optionalDependency` of the main package.
+
+**At install time:** npm uses the `os`, `cpu`, and `libc` fields in each platform sub-package's `package.json` to determine which optional dependency to install. Packages that don't match the user's platform are silently skipped. The main package itself does **not** have `os`/`cpu` fields because it contains only JavaScript — restricting it would prevent installation on unsupported platforms even for type-checking or development purposes.
+
+**At runtime:** The napi-rs generated `index.js` detects the platform (including glibc vs musl on Linux) and loads the correct `.node` binary.

src/js-host-api/npm/linux-x64-gnu/package.json

@@ -23,5 +23,8 @@
   },
   "engines": {
     "node": ">= 18"
-  }
+  },
+  "libc": [
+    "glibc"
+  ]
 }

src/js-host-api/npm/linux-x64-musl/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@hyperlight/js-host-api-linux-x64-musl",
+  "version": "0.17.0",
+  "os": [
+    "linux"
+  ],
+  "cpu": [
+    "x64"
+  ],
+  "main": "js-host-api.linux-x64-musl.node",
+  "files": [
+    "js-host-api.linux-x64-musl.node"
+  ],
+  "description": "Node.js API bindings for Hyperlight JS - Linux x64 musl",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hyperlight-dev/hyperlight-js.git"
+  },
+  "homepage": "https://github.com/hyperlight-dev/hyperlight-js#readme",
+  "bugs": {
+    "url": "https://github.com/hyperlight-dev/hyperlight-js/issues"
+  },
+  "engines": {
+    "node": ">= 18"
+  },
+  "libc": [
+    "musl"
+  ]
+}

src/js-host-api/package.json

@@ -16,12 +16,14 @@
     "binaryName": "js-host-api",
     "targets": [
       "x86_64-unknown-linux-gnu",
+      "x86_64-unknown-linux-musl",
       "x86_64-pc-windows-msvc"
     ]
   },
   "license": "Apache-2.0",
   "optionalDependencies": {
     "@hyperlight/js-host-api-linux-x64-gnu": "0.17.0",
+    "@hyperlight/js-host-api-linux-x64-musl": "0.17.0",
     "@hyperlight/js-host-api-win32-x64-msvc": "0.17.0"
   },
   "devDependencies": {