musora-content-services 1.0.18 → 1.0.20

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 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.19](https://github.com/railroadmedia/musora-content-services/compare/v1.0.18...v1.0.19) (2024-08-13)
+
 ### [1.0.18](https://github.com/railroadmedia/musora-content-services/compare/v1.0.17...v1.0.18) (2024-08-13)
 
 ### [1.0.17](https://github.com/railroadmedia/musora-content-services/compare/v1.0.16...v1.0.17) (2024-08-13)

package/docs/global.html

@@ -5330,7 +5330,7 @@ initializeSanityService({
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Tue Aug 13 2024 18:37:07 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 Tue Aug 13 2024 19:10:16 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/index.html

@@ -103,7 +103,7 @@ Run the following to execute the tests</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Tue Aug 13 2024 18:37:07 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 Tue Aug 13 2024 19:10:16 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/index.js.html

@@ -543,9 +543,9 @@ async function fetchLiveEvent(brand) {
   // Adjust the query to filter events based on the calculated time window
   const query = `
     *[_type in [${typesString}] && brand == '${brand}' 
-    && published_on > '${twoDaysAgo}' 
-    && published_on <= '${now}' 
-    && dateTime(published_on) + length_in_seconds * 1000 > '${now}'] {
+      && published_on > '${twoDaysAgo}' 
+      || (published_on <= '${now}' && dateTime(published_on) + length_in_seconds * 1000 > '${now}')
+    ] {
       "id": railcontent_id,
       title,
       "image": thumbnail.asset->url,
@@ -1081,6 +1081,7 @@ module.exports = {
     fetchSongCount,
     fetchWorkouts,
     fetchNewReleases,
+    fetchLiveEvent,
     fetchUpcomingEvents,
     fetchByRailContentId,
     fetchByRailContentIds,
@@ -1108,7 +1109,7 @@ module.exports = {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Tue Aug 13 2024 18:37:07 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 Tue Aug 13 2024 19:10:16 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.18",
+  "version": "1.0.20",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "scripts": {

package/src/contentTypeConfig.js

@@ -0,0 +1,30 @@
+let contentTypeConfig = {
+    'song': {
+        'fields': [
+            '"artist_name": artist->name',
+            'soundslice',
+            'instrumentless'
+        ],
+        'relationships': {
+            'artist': {
+                isOneToOne: true
+            }
+        }
+    },
+    'challenge':{
+        'fields':[
+            'enrollment_start_time',
+            'enrollment_end_time',
+            'registration_url',
+            '"lesson_count": child_count',
+            '"primary_cta_text": select(dateTime(published_on) > dateTime(now()) && dateTime(enrollment_start_time) > dateTime(now()) => "Notify Me", "Start Challenge")',
+            'challenge_state',
+            'challenge_state_text',
+        ]
+    }
+}
+
+
+module.exports = {
+    contentTypeConfig
+}

package/src/index.js

@@ -1,3 +1,5 @@
+const {contentTypeConfig} = require('../src/contentTypeConfig.js');
+
 let globalConfig = {};
 
 /**
@@ -11,7 +13,7 @@ let globalConfig = {};
  * @param {string} config.version - The API version to use.
  * @param {boolean} [config.debug=false] - Optional flag to enable debug mode, which logs the query and results.
  * @param {boolean} [config.useCachedAPI=true] - Optional flag to disable cached API.
- * 
+ *
  * @example
  * // Initialize the Sanity service in your app.js
  * initializeSanityService({
@@ -179,7 +181,7 @@ async function fetchRelatedSongs(brand, songId) {
  * @param {Array<string>} [params.includedFields=[]] - The fields to include in the query.
  * @param {string} [params.groupBy=""] - The field to group the results by.
  * @returns {Promise<Object|null>} - The fetched song data or null if not found.
- * 
+ *
  * @example
  * fetchAllSongs('drumeo', {
  *   page: 2,
@@ -200,124 +202,7 @@ async function fetchAllSongs(brand, {
     includedFields = [],
     groupBy = ""
 }) {
-    console.log('groupBy', groupBy)
-    const start = (page - 1) * limit;
-    const end = start + limit;
-
-    // Construct the search filter
-    const searchFilter = searchTerm
-        ? `&& (artist->name match "${searchTerm}*" || title match "${searchTerm}*")`
-        : "";
-
-    // Construct the included fields filter, replacing 'difficulty' with 'difficulty_string'
-    const includedFieldsFilter = includedFields.length > 0
-        ? includedFields.map(field => {
-            let [key, value] = field.split(',');
-            if (key === 'difficulty') {
-                key = 'difficulty_string';
-            }
-            return `&& ${key} == "${value}"`;
-        }).join(' ')
-        : "";
-
-    // Determine the sort order
-    let sortOrder;
-    switch (sort) {
-        case "slug":
-            sortOrder = "artist->name asc";
-            break;
-        case "published_on":
-            sortOrder = "published_on desc";
-            break;
-        case "-published_on":
-            sortOrder = "published_on asc";
-            break;
-        case "-slug":
-            sortOrder = "artist->name desc";
-            break;
-        case "-popularity":
-            sortOrder = "popularity desc";
-            break;
-        default:
-            sortOrder = "published_on asc";
-            break;
-    }
-
-    // Determine the group by clause
-    let query = "";
-    if (groupBy === "artist") {
-        query = `
-      {
-        "total": count(*[_type == 'artist' && count(*[_type == 'song' && brand == '${brand}' && ^._id == artist._ref ]._id) > 0]),
-        "entity": *[_type == 'artist' && count(*[_type == 'song' && brand == '${brand}' && ^._id == artist._ref ]._id) > 0]
-          {
-            'id': _id,
-            'type': _type,
-            name,
-            'head_shot_picture_url': thumbnail_url.asset->url,
-            'all_lessons_count': count(*[_type == 'song' && brand == '${brand}' && ^._id == artist._ref ]._id),
-            'lessons': *[_type == 'song' && brand == '${brand}' && ^._id == artist._ref ]{
-             "id": railcontent_id,
-              "type": _type,
-              title,
-              "thumbnail_url": thumbnail.asset->url,
-              "artist_name": artist->name,
-              difficulty_string,
-              published_on,
-              soundslice, 
-              instrumentless,
-            }[0...10]
-          }
-        |order(${sortOrder})
-        [${start}...${end}]
-      }`;
-    } else if (groupBy === "style") {
-        query = `
-      {
-        "total": count(*[_type == 'genre'  && count(*[_type == 'song' && brand == '${brand}' && ^._id in genre[]._ref ]._id) > 0]),
-        "entity":
-          *[_type == 'genre'  && count(*[_type == 'song' && brand == '${brand}' && ^._id in genre[]._ref ]._id)>0]
-          {
-            'id': _id,
-            'type': _type,
-            name,
-            'head_shot_picture_url': thumbnail_url.asset->url,
-            'all_lessons_count': count(*[_type == 'song' && brand == '${brand}' && ^._id in genre[]._ref ]._id),
-            'lessons': *[_type == 'song' && brand == '${brand}' && ^._id in genre[]._ref ]{
-              "id": railcontent_id,
-              "type": _type,
-              title,
-              "thumbnail_url": thumbnail.asset->url,
-              "artist_name": artist->name,
-              difficulty_string,
-              published_on,
-              soundslice, 
-              instrumentless,
-            }[0...10]
-          }
-        |order(${sortOrder})
-        [${start}...${end}]
-      }`;
-    } else {
-        query = `
-      {
-        "entity": *[_type == 'song' && brand == "${brand}" ${searchFilter} ${includedFieldsFilter}] | order(${sortOrder}) [${start}...${end}] {
-          "id": railcontent_id,
-          "type": _type,
-          title,
-          "thumbnail_url": thumbnail.asset->url,
-          "artist_name": artist->name,
-          difficulty_string,
-          published_on,
-          soundslice, 
-          instrumentless,
-        },
-        "total": count(*[_type == 'song' && brand == "${brand}" ${searchFilter} ${includedFieldsFilter}])
-      }
-    `;
-    }
-
-    return fetchSanity(query, true);
+    return fetchAll(brand, 'song', {page, limit, searchTerm, sort, includedFields, groupBy});
 }
 
 /**
@@ -496,9 +381,9 @@ async function fetchLiveEvent(brand) {
   // Adjust the query to filter events based on the calculated time window
   const query = `
     *[_type in [${typesString}] && brand == '${brand}' 
-    && published_on > '${twoDaysAgo}' 
-    && published_on <= '${now}' 
-    && dateTime(published_on) + length_in_seconds * 1000 > '${now}'] {
+      && published_on > '${twoDaysAgo}' 
+      || (published_on <= '${now}' && dateTime(published_on) + length_in_seconds * 1000 > '${now}')
+    ] {
       "id": railcontent_id,
       title,
       "image": thumbnail.asset->url,
@@ -581,7 +466,7 @@ async function fetchByRailContentIds(ids) {
  * @param {Array<string>} [params.includedFields=[]] - The fields to include in the query.
  * @param {string} [params.groupBy=""] - The field to group the results by (e.g., 'artist', 'genre').
  * @returns {Promise<Object|null>} - The fetched content data or null if not found.
- * 
+ *
  * @example
  * fetchAll('drumeo', 'song', {
  *   page: 2,
@@ -602,6 +487,9 @@ async function fetchAll(brand, type, {
     includedFields = [],
     groupBy = ""
 }) {
+    let config = contentTypeConfig[type] ?? {};
+    let additionalFields = config?.fields ?? [];
+    let isGroupByOneToOne = (groupBy ? config?.relationships[groupBy]?.isOneToOne : false) ?? false;
     const start = (page - 1) * limit;
     const end = start + limit;
 
@@ -644,10 +532,20 @@ async function fetchAll(brand, type, {
             break;
     }
 
+    let defaultFields = ['railcontent_id',
+        'title',
+        '"image": thumbnail.asset->url',
+        'difficulty',
+        'difficulty_string',
+        'web_url_path',
+        'published_on'];
+
+    let fields = defaultFields.concat(additionalFields);
+    let fieldsString = fields.join(',');
+
     // Determine the group by clause
     let query = "";
-    let manyReference = true; //TODO: define whether reference is one to one or one to many
-    if (groupBy !== "" && !manyReference) {
+    if (groupBy !== "" && isGroupByOneToOne) {
         query = `
         {
             "total": count(*[_type == '${groupBy}' && count(*[_type == '${type}' && brand == '${brand}' && ^._id == ${groupBy}._ref ]._id) > 0]),
@@ -659,20 +557,14 @@ async function fetchAll(brand, type, {
                 'head_shot_picture_url': thumbnail_url.asset->url,
                 'all_lessons_count': count(*[_type == '${type}' && brand == '${brand}' && ^._id == ${groupBy}._ref ]._id),
                 'lessons': *[_type == '${type}' && brand == '${brand}' && ^._id == ${groupBy}._ref ]{
-                railcontent_id,
-                title,
-                "image": thumbnail.asset->url,
-                difficulty,
-                difficulty_string,
-                web_url_path,
-                published_on,
-                ${groupBy}
+                    ${fieldsString},
+                    ${groupBy}
                 }[0...10]
             }
             |order(${sortOrder})
             [${start}...${end}]
         }`;
-    } else if (groupBy !== "" && manyReference) {
+    } else if (groupBy !== "") {
         query = `
         {
             "total": count(*[_type == '${groupBy}' && count(*[_type == '${type}' && brand == '${brand}' && ^._id in ${groupBy}[]._ref]._id)>0]),
@@ -684,14 +576,8 @@ async function fetchAll(brand, type, {
                 'head_shot_picture_url': thumbnail_url.asset->url,
                 'all_lessons_count': count(*[_type == '${type}' && brand == '${brand}' && ^._id in ${groupBy}[]._ref ]._id),
                 'lessons': *[_type == '${type}' && brand == '${brand}' && ^._id in ${groupBy}[]._ref ]{
-                railcontent_id,
-                title,
-                "image": thumbnail.asset->url,
-                difficulty,
-                difficulty_string,
-                web_url_path,
-                published_on,
-                ${groupBy}
+                    ${fieldsString},
+                    ${groupBy}
                 }[0...10]
             }
             |order(${sortOrder})
@@ -701,20 +587,14 @@ async function fetchAll(brand, type, {
         query = `
         {
             "entity": *[_type == '${type}' && brand == "${brand}" ${searchFilter} ${includedFieldsFilter}] | order(${sortOrder}) [${start}...${end}] {
-            railcontent_id,
-            title,
-            "image": thumbnail.asset->url,
-            difficulty,
-            difficulty_string,
-            web_url_path,
-            published_on
+                ${fieldsString}
             },
             "total": count(*[_type == '${type}' && brand == "${brand}" ${searchFilter} ${includedFieldsFilter}])
         }
     `;
     }
 
-    return fetchSanity(query, false);
+    return fetchSanity(query, true);
 }
 
 /**
@@ -739,14 +619,14 @@ async function fetchAll(brand, type, {
  *   .catch(error => console.error(error));
  */
 async function fetchAllFilterOptions(
-  brand,
-  filters,
-  style,
-  artist,
-  contentType,
-  term
-){
-  const query = `
+    brand,
+    filters,
+    style,
+    artist,
+    contentType,
+    term
+) {
+    const query = `
         {  
           "meta": {
             "totalResults": count(*[_type == '${contentType}' && brand == "${brand}" && ${style ? `'${style}' in genre[]->name` : `artist->name == '${artist}'`} ${filters}
@@ -772,7 +652,7 @@ async function fetchAllFilterOptions(
       }
     `;
 
-  return fetchSanity(query, false);
+    return fetchSanity(query, false);
 }
 
 /**
@@ -852,7 +732,7 @@ async function fetchNextPreviousLesson(railcontentId) {
  * Fetch the page data for a specific lesson by Railcontent ID.
  * @param {string} railContentId - The Railcontent ID of the current lesson.
  * @returns {Promise<Object|null>} - The fetched page data or null if found.
- * 
+ *
  * @example
  * fetchLessonContent('lesson123')
  *   .then(data => console.log(data))
@@ -932,7 +812,7 @@ async function fetchPackAll(railcontentId) {
  * Fetch all children of a specific pack by Railcontent ID.
  * @param {string} railcontentId - The Railcontent ID of the pack.
  * @returns {Promise<Array<Object>|null>} - The fetched pack children data or null if not found.
- * 
+ *
  * @example
  * fetchPackChildren('pack123')
  *   .then(children => console.log(children))
@@ -956,38 +836,38 @@ async function fetchPackChildren(railcontentId) {
  *   .catch(error => console.error(error));
  */
 async function fetchSanity(query, isList) {
-  // Check the config object before proceeding
-  if (!checkConfig(globalConfig)) {
-      return null;
-  }
+    // Check the config object before proceeding
+    if (!checkConfig(globalConfig)) {
+        return null;
+    }
 
-  if (globalConfig.debug) {
-      console.log("fetchSanity Query:", query);
-  }
+    if (globalConfig.debug) {
+        console.log("fetchSanity Query:", query);
+    }
 
-  const encodedQuery = encodeURIComponent(query);
-  const api = globalConfig.useCachedAPI ? 'apicdn' : 'api'
-  const url = `https://${globalConfig.projectId}.${api}.sanity.io/v${globalConfig.version}/data/query/${globalConfig.dataset}?query=${encodedQuery}`;
-  const headers = {
-      'Authorization': `Bearer ${globalConfig.token}`,
-      'Content-Type': 'application/json'
-  };
+    const encodedQuery = encodeURIComponent(query);
+    const api = globalConfig.useCachedAPI ? 'apicdn' : 'api'
+    const url = `https://${globalConfig.projectId}.${api}.sanity.io/v${globalConfig.version}/data/query/${globalConfig.dataset}?query=${encodedQuery}`;
+    const headers = {
+        'Authorization': `Bearer ${globalConfig.token}`,
+        'Content-Type': 'application/json'
+    };
 
-  try {
-      const response = await fetch(url, {headers});
-      const result = await response.json();
-      if (result.result) {
-          if (globalConfig.debug) {
-              console.log("fetchSanity Results:", result);
-          }
-          return isList ? result.result : result.result[0];
-      } else {
-          throw new Error('No results found');
-      }
-  } catch (error) {
-      console.error('fetchSanity: Fetch error:', error);
-      return null;
-  }
+    try {
+        const response = await fetch(url, {headers});
+        const result = await response.json();
+        if (result.result) {
+            if (globalConfig.debug) {
+                console.log("fetchSanity Results:", result);
+            }
+            return isList ? result.result : result.result[0];
+        } else {
+            throw new Error('No results found');
+        }
+    } catch (error) {
+        console.error('fetchSanity: Fetch error:', error);
+        return null;
+    }
 }
 
 

package/test/sanityQueryService.test.js

@@ -79,6 +79,41 @@ describe('Sanity Queries', function () {
         expect(response.railcontent_id).toBe(id);
     });
 
+    test('fetchAllSongs', async () => {
+        const response = await fetchAllSongs('drumeo', {});
+        console.log(response);
+        expect(response.entity[0].soundslice).toBeDefined();
+        expect(response.entity[0].artist_name).toBeDefined();
+        expect(response.entity[0].instrumentless).toBeDefined();
+    });
+
+    test('fetchAllSongsGroupByArtist', async () => {
+        const response = await fetchAllSongs('drumeo', {groupBy:"artist"});
+        expect(response.entity[0].lessons[0].soundslice).toBeDefined();
+        expect(response.entity[0].lessons[0].artist_name).toBeDefined();
+        expect(response.entity[0].lessons[0].instrumentless).toBeDefined();
+    }, 100000);
+
+
+    test('fetchAllWorkouts', async () => {
+        const response = await fetchAll('drumeo', 'workout',{});
+        console.log(response);
+        expect(response.entity[0].railcontent_id).toBeDefined();
+    });
+
+    test('fetchAllChallenges', async () => {
+        const response = await fetchAll('drumeo', 'challenge',{});
+        console.log(response);
+        expect(response.entity[0].registration_url).toBeDefined();
+        expect(response.entity[0].enrollment_start_time).toBeDefined();
+        expect(response.entity[0].enrollment_end_time).toBeDefined();
+
+        expect(response.entity[0].lesson_count).toBeDefined();
+        expect(response.entity[0].primary_cta_text).toBeDefined();
+        expect(response.entity[0].challenge_state).toBeDefined();
+        expect(response.entity[0].challenge_state_text).toBeDefined();
+
+    });
     // test('fetchRelatedLessons', async () => {
     //     const id = 380094;
     //     const response = await fetchRelatedLessons(id, 'singeo', 'song');