musora-content-services 2.39.4 → 2.40.0

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 (183) hide show
  1. package/.coderabbit.yaml +0 -0
  2. package/.editorconfig +0 -0
  3. package/.github/pull_request_template.md +0 -0
  4. package/.github/workflows/conventional-commits.yaml +0 -0
  5. package/.github/workflows/docs.js.yml +0 -0
  6. package/.github/workflows/node.js.yml +0 -0
  7. package/.prettierignore +0 -0
  8. package/.prettierrc +0 -0
  9. package/.yarnrc.yml +1 -0
  10. package/CHANGELOG.md +25 -0
  11. package/README.md +0 -0
  12. package/babel.config.cjs +0 -0
  13. package/docs/ContentOrganization.html +2 -2
  14. package/docs/Forums.html +28 -4
  15. package/docs/Gamification.html +2 -2
  16. package/docs/UserManagementSystem.html +2 -2
  17. package/docs/api_types.js.html +2 -2
  18. package/docs/config.js.html +2 -2
  19. package/docs/content-org_content-org.js.html +2 -2
  20. package/docs/content-org_guided-courses.ts.html +2 -2
  21. package/docs/content-org_playlists-types.js.html +2 -2
  22. package/docs/content-org_playlists.js.html +2 -2
  23. package/docs/content.js.html +2 -2
  24. package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
  25. package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
  26. package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
  27. package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
  28. package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
  29. package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
  30. package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
  31. package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
  32. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  33. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
  34. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  35. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  36. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  37. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  38. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
  39. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  40. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  41. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  42. package/docs/forums_categories.ts.html +26 -3
  43. package/docs/forums_discussions.js.html +0 -0
  44. package/docs/forums_forum.js.html +0 -0
  45. package/docs/forums_forums.ts.html +4 -3
  46. package/docs/forums_threads.ts.html +102 -0
  47. package/docs/gamification_awards.js.html +0 -0
  48. package/docs/gamification_awards.ts.html +2 -2
  49. package/docs/gamification_gamification.js.html +2 -2
  50. package/docs/gamification_types.js.html +0 -0
  51. package/docs/global.html +2 -2
  52. package/docs/index.html +2 -2
  53. package/docs/module-Accounts.html +2 -2
  54. package/docs/module-Awards.html +2 -2
  55. package/docs/module-Categories.html +679 -0
  56. package/docs/module-Config.html +2 -2
  57. package/docs/module-Content-Services-V2.html +2 -2
  58. package/docs/module-ForumCategories.html +198 -2
  59. package/docs/module-ForumDiscussions.html +0 -0
  60. package/docs/module-Forums.html +0 -0
  61. package/docs/module-GuidedCourses.html +2 -2
  62. package/docs/module-Interests.html +2 -2
  63. package/docs/module-Payments.html +2 -2
  64. package/docs/module-Permissions.html +2 -2
  65. package/docs/module-Playlists.html +2 -2
  66. package/docs/module-Railcontent-Services.html +2 -2
  67. package/docs/module-Sanity-Services.html +2 -2
  68. package/docs/module-Sessions.html +3 -3
  69. package/docs/module-Threads.html +300 -0
  70. package/docs/module-UserActivity.html +2 -2
  71. package/docs/module-UserChat.html +2 -2
  72. package/docs/module-UserManagement.html +2 -2
  73. package/docs/module-UserMemberships.html +152 -2
  74. package/docs/module-UserNotifications.html +2 -2
  75. package/docs/module-UserProfile.html +2 -2
  76. package/docs/railcontent.js.html +2 -2
  77. package/docs/sanity.js.html +2 -2
  78. package/docs/scripts/collapse.js +0 -0
  79. package/docs/scripts/commonNav.js +0 -0
  80. package/docs/scripts/linenumber.js +0 -0
  81. package/docs/scripts/nav.js +0 -0
  82. package/docs/scripts/polyfill.js +0 -0
  83. package/docs/scripts/prettify/Apache-License-2.0.txt +0 -0
  84. package/docs/scripts/prettify/lang-css.js +0 -0
  85. package/docs/scripts/prettify/prettify.js +0 -0
  86. package/docs/scripts/search.js +0 -0
  87. package/docs/styles/jsdoc.css +0 -0
  88. package/docs/styles/prettify.css +0 -0
  89. package/docs/userActivity.js.html +2 -2
  90. package/docs/user_account.ts.html +2 -2
  91. package/docs/user_chat.js.html +2 -2
  92. package/docs/user_interests.js.html +2 -2
  93. package/docs/user_management.js.html +2 -2
  94. package/docs/user_memberships.js.html +24 -2
  95. package/docs/user_notifications.js.html +2 -2
  96. package/docs/user_payments.ts.html +2 -2
  97. package/docs/user_permissions.js.html +2 -2
  98. package/docs/user_profile.js.html +2 -2
  99. package/docs/user_sessions.js.html +3 -2
  100. package/docs/user_types.js.html +2 -2
  101. package/docs/user_user-management-system.js.html +2 -2
  102. package/jest.config.js +0 -0
  103. package/jsdoc.json +0 -0
  104. package/package.json +1 -1
  105. package/src/contentMetaData.js +0 -0
  106. package/src/filterBuilder.js +0 -0
  107. package/src/index.d.ts +11 -2
  108. package/src/index.js +11 -2
  109. package/src/infrastructure/http/HttpClient.ts +0 -0
  110. package/src/infrastructure/http/executors/FetchRequestExecutor.ts +0 -0
  111. package/src/infrastructure/http/index.ts +0 -0
  112. package/src/infrastructure/http/interfaces/HeaderProvider.ts +0 -0
  113. package/src/infrastructure/http/interfaces/HttpError.ts +0 -0
  114. package/src/infrastructure/http/interfaces/NetworkError.ts +0 -0
  115. package/src/infrastructure/http/interfaces/RequestExecutor.ts +0 -0
  116. package/src/infrastructure/http/interfaces/RequestOptions.ts +0 -0
  117. package/src/infrastructure/http/providers/DefaultHeaderProvider.ts +0 -0
  118. package/src/lib/httpHelper.js +0 -0
  119. package/src/lib/lastUpdated.js +0 -0
  120. package/src/services/api/types.js +0 -0
  121. package/src/services/api/types.ts +0 -0
  122. package/src/services/config.js +0 -0
  123. package/src/services/content-org/content-org.js +0 -0
  124. package/src/services/content-org/guided-courses.ts +0 -0
  125. package/src/services/content-org/playlists-types.js +0 -0
  126. package/src/services/content-org/playlists.js +0 -0
  127. package/src/services/content.js +0 -0
  128. package/src/services/contentAggregator.js +0 -0
  129. package/src/services/contentLikes.js +0 -0
  130. package/src/services/contentProgress.js +0 -0
  131. package/src/services/dataContext.js +0 -0
  132. package/src/services/dateUtils.js +0 -0
  133. package/src/services/eventsAPI.js +0 -0
  134. package/src/services/forum.js +0 -0
  135. package/src/services/forums/categories.ts +24 -1
  136. package/src/services/forums/forums.ts +2 -1
  137. package/src/services/forums/threads.ts +30 -0
  138. package/src/services/forums/types.ts +13 -0
  139. package/src/services/gamification/awards.ts +0 -0
  140. package/src/services/gamification/gamification.js +0 -0
  141. package/src/services/imageSRCBuilder.js +0 -0
  142. package/src/services/imageSRCVerify.js +0 -0
  143. package/src/services/railcontent.js +0 -0
  144. package/src/services/recommendations.js +0 -0
  145. package/src/services/types.js +0 -0
  146. package/src/services/user/account.ts +0 -0
  147. package/src/services/user/chat.js +0 -0
  148. package/src/services/user/interests.js +0 -0
  149. package/src/services/user/management.js +0 -0
  150. package/src/services/user/memberships.js +22 -0
  151. package/src/services/user/notifications.js +0 -0
  152. package/src/services/user/payments.ts +0 -0
  153. package/src/services/user/permissions.js +0 -0
  154. package/src/services/user/profile.js +0 -0
  155. package/src/services/user/sessions.js +11 -19
  156. package/src/services/user/types.js +0 -0
  157. package/src/services/user/user-management-system.js +0 -0
  158. package/src/services/userActivity.js +0 -0
  159. package/test/HttpClient.test.js +0 -0
  160. package/test/content.test.js +0 -0
  161. package/test/contentLikes.test.js +0 -0
  162. package/test/contentProgress.test.js +0 -0
  163. package/test/dataContext.test.js +0 -0
  164. package/test/forum.test.js +0 -0
  165. package/test/imageSRCBuilder.test.js +0 -0
  166. package/test/imageSRCVerify.test.js +0 -0
  167. package/test/initializeTests.js +0 -0
  168. package/test/lib/lastUpdated.test.js +0 -0
  169. package/test/live/contentProgressLive.test.js +0 -0
  170. package/test/live/railcontentLive.test.js +0 -0
  171. package/test/localStorageMock.js +0 -0
  172. package/test/log.js +0 -0
  173. package/test/mockData/mockData_fetchByRailContentIds_one_content.json +0 -0
  174. package/test/mockData/mockData_progress_content.json +0 -0
  175. package/test/mockData/mockData_sanity_progress_content.json +0 -0
  176. package/test/mockData/mockData_user_practices.json +0 -0
  177. package/test/notifications.test.js +0 -0
  178. package/test/progressRows.test.js +0 -0
  179. package/test/sanityQueryService.test.js +0 -0
  180. package/test/streakMessage.test.js +0 -0
  181. package/test/user/permissions.test.js +0 -0
  182. package/test/userActivity.test.js +0 -0
  183. package/tools/generate-index.cjs +0 -0
package/docs/module-Categories.html ADDED
@@ -0,0 +1,679 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+
5
+ <meta charset="utf-8">
6
+ <title>Categories - Documentation</title>
7
+
8
+
9
+ <script src="scripts/prettify/prettify.js"></script>
10
+ <script src="scripts/prettify/lang-css.js"></script>
11
+ <!--[if lt IE 9]>
12
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
+ <![endif]-->
14
+ <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
+ <script src="scripts/nav.js" defer></script>
17
+
18
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
19
+ </head>
20
+ <body>
21
+
22
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
23
+ <label for="nav-trigger" class="navicon-button x">
24
+ <div class="navicon"></div>
25
+ </label>
26
+
27
+ <label for="nav-trigger" class="overlay"></label>
28
+
29
+ <nav >
30
+
31
+
32
+ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Accounts.html">Accounts</a><ul class='methods'><li data-type='method'><a href="module-Accounts.html#~confirmEmailChange">confirmEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li></ul></li><li><a href="module-Categories.html">Categories</a><ul class='methods'><li data-type='method'><a href="module-Categories.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Categories.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Categories.html#~updateForumCategory">updateForumCategory</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#.getRecentForTab">getRecentForTab</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-GuidedCourses.html">GuidedCourses</a></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</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#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</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#.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#.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#.fetchComment">fetchComment</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#.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#.fetchRecentUserActivities">fetchRecentUserActivities</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#.fetchUserPracticeNotes">fetchUserPracticeNotes</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#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentComplete">postContentComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentReset">postContentReset</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentRestore">postContentRestore</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentStart">postContentStart</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#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</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#~fetchLastInteractedChild">fetchLastInteractedChild</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#.fetchSiblingContent">fetchSiblingContent</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#~getQueryFromPage">getQueryFromPage</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-Threads.html">Threads</a><ul class='methods'><li data-type='method'><a href="module-Threads.html#~createThread">createThread</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserActivity">restoreUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</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#.blockedUsers">blockedUsers</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserData">getUserData</a></li><li data-type='method'><a href="module-UserManagement.html#.isDisplayNameAvailable">isDisplayNameAvailable</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.updateDisplayName">updateDisplayName</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserMemberships.html">UserMemberships</a><ul class='methods'><li data-type='method'><a href="module-UserMemberships.html#.fetchMemberships">fetchMemberships</a></li><li data-type='method'><a href="module-UserMemberships.html#.fetchRechargeTokens">fetchRechargeTokens</a></li><li data-type='method'><a href="module-UserMemberships.html#.upgradeSubscription">upgradeSubscription</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchLiveEventPollingState">fetchLiveEventPollingState</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotificationSettings">fetchNotificationSettings</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchUnreadCount">fetchUnreadCount</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li><li data-type='method'><a href="module-UserNotifications.html#.pauseLiveEventPolling">pauseLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.restoreNotification">restoreNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.startLiveEventPolling">startLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.updateNotificationSetting">updateNotificationSetting</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.deleteProfilePicture">deleteProfilePicture</a></li><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Forums.html">Forums</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
+
34
+ </nav>
35
+
36
+ <div id="main">
37
+
38
+ <h1 class="page-title">Categories</h1>
39
+
40
+
41
+
42
+
43
+
44
+
45
+
46
+ <section>
47
+
48
+ <header>
49
+
50
+
51
+
52
+ </header>
53
+
54
+ <article>
55
+
56
+ <div class="container-overview">
57
+
58
+
59
+
60
+
61
+
62
+ </div>
63
+
64
+
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+ <h3 class="subsection-title">Methods</h3>
81
+
82
+
83
+
84
+
85
+
86
+
87
+ <h4 class="name" id="~createForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>createForumCategory<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
88
+
89
+
90
+
91
+
92
+
93
+
94
+ <dl class="details">
95
+
96
+ <dt class="tag-description">Description:</dt>
97
+ <dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
98
+
99
+
100
+
101
+ <dt class="tag-source">Source:</dt>
102
+ <dd class="tag-source"><ul class="dummy"><li>
103
+ <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line30">line 30</a>
104
+ </li></ul></dd>
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ </dl>
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+ <h5 class="h5-parameters">Parameters:</h5>
151
+
152
+
153
+ <table class="params">
154
+ <thead>
155
+ <tr>
156
+
157
+ <th>Name</th>
158
+
159
+
160
+ <th>Type</th>
161
+
162
+
163
+
164
+
165
+
166
+ <th class="last">Description</th>
167
+ </tr>
168
+ </thead>
169
+
170
+ <tbody>
171
+
172
+
173
+ <tr>
174
+
175
+ <td class="name"><code>params</code></td>
176
+
177
+
178
+ <td class="type">
179
+
180
+
181
+ <span class="param-type">CreateForumCategoryParams</span>
182
+
183
+
184
+
185
+
186
+ </td>
187
+
188
+
189
+
190
+
191
+
192
+ <td class="description last">The parameters for creating the forum category.</td>
193
+ </tr>
194
+
195
+
196
+ </tbody>
197
+ </table>
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+ <h5 class="h5-throws">Throws:</h5>
213
+
214
+
215
+
216
+ <dl>
217
+ <dt>
218
+ <div class="param-desc usertext">
219
+ - If the request fails.
220
+ </div>
221
+ </dt>
222
+ <dd></dd>
223
+ <dt>
224
+ <dl class="param-type">
225
+ <dt>
226
+ Type
227
+ </dt>
228
+ <dd>
229
+
230
+ <span class="param-type">HttpError</span>
231
+
232
+
233
+
234
+ </dd>
235
+ </dl>
236
+ </dt>
237
+ <dd></dd>
238
+ </dl>
239
+
240
+
241
+
242
+
243
+
244
+ <h5 class="h5-returns">Returns:</h5>
245
+
246
+
247
+ <div class="param-desc">
248
+ - A promise that resolves to the created forum category.
249
+ </div>
250
+
251
+
252
+
253
+ <dl class="param-type">
254
+ <dt>
255
+ Type
256
+ </dt>
257
+ <dd>
258
+
259
+ <span class="param-type">Promise.&lt;ForumCategory></span>
260
+
261
+
262
+
263
+ </dd>
264
+ </dl>
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+ <h4 class="name" id="~fetchForumCategories"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchForumCategories<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
276
+
277
+
278
+
279
+
280
+
281
+
282
+ <dl class="details">
283
+
284
+ <dt class="tag-description">Description:</dt>
285
+ <dd class="tag-description"><ul class="dummy"><li>Fetches forum categories for the given brand.</li></ul></dd>
286
+
287
+
288
+
289
+ <dt class="tag-source">Source:</dt>
290
+ <dd class="tag-source"><ul class="dummy"><li>
291
+ <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line10">line 10</a>
292
+ </li></ul></dd>
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+ </dl>
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+ <h5 class="h5-parameters">Parameters:</h5>
339
+
340
+
341
+ <table class="params">
342
+ <thead>
343
+ <tr>
344
+
345
+ <th>Name</th>
346
+
347
+
348
+ <th>Type</th>
349
+
350
+
351
+
352
+
353
+
354
+ <th class="last">Description</th>
355
+ </tr>
356
+ </thead>
357
+
358
+ <tbody>
359
+
360
+
361
+ <tr>
362
+
363
+ <td class="name"><code>brand</code></td>
364
+
365
+
366
+ <td class="type">
367
+
368
+
369
+ <span class="param-type">string</span>
370
+ |
371
+
372
+ <span class="param-type">null</span>
373
+
374
+
375
+
376
+
377
+ </td>
378
+
379
+
380
+
381
+
382
+
383
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
384
+ </tr>
385
+
386
+
387
+ </tbody>
388
+ </table>
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+ <h5 class="h5-throws">Throws:</h5>
404
+
405
+
406
+
407
+ <dl>
408
+ <dt>
409
+ <div class="param-desc usertext">
410
+ - If the request fails.
411
+ </div>
412
+ </dt>
413
+ <dd></dd>
414
+ <dt>
415
+ <dl class="param-type">
416
+ <dt>
417
+ Type
418
+ </dt>
419
+ <dd>
420
+
421
+ <span class="param-type">HttpError</span>
422
+
423
+
424
+
425
+ </dd>
426
+ </dl>
427
+ </dt>
428
+ <dd></dd>
429
+ </dl>
430
+
431
+
432
+
433
+
434
+
435
+ <h5 class="h5-returns">Returns:</h5>
436
+
437
+
438
+ <div class="param-desc">
439
+ - A promise that resolves to the list of forum categories.
440
+ </div>
441
+
442
+
443
+
444
+ <dl class="param-type">
445
+ <dt>
446
+ Type
447
+ </dt>
448
+ <dd>
449
+
450
+ <span class="param-type">Promise.&lt;ForumCategory></span>
451
+
452
+
453
+
454
+ </dd>
455
+ </dl>
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+ <h4 class="name" id="~updateForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>updateForumCategory<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
467
+
468
+
469
+
470
+
471
+
472
+
473
+ <dl class="details">
474
+
475
+ <dt class="tag-description">Description:</dt>
476
+ <dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
477
+
478
+
479
+
480
+ <dt class="tag-source">Source:</dt>
481
+ <dd class="tag-source"><ul class="dummy"><li>
482
+ <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line53">line 53</a>
483
+ </li></ul></dd>
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+
499
+
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+ </dl>
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+ <h5 class="h5-parameters">Parameters:</h5>
530
+
531
+
532
+ <table class="params">
533
+ <thead>
534
+ <tr>
535
+
536
+ <th>Name</th>
537
+
538
+
539
+ <th>Type</th>
540
+
541
+
542
+
543
+
544
+
545
+ <th class="last">Description</th>
546
+ </tr>
547
+ </thead>
548
+
549
+ <tbody>
550
+
551
+
552
+ <tr>
553
+
554
+ <td class="name"><code>params</code></td>
555
+
556
+
557
+ <td class="type">
558
+
559
+
560
+ <span class="param-type">UpdateForumCategoryParams</span>
561
+
562
+
563
+
564
+
565
+ </td>
566
+
567
+
568
+
569
+
570
+
571
+ <td class="description last">The parameters for creating the forum category.</td>
572
+ </tr>
573
+
574
+
575
+ </tbody>
576
+ </table>
577
+
578
+
579
+
580
+
581
+
582
+
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+ <h5 class="h5-throws">Throws:</h5>
592
+
593
+
594
+
595
+ <dl>
596
+ <dt>
597
+ <div class="param-desc usertext">
598
+ - If the request fails.
599
+ </div>
600
+ </dt>
601
+ <dd></dd>
602
+ <dt>
603
+ <dl class="param-type">
604
+ <dt>
605
+ Type
606
+ </dt>
607
+ <dd>
608
+
609
+ <span class="param-type">HttpError</span>
610
+
611
+
612
+
613
+ </dd>
614
+ </dl>
615
+ </dt>
616
+ <dd></dd>
617
+ </dl>
618
+
619
+
620
+
621
+
622
+
623
+ <h5 class="h5-returns">Returns:</h5>
624
+
625
+
626
+ <div class="param-desc">
627
+ - A promise that resolves to the created forum category.
628
+ </div>
629
+
630
+
631
+
632
+ <dl class="param-type">
633
+ <dt>
634
+ Type
635
+ </dt>
636
+ <dd>
637
+
638
+ <span class="param-type">Promise.&lt;ForumCategory></span>
639
+
640
+
641
+
642
+ </dd>
643
+ </dl>
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+
652
+
653
+
654
+
655
+ </article>
656
+
657
+ </section>
658
+
659
+
660
+
661
+
662
+
663
+
664
+ </div>
665
+
666
+ <br class="clear">
667
+
668
+ <footer>
669
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Sep 18 2025 14:17:31 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
670
+ </footer>
671
+
672
+ <script>prettyPrint();</script>
673
+ <script src="scripts/polyfill.js"></script>
674
+ <script src="scripts/linenumber.js"></script>
675
+
676
+
677
+
678
+ </body>
679
+ </html>