npm - musora-content-services - Versions diffs - 1.0.20 → 1.0.21 - Mend

musora-content-services 1.0.20 → 1.0.21

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 (71) hide show

package/CHANGELOG.md +2 -0
package/docs/config.js.html +124 -0
package/docs/index.html +2 -2
package/docs/module-Config.html +669 -0
package/docs/module-Railcontent-Services.html +751 -0
package/docs/{global.html → module-Sanity-Services.html} +52 -501
package/docs/railcontent.js.html +178 -0
package/docs/sanity.js.html +994 -0
package/jsdoc.json +1 -1
package/package.json +1 -1
package/publish.sh +0 -0
package/src/index.d.ts +2 -2
package/src/index.js +32 -909
package/src/services/config.js +52 -0
package/src/services/railcontent.js +106 -0
package/src/services/sanity.js +922 -0
package/test/sanityQueryService.test.js +2 -2
package/docs/data/search.json +0 -1
package/docs/fonts/Inconsolata-Regular.ttf +0 -0
package/docs/fonts/OpenSans-Bold-webfont.eot +0 -0
package/docs/fonts/OpenSans-Bold-webfont.svg +0 -1830
package/docs/fonts/OpenSans-Bold-webfont.woff +0 -0
package/docs/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/docs/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
package/docs/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Italic-webfont.eot +0 -0
package/docs/fonts/OpenSans-Italic-webfont.svg +0 -1830
package/docs/fonts/OpenSans-Italic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Light-webfont.eot +0 -0
package/docs/fonts/OpenSans-Light-webfont.svg +0 -1831
package/docs/fonts/OpenSans-Light-webfont.woff +0 -0
package/docs/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/docs/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
package/docs/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Regular-webfont.eot +0 -0
package/docs/fonts/OpenSans-Regular-webfont.svg +0 -1831
package/docs/fonts/OpenSans-Regular-webfont.woff +0 -0
package/docs/fonts/OpenSans-Regular.ttf +0 -0
package/docs/fonts/OpenSans-Semibold-webfont.eot +0 -0
package/docs/fonts/OpenSans-Semibold-webfont.svg +0 -1830
package/docs/fonts/OpenSans-Semibold-webfont.ttf +0 -0
package/docs/fonts/OpenSans-Semibold-webfont.woff +0 -0
package/docs/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
package/docs/fonts/OpenSans-SemiboldItalic-webfont.svg +0 -1830
package/docs/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
package/docs/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
package/docs/fonts/WorkSans-Bold.ttf +0 -0
package/docs/index.js.html +0 -1122
package/docs/scripts/core.js +0 -726
package/docs/scripts/core.min.js +0 -23
package/docs/scripts/resize.js +0 -90
package/docs/scripts/search.min.js +0 -6
package/docs/scripts/third-party/Apache-License-2.0.txt +0 -202
package/docs/scripts/third-party/fuse.js +0 -9
package/docs/scripts/third-party/hljs-line-num-original.js +0 -369
package/docs/scripts/third-party/hljs-line-num.js +0 -1
package/docs/scripts/third-party/hljs-original.js +0 -5171
package/docs/scripts/third-party/hljs.js +0 -1
package/docs/scripts/third-party/popper.js +0 -5
package/docs/scripts/third-party/tippy.js +0 -1
package/docs/scripts/third-party/tocbot.js +0 -672
package/docs/scripts/third-party/tocbot.min.js +0 -1
package/docs/styles/clean-jsdoc-theme-base.css +0 -1159
package/docs/styles/clean-jsdoc-theme-dark.css +0 -412
package/docs/styles/clean-jsdoc-theme-light.css +0 -482
package/docs/styles/clean-jsdoc-theme-scrollbar.css +0 -30
package/docs/styles/clean-jsdoc-theme-without-scrollbar.min.css +0 -1
package/docs/styles/clean-jsdoc-theme.min.css +0 -1
package/docs/styles/jsdoc-default.css +0 -692
package/docs/styles/prettify-jsdoc.css +0 -111
package/docs/styles/prettify-tomorrow.css +0 -132

package/docs/railcontent.js.html ADDED Viewed

@@ -0,0 +1,178 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>railcontent.js - Documentation</title>
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
+    <script src="scripts/nav.js" defer></script>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+</head>
+<body>
+<input type="checkbox" id="nav-trigger" class="nav-trigger" />
+<label for="nav-trigger" class="navicon-button x">
+  <div class="navicon"></div>
+</label>
+<label for="nav-trigger" class="overlay"></label>
+<nav >
+    <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#.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#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLiveEvent">fetchLiveEvent</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#.fetchMethodNextLesson">fetchMethodNextLesson</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#.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>
+</nav>
+<div id="main">
+    <h1 class="page-title">railcontent.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/**
+ * @module Railcontent-Services
+ */
+const { globalConfig } = require('./config');
+/**
+ * Fetches the completion status of a specific song for the current user.
+ *
+ * @param {string} userId - The ID of the current user.
+ * @param {string} content_id - The ID of the song content to check.
+ * @param {string} token - The CSRF token for authentication.
+ * @returns {Promise&lt;Object|null>} - Returns the completion status object if found, otherwise null.
+ * @example
+ * fetchCurrentSongComplete('user123', 'song456', 'csrf-token')
+ *   .then(status => console.log(status))
+ *   .catch(error => console.error(error));
+ */
+export async function fetchCurrentSongComplete(content_id) {
+    const url = `/content/user_progress/${globalConfig.railcontentConfig.userId}?content_ids[]=${content_id}`;
+    const headers = {
+        'Content-Type': 'application/json',
+        'X-CSRF-TOKEN': globalConfig.railcontentConfig.token
+    };
+    try {
+        const response = await fetch(url, { headers });
+        const result = await response.json();
+        if(result){
+            return result[globalConfig.railcontentConfig.userId];
+        }
+    } catch (error) {
+        console.error('Fetch error:', error);
+        return null;
+    }
+}
+/**
+ * Fetches the completion status for multiple songs for the current user.
+ *
+ * @param {string} userId - The ID of the current user.
+ * @param {Array&lt;string>} contentIds - An array of content IDs to check.
+ * @param {string} token - The CSRF token for authentication.
+ * @returns {Promise&lt;Object|null>} - Returns an object containing completion statuses keyed by content ID, or null if an error occurs.
+ * @example
+ * fetchAllCompletedStates('user123', ['song456', 'song789'], 'csrf-token')
+ *   .then(statuses => console.log(statuses))
+ *   .catch(error => console.error(error));
+ */
+export async function fetchAllCompletedStates(contentIds) {
+    const url = `/content/user_progress/${globalConfig.railcontentConfig.userId}?${contentIds.map(id => `content_ids[]=${id}`).join('&amp;')}`;
+    const headers = {
+        'Content-Type': 'application/json',
+        'X-CSRF-TOKEN': globalConfig.railcontentConfig.token
+    };
+    try {
+        const response = await fetch(url, { headers });
+        const result = await response.json();
+        if(result){
+            return result;
+        } else {
+            console.log('result not json');
+        }
+    } catch (error) {
+        console.error('Fetch error:', error);
+        return null;
+    }
+}
+/**
+ * Fetches a list of songs that are currently in progress for the current user.
+ *
+ * @param {string} userId - The ID of the current user.
+ * @param {string} brand - The brand associated with the songs.
+ * @param {string} token - The CSRF token for authentication.
+ * @returns {Promise&lt;Object|null>} - Returns an object containing in-progress songs if found, otherwise null.
+ * @example
+ * fetchSongsInProgress('user123', 'drumeo', 'csrf-token')
+ *   .then(songs => console.log(songs))
+ *   .catch(error => console.error(error));
+ */
+export async function fetchSongsInProgress(brand) {
+    const url = `/content/in_progress/${globalConfig.railcontentConfig.userId}?content_type=song&amp;brand=${brand}`;
+    const headers = {
+        'Content-Type': 'application/json',
+        'X-CSRF-TOKEN': globalConfig.railcontentConfig.token
+    };
+    try {
+        const response = await fetch(url, { headers });
+        const result = await response.json();
+        if(result){
+            console.log('fetchSongsInProgress', result);
+            return result;
+        } else {
+            console.log('result not json');
+        }
+    } catch (error) {
+        console.error('Fetch error:', error);
+        return null;
+    }
+}
+</code></pre>
+        </article>
+    </section>
+</div>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Wed Aug 14 2024 02:49:16 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+</footer>
+<script>prettyPrint();</script>
+<script src="scripts/polyfill.js"></script>
+<script src="scripts/linenumber.js"></script>
+</body>
+</html>