@pocketprep/types 1.19.24 → 1.19.26

package/API/QuestionMetric.d.ts

@@ -0,0 +1,32 @@
+import { BaseResource } from './BaseResource'
+
+/**
+ * Per-choice answer statistics. Keys follow Parse's `aX` (answers) / `dX`
+ * (distractors) form where X is 1-10; only the choices a question actually has
+ * are present.
+ */
+export type ChoiceStats = Partial<Record<string, number>>
+
+/** Flat, Parse-free global answer statistics for a single question. */
+export interface QuestionMetric extends BaseResource {
+    /** Stable exam identifier the metric belongs to. */
+    examGuid: string
+    /** Serial of the question these stats describe. */
+    questionSerial: string
+    answeredCorrectlyCount: number
+    answeredIncorrectlyCount: number
+    choiceStats: ChoiceStats
+    /** @deprecated Use examMetadataId instead. */
+    examMetadata?: string
+    examMetadataId?: string
+}
+
+export interface SearchQuestionMetricsParams {
+    examMetadataId: string
+    /** Omit (or empty) to fetch every metric for the exam. */
+    serials?: string[]
+}
+
+export interface SearchQuestionMetricsResponse {
+    questionMetrics: QuestionMetric[]
+}

package/API/index.d.ts

@@ -2,6 +2,7 @@ export * from './BaseResource'
 export * from './Bundle'
 export * from './Question'
 export * from './KeywordDefinition'
+export * from './QuestionMetric'
 export * from './Session'
 export * from './User'
 export * from './LevelUp'

package/CMS/Class.d.ts

@@ -421,7 +421,6 @@ export type ExamContentPlan = Parse.Object<{
     planningStartDate?: Date
     expectedExportDate?: Date
     outlineDate?: Date
-    newOutline?: boolean
     versionFrequency?: 'annually' | '2years' | '3years' | '4years'
         | '5years' | '6years' | '7years' | '8years' | '9years'
     objectives?: ('newExam' | 'newMockExam' | 'newQuestions'
@@ -429,7 +428,6 @@ export type ExamContentPlan = Parse.Object<{
         | 'memberConcern' | 'referenceUpdate' | 'other')[]
     upcomingJobSummary?: string
     expectedExport?: 'major' | 'minor' | 'patch'
-    examLinks?: string
     lead?: User | Parse.Pointer
     expectedJobStartDate?: Date
     updateToExamLinks?: boolean

package/Study/Class.d.ts

@@ -462,6 +462,17 @@ export type UserQuizSettings = {
     enableKeyboardShortcuts?: boolean
 }
 
+/**
+ * Config that persists when a user switches between web, iOS and Android. Read it from
+ * `User` the same way as `webConfig`, but grouped into per-feature sub-objects so it can be extended.
+ */
+export type CrossPlatformConfig = {
+    levelUpFreeTrial?: {
+        hasSeenLevelUpTrialSuggestion?: boolean
+        hasUsedLevelUpTrial?: boolean
+    }
+}
+
 export type User = Parse.User<{
     username: string
     email: string
@@ -474,6 +485,7 @@ export type User = Parse.User<{
     sendStudyReminders?: boolean
     version?: string
     webConfig?: UserWebConfig
+    crossPlatformConfig?: CrossPlatformConfig
     currentOrganization?: Teach.Class.Organization
     lastActiveAt?: Date
     quizSettings?: UserQuizSettings

package/Study/Cloud.d.ts

@@ -32,6 +32,7 @@ import {
     RecommendationTip,
     ConceptQuizJSON,
     QuizJSON,
+    CrossPlatformConfig,
 } from './Class'
 
 // DEPRECATED - previously used answer package for a quiz or qotd
@@ -473,6 +474,20 @@ export type fetchUserDataV2 = (params: {
     }
 }
 
+/**
+ * Update the current user's `crossPlatformConfig`.
+ *
+ * `levelUpFreeTrial.hasUsedLevelUpTrial` is deliberately absent,
+ * it is set by the backend on level completion.
+ */
+export type updateCrossPlatformConfig = (params: {
+    crossPlatformConfig: {
+        levelUpFreeTrial?: {
+            hasSeenLevelUpTrialSuggestion?: boolean
+        }
+    }
+}) => CrossPlatformConfig
+
 export type onboardingCompleted = (params: {
     firstExamGuid: string       // examGuid of exam selected during onboarding
     firstBundleId: string       // Bundle.objectId of Bundle

package/package.json

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