musora-content-services 1.0.128 → 1.0.130

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.
 
+### [1.0.130](https://github.com/railroadmedia/musora-content-services/compare/v1.0.129...v1.0.130) (2024-10-09)
+
+### [1.0.129](https://github.com/railroadmedia/musora-content-services/compare/v1.0.127...v1.0.129) (2024-10-09)
+
 ### [1.0.128](https://github.com/railroadmedia/musora-content-services/compare/v1.0.127...v1.0.128) (2024-10-03)
 
 ### [1.0.127](https://github.com/railroadmedia/musora-content-services/compare/v1.0.123...v1.0.127) (2024-10-03)

package/README.md

@@ -44,6 +44,15 @@ To install the package, use npm:
 npm install musora-content-services
 ```
 
+## Generating index.js and index.d.ts
+
+The `index.js` and `index.d.ts` files provide all exported functions from this package, and are generated automatically.
+Simply run `npm run build-index` to build these files. It works by running the `tools/generate-index.js` file, which simply 
+parses the files under the `src/services` directory and builds up the index files with any functions tagged with `export`.
+
+If you want to exclude any of your exported functions from the generated index files, be sure to add the function name to 
+the `excludeFromGeneratedIndex` array inside the service file.
+
 ## Publishing Package Updates
 
 To publish a new version to NPM run, 

package/package.json

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

package/src/contentMetaData.js

@@ -153,6 +153,7 @@ const commonMetadata ={
             {
                 name: 'Genres',
                 short_name: 'Genres',
+                is_group_by: true,
                 value: 'genre',
             },
         ],
@@ -1066,6 +1067,7 @@ const contentMetadata = {
     }
 };
 
+const typeWithSortOrder = ['in-rhythm', 'diy-drum-experiments', 'rhythmic-adventures-of-captain-carson'];
 function processMetadata(brand, type, withFilters = false)
 {
     let brandMetaData = contentMetadata[brand]?.[type];
@@ -1099,4 +1101,5 @@ function processMetadata(brand, type, withFilters = false)
 
 module.exports = {
     processMetadata,
+    typeWithSortOrder
 }

package/src/contentTypeConfig.js

@@ -94,13 +94,26 @@ let contentTypeConfig = {
             'total_xp',
             'xp',
             '"instructors": instructor[]->name',
+            '"instructor_signature": instructor[0]->signature.asset->url',
             '"header_image_url": thumbnail.asset->url',
             '"logo_image_url": logo_image_url.asset->url',
             '"award": award.asset->url',
-            `"award_template": award_template[]{
-                streak_minimum,
-                "template" : template.asset->url,
-            }`,
+            'award_custom_text',
+            '"gold_award": gold_award.asset->url',
+            '"silver_award": silver_award.asset->url',
+            '"bronze_award": bronze_award.asset->url',
+            `"lessons": child[]->{
+                    "id": railcontent_id,
+                    title,
+                    "image": thumbnail.asset->url,
+                    "instructors": instructor[]->name,
+                    length_in_seconds,
+                    difficulty_string,
+                    difficulty,
+                    "type": _type,
+                    is_always_unlocked_for_challenge,
+                    is_bonus_content_for_challenge,
+                }`,
         ]
     },
     'course': {

package/src/index.d.ts

@@ -13,15 +13,20 @@ import {
 
 import {
 	fetchAllCompletedStates,
+	fetchChallengeMetadata,
 	fetchCompletedContent,
 	fetchCompletedState,
 	fetchContentInProgress,
 	fetchContentPageUserData,
 	fetchHandler,
 	fetchSongsInProgress,
-	fetchUserLikes,
+	fetchUserAward,
+	fetchUserChallengeProgress,
 	fetchUserPermissions,
-	fetchVimeoData
+	postChallengesEnroll,
+	postChallengesLeave,
+	postChallengesSetStartDate,
+	postChallengesUnlock
 } from './services/railcontent.js';
 
 import {
@@ -83,6 +88,7 @@ declare module 'musora-content-services' {
 		fetchByRailContentIds,
 		fetchByReference,
 		fetchCatalogMetadata,
+		fetchChallengeMetadata,
 		fetchChallengeOverview,
 		fetchChildren,
 		fetchCoachLessons,
@@ -120,15 +126,19 @@ declare module 'musora-content-services' {
 		fetchSongFilterOptions,
 		fetchSongsInProgress,
 		fetchUpcomingEvents,
-		fetchUserLikes,
+		fetchUserAward,
+		fetchUserChallengeProgress,
 		fetchUserPermissions,
-		fetchVimeoData,
 		fetchWorkouts,
 		getSortOrder,
 		globalConfig,
 		initializeService,
 		isContentLiked,
 		likeContent,
+		postChallengesEnroll,
+		postChallengesLeave,
+		postChallengesSetStartDate,
+		postChallengesUnlock,
 		unlikeContent,
 	}
 }

package/src/index.js

@@ -13,15 +13,20 @@ import {
 
 import {
 	fetchAllCompletedStates,
+	fetchChallengeMetadata,
 	fetchCompletedContent,
 	fetchCompletedState,
 	fetchContentInProgress,
 	fetchContentPageUserData,
 	fetchHandler,
 	fetchSongsInProgress,
-	fetchUserLikes,
+	fetchUserAward,
+	fetchUserChallengeProgress,
 	fetchUserPermissions,
-	fetchVimeoData
+	postChallengesEnroll,
+	postChallengesLeave,
+	postChallengesSetStartDate,
+	postChallengesUnlock
 } from './services/railcontent.js';
 
 import {
@@ -82,6 +87,7 @@ export {
 	fetchByRailContentIds,
 	fetchByReference,
 	fetchCatalogMetadata,
+	fetchChallengeMetadata,
 	fetchChallengeOverview,
 	fetchChildren,
 	fetchCoachLessons,
@@ -119,14 +125,18 @@ export {
 	fetchSongFilterOptions,
 	fetchSongsInProgress,
 	fetchUpcomingEvents,
-	fetchUserLikes,
+	fetchUserAward,
+	fetchUserChallengeProgress,
 	fetchUserPermissions,
-	fetchVimeoData,
 	fetchWorkouts,
 	getSortOrder,
 	globalConfig,
 	initializeService,
 	isContentLiked,
 	likeContent,
+	postChallengesEnroll,
+	postChallengesLeave,
+	postChallengesSetStartDate,
+	postChallengesUnlock,
 	unlikeContent,
 };

package/src/services/config.js

@@ -7,7 +7,14 @@ let globalConfig = {
     railcontentConfig: {},
     localStorage: null
   };
-  
+
+/**
+ * Exported functions that are excluded from index generation.
+ *
+ * @type {string[]}
+ */
+const excludeFromGeneratedIndex = [];
+
 /**
  * Initializes the service with the given configuration.
  * This function must be called before using any other functions in this library.

package/src/services/contentLikes.js

@@ -1,6 +1,13 @@
 import {fetchUserLikes, postContentLiked, postContentUnliked} from "./railcontent";
 import {DataContext, ContentVersionKey} from "./dataContext";
 
+/**
+ * Exported functions that are excluded from index generation.
+ *
+ * @type {string[]}
+ */
+const excludeFromGeneratedIndex = [];
+
 export let dataContext = new DataContext(ContentVersionKey, fetchUserLikes);
 
 export async function isContentLiked(contentId) {

package/src/services/dataContext.js

@@ -1,5 +1,12 @@
 import {globalConfig} from "./config";
 
+/**
+ * Exported functions that are excluded from index generation.
+ *
+ * @type {string[]}
+ */
+const excludeFromGeneratedIndex = [];
+
 //These constants need to match MWP UserDataVersionKeyEnum enum
 export const ContentVersionKey = 0;
 

package/src/services/railcontent.js

@@ -4,6 +4,13 @@
 
 const {globalConfig} = require('./config');
 
+/**
+ * Exported functions that are excluded from index generation.
+ *
+ * @type {string[]}
+ */
+const excludeFromGeneratedIndex = ['fetchUserLikes', 'postContentLiked', 'postContentUnliked'];
+
 
 /**
  * Fetches the completion status of a specific lesson for the current user.
@@ -38,40 +45,6 @@ export async function fetchCompletedState(content_id) {
     }
 }
 
-/**
- * Fetches the vimeo meta-data
- *
- * @param {string} vimeo_id - The vimeo id, found in the <document>.video.external_id field for lessons
- * @returns {Promise<Object|null>} - Returns the
- * @example
- * fetchVimeoData('642900215')
- *   .then(vimeoData => console.log(vimeoData))
- *   .catch(error => console.error(error));
- */
-export async function fetchVimeoData(vimeo_id) {
-    const url = `/content/vimeo-data/${vimeo_id}`;
-
-    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) {
-            return result;  // Return the correct object
-        } else {
-            console.log('Invalid result structure', result);
-            return null;  // Handle unexpected structure
-        }
-    } catch (error) {
-        console.error('Fetch error:', error);
-        return null;
-    }
-}
-
 
 /**
  * Fetches the completion status for multiple songs for the current user.
@@ -300,6 +273,41 @@ export async function postContentUnliked(contentId) {
     return await fetchHandler(url, "post");
 }
 
+export async function fetchChallengeMetadata(contentId) {
+    let url = `/challenges/${contentId}`;
+    return await fetchHandler(url, 'get');
+}
+
+export async function fetchUserChallengeProgress(contentId) {
+    let url = `/challenges/user_data/${contentId}`;
+    return await fetchHandler(url, 'get');
+}
+
+export async function fetchUserAward(contentId) {
+    let url = `/challenges/download_award/${contentId}`;
+    return await fetchHandler(url, 'get');
+}
+
+export async function postChallengesSetStartDate(contentId, startDate) {
+    let url = `/challenges/set_start_date/${contentId}?start_date=${startDate}`;
+    return await fetchHandler(url, 'post');
+}
+
+export async function postChallengesUnlock(contentId) {
+    let url = `/challenges/unlock/${contentId}`;
+    return await fetchHandler(url, 'post');
+}
+
+export async function postChallengesEnroll(contentId) {
+    let url = `/challenges/enroll/${contentId}`;
+    return await fetchHandler(url, 'post');
+}
+
+export async function postChallengesLeave(contentId) {
+    let url = `/challenges/leave/${contentId}`;
+    return await fetchHandler(url, 'post');
+}
+
 function fetchAbsolute(url, params) {
     if (globalConfig.railcontentConfig.baseUrl) {
         if (url.startsWith('/')) {

package/src/services/sanity.js

@@ -18,6 +18,7 @@ import {
 
 import {
     processMetadata,
+    typeWithSortOrder
 } from "../contentMetaData";
 
 import {globalConfig} from "./config";
@@ -25,6 +26,12 @@ import {globalConfig} from "./config";
 import { fetchUserPermissions, fetchAllCompletedStates, fetchCurrentSongComplete } from './railcontent.js';
 import {arrayToStringRepresentation, FilterBuilder} from "../filterBuilder";
 
+/**
+ * Exported functions that are excluded from index generation.
+ *
+ * @type {string[]}
+ */
+const excludeFromGeneratedIndex = [];
 /**
 * Fetch a song by its document ID from Sanity.
 *
@@ -960,19 +967,17 @@ export async function fetchLessonContent(railContentId) {
 * @returns {Promise<Array<Object>|null>} - The fetched related lessons data or null if not found.
 */
 export async function fetchRelatedLessons(railContentId, brand) {
-  // let sort = 'published_on'
-  // if (type == 'rhythmic-adventures-of-captain-carson' ||
-  //     type == 'diy-drum-experiments' ||
-  //     type == 'in-rhythm') {
-  //     sort = 'sort';
-  // }
-  //TODO: Implement $this->contentService->getFiltered
-  const query = `*[railcontent_id == ${railContentId} && brand == "${brand}" && references(*[_type=='permission']._id)]{
+    const query = `*[railcontent_id == ${railContentId} && brand == "${brand}" && references(*[_type=='permission']._id)]{
+   _type, parent_type, railcontent_id,
               "related_lessons" : array::unique([
-                ...(*[_type=="song" && brand == "${brand}" && references(^.artist->_id)]{_id, "id":railcontent_id, published_on, title, "thumbnail_url":thumbnail.asset->url, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,}[0...11]),
-                ...(*[_type=="song" && brand == "${brand}" && references(^.genre[]->_id)]{_id, "id":railcontent_id, published_on, title, "thumbnail_url":thumbnail.asset->url, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,}[0...11])
-                ])|order(published_on, railcontent_id)[0...11]}`;
-  return fetchSanity(query, false);
+                ...(*[references(^._id)][0].child[]->{_id, "id":railcontent_id, published_on, title, "thumbnail_url":thumbnail.asset->url, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}),
+                ...(*[_type=="song" && _type==^._type && brand == "${brand}" && references(^.artist->_id) && railcontent_id !=${railContentId}]{_id, "id":railcontent_id, published_on, title, "thumbnail_url":thumbnail.asset->url, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}|order(published_on desc, title asc)[0...11]),
+                ...(*[_type=="song" && _type==^._type && brand == "${brand}" && references(^.genre[]->_id) && railcontent_id !=${railContentId}]{_id, "id":railcontent_id, published_on, title, "thumbnail_url":thumbnail.asset->url, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}|order(published_on desc, title asc)[0...11]),
+                ...(*[_type==^._type &&  _type in ${JSON.stringify(typeWithSortOrder)} && brand == "${brand}" && railcontent_id !=${railContentId}]{_id, "id":railcontent_id, published_on, title, "thumbnail_url":thumbnail.asset->url, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type, sort}|order(sort asc, title asc)[0...11]),
+                ...(*[_type==^._type && !(_type in ${JSON.stringify(typeWithSortOrder)}) && brand == "${brand}" && railcontent_id !=${railContentId}]{_id, "id":railcontent_id, published_on, title, "thumbnail_url":thumbnail.asset->url, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}|order(published_on desc, title asc)[0...11]),
+                ])[0...11]}`;
+
+    return fetchSanity(query, false);
 }
 
 /**
@@ -1106,18 +1111,6 @@ export async function fetchChallengeOverview(id) {
   // WIP
   const query = `*[railcontent_id == ${id}]{
     ${getFieldsForContentType("challenge")}
-    "lessons": child[]->{
-      "id": railcontent_id,
-      title,
-      "image": thumbnail.asset->url,
-      "instructors": instructor[]->name,
-      length_in_seconds,
-      difficulty_string,
-      difficulty,
-      "type": _type,
-      is_always_unlocked,
-      is_bonus_content,
-    }
   } [0...1]`;
   return fetchSanity(query, false);
 }

package/test/sanityQueryService.test.js

@@ -250,6 +250,44 @@ describe('Sanity Queries', function () {
         expect(isMatch).toBeTruthy();
     });
 
+    test('fetchRelatedLessons-quick-tips', async () => {
+        const id = 406213;
+        const response = await fetchRelatedLessons(id, 'singeo');
+        log(response);
+        const relatedLessons = response.related_lessons;
+        expect(Array.isArray(relatedLessons)).toBe(true);
+        relatedLessons.forEach(lesson => {
+            expect(lesson._type).toBe('quick-tips');
+        });
+    });
+
+    test('fetchRelatedLessons-in-rhythm', async () => {
+        const id = 236677;
+        const response = await fetchRelatedLessons(id, 'drumeo');
+        log(response);
+        const relatedLessons = response.related_lessons;
+        let episode = 0;
+        expect(Array.isArray(relatedLessons)).toBe(true);
+        relatedLessons.forEach(lesson => {
+            expect(lesson._type).toBe('in-rhythm');
+            expect(lesson.sort).toBeGreaterThan(episode);
+            episode = lesson.sort;
+        });
+    });
+
+    test('fetchRelatedLessons-child', async () => {
+        const id = 362278;
+        const course = await fetchByRailContentId(362277, 'course');
+        const lessonIds = course.lessons.map((doc) => doc.id);
+        const response = await fetchRelatedLessons(id, 'drumeo');
+        log(response.related_lessons);
+        const relatedLessons = response.related_lessons;
+        expect(Array.isArray(relatedLessons)).toBe(true);
+        expect(relatedLessons.some(
+            lesson => lessonIds.includes(lesson.id)
+        )).toBe(true);
+    },10000);
+
     test('fetchChildren', async () => {
         // complement test to fetchParentByRailContentId
         const id = 191338; ////https://web-staging-one.musora.com/admin/studio/publishing/structure/play-along;play-along_191338
@@ -463,9 +501,9 @@ describe('Sanity Queries', function () {
         const response = await fetchChallengeOverview(id);
         log(response);
         expect(response.award).toBeDefined();
-        expect(response.award_template).toBeDefined();
-        expect(response.lessons[0].is_always_unlocked).toBeDefined();
-        expect(response.lessons[0].is_bonus_content).toBeDefined();
+        expect(response.award_custom_text).toBeDefined();
+        expect(response.lessons[0].is_always_unlocked_for_challenge).toBeDefined();
+        expect(response.lessons[0].is_bonus_content_for_challenge).toBeDefined();
     });
 
     test('fetchShowsData-OddTimes', async () => {

package/tools/generate-index.js

@@ -11,7 +11,7 @@ const fileExports = {};
 /**
  * Helper function to extract function names from ES module and CommonJS exports
  *
- * @param filePath
+ * @param {string} filePath
  * @returns {string[]}
  */
 function extractExportedFunctions(filePath) {
@@ -30,9 +30,29 @@ function extractExportedFunctions(filePath) {
         matches = matches.concat(exportsList);
     }
 
+    const excludedFunctions = getExclusionList(fileContent);
+    matches = matches.filter(fn => !excludedFunctions.includes(fn));
+
     return matches.sort();
 }
 
+/**
+ * Helper function to find the list of exclusions from the file's exports
+ *
+ * @param {string} fileContent
+ * @returns {string[]}
+ */
+function getExclusionList(fileContent) {
+    const excludeRegex = /const\s+excludeFromGeneratedIndex\s*=\s*\[(.*?)\];/;
+    const excludeMatch = fileContent.match(excludeRegex);
+    let excludedFunctions = [];
+    if (excludeMatch) {
+        excludedFunctions = excludeMatch[1]
+            .split(',')
+            .map(name => name.trim().replace(/['"`]/g, ''));
+    }
+    return excludedFunctions;
+}
 
 // get all files in the services directory
 const servicesDir = path.join(__dirname, '../src/services');