musora-content-services 1.3.5 → 1.3.8

package/src/index.js

@@ -1,238 +1,261 @@
 /*** This file was generated automatically. To recreate, please run `npm run build-index`. ***/
 
-import { globalConfig, initializeService } from './services/config.js'
+import {
+	globalConfig,
+	initializeService
+} from './services/config.js';
 
-import { isContentLiked, likeContent, unlikeContent } from './services/contentLikes.js'
+import {
+	isContentLiked,
+	likeContent,
+	unlikeContent
+} from './services/contentLikes.js';
 
 import {
-  assignmentStatusCompleted,
-  assignmentStatusReset,
-  contentStatusCompleted,
-  contentStatusReset,
-  getAllCompleted,
-  getAllStarted,
-  getAllStartedOrCompleted,
-  getProgressPercentage,
-  getProgressPercentageByIds,
-  getProgressState,
-  getProgressStateByIds,
-  getResumeTimeSeconds,
-  recordWatchSession,
-} from './services/contentProgress.js'
+	assignmentStatusCompleted,
+	assignmentStatusReset,
+	contentStatusCompleted,
+	contentStatusReset,
+	getAllCompleted,
+	getAllStarted,
+	getAllStartedOrCompleted,
+	getProgressPercentage,
+	getProgressPercentageByIds,
+	getProgressState,
+	getProgressStateByIds,
+	getResumeTimeSeconds,
+	recordWatchSession
+} from './services/contentProgress.js';
 
 import {
-  addItemToPlaylist,
-  countAssignmentsAndLessons,
-  createPlaylist,
-  deletePlaylist,
-  deletePlaylistItem,
-  deletePlaylistLike,
-  duplicatePlaylist,
-  fetchAllCompletedStates,
-  fetchCarouselCardData,
-  fetchChallengeIndexMetadata,
-  fetchChallengeLessonData,
-  fetchChallengeMetadata,
-  fetchChallengeUserActiveChallenges,
-  fetchCompletedChallenges,
-  fetchCompletedContent,
-  fetchCompletedState,
-  fetchContentInProgress,
-  fetchContentPageUserData,
-  fetchContentProgress,
-  fetchHandler,
-  fetchNextContentDataForParent,
-  fetchOwnedChallenges,
-  fetchPinnedPlaylists,
-  fetchPlaylist,
-  fetchPlaylistItem,
-  fetchPlaylistItems,
-  fetchSongsInProgress,
-  fetchUserAward,
-  fetchUserBadges,
-  fetchUserChallengeProgress,
-  fetchUserLikes,
-  fetchUserPermissionsData,
-  fetchUserPlaylists,
-  likePlaylist,
-  pinPlaylist,
-  playback,
-  postChallengesCommunityNotification,
-  postChallengesCompleteLesson,
-  postChallengesEnroll,
-  postChallengesEnrollmentNotification,
-  postChallengesHideCompletedBanner,
-  postChallengesLeave,
-  postChallengesSetStartDate,
-  postChallengesSoloNotification,
-  postChallengesUnlock,
-  postContentCompleted,
-  postContentLiked,
-  postContentReset,
-  postContentUnliked,
-  postRecordWatchSession,
-  reportPlaylist,
-  setStudentViewForUser,
-  unpinPlaylist,
-  updatePlaylist,
-  updatePlaylistItem,
-} from './services/railcontent.js'
+	setLastUpdatedTime,
+	wasLastUpdateOlderThanXSeconds
+} from './services/lastUpdated.js';
 
 import {
-  fetchAll,
-  fetchAllFilterOptions,
-  fetchAllPacks,
-  fetchArtistLessons,
-  fetchArtists,
-  fetchByRailContentId,
-  fetchByRailContentIds,
-  fetchByReference,
-  fetchChatAndLiveEnvent,
-  fetchCoachLessons,
-  fetchCommentModContentData,
-  fetchFoundation,
-  fetchGenreLessons,
-  fetchHierarchy,
-  fetchLessonContent,
-  fetchLiveEvent,
-  fetchMetadata,
-  fetchMethod,
-  fetchMethodChildren,
-  fetchMethodChildrenIds,
-  fetchMethodPreviousNextLesson,
-  fetchNewReleases,
-  fetchNextPreviousLesson,
-  fetchPackAll,
-  fetchPackData,
-  fetchParentForDownload,
-  fetchPlayAlongsCount,
-  fetchRelatedLessons,
-  fetchRelatedSongs,
-  fetchSanity,
-  fetchScheduledReleases,
-  fetchShowsData,
-  fetchSongArtistCount,
-  fetchSongById,
-  fetchTopLevelParentId,
-  fetchUpcomingEvents,
-  getSortOrder,
-  jumpToContinueContent,
-} from './services/sanity.js'
+	addItemToPlaylist,
+	countAssignmentsAndLessons,
+	createPlaylist,
+	deletePlaylist,
+	deletePlaylistItem,
+	deletePlaylistLike,
+	duplicatePlaylist,
+	fetchAllCompletedStates,
+	fetchCarouselCardData,
+	fetchChallengeIndexMetadata,
+	fetchChallengeLessonData,
+	fetchChallengeMetadata,
+	fetchChallengeUserActiveChallenges,
+	fetchCompletedChallenges,
+	fetchCompletedContent,
+	fetchCompletedState,
+	fetchContentInProgress,
+	fetchContentPageUserData,
+	fetchContentProgress,
+	fetchHandler,
+	fetchNextContentDataForParent,
+	fetchOwnedChallenges,
+	fetchPinnedPlaylists,
+	fetchPlaylist,
+	fetchPlaylistItem,
+	fetchPlaylistItems,
+	fetchSongsInProgress,
+	fetchUserAward,
+	fetchUserBadges,
+	fetchUserChallengeProgress,
+	fetchUserLikes,
+	fetchUserPermissionsData,
+	fetchUserPlaylists,
+	likePlaylist,
+	pinPlaylist,
+	playback,
+	postChallengesCommunityNotification,
+	postChallengesCompleteLesson,
+	postChallengesEnroll,
+	postChallengesEnrollmentNotification,
+	postChallengesHideCompletedBanner,
+	postChallengesLeave,
+	postChallengesSetStartDate,
+	postChallengesSoloNotification,
+	postChallengesUnlock,
+	postContentCompleted,
+	postContentLiked,
+	postContentReset,
+	postContentUnliked,
+	postRecordWatchSession,
+	reportPlaylist,
+	setStudentViewForUser,
+	unpinPlaylist,
+	updatePlaylist,
+	updatePlaylistItem
+} from './services/railcontent.js';
 
-import { fetchUserPermissions, reset } from './services/userPermissions.js'
+import {
+	fetchAll,
+	fetchAllFilterOptions,
+	fetchAllPacks,
+	fetchArtistLessons,
+	fetchArtists,
+	fetchByRailContentId,
+	fetchByRailContentIds,
+	fetchByReference,
+	fetchChatAndLiveEnvent,
+	fetchCoachLessons,
+	fetchComingSoon,
+	fetchCommentModContentData,
+	fetchFoundation,
+	fetchGenreLessons,
+	fetchHierarchy,
+	fetchLeaving,
+	fetchLessonContent,
+	fetchLiveEvent,
+	fetchMetadata,
+	fetchMethod,
+	fetchMethodChildren,
+	fetchMethodChildrenIds,
+	fetchMethodPreviousNextLesson,
+	fetchNewReleases,
+	fetchNextPreviousLesson,
+	fetchPackAll,
+	fetchPackData,
+	fetchParentForDownload,
+	fetchPlayAlongsCount,
+	fetchRelatedLessons,
+	fetchRelatedSongs,
+	fetchReturning,
+	fetchSanity,
+	fetchScheduledReleases,
+	fetchShowsData,
+	fetchSongArtistCount,
+	fetchSongById,
+	fetchTopLevelParentId,
+	fetchUpcomingEvents,
+	getSortOrder,
+	jumpToContinueContent
+} from './services/sanity.js';
+
+import {
+	fetchUserPermissions,
+	reset
+} from './services/userPermissions.js';
 
 export {
-  addItemToPlaylist,
-  assignmentStatusCompleted,
-  assignmentStatusReset,
-  contentStatusCompleted,
-  contentStatusReset,
-  countAssignmentsAndLessons,
-  createPlaylist,
-  deletePlaylist,
-  deletePlaylistItem,
-  deletePlaylistLike,
-  duplicatePlaylist,
-  fetchAll,
-  fetchAllCompletedStates,
-  fetchAllFilterOptions,
-  fetchAllPacks,
-  fetchArtistLessons,
-  fetchArtists,
-  fetchByRailContentId,
-  fetchByRailContentIds,
-  fetchByReference,
-  fetchCarouselCardData,
-  fetchChallengeIndexMetadata,
-  fetchChallengeLessonData,
-  fetchChallengeMetadata,
-  fetchChallengeUserActiveChallenges,
-  fetchChatAndLiveEnvent,
-  fetchCoachLessons,
-  fetchCommentModContentData,
-  fetchCompletedChallenges,
-  fetchCompletedContent,
-  fetchCompletedState,
-  fetchContentInProgress,
-  fetchContentPageUserData,
-  fetchContentProgress,
-  fetchFoundation,
-  fetchGenreLessons,
-  fetchHandler,
-  fetchHierarchy,
-  fetchLessonContent,
-  fetchLiveEvent,
-  fetchMetadata,
-  fetchMethod,
-  fetchMethodChildren,
-  fetchMethodChildrenIds,
-  fetchMethodPreviousNextLesson,
-  fetchNewReleases,
-  fetchNextContentDataForParent,
-  fetchNextPreviousLesson,
-  fetchOwnedChallenges,
-  fetchPackAll,
-  fetchPackData,
-  fetchParentForDownload,
-  fetchPinnedPlaylists,
-  fetchPlayAlongsCount,
-  fetchPlaylist,
-  fetchPlaylistItem,
-  fetchPlaylistItems,
-  fetchRelatedLessons,
-  fetchRelatedSongs,
-  fetchSanity,
-  fetchScheduledReleases,
-  fetchShowsData,
-  fetchSongArtistCount,
-  fetchSongById,
-  fetchSongsInProgress,
-  fetchTopLevelParentId,
-  fetchUpcomingEvents,
-  fetchUserAward,
-  fetchUserBadges,
-  fetchUserChallengeProgress,
-  fetchUserLikes,
-  fetchUserPermissions,
-  fetchUserPermissionsData,
-  fetchUserPlaylists,
-  getAllCompleted,
-  getAllStarted,
-  getAllStartedOrCompleted,
-  getProgressPercentage,
-  getProgressPercentageByIds,
-  getProgressState,
-  getProgressStateByIds,
-  getResumeTimeSeconds,
-  getSortOrder,
-  globalConfig,
-  initializeService,
-  isContentLiked,
-  jumpToContinueContent,
-  likeContent,
-  likePlaylist,
-  pinPlaylist,
-  playback,
-  postChallengesCommunityNotification,
-  postChallengesCompleteLesson,
-  postChallengesEnroll,
-  postChallengesEnrollmentNotification,
-  postChallengesHideCompletedBanner,
-  postChallengesLeave,
-  postChallengesSetStartDate,
-  postChallengesSoloNotification,
-  postChallengesUnlock,
-  postContentCompleted,
-  postContentLiked,
-  postContentReset,
-  postContentUnliked,
-  postRecordWatchSession,
-  recordWatchSession,
-  reportPlaylist,
-  reset,
-  setStudentViewForUser,
-  unlikeContent,
-  unpinPlaylist,
-  updatePlaylist,
-  updatePlaylistItem,
-}
+	addItemToPlaylist,
+	assignmentStatusCompleted,
+	assignmentStatusReset,
+	contentStatusCompleted,
+	contentStatusReset,
+	countAssignmentsAndLessons,
+	createPlaylist,
+	deletePlaylist,
+	deletePlaylistItem,
+	deletePlaylistLike,
+	duplicatePlaylist,
+	fetchAll,
+	fetchAllCompletedStates,
+	fetchAllFilterOptions,
+	fetchAllPacks,
+	fetchArtistLessons,
+	fetchArtists,
+	fetchByRailContentId,
+	fetchByRailContentIds,
+	fetchByReference,
+	fetchCarouselCardData,
+	fetchChallengeIndexMetadata,
+	fetchChallengeLessonData,
+	fetchChallengeMetadata,
+	fetchChallengeUserActiveChallenges,
+	fetchChatAndLiveEnvent,
+	fetchCoachLessons,
+	fetchComingSoon,
+	fetchCommentModContentData,
+	fetchCompletedChallenges,
+	fetchCompletedContent,
+	fetchCompletedState,
+	fetchContentInProgress,
+	fetchContentPageUserData,
+	fetchContentProgress,
+	fetchFoundation,
+	fetchGenreLessons,
+	fetchHandler,
+	fetchHierarchy,
+	fetchLeaving,
+	fetchLessonContent,
+	fetchLiveEvent,
+	fetchMetadata,
+	fetchMethod,
+	fetchMethodChildren,
+	fetchMethodChildrenIds,
+	fetchMethodPreviousNextLesson,
+	fetchNewReleases,
+	fetchNextContentDataForParent,
+	fetchNextPreviousLesson,
+	fetchOwnedChallenges,
+	fetchPackAll,
+	fetchPackData,
+	fetchParentForDownload,
+	fetchPinnedPlaylists,
+	fetchPlayAlongsCount,
+	fetchPlaylist,
+	fetchPlaylistItem,
+	fetchPlaylistItems,
+	fetchRelatedLessons,
+	fetchRelatedSongs,
+	fetchReturning,
+	fetchSanity,
+	fetchScheduledReleases,
+	fetchShowsData,
+	fetchSongArtistCount,
+	fetchSongById,
+	fetchSongsInProgress,
+	fetchTopLevelParentId,
+	fetchUpcomingEvents,
+	fetchUserAward,
+	fetchUserBadges,
+	fetchUserChallengeProgress,
+	fetchUserLikes,
+	fetchUserPermissions,
+	fetchUserPermissionsData,
+	fetchUserPlaylists,
+	getAllCompleted,
+	getAllStarted,
+	getAllStartedOrCompleted,
+	getProgressPercentage,
+	getProgressPercentageByIds,
+	getProgressState,
+	getProgressStateByIds,
+	getResumeTimeSeconds,
+	getSortOrder,
+	globalConfig,
+	initializeService,
+	isContentLiked,
+	jumpToContinueContent,
+	likeContent,
+	likePlaylist,
+	pinPlaylist,
+	playback,
+	postChallengesCommunityNotification,
+	postChallengesCompleteLesson,
+	postChallengesEnroll,
+	postChallengesEnrollmentNotification,
+	postChallengesHideCompletedBanner,
+	postChallengesLeave,
+	postChallengesSetStartDate,
+	postChallengesSoloNotification,
+	postChallengesUnlock,
+	postContentCompleted,
+	postContentLiked,
+	postContentReset,
+	postContentUnliked,
+	postRecordWatchSession,
+	recordWatchSession,
+	reportPlaylist,
+	reset,
+	setLastUpdatedTime,
+	setStudentViewForUser,
+	unlikeContent,
+	unpinPlaylist,
+	updatePlaylist,
+	updatePlaylistItem,
+	wasLastUpdateOlderThanXSeconds,
+};

package/src/services/dataContext.js

@@ -17,6 +17,23 @@ export class DataContext {
   context = null
   dataPromise = null
 
+  /**
+   * Verify current cached data is on the correct version
+   *
+   * @param {int} dataVersionKey - Data version key from the back end
+   * @param {int} currentVersion - Current version of the data on the back end
+   * */
+  static async verifyLocalData(dataVersionKey, currentVersion) {
+    const tempContext = new DataContext(dataVersionKey, null)
+    await tempContext.ensureLocalContextLoaded()
+
+    if (currentVersion !== tempContext.version()) {
+      tempContext.clearCache()
+    } else {
+      tempContext.setLastUpdatedTime()
+    }
+  }
+
   constructor(dataVersionKey, fetchDataFunction) {
     this.dataVersionKey = dataVersionKey
     this.fetchDataFunction = fetchDataFunction
@@ -33,7 +50,7 @@ export class DataContext {
 
   async getDataPromise() {
     await this.ensureLocalContextLoaded()
-    const shouldVerify = await this.shouldVerifyServerVerions()
+    const shouldVerify = await this.shouldVerifyServerVersions()
 
     if (!this.context || shouldVerify) {
       let version = this.version()
@@ -42,7 +59,7 @@ export class DataContext {
         this.context = data
         cache.setItem(this.localStorageKey, JSON.stringify(data))
       }
-      cache.setItem(this.localStorageLastUpdatedKey, new Date().getTime()?.toString())
+      this.setLastUpdatedTime()
     }
     this.dataPromise = null
     return this.context.data
@@ -73,11 +90,11 @@ export class DataContext {
     }
   }
 
-  async shouldVerifyServerVerions() {
+  async shouldVerifyServerVersions() {
     let lastUpdated = globalConfig.isMA
       ? await cache.getItem(this.localStorageLastUpdatedKey)
       : cache.getItem(this.localStorageLastUpdatedKey)
-    if (!lastUpdated) return false
+    if (!lastUpdated) return true
     const verifyServerTime = 10000 //10 s
     return new Date().getTime() - lastUpdated > verifyServerTime
   }
@@ -92,6 +109,10 @@ export class DataContext {
     this.context = null
   }
 
+  setLastUpdatedTime() {
+    cache.setItem(this.localStorageLastUpdatedKey, new Date().getTime().toString())
+  }
+
   async update(localUpdateFunction, serverUpdateFunction) {
     await this.ensureLocalContextLoaded()
     if (this.context) {
@@ -99,7 +120,7 @@ export class DataContext {
       if (this.context) this.context.version++
       let data = JSON.stringify(this.context)
       cache.setItem(this.localStorageKey, data)
-      cache.setItem(this.localStorageLastUpdatedKey, new Date().getTime().toString())
+      this.setLastUpdatedTime()
     }
     const updatePromise = serverUpdateFunction()
     updatePromise.then((response) => {

package/src/services/sanity.js

@@ -66,30 +66,74 @@ export async function fetchSongById(documentId) {
 }
 
 /**
-* fetches from Sanity all content marked for removal next quarter
-*
-* @string brand
-* @returns {Promise<Object|null>}
-*/
-export async function fetchQuarterRemoved(brand) {
+ * fetches from Sanity all content marked for removal next quarter
+ *
+ * @string brand
+ * @number pageNumber
+ * @number contentPerPage
+ * @returns {Promise<Object|null>}
+ */
+export async function fetchLeaving(
+    brand,
+    { pageNumber = 1, contentPerPage = 20 } = {}) {
   const nextQuarter = getNextAndPreviousQuarterDates()['next'];
   const filterString = `brand == '${brand}' && quarter_removed == '${nextQuarter}'`
-  const query = await buildQuery(filterString, {pullFutureContent: false, availableContentStatuses: ["published"]}, getFieldsForContentType(), {SortOrder: "published_on desc, id desc", end: 20});
-  return fetchSanity(query, false);
+  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);
 }
 
 /**
- * fetches from Sanity all content marked for publish next quarter
+ * fetches from Sanity all content marked for return next quarter
  *
  * @string brand
+ * @number pageNumber
+ * @number contentPerPage
  * @returns {Promise<Object|null>}
  */
-export async function fetchQuarterPublished(brand) {
+export async function fetchReturning(
+    brand,
+    { pageNumber = 1, contentPerPage = 20 } = {}) {
   const nextQuarter = getNextAndPreviousQuarterDates()['next'];
   const filterString = `brand == '${brand}' && quarter_published == '${nextQuarter}'`;
-  const query = await buildQuery(filterString, {pullFutureContent: true, availableContentStatuses: ["draft"]}, getFieldsForContentType(), {SortOrder: "published_on desc, id desc", end: 20});
+  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);
+
+  return fetchSanity(query, true);
+}
+
+/**
+ * fetches from Sanity all songs coming soon (new) next quarter
+ *
+ * @string brand
+ * @number pageNumber
+ * @number contentPerPage
+ * @returns {Promise<Object|null>}
+ */
+export async function fetchComingSoon(
+    brand,
+    { pageNumber = 1, contentPerPage = 20 } = {}) {
+  const filterString = `brand == '${brand}' && _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);
+}
 
-  return fetchSanity(query, false);
+/**
+ *
+ * @number page
+ * @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;
 }
 
 /**
@@ -97,7 +141,7 @@ export async function fetchQuarterPublished(brand) {
  *
  * @returns {*[]}
  */
-export function getNextAndPreviousQuarterDates() {
+function getNextAndPreviousQuarterDates() {
   const january = 1;
   const april = 4;
   const july = 7;
@@ -1913,7 +1957,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}]`
@@ -1927,10 +1971,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(