musora-content-services 1.2.0 → 1.2.2

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 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.2.2](https://github.com/railroadmedia/musora-content-services/compare/v1.2.1...v1.2.2) (2025-01-16)
+
+### [1.2.1](https://github.com/railroadmedia/musora-content-services/compare/v1.2.0...v1.2.1) (2025-01-16)
+
 ## [1.2.0](https://github.com/railroadmedia/musora-content-services/compare/v1.0.233...v1.2.0) (2025-01-14)
 
 

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "musora-content-services",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "type": "module",
   "scripts": {
-    "build-index": "node tools/generate-index.js",
+    "build-index": "node tools/generate-index.cjs",
     "release": "standard-version",
     "doc": "jsdoc -c jsdoc.json --verbose",
     "test": "jest --setupFiles dotenv/config"

package/src/filterBuilder.js

@@ -22,7 +22,8 @@ export class FilterBuilder {
             bypassStatuses = false,
             bypassPublishedDateRestriction = false,
             isSingle = false,
-            allowsPullSongsContent = true
+            allowsPullSongsContent = true,
+            isChildrenFilter = false
         } = {}) {
         this.availableContentStatuses = availableContentStatuses;
         this.bypassPermissions = bypassPermissions;
@@ -36,6 +37,7 @@ export class FilterBuilder {
         this.filter = filter;
         // this.debug = process.env.DEBUG === 'true' || false;
         this.debug = false;
+        this.prefix =  isChildrenFilter ? '@->' : '';
     }
 
 
@@ -81,10 +83,10 @@ export class FilterBuilder {
             const now = new Date().toISOString();
             let statuses = [...this.availableContentStatuses];
             statuses.splice(statuses.indexOf(this.STATUS_SCHEDULED), 1);
-            this._andWhere(`(status in ${arrayToStringRepresentation(statuses)} || (status == '${this.STATUS_SCHEDULED}' && defined(published_on) && published_on >= '${now}'))`)
+            this._andWhere(`(${this.prefix}status in ${arrayToStringRepresentation(statuses)} || (${this.prefix}status == '${this.STATUS_SCHEDULED}' && defined(${this.prefix}published_on) && ${this.prefix}published_on >= '${now}'))`)
 
         } else {
-            this._andWhere(`status in ${arrayToStringRepresentation(this.availableContentStatuses)}`);
+            this._andWhere(`${this.prefix}status in ${arrayToStringRepresentation(this.availableContentStatuses)}`);
         }
         return this;
     }
@@ -117,9 +119,9 @@ export class FilterBuilder {
         now = roundedDate.toISOString();
 
         if (this.getFutureContentOnly) {
-            this._andWhere(`published_on >= '${now}'`);
+            this._andWhere(`${this.prefix}published_on >= '${now}'`);
         } else if (!this.pullFutureContent) {
-            this._andWhere(`published_on <= '${now}'`);
+            this._andWhere(`${this.prefix}published_on <= '${now}'`);
         } else {
             // const date = new Date();
             // const theFuture = new Date(date.setMonth(date.getMonth() + 18));

package/src/index.d.ts

@@ -1,7 +1,6 @@
 /*** This file was generated automatically. To recreate, please run `npm run build-index`. ***/
 
 import {
-	globalConfig,
 	initializeService
 } from './services/config.js';
 
@@ -79,6 +78,7 @@ import {
 	postContentUnliked,
 	postRecordWatchSession,
 	reportPlaylist,
+	setStudentViewForUser,
 	unpinPlaylist,
 	updatePlaylist,
 	updatePlaylistItem
@@ -243,7 +243,6 @@ declare module 'musora-content-services' {
 		getProgressStateByIds,
 		getResumeTimeSeconds,
 		getSortOrder,
-		globalConfig,
 		initializeService,
 		isContentLiked,
 		jumpToContinueContent,
@@ -268,6 +267,7 @@ declare module 'musora-content-services' {
 		recordWatchSession,
 		reportPlaylist,
 		reset,
+		setStudentViewForUser,
 		unlikeContent,
 		unpinPlaylist,
 		updatePlaylist,

package/src/index.js

@@ -1,7 +1,6 @@
 /*** This file was generated automatically. To recreate, please run `npm run build-index`. ***/
 
 import {
-	globalConfig,
 	initializeService
 } from './services/config.js';
 
@@ -79,6 +78,7 @@ import {
 	postContentUnliked,
 	postRecordWatchSession,
 	reportPlaylist,
+	setStudentViewForUser,
 	unpinPlaylist,
 	updatePlaylist,
 	updatePlaylistItem
@@ -242,7 +242,6 @@ export {
 	getProgressStateByIds,
 	getResumeTimeSeconds,
 	getSortOrder,
-	globalConfig,
 	initializeService,
 	isContentLiked,
 	jumpToContinueContent,
@@ -267,6 +266,7 @@ export {
 	recordWatchSession,
 	reportPlaylist,
 	reset,
+	setStudentViewForUser,
 	unlikeContent,
 	unpinPlaylist,
 	updatePlaylist,

package/src/services/railcontent.js

@@ -289,6 +289,9 @@ async function postDataHandler(url, data) {
     return fetchHandler(url, 'post', null, data);
 }
 
+async function patchDataHandler(url, data) {
+    return fetchHandler(url, 'patch', null, data);}
+
 export async function fetchHandler(url, method = "get", dataVersion = null, body = null) {
     let headers = {
         'Content-Type': 'application/json',
@@ -1178,6 +1181,19 @@ export async function playback(playlistId) {
     return await fetchHandler(url, "GET");
 }
 
+/**
+ * Set a user's StudentView Flag
+ *
+ * @param {int|string} userId - id of the user (must be currently authenticated)
+ * @param {bool} enable - truthsy value to enable student view
+ * @returns {Promise<any|null>}
+ */
+export async function setStudentViewForUser(userId, enable) {
+    let url = `/user-management-system/user/update/${userId}`;
+    let data = {'use_student_view' : enable ? 1 : 0};
+    return await patchDataHandler(url, data);
+}
+
 function fetchAbsolute(url, params) {
     if (globalConfig.railcontentConfig.authToken) {
         params.headers['Authorization'] = `Bearer ${globalConfig.railcontentConfig.authToken}`;

package/src/services/sanity.js

@@ -422,10 +422,29 @@ export async function fetchScheduledReleases(brand, {page = 1, limit = 10}) {
  *   .catch(error => console.error(error));
  */
 export async function fetchByRailContentId(id, contentType) {
+    const fields = getFieldsForContentType(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,
+                                    },
+                                    'length_in_seconds': coalesce(
+      math::sum(
+        select(
+          child[${childrenFilter}]->length_in_seconds
+        )
+      ),
+      length_in_seconds
+    ),`;
 
     const query = buildRawQuery(
         `railcontent_id == ${id} && _type == '${contentType}'`,
-        getFieldsForContentType(contentType),
+        entityFieldsString,
         {
             isSingle: true,
         },
@@ -595,6 +614,8 @@ export async function fetchAll(brand, type, {
         `;
         filter = `_type == '${groupBy}' && count(*[${lessonsFilterWithRestrictions}]._id) > 0`;
     } else if (groupBy !== "") {
+        const childrenFilter = await new FilterBuilder(``, {isChildrenFilter: true} ).buildFilter();
+
         const webUrlPath = (groupBy == 'genre') ? '/genres' : '';
         const lessonsFilter = `brand == '${brand}' && ^._id in ${groupBy}[]._ref ${typeFilter} ${searchFilter} ${includedFieldsFilter} ${progressFilter} ${customFilter}`;
         const lessonsFilterWithRestrictions = await new FilterBuilder(lessonsFilter).buildFilter();
@@ -608,12 +629,23 @@ export async function fetchAll(brand, type, {
                 'all_lessons_count': count(*[${lessonsFilterWithRestrictions}]._id),
                 'lessons': *[${lessonsFilterWithRestrictions}]{
                     ${fieldsString},
+                     'lesson_count': coalesce(count(child[${childrenFilter}]->), 0) ,
                     ${groupBy}
                 }[0...20]`;
         filter = `_type == '${groupBy}' && count(*[${lessonsFilterWithRestrictions}]._id) > 0`;
     } else {
         filter = `brand == "${brand}" ${typeFilter} ${searchFilter} ${includedFieldsFilter} ${progressFilter} ${customFilter}`
-        entityFieldsString = fieldsString;
+        const childrenFilter = await new FilterBuilder(``, {isChildrenFilter: true} ).buildFilter();
+        entityFieldsString = ` ${fieldsString},
+                                    'lesson_count': coalesce(count(child[${childrenFilter}]->), 0) ,
+                                    'length_in_seconds': coalesce(
+      math::sum(
+        select(
+          child[${childrenFilter}]->length_in_seconds
+        )
+      ),
+      length_in_seconds
+    ),`;
     }
 
     const filterWithRestrictions = await new FilterBuilder(filter, {
@@ -965,6 +997,8 @@ export async function fetchFoundation(slug) {
  * @returns {Promise<Object|null>} - The fetched methods data or null if not found.
  */
 export async function fetchMethod(brand, slug) {
+    const childrenFilter = await new FilterBuilder(``, {isChildrenFilter: true} ).buildFilter();
+
     const query = `*[_type == 'learning-path' && brand == "${brand}" && slug.current == "${slug}"] {
     "description": ${descriptionField},
     "instructors":instructor[]->name,
@@ -984,7 +1018,7 @@ export async function fetchMethod(brand, slug) {
     } | order(length(url)),
     "type": _type,
     "permission_id": permission[]->railcontent_id,
-    "levels": child[]->
+    "levels": child[${childrenFilter}]->
       {
         "id": railcontent_id,
         published_on,
@@ -1011,8 +1045,10 @@ export async function fetchMethod(brand, slug) {
  * @returns {Promise<Object|null>} - The fetched next lesson data or null if not found.
  */
 export async function fetchMethodChildren(railcontentId) {
+    const childrenFilter = await new FilterBuilder(``, {isChildrenFilter: true} ).buildFilter();
+
     const query = `*[railcontent_id == ${railcontentId}]{
-    child_count,
+    "child_count":coalesce(count(child[${childrenFilter}]->), 0),
     "id": railcontent_id,
     "description": ${descriptionField},
     "thumbnail_url": thumbnail.asset->url,
@@ -1026,7 +1062,7 @@ export async function fetchMethodChildren(railcontentId) {
         "title": *[railcontent_id == ^.id][0].title,
         "url": *[railcontent_id == ^.id][0].web_url_path
     } | order(length(url)),
-    'children': child[]->{
+    'children': child[(${childrenFilter})]->{
         ${getFieldsForContentType('method')}
     },
   }[0..1]`;
@@ -1080,14 +1116,16 @@ export async function fetchMethodPreviousNextLesson(railcontentId, methodId) {
  * @returns {Promise<Array<Object>|null>} - The fetched children data or null if not found.
  */
 export async function fetchMethodChildrenIds(railcontentId) {
+    const childrenFilter = await new FilterBuilder(``, {isChildrenFilter: true} ).buildFilter();
+
     const query = `*[ railcontent_id == ${railcontentId}]{
-    'children': child[]-> {
+    'children': child[${childrenFilter}]-> {
         'id': railcontent_id,
         'type' : _type,
-            'children': child[]-> {
+            'children': child[${childrenFilter}]-> {
                 'id': railcontent_id,
                 'type' : _type,
-                    'children': child[]-> {
+                    'children': child[${childrenFilter}]-> {
                         'id': railcontent_id,
                         'type' : _type,
             }
@@ -1249,11 +1287,12 @@ export async function fetchRelatedLessons(railContentId, brand) {
     const filterSongSameArtist = await new FilterBuilder(`_type=="song" && _type==^._type && brand == "${brand}" && references(^.artist->_id) && railcontent_id !=${railContentId}`).buildFilter();
     const filterSongSameGenre = await new FilterBuilder(`_type=="song" && _type==^._type && brand == "${brand}" && references(^.genre[]->_id) && railcontent_id !=${railContentId}`).buildFilter();
     const filterNeighbouringSiblings = await new FilterBuilder(`references(^._id)`).buildFilter();
+    const childrenFilter = await new FilterBuilder(``, {isChildrenFilter: true} ).buildFilter();
 
     const query = `*[railcontent_id == ${railContentId} && brand == "${brand}" && (!defined(permission) || references(*[_type=='permission']._id))]{
    _type, parent_type, railcontent_id,
     "related_lessons" : array::unique([
-      ...(*[${filterNeighbouringSiblings}][0].child[]->{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}),
+      ...(*[${filterNeighbouringSiblings}][0].child[${childrenFilter}]->{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}),
       ...(*[${filterSongSameArtist}]{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}|order(published_on desc, title asc)[0...10]),
       ...(*[${filterSongSameGenre}]{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type}|order(published_on desc, title asc)[0...10]),
       ...(*[${filterSameTypeAndSortOrder}]{_id, "id":railcontent_id, published_on, "instructor": instructor[0]->name, title, "thumbnail_url":thumbnail.asset->url, length_in_seconds, web_url_path, "type": _type, difficulty, difficulty_string, railcontent_id, artist->,"permission_id": permission[]->railcontent_id,_type, sort}|order(sort asc, title asc)[0...10]),
@@ -1457,10 +1496,11 @@ export async function fetchCoachLessons(brand, id, {
         ? filtersToGroq(includedFields)
         : "";
     const filter = `brand == '${brand}' ${searchFilter} ${includedFieldsFilter} && references(*[_type=='instructor' && railcontent_id == ${id}]._id)`;
+    const filterWithRestrictions = await new FilterBuilder(filter).buildFilter();
 
     sortOrder = getSortOrder(sortOrder, brand);
     const query = buildEntityAndTotalQuery(
-        filter,
+        filterWithRestrictions,
         fieldsString,
         {
             sortOrder: sortOrder,
@@ -1683,19 +1723,20 @@ export async function fetchTopLevelParentId(railcontentId) {
 
 export async function fetchHierarchy(railcontentId) {
     let topLevelId = await fetchTopLevelParentId(railcontentId);
+    const childrenFilter = await new FilterBuilder(``, {isChildrenFilter: true} ).buildFilter();
     const query = `*[railcontent_id == ${topLevelId}]{
       railcontent_id,
       'assignments': assignment[]{railcontent_id},
-      'children': child[]->{
+      'children': child[${childrenFilter}]->{
         railcontent_id,
         'assignments': assignment[]{railcontent_id},
-        'children': child[]->{
+        'children': child[${childrenFilter}]->{
             railcontent_id,
             'assignments': assignment[]{railcontent_id},
-            'children': child[]->{
+            'children': child[${childrenFilter}]->{
                railcontent_id,
                'assignments': assignment[]{railcontent_id},
-               'children': child[]->{
+               'children': child[${childrenFilter}]->{
                   railcontent_id,                
             } 
           }

package/test/sanityQueryService.test.js

@@ -607,12 +607,12 @@ describe('Sanity Queries', function () {
     });
 
     test('fetchMethodNextPreviousLesson-Last', async () => {
-        const id = 396234;
-        const methodId = 396229;
+        const id = 260171;
+        const methodId = 259060;
         const response = await fetchMethodPreviousNextLesson(id, methodId);
         log(response);
         expect(response.prevLesson).toBeDefined();
-        expect(response.prevLesson.id).toBe(396233);
+        expect(response.prevLesson.id).toBe(260170);
         expect(response.prevLesson.type).toBe('course-part');
         expect(response.nextLesson).not.toBeDefined();
     });

package/.yarnrc.yml

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