@pocketprep/types 1.19.25 → 1.19.27

package/API/Bundle.d.ts

@@ -25,6 +25,7 @@ export interface ExamMetadata extends BaseResource {
     compositeKey: string
     description?: string
     isFree: boolean
+    isLevelUpEnabled: boolean
     /** @deprecated Use mockExamIds instead. */
     mockExams: string[]
     mockExamIds: string[]

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
@@ -680,6 +692,7 @@ export type ExamMetadata = Parse.Object<{
     compositeKey: string
     description: string
     isFree: boolean
+    isLevelUpEnabled: boolean
     mockExams?: (MockExam | Parse.Pointer)[]
     sunsetAt?: Date
     minorVersionMessaging?: {

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.25",
+  "version": "1.19.27",
   "description": "Pocket Prep type declarations",
   "repository": {
     "type": "git",