musora-content-services 1.0.20 → 1.0.21

package/src/services/config.js

@@ -0,0 +1,52 @@
+/**
+ * @module Config
+ */
+
+let globalConfig = {
+    sanityConfig: {},
+    railcontentConfig: {}
+  };
+  
+/**
+ * Initializes the service with the given configuration.
+ * This function must be called before using any other functions in this library.
+ *
+ * @param {Object} config - Configuration object containing API settings.
+ * @param {Object} config.sanityConfig - Configuration for Sanity API.
+ * @param {string} config.sanityConfig.token - The API token for authenticating with Sanity.
+ * @param {string} config.sanityConfig.projectId - The project ID in Sanity.
+ * @param {string} config.sanityConfig.dataset - The dataset name in Sanity.
+ * @param {string} config.sanityConfig.version - The API version to use.
+ * @param {boolean} [config.sanityConfig.debug=false] - Optional flag to enable debug mode.
+ * @param {boolean} [config.sanityConfig.useCachedAPI=true] - Optional flag to enable or disable the use of the cached API.
+ * @param {Object} config.railcontentConfig - Configuration for user services.
+ * @param {string} config.railcontentConfig.token - The token for authenticating user-specific requests.
+ * @param {string} config.railcontentConfig.userId - The user ID for fetching user-specific data.
+ *
+ * @example
+ * // Initialize the service in your app.js
+ * initializeService({
+ *   sanityConfig: {
+ *     token: 'your-sanity-api-token',
+ *     projectId: 'your-sanity-project-id',
+ *     dataset: 'your-dataset-name',
+ *     version: '2021-06-07',
+ *     debug: true,
+ *     useCachedAPI: false
+ *   },
+ *   railcontentConfig: {
+ *     token: 'your-user-api-token',
+ *     userId: 'current-user-id'
+ *   }
+ * });
+ */
+function initializeService(config) {
+    globalConfig.sanityConfig = config.sanityConfig;
+    globalConfig.railcontentConfig = config.railcontentConfig;
+}
+
+// Export both the initialization function and the config object
+module.exports = {
+    initializeService,
+    globalConfig
+};

package/src/services/railcontent.js

@@ -0,0 +1,106 @@
+/**
+ * @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<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<string>} contentIds - An array of content IDs to check.
+ * @param {string} token - The CSRF token for authentication.
+ * @returns {Promise<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('&')}`;
+
+    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<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&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;
+    }
+}