musora-content-services 1.0.34 → 1.0.36

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.35](https://github.com/railroadmedia/musora-content-services/compare/v1.0.34...v1.0.35) (2024-08-15)
+
 ### [1.0.34](https://github.com/railroadmedia/musora-content-services/compare/v1.0.32...v1.0.34) (2024-08-15)
 
 ### [1.0.32](https://github.com/railroadmedia/musora-content-services/compare/v1.0.31...v1.0.32) (2024-08-14)

package/README.md

@@ -26,6 +26,20 @@ To publish a new version to NPM run,
 ./publish.sh
 ```
 
+## Symlinking 
+
+To link this package to the MWP repo for local development run,  
+
+```bash
+./link_mcs.sh
+```
+
+If either of these commands fail due to permissions, 
+
+```
+chmod +x <command>
+```
+
 ## Publish Documentation
 
 This repo uses JSDoc to generate API documention. To update the docs, run:

package/docs/config.js.html

@@ -111,7 +111,7 @@ module.exports = {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Aug 15 2024 19:44:49 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 Thu Aug 15 2024 22:11:38 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

@@ -78,6 +78,13 @@
 <p>To publish a new version to NPM run,</p>
 <pre class="prettyprint source lang-bash"><code>./publish.sh
 </code></pre>
+<h2>Symlinking</h2>
+<p>To link this package to the MWP repo for local development run,</p>
+<pre class="prettyprint source lang-bash"><code>./link_mcs.sh
+</code></pre>
+<p>If either of these commands fail due to permissions,</p>
+<pre class="prettyprint source"><code>chmod +x &lt;command>
+</code></pre>
 <h2>Publish Documentation</h2>
 <p>This repo uses JSDoc to generate API documention. To update the docs, run:</p>
 <pre class="prettyprint source lang-bash"><code>npm run doc
@@ -103,7 +110,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 Thu Aug 15 2024 19:44:49 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 Thu Aug 15 2024 22:11:38 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/module-Config.html

@@ -656,7 +656,7 @@ initializeService({
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Aug 15 2024 19:44:49 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 Thu Aug 15 2024 22:11:38 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/module-Railcontent-Services.html

@@ -783,7 +783,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Aug 15 2024 19:44:49 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 Thu Aug 15 2024 22:11:38 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/module-Sanity-Services.html

@@ -4881,7 +4881,7 @@ This function retrieves the latest workout content for a given brand, fetching u
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Aug 15 2024 19:44:49 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 Thu Aug 15 2024 22:11:38 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/railcontent.js.html

@@ -201,7 +201,7 @@ export async function fetchContentInProgress(type="all", brand) {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Aug 15 2024 19:44:49 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 Thu Aug 15 2024 22:11:38 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/sanity.js.html

@@ -516,7 +516,7 @@ export async function fetchAll(brand, type, {
   sort = "-published_on",
   includedFields = [],
   groupBy = ""
-}) {
+} = {}) {
     let config = contentTypeConfig[type] ?? {};
     let additionalFields = config?.fields ?? [];
     let isGroupByOneToOne = (groupBy ? config?.relationships[groupBy]?.isOneToOne : false) ?? false;
@@ -951,7 +951,7 @@ function checkSanityConfig(config) {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Aug 15 2024 19:44:49 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 Thu Aug 15 2024 22:11:38 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/link_mcs.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# Define the paths (edit these paths according to your directory structure)
+MUSORA_CONTENT_SERVICES_DIR="../musora-content-services"
+MUSORA_WEB_PLATFORM_DIR="../musora-web-platform"
+
+# Navigate to the musora-content-services directory and create a symlink
+echo "Linking musora-content-services..."
+cd "$MUSORA_CONTENT_SERVICES_DIR" || { echo "Directory not found: $MUSORA_CONTENT_SERVICES_DIR"; exit 1; }
+npm link
+
+# Navigate to the musora-web-platform directory and link the package
+echo "Linking musora-content-services to musora-web-platform..."
+cd "$MUSORA_WEB_PLATFORM_DIR" || { echo "Directory not found: $MUSORA_WEB_PLATFORM_DIR"; exit 1; }
+npm link musora-content-services
+
+echo "Symlink created successfully. You can now test your changes locally."
+
+# Optional: List the linked packages to verify
+npm ls musora-content-services

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musora-content-services",
-  "version": "1.0.34",
+  "version": "1.0.36",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "scripts": {

package/src/contentTypeConfig.js

@@ -21,7 +21,13 @@ let contentTypeConfig = {
             'challenge_state',
             'challenge_state_text',
         ]
-    }
+    },
+    'course': {
+        'fields': [
+            '"lesson_count": child_count',
+            '"instructors": instructor[]->name'
+        ]
+    },
 }
 
 

package/src/index.d.ts

@@ -20,7 +20,8 @@ import {
     fetchRelatedLessons,
     fetchPackAll,
     fetchPackChildren,
-    fetchLessonContent
+    fetchLessonContent,
+    fetchCourseOverview
   } from './services/sanity.js';
   
   import { initializeService } from './services/config.js';
@@ -48,7 +49,8 @@ declare module 'musora-content-services' {
         fetchRelatedLessons,
         fetchPackAll,
         fetchPackChildren,
-        fetchLessonContent
+        fetchLessonContent,
+        fetchCourseOverview,
     }
     
 }

package/src/index.js

@@ -22,7 +22,8 @@ import {
   fetchRelatedLessons,
   fetchPackAll,
   fetchPackChildren,
-  fetchLessonContent
+  fetchLessonContent,
+  fetchCourseOverview,
 } from './services/sanity.js';
 
 import { 
@@ -58,5 +59,6 @@ export {
     fetchLessonContent,
     fetchCurrentSongComplete, 
     fetchAllCompletedStates,
-    fetchContentInProgress
+    fetchContentInProgress,
+    fetchCourseOverview,
 }

package/src/services/sanity.js

@@ -469,7 +469,7 @@ export async function fetchAll(brand, type, {
   sort = "-published_on",
   includedFields = [],
   groupBy = ""
-}) {
+} = {}) {
     let config = contentTypeConfig[type] ?? {};
     let additionalFields = config?.fields ?? [];
     let isGroupByOneToOne = (groupBy ? config?.relationships[groupBy]?.isOneToOne : false) ?? false;
@@ -809,6 +809,43 @@ export async function fetchPackChildren(railcontentId) {
   return fetchChildren(railcontentId, 'pack');
 }
 
+/**
+ * Fetch the data needed for the Course Overview screen.
+ * @param {string} id - The Railcontent ID of the course
+ * @returns {Promise<Object|null>} - The course information and lessons or null if not found.
+ * 
+ * @example
+ * fetchCourseOverview('course123')
+ *   .then(course => console.log(course))
+ *   .catch(error => console.error(error));
+ */
+export async function fetchCourseOverview(id) {
+  // WIP
+  const query = `*[railcontent_id == ${id}]{
+        "id": railcontent_id,
+        railcontent_id,
+        title,
+        "image": thumbnail.asset->url,
+        "instructors": instructor[]->name,
+        difficulty,
+        difficulty_string,
+        web_url_path,
+        published_on,
+        "type": _type,
+        total_xp,
+        xp,
+        "description": description[0]->children[0]->text,
+        "lessons": child[]->{
+          "id": railcontent_id,
+          title,
+          "image": thumbnail.asset->url,
+          "instructors": instructor[]->name,
+          length_in_seconds,
+        }
+      }`
+  return fetchSanity(query, false);
+}
+
 /**
  * Fetch data from the Sanity API based on a provided query.
  *