musora-content-services 1.0.60 → 1.0.62
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.
- package/CHANGELOG.md +4 -0
- package/docs/config.js.html +2 -2
- package/docs/index.html +2 -2
- package/docs/module-Config.html +2 -2
- package/docs/module-Railcontent-Services.html +2 -2
- package/docs/module-Sanity-Services.html +559 -31
- package/docs/railcontent.js.html +2 -2
- package/docs/sanity.js.html +154 -146
- package/package.json +1 -1
- package/src/contentTypeConfig.js +71 -4
- package/src/index.d.ts +2 -2
- package/src/index.js +9 -3
- package/src/services/sanity.js +152 -144
- package/test/sanityQueryService.test.js +61 -12
|
@@ -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#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCurrentSongComplete">fetchCurrentSongComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</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#.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#.fetchChildren">fetchChildren</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#.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#.
|
|
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#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCurrentSongComplete">fetchCurrentSongComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</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#.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#.fetchChildren">fetchChildren</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#.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#.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
|
|
|
@@ -100,7 +100,7 @@
|
|
|
100
100
|
|
|
101
101
|
<dt class="tag-source">Source:</dt>
|
|
102
102
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
103
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
103
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line384">line 384</a>
|
|
104
104
|
</li></ul></dd>
|
|
105
105
|
|
|
106
106
|
|
|
@@ -593,7 +593,7 @@ The filter options are dynamically generated based on the provided filters, styl
|
|
|
593
593
|
|
|
594
594
|
<dt class="tag-source">Source:</dt>
|
|
595
595
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
596
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
596
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line517">line 517</a>
|
|
597
597
|
</li></ul></dd>
|
|
598
598
|
|
|
599
599
|
|
|
@@ -935,7 +935,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
935
935
|
|
|
936
936
|
<dt class="tag-source">Source:</dt>
|
|
937
937
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
938
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
938
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line165">line 165</a>
|
|
939
939
|
</li></ul></dd>
|
|
940
940
|
|
|
941
941
|
|
|
@@ -1401,7 +1401,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1401
1401
|
|
|
1402
1402
|
<dt class="tag-source">Source:</dt>
|
|
1403
1403
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1404
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
1404
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line41">line 41</a>
|
|
1405
1405
|
</li></ul></dd>
|
|
1406
1406
|
|
|
1407
1407
|
|
|
@@ -1566,7 +1566,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1566
1566
|
|
|
1567
1567
|
<dt class="tag-source">Source:</dt>
|
|
1568
1568
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1569
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
1569
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line332">line 332</a>
|
|
1570
1570
|
</li></ul></dd>
|
|
1571
1571
|
|
|
1572
1572
|
|
|
@@ -1731,7 +1731,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1731
1731
|
|
|
1732
1732
|
<dt class="tag-source">Source:</dt>
|
|
1733
1733
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1734
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
1734
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line351">line 351</a>
|
|
1735
1735
|
</li></ul></dd>
|
|
1736
1736
|
|
|
1737
1737
|
|
|
@@ -1924,6 +1924,172 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1924
1924
|
|
|
1925
1925
|
|
|
1926
1926
|
|
|
1927
|
+
<h4 class="name" id=".fetchCatalogMetadata"><span class="type-signature type-signature-static">(static) </span>fetchCatalogMetadata<span class="signature">(contentType)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
1928
|
+
|
|
1929
|
+
|
|
1930
|
+
|
|
1931
|
+
|
|
1932
|
+
|
|
1933
|
+
|
|
1934
|
+
<dl class="details">
|
|
1935
|
+
|
|
1936
|
+
<dt class="tag-description">Description:</dt>
|
|
1937
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch CatalogueMetadata from Sanity. This information may be duplicated in the contentTypeConfig.js.
|
|
1938
|
+
It's an ongoing discussion (Aug 2024), but it's been included here if necessary</li></ul></dd>
|
|
1939
|
+
|
|
1940
|
+
|
|
1941
|
+
|
|
1942
|
+
<dt class="tag-source">Source:</dt>
|
|
1943
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
1944
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line921">line 921</a>
|
|
1945
|
+
</li></ul></dd>
|
|
1946
|
+
|
|
1947
|
+
|
|
1948
|
+
|
|
1949
|
+
|
|
1950
|
+
|
|
1951
|
+
|
|
1952
|
+
|
|
1953
|
+
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
|
|
1958
|
+
|
|
1959
|
+
|
|
1960
|
+
|
|
1961
|
+
|
|
1962
|
+
|
|
1963
|
+
|
|
1964
|
+
|
|
1965
|
+
|
|
1966
|
+
|
|
1967
|
+
|
|
1968
|
+
|
|
1969
|
+
|
|
1970
|
+
|
|
1971
|
+
|
|
1972
|
+
|
|
1973
|
+
|
|
1974
|
+
|
|
1975
|
+
|
|
1976
|
+
|
|
1977
|
+
</dl>
|
|
1978
|
+
|
|
1979
|
+
|
|
1980
|
+
|
|
1981
|
+
|
|
1982
|
+
|
|
1983
|
+
|
|
1984
|
+
|
|
1985
|
+
|
|
1986
|
+
|
|
1987
|
+
|
|
1988
|
+
|
|
1989
|
+
<h5 class="h5-examples">Example</h5>
|
|
1990
|
+
|
|
1991
|
+
<pre class="prettyprint"><code>fetchCatalogMetadata('song')
|
|
1992
|
+
.then(data => console.log(data))
|
|
1993
|
+
.catch(error => console.error(error));</code></pre>
|
|
1994
|
+
|
|
1995
|
+
|
|
1996
|
+
|
|
1997
|
+
|
|
1998
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
1999
|
+
|
|
2000
|
+
|
|
2001
|
+
<table class="params">
|
|
2002
|
+
<thead>
|
|
2003
|
+
<tr>
|
|
2004
|
+
|
|
2005
|
+
<th>Name</th>
|
|
2006
|
+
|
|
2007
|
+
|
|
2008
|
+
<th>Type</th>
|
|
2009
|
+
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
|
|
2013
|
+
|
|
2014
|
+
<th class="last">Description</th>
|
|
2015
|
+
</tr>
|
|
2016
|
+
</thead>
|
|
2017
|
+
|
|
2018
|
+
<tbody>
|
|
2019
|
+
|
|
2020
|
+
|
|
2021
|
+
<tr>
|
|
2022
|
+
|
|
2023
|
+
<td class="name"><code>contentType</code></td>
|
|
2024
|
+
|
|
2025
|
+
|
|
2026
|
+
<td class="type">
|
|
2027
|
+
|
|
2028
|
+
|
|
2029
|
+
<span class="param-type">string</span>
|
|
2030
|
+
|
|
2031
|
+
|
|
2032
|
+
|
|
2033
|
+
|
|
2034
|
+
</td>
|
|
2035
|
+
|
|
2036
|
+
|
|
2037
|
+
|
|
2038
|
+
|
|
2039
|
+
|
|
2040
|
+
<td class="description last">name of the contentype to pull</td>
|
|
2041
|
+
</tr>
|
|
2042
|
+
|
|
2043
|
+
|
|
2044
|
+
</tbody>
|
|
2045
|
+
</table>
|
|
2046
|
+
|
|
2047
|
+
|
|
2048
|
+
|
|
2049
|
+
|
|
2050
|
+
|
|
2051
|
+
|
|
2052
|
+
|
|
2053
|
+
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
|
|
2060
|
+
|
|
2061
|
+
|
|
2062
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
2063
|
+
|
|
2064
|
+
|
|
2065
|
+
<div class="param-desc">
|
|
2066
|
+
- A promise that resolves to the fetched data or null if an error occurs or no results are found.
|
|
2067
|
+
</div>
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
|
|
2071
|
+
<dl class="param-type">
|
|
2072
|
+
<dt>
|
|
2073
|
+
Type
|
|
2074
|
+
</dt>
|
|
2075
|
+
<dd>
|
|
2076
|
+
|
|
2077
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
2078
|
+
|
|
2079
|
+
|
|
2080
|
+
|
|
2081
|
+
</dd>
|
|
2082
|
+
</dl>
|
|
2083
|
+
|
|
2084
|
+
|
|
2085
|
+
|
|
2086
|
+
|
|
2087
|
+
|
|
2088
|
+
|
|
2089
|
+
|
|
2090
|
+
|
|
2091
|
+
|
|
2092
|
+
|
|
1927
2093
|
<h4 class="name" id=".fetchChildren"><span class="type-signature type-signature-static">(static) </span>fetchChildren<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
1928
2094
|
|
|
1929
2095
|
|
|
@@ -1940,7 +2106,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
1940
2106
|
|
|
1941
2107
|
<dt class="tag-source">Source:</dt>
|
|
1942
2108
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1943
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2109
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line567">line 567</a>
|
|
1944
2110
|
</li></ul></dd>
|
|
1945
2111
|
|
|
1946
2112
|
|
|
@@ -2055,7 +2221,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2055
2221
|
|
|
2056
2222
|
|
|
2057
2223
|
<div class="param-desc">
|
|
2058
|
-
- The fetched children content data or
|
|
2224
|
+
- The fetched children content data or [] if not found.
|
|
2059
2225
|
</div>
|
|
2060
2226
|
|
|
2061
2227
|
|
|
@@ -2098,7 +2264,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2098
2264
|
|
|
2099
2265
|
<dt class="tag-source">Source:</dt>
|
|
2100
2266
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2101
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2267
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line829">line 829</a>
|
|
2102
2268
|
</li></ul></dd>
|
|
2103
2269
|
|
|
2104
2270
|
|
|
@@ -2263,7 +2429,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2263
2429
|
|
|
2264
2430
|
<dt class="tag-source">Source:</dt>
|
|
2265
2431
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2266
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2432
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line742">line 742</a>
|
|
2267
2433
|
</li></ul></dd>
|
|
2268
2434
|
|
|
2269
2435
|
|
|
@@ -2428,7 +2594,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2428
2594
|
|
|
2429
2595
|
<dt class="tag-source">Source:</dt>
|
|
2430
2596
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2431
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2597
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line615">line 615</a>
|
|
2432
2598
|
</li></ul></dd>
|
|
2433
2599
|
|
|
2434
2600
|
|
|
@@ -2594,7 +2760,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2594
2760
|
|
|
2595
2761
|
|
|
2596
2762
|
|
|
2597
|
-
<h4 class="name" id=".
|
|
2763
|
+
<h4 class="name" id=".fetchMethodChildrenIds"><span class="type-signature type-signature-static">(static) </span>fetchMethodChildrenIds<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
2598
2764
|
|
|
2599
2765
|
|
|
2600
2766
|
|
|
@@ -2610,7 +2776,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2610
2776
|
|
|
2611
2777
|
<dt class="tag-source">Source:</dt>
|
|
2612
2778
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2613
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2779
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line680">line 680</a>
|
|
2614
2780
|
</li></ul></dd>
|
|
2615
2781
|
|
|
2616
2782
|
|
|
@@ -2752,7 +2918,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2752
2918
|
|
|
2753
2919
|
|
|
2754
2920
|
|
|
2755
|
-
<h4 class="name" id=".fetchMethodNextLesson"><span class="type-signature type-signature-static">(static) </span>fetchMethodNextLesson<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2921
|
+
<h4 class="name" id=".fetchMethodNextLesson"><span class="type-signature type-signature-static">(static) </span>fetchMethodNextLesson<span class="signature">(railcontentId, methodId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2756
2922
|
|
|
2757
2923
|
|
|
2758
2924
|
|
|
@@ -2768,7 +2934,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2768
2934
|
|
|
2769
2935
|
<dt class="tag-source">Source:</dt>
|
|
2770
2936
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2771
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2937
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line646">line 646</a>
|
|
2772
2938
|
</li></ul></dd>
|
|
2773
2939
|
|
|
2774
2940
|
|
|
@@ -2861,6 +3027,30 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2861
3027
|
</tr>
|
|
2862
3028
|
|
|
2863
3029
|
|
|
3030
|
+
|
|
3031
|
+
<tr>
|
|
3032
|
+
|
|
3033
|
+
<td class="name"><code>methodId</code></td>
|
|
3034
|
+
|
|
3035
|
+
|
|
3036
|
+
<td class="type">
|
|
3037
|
+
|
|
3038
|
+
|
|
3039
|
+
<span class="param-type">string</span>
|
|
3040
|
+
|
|
3041
|
+
|
|
3042
|
+
|
|
3043
|
+
|
|
3044
|
+
</td>
|
|
3045
|
+
|
|
3046
|
+
|
|
3047
|
+
|
|
3048
|
+
|
|
3049
|
+
|
|
3050
|
+
<td class="description last">The RailcontentID of the method</td>
|
|
3051
|
+
</tr>
|
|
3052
|
+
|
|
3053
|
+
|
|
2864
3054
|
</tbody>
|
|
2865
3055
|
</table>
|
|
2866
3056
|
|
|
@@ -2910,6 +3100,195 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2910
3100
|
|
|
2911
3101
|
|
|
2912
3102
|
|
|
3103
|
+
<h4 class="name" id=".fetchMethodPreviousNextLesson"><span class="type-signature type-signature-static">(static) </span>fetchMethodPreviousNextLesson<span class="signature">(railcontentId, methodId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
3104
|
+
|
|
3105
|
+
|
|
3106
|
+
|
|
3107
|
+
|
|
3108
|
+
|
|
3109
|
+
|
|
3110
|
+
<dl class="details">
|
|
3111
|
+
|
|
3112
|
+
<dt class="tag-description">Description:</dt>
|
|
3113
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the next lesson for a specific method by Railcontent ID.</li></ul></dd>
|
|
3114
|
+
|
|
3115
|
+
|
|
3116
|
+
|
|
3117
|
+
<dt class="tag-source">Source:</dt>
|
|
3118
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
3119
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line664">line 664</a>
|
|
3120
|
+
</li></ul></dd>
|
|
3121
|
+
|
|
3122
|
+
|
|
3123
|
+
|
|
3124
|
+
|
|
3125
|
+
|
|
3126
|
+
|
|
3127
|
+
|
|
3128
|
+
|
|
3129
|
+
|
|
3130
|
+
|
|
3131
|
+
|
|
3132
|
+
|
|
3133
|
+
|
|
3134
|
+
|
|
3135
|
+
|
|
3136
|
+
|
|
3137
|
+
|
|
3138
|
+
|
|
3139
|
+
|
|
3140
|
+
|
|
3141
|
+
|
|
3142
|
+
|
|
3143
|
+
|
|
3144
|
+
|
|
3145
|
+
|
|
3146
|
+
|
|
3147
|
+
|
|
3148
|
+
|
|
3149
|
+
|
|
3150
|
+
|
|
3151
|
+
|
|
3152
|
+
</dl>
|
|
3153
|
+
|
|
3154
|
+
|
|
3155
|
+
|
|
3156
|
+
|
|
3157
|
+
|
|
3158
|
+
|
|
3159
|
+
|
|
3160
|
+
|
|
3161
|
+
|
|
3162
|
+
|
|
3163
|
+
|
|
3164
|
+
<h5 class="h5-examples">Example</h5>
|
|
3165
|
+
|
|
3166
|
+
<pre class="prettyprint"><code>fetchMethodPreviousNextLesson(241284, 241247)
|
|
3167
|
+
.then(data => { console.log('nextLesson', data.nextLesson); console.log('prevlesson', data.prevLesson);})
|
|
3168
|
+
.catch(error => console.error(error));</code></pre>
|
|
3169
|
+
|
|
3170
|
+
|
|
3171
|
+
|
|
3172
|
+
|
|
3173
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
3174
|
+
|
|
3175
|
+
|
|
3176
|
+
<table class="params">
|
|
3177
|
+
<thead>
|
|
3178
|
+
<tr>
|
|
3179
|
+
|
|
3180
|
+
<th>Name</th>
|
|
3181
|
+
|
|
3182
|
+
|
|
3183
|
+
<th>Type</th>
|
|
3184
|
+
|
|
3185
|
+
|
|
3186
|
+
|
|
3187
|
+
|
|
3188
|
+
|
|
3189
|
+
<th class="last">Description</th>
|
|
3190
|
+
</tr>
|
|
3191
|
+
</thead>
|
|
3192
|
+
|
|
3193
|
+
<tbody>
|
|
3194
|
+
|
|
3195
|
+
|
|
3196
|
+
<tr>
|
|
3197
|
+
|
|
3198
|
+
<td class="name"><code>railcontentId</code></td>
|
|
3199
|
+
|
|
3200
|
+
|
|
3201
|
+
<td class="type">
|
|
3202
|
+
|
|
3203
|
+
|
|
3204
|
+
<span class="param-type">string</span>
|
|
3205
|
+
|
|
3206
|
+
|
|
3207
|
+
|
|
3208
|
+
|
|
3209
|
+
</td>
|
|
3210
|
+
|
|
3211
|
+
|
|
3212
|
+
|
|
3213
|
+
|
|
3214
|
+
|
|
3215
|
+
<td class="description last">The Railcontent ID of the current lesson.</td>
|
|
3216
|
+
</tr>
|
|
3217
|
+
|
|
3218
|
+
|
|
3219
|
+
|
|
3220
|
+
<tr>
|
|
3221
|
+
|
|
3222
|
+
<td class="name"><code>methodId</code></td>
|
|
3223
|
+
|
|
3224
|
+
|
|
3225
|
+
<td class="type">
|
|
3226
|
+
|
|
3227
|
+
|
|
3228
|
+
<span class="param-type">string</span>
|
|
3229
|
+
|
|
3230
|
+
|
|
3231
|
+
|
|
3232
|
+
|
|
3233
|
+
</td>
|
|
3234
|
+
|
|
3235
|
+
|
|
3236
|
+
|
|
3237
|
+
|
|
3238
|
+
|
|
3239
|
+
<td class="description last">The RailcontentID of the method</td>
|
|
3240
|
+
</tr>
|
|
3241
|
+
|
|
3242
|
+
|
|
3243
|
+
</tbody>
|
|
3244
|
+
</table>
|
|
3245
|
+
|
|
3246
|
+
|
|
3247
|
+
|
|
3248
|
+
|
|
3249
|
+
|
|
3250
|
+
|
|
3251
|
+
|
|
3252
|
+
|
|
3253
|
+
|
|
3254
|
+
|
|
3255
|
+
|
|
3256
|
+
|
|
3257
|
+
|
|
3258
|
+
|
|
3259
|
+
|
|
3260
|
+
|
|
3261
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
3262
|
+
|
|
3263
|
+
|
|
3264
|
+
<div class="param-desc">
|
|
3265
|
+
- object with `nextLesson` and `previousLesson` attributes
|
|
3266
|
+
</div>
|
|
3267
|
+
|
|
3268
|
+
|
|
3269
|
+
|
|
3270
|
+
<dl class="param-type">
|
|
3271
|
+
<dt>
|
|
3272
|
+
Type
|
|
3273
|
+
</dt>
|
|
3274
|
+
<dd>
|
|
3275
|
+
|
|
3276
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
3277
|
+
|
|
3278
|
+
|
|
3279
|
+
|
|
3280
|
+
</dd>
|
|
3281
|
+
</dl>
|
|
3282
|
+
|
|
3283
|
+
|
|
3284
|
+
|
|
3285
|
+
|
|
3286
|
+
|
|
3287
|
+
|
|
3288
|
+
|
|
3289
|
+
|
|
3290
|
+
|
|
3291
|
+
|
|
2913
3292
|
<h4 class="name" id=".fetchMethods"><span class="type-signature type-signature-static">(static) </span>fetchMethods<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2914
3293
|
|
|
2915
3294
|
|
|
@@ -2926,7 +3305,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
2926
3305
|
|
|
2927
3306
|
<dt class="tag-source">Source:</dt>
|
|
2928
3307
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2929
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
3308
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line599">line 599</a>
|
|
2930
3309
|
</li></ul></dd>
|
|
2931
3310
|
|
|
2932
3311
|
|
|
@@ -3084,7 +3463,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3084
3463
|
|
|
3085
3464
|
<dt class="tag-source">Source:</dt>
|
|
3086
3465
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3087
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
3466
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line256">line 256</a>
|
|
3088
3467
|
</li></ul></dd>
|
|
3089
3468
|
|
|
3090
3469
|
|
|
@@ -3242,7 +3621,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3242
3621
|
|
|
3243
3622
|
<dt class="tag-source">Source:</dt>
|
|
3244
3623
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3245
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
3624
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line716">line 716</a>
|
|
3246
3625
|
</li></ul></dd>
|
|
3247
3626
|
|
|
3248
3627
|
|
|
@@ -3400,7 +3779,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3400
3779
|
|
|
3401
3780
|
<dt class="tag-source">Source:</dt>
|
|
3402
3781
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3403
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
3782
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line789">line 789</a>
|
|
3404
3783
|
</li></ul></dd>
|
|
3405
3784
|
|
|
3406
3785
|
|
|
@@ -3558,7 +3937,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3558
3937
|
|
|
3559
3938
|
<dt class="tag-source">Source:</dt>
|
|
3560
3939
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3561
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
3940
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line815">line 815</a>
|
|
3562
3941
|
</li></ul></dd>
|
|
3563
3942
|
|
|
3564
3943
|
|
|
@@ -3707,6 +4086,155 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3707
4086
|
|
|
3708
4087
|
|
|
3709
4088
|
|
|
4089
|
+
<h4 class="name" id=".fetchParentByRailContentId"><span class="type-signature type-signature-static">(static) </span>fetchParentByRailContentId<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Array.<string>|null)>}</span></h4>
|
|
4090
|
+
|
|
4091
|
+
|
|
4092
|
+
|
|
4093
|
+
|
|
4094
|
+
|
|
4095
|
+
|
|
4096
|
+
<dl class="details">
|
|
4097
|
+
|
|
4098
|
+
|
|
4099
|
+
|
|
4100
|
+
<dt class="tag-source">Source:</dt>
|
|
4101
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
4102
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line582">line 582</a>
|
|
4103
|
+
</li></ul></dd>
|
|
4104
|
+
|
|
4105
|
+
|
|
4106
|
+
|
|
4107
|
+
|
|
4108
|
+
|
|
4109
|
+
|
|
4110
|
+
|
|
4111
|
+
|
|
4112
|
+
|
|
4113
|
+
|
|
4114
|
+
|
|
4115
|
+
|
|
4116
|
+
|
|
4117
|
+
|
|
4118
|
+
|
|
4119
|
+
|
|
4120
|
+
|
|
4121
|
+
|
|
4122
|
+
|
|
4123
|
+
|
|
4124
|
+
|
|
4125
|
+
|
|
4126
|
+
|
|
4127
|
+
|
|
4128
|
+
|
|
4129
|
+
|
|
4130
|
+
|
|
4131
|
+
|
|
4132
|
+
|
|
4133
|
+
|
|
4134
|
+
|
|
4135
|
+
</dl>
|
|
4136
|
+
|
|
4137
|
+
|
|
4138
|
+
|
|
4139
|
+
|
|
4140
|
+
|
|
4141
|
+
|
|
4142
|
+
|
|
4143
|
+
|
|
4144
|
+
|
|
4145
|
+
|
|
4146
|
+
|
|
4147
|
+
|
|
4148
|
+
|
|
4149
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
4150
|
+
|
|
4151
|
+
|
|
4152
|
+
<table class="params">
|
|
4153
|
+
<thead>
|
|
4154
|
+
<tr>
|
|
4155
|
+
|
|
4156
|
+
<th>Name</th>
|
|
4157
|
+
|
|
4158
|
+
|
|
4159
|
+
<th>Type</th>
|
|
4160
|
+
|
|
4161
|
+
|
|
4162
|
+
|
|
4163
|
+
|
|
4164
|
+
|
|
4165
|
+
<th class="last">Description</th>
|
|
4166
|
+
</tr>
|
|
4167
|
+
</thead>
|
|
4168
|
+
|
|
4169
|
+
<tbody>
|
|
4170
|
+
|
|
4171
|
+
|
|
4172
|
+
<tr>
|
|
4173
|
+
|
|
4174
|
+
<td class="name"><code>railcontentId</code></td>
|
|
4175
|
+
|
|
4176
|
+
|
|
4177
|
+
<td class="type">
|
|
4178
|
+
|
|
4179
|
+
</td>
|
|
4180
|
+
|
|
4181
|
+
|
|
4182
|
+
|
|
4183
|
+
|
|
4184
|
+
|
|
4185
|
+
<td class="description last">railcontent id of the child</td>
|
|
4186
|
+
</tr>
|
|
4187
|
+
|
|
4188
|
+
|
|
4189
|
+
</tbody>
|
|
4190
|
+
</table>
|
|
4191
|
+
|
|
4192
|
+
|
|
4193
|
+
|
|
4194
|
+
|
|
4195
|
+
|
|
4196
|
+
|
|
4197
|
+
|
|
4198
|
+
|
|
4199
|
+
|
|
4200
|
+
|
|
4201
|
+
|
|
4202
|
+
|
|
4203
|
+
|
|
4204
|
+
|
|
4205
|
+
|
|
4206
|
+
|
|
4207
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
4208
|
+
|
|
4209
|
+
|
|
4210
|
+
<div class="param-desc">
|
|
4211
|
+
- The fetched parent content data or [] if not found
|
|
4212
|
+
</div>
|
|
4213
|
+
|
|
4214
|
+
|
|
4215
|
+
|
|
4216
|
+
<dl class="param-type">
|
|
4217
|
+
<dt>
|
|
4218
|
+
Type
|
|
4219
|
+
</dt>
|
|
4220
|
+
<dd>
|
|
4221
|
+
|
|
4222
|
+
<span class="param-type">Promise.<(Array.<string>|null)></span>
|
|
4223
|
+
|
|
4224
|
+
|
|
4225
|
+
|
|
4226
|
+
</dd>
|
|
4227
|
+
</dl>
|
|
4228
|
+
|
|
4229
|
+
|
|
4230
|
+
|
|
4231
|
+
|
|
4232
|
+
|
|
4233
|
+
|
|
4234
|
+
|
|
4235
|
+
|
|
4236
|
+
|
|
4237
|
+
|
|
3710
4238
|
<h4 class="name" id=".fetchRelatedLessons"><span class="type-signature type-signature-static">(static) </span>fetchRelatedLessons<span class="signature">(railContentId, brand)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
3711
4239
|
|
|
3712
4240
|
|
|
@@ -3723,7 +4251,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3723
4251
|
|
|
3724
4252
|
<dt class="tag-source">Source:</dt>
|
|
3725
4253
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3726
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4254
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line768">line 768</a>
|
|
3727
4255
|
</li></ul></dd>
|
|
3728
4256
|
|
|
3729
4257
|
|
|
@@ -3905,7 +4433,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
3905
4433
|
|
|
3906
4434
|
<dt class="tag-source">Source:</dt>
|
|
3907
4435
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3908
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4436
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line72">line 72</a>
|
|
3909
4437
|
</li></ul></dd>
|
|
3910
4438
|
|
|
3911
4439
|
|
|
@@ -4094,7 +4622,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
|
|
|
4094
4622
|
|
|
4095
4623
|
<dt class="tag-source">Source:</dt>
|
|
4096
4624
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4097
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4625
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line870">line 870</a>
|
|
4098
4626
|
</li></ul></dd>
|
|
4099
4627
|
|
|
4100
4628
|
|
|
@@ -4284,7 +4812,7 @@ fetchSanity(query, true)
|
|
|
4284
4812
|
|
|
4285
4813
|
<dt class="tag-source">Source:</dt>
|
|
4286
4814
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4287
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4815
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line55">line 55</a>
|
|
4288
4816
|
</li></ul></dd>
|
|
4289
4817
|
|
|
4290
4818
|
|
|
@@ -4442,7 +4970,7 @@ fetchSanity(query, true)
|
|
|
4442
4970
|
|
|
4443
4971
|
<dt class="tag-source">Source:</dt>
|
|
4444
4972
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4445
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4973
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line20">line 20</a>
|
|
4446
4974
|
</li></ul></dd>
|
|
4447
4975
|
|
|
4448
4976
|
|
|
@@ -4607,7 +5135,7 @@ fetchSanity(query, true)
|
|
|
4607
5135
|
|
|
4608
5136
|
<dt class="tag-source">Source:</dt>
|
|
4609
5137
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4610
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5138
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line216">line 216</a>
|
|
4611
5139
|
</li></ul></dd>
|
|
4612
5140
|
|
|
4613
5141
|
|
|
@@ -4765,7 +5293,7 @@ fetchSanity(query, true)
|
|
|
4765
5293
|
|
|
4766
5294
|
<dt class="tag-source">Source:</dt>
|
|
4767
5295
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4768
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5296
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line187">line 187</a>
|
|
4769
5297
|
</li></ul></dd>
|
|
4770
5298
|
|
|
4771
5299
|
|
|
@@ -4930,7 +5458,7 @@ fetchSanity(query, true)
|
|
|
4930
5458
|
|
|
4931
5459
|
<dt class="tag-source">Source:</dt>
|
|
4932
5460
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4933
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5461
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line293">line 293</a>
|
|
4934
5462
|
</li></ul></dd>
|
|
4935
5463
|
|
|
4936
5464
|
|
|
@@ -5097,7 +5625,7 @@ It also includes completion status and progress percentage for each workout by f
|
|
|
5097
5625
|
|
|
5098
5626
|
<dt class="tag-source">Source:</dt>
|
|
5099
5627
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5100
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5628
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line234">line 234</a>
|
|
5101
5629
|
</li></ul></dd>
|
|
5102
5630
|
|
|
5103
5631
|
|
|
@@ -5261,7 +5789,7 @@ It also includes completion status and progress percentage for each workout by f
|
|
|
5261
5789
|
<br class="clear">
|
|
5262
5790
|
|
|
5263
5791
|
<footer>
|
|
5264
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Aug 26 2024
|
|
5792
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Aug 26 2024 20:15:19 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
5265
5793
|
</footer>
|
|
5266
5794
|
|
|
5267
5795
|
<script>prettyPrint();</script>
|