@pocketprep/types 1.15.8 → 1.15.10

package/AI/index.d.ts

@@ -0,0 +1,25 @@
+import { ReadinessStats } from '../Study/Class'
+
+export type Model = 'xgb_model' | 'rf_model'
+
+export type calculateReadinessRequest = ReadinessStats & {
+    models: Model[],
+    explain?: boolean
+    examGuid: string
+    bundleId?: string
+}
+
+export type ReadinessModelResponse = {
+    confidence: number
+    missingKeys: string[]
+    explanation?: {
+        feature: string
+        importance: number
+    }[]
+    model: Model
+}
+
+export type calculateReadinessResponse = {
+    models: ReadinessModelResponse[]
+}
+

package/Study/Class.d.ts

@@ -1,6 +1,7 @@
 import { IQuizAnswer, IStreakInfo, TChoiceKey } from './Cloud'
 import { Payload, Teach, CMS } from '../index'
 import { OrgStudent } from '../Teach/Class'
+import { Model } from '../AI/Class'
 
 export type MagicToken = Parse.Object<{
     code: string
@@ -25,18 +26,6 @@ export type LevelUpProgress = {
     goal: number
 }
 
-export type Models = 'xgb_model' | 'rf_model'
-
-export type Readiness = {
-    failProbability: number
-    passProbability: number
-    explanation: {
-        feature: string
-        importance: number
-    }[]
-    model: Models
-}
-
 export type Quiz = Parse.Object<{
     answers: IQuizAnswer[]
     correctCount: number
@@ -52,7 +41,14 @@ export type Quiz = Parse.Object<{
     levelUpProgress?: LevelUpProgress
     prebuiltQuiz?: PrebuiltQuiz | Parse.Pointer
     examMetadata?: ExamMetadata | Parse.Pointer
-    readiness?: Readiness[]
+    readiness?: {
+        confidence: number
+        explanation: {
+            feature: string
+            importance: number
+        }[]
+        model: Model
+    }[]
 }>
 
 export type QuizJSON = ReturnType<Quiz['toJSON']>
@@ -123,9 +119,17 @@ export type UserExamMetadata = Parse.Object<{
     levelUpResetDates?: Date[]
     aggregateStats?: UEMAggregateStats
     messageConfig?: MessageConfig
-    readinessScore?: number
+    readinessScore?: number // DEPRECATED
     examMetadata?: ExamMetadata | Parse.Pointer
     hasCompletedFreeQuestionBank?: boolean
+    readiness?: {
+        confidence: number
+        explanation: {
+            feature: string
+            importance: number
+        }[]
+        model: Model
+    }[]
 }>
 
 export type UserExamMetadataJSON = ReturnType<UserExamMetadata['toJSON']>
@@ -754,6 +758,9 @@ export type ReadinessStats = {
     attemptsPerQuestion: number
     uniqueQuizzesRetaken: number
     totalRetakes: number
+    recentWeightedScoreMean: number
+    recentOverallAvgScore: number
+    recentAvgSecondsPerQuestion: number
 }
 type AnswerStats = {
     [serial: string]: {

package/index.d.ts

@@ -2,11 +2,13 @@
 import * as Study from './Study'
 import * as CMS from './CMS'
 import * as Teach from './Teach'
+import * as AI from './AI'
 
 export {
     Study,
     CMS,
     Teach,
+    AI,
 }
 
 export type Payload<T extends Parse.Object> = T extends Parse.Object<infer R>

package/package.json

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