musora-content-services 1.0.89 → 1.0.91

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#.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><li data-type='method'><a href="module-Railcontent-Services.html#.fetchVimeoData">fetchVimeoData</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#.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#.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#.fetchLessonContent">fetchLessonContent</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#.fetchParentByRailContentId">fetchParentByRailContentId</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#.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#.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#.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><li data-type='method'><a href="module-Railcontent-Services.html#.fetchVimeoData">fetchVimeoData</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#.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#.fetchLessonContent">fetchLessonContent</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#.fetchParentByRailContentId">fetchParentByRailContentId</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#.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#.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>
 
@@ -271,7 +271,7 @@ export async function fetchSongFilterOptions(brand) {
 */
 export async function fetchSongCount(brand) {
   const query = `count(*[_type == 'song' &amp;&amp; brand == "${brand}"])`;
-  return fetchSanity(query, false);
+  return fetchSanity(query, true);
 }
 
 /**
@@ -719,6 +719,7 @@ export async function fetchMethodChildren(railcontentId) {
     "description": ${descriptionField},
     title,
     xp,
+    total_xp,
     'children': child[]->{
         ${getFieldsForContentType('method')}
     },
@@ -859,7 +860,9 @@ export async function fetchLessonContent(railContentId) {
           "instructors":instructor[]->name,
           instructor[]->,
           ${assignmentsField}
-         video}`
+          video,
+          length_in_seconds
+        }`
   return fetchSanity(query, false);
 }
 
@@ -867,17 +870,20 @@ export async function fetchLessonContent(railContentId) {
 * Fetch related 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.
-* @param {string} contentType - name of the contentype to pull
 * @returns {Promise&lt;Array&lt;Object>|null>} - The fetched related lessons data or null if not found.
 */
-export async function fetchRelatedLessons(railContentId, brand, contentType) {
-  let typeQuery = contentType ? `_type=="${contentType}" &amp;&amp;` : ""; 
-  
+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} &amp;&amp; brand == "${brand}" &amp;&amp; references(*[_type=='permission']._id)]{
               "related_lessons" : array::unique([
-                _...(*[${typeQuery} brand == "${brand}" &amp;&amp; references(^.artist->_id)]{_id, "id":railcontent_id, published_on, title, "thumbnail_url":thumbnail.asset->url, difficulty_string, railcontent_id, artist->}[0...11]),
-                ...(*[${typeQuery} brand == "${brand}" &amp;&amp; references(^.genre[]->_id)]{_id, "id":railcontent_id, published_on, title, "thumbnail_url":thumbnail.asset->url, difficulty_string, railcontent_id, artist->}[0...11])
+                ...(*[_type=="song" &amp;&amp; brand == "${brand}" &amp;&amp; references(^.artist->_id)]{_id, "id":railcontent_id, published_on, title, "thumbnail_url":thumbnail.asset->url, difficulty_string, railcontent_id, artist->}[0...11]),
+                ...(*[_type=="song" &amp;&amp; brand == "${brand}" &amp;&amp; references(^.genre[]->_id)]{_id, "id":railcontent_id, published_on, title, "thumbnail_url":thumbnail.asset->url, difficulty_string, railcontent_id, artist->}[0...11])
                 ])|order(published_on, railcontent_id)[0...11]}`;
   return fetchSanity(query, false);
 }
@@ -1041,33 +1047,49 @@ export async function fetchCoachLessons(brand, id, {
  *   .catch(error => console.error(error));
  */
 export async function fetchCourseOverview(id) {
-  // WIP
   const query = `*[railcontent_id == ${id}]{
-        "id": railcontent_id,
-        railcontent_id,
-        title,
-        "image": thumbnail.asset->url,
-        "instructors": instructor[]->name,
-        difficulty,
-        difficulty_string,
-        web_url_path,
-        published_on,
-        "type": _type,
-        total_xp,
-        xp,
-        description,
-        resource,
-        "lessons": child[]->{
-          "id": railcontent_id,
-          title,
-          "image": thumbnail.asset->url,
-          "instructors": instructor[]->name,
-          length_in_seconds,
-        }
+        ${getFieldsForContentType("course", true)}
       }`
   return fetchSanity(query, false);
 }
 
+/**
+ * Fetch the data needed for the coach screen.
+ * @param {string} id - The Railcontent ID of the coach
+ * 
+ * @returns {Promise&lt;Object|null>} - The lessons for the instructor or null if not found.
+ *
+ * @example
+ * fetchCoachLessons('coach123')
+ *   .then(lessons => console.log(lessons))
+ *   .catch(error => console.error(error));
+ */
+export async function fetchByReference(brand, {
+  sortOrder = '-published_on',
+  searchTerm = '',
+  page = 1,
+  limit = 20,
+  includedFields = [],
+} = {}) {
+  const fieldsString = DEFAULT_FIELDS.join(',');
+  const start = (page - 1) * limit;
+  const end = start + limit;
+  const searchFilter = searchTerm ? `&amp;&amp; title match "${searchTerm}*"`: '';
+  const includedFieldsFilter = includedFields.length > 0
+        ? includedFields.join(' &amp;&amp; ')
+        : "";
+
+  const query = `{
+      "entity": *[brand == '${brand}' ${searchFilter} &amp;&amp; references(*[${includedFieldsFilter}]._id)] | order(${sortOrder}) [${start}...${end}]
+        {
+          ${fieldsString}
+        },
+      "total": count(*[brand == '${brand}' &amp;&amp; references(*[${includedFieldsFilter}]._id)])
+    }`;
+  return fetchSanity(query, true);
+}
+
+
 /**
  * Fetch data from the Sanity API based on a provided query.
  *
@@ -1191,7 +1213,7 @@ function checkSanityConfig(config) {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Sep 09 2024 19:23:15 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 Sep 11 2024 20:19:27 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.89",
+  "version": "1.0.91",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "scripts": {

package/src/contentTypeConfig.js

@@ -75,10 +75,18 @@ let contentTypeConfig = {
     'course': {
         'fields': [
             '"lesson_count": child_count',
-            '"instructors": instructor[]->name'
+            '"instructors": instructor[]->name',
+            `"description": ${descriptionField}`,
+            'resource',
+            `"lessons": child[]->{
+                "id": railcontent_id,
+                title,
+                "image": thumbnail.asset->url,
+                "instructors": instructor[]->name,
+                length_in_seconds,
+            }`, 
         ]
     },
-
     'method': {
         'fields': [
             `"description": ${descriptionField}`,

package/src/services/railcontent.js

@@ -142,18 +142,20 @@ export async function fetchSongsInProgress(brand) {
  *
  * @param {string} type - The content type associated with the content.
  * @param {string} brand - The brand associated with the content.
+ * @param {number} [limit=20] - The limit of results per page.
+ * @param {number} [page=1] - The page number for pagination.
  * @returns {Promise<Object|null>} - Returns an object containing in-progress content if found, otherwise null.
  * @example
  * fetchContentInProgress('song', 'drumeo')
  *   .then(songs => console.log(songs))
  *   .catch(error => console.error(error));
  */
-export async function fetchContentInProgress(type="all", brand) {
+export async function fetchContentInProgress(type="all", brand, limit=20, page=1) {
     let url;
-    if(type!=="all") {
-        url = `/content/in_progress/${globalConfig.railcontentConfig.userId}?brand=${brand}`;
+    if(type !== "all") {
+        url = `/content/in_progress/${globalConfig.railcontentConfig.userId}?brand=${brand}&limit=${limit}&page=${page}`;
     } else {
-        url = `/content/in_progress/${globalConfig.railcontentConfig.userId}?content_type=${type}&brand=${brand}`;
+        url = `/content/in_progress/${globalConfig.railcontentConfig.userId}?content_type=${type}&brand=${brand}&limit=${limit}&page=${page}`;
     }
     const headers = {
         'Content-Type': 'application/json',
@@ -163,7 +165,46 @@ export async function fetchContentInProgress(type="all", brand) {
         const response = await fetchAbsolute(url, { headers });
         const result = await response.json();
         if(result){
-            console.log('contentInProgress', result);
+            //console.log('contentInProgress', result);
+            return result;
+        } else {
+            console.log('result not json');
+        }
+    } catch (error) {
+        console.error('Fetch error:', error);
+        return null;
+    }
+}
+
+/**
+ * Fetches a list of content that has been completed for the current user.
+ *
+ * @param {string} type - The content type associated with the content.
+ * @param {string} brand - The brand associated with the content.
+ * @param {number} [limit=20] - The limit of results per page.
+ * @param {number} [page=1] - The page number for pagination.
+ * @returns {Promise<Object|null>} - Returns an object containing in-progress content if found, otherwise null.
+ * @example
+ * fetchCompletedContent('song', 'drumeo')
+ *   .then(songs => console.log(songs))
+ *   .catch(error => console.error(error));
+ */
+export async function fetchCompletedContent(type="all", brand, limit=20, page=1) {
+    let url;
+    if(type !== "all") {
+        url = `/content/completed/${globalConfig.railcontentConfig.userId}?brand=${brand}&limit=${limit}&page=${page}`;
+    } else {
+        url = `/content/completed/${globalConfig.railcontentConfig.userId}?content_type=${type}&brand=${brand}&limit=${limit}&page=${page}`;
+    }
+    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('completed content', result);
             return result;
         } else {
             console.log('result not json');

package/src/services/sanity.js

@@ -1000,29 +1000,8 @@ export async function fetchCoachLessons(brand, id, {
  *   .catch(error => console.error(error));
  */
 export async function fetchCourseOverview(id) {
-  // WIP
   const query = `*[railcontent_id == ${id}]{
-        "id": railcontent_id,
-        railcontent_id,
-        title,
-        "image": thumbnail.asset->url,
-        "instructors": instructor[]->name,
-        difficulty,
-        difficulty_string,
-        web_url_path,
-        published_on,
-        "type": _type,
-        total_xp,
-        xp,
-        description,
-        resource,
-        "lessons": child[]->{
-          "id": railcontent_id,
-          title,
-          "image": thumbnail.asset->url,
-          "instructors": instructor[]->name,
-          length_in_seconds,
-        }
+        ${getFieldsForContentType("course", true)}
       }`
   return fetchSanity(query, false);
 }