musora-content-services 2.3.11 → 2.3.13

package/jsdoc.json

@@ -8,6 +8,7 @@
       "src/services/config.js",
       "src/services/sanity.js",
       "src/services/content.js",
+      "src/services/userActivity.js",
       "src/services/railcontent.js",
       "src/index.js"
     ],

package/package.json

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

package/src/index.d.ts

@@ -115,6 +115,7 @@ import {
 	fetchUserLikes,
 	fetchUserPermissionsData,
 	fetchUserPracticeMeta,
+	fetchUserPracticeNotes,
 	fetchUserPractices,
 	likeComment,
 	likePlaylist,
@@ -218,7 +219,9 @@ import {
 } from './services/user/sessions.js';
 
 import {
+	createPracticeNotes,
 	deletePracticeSession,
+	getPracticeNotes,
 	getPracticeSessions,
 	getRecentActivity,
 	getUserMonthlyStats,
@@ -228,6 +231,7 @@ import {
 	removeUserPractice,
 	restorePracticeSession,
 	restoreUserPractice,
+	updatePracticeNotes,
 	updateUserPractice
 } from './services/userActivity.js';
 
@@ -248,6 +252,7 @@ declare module 'musora-content-services' {
 		countAssignmentsAndLessons,
 		createComment,
 		createPlaylist,
+		createPracticeNotes,
 		deleteComment,
 		deletePlaylist,
 		deletePlaylistItem,
@@ -334,6 +339,7 @@ declare module 'musora-content-services' {
 		fetchUserPermissionsData,
 		fetchUserPlaylists,
 		fetchUserPracticeMeta,
+		fetchUserPracticeNotes,
 		fetchUserPractices,
 		getActiveDiscussions,
 		getAllCompleted,
@@ -343,6 +349,7 @@ declare module 'musora-content-services' {
 		getLessonContentRows,
 		getMonday,
 		getNewAndUpcoming,
+		getPracticeNotes,
 		getPracticeSessions,
 		getProgressPercentage,
 		getProgressPercentageByIds,
@@ -407,6 +414,7 @@ declare module 'musora-content-services' {
 		unpinPlaylist,
 		updatePlaylist,
 		updatePlaylistItem,
+		updatePracticeNotes,
 		updateUserPractice,
 		verifyImageSRC,
 		verifyLocalDataContext,

package/src/index.js

@@ -115,6 +115,7 @@ import {
 	fetchUserLikes,
 	fetchUserPermissionsData,
 	fetchUserPracticeMeta,
+	fetchUserPracticeNotes,
 	fetchUserPractices,
 	likeComment,
 	likePlaylist,
@@ -218,7 +219,9 @@ import {
 } from './services/user/sessions.js';
 
 import {
+	createPracticeNotes,
 	deletePracticeSession,
+	getPracticeNotes,
 	getPracticeSessions,
 	getRecentActivity,
 	getUserMonthlyStats,
@@ -228,6 +231,7 @@ import {
 	removeUserPractice,
 	restorePracticeSession,
 	restoreUserPractice,
+	updatePracticeNotes,
 	updateUserPractice
 } from './services/userActivity.js';
 
@@ -247,6 +251,7 @@ export {
 	countAssignmentsAndLessons,
 	createComment,
 	createPlaylist,
+	createPracticeNotes,
 	deleteComment,
 	deletePlaylist,
 	deletePlaylistItem,
@@ -333,6 +338,7 @@ export {
 	fetchUserPermissionsData,
 	fetchUserPlaylists,
 	fetchUserPracticeMeta,
+	fetchUserPracticeNotes,
 	fetchUserPractices,
 	getActiveDiscussions,
 	getAllCompleted,
@@ -342,6 +348,7 @@ export {
 	getLessonContentRows,
 	getMonday,
 	getNewAndUpcoming,
+	getPracticeNotes,
 	getPracticeSessions,
 	getProgressPercentage,
 	getProgressPercentageByIds,
@@ -406,6 +413,7 @@ export {
 	unpinPlaylist,
 	updatePlaylist,
 	updatePlaylistItem,
+	updatePracticeNotes,
 	updateUserPractice,
 	verifyImageSRC,
 	verifyLocalDataContext,

package/src/services/railcontent.js

@@ -1233,6 +1233,21 @@ export async function fetchUserPracticeMeta(practiceIds) {
   return await fetchHandler(url, 'GET', null)
 }
 
+/**
+ * Fetches user practice notes for a specific date.
+ * @param {string} date - The date for which to fetch practice notes (format: YYYY-MM-DD).
+ * @returns {Promise<Object|null>} - A promise that resolves to an object containing the practice notes if found, otherwise null.
+ *
+ * @example
+ * fetchUserPracticeNotes('2025-04-10')
+ *   .then(notes => console.log(notes))
+ *   .catch(error => console.error(error));
+ */
+export async function fetchUserPracticeNotes(date) {
+  const url = `/api/user/practices/v1/notes?date=${date}`
+  return await fetchHandler(url, 'GET', null)
+}
+
 function fetchAbsolute(url, params) {
   if (globalConfig.sessionConfig.authToken) {
     params.headers['Authorization'] = `Bearer ${globalConfig.sessionConfig.authToken}`

package/src/services/recommendations.js

@@ -2,8 +2,8 @@
  * @module Railcontent-Services
  */
 
-import { globalConfig } from './config.js'
-import { fetchJSONHandler } from '../lib/httpHelper.js'
+import {globalConfig} from './config.js'
+import {fetchJSONHandler} from '../lib/httpHelper.js'
 
 /**
  * Exported functions that are excluded from index generation.
@@ -32,12 +32,13 @@ export async function fetchSimilarItems(content_id, brand, count = 10) {
   let data = {
     brand: brand,
     content_ids: content_id,
-    num_similar: count,
+    num_similar: count + 1, // because the content itself is sometimes returned
   }
   const url = `/similar_items/`
   try {
     const response = await fetchHandler(url, 'POST', data)
-    return response['similar_items']
+    // we requested count + 1 then filtered out the extra potential value, so we need slice to the correct size if necessary
+    return response['similar_items'].filter((item) => item !== content_id).slice(0, count)
   } catch (error) {
     console.error('Fetch error:', error)
     return null
@@ -113,11 +114,12 @@ export async function rankItems(brand, content_ids) {
   }
 }
 
-export async function recommendations(brand, { section = ''} = {}) {
+export async function recommendations(brand, {section = ''} = {}) {
   section = section.toUpperCase().replace('-', '_')
   const sectionString = section ? `&section=${section}` : '';
   const url = `/api/content/v1/recommendations?brand=${brand}${sectionString}`
   try {
+    // This goes through the MPB, not the recommendations api, so we use fetchJSONHandler instead of the local handler
     return fetchJSONHandler(
       url,
       globalConfig.sessionConfig.token,
@@ -133,8 +135,8 @@ export async function recommendations(brand, { section = ''} = {}) {
 async function fetchHandler(url, method = 'get', body = null) {
   return fetchJSONHandler(
     url,
-    globalConfig.sessionConfig.token,
-    globalConfig.baseUrl,
+    globalConfig.recommendationsConfig.token,
+    globalConfig.recommendationsConfig.baseUrl,
     method,
     null,
     body

package/src/services/sanity.js

@@ -406,7 +406,8 @@ export async function fetchUpcomingEvents(brand, { page = 1, limit = 10 } = {})
         published_on,
         "type": _type,
         web_url_path,
-        "permission_id": permission[]->railcontent_id,`
+        "permission_id": permission[]->railcontent_id,
+         "isLive": live_event_start_time <= '${now}' && live_event_end_time >= '${now}'`
   const query = buildRawQuery(
     `_type in ${typesString} && brand == '${brand}' && published_on > '${now}' && status == 'scheduled'`,
     fields,
@@ -2348,7 +2349,8 @@ export async function fetchScheduledAndNewReleases(
       published_on,
       "type": _type,
       show_in_new_feed,
-      "permission_id": permission[]->railcontent_id
+      "permission_id": permission[]->railcontent_id,
+      "isLive": live_event_start_time <= '${now}' && live_event_end_time >= '${now}',
   }`
 
   return fetchSanity(query, true)

package/src/services/userActivity.js

@@ -2,7 +2,7 @@
  * @module User-Activity
  */
 
-import {fetchUserPractices, logUserPractice, fetchUserPracticeMeta, fetchHandler} from './railcontent'
+import {fetchUserPractices, logUserPractice, fetchUserPracticeMeta, fetchUserPracticeNotes, fetchHandler} from './railcontent'
 import { DataContext, UserActivityVersionKey } from './dataContext.js'
 import {fetchByRailContentIds} from "./sanity";
 import {lessonTypesMapping} from "../contentTypeConfig";
@@ -340,6 +340,22 @@ export async function restoreUserPractice(id) {
   return response;
 }
 
+/**
+ * Deletes all practice sessions for a specific day.
+ *
+ * This function retrieves all user practice session IDs for a given day and sends a DELETE request
+ * to remove them from the server. It also updates the local context to reflect the deletion.
+ *
+ * @async
+ * @param {string} day - The day (in `YYYY-MM-DD` format) for which practice sessions should be deleted.
+ * @returns {Promise<string[]>} - A promise that resolves once the practice session is removed.
+ *
+ *  * @example
+ * // Delete practice sessions for April 10, 2025
+ * deletePracticeSession("2025-04-10")
+ *   .then(deletedIds => console.log("Deleted sessions:", response))
+ *   .catch(error => console.error("Delete failed:", error));
+ */
 export async function deletePracticeSession(day) {
   const userPracticesIds = await getUserPracticeIds(day);
   if (!userPracticesIds.length) return [];
@@ -348,9 +364,7 @@ export async function deletePracticeSession(day) {
   await userActivityContext.update(
     async function (localContext) {
       if (localContext.data?.[DATA_KEY_PRACTICES]?.[day]) {
-        localContext.data[DATA_KEY_PRACTICES][day] = localContext.data[DATA_KEY_PRACTICES][day].filter(
-          practice => !userPracticesIds.includes(practice.id)
-        );
+        delete localContext.data[DATA_KEY_PRACTICES][day];
       }
     },
     async function () {
@@ -359,6 +373,22 @@ export async function deletePracticeSession(day) {
   );
 }
 
+/**
+ * Restores deleted practice sessions for a specific date.
+ *
+ * Sends a PUT request to restore any previously deleted practices for a given date.
+ * If restored practices are returned, they are added back into the local context.
+ *
+ * @async
+ * @param {string} date - The date (in `YYYY-MM-DD` format) for which deleted practice sessions should be restored.
+ * @returns {Promise<Object>} - The response object from the API, containing practices for selected date.
+ *
+ * @example
+ * // Restore practice sessions deleted on April 10, 2025
+ * restorePracticeSession("2025-04-10")
+ *   .then(response => console.log("Practice session restored:", response))
+ *   .catch(error => console.error("Restore failed:", error));
+ */
 export async function restorePracticeSession(date) {
   const url = `/api/user/practices/v1/practices/restore?date=${date}`;
   const response = await fetchHandler(url, 'PUT', null);
@@ -395,7 +425,7 @@ export async function restorePracticeSession(date) {
  */
 export async function getPracticeSessions(day) {
   const userPracticesIds = await getUserPracticeIds(day);
-  if (!userPracticesIds.length) return { data: { practices: [], practiceDuration: 0 } };
+  if (!userPracticesIds.length) return { data: { practices: [], practiceDuration: 0} };
 
   const meta = await fetchUserPracticeMeta(userPracticesIds);
   if (!meta.data.length) return { data: { practices: [], practiceDuration: 0 } };
@@ -432,14 +462,81 @@ export async function getPracticeSessions(day) {
       created_at: convertToTimeZone(utcDate, userTimeZone)
     };
   });
-  return { data: { practices: formattedMeta, practiceDuration } };
+  return { data: { practices: formattedMeta, practiceDuration} };
 }
 
+/**
+ * Retrieves user practice notes for a specific day.
+ *
+ * @async
+ * @param {string} day - The day (in `YYYY-MM-DD` format) to fetch practice notes for.
+ * @returns {Promise<{ data: Object[] }>} - A promise that resolves to an object containing the practice notes.
+ *
+ * @example
+ * // Get notes for April 10, 2025
+ * getPracticeNotes("2025-04-10")
+ *   .then(({ data }) => console.log("Practice notes:", data))
+ *   .catch(error => console.error("Failed to get notes:", error));
+ */
+export async function getPracticeNotes(day) {
+  const notes = await fetchUserPracticeNotes(day);
+  return { data: notes };
+}
 
+/**
+ * Retrieves the user's recent activity.
+ *
+ * Returns an object containing recent practice activity.
+ *
+ * @async
+ * @returns {Promise<{ data: Object[] }>} - A promise that resolves to an object containing recent activity items.
+ *
+ * @example
+ * // Fetch recent practice activity
+ * getRecentActivity()
+ *   .then(({ data }) => console.log("Recent activity:", data))
+ *   .catch(error => console.error("Failed to get recent activity:", error));
+ */
 export async function getRecentActivity() {
   return { data: recentActivity };
 }
 
+/**
+ * Creates practice notes for a specific date.
+ *
+ * @param {Object} payload - The data required to create practice notes.
+ * @param {string} payload.date - The date for which to create notes (format: YYYY-MM-DD).
+ * @param {string} payload.notes - The notes content to be saved.
+ * @returns {Promise<Object>} - A promise that resolves to the API response after creating the notes.
+ *
+ * @example
+ * createPracticeNotes({ date: '2025-04-10', notes: 'Worked on scales and arpeggios' })
+ *   .then(response => console.log(response))
+ *   .catch(error => console.error(error));
+ */
+export async function createPracticeNotes(payload) {
+  const url = `/api/user/practices/v1/notes`
+  return await fetchHandler(url, 'POST', null, payload)
+}
+
+/**
+ * Updates existing practice notes for a specific date.
+ *
+ * @param {Object} payload - The data required to update practice notes.
+ * @param {string} payload.date - The date for which to update notes (format: YYYY-MM-DD).
+ * @param {string} payload.notes - The updated notes content.
+ * @returns {Promise<Object>} - A promise that resolves to the API response after updating the notes.
+ *
+ * @example
+ * updatePracticeNotes({ date: '2025-04-10', notes: 'Updated: Focused on technique and timing' })
+ *   .then(response => console.log(response))
+ *   .catch(error => console.error(error));
+ */
+export async function updatePracticeNotes(payload) {
+  const url = `/api/user/practices/v1/notes`
+  return await fetchHandler(url, 'PUT', null, payload)
+}
+
 function getStreaksAndMessage(practices) {
   let { currentDailyStreak, currentWeeklyStreak, streakMessage } = calculateStreaks(practices, true);
 

package/.yarnrc.yml

@@ -1 +0,0 @@
-nodeLinker: node-modules