musora-content-services 1.2.1 → 1.2.2

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 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.2.2](https://github.com/railroadmedia/musora-content-services/compare/v1.2.1...v1.2.2) (2025-01-16)
+
 ### [1.2.1](https://github.com/railroadmedia/musora-content-services/compare/v1.2.0...v1.2.1) (2025-01-16)
 
 ## [1.2.0](https://github.com/railroadmedia/musora-content-services/compare/v1.0.233...v1.2.0) (2025-01-14)

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "musora-content-services",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "type": "module",
   "scripts": {
-    "build-index": "node tools/generate-index.js",
+    "build-index": "node tools/generate-index.cjs",
     "release": "standard-version",
     "doc": "jsdoc -c jsdoc.json --verbose",
     "test": "jest --setupFiles dotenv/config"

package/src/index.d.ts

@@ -1,7 +1,6 @@
 /*** This file was generated automatically. To recreate, please run `npm run build-index`. ***/
 
 import {
-	globalConfig,
 	initializeService
 } from './services/config.js';
 
@@ -79,6 +78,7 @@ import {
 	postContentUnliked,
 	postRecordWatchSession,
 	reportPlaylist,
+	setStudentViewForUser,
 	unpinPlaylist,
 	updatePlaylist,
 	updatePlaylistItem
@@ -243,7 +243,6 @@ declare module 'musora-content-services' {
 		getProgressStateByIds,
 		getResumeTimeSeconds,
 		getSortOrder,
-		globalConfig,
 		initializeService,
 		isContentLiked,
 		jumpToContinueContent,
@@ -268,6 +267,7 @@ declare module 'musora-content-services' {
 		recordWatchSession,
 		reportPlaylist,
 		reset,
+		setStudentViewForUser,
 		unlikeContent,
 		unpinPlaylist,
 		updatePlaylist,

package/src/index.js

@@ -1,7 +1,6 @@
 /*** This file was generated automatically. To recreate, please run `npm run build-index`. ***/
 
 import {
-	globalConfig,
 	initializeService
 } from './services/config.js';
 
@@ -79,6 +78,7 @@ import {
 	postContentUnliked,
 	postRecordWatchSession,
 	reportPlaylist,
+	setStudentViewForUser,
 	unpinPlaylist,
 	updatePlaylist,
 	updatePlaylistItem
@@ -242,7 +242,6 @@ export {
 	getProgressStateByIds,
 	getResumeTimeSeconds,
 	getSortOrder,
-	globalConfig,
 	initializeService,
 	isContentLiked,
 	jumpToContinueContent,
@@ -267,6 +266,7 @@ export {
 	recordWatchSession,
 	reportPlaylist,
 	reset,
+	setStudentViewForUser,
 	unlikeContent,
 	unpinPlaylist,
 	updatePlaylist,

package/src/services/railcontent.js

@@ -289,6 +289,9 @@ async function postDataHandler(url, data) {
     return fetchHandler(url, 'post', null, data);
 }
 
+async function patchDataHandler(url, data) {
+    return fetchHandler(url, 'patch', null, data);}
+
 export async function fetchHandler(url, method = "get", dataVersion = null, body = null) {
     let headers = {
         'Content-Type': 'application/json',
@@ -1178,6 +1181,19 @@ export async function playback(playlistId) {
     return await fetchHandler(url, "GET");
 }
 
+/**
+ * Set a user's StudentView Flag
+ *
+ * @param {int|string} userId - id of the user (must be currently authenticated)
+ * @param {bool} enable - truthsy value to enable student view
+ * @returns {Promise<any|null>}
+ */
+export async function setStudentViewForUser(userId, enable) {
+    let url = `/user-management-system/user/update/${userId}`;
+    let data = {'use_student_view' : enable ? 1 : 0};
+    return await patchDataHandler(url, data);
+}
+
 function fetchAbsolute(url, params) {
     if (globalConfig.railcontentConfig.authToken) {
         params.headers['Authorization'] = `Bearer ${globalConfig.railcontentConfig.authToken}`;