@pocketprep/types 1.16.6 → 1.16.8

package/Study/Class.d.ts

@@ -35,6 +35,44 @@ export type LevelUpProgress = {
     goal: number
 }
 
+export type RecommendationStyle = 'concept-quiz' | 'next-up' | 'info' 
+
+export type RecommendationCTA = {
+    style: RecommendationStyle
+    label: string
+    message: string
+    buttonLabel: string
+}
+
+export type PremiumRequirement = 'free' | 'premium' | false
+
+export type RecommendationConfig = Parse.Object<Partial<RecommendationCTA> & {
+    recommenderClass: string
+    weight: number
+    cadence: number
+    premiumRequirement: PremiumRequirement
+    ineligibleAfterQuizModes?: number[]
+}>
+
+export type Recommendation = RecommendationCTA & {
+    recommenderClass: string
+    config: {
+        quizMode?: number // Numeric representation of the quiz mode that this recommendation CTA will trigger
+        conceptQuizId?: string // The ID of the ConceptQuiz if a concept quiz is being recommended
+        questionCount?: number // The number of questions to be taken with the recommended quiz
+        retakeQuizId?: string // The ID of the quiz for the user to retake
+        byoConfig?: { // Config to be passed directly thru client to fetchQuizQuestions call
+            subjectIds?: string[]
+            include?: {
+                new?: boolean
+                answered?: boolean
+                flagged?: boolean
+                incorrect?: boolean
+            }
+        }
+    }
+}
+
 export type Quiz = Parse.Object<{
     answers: IQuizAnswer[]
     correctCount: number
@@ -52,6 +90,7 @@ export type Quiz = Parse.Object<{
     conceptQuiz?: ConceptQuiz | Parse.Pointer
     examMetadata?: ExamMetadata | Parse.Pointer
     readiness?: ReadinessModelData[]
+    recommendationConfig?: RecommendationConfig
 }>
 
 export type QuizJSON = ReturnType<Quiz['toJSON']>

package/Study/Cloud.d.ts

@@ -29,6 +29,7 @@ import {
     PrebuiltQuiz,
     UserExamBackgroundJSON,
     ConceptQuiz,
+    Recommendation,
 } from './Class'
 
 // DEPRECATED - previously used answer package for a quiz or qotd
@@ -174,13 +175,7 @@ export type recordQuiz = (
     feedback?: {
         progressDescription?: string
     }
-    recommendedNext?: {
-        type: 'quiz' // eventually this might include other types of recommendations like a blog link
-        quizMode: number
-        message: string
-        conceptQuizId?: string
-        questionCount?: number
-    }
+    recommendedNext?: Recommendation
 }
 
 export type recordQuizAnswers = (params: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pocketprep/types",
-  "version": "1.16.6",
+  "version": "1.16.8",
   "description": "Pocket Prep type declarations",
   "repository": {
     "type": "git",