musora-content-services 1.5.0 → 1.6.0

package/docs/sanity.js.html

@@ -29,7 +29,7 @@
 <nav >
     
     
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.countAssignmentsAndLessons">countAssignmentsAndLessons</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistItem">deletePlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistLike">deletePlaylistLike</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeIndexMetadata">fetchChallengeIndexMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeLessonData">fetchChallengeLessonData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeMetadata">fetchChallengeMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeUserActiveChallenges">fetchChallengeUserActiveChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedChallenges">fetchCompletedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchOwnedChallenges">fetchOwnedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPinnedPlaylists">fetchPinnedPlaylists</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItem">fetchPlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserChallengeProgress">fetchUserChallengeProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.pinPlaylist">pinPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesCommunityNotification">postChallengesCommunityNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesCompleteLesson">postChallengesCompleteLesson</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnroll">postChallengesEnroll</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnrollmentNotification">postChallengesEnrollmentNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesHideCompletedBanner">postChallengesHideCompletedBanner</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesLeave">postChallengesLeave</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSetStartDate">postChallengesSetStartDate</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSoloNotification">postChallengesSoloNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesUnlock">postChallengesUnlock</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unpinPlaylist">unpinPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.updatePlaylistItem">updatePlaylistItem</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchParentForDownload">fetchParentForDownload</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getNextAndPreviousQuarterDates">getNextAndPreviousQuarterDates</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li><li data-type='method'><a href="module-Sanity-Services.html#~handleCustomFetchAll">handleCustomFetchAll</a></li></ul></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.countAssignmentsAndLessons">countAssignmentsAndLessons</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistItem">deletePlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistLike">deletePlaylistLike</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeIndexMetadata">fetchChallengeIndexMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeLessonData">fetchChallengeLessonData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeMetadata">fetchChallengeMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeUserActiveChallenges">fetchChallengeUserActiveChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedChallenges">fetchCompletedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchOwnedChallenges">fetchOwnedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPinnedPlaylists">fetchPinnedPlaylists</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItem">fetchPlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserChallengeProgress">fetchUserChallengeProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.pinPlaylist">pinPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesCommunityNotification">postChallengesCommunityNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesCompleteLesson">postChallengesCompleteLesson</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnroll">postChallengesEnroll</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnrollmentNotification">postChallengesEnrollmentNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesHideCompletedBanner">postChallengesHideCompletedBanner</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesLeave">postChallengesLeave</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSetStartDate">postChallengesSetStartDate</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSoloNotification">postChallengesSoloNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesUnlock">postChallengesUnlock</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unpinPlaylist">unpinPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.updatePlaylistItem">updatePlaylistItem</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchParentForDownload">fetchParentForDownload</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedTutorials">fetchRelatedTutorials</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~buildQueryForFetch">buildQueryForFetch</a></li><li data-type='method'><a href="module-Sanity-Services.html#~buildRelatedLessonsQuery">buildRelatedLessonsQuery</a></li><li data-type='method'><a href="module-Sanity-Services.html#~buildSubQueryForFetch">buildSubQueryForFetch</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchParentContentGenres">fetchParentContentGenres</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchParentData">fetchParentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedLessonsSectionData">fetchRelatedLessonsSectionData</a></li><li data-type='method'><a href="module-Sanity-Services.html#~formatForResponse">formatForResponse</a></li><li data-type='method'><a href="module-Sanity-Services.html#~formatGenresToString">formatGenresToString</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getCurrentContentDataForQuery">getCurrentContentDataForQuery</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getNextAndPreviousQuarterDates">getNextAndPreviousQuarterDates</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li><li data-type='method'><a href="module-Sanity-Services.html#~groupCurrentContentData">groupCurrentContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#~handleCustomFetchAll">handleCustomFetchAll</a></li></ul></li><li><a href="module-Search-Engine-Services.html">Search-Engine-Services</a><ul class='methods'><li data-type='method'><a href="module-Search-Engine-Services.html#.sendAlgoliaClickEvent">sendAlgoliaClickEvent</a></li></ul></li></ul>
     
 </nav>
 
@@ -120,15 +120,22 @@ export async function fetchSongById(documentId) {
  * @number contentPerPage
  * @returns {Promise&lt;Object|null>}
  */
-export async function fetchLeaving(
-    brand,
-    { pageNumber = 1, contentPerPage = 20 } = {}) {
-  const nextQuarter = getNextAndPreviousQuarterDates()['next'];
+export async function fetchLeaving(brand, { pageNumber = 1, contentPerPage = 20 } = {}) {
+  const nextQuarter = getNextAndPreviousQuarterDates()['next']
   const filterString = `brand == '${brand}' &amp;&amp; quarter_removed == '${nextQuarter}'`
-  const startEndOrder = getQueryFromPage(pageNumber, contentPerPage);
-  const sortOrder = {sortOrder: "published_on desc, id desc", start: startEndOrder['start'], end: startEndOrder['end']};
-  const query = await buildQuery(filterString, {pullFutureContent: false, availableContentStatuses: ["published"]}, getFieldsForContentType(), sortOrder);
-  return fetchSanity(query, true);
+  const startEndOrder = getQueryFromPage(pageNumber, contentPerPage)
+  const sortOrder = {
+    sortOrder: 'published_on desc, id desc',
+    start: startEndOrder['start'],
+    end: startEndOrder['end'],
+  }
+  const query = await buildQuery(
+    filterString,
+    { pullFutureContent: false, availableContentStatuses: ['published'] },
+    getFieldsForContentType(),
+    sortOrder
+  )
+  return fetchSanity(query, true)
 }
 
 /**
@@ -139,16 +146,23 @@ export async function fetchLeaving(
  * @number contentPerPage
  * @returns {Promise&lt;Object|null>}
  */
-export async function fetchReturning(
-    brand,
-    { pageNumber = 1, contentPerPage = 20 } = {}) {
-  const nextQuarter = getNextAndPreviousQuarterDates()['next'];
-  const filterString = `brand == '${brand}' &amp;&amp; quarter_published == '${nextQuarter}'`;
-  const startEndOrder = getQueryFromPage(pageNumber, contentPerPage);
-  const sortOrder = {sortOrder: "published_on desc, id desc", start: startEndOrder['start'], end: startEndOrder['end']};
-  const query = await buildQuery(filterString, {pullFutureContent: true, availableContentStatuses: ["draft"]}, getFieldsForContentType(), sortOrder);
+export async function fetchReturning(brand, { pageNumber = 1, contentPerPage = 20 } = {}) {
+  const nextQuarter = getNextAndPreviousQuarterDates()['next']
+  const filterString = `brand == '${brand}' &amp;&amp; quarter_published == '${nextQuarter}'`
+  const startEndOrder = getQueryFromPage(pageNumber, contentPerPage)
+  const sortOrder = {
+    sortOrder: 'published_on desc, id desc',
+    start: startEndOrder['start'],
+    end: startEndOrder['end'],
+  }
+  const query = await buildQuery(
+    filterString,
+    { pullFutureContent: true, availableContentStatuses: ['draft'] },
+    getFieldsForContentType('returning'),
+    sortOrder
+  )
 
-  return fetchSanity(query, true);
+  return fetchSanity(query, true)
 }
 
 /**
@@ -159,14 +173,21 @@ export async function fetchReturning(
  * @number contentPerPage
  * @returns {Promise&lt;Object|null>}
  */
-export async function fetchComingSoon(
-    brand,
-    { pageNumber = 1, contentPerPage = 20 } = {}) {
-  const filterString = `brand == '${brand}' &amp;&amp; _type == 'song'`;
-  const startEndOrder = getQueryFromPage(pageNumber, contentPerPage);
-  const sortOrder = {sortOrder: "published_on desc, id desc", start: startEndOrder['start'], end: startEndOrder['end']};
-  const query = await buildQuery(filterString, {getFutureContentOnly: true}, getFieldsForContentType(), sortOrder);
-  return fetchSanity(query, true);
+export async function fetchComingSoon(brand, { pageNumber = 1, contentPerPage = 20 } = {}) {
+  const filterString = `brand == '${brand}' &amp;&amp; _type == 'song'`
+  const startEndOrder = getQueryFromPage(pageNumber, contentPerPage)
+  const sortOrder = {
+    sortOrder: 'published_on desc, id desc',
+    start: startEndOrder['start'],
+    end: startEndOrder['end'],
+  }
+  const query = await buildQuery(
+    filterString,
+    { getFutureContentOnly: true },
+    getFieldsForContentType(),
+    sortOrder
+  )
+  return fetchSanity(query, true)
 }
 
 /**
@@ -175,47 +196,47 @@ export async function fetchComingSoon(
  * @returns {number[]}
  */
 function getQueryFromPage(pageNumber, contentPerPage) {
-  const start = contentPerPage*(pageNumber-1);
-  const end = contentPerPage*pageNumber;
-  let result = [];
-  result['start'] = start;
-  result['end'] = end;
-  return result;
+  const start = contentPerPage * (pageNumber - 1)
+  const end = contentPerPage * pageNumber
+  let result = []
+  result['start'] = start
+  result['end'] = end
+  return result
 }
 
 /**
  * returns array of next and previous quarter dates as strings
  *
- * @returns {*[]}
+ * @returns {Array&lt;any>}
  */
 function getNextAndPreviousQuarterDates() {
-  const january = 1;
-  const april = 4;
-  const july = 7;
-  const october = 10;
-  const month = new Date().getMonth();
-  let year = new Date().getFullYear();
-  let nextQuarter = '';
-  let prevQuarter = '';
+  const january = 1
+  const april = 4
+  const july = 7
+  const october = 10
+  const month = new Date().getMonth()
+  let year = new Date().getFullYear()
+  let nextQuarter = ''
+  let prevQuarter = ''
   if (month &lt; april) {
-    nextQuarter = `${year}-0${april}-01`;
-    prevQuarter = `${year}-0${january}-01`;
+    nextQuarter = `${year}-0${april}-01`
+    prevQuarter = `${year}-0${january}-01`
   } else if (month &lt; july) {
-    nextQuarter = `${year}-0${july}-01`;
-    prevQuarter = `${year}-0${april}-01`;
+    nextQuarter = `${year}-0${july}-01`
+    prevQuarter = `${year}-0${april}-01`
   } else if (month &lt; october) {
-    nextQuarter = `${year}-${october}-01`;
-    prevQuarter = `${year}-0${july}-01`;
+    nextQuarter = `${year}-${october}-01`
+    prevQuarter = `${year}-0${july}-01`
   } else {
-    prevQuarter = `${year}-${october}-01`;
-    year++;
-    nextQuarter = `${year}-0${january}-01`;
+    prevQuarter = `${year}-${october}-01`
+    year++
+    nextQuarter = `${year}-0${january}-01`
   }
 
-  let result = [];
-  result['next'] = nextQuarter;
-  result['previous'] = prevQuarter;
-  return result;
+  let result = []
+  result['next'] = nextQuarter
+  result['previous'] = prevQuarter
+  return result
 }
 
 /**
@@ -249,8 +270,8 @@ export async function fetchArtists(brand) {
  */
 export async function fetchSongArtistCount(brand) {
   const filter = await new FilterBuilder(
-      `_type == "song" &amp;&amp; brand == "${brand}" &amp;&amp; references(^._id)`,
-      { bypassPermissions: true }
+    `_type == "song" &amp;&amp; brand == "${brand}" &amp;&amp; references(^._id)`,
+    { bypassPermissions: true }
   ).buildFilter()
   const query = `
   count(*[_type == "artist"]{
@@ -260,13 +281,13 @@ export async function fetchSongArtistCount(brand) {
   return fetchSanity(query, true, { processNeedAccess: false })
 }
 
-export async function fetchPlayAlongsCount(brand, {
-  searchTerm,
-  includedFields,
-  progressIds,
-  progress,
-}) {
-  const searchFilter = searchTerm ? `&amp;&amp; (artist->name match "${searchTerm}*" || instructor[]->name match "${searchTerm}*" || title match "${searchTerm}*" || name match "${searchTerm}*")` :'';
+export async function fetchPlayAlongsCount(
+  brand,
+  { searchTerm, includedFields, progressIds, progress }
+) {
+  const searchFilter = searchTerm
+    ? `&amp;&amp; (artist->name match "${searchTerm}*" || instructor[]->name match "${searchTerm}*" || title match "${searchTerm}*" || name match "${searchTerm}*")`
+    : ''
 
   // Construct the included fields filter, replacing 'difficulty' with 'difficulty_string'
   const includedFieldsFilter = includedFields.length > 0 ? filtersToGroq(includedFields) : ''
@@ -302,6 +323,7 @@ export async function fetchRelatedSongs(brand, songId) {
             "published_on": published_on,
             status,
             "image": thumbnail.asset->url,
+            "permission_id": permission[]->railcontent_id,
             "fields": [
               {
                 "key": "title",
@@ -327,6 +349,7 @@ export async function fetchRelatedSongs(brand, songId) {
             "id": railcontent_id,
             "url": web_url_path,
             "published_on": published_on,
+            "permission_id": permission[]->railcontent_id,
             status,
             "fields": [
               {
@@ -428,7 +451,8 @@ export async function fetchUpcomingEvents(brand, { page = 1, limit = 10 } = {})
         published_on,
         "type": _type,
         web_url_path,
-        "permission_id": permission[]->railcontent_id,`
+        "permission_id": permission[]->railcontent_id,
+        event_calendar_unique_key`
   const query = buildRawQuery(
     `_type in ${typesString} &amp;&amp; brand == '${brand}' &amp;&amp; published_on > '${now}' &amp;&amp; status == 'scheduled'`,
     fields,
@@ -534,7 +558,7 @@ export async function fetchByRailContentId(id, contentType) {
  */
 export async function fetchByRailContentIds(ids, contentType = undefined) {
   if (!ids) {
-    return [];
+    return []
   }
   const idsString = ids.join(',')
 
@@ -1288,7 +1312,7 @@ export async function fetchLessonContent(railContentId) {
             "coach_profile_image":thumbnail_url.asset->url
           },
           ${assignmentsField}
-          video,
+          'video': coalesce(video[0], video),
           length_in_seconds,
           mp3_no_drums_no_click_url,
           mp3_no_drums_yes_click_url,
@@ -1303,11 +1327,22 @@ export async function fetchLessonContent(railContentId) {
             "type": *[railcontent_id == ^.id][0]._type,
           },
           sort,
-          xp`
+          xp,
+          stbs,ds2stbs, bdsStbs`
   const query = await buildQuery(`railcontent_id == ${railContentId}`, filterParams, fields, {
     isSingle: true,
   })
-  return fetchSanity(query, false)
+  const chapterProcess = (result) => {
+    const chapters = result.chapters ?? []
+    if (chapters.length == 0) return result
+    result.chapters = chapters.map((chapter, index) => ({
+      ...chapter,
+      chapter_thumbnail_url: `https://musora-web-platform.s3.amazonaws.com/chapters/${result.brand}/Chapter${index + 1}.jpg`,
+    }))
+    return result
+  }
+
+  return fetchSanity(query, false, { customPostProcess: chapterProcess })
 }
 
 /**
@@ -1331,20 +1366,166 @@ export async function fetchRelatedLessons(railContentId, brand) {
   ).buildFilter()
   const filterNeighbouringSiblings = await new FilterBuilder(`references(^._id)`).buildFilter()
   const childrenFilter = await new FilterBuilder(``, { isChildrenFilter: true }).buildFilter()
-
-  const query = `*[railcontent_id == ${railContentId} &amp;&amp; brand == "${brand}" &amp;&amp; (!defined(permission) || references(*[_type=='permission']._id))]{
+  const queryFields = `_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type, "genre": genre[]->name`
+  const queryFieldsWithSort = queryFields + ', sort'
+  const query = `*[railcontent_id == ${railContentId} &amp;&amp; brand == "${brand}"]{
    _type, parent_type, railcontent_id,
     "related_lessons" : array::unique([
-      ...(*[${filterNeighbouringSiblings}][0].child[${childrenFilter}]->{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}),
-      ...(*[${filterSongSameArtist}]{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}|order(published_on desc, title asc)[0...10]),
-      ...(*[${filterSongSameGenre}]{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}|order(published_on desc, title asc)[0...10]),
-      ...(*[${filterSameTypeAndSortOrder}]{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type, sort}|order(sort asc, title asc)[0...10]),
-      ...(*[${filterSameType}]{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}|order(published_on desc, title asc)[0...10])
+      ...(*[${filterNeighbouringSiblings}][0].child[${childrenFilter}]->{${queryFields}}),
+      ...(*[${filterSongSameArtist}]{${queryFields}}|order(published_on desc, title asc)[0...10]),
+      ...(*[${filterSongSameGenre}]{${queryFields}}|order(published_on desc, title asc)[0...10]),
+      ...(*[${filterSameTypeAndSortOrder}]{${queryFieldsWithSort}}|order(sort asc, title asc)[0...10]),
+      ...(*[${filterSameType}]{${queryFields}}|order(published_on desc, title asc)[0...10])
       ,
       ])[0...10]}`
   return fetchSanity(query, false)
 }
 
+/**
+ * fetch song tutorials related to a specific tutorial, by genre and difficulty.
+ * @param {number} railContentId
+ * @param {string} brand
+ * @returns {Promise&lt;Object|null>}
+ */
+export async function fetchRelatedTutorials(railContentId, brand) {
+  const parentObject = await fetchParentData(railContentId, brand)
+  const relatedLessonObject = await fetchRelatedLessonsSectionData(parentObject)
+  return formatForResponse(parentObject, relatedLessonObject)
+}
+
+/**
+ * fetch data of parent content, and combine with some of current content
+ * @param {number} railContentId
+ * @param {string} brand
+ * @returns {Promise&lt;Object|null>}
+ */
+async function fetchParentData(railContentId, brand) {
+  const parentQuery = buildQueryForFetch(railContentId, brand)
+  return await fetchSanity(parentQuery, false)
+}
+
+/**
+ * build query for fetch of parent data
+ * @param {number} railContentId
+ * @param {string} brand
+ * @returns {string}
+ */
+function buildQueryForFetch(railContentId, brand) {
+  const projections = `railcontent_id, _type, parent_type, parent_content_data, difficulty_string, brand`
+  return `*[railcontent_id == ${railContentId} &amp;&amp; brand == "${brand}"]{${projections}}`
+}
+
+/**
+ * fetch related lessons content
+ * @param {Object} currentContent
+ * @returns {Promise&lt;Object|null>}
+ */
+async function fetchRelatedLessonsSectionData(currentContent) {
+  const query = await buildRelatedLessonsQuery(currentContent)
+  return await fetchSanity(query, true)
+}
+
+/**
+ * build query for related lessons by content type
+ * @param {Object} currentContent
+ * @returns {Promise&lt;string>}
+ */
+async function buildRelatedLessonsQuery(currentContent) {
+  const defaultProjectionsAndSorting = `{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type,genre}|order(published_on desc, title asc)[0...10]`
+  const currentContentData = await getCurrentContentDataForQuery(currentContent)
+  const tutorialQuery = await buildSubQueryForFetch(
+    currentContentData.parentType,
+    currentContentData.brand,
+    currentContentData.parentId,
+    currentContentData.difficulty_string,
+    currentContentData.genres
+  )
+  const quickTipQuery = await buildSubQueryForFetch(
+    'quick-tips',
+    currentContentData.brand,
+    currentContentData.parentId,
+    currentContentData.difficulty_string
+  )
+  const songQuery = await buildSubQueryForFetch(
+    'song',
+    currentContentData.brand,
+    currentContentData.parentId,
+    currentContentData.difficulty_string
+  )
+  return `[...*[${tutorialQuery}]${defaultProjectionsAndSorting}, ...*[${quickTipQuery}]${defaultProjectionsAndSorting}, ...*[${songQuery}]${defaultProjectionsAndSorting}, ]`
+}
+
+/**
+ * get data, primarily brand, for use in the related_lessons query
+ * @param {Object} currentContent
+ * @returns {Object}
+ */
+async function getCurrentContentDataForQuery(currentContent) {
+  const currentContentData = groupCurrentContentData(currentContent)
+  const genres = await fetchParentContentGenres(currentContentData)
+  const genreString = formatGenresToString(genres)
+  return { ...currentContentData, genres: genreString }
+}
+
+/**
+ * group and return specific data retrieved from parent data
+ * @param {Object} currentContent
+ * @returns {Object}
+ */
+function groupCurrentContentData(currentContent) {
+  return {
+    parentType: currentContent.parent_type,
+    parentId: currentContent.parent_content_data[0].id,
+    difficulty_string: currentContent.difficulty_string,
+    brand: currentContent.brand,
+  }
+}
+
+/**
+ * fetch genres of parent content
+ * @param {Object} contentData
+ * @returns {Promise&lt;Object|null>}
+ */
+async function fetchParentContentGenres(contentData) {
+  const genreQuery = `*[_type == "${contentData.parentType}" &amp;&amp; brand == "${contentData.brand}" &amp;&amp; railcontent_id == ${contentData.parentId}][0]{"genre":genre[]->_id}`
+  return fetchSanity(genreQuery, true)
+}
+
+/**
+ * combine data into Object
+ * @param {Object} genres
+ * @returns {string}
+ */
+function formatGenresToString(genres) {
+  return JSON.stringify(genres['genre']).replace(/[\[\]]/g, '')
+}
+
+/**
+ * build filters for use in related_lessons query
+ * @param {string} type
+ * @param {string} brand
+ * @param {number} id
+ * @param {string} difficulty
+ * @param {string|null} genres
+ * @returns {Promise&lt;string>}
+ */
+async function buildSubQueryForFetch(type, brand, id, difficulty, genres = null) {
+  const genreString = genres ? `&amp;&amp; references([${genres}])` : ``
+  return new FilterBuilder(
+    `_type == "${type}" &amp;&amp; brand == "${brand}" &amp;&amp; railcontent_id != ${id} &amp;&amp; difficulty_string == "${difficulty}" ${genreString}`
+  ).buildFilter()
+}
+
+/**
+ * format return Object for use by page
+ * @param {Object} parentObject
+ * @param {Object} relatedLessonObject
+ * @returns {Object}
+ */
+function formatForResponse(parentObject, relatedLessonObject) {
+  return { ...parentObject, related_lessons: relatedLessonObject }
+}
+
 /**
  * Fetch all packs.
  * @param {string} brand - The brand for which to fetch packs.
@@ -1754,13 +1935,16 @@ function populateHierarchyLookups(currentLevel, data, parentId) {
  * @returns {Promise&lt;Object|null>} - A promise that resolves to an object containing the data
  */
 export async function fetchCommentModContentData(ids) {
+  if (!ids) {
+    return []
+  }
   const idsString = ids.join(',')
   const fields = `"id": railcontent_id, "type": _type, title, "url": web_url_path, "parent": *[^._id in child[]._ref]{"id": railcontent_id, title}`
   const query = await buildQuery(
     `railcontent_id in [${idsString}]`,
     { bypassPermissions: true },
     fields,
-    { end: 50 }
+    { end: ids.length }
   )
   let data = await fetchSanity(query, true)
   let mapped = {}
@@ -1866,9 +2050,8 @@ function needsAccessDecorator(results, userPermissions, isAdmin) {
         result.lessons.forEach((lesson) => {
           lesson['need_access'] = doesUserNeedAccessToContent(lesson, userPermissions, isAdmin) // Updated to check lesson access
         })
-      } else {
-        result['need_access'] = doesUserNeedAccessToContent(result, userPermissions, isAdmin)
       }
+      result['need_access'] = doesUserNeedAccessToContent(result, userPermissions, isAdmin)
     })
   } else if (results.related_lessons &amp;&amp; Array.isArray(results.related_lessons)) {
     results.related_lessons.forEach((result) => {
@@ -2007,7 +2190,7 @@ function checkSanityConfig(config) {
 function buildRawQuery(
   filter = '',
   fields = '...',
-  { sortOrder = 'published_on desc', start = 0, end = 10, isSingle = false}
+  { sortOrder = 'published_on desc', start = 0, end = 10, isSingle = false }
 ) {
   const sortString = sortOrder ? `order(${sortOrder})` : ''
   const countString = isSingle ? '[0...1]' : `[${start}...${end}]`
@@ -2021,10 +2204,10 @@ async function buildQuery(
   baseFilter = '',
   filterParams = { pullFutureContent: false },
   fields = '...',
-  { sortOrder = 'published_on desc', start = 0, end = 10, isSingle = false}
+  { sortOrder = 'published_on desc', start = 0, end = 10, isSingle = false }
 ) {
   const filter = await new FilterBuilder(baseFilter, filterParams).buildFilter()
-  return buildRawQuery(filter, fields, { sortOrder, start, end, isSingle})
+  return buildRawQuery(filter, fields, { sortOrder, start, end, isSingle })
 }
 
 function buildEntityAndTotalQuery(
@@ -2151,7 +2334,7 @@ function cleanUpGroq(query) {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Feb 21 2025 20:42:51 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Jun 02 2025 15:37:28 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/jsdoc.json

@@ -4,6 +4,7 @@
       "src/services/config.js",
       "src/services/sanity.js",
       "src/services/railcontent.js",
+      "src/services/algolia.js",
       "src/index.js"
     ],
     "includePattern": ".js$",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musora-content-services",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "type": "module",
@@ -31,8 +31,10 @@
   "dependencies": {
     "@babel/preset-env": "^7.25.3",
     "@sanity/client": "^5.4.2",
+    "algoliasearch": "^5.25.0",
     "babel-jest": "^29.7.0",
     "docdash": "^2.0.2",
-    "groqd": "^0.15.12"
+    "groqd": "^0.15.12",
+    "instantsearch.js": "^4.78.3"
   }
 }

package/src/index.d.ts

@@ -1,5 +1,9 @@
 /*** This file was generated automatically. To recreate, please run `npm run build-index`. ***/
 
+import {
+	sendAlgoliaClickEvent
+} from './services/algolia.js';
+
 import {
 	globalConfig,
 	initializeService,
@@ -295,6 +299,7 @@ declare module 'musora-content-services' {
 		recordWatchSession,
 		reportPlaylist,
 		reset,
+		sendAlgoliaClickEvent,
 		setLastUpdatedTime,
 		setStudentViewForUser,
 		setUserMetadata,

package/src/index.js

@@ -1,5 +1,9 @@
 /*** This file was generated automatically. To recreate, please run `npm run build-index`. ***/
 
+import {
+	sendAlgoliaClickEvent
+} from './services/algolia.js';
+
 import {
 	globalConfig,
 	initializeService,
@@ -294,6 +298,7 @@ export {
 	recordWatchSession,
 	reportPlaylist,
 	reset,
+	sendAlgoliaClickEvent,
 	setLastUpdatedTime,
 	setStudentViewForUser,
 	setUserMetadata,