musora-content-services 1.2.3 → 1.2.5

package/src/services/sanity.js

@@ -183,107 +183,6 @@ export async function fetchRelatedSongs(brand, songId) {
     return fetchSanity(query, false);
 }
 
-/**
- * Fetch all songs for a specific brand with pagination and search options.
- * @param {string} brand - The brand for which to fetch songs.
- * @param {Object} params - Parameters for pagination, filtering, and sorting.
- * @param {number} [params.page=1] - The page number for pagination.
- * @param {number} [params.limit=10] - The number of songs per page.
- * @param {string} [params.searchTerm=""] - The search term to filter songs by title or artist.
- * @param {string} [params.sort="-published_on"] - The field to sort the songs by.
- * @param {Array<string>} [params.includedFields=[]] - The fields to include in the query.
- * @param {string} [params.groupBy=""] - The field to group the results by.
- * @returns {Promise<Object|null>} - The fetched song data or null if not found.
- *
- * @example
- * fetchAllSongs('drumeo', {
- *   page: 2,
- *   limit: 20,
- *   searchTerm: 'rock',
- *   sort: 'published_on',
- *   includedFields: ['difficulty', 'style'],
- *   groupBy: 'artist'
- * })
- *   .then(result => console.log(result))
- *   .catch(error => console.error(error));
- */
-export async function fetchAllSongs(brand, {
-    page = 1,
-    limit = 10,
-    searchTerm = "",
-    sort = "-published_on",
-    includedFields = [],
-    groupBy = ""
-}) {
-    return fetchAll(brand, 'song', {page, limit, searchTerm, sort, includedFields, groupBy});
-}
-
-/**
- * Fetch filter options for a specific brand.
- *
- * @param {string} brand - The brand for which to fetch filter options.
- * @returns {Promise<Object|null>} - A promise that resolves to an object containing filter options or null if not found.
- *
- * @example
- * fetchSongFilterOptions('drumeo')
- *   .then(options => console.log(options))
- *   .catch(error => console.error(error));
- */
-export async function fetchSongFilterOptions(brand) {
-    const query = `
-  {
-    "difficulty": [
-      {"type": "Introductory", "count": count(*[_type == 'song' && brand == '${brand}' && difficulty_string == "Introductory"]._id)},
-      {"type": "Beginner", "count": count(*[_type == 'song' && brand == '${brand}' && difficulty_string == "Beginner"]._id)},
-      {"type": "Intermediate", "count": count(*[_type == 'song' && brand == '${brand}' && difficulty_string == "Intermediate"]._id)},
-      {"type": "Advanced", "count": count(*[_type == 'song' && brand == '${brand}' && difficulty_string == "Advanced"]._id)},
-      {"type": "Expert", "count": count(*[_type == 'song' && brand == '${brand}' && difficulty_string == "Expert"]._id)}
-    ],
-    "genre": *[_type == 'genre' && 'song' in filter_types] {
-      "type": name,
-      "count": count(*[_type == 'song' && brand == '${brand}' && references(^._id)]._id)
-    },
-    "instrumentless": [
-      {"type": "Full Song Only", "count": count(*[_type == 'song' && brand == '${brand}' && instrumentless == false]._id)},
-      {"type": "Instrument Removed", "count": count(*[_type == 'song' && brand == '${brand}' && instrumentless == true]._id)}
-    ]
-  }`;
-
-    return fetchSanity(query, true);
-}
-
-/**
- * Fetch the total count of songs for a specific brand.
- * @param {string} brand - The brand for which to fetch the song count.
- * @returns {Promise<number|null>} - The total count of songs or null if an error occurs.
- */
-export async function fetchSongCount(brand) {
-    const query = `count(*[_type == 'song' && brand == "${brand}"])`;
-    return fetchSanity(query, true, {processNeedAccess: false});
-}
-
-/**
- * Fetch the latest workouts for a specific brand, including completion status and progress.
- * This function retrieves up to five of the latest workout content for a given brand, sorted in descending order by their publication date.
- * It also includes completion status and progress percentage for each workout by fetching additional data about user progress.
- *
- * @param {string} brand - The brand for which to fetch workouts (e.g., 'drumeo', 'pianote').
- * @returns {Promise<Array<Object>|null>} - A promise that resolves to an array of workout data objects with additional properties for completion status and progress percentage,
- *     or null if no workouts are found.
- *
- * @example
- * fetchWorkouts('drumeo')
- *   .then(workouts => console.log(workouts))
- *   .catch(error => console.error(error));
- */
-export async function fetchWorkouts(brand) {
-    const fields = getFieldsForContentType('workout');
-    const query = `*[_type == 'workout' && brand == '${brand}'] [0...5] {
-        ${fields.toString()}
-      } | order(published_on desc)[0...5]`
-    return fetchSanity(query, true);
-}
-
 /**
  * Fetch the latest new releases for a specific brand.
  * @param {string} brand - The brand for which to fetch new releases.
@@ -546,7 +445,6 @@ export async function fetchAll(brand, type, {
     if (customResults) {
         return customResults;
     }
-
     let config = contentTypeConfig[type] ?? {};
     let additionalFields = config?.fields ?? [];
     let isGroupByOneToOne = (groupBy ? config?.relationships?.[groupBy]?.isOneToOne : false) ?? false;
@@ -564,7 +462,7 @@ export async function fetchAll(brand, type, {
     } else if(type === 'pack'){
         typeFilter = `&& (_type == 'pack' || _type == 'semester-pack')`;
     } else {
-        typeFilter = type ? `&& _type == '${type}'` : "";
+        typeFilter = type ? `&& _type == '${type}'` : progress === 'in progress' || progress === 'completed' ? " && (_type != 'challenge-part' && _type != 'challenge')" : "";  
     }
 
     // Construct the search filter
@@ -917,60 +815,6 @@ export async function fetchAllFilterOptions(
     return includeTabs ? {...results, tabs, catalogName} : results;
 }
 
-
-/**
- * Fetch children content by Railcontent ID.
- * @param {string} railcontentId - The Railcontent ID of the parent content.
- * @param {string} [contentType] - The content type the IDs to add needed fields to the response.
- * @returns {Promise<Array<Object>|null>} - The fetched children content data or [] if not found.
- */
-export async function fetchChildren(railcontentId, contentType) {
-    const query = `*[railcontent_id == ${railcontentId}]{
-        title,
-
-        'children': child[]->{
-                           ${getFieldsForContentType(contentType)}
-                        },
-      }[0..1]`;
-    let parent = await fetchSanity(query, false);
-    return parent['children'] ?? [];
-}
-
-/**
- *
- * @param railcontentId - railcontent id of the child
- * @returns {Promise<Array<string>|null>} - The fetched parent content data or [] if not found
- */
-export async function fetchParentByRailContentId(railcontentId) {
-    const query = `*[railcontent_id == ${railcontentId}]{
-        'parents': array::unique([
-            ...(*[references(^._id)]{
-                ${getFieldsForContentType()}
-                })
-            ])
-        }[0...1]`;
-    let child = await fetchSanity(query, false);
-    return child['parents'][0] ?? [];
-}
-
-/**
- * Fetch the Methods (learning-paths) for a specific brand.
- * @param {string} brand - The brand for which to fetch methods.
- * @returns {Promise<Object|null>} - The fetched methods data or null if not found.
- */
-export async function fetchMethods(brand) {
-    const query = `*[_type == 'learning-path' && brand == '${brand}'] {
-    parent_content_data,
-    "breadcrumbs_data": parent_content_data[] {
-        "id": id,
-        "title": *[railcontent_id == ^.id][0].title,
-        "url": *[railcontent_id == ^.id][0].web_url_path
-    } | order(length(url)),
-      ${getFieldsForContentType()}
-    } | order(published_on asc)`
-    return fetchSanity(query, true);
-}
-
 /**
  * Fetch the Foundations 2019.
  * @param {string} slug - The slug of the method.
@@ -1069,19 +913,6 @@ export async function fetchMethodChildren(railcontentId) {
     return fetchSanity(query, true);
 }
 
-/**
- * Fetch the next lesson for a specific method by Railcontent ID.
- * @param {string} railcontentId - The Railcontent ID of the current lesson.
- * @param {string} methodId - The RailcontentID of the method
- * @returns {Promise<Object|null>} - The fetched next lesson data or null if not found.
- */
-export async function fetchMethodNextLesson(railcontentId, methodId) {
-    const sortedChildren = await fetchMethodChildrenIds(methodId);
-    const index = sortedChildren.indexOf(railcontentId);
-    const childIndex = sortedChildren[index + 1];
-    return childIndex ? await fetchByRailContentId(childIndex) : null;
-}
-
 /**
  * Fetch the next lesson for a specific method by Railcontent ID.
  * @param {string} railcontentId - The Railcontent ID of the current lesson.
@@ -1302,30 +1133,6 @@ export async function fetchRelatedLessons(railContentId, brand) {
     return fetchSanity(query, false);
 }
 
-/**
- * Fetch related method lessons for a specific lesson by RailContent ID and type.
- * @param {string} railContentId - The RailContent ID of the current lesson.
- * @param {string} brand - The current brand.
- * @returns {Promise<Array<Object>|null>} - The fetched related lessons
- */
-export async function fetchRelatedMethodLessons(railContentId, brand) {
-    const query = `*[railcontent_id == ${railContentId} && brand == "${brand}"]{
-      "id":_id,
-      "related_lessons": *[references(^._id)][0].child[]->{
-        "id": railcontent_id,
-        "type": _type,
-        title,
-        "description": description[0].children[0].text, // Extraer texto plano
-        "thumbnail_url": thumbnail.asset->url,
-        "url": web_url_path,
-        difficulty,
-        difficulty_string,
-      }
-    }
-  }`
-    return fetchSanity(query, false);
-}
-
 /**
  * Fetch all packs.
  * @param {string} brand - The brand for which to fetch packs.
@@ -1415,20 +1222,6 @@ export async function fetchLiveEvent(brand) {
     return await fetchSanity(query, false, {processNeedAccess: false});
 }
 
-/**
- * Fetch all children of a specific pack by Railcontent ID.
- * @param {string} railcontentId - The Railcontent ID of the pack.
- * @returns {Promise<Array<Object>|null>} - The fetched pack children data or null if not found.
- *
- * @example
- * fetchPackChildren('pack123')
- *   .then(children => console.log(children))
- *   .catch(error => console.error(error));
- */
-export async function fetchPackChildren(railcontentId) {
-    return fetchChildren(railcontentId, 'pack-children');
-}
-
 /**
  * Fetch the data needed for the Pack Overview screen.
  * @param {number} id - The Railcontent ID of the pack
@@ -1446,24 +1239,6 @@ export async function fetchPackData(id) {
     return fetchSanity(query, false);
 }
 
-/**
- * Fetch the data needed for the Challenge Overview screen.
- * @param {string} id - The Railcontent ID of the course
- * @returns {Promise<Object|null>} - The challenge information and lessons or null if not found.
- *
- * @example
- * fetchChallengeOverview('challenge123')
- *   .then(challenge => console.log(challenge))
- *   .catch(error => console.error(error));
- */
-export async function fetchChallengeOverview(id) {
-    // WIP
-    const query = `*[railcontent_id == ${id}]{
-    ${getFieldsForContentType("challenge")}
-  } [0...1]`;
-    return fetchSanity(query, false);
-}
-
 /**
  * Fetch the data needed for the coach screen.
  * @param {string} brand - The brand for which to fetch coach lessons
@@ -1511,20 +1286,6 @@ export async function fetchCoachLessons(brand, id, {
     return fetchSanity(query, true);
 }
 
-/**
- * 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) {
-    return fetchByRailContentId(id, 'course');
-}
-
 /**
  * Fetch the data needed for the Course Overview screen.
  * @param {string} id - The Railcontent ID of the course
@@ -1780,26 +1541,6 @@ function populateHierarchyLookups(currentLevel, data, parentId) {
 
 }
 
-/**
- * Fetch assignments for content
- *
- * @param {integer} contentId - List of ids get data for
- * @returns {Promise<array|null>} - A promise that resolves to an array containing the data
- */
-export async function fetchAssignments(contentId) {
-    const fields = `"id": railcontent_id,"assignments":assignment[]{"id": railcontent_id}`;
-    const query = await buildQuery(`railcontent_id == ${contentId}`,
-        {bypassPermissions: true},
-        fields,
-        {end: 100});
-    let data = await fetchSanity(query, false);
-    let mapped = [];
-    data.assignments.forEach(function (content) {
-        mapped.push(content.id);
-    });
-    return mapped;
-}
-
 /**
  * Fetch data for comment mod page
  *
@@ -1949,32 +1690,6 @@ function doesUserNeedAccessToContent(result, userPermissions, isAdmin) {
     return true;
 }
 
-/**
- * Fetch CatalogueMetadata from Sanity. This information may be duplicated in the contentTypeConfig.js.
- * It's an ongoing discussion (Aug 2024), but it's been included here if necessary
- *
- * @param {string} contentType - name of the contentype to pull
- * @returns {Promise<Object|null>} - A promise that resolves to the fetched data or null if an error occurs or no results are found.
- *
- * @example
- *
- * fetchCatalogMetadata('song')
- *   .then(data => console.log(data))
- *   .catch(error => console.error(error));
- */
-export async function fetchCatalogMetadata(contentType) {
-    const query = `*[_type == 'CatalogMetadata']{
-        catalog_type,
-        brand,
-        groq_results,
-        groq_search_fields,
-        meta_data_groq,
-        modal_text,
-        sort_by,
-      }`
-    return fetchSanity(query, false, {processNeedAccess: false});
-}
-
 /**
  * Fetch shows data for a brand.
  *

package/test/sanityQueryService.test.js

@@ -2,7 +2,6 @@ import {getFieldsForContentType} from "../src/contentTypeConfig";
 const railContentModule = require('../src/services/railcontent.js')
 
 import {
-    fetchAssignments,
     fetchCommentModContentData,
     fetchMethodPreviousNextLesson,
     fetchSanity
@@ -17,9 +16,6 @@ const {
     fetchArtists,
     fetchSongArtistCount,
     fetchRelatedSongs,
-    fetchAllSongs,
-    fetchSongFilterOptions,
-    fetchSongCount,
     fetchNewReleases,
     fetchUpcomingEvents,
     fetchByRailContentId,
@@ -28,17 +24,12 @@ const {
     fetchAllOld,
     fetchAllFilterOptions,
     fetchFoundation,
-    fetchMethods,
     fetchMethod,
     fetchRelatedLessons,
     fetchAllPacks,
     fetchPackAll,
     fetchLessonContent,
-    fetchCourseOverview,
-    fetchChildren,
-    fetchParentByRailContentId,
     fetchLiveEvent,
-    fetchChallengeOverview,
     fetchCoachLessons,
     fetchByReference,
     fetchScheduledReleases,
@@ -110,14 +101,6 @@ describe('Sanity Queries', function () {
         expect(response.id).toBe(id);
     });
 
-    test('fetchChallengeOverview', async () => {
-        const id = 402197;
-        const response = await fetchChallengeOverview(id);
-        expect(response.lessons).toBeDefined();
-        expect(response.id).toBe(id);
-
-    });
-
     test('fetchByRailContentIds', async () => {
         const id = 380094;
         const id2 = 402204;
@@ -155,27 +138,6 @@ describe('Sanity Queries', function () {
         expect(response.id).toBe(id);
     });
 
-
-    test('fetchCourseOverview', async () => {
-        const id = 310414;
-        const response = await fetchCourseOverview(id);
-        expect(response.id).toBe(id);
-        expect(response.type).toBe('course');
-    });
-
-    test('fetchSongCount', async () => {
-        const response = await fetchSongCount('drumeo');
-        expect(response).toBeGreaterThan(1000);
-    });
-
-    test('fetchAllSongs', async () => {
-        const response = await fetchAllSongs('drumeo', {});
-        log(response);
-        expect(response.entity[0].soundslice).toBeDefined();
-        expect(response.entity[0].artist_name).toBeDefined();
-        expect(response.entity[0].instrumentless).toBeDefined();
-    });
-
     test('fetchAllSongsInProgress', async () => {
        var mock = jest.spyOn(dataContext, 'fetchData');
         var json = JSON.parse(`{"version":1,"config":{"key":1,"enabled":1,"checkInterval":1,"refreshInterval":2},"data":{"412941":{"s":"started","p":6,"t":20,"u":1731108082}}}`);
@@ -205,21 +167,6 @@ describe('Sanity Queries', function () {
     //     expect(response.entity[0].id).not.toBe(231622);
     // });
 
-    test('fetchSongFilterOptions', async () => {
-        const response = await fetchSongFilterOptions('drumeo', {});
-        log(response);
-        expect(response.genre).toBeDefined();
-        expect(response.difficulty).toBeDefined();
-    });
-
-    test('fetchAllSongsGroupByArtist', async () => {
-        const response = await fetchAllSongs('drumeo', {groupBy: "artist"});
-        expect(response.entity[0].lessons[0].soundslice).toBeDefined();
-        expect(response.entity[0].lessons[0].artist_name).toBeDefined();
-        expect(response.entity[0].lessons[0].instrumentless).toBeDefined();
-    }, 100000);
-
-
     test('fetchNewReleases', async () => {
         const response = await fetchNewReleases('drumeo');
         log(response);
@@ -361,29 +308,6 @@ describe('Sanity Queries', function () {
         )).toBe(true);
     }, 10000);
 
-    test('fetchChildren', async () => {
-        // complement test to fetchParentByRailContentId
-        const id = 191338; ////https://web-staging-one.musora.com/admin/studio/publishing/structure/play-along;play-along_191338
-        const expectedChildID = 191492;
-        const response = await fetchChildren(id);
-        log('num children', response.length);
-        log(response);
-
-        expect(response.length > 0).toBeTruthy();
-        const foundExpectedChild = response.some((child) => {
-            return child['id'] = expectedChildID;
-        });
-        expect(foundExpectedChild).toBeTruthy();
-    });
-
-    test('fetchParentByRailContentId', async () => {
-        // complement test to fetchChildren
-        const childId = 191492; // child of https://web-staging-one.musora.com/admin/studio/publishing/structure/play-along;play-along_191338
-        const expectedParent = 191338;
-        const response = await fetchParentByRailContentId(childId);
-        expect(response['id']).toBe(expectedParent);
-    });
-
     test('getSortOrder', () => {
         let sort = getSortOrder()
         expect(sort).toBe('published_on desc');
@@ -404,13 +328,6 @@ describe('Sanity Queries', function () {
         expect(response.levels.length).toBeGreaterThan(0);
     });
 
-    test('fetchMethods', async () => {
-        const response = await fetchMethods('drumeo');
-        log(response);
-        expect(response.length).toBeGreaterThan(0);
-        expect(response[0].type).toBe('learning-path');
-    });
-
     test('fetchAll-WithProgress', async () => {
         const ids = [410213, 410215];
         let response = await fetchAll('drumeo', 'song', {
@@ -571,16 +488,6 @@ describe('Sanity Queries', function () {
         expect(response.tabs.length).toBeGreaterThan(0);
     });
 
-    test('fetchChallengesV2Fields', async () => {
-        const id = 402197;
-        const response = await fetchChallengeOverview(id);
-        log(response);
-        expect(response.award).toBeDefined();
-        expect(response.award_custom_text).toBeDefined();
-        expect(response.lessons[0].is_always_unlocked_for_challenge).toBeDefined();
-        expect(response.lessons[0].is_bonus_content_for_challenge).toBeDefined();
-    });
-
     test('fetchShowsData-OddTimes', async () => {
         const response = await fetchShowsData('drumeo');
         log(response);
@@ -690,12 +597,6 @@ describe('Sanity Queries', function () {
         expect(data[241251].parentTitle).toBe("Gear");
         expect(data[241252].title).toBe("Setting Up Your Pedals & Throne");
     });
-
-    test('fetchAssignments', async()=>{
-        let data = await fetchAssignments(241250);
-        expect(data).toContain(241676);
-    });
-
 });
 
 describe('Filter Builder', function () {

package/.yarnrc.yml

@@ -1 +0,0 @@
-nodeLinker: node-modules