musora-content-services 1.3.15 → 1.3.17

package/.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+  "emeraldwalk.runonsave": {
+    "commands": [
+      {
+        "cmd": "cp -r ~/Workspace/musora/musora-content-services/src ~/Workspace/musora/MusoraApp/node_modules/musora-content-services; cp ~/Workspace/musora/musora-content-services/index.d.ts ~/Workspace/musora/MusoraApp/node_modules/musora-content-services"
+      }
+    ]
+  }
+}

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 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.
 
+### [1.3.17](https://github.com/railroadmedia/musora-content-services/compare/v1.3.16...v1.3.17) (2025-03-17)
+
+### [1.3.16](https://github.com/railroadmedia/musora-content-services/compare/v1.3.15...v1.3.16) (2025-03-14)
+
 ### [1.3.15](https://github.com/railroadmedia/musora-content-services/compare/v1.3.14...v1.3.15) (2025-03-10)
 
 ### [1.3.14](https://github.com/railroadmedia/musora-content-services/compare/v1.3.13...v1.3.14) (2025-03-06)

package/package.json

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

package/src/index.d.ts

@@ -38,12 +38,17 @@ import {
 
 import {
 	addItemToPlaylist,
+	assignModeratorToComment,
+	closeComment,
 	countAssignmentsAndLessons,
+	createComment,
 	createPlaylist,
+	deleteComment,
 	deletePlaylist,
 	deletePlaylistItem,
 	deletePlaylistLike,
 	duplicatePlaylist,
+	editComment,
 	fetchAllCompletedStates,
 	fetchCarouselCardData,
 	fetchChallengeIndexMetadata,
@@ -73,7 +78,9 @@ import {
 	fetchUserLikes,
 	fetchUserPermissionsData,
 	fetchUserPlaylists,
+	likeComment,
 	likePlaylist,
+	openComment,
 	pinPlaylist,
 	playback,
 	postChallengesCommunityNotification,
@@ -90,8 +97,11 @@ import {
 	postContentReset,
 	postContentUnliked,
 	postRecordWatchSession,
+	replyToComment,
 	reportPlaylist,
 	setStudentViewForUser,
+	unassignModeratorToComment,
+	unlikeComment,
 	unpinPlaylist,
 	updatePlaylist,
 	updatePlaylistItem
@@ -155,16 +165,21 @@ import {
 declare module 'musora-content-services' {
 	export {
 		addItemToPlaylist,
+		assignModeratorToComment,
 		assignmentStatusCompleted,
 		assignmentStatusReset,
+		closeComment,
 		contentStatusCompleted,
 		contentStatusReset,
 		countAssignmentsAndLessons,
+		createComment,
 		createPlaylist,
+		deleteComment,
 		deletePlaylist,
 		deletePlaylistItem,
 		deletePlaylistLike,
 		duplicatePlaylist,
+		editComment,
 		fetchAll,
 		fetchAllCompletedStates,
 		fetchAllFilterOptions,
@@ -247,8 +262,10 @@ declare module 'musora-content-services' {
 		initializeService,
 		isContentLiked,
 		jumpToContinueContent,
+		likeComment,
 		likeContent,
 		likePlaylist,
+		openComment,
 		pinPlaylist,
 		playback,
 		postChallengesCommunityNotification,
@@ -268,11 +285,14 @@ declare module 'musora-content-services' {
 		rankCategories,
 		rankItems,
 		recordWatchSession,
+		replyToComment,
 		reportPlaylist,
 		reset,
 		setLastUpdatedTime,
 		setStudentViewForUser,
 		similarItems,
+		unassignModeratorToComment,
+		unlikeComment,
 		unlikeContent,
 		unpinPlaylist,
 		updatePlaylist,

package/src/index.js

@@ -38,12 +38,17 @@ import {
 
 import {
 	addItemToPlaylist,
+	assignModeratorToComment,
+	closeComment,
 	countAssignmentsAndLessons,
+	createComment,
 	createPlaylist,
+	deleteComment,
 	deletePlaylist,
 	deletePlaylistItem,
 	deletePlaylistLike,
 	duplicatePlaylist,
+	editComment,
 	fetchAllCompletedStates,
 	fetchCarouselCardData,
 	fetchChallengeIndexMetadata,
@@ -73,7 +78,9 @@ import {
 	fetchUserLikes,
 	fetchUserPermissionsData,
 	fetchUserPlaylists,
+	likeComment,
 	likePlaylist,
+	openComment,
 	pinPlaylist,
 	playback,
 	postChallengesCommunityNotification,
@@ -90,8 +97,11 @@ import {
 	postContentReset,
 	postContentUnliked,
 	postRecordWatchSession,
+	replyToComment,
 	reportPlaylist,
 	setStudentViewForUser,
+	unassignModeratorToComment,
+	unlikeComment,
 	unpinPlaylist,
 	updatePlaylist,
 	updatePlaylistItem
@@ -154,16 +164,21 @@ import {
 
 export {
 	addItemToPlaylist,
+	assignModeratorToComment,
 	assignmentStatusCompleted,
 	assignmentStatusReset,
+	closeComment,
 	contentStatusCompleted,
 	contentStatusReset,
 	countAssignmentsAndLessons,
+	createComment,
 	createPlaylist,
+	deleteComment,
 	deletePlaylist,
 	deletePlaylistItem,
 	deletePlaylistLike,
 	duplicatePlaylist,
+	editComment,
 	fetchAll,
 	fetchAllCompletedStates,
 	fetchAllFilterOptions,
@@ -246,8 +261,10 @@ export {
 	initializeService,
 	isContentLiked,
 	jumpToContinueContent,
+	likeComment,
 	likeContent,
 	likePlaylist,
+	openComment,
 	pinPlaylist,
 	playback,
 	postChallengesCommunityNotification,
@@ -267,11 +284,14 @@ export {
 	rankCategories,
 	rankItems,
 	recordWatchSession,
+	replyToComment,
 	reportPlaylist,
 	reset,
 	setLastUpdatedTime,
 	setStudentViewForUser,
 	similarItems,
+	unassignModeratorToComment,
+	unlikeComment,
 	unlikeContent,
 	unpinPlaylist,
 	updatePlaylist,

package/src/services/railcontent.js

@@ -290,6 +290,10 @@ async function patchDataHandler(url, data) {
   return fetchHandler(url, 'patch', null, data)
 }
 
+async function deleteDataHandler(url, data) {
+  return fetchHandler(url, 'delete')
+}
+
 export async function fetchHandler(url, method = 'get', dataVersion = null, body = null) {
   let headers = {
     'Content-Type': 'application/json',
@@ -1206,28 +1210,28 @@ export async function setStudentViewForUser(userId, enable) {
  * @returns {Promise<Object|null>} - A promise that resolves to an comment object
  */
 export async function fetchTopComment(railcontentId) {
-  const url = `/api/content/v1/comments/${railcontentId}/top`
+  const url = `/api/content/v1/comments/content/${railcontentId}/top`
   return await fetchHandler(url)
 }
 
 
 /**
  *
- * @param railcontentId
- * @param page
- * @param limit
+ * @param {int} railcontentId
+ * @param {int} page
+ * @param {int} limit
  * @returns {Promise<*|null>}
  */
 export async function fetchComments(railcontentId, page = 1, limit = 20) {
-  const url = `/api/content/v1/comments/${railcontentId}/all?page=${page}&limit=${limit}`
+  const url = `/api/content/v1/comments/content/${railcontentId}/all?page=${page}&limit=${limit}`
   return await fetchHandler(url)
 }
 
 /**
  *
- * @param commentId
- * @param page
- * @param limit
+ * @param {int} commentId
+ * @param {int} page
+ * @param {int} limit
  * @returns {Promise<*|null>}
  */
 export async function fetchCommentRelies(commentId, page = 1, limit = 20) {
@@ -1235,6 +1239,115 @@ export async function fetchCommentRelies(commentId, page = 1, limit = 20) {
   return await fetchHandler(url)
 }
 
+/**
+ * @param {int} commentId
+ * @returns {Promise<*|null>}
+ */
+export async function deleteComment(commentId) {
+  const url = `/api/content/v1/comments/${commentId}`
+  return await fetchHandler(url, "DELETE")
+}
+
+/**
+ * @param {int} commentId
+ * @param {string} comment
+ * @returns {Promise<*|null>}
+ */
+export async function replyToComment(commentId, comment) {
+  const data = {'comment' : comment}
+  const url = `/api/content/v1/comments/${commentId}/reply`
+  return await postDataHandler(url, data)
+}
+
+/**
+ * @param {int} railcontentId
+ * @param {string} comment
+ * @returns {Promise<*|null>}
+ */
+export async function createComment(railcontentId, comment) {
+  const data = {
+    'comment' : comment,
+    'content_id' : railcontentId
+  }
+  const url = `/api/content/v1/comments/store`
+  return await postDataHandler(url, data)
+}
+
+/**
+ * @param {int} commentId
+ * @returns {Promise<*|null>}
+ */
+export async function assignModeratorToComment(commentId) {
+  const url = `/api/content/v1/comments/${commentId}/assign_moderator`
+  return await postDataHandler(url)
+}
+
+/**
+ * @param {int} commentId
+ * @returns {Promise<*|null>}
+ */
+export async function unassignModeratorToComment(commentId) {
+  const url = `/api/content/v1/comments/${commentId}/unassign_moderator`
+  return await postDataHandler(url)
+}
+
+/**
+ * @param {int} commentId
+ * @returns {Promise<*|null>}
+ */
+export async function likeComment(commentId) {
+  const url = `/api/content/v1/comments/${commentId}/like`
+  return await postDataHandler(url)
+}
+
+/**
+ * @param {int} commentId
+ * @returns {Promise<*|null>}
+ */
+export async function unlikeComment(commentId) {
+  const url = `/api/content/v1/comments/${commentId}/like`
+  return await deleteDataHandler(url)
+}
+
+/**
+ * @param {int} commentId
+ * @returns {Promise<*|null>}
+ */
+export async function closeComment(commentId) {
+  const url = `/api/content/v1/comments/${commentId}`
+  const data = {
+    'conversation_status' : 'closed'
+  }
+  return await patchDataHandler(url, data)
+}
+
+/**
+ * @param {int} commentId
+ * @returns {Promise<*|null>}
+ */
+export async function openComment(commentId) {
+  const url = `/api/content/v1/comments/${commentId}`
+  const data = {
+    'conversation_status' : 'open'
+  }
+  return await patchDataHandler(url, data)
+}
+
+/**
+ * @param {int} commentId
+ * @param {string} comment
+ * @returns {Promise<*|null>}
+ */
+export async function editComment(commentId, comment) {
+  const url = `/api/content/v1/comments/${commentId}`
+  const data = {
+    'comment' : comment
+  }
+  return await patchDataHandler(url, data)
+}
+
+
+
 function fetchAbsolute(url, params) {
   if (globalConfig.railcontentConfig.authToken) {
     params.headers['Authorization'] = `Bearer ${globalConfig.railcontentConfig.authToken}`

package/src/services/recommendations.js

@@ -48,8 +48,7 @@ export async function similarItems(brand, content_id, count = 10) {
  *
  * @param {brand} brand - brand of the content to filter
  * @param {Object} categories - Keyed arrays of content ids
- * @param {boolean} rankEachCategory - flag to sort each category by user's match
- * @returns {Promise<Object|null>} - Returns the content_ids sorted by rank (most significant first)
+ * @returns {Promise<Object|null>} - Returns the content_ids sorted by rank (most significant first), elements in each category are also ranked
  * @example
  * rankCategories('drumeo', {
  *                            1: [111222, 23120, 402199],
@@ -59,7 +58,7 @@ export async function similarItems(brand, content_id, count = 10) {
  *   .then(status => console.log(status))
  *   .catch(error => console.error(error));
  */
-export async function rankCategories(brand, categories, rankEachCategory = true) {
+export async function rankCategories(brand, categories) {
   if (categories.length === 0) {
     return []
   }
@@ -67,9 +66,8 @@ export async function rankCategories(brand, categories, rankEachCategory = true)
     'brand': brand,
     'user_id': globalConfig.railcontentConfig.userId,
     'playlists': categories,
-    'rank_each_list': Boolean(rankEachCategory),
   }
-  const url = `/rank_playlists/`
+  const url = `/rank_each_list/`
   try {
     const response = await fetchHandler(url, 'POST', data)
     let rankedCategories = {}

package/src/services/sanity.js

@@ -1297,15 +1297,16 @@ export async function fetchRelatedLessons(railContentId, brand) {
   ).buildFilter()
   const filterNeighbouringSiblings = await new FilterBuilder(`references(^._id)`).buildFilter()
   const childrenFilter = await new FilterBuilder(``, { isChildrenFilter: true }).buildFilter()
-
+  const queryFields = `_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":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'
   const query = `*[railcontent_id == ${railContentId} && brand == "${brand}" && (!defined(permission) || references(*[_type=='permission']._id))]{
    _type, parent_type, railcontent_id,
     "related_lessons" : array::unique([
-      ...(*[${filterNeighbouringSiblings}][0].child[${childrenFilter}]->{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}),
-      ...(*[${filterSongSameArtist}]{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}|order(published_on desc, title asc)[0...10]),
-      ...(*[${filterSongSameGenre}]{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}|order(published_on desc, title asc)[0...10]),
-      ...(*[${filterSameTypeAndSortOrder}]{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type, sort}|order(sort asc, title asc)[0...10]),
-      ...(*[${filterSameType}]{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}|order(published_on desc, title asc)[0...10])
+      ...(*[${filterNeighbouringSiblings}][0].child[${childrenFilter}]->{${queryFields}}),
+      ...(*[${filterSongSameArtist}]{${queryFields}}|order(published_on desc, title asc)[0...10]),
+      ...(*[${filterSongSameGenre}]{${queryFields}}|order(published_on desc, title asc)[0...10]),
+      ...(*[${filterSameTypeAndSortOrder}]{${queryFieldsWithSort}}|order(sort asc, title asc)[0...10]),
+      ...(*[${filterSameType}]{${queryFields}}|order(published_on desc, title asc)[0...10])
       ,
       ])[0...10]}`
   return fetchSanity(query, false)