musora-content-services 1.0.148 → 1.0.152

package/src/index.d.ts

@@ -12,24 +12,56 @@ import {
 } from './services/contentLikes.js';
 
 import {
+	contentStatusCompleted,
+	contentStatusReset,
+	contentStatusStarted,
+	getProgressPercentage,
+	getProgressState,
+	getResumeTimeSeconds,
+	recordWatchSession
+} from './services/contentProgress.js';
+
+import {
+	createPlaylist,
+	deletePlaylist,
+	deletePlaylistItem,
+	deletePlaylistLike,
+	duplicatePlaylist,
 	fetchAllCompletedStates,
+	fetchChallengeIndexMetadata,
 	fetchChallengeLessonData,
 	fetchChallengeMetadata,
 	fetchCompletedContent,
 	fetchCompletedState,
 	fetchContentInProgress,
 	fetchContentPageUserData,
+	fetchContentProgress,
 	fetchHandler,
+	fetchPlaylist,
+	fetchPlaylistItem,
+	fetchPlaylistItems,
 	fetchSongsInProgress,
 	fetchUserAward,
 	fetchUserChallengeProgress,
+	fetchUserLikes,
 	fetchUserPermissions,
+	fetchUserPlaylists,
+	likePlaylist,
 	postChallengesCommunityNotification,
 	postChallengesEnroll,
 	postChallengesEnrollmentNotification,
 	postChallengesLeave,
 	postChallengesSetStartDate,
-	postChallengesUnlock
+	postChallengesUnlock,
+	postCompleteLesson,
+	postContentCompleted,
+	postContentLiked,
+	postContentReset,
+	postContentStarted,
+	postContentUnliked,
+	postRecordWatchSession,
+	updatePlaylist,
+	updatePlaylistItem
 } from './services/railcontent.js';
 
 import {
@@ -49,6 +81,7 @@ import {
 	fetchCourseOverview,
 	fetchFoundation,
 	fetchGenreLessons,
+	fetchHierarchy,
 	fetchLessonContent,
 	fetchLiveEvent,
 	fetchMetadata,
@@ -64,6 +97,7 @@ import {
 	fetchPackChildren,
 	fetchPackData,
 	fetchParentByRailContentId,
+	fetchParentForDownload,
 	fetchRelatedLessons,
 	fetchRelatedMethodLessons,
 	fetchRelatedSongs,
@@ -74,14 +108,22 @@ import {
 	fetchSongById,
 	fetchSongCount,
 	fetchSongFilterOptions,
+	fetchTopLevelParentId,
 	fetchUpcomingEvents,
 	fetchWorkouts,
-	getSortOrder,
-	fetchParentForDownload,
+	getSortOrder
 } from './services/sanity.js';
 
 declare module 'musora-content-services' {
 	export {
+		contentStatusCompleted,
+		contentStatusReset,
+		contentStatusStarted,
+		createPlaylist,
+		deletePlaylist,
+		deletePlaylistItem,
+		deletePlaylistLike,
+		duplicatePlaylist,
 		fetchAll,
 		fetchAllCompletedStates,
 		fetchAllFilterOptions,
@@ -93,6 +135,7 @@ declare module 'musora-content-services' {
 		fetchByRailContentIds,
 		fetchByReference,
 		fetchCatalogMetadata,
+		fetchChallengeIndexMetadata,
 		fetchChallengeLessonData,
 		fetchChallengeMetadata,
 		fetchChallengeOverview,
@@ -102,10 +145,12 @@ declare module 'musora-content-services' {
 		fetchCompletedState,
 		fetchContentInProgress,
 		fetchContentPageUserData,
+		fetchContentProgress,
 		fetchCourseOverview,
 		fetchFoundation,
 		fetchGenreLessons,
 		fetchHandler,
+		fetchHierarchy,
 		fetchLessonContent,
 		fetchLiveEvent,
 		fetchMetadata,
@@ -121,6 +166,10 @@ declare module 'musora-content-services' {
 		fetchPackChildren,
 		fetchPackData,
 		fetchParentByRailContentId,
+		fetchParentForDownload,
+		fetchPlaylist,
+		fetchPlaylistItem,
+		fetchPlaylistItems,
 		fetchRelatedLessons,
 		fetchRelatedMethodLessons,
 		fetchRelatedSongs,
@@ -132,23 +181,39 @@ declare module 'musora-content-services' {
 		fetchSongCount,
 		fetchSongFilterOptions,
 		fetchSongsInProgress,
+		fetchTopLevelParentId,
 		fetchUpcomingEvents,
 		fetchUserAward,
 		fetchUserChallengeProgress,
+		fetchUserLikes,
 		fetchUserPermissions,
+		fetchUserPlaylists,
 		fetchWorkouts,
+		getProgressPercentage,
+		getProgressState,
+		getResumeTimeSeconds,
 		getSortOrder,
 		globalConfig,
 		initializeService,
 		isContentLiked,
 		likeContent,
+		likePlaylist,
 		postChallengesCommunityNotification,
 		postChallengesEnroll,
 		postChallengesEnrollmentNotification,
 		postChallengesLeave,
 		postChallengesSetStartDate,
 		postChallengesUnlock,
+		postCompleteLesson,
+		postContentCompleted,
+		postContentLiked,
+		postContentReset,
+		postContentStarted,
+		postContentUnliked,
+		postRecordWatchSession,
+		recordWatchSession,
 		unlikeContent,
-		fetchParentForDownload,
+		updatePlaylist,
+		updatePlaylistItem,
 	}
 }

package/src/index.js

@@ -12,24 +12,56 @@ import {
 } from './services/contentLikes.js';
 
 import {
+	contentStatusCompleted,
+	contentStatusReset,
+	contentStatusStarted,
+	getProgressPercentage,
+	getProgressState,
+	getResumeTimeSeconds,
+	recordWatchSession
+} from './services/contentProgress.js';
+
+import {
+	createPlaylist,
+	deletePlaylist,
+	deletePlaylistItem,
+	deletePlaylistLike,
+	duplicatePlaylist,
 	fetchAllCompletedStates,
+	fetchChallengeIndexMetadata,
 	fetchChallengeLessonData,
 	fetchChallengeMetadata,
 	fetchCompletedContent,
 	fetchCompletedState,
 	fetchContentInProgress,
 	fetchContentPageUserData,
+	fetchContentProgress,
 	fetchHandler,
+	fetchPlaylist,
+	fetchPlaylistItem,
+	fetchPlaylistItems,
 	fetchSongsInProgress,
 	fetchUserAward,
 	fetchUserChallengeProgress,
+	fetchUserLikes,
 	fetchUserPermissions,
+	fetchUserPlaylists,
+	likePlaylist,
 	postChallengesCommunityNotification,
 	postChallengesEnroll,
 	postChallengesEnrollmentNotification,
 	postChallengesLeave,
 	postChallengesSetStartDate,
-	postChallengesUnlock
+	postChallengesUnlock,
+	postCompleteLesson,
+	postContentCompleted,
+	postContentLiked,
+	postContentReset,
+	postContentStarted,
+	postContentUnliked,
+	postRecordWatchSession,
+	updatePlaylist,
+	updatePlaylistItem
 } from './services/railcontent.js';
 
 import {
@@ -49,6 +81,7 @@ import {
 	fetchCourseOverview,
 	fetchFoundation,
 	fetchGenreLessons,
+	fetchHierarchy,
 	fetchLessonContent,
 	fetchLiveEvent,
 	fetchMetadata,
@@ -64,6 +97,7 @@ import {
 	fetchPackChildren,
 	fetchPackData,
 	fetchParentByRailContentId,
+	fetchParentForDownload,
 	fetchRelatedLessons,
 	fetchRelatedMethodLessons,
 	fetchRelatedSongs,
@@ -74,13 +108,21 @@ import {
 	fetchSongById,
 	fetchSongCount,
 	fetchSongFilterOptions,
+	fetchTopLevelParentId,
 	fetchUpcomingEvents,
 	fetchWorkouts,
-	getSortOrder,
-	fetchParentForDownload,
+	getSortOrder
 } from './services/sanity.js';
 
 export {
+	contentStatusCompleted,
+	contentStatusReset,
+	contentStatusStarted,
+	createPlaylist,
+	deletePlaylist,
+	deletePlaylistItem,
+	deletePlaylistLike,
+	duplicatePlaylist,
 	fetchAll,
 	fetchAllCompletedStates,
 	fetchAllFilterOptions,
@@ -92,6 +134,7 @@ export {
 	fetchByRailContentIds,
 	fetchByReference,
 	fetchCatalogMetadata,
+	fetchChallengeIndexMetadata,
 	fetchChallengeLessonData,
 	fetchChallengeMetadata,
 	fetchChallengeOverview,
@@ -101,10 +144,12 @@ export {
 	fetchCompletedState,
 	fetchContentInProgress,
 	fetchContentPageUserData,
+	fetchContentProgress,
 	fetchCourseOverview,
 	fetchFoundation,
 	fetchGenreLessons,
 	fetchHandler,
+	fetchHierarchy,
 	fetchLessonContent,
 	fetchLiveEvent,
 	fetchMetadata,
@@ -120,6 +165,10 @@ export {
 	fetchPackChildren,
 	fetchPackData,
 	fetchParentByRailContentId,
+	fetchParentForDownload,
+	fetchPlaylist,
+	fetchPlaylistItem,
+	fetchPlaylistItems,
 	fetchRelatedLessons,
 	fetchRelatedMethodLessons,
 	fetchRelatedSongs,
@@ -131,22 +180,38 @@ export {
 	fetchSongCount,
 	fetchSongFilterOptions,
 	fetchSongsInProgress,
+	fetchTopLevelParentId,
 	fetchUpcomingEvents,
 	fetchUserAward,
 	fetchUserChallengeProgress,
+	fetchUserLikes,
 	fetchUserPermissions,
+	fetchUserPlaylists,
 	fetchWorkouts,
+	getProgressPercentage,
+	getProgressState,
+	getResumeTimeSeconds,
 	getSortOrder,
 	globalConfig,
 	initializeService,
 	isContentLiked,
 	likeContent,
+	likePlaylist,
 	postChallengesCommunityNotification,
 	postChallengesEnroll,
 	postChallengesEnrollmentNotification,
 	postChallengesLeave,
 	postChallengesSetStartDate,
 	postChallengesUnlock,
+	postCompleteLesson,
+	postContentCompleted,
+	postContentLiked,
+	postContentReset,
+	postContentStarted,
+	postContentUnliked,
+	postRecordWatchSession,
+	recordWatchSession,
 	unlikeContent,
-	fetchParentForDownload,
+	updatePlaylist,
+	updatePlaylistItem,
 };

package/src/services/contentLikes.js

@@ -1,5 +1,5 @@
 import {fetchUserLikes, postContentLiked, postContentUnliked} from "./railcontent";
-import {DataContext, ContentVersionKey} from "./dataContext";
+import {DataContext, ContentLikesVersionKey} from "./dataContext";
 
 /**
  * Exported functions that are excluded from index generation.
@@ -8,7 +8,7 @@ import {DataContext, ContentVersionKey} from "./dataContext";
  */
 const excludeFromGeneratedIndex = [];
 
-export let dataContext = new DataContext(ContentVersionKey, fetchUserLikes);
+export let dataContext = new DataContext(ContentLikesVersionKey, fetchUserLikes);
 
 export async function isContentLiked(contentId) {
     contentId = parseInt(contentId);
@@ -19,12 +19,12 @@ export async function isContentLiked(contentId) {
 export async function likeContent(contentId) {
     contentId = parseInt(contentId);
     await dataContext.update(
-        function (context) {
-            if (!context.data.includes(contentId)) {
-                context.data.push(contentId);
+        function (localContext) {
+            if (!localContext.data.includes(contentId)) {
+                localContext.data.push(contentId);
             }
         },
-        async function(){
+        async function () {
             return postContentLiked(contentId);
         }
     );
@@ -33,15 +33,15 @@ export async function likeContent(contentId) {
 export async function unlikeContent(contentId) {
     contentId = parseInt(contentId);
     await dataContext.update(
-        function (context) {
-            if (context.data.includes(contentId)) {
-                const index = context.data.indexOf(contentId);
+        function (localContext) {
+            if (localContext.data.includes(contentId)) {
+                const index = localContext.data.indexOf(contentId);
                 if (index > -1) { // only splice array when item is found
-                   context.data.splice(index, 1); // 2nd parameter means remove one item only
+                    localContext.data.splice(index, 1); // 2nd parameter means remove one item only
                 }
             }
         },
-        async function(){
+        async function () {
             return postContentUnliked(contentId);
         }
     );

package/src/services/contentProgress.js

@@ -0,0 +1,153 @@
+import {
+    fetchContentProgress,
+    postContentCompleted,
+    postContentReset,
+    postContentStarted,
+    postRecordWatchSession
+} from "./railcontent";
+import {DataContext, ContentProgressVersionKey} from "./dataContext";
+import {fetchHierarchy, fetchParentByRailContentId} from "./sanity";
+
+const STATE_STARTED = 'started';
+const STATE_COMPLETED = 'completed';
+const DATA_KEY_STATUS = 's';
+const DATA_KEY_PROGRESS = 'p';
+const DATA_KEY_RESUME_TIME = 't';
+export let dataContext = new DataContext(ContentProgressVersionKey, fetchContentProgress());
+
+export async function getProgressPercentage(contentId) {
+    let data = await dataContext.getData();
+    return data[contentId]?.[DATA_KEY_PROGRESS] ?? 0;
+}
+
+export async function getProgressState(contentId) {
+    let data = await dataContext.getData();
+    return data[contentId]?.[DATA_KEY_STATUS] ?? 0;
+}
+
+export async function getResumeTimeSeconds(contentId) {
+    let data = await dataContext.getData();
+    return data[contentId]?.[DATA_KEY_RESUME_TIME] ?? 0;
+}
+
+export async function contentStatusStarted(contentId) {
+    await dataContext.update(
+        function (localContext) {
+            let data = localContext.data[contentId] ?? [];
+            let progress = data?.[DATA_KEY_PROGRESS] ?? 0;
+            let status = data?.[DATA_KEY_STATUS] ?? 0;
+
+            if (status !== STATE_COMPLETED && progress !== 100) {
+                status = STATE_STARTED;
+            }
+
+            data[DATA_KEY_STATUS] = status;
+            localContext.data[contentId] = data;
+        },
+        async function () {
+            return postContentStarted(contentId);
+        });
+}
+
+
+export async function contentStatusCompleted(contentId) {
+    await dataContext.update(
+        function (localContext) {
+            let hierarchy = fetchHierarchy(contentId);
+            completeStatusInLocalContext(contentId, localContext, hierarchy);
+        },
+        async function () {
+            return postContentCompleted(contentId);
+        });
+}
+
+function completeStatusInLocalContext(contentId, localContext, hierarchy) {
+    let data = localContext.data[contentId] ?? [];
+    data[DATA_KEY_STATUS] = STATE_COMPLETED;
+    data[DATA_KEY_PROGRESS] = 100;
+    localContext.data[contentId] = data;
+
+    let children = hierarchy.children[contentId] ?? [];
+    for(let i = 0; i < children.length; i++) {
+        let childId  = children[i];
+        completeStatusInLocalContext(childId, localContext, hierarchy);
+    }
+}
+
+export async function contentStatusReset(contentId) {
+    await dataContext.update(
+        function (localContext) {
+            const index = localContext.data.indexOf(contentId);
+            if (index > -1) { // only splice array when item is found
+                localContext.data.splice(index, 1); // 2nd parameter means remove one item only
+            }
+        },
+        async function () {
+            return postContentReset(contentId);
+        });
+}
+
+
+export async function recordWatchSession({
+                                             mediaId,
+                                             mediaType,
+                                             mediaCategory,
+                                             watchPositionSeconds,
+                                             totalDurationSeconds,
+                                             sessionToken,
+                                             brand,
+                                             contentId = null
+                                         }) {
+    await dataContext.update(
+        async function (localContext) {
+            if (contentId) {
+                let data = localContext.data[contentId] ?? [];
+                let progress = data?.[DATA_KEY_PROGRESS] ?? 0;
+                let status = data?.[DATA_KEY_STATUS] ?? 0;
+
+                if (status !== STATE_COMPLETED && progress !== 100) {
+                    status = STATE_STARTED;
+                    progress = Math.min(99, Math.round(watchPositionSeconds ?? 0 / Math.max(1, totalDurationSeconds ?? 0) * 100));
+                }
+
+                data[DATA_KEY_PROGRESS] = progress;
+                data[DATA_KEY_STATUS] = status;
+                data[DATA_KEY_RESUME_TIME] = watchPositionSeconds;
+                localContext.data[contentId] = data;
+
+                let hierarchy = await fetchHierarchy(contentId);
+                bubbleProgress(hierarchy, contentId, localContext);
+            }
+        },
+        async function () {
+            return postRecordWatchSession({
+                mediaId,
+                mediaType,
+                mediaCategory,
+                watchPositionSeconds,
+                totalDurationSeconds,
+                sessionToken,
+                brand,
+                contentId
+            });
+        }
+    );
+}
+
+function bubbleProgress(hierarchy, contentId, localContext) {
+    let parentId = hierarchy.parents[contentId];
+    if (!parentId) return;
+    let data = localContext.data[parentId] ?? [];
+    let progress = data[DATA_KEY_PROGRESS];
+    let status = data[DATA_KEY_STATUS];
+    if (status !== STATE_COMPLETED && progress !== 100) {
+        let childProgress = hierarchy.children[parentId].map(function (childId) {
+            return localContext.data[childId]?.[DATA_KEY_PROGRESS] ?? 0;
+        });
+        progress = Math.round(childProgress.reduce((a, b) => a + b, 0) / childProgress.length);
+        data[DATA_KEY_PROGRESS] = progress;
+        localContext.data[parentId] = data;
+    }
+    bubbleProgress(hierarchy, parentId, localContext);
+}
+

package/src/services/dataContext.js

@@ -8,7 +8,8 @@ import {globalConfig} from "./config";
 const excludeFromGeneratedIndex = [];
 
 //These constants need to match MWP UserDataVersionKeyEnum enum
-export const ContentVersionKey = 0;
+export const ContentLikesVersionKey = 0;
+export const ContentProgressVersionKey = 1;
 
 let cache = null;
 
@@ -78,7 +79,7 @@ export class DataContext {
     async update(localUpdateFunction, serverUpdateFunction) {
         await this.ensureLocalContextLoaded();
         if (this.context) {
-            localUpdateFunction(this.context);
+            await localUpdateFunction(this.context);
             this.context.version++;
             let data = JSON.stringify(this.context);
             cache.setItem(this.localStorageKey, data);