musora-content-services 1.0.10 → 1.0.11

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.11](https://github.com/railroadmedia/musora-content-services/compare/v1.0.10...v1.0.11) (2024-08-12)
+
 ### [1.0.10](https://github.com/railroadmedia/musora-content-services/compare/v1.0.9...v1.0.10) (2024-08-12)
 
 ### [1.0.9](https://github.com/railroadmedia/musora-content-services/compare/v1.0.7...v1.0.9) (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#line463">line 463</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line530">line 530</a>
     </li></ul></dd>
     
 
@@ -191,6 +191,20 @@
 
 
 
+    <h5 class="h5-examples">Example</h5>
+    
+    <pre class="prettyprint"><code>fetchAll('drumeo', 'song', {
+  page: 2,
+  limit: 20,
+  searchTerm: 'jazz',
+  sort: '-popularity',
+  includedFields: ['difficulty,Intermediate'],
+  groupBy: 'artist'
+})
+  .then(content => console.log(content))
+  .catch(error => console.error(error));</code></pre>
+
+
 
 
     <h5 class="h5-parameters">Parameters:</h5>
@@ -625,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#line607">line 607</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line674">line 674</a>
     </li></ul></dd>
     
 
@@ -967,7 +981,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#line164">line 164</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line195">line 195</a>
     </li></ul></dd>
     
 
@@ -1012,6 +1026,20 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
 
 
+    <h5 class="h5-examples">Example</h5>
+    
+    <pre class="prettyprint"><code>fetchAllSongs('drumeo', {
+  page: 2,
+  limit: 20,
+  searchTerm: 'rock',
+  sort: 'published_on',
+  includedFields: ['difficulty', 'style'],
+  groupBy: 'artist'
+})
+  .then(result => console.log(result))
+  .catch(error => console.error(error));</code></pre>
+
+
 
 
     <h5 class="h5-parameters">Parameters:</h5>
@@ -1419,7 +1447,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#line59">line 59</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line72">line 72</a>
     </li></ul></dd>
     
 
@@ -1464,6 +1492,13 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
 
 
+    <h5 class="h5-examples">Example</h5>
+    
+    <pre class="prettyprint"><code>fetchArtists('drumeo')
+  .then(artists => console.log(artists))
+  .catch(error => console.error(error));</code></pre>
+
+
 
 
     <h5 class="h5-parameters">Parameters:</h5>
@@ -1534,7 +1569,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
         
 <div class="param-desc">
-    - The fetched artist data or null if not found.
+    - A promise that resolves to an array of artist objects or null if not found.
 </div>
 
 
@@ -1577,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#line414">line 414</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line463">line 463</a>
     </li></ul></dd>
     
 
@@ -1622,6 +1657,13 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
 
 
+    <h5 class="h5-examples">Example</h5>
+    
+    <pre class="prettyprint"><code>fetchByRailContentId('abc123')
+  .then(content => console.log(content))
+  .catch(error => console.error(error));</code></pre>
+
+
 
 
     <h5 class="h5-parameters">Parameters:</h5>
@@ -1692,7 +1734,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
         
 <div class="param-desc">
-    - The fetched content data or null if not found.
+    - A promise that resolves to the content object or null if not found.
 </div>
 
 
@@ -1735,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#line434">line 434</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line489">line 489</a>
     </li></ul></dd>
     
 
@@ -1780,6 +1822,13 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
 
 
+    <h5 class="h5-examples">Example</h5>
+    
+    <pre class="prettyprint"><code>fetchByRailContentIds(['abc123', 'def456', 'ghi789'])
+  .then(contents => console.log(contents))
+  .catch(error => console.error(error));</code></pre>
+
+
 
 
     <h5 class="h5-parameters">Parameters:</h5>
@@ -1850,7 +1899,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
         
 <div class="param-desc">
-    - The fetched content data or null if not found.
+    - A promise that resolves to an array of content objects or null if not found.
 </div>
 
 
@@ -1893,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#line649">line 649</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line716">line 716</a>
     </li></ul></dd>
     
 
@@ -2051,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#line722">line 722</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line794">line 794</a>
     </li></ul></dd>
     
 
@@ -2096,6 +2145,13 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
 
 
+    <h5 class="h5-examples">Example</h5>
+    
+    <pre class="prettyprint"><code>fetchLessonContent('lesson123')
+  .then(data => console.log(data))
+  .catch(error => console.error(error));</code></pre>
+
+
 
 
     <h5 class="h5-parameters">Parameters:</h5>
@@ -2209,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#line691">line 691</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line758">line 758</a>
     </li></ul></dd>
     
 
@@ -2367,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#line670">line 670</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line737">line 737</a>
     </li></ul></dd>
     
 
@@ -2525,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#line356">line 356</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line393">line 393</a>
     </li></ul></dd>
     
 
@@ -2683,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#line701">line 701</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line768">line 768</a>
     </li></ul></dd>
     
 
@@ -2841,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#line776">line 776</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line848">line 848</a>
     </li></ul></dd>
     
 
@@ -2999,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#line797">line 797</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line874">line 874</a>
     </li></ul></dd>
     
 
@@ -3044,6 +3100,13 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
 
 
+    <h5 class="h5-examples">Example</h5>
+    
+    <pre class="prettyprint"><code>fetchPackChildren('pack123')
+  .then(children => console.log(children))
+  .catch(error => console.error(error));</code></pre>
+
+
 
 
     <h5 class="h5-parameters">Parameters:</h5>
@@ -3157,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#line755">line 755</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line827">line 827</a>
     </li></ul></dd>
     
 
@@ -3339,7 +3402,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#line84">line 84</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line103">line 103</a>
     </li></ul></dd>
     
 
@@ -3384,6 +3447,13 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
 
 
+    <h5 class="h5-examples">Example</h5>
+    
+    <pre class="prettyprint"><code>fetchRelatedSongs('drumeo', '12345')
+  .then(relatedSongs => console.log(relatedSongs))
+  .catch(error => console.error(error));</code></pre>
+
+
 
 
     <h5 class="h5-parameters">Parameters:</h5>
@@ -3478,7 +3548,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
         
 <div class="param-desc">
-    - The fetched related songs data or null if not found.
+    - A promise that resolves to an array of related song objects or null if not found.
 </div>
 
 
@@ -3521,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#line807">line 807</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line891">line 891</a>
     </li></ul></dd>
     
 
@@ -3566,6 +3636,14 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
 
 
+    <h5 class="h5-examples">Example</h5>
+    
+    <pre class="prettyprint"><code>const query = `*[_type == "song"]{title, artist->name}`;
+fetchSanity(query, true)
+  .then(data => console.log(data))
+  .catch(error => console.error(error));</code></pre>
+
+
 
 
     <h5 class="h5-parameters">Parameters:</h5>
@@ -3634,7 +3712,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
             
 
-            <td class="description last">Whether to return an array or single result</td>
+            <td class="description last">Whether to return an array or a single result.</td>
         </tr>
 
     
@@ -3660,7 +3738,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
         
 <div class="param-desc">
-    - The first result from the query, or null if an error occurs or no results are found.
+    - A promise that resolves to the fetched data or null if an error occurs or no results are found.
 </div>
 
 
@@ -3703,7 +3781,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#line73">line 73</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line86">line 86</a>
     </li></ul></dd>
     
 
@@ -3861,7 +3939,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#line34">line 34</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line41">line 41</a>
     </li></ul></dd>
     
 
@@ -3906,6 +3984,13 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
 
 
+    <h5 class="h5-examples">Example</h5>
+    
+    <pre class="prettyprint"><code>fetchSongById('abc123')
+  .then(song => console.log(song))
+  .catch(error => console.error(error));</code></pre>
+
+
 
 
     <h5 class="h5-parameters">Parameters:</h5>
@@ -3976,7 +4061,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
         
 <div class="param-desc">
-    - The fetched song data or null if not found.
+    - A promise that resolves to an object containing the song data or null if not found.
 </div>
 
 
@@ -4019,7 +4104,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#line326">line 326</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line363">line 363</a>
     </li></ul></dd>
     
 
@@ -4177,7 +4262,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#line297">line 297</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line334">line 334</a>
     </li></ul></dd>
     
 
@@ -4222,6 +4307,13 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
 
 
+    <h5 class="h5-examples">Example</h5>
+    
+    <pre class="prettyprint"><code>fetchSongFilterOptions('drumeo')
+  .then(options => console.log(options))
+  .catch(error => console.error(error));</code></pre>
+
+
 
 
     <h5 class="h5-parameters">Parameters:</h5>
@@ -4292,7 +4384,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
         
 <div class="param-desc">
-    - The fetched filter options or null if not found.
+    - A promise that resolves to an object containing filter options or null if not found.
 </div>
 
 
@@ -4335,7 +4427,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#line384">line 384</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line427">line 427</a>
     </li></ul></dd>
     
 
@@ -4380,6 +4472,13 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
 
 
+    <h5 class="h5-examples">Example</h5>
+    
+    <pre class="prettyprint"><code>fetchUpcomingEvents('drumeo')
+  .then(events => console.log(events))
+  .catch(error => console.error(error));</code></pre>
+
+
 
 
     <h5 class="h5-parameters">Parameters:</h5>
@@ -4450,7 +4549,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
 
         
 <div class="param-desc">
-    - The fetched upcoming events data or null if not found.
+    - A promise that resolves to an array of upcoming event objects or null if not found.
 </div>
 
 
@@ -4493,7 +4592,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#line336">line 336</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line373">line 373</a>
     </li></ul></dd>
     
 
@@ -4652,7 +4751,7 @@ This function must be called before using any other functions in this library.</
     
     <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#line25">line 25</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line26">line 26</a>
     </li></ul></dd>
     
 
@@ -4705,7 +4804,7 @@ initializeSanityService({
   projectId: 'your-sanity-project-id',
   dataset: 'your-dataset-name',
   version: '2021-06-07',
-  debug: true // Optional: Enable debug mode
+  debug: true, // Optional: Enable debug mode
   useCachedAPI: true // Optional: Use cached API
 });</code></pre>
 
@@ -5001,7 +5100,7 @@ initializeSanityService({
                 </td>
             
 
-            <td class="description last">Optional flag to disable cached API. *</td>
+            <td class="description last">Optional flag to disable cached API.</td>
         </tr>
 
     
@@ -5053,7 +5152,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 14:00:38 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 Mon Aug 12 2024 15:31:44 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 14:00:38 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 Mon Aug 12 2024 15:31:44 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

@@ -57,7 +57,8 @@
  * @param {string} config.dataset - The dataset name in Sanity.
  * @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. *
+ * @param {boolean} [config.useCachedAPI=true] - Optional flag to disable cached API.
+ * 
  * @example
  * // Initialize the Sanity service in your app.js
  * initializeSanityService({
@@ -65,7 +66,7 @@
  *   projectId: 'your-sanity-project-id',
  *   dataset: 'your-dataset-name',
  *   version: '2021-06-07',
- *   debug: true // Optional: Enable debug mode
+ *   debug: true, // Optional: Enable debug mode
  *   useCachedAPI: true // Optional: Use cached API
  * });
  */
@@ -75,8 +76,14 @@ function initializeSanityService(config) {
 
 /**
  * Fetch a song by its document ID from Sanity.
+ *
  * @param {string} documentId - The ID of the document to fetch.
- * @returns {Promise<Object|null>} - The fetched song data or null if not found.
+ * @returns {Promise<Object|null>} - A promise that resolves to an object containing the song data or null if not found.
+ *
+ * @example
+ * fetchSongById('abc123')
+ *   .then(song => console.log(song))
+ *   .catch(error => console.error(error));
  */
 async function fetchSongById(documentId) {
     const fields = [
@@ -100,8 +107,14 @@ async function fetchSongById(documentId) {
 
 /**
  * Fetch all artists with lessons available for a specific brand.
+ *
  * @param {string} brand - The brand for which to fetch artists.
- * @returns {Promise<Object|null>} - The fetched artist data or null if not found.
+ * @returns {Promise<Object|null>} - A promise that resolves to an array of artist objects or null if not found.
+ *
+ * @example
+ * fetchArtists('drumeo')
+ *   .then(artists => console.log(artists))
+ *   .catch(error => console.error(error));
  */
 async function fetchArtists(brand) {
     const query = `
@@ -124,9 +137,15 @@ async function fetchSongArtistCount(brand) {
 
 /**
  * Fetch related songs for a specific brand and song ID.
+ *
  * @param {string} brand - The brand for which to fetch related songs.
  * @param {string} songId - The ID of the song to find related songs for.
- * @returns {Promise<Object|null>} - The fetched related songs data or null if not found.
+ * @returns {Promise<Object|null>} - A promise that resolves to an array of related song objects or null if not found.
+ *
+ * @example
+ * fetchRelatedSongs('drumeo', '12345')
+ *   .then(relatedSongs => console.log(relatedSongs))
+ *   .catch(error => console.error(error));
  */
 async function fetchRelatedSongs(brand, songId) {
     const query = `
@@ -207,6 +226,18 @@ 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,
+ *   limit: 20,
+ *   searchTerm: 'rock',
+ *   sort: 'published_on',
+ *   includedFields: ['difficulty', 'style'],
+ *   groupBy: 'artist'
+ * })
+ *   .then(result => console.log(result))
+ *   .catch(error => console.error(error));
  */
 async function fetchAllSongs(brand, {
     page = 1,
@@ -338,8 +369,14 @@ async function fetchAllSongs(brand, {
 
 /**
  * Fetch filter options for a specific brand.
+ *
  * @param {string} brand - The brand for which to fetch filter options.
- * @returns {Promise<Object|null>} - The fetched filter options or null if not found.
+ * @returns {Promise<Object|null>} - A promise that resolves to an object containing filter options or null if not found.
+ *
+ * @example
+ * fetchSongFilterOptions('drumeo')
+ *   .then(options => console.log(options))
+ *   .catch(error => console.error(error));
  */
 async function fetchSongFilterOptions(brand) {
     const query = `
@@ -425,8 +462,14 @@ async function fetchNewReleases(brand) {
 
 /**
  * Fetch upcoming events for a specific brand.
+ *
  * @param {string} brand - The brand for which to fetch upcoming events.
- * @returns {Promise<Object|null>} - The fetched upcoming events data or null if not found.
+ * @returns {Promise<Object|null>} - A promise that resolves to an array of upcoming event objects or null if not found.
+ *
+ * @example
+ * fetchUpcomingEvents('drumeo')
+ *   .then(events => console.log(events))
+ *   .catch(error => console.error(error));
  */
 async function fetchUpcomingEvents(brand) {
     const liveTypes = {
@@ -455,8 +498,14 @@ async function fetchUpcomingEvents(brand) {
 
 /**
  * Fetch content by a specific Railcontent ID.
+ *
  * @param {string} id - The Railcontent ID of the content to fetch.
- * @returns {Promise<Object|null>} - The fetched content data or null if not found.
+ * @returns {Promise<Object|null>} - A promise that resolves to the content object or null if not found.
+ *
+ * @example
+ * fetchByRailContentId('abc123')
+ *   .then(content => console.log(content))
+ *   .catch(error => console.error(error));
  */
 async function fetchByRailContentId(id) {
     const query = `*[railcontent_id == ${id}]{
@@ -475,8 +524,14 @@ async function fetchByRailContentId(id) {
 
 /**
  * Fetch content by an array of Railcontent IDs.
+ *
  * @param {Array<string>} ids - The array of Railcontent IDs of the content to fetch.
- * @returns {Promise<Array<Object>|null>} - The fetched content data or null if not found.
+ * @returns {Promise<Array<Object>|null>} - A promise that resolves to an array of content objects or null if not found.
+ *
+ * @example
+ * fetchByRailContentIds(['abc123', 'def456', 'ghi789'])
+ *   .then(contents => console.log(contents))
+ *   .catch(error => console.error(error));
  */
 async function fetchByRailContentIds(ids) {
     const idsString = ids.join(',');
@@ -506,6 +561,18 @@ 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,
+ *   limit: 20,
+ *   searchTerm: 'jazz',
+ *   sort: '-popularity',
+ *   includedFields: ['difficulty,Intermediate'],
+ *   groupBy: 'artist'
+ * })
+ *   .then(content => console.log(content))
+ *   .catch(error => console.error(error));
  */
 async function fetchAll(brand, type, {
     page = 1,
@@ -765,6 +832,11 @@ 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))
+ *   .catch(error => console.error(error));
  */
 async function fetchLessonContent(railContentId) {
     const query = `*[railcontent_id == ${railContentId} ]
@@ -840,6 +912,11 @@ 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))
+ *   .catch(error => console.error(error));
  */
 async function fetchPackChildren(railcontentId) {
     return fetchChildren(railcontentId, 'pack');
@@ -847,43 +924,50 @@ async function fetchPackChildren(railcontentId) {
 
 /**
  * Fetch data from the Sanity API based on a provided query.
+ *
  * @param {string} query - The GROQ query to execute against the Sanity API.
- * @param {boolean} isList - Whether to return an array or single result
- * @returns {Promise<Object|null>} - The first result from the query, or null if an error occurs or no results are found.
+ * @param {boolean} isList - Whether to return an array or a single result.
+ * @returns {Promise<Object|null>} - A promise that resolves to the fetched data or null if an error occurs or no results are found.
+ *
+ * @example
+ * const query = `*[_type == "song"]{title, artist->name}`;
+ * fetchSanity(query, true)
+ *   .then(data => console.log(data))
+ *   .catch(error => console.error(error));
  */
 async function fetchSanity(query, isList) {
-    // Check the config object before proceeding
-    if (!checkConfig(globalConfig)) {
-        return null;
-    }
-
-    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'
-    };
-
-    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;
-    }
+  // Check the config object before proceeding
+  if (!checkConfig(globalConfig)) {
+      return null;
+  }
+
+  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'
+  };
+
+  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;
+  }
 }
 
 
@@ -958,7 +1042,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 14:00:38 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 Mon Aug 12 2024 15:31:44 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.10",
+  "version": "1.0.11",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "scripts": {

package/src/index.js

@@ -10,7 +10,8 @@ let globalConfig = {};
  * @param {string} config.dataset - The dataset name in Sanity.
  * @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. *
+ * @param {boolean} [config.useCachedAPI=true] - Optional flag to disable cached API.
+ * 
  * @example
  * // Initialize the Sanity service in your app.js
  * initializeSanityService({
@@ -18,7 +19,7 @@ let globalConfig = {};
  *   projectId: 'your-sanity-project-id',
  *   dataset: 'your-dataset-name',
  *   version: '2021-06-07',
- *   debug: true // Optional: Enable debug mode
+ *   debug: true, // Optional: Enable debug mode
  *   useCachedAPI: true // Optional: Use cached API
  * });
  */
@@ -28,8 +29,14 @@ function initializeSanityService(config) {
 
 /**
  * Fetch a song by its document ID from Sanity.
+ *
  * @param {string} documentId - The ID of the document to fetch.
- * @returns {Promise<Object|null>} - The fetched song data or null if not found.
+ * @returns {Promise<Object|null>} - A promise that resolves to an object containing the song data or null if not found.
+ *
+ * @example
+ * fetchSongById('abc123')
+ *   .then(song => console.log(song))
+ *   .catch(error => console.error(error));
  */
 async function fetchSongById(documentId) {
     const fields = [
@@ -53,8 +60,14 @@ async function fetchSongById(documentId) {
 
 /**
  * Fetch all artists with lessons available for a specific brand.
+ *
  * @param {string} brand - The brand for which to fetch artists.
- * @returns {Promise<Object|null>} - The fetched artist data or null if not found.
+ * @returns {Promise<Object|null>} - A promise that resolves to an array of artist objects or null if not found.
+ *
+ * @example
+ * fetchArtists('drumeo')
+ *   .then(artists => console.log(artists))
+ *   .catch(error => console.error(error));
  */
 async function fetchArtists(brand) {
     const query = `
@@ -77,9 +90,15 @@ async function fetchSongArtistCount(brand) {
 
 /**
  * Fetch related songs for a specific brand and song ID.
+ *
  * @param {string} brand - The brand for which to fetch related songs.
  * @param {string} songId - The ID of the song to find related songs for.
- * @returns {Promise<Object|null>} - The fetched related songs data or null if not found.
+ * @returns {Promise<Object|null>} - A promise that resolves to an array of related song objects or null if not found.
+ *
+ * @example
+ * fetchRelatedSongs('drumeo', '12345')
+ *   .then(relatedSongs => console.log(relatedSongs))
+ *   .catch(error => console.error(error));
  */
 async function fetchRelatedSongs(brand, songId) {
     const query = `
@@ -160,6 +179,18 @@ 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,
+ *   limit: 20,
+ *   searchTerm: 'rock',
+ *   sort: 'published_on',
+ *   includedFields: ['difficulty', 'style'],
+ *   groupBy: 'artist'
+ * })
+ *   .then(result => console.log(result))
+ *   .catch(error => console.error(error));
  */
 async function fetchAllSongs(brand, {
     page = 1,
@@ -291,8 +322,14 @@ async function fetchAllSongs(brand, {
 
 /**
  * Fetch filter options for a specific brand.
+ *
  * @param {string} brand - The brand for which to fetch filter options.
- * @returns {Promise<Object|null>} - The fetched filter options or null if not found.
+ * @returns {Promise<Object|null>} - A promise that resolves to an object containing filter options or null if not found.
+ *
+ * @example
+ * fetchSongFilterOptions('drumeo')
+ *   .then(options => console.log(options))
+ *   .catch(error => console.error(error));
  */
 async function fetchSongFilterOptions(brand) {
     const query = `
@@ -378,8 +415,14 @@ async function fetchNewReleases(brand) {
 
 /**
  * Fetch upcoming events for a specific brand.
+ *
  * @param {string} brand - The brand for which to fetch upcoming events.
- * @returns {Promise<Object|null>} - The fetched upcoming events data or null if not found.
+ * @returns {Promise<Object|null>} - A promise that resolves to an array of upcoming event objects or null if not found.
+ *
+ * @example
+ * fetchUpcomingEvents('drumeo')
+ *   .then(events => console.log(events))
+ *   .catch(error => console.error(error));
  */
 async function fetchUpcomingEvents(brand) {
     const liveTypes = {
@@ -408,8 +451,14 @@ async function fetchUpcomingEvents(brand) {
 
 /**
  * Fetch content by a specific Railcontent ID.
+ *
  * @param {string} id - The Railcontent ID of the content to fetch.
- * @returns {Promise<Object|null>} - The fetched content data or null if not found.
+ * @returns {Promise<Object|null>} - A promise that resolves to the content object or null if not found.
+ *
+ * @example
+ * fetchByRailContentId('abc123')
+ *   .then(content => console.log(content))
+ *   .catch(error => console.error(error));
  */
 async function fetchByRailContentId(id) {
     const query = `*[railcontent_id == ${id}]{
@@ -428,8 +477,14 @@ async function fetchByRailContentId(id) {
 
 /**
  * Fetch content by an array of Railcontent IDs.
+ *
  * @param {Array<string>} ids - The array of Railcontent IDs of the content to fetch.
- * @returns {Promise<Array<Object>|null>} - The fetched content data or null if not found.
+ * @returns {Promise<Array<Object>|null>} - A promise that resolves to an array of content objects or null if not found.
+ *
+ * @example
+ * fetchByRailContentIds(['abc123', 'def456', 'ghi789'])
+ *   .then(contents => console.log(contents))
+ *   .catch(error => console.error(error));
  */
 async function fetchByRailContentIds(ids) {
     const idsString = ids.join(',');
@@ -459,6 +514,18 @@ 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,
+ *   limit: 20,
+ *   searchTerm: 'jazz',
+ *   sort: '-popularity',
+ *   includedFields: ['difficulty,Intermediate'],
+ *   groupBy: 'artist'
+ * })
+ *   .then(content => console.log(content))
+ *   .catch(error => console.error(error));
  */
 async function fetchAll(brand, type, {
     page = 1,
@@ -718,6 +785,11 @@ 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))
+ *   .catch(error => console.error(error));
  */
 async function fetchLessonContent(railContentId) {
     const query = `*[railcontent_id == ${railContentId} ]
@@ -793,6 +865,11 @@ 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))
+ *   .catch(error => console.error(error));
  */
 async function fetchPackChildren(railcontentId) {
     return fetchChildren(railcontentId, 'pack');
@@ -800,43 +877,50 @@ async function fetchPackChildren(railcontentId) {
 
 /**
  * Fetch data from the Sanity API based on a provided query.
+ *
  * @param {string} query - The GROQ query to execute against the Sanity API.
- * @param {boolean} isList - Whether to return an array or single result
- * @returns {Promise<Object|null>} - The first result from the query, or null if an error occurs or no results are found.
+ * @param {boolean} isList - Whether to return an array or a single result.
+ * @returns {Promise<Object|null>} - A promise that resolves to the fetched data or null if an error occurs or no results are found.
+ *
+ * @example
+ * const query = `*[_type == "song"]{title, artist->name}`;
+ * fetchSanity(query, true)
+ *   .then(data => console.log(data))
+ *   .catch(error => console.error(error));
  */
 async function fetchSanity(query, isList) {
-    // Check the config object before proceeding
-    if (!checkConfig(globalConfig)) {
-        return null;
-    }
-
-    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'
-    };
-
-    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;
-    }
+  // Check the config object before proceeding
+  if (!checkConfig(globalConfig)) {
+      return null;
+  }
+
+  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'
+  };
+
+  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;
+  }
 }