musora-content-services 1.0.177 → 1.0.179

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.0.179](https://github.com/railroadmedia/musora-content-services/compare/v1.0.178...v1.0.179) (2024-11-19)
+
+### [1.0.178](https://github.com/railroadmedia/musora-content-services/compare/v1.0.177...v1.0.178) (2024-11-19)
+
 ### [1.0.177](https://github.com/railroadmedia/musora-content-services/compare/v1.0.176...v1.0.177) (2024-11-18)
 
 ### [1.0.176](https://github.com/railroadmedia/musora-content-services/compare/v1.0.161...v1.0.176) (2024-11-15)

package/package.json

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

package/src/contentMetaData.js

@@ -37,13 +37,11 @@ const commonMetadata ={
             {
                 name: 'Completed',
                 short_name: 'COMPLETED',
-                is_group_by: true,
                 value: 'completed'
             },
             {
                 name: 'Owned Challenges',
                 short_name: 'OWNED CHALLENGES',
-                is_group_by: true,
                 value: 'owned',
             },
         ],

package/src/contentTypeConfig.js

@@ -86,7 +86,7 @@ let contentTypeConfig = {
         'fields': [
             'enrollment_start_time',
             'enrollment_end_time',
-            'registration_url',
+            "'registration_url': '/' + brand + '/enrollment/' + slug.current",
             '"lesson_count": child_count',
             '"primary_cta_text": select(dateTime(published_on) > dateTime(now()) && dateTime(enrollment_start_time) > dateTime(now()) => "Notify Me", "Start Challenge")',
             'challenge_state',

package/src/filterBuilder.js

@@ -4,6 +4,10 @@ import {fetchUserPermissions} from "./services/userPermissions";
 export class FilterBuilder {
 
     STATUS_SCHEDULED = 'scheduled';
+    STATUS_PUBLISHED = 'published';
+    STATUS_DRAFT = 'draft';
+    STATUS_ARCHIVED = 'archived';
+    STATUS_UNLISTED = 'unlisted';
 
     constructor(
         filter = '',
@@ -13,13 +17,18 @@ export class FilterBuilder {
             pullFutureContent = false,
             getFutureContentOnly = false,
             getFutureScheduledContentsOnly = false,
-
+            bypassStatuses = false,
+            bypassPublishedDateRestriction = false,
+            isSingle = false
         } = {}) {
         this.availableContentStatuses = availableContentStatuses;
         this.bypassPermissions = bypassPermissions;
+        this.bypassStatuses = bypassStatuses;
+        this.bypassPublishedDateRestriction = bypassPublishedDateRestriction;
         this.pullFutureContent = pullFutureContent;
         this.getFutureContentOnly = getFutureContentOnly;
         this.getFutureScheduledContentsOnly = getFutureScheduledContentsOnly;
+        this.isSingle = isSingle;
         this.filter = filter;
         // this.debug = process.env.DEBUG === 'true' || false;
         this.debug = false;
@@ -48,7 +57,17 @@ export class FilterBuilder {
 
     _applyContentStatuses() {
         // This must be run before _applyPublishDateRestrictions()
-        if (this.availableContentStatuses.length === 0) return this;
+        if(this.bypassStatuses) return this;
+        if (this.availableContentStatuses.length === 0) {
+            if (this.userData.isAdmin) {
+                this.availableContentStatuses = [this.STATUS_DRAFT, this.STATUS_SCHEDULED, this.STATUS_PUBLISHED, this.STATUS_ARCHIVED, this.STATUS_UNLISTED];
+            } else if(this.isSingle){
+                this.availableContentStatuses = [this.STATUS_SCHEDULED, this.STATUS_PUBLISHED, this.STATUS_UNLISTED, this.STATUS_ARCHIVED];
+            } else{
+                this.availableContentStatuses = [this.STATUS_SCHEDULED, this.STATUS_PUBLISHED];
+            }
+        }
+
         // I'm not sure if I'm 100% on this logic, but this is my intepretation of the ContentRepository logic
         if (this.getFutureScheduledContentsOnly && this.availableContentStatuses.includes(this.STATUS_SCHEDULED)) {
             // we must pull in future content here, otherwise we'll restrict on content this is published in the past and remove any scheduled content
@@ -77,6 +96,7 @@ export class FilterBuilder {
     }
 
     _applyPublishingDateRestrictions() {
+        if(this.bypassPublishedDateRestriction) return this;
         const now = new Date().toISOString();
         if (this.getFutureContentOnly) {
             this._andWhere(`published_on >= '${now}'`);

package/src/index.d.ts

@@ -40,12 +40,14 @@ import {
 	fetchChallengeLessonData,
 	fetchChallengeMetadata,
 	fetchChallengeUserActiveChallenges,
+	fetchCompletedChallenges,
 	fetchCompletedContent,
 	fetchCompletedState,
 	fetchContentInProgress,
 	fetchContentPageUserData,
 	fetchContentProgress,
 	fetchHandler,
+	fetchOwnedChallenges,
 	fetchPinnedPlaylists,
 	fetchPlaylist,
 	fetchPlaylistItem,
@@ -166,6 +168,7 @@ declare module 'musora-content-services' {
 		fetchChildren,
 		fetchCoachLessons,
 		fetchCommentModContentData,
+		fetchCompletedChallenges,
 		fetchCompletedContent,
 		fetchCompletedState,
 		fetchContentInProgress,
@@ -187,6 +190,7 @@ declare module 'musora-content-services' {
 		fetchMethods,
 		fetchNewReleases,
 		fetchNextPreviousLesson,
+		fetchOwnedChallenges,
 		fetchPackAll,
 		fetchPackChildren,
 		fetchPackData,

package/src/index.js

@@ -40,12 +40,14 @@ import {
 	fetchChallengeLessonData,
 	fetchChallengeMetadata,
 	fetchChallengeUserActiveChallenges,
+	fetchCompletedChallenges,
 	fetchCompletedContent,
 	fetchCompletedState,
 	fetchContentInProgress,
 	fetchContentPageUserData,
 	fetchContentProgress,
 	fetchHandler,
+	fetchOwnedChallenges,
 	fetchPinnedPlaylists,
 	fetchPlaylist,
 	fetchPlaylistItem,
@@ -165,6 +167,7 @@ export {
 	fetchChildren,
 	fetchCoachLessons,
 	fetchCommentModContentData,
+	fetchCompletedChallenges,
 	fetchCompletedContent,
 	fetchCompletedState,
 	fetchContentInProgress,
@@ -186,6 +189,7 @@ export {
 	fetchMethods,
 	fetchNewReleases,
 	fetchNextPreviousLesson,
+	fetchOwnedChallenges,
 	fetchPackAll,
 	fetchPackChildren,
 	fetchPackData,

package/src/services/railcontent.js

@@ -336,6 +336,36 @@ export async function fetchChallengeLessonData(contentId) {
     return await fetchHandler(url, 'get');
 }
 
+
+/**
+ * Fetch all owned brand challenges for user
+ * @param {string|null} brand - brand
+ * @param {int} page - page of data to pull
+ * @param {int} limit - number of elements to pull
+ * @returns {Promise<any|null>}
+ */
+export async function fetchOwnedChallenges(brand = null, page, limit) {
+    let brandParam = brand ? `&brand=${brand}` : '';
+    let pageAndLimit = `?page=${page}&limit=${limit}`;
+    let url = `/challenges/tab_owned/get${pageAndLimit}${brandParam}`;
+    return await fetchHandler(url, 'get');
+}
+
+/**
+ * Fetch all completed brand challenges for user
+ * @param {string|null} brand - brand
+ * @param {int} page - page of data to pull
+ * @param {int} limit - number of elements to pull
+ * @returns {Promise<any|null>}
+ */
+export async function fetchCompletedChallenges(brand = null, page, limit) {
+    let brandParam = brand ? `&brand=${brand}` : '';
+    let pageAndLimit = `?page=${page}&limit=${limit}`;
+    let url = `/challenges/tab_completed/get${pageAndLimit}${brandParam}`;
+    return await fetchHandler(url, 'get');
+}
+
+
 /**
  * Fetch challenge, lesson, and user metadata for a given challenge
  *

package/src/services/sanity.js

@@ -23,7 +23,12 @@ import {
 
 import {globalConfig} from "./config";
 
-import {fetchAllCompletedStates, fetchCurrentSongComplete} from './railcontent.js';
+import {
+    fetchAllCompletedStates,
+    fetchCompletedChallenges,
+    fetchCurrentSongComplete,
+    fetchOwnedChallenges
+} from './railcontent.js';
 import {arrayToStringRepresentation, FilterBuilder} from "../filterBuilder";
 import {fetchUserPermissions} from "./userPermissions";
 import {getAllCompleted, getAllStarted, getAllStartedOrCompleted} from "./contentProgress";
@@ -33,7 +38,7 @@ import {getAllCompleted, getAllStarted, getAllStartedOrCompleted} from "./conten
  *
  * @type {string[]}
  */
-const excludeFromGeneratedIndex = [];
+const excludeFromGeneratedIndex = ['handleCustomFetchAll'];
 
 /**
  * Fetch a song by its document ID from Sanity.
@@ -484,12 +489,28 @@ export async function fetchAll(brand, type, {
     customFields = [],
     progress = "all"
 } = {}) {
+    let customResults = await handleCustomFetchAll(brand, type, {
+        page,
+        limit,
+        searchTerm,
+        sort,
+        includedFields,
+        groupBy,
+        progressIds,
+        useDefaultFields,
+        customFields,
+        progress});
+    if (customResults) {
+        return customResults;
+    }
+
     let config = contentTypeConfig[type] ?? {};
     let additionalFields = config?.fields ?? [];
     let isGroupByOneToOne = (groupBy ? config?.relationships?.[groupBy]?.isOneToOne : false) ?? false;
     let webUrlPathType = config?.slug ?? type;
     const start = (page - 1) * limit;
     const end = start + limit;
+    let bypassStatusAndPublishedValidation = (type == 'instructor');
 
     // Construct the type filter
     const typeFilter = type ? `&& _type == '${type}'` : "";
@@ -554,8 +575,10 @@ export async function fetchAll(brand, type, {
         filter = `brand == "${brand}" ${typeFilter} ${searchFilter} ${includedFieldsFilter} ${progressFilter}`
         entityFieldsString = fieldsString;
     }
+
+    const filterWithRestrictions = await new FilterBuilder(filter,{bypassStatuses:bypassStatusAndPublishedValidation, bypassPermissions: bypassStatusAndPublishedValidation, bypassPublishedDateRestriction: bypassStatusAndPublishedValidation} ).buildFilter();
     query = buildEntityAndTotalQuery(
-        filter,
+        filterWithRestrictions,
         entityFieldsString,
         {
             sortOrder: sortOrder,
@@ -566,6 +589,45 @@ export async function fetchAll(brand, type, {
     return fetchSanity(query, true);
 }
 
+/**
+ * Fetch all content that requires custom handling or a distinct external call
+ * @param {string} brand - The brand for which to fetch content.
+ * @param {string} type - The content type to fetch (e.g., 'song', 'artist').
+ * @param {Object} params - Parameters for pagination, filtering, sorting, and grouping.
+ * @param {number} [params.page=1] - The page number for pagination.
+ * @param {number} [params.limit=10] - The number of items per page.
+ * @param {string} [params.searchTerm=""] - The search term to filter content by title or artist.
+ * @param {string} [params.sort="-published_on"] - The field to sort the content by.
+ * @param {Array<string>} [params.includedFields=[]] - The fields to include in the query.
+ * @param {string} [params.groupBy=""] - The field to group the results by (e.g., 'artist', 'genre').
+ * @param {Array<string>} [params.progressIds=undefined] - An array of railcontent IDs to filter the results by. Used for filtering by progress.
+ * @param {boolean} [params.useDefaultFields=true] - use the default sanity fields for content Type
+ * @param {Array<string>} [params.customFields=[]] - An array of sanity fields to include in the request
+ * @param {string} [params.progress="all"] - An string representing which progress filter to use ("all", "in progress", "complete", "not started").
+ * @returns {Promise<Object|null>} - The fetched content data or null if not found.
+ */
+async function handleCustomFetchAll(brand, type, {
+    page = 1,
+    limit = 10,
+    searchTerm = "",
+    sort = "-published_on",
+    includedFields = [],
+    groupBy = "",
+    progressIds = undefined,
+    useDefaultFields = true,
+    customFields = [],
+    progress = "all"
+} = {}) {
+    if (type === 'challenge') {
+        if (groupBy === 'completed') {
+            return fetchCompletedChallenges(brand, page, limit);
+        } else if(groupBy === 'owned') {
+            return fetchOwnedChallenges(brand, page, limit);
+        }
+    }
+    return null;
+}
+
 async function getProgressFilter(progress, progressIds) {
     switch (progress) {
         case "all":
@@ -931,7 +993,7 @@ export async function fetchNextPreviousLesson(railcontentId) {
  *   .catch(error => console.error(error));
  */
 export async function fetchLessonContent(railContentId) {
-    const filterParams = {};
+    const filterParams = {isSingle:true};
     // Format changes made to the `fields` object may also need to be reflected in Musora-web-platform SanityGateway.php $fields object
     // Currently only for challenges and challenge lessons
     // If you're unsure, message Adrian, or just add them.

package/test/sanityQueryService.test.js

@@ -630,13 +630,16 @@ describe('Filter Builder', function () {
         let finalFilter = await builder.buildFilter(filter);
         let clauses = spliceFilterForAnds(finalFilter);
         expect(clauses[0].phrase).toBe(filter);
-        expect(clauses[1].field).toBe('published_on');
+        expect(clauses[1].field).toBe('status');
+        expect(clauses[2].field).toBe('published_on');
 
         builder = new FilterBuilder('', {bypassPermissions: true});
         finalFilter = await builder.buildFilter(filter);
         clauses = spliceFilterForAnds(finalFilter);
-        expect(clauses[0].field).toBe('published_on');
-        expect(clauses[0].operator).toBe('<=');
+        expect(clauses[0].field).toBe('status');
+        expect(clauses[0].operator).toBe('in');
+        expect(clauses[1].field).toBe('published_on');
+        expect(clauses[1].operator).toBe('<=');
     });
 
     test('withOnlyFilterAvailableStatuses', async () => {
@@ -665,8 +668,6 @@ describe('Filter Builder', function () {
         expect(clauses[1].operator).toBe('in');
         // getFutureScheduledContentsOnly doesn't make a filter that's splicable, so we match on the more static string
         const expected = "['published','unlisted'] || (status == 'scheduled' && published_on >=";
-        console.log(clauses[1].condition);
-        console.log(expected)
         const isMatch = finalFilter.includes(expected);
         expect(isMatch).toBeTruthy();
     });
@@ -701,7 +702,9 @@ describe('Filter Builder', function () {
         expect(isMatch).toBeFalsy();
         const clauses = spliceFilterForAnds(finalFilter);
         expect(clauses[0].field).toBe('railcontent_id');
-        expect(clauses[1].field).toBe('published_on');
+        expect(clauses[1].field).toBe('status');
+        expect(clauses[2].field).toBe('published_on');
+
     });
 
 
@@ -717,10 +720,11 @@ describe('Filter Builder', function () {
         let finalFilter = await builder.buildFilter();
         let clauses = spliceFilterForAnds(finalFilter);
         expect(clauses[0].phrase).toBe(filter);
-
-        expect(clauses[1].field).toBe('published_on');
-        expect(clauses[1].operator).toBe('<=');
-        const restrictionDate = new Date(clauses[1].condition)
+        expect(clauses[1].field).toBe('status');
+        expect(clauses[1].operator).toBe('in');
+        expect(clauses[2].field).toBe('published_on');
+        expect(clauses[2].operator).toBe('<=');
+        const restrictionDate = new Date(clauses[2].condition)
         const now = new Date();
         expect(now.getTime()).toBeLessThan(restrictionDate.getTime());
 
@@ -732,8 +736,8 @@ describe('Filter Builder', function () {
         finalFilter = await builder.buildFilter();
         clauses = spliceFilterForAnds(finalFilter);
         expect(clauses[0].phrase).toBe(filter);
-        expect(clauses[1].field).toBe('published_on');
-        expect(clauses[1].operator).toBe('>=');
+        expect(clauses[2].field).toBe('published_on');
+        expect(clauses[2].operator).toBe('>=');
     });
 
     function spliceFilterForAnds(filter) {