musora-content-services 1.0.121 → 1.0.123

package/docs/railcontent.js.html

@@ -49,7 +49,7 @@
  * @module Railcontent-Services
  */
 
-const { globalConfig } = require('./config');
+const {globalConfig} = require('./config');
 
 
 /**
@@ -71,10 +71,11 @@ export async function fetchCompletedState(content_id) {
     };
 
     try {
-        const response = await fetchAbsolute(url, { headers });
+        const response = await fetchAbsolute(url, {headers});
         const result = await response.json();
 
-        if (result && result[content_id]) {            return result[content_id];  // Return the correct object
+        if (result && result[content_id]) {
+            return result[content_id];  // Return the correct object
         } else {
             return null;  // Handle unexpected structure
         }
@@ -103,7 +104,7 @@ export async function fetchVimeoData(vimeo_id) {
     };
 
     try {
-        const response = await fetchAbsolute(url, { headers });
+        const response = await fetchAbsolute(url, {headers});
         const result = await response.json();
 
         if (result) {
@@ -138,9 +139,9 @@ export async function fetchAllCompletedStates(contentIds) {
     };
 
     try {
-        const response = await fetchAbsolute(url, { headers });
+        const response = await fetchAbsolute(url, {headers});
         const result = await response.json();
-        if(result){
+        if (result) {
             return result;
         } else {
             console.log('result not json');
@@ -170,9 +171,9 @@ export async function fetchSongsInProgress(brand) {
     };
 
     try {
-        const response = await fetchAbsolute(url, { headers });
+        const response = await fetchAbsolute(url, {headers});
         const result = await response.json();
-        if(result){
+        if (result) {
             //console.log('fetchSongsInProgress', result);
             return result;
         } else {
@@ -197,12 +198,12 @@ export async function fetchSongsInProgress(brand) {
  *   .then(songs => console.log(songs))
  *   .catch(error => console.error(error));
  */
-export async function fetchContentInProgress(type="all", brand, { page, limit } = {}) {
+export async function fetchContentInProgress(type = "all", brand, {page, limit} = {}) {
     let url;
     const limitString = limit ? `&limit=${limit}` : '';
     const pageString = page ? `&page=${page}` : '';
 
-    if(type === "all") {
+    if (type === "all") {
         url = `/content/in_progress/${globalConfig.railcontentConfig.userId}?brand=${brand}${limitString}${pageString}`;
     } else {
         url = `/content/in_progress/${globalConfig.railcontentConfig.userId}?content_type=${type}&brand=${brand}${limitString}${pageString}`;
@@ -212,9 +213,9 @@ export async function fetchContentInProgress(type="all", brand, { page, limit }
         'X-CSRF-TOKEN': globalConfig.railcontentConfig.token
     };
     try {
-        const response = await fetchAbsolute(url, { headers });
+        const response = await fetchAbsolute(url, {headers});
         const result = await response.json();
-        if(result){
+        if (result) {
             //console.log('contentInProgress', result);
             return result;
         } else {
@@ -239,12 +240,12 @@ export async function fetchContentInProgress(type="all", brand, { page, limit }
  *   .then(songs => console.log(songs))
  *   .catch(error => console.error(error));
  */
-export async function fetchCompletedContent(type="all", brand, { page, limit } = {}) {
+export async function fetchCompletedContent(type = "all", brand, {page, limit} = {}) {
     let url;
     const limitString = limit ? `&limit=${limit}` : '';
     const pageString = page ? `&page=${page}` : '';
 
-    if(type === "all") {
+    if (type === "all") {
         url = `/content/completed/${globalConfig.railcontentConfig.userId}?brand=${brand}${limitString}${pageString}`;
     } else {
         url = `/content/completed/${globalConfig.railcontentConfig.userId}?content_type=${type}&brand=${brand}${limitString}${pageString}`;
@@ -254,9 +255,9 @@ export async function fetchCompletedContent(type="all", brand, { page, limit } =
         'X-CSRF-TOKEN': globalConfig.railcontentConfig.token
     };
     try {
-        const response = await fetchAbsolute(url, { headers });
+        const response = await fetchAbsolute(url, {headers});
         const result = await response.json();
-        if(result){
+        if (result) {
             //console.log('completed content', result);
             return result;
         } else {
@@ -286,32 +287,11 @@ export async function fetchContentPageUserData(contentId) {
         'X-CSRF-TOKEN': globalConfig.railcontentConfig.token
     };
 
-    try {
-        const response = await fetchAbsolute(url, { headers });
-        const result = await response.json();
-        if(result){
-            console.log('fetchContentPageUserData', result);
-            return result;
-        } else {
-            console.log('result not json');
-        }
-    } catch (error) {
-        console.error('Fetch error:', error);
-        return null;
-    }
-}
-
-export async function fetchUserContext() {
-    let url = `/content/user_data_all`;
-    const headers = {
-        'Content-Type': 'application/json',
-        'X-CSRF-TOKEN': globalConfig.railcontentConfig.token
-    };
     try {
         const response = await fetchAbsolute(url, {headers});
         const result = await response.json();
         if (result) {
-            console.log('fetchUserContext', result);
+            console.log('fetchContentPageUserData', result);
             return result;
         } else {
             console.log('result not json');
@@ -334,11 +314,16 @@ export async function fetchUserPermissions() {
     return fetchHandler(url, 'get') ?? [];
 }
 
-export async function fetchHandler(url, method = "get") {
-    const headers = {
+async function fetchDataHandler(url, dataVersion, method = "get") {
+    return fetchHandler(url, method, dataVersion);
+}
+
+export async function fetchHandler(url, method = "get", dataVersion = null) {
+    let headers = {
         'Content-Type': 'application/json',
-        'X-CSRF-TOKEN': globalConfig.railcontentConfig.token
+        'X-CSRF-TOKEN': globalConfig.railcontentConfig.token,
     };
+    if (dataVersion) headers['Data-Version'] = dataVersion;
     try {
         const response = await fetchAbsolute(url, {method, headers});
         const result = await response.json();
@@ -353,18 +338,23 @@ export async function fetchHandler(url, method = "get") {
     return null;
 }
 
-export async function fetchLikeContent(contentId) {
-    let url = `/content/${contentId}/like`;
+export async function fetchUserLikes(currentVersion) {
+    let url = `/content/user/likes/all`;
+    return fetchDataHandler(url, currentVersion);
+}
+
+export async function postContentLiked(contentId) {
+    let url = `/content/user/likes/like/${contentId}`;
     return await fetchHandler(url, "post");
 }
 
-export async function fetchUnlikeContent(contentId) {
-    let url = `/content/${contentId}/unlike`;
+export async function postContentUnliked(contentId) {
+    let url = `/content/user/likes/unlike/${contentId}`;
     return await fetchHandler(url, "post");
 }
 
 function fetchAbsolute(url, params) {
-    if(globalConfig.railcontentConfig.baseUrl) {
+    if (globalConfig.railcontentConfig.baseUrl) {
         if (url.startsWith('/')) {
             return fetch(globalConfig.railcontentConfig.baseUrl + url, params)
         }
@@ -384,7 +374,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 Fri Sep 27 2024 21:58:51 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 Wed Oct 02 2024 12:20:08 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

@@ -60,6 +60,7 @@ import {
     getUpcomingEventsTypes,
     showsTypes,
     getNewReleasesTypes,
+    coachLessonsTypes
 } from "../contentTypeConfig";
 
 import {
@@ -623,6 +624,7 @@ export function getSortOrder(sort= '-published_on', groupBy)
 *
 * This function constructs a query to retrieve the total number of results and filter options such as difficulty, instrument type, and genre.
 * The filter options are dynamically generated based on the provided filters, style, artist, and content type.
+* If a coachId is provided, the content type must be 'coach-lessons'.
 *
 * @param {string} brand - The brand for which to fetch the filter options.
 * @param {string[]} filters - Additional filters to apply to the query in the format of a key,value array. eg. ['difficulty,Intermediate', 'genre,rock']
@@ -631,13 +633,22 @@ export function getSortOrder(sort= '-published_on', groupBy)
 * @param {string} contentType - The content type to fetch (e.g., 'song', 'lesson').
 * @param {string} [term] - Optional search term to match against various fields such as title, album, artist name, and genre.
 * @param {Array<string>} [progressIds=undefined] - An array of railcontent IDs to filter the results by. Used for filtering by progress.
+* @param {string} [coachId=undefined] - Optional coach ID to filter the results by a specific coach. If provided, contentType must be 'coach-lessons'.
 * @returns {Promise<Object|null>} - A promise that resolves to an object containing the total results and filter options, or null if the query fails.
 *
+* @throws {Error} Will throw an error if coachId is provided but contentType is not 'coach-lessons'.
+ *
 * @example
 * // Example usage:
 * fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 *   .then(options => console.log(options))
 *   .catch(error => console.error(error));
+*
+* @example
+* // Example usage with coachId:
+* fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love', undefined, '123')
+*   .then(options => console.log(options))
+*   .catch(error => console.error(error));
 */
 export async function fetchAllFilterOptions(
     brand,
@@ -646,25 +657,48 @@ export async function fetchAllFilterOptions(
     artist,
     contentType,
     term,
-    progressIds = undefined
+    progressIds = undefined,
+    coachId = undefined, // New parameter for coach ID
 ) {
+    if (coachId && contentType !== 'coach-lessons') {
+        throw new Error(`Invalid contentType: '${contentType}' for coachId. It must be 'coach-lessons'.`);
+    }
+
     filters = Array.isArray(filters) ? filters : [];
     const includedFieldsFilter = filters?.length > 0 ? filtersToGroq(filters) : undefined;
 
     const progressFilter = progressIds !== undefined ?
         `&& railcontent_id in [${progressIds.join(',')}]` : "";
 
-    const commonFilter = `_type == '${contentType}' && brand == "${brand}"${style ? ` && '${style}' in genre[]->name` : ''}${artist ? ` && artist->name == '${artist}'` : ''} ${progressFilter} ${includedFieldsFilter ? includedFieldsFilter : ''}`;
+    // General common filter logic
+    let commonFilter;
+
+    if (coachId) {
+        // Coach-specific filtering
+        commonFilter = `brand == '${brand}' && references(*[_type=='instructor' && railcontent_id == ${coachId}]._id) ${includedFieldsFilter ? includedFieldsFilter : ''}`;
+    } else {
+        // Regular content filtering
+        commonFilter = `_type == '${contentType}' && brand == "${brand}"${style ? ` && '${style}' in genre[]->name` : ''}${artist ? ` && artist->name == '${artist}'` : ''} ${progressFilter} ${includedFieldsFilter ? includedFieldsFilter : ''}`;
+    }
+
+    // Determine metadata and allowable filters (handle coach lessons if coachId exists)
     const metaData = processMetadata(brand, contentType, true);
     const allowableFilters = metaData?.allowableFilters || [];
 
+    // Dynamic filter options construction
     const dynamicFilterOptions = allowableFilters.map(filter => {
-        // Create a modified common filter for each allowable filter
         let includedFieldsFilterWithoutSelectedOption = filters?.length > 0 ? filtersToGroq(filters, filter) : undefined;
-        const commonFilterWithoutSelectedOption = `_type == '${contentType}' && brand == "${brand}"${(style && filter !== "style") ? ` && '${style}' in genre[]->name` : ''}${(artist && filter !== "artist") ? ` && artist->name == '${artist}'` : ''} ${includedFieldsFilterWithoutSelectedOption ? includedFieldsFilterWithoutSelectedOption : ''}`;
+        let commonFilterWithoutSelectedOption;
+
+        if (coachId) {
+            commonFilterWithoutSelectedOption = `brand == '${brand}' && references(*[_type=='instructor' && railcontent_id == ${coachId}]._id) ${includedFieldsFilterWithoutSelectedOption ? includedFieldsFilterWithoutSelectedOption : ''}`;
+        } else {
+            // Regular content filter without the selected option
+            commonFilterWithoutSelectedOption = `_type == '${contentType}' && brand == "${brand}"${(style && filter !== "style") ? ` && '${style}' in genre[]->name` : ''}${(artist && filter !== "artist") ? ` && artist->name == '${artist}'` : ''} ${includedFieldsFilterWithoutSelectedOption ? includedFieldsFilterWithoutSelectedOption : ''}`;
+        }
 
         // Call getFilterOptions with the modified common filter
-        return getFilterOptions(filter, commonFilterWithoutSelectedOption,  contentType);
+        return getFilterOptions(filter, commonFilterWithoutSelectedOption, contentType, brand);
     }).join(' ');
 
     const query = `
@@ -920,7 +954,7 @@ export async function fetchLessonContent(railContentId) {
           "thumbnail_url":thumbnail.asset->url, 
           "url": web_url_path, 
           soundslice_slug,
-          description,
+          "description": description[0].children[0].text,
           "chapters": chapter[]{
             chapter_description,
             chapter_timecode,
@@ -936,6 +970,7 @@ export async function fetchLessonContent(railContentId) {
             "id":_id,
             name,
             short_bio,
+            "biography": short_bio[0].children[0].text, 
             web_url_path,
             "coach_card_image": coach_card_image.asset->url,
           },
@@ -983,7 +1018,7 @@ export async function fetchRelatedLessons(railContentId, brand) {
 * Fetch related method lessons for a specific lesson by RailContent ID and type.
 * @param {string} railContentId - The RailContent ID of the current lesson.
 * @param {string} brand - The current brand.
-* @returns {Promise<Object>|null>} - The fetched related lessons
+* @returns {Promise<Array<Object>|null>} - The fetched related lessons
 */
 export async function fetchRelatedMethodLessons(railContentId, brand) {
   const query = `*[railcontent_id == ${railContentId} && brand == "${brand}"]{
@@ -1119,6 +1154,8 @@ export async function fetchChallengeOverview(id) {
       difficulty_string,
       difficulty,
       "type": _type,
+      is_always_unlocked,
+      is_bonus_content,
     }
   } [0...1]`;
   return fetchSanity(query, false);
@@ -1126,8 +1163,15 @@ export async function fetchChallengeOverview(id) {
 
 /**
  * Fetch the data needed for the coach screen.
+ * @param {string} brand - The brand for which to fetch coach lessons
  * @param {string} id - The Railcontent ID of the coach
  * @returns {Promise<Object|null>} - The lessons for the instructor or null if not found.
+ * @param {Object} params - Parameters for pagination, filtering and sorting.
+ * @param {string} [params.sortOrder="-published_on"] - The field to sort the lessons by.
+ * @param {string} [params.searchTerm=""] - The search term to filter content by title.
+ * @param {number} [params.page=1] - The page number for pagination.
+ * @param {number} [params.limit=10] - The number of items per page.
+ * @param {Array<string>} [params.includedFields=[]] - Additional filters to apply to the query in the format of a key,value array. eg. ['difficulty,Intermediate', 'genre,rock'].
  *
  * @example
  * fetchCoachLessons('coach123')
@@ -1139,12 +1183,17 @@ export async function fetchCoachLessons(brand, id, {
   searchTerm = '',
   page = 1,
   limit = 20,
+  includedFields = [],
 } = {}) {
   const fieldsString = getFieldsForContentType();
   const start = (page - 1) * limit;
   const end = start + limit;
   const searchFilter = searchTerm ? `&& title match "${searchTerm}*"`: ''
-  const filter = `brand == '${brand}' ${searchFilter} && references(*[_type=='instructor' && railcontent_id == ${id}]._id)`;
+  const includedFieldsFilter = includedFields.length > 0
+        ? filtersToGroq(includedFields)
+        : "";
+  const filter = `brand == '${brand}' ${searchFilter} ${includedFieldsFilter} && references(*[_type=='instructor' && railcontent_id == ${id}]._id)`;
+
   sortOrder = getSortOrder(sortOrder);
   const query = buildEntityAndTotalQuery(
     filter,
@@ -1418,7 +1467,7 @@ export async function fetchCatalogMetadata(contentType)
  * Fetch shows data for a brand.
  *
  * @param brand - The brand for which to fetch shows.
- * @returns {Promise<[]>}
+ * @returns {Promise<{name, description, type: *, thumbnailUrl}>}
  *
  *  @example
  *
@@ -1552,8 +1601,10 @@ function     buildEntityAndTotalQuery(
 }
 
 
-function getFilterOptions(option, commonFilter,contentType){
+function getFilterOptions(option, commonFilter,contentType, brand){
     let filterGroq = '';
+    const types = Array.from(new Set([...coachLessonsTypes,...showsTypes[brand]]));
+
     switch (option) {
         case "difficulty":
             filterGroq = ` 
@@ -1565,6 +1616,12 @@ function getFilterOptions(option, commonFilter,contentType){
         {"type": "Expert", "count": count(*[${commonFilter} && difficulty_string == "Expert" ])}
         ][count > 0],`;
             break;
+        case "type":
+            const dynamicTypeOptions = types.map(filter => {
+                return `{"type": "${filter}", "count": count(*[${commonFilter} && _type == "${filter}"])}`
+            }).join(', ');
+            filterGroq = `"type": [${dynamicTypeOptions}][count > 0],`;
+            break;
         case "genre":
         case "essential":
         case "focus":
@@ -1573,7 +1630,7 @@ function getFilterOptions(option, commonFilter,contentType){
         case "lifestyle":
         case "creativity":
             filterGroq = `
-            "${option}": *[_type == '${option}' && '${contentType}' in filter_types] {
+            "${option}": *[_type == '${option}' ${contentType ? ` && '${contentType}' in filter_types` : ''} ] {
             "type": name,
                 "count": count(*[${commonFilter} && references(^._id)])
         }[count > 0],`;
@@ -1652,7 +1709,7 @@ function cleanUpGroq(query) {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Sep 27 2024 21:58:51 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 Wed Oct 02 2024 12:20:08 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.121",
+  "version": "1.0.123",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "scripts": {

package/src/contentMetaData.js

@@ -192,6 +192,9 @@ const commonMetadata ={
         ],
             modalText: 'Workouts are fun play-along lessons that help hone your musical skills. They cover various topics, and have multiple difficulty and duration options — so there’s always a perfect Workout for you. Just pick one, press start, and play along!',
     },
+    'coach-lessons':{
+        allowableFilters: ['difficulty', 'genre', 'essential','theory','lifestyle','type'],
+    }
 }
 const contentMetadata = {
     'drumeo': {
@@ -703,6 +706,14 @@ const contentMetadata = {
         'pack': {
             allowableFilters: ['difficulty', 'genre', 'essential', 'theory', 'lifestyle'],
         },
+        'odd-times': {
+            thumbnailUrl: 'https://musora.com/cdn-cgi/imagedelivery/0Hon__GSkIjm-B_W77SWCA/1bf6fc7a-d1a5-4934-d322-b9f6da454000/public',
+            name: 'Odd Times With Aaron Edgar',
+            shortname: 'Episodes',
+            icon: 'icon-shows',
+            allowableFilters: [],
+            sortBy: 'sort',
+        },
     },
     'pianote':{
         'instructor': {

package/src/contentTypeConfig.js

@@ -44,7 +44,7 @@ const contentWithSortField = {
     ]
 }
 const showsTypes = {
-    'drumeo': ['drum-fest-international-2022', 'spotlight', 'the-history-of-electronic-drums', 'backstage-secret', 'quick-tips', 'question-and-answer', 'student-collaboration',
+    'drumeo': ['odd-times','drum-fest-international-2022', 'spotlight', 'the-history-of-electronic-drums', 'backstage-secret', 'quick-tips', 'question-and-answer', 'student-collaboration',
          'live', 'podcast', 'solo', 'boot-camp', 'gear-guide', 'performance', 'in-rhythm', 'challenges', 'on-the-road', 'diy-drum-experiment', 'rhythmic-adventures-of-captain-carson',
         'study-the-greats', 'rhythms-from-another-planet', 'tama', 'paiste-cymbals', 'behind-the-scenes', 'exploring-beats', 'sonor'
     ],
@@ -53,6 +53,7 @@ const showsTypes = {
     'singeo': ['student-review', 'question-and-answer']
 }
 
+const coachLessonsTypes = ['course', 'course-part', 'coach-stream', 'student-focus', 'quick-tips', 'pack', 'semester-pack', 'question-and-answer', 'song-tutorial', 'song-tutorial-children', 'workout'];
 
 let contentTypeConfig = {
     'song': {
@@ -370,8 +371,10 @@ function filtersToGroq(filters, selectedFilters = []) {
                 return `instrumentless == ${value}`;
             } else if (key === 'difficulty' && !selectedFilters.includes(key)) {
                 return `difficulty_string == "${value}"`;
+            } else if (key === 'type' && !selectedFilters.includes(key)) {
+                return `_type == "${value}"`;
             } else if (!selectedFilters.includes(key)) {
-                return `&& ${key} == ${/^\d+$/.test(value) ? value : `"$${value}"`}`;
+                return ` ${key} == ${/^\d+$/.test(value) ? value : `"$${value}"`}`;
             }
         }).filter(Boolean).join(' || ');
 
@@ -402,4 +405,5 @@ module.exports = {
     getNewReleasesTypes,
     getUpcomingEventsTypes,
     showsTypes,
+    coachLessonsTypes
 }

package/src/services/railcontent.js

@@ -256,8 +256,6 @@ export async function fetchContentPageUserData(contentId) {
 }
 
 export async function fetchUserPermissions() {
-    //TODO: Should be investigate why throw 500 errors on MA
-    return [];
     let url = `/content/user_data_permissions`;
     const headers = {
         'Content-Type': 'application/json',