@simontan/llm-gateway 0.2.1 → 0.3.0

package/README.en.md

@@ -195,3 +195,27 @@ Add a provider in `config.yaml`, then set `{PROVIDER}_API_KEY` in `.env`. Provid
 - Put a reverse proxy in front (TLS, WAF, IP controls)
 - For multi-instance deployments, use distributed rate limiting (Redis / Envoy / Nginx)
 - Keep API keys in environment variables only, never commit them
+
+## Cross-platform npm packaging (zigbuild)
+
+Install Zig and cargo-zigbuild first:
+
+```bash
+brew install zig
+cargo install cargo-zigbuild
+```
+
+Run the following commands to build and pack the npm package:
+
+```bash
+cargo zigbuild --release --target aarch64-apple-darwin
+cargo zigbuild --release --target x86_64-apple-darwin
+cargo zigbuild --release --target x86_64-unknown-linux-gnu
+cargo zigbuild --release --target x86_64-pc-windows-gnu
+npm run prepare:binaries
+npm pack
+```
+
+Artifacts:
+- Rust binaries are generated at `target/<triple>/release/llm-gateway`
+- The npm tarball is generated in the project root by `npm pack`

package/README.zh.md

@@ -195,3 +195,27 @@ sequenceDiagram
 - 建议在网关前加反向代理（TLS、WAF、IP 限制）
 - 多实例部署时，建议使用分布式限流（Redis / Envoy / Nginx）
 - API keys 仅放在环境变量，不要提交到仓库
+
+## npm 跨平台打包（zigbuild）
+
+先安装 Zig 和 cargo-zigbuild：
+
+```bash
+brew install zig
+cargo install cargo-zigbuild
+```
+
+执行以下命令构建并打包 npm 包：
+
+```bash
+cargo zigbuild --release --target aarch64-apple-darwin
+cargo zigbuild --release --target x86_64-apple-darwin
+cargo zigbuild --release --target x86_64-unknown-linux-gnu
+cargo zigbuild --release --target x86_64-pc-windows-gnu
+npm run prepare:binaries
+npm pack
+```
+
+产物说明：
+- Rust 二进制分别位于 `target/<triple>/release/llm-gateway`
+- npm 包文件由 `npm pack` 生成在项目根目录

package/lib/resolve-binary.js

@@ -3,11 +3,15 @@ const fs = require('node:fs')
 
 function resolveBinary() {
   const key = `${process.platform}-${process.arch}`
-  if (process.platform !== 'darwin') {
-    throw new Error(`Unsupported platform: ${key}. This package only supports macOS.`)
+  const supportedPlatforms = new Set(['darwin-arm64', 'darwin-x64', 'linux-x64', 'win32-x64'])
+  if (!supportedPlatforms.has(key)) {
+    throw new Error(
+      `Unsupported platform: ${key}. This package supports darwin-arm64, darwin-x64, linux-x64 (glibc), and win32-x64.`
+    )
   }
 
-  const binaryPath = path.resolve(__dirname, '..', 'npm-bin', key, 'llm-gateway')
+  const binaryName = process.platform === 'win32' ? 'llm-gateway.exe' : 'llm-gateway'
+  const binaryPath = path.resolve(__dirname, '..', 'npm-bin', key, binaryName)
   if (!fs.existsSync(binaryPath)) {
     throw new Error(`Missing binary: ${binaryPath}. Run: npm run prepare:binaries`)
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@simontan/llm-gateway",
-  "version": "0.2.1",
-  "description": "Prebuilt llm-gateway binary wrapper for macOS",
+  "version": "0.3.0",
+  "description": "Prebuilt llm-gateway binary wrapper for macOS, Linux, and Windows",
   "license": "MIT",
   "bin": {
     "llm-gateway": "bin/llm-gateway.js"
@@ -11,6 +11,8 @@
     "lib/resolve-binary.js",
     "npm-bin/darwin-arm64/llm-gateway",
     "npm-bin/darwin-x64/llm-gateway",
+    "npm-bin/linux-x64/llm-gateway",
+    "npm-bin/win32-x64/llm-gateway.exe",
     "README.md",
     "README.en.md",
     "README.zh.md"