musora-content-services 2.3.24 → 2.3.25

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.
 
+### [2.3.25](https://github.com/railroadmedia/musora-content-services/compare/v2.3.24...v2.3.25) (2025-05-07)
+
 ### [2.3.24](https://github.com/railroadmedia/musora-content-services/compare/v2.3.23...v2.3.24) (2025-05-06)
 
 ### [2.3.23](https://github.com/railroadmedia/musora-content-services/compare/v2.3.22...v2.3.23) (2025-05-06)

package/package.json

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

package/src/index.d.ts

@@ -8,15 +8,16 @@ import {
 import {
 	addItemToPlaylist,
 	createPlaylist,
+	deleteItemsFromPlaylist,
 	duplicatePlaylist,
 	fetchPlaylist,
 	fetchPlaylistItems,
 	fetchUserPlaylists,
 	likePlaylist,
-	reorderPlaylistItems,
 	reportPlaylist,
 	togglePlaylistPrivate,
-	unlikePlaylist
+	unlikePlaylist,
+	updatePlaylist
 } from './services/content-org/playlists.js';
 
 import {
@@ -255,6 +256,7 @@ declare module 'musora-content-services' {
 		createPlaylist,
 		createPracticeNotes,
 		deleteComment,
+		deleteItemsFromPlaylist,
 		deletePracticeSession,
 		duplicatePlaylist,
 		editComment,
@@ -397,7 +399,6 @@ declare module 'musora-content-services' {
 		recordUserPractice,
 		recordWatchSession,
 		removeUserPractice,
-		reorderPlaylistItems,
 		replyToComment,
 		reportComment,
 		reportPlaylist,
@@ -411,6 +412,7 @@ declare module 'musora-content-services' {
 		unlikeComment,
 		unlikeContent,
 		unlikePlaylist,
+		updatePlaylist,
 		updatePracticeNotes,
 		updateUserPractice,
 		verifyImageSRC,

package/src/index.js

@@ -8,15 +8,16 @@ import {
 import {
 	addItemToPlaylist,
 	createPlaylist,
+	deleteItemsFromPlaylist,
 	duplicatePlaylist,
 	fetchPlaylist,
 	fetchPlaylistItems,
 	fetchUserPlaylists,
 	likePlaylist,
-	reorderPlaylistItems,
 	reportPlaylist,
 	togglePlaylistPrivate,
-	unlikePlaylist
+	unlikePlaylist,
+	updatePlaylist
 } from './services/content-org/playlists.js';
 
 import {
@@ -254,6 +255,7 @@ export {
 	createPlaylist,
 	createPracticeNotes,
 	deleteComment,
+	deleteItemsFromPlaylist,
 	deletePracticeSession,
 	duplicatePlaylist,
 	editComment,
@@ -396,7 +398,6 @@ export {
 	recordUserPractice,
 	recordWatchSession,
 	removeUserPractice,
-	reorderPlaylistItems,
 	replyToComment,
 	reportComment,
 	reportPlaylist,
@@ -410,6 +411,7 @@ export {
 	unlikeComment,
 	unlikeContent,
 	unlikePlaylist,
+	updatePlaylist,
 	updatePracticeNotes,
 	updateUserPractice,
 	verifyImageSRC,

package/src/services/content-org/playlists.js

@@ -70,72 +70,6 @@ export async function createPlaylist(playlistData) {
   return await fetchHandler(url, 'POST', null, playlistData)
 }
 
-/**
- * Adds an item to one or more playlists by making a POST request to the `/playlists/add-item` endpoint.
- *
- * @param {AddItemToPlaylistDTO} payload - The request payload containing necessary parameters.
- *
- * @returns {Promise<Object|null>} - A promise that resolves to an object with the response data, including:
- *  - `success` (boolean): Indicates if the items were added successfully (`true` on success).
- *  - `limit_excedeed` (Array): A list of playlists where the item limit was exceeded, if any.
- *  - `successful` (Array): A list of successfully added items (empty if none).
- *
- * Resolves to `null` if the request fails.
- * @throws {Error} - Throws an error if the request encounters issues during the operation.
- *
- * @example
- * const payload = {
- *     content_id: 123,
- *     playlist_id: [1, 2, 3],
- *     import_all_assignments: true
- * };
- *
- * addItemToPlaylist(payload)
- *   .then(response => {
- *     if (response?.success) {
- *       console.log("Item(s) added to playlist successfully");
- *     }
- *     if (response?.limit_excedeed) {
- *       console.warn("Some playlists exceeded the item limit:", response.limit_excedeed);
- *     }
- *   })
- *   .catch(error => {
- *     console.error("Error adding item to playlist:", error);
- *   });
- */
-export async function addItemToPlaylist(payload) {
-  const url = `${BASE_PATH}/v1/user/playlists/items`
-  return await fetchHandler(url, 'POST', null, payload)
-}
-
-/**
- * Updates a playlist's privacy setting by toggling its public/private status.
-
- *
- * @async
- * @function togglePlaylistPrivate
- * @param {string|number} playlistId - The unique identifier of the playlist to update.
- * @param {boolean} [is_private=true] - is public flag
- *
- * @returns {Promise<Object>}
- *
- * @example
- * // Make playlist with ID '81111' public
- * try {
- *   const response = await togglePublic(81111, true);
- *   console.log('Playlist is now private:', response);
- * } catch (error) {
- *   console.error('Failed to update playlist visibility:', error);
- * }
- */
-export async function togglePlaylistPrivate(playlistId, is_private = true) {
-  const url = `${BASE_PATH}/v1/user/playlists/update/${playlistId}`
-  const payload = {
-    private: is_private,
-  }
-  return await fetchHandler(url, 'POST', null, payload)
-}
-
 /**
  * Likes a playlist for the current user.
  *
@@ -206,30 +140,121 @@ export async function reportPlaylist(playlistId) {
 }
 
 /**
- * Reorders items within a playlist.
+ * Adds an item to one or more playlists by making a POST request to the `/playlists/add-item` endpoint.
+ *
+ * @param {AddItemToPlaylistDTO} payload - The request payload containing necessary parameters.
+ *
+ * @returns {Promise<Object|null>} - A promise that resolves to an object with the response data, including:
+ *  - `success` (boolean): Indicates if the items were added successfully (`true` on success).
+ *  - `limit_excedeed` (Array): A list of playlists where the item limit was exceeded, if any.
+ *  - `successful` (Array): A list of successfully added items (empty if none).
+ *
+ * Resolves to `null` if the request fails.
+ * @throws {Error} - Throws an error if the request encounters issues during the operation.
+ *
+ * @example
+ * const payload = {
+ *     content_id: 123,
+ *     playlist_id: [1, 2, 3],
+ *     import_all_assignments: true
+ * };
+ *
+ * addItemToPlaylist(payload)
+ *   .then(response => {
+ *     if (response?.success) {
+ *       console.log("Item(s) added to playlist successfully");
+ *     }
+ *     if (response?.limit_excedeed) {
+ *       console.warn("Some playlists exceeded the item limit:", response.limit_excedeed);
+ *     }
+ *   })
+ *   .catch(error => {
+ *     console.error("Error adding item to playlist:", error);
+ *   });
+ */
+export async function addItemToPlaylist(payload) {
+  const url = `${BASE_PATH}/v1/user/playlists/items`
+  return await fetchHandler(url, 'POST', null, payload)
+}
+
+/**
+ * Toggles a playlists public/private state
+ *
+ * @param {string|number} playlistId
+ * @param {Boolean} is_private - flag for private/public
+
+ * @returns {Promise<Playlist>} - A promise that resolves to the updated playlist data if successful, or an error response if validation fails.
+ *
+ * @example
+ * togglePlaylistPrivate(11541, true)
+ *   .then(response => console.log(response))
+ *   .catch(error => console.error('Error creating playlist:', error));
+ */
+export async function togglePlaylistPrivate(playlistId, is_private)
+{
+  return await updatePlaylist(playlistId, {is_private})
+}
+
+
+/**
+ * Updates a playlists values
+ *
+ * @param {string|number} playlistId
+ * @param {Object} updateData - An object containing fields to update on the playlist:
+ *  - `name` (string): The name of the new playlist (required, max 255 characters).
+ *  - `description` (string): A description of the playlist (optional, max 1000 characters).
+ *  - `category` (string): The category of the playlist.
+ * + *  - `deleted_items` (array): List of playlist item IDs to delete.
+ * + *  - `item_order` (array): Updated order of playlist items (ids, not railcontent_ids).
+ *
+ * @returns {Promise<object>} - A promise that resolves to the created playlist data and lessons if successful, or an error response if validation fails.
+ *
+ * The server response includes:
+ *  - `playlist`: Playlist metadata (same as fetchPlaylist)
+ *  - `lessons`: Updated list of plalyist lessons  (same as fetchPlaylistItems)
+ *
+ * @example
+ * updatePlaylist(661113 { name: "My Playlist", description: "A cool playlist", is_private: true, deleted_items : [2189832, 221091] })
+ *   .then(response => console.log(response.playlist); console.log(response.lessons))
+ *   .catch(error => console.error('Error updating playlist:', error));
+ */
+export async function updatePlaylist(playlistId, {
+  name = null, description = null,  is_private = null, brand = null, category = null, deleted_items = null, item_order = null
+})
+{
+  const data = {
+    ...name && { name },
+    ...description && { description },
+    ...is_private !== null && { private: is_private},
+    ...brand && { brand },
+    ...category && { category},
+    ...deleted_items && { deleted_items },
+    ...item_order && { item_order },
+  }
+  const url = `${BASE_PATH}/v1/user/playlists/${playlistId}`
+  return await fetchHandler(url, 'POST', null, data);
+}
+
+/**
+ * Delete Items from playlist
+ *
  * @async
- * @function reorderPlaylistItems
- * @param {string|number} playlistId - The unique identifier of the playlist to reorder.
- * @param {Array<string|number>} playlistItemIds - An array of playlist item IDs (not content ids) in the desired order.
- *                                              All items in the playlist must present in this list for the BE to handle the reorder.
+ * @function togglePlaylistPrivate
+ * @param {string|number} playlistId - The unique identifier of the playlist to update.
+ * @param {array} deleted_items - list of playlist ids to delete (user_playlist_item_id, not the railcontent_id)
  *
  * @returns {Promise<Object>}
+ *
  * @example
- * // Reorder items in playlist with ID '123'
+ * // Delete items 8462221 and 8462222 from playlist 81111
  * try {
- *   const newOrder = [5, 2, 1, 4, 3]; // Representing playlist item IDs in the desired order
- *   const response = await reorderPlaylistItems('123', newOrder);
- *   console.log('Playlist items reordered successfully:', response);
+ *   const response = await deleteItemsFromPlaylist(81111, [8462221, 8462222]);
  * } catch (error) {
- *   console.error('Failed to reorder playlist items:', error);
+ *   console.error('Failed to delete playlist items:', error);
  * }
  */
-export async function reorderPlaylistItems(playlistId, playlistItemIds){
-  const url = `${BASE_PATH}/v1/user/playlists/reorder/${playlistId}`
-  const payload = {
-    items: playlistItemIds,
-  }
-  return await fetchHandler(url, 'POST')
+export async function deleteItemsFromPlaylist(playlistId, deleted_items) {
+  return await updatePlaylist(playlistId, {deleted_items})
 }
 
 /**
@@ -294,179 +319,3 @@ export async function fetchPlaylistItems(playlistId) {
   const url = `${BASE_PATH}/v1/user/playlists/items/${playlistId}`
   return await fetchHandler(url, 'GET')
 }
-
-// Unsupported playlist endpoints are here and will need to be implemented one by one
-//
-//
-// /**
-//  * Deletes a user’s playlist along with all associated items by sending a DELETE request to the API.
-//  *
-//  * This function calls the `/playlists/playlist` endpoint, where the server verifies the user’s ownership of the specified playlist.
-//  * If the user is authorized, it deletes both the playlist and its associated items.
-//  *
-//  * @param {string|number} playlistId - The unique identifier of the playlist to be deleted.
-//  *
-//  * @returns {Promise<Object>} - A promise that resolves to an object containing:
-//  *  - `success` (boolean): Indicates if the deletion was successful (`true` for success).
-//  *  - `message` (string): Success confirmation message (e.g., "Playlist and associated items deleted successfully").
-//  *
-//  * If the user is unauthorized or the playlist does not exist, the promise rejects with an error.
-//  *
-//  * @example
-//  * deletePlaylist(12345)
-//  *   .then(response => {
-//  *       if (response.success) {
-//  *           console.log(response.message);
-//  *       }
-//  *   })
-//  *   .catch(error => console.error('Error deleting playlist:', error));
-//  */
-// export async function deletePlaylist(playlistId) {
-//   let url = `/playlists/playlist/${playlistId}`
-//   return await fetchHandler(url, 'delete')
-// }
-//
-// /**
-//  * Updates a user’s playlist by sending a PUT request with updated data to the API.
-//  *
-//  * This function calls the `/playlists/playlist/{playlistId}` endpoint, where the server validates the incoming data
-//  * and verifies that the authenticated user is the playlist owner. If authorized, it updates the playlist details with the provided data.
-//  *
-//  * @param {string|number} playlistId - The unique identifier of the playlist to be updated.
-//  * @param {Object} updatedData - An object containing the playlist data to update. The possible fields include:
-//  *  - `name` (string): The new name of the playlist (max 255 characters).
-//  *  - `description` (string): A new description for the playlist (max 1000 characters).
-//  *  - `category` (string): The updated category of the playlist (max 255 characters).
-//  *  - `private` (boolean): Whether the playlist is private.
-//  *  - `thumbnail_url` (string): The URL of the playlist thumbnail.
-//  *
-//  * @returns {Promise<Object>} - A promise that resolves to an object containing:
-//  *  - `success` (boolean): Indicates if the update was successful (`true` for success).
-//  *  - `message` (string): Success confirmation message if the update is successful.
-//  *  - Other fields containing the updated playlist data.
-//  *
-//  * If the user is unauthorized or the data validation fails, the promise rejects with an error.
-//  *
-//  * @example
-//  * updatePlaylist(12345, { name: "My New Playlist Name", description: "Updated description" })
-//  *   .then(response => {
-//  *       if (response.success) {
-//  *           console.log(response.message);
-//  *       }
-//  *   })
-//  *   .catch(error => console.error('Error updating playlist:', error));
-//  */
-// export async function updatePlaylist(playlistId, updatedData) {
-//   const url = `/playlists/playlist/${playlistId}`
-//   return await fetchHandler(url, 'PUT', null, updatedData)
-// }
-//
-//
-//
-// /**
-//  * Updates a playlist item with the provided data.
-//  *
-//  * @param {Object} updatedData - The data to update the playlist item with.
-//  * @param {number} updatedData.user_playlist_item_id - The ID of the playlist item to update.
-//  * @param {number} [updatedData.start_second] - (Optional) The start time in seconds for the item.
-//  * @param {number} [updatedData.end_second] - (Optional) The end time in seconds for the item.
-//  * @param {string} [updatedData.playlist_item_name] - (Optional) The new name for the playlist item.
-//  * @param {number} [updatedData.position] - (Optional) The new position for the playlist item within the playlist.
-//  * @returns {Promise<Object|null>} - A promise that resolves to an object containing:
-//  *  - `success` (boolean): Indicates if the update was successful (`true` for success).
-//  *  - `data` (Object): The updated playlist item data.
-//  *
-//  * Resolves to `null` if the request fails.
-//  * @throws {Error} - Throws an error if the request fails.
-//  *
-//  * @example
-//  * const updatedData = {
-//  *   user_playlist_item_id: 123,
-//  *   start_second: 30,
-//  *   end_second: 120,
-//  *   playlist_item_name: "Updated Playlist Item Name",
-//  *   position: 2
-//  * };
-//  *
-//  * updatePlaylistItem(updatedData)
-//  *   .then(response => {
-//  *     if (response.success) {
-//  *       console.log("Playlist item updated successfully:", response.data);
-//  *     }
-//  *   })
-//  *   .catch(error => {
-//  *     console.error("Error updating playlist item:", error);
-//  *   });
-//  */
-// export async function updatePlaylistItem(updatedData) {
-//   const url = `/playlists/item`
-//   return await fetchHandler(url, 'POST', null, updatedData)
-// }
-//
-// /**
-//  * Deletes a playlist item and repositions other items in the playlist if necessary.
-//  *
-//  * @param {Object} payload - The data required to delete the playlist item.
-//  * @param {number} payload.user_playlist_item_id - The ID of the playlist item to delete.
-//  * @returns {Promise<Object|null>} - A promise that resolves to an object containing:
-//  *  - `success` (boolean): Indicates if the deletion was successful (`true` for success).
-//  *  - `message` (string): A success message if the item is deleted successfully.
-//  *  - `error` (string): An error message if the deletion fails.
-//  *
-//  * Resolves to `null` if the request fails.
-//  * @throws {Error} - Throws an error if the request fails.
-//  *
-//  * @example
-//  * const payload = {
-//  *   user_playlist_item_id: 123
-//  * };
-//  *
-//  * deletePlaylistItem(payload)
-//  *   .then(response => {
-//  *     if (response.success) {
-//  *       console.log("Playlist item deleted successfully:", response.message);
-//  *     } else {
-//  *       console.error("Error:", response.error);
-//  *     }
-//  *   })
-//  *   .catch(error => {
-//  *     console.error("Error deleting playlist item:", error);
-//  *   });
-//  */
-// export async function deletePlaylistItem(payload) {
-//   const url = `/playlists/item`
-//   return await fetchHandler(url, 'DELETE', null, payload)
-// }
-//
-// /**
-//  * Fetches detailed data for a specific playlist item, including associated Sanity and Assignment information if available.
-//  *
-//  * @param {Object} payload - The request payload containing necessary parameters.
-//  * @param {number} payload.user_playlist_item_id - The unique ID of the playlist item to fetch.
-//  * @returns {Promise<Object|null>} - A promise that resolves to an object with the fetched playlist item data, including:
-//  *  - `success` (boolean): Indicates if the data retrieval was successful (`true` on success).
-//  *  - `data` (Object): Contains the detailed playlist item data enriched with Sanity and Assignment details, if available.
-//  *
-//  * Resolves to `null` if the request fails.
-//  * @throws {Error} - Throws an error if the request encounters issues during retrieval.
-//  *
-//  * @example
-//  * const payload = { user_playlist_item_id: 123 };
-//  *
-//  * fetchPlaylistItem(payload)
-//  *   .then(response => {
-//  *     if (response?.success) {
-//  *       console.log("Fetched playlist item data:", response.data);
-//  *     } else {
-//  *       console.log("Failed to fetch playlist item data.");
-//  *     }
-//  *   })
-//  *   .catch(error => {
-//  *     console.error("Error fetching playlist item:", error);
-//  *   });
-//  */
-// export async function fetchPlaylistItem(payload) {
-//   const playlistItemId = payload.user_playlist_item_id
-//   const url = `/playlists/item/${playlistItemId}`
-//   return await fetchHandler(url)
-// }