musora-content-services 1.3.2 → 1.3.5

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.3.5](https://github.com/railroadmedia/musora-content-services/compare/v1.3.4...v1.3.5) (2025-02-14)
+
+### [1.3.4](https://github.com/railroadmedia/musora-content-services/compare/v1.3.2...v1.3.4) (2025-02-14)
+
+### [1.3.3](https://github.com/railroadmedia/musora-content-services/compare/v1.3.2...v1.3.3) (2025-01-31)
+
 ### [1.3.2](https://github.com/railroadmedia/musora-content-services/compare/v1.3.1...v1.3.2) (2025-01-30)
 
 ### [1.3.1](https://github.com/railroadmedia/musora-content-services/compare/v1.3.0...v1.3.1) (2025-01-29)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musora-content-services",
-  "version": "1.3.2",
+  "version": "1.3.5",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "type": "module",

package/src/contentMetaData.js

@@ -266,6 +266,36 @@ const contentMetadata = {
     song: {
       sortBy: '-published_on',
     },
+    'song-tutorial': {
+      name: 'Song Tutorials',
+      thumbnailUrl: 'https://dpwjbsxqtam5n.cloudfront.net/shows/pianote/songs.jpg',
+      allowableFilters: ['difficulty', 'genre'],
+      sortBy: '-published_on',
+      shortname: 'song tutorials',
+      icon: 'play-progress',
+      description: '',
+      amountOfFutureLessonsToShow: 3,
+      showFutureLessonAtTopOrBottom: 'bottom',
+      tabs: [
+        {
+          name: 'Lessons',
+          short_name: 'Lessons',
+          value: '',
+        },
+        {
+          name: 'Artists',
+          short_name: 'ARTISTS',
+          is_group_by: true,
+          value: 'artist',
+        },
+        {
+          name: 'Genres',
+          short_name: 'Genres',
+          is_group_by: true,
+          value: 'genre',
+        },
+      ],
+    },
     'student-review': null,
     'student-focus': {
       name: 'Student Focus',
@@ -1013,6 +1043,36 @@ const contentMetadata = {
     song: {
       allowableFilters: ['difficulty', 'genre', 'lifestyle', 'instrumentless'],
     },
+    'song-tutorial': {
+      name: 'Song Tutorials',
+      thumbnailUrl: 'https://dpwjbsxqtam5n.cloudfront.net/shows/pianote/songs.jpg',
+      allowableFilters: ['difficulty', 'genre'],
+      sortBy: '-published_on',
+      shortname: 'song tutorials',
+      icon: 'play-progress',
+      description: '',
+      amountOfFutureLessonsToShow: 3,
+      showFutureLessonAtTopOrBottom: 'bottom',
+      tabs: [
+        {
+          name: 'Lessons',
+          short_name: 'Lessons',
+          value: '',
+        },
+        {
+          name: 'Artists',
+          short_name: 'ARTISTS',
+          is_group_by: true,
+          value: 'artist',
+        },
+        {
+          name: 'Genres',
+          short_name: 'Genres',
+          is_group_by: true,
+          value: 'genre',
+        },
+      ],
+    },
     'play-along': {
       name: 'Play Alongs',
       icon: 'icon-play-alongs',
@@ -1138,6 +1198,36 @@ const contentMetadata = {
       description:
         'Want feedback on your singing? Submit a video for student review. We will watch your submission and then provide helpful encouragement and feedback. This is a great way to build accountability and benefit from the expertise of our teachers.',
     },
+    'song-tutorial': {
+      name: 'Song Tutorials',
+      thumbnailUrl: 'https://dpwjbsxqtam5n.cloudfront.net/shows/pianote/songs.jpg',
+      allowableFilters: ['difficulty', 'genre'],
+      sortBy: '-published_on',
+      shortname: 'song tutorials',
+      icon: 'play-progress',
+      description: '',
+      amountOfFutureLessonsToShow: 3,
+      showFutureLessonAtTopOrBottom: 'bottom',
+      tabs: [
+        {
+          name: 'Lessons',
+          short_name: 'Lessons',
+          value: '',
+        },
+        {
+          name: 'Artists',
+          short_name: 'ARTISTS',
+          is_group_by: true,
+          value: 'artist',
+        },
+        {
+          name: 'Genres',
+          short_name: 'Genres',
+          is_group_by: true,
+          value: 'genre',
+        },
+      ],
+    },
     routine: {
       name: 'Routines',
       icon: 'icon-shows',

package/src/contentTypeConfig.js

@@ -26,6 +26,13 @@ export const DEFAULT_FIELDS = [
   'xp',
   'child_count',
 ]
+export const DEFAULT_CHILD_FIELDS = [
+  `"id": railcontent_id`,
+  `title`,
+  `"image": thumbnail.asset->url`,
+  `"instructors": instructor[]->name`,
+  `length_in_seconds`,
+]
 
 export const descriptionField = 'description[0].children[0].text'
 // this pulls both any defined resources for the document as well as any resources in the parent document
@@ -111,6 +118,14 @@ export const coachLessonsTypes = [
   'workout',
 ]
 
+export const childContentTypeConfig = {
+  'song-tutorial': [
+    `"genre": genre[]->name`,
+    `difficulty_string`,
+    `"type": _type`,
+  ]
+}
+
 export let contentTypeConfig = {
   song: {
     fields: ['album', 'soundslice', 'instrumentless', `"resources": ${resourcesField}`],
@@ -130,7 +145,9 @@ export let contentTypeConfig = {
                 "image": thumbnail.asset->url,
                 "instructors": instructor[]->name,
                 length_in_seconds,
+                web_url_path,
             }`,
+      '"instructors": instructor[]->name',
     ],
     relationships: {
       artist: {
@@ -560,6 +577,13 @@ export function getFieldsForContentType(contentType, asQueryString = true) {
   return asQueryString ? fields.toString() + ',' : fields
 }
 
+export function getChildFieldsForContentType(contentType, asQueryString = true) {
+  const fields = contentType
+    ? DEFAULT_CHILD_FIELDS.concat(childContentTypeConfig?.[contentType] ?? [])
+    : DEFAULT_CHILD_FIELDS
+  return asQueryString ? fields.toString() + ',' : fields
+}
+
 /**
  * Takes the included fields array and returns a string that can be used in a groq query.
  * @param {Array<string>} filters - An array of strings that represent applied filters. This should be in the format of a key,value array. eg. ['difficulty,Intermediate',
@@ -621,6 +645,9 @@ export function filtersToGroq(filters, selectedFilters = []) {
               return `instrumentless == ${value}`
             }
           } else if (key === 'difficulty' && !selectedFilters.includes(key)) {
+            if(value === 'Introductory'){
+              return `(difficulty_string == "Novice" || difficulty_string == "Introductory" )`
+            }
             return `difficulty_string == "${value}"`
           } else if (key === 'type' && !selectedFilters.includes(key)) {
             return `_type == "${value}"`

package/src/services/railcontent.js

@@ -493,7 +493,7 @@ export async function fetchChallengeUserActiveChallenges(brand = null) {
  */
 export async function fetchCarouselCardData(brand = null) {
   const brandParam = brand ? `?brand=${brand}` : ''
-  let url = `/api/v1/content/carousel${brandParam}`
+  let url = `/api/v2/content/carousel${brandParam}`
   return await fetchHandler(url, 'get')
 }
 

package/src/services/sanity.js

@@ -15,6 +15,7 @@ import {
   showsTypes,
   getNewReleasesTypes,
   coachLessonsTypes,
+  getChildFieldsForContentType,
 } from '../contentTypeConfig.js'
 
 import { processMetadata, typeWithSortOrder } from '../contentMetaData.js'
@@ -64,6 +65,68 @@ export async function fetchSongById(documentId) {
   return fetchSanity(query, false)
 }
 
+/**
+* fetches from Sanity all content marked for removal next quarter
+*
+* @string brand
+* @returns {Promise<Object|null>}
+*/
+export async function fetchQuarterRemoved(brand) {
+  const nextQuarter = getNextAndPreviousQuarterDates()['next'];
+  const filterString = `brand == '${brand}' && quarter_removed == '${nextQuarter}'`
+  const query = await buildQuery(filterString, {pullFutureContent: false, availableContentStatuses: ["published"]}, getFieldsForContentType(), {SortOrder: "published_on desc, id desc", end: 20});
+  return fetchSanity(query, false);
+}
+
+/**
+ * fetches from Sanity all content marked for publish next quarter
+ *
+ * @string brand
+ * @returns {Promise<Object|null>}
+ */
+export async function fetchQuarterPublished(brand) {
+  const nextQuarter = getNextAndPreviousQuarterDates()['next'];
+  const filterString = `brand == '${brand}' && quarter_published == '${nextQuarter}'`;
+  const query = await buildQuery(filterString, {pullFutureContent: true, availableContentStatuses: ["draft"]}, getFieldsForContentType(), {SortOrder: "published_on desc, id desc", end: 20});
+
+  return fetchSanity(query, false);
+}
+
+/**
+ * returns array of next and previous quarter dates as strings
+ *
+ * @returns {*[]}
+ */
+export function getNextAndPreviousQuarterDates() {
+  const january = 1;
+  const april = 4;
+  const july = 7;
+  const october = 10;
+  const month = new Date().getMonth();
+  let year = new Date().getFullYear();
+  let nextQuarter = '';
+  let prevQuarter = '';
+  if (month < april) {
+    nextQuarter = `${year}-0${april}-01`;
+    prevQuarter = `${year}-0${january}-01`;
+  } else if (month < july) {
+    nextQuarter = `${year}-0${july}-01`;
+    prevQuarter = `${year}-0${april}-01`;
+  } else if (month < october) {
+    nextQuarter = `${year}-${october}-01`;
+    prevQuarter = `${year}-0${july}-01`;
+  } else {
+    prevQuarter = `${year}-${october}-01`;
+    year++;
+    nextQuarter = `${year}-0${january}-01`;
+  }
+
+  let result = [];
+  result['next'] = nextQuarter;
+  result['previous'] = prevQuarter;
+  return result;
+}
+
 /**
  * Fetch all artists with lessons available for a specific brand.
  *
@@ -106,8 +169,20 @@ export async function fetchSongArtistCount(brand) {
   return fetchSanity(query, true, { processNeedAccess: false })
 }
 
-export async function fetchPlayAlongsCount(brand) {
-  const query = `count(*[brand == '${brand}' && _type == "play-along"]) `
+export async function fetchPlayAlongsCount(brand, {
+  searchTerm,
+  includedFields,
+  progressIds,
+  progress,
+}) {
+  const searchFilter = searchTerm ? `&& (artist->name match "${searchTerm}*" || instructor[]->name match "${searchTerm}*" || title match "${searchTerm}*" || name match "${searchTerm}*")` :'';
+
+  // Construct the included fields filter, replacing 'difficulty' with 'difficulty_string'
+  const includedFieldsFilter = includedFields.length > 0 ? filtersToGroq(includedFields) : ''
+
+  // limits the results to supplied progressIds for started & completed filters
+  const progressFilter = await getProgressFilter(progress, progressIds)
+  const query = `count(*[brand == '${brand}' && _type == "play-along" ${searchFilter} ${includedFieldsFilter} ${progressFilter} ]) `
   return fetchSanity(query, true, { processNeedAccess: false })
 }
 
@@ -329,16 +404,11 @@ export async function fetchScheduledReleases(brand, { page = 1, limit = 10 }) {
  */
 export async function fetchByRailContentId(id, contentType) {
   const fields = getFieldsForContentType(contentType)
+  const childFields = getChildFieldsForContentType(contentType)
   const childrenFilter = await new FilterBuilder(``, { isChildrenFilter: true }).buildFilter()
   const entityFieldsString = ` ${fields}
                                     'child_count': coalesce(count(child[${childrenFilter}]->), 0) ,
-                                    "lessons": child[${childrenFilter}]->{
-                                        "id": railcontent_id,
-                                        title,
-                                        "image": thumbnail.asset->url,
-                                        "instructors": instructor[]->name,
-                                        length_in_seconds,
-                                    },
+                                    "lessons": child[${childrenFilter}]->{${childFields}},
                                     'length_in_seconds': coalesce(
       math::sum(
         select(
@@ -1889,7 +1959,7 @@ function getFilterOptions(option, commonFilter, contentType, brand) {
       filterGroq = ` 
                 "difficulty": [
         {"type": "All", "count": count(*[${commonFilter} && difficulty_string == "All"])},
-        {"type": "Introductory", "count": count(*[${commonFilter} && difficulty_string == "Introductory"])},
+        {"type": "Introductory", "count": count(*[${commonFilter} && (difficulty_string == "Novice" || difficulty_string == "Introductory")])},
         {"type": "Beginner", "count": count(*[${commonFilter} && difficulty_string == "Beginner"])},
         {"type": "Intermediate", "count": count(*[${commonFilter} && difficulty_string == "Intermediate" ])},
         {"type": "Advanced", "count": count(*[${commonFilter} && difficulty_string == "Advanced" ])},

package/test/sanityQueryService.test.js

@@ -14,6 +14,8 @@ import { fetchOwnedChallenges } from '../src'
 const {
   fetchSongById,
   fetchArtists,
+  fetchQuarterPublished,
+  fetchQuarterRemoved,
   fetchSongArtistCount,
   fetchRelatedSongs,
   fetchNewReleases,
@@ -56,6 +58,17 @@ describe('Sanity Queries', function () {
     expect(response.id).toBe(id)
   })
 
+  test('fetchQuarterPublished', async () => {
+    const brand = 'guitareo'
+    const response = await fetchQuarterPublished(brand)
+  });
+
+  test('fetchQuarterRemoved', async () => {
+    const brand = 'guitareo'
+    const response = await fetchQuarterRemoved(brand)
+  });
+
+
   test('fetchArtists', async () => {
     const response = await fetchArtists('drumeo')
     const artistNames = response.map((x) => x.name)

package/.yarnrc.yml

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