musora-content-services 2.184.1 → 2.185.0

package/.claude/settings.local.json

@@ -0,0 +1,35 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(rg:*)",
+      "Bash(npm run lint:*)",
+      "Bash(ls:*)",
+      "Bash(npm test *)",
+      "Bash(npx jest *)"
+    ],
+    "deny": []
+  },
+  "enabledMcpjsonServers": [
+    "1password",
+    "atlassian",
+    "figma",
+    "google-workspace",
+    "snowflake",
+    "aws",
+    "hex",
+    "sanity",
+    "mysql",
+    "slack",
+    "langfuse",
+    "chrome-devtools",
+    "railway",
+    "github",
+    "asana",
+    "nightwatch",
+    "mysql-staging",
+    "mysql-local",
+    "mobile",
+    "sentry",
+    "customerio"
+  ]
+}

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.185.0](https://github.com/railroadmedia/musora-content-services/compare/v2.184.1...v2.185.0) (2026-10-01)
+
+
+### Features
+
+* **BEHLTP-380:** preroll LP intros ([#1066](https://github.com/railroadmedia/musora-content-services/issues/1066)) ([4706a1f](https://github.com/railroadmedia/musora-content-services/commit/4706a1f19d15ddfd409a85d2d8ebb1f70e134a99))
+
 ### [2.184.1](https://github.com/railroadmedia/musora-content-services/compare/v2.184.0...v2.184.1) (2026-09-28)
 
 

package/dist/services/api/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

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

package/src/contentTypeConfig.js

@@ -549,6 +549,7 @@ export let contentTypeConfig = {
   'learning-path-v2': {
     fields: [
       `"intro_video": intro_video->{ ${getIntroVideoFields('learning-path-v2').join(', ')} }`,
+      `"preroll": intro_video->{ ${getPrerollFields().join(', ')} }`,
       'total_skills',
       `"resource": ${resourcesField}`,
     ],
@@ -693,6 +694,7 @@ export let contentTypeConfig = {
       "thumbnail": thumbnail.asset->url,
       length_in_seconds,
       intro_video,
+      "preroll": intro_video,
       child[]->{
         ${DEFAULT_FIELDS.join(',')}
       }
@@ -728,6 +730,20 @@ export function getIntroVideoFields(type) {
   return fields
 }
 
+export function getPrerollFields() {
+  return [
+    `"id": railcontent_id`,
+    'title',
+    'brand',
+    `"instructor": ${instructorField}`,
+    `"type": _type`,
+    `"description": ${descriptionField}`,
+    `"thumbnail": thumbnail.asset->url`,
+    'length_in_seconds',
+    'video',
+  ]
+}
+
 export const plusMembershipPermissions = 92
 
 /**

package/src/index.d.ts

@@ -251,6 +251,11 @@ import {
 	storeQuizAnswers
 } from './services/my-path/placement-quiz.ts';
 
+import {
+	completeMyPathIntroVideo,
+	completePreroll
+} from './services/my-path/preroll.ts';
+
 import {
 	deleteAllNotifications,
 	deleteNotification,
@@ -584,6 +589,8 @@ declare module 'musora-content-services' {
 		closeComment,
 		completeLearningPathIntroVideo,
 		completeMethodIntroVideo,
+		completeMyPathIntroVideo,
+		completePreroll,
 		confirmEmailChange,
 		contentStatusCompleted,
 		contentStatusCompletedMany,

package/src/index.js

@@ -255,6 +255,11 @@ import {
 	storeQuizAnswers
 } from './services/my-path/placement-quiz.ts';
 
+import {
+	completeMyPathIntroVideo,
+	completePreroll
+} from './services/my-path/preroll.ts';
+
 import {
 	deleteAllNotifications,
 	deleteNotification,
@@ -583,6 +588,8 @@ export {
 	closeComment,
 	completeLearningPathIntroVideo,
 	completeMethodIntroVideo,
+	completeMyPathIntroVideo,
+	completePreroll,
 	confirmEmailChange,
 	contentStatusCompleted,
 	contentStatusCompletedMany,

package/src/services/contentAggregator.js

@@ -127,12 +127,12 @@ export async function addContextToContent(dataPromise, ...dataArgs) {
  * Key behaviors:
  * 1. Enriches all learning paths in a method structure
  * 2. Auto-sets collection for learning-path-v2 items when no collection specified
- * 3. Enriches intro videos when dataField_includeIntroVideo is true
+ * 3. Enriches LP preroll when dataField_includePreroll is true
  *
  * @param dataPromise - promise or method that provides sanity data
  * @param dataArgs - Arguments to pass to the dataPromise
  * @param options - Same as addContextToContent, plus:
- * @param options.dataField_includeIntroVideo - If true, adds progress to intro_video field where it exists
+ * @param options.dataField_includePreroll - If true, adds progress to preroll (and intro_video for FF) field where it exists
  *
  * @returns {Promise<Object | false>} - Enriched data or false if no data found
  *
@@ -140,7 +140,7 @@ export async function addContextToContent(dataPromise, ...dataArgs) {
  * // Enrich method structure with all learning paths
  * const method = await addContextToMethodContent(fetchMethodV2Structure, brand, {
  *   dataField: 'learningPaths',
- *   dataField_includeIntroVideo: true,
+ *   dataField_includePreroll: true,
  *   addProgressStatus: true,
  *   addProgressPercentage: true,
  * })
@@ -151,7 +151,7 @@ export async function addContextToContent(dataPromise, ...dataArgs) {
  *   collection: { id: lpId, type: 'learning-path-v2' },
  *   dataField: 'children',
  *   dataField_includeParent: true,
- *   dataField_includeIntroVideo: true,
+ *   dataField_includePreroll: true,
  *   addProgressStatus: true,
  * })
  */
@@ -163,7 +163,7 @@ export async function addContextToLearningPaths(dataPromise, ...dataArgs) {
   const {
     dataField = null,
     dataField_includeParent = false,
-    dataField_includeIntroVideo = false,
+    dataField_includePreroll = false,
     addProgressPercentage = false,
     addProgressStatus = false,
     addProgressTimestamp = false,
@@ -175,8 +175,9 @@ export async function addContextToLearningPaths(dataPromise, ...dataArgs) {
   } = options
 
   let dataFields = dataField ? [dataField] : []
-  if (dataField_includeIntroVideo) {
-    dataFields.push('intro_video')
+  if (dataField_includePreroll) {
+    dataFields.push('preroll')
+    dataFields.push('intro_video') // todo: remove intro_video things when My Path feature flag is removed.
   }
 
   const dataParam = lastArg === options ? dataArgs.slice(0, -1) : dataArgs
@@ -187,7 +188,7 @@ export async function addContextToLearningPaths(dataPromise, ...dataArgs) {
   if (!data) return false
 
   let items, recordIds
-  [data, items, recordIds] = addRecordIdsToData(data, dataField, isDataAnArray, dataField_includeParent, dataField_includeIntroVideo) ?? []
+  [data, items, recordIds] = addRecordIdsToData(data, dataField, isDataAnArray, dataField_includeParent, dataField_includePreroll) ?? []
   if (items.length === 0) return data
 
   const ids = recordIds.map(item => extractFromRecordId(item).contentId)
@@ -304,7 +305,7 @@ function extractItemsFromData(data, dataField, isParentArray, includeParent) {
   return items
 }
 
-function addRecordIdsToData(data, dataField, isDataAnArray, includeParent, includeIntroVideo) {
+function addRecordIdsToData(data, dataField, isDataAnArray, includeParent, includePreroll) {
   let items = []
   let recordIds = []
 
@@ -317,10 +318,11 @@ function addRecordIdsToData(data, dataField, isDataAnArray, includeParent, inclu
         items.push(content)
         recordIds.push(content.record_id)
       }
-      if (includeIntroVideo && content.intro_video?.id) {
-        content.intro_video.record_id = generateRecordId(content.intro_video.id, null)
-        items.push(content.intro_video)
-        recordIds.push(content.intro_video.record_id)
+      if (includePreroll && content.preroll?.id) {
+        content.preroll.record_id = generateRecordId(content.preroll.id, null)
+        content.intro_video.record_id = generateRecordId(content.intro_video.id, null) // for My Path feature flag, maintaining Method functionality.
+        items.push(content.preroll)
+        recordIds.push(content.preroll.record_id)
       }
       if (dataField) {
         for (const child of content[dataField] ?? []) {

package/src/services/my-path/dev/map-types.ts

@@ -9,7 +9,7 @@ interface LearningPath {
   title: string
   difficulty?: number
   branch: Branch
-  intro_video_id?: number // only if we have intro videos
+  preroll_id?: number
   published_on?: string
   // ... any other content-related fields we need
 }

package/src/services/my-path/learning-paths.ts

@@ -18,7 +18,7 @@ import {
   contentStatusReset,
   getAllCompletedByIds,
   getIdsWhereLastAccessedFromMethod,
-  getProgressState, 
+  getProgressState,
   resetStatus,
 } from '../contentProgress.js'
 import { COLLECTION_ID_SELF, COLLECTION_TYPE, CollectionParameter, STATE } from '../sync/models/ContentProgress'
@@ -254,7 +254,7 @@ export async function getEnrichedLearningPath(learningPathId: number) {
     {
       dataField: 'children',
       dataField_includeParent: true,
-      dataField_includeIntroVideo: true,
+      dataField_includePreroll: true,
       addProgressStatus: true,
       addProgressPercentage: true,
       addProgressTimestamp: true,
@@ -286,7 +286,7 @@ export async function getEnrichedLearningPaths(learningPathIds: number[]) {
     {
       dataField: 'children',
       dataField_includeParent: true,
-      dataField_includeIntroVideo: true,
+      dataField_includePreroll: true,
       addProgressStatus: true,
       addProgressPercentage: true,
       addProgressTimestamp: true,
@@ -484,6 +484,7 @@ export async function fetchLearningPathLessons(
  *
  * @param {number[]} contentIds The array of content IDs within the learning path
  * @returns {Promise<number[]>} Array with completed content IDs
+ * @deprecated Only use for Method behaviour. Learning path progress import is removed in My Path. Kept for backwards compatibility for Method.
  */
 export async function fetchLearningPathProgressCheckLessons(
   contentIds: number[],
@@ -505,6 +506,7 @@ interface completeMethodIntroVideo {
  * @returns {Promise<Array>} response - The response object.
  * @returns {Promise<Object|null>} response.intro_video_response - The intro video completion response or null if already completed.
  * @returns {Promise<Object>} response.active_path_response - The set active learning path response.
+ * @deprecated Only use for Method behaviour. For My Path, call `completeMyPathIntroVideo` instead.
  */
 export async function completeMethodIntroVideo(
   introVideoId: number | null,
@@ -563,6 +565,7 @@ interface completeLearningPathIntroVideo {
  * @returns {Promise<void>} response.learning_path_reset_response - The reset learning path response.
  * @returns {Promise<Object[]>} response.lesson_import_response - The responses for completing each content_id within the learning path.
  * @returns {Promise<Object|null>} response.update_dailies_response - The updated daily session if it was changed.
+ * @deprecated Only use for Method behaviour. For My Path, use `completePreroll` from `my-path/preroll.ts`.
  */
 export async function completeLearningPathIntroVideo(
   introVideoId: number,

package/src/services/my-path/placement-quiz.ts

@@ -14,6 +14,7 @@ interface PlacementQuizAnswers {
   gear: string[]
 }
 
+// todo(BEHLTP-494): return recommended_content too.
 interface PlacementQuizResponse {
   user_id: string
   brand: string

package/src/services/my-path/preroll.ts

@@ -0,0 +1,35 @@
+/**
+ * @module MyPathPreroll
+ */
+import { contentStatusCompleted, getProgressState } from '../contentProgress.js'
+import { SyncWriteDTO } from '../sync'
+import { ContentProgress } from '../sync/models'
+import { STATE } from '../sync/models/ContentProgress'
+import { fetchQuizAnswers } from './placement-quiz'
+
+export async function completePreroll(
+  prerollId: number
+): Promise<SyncWriteDTO<ContentProgress, any> | null> {
+  return await completeIfNotCompleted(prerollId)
+}
+
+interface completeMyPathIntroVideo {
+  placement_quiz: any
+  recommended_content: any
+}
+
+export async function completeMyPathIntroVideo(
+  introVideoId: number,
+  brand: string,
+): Promise<any> {
+  completeIfNotCompleted(introVideoId) // no need to wait for result
+
+  return await fetchQuizAnswers(brand)
+}
+
+async function completeIfNotCompleted(
+  contentId: number,
+): Promise<SyncWriteDTO<ContentProgress, any> | null> {
+  const status = await getProgressState(contentId)
+  return status !== STATE.COMPLETED ? await contentStatusCompleted(contentId) : null
+}

package/src/services/sanity.js

@@ -2326,6 +2326,7 @@ export async function fetchMethodV2IntroVideo(brand) {
  * Fetch the structure (just ids) of the Method for a given brand.
  * @param brand
  * @returns {Promise<*|null>}
+ * @deprecated Kept for backwards compatibility for Method.
  */
 export async function fetchMethodV2Structure(brand) {
   const _type = 'method-v2'
@@ -2338,6 +2339,7 @@ export async function fetchMethodV2Structure(brand) {
       status,
       published_on,
       'intro_video_id': intro_video->railcontent_id,
+      'preroll_id': intro_video->railcontent_id,
       'children': child[]->railcontent_id
     }
   }`
@@ -2356,6 +2358,7 @@ export async function devFetchAllLearningPathsAndIntroVideoIdsForDelete() {
  * Fetch the structure (just ids) of the Method of a given learning path or learning path lesson.
  * @param contentId
  * @returns {Promise<*|null>}
+ * @deprecated Kept for backwards compatibility for Method.
  */
 export async function fetchMethodV2StructureFromId(contentId) {
   const _type = 'method-v2'
@@ -2366,6 +2369,7 @@ export async function fetchMethodV2StructureFromId(contentId) {
     'learning_paths': child[]->{
       'id': railcontent_id,
       'intro_video_id': intro_video->railcontent_id,
+      'preroll_id': intro_video->railcontent_id,
       'children': child[]->railcontent_id
     }
   }`

package/src/version-info.js

@@ -1 +1 @@
-export const MCS_VERSION = '2.184.1'
+export const MCS_VERSION = '2.185.0'

package/.idea/codeStyles/Project.xml

@@ -1,61 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <code_scheme name="Project" version="173">
-    <HTMLCodeStyleSettings>
-      <option name="HTML_SPACE_INSIDE_EMPTY_TAG" value="true" />
-    </HTMLCodeStyleSettings>
-    <JSCodeStyleSettings version="0">
-      <option name="USE_SEMICOLON_AFTER_STATEMENT" value="false" />
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
-      <option name="USE_DOUBLE_QUOTES" value="false" />
-      <option name="FORCE_QUOTE_STYlE" value="true" />
-      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </JSCodeStyleSettings>
-    <TypeScriptCodeStyleSettings version="0">
-      <option name="USE_SEMICOLON_AFTER_STATEMENT" value="false" />
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
-      <option name="USE_DOUBLE_QUOTES" value="false" />
-      <option name="FORCE_QUOTE_STYlE" value="true" />
-      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </TypeScriptCodeStyleSettings>
-    <VueCodeStyleSettings>
-      <option name="INTERPOLATION_NEW_LINE_AFTER_START_DELIMITER" value="false" />
-      <option name="INTERPOLATION_NEW_LINE_BEFORE_END_DELIMITER" value="false" />
-    </VueCodeStyleSettings>
-    <codeStyleSettings language="HTML">
-      <option name="SOFT_MARGINS" value="100" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="JavaScript">
-      <option name="SOFT_MARGINS" value="100" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="TypeScript">
-      <option name="SOFT_MARGINS" value="100" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="Vue">
-      <option name="SOFT_MARGINS" value="100" />
-      <indentOptions>
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-  </code_scheme>
-</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <state>
-    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
-  </state>
-</component>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/musora-content-services.iml" filepath="$PROJECT_DIR$/.idea/musora-content-services.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/musora-content-services.iml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/php.xml

@@ -1,19 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="MessDetectorOptionsConfiguration">
-    <option name="transferred" value="true" />
-  </component>
-  <component name="PHPCSFixerOptionsConfiguration">
-    <option name="transferred" value="true" />
-  </component>
-  <component name="PHPCodeSnifferOptionsConfiguration">
-    <option name="highlightLevel" value="WARNING" />
-    <option name="transferred" value="true" />
-  </component>
-  <component name="PhpStanOptionsConfiguration">
-    <option name="transferred" value="true" />
-  </component>
-  <component name="PsalmOptionsConfiguration">
-    <option name="transferred" value="true" />
-  </component>
-</project>

package/.idea/prettier.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="PrettierConfiguration">
-    <option name="myConfigurationMode" value="AUTOMATIC" />
-  </component>
-</project>

package/.idea/vcs.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="Git" />
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>