Update code docs

Author: jellyrock-bot

docs/components_home_FavoritesRows.bs.html

@@ -33,6 +33,12 @@
     "MusicArtist": tr("Artists"),
     "MusicAlbum": tr("Albums"),
     "Audio": tr("Songs"),
+    "Video": tr("Videos"),
+    "MusicVideo": tr("Music Videos"),
+    "TvChannel": tr("Channels"),
+    "Recording": tr("Recordings"),
+    "PhotoAlbum": tr("Photo Albums"),
+    "Photo": tr("Photos"),
     "BoxSet": tr("Collections")
   }
   m.initialLoadComplete = false
@@ -220,10 +226,13 @@
 
 ' Returns the appropriate slot size for a Jellyfin item type.
 ' Follows the same logic as SearchRow.bs getSlotSizeForType.
+' WIDE  (16:9) — Episode, Video, MusicVideo, PhotoAlbum, Photo
+' SQUARE (1:1) — Music types, Playlist, TvChannel, Recording
+' PORTRAIT (2:3) — all others (Movie, Series, Person, BoxSet, etc.)
 function getSlotSizeForType(itemType as string) as object
-  if itemType = "Episode"
+  if itemType = "Episode" or itemType = "Video" or itemType = "MusicVideo" or itemType = "PhotoAlbum" or itemType = "Photo"
     return rowSlotSize.WIDE
-  else if itemType = "MusicArtist" or itemType = "MusicAlbum" or itemType = "Audio" or itemType = "Playlist"
+  else if itemType = "MusicArtist" or itemType = "MusicAlbum" or itemType = "Audio" or itemType = "Playlist" or itemType = "TvChannel" or itemType = "Recording"
     return rowSlotSize.SQUARE
   end if
   return rowSlotSize.PORTRAIT

docs/components_home_LoadItemsTask.bs.html

@@ -129,11 +129,33 @@
       for each item in data.Items
         ' Skip Books for now as we don't support it (issue #558)
         if item.Type <> "Book"
+          ' Live TV recordings come back from /Items as the content type (Movie/Episode).
+          ' The only reliable discriminator is the container format: recordings are always
+          ' stored as MPEG transport streams ("ts"), while library items never are.
+          if LCase(item.Container ?? "") = "ts"
+            item.Type = "Recording"
+          end if
           results.push(m.transformer.transformBaseItem(item))
         end if
       end for
     end if
 
+    ' People — favorited persons are not returned by /Items; requires /Persons endpoint.
+    personData = GetApi().GetPersons({
+      "IsFavorite": true,
+      "SortBy": "SortName",
+      "SortOrder": "Ascending",
+      "EnableTotalRecordCount": false
+    })
+    if isValid(personData) and isValid(personData.Items)
+      for each item in personData.Items
+        results.push(m.transformer.transformBaseItem(item))
+      end for
+    end if
+
+    ' Note: MusicArtist items ARE returned by /Items above (they are regular library items),
+    ' so no separate /Artists call is needed here (unlike search, where /Items misses them).
+
   else if m.top.itemsToLoad = "onNow"
     url = "LiveTv/Programs/Recommended"
     params = {}

docs/components_search_SearchRow.bs.html

@@ -48,7 +48,13 @@
     "MusicArtist": { "label": "Artists", "count": 0 },
     "MusicAlbum": { "label": "Albums", "count": 0 },
     "Audio": { "label": "Songs", "count": 0 },
+    "Video": { "label": "Videos", "count": 0 },
+    "MusicVideo": { "label": "Music Videos", "count": 0 },
+    "Program": { "label": "Programs", "count": 0 },
     "TvChannel": { "label": "Channels", "count": 0 },
+    "Recording": { "label": "Recordings", "count": 0 },
+    "PhotoAlbum": { "label": "Photo Albums", "count": 0 },
+    "Photo": { "label": "Photos", "count": 0 },
     "BoxSet": { "label": "Collections", "count": 0 }
   }
 
@@ -82,13 +88,13 @@
 end sub
 
 ' Returns the appropriate slot size for a given Jellyfin item type.
-' Episode → WIDE (16:9 screenshots)
-' Music and Playlist → SQUARE (1:1 album art)
-' All others (Movie, Series, TvChannel, Person, etc.) → PORTRAIT (2:3 poster)
+' WIDE  (16:9) — Episode, Video, MusicVideo, PhotoAlbum, Photo
+' SQUARE (1:1) — Music types, Playlist, Program, TvChannel, Recording
+' PORTRAIT (2:3) — all others (Movie, Series, Person, BoxSet, etc.)
 function getSlotSizeForType(itemType as string) as object
-  if itemType = "Episode"
+  if itemType = "Episode" or itemType = "Video" or itemType = "MusicVideo" or itemType = "PhotoAlbum" or itemType = "Photo"
     return rowSlotSize.WIDE
-  else if itemType = "MusicArtist" or itemType = "MusicAlbum" or itemType = "Audio" or itemType = "Playlist"
+  else if itemType = "MusicArtist" or itemType = "MusicAlbum" or itemType = "Audio" or itemType = "Playlist" or itemType = "Program" or itemType = "TvChannel" or itemType = "Recording"
     return rowSlotSize.SQUARE
   end if
   return rowSlotSize.PORTRAIT

docs/data/search.json

@@ -204,6 +204,18 @@
     return sdk.artists.Get(mergedParams)
   end function
 
+  ' Get all persons with automatic image injection
+  ' @param params - Query parameters (e.g. searchTerm, IsFavorite)
+  ' @returns API response or invalid on error
+  function GetPersons(params = {} as object) as dynamic
+    userId = m.getUserId()
+    if userId = "" then return invalid
+
+    mergedParams = m.injectDefaults(params)
+    mergedParams.UserId = userId
+    return sdk.persons.Get(mergedParams)
+  end function
+
   ' Get all album artists with automatic image injection
   ' @param params - Query parameters
   ' @returns API response or invalid on error
@@ -668,6 +680,14 @@
     return sdk.liveTV.GetChannels(params)
   end function
 
+  ' Get Live TV programs with automatic image injection
+  ' @param params - Query parameters (e.g. SearchTerm, Limit)
+  ' @returns API response or invalid on error
+  function GetLiveTVPrograms(params = {} as object) as dynamic
+    mergedParams = m.injectDefaults(params)
+    return sdk.liveTV.GetPrograms(mergedParams)
+  end function
+
   ' ═══════════════════════════════════════════════════════════════════════════
   ' STUDIOS ENDPOINTS
   ' ═══════════════════════════════════════════════════════════════════════════

docs/module-ApiClient.ApiClient.html

@@ -235,32 +235,72 @@
 
 ' Search across all libraries
 function searchMedia(query as string)
-  if query <> ""
-    data = GetApi().GetItemsByQuery({
-      "searchTerm": query,
-      "IncludePeople": true,
-      "IncludeMedia": true,
-      "IncludeShows": true,
-      "IncludeGenres": true,
-      "IncludeStudios": true,
-      "IncludeArtists": true,
-      "IncludeItemTypes": "LiveTvChannel,Movie,BoxSet,Series,Episode,Video,Person,Audio,MusicAlbum,MusicArtist,Playlist",
-      "EnableTotalRecordCount": false,
-      "Recursive": true,
-      "limit": 100
-    })
-
-    if not isValid(data) then return []
-
-    transformer = JellyfinDataTransformer()
-    results = []
+  if query = "" then return []
+
+  transformer = JellyfinDataTransformer()
+  allItems = []
+
+  ' Regular library items — Person and MusicArtist are fetched via dedicated endpoints below.
+  ' LiveTvProgram is excluded here because /Items EPG search is incomplete; /LiveTv/Programs is used instead.
+  data = GetApi().GetItemsByQuery({
+    "searchTerm": query,
+    "IncludeItemTypes": "Movie,Series,Episode,Video,MusicVideo,Audio,MusicAlbum,Playlist,LiveTvChannel,PhotoAlbum,Photo,BoxSet",
+    "EnableTotalRecordCount": false,
+    "Recursive": true,
+    "limit": 100
+  })
+  if isValid(data) and isValid(data.Items)
     for each item in data.Items
-      results.push(transformer.transformBaseItem(item))
+      ' Live TV recordings come back from /Items as the content type (Movie/Episode).
+      ' The only reliable discriminator is the container format: recordings are always
+      ' stored as MPEG transport streams ("ts"), while library items never are.
+      if LCase(item.Container ?? "") = "ts"
+        item.Type = "Recording"
+      end if
+      allItems.push(transformer.transformBaseItem(item))
+    end for
+  end if
+
+  ' People — /Items does not return Person type; /Persons endpoint required.
+  personData = GetApi().GetPersons({
+    "searchTerm": query,
+    "Limit": 20,
+    "EnableTotalRecordCount": false
+  })
+  if isValid(personData) and isValid(personData.Items)
+    for each item in personData.Items
+      allItems.push(transformer.transformBaseItem(item))
+    end for
+  end if
+
+  ' Artists — /Items does not return MusicArtist type; /Artists endpoint required.
+  artistData = GetApi().GetArtists({
+    "searchTerm": query,
+    "Limit": 20,
+    "EnableTotalRecordCount": false
+  })
+  if isValid(artistData) and isValid(artistData.Items)
+    for each item in artistData.Items
+      allItems.push(transformer.transformBaseItem(item))
     end for
-    data.Items = results
-    return data
   end if
-  return []
+
+  ' Live TV Programs — /LiveTv/Programs searches the full EPG; /Items only covers recordings.
+  programData = GetApi().GetLiveTVPrograms({
+    "SearchTerm": query,
+    "Limit": 20,
+    "EnableTotalRecordCount": false
+  })
+  if isValid(programData) and isValid(programData.Items)
+    for each item in programData.Items
+      allItems.push(transformer.transformBaseItem(item))
+    end for
+  end if
+
+  result = {}
+  result.Items = allItems
+  result.TotalRecordCount = allItems.count()
+  return result
 end function
 
 ' MetaData about an item — returns a JellyfinBaseItem node.