musora-content-services 2.28.2 → 2.28.4

package/src/index.d.ts

@@ -115,14 +115,9 @@ import {
 	editComment,
 	fetchAllCompletedStates,
 	fetchCarouselCardData,
-	fetchChallengeIndexMetadata,
-	fetchChallengeLessonData,
-	fetchChallengeMetadata,
-	fetchChallengeUserActiveChallenges,
 	fetchComment,
 	fetchCommentRelies,
 	fetchComments,
-	fetchCompletedChallenges,
 	fetchCompletedContent,
 	fetchCompletedState,
 	fetchContentInProgress,
@@ -132,13 +127,11 @@ import {
 	fetchLastInteractedChild,
 	fetchLikeCount,
 	fetchNextContentDataForParent,
-	fetchOwnedChallenges,
 	fetchRecentUserActivities,
 	fetchSongsInProgress,
 	fetchTopComment,
 	fetchUserAward,
 	fetchUserBadges,
-	fetchUserChallengeProgress,
 	fetchUserLikes,
 	fetchUserPermissionsData,
 	fetchUserPracticeMeta,
@@ -147,14 +140,6 @@ import {
 	likeComment,
 	logUserPractice,
 	openComment,
-	postChallengesCommunityNotification,
-	postChallengesEnroll,
-	postChallengesEnrollmentNotification,
-	postChallengesHideCompletedBanner,
-	postChallengesLeave,
-	postChallengesSetStartDate,
-	postChallengesSoloNotification,
-	postChallengesUnlock,
 	postContentComplete,
 	postContentLiked,
 	postContentReset,
@@ -353,10 +338,6 @@ declare module 'musora-content-services' {
 		fetchByRailContentIds,
 		fetchByReference,
 		fetchCarouselCardData,
-		fetchChallengeIndexMetadata,
-		fetchChallengeLessonData,
-		fetchChallengeMetadata,
-		fetchChallengeUserActiveChallenges,
 		fetchChatAndLiveEnvent,
 		fetchChatSettings,
 		fetchCoachLessons,
@@ -365,7 +346,6 @@ declare module 'musora-content-services' {
 		fetchCommentModContentData,
 		fetchCommentRelies,
 		fetchComments,
-		fetchCompletedChallenges,
 		fetchCompletedContent,
 		fetchCompletedState,
 		fetchContentInProgress,
@@ -396,7 +376,6 @@ declare module 'musora-content-services' {
 		fetchNotificationSettings,
 		fetchNotifications,
 		fetchOtherSongVersions,
-		fetchOwnedChallenges,
 		fetchPackAll,
 		fetchPackData,
 		fetchParentForDownload,
@@ -428,7 +407,6 @@ declare module 'musora-content-services' {
 		fetchUpcomingEvents,
 		fetchUserAward,
 		fetchUserBadges,
-		fetchUserChallengeProgress,
 		fetchUserLikes,
 		fetchUserPermissions,
 		fetchUserPermissionsData,
@@ -496,14 +474,6 @@ declare module 'musora-content-services' {
 		pinGuidedCourse,
 		pinProgressRow,
 		pinnedGuidedCourses,
-		postChallengesCommunityNotification,
-		postChallengesEnroll,
-		postChallengesEnrollmentNotification,
-		postChallengesHideCompletedBanner,
-		postChallengesLeave,
-		postChallengesSetStartDate,
-		postChallengesSoloNotification,
-		postChallengesUnlock,
 		postContentComplete,
 		postContentLiked,
 		postContentReset,

package/src/index.js

@@ -115,14 +115,9 @@ import {
 	editComment,
 	fetchAllCompletedStates,
 	fetchCarouselCardData,
-	fetchChallengeIndexMetadata,
-	fetchChallengeLessonData,
-	fetchChallengeMetadata,
-	fetchChallengeUserActiveChallenges,
 	fetchComment,
 	fetchCommentRelies,
 	fetchComments,
-	fetchCompletedChallenges,
 	fetchCompletedContent,
 	fetchCompletedState,
 	fetchContentInProgress,
@@ -132,13 +127,11 @@ import {
 	fetchLastInteractedChild,
 	fetchLikeCount,
 	fetchNextContentDataForParent,
-	fetchOwnedChallenges,
 	fetchRecentUserActivities,
 	fetchSongsInProgress,
-	fetchTopComment,
 	fetchUserAward,
 	fetchUserBadges,
-	fetchUserChallengeProgress,
+	fetchTopComment,
 	fetchUserLikes,
 	fetchUserPermissionsData,
 	fetchUserPracticeMeta,
@@ -147,14 +140,6 @@ import {
 	likeComment,
 	logUserPractice,
 	openComment,
-	postChallengesCommunityNotification,
-	postChallengesEnroll,
-	postChallengesEnrollmentNotification,
-	postChallengesHideCompletedBanner,
-	postChallengesLeave,
-	postChallengesSetStartDate,
-	postChallengesSoloNotification,
-	postChallengesUnlock,
 	postContentComplete,
 	postContentLiked,
 	postContentReset,
@@ -352,10 +337,6 @@ export {
 	fetchByRailContentIds,
 	fetchByReference,
 	fetchCarouselCardData,
-	fetchChallengeIndexMetadata,
-	fetchChallengeLessonData,
-	fetchChallengeMetadata,
-	fetchChallengeUserActiveChallenges,
 	fetchChatAndLiveEnvent,
 	fetchChatSettings,
 	fetchCoachLessons,
@@ -364,7 +345,6 @@ export {
 	fetchCommentModContentData,
 	fetchCommentRelies,
 	fetchComments,
-	fetchCompletedChallenges,
 	fetchCompletedContent,
 	fetchCompletedState,
 	fetchContentInProgress,
@@ -395,7 +375,6 @@ export {
 	fetchNotificationSettings,
 	fetchNotifications,
 	fetchOtherSongVersions,
-	fetchOwnedChallenges,
 	fetchPackAll,
 	fetchPackData,
 	fetchParentForDownload,
@@ -427,7 +406,6 @@ export {
 	fetchUpcomingEvents,
 	fetchUserAward,
 	fetchUserBadges,
-	fetchUserChallengeProgress,
 	fetchUserLikes,
 	fetchUserPermissions,
 	fetchUserPermissionsData,
@@ -495,14 +473,6 @@ export {
 	pinGuidedCourse,
 	pinProgressRow,
 	pinnedGuidedCourses,
-	postChallengesCommunityNotification,
-	postChallengesEnroll,
-	postChallengesEnrollmentNotification,
-	postChallengesHideCompletedBanner,
-	postChallengesLeave,
-	postChallengesSetStartDate,
-	postChallengesSoloNotification,
-	postChallengesUnlock,
 	postContentComplete,
 	postContentLiked,
 	postContentReset,

package/src/services/content.js

@@ -41,7 +41,7 @@ export async function getLessonContentRows (brand='drumeo', pageName = 'lessons'
 /**
  * Get data that should be displayed for a specific tab with pagination
  * @param {string} brand - The brand for which to fetch data.
- * @param {string} pageName - The page name (e.g., 'lessons', 'songs','challenges).
+ * @param {string} pageName - The page name (e.g., 'lessons', 'songs').
  * @param {string} tabName - The name for the selected tab. Should be same name received from fetchMetadata (e.g., 'Individuals', 'Collections','For You').
  * @param {Object} params - Parameters for pagination, sorting, and filter.
  * @param {number} [params.page=1] - The page number for pagination.
@@ -166,7 +166,7 @@ export async function getRecent(brand, pageName, tabName = 'all', {
  * Fetches content rows for a given brand and page with optional filtering by content row slug.
  *
  * @param {string} brand - The brand for which to fetch content rows.
- * @param {string} pageName - The page name (e.g., 'lessons', 'songs', 'challenges').
+ * @param {string} pageName - The page name (e.g., 'lessons', 'songs').
  * @param {string|null} contentRowSlug - The specific content row ID to fetch.
  * @param {Object} params - Parameters for pagination.
  * @param {number} [params.page=1] - The page number for pagination.

package/src/services/railcontent.js

@@ -21,8 +21,6 @@ const excludeFromGeneratedIndex = [
   'fetchUserPermissionsData',
 ]
 
-let challengeIndexMetaDataPromise = null
-
 /**
  * Fetches the completion status of a specific lesson for the current user.
  *
@@ -286,8 +284,8 @@ async function postDataHandler(url, data) {
   return fetchHandler(url, 'post', null, data)
 }
 
-async function patchDataHandler(url, data) {
-  return fetchHandler(url, 'patch', null, data)
+async function patchDataHandler_depreciated(url, data) {
+  throw Error("PATCH verb throws a CORS error on the FEW. Use PATCH instead")
 }
 
 async function putDataHandler(url, data) {
@@ -347,67 +345,6 @@ export async function postRecordWatchSession(
   })
 }
 
-/**
- * Fetch enrolled user data for a given challenge. Intended to be used in the enrolled modal
- *
- * @param contentId - railcontent id of the challenge
- * @returns {Promise<any|null>}
- */
-export async function fetchChallengeMetadata(contentId) {
-  let url = `/challenges/${contentId}`
-  return await fetchHandler(url, 'get')
-}
-
-/**
- * Fetch lesson, user, and challenge data for a given lesson
- *
- * @param contentId - railcontent id of the lesson
- * @returns {Promise<any|null>}
- */
-export async function fetchChallengeLessonData(contentId) {
-  let url = `/challenges/lessons/${contentId}`
-  return await fetchHandler(url, 'get')
-}
-
-/**
- * Fetch all owned brand challenges for user
- * @param {string|null} brand - brand
- * @param {int} page - page of data to pull
- * @param {int} limit - number of elements to pull
- * @returns {Promise<any|null>}
- */
-export async function fetchOwnedChallenges(brand = null, page, limit) {
-  let brandParam = brand ? `&brand=${brand}` : ''
-  let pageAndLimit = `?page=${page}&limit=${limit}`
-  let url = `/challenges/tab_owned/get${pageAndLimit}${brandParam}`
-  return await fetchHandler(url, 'get')
-}
-
-/**
- * Fetch all completed brand challenges for user
- * @param {string|null} brand - brand
- * @param {int} page - page of data to pull
- * @param {int} limit - number of elements to pull
- * @returns {Promise<any|null>}
- */
-export async function fetchCompletedChallenges(brand = null, page, limit) {
-  let brandParam = brand ? `&brand=${brand}` : ''
-  let pageAndLimit = `?page=${page}&limit=${limit}`
-  let url = `/challenges/tab_completed/get${pageAndLimit}${brandParam}`
-  return await fetchHandler(url, 'get')
-}
-
-/**
- * Fetch challenge, lesson, and user metadata for a given challenge
- *
- * @param contentId - railcontent id of the challenge
- * @returns {Promise<any|null>}
- */
-export async function fetchUserChallengeProgress(contentId) {
-  let url = `/challenges/user_data/${contentId}`
-  return await fetchHandler(url, 'get')
-}
-
 /**
  * Fetch the user's best award for this challenge
  *
@@ -419,44 +356,6 @@ export async function fetchUserAward(contentId) {
   return await fetchHandler(url, 'get')
 }
 
-/**
- * Get challenge duration, user progress, and status for the list of challenges
- * Intended to be used on the index page for challenges
- *
- * @param {array} contentIds - arary of railcontent ids of the challenges
- * @returns {Promise<any|null>}
- */
-export async function fetchChallengeIndexMetadata(contentIds) {
-  if (!challengeIndexMetaDataPromise) {
-    challengeIndexMetaDataPromise = getChallengeIndexMetadataPromise()
-  }
-  let results = await challengeIndexMetaDataPromise
-  if (Array.isArray(contentIds)) {
-    results = results.filter(function (challenge) {
-      return contentIds.includes(challenge.content_id)
-    })
-  }
-  return results
-}
-
-async function getChallengeIndexMetadataPromise() {
-  let url = `/challenges/user_progress_for_index_page/get`
-  const result = await fetchHandler(url, 'get')
-  challengeIndexMetaDataPromise = null
-  return result
-}
-
-/**
- * Get active brand challenges for the authorized user
- *
- * @returns {Promise<any|null>}
- */
-export async function fetchChallengeUserActiveChallenges(brand = null) {
-  let brandParam = brand ? `?brand=${brand}` : ''
-  let url = `/challenges/user_active_challenges/get${brandParam}`
-  return await fetchHandler(url, 'get')
-}
-
 /**
  * Fetch All Carousel Card Data
  *
@@ -480,99 +379,6 @@ export async function fetchUserBadges(brand = null) {
   return await fetchHandler(url, 'get')
 }
 
-/**
- * Enroll a user in a challenge and set the start date of the challenge to the provided day.
- * Clears any existing progress data for this challenge
- *
- * @param {int|string} contentId - railcontent id of the challenge
- * @param {string} startDate - prefered format YYYYMMDD, but any Carbon parsable string will do.
- * @returns {Promise<any|null>}
- */
-export async function postChallengesSetStartDate(contentId, startDate) {
-  let url = `/challenges/set_start_date/${contentId}?start_date=${startDate}`
-  return await fetchHandler(url, 'post')
-}
-
-/**
- * Enroll the user in the provided challenge and set to unlocked
- * Clears any current progress data for this challenge
- *
- * @param {int|string} contentId - railcontent id of the challenge
- * @returns {Promise<any|null>}
- */
-export async function postChallengesUnlock(contentId) {
-  let url = `/challenges/unlock/${contentId}`
-  return await fetchHandler(url, 'post')
-}
-
-/**
- * Enroll the user in the given challenge on the challenge published_on date
- *  Clears any current progress data for this challenge
- *
- * @param {int|string} contentId - railcontent id of the challenge
- * @returns {Promise<any|null>}
- */
-export async function postChallengesEnroll(contentId) {
-  let url = `/challenges/enroll/${contentId}`
-  return await fetchHandler(url, 'post')
-}
-
-/**
- * Remove the user from the provided challenge
- * Clears any current progress data for this challenge
- *
- * @param {int|string} contentId - railcontent id of the challenge
- * @returns {Promise<any|null>}
- */
-export async function postChallengesLeave(contentId) {
-  let url = `/challenges/leave/${contentId}`
-  return await fetchHandler(url, 'post')
-}
-
-/**
- * Enable enrollment notifications for the provided challenge
- *
- * @param {int|string} contentId - railcontent id of the challenge
- * @returns {Promise<any|null>}
- */
-export async function postChallengesEnrollmentNotification(contentId) {
-  let url = `/challenges/notifications/enrollment_open/${contentId}`
-  return await fetchHandler(url, 'post')
-}
-
-/**
- * Enable community notifications for the provided challenge
- *
- * @param {int|string} contentId - railcontent id of the challenge
- * @returns {Promise<any|null>}
- */
-export async function postChallengesCommunityNotification(contentId) {
-  let url = `/challenges/notifications/community_reminders/${contentId}`
-  return await fetchHandler(url, 'post')
-}
-
-/**
- * Enable solo notifications for the provided challenge
- *
- * @param {int|string} contentId - railcontent id of the challenge
- * @returns {Promise<any|null>}
- */
-export async function postChallengesSoloNotification(contentId) {
-  let url = `/challenges/notifications/solo_reminders/${contentId}`
-  return await fetchHandler(url, 'post')
-}
-
-/**
- * Hide challenge completed award bannare
- *
- * @param {int|string} contentId - railcontent id of the challenge
- * @returns {Promise<any|null>}
- */
-export async function postChallengesHideCompletedBanner(contentId) {
-  let url = `/challenges/hide_completed_banner/${contentId}`
-  return await fetchHandler(url, 'post')
-}
-
 export async function postContentComplete(contentId) {
   let url = `/api/content/v1/user/progress/complete/${contentId}`
   return postDataHandler(url)
@@ -593,7 +399,7 @@ export async function postContentReset(contentId) {
 export async function setStudentViewForUser(userId, enable) {
   let url = `/user-management-system/user/update/${userId}`
   let data = { use_student_view: enable ? 1 : 0 }
-  return await patchDataHandler(url, data)
+  return await putDataHandler(url, data)
 }
 
 /**
@@ -719,7 +525,7 @@ export async function closeComment(commentId) {
   const data = {
     conversation_status: 'closed',
   }
-  return await patchDataHandler(url, data)
+  return await putDataHandler(url, data)
 }
 
 /**
@@ -731,7 +537,7 @@ export async function openComment(commentId) {
   const data = {
     conversation_status: 'open',
   }
-  return await patchDataHandler(url, data)
+  return await putDataHandler(url, data)
 }
 
 /**

package/src/services/sanity.js

@@ -25,8 +25,6 @@ import { processMetadata, typeWithSortOrder } from '../contentMetaData.js'
 import { globalConfig } from './config.js'
 
 import {
-  fetchCompletedChallenges,
-  fetchOwnedChallenges,
   fetchNextContentDataForParent,
   fetchHandler,
 } from './railcontent.js'
@@ -40,7 +38,7 @@ import {fetchRecentActivitiesActiveTabs} from "./userActivity.js";
  *
  * @type {string[]}
  */
-const excludeFromGeneratedIndex = ['handleCustomFetchAll', 'fetchRelatedByLicense']
+const excludeFromGeneratedIndex = ['fetchRelatedByLicense']
 
 /**
  * Fetch a song by its document ID from Sanity.
@@ -628,21 +626,6 @@ export async function fetchAll(
     progress = 'all',
   } = {}
 ) {
-  let customResults = await handleCustomFetchAll(brand, type, {
-    page,
-    limit,
-    searchTerm,
-    sort,
-    includedFields,
-    groupBy,
-    progressIds,
-    useDefaultFields,
-    customFields,
-    progress,
-  })
-  if (customResults) {
-    return customResults
-  }
   let config = contentTypeConfig[type] ?? {}
   let additionalFields = config?.fields ?? []
   let isGroupByOneToOne = (groupBy ? config?.relationships?.[groupBy]?.isOneToOne : false) ?? false
@@ -665,9 +648,7 @@ export async function fetchAll(
   } else {
     typeFilter = type
       ? `&& _type == '${type}'`
-      : progress === 'in progress' || progress === 'completed'
-        ? " && (_type != 'challenge-part' && _type != 'challenge')"
-        : ''
+      : ''
   }
 
   // Construct the search filter
@@ -765,152 +746,6 @@ export async function fetchAll(
   return fetchSanity(query, true)
 }
 
-/**
- * Fetch all content that requires custom handling or a distinct external call
- * @param {string} brand - The brand for which to fetch content.
- * @param {string} type - The content type to fetch (e.g., 'song', 'artist').
- * @param {Object} params - Parameters for pagination, filtering, sorting, and grouping.
- * @param {number} [params.page=1] - The page number for pagination.
- * @param {number} [params.limit=10] - The number of items per page.
- * @param {string} [params.searchTerm=""] - The search term to filter content by title or artist.
- * @param {string} [params.sort="-published_on"] - The field to sort the content by.
- * @param {Array<string>} [params.includedFields=[]] - The fields to include in the query.
- * @param {string} [params.groupBy=""] - The field to group the results by (e.g., 'artist', 'genre').
- * @param {Array<string>} [params.progressIds=undefined] - An array of railcontent IDs to filter the results by. Used for filtering by progress.
- * @param {boolean} [params.useDefaultFields=true] - use the default sanity fields for content Type
- * @param {Array<string>} [params.customFields=[]] - An array of sanity fields to include in the request
- * @param {string} [params.progress="all"] - An string representing which progress filter to use ("all", "in progress", "complete", "not started").
- * @returns {Promise<Object|null>} - The fetched content data or null if not found.
- */
-async function handleCustomFetchAll(
-  brand,
-  type,
-  {
-    page = 1,
-    limit = 10,
-    searchTerm = '',
-    sort = '-published_on',
-    includedFields = [],
-    groupBy = '',
-    progressIds = undefined,
-    useDefaultFields = true,
-    customFields = [],
-    progress = 'all',
-  } = {}
-) {
-  if (type === 'challenge') {
-    if (groupBy === 'completed') {
-      const completedIds = await fetchCompletedChallenges(brand, page, limit)
-      return fetchAll(brand, type, {
-        page,
-        limit,
-        searchTerm,
-        sort,
-        includedFields,
-        groupBy: '',
-        progressIds: completedIds,
-        useDefaultFields,
-        customFields,
-        progress,
-      })
-    } else if (groupBy === 'owned') {
-      const ownedIds = await fetchOwnedChallenges(brand, page, limit)
-      return fetchAll(brand, type, {
-        page,
-        limit,
-        searchTerm,
-        sort,
-        includedFields,
-        groupBy: '',
-        progressIds: ownedIds,
-        useDefaultFields,
-        customFields,
-        progress,
-      })
-    } else if (groupBy === 'difficulty_string') {
-      return fetchChallengesByDifficulty(
-        brand,
-        type,
-        page,
-        limit,
-        searchTerm,
-        sort,
-        includedFields,
-        groupBy,
-        progressIds,
-        useDefaultFields,
-        customFields,
-        progress
-      )
-    }
-  }
-  return null
-}
-
-async function fetchChallengesByDifficulty(
-  brand,
-  type,
-  page,
-  limit,
-  searchTerm,
-  sort,
-  includedFields,
-  groupBy,
-  progressIds,
-  useDefaultFields,
-  customFields,
-  progress
-) {
-  let config = contentTypeConfig['challenge'] ?? {}
-  let additionalFields = config?.fields ?? []
-
-  // Construct the search filter
-  const searchFilter = searchTerm
-    ? groupBy !== ''
-      ? `&& (^.name match "${searchTerm}*" || title match "${searchTerm}*")`
-      : `&& (artist->name match "${searchTerm}*" || instructor[]->name match "${searchTerm}*" || title match "${searchTerm}*" || name match "${searchTerm}*")`
-    : ''
-
-  // Construct the included fields filter, replacing 'difficulty' with 'difficulty_string'
-  const includedFieldsFilter = includedFields.length > 0 ? filtersToGroq(includedFields) : ''
-
-  // limits the results to supplied progressIds for started & completed filters
-  const progressFilter = await getProgressFilter(progress, progressIds)
-
-  let fields = useDefaultFields
-    ? customFields.concat(DEFAULT_FIELDS, additionalFields)
-    : customFields
-  let fieldsString = fields.join(',')
-
-  const lessonsFilter = `_type == 'challenge' && brand == '${brand}' && ^.name == difficulty_string ${searchFilter} ${includedFieldsFilter} ${progressFilter}`
-  const lessonsFilterWithRestrictions = await new FilterBuilder(lessonsFilter).buildFilter()
-
-  const query = `{
-      "entity": [
-        {"name": "All"},
-        {"name": "Novice"},
-        {"name": "Beginner"},
-        {"name": "Intermediate"},
-        {"name": "Advanced"},
-        {"name": "Expert"}]
-          {
-            'id': 0,
-            name,
-            'all_lessons_count': count(*[${lessonsFilterWithRestrictions}]._id),
-            'lessons': *[${lessonsFilterWithRestrictions}]{
-                ${fieldsString},
-                name
-            }[0...20]
-          },
-          "total": 0
-        }`
-  let data = await fetchSanity(query, true)
-  data.entity = data.entity.filter(function (difficulty) {
-    return difficulty.lessons.length > 0
-  })
-  return data
-}
-
 async function getProgressFilter(progress, progressIds) {
   switch (progress) {
     case 'all':
@@ -1632,7 +1467,7 @@ export async function fetchLiveEvent(brand, forcedContentId = null) {
  *
  * @example
  * fetchPackData(404048)
- *   .then(challenge => console.log(challenge))
+ *   .then(pack => console.log(pack))
  *   .catch(error => console.error(error));
  */
 export async function fetchPackData(id) {

package/src/services/userActivity.js

@@ -9,7 +9,6 @@ import {
   fetchUserPracticeNotes,
   fetchHandler,
   fetchRecentUserActivities,
-  fetchChallengeLessonData,
   fetchLastInteractedChild,
 } from './railcontent'
 import { DataContext, UserActivityVersionKey } from './dataContext.js'

package/test/live/railcontentLive.test.js

@@ -1,14 +1,7 @@
 import { initializeTestService } from '../initializeTests'
-import { fetchChallengeIndexMetadata } from '../../src'
 
 describe('railcontentLive', function () {
   beforeEach(async () => {
     await initializeTestService(true)
   }, 1000000)
-
-  test('challengeIndexMetadata', async () => {
-    let contentId = 281709
-    let results = await fetchChallengeIndexMetadata([contentId])
-    expect(Array.isArray(results)).toBe(true)
-  })
 })