@pocketprep/types 1.9.2 → 1.9.4

package/Study/Class.d.ts

@@ -31,6 +31,32 @@ export type Quiz = Parse.Object<{
 export type QuizJSON = ReturnType<Quiz['toJSON']>
 export type QuizPayload = Payload<Quiz>
 
+export type Platform = 'Android' | 'iOS' | 'Web'
+export type OnboardingResult = 'Free' | 'Monthly' | 'Quarterly' | 'Yearly'
+export type UserConversion = Parse.Object<{
+    user: User | Parse.Pointer
+    mobileAppId?: string        // eg com.pocketprep.app.ems
+    firstExamGuid?: string
+    firstBundleId?: string
+    signedUpOn?: Platform
+    onboardingResult?: OnboardingResult
+    firstQuizSource?: Platform
+    firstSubscriptionSource?: ReceiptSource[keyof ReceiptSource]
+
+    // dates stored in case future metrics require new calculations
+    userCreatedAt: Date
+    onboardedAt?: Date
+    firstQuizAt?: Date
+    firstSubscriptionAt?: Date
+
+    // computed values included for ELK graphs
+    daysToOnboard?: number
+    daysToFirstQuiz?: number
+    daysToFirstSubscription?: number
+    daysFromQuizToSubscription?: number
+}>
+export type UserConversionPayload = Payload<UserConversion>
+
 export type UserExamMetadata = Parse.Object<{
     examGuid: string
     user: User | Parse.Pointer

package/Study/Cloud.d.ts

@@ -23,6 +23,8 @@ import {
     Referral,
     QuestionJSON,
     Question,
+    Platform,
+    OnboardingResult,
 } from './Class'
 
 // DEPRECATED - previously used answer package for a quiz or qotd
@@ -334,6 +336,14 @@ export type fetchUserDataV2 = (params: {
     userExamMetadata: UserExamMetadata | undefined
 }
 
+export type onboardingCompleted = (params: {
+    firstExamGuid: string       // examGuid of exam selected during onboarding
+    firstBundleId: string       // Bundle.objectId of Bundle
+    signedUpOn: Platform        // Android | iOS | Web
+    onboardingResult: OnboardingResult    // Free | Monthly | Quarterly | Yearly
+    mobileAppId?: string        // mobile app id, if applicable.  eg com.pocketprep.app.ems
+}) => void
+
 export type activateLicense = (params: { licenseKey: string }) => Subscription
 
 export type activateLicenseV2 = (params: { licenseKey: string }) => { license: License; subscription: Subscription }[]

package/package.json

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