musora-content-services 1.0.150 → 1.0.152

package/src/services/railcontent.js

@@ -320,56 +320,145 @@ export async function postRecordWatchSession({
     });
 }
 
+/**
+ * Fetch enrolled user data for a given challenge. Intended to be used in the enrolled modal
+ *
+ * @param contentId - railcontent id of the challenge
+ * @returns {Promise<any|null>}
+ */
 export async function fetchChallengeMetadata(contentId) {
     let url = `/challenges/${contentId}`;
     return await fetchHandler(url, 'get');
 }
 
+/**
+ * Fetch lesson, user, and challenge data for a given lesson
+ *
+ * @param contentId - railcontent id of the lesson
+ * @returns {Promise<any|null>}
+ */
 export async function fetchChallengeLessonData(contentId) {
     let url = `/challenges/lessons/${contentId}`;
     return await fetchHandler(url, 'get');
 }
 
+/**
+ * Fetch challenge, lesson, and user metadata for a given challenge
+ *
+ * @param contentId - railcontent id of the challenge
+ * @returns {Promise<any|null>}
+ */
 export async function fetchUserChallengeProgress(contentId) {
     let url = `/challenges/user_data/${contentId}`;
     return await fetchHandler(url, 'get');
 }
 
+/**
+ * Fetch the user's best award for this challenge
+ *
+ * @param contentId - railcontent id of the challenge
+ * @returns {Promise<any|null>} - streamed PDF
+ */
 export async function fetchUserAward(contentId) {
     let url = `/challenges/download_award/${contentId}`;
     return await fetchHandler(url, 'get');
 }
 
+/**
+ * Get challange duration, user progress, and status for the list of challenges
+ * Intended to be used on the index page for challenges
+ *
+ * @param {array} contentIds - arary of railcontent ids of the challenges
+ * @returns {Promise<any|null>}
+ */
+export async function fetchChallengeIndexMetadata(contentIds) {
+    let idsString = contentIds.toString();
+    let url = `/challenges/user_progress_for_index_page/get?content_ids=${idsString}`;
+    return await fetchHandler(url, 'get');
+}
+
+/**
+ * Enroll a user in a challenge and set the start date of the challenge to the provided day.
+ * Clears any existing progress data for this challenge
+ *
+ * @param {int|string} contentId - railcontent id of the challenge
+ * @param {string} startDate - prefered format YYYYMMDD, but any Carbon parsable string will do.
+ * @returns {Promise<any|null>}
+ */
 export async function postChallengesSetStartDate(contentId, startDate) {
     let url = `/challenges/set_start_date/${contentId}?start_date=${startDate}`;
     return await fetchHandler(url, 'post');
 }
 
+/**
+ * Enroll the user in the provided challenge and set to unlocked
+ * Clears any current progress data for this challenge
+ *
+ * @param {int|string} contentId - railcontent id of the challenge
+ * @returns {Promise<any|null>}
+ */
 export async function postChallengesUnlock(contentId) {
     let url = `/challenges/unlock/${contentId}`;
     return await fetchHandler(url, 'post');
 }
 
+/**
+ * Enroll the user in the given challenge on the challenge published_on date
+ *  Clears any current progress data for this challenge
+ *
+ * @param {int|string} contentId - railcontent id of the challenge
+ * @returns {Promise<any|null>}
+ */
 export async function postChallengesEnroll(contentId) {
     let url = `/challenges/enroll/${contentId}`;
     return await fetchHandler(url, 'post');
 }
 
+/**
+ * Remove the user from the provided challenge
+ * Clears any current progress data for this challenge
+ *
+ * @param {int|string} contentId - railcontent id of the challenge
+ * @returns {Promise<any|null>}
+ */
 export async function postChallengesLeave(contentId) {
     let url = `/challenges/leave/${contentId}`;
     return await fetchHandler(url, 'post');
 }
 
+/**
+ * Enable enrollment notifications for the provided challenge
+ *
+ * @param {int|string} contentId - railcontent id of the challenge
+ * @returns {Promise<any|null>}
+ */
 export async function postChallengesEnrollmentNotification(contentId) {
     let url = `/challenges/notifications/enrollment_open/${contentId}`;
     return await fetchHandler(url, 'post');
 }
 
+/**
+ * Enable community notifications for the provided challenge
+ *
+ * @param {int|string} contentId - railcontent id of the challenge
+ * @returns {Promise<any|null>}
+ */
 export async function postChallengesCommunityNotification(contentId) {
     let url = `/challenges/notifications/community_reminders/${contentId}`;
     return await fetchHandler(url, 'post');
 }
 
+/**
+ * Complete the challenge lesson and update challenge progress
+ *
+ * @param {int|string} contentId - railcontent id of the challenge
+ * @returns {Promise<any|null>} - Modal data to display
+ */
+export async function postCompleteLesson(contentId) {
+    let url = `/challenges/complete_lesson/${contentId}`;
+    return await fetchHandler(url, 'post');
+}
+
 /**
  * Fetches user playlists for a specific brand.
  *
@@ -455,9 +544,8 @@ export async function duplicatePlaylist(playlistId, playlistData) {
  *   .catch(error => console.error('Error deleting playlist:', error));
  */
 export async function deletePlaylist(playlistId) {
-    let url = `/playlists/playlist`;
-    const payload = { playlist_id: playlistId };
-    return await fetchHandler(url, "delete",  null, payload);
+    let url = `/playlists/playlist/${playlistId}`;
+    return await fetchHandler(url, "delete");
 }
 
 /**
@@ -603,7 +691,7 @@ export async function deletePlaylistLike(playlistId) {
  *   .catch(error => console.error('Error fetching playlist:', error));
  */
 export async function fetchPlaylist(playlistId) {
-    const url = `/playlists/playlist?playlist_id=${playlistId}`;
+    const url = `/playlists/playlist/${playlistId}`;
     return await fetchHandler(url, "GET");
 }
 
@@ -635,6 +723,7 @@ export async function fetchPlaylistItems(playlistId) {
  * @param {number} [updatedData.start_second] - (Optional) The start time in seconds for the item.
  * @param {number} [updatedData.end_second] - (Optional) The end time in seconds for the item.
  * @param {string} [updatedData.playlist_item_name] - (Optional) The new name for the playlist item.
+ * @param {number} [updatedData.position] - (Optional) The new position for the playlist item within the playlist.
  * @returns {Promise<Object|null>} - A promise that resolves to an object containing:
  *  - `success` (boolean): Indicates if the update was successful (`true` for success).
  *  - `data` (Object): The updated playlist item data.
@@ -647,7 +736,8 @@ export async function fetchPlaylistItems(playlistId) {
  *   user_playlist_item_id: 123,
  *   start_second: 30,
  *   end_second: 120,
- *   playlist_item_name: "Updated Playlist Item Name"
+ *   playlist_item_name: "Updated Playlist Item Name",
+ *   position: 2
  * };
  *
  * updatePlaylistItem(updatedData)
@@ -665,6 +755,74 @@ export async function updatePlaylistItem(updatedData) {
     return await fetchHandler(url, "POST", null, updatedData);
 }
 
+/**
+ * Deletes a playlist item and repositions other items in the playlist if necessary.
+ *
+ * @param {Object} payload - The data required to delete the playlist item.
+ * @param {number} payload.user_playlist_item_id - The ID of the playlist item to delete.
+ * @returns {Promise<Object|null>} - A promise that resolves to an object containing:
+ *  - `success` (boolean): Indicates if the deletion was successful (`true` for success).
+ *  - `message` (string): A success message if the item is deleted successfully.
+ *  - `error` (string): An error message if the deletion fails.
+ *
+ * Resolves to `null` if the request fails.
+ * @throws {Error} - Throws an error if the request fails.
+ *
+ * @example
+ * const payload = {
+ *   user_playlist_item_id: 123
+ * };
+ *
+ * deletePlaylistItem(payload)
+ *   .then(response => {
+ *     if (response.success) {
+ *       console.log("Playlist item deleted successfully:", response.message);
+ *     } else {
+ *       console.error("Error:", response.error);
+ *     }
+ *   })
+ *   .catch(error => {
+ *     console.error("Error deleting playlist item:", error);
+ *   });
+ */
+export async function deletePlaylistItem(payload) {
+    const url = `/playlists/item`;
+    return await fetchHandler(url, "DELETE", null, payload);
+}
+
+/**
+ * Fetches detailed data for a specific playlist item, including associated Sanity and Assignment information if available.
+ *
+ * @param {Object} payload - The request payload containing necessary parameters.
+ * @param {number} payload.user_playlist_item_id - The unique ID of the playlist item to fetch.
+ * @returns {Promise<Object|null>} - A promise that resolves to an object with the fetched playlist item data, including:
+ *  - `success` (boolean): Indicates if the data retrieval was successful (`true` on success).
+ *  - `data` (Object): Contains the detailed playlist item data enriched with Sanity and Assignment details, if available.
+ *
+ * Resolves to `null` if the request fails.
+ * @throws {Error} - Throws an error if the request encounters issues during retrieval.
+ *
+ * @example
+ * const payload = { user_playlist_item_id: 123 };
+ *
+ * fetchPlaylistItem(payload)
+ *   .then(response => {
+ *     if (response?.success) {
+ *       console.log("Fetched playlist item data:", response.data);
+ *     } else {
+ *       console.log("Failed to fetch playlist item data.");
+ *     }
+ *   })
+ *   .catch(error => {
+ *     console.error("Error fetching playlist item:", error);
+ *   });
+ */
+export async function fetchPlaylistItem(payload) {
+    const playlistItemId = payload.user_playlist_item_id;
+    const url = `/playlists/item/${playlistItemId}`;
+    return await fetchHandler(url);
+}
+
 export async function postContentStarted(contentId) {
     let url = `/content/${contentId}/started`;
     return postDataHandler(url);
@@ -681,7 +839,6 @@ export async function postContentReset(contentId) {
 }
 
 
-
 function fetchAbsolute(url, params) {
     if (globalConfig.railcontentConfig.baseUrl) {
         if (url.startsWith('/')) {