musora-content-services 2.3.15 → 2.3.16

package/.github/pull_request_template.md

@@ -0,0 +1,19 @@
+## Jira Ticket(s)/RelatedPR(s)
+
+- _Provide link to Jira tickets or other connected PRs_
+
+## Description/Design
+
+- _Provide a brief description of your changes. The context of why you made changes is more important than the what._
+
+## Testing
+
+- _How can this be verified?_
+- _Setup required_
+- _what page(s) are applicable_
+- _what action(s) should a user take_
+- _what is the expected outcome?_
+
+## Additional Notes
+
+- _Provide any additional context or notes that might be helpful for the reviewer._

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 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.3.16](https://github.com/railroadmedia/musora-content-services/compare/v2.3.15...v2.3.16) (2025-04-22)
+
 ### [2.3.15](https://github.com/railroadmedia/musora-content-services/compare/v2.3.14...v2.3.15) (2025-04-11)
 
 ### [2.3.14](https://github.com/railroadmedia/musora-content-services/compare/v2.3.13...v2.3.14) (2025-04-11)

package/package.json

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

package/src/contentAggregator.js

@@ -0,0 +1,57 @@
+import { getProgressStateByIds, getProgressPercentageByIds, getResumeTimeSecondsByIds } from "./services/contentProgress" 
+import { isContentLikedByIds } from "./services/contentLikes"
+import { fetchLikeCount } from "./services/railcontent"
+
+export const addContextToContent = async (dataPromise, ...dataArgs) => {
+  const lastArg = dataArgs[dataArgs.length - 1]
+  const options = typeof lastArg === 'object' && !Array.isArray(lastArg) ? lastArg : {}
+
+  const {
+    dataField = null,
+    addProgressPercentage = false,
+    addIsLiked = false,
+    addLikeCount = false,
+    addStatus = false,
+    addResumeTimeSeconds = false
+  } = options
+
+  const dataParam = lastArg === options ? dataArgs.slice(0, -1) : dataArgs
+
+  const data = await dataPromise(...dataParam)
+  if(!data) return false
+
+  let ids = []
+
+  if (dataField && data?.[dataField]) {
+    ids = data[dataField].map(item => item?.id).filter(Boolean);
+  } else if (Array.isArray(data)) {
+    ids = data.map(item => item?.id).filter(Boolean);
+  } else if (data?.id) {
+    ids = [data.id]
+  }
+
+  if(ids.length === 0) return false
+
+  const [progressPercentageData, statusData, isLikedData, resumeTimeData] = await Promise.all([
+    addProgressPercentage ? getProgressPercentageByIds(ids) : Promise.resolve(null),
+    addStatus ? getProgressStateByIds(ids) : Promise.resolve(null),
+    addIsLiked ? isContentLikedByIds(ids) : Promise.resolve(null),
+    addResumeTimeSeconds ? getResumeTimeSecondsByIds(ids) : Promise.resolve(null),
+  ])
+
+  const addContext = async (item) => ({
+    ...item,
+    ...(addProgressPercentage ? { progressPercentage: progressPercentageData?.[item.id] } : {}),
+    ...(addStatus ? { progressStatus: statusData?.[item.id] } : {}),
+    ...(addIsLiked ? { isLiked: isLikedData?.[item.id] } : {}),
+    ...(addLikeCount && ids.length === 1 ? { likeCount: await fetchLikeCount(item.id) } : {}),
+    ...(addResumeTimeSeconds ? { resumeTime: resumeTimeData?.[item.id] } : {}),
+  })
+  
+  const newData = Array.isArray(data)
+  ? await Promise.all(data.map(addContext))
+  : await addContext(data)
+
+  return newData
+}
+

package/src/index.d.ts

@@ -137,6 +137,7 @@ import {
 	postContentUnliked,
 	postRecordWatchSession,
 	replyToComment,
+	reportComment,
 	reportPlaylist,
 	setStudentViewForUser,
 	unassignModeratorToComment,
@@ -235,8 +236,11 @@ import {
 	updateUserPractice
 } from './services/userActivity.js';
 
+import { addContextToContent } from './contentAggregator.js';
+
 declare module 'musora-content-services' {
 	export {
+		addContextToContent,
 		addItemToPlaylist,
 		applyCloudflareWrapper,
 		applySanityTransformations,
@@ -402,6 +406,7 @@ declare module 'musora-content-services' {
 		recordWatchSession,
 		removeUserPractice,
 		replyToComment,
+		reportComment,
 		reportPlaylist,
 		reset,
 		restorePracticeSession,

package/src/index.js

@@ -137,6 +137,7 @@ import {
 	postContentUnliked,
 	postRecordWatchSession,
 	replyToComment,
+	reportComment,
 	reportPlaylist,
 	setStudentViewForUser,
 	unassignModeratorToComment,
@@ -235,7 +236,10 @@ import {
 	updateUserPractice
 } from './services/userActivity.js';
 
+import { addContextToContent } from './contentAggregator.js';
+
 export {
+	addContextToContent,
 	addItemToPlaylist,
 	applyCloudflareWrapper,
 	applySanityTransformations,
@@ -401,6 +405,7 @@ export {
 	recordWatchSession,
 	removeUserPractice,
 	replyToComment,
+	reportComment,
 	reportPlaylist,
 	reset,
 	restorePracticeSession,

package/src/services/contentLikes.js

@@ -16,6 +16,15 @@ export async function isContentLiked(contentId) {
   return data.includes(contentId)
 }
 
+export async function isContentLikedByIds(contentIds) {
+  const data = await dataContext.getData()
+  const likes = {}
+
+  contentIds?.forEach((id) => (likes[id] = data.includes(id)))
+
+  return likes
+}
+
 export async function likeContent(contentId) {
   contentId = parseInt(contentId)
   await dataContext.update(

package/src/services/contentProgress.js

@@ -16,30 +16,38 @@ const DATA_KEY_LAST_UPDATED_TIME = 'u'
 export let dataContext = new DataContext(ContentProgressVersionKey, fetchContentProgress)
 
 export async function getProgressPercentage(contentId) {
-  let data = await dataContext.getData()
-  return data[contentId]?.[DATA_KEY_PROGRESS] ?? 0
+  return getById(contentIds, DATA_KEY_PROGRESS, 0)
 }
 
 export async function getProgressPercentageByIds(contentIds) {
-  const data = await dataContext.getData()
-  let progress = {}
-
-  contentIds?.forEach((id) => (progress[id] = data[id]?.[DATA_KEY_PROGRESS] ?? 0))
-
-  return progress
+  return getByIds(contentIds, DATA_KEY_PROGRESS, 0)
 }
 
 export async function getProgressState(contentId) {
-  let data = await dataContext.getData()
-  return data[contentId]?.[DATA_KEY_STATUS] ?? ''
+  return getById(contentId, DATA_KEY_STATUS, '')
 }
 
 export async function getProgressStateByIds(contentIds) {
-  const data = await dataContext.getData()
-  let progress = {}
+  return getByIds(contentIds, DATA_KEY_STATUS, '')
+}
 
-  contentIds?.forEach((id) => (progress[id] = data[id]?.[DATA_KEY_STATUS] ?? ''))
+export async function getResumeTimeSeconds(contentId) {
+  return getById(contentId, DATA_KEY_RESUME_TIME, 0)
+}
 
+export async function getResumeTimeSecondsByIds(contentIds) {
+  return getByIds(contentIds, DATA_KEY_RESUME_TIME, 0)
+}
+
+async function getById(contentId, dataKey, defaultValue) {
+  let data = await dataContext.getData()
+  return data[contentId]?.[dataKey] ?? defaultValue
+}
+
+async function getByIds(contentIds, dataKey, defaultValue) {
+  let data = await dataContext.getData()
+  let progress = {}
+  contentIds?.forEach((id) => (progress[id] = data[id]?.[dataKey] ?? defaultValue))
   return progress
 }
 
@@ -112,11 +120,6 @@ export async function getAllStartedOrCompleted(limit = null) {
   return ids
 }
 
-export async function getResumeTimeSeconds(contentId) {
-  let data = await dataContext.getData()
-  return data[contentId]?.[DATA_KEY_RESUME_TIME] ?? 0
-}
-
 export async function assignmentStatusCompleted(assignmentId, parentContentId) {
   await dataContext.update(
     async function (localContext) {

package/src/services/railcontent.js

@@ -294,6 +294,11 @@ async function deleteDataHandler(url, data) {
   return fetchHandler(url, 'delete')
 }
 
+export async function fetchLikeCount(contendId){
+  const url  = `/api/content/v1/content/like_count/${contendId}`
+  return await fetchDataHandler(url)
+}
+
 export async function fetchUserLikes(currentVersion) {
   let url = `/api/content/v1/user/likes`
   return fetchDataHandler(url, currentVersion)
@@ -1175,6 +1180,19 @@ export async function editComment(commentId, comment) {
   return await patchDataHandler(url, data)
 }
 
+/**
+ * @param {int} commentId
+ * @param {string} issue
+ * @returns {Promise<*|null>}
+ */
+export async function reportComment(commentId, issue) {
+  const url = `/api/content/v1/comments/${commentId}/report`
+  const data = {
+    issue: issue,
+  }
+  return await postDataHandler(url, data)
+}
+
 export async function fetchUserPractices(currentVersion) {
   const url = `/api/user/practices/v1/practices`;
   const response = await fetchDataHandler(url, currentVersion);