musora-content-services 1.0.78 → 1.0.81

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 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.81](https://github.com/railroadmedia/musora-content-services/compare/v1.0.80...v1.0.81) (2024-09-05)
+
+### [1.0.80](https://github.com/railroadmedia/musora-content-services/compare/v1.0.79...v1.0.80) (2024-09-05)
+
+### [1.0.79](https://github.com/railroadmedia/musora-content-services/compare/v1.0.77...v1.0.79) (2024-09-05)
+
 ### [1.0.77](https://github.com/railroadmedia/musora-content-services/compare/v1.0.76...v1.0.77) (2024-09-04)
 
 ### [1.0.76](https://github.com/railroadmedia/musora-content-services/compare/v1.0.75...v1.0.76) (2024-08-30)

package/package.json

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

package/src/contentTypeConfig.js

@@ -134,13 +134,14 @@ let contentTypeConfig = {
             'low_soundslice_slug'
         ]
     },
-    'pack-bundle': {
+    'pack-children': {
         'fields': [
             'child_count',
             `"children": child[]->{
                 "description": ${descriptionField},
                 ${getFieldsForContentType()}
             }`,
+            '"resources": resource',
             '"image": logo_image_url.asset->url',
             '"thumbnail": thumbnail.asset->url',
             '"light_logo": light_mode_logo_url.asset->url',
@@ -149,6 +150,33 @@ let contentTypeConfig = {
             'total_xp',
         ]
     },
+    'foundation': {
+        'fields': [
+            `"description": ${descriptionField}`,
+            `"instructors":instructor[]->name`,
+            `"units": child[]->{
+                "id": railcontent_id,
+                published_on,
+                child_count,
+                difficulty,
+                difficulty_string,
+                "thumbnail_url": thumbnail.asset->url,
+                "instructor": instructor[]->{name},
+                title,
+                "type": _type,
+                "description": ${descriptionField},
+                "url": web_url_path,
+                xp,
+            }`
+        ]
+    },
+    'instructor': {
+        'fields': [
+            'name',
+            '"coach_card_image": coach_card_image.asset->url',
+            'focus'
+        ]
+    },
     // content with just the added 'instructors' Field
     'student-focus': contentWithInstructorsField,
     'quick-tips': contentWithInstructorsField,

package/src/index.d.ts

@@ -14,6 +14,7 @@ import {
     fetchByRailContentIds,
     fetchAll,
     fetchAllFilterOptions,
+    fetchFoundation,
     fetchMethods,
     fetchMethod,
     fetchMethodChildren,
@@ -51,6 +52,7 @@ declare module 'musora-content-services' {
         fetchByRailContentIds,
         fetchAll,
         fetchAllFilterOptions,
+        fetchFoundation,
         fetchMethods,
         fetchMethod,
         fetchMethodNextLesson,

package/src/index.js

@@ -16,6 +16,7 @@ import {
   fetchAll,
   fetchAllFilterOptions,
   fetchMethodNextLesson,
+  fetchFoundation,
   fetchMethod,
   fetchMethods,
   fetchMethodChildren,
@@ -38,6 +39,7 @@ import {
   fetchAllCompletedStates,
   fetchContentInProgress,
   fetchVimeoData,
+  fetchContentPageUserData,
 } from './services/railcontent.js';
 
 
@@ -57,6 +59,7 @@ export {
     fetchByRailContentIds,
     fetchAll,
     fetchAllFilterOptions,
+    fetchFoundation,
     fetchMethods,
     fetchMethod,
     fetchMethodChildren,
@@ -77,4 +80,5 @@ export {
     fetchLiveEvent,
     fetchChallengeOverview,
     fetchVimeoData,
+    fetchContentPageUserData,
 }

package/src/services/sanity.js

@@ -366,6 +366,7 @@ export async function fetchByRailContentIds(ids, contentType = undefined) {
  * @param {string} [params.sort="-published_on"] - The field to sort the content by.
  * @param {Array<string>} [params.includedFields=[]] - The fields to include in the query.
  * @param {string} [params.groupBy=""] - The field to group the results by (e.g., 'artist', 'genre').
+ * @param {Array<string>} [params.progressIds=undefined] - An array of railcontent IDs to filter the results by. Used for filtering by progress.
  * @returns {Promise<Object|null>} - The fetched content data or null if not found.
  *
  * @example
@@ -386,7 +387,8 @@ export async function fetchAll(brand, type, {
   searchTerm = "",
   sort = "-published_on",
   includedFields = [],
-  groupBy = ""
+  groupBy = "",
+  progressIds = undefined
 } = {}) {
     let config = contentTypeConfig[type] ?? {};
     let additionalFields = config?.fields ?? [];
@@ -406,6 +408,10 @@ export async function fetchAll(brand, type, {
         ? filtersToGroq(includedFields)
         : "";
 
+    // limits the results to supplied progressIds for started & completed filters
+    const progressFilter = progressIds !== undefined ?
+        `&& railcontent_id in [${progressIds.join(',')}]` : "";
+
     // Determine the sort order
     const sortOrder = getSortOrder(sort);
 
@@ -417,15 +423,15 @@ export async function fetchAll(brand, type, {
     if (groupBy !== "" && isGroupByOneToOne) {
         query = `
         {
-            "total": count(*[_type == '${groupBy}' && count(*[_type == '${type}' && brand == '${brand}' && ^._id == ${groupBy}._ref ${searchFilter} ${includedFieldsFilter}]._id) > 0]),
-            "entity": *[_type == '${groupBy}' && count(*[_type == '${type}' && brand == '${brand}' && ^._id == ${groupBy}._ref ${searchFilter} ${includedFieldsFilter}]._id) > 0]
+            "total": count(*[_type == '${groupBy}' && count(*[_type == '${type}' && brand == '${brand}' && ^._id == ${groupBy}._ref ${searchFilter} ${includedFieldsFilter} ${progressFilter}]._id) > 0]),
+            "entity": *[_type == '${groupBy}' && count(*[_type == '${type}' && brand == '${brand}' && ^._id == ${groupBy}._ref ${searchFilter} ${includedFieldsFilter} ${progressFilter}]._id) > 0]
             {
                 'id': _id,
                 'type': _type,
                 name,
                 'head_shot_picture_url': thumbnail_url.asset->url,
-                'all_lessons_count': count(*[_type == '${type}' && brand == '${brand}' && ^._id == ${groupBy}._ref ${searchFilter} ${includedFieldsFilter}]._id),
-                'lessons': *[_type == '${type}' && brand == '${brand}' && ^._id == ${groupBy}._ref ${searchFilter} ${includedFieldsFilter}]{
+                'all_lessons_count': count(*[_type == '${type}' && brand == '${brand}' && ^._id == ${groupBy}._ref ${searchFilter} ${includedFieldsFilter} ${progressFilter}]._id),
+                'lessons': *[_type == '${type}' && brand == '${brand}' && ^._id == ${groupBy}._ref ${searchFilter} ${includedFieldsFilter} ${progressFilter}]{
                     ${fieldsString},
                     ${groupBy}
                 }[0...10]
@@ -436,15 +442,15 @@ export async function fetchAll(brand, type, {
     } else if (groupBy !== "") {
         query = `
         {
-            "total": count(*[_type == '${groupBy}' && count(*[_type == '${type}' && brand == '${brand}' && ^._id in ${groupBy}[]._ref ${searchFilter} ${includedFieldsFilter}]._id) > 0]),
-            "entity": *[_type == '${groupBy}' && count(*[_type == '${type}' && brand == '${brand}' && ^._id in ${groupBy}[]._ref ${searchFilter} ${includedFieldsFilter}]._id) > 0]
+            "total": count(*[_type == '${groupBy}' && count(*[_type == '${type}' && brand == '${brand}' && ^._id in ${groupBy}[]._ref ${searchFilter} ${includedFieldsFilter} ${progressFilter}]._id) > 0]),
+            "entity": *[_type == '${groupBy}' && count(*[_type == '${type}' && brand == '${brand}' && ^._id in ${groupBy}[]._ref ${searchFilter} ${includedFieldsFilter} ${progressFilter}]._id) > 0]
             {
                 'id': _id,
                 'type': _type,
                 name,
                 'head_shot_picture_url': thumbnail_url.asset->url,
-                'all_lessons_count': count(*[_type == '${type}' && brand == '${brand}' && ^._id in ${groupBy}[]._ref ${searchFilter} ${includedFieldsFilter}]._id),
-                'lessons': *[_type == '${type}' && brand == '${brand}' && ^._id in ${groupBy}[]._ref ${searchFilter} ${includedFieldsFilter}]{
+                'all_lessons_count': count(*[_type == '${type}' && brand == '${brand}' && ^._id in ${groupBy}[]._ref ${searchFilter} ${includedFieldsFilter} ${progressFilter}]._id),
+                'lessons': *[_type == '${type}' && brand == '${brand}' && ^._id in ${groupBy}[]._ref ${searchFilter} ${includedFieldsFilter} ${progressFilter}]{
                     ${fieldsString},
                     ${groupBy}
                 }[0...10]
@@ -455,10 +461,10 @@ export async function fetchAll(brand, type, {
     } else {
         query = `
         {
-            "entity": *[_type == '${type}' && brand == "${brand}" ${searchFilter} ${includedFieldsFilter}] | order(${sortOrder}) [${start}...${end}] {
+            "entity": *[_type == '${type}' && brand == "${brand}" ${searchFilter} ${includedFieldsFilter} ${progressFilter}] | order(${sortOrder}) [${start}...${end}] {
                 ${fieldsString}
             },
-            "total": count(*[_type == '${type}' && brand == "${brand}" ${searchFilter} ${includedFieldsFilter}])
+            "total": count(*[_type == '${type}' && brand == "${brand}" ${searchFilter} ${includedFieldsFilter} ${progressFilter}])
         }
     `;
     }
@@ -500,7 +506,7 @@ export function getSortOrder(sort= '-published_on', groupBy)
 * @param {string} [artist] - Optional artist name to filter the results. If provided, the query will check if the artist's name matches.
 * @param {string} contentType - The content type to fetch (e.g., 'song', 'lesson').
 * @param {string} [term] - Optional search term to match against various fields such as title, album, artist name, and genre.
-*
+* @param {Array<string>} [progressIds=undefined] - An array of railcontent IDs to filter the results by. Used for filtering by progress.
 * @returns {Promise<Object|null>} - A promise that resolves to an object containing the total results and filter options, or null if the query fails.
 *
 * @example
@@ -515,11 +521,15 @@ export async function fetchAllFilterOptions(
     style,
     artist,
     contentType,
-    term
+    term,
+    progressIds = undefined
 ) {
     const includedFieldsFilter = filters?.length > 0 ? filtersToGroq(filters) : undefined;
 
-    const commonFilter = `_type == '${contentType}' && brand == "${brand}"${style ? ` && '${style}' in genre[]->name` : ''}${artist ? ` && artist->name == '${artist}'` : ''} ${includedFieldsFilter ? includedFieldsFilter : ''}`;
+    const progressFilter = progressIds !== undefined ?
+        `&& railcontent_id in [${progressIds.join(',')}]` : "";
+
+    const commonFilter = `_type == '${contentType}' && brand == "${brand}"${style ? ` && '${style}' in genre[]->name` : ''}${artist ? ` && artist->name == '${artist}'` : ''} ${progressFilter} ${includedFieldsFilter ? includedFieldsFilter : ''}`;
     const query = `
         {
           "meta": {
@@ -594,6 +604,18 @@ export async function fetchMethods(brand) {
   return fetchSanity(query, true);
 }
 
+/**
+* Fetch the Foundations 2019.
+* @param {string} slug - The slug of the method.
+* @returns {Promise<Object|null>} - The fetched foundation data or null if not found.
+*/
+export async function fetchFoundation(slug) {
+  const query = `*[_type == 'foundation' && slug.current == "${slug}"] {
+    ${ getFieldsForContentType('foundation') }
+  } | order(published_on asc)`
+return fetchSanity(query, false);
+}
+
 /**
 * Fetch the Method (learning-paths) for a specific brand.
 * @param {string} brand - The brand for which to fetch methods.

package/test/sanityQueryService.test.js

@@ -27,6 +27,7 @@ const {
     fetchChildren,
     fetchMethod,
     fetchMethods,
+    fetchFoundation,
 } = require('../src/services/sanity.js');
 
 describe('Sanity Queries', function () {
@@ -203,4 +204,38 @@ describe('Sanity Queries', function () {
         expect(response.length).toBeGreaterThan(0);
         expect(response[0].type).toBe('learning-path');
     });
+
+    test('fetchAll-WithProgress', async () => {
+        const ids = [410213, 305649];
+        let response = await fetchAll('drumeo', 'song', {
+            sort: 'slug',
+            progressIds: ids,
+        });
+        expect(response.entity.length).toBe(2);
+        expect(response.entity[0].id = 305649);
+        expect(response.entity[1].id = 410213);
+        // change the type and we expect no results
+        response = await fetchAll('drumeo', 'quick-tip', {
+            sort: 'slug',
+            progressIds: ids,
+        });
+        expect(response.entity.length).toBe(0);
+    });
+
+    test('fetchAllFilterOptions-WithProgress', async () => {
+        const ids = [410213, 305649];
+        let response = await fetchAllFilterOptions('drumeo', '', '', '', 'song', '', ids);
+        expect(response.meta.totalResults).toBe(2);
+        // change the brand and we expect no results
+        response = await fetchAllFilterOptions('singeo', '', '', '', 'song', '', ids);
+        expect(response.meta.totalResults).toBe(0);
+
+    });
+
+    test('fetchFoundation', async () => {
+        const response = await fetchFoundation('foundations-2019');
+        //console.log(response);
+        expect(response.units.length).toBeGreaterThan(0);
+        expect(response.type).toBe('foundation');
+    });
 });