musora-content-services 2.92.3 → 2.92.7

package/.github/workflows/docs.js.yml

@@ -1,61 +1,78 @@
-name: Sync V2 Docs to Main
+name: Deploy Docs to GitHub Pages
 on:
   push:
-    branches: [project-v2]
+    branches: [main, project-v2]
+
+# Required permissions for GitHub Pages deployment
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
 
 jobs:
-  sync-docs:
+  deploy-docs:
     runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
     steps:
+      - name: Checkout main branch
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          path: main-content
+
       - name: Checkout project-v2 branch
         uses: actions/checkout@v4
         with:
           ref: project-v2
-          path: project-v2-content
+          path: v2-content
 
-      - name: Checkout main branch
-        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          ref: main
-          path: main-content
-          token: ${{ secrets.PROJECT_V2_DOCS_TOKEN }}  #use separate token to trigger other actions
+          node-version: '20'
 
-      - name: Copy docs from project-v2 to main
-        run: |
-          # Create the target directory if it doesn't exist
-          mkdir -p main-content/docs/v2
-
-          # Remove existing v2 docs to ensure clean copy
-          rm -rf main-content/docs/v2/*
-
-          # Copy docs from project-v2 to main/docs/v2
-          if [ -d "project-v2-content/docs" ]; then
-            cp -r project-v2-content/docs/* main-content/docs/v2/
-            echo "✅ Copied docs from project-v2 to main/docs/v2"
-          else
-            echo "⚠️ No docs folder found in project-v2 branch"
-            exit 1
-          fi
-
-      - name: Commit and push changes to main
-        id: commit
+      - name: Install dependencies for v1
+        working-directory: main-content
+        run: npm ci
+
+      - name: Generate v1 documentation
+        working-directory: main-content
+        run: npm run doc
+
+      - name: Install dependencies for v2
+        working-directory: v2-content
+        run: npm ci
+
+      - name: Generate v2 documentation
+        working-directory: v2-content
+        run: npm run doc
+
+      - name: Combine v1 and v2 docs into deployment structure
         run: |
-          cd main-content
-          git config --local user.email "action@github.com"
-          git config --local user.name "GitHub Action"
-
-          # Check if there are any changes
-          if [ -n "$(git status --porcelain)" ]; then
-            git add docs/v2/
-            git commit -m "🔄 Auto-sync: Update v2 docs from project-v2 branch
-
-            - Synced from project-v2/docs
-            - Triggered by commit: ${{ github.sha }}
-            - Date: $(date)"
-            git push
-            echo "✅ Successfully pushed updated docs to main branch"
-            echo "changes=true" >> $GITHUB_OUTPUT
-          else
-            echo "ℹ️ No changes detected in docs"
-            echo "changes=false" >> $GITHUB_OUTPUT
-          fi
+          mkdir -p _site
+          # Copy v1 docs to root
+          cp -r main-content/docs/* _site/
+          # Copy v2 docs to /v2/ subdirectory
+          mkdir -p _site/v2
+          cp -r v2-content/docs/* _site/v2/
+          echo "✅ Combined v1 (root) and v2 (/v2/) documentation"
+
+      - name: Setup GitHub Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload combined documentation artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './_site'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 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.
 
+### [2.92.7](https://github.com/railroadmedia/musora-content-services/compare/v2.92.6...v2.92.7) (2025-12-02)
+
+
+### Bug Fixes
+
+* **agi:** make brand parameter less strict for now ([#603](https://github.com/railroadmedia/musora-content-services/issues/603)) ([b440b92](https://github.com/railroadmedia/musora-content-services/commit/b440b92ae1b4aab80d7e5ac5238c1e386cf09db8))
+
+### [2.92.6](https://github.com/railroadmedia/musora-content-services/compare/v2.92.5...v2.92.6) (2025-12-02)
+
+### [2.92.5](https://github.com/railroadmedia/musora-content-services/compare/v2.92.3...v2.92.5) (2025-12-02)
+
+
+### Bug Fixes
+
+* fixes to get things working with watermelon. added todos for subsequent commits ([#601](https://github.com/railroadmedia/musora-content-services/issues/601)) ([ed83230](https://github.com/railroadmedia/musora-content-services/commit/ed83230006c1fc3a79dfd1a4955fb3785651bf1b))
+
+### [2.92.4](https://github.com/railroadmedia/musora-content-services/compare/v2.92.3...v2.92.4) (2025-12-02)
+
+
+### Bug Fixes
+
+* fixes to get things working with watermelon. added todos for subsequent commits ([#601](https://github.com/railroadmedia/musora-content-services/issues/601)) ([ed83230](https://github.com/railroadmedia/musora-content-services/commit/ed83230006c1fc3a79dfd1a4955fb3785651bf1b))
+
 ### [2.92.3](https://github.com/railroadmedia/musora-content-services/compare/v2.92.2...v2.92.3) (2025-11-28)
 
 ### [2.92.2](https://github.com/railroadmedia/musora-content-services/compare/v2.92.0...v2.92.2) (2025-11-28)

package/package.json

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

package/src/index.d.ts

@@ -92,6 +92,7 @@ import {
 	contentStatusReset,
 	contentStatusStarted,
 	getAllCompleted,
+	getAllCompletedByIds,
 	getAllStarted,
 	getAllStartedOrCompleted,
 	getLastInteractedOf,
@@ -561,6 +562,7 @@ declare module 'musora-content-services' {
 		getActiveDiscussions,
 		getActivePath,
 		getAllCompleted,
+		getAllCompletedByIds,
 		getAllStarted,
 		getAllStartedOrCompleted,
 		getAwardDataForGuidedContent,

package/src/index.js

@@ -96,6 +96,7 @@ import {
 	contentStatusReset,
 	contentStatusStarted,
 	getAllCompleted,
+	getAllCompletedByIds,
 	getAllStarted,
 	getAllStartedOrCompleted,
 	getLastInteractedOf,
@@ -560,6 +561,7 @@ export {
 	getActiveDiscussions,
 	getActivePath,
 	getAllCompleted,
+	getAllCompletedByIds,
 	getAllStarted,
 	getAllStartedOrCompleted,
 	getAwardDataForGuidedContent,

package/src/lib/brands.ts

@@ -1,8 +1,8 @@
-export enum Brand {
-  MUSORA = 'musora',
-  DRUMEO = 'drumeo',
-  PIANOTE = 'pianote',
-  GUITAREO = 'guitareo',
-  SINGEO = 'singeo',
-  PLAYBASS = 'playbass',
+export enum Brands {
+  Musora = 'musora',
+  Drumeo = 'drumeo',
+  Pianote = 'pianote',
+  Guitareo = 'guitareo',
+  Singeo = 'singeo',
+  Playbass = 'playbass',
 }

package/src/services/content/artist.ts

@@ -6,7 +6,7 @@ import { FilterBuilder } from '../../filterBuilder.js'
 import { buildDataAndTotalQuery } from '../../lib/sanity/query'
 import { fetchSanity, getSortOrder } from '../sanity.js'
 import { Lesson } from './content'
-import { Brand } from '../../lib/brands'
+import { Brands } from '../../lib/brands'
 
 export interface Artist {
   slug: string
@@ -18,7 +18,7 @@ export interface Artist {
 /**
  * Fetch all artists with lessons available for a specific brand.
  *
- * @param {Brand} brand - The brand for which to fetch artists.
+ * @param {Brands|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
@@ -26,7 +26,7 @@ export interface Artist {
  *   .then(artists => console.log(artists))
  *   .catch(error => console.error(error));
  */
-export async function fetchArtists(brand: Brand): Promise<Artist[] | null> {
+export async function fetchArtists(brand: Brands | string): Promise<Artist[] | null> {
   const filter = await new FilterBuilder(
     `_type == "song" && brand == "${brand}" && references(^._id)`,
     { bypassPermissions: true }
@@ -45,7 +45,7 @@ export async function fetchArtists(brand: Brand): Promise<Artist[] | null> {
  * Fetch a single artist by their Sanity ID.
  *
  * @param {string} slug - The name of the artist to fetch.
- * @param {Brand} [brand] - The brand for which to fetch the artist.
+ * @param {Brands|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
@@ -53,7 +53,10 @@ export async function fetchArtists(brand: Brand): Promise<Artist[] | null> {
  *   .then(artists => console.log(artists))
  *   .catch(error => console.error(error));
  */
-export async function fetchArtistBySlug(slug: string, brand?: Brand): Promise<Artist | null> {
+export async function fetchArtistBySlug(
+  slug: string,
+  brand?: Brands | string
+): Promise<Artist | null> {
   const brandFilter = brand ? `brand == "${brand}" && ` : ''
   const filter = await new FilterBuilder(`${brandFilter} _type == "song" && references(^._id)`, {
     bypassPermissions: true,
@@ -84,7 +87,7 @@ export interface LessonsByArtistResponse {
 /**
  * Fetch the artist's lessons.
  * @param {string} slug - The slug of the artist
- * @param {Brand} brand - The brand for which to fetch lessons.
+ * @param {Brands|string} brand - The brand for which to fetch lessons.
  * @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.
@@ -102,7 +105,7 @@ export interface LessonsByArtistResponse {
  */
 export async function fetchArtistLessons(
   slug: string,
-  brand: Brand,
+  brand: Brands | string,
   contentType: string,
   {
     sort = '-published_on',

package/src/services/content/genre.ts

@@ -6,7 +6,7 @@ import { fetchSanity, getSortOrder } from '../sanity.js'
 import { FilterBuilder } from '../../filterBuilder.js'
 import { Lesson } from './content'
 import { buildDataAndTotalQuery } from '../../lib/sanity/query'
-import { Brand } from '../../lib/brands'
+import { Brands } from '../../lib/brands'
 
 export interface Genre {
   name: string
@@ -18,7 +18,7 @@ export interface 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.
+ * @param {Brands|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
@@ -26,7 +26,7 @@ export interface Genre {
  *   .then(genres => console.log(genres))
  *   .catch(error => console.error(error));
  */
-export async function fetchGenres(brand: Brand): Promise<Genre[]> {
+export async function fetchGenres(brand: Brands | string): Promise<Genre[]> {
   const filter = await new FilterBuilder(`brand == "${brand}" && references(^._id)`, {
     bypassPermissions: true,
   }).buildFilter()
@@ -46,7 +46,7 @@ export async function fetchGenres(brand: Brand): Promise<Genre[]> {
  * Fetch a single genre by their slug and brand
  *
  * @param {string} slug - The slug of the genre to fetch.
- * @param {Brand} [brand] - The brand for which to fetch the genre. Lesson count will be filtered by this brand if provided.
+ * @param {Brands|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
@@ -54,7 +54,10 @@ export async function fetchGenres(brand: Brand): Promise<Genre[]> {
  *   .then(genres => console.log(genres))
  *   .catch(error => console.error(error));
  */
-export async function fetchGenreBySlug(slug: string, brand?: Brand): Promise<Genre | null> {
+export async function fetchGenreBySlug(
+  slug: string,
+  brand?: Brands | string
+): Promise<Genre | null> {
   const brandFilter = brand ? `brand == "${brand}" && ` : ''
   const filter = await new FilterBuilder(`${brandFilter} references(^._id)`, {
     bypassPermissions: true,
@@ -88,7 +91,7 @@ export interface LessonsByGenreResponse {
 /**
  * Fetch the genre's lessons.
  * @param {string} slug - The slug of the genre
- * @param {Brand} brand - The brand for which to fetch lessons.
+ * @param {Brands|string} brand - The brand for which to fetch lessons.
  * @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.
@@ -105,7 +108,7 @@ export interface LessonsByGenreResponse {
  */
 export async function fetchGenreLessons(
   slug: string,
-  brand: Brand,
+  brand: Brands | string,
   contentType?: string,
   {
     sort = '-published_on',

package/src/services/content/instructor.ts

@@ -6,7 +6,7 @@ import { filtersToGroq, getFieldsForContentType } from '../../contentTypeConfig.
 import { fetchSanity, getSortOrder } from '../sanity.js'
 import { Lesson } from './content'
 import { buildDataAndTotalQuery } from '../../lib/sanity/query'
-import { Brand } from '../../lib/brands'
+import { Brands } from '../../lib/brands'
 
 export interface Instructor {
   lessonCount: number
@@ -19,7 +19,7 @@ export interface Instructor {
 /**
  * Fetch all instructor with lessons available for a specific brand.
  *
- * @param {Brand} brand - The brand for which to fetch instructors.
+ * @param {Brands|string} brand - The brand for which to fetch instructors.
  * @returns {Promise<Instructor[]>} - A promise that resolves to an array of instructor objects.
  *
  * @example
@@ -27,7 +27,7 @@ export interface Instructor {
  *   .then(instructors => console.log(instructors))
  *   .catch(error => console.error(error));
  */
-export async function fetchInstructors(brand: Brand): Promise<Instructor[]> {
+export async function fetchInstructors(brand: Brands | string): Promise<Instructor[]> {
   const filter = await new FilterBuilder(`brand == "${brand}" && references(^._id)`, {
     bypassPermissions: true,
   }).buildFilter()
@@ -46,7 +46,7 @@ export async function fetchInstructors(brand: Brand): Promise<Instructor[]> {
  * Fetch a single instructor by their name
  *
  * @param {string} slug - The slug of the instructor to fetch.
- * @param {Brand} [brand] - The brand for which to fetch the instructor. Lesson count will be filtered by this brand if provided.
+ * @param {Brands|string} [brand] - The brand for which to fetch the instructor. Lesson count will be filtered by this brand if provided.
  * @returns {Promise<Instructor[]>} - A promise that resolves to an instructor object or null if not found.
  *
  * @example
@@ -56,7 +56,7 @@ export async function fetchInstructors(brand: Brand): Promise<Instructor[]> {
  */
 export async function fetchInstructorBySlug(
   slug: string,
-  brand?: Brand
+  brand?: Brands | string
 ): Promise<Instructor | null> {
   const brandFilter = brand ? `brand == "${brand}" && ` : ''
   const filter = await new FilterBuilder(`${brandFilter} references(^._id)`, {
@@ -89,8 +89,8 @@ export interface InstructorLessonsResponse {
 
 /**
  * Fetch the data needed for the instructor screen.
- * @param {string} brand - The brand for which to fetch instructor lessons
  * @param {string} slug - The slug of the instructor
+ * @param {Brands|string} brand - The brand for which to fetch instructor lessons
  *
  * @param {FetchInstructorLessonsOptions} options - Parameters for pagination, filtering and sorting.
  * @param {string} [options.sortOrder="-published_on"] - The field to sort the lessons by.
@@ -107,7 +107,7 @@ export interface InstructorLessonsResponse {
  */
 export async function fetchInstructorLessons(
   slug: string,
-  brand: Brand,
+  brand: Brands | string,
   {
     sortOrder = '-published_on',
     searchTerm = '',

package/src/services/content-org/learning-paths.ts

@@ -268,7 +268,7 @@ export async function completeMethodIntroVideo(introVideoId: number, brand: stri
   response.intro_video_response = await completeIfNotCompleted(introVideoId)
 
   const methodStructure = await fetchMethodV2Structure(brand)
-  const learningPathId = methodStructure.learningPaths[0].id
+  const learningPathId = methodStructure.learning_paths[0].id
 
   response.active_path_response = await startLearningPath(brand, learningPathId)
 
@@ -279,7 +279,7 @@ export async function completeMethodIntroVideo(introVideoId: number, brand: stri
 interface completeLearningPathIntroVideo {
   intro_video_response: Object | null,
   learning_path_reset_response: void | null,
-  lesson_import_response: Object[] | null
+  lesson_import_response: Object | null
 }
 /**
  * Handles completion of learning path intro video and other related actions.
@@ -299,12 +299,12 @@ export async function completeLearningPathIntroVideo(introVideoId: number, learn
   const collection = { id: learningPathId, type: 'learning-path-v2' }
 
   if (!lessonsToImport) {
-    // returns nothing now, but it will when watermelon comes 'round
     response.learning_path_reset_response = await contentStatusReset(learningPathId, collection)
 
   } else {
       response.lesson_import_response = {}
     for (const contentId of lessonsToImport) {
+      // todo: create bulk complete endpoint with bubbling. and set up watermelon method bubbling
       response.lesson_import_response[contentId] = await contentStatusCompleted(contentId, collection)
     }
   }

package/src/services/progress-row/method-card.js

@@ -18,7 +18,7 @@ export async function getMethodCard(brand) {
   const introVideo = await fetchMethodV2IntroVideo(brand)
   const introVideoProgressState = await getProgressState(introVideo?.id)
   //resetAllLearningPaths()
-  if (introVideoProgressState != 'completed') {
+  if (introVideoProgressState !== 'completed') {
     //startLearningPath('drumeo', 422533)
     const timestamp = Math.floor(Date.now() / 1000)
     return {

package/src/services/reporting/reporting.ts

@@ -9,13 +9,8 @@
 
 import { HttpClient } from '../../infrastructure/http/HttpClient'
 import { globalConfig } from '../config.js'
-import {
-  ReportResponse,
-  ReportableType,
-  IssueTypeMap,
-  ReportIssueOption,
-} from './types'
-import {Brand} from "../../lib/brands";
+import { ReportResponse, ReportableType, IssueTypeMap, ReportIssueOption } from './types'
+import { Brands } from '../../lib/brands'
 
 /**
  * Parameters for submitting a report with type-safe issue values
@@ -30,7 +25,7 @@ export type ReportParams<T extends ReportableType = ReportableType> = {
   /** Details about the issue - required when issue is 'other', not sent otherwise */
   details?: string
   /** Brand context (required: drumeo, pianote, guitareo, singeo, playbass) */
-  brand: Brand
+  brand: Brands | string
 }
 
 /**
@@ -73,7 +68,9 @@ export type ReportParams<T extends ReportableType = ReportableType> = {
  *   brand: 'drumeo'
  * })
  */
-export async function report<T extends ReportableType>(params: ReportParams<T>): Promise<ReportResponse> {
+export async function report<T extends ReportableType>(
+  params: ReportParams<T>
+): Promise<ReportResponse> {
   const httpClient = new HttpClient(globalConfig.baseUrl)
 
   // Build request body
@@ -125,7 +122,10 @@ export async function report<T extends ReportableType>(params: ReportParams<T>):
  * //   { value: 'other', label: 'Other' }
  * // ]
  */
-export function getReportIssueOptions(type: ReportableType, isMobileApp: boolean = false): ReportIssueOption[] {
+export function getReportIssueOptions(
+  type: ReportableType,
+  isMobileApp: boolean = false
+): ReportIssueOption[] {
   switch (type) {
     case 'forum_post':
       return [
@@ -147,7 +147,10 @@ export function getReportIssueOptions(type: ReportableType, isMobileApp: boolean
 
     case 'content':
       const contentOptions = [
-        { value: 'incorrect_metadata', label: 'The lesson image, title or description is incorrect' },
+        {
+          value: 'incorrect_metadata',
+          label: 'The lesson image, title or description is incorrect',
+        },
         { value: 'video_issue', label: 'Video issue' },
       ]
 
@@ -165,7 +168,10 @@ export function getReportIssueOptions(type: ReportableType, isMobileApp: boolean
 
     case 'playlist':
       const playlistOptions = [
-        { value: 'incorrect_metadata', label: 'The lesson image, title or description is incorrect' },
+        {
+          value: 'incorrect_metadata',
+          label: 'The lesson image, title or description is incorrect',
+        },
         { value: 'video_issue', label: 'Video issue' },
       ]
 
@@ -182,8 +188,6 @@ export function getReportIssueOptions(type: ReportableType, isMobileApp: boolean
       return playlistOptions
 
     default:
-      return [
-        { value: 'other', label: 'Other' },
-      ]
+      return [{ value: 'other', label: 'Other' }]
   }
 }

package/src/services/sync/fetch.ts

@@ -117,6 +117,9 @@ export function makeFetchRequest(input: RequestInfo, init?: RequestInit): (sessi
     ...init,
     headers: {
       ...init?.headers,
+      ...globalConfig.sessionConfig?.token ? {
+        'Authorization': `Bearer ${globalConfig.sessionConfig.token}`
+      } : {},
       'Content-Type': 'application/json',
       'X-Sync-Client-Id': session.getClientId(),
       ...(session.getSessionId() ? {

package/src/services/user/onboarding.ts

@@ -2,7 +2,7 @@
  * @module Onboarding
  */
 import { HttpClient } from '../../infrastructure/http/HttpClient'
-import { Brand } from '../../lib/brands'
+import { Brands } from '../../lib/brands'
 import { globalConfig } from '../config.js'
 
 export interface OnboardingSteps {
@@ -224,13 +224,13 @@ const recommendedContentCache: { [brand: string]: OnboardingRecommendedContent }
  * Fetches recommended content for onboarding based on the specified brand.
  *
  * @param {string} email - The user's email address.
- * @param {Brand} brand - The brand identifier.
+ * @param {Brands} brand - The brand identifier.
  * @returns {Promise<OnboardingRecommendedContent>} - A promise that resolves with the recommended content.
  * @throws {HttpError} - If the HTTP request fails.
  */
 export async function getOnboardingRecommendedContent(
   email: string,
-  brand: Brand
+  brand: Brands
 ): Promise<OnboardingRecommendedContent> {
   // TODO: Replace with real API call when available
   if (recommendedContentCache[brand]) {