musora-content-services 2.3.3 → 2.3.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/docs/ContentOrganization.html +245 -0
  3. package/docs/Gamification.html +2 -2
  4. package/docs/UserManagement.html +269 -0
  5. package/docs/UserManagementSystem.html +293 -0
  6. package/docs/api_types.js.html +2 -2
  7. package/docs/config.js.html +16 -22
  8. package/docs/content-org_content-org.js.html +76 -0
  9. package/docs/content-org_playlists-types.js.html +2 -2
  10. package/docs/content-org_playlists.js.html +4 -6
  11. package/docs/content.js.html +6 -3
  12. package/docs/gamification_awards.js.html +2 -2
  13. package/docs/gamification_gamification.js.html +2 -2
  14. package/docs/gamification_types.js.html +2 -2
  15. package/docs/global.html +2 -2
  16. package/docs/global.html#User +293 -0
  17. package/docs/index.html +2 -2
  18. package/docs/module-Awards.html +2 -2
  19. package/docs/module-Config.html +83 -616
  20. package/docs/module-Content-Services-V2.html +3 -3
  21. package/docs/module-Permissions.html +406 -0
  22. package/docs/module-Playlists.html +6 -6
  23. package/docs/module-Railcontent-Services.html +57 -57
  24. package/docs/module-Sanity-Services.html +34 -34
  25. package/docs/module-Sessions.html +575 -0
  26. package/docs/module-User-Management.html +490 -0
  27. package/docs/module-UserManagement.html +490 -0
  28. package/docs/railcontent.js.html +82 -74
  29. package/docs/sanity.js.html +12 -9
  30. package/docs/types.js.html +122 -0
  31. package/docs/user_management.js.html +105 -0
  32. package/docs/user_permissions.js.html +3 -3
  33. package/docs/user_sessions.js.html +6 -6
  34. package/docs/user_types.js.html +2 -2
  35. package/docs/user_user-management-system.js.html +78 -0
  36. package/docs/user_user-management.js.html +78 -0
  37. package/package.json +1 -1
  38. package/src/services/config.js +13 -20
  39. package/src/services/content-org/content-org.js +4 -0
  40. package/src/services/content-org/playlists.js +2 -4
  41. package/src/services/forum.js +8 -4
  42. package/src/services/railcontent.js +41 -43
  43. package/src/services/recommendations.js +19 -19
  44. package/src/services/types.js +50 -0
  45. package/src/services/user/management.js +1 -3
  46. package/src/services/user/permissions.js +1 -1
  47. package/src/services/user/sessions.js +4 -4
  48. package/src/services/user/user-management-system.js +6 -0
  49. package/src/services/userActivity.js +7 -9
  50. package/test/initializeTests.js +6 -4
  51. package/docs/Playlists.html +0 -192
  52. package/docs/content-org_types.js.html +0 -112
  53. package/docs/module-Content-Organization-Playlists.html +0 -194
  54. package/docs/module-Content-Organization.html +0 -976
  55. package/docs/module-playlists.html +0 -1878
  56. package/docs/module-playlists_.html +0 -108
package/docs/module-Config.html CHANGED
@@ -29,7 +29,7 @@
29
29
  <nav >
30
30
 
31
31
 
32
- <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#.fetchAwardsForUser">fetchAwardsForUser</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.countAssignmentsAndLessons">countAssignmentsAndLessons</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistItem">deletePlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistLike">deletePlaylistLike</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeIndexMetadata">fetchChallengeIndexMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeLessonData">fetchChallengeLessonData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeMetadata">fetchChallengeMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeUserActiveChallenges">fetchChallengeUserActiveChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedChallenges">fetchCompletedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchOwnedChallenges">fetchOwnedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPinnedPlaylists">fetchPinnedPlaylists</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItem">fetchPlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserChallengeProgress">fetchUserChallengeProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.pinPlaylist">pinPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesCommunityNotification">postChallengesCommunityNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnroll">postChallengesEnroll</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnrollmentNotification">postChallengesEnrollmentNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesHideCompletedBanner">postChallengesHideCompletedBanner</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesLeave">postChallengesLeave</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSetStartDate">postChallengesSetStartDate</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSoloNotification">postChallengesSoloNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesUnlock">postChallengesUnlock</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unpinPlaylist">unpinPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.updatePlaylistItem">updatePlaylistItem</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchParentForDownload">fetchParentForDownload</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getNextAndPreviousQuarterDates">getNextAndPreviousQuarterDates</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li><li data-type='method'><a href="module-Sanity-Services.html#~handleCustomFetchAll">handleCustomFetchAll</a></li></ul></li><li><a href="module-Session-Management.html">Session-Management</a><ul class='methods'><li data-type='method'><a href="module-Session-Management.html#.login">login</a></li><li data-type='method'><a href="module-Session-Management.html#.logout">logout</a></li></ul></li><li><a href="module-User-Permissions.html">User-Permissions</a><ul class='methods'><li data-type='method'><a href="module-User-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-User-Permissions.html#.reset">reset</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="Content-Organization.html">Content-Organization</a></li><li><a href="Gamification.html">Gamification</a></li></ul><h3><a href="global.html">Global</a></h3>
32
+ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#.fetchAwardsForUser">fetchAwardsForUser</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.countAssignmentsAndLessons">countAssignmentsAndLessons</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistItem">deletePlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistLike">deletePlaylistLike</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeIndexMetadata">fetchChallengeIndexMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeLessonData">fetchChallengeLessonData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeMetadata">fetchChallengeMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeUserActiveChallenges">fetchChallengeUserActiveChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedChallenges">fetchCompletedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchOwnedChallenges">fetchOwnedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPinnedPlaylists">fetchPinnedPlaylists</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItem">fetchPlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserChallengeProgress">fetchUserChallengeProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.pinPlaylist">pinPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesCommunityNotification">postChallengesCommunityNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnroll">postChallengesEnroll</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnrollmentNotification">postChallengesEnrollmentNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesHideCompletedBanner">postChallengesHideCompletedBanner</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesLeave">postChallengesLeave</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSetStartDate">postChallengesSetStartDate</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSoloNotification">postChallengesSoloNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesUnlock">postChallengesUnlock</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unpinPlaylist">unpinPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.updatePlaylistItem">updatePlaylistItem</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchParentForDownload">fetchParentForDownload</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getNextAndPreviousQuarterDates">getNextAndPreviousQuarterDates</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li><li data-type='method'><a href="module-Sanity-Services.html#~handleCustomFetchAll">handleCustomFetchAll</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3><a href="global.html">Global</a></h3>
33
33
 
34
34
  </nav>
35
35
 
@@ -79,6 +79,77 @@
79
79
 
80
80
 
81
81
 
82
+ <h4 class="name" id=".globalConfig"><span class="type-signature type-signature-static">(static) </span>globalConfig<span class="type-signature"> :Config</span></h4>
83
+
84
+
85
+
86
+
87
+
88
+ <dl class="details">
89
+
90
+
91
+
92
+ <dt class="tag-source">Source:</dt>
93
+ <dd class="tag-source"><ul class="dummy"><li>
94
+ <a href="config.js.html">config.js</a>, <a href="config.js.html#line8">line 8</a>
95
+ </li></ul></dd>
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+ </dl>
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+ <h5 class="h5-types">Type:</h5>
136
+ <ul>
137
+ <li>
138
+
139
+ <span class="param-type">Config</span>
140
+
141
+
142
+
143
+ </li>
144
+ </ul>
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
82
153
  <h4 class="name" id="~excludeFromGeneratedIndex"><span class="type-signature type-signature-inner, constant">(inner, constant) </span>excludeFromGeneratedIndex<span class="type-signature"> :Array.&lt;string></span></h4>
83
154
 
84
155
 
@@ -94,7 +165,7 @@
94
165
 
95
166
  <dt class="tag-source">Source:</dt>
96
167
  <dd class="tag-source"><ul class="dummy"><li>
97
- <a href="config.js.html">config.js</a>, <a href="config.js.html#line19">line 19</a>
168
+ <a href="config.js.html">config.js</a>, <a href="config.js.html#line23">line 23</a>
98
169
  </li></ul></dd>
99
170
 
100
171
 
@@ -183,7 +254,7 @@ This function must be called before using any other functions in this library.</
183
254
 
184
255
  <dt class="tag-source">Source:</dt>
185
256
  <dd class="tag-source"><ul class="dummy"><li>
186
- <a href="config.js.html">config.js</a>, <a href="config.js.html#line71">line 71</a>
257
+ <a href="config.js.html">config.js</a>, <a href="config.js.html#line62">line 62</a>
187
258
  </li></ul></dd>
188
259
 
189
260
 
@@ -246,10 +317,16 @@ initializeService({
246
317
  baseUrl: 'https://web-staging-one.musora.com',
247
318
  authToken 'your-auth-token',
248
319
  },
320
+ sessionConfig: {
321
+ token: 'your-user-api-token',
322
+ userId: 'current-user-id',
323
+ authToken 'your-auth-token',
324
+ },
249
325
  recommendationsConfig: {
250
326
  token: 'your-user-api-token',
251
327
  baseUrl: 'https://MusoraProductDepartment-PWGenerator.hf.space',
252
328
  },
329
+ baseUrl: 'https://web-staging-one.musora.com',
253
330
  localStorage: localStorage,
254
331
  isMA: false,
255
332
  });</code></pre>
@@ -288,205 +365,7 @@ initializeService({
288
365
  <td class="type">
289
366
 
290
367
 
291
- <span class="param-type">Object</span>
292
-
293
-
294
-
295
-
296
- </td>
297
-
298
-
299
-
300
-
301
-
302
- <td class="description last">Configuration object containing API settings.
303
- <h6>Properties</h6>
304
-
305
-
306
- <table class="params">
307
- <thead>
308
- <tr>
309
-
310
- <th>Name</th>
311
-
312
-
313
- <th>Type</th>
314
-
315
-
316
-
317
-
318
-
319
- <th class="last">Description</th>
320
- </tr>
321
- </thead>
322
-
323
- <tbody>
324
-
325
-
326
- <tr>
327
-
328
- <td class="name"><code>sanityConfig</code></td>
329
-
330
-
331
- <td class="type">
332
-
333
-
334
- <span class="param-type">Object</span>
335
-
336
-
337
-
338
-
339
- </td>
340
-
341
-
342
-
343
-
344
-
345
- <td class="description last">Configuration for Sanity API.
346
- <h6>Properties</h6>
347
-
348
-
349
- <table class="params">
350
- <thead>
351
- <tr>
352
-
353
- <th>Name</th>
354
-
355
-
356
- <th>Type</th>
357
-
358
-
359
- <th>Attributes</th>
360
-
361
-
362
-
363
- <th>Default</th>
364
-
365
-
366
- <th class="last">Description</th>
367
- </tr>
368
- </thead>
369
-
370
- <tbody>
371
-
372
-
373
- <tr>
374
-
375
- <td class="name"><code>token</code></td>
376
-
377
-
378
- <td class="type">
379
-
380
-
381
- <span class="param-type">string</span>
382
-
383
-
384
-
385
-
386
- </td>
387
-
388
-
389
- <td class="attributes">
390
-
391
-
392
-
393
-
394
-
395
- </td>
396
-
397
-
398
-
399
- <td class="default">
400
-
401
- </td>
402
-
403
-
404
- <td class="description last">The API token for authenticating with Sanity.</td>
405
- </tr>
406
-
407
-
408
-
409
- <tr>
410
-
411
- <td class="name"><code>projectId</code></td>
412
-
413
-
414
- <td class="type">
415
-
416
-
417
- <span class="param-type">string</span>
418
-
419
-
420
-
421
-
422
- </td>
423
-
424
-
425
- <td class="attributes">
426
-
427
-
428
-
429
-
430
-
431
- </td>
432
-
433
-
434
-
435
- <td class="default">
436
-
437
- </td>
438
-
439
-
440
- <td class="description last">The project ID in Sanity.</td>
441
- </tr>
442
-
443
-
444
-
445
- <tr>
446
-
447
- <td class="name"><code>dataset</code></td>
448
-
449
-
450
- <td class="type">
451
-
452
-
453
- <span class="param-type">string</span>
454
-
455
-
456
-
457
-
458
- </td>
459
-
460
-
461
- <td class="attributes">
462
-
463
-
464
-
465
-
466
-
467
- </td>
468
-
469
-
470
-
471
- <td class="default">
472
-
473
- </td>
474
-
475
-
476
- <td class="description last">The dataset name in Sanity.</td>
477
- </tr>
478
-
479
-
480
-
481
- <tr>
482
-
483
- <td class="name"><code>version</code></td>
484
-
485
-
486
- <td class="type">
487
-
488
-
489
- <span class="param-type">string</span>
368
+ <span class="param-type">Config</span>
490
369
 
491
370
 
492
371
 
@@ -494,422 +373,10 @@ initializeService({
494
373
  </td>
495
374
 
496
375
 
497
- <td class="attributes">
498
-
499
-
500
-
501
-
502
-
503
- </td>
504
-
505
-
506
-
507
- <td class="default">
508
-
509
- </td>
510
-
511
-
512
- <td class="description last">The API version to use.</td>
513
- </tr>
514
-
515
-
516
376
 
517
- <tr>
518
-
519
- <td class="name"><code>debug</code></td>
520
377
 
521
378
 
522
- <td class="type">
523
-
524
-
525
- <span class="param-type">boolean</span>
526
-
527
-
528
-
529
-
530
- </td>
531
-
532
-
533
- <td class="attributes">
534
-
535
- &lt;optional><br>
536
-
537
-
538
-
539
-
540
-
541
- </td>
542
-
543
-
544
-
545
- <td class="default">
546
-
547
- <code>false</code>
548
-
549
- </td>
550
-
551
-
552
- <td class="description last">Optional flag to enable debug mode.</td>
553
- </tr>
554
-
555
-
556
-
557
- <tr>
558
-
559
- <td class="name"><code>useCachedAPI</code></td>
560
-
561
-
562
- <td class="type">
563
-
564
-
565
- <span class="param-type">boolean</span>
566
-
567
-
568
-
569
-
570
- </td>
571
-
572
-
573
- <td class="attributes">
574
-
575
- &lt;optional><br>
576
-
577
-
578
-
579
-
580
-
581
- </td>
582
-
583
-
584
-
585
- <td class="default">
586
-
587
- <code>true</code>
588
-
589
- </td>
590
-
591
-
592
- <td class="description last">Optional flag to enable or disable the use of the cached API.</td>
593
- </tr>
594
-
595
-
596
-
597
- <tr>
598
-
599
- <td class="name"><code>useDummyRailContentMethods</code></td>
600
-
601
-
602
- <td class="type">
603
-
604
-
605
- <span class="param-type">boolean</span>
606
-
607
-
608
-
609
-
610
- </td>
611
-
612
-
613
- <td class="attributes">
614
-
615
- &lt;optional><br>
616
-
617
-
618
-
619
-
620
-
621
- </td>
622
-
623
-
624
-
625
- <td class="default">
626
-
627
- <code>false</code>
628
-
629
- </td>
630
-
631
-
632
- <td class="description last">Optional flag to use test harness for railcontent methods. Should only be used by jest tests.</td>
633
- </tr>
634
-
635
-
636
- </tbody>
637
- </table>
638
-
639
- </td>
640
- </tr>
641
-
642
-
643
-
644
- <tr>
645
-
646
- <td class="name"><code>railcontentConfig</code></td>
647
-
648
-
649
- <td class="type">
650
-
651
-
652
- <span class="param-type">Object</span>
653
-
654
-
655
-
656
-
657
- </td>
658
-
659
-
660
-
661
-
662
-
663
- <td class="description last">Configuration for user services.
664
- <h6>Properties</h6>
665
-
666
-
667
- <table class="params">
668
- <thead>
669
- <tr>
670
-
671
- <th>Name</th>
672
-
673
-
674
- <th>Type</th>
675
-
676
-
677
-
678
-
679
-
680
- <th class="last">Description</th>
681
- </tr>
682
- </thead>
683
-
684
- <tbody>
685
-
686
-
687
- <tr>
688
-
689
- <td class="name"><code>token</code></td>
690
-
691
-
692
- <td class="type">
693
-
694
-
695
- <span class="param-type">string</span>
696
-
697
-
698
-
699
-
700
- </td>
701
-
702
-
703
-
704
-
705
-
706
- <td class="description last">The token for authenticating user-specific requests.</td>
707
- </tr>
708
-
709
-
710
-
711
- <tr>
712
-
713
- <td class="name"><code>userId</code></td>
714
-
715
-
716
- <td class="type">
717
-
718
-
719
- <span class="param-type">string</span>
720
-
721
-
722
-
723
-
724
- </td>
725
-
726
-
727
-
728
-
729
-
730
- <td class="description last">The user ID for fetching user-specific data.</td>
731
- </tr>
732
-
733
-
734
-
735
- <tr>
736
-
737
- <td class="name"><code>baseUrl</code></td>
738
-
739
-
740
- <td class="type">
741
-
742
-
743
- <span class="param-type">string</span>
744
-
745
-
746
-
747
-
748
- </td>
749
-
750
-
751
-
752
-
753
-
754
- <td class="description last">The url for the environment.</td>
755
- </tr>
756
-
757
-
758
-
759
- <tr>
760
-
761
- <td class="name"><code>authToken</code></td>
762
-
763
-
764
- <td class="type">
765
-
766
-
767
- <span class="param-type">string</span>
768
-
769
-
770
-
771
-
772
- </td>
773
-
774
-
775
-
776
-
777
-
778
- <td class="description last">The bearer authorization token.</td>
779
- </tr>
780
-
781
-
782
- </tbody>
783
- </table>
784
-
785
- </td>
786
- </tr>
787
-
788
-
789
-
790
- <tr>
791
-
792
- <td class="name"><code>recommendationsConfig.token</code></td>
793
-
794
-
795
- <td class="type">
796
-
797
-
798
- <span class="param-type">string</span>
799
-
800
-
801
-
802
-
803
- </td>
804
-
805
-
806
-
807
-
808
-
809
- <td class="description last">The token for authenticating recommendation requests.</td>
810
- </tr>
811
-
812
-
813
-
814
- <tr>
815
-
816
- <td class="name"><code>recommendationsConfig.baseUrl</code></td>
817
-
818
-
819
- <td class="type">
820
-
821
-
822
- <span class="param-type">string</span>
823
-
824
-
825
-
826
-
827
- </td>
828
-
829
-
830
-
831
-
832
-
833
- <td class="description last">The url for the recommendation server.</td>
834
- </tr>
835
-
836
-
837
-
838
- <tr>
839
-
840
- <td class="name"><code>localStorage</code></td>
841
-
842
-
843
- <td class="type">
844
-
845
-
846
- <span class="param-type">Object</span>
847
-
848
-
849
-
850
-
851
- </td>
852
-
853
-
854
-
855
-
856
-
857
- <td class="description last">Cache to use for localStorage</td>
858
- </tr>
859
-
860
-
861
-
862
- <tr>
863
-
864
- <td class="name"><code>isMA</code></td>
865
-
866
-
867
- <td class="type">
868
-
869
-
870
- <span class="param-type">boolean</span>
871
-
872
-
873
-
874
-
875
- </td>
876
-
877
-
878
-
879
-
880
-
881
- <td class="description last">Variable that tells if the library is used by MA or FEW</td>
882
- </tr>
883
-
884
-
885
-
886
- <tr>
887
-
888
- <td class="name"><code>localTimezoneString</code></td>
889
-
890
-
891
- <td class="type">
892
-
893
-
894
- <span class="param-type">string</span>
895
-
896
-
897
-
898
-
899
- </td>
900
-
901
-
902
-
903
-
904
-
905
- <td class="description last">The local timezone string in format: America/Vancouver</td>
906
- </tr>
907
-
908
-
909
- </tbody>
910
- </table>
911
-
912
- </td>
379
+ <td class="description last">Configuration object containing API settings.</td>
913
380
  </tr>
914
381
 
915
382
 
@@ -954,7 +421,7 @@ initializeService({
954
421
  <br class="clear">
955
422
 
956
423
  <footer>
957
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Mar 27 2025 03:14:21 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
424
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Wed Apr 02 2025 23:00:03 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
958
425
  </footer>
959
426
 
960
427
  <script>prettyPrint();</script>