@pocketprep/types 1.19.31 → 1.19.33

package/Study/Class.d.ts

@@ -666,9 +666,10 @@ export type MockExamJSON = ReturnType<MockExam['toJSON']>
 export type MockExamPayload = Payload<MockExam>
 
 export type Reference = Parse.Object<{
-    citationTemplate: string
+    citationTemplate?: string // DEPRECATED: use source instead
     weaviateCollectionName?: string // DEPRECATED: use documentId instead
     documentId: string
+    source: string
     name?: string
     isbn13?: string
     filename?: string
@@ -940,6 +941,49 @@ export type AggregateStats = Parse.Object<{
 export type AggregateStatsPayload = Payload<AggregateStats>
 export type AggregateStatsJSON = ReturnType<AggregateStats['toJSON']>
 
+export type LatestAnswerBySerial = { [serial: string]: boolean }
+
+export type SubjectStudyStats = {
+    subjectId: string
+    name: string
+    totalAnswersCount: number
+    totalCorrectAnswersCount: number
+    averageScore: number
+}
+
+/**
+ * The stats calculated from a user's accumulated answers and the exam's question bank
+ */
+export type ComputedStudyStats = {
+    totalAnswersCount: number
+    totalCorrectAnswersCount: number
+    averageScore: number
+    totalQuizzesCount: number // Excludes QotD and Mock Exams
+    daysStudyingCount: number
+    studyingDurationSeconds: number // Excludes Mock Exams
+    subjectStats: SubjectStudyStats[]
+    unansweredCount: {
+        premium: number
+        free: number
+    }
+}
+
+/**
+ * A user's study stats for one exam version, one document per user per version.
+ */
+export type StudyStats = Parse.Object<{
+    user: User | Parse.Pointer
+    examMetadata: ExamMetadata | Parse.Pointer
+    latestAnswerBySerial: LatestAnswerBySerial
+    quizCount: number // Excludes QotD and Mock Exams
+    studyDays: string[]
+    durationSeconds: number // Excludes Mock Exams
+    studyStats: ComputedStudyStats
+}>
+
+export type StudyStatsPayload = Payload<StudyStats>
+export type StudyStatsJSON = ReturnType<StudyStats['toJSON']>
+
 export type PrebuiltQuiz = Parse.Object<{
     name: string
     questionSerials: string[]

package/Study/Cloud.d.ts

@@ -33,6 +33,7 @@ import {
     ConceptQuizJSON,
     QuizJSON,
     CrossPlatformConfig,
+    ComputedStudyStats,
 } from './Class'
 
 // DEPRECATED - previously used answer package for a quiz or qotd
@@ -106,6 +107,17 @@ export interface IRecordQuizPayload {
     includeRecommendedNext?: boolean
     includeReadiness?: boolean
     includeConceptQuiz?: boolean
+    includeStudyStats?: boolean
+}
+
+/**
+ * The study stats a client renders on its stats page.
+ * Calculated on the server so that all clients show the same values.
+ */
+export type TStudyStats = Omit<ComputedStudyStats, 'unansweredCount'> & {
+    totalUnansweredCount: number
+    examCommunityAverage: number
+    weakestSubjectId?: string
 }
 
 export type TLevelUpProgress = NonNullable<UserExamMetadataJSON['levelUpProgress']>
@@ -193,6 +205,7 @@ export type recordQuizV2 = (
     }
     tip: RecommendationTip | null
     recommendedNext: Recommendation | null
+    studyStats?: TStudyStats
 }
 
 export type recordQuizAnswers = (params: {
@@ -442,9 +455,11 @@ export type fetchUserDataV2 = (params: {
     lastFetchedAt?: string  // ISO8901 date string
     version?: string
     includeQuestionMetrics?: boolean
+    includeStudyStats?: boolean
 }) => {
     quizzes: QuizJSON[]
     subscriptions: Subscription[]
+    studyStats?: TStudyStats
     user: User
     userExamMetadata: UserExamMetadata | undefined
     referralInfo: {

package/package.json

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