musora-content-services 1.0.148 → 1.0.152

package/docs/railcontent.js.html

@@ -29,7 +29,7 @@
 <nav >
     
     
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><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-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</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#.fetchSongsInProgress">fetchSongsInProgress</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#.fetchAllSongs">fetchAllSongs</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#.fetchCatalogMetadata">fetchCatalogMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchChallengeOverview">fetchChallengeOverview</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchChildren">fetchChildren</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#.fetchCourseOverview">fetchCourseOverview</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#.fetchLessonContent">fetchLessonContent</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#.fetchMethodNextLesson">fetchMethodNextLesson</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#.fetchMethods">fetchMethods</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#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackChildren">fetchPackChildren</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#.fetchParentByRailContentId">fetchParentByRailContentId</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#.fetchRelatedMethodLessons">fetchRelatedMethodLessons</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#.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#.fetchSongCount">fetchSongCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongFilterOptions">fetchSongFilterOptions</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#.fetchWorkouts">fetchWorkouts</a></li></ul></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><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-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.createPlaylist">createPlaylist</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#.fetchAllCompletedStates">fetchAllCompletedStates</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#.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#.fetchUserPlaylists">fetchUserPlaylists</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#.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#.fetchAllSongs">fetchAllSongs</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#.fetchCatalogMetadata">fetchCatalogMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchChallengeOverview">fetchChallengeOverview</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchChildren">fetchChildren</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#.fetchCourseOverview">fetchCourseOverview</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#.fetchLessonContent">fetchLessonContent</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#.fetchMethodNextLesson">fetchMethodNextLesson</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#.fetchMethods">fetchMethods</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#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackChildren">fetchPackChildren</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#.fetchParentByRailContentId">fetchParentByRailContentId</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#.fetchRelatedMethodLessons">fetchRelatedMethodLessons</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#.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#.fetchSongCount">fetchSongCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongFilterOptions">fetchSongFilterOptions</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#.fetchWorkouts">fetchWorkouts</a></li></ul></li></ul>
     
 </nav>
 
@@ -285,14 +285,21 @@ async function fetchDataHandler(url, dataVersion, method = "get") {
     return fetchHandler(url, method, dataVersion);
 }
 
-export async function fetchHandler(url, method = "get", dataVersion = null) {
+export async function fetchHandler(url, method = "get", dataVersion = null, body = null) {
     let headers = {
         'Content-Type': 'application/json',
         'X-CSRF-TOKEN': globalConfig.railcontentConfig.token,
     };
     if (dataVersion) headers['Data-Version'] = dataVersion;
+    const options = {
+        method,
+        headers,
+    };
+    if (body) {
+        options.body = JSON.stringify(body);
+    }
     try {
-        const response = await fetchAbsolute(url, {method, headers});
+        const response = await fetchAbsolute(url, options);
         const result = await response.json();
         if (result) {
             return result;
@@ -370,7 +377,367 @@ export async function postChallengesCommunityNotification(contentId) {
     return await fetchHandler(url, 'post');
 }
 
+/**
+ * Fetches user playlists for a specific brand.
+ *
+ * Allows optional pagination, sorting, and search parameters to control the result set.
+ *
+ * @param {string} brand - The brand identifier for which playlists are being fetched.
+ * @param {number} [params.limit=10] - The maximum number of playlists to return per page (default is 10).
+ * @param {number} [params.page=1] - The page number for pagination.
+ * @param {string} [params.sort='-created_at'] - The sorting order for the playlists (default is by created_at in descending order).
+ * @param {string} [params.searchTerm] - A search term to filter playlists by name.
+ *
+ * @returns {Promise&lt;Object|null>} - A promise that resolves to the response from the API, containing the user playlists data.
+ *
+ * @example
+ * fetchUserPlaylists('drumeo', { page: 1, sort: 'name', searchTerm: 'rock' })
+ *   .then(playlists => console.log(playlists))
+ *   .catch(error => console.error(error));
+ */
+export async function fetchUserPlaylists(brand, {page, limit, sort, searchTerm} = {}) {
+    let url;
+    const limitString = limit ? `&amp;limit=${limit}` : '';
+    const pageString = page ? `&amp;page=${page}` : '';
+    const sortString = sort ? `&amp;sort=${sort}`:'';
+    const searchFilter = searchTerm ? `&amp;term=${searchTerm}`: '';
+    url = `/playlists/all?brand=${brand}${limitString}${pageString}${sortString}${searchFilter}`;
+    return await fetchHandler(url);
+}
+
+/**
+ * Duplicates an existing playlist by sending a POST request to the API.
+ *
+ * This function calls the `/playlists/duplicate` endpoint, where the server replicates the specified playlist,
+ * including its items. Optionally, new `name`, `description`, `category`, or `thumbnail_url` parameters can be provided
+ * to customize the duplicated playlist. If a new name is not provided, the server appends " (Duplicate)" to the original name.
+ *
+ * @param {string|number} playlistId - The unique identifier of the playlist to be duplicated.
+ * @param {Object} [playlistData] - Optional data to customize the duplicated playlist.
+ * @param {string} [playlistData.name] - New name for the duplicated playlist (default is original name + " (Duplicate)").
+ * @param {string} [playlistData.description] - New description for the duplicated playlist (defaults to original description).
+ * @param {string} [playlistData.category] - New category for the duplicated playlist (defaults to original category).
+ * @param {string} [playlistData.thumbnail_url] - New URL for the duplicated playlist thumbnail (defaults to original thumbnail).
+ *
+ * @returns {Promise&lt;Object>} - A promise that resolves to the duplicated playlist data, or rejects with an error if the duplication fails.
+ *
+ * The duplicated playlist contains:
+ *  - `name` (string): Name of the new playlist.
+ *  - `description` (string|null): Description of the duplicated playlist.
+ *  - `category` (string|null): Category of the duplicated playlist.
+ *  - `thumbnail_url` (string|null): URL of the playlist thumbnail.
+ *  - `items` (Array): A list of items (e.g., songs, tracks) copied from the original playlist.
+ *
+ * @example
+ * duplicatePlaylist(12345, { name: "My New Playlist" })
+ *   .then(duplicatedPlaylist => console.log(duplicatedPlaylist))
+ *   .catch(error => console.error('Error duplicating playlist:', error));
+ */
+export async function duplicatePlaylist(playlistId, playlistData) {
+    let url = `/playlists/duplicate/${playlistId}`;
+    return await fetchHandler(url, "post",null, playlistData);
+}
+
+/**
+ * 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&lt;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`;
+    const payload = { playlist_id: playlistId };
+    return await fetchHandler(url, "delete",  null, payload);
+}
+
+/**
+ * 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&lt;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);
+}
 
+/**
+ * Creates a new user playlist by sending a POST request with playlist data to the API.
+ *
+ * This function calls the `/playlists/playlist` endpoint, where the server validates the incoming data and associates
+ * the new playlist with the authenticated user. The `name` field is required, while other fields are optional.
+ *
+ * @param {Object} playlistData - An object containing data to create the playlist. The fields include:
+ *  - `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.
+ *  - `thumbnail_url` (string): The URL of the playlist thumbnail (optional, must be a valid URL).
+ *  - `private` (boolean): Whether the playlist is private (optional, defaults to true).
+ *  - `brand` (string): Brand identifier for the playlist.
+ *
+ * @returns {Promise&lt;Object>} - A promise that resolves to the created playlist data if successful, or an error response if validation fails.
+ *
+ * The server response includes:
+ *  - `message`: Success message indicating playlist creation (e.g., "Playlist created successfully").
+ *  - `playlist`: The data for the created playlist, including the `user_id` of the authenticated user.
+ *
+ * @example
+ * createPlaylist({ name: "My Playlist", description: "A cool playlist", private: true })
+ *   .then(response => console.log(response.message))
+ *   .catch(error => console.error('Error creating playlist:', error));
+ */
+export async function createPlaylist(playlistData) {
+    const url = `/playlists/playlist`;
+    return await fetchHandler(url, "POST", null, playlistData);
+}
+
+/**
+ * Sends a request to "like" a playlist on behalf of the authenticated user.
+ *
+ * This function calls the `/playlists/playlist/like` endpoint, where the server validates the `playlist_id` and checks
+ * if the authenticated user has already liked the playlist. If not, it creates a new "like" entry associated with the playlist.
+ *
+ * @param {string|number} playlistId - The unique identifier of the playlist to be liked.
+ *
+ * @returns {Promise&lt;Object>} - A promise that resolves with the response from the API. The response contains:
+ *  - `success` (boolean): Indicates if the like action was successful (`true` for success).
+ *  - `message` (string): A success message if the playlist is liked successfully, or a notification if it was already liked.
+ *  - `like` (Object|null): Details of the created "like" entry if the playlist is newly liked, or null if it was already liked.
+ *
+ * The `like` object in the response includes:
+ *  - `playlist_id`: The ID of the liked playlist.
+ *  - `user_id`: The ID of the user who liked the playlist.
+ *  - `brand`: The brand associated with the like.
+ *  - `created_at`: Timestamp of when the like was created.
+ *
+ * @example
+ * likePlaylist(12345)
+ *   .then(response => {
+ *       if (response.success) {
+ *           console.log(response.message);
+ *       }
+ *   })
+ *   .catch(error => console.error('Error liking playlist:', error));
+ */
+export async function likePlaylist(playlistId) {
+    const url = `/playlists/like`;
+    const payload = { playlist_id: playlistId };
+    return await fetchHandler(url, "PUT", null, payload);
+}
+
+/**
+ * Removes a "like" from a playlist for the authenticated user.
+ *
+ * This function sends a DELETE request to the `/playlists/like` endpoint, where the server validates the `playlist_id`
+ * and checks if a like by the authenticated user already exists for the specified playlist. If so, it deletes the like.
+ *
+ * @param {string|number} playlistId - The unique identifier of the playlist whose like is to be removed.
+ *
+ * @returns {Promise&lt;Object>} - A promise that resolves with the response from the API. The response contains:
+ *  - `success` (boolean): Indicates if the removal was successful (`true` for success).
+ *  - `message` (string): A success message if the playlist like is removed successfully or a notification if the playlist was not previously liked.
+ *
+ * @example
+ * deletePlaylistLike(12345)
+ *   .then(response => {
+ *       if (response.success) {
+ *           console.log(response.message);
+ *       }
+ *   })
+ *   .catch(error => console.error('Error removing playlist like:', error));
+ */
+export async function deletePlaylistLike(playlistId) {
+    const url = `/playlists/like`;
+    const payload = { playlist_id: playlistId };
+    return await fetchHandler(url, "DELETE", null, payload);
+}
+
+/**
+ * Retrieves details of a specific playlist by its ID.
+ *
+ * This function sends a GET request to the `/playlists/playlist` endpoint with a specified playlist ID.
+ * The server validates the user's access to the playlist and returns playlist details if the user is authorized.
+ *
+ * @param {string|number} playlistId - The unique identifier of the playlist to retrieve.
+ *
+ * @returns {Promise&lt;Object>} - A promise that resolves to the response from the API, containing:
+ *  - `data` (Object): The playlist details, or an error message if access is denied or the playlist is not found.
+ *
+ * @example
+ * fetchPlaylist(12345)
+ *   .then(response => console.log(response.data))
+ *   .catch(error => console.error('Error fetching playlist:', error));
+ */
+export async function fetchPlaylist(playlistId) {
+    const url = `/playlists/playlist?playlist_id=${playlistId}`;
+    return await fetchHandler(url, "GET");
+}
+
+/**
+ * Retrieves items within a specified playlist by playlist ID.
+ *
+ * This function sends a GET request to the `/playlists/playlist-lessons` endpoint to fetch items in the given playlist.
+ * The server combines data from the playlist and additional metadata from Sanity to enhance item details.
+ *
+ * @param {string|number} playlistId - The unique identifier of the playlist whose items are to be fetched.
+ *
+ * @returns {Promise&lt;Array&lt;Object>>} - A promise that resolves to an array of playlist items
+ *
+ * @example
+ * fetchPlaylistItems(12345)
+ *   .then(items => console.log(items))
+ *   .catch(error => console.error('Error fetching playlist items:', error));
+ */
+export async function fetchPlaylistItems(playlistId) {
+    const url = `/playlists/playlist-lessons?playlist_id=${playlistId}`;
+    return await fetchHandler(url, "GET");
+}
+
+/**
+ * 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&lt;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&lt;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 ID of the playlist item to fetch.
+ * @returns {Promise&lt;Object|null>} - A promise that resolves to an object containing the playlist item data, including:
+ *  - `success` (boolean): Indicates if the retrieval was successful (`true` for success).
+ *  - `data` (Object): The playlist item data enriched with Sanity and Assignment details.
+ *
+ * Resolves to `null` if the request fails.
+ * @throws {Error} - Throws an error if the request fails.
+ *
+ * @example
+ * const payload = { user_playlist_item_id: 123 };
+ *
+ * fetchPlaylistItem(payload)
+ *   .then(response => {
+ *     if (response.success) {
+ *       console.log("Fetched playlist item data:", response.data);
+ *     }
+ *   })
+ *   .catch(error => {
+ *     console.error("Error fetching playlist item:", error);
+ *   });
+ */
+export async function fetchPlaylistItem(payload) {
+    const url = `/playlists/item`;
+    return await fetchHandler(url, "GET", null, payload);
+}
 
 function fetchAbsolute(url, params) {
     if (globalConfig.railcontentConfig.baseUrl) {
@@ -379,7 +746,8 @@ function fetchAbsolute(url, params) {
         }
     }
     return fetch(url, params);
-}</code></pre>
+}
+</code></pre>
         </article>
     </section>
 
@@ -393,7 +761,7 @@ function fetchAbsolute(url, params) {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Oct 24 2024 18:49:53 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Nov 01 2024 14:03:54 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/sanity.js.html

@@ -29,7 +29,7 @@
 <nav >
     
     
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><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-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</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#.fetchSongsInProgress">fetchSongsInProgress</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#.fetchAllSongs">fetchAllSongs</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#.fetchCatalogMetadata">fetchCatalogMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchChallengeOverview">fetchChallengeOverview</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchChildren">fetchChildren</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#.fetchCourseOverview">fetchCourseOverview</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#.fetchLessonContent">fetchLessonContent</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#.fetchMethodNextLesson">fetchMethodNextLesson</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#.fetchMethods">fetchMethods</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#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackChildren">fetchPackChildren</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#.fetchParentByRailContentId">fetchParentByRailContentId</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#.fetchRelatedMethodLessons">fetchRelatedMethodLessons</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#.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#.fetchSongCount">fetchSongCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongFilterOptions">fetchSongFilterOptions</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#.fetchWorkouts">fetchWorkouts</a></li></ul></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><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-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.createPlaylist">createPlaylist</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#.fetchAllCompletedStates">fetchAllCompletedStates</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#.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#.fetchUserPlaylists">fetchUserPlaylists</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#.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#.fetchAllSongs">fetchAllSongs</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#.fetchCatalogMetadata">fetchCatalogMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchChallengeOverview">fetchChallengeOverview</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchChildren">fetchChildren</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#.fetchCourseOverview">fetchCourseOverview</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#.fetchLessonContent">fetchLessonContent</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#.fetchMethodNextLesson">fetchMethodNextLesson</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#.fetchMethods">fetchMethods</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#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackChildren">fetchPackChildren</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#.fetchParentByRailContentId">fetchParentByRailContentId</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#.fetchRelatedMethodLessons">fetchRelatedMethodLessons</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#.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#.fetchSongCount">fetchSongCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongFilterOptions">fetchSongFilterOptions</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#.fetchWorkouts">fetchWorkouts</a></li></ul></li></ul>
     
 </nav>
 
@@ -691,6 +691,7 @@ export async function fetchAllFilterOptions(
   const metaData = processMetadata(brand, contentType, true);
   const allowableFilters = metaData?.allowableFilters || [];
   const tabs = metaData?.tabs || [];
+  const catalogName = metaData?.shortname || metaData?.name;
 
   const dynamicFilterOptions = allowableFilters.map(filter => getFilterOptions(filter, constructCommonFilter(filter), contentType, brand)).join(' ');
 
@@ -707,7 +708,7 @@ export async function fetchAllFilterOptions(
 
   const results = await fetchSanity(query, true, { processNeedAccess: false });
 
-  return includeTabs ? { ...results, tabs } : results;
+  return includeTabs ? { ...results, tabs, catalogName } : results;
 }
 
 
@@ -950,6 +951,9 @@ export async function fetchNextPreviousLesson(railcontentId) {
  */
 export async function fetchLessonContent(railContentId) {
     const filterParams = {};
+    // Format changes made to the `fields` object may also need to be reflected in Musora-web-platform SanityGateway.php $fields object
+    // Currently only for challenges and challenge lessons
+    // If you're unsure, message Adrian, or just add them.
     const fields = `title, 
           published_on,
           "type":_type, 
@@ -1789,7 +1793,7 @@ function cleanUpGroq(query) {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Oct 24 2024 18:49:53 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Nov 01 2024 14:03:54 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musora-content-services",
-  "version": "1.0.148",
+  "version": "1.0.152",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "scripts": {

package/src/contentTypeConfig.js

@@ -481,6 +481,8 @@ function filtersToGroq(filters, selectedFilters = []) {
     return filterClauses;
 }
 function groupFilters(filters) {
+    if (filters.length === 0) return {};
+
     return filters.reduce((acc, filter) => {
         const [category, value] = filter.split(',');
         if (!acc[category]) acc[category] = [];