musora-content-services 2.11.0 → 2.12.0

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 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.12.0](https://github.com/railroadmedia/musora-content-services/compare/v2.11.0...v2.12.0) (2025-06-25)
+
+
+### Features
+
+* **MU2-478:** simplified version of getAllStartedOrCompleted method ([b58b97b](https://github.com/railroadmedia/musora-content-services/commit/b58b97bcf95db7ad71019848dbf5e5b508adeeb8))
+
+
+### Bug Fixes
+
+* **MU2-608:** Sort recent lessons by user progress ([e966ffc](https://github.com/railroadmedia/musora-content-services/commit/e966ffcd87847ee6b72d35bed84967ee8fd1db44))
+* **MU2-730:** Pagination on fetchNotifications method ([37e95db](https://github.com/railroadmedia/musora-content-services/commit/37e95dbaacca06a1e408db8a5d6dead3dfb23550))
+* Pagination on fetchNotifications method ([9e613b9](https://github.com/railroadmedia/musora-content-services/commit/9e613b9227bb188814ebc2d8c084c18e115fbcc3))
+
+### [2.11.1](https://github.com/railroadmedia/musora-content-services/compare/v2.11.0...v2.11.1) (2025-06-24)
+
 ## [2.11.0](https://github.com/railroadmedia/musora-content-services/compare/v2.10.0...v2.11.0) (2025-06-24)
 
 

package/README.md

@@ -6,7 +6,6 @@ allowing you to easily retrieve, filter, and manipulate content for use in vario
 
 ## Setup
 To set up the Musora Content Services project for local development, follow these steps:
-- Pull the latest railenvironment `php-8-3-upgrade` branch changes
 - In the railenvironment directory, start up the container with the `./rrr.sh` command
 - Run `r setup musora-content-services`
 - Run `npm install --save-dev jest`
@@ -94,4 +93,4 @@ and having jest installed (`npm install --save-dev jest`). To run the full test
 npm test
 ```
 You can also filter down to specific tests with the `-- -t="..."` option. e.g. you can run the userContext test suite 
-with `npm test -- -t="userContext"` or just the contentLiked test with `npm test -- -t="contentLiked"`
+with `npm test -- -t="userContext"` or just the contentLiked test with `npm test -- -t="contentLiked"`

package/package.json

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

package/src/index.d.ts

@@ -59,6 +59,7 @@ import {
 	getProgressStateByIds,
 	getResumeTimeSeconds,
 	getResumeTimeSecondsByIds,
+	getStartedOrCompletedProgressOnly,
 	recordWatchSession
 } from './services/contentProgress.js';
 
@@ -419,6 +420,7 @@ declare module 'musora-content-services' {
 		getResumeTimeSecondsByIds,
 		getScheduleContentRows,
 		getSortOrder,
+		getStartedOrCompletedProgressOnly,
 		getTabResults,
 		getTimeRemainingUntilLocal,
 		getUserMonthlyStats,

package/src/index.js

@@ -59,6 +59,7 @@ import {
 	getProgressStateByIds,
 	getResumeTimeSeconds,
 	getResumeTimeSecondsByIds,
+	getStartedOrCompletedProgressOnly,
 	recordWatchSession
 } from './services/contentProgress.js';
 
@@ -418,6 +419,7 @@ export {
 	getResumeTimeSecondsByIds,
 	getScheduleContentRows,
 	getSortOrder,
+	getStartedOrCompletedProgressOnly,
 	getTabResults,
 	getTimeRemainingUntilLocal,
 	getUserMonthlyStats,

package/src/services/content.js

@@ -19,7 +19,7 @@ import {recommendations} from "./recommendations";
 
 
 export async function getLessonContentRows (brand='drumeo', pageName = 'lessons') {
-  let recentContentIds = await fetchRecent(brand, pageName, { progress: 'recent' });
+  let recentContentIds = await fetchRecent(brand, pageName, { progress: 'recent', limit: 10 });
 
   let contentRows = await getContentRows(brand, pageName);
   contentRows = Array.isArray(contentRows) ? contentRows : [];

package/src/services/contentProgress.js

@@ -118,7 +118,7 @@ export async function getAllStartedOrCompleted({ limit = null, onlyIds = true, b
       const isRelevantStatus =
         item[DATA_KEY_STATUS] === STATE_STARTED || item[DATA_KEY_STATUS] === STATE_COMPLETED
       const isRecent = item[DATA_KEY_LAST_UPDATED_TIME] >= oneMonthAgoInSeconds
-      const isCorrectBrand = !brand || item.b === brand
+      const isCorrectBrand = !brand || !item.b || item.b === brand
       const isNotExcluded = !excludedSet.has(id)
       return isRelevantStatus && isRecent && isCorrectBrand && isNotExcluded
     })
@@ -151,6 +151,40 @@ export async function getAllStartedOrCompleted({ limit = null, onlyIds = true, b
   }
 }
 
+/**
+ * Simplified version of `getAllStartedOrCompleted`.
+ *
+ * Fetches content IDs and progress percentages for items that were
+ * started or completed.
+ *
+ * @param {Object} [options={}] - Optional filtering options.
+ * @param {string|null} [options.brand=null] - Brand to filter by (e.g., 'drumeo').
+ * @returns {Promise<Object>} - A map of content ID to progress value:
+ *   {
+ *     [id]: progressPercentage
+ *   }
+ *
+ * @example
+ * const progressMap = await getStartedOrCompletedProgressOnly({ brand: 'drumeo' });
+ * console.log(progressMap[123]); // => 52
+ */
+export async function getStartedOrCompletedProgressOnly({ brand = null} = {}) {
+  const data = await dataContext.getData()
+  const result = {}
+
+  Object.entries(data).forEach(([key, item]) => {
+    const id = parseInt(key)
+    const isRelevantStatus = item[DATA_KEY_STATUS] === STATE_STARTED || item[DATA_KEY_STATUS] === STATE_COMPLETED
+    const isCorrectBrand = !brand || item.b === brand
+
+    if (isRelevantStatus && isCorrectBrand) {
+      result[id] = item?.[DATA_KEY_PROGRESS] ?? 0
+    }
+  })
+
+  return result
+}
+
 export async function assignmentStatusCompleted(assignmentId, parentContentId) {
   await dataContext.update(
     async function (localContext) {

package/src/services/sanity.js

@@ -512,7 +512,7 @@ export async function fetchByRailContentId(id, contentType) {
  *   .then(contents => console.log(contents))
  *   .catch(error => console.error(error));
  */
-export async function fetchByRailContentIds(ids, contentType = undefined, brand= undefined) {
+export async function fetchByRailContentIds(ids, contentType = undefined, brand = undefined) {
   if (!ids) {
     return []
   }
@@ -888,11 +888,11 @@ async function getProgressFilter(progress, progressIds) {
       return `&& !(railcontent_id in [${ids.join(',')}])`
     }
     case 'recent': {
-      const ids = await getAllStartedOrCompleted()
+      const ids = progressIds !== undefined ? progressIds : await getAllStartedOrCompleted()
       return `&& (railcontent_id in [${ids.join(',')}])`
     }
     case 'incomplete': {
-      const ids = await getAllStarted()
+      const ids = progressIds !== undefined ? progressIds :await getAllStarted()
       return `&& railcontent_id in [${ids.join(',')}]`
     }
     default:
@@ -1320,7 +1320,7 @@ export async function fetchLessonContent(railContentId) {
   })
   const chapterProcess = (result) => {
     const now = getSanityDate(new Date(), false)
-    if(result.live_event_start_time && result.live_event_start_time){
+    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
     }
     const chapters = result.chapters ?? []
@@ -1336,15 +1336,23 @@ export async function fetchLessonContent(railContentId) {
 }
 
 /**
+ * Returns a list of recommended content based on the provided railContentId.
+ * If no recommendations found in recsys, falls back to fetching related lessons.
  *
  * @param railContentId
  * @param brand
  * @param count
- * @returns {Promise<Array<Object>|null>}
+ * @returns {Promise<Array<Object>>}
  */
 export async function fetchRelatedRecommendedContent(railContentId, brand, count = 10) {
   const recommendedItems = await fetchSimilarItems(railContentId, brand, count)
-  return fetchByRailContentIds(recommendedItems)
+  if (recommendedItems && recommendedItems.length > 0) {
+    return fetchByRailContentIds(recommendedItems)
+  }
+
+  return await fetchRelatedLessons(railContentId, brand).then((result) =>
+    result.related_lessons?.splice(0, count)
+  )
 }
 
 /**
@@ -1414,18 +1422,20 @@ async function fetchRelatedByLicense(railcontentId, brand, onlyUseSongTypes, cou
  */
 export async function fetchRelatedLessons(railContentId, brand) {
   const filterSameTypeAndSortOrder = await new FilterBuilder(
-    `_type==^._type &&  _type in ${JSON.stringify(typeWithSortOrder)} && brand == "${brand}" && railcontent_id !=${railContentId}`,
+    `_type==^._type &&  _type in ${JSON.stringify(typeWithSortOrder)} && brand == "${brand}" && railcontent_id !=${railContentId}`
   ).buildFilter()
   const filterSameType = await new FilterBuilder(
-    `_type==^._type && !(_type in ${JSON.stringify(typeWithSortOrder)}) && !(defined(parent_type)) && brand == "${brand}" && railcontent_id !=${railContentId}`,
+    `_type==^._type && !(_type in ${JSON.stringify(typeWithSortOrder)}) && !(defined(parent_type)) && brand == "${brand}" && railcontent_id !=${railContentId}`
   ).buildFilter()
   const filterSongSameArtist = await new FilterBuilder(
-    `_type=="song" && _type==^._type && brand == "${brand}" && references(^.artist->_id) && railcontent_id !=${railContentId}`,
+    `_type=="song" && _type==^._type && brand == "${brand}" && references(^.artist->_id) && railcontent_id !=${railContentId}`
   ).buildFilter()
   const filterSongSameGenre = await new FilterBuilder(
-    `_type=="song" && _type==^._type && brand == "${brand}" && references(^.genre[]->_id) && railcontent_id !=${railContentId}`,
+    `_type=="song" && _type==^._type && brand == "${brand}" && references(^.genre[]->_id) && railcontent_id !=${railContentId}`
   ).buildFilter()
-  const filterNeighbouringSiblings = await new FilterBuilder(`references(^._id)`, {pullFutureContent: true}).buildFilter()
+  const filterNeighbouringSiblings = await new FilterBuilder(`references(^._id)`, {
+    pullFutureContent: true,
+  }).buildFilter()
   const childrenFilter = await new FilterBuilder(``, { isChildrenFilter: true }).buildFilter()
   const queryFields = `_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail":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'
@@ -1446,15 +1456,15 @@ export async function fetchRelatedLessons(railContentId, brand) {
   let result = await fetchSanity(query, false)
 
   //there's no way in sanity to retrieve the index of an array, so we must calculate after fetch
-  if (result['for-calculations']['parents-list']) {
+  if (result['for-calculations'] && result['for-calculations']['parents-list']) {
     const calc = result['for-calculations']
     const parentCount = calc['parents-list'].length
-    const currentParent = (calc['parents-list'].indexOf(result['parent_id']) + 1)
+    const currentParent = calc['parents-list'].indexOf(result['parent_id']) + 1
     const siblingCount = calc['siblings-list'].length
-    const currentSibling = (calc['siblings-list'].indexOf(result['railcontent_id']) + 1)
+    const currentSibling = calc['siblings-list'].indexOf(result['railcontent_id']) + 1
 
     delete result['for-calculations']
-    result = {...result, parentCount, currentParent, siblingCount, currentSibling}
+    result = { ...result, parentCount, currentParent, siblingCount, currentSibling }
     return result
   } else {
     delete result['for-calculations']
@@ -1504,7 +1514,7 @@ export async function fetchPackAll(railcontentId, type = 'pack') {
 }
 
 export async function fetchLiveEvent(brand, forcedContentId = null) {
-  const LIVE_EXTRA_MINUTES = 30;
+  const LIVE_EXTRA_MINUTES = 30
   //calendarIDs taken from addevent.php
   // TODO import instructor calendars to Sanity
   let defaultCalendarID = ''
@@ -1526,8 +1536,10 @@ export async function fetchLiveEvent(brand, forcedContentId = null) {
   }
   let startDateTemp = new Date()
   let endDateTemp = new Date()
- 
-  startDateTemp = new Date(startDateTemp.setMinutes(startDateTemp.getMinutes() + LIVE_EXTRA_MINUTES))
+
+  startDateTemp = new Date(
+    startDateTemp.setMinutes(startDateTemp.getMinutes() + LIVE_EXTRA_MINUTES)
+  )
   endDateTemp = new Date(endDateTemp.setMinutes(endDateTemp.getMinutes() - LIVE_EXTRA_MINUTES))
 
   // See LiveStreamEventService.getCurrentOrNextLiveEvent for some nice complicated logic which I don't think is actually importart
@@ -2175,12 +2187,12 @@ async function buildQuery(
 function buildEntityAndTotalQuery(
   filter = '',
   fields = '...',
-  { sortOrder = 'published_on desc', start = 0, end = 10, isSingle = false }
+  { sortOrder = 'published_on desc', start = 0, end = 10, isSingle = false, withoutPagination = false }
 ) {
-  const sortString = sortOrder ? `order(${sortOrder})` : ''
-  const countString = isSingle ? '[0...1]' : `[${start}...${end}]`
+  const sortString = sortOrder ? ` | order(${sortOrder})` : ''
+  const countString = isSingle ? '[0...1]' : (withoutPagination ? ``: `[${start}...${end}]`)
   const query = `{
-      "entity": *[${filter}] | ${sortString}${countString}
+      "entity": *[${filter}]  ${sortString}${countString}
       {
         ${fields}
       },
@@ -2299,17 +2311,32 @@ export async function fetchTabData(
 ) {
   const start = (page - 1) * limit
   const end = start + limit
-
+  let withoutPagination = false
   // Construct the included fields filter, replacing 'difficulty' with 'difficulty_string'
   const includedFieldsFilter =
     includedFields.length > 0 ? filtersToGroq(includedFields, [], pageName) : ''
 
+  let sortOrder = getSortOrder(sort, brand, '')
+
+  switch (progress) {
+    case 'recent':
+      progressIds = await getAllStartedOrCompleted({ brand, onlyIds: true });
+      sortOrder = null;
+      withoutPagination = true;
+      break;
+    case 'incomplete':
+      progressIds = await getAllStarted();
+      sortOrder = null;
+      break;
+    case 'completed':
+      progressIds = await getAllCompleted();
+      sortOrder = null;
+      break;
+  }
+
   // limits the results to supplied progressIds for started & completed filters
   const progressFilter = await getProgressFilter(progress, progressIds)
 
-  // Determine the sort order
-  const sortOrder = getSortOrder(sort, brand, '')
-
   let fields = DEFAULT_FIELDS
   let fieldsString = fields.join(',')
 
@@ -2336,9 +2363,23 @@ export async function fetchTabData(
     sortOrder: sortOrder,
     start: start,
     end: end,
+    withoutPagination: withoutPagination,
   })
 
-  return fetchSanity(query, true)
+  let results = await fetchSanity(query, true);
+
+  if (['recent', 'incomplete', 'completed'].includes(progress) && results.entity.length > 1) {
+    const orderMap = new Map(progressIds.map((id, index) => [id, index]))
+    results.entity = results.entity
+      .sort((a, b) => {
+        const aIdx = orderMap.get(a.id) ?? Number.MAX_SAFE_INTEGER;
+        const bIdx = orderMap.get(b.id) ?? Number.MAX_SAFE_INTEGER;
+        return aIdx - bIdx || new Date(b.published_on) - new Date(a.published_on);
+      })
+      .slice(start, end);
+  }
+
+  return results;
 }
 
 export async function fetchRecent(
@@ -2394,17 +2435,13 @@ export async function fetchScheduledAndNewReleases(
   return fetchSanity(query, true)
 }
 
-export async function fetchShows(
-  brand,
-  type,
-  sort = 'sort'
-) {
+export async function fetchShows(brand, type, sort = 'sort') {
   const sortOrder = getSortOrder(sort, brand)
   const filter = `_type == '${type}'  && brand == '${brand}'`
   const filterParams = {}
 
   const query = await buildQuery(filter, filterParams, getFieldsForContentType(type), {
-    sortOrder: sortOrder
+    sortOrder: sortOrder,
   })
   return fetchSanity(query, true)
 }

package/src/services/user/notifications.js

@@ -12,6 +12,7 @@ const baseUrl = `/api/notifications`
  * @param {Object} [options={}] - Options for fetching notifications.
  * @param {string} options.brand - The brand to filter notifications by. (Required)
  * @param {number} [options.limit=10] - The maximum number of notifications to fetch.
+ * @param {number} [options.page=1] - The page number for pagination.
  * @param {boolean} [options.onlyUnread=false] - Whether to fetch only unread notifications. If true, adds `unread=1` to the query.
  *
  * @returns {Promise<Array<Object>>} - A promise that resolves to an array of notifications.
@@ -19,17 +20,17 @@ const baseUrl = `/api/notifications`
  * @throws {Error} - Throws an error if the brand is not provided.
  *
  * @example
- * fetchNotifications({ brand: 'drumeo', limit: 5, onlyUnread: true })
+ * fetchNotifications({ brand: 'drumeo', limit: 5, onlyUnread: true,  page: 2  })
  *   .then(notifications => console.log(notifications))
  *   .catch(error => console.error(error));
  */
-export async function fetchNotifications({ brand = null, limit = 10, onlyUnread = false } = {}) {
+export async function fetchNotifications({ brand = null, limit = 10, onlyUnread = false, page = 1 } = {}) {
   if (!brand) {
     throw new Error('brand is required')
   }
 
   const unreadParam = onlyUnread ? '&unread=1' : ''
-  const url = `${baseUrl}/v1?brand=${brand}${unreadParam}&limit=${limit}`
+  const url = `${baseUrl}/v1?brand=${brand}${unreadParam}&limit=${limit}&page=${page}`
   return fetchHandler(url, 'get')
 }