feat(android): Publish sentry-android-navigation3 and SentryNavEffect

Commit publishes the sentry-android-navigation3 module, which implements our initial support for Android's [Nav3 library](https://developer.android.com/guide/navigation/navigation-3). It also removes the `@ApiStatus.Internal` annotations from our public Nav3 APIs, including SentryNavEffect.

See the SentryNavEffect KDoc and sentry-android-navigation3 README for more details.

Author: 0xadam-brown

.craft.yml

@@ -64,6 +64,7 @@ targets:
       maven:io.sentry:sentry-quartz:
       maven:io.sentry:sentry-okhttp:
       maven:io.sentry:sentry-android-navigation:
+      maven:io.sentry:sentry-android-navigation3:
       maven:io.sentry:sentry-compose:
       maven:io.sentry:sentry-compose-android:
       maven:io.sentry:sentry-compose-desktop:

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Features
 
+- Add support for Android Navigation 3 through the new `sentry-android-navigation3` library. Use `SentryNavEffect` to record navigation transactions, breadcrumbs, screen names, and additional context as your nav back stack changes ([#XXXX](https://github.com/getsentry/sentry-java/pull/XXXX))
 - Report the cellular network technology generation in `device.connection_effective_type`, for example `4g` or `5g` ([#6146](https://github.com/getsentry/sentry-java/pull/6146))
 
 ### Dependencies

README.md

@@ -25,6 +25,7 @@ Sentry SDK for Java and Android
 | sentry-android-timber                   | [![Maven Central Version](https://img.shields.io/maven-central/v/io.sentry/sentry-android-timber?style=for-the-badge&logo=sentry&color=green)](https://central.sonatype.com/artifact/io.sentry/sentry-android-timber)                   | 21 |
 | sentry-android-fragment                 | [![Maven Central Version](https://img.shields.io/maven-central/v/io.sentry/sentry-android-fragment?style=for-the-badge&logo=sentry&color=green)](https://central.sonatype.com/artifact/io.sentry/sentry-android-fragment)                 | 21 |
 | sentry-android-navigation               | [![Maven Central Version](https://img.shields.io/maven-central/v/io.sentry/sentry-android-navigation?style=for-the-badge&logo=sentry&color=green)](https://central.sonatype.com/artifact/io.sentry/sentry-android-navigation)               | 21 |
+| sentry-android-navigation3              | [![Maven Central Version](https://img.shields.io/maven-central/v/io.sentry/sentry-android-navigation3?style=for-the-badge&logo=sentry&color=green)](https://central.sonatype.com/artifact/io.sentry/sentry-android-navigation3)              | 21 |
 | sentry-android-sqlite                   | [![Maven Central Version](https://img.shields.io/maven-central/v/io.sentry/sentry-android-sqlite?style=for-the-badge&logo=sentry&color=green)](https://central.sonatype.com/artifact/io.sentry/sentry-android-sqlite)                   | 21 |
 | sentry-android-replay                   | [![Maven Central Version](https://img.shields.io/maven-central/v/io.sentry/sentry-android-replay?style=for-the-badge&logo=sentry&color=green)](https://central.sonatype.com/artifact/io.sentry/sentry-android-replay)                   | 26 |
 | sentry-compose-android                  | [![Maven Central Version](https://img.shields.io/maven-central/v/io.sentry/sentry-compose-android?style=for-the-badge&logo=sentry&color=green)](https://central.sonatype.com/artifact/io.sentry/sentry-compose-android)                  | 21 |

sentry-android-navigation3/README.md

@@ -0,0 +1,12 @@
+# sentry-android-navigation3
+
+[Navigation 3](https://developer.android.com/guide/navigation/navigation-3) instrumentation for the Sentry Android SDK.
+
+Use `SentryNavEffect` alongside your `NavDisplay` to record navigation transactions, breadcrumbs, screen names, and back stack context as
+users move around your app. Configure the data you want captured via `SentryNavOptions`.
+
+Because Nav3 back stacks can have arbitrary key types, host apps need to provide `SentryNavEffect` with a mapping between their back stack
+keys and the data Sentry should display for each (see `BackStackEntryMapper`).
+
+See the [Navigation for Android docs](https://docs.sentry.io/platforms/android/integrations/navigation/) for additional details, including
+installation, configuration, and limitations.

sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/BackStackEntryMapper.kt

@@ -5,7 +5,6 @@ import org.jetbrains.annotations.ApiStatus
 
 /** Info about a given back stack entry, suitable for display in Sentry. */
 @ApiStatus.Experimental
-@ApiStatus.Internal
 public class SentryBackStackEntry(
   /**
    * A host-app defined name for a given back stack entry.
@@ -146,7 +145,6 @@ public class SentryBackStackEntry(
  * ```
  */
 @ApiStatus.Experimental
-@ApiStatus.Internal
 public fun interface BackStackEntryMapper<T : Any> {
   public fun map(backStackEntry: T): SentryBackStackEntry?
 }

sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/SentryNavEffect.kt

@@ -47,7 +47,7 @@ import org.jetbrains.annotations.ApiStatus
  * - a new navigation transaction
  * - a breadcrumb
  * - a screen name
- * - a record of the current back stack (last 10 entries)
+ * - a record of the current back stack (last 5 entries)
  *
  * You can configure the above defaults via [SentryNavOptions]. (Screen names can be disabled via
  * [SentryOptions.setEnableScreenTracking].)
@@ -75,7 +75,6 @@ import org.jetbrains.annotations.ApiStatus
  * @param options The kinds of navigation info this effect should record.
  */
 @ApiStatus.Experimental
-@ApiStatus.Internal
 @Composable
 public fun <T : Any> SentryNavEffect(
   backStack: List<T>,

sentry-android-navigation3/src/main/kotlin/io/sentry/compose/navigation3/SentryNavOptions.kt

@@ -19,7 +19,6 @@ private const val DEFAULT_MAX_CAPTURED_BACK_STACK_ENTRIES = 5
  * ```
  */
 @ApiStatus.Experimental
-@ApiStatus.Internal
 @Immutable
 public class SentryNavOptions
 private constructor(
@@ -116,6 +115,5 @@ private constructor(
  * ```
  */
 @ApiStatus.Experimental
-@ApiStatus.Internal
 public fun SentryNavOptions(configure: SentryNavOptions.Builder.() -> Unit = {}): SentryNavOptions =
   SentryNavOptions.Builder().apply(configure).build()