Replace deprectated prebuld

Author: gms1

.github/workflows/ci.yml

@@ -63,48 +63,82 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os:
-          - macos-latest
-          - ubuntu-24.04
-          - windows-latest
-        host:
-          - x64
-        target:
-          - x64
-        node:
-          - 20
-          - 22
-          - 24
-        exclude:
-          # Node 20 x64 crashes under Rosetta 2 on ARM64 macOS runners
+        include:
           - os: macos-latest
+            host: x64
+            target: x64
+            platform: macos-x64
             node: 20
+          - os: macos-latest
             host: x64
-        include:
+            target: x64
+            platform: macos-x64
+            node: 22
           - os: macos-latest
+            host: x64
+            target: x64
+            platform: macos-x64
+            node: 24
+          - os: ubuntu-24.04
+            host: x64
+            target: x64
+            platform: linux-x64
+            node: 20
+          - os: ubuntu-24.04
+            host: x64
+            target: x64
+            platform: linux-x64
+            node: 22
+          - os: ubuntu-24.04
+            host: x64
+            target: x64
+            platform: linux-x64
+            node: 24
+          - os: windows-latest
+            host: x64
+            target: x64
+            platform: win32-x64
             node: 20
+          - os: windows-latest
+            host: x64
+            target: x64
+            platform: win32-x64
+            node: 22
+          - os: windows-latest
+            host: x64
+            target: x64
+            platform: win32-x64
+            node: 24
+          - os: macos-latest
             host: arm64
             target: arm64
+            platform: macos-arm64
+            node: 20
           - os: macos-latest
-            node: 22
             host: arm64
             target: arm64
+            platform: macos-arm64
+            node: 22
           - os: macos-latest
-            node: 24
             host: arm64
             target: arm64
+            platform: macos-arm64
+            node: 24
           - os: ubuntu-24.04-arm
-            node: 20
             host: arm64
             target: arm64
+            platform: linux-arm64
+            node: 20
           - os: ubuntu-24.04-arm
-            node: 22
             host: arm64
             target: arm64
+            platform: linux-arm64
+            node: 22
           - os: ubuntu-24.04-arm
-            node: 24
             host: arm64
             target: arm64
+            platform: linux-arm64
+            node: 24
     name: ${{ matrix.os }} (node=${{ matrix.node }}, host=${{ matrix.host }}, target=${{ matrix.target }})
     steps:
       - uses: actions/checkout@v6
@@ -143,16 +177,17 @@ jobs:
           echo "CXXFLAGS=${CXXFLAGS:-} -include ../src/gcc-preinclude.h" >> $GITHUB_ENV
 
       - name: Build binaries
-        run: yarn prebuild -a ${{ env.TARGET }}
+        run: yarn prebuild
 
       - name: Print binary info
         if: contains(matrix.os, 'ubuntu')
         run: |
-          ldd build/**/node_sqlite3.node
+          BIN=$(find prebuilds -name "*.node" | head -1)
+          ldd "$BIN"
           echo "---"
-          nm build/**/node_sqlite3.node | grep "GLIBC_" | c++filt || true
+          nm "$BIN" | grep "GLIBC_" | c++filt || true
           echo "---"
-          file build/**/node_sqlite3.node
+          file "$BIN"
 
       - name: Run tests
         run: yarn test
@@ -161,13 +196,15 @@ jobs:
         uses: actions/upload-artifact@v7
         if: matrix.node == 24
         with:
-          name: prebuilt-binaries-${{ matrix.os }}-${{ matrix.host }}
+          name: prebuilt-binaries-${{ matrix.platform }}
           path: prebuilds/*
           retention-days: 7
 
       - name: Upload binaries to GitHub Release
-        run: yarn upload --upload-all ${{ github.token }}
+        run: gh release upload ${GITHUB_REF#refs/tags/} prebuilds/* --clobber
         if: matrix.node == 24 && startsWith(github.ref, 'refs/tags/')
+        env:
+          GH_TOKEN: ${{ github.token }}
 
   build-musl:
     permissions:
@@ -209,8 +246,54 @@ jobs:
           retention-days: 7
 
       - name: Upload binaries to GitHub Release
-        run: yarn install --frozen-lockfile --ignore-scripts && yarn upload --upload-all ${{ github.token }}
+        run: |
+          gh release upload ${GITHUB_REF#refs/tags/} prebuilds/* --clobber
         if: startsWith(github.ref, 'refs/tags/')
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+  package:
+    needs: [build]
+    if: github.event_name == 'workflow_dispatch' || (github.event_name == 'pull_request') || (github.event_name == 'push' && !startsWith(github.ref, 'refs/tags/'))
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 24
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile --ignore-scripts
+
+      - name: Download all prebuilt binary artifacts
+        uses: actions/download-artifact@v5
+        with:
+          path: prebuilds-artifacts
+          merge-multiple: true
+
+      - name: Merge prebuilds into package
+        run: |
+          mkdir -p prebuilds
+          # Each artifact may contain platform-specific subdirs
+          # Copy all prebuilds from artifacts into prebuilds/
+          cp -r prebuilds-artifacts/*/ prebuilds/ 2>/dev/null || true
+          # Also handle flat structure (files directly in artifact root)
+          cp -r prebuilds-artifacts/ prebuilds/ 2>/dev/null || true
+          # Verify the prebuilds are present
+          find prebuilds -name '*.node' -type f
+
+      - name: Create npm tarball
+        run: |
+          npm pack
+          echo "npm tarball created:"
+          ls -la *.tgz
+
+      - name: Upload npm tarball as commit artifact
+        uses: actions/upload-artifact@v7
+        with:
+          name: npm-package-tarball
+          path: '*.tgz'
+          retention-days: 7
 
   publish-npm:
     needs: [build, build-musl]
@@ -229,5 +312,18 @@ jobs:
       - name: Install dependencies
         run: yarn install --frozen-lockfile --ignore-scripts
 
+      - name: Download all prebuilt binary artifacts
+        uses: actions/download-artifact@v5
+        with:
+          path: prebuilds-artifacts
+          merge-multiple: true
+
+      - name: Merge prebuilds into package
+        run: |
+          mkdir -p prebuilds
+          cp -r prebuilds-artifacts/*/ prebuilds/ 2>/dev/null || true
+          cp -r prebuilds-artifacts/ prebuilds/ 2>/dev/null || true
+          find prebuilds -name '*.node' -type f
+
       - name: Publish to npm
         run: npm publish

.github/workflows/test-npm-package.yml

@@ -0,0 +1,93 @@
+name: Test npm package
+on:
+  workflow_dispatch:
+    inputs:
+      target_run_id:
+        description: 'The Run ID of the upstream CI workflow'
+        required: true
+        type: string
+      node_version:
+        description: 'Node.js version to test with'
+        required: false
+        default: '20'
+        type: string
+
+jobs:
+  test-artifact:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            platform: linux-x64
+          - os: ubuntu-24.04-arm
+            platform: linux-arm64
+          - os: macos-latest
+            platform: macos-arm64
+          - os: windows-latest
+            platform: win32-x64
+    runs-on: ${{ matrix.os }}
+    name: ${{ matrix.platform }}
+    steps:
+      - name: Download artifact from specific run
+        uses: actions/download-artifact@v5
+        with:
+          run-id: ${{ github.event.inputs.target_run_id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          name: npm-package-tarball
+          path: ./downloads
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: ${{ github.event.inputs.node_version || '20' }}
+
+      - name: Install tarball and verify
+        shell: bash
+        run: |
+          TARBALL=$(ls ./downloads/*.tgz | head -1)
+          echo "Installing tarball: $TARBALL"
+          mkdir test-project && cd test-project
+          npm init -y
+          npm install "$TARBALL"
+          echo "--- Installed package contents ---"
+          ls -la node_modules/@homeofthings/sqlite3/ 2>/dev/null || dir node_modules\\@homeofthings\\sqlite3\\ 2>/dev/null || true
+          echo "--- Prebuilds ---"
+          find node_modules/@homeofthings/sqlite3/prebuilds -name "*.node" -type f 2>/dev/null || true
+
+      - name: Smoke test - callback API
+        shell: bash
+        run: |
+          cd test-project
+          node -e "
+            const sqlite3 = require('@homeofthings/sqlite3');
+            console.log('sqlite3 version:', sqlite3.VERSION);
+            const db = new sqlite3.Database(':memory:');
+            db.serialize(() => {
+              db.run('CREATE TABLE test (id INT, name TEXT)');
+              db.run('INSERT INTO test VALUES (1, \"hello\")');
+              db.get('SELECT * FROM test', (err, row) => {
+                if (err) { console.error('Query failed:', err); process.exit(1); }
+                console.log('Callback API result:', JSON.stringify(row));
+                db.close();
+              });
+            });
+          "
+
+      - name: Smoke test - promise API
+        shell: bash
+        run: |
+          cd test-project
+          node -e "
+            const sqlite3 = require('@homeofthings/sqlite3');
+            const { SqliteDatabase } = sqlite3;
+            async function main() {
+              const db = await SqliteDatabase.open(':memory:');
+              await db.run('CREATE TABLE test (id INT, name TEXT)');
+              await db.run('INSERT INTO test VALUES (1, \"hello\")');
+              const row = await db.get('SELECT * FROM test');
+              console.log('Promise API result:', JSON.stringify(row));
+              await db.close();
+            }
+            main().catch(err => { console.error(err); process.exit(1); });
+          "

README.md

@@ -36,23 +36,25 @@ yarn add @homeofthings/sqlite3
 
 ### Prebuilt binaries
 
-`@homeofthings/sqlite3` uses [Node-API](https://nodejs.org/api/n-api.html) so prebuilt binaries do not need to be built for specific Node versions. Prebuilt binaries are available for Node-API v3 and v6. Check the [Node-API version matrix](https://nodejs.org/api/n-api.html#node-api-version-matrix) to ensure your Node version supports one of these. Requires Node.js v20.17.0 or later.
+`@homeofthings/sqlite3` uses [Node-API](https://nodejs.org/api/n-api.html) so prebuilt binaries do not need to be built for specific Node versions. Prebuilt binaries are built as NAPI-version-agnostic (`@homeofthings+sqlite3.*.node`) using the `--napi` flag, and work on any Node.js version that supports the NAPI version used at compile time. Requires Node.js v20.17.0 or later.
 
-The module uses [`prebuild-install`](https://github.com/prebuild/prebuild-install) to download the prebuilt binary for your platform, if it exists. These binaries are hosted on GitHub Releases. The following targets are currently provided:
+Prebuilt binaries are bundled inside the npm package using [`prebuildify`](https://github.com/prebuild/prebuildify) and loaded at runtime by [`node-gyp-build`](https://github.com/prebuild/node-gyp-build). No separate download step is needed — `npm install` just works. The following targets are currently provided:
 
 * `darwin-arm64`
 * `darwin-x64`
-* `linux-arm64`
-* `linux-x64`
-* `linuxmusl-arm64`
-* `linuxmusl-x64`
+* `linux-arm64` (glibc)
+* `linux-x64` (glibc)
+* `linux-arm64` (musl)
+* `linux-x64` (musl)
 * `win32-x64`
 
-Unfortunately, [prebuild](https://github.com/prebuild/prebuild/issues/174) cannot differentiate between `armv6` and `armv7`, and instead uses `arm` as the `{arch}`. Until that is fixed, you will still need to install `sqlite3` from [source](#source-install).
-
 Support for other platforms and architectures may be added in the future if CI supports building on them.
 
-If your environment isn't supported, it'll use `node-gyp` to build SQLite, but you will need to install a C++ compiler and linker.
+If your platform isn't supported, `node-gyp-build` automatically falls back to building from source using `node-gyp`. For custom builds (e.g., SQLCipher, external SQLite), use `--build-from-source`:
+
+```bash
+npm install @homeofthings/sqlite3 --build-from-source --sqlite_libname=sqlcipher --sqlite=/usr/
+```
 
 ### Other ways to install
 
@@ -135,23 +137,23 @@ db.close();
 To skip searching for pre-compiled binaries, and force a build from source, use
 
 ```bash
-npm install --build-from-source --sqlite=/usr/local
+npm install @homeofthings/sqlite3 --build-from-source --sqlite=/usr/local
 ```
 
 If building against an external sqlite3 make sure to have the development headers available. Mac OS X ships with these by default. If you don't have them installed, install the `-dev` package with your package manager, e.g. `apt-get install libsqlite3-dev` for Debian/Ubuntu. Make sure that you have at least `libsqlite3` >= 3.6.
 
 Note, if building against homebrew-installed sqlite on OS X you can do:
 
 ```bash
-npm install --build-from-source --sqlite=/usr/local/opt/sqlite/
+npm install @homeofthings/sqlite3 --build-from-source --sqlite=/usr/local/opt/sqlite/
 ```
 
 ## Custom file header (magic)
 
 The default sqlite file header is "SQLite format 3". You can specify a different magic, though this will make standard tools and libraries unable to work with your files.
 
 ```bash
-npm install --build-from-source --sqlite_magic="MyCustomMagic15"
+npm install @homeofthings/sqlite3 --build-from-source --sqlite_magic="MyCustomMagic15"
 ```
 
 Note that the magic *must* be exactly 15 characters long (16 bytes including null terminator).
@@ -174,7 +176,7 @@ npm install @homeofthings/sqlite3 --build-from-source --runtime=node-webkit --ta
 You can also run this command from within a `@homeofthings/sqlite3` checkout:
 
 ```bash
-npm install --build-from-source --runtime=node-webkit --target_arch=ia32 --target=$(NODE_WEBKIT_VERSION)
+npm install @homeofthings/sqlite3 --build-from-source --runtime=node-webkit --target_arch=ia32 --target=$(NODE_WEBKIT_VERSION)
 ```
 
 Remember the following: