musora-content-services 2.95.2 → 2.95.3

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.95.3](https://github.com/railroadmedia/musora-content-services/compare/v2.95.2...v2.95.3) (2025-12-08)
+
+
+### Bug Fixes
+
+* make agi responses standard ([#630](https://github.com/railroadmedia/musora-content-services/issues/630)) ([0301133](https://github.com/railroadmedia/musora-content-services/commit/03011331cb835412af80111a97e6ae83fd6e56d5))
+
 ### [2.95.2](https://github.com/railroadmedia/musora-content-services/compare/v2.95.1...v2.95.2) (2025-12-08)
 
 ### [2.95.1](https://github.com/railroadmedia/musora-content-services/compare/v2.95.0...v2.95.1) (2025-12-08)

package/package.json

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

package/src/lib/ads/monoid.ts

@@ -0,0 +1,5 @@
+import { Semigroup } from './semigroup'
+
+export interface Monoid<A> extends Semigroup<A> {
+  empty: A
+}

package/src/lib/ads/semigroup.ts

@@ -0,0 +1,3 @@
+export interface Semigroup<A> {
+  concat: (a: A, b: A) => A
+}

package/src/lib/sanity/query.ts

@@ -1,30 +1,127 @@
+import { Monoid } from '../ads/monoid'
+import { Semigroup } from '../ads/semigroup'
+
 export interface BuildQueryOptions {
-  sort: string
-  start: number
-  end: number
-  isSingle?: boolean
-  withoutPagination?: boolean
-}
-
-export function buildDataAndTotalQuery(
-  filter: string = '',
-  fields: string = '...',
-  {
-    sort = 'published_on desc',
-    start = 0,
-    end = 10,
-    isSingle = false,
-    withoutPagination = false,
-  }: BuildQueryOptions
-): string {
-  const sortString = sort ? ` | order(${sort})` : ''
-  const countString = isSingle ? '[0...1]' : withoutPagination ? `` : `[${start}...${end}]`
-  const query = `{
-      "data": *[${filter}]  ${sortString}${countString}
-      {
-        ${fields}
-      },
-      "total": count(*[${filter}]),
-    }`
-  return query
+  sort?: string
+  offset?: number
+  limit?: number
+}
+
+export type Projection = string[]
+
+export interface QueryBuilderState {
+  filter: string
+  ordering: string
+  slice: string
+  projection: string
+  postFilter: string
+}
+
+export interface QueryBuilder {
+  and(expr: string): QueryBuilder
+  or(...exprs: string[]): QueryBuilder
+  order(expr: string): QueryBuilder
+  slice(start: number, end: number): QueryBuilder
+  first(): QueryBuilder
+  select(...fields: string[]): QueryBuilder
+  postFilter(expr: string): QueryBuilder
+  build(): string
+
+  _state(): QueryBuilderState
+}
+
+const and: Monoid<string> = {
+  empty: '',
+  concat: (a, b) => (!a ? b : !b ? a : `${a} && ${b}`),
+}
+
+const or: Monoid<string> = {
+  empty: '',
+  concat: (a, b) => (!a ? b : !b ? a : `(${a} || ${b})`),
+}
+
+const order: Monoid<string> = {
+  empty: '',
+  concat: (a, b) => `| order(${b || a})`,
+}
+
+const slice: Monoid<string> = {
+  empty: '',
+  concat: (a, b) => b || a,
+}
+
+const project: Semigroup<string> = {
+  concat: (a, b) => `${a}, ${b}`,
+}
+
+export const query = (): QueryBuilder => {
+  let state: QueryBuilderState = {
+    filter: and.empty,
+    ordering: order.empty,
+    slice: slice.empty,
+    projection: '_id',
+    postFilter: and.empty,
+  }
+
+  const builder: QueryBuilder = {
+    // main filters
+    and(expr: string) {
+      state.filter = and.concat(state.filter, expr)
+      return builder
+    },
+
+    or(...exprs: string[]) {
+      const orExpr = exprs.reduce(or.concat, or.empty)
+      state.filter = and.concat(state.filter, orExpr)
+      return builder
+    },
+
+    // sorting
+    order(expr: string) {
+      state.ordering = order.concat(state.ordering, expr)
+      return builder
+    },
+
+    // pagination / slicing
+    slice(start: number = 0, end?: number) {
+      const sliceExpr = !end ? `[${start}]` : `[${start}...${end}]`
+
+      state.slice = slice.concat(state.slice, sliceExpr)
+      return builder
+    },
+
+    first() {
+      return this.slice()
+    },
+
+    // projection
+    select(...fields: string[]) {
+      state.projection = fields.reduce(project.concat, state.projection)
+      return builder
+    },
+
+    // post filters
+    postFilter(expr: string) {
+      state.postFilter = and.concat(state.postFilter, expr)
+      return builder
+    },
+
+    build() {
+      const { filter, ordering, slice, projection } = state
+
+      return `
+        *[${filter}]
+          ${ordering}
+          ${slice}
+        { ${projection} }
+        ${state.postFilter ? `[${state.postFilter}]` : ''}
+      `.trim()
+    },
+
+    _state() {
+      return state
+    },
+  }
+
+  return builder
 }

package/src/services/content/artist.ts

@@ -3,7 +3,7 @@
  */
 import { filtersToGroq, getFieldsForContentType } from '../../contentTypeConfig.js'
 import { FilterBuilder } from '../../filterBuilder.js'
-import { buildDataAndTotalQuery } from '../../lib/sanity/query'
+import { BuildQueryOptions, query } from '../../lib/sanity/query'
 import { fetchSanity, getSortOrder } from '../sanity.js'
 import { Lesson } from './content'
 import { Brands } from '../../lib/brands'
@@ -26,19 +26,39 @@ export interface Artist {
  *   .then(artists => console.log(artists))
  *   .catch(error => console.error(error));
  */
-export async function fetchArtists(brand: Brands | string): Promise<Artist[] | null> {
-  const filter = await new FilterBuilder(
-    `_type == "song" && brand == "${brand}" && references(^._id)`,
-    { bypassPermissions: true }
-  ).buildFilter()
-  const query = `
-  *[_type == "artist"]{
-    name,
-    "slug": slug.current,
-    'thumbnail': thumbnail_url.asset->url,
-    "lessonCount": count(*[${filter}])
-  }[lessonCount > 0] |order(lower(name)) `
-  return fetchSanity(query, true, { processNeedAccess: false, processPageType: false })
+export async function fetchArtists(
+  brand: Brands | string,
+  options: BuildQueryOptions = { sort: 'lower(name) asc' }
+): Promise<Artist[] | null> {
+  const lessonFilter = await new FilterBuilder(`brand == "${brand}" && references(^._id)`, {
+    bypassPermissions: true,
+  }).buildFilter()
+
+  const data = query()
+    .and(`_type == "artist"`)
+    .order(options.sort || 'lower(name) asc')
+    .slice(options.offset || 0, (options.offset || 0) + (options.limit || 20))
+    .select(
+      'name',
+      `"slug": slug.current`,
+      `"thumbnail": thumbnail_url.asset->url`,
+      `"lessonCount": count(*[${lessonFilter}])`
+    )
+    .postFilter(`lessonCount > 0`)
+    .build()
+
+  const total = query()
+    .and(`_type == "artist"`)
+    .select(`"lessonCount": count(*[${lessonFilter}])`)
+    .postFilter(`lessonCount > 0`)
+    .build()
+
+  const q = `{
+    "data": ${data},
+    "total": ${total}
+  }`
+
+  return fetchSanity(q, true, { processNeedAccess: false, processPageType: false })
 }
 
 /**
@@ -61,25 +81,29 @@ export async function fetchArtistBySlug(
   const filter = await new FilterBuilder(`${brandFilter} _type == "song" && references(^._id)`, {
     bypassPermissions: true,
   }).buildFilter()
-  const query = `
-  *[_type == "artist" && slug.current == '${slug}']{
-    name,
-    "slug": slug.current,
-    "lessonCount": count(*[${filter}])
-  }[lessonCount > 0] |order(lower(name)) `
-  return fetchSanity(query, true, { processNeedAccess: false, processPageType: false })
+
+  const q = query()
+    .and(`_type == "artist"`)
+    .and(`&& slug.current == '${slug}'`)
+    .select(
+      'name',
+      `"slug": slug.current`,
+      `"thumbnail": thumbnail_url.asset->url`,
+      `"lessonCount": count(*[${filter}])`
+    )
+    .first()
+    .build()
+
+  return fetchSanity(q, true, { processNeedAccess: false, processPageType: false })
 }
 
-export interface ArtistLessonOptions {
-  sort?: string
+export interface ArtistLessonOptions extends BuildQueryOptions {
   searchTerm?: string
-  page?: number
-  limit?: number
   includedFields?: Array<string>
   progressIds?: Array<number>
 }
 
-export interface LessonsByArtistResponse {
+export interface ArtistLessons {
   data: Lesson[]
   total: number
 }
@@ -96,7 +120,7 @@ export interface LessonsByArtistResponse {
  * @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.progressId=[]] - The ids of the lessons that are in progress or completed
- * @returns {Promise<LessonsByArtistResponse|null>} - The lessons for the artist
+ * @returns {Promise<ArtistLessons>} - The lessons for the artist
  *
  * @example
  * fetchArtistLessons('10 Years', 'drumeo', 'song', {'-published_on', '', 1, 10, ["difficulty,Intermediate"], [232168, 232824, 303375, 232194, 393125]})
@@ -110,15 +134,13 @@ export async function fetchArtistLessons(
   {
     sort = '-published_on',
     searchTerm = '',
-    page = 1,
+    offset = 1,
     limit = 10,
     includedFields = [],
     progressIds = [],
   }: ArtistLessonOptions = {}
-): Promise<LessonsByArtistResponse | null> {
+): Promise<ArtistLessons> {
   const fieldsString = getFieldsForContentType(contentType) as string
-  const start = (page - 1) * limit
-  const end = start + limit
   const searchFilter = searchTerm ? `&& title match "${searchTerm}*"` : ''
   const includedFieldsFilter = includedFields.length > 0 ? filtersToGroq(includedFields) : ''
   const addType = contentType ? `_type == '${contentType}' && ` : ''
@@ -128,10 +150,20 @@ export async function fetchArtistLessons(
   const filterWithRestrictions = await new FilterBuilder(filter).buildFilter()
 
   sort = getSortOrder(sort, brand)
-  const query = buildDataAndTotalQuery(filterWithRestrictions, fieldsString, {
-    sort,
-    start: start,
-    end: end,
-  })
-  return fetchSanity(query, true, { processNeedAccess: false, processPageType: false })
+
+  const data = query()
+    .and(filterWithRestrictions)
+    .order(sort)
+    .slice(offset, offset + limit)
+    .select(...(fieldsString ? [fieldsString] : []))
+    .build()
+
+  const total = query().and(filterWithRestrictions).build()
+
+  const q = `{
+    "data": ${data},
+    "total": ${total}
+  }`
+
+  return fetchSanity(q, true, { processNeedAccess: false, processPageType: false })
 }

package/src/services/content/genre.ts

@@ -5,7 +5,7 @@ import { filtersToGroq, getFieldsForContentType } from '../../contentTypeConfig.
 import { fetchSanity, getSortOrder } from '../sanity.js'
 import { FilterBuilder } from '../../filterBuilder.js'
 import { Lesson } from './content'
-import { buildDataAndTotalQuery } from '../../lib/sanity/query'
+import { BuildQueryOptions, query } from '../../lib/sanity/query'
 import { Brands } from '../../lib/brands'
 
 export interface Genre {
@@ -26,20 +26,39 @@ export interface Genre {
  *   .then(genres => console.log(genres))
  *   .catch(error => console.error(error));
  */
-export async function fetchGenres(brand: Brands | string): Promise<Genre[]> {
-  const filter = await new FilterBuilder(`brand == "${brand}" && references(^._id)`, {
+export async function fetchGenres(
+  brand: Brands | string,
+  options: BuildQueryOptions = { sort: 'lower(name) asc' }
+): Promise<Genre[]> {
+  const lessonFilter = await new FilterBuilder(`brand == "${brand}" && references(^._id)`, {
     bypassPermissions: true,
   }).buildFilter()
 
-  const query = `
-  *[_type == 'genre'] {
-    'type': _type,
-    name,
-    "slug": slug.current,
-    'thumbnail': thumbnail_url.asset->url,
-    "lessons_count": count(*[${filter}])
-  } |order(lower(name)) `
-  return fetchSanity(query, true, { processNeedAccess: false, processPageType: false })
+  const data = query()
+    .and(`_type == "genre"`)
+    .order(options.sort || 'lower(name) asc')
+    .slice(options.offset || 0, (options.offset || 0) + (options.limit || 20))
+    .select(
+      'name',
+      `"slug": slug.current`,
+      `"thumbnail": thumbnail_url.asset->url`,
+      `"lessons_count": count(*[${lessonFilter}])`
+    )
+    .postFilter(`lessons_count > 0`)
+    .build()
+
+  const total = query()
+    .and(`_type == "genre"`)
+    .select(`"lessons_count": count(*[${lessonFilter}])`)
+    .postFilter(`lessons_count > 0`)
+    .build()
+
+  const q = `{
+    "data": ${data},
+    "total": ${total}
+  }`
+
+  return fetchSanity(q, true, { processNeedAccess: false, processPageType: false })
 }
 
 /**
@@ -47,7 +66,7 @@ export async function fetchGenres(brand: Brands | string): Promise<Genre[]> {
  *
  * @param {string} slug - The slug of the genre to fetch.
  * @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.
+ * @returns {Promise<Genre | null>} - A promise that resolves to an genre object or null if not found.
  *
  * @example
  * fetchGenreBySlug('drumeo')
@@ -63,27 +82,28 @@ export async function fetchGenreBySlug(
     bypassPermissions: true,
   }).buildFilter()
 
-  const query = `
-  *[_type == 'genre' && slug.current == '${slug}'] {
-    'type': _type, name,
-    name,
-    "slug": slug.current,
-    'thumbnail':thumbnail_url.asset->url,
-    "lessonsCount": count(*[${filter}])
-  }`
-  return fetchSanity(query, true, { processNeedAccess: false, processPageType: false })
+  const q = query()
+    .and(`_type == "genre"`)
+    .and(`slug.current == "${slug}"`)
+    .select(
+      'name',
+      `"slug": slug.current`,
+      `"thumbnail": thumbnail_url.asset->url`,
+      `"lessons_count": count(*[${filter}])`
+    )
+    .first()
+    .build()
+
+  return fetchSanity(q, true, { processNeedAccess: false, processPageType: false })
 }
 
-export interface FetchGenreLessonsOptions {
-  sort?: string
+export interface GenreLessonsOptions extends BuildQueryOptions {
   searchTerm?: string
-  page?: number
-  limit?: number
   includedFields?: Array<string>
   progressIds?: Array<number>
 }
 
-export interface LessonsByGenreResponse {
+export interface GenreLessons {
   data: Lesson[]
   total: number
 }
@@ -99,7 +119,7 @@ export interface LessonsByGenreResponse {
  * @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<LessonsByGenreResponse|null>} - The lessons for the genre
+ * @returns {Promise<GenreLessons|null>} - The lessons for the genre
  *
  * @example
  * fetchGenreLessons('Blues', 'drumeo', 'song', {'-published_on', '', 1, 10, ["difficulty,Intermediate"], [232168, 232824, 303375, 232194, 393125]})
@@ -113,15 +133,13 @@ export async function fetchGenreLessons(
   {
     sort = '-published_on',
     searchTerm = '',
-    page = 1,
+    offset = 1,
     limit = 10,
     includedFields = [],
     progressIds = [],
-  }: FetchGenreLessonsOptions = {}
-): Promise<LessonsByGenreResponse | null> {
+  }: GenreLessonsOptions = {}
+): Promise<GenreLessons> {
   const fieldsString = getFieldsForContentType(contentType) as string
-  const start = (page - 1) * limit
-  const end = start + limit
   const searchFilter = searchTerm ? `&& title match "${searchTerm}*"` : ''
   const includedFieldsFilter = includedFields.length > 0 ? filtersToGroq(includedFields) : ''
   const addType = contentType ? `_type == '${contentType}' && ` : ''
@@ -131,10 +149,20 @@ export async function fetchGenreLessons(
   const filterWithRestrictions = await new FilterBuilder(filter).buildFilter()
 
   sort = getSortOrder(sort, brand)
-  const query = buildDataAndTotalQuery(filterWithRestrictions, fieldsString, {
-    sort: sort,
-    start: start,
-    end: end,
-  })
-  return fetchSanity(query, true, { processNeedAccess: false, processPageType: false })
+  const data = query()
+    .and(filterWithRestrictions)
+    .and(`brand == ${brand}`)
+    .order(sort)
+    .slice(offset, offset + limit)
+    .select(...(fieldsString ? [fieldsString] : []))
+    .build()
+
+  const total = query().and(filterWithRestrictions).build()
+
+  const q = `{
+    "data": ${data},
+    "total": ${total}
+  }`
+
+  return fetchSanity(q, true, { processNeedAccess: false, processPageType: false })
 }