musora-content-services 1.0.12 → 1.0.14

package/.github/workflows/node.js.yml

@@ -0,0 +1,39 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - name: 'Create env file'
+      run: |
+          touch .env
+          echo SANITY_API_TOKEN=${{ secrets.SANITY_API_TOKEN }} >> .env
+          echo SANITY_PROJECT_ID=4032r8py >> .env
+          echo SANITY_DATASET=staging >> .env
+          echo SANITY_USE_CACHED_API=false >> .env
+          cat .env
+    - run: npm test

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.14](https://github.com/railroadmedia/musora-content-services/compare/v1.0.13...v1.0.14) (2024-08-13)
+
+### [1.0.13](https://github.com/railroadmedia/musora-content-services/compare/v1.0.12...v1.0.13) (2024-08-13)
+
 ### [1.0.12](https://github.com/railroadmedia/musora-content-services/compare/v1.0.11...v1.0.12) (2024-08-12)
 
 ### [1.0.11](https://github.com/railroadmedia/musora-content-services/compare/v1.0.10...v1.0.11) (2024-08-12)

package/docs/global.html

@@ -146,7 +146,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line530">line 530</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line538">line 538</a>
     </li></ul></dd>
     
 
@@ -639,7 +639,7 @@ The filter options are dynamically generated based on the provided filters, styl
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line674">line 674</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line682">line 682</a>
     </li></ul></dd>
     
 
@@ -1612,7 +1612,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line463">line 463</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line471">line 471</a>
     </li></ul></dd>
     
 
@@ -1777,7 +1777,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line489">line 489</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line497">line 497</a>
     </li></ul></dd>
     
 
@@ -1942,7 +1942,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line716">line 716</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line724">line 724</a>
     </li></ul></dd>
     
 
@@ -2100,7 +2100,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line794">line 794</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line802">line 802</a>
     </li></ul></dd>
     
 
@@ -2265,7 +2265,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line758">line 758</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line766">line 766</a>
     </li></ul></dd>
     
 
@@ -2423,7 +2423,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line737">line 737</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line745">line 745</a>
     </li></ul></dd>
     
 
@@ -2581,7 +2581,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line393">line 393</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line401">line 401</a>
     </li></ul></dd>
     
 
@@ -2739,7 +2739,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line768">line 768</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line776">line 776</a>
     </li></ul></dd>
     
 
@@ -2897,7 +2897,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line848">line 848</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line856">line 856</a>
     </li></ul></dd>
     
 
@@ -3055,7 +3055,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line874">line 874</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line882">line 882</a>
     </li></ul></dd>
     
 
@@ -3220,7 +3220,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line827">line 827</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line835">line 835</a>
     </li></ul></dd>
     
 
@@ -3591,7 +3591,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line891">line 891</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line899">line 899</a>
     </li></ul></dd>
     
 
@@ -4427,7 +4427,7 @@ fetchSanity(query, true)
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line427">line 427</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line435">line 435</a>
     </li></ul></dd>
     
 
@@ -4576,7 +4576,7 @@ fetchSanity(query, true)
 
     
 
-    <h4 class="name" id="fetchWorkouts"><span class="type-signature type-signature-async">(async) </span>fetchWorkouts<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
+    <h4 class="name" id="fetchWorkouts"><span class="type-signature type-signature-async">(async) </span>fetchWorkouts<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Array.&lt;Object>|null)>}</span></h4>
 
     
 
@@ -4586,13 +4586,14 @@ fetchSanity(query, true)
 <dl class="details">
     
     <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Fetch the latest workouts for the home page of a specific brand.</li></ul></dd>
+    <dd class="tag-description"><ul class="dummy"><li>Fetch the latest workouts for the home page of a specific brand.
+This function retrieves the latest workout content for a given brand, fetching up to five workouts. The workouts are sorted in descending order by their publication date.</li></ul></dd>
     
 
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line373">line 373</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line379">line 379</a>
     </li></ul></dd>
     
 
@@ -4637,6 +4638,13 @@ fetchSanity(query, true)
 
 
 
+    <h5 class="h5-examples">Example</h5>
+    
+    <pre class="prettyprint"><code>fetchWorkouts('drumeo')
+  .then(workouts => console.log(workouts))
+  .catch(error => console.error(error));</code></pre>
+
+
 
 
     <h5 class="h5-parameters">Parameters:</h5>
@@ -4681,7 +4689,7 @@ fetchSanity(query, true)
 
             
 
-            <td class="description last">The brand for which to fetch workouts.</td>
+            <td class="description last">The brand for which to fetch workouts (e.g., 'drumeo', 'pianote').</td>
         </tr>
 
     
@@ -4707,7 +4715,7 @@ fetchSanity(query, true)
 
         
 <div class="param-desc">
-    - The fetched workout data or null if not found.
+    - A promise that resolves to an array of workout data objects or null if no workouts are found.
 </div>
 
 
@@ -4718,7 +4726,7 @@ fetchSanity(query, true)
     </dt>
     <dd>
         
-<span class="param-type">Promise.&lt;(Object|null)></span>
+<span class="param-type">Promise.&lt;(Array.&lt;Object>|null)></span>
 
 
 
@@ -5152,7 +5160,7 @@ initializeSanityService({
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Aug 12 2024 15:31:44 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 03:05:39 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 Mon Aug 12 2024 15:31:44 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 03:05:39 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

@@ -132,7 +132,7 @@ async function fetchArtists(brand) {
  */
 async function fetchSongArtistCount(brand) {
     const query = `count(*[_type == 'artist']{'lessonsCount': count(*[_type == 'song' && brand == '${brand}' && references(^._id)]._id)}[lessonsCount > 0])`;
-    return fetchSanity(query, false);
+    return fetchSanity(query, true);
 }
 
 /**
@@ -304,21 +304,21 @@ async function fetchAllSongs(brand, {
             '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 ]{
-              railcontent_id,
+             "id": railcontent_id,
+              "type": _type,
               title,
-              "image": thumbnail.asset->url,
+              "thumbnail_url": thumbnail.asset->url,
               "artist_name": artist->name,
-              artist,
-              difficulty,
               difficulty_string,
-              web_url_path,
-              published_on
+              published_on,
+              soundslice, 
+              instrumentless,
             }[0...10]
           }
         |order(${sortOrder})
         [${start}...${end}]
       }`;
-    } else if (groupBy === "genre") {
+    } else if (groupBy === "style") {
         query = `
       {
         "total": count(*[_type == 'genre'  && count(*[_type == 'song' && brand == '${brand}' && ^._id in genre[]._ref ]._id) > 0]),
@@ -331,15 +331,15 @@ async function fetchAllSongs(brand, {
             '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 ]{
-              railcontent_id,
+              "id": railcontent_id,
+              "type": _type,
               title,
-              "image": thumbnail.asset->url,
+              "thumbnail_url": thumbnail.asset->url,
               "artist_name": artist->name,
-              artist,
-              difficulty,
               difficulty_string,
-              web_url_path,
-              published_on
+              published_on,
+              soundslice, 
+              instrumentless,
             }[0...10]
           }
         |order(${sortOrder})
@@ -349,22 +349,22 @@ async function fetchAllSongs(brand, {
         query = `
       {
         "entity": *[_type == 'song' && brand == "${brand}" ${searchFilter} ${includedFieldsFilter}] | order(${sortOrder}) [${start}...${end}] {
-          railcontent_id,
+          "id": railcontent_id,
+          "type": _type,
           title,
-          "image": thumbnail.asset->url,
+          "thumbnail_url": thumbnail.asset->url,
           "artist_name": artist->name,
-          artist,
-          difficulty,
           difficulty_string,
-          web_url_path,
-          published_on
+          published_on,
+          soundslice, 
+          instrumentless,
         },
         "total": count(*[_type == 'song' && brand == "${brand}" ${searchFilter} ${includedFieldsFilter}])
       }
     `;
     }
 
-    return fetchSanity(query, false);
+    return fetchSanity(query, true);
 }
 
 /**
@@ -382,24 +382,24 @@ async function fetchSongFilterOptions(brand) {
     const query = `
     {
       "difficulty": [
-        {"type": "Introductory", "count": count(*[_type == 'song' && brand == ${brand} && difficulty_string == "Introductory"]._id)},
-        {"type": "Beginner", "count": count(*[_type == 'song' && brand == ${brand} && difficulty_string == "Beginner"]._id)},
-        {"type": "Intermediate", "count": count(*[_type == 'song' && brand == ${brand} && difficulty_string == "Intermediate"]._id)},
-        {"type": "Advanced", "count": count(*[_type == 'song' && brand == ${brand} && difficulty_string == "Advanced"]._id)},
-        {"type": "Expert", "count": count(*[_type == 'song' && brand == ${brand} && difficulty_string == "Expert"]._id)}
+        {"type": "Introductory", "count": count(*[_type == 'song' && brand == '${brand}' && difficulty_string == "Introductory"]._id)},
+        {"type": "Beginner", "count": count(*[_type == 'song' && brand == '${brand}' && difficulty_string == "Beginner"]._id)},
+        {"type": "Intermediate", "count": count(*[_type == 'song' && brand == '${brand}' && difficulty_string == "Intermediate"]._id)},
+        {"type": "Advanced", "count": count(*[_type == 'song' && brand == '${brand}' && difficulty_string == "Advanced"]._id)},
+        {"type": "Expert", "count": count(*[_type == 'song' && brand == '${brand}' && difficulty_string == "Expert"]._id)}
       ],
       "genre": *[_type == 'genre' && 'song' in filter_types] {
         "type": name,
-        "count": count(*[_type == 'song' && brand == ${brand} && references(^._id)]._id)
+        "count": count(*[_type == 'song' && brand == '${brand}' && references(^._id)]._id)
       },
       "instrumentless": [
-        {"type": "Full Song Only", "count": count(*[_type == 'song' && brand == ${brand} && instrumentless == false]._id)},
-        {"type": "Instrument Removed", "count": count(*[_type == 'song' && brand == ${brand} && instrumentless == true]._id)}
+        {"type": "Full Song Only", "count": count(*[_type == 'song' && brand == '${brand}' && instrumentless == false]._id)},
+        {"type": "Instrument Removed", "count": count(*[_type == 'song' && brand == '${brand}' && instrumentless == true]._id)}
       ]
     }
   `;
 
-    return fetchSanity(query, false);
+    return fetchSanity(query, true);
 }
 
 /**
@@ -414,20 +414,28 @@ async function fetchSongCount(brand) {
 
 /**
  * Fetch the latest workouts for the home page of a specific brand.
- * @param {string} brand - The brand for which to fetch workouts.
- * @returns {Promise<Object|null>} - The fetched workout data or null if not found.
+ * This function retrieves the latest workout content for a given brand, fetching up to five workouts. The workouts are sorted in descending order by their publication date.
+ * @param {string} brand - The brand for which to fetch workouts (e.g., 'drumeo', 'pianote').
+ * @returns {Promise<Array<Object>|null>} - A promise that resolves to an array of workout data objects or null if no workouts are found.
+ *
+ * @example
+ * fetchWorkouts('drumeo')
+ *   .then(workouts => console.log(workouts))
+ *   .catch(error => console.error(error));
  */
 async function fetchWorkouts(brand) {
     const query = `*[_type == 'workout' && brand == '${brand}'] [0...5] {
           railcontent_id,
           title,
           "image": thumbnail.asset->url,
-          "artist_name": artist->name,
-          artist,
+          "artist_name": instructor[0]->name,
+          "artists": instructor[]->name,
           difficulty,
           difficulty_string,
+          length_in_seconds,
+          published_on,
+          "type": _type,
           web_url_path,
-          published_on
         } | order(published_on desc)[0...5]`
     return fetchSanity(query, true);
 }
@@ -1027,7 +1035,6 @@ module.exports = {
     fetchPackChildren,
     fetchLessonContent
 };
-
 </code></pre>
         </article>
     </section>
@@ -1042,7 +1049,7 @@ module.exports = {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Aug 12 2024 15:31:44 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 03:05:39 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.12",
+  "version": "1.0.14",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "scripts": {

package/src/index.js

@@ -367,20 +367,28 @@ async function fetchSongCount(brand) {
 
 /**
  * Fetch the latest workouts for the home page of a specific brand.
- * @param {string} brand - The brand for which to fetch workouts.
- * @returns {Promise<Object|null>} - The fetched workout data or null if not found.
+ * This function retrieves the latest workout content for a given brand, fetching up to five workouts. The workouts are sorted in descending order by their publication date.
+ * @param {string} brand - The brand for which to fetch workouts (e.g., 'drumeo', 'pianote').
+ * @returns {Promise<Array<Object>|null>} - A promise that resolves to an array of workout data objects or null if no workouts are found.
+ *
+ * @example
+ * fetchWorkouts('drumeo')
+ *   .then(workouts => console.log(workouts))
+ *   .catch(error => console.error(error));
  */
 async function fetchWorkouts(brand) {
     const query = `*[_type == 'workout' && brand == '${brand}'] [0...5] {
           railcontent_id,
           title,
           "image": thumbnail.asset->url,
-          "artist_name": artist->name,
-          artist,
+          "artist_name": instructor[0]->name,
+          "artists": instructor[]->name,
           difficulty,
           difficulty_string,
+          length_in_seconds,
+          published_on,
+          "type": _type,
           web_url_path,
-          published_on
         } | order(published_on desc)[0...5]`
     return fetchSanity(query, true);
 }