musora-content-services 1.0.120 → 1.0.122

package/src/index.js

@@ -5,6 +5,12 @@ import {
 	initializeService
 } from './services/config.js';
 
+import {
+	isContentLiked,
+	likeContent,
+	unlikeContent
+} from './services/contentLikes.js';
+
 import {
 	fetchAllCompletedStates,
 	fetchCompletedContent,
@@ -12,10 +18,9 @@ import {
 	fetchContentInProgress,
 	fetchContentPageUserData,
 	fetchHandler,
-	fetchLikeContent,
 	fetchSongsInProgress,
-	fetchUnlikeContent,
-	fetchUserContext,
+	fetchUserLikes,
+	fetchUserPermissions,
 	fetchVimeoData
 } from './services/railcontent.js';
 
@@ -65,18 +70,7 @@ import {
 	getSortOrder
 } from './services/sanity.js';
 
-import {
-	clearCache,
-	fetchContentData,
-	init,
-	likeContent,
-	testClearLocal,
-	unlikeContent,
-	version
-} from './services/userContext.js';
-
 export {
-	clearCache,
 	fetchAll,
 	fetchAllCompletedStates,
 	fetchAllFilterOptions,
@@ -93,7 +87,6 @@ export {
 	fetchCoachLessons,
 	fetchCompletedContent,
 	fetchCompletedState,
-	fetchContentData,
 	fetchContentInProgress,
 	fetchContentPageUserData,
 	fetchCourseOverview,
@@ -101,7 +94,6 @@ export {
 	fetchGenreLessons,
 	fetchHandler,
 	fetchLessonContent,
-	fetchLikeContent,
 	fetchLiveEvent,
 	fetchMetadata,
 	fetchMethod,
@@ -126,17 +118,15 @@ export {
 	fetchSongCount,
 	fetchSongFilterOptions,
 	fetchSongsInProgress,
-	fetchUnlikeContent,
 	fetchUpcomingEvents,
-	fetchUserContext,
+	fetchUserLikes,
+	fetchUserPermissions,
 	fetchVimeoData,
 	fetchWorkouts,
 	getSortOrder,
 	globalConfig,
-	init,
 	initializeService,
+	isContentLiked,
 	likeContent,
-	testClearLocal,
 	unlikeContent,
-	version,
 };

package/src/services/config.js

@@ -4,7 +4,8 @@
 
 let globalConfig = {
     sanityConfig: {},
-    railcontentConfig: {}
+    railcontentConfig: {},
+    localStorage: null
   };
   
 /**
@@ -24,6 +25,7 @@ let globalConfig = {
  * @param {string} config.railcontentConfig.token - The token for authenticating user-specific requests.
  * @param {string} config.railcontentConfig.userId - The user ID for fetching user-specific data.
  * @param {string} config.railcontentConfig.baseUrl - The url for the enviroment.
+ * @param {Object} config.localStorage - Cache to use for localStorage
 
  *
  * @example
@@ -41,12 +43,14 @@ let globalConfig = {
  *     token: 'your-user-api-token',
  *     userId: 'current-user-id',
  *     baseUrl: 'https://web-staging-one.musora.com'
- *   }
+ *   },
+ *   localStorage: localStorage
  * });
  */
 function initializeService(config) {
     globalConfig.sanityConfig = config.sanityConfig;
     globalConfig.railcontentConfig = config.railcontentConfig;
+    globalConfig.localStorage = config.localStorage;
 }
 
 // Export both the initialization function and the config object

package/src/services/contentLikes.js

@@ -0,0 +1,38 @@
+import {fetchUserLikes, postContentLiked, postContentUnliked} from "./railcontent";
+import {DataContext, ContentVersionKey} from "./dataContext";
+
+export let dataContext = new DataContext(ContentVersionKey, fetchUserLikes);
+
+export async function isContentLiked(contentId) {
+    let data = await dataContext.getData();
+    return data.includes(contentId);
+}
+
+export async function likeContent(contentId) {
+   await dataContext.update(
+        function (context) {
+            if (!context.data.includes(contentId)) {
+                context.data.push(contentId);
+            }
+        },
+        async function(){
+            return postContentLiked(contentId);
+        }
+    );
+}
+
+export async function unlikeContent(contentId) {
+    await dataContext.update(
+        function (context) {
+            if (context.data.includes(contentId)) {
+                const index = context.data.indexOf(contentId);
+                if (index > -1) { // only splice array when item is found
+                   context.data.splice(index, 1); // 2nd parameter means remove one item only
+                }
+            }
+        },
+        async function(){
+            return postContentUnliked(contentId);
+        }
+    );
+}

package/src/services/dataContext.js

@@ -0,0 +1,88 @@
+import {globalConfig} from "./config";
+
+//These constants need to match MWP UserDataVersionKeyEnum enum
+export const ContentVersionKey = 0;
+
+let cache = null;
+
+export class DataContext {
+    context = null;
+
+    constructor(dataVersionKey, fetchDataFunction) {
+        this.dataVersionKey = dataVersionKey;
+        this.fetchDataFunction = fetchDataFunction;
+        this.localStorageKey = `dataContext_${this.dataVersionKey}`;
+        this.localStorageLastUpdatedKey = `dataContext_${this.dataVersionKey}_lastUpdated`;
+    }
+
+    async getData() {
+        this.ensureLocalContextLoaded();
+        if (!this.context || this.shouldVerifyServerVerions()) {
+            let version = this.version();
+            let data = await this.fetchData(version);
+            if (data.version !== "No Change") {
+                this.context = data;
+                cache.setItem(this.localStorageKey, JSON.stringify(data));
+            }
+            cache.setItem(this.localStorageLastUpdatedKey, new Date().getTime());
+        }
+        return this.context.data;
+    }
+
+    async fetchData(version) {
+        return await this.fetchDataFunction(version);
+    }
+
+    ensureLocalContextLoaded() {
+        if (this.context) return;
+        this.verifyConfig();
+        let localData = cache.getItem(this.localStorageKey);
+        if (localData) {
+            this.context = JSON.parse(localData);
+        }
+    }
+
+    verifyConfig() {
+        if (!cache) {
+            cache = globalConfig.localStorage;
+            if (!cache) throw new Error('dataContext: LocalStorage cache not configured in musora content services initializeService.');
+        }
+    }
+
+    shouldVerifyServerVerions() {
+        let lastUpdated = cache.getItem(this.localStorageLastUpdatedKey);
+        if (!lastUpdated) return false;
+        const verifyServerTime = 10000; //10 s
+        return (new Date().getTime() - lastUpdated) > verifyServerTime;
+    }
+
+    clearCache() {
+        this.clearContext();
+        cache.removeItem(this.localStorageKey);
+        cache.removeItem(this.localStorageLastUpdatedKey);
+    }
+
+    clearContext() {
+        this.context = null;
+    }
+
+    async update(localUpdateFunction, serverUpdateFunction) {
+        this.ensureLocalContextLoaded();
+        if (this.context) {
+            localUpdateFunction(this.context);
+            this.context.version++;
+            let data = JSON.stringify(this.context);
+            cache.setItem(this.localStorageKey, data);
+            cache.setItem(this.localStorageLastUpdatedKey, new Date().getTime());
+        }
+        let response = await serverUpdateFunction();
+        if (response.version !== this.version()) {
+            this.clearCache();
+        }
+    }
+
+    version() {
+        return this.context?.version ?? -1;
+    }
+
+}

package/src/services/railcontent.js

@@ -2,7 +2,7 @@
  * @module Railcontent-Services
  */
 
-const { globalConfig } = require('./config');
+const {globalConfig} = require('./config');
 
 
 /**
@@ -24,10 +24,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
         }
@@ -56,7 +57,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) {
@@ -91,9 +92,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');
@@ -123,9 +124,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 {
@@ -150,12 +151,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}`;
@@ -165,9 +166,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 {
@@ -192,12 +193,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}`;
@@ -207,9 +208,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 {
@@ -239,32 +240,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');
@@ -287,11 +267,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();
@@ -306,18 +291,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)
         }

package/src/services/sanity.js

@@ -13,6 +13,7 @@ import {
     getUpcomingEventsTypes,
     showsTypes,
     getNewReleasesTypes,
+    coachLessonsTypes
 } from "../contentTypeConfig";
 
 import {
@@ -576,6 +577,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']
@@ -584,13 +586,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,
@@ -599,25 +610,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 = `
@@ -937,7 +971,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}"]{
@@ -1082,8 +1116,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')
@@ -1095,12 +1136,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,
@@ -1374,7 +1420,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
  *
@@ -1508,8 +1554,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 = ` 
@@ -1521,6 +1569,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":
@@ -1529,7 +1583,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],`;