@pocketprep/types 1.15.9 → 1.15.11

package/AI/index.d.ts

@@ -1,4 +1,25 @@
-import * as Class from './Class'
-import * as Cloud from './Cloud'
+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[]
+}
 
-export { Class, Cloud }

package/Study/Class.d.ts

@@ -1,7 +1,16 @@
 import { IQuizAnswer, IStreakInfo, TChoiceKey } from './Cloud'
 import { Payload, Teach, CMS } from '../index'
 import { OrgStudent } from '../Teach/Class'
-import { Model } from '../AI/Class'
+import { Model } from '../AI'
+
+export type ReadinessModelData = {
+    confidence: number
+    explanation: {
+        feature: string
+        importance: number
+    }[]
+    model: Model
+}
 
 export type MagicToken = Parse.Object<{
     code: string
@@ -41,14 +50,7 @@ export type Quiz = Parse.Object<{
     levelUpProgress?: LevelUpProgress
     prebuiltQuiz?: PrebuiltQuiz | Parse.Pointer
     examMetadata?: ExamMetadata | Parse.Pointer
-    readiness?: {
-        confidence: number
-        explanation: {
-            feature: string
-            importance: number
-        }[]
-        model: Model
-    }[]
+    readiness?: ReadinessModelData[]
 }>
 
 export type QuizJSON = ReturnType<Quiz['toJSON']>
@@ -119,9 +121,10 @@ export type UserExamMetadata = Parse.Object<{
     levelUpResetDates?: Date[]
     aggregateStats?: UEMAggregateStats
     messageConfig?: MessageConfig
-    readinessScore?: number
+    readinessScore?: number // DEPRECATED
     examMetadata?: ExamMetadata | Parse.Pointer
     hasCompletedFreeQuestionBank?: boolean
+    readiness?: ReadinessModelData[]
 }>
 
 export type UserExamMetadataJSON = ReturnType<UserExamMetadata['toJSON']>
@@ -706,6 +709,7 @@ export type SurveyExamResult = Parse.Object<{
     user: User | Parse.Pointer
     readinessScore?: number
     examMetadata?: ExamMetadata | Parse.Pointer
+    readiness?: ReadinessModelData[]
 }>
 
 export type ReadinessStats = {
@@ -750,6 +754,9 @@ export type ReadinessStats = {
     attemptsPerQuestion: number
     uniqueQuizzesRetaken: number
     totalRetakes: number
+    recentWeightedScoreMean: number
+    recentOverallAvgScore: number
+    recentAvgSecondsPerQuestion: number
 }
 type AnswerStats = {
     [serial: string]: {

package/package.json

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

package/AI/Class.d.ts

@@ -1 +0,0 @@
-export type Model = 'xgb_model' | 'rf_model'

package/AI/Cloud.d.ts

@@ -1,13 +0,0 @@
-import { Model } from './Class'
-
-export type calculateReadiness = () => {
-    models: {
-        confidence: number
-        missingKeys: string[]
-        explanation?: {
-            feature: string
-            importance: number
-        }[]
-        model: Model
-    }[]
-}