cobrowse-sdk-react-native 3.8.0 → 3.10.0

package/.github/actions/install-npm-deps/action.yml

@@ -0,0 +1,26 @@
+name: Install npm dependencies
+description: >-
+  Install Node.js (with npm caching) and run `npm ci` for both the SDK (repo root —
+  needed by the symlinked SDK and `npm pack`) and the Example app, so the Example is
+  ready to build. Assumes the repo is already checked out.
+
+runs:
+  using: composite
+  steps:
+    - name: Install Node.js
+      uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+      with:
+        node-version-file: .nvmrc
+        cache: 'npm'
+        cache-dependency-path: |
+          package-lock.json
+          Example/package-lock.json
+
+    - name: Install SDK dependencies
+      shell: bash
+      run: npm ci
+
+    - name: Install Example dependencies
+      shell: bash
+      run: npm ci
+      working-directory: Example

package/.github/actions/install-packaged-sdk/action.yml

@@ -0,0 +1,22 @@
+name: Install the packaged SDK into the Example app
+description: >-
+  Pack the SDK (`npm pack` → runs prepack = `bob build`, exactly what publish does)
+  and install the tarball over the Example app's `file:../` symlink, so the app
+  bundles/links against what actually ships rather than the working tree. `npm install`
+  is used rather than manually extracting the tarball so npm resolves the SDK's runtime
+  deps (e.g. lodash). Assumes Node and the Example app's deps are already installed.
+
+runs:
+  using: composite
+  steps:
+    - name: Install the packaged SDK into the Example app
+      shell: bash
+      run: |
+        npm pack --pack-destination "$RUNNER_TEMP"
+        cd Example
+        npm install "$RUNNER_TEMP"/cobrowse-sdk-react-native-*.tgz --no-save
+        # The install must have replaced the file:../ symlink with the real package,
+        # otherwise we'd silently be testing the working tree again.
+        test -d node_modules/cobrowse-sdk-react-native && test ! -L node_modules/cobrowse-sdk-react-native \
+          || { echo "::error::packaged SDK install did not take (dependency is still a symlink)"; exit 1; }
+        echo "Installed packaged SDK $(node -p "require('./node_modules/cobrowse-sdk-react-native/package.json').version")"

package/.github/actions/install-pods/action.yml

@@ -0,0 +1,20 @@
+name: Install CocoaPods dependencies
+description: >-
+  Run `pod install` for the Example iOS app, retrying to survive the transient 503s that
+  hit Hermes' source download. Assumes the Example's node deps (and, for the e2e, the
+  packaged SDK) are already installed, since `pod install` resolves native modules from
+  node_modules.
+
+runs:
+  using: composite
+  steps:
+    - name: Install Pods
+      shell: bash
+      working-directory: Example/ios
+      run: |
+        for attempt in 1 2 3; do
+          pod install && exit 0
+          echo "pod install failed (attempt $attempt) — retrying in 15s…"
+          sleep 15
+        done
+        exit 1

package/.github/dependabot.yml

@@ -0,0 +1,27 @@
+version: 2
+
+updates:
+  - package-ecosystem: "npm"
+    directories:
+      - "/"
+      - "/Example"
+    schedule:
+      interval: "weekly"
+    # Take security updates only: `0` disables version updates but
+    # security updates are not subject to the limit.
+    open-pull-requests-limit: 0
+    ignore:
+      # CI fixtures — they exist so jest and tsc have a React Native to
+      # resolve against. React and React Native must move together, so
+      # bumping them is a deliberate change rather than an automatic one.
+      - dependency-name: "react"
+      - dependency-name: "react-native"
+      - dependency-name: "react-test-renderer"
+      - dependency-name: "@types/react-test-renderer"
+      - dependency-name: "metro-react-native-babel-preset"
+      - dependency-name: "@react-native/*"
+
+      # Shipped to consumers via optionalDependencies — bumping these is a
+      # customer-facing change that must move with the React upgrade.
+      - dependency-name: "@types/react"
+      - dependency-name: "@types/react-native"

package/.github/workflows/build-android.yml

@@ -0,0 +1,37 @@
+name: Build Android
+
+# Compiles and validates the SDK's native Android module by building the Example app.
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+# A newer push to the same PR cancels the in-flight run.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-android:
+    name: Build Example app (Android)
+    runs-on: ubuntu-latest
+    timeout-minutes: 25
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+
+      - name: Install npm dependencies
+        uses: ./.github/actions/install-npm-deps
+
+      # AGP 8.2.2 / Gradle 8.2.1 require JDK 17 (they reject 21). Pin explicitly.
+      - uses: actions/setup-java@03ad4de0992f5dab5e18fcb136590ce7c4a0ac95 # v5.6.0
+        name: Install JDK 17
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+          cache: 'gradle'
+
+      - name: Build debug APK
+        run: ./gradlew :app:assembleDebug
+        working-directory: Example/android

package/.github/workflows/build-ios.yml

@@ -0,0 +1,51 @@
+name: Build iOS
+
+# Compiles and validates the SDK's native iOS module by building the Example app.
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+# A newer push to the same PR cancels the in-flight run.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-ios:
+    name: Build Example app (iOS)
+    runs-on: macos-14
+    timeout-minutes: 45
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+
+      - name: Install npm dependencies
+        uses: ./.github/actions/install-npm-deps
+
+      - name: Install Pods
+        uses: ./.github/actions/install-pods
+
+      # Simulator build so no signing needed. Also compiles the Full-Device-Screen-Sharing extension.
+      - name: Build Example app
+        working-directory: Example/ios
+        run: |
+          xcodebuild \
+            -workspace Example.xcworkspace \
+            -scheme Example \
+            -configuration Debug \
+            -destination 'generic/platform=iOS Simulator' \
+            -resultBundlePath build/Example.xcresult \
+            CODE_SIGNING_ALLOWED=NO \
+            build
+
+      # xcodebuild output is huge/truncated in the UI; the .xcresult has the structured errors.
+      - name: Upload xcodebuild result bundle (on failure)
+        if: failure()
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: ios-xcresult
+          path: Example/ios/build/Example.xcresult
+          retention-days: 7
+          if-no-files-found: ignore

package/.github/workflows/build.yml

@@ -0,0 +1,67 @@
+name: Build
+
+# Builds and validates the publishable npm package. 
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+# A newer push to the same PR cancels the in-flight run.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-package:
+    name: Build & validate npm package
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+        name: Install Node.js
+        with:
+          node-version-file: .nvmrc
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build package (react-native-builder-bob)
+        run: npm run build
+
+      # `npm pack` runs the `prepack` script (bob build), so a dry-run exercises
+      # the exact build path `npm publish` takes — a broken publish fails here.
+      - name: Validate publish/pack path
+        run: npm pack --dry-run
+
+      # --- Advisory checks (non-blocking for now) ---
+      # These surface real, pre-existing packaging issues (main/module both point
+      # at the ESM build; no `type` field; internal files shipped). They are
+      # `continue-on-error` until the packaging fixes land, then flip to required
+      # by removing `continue-on-error` (and add `--strict` to publint).
+
+      - name: Validate package exports (publint) [advisory]
+        continue-on-error: true
+        run: npx --yes publint@0.3.22
+
+      - name: Validate type resolution (are-the-types-wrong) [advisory]
+        continue-on-error: true
+        run: npx --yes @arethetypeswrong/cli@0.18.5 --pack .
+
+      # Repo sanity: no build/codegen step above should modify or create tracked
+      # files. lib/ is gitignored, so this is a no-op today — it's a tripwire for
+      # when generated artefacts or a codegen step (e.g. a bob upgrade) later
+      # become part of the repo. `git status --porcelain` also catches new
+      # untracked files, which `git diff --exit-code` would miss.
+      - name: Verify working tree is clean
+        run: |
+          if [ -n "$(git status --porcelain)" ]; then
+            echo "::error::Build steps modified tracked files — commit the changes or fix the build."
+            git status --porcelain
+            git diff
+            exit 1
+          fi

package/.github/workflows/e2e-android.yml

@@ -0,0 +1,95 @@
+name: E2E Android
+
+# Validates the native Android Example app builds, runs, and can call the Cobrowse SDK.
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+# A newer push to the same PR cancels the in-flight run.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  e2e-android:
+    name: E2E Example app (Android)
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    # Build the Example against the *packaged* SDK (installed below), not the
+    # working-tree symlink — so this validates what actually ships. Read by
+    # Example/metro.config.js to pick the packaged-vs-symlink resolver.
+    env:
+      E2E_PACKAGED: '1'
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+
+      - name: Install npm dependencies
+        uses: ./.github/actions/install-npm-deps
+
+      # AGP 8.2.2 / Gradle 8.2.1 require JDK 17.
+      - uses: actions/setup-java@03ad4de0992f5dab5e18fcb136590ce7c4a0ac95 # v5.6.0
+        name: Install JDK 17
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+          cache: 'gradle'
+
+      - name: Install the packaged SDK into the Example app
+        uses: ./.github/actions/install-packaged-sdk
+
+      # Release embeds the JS bundle and is debug-keystore signed, so both APKs install on the emulator.
+      - name: Build release + test APKs
+        run: ./gradlew :app:assembleRelease :app:assembleReleaseAndroidTest
+        working-directory: Example/android
+
+      # Reclaim space from large preinstalled toolchains we don't use. The emulator's
+      # userdata partition is ~7GB once the build outputs are on disk.
+      - name: Free up disk space
+        run: |
+          df -h /
+          sudo rm -rf /usr/share/dotnet /opt/ghc /usr/local/.ghcup \
+                      /usr/share/swift /opt/hostedtoolcache/CodeQL
+          df -h /
+
+      # Emulators need hardware acceleration (KVM) to boot in reasonable time.
+      - name: Enable KVM
+        run: |
+          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+          sudo udevadm control --reload-rules
+          sudo udevadm trigger --name-match=kvm
+
+      - name: Boot emulator and run E2E tests
+        uses: reactivecircus/android-emulator-runner@e89f39f1abbbd05b1113a29cf4db69e7540cae5a # v2.37.0
+        env:
+          # Wait longer for the emulator to shut down cleanly before the action force-kills
+          # it (default 20s) — avoids spurious teardown errors on slow/loaded runners.
+          ANDROID_EMULATOR_WAIT_TIME_BEFORE_KILL: 180
+        with:
+          api-level: 34
+          target: google_apis
+          arch: x86_64
+          force-avd-creation: false
+          working-directory: Example/android
+          emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+          disable-animations: true
+          # Capture full logcat to a file (uploaded on failure) for red-run diagnostics,
+          # then install the app + test APKs, run E2ETests, and report pass/fail.
+          script: |
+            adb logcat -c
+            adb logcat > emulator.log &
+            ./gradlew :app:connectedReleaseAndroidTest
+
+      # Test reports + full logcat for debugging red runs.
+      - name: Upload instrumented-test report (on failure)
+        if: failure()
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: android-e2e-report
+          path: |
+            Example/android/app/build/reports/androidTests/connected
+            Example/android/emulator.log
+          retention-days: 7
+          if-no-files-found: ignore

package/.github/workflows/e2e-ios.yml

@@ -0,0 +1,58 @@
+name: E2E iOS
+
+# Validates the native iOS Example app builds, runs, and can call the Cobrowse SDK. 
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+# A newer push to the same PR cancels the in-flight run.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  e2e-ios:
+    name: E2E Example app (iOS)
+    runs-on: macos-14
+    timeout-minutes: 60
+    # Build the Example against the *packaged* SDK (installed below), not the
+    # working-tree symlink — so this validates what actually ships. Read by
+    # Example/metro.config.js (JS bundle) and, via node_modules, by `pod install`.
+    env:
+      E2E_PACKAGED: '1'
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+
+      - name: Install npm dependencies
+        uses: ./.github/actions/install-npm-deps
+
+      # pod install (next) resolves the packaged podspec + ios/ from node_modules.
+      - name: Install the packaged SDK into the Example app
+        uses: ./.github/actions/install-packaged-sdk
+
+      - name: Install Pods
+        uses: ./.github/actions/install-pods
+
+      # Release config embeds the JS bundle (no Metro); simulator build needs no signing.
+      - name: Run iOS E2E test
+        working-directory: Example/ios
+        run: |
+          xcodebuild test \
+            -workspace Example.xcworkspace \
+            -scheme Example \
+            -configuration Release \
+            -destination 'platform=iOS Simulator,name=iPhone 15,OS=latest' \
+            -resultBundlePath build/ExampleE2E.xcresult \
+            CODE_SIGNING_ALLOWED=NO
+
+      - name: Upload xcresult (on failure)
+        if: failure()
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: ios-e2e-xcresult
+          path: Example/ios/build/ExampleE2E.xcresult
+          retention-days: 7
+          if-no-files-found: ignore

package/.github/workflows/release.yml

@@ -18,7 +18,7 @@ jobs:
 
       - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
-          node-version: '24'
+          node-version-file: .nvmrc
           registry-url: 'https://registry.npmjs.org'
 
       - run: npm ci

package/.github/workflows/test.yml

@@ -0,0 +1,40 @@
+name: Test
+
+# Correctness checks for the JS layer: lint, type-check, and unit tests.
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+# A newer push to the same PR cancels the in-flight run.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Lint, type-check & unit tests
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+        name: Install Node.js
+        with:
+          node-version-file: .nvmrc
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Lint (ts-standard)
+        run: npm run lint
+
+      - name: Type-check (tsc --noEmit)
+        run: npm run typecheck
+
+      - name: Unit tests (jest)
+        run: npm test