musora-content-services 2.26.1 → 2.27.1

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.27.1](https://github.com/railroadmedia/musora-content-services/compare/v2.27.0...v2.27.1) (2025-07-17)
+
+
+### Bug Fixes
+
+* **Userpractice:** add category_id and instrument_id to userPractice ([2c92c6f](https://github.com/railroadmedia/musora-content-services/commit/2c92c6f6adcb7fac657c3b12e1c3f5e927cff214))
+
+## [2.27.0](https://github.com/railroadmedia/musora-content-services/compare/v2.24.0...v2.27.0) (2025-07-17)
+
+
+### Features
+
+* **BEH-38:** add context data to tab results ([#344](https://github.com/railroadmedia/musora-content-services/issues/344)) ([02fe932](https://github.com/railroadmedia/musora-content-services/commit/02fe9321dfa56e74d7c73cb7a80e54f5818d1427))
+* **MU2-805:** Set a pauseLiveEventPollingUntil field when user mark all notificatio… ([#351](https://github.com/railroadmedia/musora-content-services/issues/351)) ([bfe1010](https://github.com/railroadmedia/musora-content-services/commit/bfe10107c522ea725436e4a6338a869e852c08d5))
+
+
+### Bug Fixes
+
+* Add live event fallback to unread notifications count ([61afc83](https://github.com/railroadmedia/musora-content-services/commit/61afc835a7f009ec5e12947b2bf2131b7ed7049a))
+* T3PS-21: Live Stream content cards in the Progress Row and Recent Lessons ([3736c48](https://github.com/railroadmedia/musora-content-services/commit/3736c4898d9db27869de079660474e6dd0233da4))
+* T3PS-259: Incorrect stats for past months ([b38ee32](https://github.com/railroadmedia/musora-content-services/commit/b38ee320488196115ff4ef97d4ea4ea661d1eb43))
+* user data endpoint ([#356](https://github.com/railroadmedia/musora-content-services/issues/356)) ([2a00bb8](https://github.com/railroadmedia/musora-content-services/commit/2a00bb859faa72ec22930919f4a636275b219772))
+
 ### [2.26.1](https://github.com/railroadmedia/musora-content-services/compare/v2.26.0...v2.26.1) (2025-07-16)
 
 ## [2.26.0](https://github.com/railroadmedia/musora-content-services/compare/v2.25.1...v2.26.0) (2025-07-16)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musora-content-services",
-  "version": "2.26.1",
+  "version": "2.27.1",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "type": "module",

package/src/index.d.ts

@@ -261,13 +261,14 @@ import {
 
 import {
 	deleteNotification,
+	fetchLiveEventPollingState,
 	fetchNotificationSettings,
 	fetchNotifications,
 	fetchUnreadCount,
 	markAllNotificationsAsRead,
 	markNotificationAsRead,
 	markNotificationAsUnread,
-	pauseLiveEventPollingUntil,
+	pauseLiveEventPolling,
 	startLiveEventPolling,
 	updateNotificationSetting
 } from './services/user/notifications.js';
@@ -382,6 +383,7 @@ declare module 'musora-content-services' {
 		fetchLessonsFeaturingThisContent,
 		fetchLikeCount,
 		fetchLiveEvent,
+		fetchLiveEventPollingState,
 		fetchMetadata,
 		fetchMethod,
 		fetchMethodChildren,
@@ -488,7 +490,7 @@ declare module 'musora-content-services' {
 		markNotificationAsUnread,
 		openComment,
 		otherStats,
-		pauseLiveEventPollingUntil,
+		pauseLiveEventPolling,
 		pinGuidedCourse,
 		pinProgressRow,
 		pinnedGuidedCourses,

package/src/index.js

@@ -261,13 +261,14 @@ import {
 
 import {
 	deleteNotification,
+	fetchLiveEventPollingState,
 	fetchNotificationSettings,
 	fetchNotifications,
 	fetchUnreadCount,
 	markAllNotificationsAsRead,
 	markNotificationAsRead,
 	markNotificationAsUnread,
-	pauseLiveEventPollingUntil,
+	pauseLiveEventPolling,
 	startLiveEventPolling,
 	updateNotificationSetting
 } from './services/user/notifications.js';
@@ -381,6 +382,7 @@ export {
 	fetchLessonsFeaturingThisContent,
 	fetchLikeCount,
 	fetchLiveEvent,
+	fetchLiveEventPollingState,
 	fetchMetadata,
 	fetchMethod,
 	fetchMethodChildren,
@@ -487,7 +489,7 @@ export {
 	markNotificationAsUnread,
 	openComment,
 	otherStats,
-	pauseLiveEventPollingUntil,
+	pauseLiveEventPolling,
 	pinGuidedCourse,
 	pinProgressRow,
 	pinnedGuidedCourses,

package/src/services/contentProgress.js

@@ -371,6 +371,8 @@ function resetStatusInLocalContext(localContext, contentId, hierarchy) {
  * @param {int} currentSeconds
  * @param {int} secondsPlayed
  * @param {string} sessionId - This function records a sessionId to pass into future updates to progress on the same video
+ * @param {int} instrumentId - enum value of instrument id
+ * @param {int} categoryId - enum value of category id
  */
 export async function recordWatchSession(
   contentId,
@@ -379,7 +381,9 @@ export async function recordWatchSession(
   mediaLengthSeconds,
   currentSeconds,
   secondsPlayed,
-  sessionId = null
+  sessionId = null,
+  instrumentId = null,
+  categoryId = null,
 ) {
   let mediaTypeId = getMediaTypeId(mediaType, mediaCategory)
   let updateLocalProgress = mediaTypeId === 1 || mediaTypeId === 2 //only update for video playback
@@ -391,7 +395,7 @@ export async function recordWatchSession(
     //TODO: Good enough for Alpha, Refine in reliability improvements
     sessionData[sessionId] = sessionData[sessionId] || {}
     const secondsSinceLastUpdate = Math.ceil(secondsPlayed - (sessionData[sessionId][contentId] ?? 0))
-    await recordUserPractice({ content_id: contentId, duration_seconds: secondsSinceLastUpdate })
+    await recordUserPractice({ content_id: contentId, duration_seconds: secondsSinceLastUpdate, category_id: categoryId, instrument_id: instrumentId })
   } catch (error) {
       console.error('Failed to record user practice:', error)
   }

package/src/services/sanity.js

@@ -520,13 +520,30 @@ export async function fetchByRailContentIds(ids, contentType = undefined, brand
   }
   const idsString = ids.join(',')
   const brandFilter = brand ? ` && brand == "${brand}"` : ''
+  const now = getSanityDate(new Date())
   const query = `*[
     railcontent_id in [${idsString}]${brandFilter}
   ]{
     ${getFieldsForContentType(contentType)}
+    live_event_start_time,
+    live_event_end_time,
   }`
 
-  const results = await fetchSanity(query, true)
+  const customPostProcess = (results) => {
+    const now = getSanityDate(new Date(), false);
+    const liveProcess = (result) => {
+      if (result.live_event_start_time && result.live_event_end_time) {
+        result.isLive =
+          result.live_event_start_time <= now &&
+          result.live_event_end_time >= now;
+      } else {
+        result.isLive = false;
+      }
+      return result;
+    };
+    return results.map(liveProcess);
+  }
+  const results = await fetchSanity(query, true, { customPostProcess: customPostProcess })
 
   const sortFuction = function compare(a, b) {
     const indexA = ids.indexOf(a['id'])
@@ -2385,6 +2402,7 @@ export async function fetchTabData(
   }
 
   const fieldsString = getFieldsForContentType('tab-data');
+  const now = getSanityDate(new Date())
 
   // Determine the group by clause
   let query = ''
@@ -2396,6 +2414,7 @@ export async function fetchTabData(
   entityFieldsString =
     ` ${fieldsString}
     'children': child[${childrenFilter}]->{'id': railcontent_id},
+    'isLive': live_event_start_time <= "${now}" && live_event_end_time >= "${now}",
     'lesson_count': coalesce(count(child[${childrenFilter}]->), 0),
     'length_in_seconds': coalesce(
       math::sum(

package/src/services/user/notifications.js

@@ -60,21 +60,15 @@ export async function markNotificationAsRead(notificationId) {
 }
 
 /**
- * Marks all notifications as read for a specific brand.
+ * Marks all notifications as read for the current user.
  *
- * @returns {Promise<any>} - A promise that resolves when all notifications are marked as read.
+ * This also pauses live event polling if there is an active event, to prevent immediate re-polling.
  *
- * @example
- * markAllNotificationsAsRead('drumeo')
- *   .then(response => console.log(response))
- *   .catch(error => console.error(error));
+ * @param {string} [brand='drumeo'] - The brand context for live event handling before marking notifications.
+ * @returns {Promise<Object>} - A promise resolving to the API response from the notifications read endpoint.
  */
 export async function markAllNotificationsAsRead(brand = 'drumeo') {
-  const liveEvent = await fetchLiveEvent(brand)
-  if(liveEvent){
-    await pauseLiveEventPollingUntil(liveEvent.live_event_end_time)
-  }
-
+  await pauseLiveEventPolling(brand)
   const url = `${baseUrl}/v1/read`
   return fetchHandler(url, 'put')
 }
@@ -128,20 +122,33 @@ export async function deleteNotification(notificationId) {
 /**
  * Fetches the count of unread notifications for the current user in a given brand context.
  *
+ * This function first checks for standard unread notifications. If none are found,
+ * it checks if live event polling is active. If so, it will query for any ongoing live events.
+ * If a live event is active, it counts as an unread item.
+ *
  * @param {Object} [options={}] - Options for fetching unread count.
- * @param {string} options.brand - The brand to filter unread notifications by (required).
- * @returns {Promise<Object>} - A promise that resolves to an object with the unread count.
+ * @param {string} options.brand - The brand to filter unread notifications by. Defaults to 'drumeo'.
+ * @returns {Promise<Object>} - A promise that resolves to an object with a `data` property indicating the unread count (0 or 1).
  *
- * @throws {Error} If the brand is not provided.
+ * @throws {Error} If the brand is not provided or if network requests fail.
  *
  * @example
  * fetchUnreadCount({ brand: 'drumeo' })
- *   .then(data => console.log(data.unread_count))
+ *   .then(data => console.log(data.data)) // 0 or 1
  *   .catch(error => console.error(error));
  */
-export async function fetchUnreadCount({ brand = null} = {}) {
+export async function fetchUnreadCount({ brand = 'drumeo'} = {}) {
   const url = `${baseUrl}/v1/unread-count`
-  return fetchHandler(url, 'get')
+  const notifUnread =  await fetchHandler(url, 'get')
+  if (notifUnread.data > 0) {
+    return notifUnread// Return early if unread notifications exist
+  }
+  const liveEventPollingState = await fetchLiveEventPollingState()
+  if(liveEventPollingState.data?.read_state === true){
+    const liveEvent = await fetchLiveEvent(brand)
+    return { data: liveEvent ? 1 : 0}
+  }
+  return notifUnread
 }
 
 /**
@@ -231,20 +238,26 @@ export async function updateNotificationSetting({ brand, settingName, email, pus
 }
 
 /**
-  * Pauses live event polling until the specified time.
-  * @param {string|null} [until=null] - ISO timestamp string or null to unpause
-  * @returns {Promise<Object>} - Promise resolving to the API response
+ * Pauses live event polling for the current user based on the live event end time.
+ *
+ * If a live event is active, polling will be paused until its end time. If no live event is found,
+ * polling is not paused.
+ *
+ * @param {string} [brand='drumeo'] - The brand context to fetch live event data for.
+ * @returns {Promise<Object>} - A promise resolving to the API response from the pause polling endpoint.
  */
-export async function pauseLiveEventPollingUntil(until = null) {
-    const url = `/api/user-management-system/v1/users/pause-polling${until ? `?until=${until}` : ''}`
-    return fetchHandler(url, 'PUT', null)
+export async function pauseLiveEventPolling(brand = 'drumeo') {
+  const liveEvent = await fetchLiveEvent(brand)
+  const until = liveEvent?.live_event_end_time || null
+  const url = `/api/user-management-system/v1/users/pause-polling${until ? `?until=${until}` : ''}`
+  return fetchHandler(url, 'PUT', null)
 }
 
 /**
  * Start live event polling.
  * @returns {Promise<Object>} - Promise resolving to the API response
  */
-export async function startLiveEventPolling() {
+export async function startLiveEventPolling(brand = 'drumeo') {
   const url = `/api/user-management-system/v1/users/start-polling`
   return fetchHandler(url, 'PUT', null)
 }
@@ -254,10 +267,10 @@ export async function startLiveEventPolling() {
  + @returns {Promise<Object>} - Promise resolving to the polling state
  */
 
-  export async function fetchLiveEventPollingState() {
+export async function fetchLiveEventPollingState() {
     const url = `/api/user-management-system/v1/users/polling`
     return fetchHandler(url, 'GET', null)
-  }
+}
 
 
 

package/src/services/userActivity.js

@@ -174,11 +174,11 @@ export async function getUserMonthlyStats(params = {}) {
   }
 
   let endOfMonth = new Date(year, month + 1, 0)
-  while (endOfMonth.getDay() !== 0) {
-    endOfMonth.setDate(endOfMonth.getDate() + 1)
+  let endOfGrid = new Date(year, month + 1, 0)
+  while (endOfGrid.getDay() !== 0) {
+    endOfGrid.setDate(endOfGrid.getDate() + 1)
   }
-
-  let daysInMonth = Math.ceil((endOfMonth - startOfGrid) / (1000 * 60 * 60 * 24)) + 1
+  let daysInMonth = Math.ceil((endOfGrid - startOfGrid) / (1000 * 60 * 60 * 24)) + 1
 
   let dailyStats = []
   let practiceDuration = 0
@@ -272,7 +272,9 @@ export async function getUserMonthlyStats(params = {}) {
  *   auto: false,
  *   category_id: 5,
  *   title: "Guitar Warm-up",
- *   thumbnail_url: "https://example.com/thumbnail.jpg"
+ *   thumbnail_url: "https://example.com/thumbnail.jpg",
+ *   instrument_id: 1,
+ *   instrument_id: 2,
  * })
  *   .then(response => console.log(response))
  *   .catch(error => console.error(error));
@@ -1073,6 +1075,7 @@ async function processContentItem(item) {
   let data = item.raw;
   const contentType = getFormattedType(data.type, data.brand);
   const status = item.state;
+  const isLive = data.isLive ?? false
   let ctaText = 'Continue';
   if (contentType === 'transcription' || contentType === 'play-along' || contentType === 'jam-track') ctaText = 'Replay Song';
   if (contentType === 'lesson') ctaText = status === 'completed' ? 'Revisit Lesson' : 'Continue';
@@ -1159,13 +1162,14 @@ async function processContentItem(item) {
     header:            contentType,
     pinned:            item.pinned ?? false,
     body:              {
-      progressPercent: item.percent,
+      progressPercent: isLive ? undefined: item.percent,
       thumbnail:       data.thumbnail,
       title:           data.title,
+      isLive:          isLive,
       badge:           data.badge ?? null,
       isLocked:        data.is_locked ?? false,
       subtitle:        !data.child_count || data.lesson_count === 1
-        ? (contentType === 'lesson') ? `${item.percent}% Complete`: `${data.difficulty_string} • ${data.artist_name}`
+        ? (contentType === 'lesson' && isLive === false) ? `${item.percent}% Complete`: `${data.difficulty_string} • ${data.artist_name}`
         : `${data.completed_children} of ${data.lesson_count ?? data.child_count} Lessons Complete`
     },
     cta:               {