musora-content-services 2.11.1 → 2.13.0

package/.github/workflows/docs.js.yml

@@ -0,0 +1,61 @@
+name: Sync V2 Docs to Main
+on:
+  push:
+    branches: [project-v2]
+
+jobs:
+  sync-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout project-v2 branch
+        uses: actions/checkout@v4
+        with:
+          ref: project-v2
+          path: project-v2-content
+
+      - name: Checkout main branch
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          path: main-content
+          token: ${{ secrets.PROJECT_V2_DOCS_TOKEN }}  #use separate token to trigger other actions
+
+      - name: Copy docs from project-v2 to main
+        run: |
+          # Create the target directory if it doesn't exist
+          mkdir -p main-content/docs/v2
+
+          # Remove existing v2 docs to ensure clean copy
+          rm -rf main-content/docs/v2/*
+
+          # Copy docs from project-v2 to main/docs/v2
+          if [ -d "project-v2-content/docs" ]; then
+            cp -r project-v2-content/docs/* main-content/docs/v2/
+            echo "✅ Copied docs from project-v2 to main/docs/v2"
+          else
+            echo "⚠️ No docs folder found in project-v2 branch"
+            exit 1
+          fi
+
+      - name: Commit and push changes to main
+        id: commit
+        run: |
+          cd main-content
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+
+          # Check if there are any changes
+          if [ -n "$(git status --porcelain)" ]; then
+            git add docs/v2/
+            git commit -m "🔄 Auto-sync: Update v2 docs from project-v2 branch
+
+            - Synced from project-v2/docs
+            - Triggered by commit: ${{ github.sha }}
+            - Date: $(date)"
+            git push
+            echo "✅ Successfully pushed updated docs to main branch"
+            echo "changes=true" >> $GITHUB_OUTPUT
+          else
+            echo "ℹ️ No changes detected in docs"
+            echo "changes=false" >> $GITHUB_OUTPUT
+          fi

package/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 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.13.0](https://github.com/railroadmedia/musora-content-services/compare/v2.12.0...v2.13.0) (2025-06-26)
+
+
+### Features
+
+* add logo data to parent in fetchLessonContent ([5c924b6](https://github.com/railroadmedia/musora-content-services/commit/5c924b6ad770d9befc0d5a972d0333840e8c5c83))
+
+## [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/package.json

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

package/src/contentTypeConfig.js

@@ -426,8 +426,8 @@ export let contentTypeConfig = {
             }`,
       `"resources": ${resourcesField}`,
       '"thumbnail": thumbnail.asset->url',
-      '"light_logo": light_mode_logo_url.asset->url',
-      '"dark_logo": dark_mode_logo_url.asset->url',
+      '"light_mode_logo": light_mode_logo_url.asset->url',
+      '"dark_mode_logo": dark_mode_logo_url.asset->url',
       `"description": ${descriptionField}`,
     ],
   },
@@ -449,8 +449,8 @@ export let contentTypeConfig = {
       `"resources": ${resourcesField}`,
       '"image": logo_image_url.asset->url',
       '"thumbnail": thumbnail.asset->url',
-      '"light_logo": light_mode_logo_url.asset->url',
-      '"dark_logo": dark_mode_logo_url.asset->url',
+      '"light_mode_logo": light_mode_logo_url.asset->url',
+      '"dark_mode_logo": dark_mode_logo_url.asset->url',
       `"description": ${descriptionField}`,
       'total_xp',
     ],

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

@@ -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:
@@ -1269,7 +1269,6 @@ export async function fetchLessonContent(railContentId) {
           "id":railcontent_id,
           slug, artist->,
           "thumbnail":thumbnail.asset->url,
-          "url": web_url_path,
           soundslice_slug,
           "description": description[0].children[0].text,
           "chapters": chapter[]{
@@ -1299,9 +1298,11 @@ export async function fetchLessonContent(railContentId) {
           "parent_content_data": parent_content_data[]{
             "id": id,
             "title": *[railcontent_id == ^.id][0].title,
-            "web_url_path": *[railcontent_id == ^.id][0].web_url_path,
             "slug":*[railcontent_id == ^.id][0].slug,
             "type": *[railcontent_id == ^.id][0]._type,
+            "logo" : *[railcontent_id == ^.id][0].logo_image_url.asset->url,
+            "dark_mode_logo": *[railcontent_id == ^.id][0].dark_mode_logo_url.asset->url,
+            "light_mode_logo": *[railcontent_id == ^.id][0].light_mode_logo_url.asset->url,
           },
           sort,
           xp,
@@ -2187,12 +2188,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}
       },
@@ -2311,17 +2312,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(',')
 
@@ -2348,9 +2364,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(

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')
 }