musora-content-services 2.79.0 → 2.80.0

package/package.json

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

package/src/contentTypeConfig.js

@@ -81,8 +81,8 @@ export const playAlongMp3sField = `{
 `
 
 export const instructorField = `instructor[]->{
-            "id": railcontent_id,
             name,
+            slug,
             short_bio,
             "biography": short_bio[0].children[0].text,
             "coach_card_image": coach_card_image.asset->url,
@@ -278,7 +278,7 @@ export const getNextLessonLessonParentTypes = [
   'pack-bundle',
   'song-tutorial',
   'learning-path-v2',
-  'skill-pack'
+  'skill-pack',
 ]
 
 export const progressTypesMapping = {

package/src/index.d.ts

@@ -5,6 +5,24 @@ import {
 	initializeService
 } from './services/config.js';
 
+import {
+	fetchArtistBySlug,
+	fetchArtistLessons,
+	fetchArtists
+} from './services/content/artist.ts';
+
+import {
+	fetchGenreBySlug,
+	fetchGenreLessons,
+	fetchGenres
+} from './services/content/genre.ts';
+
+import {
+	fetchInstructorBySlug,
+	fetchInstructorLessons,
+	fetchInstructors
+} from './services/content/instructor.ts';
+
 import {
 	enrollUserInGuidedCourse,
 	fetchEnrollmentPageMetadata,
@@ -225,21 +243,18 @@ import {
 } from './services/recommendations.js';
 
 import {
+	buildEntityAndTotalQuery,
 	fetchAll,
 	fetchAllFilterOptions,
 	fetchAllPacks,
-	fetchArtistLessons,
-	fetchArtists,
 	fetchByRailContentId,
 	fetchByRailContentIds,
 	fetchByReference,
 	fetchChatAndLiveEnvent,
-	fetchCoachLessons,
 	fetchComingSoon,
 	fetchCommentModContentData,
 	fetchContentRows,
 	fetchFoundation,
-	fetchGenreLessons,
 	fetchHierarchy,
 	fetchLeaving,
 	fetchLessonContent,
@@ -274,6 +289,7 @@ import {
 	fetchTabData,
 	fetchTopLevelParentId,
 	fetchUpcomingEvents,
+	getSanityDate,
 	getSortOrder,
 	jumpToContinueContent
 } from './services/sanity.js';
@@ -406,6 +422,7 @@ declare module 'musora-content-services' {
 		assignModeratorToComment,
 		blockUser,
 		blockedUsers,
+		buildEntityAndTotalQuery,
 		buildImageSRC,
 		calculateLongestStreaks,
 		closeComment,
@@ -442,6 +459,7 @@ declare module 'musora-content-services' {
 		fetchAllCompletedStates,
 		fetchAllFilterOptions,
 		fetchAllPacks,
+		fetchArtistBySlug,
 		fetchArtistLessons,
 		fetchArtists,
 		fetchAwardsForUser,
@@ -452,7 +470,6 @@ declare module 'musora-content-services' {
 		fetchCertificate,
 		fetchChatAndLiveEnvent,
 		fetchChatSettings,
-		fetchCoachLessons,
 		fetchComingSoon,
 		fetchComment,
 		fetchCommentModContentData,
@@ -470,9 +487,14 @@ declare module 'musora-content-services' {
 		fetchFollowedThreads,
 		fetchForumCategories,
 		fetchFoundation,
+		fetchGenreBySlug,
 		fetchGenreLessons,
+		fetchGenres,
 		fetchHandler,
 		fetchHierarchy,
+		fetchInstructorBySlug,
+		fetchInstructorLessons,
+		fetchInstructors,
 		fetchInterests,
 		fetchLastInteractedChild,
 		fetchLatestThreads,
@@ -572,6 +594,7 @@ declare module 'musora-content-services' {
 		getRecommendedForYou,
 		getResumeTimeSeconds,
 		getResumeTimeSecondsByIds,
+		getSanityDate,
 		getScheduleContentRows,
 		getSortOrder,
 		getStartedOrCompletedProgressOnly,

package/src/index.js

@@ -5,6 +5,24 @@ import {
 	initializeService
 } from './services/config.js';
 
+import {
+	fetchArtistBySlug,
+	fetchArtistLessons,
+	fetchArtists
+} from './services/content/artist.ts';
+
+import {
+	fetchGenreBySlug,
+	fetchGenreLessons,
+	fetchGenres
+} from './services/content/genre.ts';
+
+import {
+	fetchInstructorBySlug,
+	fetchInstructorLessons,
+	fetchInstructors
+} from './services/content/instructor.ts';
+
 import {
 	enrollUserInGuidedCourse,
 	fetchEnrollmentPageMetadata,
@@ -225,21 +243,18 @@ import {
 } from './services/recommendations.js';
 
 import {
+	buildEntityAndTotalQuery,
 	fetchAll,
 	fetchAllFilterOptions,
 	fetchAllPacks,
-	fetchArtistLessons,
-	fetchArtists,
 	fetchByRailContentId,
 	fetchByRailContentIds,
 	fetchByReference,
 	fetchChatAndLiveEnvent,
-	fetchCoachLessons,
 	fetchComingSoon,
 	fetchCommentModContentData,
 	fetchContentRows,
 	fetchFoundation,
-	fetchGenreLessons,
 	fetchHierarchy,
 	fetchLeaving,
 	fetchLessonContent,
@@ -274,6 +289,7 @@ import {
 	fetchTabData,
 	fetchTopLevelParentId,
 	fetchUpcomingEvents,
+	getSanityDate,
 	getSortOrder,
 	jumpToContinueContent
 } from './services/sanity.js';
@@ -405,6 +421,7 @@ export {
 	assignModeratorToComment,
 	blockUser,
 	blockedUsers,
+	buildEntityAndTotalQuery,
 	buildImageSRC,
 	calculateLongestStreaks,
 	closeComment,
@@ -441,6 +458,7 @@ export {
 	fetchAllCompletedStates,
 	fetchAllFilterOptions,
 	fetchAllPacks,
+	fetchArtistBySlug,
 	fetchArtistLessons,
 	fetchArtists,
 	fetchAwardsForUser,
@@ -451,7 +469,6 @@ export {
 	fetchCertificate,
 	fetchChatAndLiveEnvent,
 	fetchChatSettings,
-	fetchCoachLessons,
 	fetchComingSoon,
 	fetchComment,
 	fetchCommentModContentData,
@@ -469,9 +486,14 @@ export {
 	fetchFollowedThreads,
 	fetchForumCategories,
 	fetchFoundation,
+	fetchGenreBySlug,
 	fetchGenreLessons,
+	fetchGenres,
 	fetchHandler,
 	fetchHierarchy,
+	fetchInstructorBySlug,
+	fetchInstructorLessons,
+	fetchInstructors,
 	fetchInterests,
 	fetchLastInteractedChild,
 	fetchLatestThreads,
@@ -571,6 +593,7 @@ export {
 	getRecommendedForYou,
 	getResumeTimeSeconds,
 	getResumeTimeSecondsByIds,
+	getSanityDate,
 	getScheduleContentRows,
 	getSortOrder,
 	getStartedOrCompletedProgressOnly,

package/src/services/content/artist.ts

@@ -0,0 +1,139 @@
+/**
+ * @module Artist
+ */
+import { DEFAULT_FIELDS, filtersToGroq } from '../../contentTypeConfig.js'
+import { FilterBuilder } from '../../filterBuilder.js'
+import { fetchSanity, getSanityDate, getSortOrder } from '../sanity.js'
+import { Lesson } from './content'
+
+export interface Artist {
+  slug: string
+  name: string
+  lessons?: Lesson[]
+  lessonsCount: number
+}
+
+/**
+ * Fetch all artists with lessons available for a specific brand.
+ *
+ * @param {string} brand - The brand for which to fetch artists.
+ * @returns {Promise<Artist[]|null>} - A promise that resolves to an array of artist objects or null if not found.
+ *
+ * @example
+ * fetchArtists('drumeo')
+ *   .then(artists => console.log(artists))
+ *   .catch(error => console.error(error));
+ */
+export async function fetchArtists(brand: string): Promise<Artist[] | null> {
+  const filter = await new FilterBuilder(
+    `_type == "song" && brand == "${brand}" && references(^._id)`,
+    { bypassPermissions: true }
+  ).buildFilter()
+  const query = `
+  *[_type == "artist"]{
+    name,
+    "slug": slug.current,
+    "lessonsCount": count(*[${filter}])
+  }[lessonsCount > 0] |order(lower(name)) `
+  return fetchSanity(query, true, { processNeedAccess: false, processPageType: false })
+}
+
+/**
+ * Fetch a single artist by their Sanity ID.
+ *
+ * @param {string} slug - The name of the artist to fetch.
+ * @param {string} [brand] - The brand for which to fetch the artist.
+ * @returns {Promise<Artist|null>} - A promise that resolves to an artist objects or null if not found.
+ *
+ * @example
+ * fetchArtists('drumeo')
+ *   .then(artists => console.log(artists))
+ *   .catch(error => console.error(error));
+ */
+export async function fetchArtistBySlug(slug: string, brand?: string): Promise<Artist | null> {
+  const brandFilter = brand ? `brand == "${brand}" && ` : ''
+  const filter = await new FilterBuilder(`${brandFilter} _type == "song" && references(^._id)`, {
+    bypassPermissions: true,
+  }).buildFilter()
+  const query = `
+  *[_type == "artist" && slug.current == '${slug}']{
+    name,
+    "slug": slug.current,
+    "lessonsCount": count(*[${filter}])
+  }[lessonsCount > 0] |order(lower(name)) `
+  return fetchSanity(query, true, { processNeedAccess: false, processPageType: false })
+}
+
+export interface ArtistLessonOptions {
+  sort?: string
+  searchTerm?: string
+  page?: number
+  limit?: number
+  includedFields?: Array<string>
+  progressIds?: Array<number>
+}
+
+export interface LessonsByArtistResponse {
+  entity: Artist[]
+}
+
+/**
+ * Fetch the artist's lessons.
+ * @param {string} brand - The brand for which to fetch lessons.
+ * @param {string} slug - The slug of the artist
+ * @param {string} contentType - The type of the lessons we need to get from the artist. If not defined, groq will get lessons from all content types
+ * @param {Object} params - Parameters for sorting, searching, pagination and filtering.
+ * @param {string} [params.sort="-published_on"] - The field to sort the lessons by.
+ * @param {string} [params.searchTerm=""] - The search term to filter the lessons.
+ * @param {number} [params.page=1] - The page number for pagination.
+ * @param {number} [params.limit=10] - The number of items per page.
+ * @param {Array<string>} [params.includedFields=[]] - Additional filters to apply to the query in the format of a key,value array. eg. ['difficulty,Intermediate', 'genre,rock'].
+ * @param {Array<number>} [params.progressIds] - The ids of the lessons that are in progress or completed
+ * @returns {Promise<LessonsByArtistResponse|null>} - The lessons for the artist and some details about the artist (name and thumbnail).
+ *
+ * @example
+ * fetchArtistLessons('drumeo', '10 Years', 'song', {'-published_on', '', 1, 10, ["difficulty,Intermediate"], [232168, 232824, 303375, 232194, 393125]})
+ *   .then(lessons => console.log(lessons))
+ *   .catch(error => console.error(error));
+ */
+export async function fetchArtistLessons(
+  brand: string,
+  slug: string,
+  contentType: string,
+  {
+    sort = '-published_on',
+    searchTerm = '',
+    page = 1,
+    limit = 10,
+    includedFields = [],
+    progressIds = undefined,
+  }: ArtistLessonOptions = {}
+): Promise<LessonsByArtistResponse | null> {
+  const fieldsString = DEFAULT_FIELDS.join(',')
+  const start = (page - 1) * limit
+  const end = start + limit
+  const searchFilter = searchTerm ? `&& title match "${searchTerm}*"` : ''
+  const sortOrder = getSortOrder(sort, brand)
+  const addType =
+    contentType && Array.isArray(contentType)
+      ? `_type in ['${contentType.join("', '")}'] &&`
+      : contentType
+        ? `_type == '${contentType}' && `
+        : ''
+  const includedFieldsFilter = includedFields.length > 0 ? filtersToGroq(includedFields) : ''
+
+  // limits the results to supplied progressIds for started & completed filters
+  const progressFilter =
+    progressIds !== undefined ? `&& railcontent_id in [${progressIds.join(',')}]` : ''
+  const now = getSanityDate(new Date())
+  const query = `{
+    "entity":
+      *[_type == 'artist' && slug.current == '${slug}']
+        {'type': _type, name, 'thumbnail':thumbnail_url.asset->url,
+        'lessons_count': count(*[${addType} brand == '${brand}' && references(^._id)]),
+        'lessons': *[${addType} brand == '${brand}' && references(^._id) && (status in ['published'] || (status == 'scheduled' && defined(published_on) && published_on >= '${now}')) ${searchFilter} ${includedFieldsFilter} ${progressFilter}]{${fieldsString}}
+      [${start}...${end}]}
+      |order(${sortOrder})
+  }`
+  return fetchSanity(query, true)
+}

package/src/services/content/content.ts

@@ -0,0 +1,38 @@
+/**
+ * @namespace Content
+ * @property {module:Instructor} Instructor
+ * @property {module:Genre} Genre
+ * @property {module:Artist} Artist
+ */
+
+export type LessonType = 'workout' | 'challenge-part' | 'song' | string
+export type LessonPageType = 'lesson' | 'song' | string
+
+export interface ArtistObject {
+  name: string
+  thumbnail: string | null
+}
+
+export interface Lesson {
+  artist: ArtistObject | string | null
+  artist_name: string
+  brand: string
+  child_count: number | null
+  difficulty: number | null
+  difficulty_string: string | null
+  genre: string[] | string | null
+  id: number
+  image: string
+  length_in_seconds: number
+  parent_id: number | null
+  permission_id: number[]
+  published_on: string
+  sanity_id: string
+  slug: string
+  status: string
+  thumbnail: string
+  title: string
+  type: LessonType
+  need_access: boolean
+  page_type: LessonPageType
+}

package/src/services/content/genre.ts

@@ -0,0 +1,139 @@
+/**
+ * @module Genre
+ */
+import { DEFAULT_FIELDS, filtersToGroq } from '../../contentTypeConfig.js'
+import { fetchSanity, getSanityDate, getSortOrder } from '../sanity.js'
+import { FilterBuilder } from '../../filterBuilder.js'
+import { Lesson } from './content'
+
+export interface Genre {
+  lessons?: Lesson[]
+  lessons_count: number
+  name: string
+  slug: string
+  thumbnail: string
+  type: 'genre'
+}
+
+/**
+ * Fetch all genres with lessons available for a specific brand.
+ *
+ * @param {string} [brand] - The brand for which to fetch the genre for. Lesson count will be filtered by this brand if provided.
+ * @returns {Promise<Genre[]>} - A promise that resolves to an genre object or null if not found.
+ *
+ * @example
+ * fetchGenres('drumeo')
+ *   .then(genres => console.log(genres))
+ *   .catch(error => console.error(error));
+ */
+export async function fetchGenres(brand: string): Promise<Genre[]> {
+  const filter = await new FilterBuilder(`brand == "${brand}" && references(^._id)`, {
+    bypassPermissions: true,
+  }).buildFilter()
+
+  const query = `
+  *[_type == 'genre'] {
+    'type': _type,
+    name,
+    "slug": slug.current,
+    'thumbnail': thumbnail_url.asset->url,
+    "lessons_count": count(*[${filter}])
+  } |order(lower(name)) `
+  return fetchSanity(query, true, { processNeedAccess: false, processPageType: false})
+}
+
+/**
+ * Fetch a single genre by their slug and brand
+ *
+ * @param {string} slug - The slug of the genre to fetch.
+ * @param {string} [brand] - The brand for which to fetch the genre. Lesson count will be filtered by this brand if provided.
+ * @returns {Promise<Genre[]|null>} - A promise that resolves to an genre object or null if not found.
+ *
+ * @example
+ * fetchGenreBySlug('drumeo')
+ *   .then(genres => console.log(genres))
+ *   .catch(error => console.error(error));
+ */
+export async function fetchGenreBySlug(slug: string, brand?: string): Promise<Genre | null> {
+  const brandFilter = brand ? `brand == "${brand}" && ` : ''
+  const filter = await new FilterBuilder(`${brandFilter} references(^._id)`, {
+    bypassPermissions: true,
+  }).buildFilter()
+
+  const query = `
+  *[_type == 'genre' && slug.current == '${slug}'] {
+    'type': _type, name,
+    name,
+    "slug": slug.current,
+    'thumbnail':thumbnail_url.asset->url,
+    "lessonsCount": count(*[${filter}])
+  }`
+  return fetchSanity(query, true, { processNeedAccess: false, processPageType: false})
+}
+
+export interface FetchGenreLessonsOptions {
+  sort?: string
+  searchTerm?: string
+  page?: number
+  limit?: number
+  includedFields?: Array<string>
+  progressIds?: Array<number>
+}
+
+export interface LessonsByGenreResponse {
+  entity: Genre[]
+}
+
+/**
+ * Fetch the genre's lessons.
+ * @param {string} brand - The brand for which to fetch lessons.
+ * @param {string} slug - The slug of the genre
+ * @param {Object} params - Parameters for sorting, searching, pagination and filtering.
+ * @param {string} [params.sort="-published_on"] - The field to sort the lessons by.
+ * @param {string} [params.searchTerm=""] - The search term to filter the lessons.
+ * @param {number} [params.page=1] - The page number for pagination.
+ * @param {number} [params.limit=10] - The number of items per page.
+ * @param {Array<string>} [params.includedFields=[]] - Additional filters to apply to the query in the format of a key,value array. eg. ['difficulty,Intermediate', 'genre,rock'].
+ * @param {Array<number>} [params.progressIds=[]] - The ids of the lessons that are in progress or completed
+ * @returns {Promise<LessonsByGenreResponse>} - The lessons for the artist and some details about the artist (name and thumbnail).
+ *
+ * @example
+ * fetchGenreLessons('drumeo', 'Blues', 'song', {'-published_on', '', 1, 10, ["difficulty,Intermediate"], [232168, 232824, 303375, 232194, 393125]})
+ *   .then(lessons => console.log(lessons))
+ *   .catch(error => console.error(error));
+ */
+export async function fetchGenreLessons(
+  brand: string,
+  slug: string,
+  contentType: string,
+  {
+    sort = '-published_on',
+    searchTerm = '',
+    page = 1,
+    limit = 10,
+    includedFields = [],
+    progressIds = [],
+  }: FetchGenreLessonsOptions = {}
+): Promise<LessonsByGenreResponse> {
+  const fieldsString = DEFAULT_FIELDS.join(',')
+  const start = (page - 1) * limit
+  const end = start + limit
+  const searchFilter = searchTerm ? `&& title match "${searchTerm}*"` : ''
+  const sortOrder = getSortOrder(sort, brand)
+  const addType = contentType ? `_type == '${contentType}' && ` : ''
+  const includedFieldsFilter = includedFields.length > 0 ? filtersToGroq(includedFields) : ''
+  // limits the results to supplied progressIds for started & completed filters
+  const progressFilter =
+    progressIds !== undefined ? `&& railcontent_id in [${progressIds.join(',')}]` : ''
+  const now = getSanityDate(new Date())
+  const query = `{
+    "entity":
+      *[_type == 'genre' && slug.current == '${slug}']
+        {'type': _type, name, 'thumbnail':thumbnail_url.asset->url,
+        'lessons_count': count(*[${addType} brand == '${brand}' && references(^._id)]),
+        'lessons': *[${addType} brand == '${brand}' && references(^._id) && (status in ['published'] || (status == 'scheduled' && defined(published_on) && published_on >= '${now}')) ${searchFilter} ${includedFieldsFilter} ${progressFilter}]{${fieldsString}}
+      [${start}...${end}]}
+      |order(${sortOrder})
+  }`
+  return fetchSanity(query, true)
+}