musora-content-services 1.3.21 → 1.4.1

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.4.1](https://github.com/railroadmedia/musora-content-services/compare/v1.4.0...v1.4.1) (2025-03-25)
+
+## [1.4.0](https://github.com/railroadmedia/musora-content-services/compare/v1.3.21...v1.4.0) (2025-03-24)
+
 ### [1.3.21](https://github.com/railroadmedia/musora-content-services/compare/v1.3.20...v1.3.21) (2025-03-21)
 
 ### [1.3.20](https://github.com/railroadmedia/musora-content-services/compare/v1.3.19...v1.3.20) (2025-03-21)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musora-content-services",
-  "version": "1.3.21",
+  "version": "1.4.1",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "type": "module",

package/src/index.d.ts

@@ -2,7 +2,8 @@
 
 import {
 	globalConfig,
-	initializeService
+	initializeService,
+	setUserMetadata
 } from './services/config.js';
 
 import {
@@ -32,6 +33,7 @@ import {
 } from './services/dataContext.js';
 
 import {
+	clearLastUpdatedTime,
 	setLastUpdatedTime,
 	wasLastUpdateOlderThanXSeconds
 } from './services/lastUpdated.js';
@@ -135,6 +137,7 @@ import {
 	fetchPlayAlongsCount,
 	fetchRelatedLessons,
 	fetchRelatedSongs,
+	fetchRelatedTutorials,
 	fetchReturning,
 	fetchSanity,
 	fetchScheduledReleases,
@@ -148,8 +151,10 @@ import {
 } from './services/sanity.js';
 
 import {
+	clearPermissionsData,
 	fetchUserPermissions,
-	reset
+	reset,
+	updatePermissionsData
 } from './services/userPermissions.js';
 
 declare module 'musora-content-services' {
@@ -157,6 +162,8 @@ declare module 'musora-content-services' {
 		addItemToPlaylist,
 		assignmentStatusCompleted,
 		assignmentStatusReset,
+		clearLastUpdatedTime,
+		clearPermissionsData,
 		contentStatusCompleted,
 		contentStatusReset,
 		countAssignmentsAndLessons,
@@ -217,6 +224,7 @@ declare module 'musora-content-services' {
 		fetchPlaylistItems,
 		fetchRelatedLessons,
 		fetchRelatedSongs,
+		fetchRelatedTutorials,
 		fetchReturning,
 		fetchSanity,
 		fetchScheduledReleases,
@@ -272,9 +280,11 @@ declare module 'musora-content-services' {
 		reset,
 		setLastUpdatedTime,
 		setStudentViewForUser,
+		setUserMetadata,
 		similarItems,
 		unlikeContent,
 		unpinPlaylist,
+		updatePermissionsData,
 		updatePlaylist,
 		updatePlaylistItem,
 		verifyLocalDataContext,

package/src/index.js

@@ -2,7 +2,8 @@
 
 import {
 	globalConfig,
-	initializeService
+	initializeService,
+	setUserMetadata
 } from './services/config.js';
 
 import {
@@ -32,6 +33,7 @@ import {
 } from './services/dataContext.js';
 
 import {
+	clearLastUpdatedTime,
 	setLastUpdatedTime,
 	wasLastUpdateOlderThanXSeconds
 } from './services/lastUpdated.js';
@@ -135,6 +137,7 @@ import {
 	fetchPlayAlongsCount,
 	fetchRelatedLessons,
 	fetchRelatedSongs,
+	fetchRelatedTutorials,
 	fetchReturning,
 	fetchSanity,
 	fetchScheduledReleases,
@@ -148,14 +151,18 @@ import {
 } from './services/sanity.js';
 
 import {
+	clearPermissionsData,
 	fetchUserPermissions,
-	reset
+	reset,
+	updatePermissionsData
 } from './services/userPermissions.js';
 
 export {
 	addItemToPlaylist,
 	assignmentStatusCompleted,
 	assignmentStatusReset,
+	clearLastUpdatedTime,
+	clearPermissionsData,
 	contentStatusCompleted,
 	contentStatusReset,
 	countAssignmentsAndLessons,
@@ -216,6 +223,7 @@ export {
 	fetchPlaylistItems,
 	fetchRelatedLessons,
 	fetchRelatedSongs,
+	fetchRelatedTutorials,
 	fetchReturning,
 	fetchSanity,
 	fetchScheduledReleases,
@@ -271,9 +279,11 @@ export {
 	reset,
 	setLastUpdatedTime,
 	setStudentViewForUser,
+	setUserMetadata,
 	similarItems,
 	unlikeContent,
 	unpinPlaylist,
+	updatePermissionsData,
 	updatePlaylist,
 	updatePlaylistItem,
 	verifyLocalDataContext,

package/src/services/config.js

@@ -1,6 +1,8 @@
 /**
  * @module Config
  */
+import { verifyLocalDataContext } from './dataContext.js'
+import { updatePermissionsData } from './userPermissions.js'
 
 export let globalConfig = {
   sanityConfig: {},
@@ -76,3 +78,12 @@ export function initializeService(config) {
   globalConfig.localTimezoneString = config.localTimezoneString || null
   globalConfig.recommendationsConfig = config.recommendationsConfig
 }
+
+export function setUserMetadata(userMetaData) {
+  updatePermissionsData(userMetaData.permissionsData)
+
+  const userDataVersions = userMetaData.userDataVersions
+  for (let i = 0; i < userDataVersions.length; i++) {
+    verifyLocalDataContext(userDataVersions[i].dataVersionKey, userDataVersions[i].currentVersion)
+  }
+}

package/src/services/lastUpdated.js

@@ -5,7 +5,12 @@ import { globalConfig } from './config.js'
  *
  * @type {string[]}
  */
-const excludeFromGeneratedIndex = ['wasLastUpdateOlderThanXSeconds', 'setLastUpdatedTime']
+const excludeFromGeneratedIndex = [
+  'wasLastUpdateOlderThanXSeconds',
+  'setLastUpdatedTime',
+  'clearLastUpdatedTime',
+]
+
 export function wasLastUpdateOlderThanXSeconds(seconds, key) {
   let lastUpdated = globalConfig.localStorage.getItem(key)
   if (!lastUpdated) return false
@@ -16,3 +21,7 @@ export function wasLastUpdateOlderThanXSeconds(seconds, key) {
 export function setLastUpdatedTime(key) {
   globalConfig.localStorage.setItem(key, new Date().getTime()?.toString())
 }
+
+export function clearLastUpdatedTime(key) {
+  globalConfig.localStorage.removeItem(key)
+}

package/src/services/sanity.js

@@ -1299,7 +1299,7 @@ export async function fetchRelatedLessons(railContentId, brand) {
   const childrenFilter = await new FilterBuilder(``, { isChildrenFilter: true }).buildFilter()
   const queryFields = `_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type, "genre": genre[]->name`
   const queryFieldsWithSort = queryFields + ', sort'
-  const query = `*[railcontent_id == ${railContentId} && brand == "${brand}" && (!defined(permission) || references(*[_type=='permission']._id))]{
+  const query = `*[railcontent_id == ${railContentId} && brand == "${brand}"]{
    _type, parent_type, railcontent_id,
     "related_lessons" : array::unique([
       ...(*[${filterNeighbouringSiblings}][0].child[${childrenFilter}]->{${queryFields}}),
@@ -1312,6 +1312,137 @@ export async function fetchRelatedLessons(railContentId, brand) {
   return fetchSanity(query, false)
 }
 
+/**
+ * fetch song tutorials related to a specific tutorial, by genre and difficulty.
+ * @param {number} railContentId
+ * @param {string} brand
+ * @returns {Promise<Object|null>}
+ */
+export async function fetchRelatedTutorials(railContentId, brand) {
+  const parentObject = await fetchParentData(railContentId, brand)
+  const relatedLessonObject = await fetchRelatedLessonsSectionData(parentObject)
+  return formatForResponse(parentObject, relatedLessonObject)
+}
+
+/**
+ * fetch data of parent content, and combine with some of current content
+ * @param {number} railContentId
+ * @param {string} brand
+ * @returns {Promise<Object|null>}
+ */
+async function fetchParentData(railContentId, brand) {
+  const parentQuery = buildQueryForFetch(railContentId, brand)
+  return await fetchSanity(parentQuery, false)
+}
+
+/**
+ * build query for fetch of parent data
+ * @param {number} railContentId
+ * @param {string} brand
+ * @returns {string}
+ */
+function buildQueryForFetch(railContentId, brand) {
+  const projections = `railcontent_id, _type, parent_type, parent_content_data, difficulty_string, brand`
+  return `*[railcontent_id == ${railContentId} && brand == "${brand}"]{${projections}}`
+}
+
+/**
+ * fetch related lessons content
+ * @param {Object} currentContent
+ * @returns {Promise<Object|null>}
+ */
+async function fetchRelatedLessonsSectionData(currentContent) {
+  const query = await buildRelatedLessonsQuery(currentContent)
+  return await fetchSanity(query, true)
+}
+
+/**
+ * build query for related lessons by content type
+ * @param {Object} currentContent
+ * @returns {Promise<string>}
+ */
+async function buildRelatedLessonsQuery(currentContent) {
+  const defaultProjectionsAndSorting = `{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type,genre}|order(published_on desc, title asc)[0...10]`
+  const currentContentData = await getCurrentContentDataForQuery(currentContent)
+  const tutorialQuery = await buildSubQueryForFetch(currentContentData.parentType, currentContentData.brand, currentContentData.parentId, currentContentData.difficulty_string, currentContentData.genres)
+  const quickTipQuery = await buildSubQueryForFetch("quick-tips", currentContentData.brand, currentContentData.parentId, currentContentData.difficulty_string)
+  const songQuery = await buildSubQueryForFetch("song", currentContentData.brand, currentContentData.parentId, currentContentData.difficulty_string)
+  return `[...*[${tutorialQuery}]${defaultProjectionsAndSorting}, ...*[${quickTipQuery}]${defaultProjectionsAndSorting}, ...*[${songQuery}]${defaultProjectionsAndSorting}, ]`
+}
+
+/**
+ * get data, primarily brand, for use in the related_lessons query
+ * @param {Object} currentContent
+ * @returns {Object}
+ */
+async function getCurrentContentDataForQuery(currentContent) {
+  const currentContentData = groupCurrentContentData(currentContent)
+  const genres = await fetchParentContentGenres(currentContentData)
+  const genreString = formatGenresToString(genres)
+  return {...currentContentData,
+    genres: genreString
+  }
+}
+
+/**
+ * group and return specific data retrieved from parent data
+ * @param {Object} currentContent
+ * @returns {Object}
+ */
+function groupCurrentContentData(currentContent) {
+  return {
+    parentType: currentContent.parent_type,
+    parentId: currentContent.parent_content_data[0].id,
+    difficulty_string: currentContent.difficulty_string,
+    brand: currentContent.brand
+  }
+}
+
+/**
+ * fetch genres of parent content
+ * @param {Object} contentData
+ * @returns {Promise<Object|null>}
+ */
+async function fetchParentContentGenres(contentData) {
+  const genreQuery = `*[_type == "${contentData.parentType}" && brand == "${contentData.brand}" && railcontent_id == ${contentData.parentId}][0]{"genre":genre[]->_id}`
+  return fetchSanity(genreQuery, true)
+}
+
+/**
+ * combine data into Object
+ * @param {Object} genres
+ * @returns {string}
+ */
+function formatGenresToString(genres) {
+  return JSON.stringify(genres['genre']).replace(/[\[\]]/g, '')
+}
+
+/**
+ * build filters for use in related_lessons query
+ * @param {string} type
+ * @param {string} brand
+ * @param {number} id
+ * @param {string} difficulty
+ * @param {string|null} genres
+ * @returns {Promise<string>}
+ */
+async function buildSubQueryForFetch(type, brand, id, difficulty, genres = null) {
+  const genreString = genres ? `&& references([${genres}])` : ``
+  return new FilterBuilder(`_type == "${type}" && brand == "${brand}" && railcontent_id != ${id} && difficulty_string == "${difficulty}" ${genreString}`).buildFilter()
+}
+
+/**
+ * format return Object for use by page
+ * @param {Object} parentObject
+ * @param {Object} relatedLessonObject
+ * @returns {Object}
+ */
+function formatForResponse(parentObject, relatedLessonObject) {
+  return {...parentObject,
+    related_lessons: relatedLessonObject
+  }
+}
+
 /**
  * Fetch all packs.
  * @param {string} brand - The brand for which to fetch packs.

package/src/services/userPermissions.js

@@ -1,5 +1,9 @@
 import { fetchUserPermissionsData } from './railcontent.js'
-import { setLastUpdatedTime, wasLastUpdateOlderThanXSeconds } from './lastUpdated.js'
+import {
+  clearLastUpdatedTime,
+  setLastUpdatedTime,
+  wasLastUpdateOlderThanXSeconds,
+} from './lastUpdated.js'
 
 /**
  * Exported functions that are excluded from index generation.
@@ -22,3 +26,13 @@ export async function fetchUserPermissions() {
 export async function reset() {
   userPermissionsPromise = null
 }
+
+export function updatePermissionsData(permissionsData) {
+  userPermissionsPromise = permissionsData
+  setLastUpdatedTime(lastUpdatedKey)
+}
+
+export function clearPermissionsData() {
+  userPermissionsPromise = null
+  clearLastUpdatedTime(lastUpdatedKey)
+}

package/test/config.test.js

@@ -0,0 +1,29 @@
+import { setUserMetadata, verifyLocalDataContext } from '../src/services/config.js'
+import { initializeTestService } from './initializeTests.js'
+import { fetchUserPermissions, updatePermissionsData } from '../src/services/userPermissions.js'
+
+describe('config', function () {
+  beforeEach(() => {
+    initializeTestService()
+  })
+
+  test('setUserMetadata', async () => {
+    const newPermissions = [80, 81, 82]
+    const isAdminUpdate = true
+
+    const userMetadata = {
+      permissionsData: { permissions: newPermissions, isAdmin: isAdminUpdate },
+      userDataVersions: [
+        { dataVersionKey: 1, currentVersion: 2 },
+        { dataVersionKey: 2, currentVersion: 3 },
+      ],
+    }
+
+    setUserMetadata(userMetadata)
+
+    let result = await fetchUserPermissions()
+
+    expect(result.permissions).toStrictEqual(newPermissions)
+    expect(result.isAdmin).toStrictEqual(isAdminUpdate)
+  })
+})

package/test/initializeTests.js

@@ -1,5 +1,6 @@
 import { globalConfig, initializeService } from '../src'
 import { LocalStorageMock } from './localStorageMock'
+import { clearPermissionsData } from '../src/services/userPermissions.js'
 
 const railContentModule = require('../src/services/railcontent.js')
 let token = null
@@ -36,6 +37,7 @@ export async function initializeTestService(useLive = false) {
   let mock = jest.spyOn(railContentModule, 'fetchUserPermissionsData')
   let testData = { permissions: [78, 91, 92], isAdmin: false }
   mock.mockImplementation(() => testData)
+  clearPermissionsData()
 }
 
 async function fetchLoginToken(email, password) {

package/test/sanityQueryService.test.js

@@ -29,6 +29,8 @@ const {
   fetchFoundation,
   fetchMethod,
   fetchRelatedLessons,
+  fetchRelatedTutorials,
+  newFetchRelatedTutorials,
   fetchAllPacks,
   fetchPackAll,
   fetchLessonContent,
@@ -288,6 +290,20 @@ describe('Sanity Queries', function () {
     expect(isMatch).toBeTruthy()
   })
 
+  test('fetchRelatedTutorials', async () => {
+    const railContentId = 387379
+    const brand = "pianote"
+    const queryResult = await fetchRelatedTutorials(railContentId, brand)
+    console.log(queryResult)
+    expect(typeof queryResult).toBe('object') //check structure of parent
+    expect(typeof queryResult.parent_content_data).toBe('object') //check structure of parentdata
+    expect(typeof queryResult.related_lessons).toBe('object') //check structure of relatedlessons
+    expect(queryResult.related_lessons[0]._id).toBe('song-tutorial_333333') //check there is a first element and matches
+    expect(queryResult.related_lessons[6]._id).toBe('quick-tips_390225') //check first quiktips
+    expect(queryResult.related_lessons[16]._id).toBe('0c5aa2d7-91a3-4349-b999-9ed9dd916e8e') //check first songs
+    expect(queryResult.related_lessons.length).toBe(26)
+  })
+
   test('fetchRelatedLessons-quick-tips', async () => {
     const id = 406213
     const response = await fetchRelatedLessons(id, 'singeo')
@@ -308,8 +324,6 @@ describe('Sanity Queries', function () {
     expect(Array.isArray(relatedLessons)).toBe(true)
     relatedLessons.forEach((lesson) => {
       expect(lesson._type).toBe('in-rhythm')
-      expect(lesson.sort).toBeGreaterThan(episode)
-      episode = lesson.sort
     })
   })
 

package/test/userPermissions.test.js

@@ -1,5 +1,9 @@
 const { fetchUserPermissions } = require('../src/services/userPermissions')
 const { initializeTestService } = require('./initializeTests')
+const {
+  updatePermissionsData,
+  clearPermissionsData,
+} = require('../src/services/userPermissions.js')
 
 describe('userPermissions', function () {
   beforeEach(() => {
@@ -16,4 +20,25 @@ describe('userPermissions', function () {
     expect(result.isAdmin).toStrictEqual(false)
     expect(result).toBe(result2)
   })
+
+  test('updatePermissionsData', async () => {
+    const newPermissions = [80, 81, 82]
+    const isAdminUpdate = true
+
+    // Call the function to update permissions
+    updatePermissionsData({
+      permissions: newPermissions,
+      isAdmin: isAdminUpdate,
+    })
+    let result = await fetchUserPermissions()
+
+    expect(result.permissions).toStrictEqual(newPermissions)
+    expect(result.isAdmin).toStrictEqual(isAdminUpdate)
+
+    clearPermissionsData()
+    result = await fetchUserPermissions()
+
+    expect(result.permissions).toStrictEqual([78, 91, 92])
+    expect(result.isAdmin).toStrictEqual(false)
+  })
 })