Update code docs

Author: jellyrock-bot

docs/components_GetShuffleItemsTask.bs.html

@@ -38,6 +38,14 @@
     })
     if isValid(moviesData) and isValid(moviesData.Items) then items.append(moviesData.Items)
     if isValid(episodesData) and isValid(episodesData.Items) then items.append(episodesData.Items)
+  else if input.type = "BoxSet"
+    data = GetApi().GetItemsByQuery({
+      "ParentId": input.id,
+      "SortBy": "Random",
+      "Limit": 200,
+      "EnableTotalRecordCount": false
+    })
+    if isValid(data) and isValid(data.Items) then items = data.Items
   end if
 
   m.top.shuffleItems = items

docs/components_ItemDetails.bs.html

@@ -428,6 +428,8 @@
     populateInfoGroupMusicVideo(item, userSettings)
   else if item.type = "Person"
     populateInfoGroupPerson(item)
+  else if item.type = "BoxSet"
+    populateInfoGroupBoxSet(item, userSettings)
   else
     ' Movie, Video, Recording
     populateInfoGroupMovie(item, userSettings)
@@ -671,6 +673,50 @@
   end if
 end sub
 
+' populateInfoGroupBoxSet: Info rows for BoxSet (movie collection)
+' Row 1: Year · Official Rating · Community Rating · N Movies
+' Row 2: Genres · Studio
+sub populateInfoGroupBoxSet(item as object, userSettings as object)
+  if item.productionYear > 0
+    yearNode = createInfoLabel("releaseYear")
+    yearNode.text = stri(item.productionYear).trim()
+    displayInfoNode(yearNode)
+  end if
+
+  if isValidAndNotEmpty(item.officialRating)
+    ratingNode = createInfoLabel("officialRating")
+    ratingNode.text = item.officialRating
+    displayInfoNode(ratingNode)
+  end if
+
+  if userSettings.uiMoviesShowRatings and item.communityRating > 0
+    communityRatingNode = CreateObject("roSGNode", "CommunityRating")
+    communityRatingNode.id = "communityRating"
+    communityRatingNode.rating = item.communityRating
+    displayInfoNode(communityRatingNode)
+  end if
+
+  if item.childCount > 0
+    movieCountNode = createInfoLabel("movieCount")
+    movieLabel = tr("Movie")
+    if item.childCount <> 1 then movieLabel = tr("Movies")
+    movieCountNode.text = stri(item.childCount).trim() + " " + movieLabel
+    displayInfoNode(movieCountNode)
+  end if
+
+  if item.genres.count() > 0
+    genreNode = createInfoLabel("genre")
+    genreNode.text = item.genres.join(" / ")
+    displayDirectorGenreNode(genreNode)
+  end if
+
+  if item.studios.count() > 0
+    studioNode = createInfoLabel("studio")
+    studioNode.text = item.studios[0]
+    displayDirectorGenreNode(studioNode)
+  end if
+end sub
+
 ' populateInfoGroupSeason: Info rows for Season
 ' Row 1: Year · Official Rating (series) · Avg episode runtime (series) · Ends At
 ' Row 2: Series name · Episode count · Studio
@@ -866,9 +912,9 @@
 
     ' Media tracks and stream options are only relevant for playable types
     ' Use reparenting instead of visible=false — invisible nodes still take up LayoutGroup space
-    setTracksInLayout(item.type <> "Series" and item.type <> "Season" and item.type <> "Person")
+    setTracksInLayout(item.type <> "Series" and item.type <> "Season" and item.type <> "Person" and item.type <> "BoxSet")
 
-    if item.type <> "Series" and item.type <> "Season" and item.type <> "Person"
+    if item.type <> "Series" and item.type <> "Season" and item.type <> "Person" and item.type <> "BoxSet"
       if m.top.selectedVideoStreamId = "" and isValidAndNotEmpty(item.mediaSourceId)
         m.top.selectedVideoStreamId = item.mediaSourceId
       end if
@@ -1188,7 +1234,7 @@
   if isValidAndNotEmpty(logoImageTag)
     imgParams = { maxHeight: 212, maxWidth: 500, quality: 90, tag: logoImageTag }
     m.itemLogo.uri = ImageURL(logoItemId, "Logo", imgParams)
-  else if item.type = "Movie" or item.type = "Series"
+  else if item.type = "Movie" or item.type = "Series" or item.type = "BoxSet"
     ' No logo: fall back to primary (poster) image — fetch at full quality; display height is
     ' capped by LOGO_MAX_DISPLAY_HEIGHT in onLogoLoadStatusChanged to avoid overlapping info rows.
     if isValidAndNotEmpty(item.primaryImageTag)
@@ -1512,7 +1558,7 @@
     playButton = CreateObject("roSGNode", "IconButton")
     playButton.id = "playButton"
     playButton.icon = "pkg:/images/icons/play.png"
-    if itemType = "Series" or itemType = "Season"
+    if itemType = "Series" or itemType = "Season" or itemType = "BoxSet"
       playButton.text = tr("Play All")
     else
       playButton.text = tr("Play")
@@ -1529,8 +1575,8 @@
     m.buttonGrp.appendChild(watchedButton)
   end if
 
-  ' Shuffle button — Series and Season only (Person shuffle is async via onPersonHasMediaChanged)
-  if itemType = "Series" or itemType = "Season"
+  ' Shuffle button — Series, Season, and BoxSet (Person shuffle is async via onPersonHasMediaChanged)
+  if itemType = "Series" or itemType = "Season" or itemType = "BoxSet"
     m.shuffleButton = CreateObject("roSGNode", "IconButton")
     m.shuffleButton.id = "shuffleButton"
     m.shuffleButton.icon = "pkg:/images/icons/shuffle.png"

docs/components_extras_ExtrasRowList.bs.html

@@ -20,6 +20,8 @@
   m.LoadAdditionalPartsTask.itemsToLoad = "additionalparts"
   m.LoadSeasonsTask = CreateObject("roSGNode", "LoadItemsTask")
   m.LoadSeasonsTask.itemsToLoad = "seasons"
+  m.LoadBoxSetItemsTask = CreateObject("roSGNode", "LoadItemsTask")
+  m.LoadBoxSetItemsTask.itemsToLoad = "boxsetitems"
   m.LoadMoviesTask = CreateObject("roSGNode", "LoadItemsTask")
   m.LoadMoviesTask.itemsToLoad = "personMovies"
   m.LoadShowsTask = CreateObject("roSGNode", "LoadItemsTask")
@@ -47,6 +49,7 @@
   m.rowCast = invalid
   m.rowLikeThis = invalid
   m.rowSpecialFeatures = invalid
+  m.rowBoxSetItems = invalid
   m.rowMovies = invalid
   m.rowTvShows = invalid
   m.rowSeries = invalid
@@ -88,6 +91,8 @@
   m.LoadShowsTask.unobserveField("content")
   m.LoadSeriesTask.control = "STOP"
   m.LoadSeriesTask.unobserveField("content")
+  m.LoadBoxSetItemsTask.control = "STOP"
+  m.LoadBoxSetItemsTask.unobserveField("content")
 end sub
 
 ' loadParts: Start the extras loading chain appropriate for the item type.
@@ -96,7 +101,8 @@
 '   Movie / Video / Recording → AdditionalParts → People → LikeThis → SpecialFeatures
 '   MusicVideo / Episode      → People → LikeThis
 '   Series                    → Seasons → People → LikeThis
-'   Season                    → Episodes ("Season X") → People → LikeThis'
+'   Season                    → Episodes ("Season X") → People → LikeThis
+'   BoxSet                    → BoxSetItems ("Movies") → People → LikeThis
 ' m.top.type must be set before calling this function (done by ShowScenes.bs).
 sub loadParts(data as object)
   cancelInFlightChain()
@@ -132,6 +138,11 @@
     m.LoadPeopleTask.observeField("content", "onPeopleLoaded")
     m.LoadPeopleTask.peopleList = m.people
     m.LoadPeopleTask.control = "RUN"
+  else if itemType = "BoxSet"
+    m.top.rowItemSize = [rowSlotSize.PORTRAIT]
+    m.LoadBoxSetItemsTask.itemId = m.top.parentId
+    m.LoadBoxSetItemsTask.observeField("content", "onBoxSetItemsLoaded")
+    m.LoadBoxSetItemsTask.control = "RUN"
   else
     ' Movie, Video, Recording: full chain starting with AdditionalParts
     m.LoadAdditionalPartsTask.observeField("content", "onAdditionalPartsLoaded")
@@ -240,6 +251,25 @@
   m.LoadPeopleTask.control = "RUN"
 end sub
 
+' onBoxSetItemsLoaded: Build "Movies" row then chain to People → LikeThis (BoxSet only)
+sub onBoxSetItemsLoaded()
+  content = m.LoadBoxSetItemsTask.content
+  m.LoadBoxSetItemsTask.unobserveField("content")
+  m.LoadBoxSetItemsTask.content = []
+
+  if isValid(content) and content.count() > 0
+    m.rowBoxSetItems = populateRow(m.rowBoxSetItems, tr("Movies"), content, rowSlotSize.ROW_HEIGHT_PORTRAIT)
+  else if isValid(m.rowBoxSetItems)
+    m.top.content.removeChild(m.rowBoxSetItems)
+    m.rowBoxSetItems = invalid
+  end if
+
+  ' Continue chain: People → LikeThis
+  m.LoadPeopleTask.observeField("content", "onPeopleLoaded")
+  m.LoadPeopleTask.peopleList = m.people
+  m.LoadPeopleTask.control = "RUN"
+end sub
+
 sub onAdditionalPartsLoaded()
   parts = m.LoadAdditionalPartsTask.content
   m.LoadAdditionalPartsTask.unobserveField("content")
@@ -311,8 +341,8 @@
     m.rowLikeThis = invalid
   end if
 
-  ' SpecialFeatures only for Movie / Video / Recording — not MusicVideo, Episode, Series, or Season
-  if itemType <> "MusicVideo" and itemType <> "Episode" and itemType <> "Series" and itemType <> "Season"
+  ' SpecialFeatures only for Movie / Video / Recording — not MusicVideo, Episode, Series, Season, or BoxSet
+  if itemType <> "MusicVideo" and itemType <> "Episode" and itemType <> "Series" and itemType <> "Season" and itemType <> "BoxSet"
     m.SpecialFeaturesTask.observeField("content", "onSpecialFeaturesLoaded")
     m.SpecialFeaturesTask.itemId = m.top.parentId
     m.SpecialFeaturesTask.control = "RUN"

docs/components_home_LoadItemsTask.bs.html

@@ -263,6 +263,20 @@
     results.push(AudioStream(m.top.itemId))
   else if m.top.itemsToLoad = "backdropImage"
     results.push(BackdropImage(m.top.itemId))
+  else if m.top.itemsToLoad = "boxsetitems"
+    data = GetApi().GetItemsByQuery({
+      "ParentId": m.top.itemId,
+      "SortBy": "SortName",
+      "SortOrder": "Ascending",
+      "Fields": "PrimaryImageAspectRatio,Overview",
+      "EnableTotalRecordCount": false
+    })
+    if isValid(data) and isValid(data.Items)
+      for each item in data.Items
+        node = m.transformer.transformBaseItem(item)
+        if isValid(node) then results.push(node)
+      end for
+    end if
   end if
 
   m.top.content = results

docs/data/search.json

@@ -199,11 +199,13 @@
           group.observeField("selectedItem", m.port)
           group.observeField("quickPlayNode", m.port)
           m.global.sceneManager.callFunc("pushScene", group)
-        else if selectedItemType = "UserView" or selectedItemType = "Folder" or selectedItemType = "Channel" or selectedItemType = "BoxSet"
+        else if selectedItemType = "UserView" or selectedItemType = "Folder" or selectedItemType = "Channel"
           group = CreateLibraryView(selectedItem)
           group.observeField("selectedItem", m.port)
           group.observeField("quickPlayNode", m.port)
           m.global.sceneManager.callFunc("pushScene", group)
+        else if selectedItemType = "BoxSet"
+          group = CreateItemDetailsGroup(selectedItem)
         else if selectedItemType = "Episode" or LCase(selectedItemType) = "recording"
           group = CreateItemDetailsGroup(selectedItem)
         else if selectedItemType = "Series"
@@ -437,6 +439,8 @@
         m.global.queueManager.callFunc("playQueue")
       else if node.type = "Person"
         group = CreateItemDetailsGroup(node)
+      else if node.type = "BoxSet"
+        group = CreateItemDetailsGroup(node)
       else if node.type = "TvChannel"
         m.global.queueManager.callFunc("clear")
         m.global.queueManager.callFunc("push", nodeHelpers.createQueueItem(node))
@@ -520,6 +524,22 @@
             else
               stopLoadingSpinner()
             end if
+          else if group.subtype() = "ItemDetails" and group.itemContent.type = "BoxSet"
+            ' BoxSet "Play All": queue all movies in collection in alphabetical order
+            item = group.itemContent
+            boxsetData = GetApi().GetItemsByQuery({
+              "ParentId": item.id,
+              "SortBy": "SortName",
+              "SortOrder": "Ascending",
+              "EnableTotalRecordCount": false
+            })
+            if isValid(boxsetData) and isValid(boxsetData.Items) and boxsetData.Items.count() > 0
+              m.global.queueManager.callFunc("clear")
+              m.global.queueManager.callFunc("set", boxsetData.Items)
+              m.global.queueManager.callFunc("playQueue")
+            else
+              stopLoadingSpinner()
+            end if
           else
             queueItem = nodeHelpers.createQueueItem(group.itemContent)
             if not isValid(queueItem) then return

docs/module-ExtrasRowList.html

@@ -651,8 +651,10 @@
       count = apiData.ChildCount ?? 0
       if count = 1
         return "1 item"
+      else if count > 1
+        return str(count).trim() + " items"
       end if
-      return str(count).trim() + " items"
+      return ""
 
     else if itemType = "Program" or itemType = "Recording"
       episodeTitle = apiData.EpisodeTitle ?? ""