musora-content-services 1.0.133 → 1.0.134

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.134](https://github.com/railroadmedia/musora-content-services/compare/v1.0.133...v1.0.134) (2024-10-11)
+
 ### [1.0.133](https://github.com/railroadmedia/musora-content-services/compare/v1.0.132...v1.0.133) (2024-10-10)
 
 ### [1.0.132](https://github.com/railroadmedia/musora-content-services/compare/v1.0.131...v1.0.132) (2024-10-10)

package/package.json

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

package/src/services/sanity.js

@@ -1214,10 +1214,17 @@ export async function fetchByReference(brand, {
  * @param {string} brand - The brand for which to fetch lessons.
  * @param {string} name - The name 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<Object|null>} - The lessons for the artist and some details about the artist (name and thumbnail).
  *
  * @example
- * fetchArtistLessons('10 Years', 'song')
+ * 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));
  */
@@ -1227,7 +1234,9 @@ export async function fetchArtistLessons(brand, name, contentType, {
   page = 1,
   limit = 10,
   includedFields = [],
+  progressIds = undefined,
 } = {}) {
+
   const fieldsString = DEFAULT_FIELDS.join(',');
   const start = (page - 1) * limit;
   const end = start + limit;
@@ -1238,12 +1247,15 @@ export async function fetchArtistLessons(brand, name, contentType, {
   ? filtersToGroq(includedFields)
   : "";
 
+  // limits the results to supplied progressIds for started & completed filters
+  const progressFilter = progressIds !== undefined ? `&& railcontent_id in [${progressIds.join(',')}]` : "";
+
   const query = `{
     "entity": 
       *[_type == 'artist' && name == '${name}']
         {'type': _type, name, 'thumbnail_url':thumbnail_url.asset->url, 
         'lessons_count': count(*[${addType} brand == '${brand}' && references(^._id)]), 
-        'lessons': *[${addType} brand == '${brand}' && references(^._id) ${searchFilter} ${includedFieldsFilter}]{${fieldsString}}
+        'lessons': *[${addType} brand == '${brand}' && references(^._id) ${searchFilter} ${includedFieldsFilter} ${progressFilter}]{${fieldsString}}
       [${start}...${end}]}
       |order(${sortOrder})
   }`;
@@ -1254,11 +1266,17 @@ export async function fetchArtistLessons(brand, name, contentType, {
  * Fetch the genre's lessons.
  * @param {string} brand - The brand for which to fetch lessons.
  * @param {string} name - The name of the genre
- * @param {string} contentType - The type of the lessons we need to get from the genre. If not defined, groq will get lessons from all content types
- * @returns {Promise<Object|null>} - The lessons for the genre and some details about the genre (name and thumbnail).
+ * @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<Object|null>} - The lessons for the artist and some details about the artist (name and thumbnail).
  *
  * @example
- * fetchGenreLessons('Blues', 'song')
+ * 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));
  */
@@ -1268,6 +1286,7 @@ export async function fetchGenreLessons(brand, name, contentType, {
   page = 1,
   limit = 10,
   includedFields = [],
+  progressIds = undefined,
 } = {}) {
   const fieldsString = DEFAULT_FIELDS.join(',');
   const start = (page - 1) * limit;
@@ -1278,13 +1297,15 @@ export async function fetchGenreLessons(brand, name, 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 query = `{
     "entity": 
       *[_type == 'genre' && name == '${name}']
         {'type': _type, name, 'thumbnail_url':thumbnail_url.asset->url, 
         'lessons_count': count(*[${addType} brand == '${brand}' && references(^._id)]), 
-        'lessons': *[${addType} brand == '${brand}' && references(^._id) ${searchFilter} ${includedFieldsFilter}]{${fieldsString}}
+        'lessons': *[${addType} brand == '${brand}' && references(^._id) ${searchFilter} ${includedFieldsFilter} ${progressFilter}]{${fieldsString}}
       [${start}...${end}]}
       |order(${sortOrder})
   }`;