feat: surfpool SDK

.github/workflows/release_crates.yaml

@@ -22,6 +22,7 @@ jobs:
     environment: release
 
     permissions:
+      contents: read
       id-token: write
 
     steps:
@@ -52,7 +53,7 @@ jobs:
           if [ -n "${{ inputs.crates }}" ]; then
             CRATES="${{ inputs.crates }}"
           else
-            CRATES="surfpool-types surfpool-db surfpool-core surfpool-studio-ui"
+            CRATES="surfpool-types surfpool-db surfpool-core surfpool-sdk surfpool-studio-ui"
           fi
 
           for CRATE in $CRATES; do

.github/workflows/release_sdk_node_npm.yml

@@ -0,0 +1,258 @@
+name: Publish SDK Node Package
+
+on:
+  workflow_dispatch:
+    inputs:
+      dry_run:
+        description: "Dry run (do not actually publish to npm)"
+        required: false
+        type: boolean
+        default: false
+
+env:
+  CARGO_TERM_COLOR: always
+  SURFPOOL_WEB_UI_VERSION: 0.2.0-alpha.0
+
+jobs:
+  prepare_release:
+    name: Prepare Release
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.package.outputs.version }}
+      publish_root: ${{ steps.package.outputs.publish_root }}
+      publish_darwin_x64: ${{ steps.package.outputs.publish_darwin_x64 }}
+      publish_darwin_arm64: ${{ steps.package.outputs.publish_darwin_arm64 }}
+      publish_linux_x64_gnu: ${{ steps.package.outputs.publish_linux_x64_gnu }}
+      should_publish: ${{ steps.package.outputs.should_publish }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.14.0
+          registry-url: https://registry.npmjs.org
+
+      - name: Ensure npm 11
+        run: |
+          npm install -g npm@^11.10.0
+          npm --version
+
+      - name: Read package version
+        id: package
+        working-directory: crates/sdk-node
+        shell: bash
+        run: |
+          VERSION=$(node -p "require('./package.json').version")
+          echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
+          SHOULD_PUBLISH=false
+
+          for ENTRY in \
+            "surfpool-sdk publish_root" \
+            "surfpool-sdk-darwin-x64 publish_darwin_x64" \
+            "surfpool-sdk-darwin-arm64 publish_darwin_arm64" \
+            "surfpool-sdk-linux-x64-gnu publish_linux_x64_gnu"
+          do
+            PACKAGE_NAME="${ENTRY% *}"
+            OUTPUT_NAME="${ENTRY#* }"
+
+            if npm view "${PACKAGE_NAME}@${VERSION}" version --registry=https://registry.npmjs.org >/dev/null 2>&1; then
+              echo "${OUTPUT_NAME}=false" >> "$GITHUB_OUTPUT"
+              echo "${PACKAGE_NAME}@${VERSION} is already published"
+            else
+              echo "${OUTPUT_NAME}=true" >> "$GITHUB_OUTPUT"
+              echo "${PACKAGE_NAME}@${VERSION} is ready to publish"
+              SHOULD_PUBLISH=true
+            fi
+          done
+
+          echo "should_publish=${SHOULD_PUBLISH}" >> "$GITHUB_OUTPUT"
+
+  build_artifacts:
+    name: Build (${{ matrix.name }})
+    needs: prepare_release
+    if: needs.prepare_release.outputs.should_publish == 'true'
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: linux-x64
+            os: ubuntu-22.04
+            upload_metadata: true
+            platform_dir: linux-x64-gnu
+          - name: macos-x64
+            os: macos-15-intel
+            upload_metadata: false
+            platform_dir: darwin-x64
+          - name: macos-arm64
+            os: macos-15
+            upload_metadata: false
+            platform_dir: darwin-arm64
+
+    steps:
+      - name: Install Linux dependencies
+        if: runner.os == 'Linux'
+        run: sudo apt-get update && sudo apt-get install -y libudev-dev clang libclang-dev
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache Rust artifacts
+        uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: |
+            . -> target
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.14.0
+          cache: npm
+          cache-dependency-path: crates/sdk-node/package-lock.json
+
+      - name: Install npm dependencies
+        working-directory: crates/sdk-node
+        run: npm ci
+
+      - name: Build npm package
+        working-directory: crates/sdk-node
+        run: npm run build
+
+      - name: Smoke test package
+        working-directory: crates/sdk-node
+        run: npm run smoke
+
+      - name: Upload native binary
+        uses: actions/upload-artifact@v4
+        with:
+          name: sdk-node-${{ matrix.name }}-binary
+          path: crates/sdk-node/surfpool-sdk.*.node
+          if-no-files-found: error
+
+      - name: Upload package metadata
+        if: matrix.upload_metadata
+        uses: actions/upload-artifact@v4
+        with:
+          name: sdk-node-package-metadata
+          path: |
+            crates/sdk-node/surfpool-sdk/internal.js
+            crates/sdk-node/surfpool-sdk/internal.d.ts
+          if-no-files-found: error
+
+  publish:
+    name: Publish To npm
+    needs:
+      - prepare_release
+      - build_artifacts
+    if: needs.prepare_release.outputs.should_publish == 'true'
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Install Linux dependencies
+        run: sudo apt-get update && sudo apt-get install -y libudev-dev clang libclang-dev
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.14.0
+          registry-url: https://registry.npmjs.org
+          cache: npm
+          cache-dependency-path: crates/sdk-node/package-lock.json
+
+      - name: Ensure npm 11
+        run: |
+          npm install -g npm@^11.10.0
+          npm --version
+
+      - name: Install npm dependencies
+        working-directory: crates/sdk-node
+        run: npm ci
+
+      - name: Download native binaries
+        uses: actions/download-artifact@v4
+        with:
+          pattern: sdk-node-*-binary
+          path: crates/sdk-node/artifacts
+
+      - name: Download package metadata
+        uses: actions/download-artifact@v4
+        with:
+          name: sdk-node-package-metadata
+          path: crates/sdk-node/surfpool-sdk
+
+      - name: Create npm platform package directories
+        working-directory: crates/sdk-node
+        run: npm run create-npm-dir
+
+      - name: Copy artifacts into npm platform packages
+        working-directory: crates/sdk-node
+        run: npm run artifacts
+
+      - name: Build TypeScript wrapper
+        working-directory: crates/sdk-node
+        run: npm run build:ts
+
+      - name: Pack root npm tarball
+        working-directory: crates/sdk-node
+        run: NPM_CONFIG_CACHE=$(mktemp -d) npm pack --dry-run
+
+      - name: Pack platform npm tarballs
+        working-directory: crates/sdk-node
+        run: |
+          cd npm/darwin-x64 && NPM_CONFIG_CACHE=$(mktemp -d) npm pack --dry-run
+          cd ../darwin-arm64 && NPM_CONFIG_CACHE=$(mktemp -d) npm pack --dry-run
+          cd ../linux-x64-gnu && NPM_CONFIG_CACHE=$(mktemp -d) npm pack --dry-run
+
+      - name: Publish darwin-x64 package
+        if: inputs.dry_run != true && needs.prepare_release.outputs.publish_darwin_x64 == 'true'
+        working-directory: crates/sdk-node/npm/darwin-x64
+        run: npm publish --access public --provenance
+
+      - name: Publish darwin-arm64 package
+        if: inputs.dry_run != true && needs.prepare_release.outputs.publish_darwin_arm64 == 'true'
+        working-directory: crates/sdk-node/npm/darwin-arm64
+        run: npm publish --access public --provenance
+
+      - name: Publish linux-x64-gnu package
+        if: inputs.dry_run != true && needs.prepare_release.outputs.publish_linux_x64_gnu == 'true'
+        working-directory: crates/sdk-node/npm/linux-x64-gnu
+        run: npm publish --access public --provenance
+
+      - name: Dry run darwin-x64 publish
+        if: inputs.dry_run == true && needs.prepare_release.outputs.publish_darwin_x64 == 'true'
+        working-directory: crates/sdk-node/npm/darwin-x64
+        run: npm publish --dry-run --access public
+
+      - name: Dry run darwin-arm64 publish
+        if: inputs.dry_run == true && needs.prepare_release.outputs.publish_darwin_arm64 == 'true'
+        working-directory: crates/sdk-node/npm/darwin-arm64
+        run: npm publish --dry-run --access public
+
+      - name: Dry run linux-x64-gnu publish
+        if: inputs.dry_run == true && needs.prepare_release.outputs.publish_linux_x64_gnu == 'true'
+        working-directory: crates/sdk-node/npm/linux-x64-gnu
+        run: npm publish --dry-run --access public
+
+      - name: Publish root package
+        if: inputs.dry_run != true && needs.prepare_release.outputs.publish_root == 'true'
+        working-directory: crates/sdk-node
+        run: npm publish --access public --provenance
+
+      - name: Dry run root publish
+        if: inputs.dry_run == true && needs.prepare_release.outputs.publish_root == 'true'
+        working-directory: crates/sdk-node
+        run: npm publish --dry-run --access public