musora-content-services 2.78.0 → 2.79.0

package/src/services/forums/categories.ts

@@ -43,7 +43,7 @@ export async function createForumCategory(
 
 export interface UpdateForumCategoryParams {
   id: number
-  brand: number
+  brand: string
   name: string
   weight: number
   description?: string

package/src/services/gamification/awards.ts

@@ -11,8 +11,16 @@ const baseUrl = `/api/gamification`
 export interface Award {
   id: number
   user_id: number
-  completed_at: string          // ISO-8601 timestamp
-  completion_data: Object
+  completed_at: string // ISO-8601 timestamp
+  completion_data: {
+    message?: string
+    message_certificate?: string
+    content_title?: string
+    completed_at?: Date
+    days_user_practiced?: number
+    practice_minutes?: number
+    [key: string]: any
+  }
   award_id: number
   type: string
   title: string
@@ -23,7 +31,7 @@ export interface Certificate {
   id: number
   user_name: string
   user_id: number
-  completed_at: string          // ISO-8601 timestamp
+  completed_at: string // ISO-8601 timestamp
   message: string
   award_id: number
   type: string
@@ -42,6 +50,7 @@ export interface Certificate {
   instructor_signature?: string
   instructor_signature_64?: string
 }
+
 /**
  * Get awards for a specific user.
  *
@@ -49,18 +58,23 @@ export interface Certificate {
  * (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} userId - The user ID. If not provided, the authenticated user is used instead.
- * @param {string} _brand - The brand to fetch the awards for.
+ * @param {number|null} [userId] - The user ID. If not provided, the authenticated user is used instead.
+ * @param {string|null} [_brand] - The brand to fetch the awards for.
  * @param {number|null} [page=1] - Page attribute for pagination
  * @param {number|null} [limit=5] - Limit how many items to return
  * @returns {Promise<PaginatedResponse<Award>>} - The awards for the user.
+ * @throws {HttpError} - If the HTTP request fails.
  */
 export async function fetchAwardsForUser(
-  userId: number,
-  _brand: string,
+  userId?: number,
+  _brand?: string,
   page: number = 1,
   limit: number = 5
 ): Promise<PaginatedResponse<Award>> {
+  if (!userId) {
+    userId = Number.parseInt(globalConfig.sessionConfig.userId)
+  }
+
   const httpClient = new HttpClient(globalConfig.baseUrl, globalConfig.sessionConfig.token)
   const response = await httpClient.get<PaginatedResponse<Award>>(
     `${baseUrl}/v1/users/${userId}/awards?limit=${limit}&page=${page}`
@@ -78,10 +92,9 @@ export async function fetchAwardsForUser(
  *
  * @param {number} guidedCourseLessonId - The guided course lesson Id
  * @returns {Promise<Award>} - The award data for a given award and given user.
+ * @throws {HttpError} - If the HTTP request fails.
  */
-export async function getAwardDataForGuidedContent(
-  guidedCourseLessonId,
-): Promise<Award> {
+export async function getAwardDataForGuidedContent(guidedCourseLessonId: number): Promise<Award> {
   const httpClient = new HttpClient(globalConfig.baseUrl, globalConfig.sessionConfig.token)
   const response = await httpClient.get<Award>(
     `${baseUrl}/v1/users/guided_course_award/${guidedCourseLessonId}`
@@ -99,6 +112,7 @@ export async function getAwardDataForGuidedContent(
  *
  * @param {number} userAwardId - The user award progress id
  * @returns {Promise<Certificate>} - The certificate data for the completed user award.
+ * @throws {HttpError} - If the HTTP request fails.
  */
 export async function fetchCertificate(userAwardId: number): Promise<Certificate> {
   const httpClient = new HttpClient(globalConfig.baseUrl, globalConfig.sessionConfig.token)