musora-content-services 2.3.4 → 2.3.6

package/src/services/railcontent.js

@@ -1,8 +1,6 @@
 /**
  * @module Railcontent-Services
  */
-import { contentStatusCompleted } from './contentProgress.js'
-
 import { globalConfig } from './config.js'
 import { fetchJSONHandler } from '../lib/httpHelper.js'
 
@@ -35,12 +33,12 @@ let challengeIndexMetaDataPromise = null
  *   .catch(error => console.error(error));
  */
 export async function fetchCompletedState(content_id) {
-  const url = `/content/user_progress/${globalConfig.railcontentConfig.userId}?content_ids[]=${content_id}`
+  const url = `/content/user_progress/${globalConfig.sessionConfig.userId}?content_ids[]=${content_id}`
 
   const headers = {
     'Content-Type': 'application/json',
     Accept: 'application/json',
-    'X-CSRF-TOKEN': globalConfig.railcontentConfig.token,
+    'X-CSRF-TOKEN': globalConfig.sessionConfig.token,
   }
 
   try {
@@ -69,12 +67,12 @@ export async function fetchCompletedState(content_id) {
  *   .catch(error => console.error(error));
  */
 export async function fetchAllCompletedStates(contentIds) {
-  const url = `/content/user_progress/${globalConfig.railcontentConfig.userId}?${contentIds.map((id) => `content_ids[]=${id}`).join('&')}`
+  const url = `/content/user_progress/${globalConfig.sessionConfig.userId}?${contentIds.map((id) => `content_ids[]=${id}`).join('&')}`
 
   const headers = {
     'Content-Type': 'application/json',
     Accept: 'application/json',
-    'X-CSRF-TOKEN': globalConfig.railcontentConfig.token,
+    'X-CSRF-TOKEN': globalConfig.sessionConfig.token,
   }
 
   try {
@@ -102,12 +100,12 @@ export async function fetchAllCompletedStates(contentIds) {
  *   .catch(error => console.error(error));
  */
 export async function fetchSongsInProgress(brand) {
-  const url = `/content/in_progress/${globalConfig.railcontentConfig.userId}?content_type=song&brand=${brand}`
+  const url = `/content/in_progress/${globalConfig.sessionConfig.userId}?content_type=song&brand=${brand}`
 
   const headers = {
     'Content-Type': 'application/json',
     Accept: 'application/json',
-    'X-CSRF-TOKEN': globalConfig.railcontentConfig.token,
+    'X-CSRF-TOKEN': globalConfig.sessionConfig.token,
   }
 
   try {
@@ -144,14 +142,14 @@ export async function fetchContentInProgress(type = 'all', brand, { page, limit
   const pageString = page ? `&page=${page}` : ''
 
   if (type === 'all') {
-    url = `/content/in_progress/${globalConfig.railcontentConfig.userId}?brand=${brand}${limitString}${pageString}`
+    url = `/content/in_progress/${globalConfig.sessionConfig.userId}?brand=${brand}${limitString}${pageString}`
   } else {
-    url = `/content/in_progress/${globalConfig.railcontentConfig.userId}?content_type=${type}&brand=${brand}${limitString}${pageString}`
+    url = `/content/in_progress/${globalConfig.sessionConfig.userId}?content_type=${type}&brand=${brand}${limitString}${pageString}`
   }
   const headers = {
     'Content-Type': 'application/json',
     Accept: 'application/json',
-    'X-CSRF-TOKEN': globalConfig.railcontentConfig.token,
+    'X-CSRF-TOKEN': globalConfig.sessionConfig.token,
   }
   try {
     const response = await fetchAbsolute(url, { headers })
@@ -187,14 +185,14 @@ export async function fetchCompletedContent(type = 'all', brand, { page, limit }
   const pageString = page ? `&page=${page}` : ''
 
   if (type === 'all') {
-    url = `/content/completed/${globalConfig.railcontentConfig.userId}?brand=${brand}${limitString}${pageString}`
+    url = `/content/completed/${globalConfig.sessionConfig.userId}?brand=${brand}${limitString}${pageString}`
   } else {
-    url = `/content/completed/${globalConfig.railcontentConfig.userId}?content_type=${type}&brand=${brand}${limitString}${pageString}`
+    url = `/content/completed/${globalConfig.sessionConfig.userId}?content_type=${type}&brand=${brand}${limitString}${pageString}`
   }
   const headers = {
     'Content-Type': 'application/json',
     Accept: 'application/json',
-    'X-CSRF-TOKEN': globalConfig.railcontentConfig.token,
+    'X-CSRF-TOKEN': globalConfig.sessionConfig.token,
   }
   try {
     const response = await fetchAbsolute(url, { headers })
@@ -222,11 +220,11 @@ export async function fetchCompletedContent(type = 'all', brand, { page, limit }
  *   .catch(error => console.error(error));
  */
 export async function fetchContentPageUserData(contentId) {
-  let url = `/api/content/v1/${contentId}/user_data/${globalConfig.railcontentConfig.userId}`
+  let url = `/api/content/v1/${contentId}/user_data/${globalConfig.sessionConfig.userId}`
   const headers = {
     'Content-Type': 'application/json',
     Accept: 'application/json',
-    'X-CSRF-TOKEN': globalConfig.railcontentConfig.token,
+    'X-CSRF-TOKEN': globalConfig.sessionConfig.token,
   }
 
   try {
@@ -251,10 +249,10 @@ export async function fetchContentPageUserData(contentId) {
  * @returns {Promise<Object|null>} - Returns and Object with the id and type of the next piece of content if found, otherwise null.
  */
 export async function fetchNextContentDataForParent(contentId) {
-  let url = `/content/${contentId}/next/${globalConfig.railcontentConfig.userId}`
+  let url = `/content/${contentId}/next/${globalConfig.sessionConfig.userId}`
   const headers = {
     'Content-Type': 'application/json',
-    'X-CSRF-TOKEN': globalConfig.railcontentConfig.token,
+    'X-CSRF-TOKEN': globalConfig.sessionConfig.token,
   }
 
   try {
@@ -1178,30 +1176,30 @@ export async function editComment(commentId, comment) {
 
 export async function fetchUserPractices(currentVersion) {
   const url = `/api/user/practices/v1/practices`
-  const response =  await fetchDataHandler(url, currentVersion)
-  const { data, version } = response;
-  const userPractices = data;
+  const response = await fetchDataHandler(url, currentVersion)
+  const { data, version } = response
+  const userPractices = data
 
   let formattedPractices = userPractices.reduce((acc, practice) => {
     // Initialize the array if the day does not exist
     if (!acc[practice.day]) {
-      acc[practice.day] = [];
+      acc[practice.day] = []
     }
 
     // Push the practice entry into the array
-    acc[practice.day].push({ id:practice.id, duration_seconds: practice.duration_seconds });
+    acc[practice.day].push({ id: practice.id, duration_seconds: practice.duration_seconds })
 
-    return acc;
-  }, {});
+    return acc
+  }, {})
 
   let json = {
     data: {
-      practices: formattedPractices
+      practices: formattedPractices,
     },
-    version: version
-  };
+    version: version,
+  }
 
-  return json;
+  return json
 }
 
 export async function logUserPractice(practiceDetails) {
@@ -1209,29 +1207,28 @@ export async function logUserPractice(practiceDetails) {
   return await fetchHandler(url, 'POST', null, practiceDetails)
 }
 export async function fetchUserPracticeMeta(practiceIds) {
-  if(practiceIds.length == 0)
-  {
-    return [];
+  if (practiceIds.length == 0) {
+    return []
   }
-  let idsString = '';
+  let idsString = ''
   if (practiceIds && practiceIds.length > 0) {
-    idsString = '?';
+    idsString = '?'
     practiceIds.forEach((id, index) => {
-      idsString += `practice_ids[]=${id}${index < practiceIds.length - 1 ? '&' : ''}`;
-    });
+      idsString += `practice_ids[]=${id}${index < practiceIds.length - 1 ? '&' : ''}`
+    })
   }
   const url = `/api/user/practices/v1/practices${idsString}`
   return await fetchHandler(url, 'GET', null)
 }
 
 function fetchAbsolute(url, params) {
-  if (globalConfig.railcontentConfig.authToken) {
-    params.headers['Authorization'] = `Bearer ${globalConfig.railcontentConfig.authToken}`
+  if (globalConfig.sessionConfig.authToken) {
+    params.headers['Authorization'] = `Bearer ${globalConfig.sessionConfig.authToken}`
   }
 
-  if (globalConfig.railcontentConfig.baseUrl) {
+  if (globalConfig.baseUrl) {
     if (url.startsWith('/')) {
-      return fetch(globalConfig.railcontentConfig.baseUrl + url, params)
+      return fetch(globalConfig.baseUrl + url, params)
     }
   }
   return fetch(url, params)
@@ -1239,9 +1236,10 @@ function fetchAbsolute(url, params) {
 export async function fetchHandler(url, method = 'get', dataVersion = null, body = null) {
   return fetchJSONHandler(
     url,
-    globalConfig.railcontentConfig.token,
-    globalConfig.railcontentConfig.baseUrl,
+    globalConfig.sessionConfig.token,
+    globalConfig.baseUrl,
     method,
     dataVersion,
-    body)
+    body
+  )
 }

package/src/services/recommendations.js

@@ -3,7 +3,7 @@
  */
 
 import { globalConfig } from './config.js'
-import { fetchJSONHandler} from '../lib/httpHelper.js'
+import { fetchJSONHandler } from '../lib/httpHelper.js'
 
 /**
  * Exported functions that are excluded from index generation.
@@ -30,9 +30,9 @@ export async function fetchSimilarItems(content_id, brand, count = 10) {
   }
 
   let data = {
-    'brand': brand,
-    'content_ids': content_id,
-    'num_similar': count,
+    brand: brand,
+    content_ids: content_id,
+    num_similar: count,
   }
   const url = `/similar_items/`
   try {
@@ -64,15 +64,18 @@ export async function rankCategories(brand, categories) {
     return []
   }
   let data = {
-    'brand': brand,
-    'user_id': globalConfig.railcontentConfig.userId,
-    'playlists': categories,
+    brand: brand,
+    user_id: globalConfig.sessionConfig.userId,
+    playlists: categories,
   }
   const url = `/rank_each_list/`
   try {
     const response = await fetchHandler(url, 'POST', data)
     let rankedCategories = {}
-    response['ranked_playlists'].forEach((category) => rankedCategories[category['playlist_id']] = categories[category['playlist_id']])
+    response['ranked_playlists'].forEach(
+      (category) =>
+        (rankedCategories[category['playlist_id']] = categories[category['playlist_id']])
+    )
     return rankedCategories
   } catch (error) {
     console.error('Fetch error:', error)
@@ -96,9 +99,9 @@ export async function rankItems(brand, content_ids) {
     return []
   }
   let data = {
-    'brand': brand,
-    'user_id': globalConfig.railcontentConfig.userId,
-    'content_ids': content_ids,
+    brand: brand,
+    user_id: globalConfig.sessionConfig.userId,
+    content_ids: content_ids,
   }
   const url = `/rank_items/`
   try {
@@ -110,14 +113,11 @@ export async function rankItems(brand, content_ids) {
   }
 }
 
-export async function recommendations(brand, {
-  page = 1,
-  limit = 10,
-} = {}) {
+export async function recommendations(brand, { page = 1, limit = 10 } = {}) {
   let data = {
-    'brand': brand,
-    'user_id': globalConfig.railcontentConfig.userId,
-    'num_recommendations': limit
+    brand: brand,
+    user_id: globalConfig.sessionConfig.userId,
+    num_recommendations: limit,
   }
   const url = `/recommendations/`
   try {
@@ -137,5 +137,5 @@ async function fetchHandler(url, method = 'get', body = null) {
     method,
     null,
     body
-    )
+  )
 }

package/src/services/sanity.js

@@ -1273,6 +1273,7 @@ export async function fetchLessonContent(railContentId) {
             chapter_timecode,
             "chapter_thumbnail_url": chapter_thumbnail_url.asset->url
           },
+          artist->,
           "instructors":instructor[]->name,
           "instructor": instructor[]->{
             "id":railcontent_id,

package/src/services/types.js

@@ -0,0 +1,50 @@
+/**
+ * @typedef {object} SanityConfig - Configuration for Sanity API.
+ *
+ * @property {string} token - The API token for authenticating with Sanity.
+ * @property {string} projectId - The project ID in Sanity.
+ * @property {string} dataset - The dataset name in Sanity.
+ * @property {string} version - The API version to use.
+ * @property {boolean} [debug=false] - Optional flag to enable debug mode.
+ * @property {boolean} [useCachedAPI=true] - Optional flag to enable or disable the use of the cached API.
+ * @property {boolean} [useDummyRailContentMethods=false] - Optional flag to use test harness for railcontent methods. Should only be used by jest tests.
+ */
+
+/**
+ * @deprecated use `config.session` and `config.baseUrl` instead. Will be removed in future versions.
+ *
+ * @typedef {object} RailcontentConfig - Configuration for user services.
+ *
+ * @property {string} token - The token for authenticating user-specific requests.
+ * @property {string} userId - The user ID for fetching user-specific data.
+ * @property {string} authToken - The bearer authorization token.
+ * @property {string} baseUrl - The url for the environment.
+ */
+
+/**
+ * @typedef {object} SessionConfig - Configuration for user session.
+ *
+ * @property {string} token - The token for authenticating user-specific requests.
+ * @property {string} userId - The user ID for fetching user-specific data.
+ * @property {string} authToken - The bearer authorization token.
+ */
+
+/**
+ * @typedef {object} RecommendationsConfig - Configuration for recommendation services.
+ *
+ * @property {string} token - The token for authenticating recommendation requests.
+ * @property {string} baseUrl - The url for the recommendation server.
+ */
+
+/**
+ * @typedef {object} Config
+ *
+ * @property {SanityConfig} sanityConfig
+ * @property {RailcontentConfig} railcontentConfig - DEPRECATED use sessionConfig and baseUrl instead.
+ * @property {SessionConfig} sessionConfig
+ * @property {RecommendationsConfig} recommendationsConfig
+ * @property {string} baseUrl - The url for the environment.
+ * @property {Object} localStorage - Cache to use for localStorage
+ * @property {boolean} isMA - Variable that tells if the library is used by MA or FEW
+ * @property {string} localTimezoneString - The local timezone string in format: America/Vancouver
+ */

package/src/services/user/management.js

@@ -1,10 +1,8 @@
 /**
- * @module User-Management
+ * @module UserManagement
  */
 import { fetchHandler } from '../railcontent.js'
 
-
-
 /**
  * Exported functions that are excluded from index generation.
  *

package/src/services/user/permissions.js

@@ -1,5 +1,5 @@
 /**
- * @module User-Permissions
+ * @module Permissions
  */
 import { setLastUpdatedTime, wasLastUpdateOlderThanXSeconds } from '../../lib/lastUpdated.js'
 import { fetchUserPermissionsData } from '../railcontent.js'

package/src/services/user/sessions.js

@@ -1,5 +1,5 @@
 /**
- * @module Session-Management
+ * @module Sessions
  */
 import { globalConfig } from '../config.js'
 import './types.js'
@@ -11,8 +11,6 @@ import './types.js'
  */
 const excludeFromGeneratedIndex = []
 
-const baseUrl = `${globalConfig.railcontentConfig.baseUrl}/api/user-management-system`
-
 /**
  * Authenticates the User.
  *
@@ -30,6 +28,7 @@ const baseUrl = `${globalConfig.railcontentConfig.baseUrl}/api/user-management-s
  *   .catch(error => console.error(error));
  */
 export async function login(email, password, deviceName, deviceToken, platform) {
+  const baseUrl = `${globalConfig.baseUrl}/api/user-management-system`
   return fetch(`${baseUrl}/v1/sessions`, {
     method: 'POST',
     headers: {
@@ -57,10 +56,11 @@ export async function login(email, password, deviceName, deviceToken, platform)
  *   .catch(error => console.error(error));
  */
 export async function logout() {
+  const baseUrl = `${globalConfig.baseUrl}/api/user-management-system`
   await fetch(`${baseUrl}/v1/sessions`, {
     method: 'DELETE',
     headers: {
-      Authorization: `Bearer ${globalConfig.railcontentConfig.authToken}`,
+      Authorization: `Bearer ${globalConfig.sessionConfig.authToken}`,
       'Content-Type': 'application/json',
     },
   })

package/src/services/user/user-management-system.js

@@ -0,0 +1,6 @@
+/**
+ * @namespace UserManagementSystem
+ * @property {module:Sessions} Sessions
+ * @property {module:Permissions} Permissions
+ * @property {module:UserManagement} UserManagement
+ */

package/test/initializeTests.js

@@ -14,6 +14,7 @@ export async function initializeTestService(useLive = false, isAdmin = false) {
     token = data['token']
     userId = data['userId']
   }
+
   const config = {
     sanityConfig: {
       token: process.env.SANITY_API_TOKEN,
@@ -24,17 +25,18 @@ export async function initializeTestService(useLive = false, isAdmin = false) {
       debug: process.env.DEBUG === 'true' || false,
       useDummyRailContentMethods: true,
     },
-    railcontentConfig: {
-      baseUrl: process.env.RAILCONTENT_BASE_URL,
+    sessionConfig: {
+      token: token,
       userId: userId,
       authToken: token,
     },
+    baseUrl: process.env.RAILCONTENT_BASE_URL,
     localStorage: new LocalStorageMock(),
     isMA: true,
     recommendationsConfig: {
       token: process.env.HUGGINGFACE_TOKEN,
-      baseUrl: process.env.HUGGINGFACE_URL
-    }
+      baseUrl: process.env.HUGGINGFACE_URL,
+    },
   }
   initializeService(config)
 

package/test/sanityQueryService.test.js

@@ -148,9 +148,19 @@ describe('Sanity Queries', function() {
   })
 
   test('fetchLessonContent', async () => {
-    const id = 380094
+    const id = 392820
+    const response = await fetchLessonContent(id)
+    expect(response.id).toBe(id)
+    expect(response.video.type).toBeDefined()
+  })
+
+  test('fetchLessonContent-PlayAlong-containts-array-of-videos', async () => {
+    const id = 9184
     const response = await fetchLessonContent(id)
     expect(response.id).toBe(id)
+    expect(response.video.length).toBeGreaterThanOrEqual(1)
+    const firstElement = response.video.find(() => true)
+    expect(firstElement.version_name).toBeDefined()
   })
 
   test('fetchAllSongsInProgress', async () => {

package/.yarnrc.yml

@@ -1 +0,0 @@
-nodeLinker: node-modules