react-native-audio-browser 0.2.0-next.11 → 0.2.0-next.12

package/ios/Browser/BrowserManager.swift

@@ -77,12 +77,12 @@ final class BrowserManager {
   var resolvedRequestLayer: TransformableRequestConfig?
   private var resolvedBrowseLayer: TransformableRequestConfig?
 
-  // Set of favorited track identifiers (src)
+  // Set of favorited track identities (id when non-blank, else src).
   private var favoriteIds: Set<String> = []
 
-  // Favorite match mode, propagated from the player's `favorite` capability.
-  // nil = favoriting disabled (no row hearts). Set via setFavoriteMatch.
-  private var favoriteMatch: FavoritesMatchMode?
+  // Whether favoriting is enabled, propagated from the player's `favorite`
+  // capability. false = no row hearts. Set via setFavoriteEnabled.
+  private var favoriteEnabled = false
 
   // Navigation tracking to prevent race conditions
   private var currentNavigationId: Int = 0
@@ -162,62 +162,49 @@ final class BrowserManager {
     onFavoritesChanged?()
   }
 
-  /// Sets the favorite match mode (propagated from the `favorite` capability).
-  /// nil disables row-heart hydration.
-  func setFavoriteMatch(_ match: FavoritesMatchMode?) {
-    favoriteMatch = match
+  /// Enables/disables favoriting (propagated from the `favorite` capability).
+  /// false disables row-heart hydration.
+  func setFavoriteEnabled(_ enabled: Bool) {
+    favoriteEnabled = enabled
   }
 
-  /// Optimistically reflects a local favorite toggle for `src` in the match set,
-  /// needing no consumer-specific id extraction: favoriting inserts `src` (which
-  /// matches itself under either mode). Removal mirrors `isFavorite`'s match
-  /// semantics — partial drops every id that is a path segment of `src` (the
-  /// channel uid, and self-heals stray ids); exact (or disabled) drops only
-  /// `src`, so unrelated exact favorites that happen to be a segment of `src`
-  /// aren't collaterally lost. The consumer reconciles `favoriteIds` to its
-  /// canonical ids on the next `setFavorites`; `isFavorite(src:)` gives the same
-  /// answer before and after, so the now-playing heart stays responsive.
-  func setFavorited(src: String, favorited: Bool) {
+  /// Optimistically reflects a local favorite toggle in the favorite set, keyed
+  /// by the track's identity (id when non-blank, else src). The consumer
+  /// reconciles `favoriteIds` to its canonical set on the next `setFavorites`;
+  /// `isFavorite` gives the same answer before and after, so the now-playing
+  /// heart stays responsive.
+  func setFavorited(identity: String, favorited: Bool) {
     if favorited {
-      favoriteIds.insert(src)
-    } else if favoriteMatch == .partial {
-      favoriteIds = favoriteIds.filter { !BrowserPathHelper.containsSegment(src, $0) }
+      favoriteIds.insert(identity)
     } else {
-      favoriteIds.remove(src)
+      favoriteIds.remove(identity)
     }
   }
 
   /// Hydrates the favorited field on a track based on the favoriteIds set.
   /// No-op unless favoriting is enabled (the `favorite` capability). Only
-  /// playable (src-bearing) tracks are favoritable; the flag is set to true OR
-  /// false so non-favorited tracks still show an (empty) heart. Local
-  /// favoriteIds take precedence over API-provided values.
+  /// identity-bearing tracks (id or src) are favoritable; the flag is set to
+  /// true OR false so non-favorited tracks still show an (empty) heart. A
+  /// caller-set `favorited` wins — API/consumer-provided values are never
+  /// overwritten (matches Android and web).
   func hydrateFavorite(_ track: Track) -> Track {
-    guard let match = favoriteMatch, let src = track.src else { return track }
-
-    let isFavorited = isFavorite(src: src, match: match)
-
-    // Only create a new track if the favorited state differs
-    if track.favorited == isFavorited { return track }
-
-    return track.copying(favorited: isFavorited)
+    guard favoriteEnabled, track.favorited == nil, track.identity != nil else { return track }
+    return track.copying(favorited: isFavorite(track))
   }
 
-  /// Whether `src` is favorited under the given match mode.
-  private func isFavorite(src: String, match: FavoritesMatchMode) -> Bool {
-    switch match {
-    case .exact:
-      favoriteIds.contains(src)
-    case .partial:
-      favoriteIds.contains { BrowserPathHelper.containsSegment(src, $0) }
-    }
+  /// Whether the track's identity is in the favorite set.
+  private func isFavorite(_ track: Track) -> Bool {
+    track.identity.map(favoriteIds.contains) ?? false
   }
 
-  /// Hydrates favorites on all children of a ResolvedTrack.
+  /// Hydrates favorites on all tracks of a resolved page. Pages reach
+  /// hydration normalized (ADR 0010), so `sections` is the only structure
+  /// to walk.
   private func hydrateChildren(_ resolvedTrack: ResolvedTrack) -> ResolvedTrack {
-    guard let children = resolvedTrack.children else { return resolvedTrack }
-    let hydratedChildren = children.map { hydrateFavorite($0) }
-    return resolvedTrack.copying(children: hydratedChildren)
+    guard let sections = resolvedTrack.sections else { return resolvedTrack }
+    return resolvedTrack.copying(sections: sections.map { section in
+      section.copying(children: section.children.map { hydrateFavorite($0) })
+    })
   }
 
   // MARK: - Navigation
@@ -304,12 +291,14 @@ final class BrowserManager {
       )
     }
 
-    // Validate and transform children
-    if let children = resolvedTrack.children {
-      let transformed = try await transformChildren(
-        children, parentPath: path, routeEntry: routeEntry?.0,
+    // Normalize to the canonical sectioned shape (children sugar → one
+    // untitled section — ADR 0010), then validate and transform. The output
+    // never carries `children`.
+    if let sections = resolvedTrack.normalizedSections {
+      let transformed = try await transformSections(
+        sections, parentPath: path, routeEntry: routeEntry?.0,
       )
-      return resolvedTrack.copying(children: transformed)
+      return resolvedTrack.copying(sections: transformed, children: .some(nil))
     }
 
     return resolvedTrack
@@ -426,7 +415,7 @@ final class BrowserManager {
     )
   }
 
-  /// Resolves a browse route: a page object (`{title,url,children:[…]}`).
+  /// Resolves a browse route: a page object (`{title,path,children:[…]}`).
   /// The browse kind layer is the cached resolved layer (`resolvedBrowseLayer`),
   /// populated by `ensureLayersResolved()` inside `buildApiRequest`.
   private func resolveFromConfig(
@@ -447,8 +436,8 @@ final class BrowserManager {
     let nitroResult = result.toNitro()
 
     logger.debug("Resolved: \(nitroResult.title)")
-    if let children = nitroResult.children {
-      logger.debug("  children: \(children.count) tracks")
+    if let sections = nitroResult.normalizedSections {
+      logger.debug("  children: \(sections.reduce(0) { $0 + $1.children.count }) tracks")
     }
 
     return nitroResult
@@ -525,65 +514,51 @@ final class BrowserManager {
 
   // MARK: - Child Transformation
 
-  private func transformChildren(
-    _ children: [Track],
+  private func transformSections(
+    _ sections: [Section],
     parentPath: String,
     routeEntry: NativeRouteEntry?,
-  ) async throws -> [Track] {
-    var transformed: [Track] = []
-
-    for track in children {
-      // Validate track has stable identifier. A track carrying an imageRow is
-      // exempt: a url-less row is a pure preview — never selected, navigated
-      // to, or cached (its items carry their own identity).
-      if track.url == nil, track.src == nil, track.imageRow?.isEmpty != false {
-        throw BrowserError.invalidConfiguration(
-          "Track must have either 'url' or 'src' for stable identification: \(track.title)",
-        )
-      }
-
-      var transformedTrack = track
+  ) async throws -> [Section] {
+    var transformed: [Section] = []
+    // The contextual index is the flat page position — children concatenated
+    // in section order (ADR 0009/0010).
+    var flatIndex = 0
+
+    for section in sections {
+      var transformedChildren: [Track] = []
+
+      for track in section.children {
+        let index = flatIndex
+        flatIndex += 1
+
+        // Validate track has stable identifier.
+        if track.path == nil, track.src == nil {
+          throw BrowserError.invalidConfiguration(
+            "Track must have either 'path' or 'src' for stable identification: \(track.title)",
+          )
+        }
 
-      if track.src != nil, track.url == nil {
-        let contextualUrl = BrowserPathHelper.build(parentPath: parentPath, trackId: track.src!)
-        transformedTrack = track.copying(url: contextualUrl)
-      }
+        var transformedTrack = track
 
-      // Resolve artwork URL at browse-time (no size context)
-      let artworkConfig = routeEntry?.artwork ?? config.artwork
-      if let imageSource = await resolveArtworkUrl(track: transformedTrack, perRouteConfig: artworkConfig) {
-        transformedTrack = transformedTrack.copying(artworkSource: imageSource)
-      }
+        if track.src != nil, track.path == nil {
+          // src != nil guarantees a non-nil identity (id when non-blank, else src).
+          // The flat page position rides along as a duplicate-identity tie-breaker.
+          let contextualPath = BrowserPathHelper.build(
+            parentPath: parentPath, trackId: track.identity!, index: index,
+          )
+          transformedTrack = track.copying(path: contextualPath)
+        }
 
-      // Resolve artwork for image row items
-      if let imageRowItems = transformedTrack.imageRow {
-        var resolvedItems: [ImageRowItem] = []
-        for item in imageRowItems {
-          let itemImageSource = await resolveArtworkUrl(track: item.toTrack(), perRouteConfig: artworkConfig)
-          // Playable items get a contextual URL like any list row, so a
-          // thumbnail tap expands into its section's queue instead of a
-          // queue of one (ADR 0006).
-          let itemUrl = item.url ?? item.src.map {
-            BrowserPathHelper.build(parentPath: parentPath, trackId: $0)
-          }
-          resolvedItems.append(ImageRowItem(
-            id: item.id,
-            url: itemUrl,
-            src: item.src,
-            artwork: item.artwork,
-            artworkSource: itemImageSource,
-            title: item.title,
-            artist: item.artist,
-            album: item.album,
-            albumUrl: item.albumUrl,
-            live: item.live,
-            request: item.request,
-          ))
+        // Resolve artwork URL at browse-time (no size context)
+        let artworkConfig = routeEntry?.artwork ?? config.artwork
+        if let imageSource = await resolveArtworkUrl(track: transformedTrack, perRouteConfig: artworkConfig) {
+          transformedTrack = transformedTrack.copying(artworkSource: imageSource)
         }
-        transformedTrack = transformedTrack.copying(imageRow: resolvedItems)
+
+        transformedChildren.append(transformedTrack)
       }
 
-      transformed.append(transformedTrack)
+      transformed.append(section.copying(children: transformedChildren))
     }
 
     return transformed
@@ -668,37 +643,40 @@ final class BrowserManager {
   /// station. Decision in `SearchDrillIn.playable`; mirrors Android's
   /// `searchPlayable`.
   func searchPlayable(_ params: SearchParams) async throws -> [Track]? {
-    let children = try await (search(params).children) ?? []
-    return try await SearchDrillIn.playable(from: children) { [self] url in
-      logger.debug("First search result is browsable-only, resolving: \(url)")
-      return try await (resolve(url).children) ?? []
+    // Voice search never matches a disabled track (Track.disabled) — filtered
+    // before drill-in so an unavailable first result can't capture the play.
+    let children = try await ((search(params).flattenedChildren) ?? [])
+      .filter { $0.disabled != true }
+    return try await SearchDrillIn.playable(from: children) { [self] path in
+      logger.debug("First search result is browsable-only, resolving: \(path)")
+      return try await ((resolve(path).flattenedChildren) ?? []).filter { $0.disabled != true }
     }
   }
 
   private func makeSearchResult(query: String, results: [Track]) -> ResolvedTrack {
+    // Search results are a flat list; as a resolved page they are one
+    // untitled section (ADR 0010).
     ResolvedTrack(
-      url: BrowserPathHelper.createSearchPath(query),
-      children: results,
+      path: BrowserPathHelper.createSearchPath(query),
+      style: nil,
+      sections: [.untitled(results)],
+      children: nil,
       carPlaySiriListButton: nil,
       id: nil,
       src: nil,
       artwork: nil,
       artworkSource: nil, request: nil,
-      artworkCarPlayTinted: nil,
       title: "Search: \(query)",
       subtitle: nil,
       artist: nil,
-      albumUrl: nil,
+      albumPath: nil,
       album: nil,
       description: nil,
       genre: nil,
       duration: nil,
-      style: nil,
-      childrenStyle: nil,
+      disabled: nil,
       favorited: nil,
-      groupTitle: nil,
       live: nil,
-      imageRow: nil,
     )
   }
 
@@ -715,7 +693,8 @@ final class BrowserManager {
     }
 
     let resolved = try await resolveRouteEntry(tabsEntry, path: Self.tabsRoutePath, params: [:])
-    let tabTracks = resolved.children ?? []
+    // Tabs are a flat list, not a page — a sectioned tabs source flattens.
+    let tabTracks = resolved.flattenedChildren ?? []
 
     tabs = tabTracks
     return tabTracks
@@ -723,38 +702,39 @@ final class BrowserManager {
 
   // MARK: - Queue Expansion (for CarPlay/external controllers)
 
-  /// Expands a contextual URL to a full queue of playable tracks.
-  func expandQueueFromContextualUrl(_ url: String) async throws -> (tracks: [Track], selectedIndex: Int)? {
-    guard BrowserPathHelper.isContextual(url) else { return nil }
+  /// Expands a contextual path to a full queue of playable tracks.
+  func expandQueueFromContextualPath(_ path: String) async throws -> (tracks: [Track], selectedIndex: Int)? {
+    guard BrowserPathHelper.isContextual(path) else { return nil }
 
-    let parentPath = BrowserPathHelper.stripTrackId(url)
-    guard let trackId = BrowserPathHelper.extractTrackId(url) else { return nil }
+    let parentPath = BrowserPathHelper.stripTrackId(path)
+    guard let trackId = BrowserPathHelper.extractTrackId(path) else { return nil }
 
-    logger.debug("Expanding queue from contextual URL")
-    logger.debug("  url: \(url)")
+    logger.debug("Expanding queue from contextual path")
+    logger.debug("  path: \(path)")
     logger.debug("  parentPath: \(parentPath)")
     logger.debug("  trackId: \(trackId)")
 
     // Resolve the parent container
     let resolved = try await resolve(parentPath, useCache: true)
-    guard let children = resolved.children else { return nil }
-
-    // Queue scope is the tapped section, not the whole page (ADR 0006). An
-    // id that no longer appears on the page aborts the expansion — the
-    // caller falls back to the stored single track (matching Android);
-    // silently queueing the changed list would resume the wrong station.
-    let sectionTracks: [Track]
-    switch SectionScope.section(of: children, containing: trackId) {
-    case let .imageRow(items):
-      sectionTracks = items.map { $0.toTrack() }
-    case let .run(tracks):
-      sectionTracks = tracks
-    case nil:
+    guard let sections = resolved.normalizedSections else { return nil }
+
+    // Queue scope is the tapped section, not the whole page (ADR 0006). The
+    // stamped flat index pins which section (and which copy) was tapped when
+    // the same identity appears more than once; it is only a tie-breaker —
+    // a stale index falls back to the first identity match. An id that no
+    // longer appears on the page at all aborts the expansion — the caller
+    // falls back to the stored single track (matching Android); silently
+    // queueing the changed list would resume the wrong station.
+    let tappedIndex = BrowserPathHelper.extractIndex(path)
+    guard let scoped = SectionScope.scoped(in: sections, containing: trackId, tappedIndex: tappedIndex) else {
       return nil
     }
+    let sectionTracks = scoped.section.children
+    let tappedOffset = scoped.tappedOffset
 
-    // Filter to playable tracks (have src)
-    let playableTracks = sectionTracks.filter { $0.src != nil }
+    // Filter to playable tracks (have src). A disabled track is unavailable —
+    // queue expansion excludes it, so auto-advance never meets one.
+    let playableTracks = sectionTracks.filter { $0.src != nil && $0.disabled != true }
     guard !playableTracks.isEmpty else { return nil }
 
     logger.debug("Found \(playableTracks.count) playable tracks")
@@ -762,10 +742,18 @@ final class BrowserManager {
       logger.debug("  [\(index)] \(track.title) - src: \(track.src ?? "nil")")
     }
 
-    // Find selected track index
-    // Unreachable in practice (the section was found BY this id), but a miss
-    // must abort rather than silently start the queue at the wrong track.
-    guard let selectedIndex = playableTracks.firstIndex(where: { $0.src == trackId }) else {
+    // Find selected track index: the pinned copy when the stamp survived,
+    // else the first identity match. A miss must abort rather than silently
+    // start the queue at the wrong track (unreachable in practice — the
+    // section was found BY this id).
+    let selectedIndex: Int
+    if let tappedOffset, sectionTracks[tappedOffset].src != nil, sectionTracks[tappedOffset].disabled != true {
+      selectedIndex =
+        sectionTracks.prefix(through: tappedOffset)
+          .count(where: { $0.src != nil && $0.disabled != true }) - 1
+    } else if let index = playableTracks.firstIndex(where: { $0.identity == trackId }) {
+      selectedIndex = index
+    } else {
       return nil
     }
     logger.debug("Selected track index: \(selectedIndex)")

package/ios/Browser/BrowserPathHelper.swift

@@ -3,23 +3,24 @@ import Foundation
 /// Utility for handling browser paths and contextual URLs in the media browser system.
 ///
 /// Handles two types of special paths:
-/// 1. System paths (prefixed with `/__`): Root, recent, and search paths
+/// 1. System paths (prefixed with `/__`): root, search, and offline paths
 /// 2. Contextual URLs: Embed parent context in track identifiers for playback integration
 ///
-/// Contextual URL format: `{parentPath}?__trackId={trackSrc}`
-/// Example: "/library/radio?__trackId=song.mp3"
+/// Contextual URL format: `{parentPath}?__trackId={trackIdentity}&__index={childIndex}`
+/// Example: "/library/radio?__trackId=song.mp3&__index=2"
+///
+/// `__trackId` is the identity check; `__index` (the child's position on the
+/// page at stamp time) is only a tie-breaker between surfaces that carry the
+/// same identity — a stale index never selects a different track.
 ///
 /// This allows:
-/// - Playable-only tracks (tracks with `src` but no `url`) to be referenced
+/// - Playable-only tracks (tracks with `src` but no `path`) to be referenced
 /// - Cache lookup to work consistently
 /// - Parent context to be preserved for queue restoration
 enum BrowserPathHelper {
   /// Root path for media browsing
   static let rootPath = "/__root"
 
-  /// Recent media path for playback resumption
-  static let recentPath = "/__recent"
-
   /// Search path prefix (full path is /__search?q=query)
   static let searchPathPrefix = "/__search"
 
@@ -38,10 +39,12 @@ enum BrowserPathHelper {
   /// Query parameter name for contextual track identifiers
   private static let contextualTrackParam = "__trackId"
 
+  /// Query parameter name for the tapped child's page position (tie-breaker)
+  private static let contextualIndexParam = "__index"
+
   /// Check if a path is a special system path (not a regular navigation path)
   static func isSpecialPath(_ path: String) -> Bool {
     path == rootPath ||
-      path == recentPath ||
       path.hasPrefix("\(searchPathPrefix)?")
   }
 
@@ -61,13 +64,13 @@ enum BrowserPathHelper {
       || path.contains("&\(contextualTrackParam)=")
   }
 
-  /// Strips the __trackId parameter from a contextual URL to get the parent path.
-  /// If the URL is not contextual, returns it unchanged.
+  /// Strips the contextual parameters (__trackId and __index) from a contextual
+  /// URL to get the parent path. If the URL is not contextual, returns it unchanged.
   ///
   /// - Parameter url: The URL to process
-  /// - Returns: The URL without the __trackId parameter
+  /// - Returns: The URL without the contextual parameters
   ///
-  /// Example: "/library/radio?__trackId=song.mp3" → "/library/radio"
+  /// Example: "/library/radio?__trackId=song.mp3&__index=2" → "/library/radio"
   /// Example: "/search?q=jazz&__trackId=song.mp3" → "/search?q=jazz"
   static func stripTrackId(_ url: String) -> String {
     guard isContextual(url) else {
@@ -78,8 +81,10 @@ enum BrowserPathHelper {
       return url
     }
 
-    // Filter out __trackId parameter
-    components.queryItems = components.queryItems?.filter { $0.name != contextualTrackParam }
+    // Filter out the contextual parameters
+    components.queryItems = components.queryItems?.filter {
+      $0.name != contextualTrackParam && $0.name != contextualIndexParam
+    }
 
     // If no query items left, clear the query string entirely
     if components.queryItems?.isEmpty == true {
@@ -89,21 +94,24 @@ enum BrowserPathHelper {
     return components.string ?? url
   }
 
-  /// Builds a contextual URL by appending a track identifier to a parent path.
+  /// Builds a contextual URL by appending a track identifier — and optionally
+  /// the tapped child's page position — to a parent path.
   /// Handles existing query parameters correctly.
   ///
   /// - Parameters:
   ///   - parentPath: The parent container path
-  ///   - trackId: The track identifier (typically the `src` value)
-  /// - Returns: A contextual URL combining parent path and track ID
+  ///   - trackId: The track identity (`id` when non-blank, else `src`)
+  ///   - index: The child's position on the page at stamp time (tie-breaker)
+  /// - Returns: A contextual URL combining parent path, track ID, and index
   ///
-  /// Example: build("/library", "song.mp3") → "/library?__trackId=song.mp3"
+  /// Example: build("/library", "song.mp3", index: 2) → "/library?__trackId=song.mp3&__index=2"
   /// Example: build("/search?q=jazz", "song.mp3") → "/search?q=jazz&__trackId=song.mp3"
-  static func build(parentPath: String, trackId: String) -> String {
+  static func build(parentPath: String, trackId: String, index: Int? = nil) -> String {
     let encodedTrackId =
-      trackId.addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed) ?? trackId
+      trackId.addingPercentEncoding(withAllowedCharacters: queryComponentAllowed) ?? trackId
     let separator = parentPath.contains("?") ? "&" : "?"
-    return "\(parentPath)\(separator)\(contextualTrackParam)=\(encodedTrackId)"
+    let indexParam = index.map { "&\(contextualIndexParam)=\($0)" } ?? ""
+    return "\(parentPath)\(separator)\(contextualTrackParam)=\(encodedTrackId)\(indexParam)"
   }
 
   /// Extracts the track ID from a contextual URL.
@@ -125,6 +133,21 @@ enum BrowserPathHelper {
     return components.queryItems?.first { $0.name == contextualTrackParam }?.value
   }
 
+  /// Extracts the stamped page index from a contextual URL, or nil when the
+  /// URL is not contextual or carries no (valid, non-negative) index.
+  ///
+  /// Example: "/library/radio?__trackId=song.mp3&__index=2" → 2
+  static func extractIndex(_ path: String) -> Int? {
+    guard isContextual(path),
+          let components = URLComponents(string: path),
+          let raw = components.queryItems?.first(where: { $0.name == contextualIndexParam })?.value,
+          let index = Int(raw), index >= 0
+    else {
+      return nil
+    }
+    return index
+  }
+
   /// Appends query parameters to a URL, handling `?` vs `&` separator and percent-encoding.
   ///
   /// - Parameters:
@@ -193,27 +216,4 @@ enum BrowserPathHelper {
 
     return "\(normalizedBase)/\(normalizedPath)"
   }
-
-  /// True if `segment` appears in `path` as a complete path segment — bounded on
-  /// the left by the string start or `/`, and on the right by the string end or
-  /// one of `/`, `?`, `#`.
-  static func containsSegment(_ path: String, _ segment: String) -> Bool {
-    guard !segment.isEmpty else { return false }
-    var searchStart = path.startIndex
-    while let range = path.range(of: segment, range: searchStart ..< path.endIndex) {
-      let beforeOk =
-        range.lowerBound == path.startIndex
-          || path[path.index(before: range.lowerBound)] == "/"
-      let afterOk: Bool
-      if range.upperBound == path.endIndex {
-        afterOk = true
-      } else {
-        let next = path[range.upperBound]
-        afterOk = next == "/" || next == "?" || next == "#"
-      }
-      if beforeOk, afterOk { return true }
-      searchStart = range.upperBound
-    }
-    return false
-  }
 }