musora-content-services 2.3.19 → 2.3.21

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 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.21](https://github.com/railroadmedia/musora-content-services/compare/v2.3.20...v2.3.21) (2025-05-02)
+
+### [2.3.20](https://github.com/railroadmedia/musora-content-services/compare/v2.3.19...v2.3.20) (2025-04-30)
+
 ### [2.3.19](https://github.com/railroadmedia/musora-content-services/compare/v2.3.18...v2.3.19) (2025-04-30)
 
 ### [2.3.18](https://github.com/railroadmedia/musora-content-services/compare/v2.3.16...v2.3.18) (2025-04-30)

package/package.json

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

package/src/index.d.ts

@@ -9,6 +9,8 @@ import {
 	addItemToPlaylist,
 	createPlaylist,
 	duplicatePlaylist,
+	fetchPlaylist,
+	fetchPlaylistItems,
 	fetchUserPlaylists,
 	likePlaylist,
 	reorderPlaylistItems,
@@ -300,6 +302,8 @@ declare module 'musora-content-services' {
 		fetchPackData,
 		fetchParentForDownload,
 		fetchPlayAlongsCount,
+		fetchPlaylist,
+		fetchPlaylistItems,
 		fetchRecent,
 		fetchRelatedLessons,
 		fetchRelatedRecommendedContent,

package/src/index.js

@@ -9,6 +9,8 @@ import {
 	addItemToPlaylist,
 	createPlaylist,
 	duplicatePlaylist,
+	fetchPlaylist,
+	fetchPlaylistItems,
 	fetchUserPlaylists,
 	likePlaylist,
 	reorderPlaylistItems,
@@ -299,6 +301,8 @@ export {
 	fetchPackData,
 	fetchParentForDownload,
 	fetchPlayAlongsCount,
+	fetchPlaylist,
+	fetchPlaylistItems,
 	fetchRecent,
 	fetchRelatedLessons,
 	fetchRelatedRecommendedContent,

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

@@ -254,6 +254,47 @@ export async function duplicatePlaylist(playlistId, playlistData) {
   return await fetchHandler(url, 'POST', null, playlistData)
 }
 
+/**
+ * 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<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 = `${BASE_PATH}/v1/user/playlists/${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<Array<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 = `${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
 //
 //
@@ -321,47 +362,6 @@ export async function duplicatePlaylist(playlistId, playlistData) {
 // }
 //
 //
-// /**
-//  * 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<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/${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<Array<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, { sort } = {}) {
-//   const sortString = sort ? `&sort=${sort}` : ''
-//   const url = `/playlists/playlist-lessons?playlist_id=${playlistId}${sortString}`
-//   return await fetchHandler(url, 'GET')
-// }
 //
 // /**
 //  * Updates a playlist item with the provided data.

package/src/services/imageSRCBuilder.js

@@ -55,7 +55,7 @@ export function buildImageSRC(url, options = {}) {
 export function applySanityTransformations(url, options) {
   const { width, height, quality } = options
 
-  const sanityOptions = ['auto=format']
+  const sanityOptions = ['fm=webp']
 
   // Dimensions
   if (width) sanityOptions.push(`w=${width}`)

package/test/imageSRCBuilder.test.js

@@ -14,7 +14,7 @@ describe('imageSRCBuilder', function () {
       quality: quality,
       height: height,
     })
-    const expected = `${url}?auto=format&w=${width}&h=${height}&q=${quality}`
+    const expected = `${url}?fm=webp&w=${width}&h=${height}&q=${quality}`
 
     expect(resultingURL).toStrictEqual(expected)
   })