musora-content-services 2.40.0 → 2.42.0

package/src/services/forums/threads.ts

@@ -1,9 +1,10 @@
 /**
- * @module Threads
+ * @module Forums
  */
 import { HttpClient } from '../../infrastructure/http/HttpClient'
 import { globalConfig } from '../config.js'
 import { ForumThread } from './types'
+import { PaginatedResponse } from '../api/types'
 
 const baseUrl = `/api/forums`
 
@@ -28,3 +29,60 @@ export async function createThread(
   const httpClient = new HttpClient(globalConfig.baseUrl)
   return httpClient.post<ForumThread>(`${baseUrl}/v1/categories/${categoryId}/threads`, params)
 }
+
+/**
+ * Follow a thread.
+ *
+ * @param {number} threadId - The ID of the thread to lock.
+ * @param {string} brand - The brand associated with the follow action.
+ * @return {Promise<void>} - A promise that resolves when the thread is locked.
+ * @throws {HttpError} - If the request fails.
+ */
+export async function followThread(threadId: number, brand: string): Promise<void> {
+  const httpClient = new HttpClient(globalConfig.baseUrl)
+  return httpClient.post<void>(`${baseUrl}/v1/threads/${threadId}/follow`, { brand })
+}
+
+/**
+ * Unlock a thread to allow further posts.
+ *
+ * @param {number} threadId - The ID of the thread to unlock.
+ * @param {string} brand - The brand associated with the unlock action.
+ * @return {Promise<void>} - A promise that resolves when the thread is unlocked.
+ * @throws {HttpError} - If the request fails.
+ */
+export async function unfollowThread(threadId: number, brand: string): Promise<void> {
+  const httpClient = new HttpClient(globalConfig.baseUrl)
+  return httpClient.delete<void>(`${baseUrl}/v1/threads/${threadId}/follow?brand=${brand}`)
+}
+
+export interface FetchThreadParams {
+  is_followed?: boolean,
+  page?: number,
+  limit?: number,
+  sort?: '-last_post_published_on' | string
+}
+/**
+ * Fetches forum threads for the given category.
+ *
+ * @param {number} categoryId - The ID of the forum category.
+ * @param {string} brand - The brand context (e.g., "drumeo", "singeo").
+ * @param {FetchThreadParams} params - Optional additional parameters (e.g., is_followed, sort("last_post_published_on","-last_post_published_on","mine")).
+ * @returns {Promise<PaginatedResponse<ForumThread>>} - A promise that resolves to a paginated list of forum threads.
+ * @throws {HttpError} - If the HTTP request fails.
+ */
+export async function fetchThreads(
+  categoryId: number,
+  brand: string,
+  params: FetchThreadParams = {}
+): Promise<PaginatedResponse<ForumThread>> {
+  const httpClient = new HttpClient(globalConfig.baseUrl)
+  const queryObj: Record<string, string> = { brand, ...Object.fromEntries(
+      Object.entries(params).filter(([_, v]) => v !== undefined && v !== null).map(([k, v]) => [k, String(v)])
+    )}
+  const query = new URLSearchParams(queryObj).toString()
+
+  const url = `${baseUrl}/v1/categories/${categoryId}/threads?${query}`
+  return httpClient.get<PaginatedResponse<ForumThread>>(url)
+}
+

package/src/services/forums/types.ts

@@ -23,6 +23,7 @@ export interface ForumThread {
   category_id: number
   post_count: number
   last_post: ForumPost | null
+  is_read: boolean
 }
 
 export interface ForumCategory {

package/src/services/gamification/awards.ts

@@ -69,6 +69,27 @@ export async function fetchAwardsForUser(
   return response
 }
 
+/**
+ * Get award progress for the guided course lesson for the authorized user.
+ *
+ * NOTE: needs error handling for the response from http client
+ * (Alexandre: I'm doing it in a different branch/PR: https://github.com/railroadmedia/musora-content-services/pull/349)
+ * NOTE: This function still expects brand because FE passes the argument. It is ignored for now
+ *
+ * @param {number} guidedCourseLessonId - The guided course lesson Id
+ * @returns {Promise<Award>} - The award data for a given award and given user.
+ */
+export async function getAwardDataForGuidedContent(
+  guidedCourseLessonId,
+): Promise<Award> {
+  const httpClient = new HttpClient(globalConfig.baseUrl, globalConfig.sessionConfig.token)
+  const response = await httpClient.get<Award>(
+    `${baseUrl}/v1/users/guided_course_award/${guidedCourseLessonId}`
+  )
+
+  return response
+}
+
 /**
  * Get certificate data for a completed user award
  *