@pocketprep/types 1.14.18 → 1.14.20

package/Study/Class.d.ts

@@ -11,6 +11,7 @@ export type OrderedQuestions = Parse.Object<{
     examGuid: string
     serials: string[]
     version: string
+    examMetadata?: ExamMetadata | Parse.Pointer
 }>
 
 export type OrderedQuestionsPayload = Payload<OrderedQuestions>
@@ -37,6 +38,7 @@ export type Quiz = Parse.Object<{
     readinessScore?: number
     levelUpProgress?: LevelUpProgress
     prebuiltQuiz?: PrebuiltQuiz | Parse.Pointer
+    examMetadata?: ExamMetadata | Parse.Pointer
 }>
 
 export type QuizJSON = ReturnType<Quiz['toJSON']>
@@ -108,6 +110,7 @@ export type UserExamMetadata = Parse.Object<{
     aggregateStats?: UEMAggregateStats
     messageConfig?: MessageConfig
     readinessScore?: number
+    examMetadata?: ExamMetadata | Parse.Pointer
 }>
 
 export type UserExamMetadataJSON = ReturnType<UserExamMetadata['toJSON']>
@@ -218,11 +221,13 @@ export type GlobalQuestionMetric = Parse.Object<{
     answeredCorrectlyCount?: number
     answeredIncorrectlyCount?: number
     questionSerial: string
-    examType: string
+    examType?: string
     examGuid: string
     choiceStats: Partial<Record<TChoiceKey, number>>
+    examMetadata?: ExamMetadata | Parse.Pointer
 }>
 
+export type GlobalQuestionMetricPayload = Payload<GlobalQuestionMetric>
 export type GlobalQuestionMetricJSON = ReturnType<GlobalQuestionMetric['toJSON']>
 
 export type License = Parse.Object<{
@@ -337,14 +342,15 @@ export type User = Parse.User<{
     studyRemindersFrequency?: string
     studyRemindersEmail?: string
     sendStudyReminders?: boolean
-    currentExamGuid?: string
-    currentApp?: string
     version?: string
     webConfig?: UserWebConfig
     currentOrganization?: Teach.Class.Organization
     lastActiveAt?: Date
     quizSettings?: UserQuizSettings
     deleteRequestedDate?: Date
+    currentUserExamMetadata?: UserExamMetadata | Parse.Pointer
+    currentExamGuid?: string // DEPRECATED
+    currentApp?: string // DEPRECATED
 }>
 
 export type UserJSON = ReturnType<User['toJSON']>
@@ -423,6 +429,7 @@ export type QuestionScenarioJSON = ReturnType<QuestionScenario['toJSON']>
 export type KeywordDefinition = Parse.Object<{
     examGuid: string
     serial: string
+    examMetadata?: ExamMetadata | Parse.Pointer
     keyword: string
     definition: string
     voteCountHelpful: number
@@ -617,6 +624,7 @@ export type SurveyExamResult = Parse.Object<{
     source: string
     user: User | Parse.Pointer
     readinessScore?: number
+    examMetadata?: ExamMetadata | Parse.Pointer
 }>
 
 export type ReadinessStats = {
@@ -717,9 +725,10 @@ export type RecentActivity = {
     durationSeconds: number
 }
 export type AggregateStats = Parse.Object<{
-    user: User
+    user: User | Parse.Pointer
     examGuid: string
     majorVersion: number
+    examMetadata?: ExamMetadata | Parse.Pointer
     answerStats: AnswerStats
     quizStats: QuizStats
     counts: AggregateCounts
@@ -733,6 +742,8 @@ export type AggregateStats = Parse.Object<{
     }[]
 }>
 
+export type AggregateStatsPayload = Payload<AggregateStats>
+
 export type PrebuiltQuiz = Parse.Object<{
     name: string
     key: string

package/Study/Cloud.d.ts

@@ -95,6 +95,7 @@ export interface IRecordQuizPayload {
     levelSubjectId?: string
     appBundleId?: string
     prebuiltQuizId?: string
+    examMetadataId?: string
 }
 
 export type TLevelUpProgress = NonNullable<UserExamMetadataJSON['levelUpProgress']>
@@ -223,6 +224,7 @@ export type fetchQotDV4 = (params: {
     examGuid: string
     version: string
     includeMatrixQuestions?: boolean
+    examMetadataId?: string
 }) => Question[]
 
 export type fetchQotDV5 = (params: {
@@ -231,6 +233,7 @@ export type fetchQotDV5 = (params: {
     examGuid: string
     version: string
     includeMatrixQuestions?: boolean
+    examMetadataId?: string
 }) => QuestionJSON[]
 
 export type fetchSharedQotd = (params: {
@@ -259,6 +262,7 @@ export type fetchSharedQotdV3 = (params: {
     daysSinceEpoch: number
     examGuid: string
     version: string
+    examMetadataId?: string
 }) => {
     bundle?: Bundle
     examMetadata: ExamMetadata
@@ -269,6 +273,7 @@ export type fetchSharedQotdV3 = (params: {
 export type fetchGlobalQuestionMetrics = (params: {
     examGuid: string
     serials?: string[]
+    examMetadataId?: string
 }) => GlobalQuestionMetric[]
 
 export type fetchQuizQuestions = (params: {
@@ -316,6 +321,7 @@ export type fetchQuizQuestionsV4 = (params: {
         incorrect?: boolean
     }
     includeMatrixQuestions?: boolean
+    examMetadataId?: string
 }) => QuestionJSON[]
 
 export type fetchQuizQuestionsV5 = (params: {
@@ -331,6 +337,7 @@ export type fetchQuizQuestionsV5 = (params: {
         incorrect?: boolean
     }
     includeMatrixQuestions?: boolean
+    examMetadataId?: string
 }) => QuestionJSON[]
 
 export type fetchFlaggedQuestionKnowledgeAreas =
@@ -385,6 +392,7 @@ export type fetchUserData = (params: {
 
 export type fetchUserDataV2 = (params: {
     examGuid: string
+    examMetadataId?: string
     lastFetchedAt?: string  // ISO8901 date string
     version?: string
     includeQuestionMetrics?: boolean
@@ -437,7 +445,10 @@ export type resetUserExamProgress = (params: { appId: string }) => (
     UserExamMetadata | TEUserAppMetadata | undefined
 )
 
-export type resetQuizProgress = (params: { examGuid: string }) => UserExamMetadata | undefined
+export type resetQuizProgress = (params: { 
+    examGuid: string
+    examMetadataId?: string
+}) => UserExamMetadata | undefined
 
 export type buySubscription = (params: {
     stripeToken?: Stripe.Token
@@ -621,6 +632,7 @@ export type fetchLevelUpQuizQuestionsV2 = (params: {
     subjectId?: string
     lastResetDateISO?: string
     includeMatrixQuestions?: boolean
+    examMetadataId?: string
 }) => QuestionJSON[]
 
 export type fetchLevelUpQuizQuestionsV3 = (params: {
@@ -632,6 +644,7 @@ export type fetchLevelUpQuizQuestionsV3 = (params: {
     subjectName?: string
     lastResetDateISO?: string
     includeMatrixQuestions?: boolean
+    examMetadataId?: string
 }) => QuestionJSON[]
 
 export type fetchSubjectsWithLevels = (params: {
@@ -656,6 +669,7 @@ export type resetLevelUpProgress = (params: {
     majorVersion: string
     subjectNames?: string[]
     subjectIds?: string[]
+    examMetadataId?: string
 }) => TLevelUpProgress
 
 export type fetchReferralInfo = (params: { bundleId: string }) => {
@@ -671,13 +685,50 @@ export type fetchPrebuiltQuizQuestions = (params: { prebuiltQuizId: string }) =>
 export type fetchQuestionsByExamV2 = (params: {
     compositeKey: string
     includeMatrixQuestions?: boolean
+    examMetadataId?: string
 }) => Question[]
 
 export type fetchQuestionsByExamV3 = (params: {
     compositeKey: string
     includeMatrixQuestions?: boolean
+    examMetadataId?: string
 }) => QuestionJSON[]
 
 export type fetchExamNamesByQuestionSerials = (params: { serials: string[] }) => {
     [serial: string]: string[]
-}
+}
+
+export type updateCurrentExam = (params: { examMetadataId: string }) => UserExamMetadataJSON
+
+export type CustomerIOCustomer = {
+    id: string
+    identifiers: {
+        cio_id: string
+        email: string
+        id: string
+    }
+    topics: {
+        id: number
+        subscribed: boolean
+        name: string
+        description: string
+    }[]
+    unsubscribed: boolean // can be true even with topics listed
+}
+
+export type fetchUserSubscriptionSettingsV2 = (params: {
+    userId: string
+    secret: string
+}) => Promise<undefined |{
+    email: string
+    studyReminders?: string
+    customerioSubscriptions: CustomerIOCustomer['topics']
+}>
+
+export type updateSubscriptionSettingsV2 = (params: {
+    userId: string
+    secret: string
+    subscribedTopicIds: string[]
+    studyReminders: 'weekly' | 'daily' | false
+    messageId?: string
+}) => Promise<void>

package/Teach/Cloud.d.ts

@@ -64,11 +64,13 @@ export type createAssignment = (params: {
         questionCount?: number
         subjectIds?: string[]
     }
+    examMetadataId?: string
 }) => Study.Class.PrebuiltQuiz
 
 export type fetchQuestionDifficultyCounts = (params: {
     examGuid: string
     majorVersion: string
+    examMetadataId?: string
 }) => {
     [subjectId: string]: {
         easy: number

package/package.json

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