musora-content-services 1.0.90 → 1.0.91

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/CHANGELOG.md +2 -0
  2. package/docs/config.js.html +6 -3
  3. package/docs/index.html +2 -2
  4. package/docs/module-Config.html +29 -4
  5. package/docs/module-Railcontent-Services.html +410 -5
  6. package/docs/module-Sanity-Services.html +182 -41
  7. package/docs/railcontent.js.html +63 -13
  8. package/docs/sanity.js.html +54 -32
  9. package/package.json +1 -1
  10. package/src/services/railcontent.js +40 -1
package/docs/module-Railcontent-Services.html CHANGED
@@ -29,7 +29,7 @@
29
29
  <nav >
30
30
 
31
31
 
32
- <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>
32
+ <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>
33
33
 
34
34
  </nav>
35
35
 
@@ -249,6 +249,303 @@
249
249
 
250
250
 
251
251
 
252
+ <h4 class="name" id=".fetchCompletedContent"><span class="type-signature type-signature-static">(static) </span>fetchCompletedContent<span class="signature">(type, brand, limit<span class="signature-attributes">opt</span>, page<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
253
+
254
+
255
+
256
+
257
+
258
+
259
+ <dl class="details">
260
+
261
+ <dt class="tag-description">Description:</dt>
262
+ <dd class="tag-description"><ul class="dummy"><li>Fetches a list of content that has been completed for the current user.</li></ul></dd>
263
+
264
+
265
+
266
+ <dt class="tag-source">Source:</dt>
267
+ <dd class="tag-source"><ul class="dummy"><li>
268
+ <a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line192">line 192</a>
269
+ </li></ul></dd>
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+ </dl>
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+ <h5 class="h5-examples">Example</h5>
314
+
315
+ <pre class="prettyprint"><code>fetchCompletedContent('song', 'drumeo')
316
+ .then(songs => console.log(songs))
317
+ .catch(error => console.error(error));</code></pre>
318
+
319
+
320
+
321
+
322
+ <h5 class="h5-parameters">Parameters:</h5>
323
+
324
+
325
+ <table class="params">
326
+ <thead>
327
+ <tr>
328
+
329
+ <th>Name</th>
330
+
331
+
332
+ <th>Type</th>
333
+
334
+
335
+ <th>Attributes</th>
336
+
337
+
338
+
339
+ <th>Default</th>
340
+
341
+
342
+ <th class="last">Description</th>
343
+ </tr>
344
+ </thead>
345
+
346
+ <tbody>
347
+
348
+
349
+ <tr>
350
+
351
+ <td class="name"><code>type</code></td>
352
+
353
+
354
+ <td class="type">
355
+
356
+
357
+ <span class="param-type">string</span>
358
+
359
+
360
+
361
+
362
+ </td>
363
+
364
+
365
+ <td class="attributes">
366
+
367
+
368
+
369
+
370
+
371
+ </td>
372
+
373
+
374
+
375
+ <td class="default">
376
+
377
+ </td>
378
+
379
+
380
+ <td class="description last">The content type associated with the content.</td>
381
+ </tr>
382
+
383
+
384
+
385
+ <tr>
386
+
387
+ <td class="name"><code>brand</code></td>
388
+
389
+
390
+ <td class="type">
391
+
392
+
393
+ <span class="param-type">string</span>
394
+
395
+
396
+
397
+
398
+ </td>
399
+
400
+
401
+ <td class="attributes">
402
+
403
+
404
+
405
+
406
+
407
+ </td>
408
+
409
+
410
+
411
+ <td class="default">
412
+
413
+ </td>
414
+
415
+
416
+ <td class="description last">The brand associated with the content.</td>
417
+ </tr>
418
+
419
+
420
+
421
+ <tr>
422
+
423
+ <td class="name"><code>limit</code></td>
424
+
425
+
426
+ <td class="type">
427
+
428
+
429
+ <span class="param-type">number</span>
430
+
431
+
432
+
433
+
434
+ </td>
435
+
436
+
437
+ <td class="attributes">
438
+
439
+ &lt;optional><br>
440
+
441
+
442
+
443
+
444
+
445
+ </td>
446
+
447
+
448
+
449
+ <td class="default">
450
+
451
+ <code>20</code>
452
+
453
+ </td>
454
+
455
+
456
+ <td class="description last">The limit of results per page.</td>
457
+ </tr>
458
+
459
+
460
+
461
+ <tr>
462
+
463
+ <td class="name"><code>page</code></td>
464
+
465
+
466
+ <td class="type">
467
+
468
+
469
+ <span class="param-type">number</span>
470
+
471
+
472
+
473
+
474
+ </td>
475
+
476
+
477
+ <td class="attributes">
478
+
479
+ &lt;optional><br>
480
+
481
+
482
+
483
+
484
+
485
+ </td>
486
+
487
+
488
+
489
+ <td class="default">
490
+
491
+ <code>1</code>
492
+
493
+ </td>
494
+
495
+
496
+ <td class="description last">The page number for pagination.</td>
497
+ </tr>
498
+
499
+
500
+ </tbody>
501
+ </table>
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+ <h5 class="h5-returns">Returns:</h5>
519
+
520
+
521
+ <div class="param-desc">
522
+ - Returns an object containing in-progress content if found, otherwise null.
523
+ </div>
524
+
525
+
526
+
527
+ <dl class="param-type">
528
+ <dt>
529
+ Type
530
+ </dt>
531
+ <dd>
532
+
533
+ <span class="param-type">Promise.&lt;(Object|null)></span>
534
+
535
+
536
+
537
+ </dd>
538
+ </dl>
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+
252
549
  <h4 class="name" id=".fetchCompletedState"><span class="type-signature type-signature-static">(static) </span>fetchCompletedState<span class="signature">(content_id)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
253
550
 
254
551
 
@@ -414,7 +711,7 @@
414
711
 
415
712
 
416
713
 
417
- <h4 class="name" id=".fetchContentInProgress"><span class="type-signature type-signature-static">(static) </span>fetchContentInProgress<span class="signature">(type, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
714
+ <h4 class="name" id=".fetchContentInProgress"><span class="type-signature type-signature-static">(static) </span>fetchContentInProgress<span class="signature">(type, brand, limit<span class="signature-attributes">opt</span>, page<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
418
715
 
419
716
 
420
717
 
@@ -430,7 +727,7 @@
430
727
 
431
728
  <dt class="tag-source">Source:</dt>
432
729
  <dd class="tag-source"><ul class="dummy"><li>
433
- <a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line151">line 151</a>
730
+ <a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line153">line 153</a>
434
731
  </li></ul></dd>
435
732
 
436
733
 
@@ -497,8 +794,12 @@
497
794
  <th>Type</th>
498
795
 
499
796
 
797
+ <th>Attributes</th>
798
+
500
799
 
501
800
 
801
+ <th>Default</th>
802
+
502
803
 
503
804
  <th class="last">Description</th>
504
805
  </tr>
@@ -523,8 +824,20 @@
523
824
  </td>
524
825
 
525
826
 
827
+ <td class="attributes">
828
+
829
+
830
+
831
+
832
+
833
+ </td>
834
+
526
835
 
527
836
 
837
+ <td class="default">
838
+
839
+ </td>
840
+
528
841
 
529
842
  <td class="description last">The content type associated with the content.</td>
530
843
  </tr>
@@ -547,13 +860,105 @@
547
860
  </td>
548
861
 
549
862
 
863
+ <td class="attributes">
864
+
550
865
 
866
+
867
+
868
+
869
+ </td>
870
+
871
+
872
+
873
+ <td class="default">
874
+
875
+ </td>
551
876
 
552
877
 
553
878
  <td class="description last">The brand associated with the content.</td>
554
879
  </tr>
555
880
 
556
881
 
882
+
883
+ <tr>
884
+
885
+ <td class="name"><code>limit</code></td>
886
+
887
+
888
+ <td class="type">
889
+
890
+
891
+ <span class="param-type">number</span>
892
+
893
+
894
+
895
+
896
+ </td>
897
+
898
+
899
+ <td class="attributes">
900
+
901
+ &lt;optional><br>
902
+
903
+
904
+
905
+
906
+
907
+ </td>
908
+
909
+
910
+
911
+ <td class="default">
912
+
913
+ <code>20</code>
914
+
915
+ </td>
916
+
917
+
918
+ <td class="description last">The limit of results per page.</td>
919
+ </tr>
920
+
921
+
922
+
923
+ <tr>
924
+
925
+ <td class="name"><code>page</code></td>
926
+
927
+
928
+ <td class="type">
929
+
930
+
931
+ <span class="param-type">number</span>
932
+
933
+
934
+
935
+
936
+ </td>
937
+
938
+
939
+ <td class="attributes">
940
+
941
+ &lt;optional><br>
942
+
943
+
944
+
945
+
946
+
947
+ </td>
948
+
949
+
950
+
951
+ <td class="default">
952
+
953
+ <code>1</code>
954
+
955
+ </td>
956
+
957
+
958
+ <td class="description last">The page number for pagination.</td>
959
+ </tr>
960
+
961
+
557
962
  </tbody>
558
963
  </table>
559
964
 
@@ -619,7 +1024,7 @@
619
1024
 
620
1025
  <dt class="tag-source">Source:</dt>
621
1026
  <dd class="tag-source"><ul class="dummy"><li>
622
- <a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line188">line 188</a>
1027
+ <a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line229">line 229</a>
623
1028
  </li></ul></dd>
624
1029
 
625
1030
 
@@ -1113,7 +1518,7 @@
1113
1518
  <br class="clear">
1114
1519
 
1115
1520
  <footer>
1116
- 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.
1521
+ 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.
1117
1522
  </footer>
1118
1523
 
1119
1524
  <script>prettyPrint();</script>