musora-content-services 2.1.0 → 2.2.0

package/src/services/gamification/gamification.js

@@ -0,0 +1,4 @@
+/**
+ * @namespace Gamification
+ * @property {module:Awards} Awards
+ */

package/src/services/gamification/types.js

@@ -0,0 +1,26 @@
+/**
+ * @typedef {Object} Award
+ * @property {string} username - The username of the user.
+ * @property {number} streak - The name of the award.
+ * @property {number} minutes_practiced - The name of the award.
+ * @property {Date} date_completed - Date of completion
+ * @property {string} challenge_title - The name of the challenge completed.
+ * @property {string} award_text - Award description
+ * @property {string} tier - Award tier [bronze, silver, gold]
+ * @property {string} award - Award image URL
+ * @property {string} award_64 - Award image in base64
+ * @property {string} instructor_signature - Instructor signature image URL
+ * @property {string} instructor_signature_64 - Instructor signature image in base64
+ * @property {string} musora_logo - Musora logo image URL
+ * @property {string} musora_logo_64 - Musora logo image in base64
+ * @property {string} brand_logo - Brand logo image URL
+ * @property {string} brand_logo_64 - Brand logo image in base64
+ * @property {string} ribbon_image - Ribbon image URL
+ * @property {string} ribbon_image_64 - Ribbon image in base64
+ * @property {number} id - ID of the challenge completed
+ * @property {string} artist_name - Name of the artist featured in the challenge
+ * @property {string} dark_mode_logo_url - Dark mode logo image URL
+ * @property {string} light_mode_logo_url - Light mode logo image URL
+ * @property {string} logo_image_url - Name of the artist featured in the challenge
+ * @property {string} web_url_path - URL path for the challenge
+ */

package/src/services/railcontent.js

@@ -4,6 +4,7 @@
 import { contentStatusCompleted } from './contentProgress.js'
 
 import { globalConfig } from './config.js'
+import { fetchJSONHandler } from '../lib/httpHelper.js'
 
 /**
  * Exported functions that are excluded from index generation.
@@ -294,54 +295,6 @@ async function deleteDataHandler(url, data) {
   return fetchHandler(url, 'delete')
 }
 
-// TODO: this should be extracted to a utility file
-export async function fetchHandler(url, method = 'get', dataVersion = null, body = null) {
-  let headers = {
-    'Content-Type': 'application/json',
-    Accept: 'application/json',
-    'X-CSRF-TOKEN': globalConfig.railcontentConfig.token,
-  }
-
-  if (!globalConfig.isMA) {
-    const params = new URLSearchParams(window.location.search)
-    if (params.get('testNow')) {
-      headers['testNow'] = params.get('testNow')
-    }
-    if (params.get('timezone')) {
-      headers['M-Client-Timezone'] = params.get('timezone')
-    }
-  }
-
-  if (globalConfig.localTimezoneString) {
-    headers['M-Client-Timezone'] = globalConfig.localTimezoneString
-  }
-
-  if (globalConfig.railcontentConfig.authToken) {
-    headers['Authorization'] = `Bearer ${globalConfig.railcontentConfig.authToken}`
-  }
-
-  if (dataVersion) headers['Data-Version'] = dataVersion
-  const options = {
-    method,
-    headers,
-  }
-  if (body) {
-    options.body = JSON.stringify(body)
-  }
-  try {
-    const response = await fetchAbsolute(url, options)
-    if (response.ok) {
-      return await response.json()
-    } else {
-      console.error(`Fetch error: ${method} ${url} ${response.status} ${response.statusText}`)
-      console.log(response)
-    }
-  } catch (error) {
-    console.error('Fetch error:', error)
-  }
-  return null
-}
-
 export async function fetchUserLikes(currentVersion) {
   let url = `/api/content/v1/user/likes`
   return fetchDataHandler(url, currentVersion)
@@ -1223,15 +1176,12 @@ export async function editComment(commentId, comment) {
   return await patchDataHandler(url, data)
 }
 
-function fetchAbsolute(url, params) {
-  if (globalConfig.railcontentConfig.authToken) {
-    params.headers['Authorization'] = `Bearer ${globalConfig.railcontentConfig.authToken}`
-  }
-
-  if (globalConfig.railcontentConfig.baseUrl) {
-    if (url.startsWith('/')) {
-      return fetch(globalConfig.railcontentConfig.baseUrl + url, params)
-    }
-  }
-  return fetch(url, params)
+export async function fetchHandler(url, method = 'get', dataVersion = null, body = null) {
+  return fetchJSONHandler(
+    url,
+    globalConfig.railcontentConfig.token,
+    globalConfig.railcontentConfig.baseUrl,
+    method,
+    dataVersion,
+    body)
 }

package/src/services/recommendations.js

@@ -3,6 +3,7 @@
  */
 
 import { globalConfig } from './config.js'
+import { fetchJSONHandler} from '../lib/httpHelper.js'
 
 /**
  * Exported functions that are excluded from index generation.
@@ -129,44 +130,12 @@ export async function recommendations(brand, {
 }
 
 async function fetchHandler(url, method = 'get', body = null) {
-
-  let headers = {
-    'Content-Type': 'application/json',
-    Accept: 'application/json',
-    'X-CSRF-TOKEN': globalConfig.recommendationsConfig.token,
-  }
-
-  const options = {
+  return fetchJSONHandler(
+    url,
+    globalConfig.recommendationsConfig.token,
+    globalConfig.recommendationsConfig.baseUrl,
     method,
-    headers,
-  }
-
-  if (body) {
-    options.body = JSON.stringify(body)
-  }
-  try {
-    const response = await fetchAbsolute(url, options)
-    if (response.ok) {
-      return await response.json()
-    } else {
-      console.error(`Fetch error: ${method} ${url} ${response.status} ${response.statusText}`)
-      console.log(response)
-    }
-  } catch (error) {
-    console.error('Fetch error:', error)
-  }
-  return null
-}
-
-
-function fetchAbsolute(url, params) {
-  if (globalConfig.recommendationsConfig.token) {
-    params.headers['Authorization'] = `Bearer ${globalConfig.recommendationsConfig.token}`
-  }
-  if (globalConfig.recommendationsConfig.baseUrl) {
-    if (url.startsWith('/')) {
-      return fetch(globalConfig.recommendationsConfig.baseUrl + url, params)
-    }
-  }
-  return fetch(url, params)
+    null,
+    body
+    )
 }

package/src/services/sanity.js

@@ -15,7 +15,7 @@ import {
   getNewReleasesTypes,
   coachLessonsTypes,
   getChildFieldsForContentType,
-  SONG_TYPES
+  SONG_TYPES,
 } from '../contentTypeConfig.js'
 import { fetchSimilarItems } from './recommendations.js'
 import { processMetadata, typeWithSortOrder } from '../contentMetaData.js'
@@ -1321,7 +1321,7 @@ export async function fetchLessonContent(railContentId) {
  * @param count
  * @returns {Promise<Array<Object>|null>}
  */
-export async function fetchRelatedRecommendedContent(railContentId, brand, count=10) {
+export async function fetchRelatedRecommendedContent(railContentId, brand, count = 10) {
   const recommendedItems = await fetchSimilarItems(railContentId, brand, count)
   return fetchByRailContentIds(recommendedItems)
 }
@@ -1333,9 +1333,9 @@ export async function fetchRelatedRecommendedContent(railContentId, brand, count
  * @param railcontentId
  * @param brand
  * @param count
- * @returns {Promise<*>}
+ * @returns {Promise<Array<Object>>}
  */
-export async function fetchOtherSongVersions(railcontentId, brand, count=3){
+export async function fetchOtherSongVersions(railcontentId, brand, count = 3) {
   return fetchRelatedByLicense(railcontentId, brand, true, count)
 }
 
@@ -1346,9 +1346,9 @@ export async function fetchOtherSongVersions(railcontentId, brand, count=3){
  * @param {integer} railcontentId
  * @param {string} brand
  * @param {integer:3} count
- * @returns {Promise<*>}
+ * @returns {Promise<Array<Object>>}
  */
-export async function fetchLessonsFeaturingThisContent(railcontentId, brand, count=3){
+export async function fetchLessonsFeaturingThisContent(railcontentId, brand, count = 3) {
   return fetchRelatedByLicense(railcontentId, brand, false, count)
 }
 
@@ -1359,16 +1359,15 @@ export async function fetchLessonsFeaturingThisContent(railcontentId, brand, cou
  * @param {string} brand
  * @param {boolean} onlyUseSongTypes - if true, only return the song type documents. If false, return everything except those
  * @param {integer:3} count
- * @returns {Promise<*[]>}
+ * @returns {Promise<Array<Object>>}
  */
 async function fetchRelatedByLicense(railcontentId, brand, onlyUseSongTypes, count) {
   const typeCheck = `@->_type in [${arrayJoinWithQuotes(SONG_TYPES)}]`
   const typeCheckString = onlyUseSongTypes ? `${typeCheck}` : `!(${typeCheck})`
-  const contentFromLicenseFilter =`_type == 'license' && references(^._id)].content[${typeCheckString} && @->railcontent_id != ${railcontentId}`
-  let filterSongTypesWithSameLicense = await new FilterBuilder(
-    contentFromLicenseFilter,
-    {isChildrenFilter: true},
-  ).buildFilter()
+  const contentFromLicenseFilter = `_type == 'license' && references(^._id)].content[${typeCheckString} && @->railcontent_id != ${railcontentId}`
+  let filterSongTypesWithSameLicense = await new FilterBuilder(contentFromLicenseFilter, {
+    isChildrenFilter: true,
+  }).buildFilter()
   let queryFields = getFieldsForContentType()
   const baseParentQuery = `railcontent_id == ${railcontentId}`
   let parentQuery = await new FilterBuilder(baseParentQuery).buildFilter()
@@ -1383,7 +1382,7 @@ async function fetchRelatedByLicense(railcontentId, brand, onlyUseSongTypes, cou
       }[0...1]`
 
   const results = await fetchSanity(query, false)
-  return results['related_by_license'] ?? [];
+  return results['related_by_license'] ?? []
 }
 
 /**
@@ -2350,4 +2349,3 @@ export async function fetchScheduledAndNewReleases(
 
   return fetchSanity(query, true)
 }
-

package/src/services/user/management.js

@@ -0,0 +1,35 @@
+/**
+ * @module User-Management
+ */
+import { fetchHandler } from '../railcontent.js'
+
+
+
+/**
+ * Exported functions that are excluded from index generation.
+ *
+ * @type {string[]}
+ */
+const excludeFromGeneratedIndex = []
+
+const baseUrl = `/api/user-management-system`
+
+/**
+ * Block the provided user
+ * @param userId
+ * @returns {Promise<any|string|null>}
+ */
+export async function blockUser(userId) {
+  const url = `${baseUrl}/v1/block/${userId}`
+  return fetchHandler(url, 'post')
+}
+
+/**
+ * Unblock the provided user. Returns a 422 if the user wasn't blocked
+ * @param userId
+ * @returns {Promise<any|string|null>}
+ */
+export async function unblockUser(userId) {
+  const url = `${baseUrl}/v1/unblock/${userId}`
+  return fetchHandler(url, 'post')
+}