feat: ✨ add options to use Next Script Component or a regular script tag

[davevanhoorn]

When using Sentry and next-runtime-env, we ran into a race condition with Sentry's client side configuration sentry.client.config.ts:

1. A user visits our application
2. The webpage loads
3. Sentry's sentry.client.config.ts runs before our <PublicEnvScript />, and looks for env('DEPLOYMENT_ENV'), but these values are undefined
4. Next.js Script component defaults to "beforeInteractive" and adds the runtime variables to window.__ENV after Sentry's init.

For now, the quickest solution is to enable users to use both Next.js Script Component and a regular script tag.

[Copilot]

PR Overview

This PR adds the option to choose between the Next.js Script Component and a regular <script> tag in order to work around a Sentry timing issue related to runtime environment initialization.

• Added two new optional props (withNextScriptComponent and nextScriptComponentProps) to EnvScript for toggling component usage and customizing the Next.js Script Component.
• Updated the component implementation to conditionally render either a Next.js Script or a regular <script> tag.
• Extended test coverage in env-script.spec.tsx to verify the new behavior for both rendering strategies.

Reviewed Changes

File	Description
src/script/env-script.tsx	Introduces new props and conditional rendering to support two modes.
src/script/env-script.spec.tsx	Adds tests to ensure correct attribute propagation and behavior.

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (669f9cb) to head (3feb6c0).
Report is 6 commits behind head on development.

Additional details and impacted files

@@              Coverage Diff              @@
##           development      #163   +/-   ##
=============================================
  Coverage       100.00%   100.00%           
=============================================
  Files               12        12           
  Lines               89        95    +6     
  Branches            14        17    +3     
=============================================
+ Hits                89        95    +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[expatfile-bot]

🎉 This PR is included in version 3.3.0-alpha.3 🎉

The release is available on:

• npm package (@alpha dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[expatfile-bot]

🎉 This PR is included in version 3.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀