chore: Prepare to use TypeScript natively (#2910)

### Description

This PR is a starting point of upgrading to TypeScript and preparing for
future upgrades around testing and maintenance.

I've seen that couple of types between the `*.js` files and the
`index.d.ts` were not 100% in sync, which is one of the reasons the move
to TypeScript natively could help here.

### What's new / changed

- moved `js` to `lib` in order to keep `js` as the same output folder
which is delivered to NPM
- `js/index.d.ts` stays as type export for NPM and the types are
re-exported via the jsdoc `@typedef`
- `types.ts` is actually the same as the previous `index.d.ts` excluding
the `SentryCli` class
- TypeScript is partially used to keep the changes minimal
- I aligned the jsdoc types with the actual text from the previous
`index.d.ts`

Author: JPeer264

.cursor/rules/javascript-development.mdc

@@ -9,7 +9,6 @@ alwaysApply: false
 ## Code Organization
 
 - Maintain compatibility with existing npm package structure
-- Update TypeScript definitions in `js/index.d.ts` if needed
 - Consider impact on installation flow in `scripts/install.js`
 - Test across different Node.js versions
 
@@ -36,6 +35,6 @@ npm run check:types
 
 ## TypeScript Support
 
-- Type definitions maintained in `js/index.d.ts`
+- Type definitions are generated via TypeScript
 - Sync with Rust CLI interface changes
 - Consider backward compatibility for JS API

.cursor/rules/sentry-cli-project.mdc

@@ -20,7 +20,7 @@ This is **sentry-cli**, a command-line utility for working with Sentry. It's pri
 ## Project Structure
 
 - `src/` - Core Rust source code with command modules and utilities
-- `js/` - JavaScript wrapper and npm package code
+- `lib/` - JavaScript wrapper and npm package code
 - `scripts/` - Build and utility scripts
 - `tests/integration/` - Integration tests using `.trycmd` format
 - `npm-binary-distributions/` - Platform-specific binary packages

.github/CODEOWNERS

@@ -4,7 +4,7 @@
 /.cursor/rules/javascript-development.mdc @getsentry/team-javascript-sdks @getsentry/owners-sentry-cli
 /.npmignore @getsentry/team-javascript-sdks @getsentry/owners-sentry-cli
 /bin/ @getsentry/team-javascript-sdks @getsentry/owners-sentry-cli  # these are the JS "binaries"
-/js @getsentry/team-javascript-sdks @getsentry/owners-sentry-cli
+/lib @getsentry/team-javascript-sdks @getsentry/owners-sentry-cli
 /package.json @getsentry/team-javascript-sdks @getsentry/owners-sentry-cli
 /scripts/*.js @getsentry/team-javascript-sdks @getsentry/owners-sentry-cli
 /tsconfig.json @getsentry/team-javascript-sdks @getsentry/owners-sentry-cli

.github/workflows/build.yml

@@ -228,6 +228,9 @@ jobs:
         with:
           node-version: '20.10.0'
 
+      - name: Install dependencies
+        run: npm ci --ignore-scripts
+
       - name: Download compiled binaries
         uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # 6.0.0
         with:

.github/workflows/test_node.yml

@@ -26,7 +26,7 @@ jobs:
 
       - name: Install dependencies via npm ci
         if: ${{ !inputs.triggered-by-release }}
-        run: npm ci
+        run: npm ci --ignore-scripts
 
       # For pushes to the release branch, we need to install the dependencies via `npm install`
       # because the `package-lock.json` is not updated with the new versions of the optional
@@ -37,7 +37,30 @@ jobs:
 
       - run: npm run check:types
 
+  prepare_build:
+    name: Prepare Build
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0
+
+      - name: Use Node.js
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # 6.0.0
+        with:
+          node-version-file: package.json
+
+      - name: Install dependencies
+        run: npm ci --ignore-scripts
+
+      - name: Build
+        run: npm run build
+
+      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # 4.6.2
+        with:
+          name: artifact-build
+          path: js
+
   test_node:
+    needs: prepare_build
     strategy:
       fail-fast: false
       matrix:
@@ -56,7 +79,7 @@ jobs:
 
       - name: Install dependencies via npm ci
         if: ${{ !inputs.triggered-by-release }}
-        run: npm ci
+        run: npm ci --ignore-scripts
 
       # For pushes to the release branch, we need to install the dependencies via `npm install`
       # because the `package-lock.json` is not updated with the new versions of the optional
@@ -65,6 +88,15 @@ jobs:
         if: ${{ inputs.triggered-by-release }}
         run: npm install --omit=optional --ignore-scripts
 
+      - name: Download build artifact
+        uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # 5.0.0
+        with:
+          name: artifact-build
+          path: js
+
+      - name: Install CLI
+        run: npm run install-cli
+
       # older node versions need an older nft
       - run: SENTRYCLI_SKIP_DOWNLOAD=1 npm install @vercel/nft@0.22.1
         if: matrix.node-version == '10.x' || matrix.node-version == '12.x'

.gitignore

@@ -4,6 +4,7 @@ target
 node_modules
 coverage
 dist
+js
 dump
 checksums.txt
 yarn-error.log

CHANGELOG.md

@@ -46,6 +46,10 @@
 
 - Slightly sped up the `sentry-cli sourcemaps upload` command by eliminating an HTTP request to the Sentry server, which was not required in most cases ([#2913](https://github.com/getsentry/sentry-cli/pull/2913)).
 
+### Internal changes
+
+- Migrated JavaScript wrapper to TypeScript for better type safety ([#2910](https://github.com/getsentry/sentry-cli/pull/2910))
+
 ## 2.57.0
 
 ### New Features