musora-content-services 2.42.0 → 2.44.0

package/src/contentTypeConfig.js

@@ -17,7 +17,6 @@ export const artistField = `select(
 export const DEFAULT_FIELDS = [
   "'sanity_id' : _id",
   "'id': railcontent_id",
-  'railcontent_id',
   artistOrInstructorName(),
   `'artist': ${artistField}`,
   'title',
@@ -25,8 +24,6 @@ export const DEFAULT_FIELDS = [
   "'thumbnail': thumbnail.asset->url",
   'difficulty',
   'difficulty_string',
-  'web_url_path',
-  "'url': web_url_path",
   'published_on',
   "'type': _type",
   "'length_in_seconds' : coalesce(length_in_seconds, soundslice[0].soundslice_length_in_second)",
@@ -35,17 +32,16 @@ export const DEFAULT_FIELDS = [
   'status',
   "'slug' : slug.current",
   "'permission_id': permission[]->railcontent_id",
-  'xp',
   'child_count',
-  '"lesson_count": coalesce(count(child[]->.child[]->), child_count)',
   '"parent_id": parent_content_data[0].id',
 ]
 
+// these are identical... why
 export const DEFAULT_CHILD_FIELDS = [
+  "'sanity_id' : _id",
   "'id': railcontent_id",
-  'railcontent_id',
   artistOrInstructorName(),
-  "'artist': artist->{ 'name': name, 'thumbnail': thumbnail_url.asset->url}",
+  `'artist': ${artistField}`,
   'title',
   "'image': thumbnail.asset->url",
   "'thumbnail': thumbnail.asset->url",
@@ -63,6 +59,14 @@ export const DEFAULT_CHILD_FIELDS = [
   '"parent_id": parent_content_data[0].id',
 ]
 
+export const playAlongMp3sField = `{
+      'mp3_no_drums_no_click_url':      mp3_no_drums_no_click_url,
+      'mp3_no_drums_yes_click_url':     mp3_no_drums_yes_click_url,
+      'mp3_yes_drums_no_click_url':     mp3_yes_drums_no_click_url,
+      'mp3_yes_drums_yes_click_url':    mp3_yes_drums_yes_click_url,
+}
+`
+
 export const instructorField = `instructor[]->{
             "id": railcontent_id,
             name,
@@ -319,44 +323,49 @@ export let contentTypeConfig = {
     ],
     slug: 'courses',
   },
-  'parent-download': {
+  'download': {
     fields: [
-      '"lesson_count": child_count',
-      '"instructors": instructor[]->name',
-      `"description": ${descriptionField}`,
       `"resource": ${resourcesField}`,
-      'xp',
-      'total_xp',
-      '"thumbnail_url":thumbnail.asset->url',
-      `"lessons": child[]->{
-                "id": railcontent_id,
-                title,
-                published_on,
-                "type":_type,
-                "image": thumbnail.asset->url,
-                length_in_seconds,
-                "resources": ${resourcesField},
-                difficulty,
-                difficulty_string,
-                artist->,
-                "thumbnail_url":thumbnail.asset->url,
-                "description": description[0].children[0].text,
-                "chapters": ${chapterField},
-                "instructors":instructor[]->name,
-                "instructor": instructor[]->{
-                    "id":railcontent_id,
-                    name,
-                    short_bio,
-                    "biography": short_bio[0].children[0].text,
-                    web_url_path,
-                    "coach_card_image": coach_card_image.asset->url,
-                    "coach_profile_image":thumbnail_url.asset->url
-                },
-                ${assignmentsField}
-                video,
-                parent_content_data,
-            }`,
+      'soundslice',
+      'instrumentless',
+      `"description": ${descriptionField}`,
+      `"chapters": ${chapterField}`,
+      '"instructors":instructor[]->name',
+      `"instructor": ${instructorField}`,
+      'video',
+      `"play_along_mp3s": ${playAlongMp3sField}`,
+      `...select(
+        defined(live_event_start_time) => {
+          "live_event_start_time": live_event_start_time,
+          "live_event_end_time": live_event_end_time,
+          "live_event_youtube_id": live_event_youtube_id,
+          "videoId": coalesce(live_event_youtube_id, video.external_id),
+          "live_event_is_global": live_global_event == true
+        }
+      )`
+
     ],
+    childFields: [
+      `"resource": ${resourcesField}`,
+      'soundslice',
+      'instrumentless',
+      `"description": ${descriptionField}`,
+      `"chapters": ${chapterField}`,
+      '"instructors":instructor[]->name',
+      `"instructor": ${instructorField}`,
+      'video',
+      `"play_along_mp3s": ${playAlongMp3sField}`,
+      `...select(
+        defined(live_event_start_time) => {
+          "live_event_start_time": live_event_start_time,
+          "live_event_end_time": live_event_end_time,
+          "live_event_youtube_id": live_event_youtube_id,
+          "videoId": coalesce(live_event_youtube_id, video.external_id),
+          "live_event_is_global": live_global_event == true
+        }
+      )`
+
+    ]
   },
   method: {
     fields: [

package/src/index.d.ts

@@ -102,7 +102,12 @@ import {
 	createThread,
 	fetchThreads,
 	followThread,
-	unfollowThread
+	lockThread,
+	pinThread,
+	unfollowThread,
+	unlockThread,
+	unpinThread,
+	updateThread
 } from './services/forums/threads.ts';
 
 import {
@@ -211,7 +216,6 @@ import {
 	fetchOtherSongVersions,
 	fetchPackAll,
 	fetchPackData,
-	fetchParentForDownload,
 	fetchPlayAlongsCount,
 	fetchRelatedLessons,
 	fetchRelatedRecommendedContent,
@@ -427,7 +431,6 @@ declare module 'musora-content-services' {
 		fetchOtherSongVersions,
 		fetchPackAll,
 		fetchPackData,
-		fetchParentForDownload,
 		fetchPlayAlongsCount,
 		fetchPlaylist,
 		fetchPlaylistItems,
@@ -517,6 +520,7 @@ declare module 'musora-content-services' {
 		likeComment,
 		likeContent,
 		likePlaylist,
+		lockThread,
 		logUserPractice,
 		login,
 		loginWithProvider,
@@ -530,6 +534,7 @@ declare module 'musora-content-services' {
 		otherStats,
 		pauseLiveEventPolling,
 		pinProgressRow,
+		pinThread,
 		postContentComplete,
 		postContentLiked,
 		postContentReset,
@@ -575,12 +580,15 @@ declare module 'musora-content-services' {
 		unlikeComment,
 		unlikeContent,
 		unlikePlaylist,
+		unlockThread,
 		unpinProgressRow,
+		unpinThread,
 		updateDisplayName,
 		updateForumCategory,
 		updateNotificationSetting,
 		updatePlaylist,
 		updatePracticeNotes,
+		updateThread,
 		updateUserPractice,
 		upgradeSubscription,
 		uploadPicture,

package/src/index.js

@@ -102,7 +102,12 @@ import {
 	createThread,
 	fetchThreads,
 	followThread,
-	unfollowThread
+	lockThread,
+	pinThread,
+	unfollowThread,
+	unlockThread,
+	unpinThread,
+	updateThread
 } from './services/forums/threads.ts';
 
 import {
@@ -211,7 +216,6 @@ import {
 	fetchOtherSongVersions,
 	fetchPackAll,
 	fetchPackData,
-	fetchParentForDownload,
 	fetchPlayAlongsCount,
 	fetchRelatedLessons,
 	fetchRelatedRecommendedContent,
@@ -426,7 +430,6 @@ export {
 	fetchOtherSongVersions,
 	fetchPackAll,
 	fetchPackData,
-	fetchParentForDownload,
 	fetchPlayAlongsCount,
 	fetchPlaylist,
 	fetchPlaylistItems,
@@ -516,6 +519,7 @@ export {
 	likeComment,
 	likeContent,
 	likePlaylist,
+	lockThread,
 	logUserPractice,
 	login,
 	loginWithProvider,
@@ -529,6 +533,7 @@ export {
 	otherStats,
 	pauseLiveEventPolling,
 	pinProgressRow,
+	pinThread,
 	postContentComplete,
 	postContentLiked,
 	postContentReset,
@@ -574,12 +579,15 @@ export {
 	unlikeComment,
 	unlikeContent,
 	unlikePlaylist,
+	unlockThread,
 	unpinProgressRow,
+	unpinThread,
 	updateDisplayName,
 	updateForumCategory,
 	updateNotificationSetting,
 	updatePlaylist,
 	updatePracticeNotes,
+	updateThread,
 	updateUserPractice,
 	upgradeSubscription,
 	uploadPicture,

package/src/services/forums/threads.ts

@@ -9,9 +9,8 @@ import { PaginatedResponse } from '../api/types'
 const baseUrl = `/api/forums`
 
 export interface CreateThreadParams {
-  name: string
-  description: string
-  weight: number
+  title: string
+  first_post_content: string
   brand: string
 }
 
@@ -30,6 +29,26 @@ export async function createThread(
   return httpClient.post<ForumThread>(`${baseUrl}/v1/categories/${categoryId}/threads`, params)
 }
 
+export interface UpdateThreadParams {
+  title: string
+  brand: string
+}
+/**
+ * Updates an existing thread under a forum category.
+ *
+ * @param {number} threadId - The ID of the thread to update.
+ * @param {UpdateThreadParams} params - The parameters for updating the thread.
+ * @returns {Promise<ForumThread>} - A promise that resolves to the updated thread.
+ * @throws {HttpError} - If the request fails.
+ */
+export async function updateThread(
+  threadId: number,
+  params: UpdateThreadParams
+): Promise<ForumThread> {
+  const httpClient = new HttpClient(globalConfig.baseUrl)
+  return httpClient.put<ForumThread>(`${baseUrl}/v1/threads/${threadId}`, params)
+}
+
 /**
  * Follow a thread.
  *
@@ -86,3 +105,55 @@ export async function fetchThreads(
   return httpClient.get<PaginatedResponse<ForumThread>>(url)
 }
 
+/**
+ * Pins a thread to the top of its category.
+ *
+ * @param {number} threadId - The ID of the thread to pin.
+ * @param {string} brand - The brand context (e.g., "drumeo", "singeo").
+ * @return {Promise<void>} - A promise that resolves when the thread is pinned.
+ * @throws {HttpError} - If the request fails.
+ */
+export async function pinThread(threadId: number, brand: string): Promise<void> {
+  const httpClient = new HttpClient(globalConfig.baseUrl)
+  return httpClient.post<void>(`${baseUrl}/v1/threads/${threadId}/pin`, { brand })
+}
+
+/**
+ * Unpins a thread from the top of its category.
+ *
+ * @param {number} threadId - The ID of the thread to unpin.
+ * @param {string} brand - The brand context (e.g., "drumeo", "singeo").
+ * @return {Promise<void>} - A promise that resolves when the thread is unpinned.
+ * @throws {HttpError} - If the request fails.
+ */
+export async function unpinThread(threadId: number, brand: string): Promise<void> {
+  const httpClient = new HttpClient(globalConfig.baseUrl)
+  return httpClient.delete<void>(`${baseUrl}/v1/threads/${threadId}/pin?brand=${brand}`)
+}
+
+/**
+ * Locks a thread to prevent further posts.
+ *
+ * @param {number} threadId - The ID of the thread to lock.
+ * @param {string} brand - The brand context (e.g., "drumeo", "singeo").
+ * @return {Promise<void>} - A promise that resolves when the thread is locked.
+ * @throws {HttpError} - If the request fails.
+ */
+export async function lockThread(threadId: number, brand: string): Promise<void> {
+  const httpClient = new HttpClient(globalConfig.baseUrl)
+  return httpClient.post<void>(`${baseUrl}/v1/threads/${threadId}/unlock`, { brand })
+}
+
+/**
+ * Unlock a thread to allow further posts.
+ *
+ * @param {number} threadId - The ID of the thread to unlock.
+ * @param {string} brand - The brand context (e.g., "drumeo", "singeo").
+ * @return {Promise<void>} - A promise that resolves when the thread is unlocked.
+ * @throws {HttpError} - If the request fails.
+ */
+export async function unlockThread(threadId: number, brand: string): Promise<void> {
+  const httpClient = new HttpClient(globalConfig.baseUrl)
+  return httpClient.delete<void>(`${baseUrl}/v1/threads/${threadId}/lock?brand=${brand}`)
+}
+

package/src/services/sanity.js

@@ -468,7 +468,7 @@ export async function fetchByRailContentId(id, contentType) {
 /**
  * Fetch content by an array of Railcontent IDs.
  *
- * @param {Array<string>} ids - The array of Railcontent IDs of the content to fetch.
+ * @param {Array<string|number>} ids - The array of Railcontent IDs of the content to fetch.
  * @param {string} [contentType] - The content type the IDs to add needed fields to the response.
  * @returns {Promise<Array<Object>|null>} - A promise that resolves to an array of content objects or null if not found.
  *
@@ -1496,28 +1496,6 @@ export async function fetchCoachLessons(
   return fetchSanity(query, true)
 }
 
-/**
- * Fetch the data needed for the Course Overview screen.
- * @param {string} id - The Railcontent ID of the course
- * @returns {Promise<Object|null>} - The course information and lessons or null if not found.
- *
- * @example
- * fetchParentForDownload('course123')
- *   .then(course => console.log(course))
- *   .catch(error => console.error(error));
- */
-export async function fetchParentForDownload(id) {
-  const query = buildRawQuery(
-    `railcontent_id == ${id}`,
-    getFieldsForContentType('parent-download'),
-    {
-      isSingle: true,
-    }
-  )
-
-  return fetchSanity(query, false)
-}
-
 /**
  * Fetch the data needed for the coach screen.
  * @param {string} id - The Railcontent ID of the coach