musora-content-services 1.3.14 → 1.3.15

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.
 
+### [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)
 
 ### [1.3.13](https://github.com/railroadmedia/musora-content-services/compare/v1.3.12...v1.3.13) (2025-03-06)

package/package.json

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

package/src/index.d.ts

@@ -50,6 +50,8 @@ import {
 	fetchChallengeLessonData,
 	fetchChallengeMetadata,
 	fetchChallengeUserActiveChallenges,
+	fetchCommentRelies,
+	fetchComments,
 	fetchCompletedChallenges,
 	fetchCompletedContent,
 	fetchCompletedState,
@@ -64,6 +66,7 @@ import {
 	fetchPlaylistItem,
 	fetchPlaylistItems,
 	fetchSongsInProgress,
+	fetchTopComment,
 	fetchUserAward,
 	fetchUserBadges,
 	fetchUserChallengeProgress,
@@ -94,6 +97,12 @@ import {
 	updatePlaylistItem
 } from './services/railcontent.js';
 
+import {
+	rankCategories,
+	rankItems,
+	similarItems
+} from './services/recommendations.js';
+
 import {
 	fetchAll,
 	fetchAllFilterOptions,
@@ -174,6 +183,8 @@ declare module 'musora-content-services' {
 		fetchCoachLessons,
 		fetchComingSoon,
 		fetchCommentModContentData,
+		fetchCommentRelies,
+		fetchComments,
 		fetchCompletedChallenges,
 		fetchCompletedContent,
 		fetchCompletedState,
@@ -213,6 +224,7 @@ declare module 'musora-content-services' {
 		fetchSongArtistCount,
 		fetchSongById,
 		fetchSongsInProgress,
+		fetchTopComment,
 		fetchTopLevelParentId,
 		fetchUpcomingEvents,
 		fetchUserAward,
@@ -253,11 +265,14 @@ declare module 'musora-content-services' {
 		postContentReset,
 		postContentUnliked,
 		postRecordWatchSession,
+		rankCategories,
+		rankItems,
 		recordWatchSession,
 		reportPlaylist,
 		reset,
 		setLastUpdatedTime,
 		setStudentViewForUser,
+		similarItems,
 		unlikeContent,
 		unpinPlaylist,
 		updatePlaylist,

package/src/index.js

@@ -50,6 +50,8 @@ import {
 	fetchChallengeLessonData,
 	fetchChallengeMetadata,
 	fetchChallengeUserActiveChallenges,
+	fetchCommentRelies,
+	fetchComments,
 	fetchCompletedChallenges,
 	fetchCompletedContent,
 	fetchCompletedState,
@@ -64,6 +66,7 @@ import {
 	fetchPlaylistItem,
 	fetchPlaylistItems,
 	fetchSongsInProgress,
+	fetchTopComment,
 	fetchUserAward,
 	fetchUserBadges,
 	fetchUserChallengeProgress,
@@ -94,6 +97,12 @@ import {
 	updatePlaylistItem
 } from './services/railcontent.js';
 
+import {
+	rankCategories,
+	rankItems,
+	similarItems
+} from './services/recommendations.js';
+
 import {
 	fetchAll,
 	fetchAllFilterOptions,
@@ -173,6 +182,8 @@ export {
 	fetchCoachLessons,
 	fetchComingSoon,
 	fetchCommentModContentData,
+	fetchCommentRelies,
+	fetchComments,
 	fetchCompletedChallenges,
 	fetchCompletedContent,
 	fetchCompletedState,
@@ -212,6 +223,7 @@ export {
 	fetchSongArtistCount,
 	fetchSongById,
 	fetchSongsInProgress,
+	fetchTopComment,
 	fetchTopLevelParentId,
 	fetchUpcomingEvents,
 	fetchUserAward,
@@ -252,11 +264,14 @@ export {
 	postContentReset,
 	postContentUnliked,
 	postRecordWatchSession,
+	rankCategories,
+	rankItems,
 	recordWatchSession,
 	reportPlaylist,
 	reset,
 	setLastUpdatedTime,
 	setStudentViewForUser,
+	similarItems,
 	unlikeContent,
 	unpinPlaylist,
 	updatePlaylist,

package/src/services/config.js

@@ -5,6 +5,7 @@
 export let globalConfig = {
   sanityConfig: {},
   railcontentConfig: {},
+  recommendationsConfig: {},
   localStorage: null,
   isMA: false,
   localTimezoneString: null, // In format: America/Vancouver
@@ -35,6 +36,8 @@ const excludeFromGeneratedIndex = []
  * @param {string} config.railcontentConfig.userId - The user ID for fetching user-specific data.
  * @param {string} config.railcontentConfig.baseUrl - The url for the environment.
  * @param {string} config.railcontentConfig.authToken - The bearer authorization token.
+ * @param {string} config.recommendationsConfig.token - The token for authenticating recommendation requests.
+ * @param {string} config.recommendationsConfig.baseUrl - The url for the recommendation server.
  * @param {Object} config.localStorage - Cache to use for localStorage
  * @param {boolean} config.isMA - Variable that tells if the library is used by MA or FEW
  * @param {string} config.localTimezoneString - The local timezone string in format: America/Vancouver
@@ -49,15 +52,20 @@ const excludeFromGeneratedIndex = []
  *     dataset: 'your-dataset-name',
  *     version: '2021-06-07',
  *     debug: true,
- *     useCachedAPI: false
+ *     useCachedAPI: false,
  *   },
  *   railcontentConfig: {
  *     token: 'your-user-api-token',
  *     userId: 'current-user-id',
- *     baseUrl: 'https://web-staging-one.musora.com'
+ *     baseUrl: 'https://web-staging-one.musora.com',
+ *     authToken 'your-auth-token',
+ *   },
+ *   recommendationsConfig: {
+ *     token: 'your-user-api-token',
+ *     baseUrl: 'https://MusoraProductDepartment-PWGenerator.hf.space',
  *   },
  *   localStorage: localStorage,
- *   isMA: false
+ *   isMA: false,
  * });
  */
 export function initializeService(config) {
@@ -66,4 +74,5 @@ export function initializeService(config) {
   globalConfig.localStorage = config.localStorage
   globalConfig.isMA = config.isMA || false
   globalConfig.localTimezoneString = config.localTimezoneString || null
+  globalConfig.recommendationsConfig = config.recommendationsConfig
 }

package/src/services/recommendations.js

@@ -0,0 +1,155 @@
+/**
+ * @module Railcontent-Services
+ */
+
+import { globalConfig } from './config.js'
+
+/**
+ * Exported functions that are excluded from index generation.
+ *
+ * @type {string[]}
+ */
+const excludeFromGeneratedIndex = []
+
+/**
+ * Fetches similar content to the provided content id
+ *
+ * @param {brand} brand - brand of the content to filter
+ * @param {integer} content_id - The ID of the content to find similar items for
+ * @param {integer} count - number of items to return
+ * @returns {Promise<Object|null>} - Returns the content_ids sorted by rank (most significant first)
+ * @example
+ * rankItems('drumeo', 1113)
+ *   .then(status => console.log(status))
+ *   .catch(error => console.error(error));
+ */
+export async function similarItems(brand, content_id, count = 10) {
+  if (!content_id) {
+    return []
+  }
+
+  let data = {
+    'brand': brand,
+    'content_ids': content_id,
+    'num_similar': count,
+  }
+  const url = `/similar_items/`
+  try {
+    const response = await fetchHandler(url, 'POST', data)
+    return response['similar_items']
+  } catch (error) {
+    console.error('Fetch error:', error)
+    return null
+  }
+}
+
+/**
+ * Sorts the provided categories based on the user's match
+ *
+ * @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)
+ * @example
+ * rankCategories('drumeo', {
+ *                            1: [111222, 23120, 402199],
+ *                            2: [2222, 33333, 44444]
+ *                          }
+ *                )
+ *   .then(status => console.log(status))
+ *   .catch(error => console.error(error));
+ */
+export async function rankCategories(brand, categories, rankEachCategory = true) {
+  if (categories.length === 0) {
+    return []
+  }
+  let data = {
+    'brand': brand,
+    'user_id': globalConfig.railcontentConfig.userId,
+    'playlists': categories,
+    'rank_each_list': Boolean(rankEachCategory),
+  }
+  const url = `/rank_playlists/`
+  try {
+    const response = await fetchHandler(url, 'POST', data)
+    let rankedCategories = {}
+    response['ranked_playlists'].forEach((category) => rankedCategories[category['playlist_id']] = categories[category['playlist_id']])
+    return rankedCategories
+  } catch (error) {
+    console.error('Fetch error:', error)
+    return null
+  }
+}
+
+/**
+ * Fetches the completion status of a specific lesson for the current user.
+ *
+ * @param {brand} brand - brand of the content to filter
+ * @param {Array<string>} content_ids - The IDs of the content to rank
+ * @returns {Promise<Object|null>} - Returns the content_ids sorted by rank (most significant first)
+ * @example
+ * rankItems('drumeo', ([111222, 23120, 402199])
+ *   .then(status => console.log(status))
+ *   .catch(error => console.error(error));
+ */
+export async function rankItems(brand, content_ids) {
+  if (content_ids.length === 0) {
+    return []
+  }
+  let data = {
+    'brand': brand,
+    'user_id': globalConfig.railcontentConfig.userId,
+    'content_ids': content_ids,
+  }
+  const url = `/rank_items/`
+  try {
+    const response = await fetchHandler(url, 'POST', data)
+    return response['ranked_content_ids']
+  } catch (error) {
+    console.error('Fetch error:', error)
+    return null
+  }
+}
+
+async function fetchHandler(url, method = 'get', body = null) {
+
+  let headers = {
+    'Content-Type': 'application/json',
+    Accept: 'application/json',
+    'X-CSRF-TOKEN': globalConfig.recommendationsConfig.token,
+  }
+
+  const options = {
+    method,
+    headers,
+  }
+
+  if (body) {
+    options.body = JSON.stringify(body)
+  }
+  try {
+    const response = await fetchAbsolute(url, options)
+    if (response.ok) {
+      return await response.json()
+    } else {
+      console.error(`Fetch error: ${method} ${url} ${response.status} ${response.statusText}`)
+      console.log(response)
+    }
+  } catch (error) {
+    console.error('Fetch error:', error)
+  }
+  return null
+}
+
+
+function fetchAbsolute(url, params) {
+  if (globalConfig.recommendationsConfig.token) {
+    params.headers['Authorization'] = `Bearer ${globalConfig.recommendationsConfig.token}`
+  }
+  if (globalConfig.recommendationsConfig.baseUrl) {
+    if (url.startsWith('/')) {
+      return fetch(globalConfig.recommendationsConfig.baseUrl + url, params)
+    }
+  }
+  return fetch(url, params)
+}