musora-content-services 1.0.173 → 1.0.174

package/package.json

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

package/src/index.d.ts

@@ -18,6 +18,7 @@ import {
 	contentStatusReset,
 	getAllCompleted,
 	getAllStarted,
+	getAllStartedOrCompleted,
 	getProgressPercentage,
 	getProgressPercentageByIds,
 	getProgressState,
@@ -214,6 +215,7 @@ declare module 'musora-content-services' {
 		fetchWorkouts,
 		getAllCompleted,
 		getAllStarted,
+		getAllStartedOrCompleted,
 		getProgressPercentage,
 		getProgressPercentageByIds,
 		getProgressState,

package/src/index.js

@@ -18,6 +18,7 @@ import {
 	contentStatusReset,
 	getAllCompleted,
 	getAllStarted,
+	getAllStartedOrCompleted,
 	getProgressPercentage,
 	getProgressPercentageByIds,
 	getProgressState,
@@ -213,6 +214,7 @@ export {
 	fetchWorkouts,
 	getAllCompleted,
 	getAllStarted,
+	getAllStartedOrCompleted,
 	getProgressPercentage,
 	getProgressPercentageByIds,
 	getProgressState,

package/src/services/contentProgress.js

@@ -81,6 +81,25 @@ export async function getAllCompleted(limit = null) {
     return ids;
 }
 
+export async function getAllStartedOrCompleted(limit = null) {
+    const data = await dataContext.getData();
+    let ids = Object.keys(data).filter(function (key) {
+        return data[parseInt(key)][DATA_KEY_STATUS] === STATE_STARTED || data[parseInt(key)][DATA_KEY_STATUS] === STATE_COMPLETED;
+    }).map(function (key) {
+        return parseInt(key);
+    }).sort(function (a, b) {
+        let v1 = data[a][DATA_KEY_LAST_UPDATED_TIME];
+        let v2 = data[b][DATA_KEY_LAST_UPDATED_TIME];
+        if (v1 > v2) return -1;
+        else if (v1 < v2) return 1;
+        return 0;
+    });
+    if (limit) {
+        ids = ids.slice(0, limit);
+    }
+    return ids;
+}
+
 export async function getResumeTimeSeconds(contentId) {
     let data = await dataContext.getData();
     return data[contentId]?.[DATA_KEY_RESUME_TIME] ?? 0;

package/src/services/sanity.js

@@ -26,6 +26,7 @@ import {globalConfig} from "./config";
 import {fetchAllCompletedStates, fetchCurrentSongComplete} from './railcontent.js';
 import {arrayToStringRepresentation, FilterBuilder} from "../filterBuilder";
 import {fetchUserPermissions} from "./userPermissions";
+import {getAllCompleted, getAllStarted, getAllStartedOrCompleted} from "./contentProgress";
 
 /**
  * Exported functions that are excluded from index generation.
@@ -453,6 +454,7 @@ export async function fetchByRailContentIds(ids, contentType = undefined) {
  * @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.
  *
  * @example
@@ -480,6 +482,7 @@ export async function fetchAll(brand, type, {
     progressIds = undefined,
     useDefaultFields = true,
     customFields = [],
+    progress = "all"
 } = {}) {
     let config = contentTypeConfig[type] ?? {};
     let additionalFields = config?.fields ?? [];
@@ -504,8 +507,7 @@ export async function fetchAll(brand, type, {
         : "";
 
     // limits the results to supplied progressIds for started & completed filters
-    const progressFilter = progressIds !== undefined ?
-        `&& railcontent_id in [${progressIds.join(',')}]` : "";
+    const progressFilter = await getProgressFilter(progress, progressIds);
 
     // Determine the sort order
     const sortOrder = getSortOrder(sort);
@@ -564,6 +566,28 @@ export async function fetchAll(brand, type, {
     return fetchSanity(query, true);
 }
 
+async function getProgressFilter(progress, progressIds) {
+    switch (progress) {
+        case "all":
+            return progressIds !== undefined ?
+                `&& railcontent_id in [${progressIds.join(',')}]` : "";
+        case "in progress": {
+            const ids = await getAllStarted();
+            return `&& railcontent_id in [${ids.join(',')}]`;
+        }
+        case "completed": {
+            const ids = await getAllCompleted();
+            return `&& railcontent_id in [${ids.join(',')}]`;
+        }
+        case "not started": {
+            const ids = await getAllStartedOrCompleted();
+            return `&& !(railcontent_id in [${ids.join(',')}])`;
+        }
+        default:
+            throw new Error(`'${progress}' progress option not implemented`);
+    }
+}
+
 export function getSortOrder(sort = '-published_on', groupBy) {
     // Determine the sort order
     let sortOrder = '';

package/test/contentProgress.test.js

@@ -7,7 +7,11 @@ import {
     getProgressStateByIds,
     getAllStarted,
     getAllCompleted,
-    contentStatusCompleted, assignmentStatusCompleted, contentStatusReset, assignmentStatusReset
+    contentStatusCompleted,
+    assignmentStatusCompleted,
+    contentStatusReset,
+    assignmentStatusReset,
+    getAllStartedOrCompleted
 } from "../src/services/contentProgress";
 import {initializeTestService} from "./initializeTests";
 import {postContentCompleted} from "../src";
@@ -71,6 +75,12 @@ describe('contentProgressDataContext', function () {
         expect(result).toStrictEqual([233955]);
     });
 
+    test('getAllStartedOrCompleted', async () => {
+        let result = await getAllStartedOrCompleted();
+        expect(result).toStrictEqual([259426, 233955, 234191]);
+    });
+
+
     // test('getAllStartedWithUpdate', async () => {
     //     let mock2 = jest.spyOn(railContentModule, 'postRecordWatchSession');
     //     let serverVersion = 2;

package/test/sanityQueryService.test.js

@@ -2,6 +2,7 @@ import {getFieldsForContentType} from "../src/contentTypeConfig";
 import {fetchAssignments, fetchCommentModContentData, fetchSanity} from "../src/services/sanity";
 import {log} from './log.js';
 import {initializeTestService} from "./initializeTests";
+import {dataContext} from "../src/services/contentProgress";
 
 const {
     fetchSongById,
@@ -158,6 +159,35 @@ describe('Sanity Queries', function () {
         expect(response.entity[0].instrumentless).toBeDefined();
     });
 
+    test('fetchAllSongsInProgress', async () => {
+       var mock = jest.spyOn(dataContext, 'fetchData');
+        var json = JSON.parse(`{"version":1,"config":{"key":1,"enabled":1,"checkInterval":1,"refreshInterval":2},"data":{"232979":{"s":"started","p":6,"t":20,"u":1731108082}}}`);
+        mock.mockImplementation(() =>
+            json);
+        const response = await fetchAll('drumeo', 'song',{progress:"in progress"});
+        expect(response.entity[0].id).toBe(232979);
+        expect(response.entity.length).toBe(1);
+    });
+
+    test('fetchAllSongsCompleted', async () => {
+        var mock = jest.spyOn(dataContext, 'fetchData');
+        var json = JSON.parse(`{"version":1,"config":{"key":1,"enabled":1,"checkInterval":1,"refreshInterval":2},"data":{"232979":{"s":"completed","p":100,"t":20,"u":1731108082}}}`);
+        mock.mockImplementation(() =>
+            json);
+        const response = await fetchAll('drumeo', 'song', {progress:"completed"});
+        expect(response.entity[0].id).toBe(232979);
+        expect(response.entity.length).toBe(1);
+    });
+
+    test('fetchAllSongsNotStarted', async () => {
+        var mock = jest.spyOn(dataContext, 'fetchData');
+        var json = JSON.parse(`{"version":1,"config":{"key":1,"enabled":1,"checkInterval":1,"refreshInterval":2},"data":{"198122":{"s":"started","p":100,"t":20,"u":1731108082},"231622":{"s":"completed","p":100,"t":20,"u":1731108082}}}`);
+        mock.mockImplementation(() =>
+            json);  const response = await fetchAll('drumeo', 'song', {progress:"not started"});
+        expect(response.entity[0].id).not.toBe(198122);
+        expect(response.entity[0].id).not.toBe(231622);
+    });
+
     test('fetchSongFilterOptions', async () => {
         const response = await fetchSongFilterOptions('drumeo', {});
         log(response);