@vrplatform/log 2.0.81 → 2.0.83

package/build/main/tracking/types.d.ts

@@ -57,12 +57,15 @@ export type GroupProps = OptionalUser<{
 }>;
 export type TrackingEventProps = {
     account_invitation_accepted: AccountInvitationAcceptedProps;
-    account_signed_out: AccountSignedOutProps;
-    account_signin_completed: AccountSigninCompletedProps;
+    account_signup_started: AccountSignupStartedProps;
     account_signup_code_requested: AccountSignupCodeRequestedProps;
-    account_signup_code_completed: AccountSignupCodeCompletedProps;
     account_signup_code_failed: AccountSignupCodeFailedProps;
+    account_signup_code_completed: AccountSignupCodeCompletedProps;
     account_signup_completed: AccountSignupCompletedProps;
+    onboarding_account_settings_set: OnboardingAccountSettingsSetProps;
+    onboarding_completed: OnboardingCompletedProps;
+    account_signed_out: AccountSignedOutProps;
+    account_signin_completed: AccountSigninCompletedProps;
     account_password_reset_requested: AccountPasswordResetRequestedProps;
     account_password_reset_failed: AccountPasswordResetFailedProps;
     account_password_reset_completed: AccountPasswordResetCompletedProps;
@@ -152,49 +155,30 @@ type AccountInvitationAcceptedProps = MaybePartial<{
     tenantId: string;
     isNewUser: boolean;
 }>;
-type AccountPasswordResetCompletedProps = MaybePartial<{
-    userEmail: string;
-}>;
-type AccountPasswordResetFailedProps = MaybePartial<{
-    userEmail: string;
-    status: 'needs_second_factor' | 'needs_identifier' | 'needs_first_factor' | 'needs_new_password' | null | any;
+type AccountSignupStartedProps = MaybePartial<{
+    type: 'owner' | 'property_manager' | 'partner';
 }>;
-type AccountPasswordResetRequestedProps = MaybePartial<{
-    userEmail: string;
-}>;
-type AccountSignedOutProps = MaybePartial<{
-    userId: string;
-    userEmail: string;
-    tenantId: string;
-    firstName: string;
-    lastName: string;
-}>;
-type AccountSigninCompletedProps = MaybePartial<{
-    firstName: string;
-    lastName: string;
-    userEmail: string;
-}>;
-type AccountSignupCodeCompletedProps = MaybePartial<{
+type AccountSignupCodeRequestedProps = MaybePartial<{
     firstName: string;
     lastName: string;
     userEmail: string;
     companyName: string;
-    type: 'property_manager' | 'partner';
+    type: 'owner' | 'property_manager' | 'partner';
 }>;
 type AccountSignupCodeFailedProps = MaybePartial<{
     firstName: string;
     lastName: string;
     userEmail: string;
     companyName: string;
-    type: 'property_manager' | 'partner';
+    type: 'owner' | 'property_manager' | 'partner';
     status: 'missing_requirements' | 'abandoned' | null | any;
 }>;
-type AccountSignupCodeRequestedProps = MaybePartial<{
+type AccountSignupCodeCompletedProps = MaybePartial<{
     firstName: string;
     lastName: string;
     userEmail: string;
     companyName: string;
-    type: 'property_manager' | 'partner';
+    type: 'owner' | 'property_manager' | 'partner';
 }>;
 type AccountSignupCompletedProps = MaybePartial<{
     tenantId: string;
@@ -203,25 +187,18 @@ type AccountSignupCompletedProps = MaybePartial<{
     lastName: string;
     userId: string;
 }>;
-type AutomationCreatedProps = MaybePartial<{
-    automationId: string;
-    templateId: string;
-    type?: string | null;
-    uniqueRef: string;
-    userId: string;
-    userEmail: string;
+type OnboardingAccountSettingsSetProps = MaybePartial<{
     tenantId: string;
-}>;
-type AutomationDeletedProps = MaybePartial<{
-    automationId: string;
-    templateId: string;
-    type?: string | null;
-    uniqueRef: string;
     userId: string;
-    userEmail: string;
+    start: Date;
+    country: string;
+    currency: string;
+}>;
+type OnboardingCompletedProps = MaybePartial<{
     tenantId: string;
+    userId: string;
+    listingId: string | null;
 }>;
-type AutomationUpdatedProps = any;
 type ConnectionCreatedProps = MaybePartial<{
     connectionId: string;
     tenantId: string;
@@ -252,6 +229,47 @@ type ConnectionRequestedProps = MaybePartial<{
     userEmail: string;
     tenantId: string;
 }>;
+type AccountPasswordResetCompletedProps = MaybePartial<{
+    userEmail: string;
+}>;
+type AccountPasswordResetFailedProps = MaybePartial<{
+    userEmail: string;
+    status: 'needs_second_factor' | 'needs_identifier' | 'needs_first_factor' | 'needs_new_password' | null | any;
+}>;
+type AccountPasswordResetRequestedProps = MaybePartial<{
+    userEmail: string;
+}>;
+type AccountSignedOutProps = MaybePartial<{
+    userId: string;
+    userEmail: string;
+    tenantId: string;
+    firstName: string;
+    lastName: string;
+}>;
+type AccountSigninCompletedProps = MaybePartial<{
+    firstName: string;
+    lastName: string;
+    userEmail: string;
+}>;
+type AutomationCreatedProps = MaybePartial<{
+    automationId: string;
+    templateId: string;
+    type?: string | null;
+    uniqueRef: string;
+    userId: string;
+    userEmail: string;
+    tenantId: string;
+}>;
+type AutomationDeletedProps = MaybePartial<{
+    automationId: string;
+    templateId: string;
+    type?: string | null;
+    uniqueRef: string;
+    userId: string;
+    userEmail: string;
+    tenantId: string;
+}>;
+type AutomationUpdatedProps = any;
 type GlOwnerStatementDownloadedProps = MaybePartial<{
     ownerStatementId: string;
     ownerStatementUrls: string[];
@@ -593,6 +611,7 @@ type IntercomConversationRated = MaybePartial<{
 }>;
 type MrrReportedProps = MaybePartial<{
     mrr: number;
+    mrrAlt: number;
     listings?: number;
     subscriptionStatus: SubscriptionStatus;
 }>;

package/build/module/tracking/types.d.ts

@@ -57,12 +57,15 @@ export type GroupProps = OptionalUser<{
 }>;
 export type TrackingEventProps = {
     account_invitation_accepted: AccountInvitationAcceptedProps;
-    account_signed_out: AccountSignedOutProps;
-    account_signin_completed: AccountSigninCompletedProps;
+    account_signup_started: AccountSignupStartedProps;
     account_signup_code_requested: AccountSignupCodeRequestedProps;
-    account_signup_code_completed: AccountSignupCodeCompletedProps;
     account_signup_code_failed: AccountSignupCodeFailedProps;
+    account_signup_code_completed: AccountSignupCodeCompletedProps;
     account_signup_completed: AccountSignupCompletedProps;
+    onboarding_account_settings_set: OnboardingAccountSettingsSetProps;
+    onboarding_completed: OnboardingCompletedProps;
+    account_signed_out: AccountSignedOutProps;
+    account_signin_completed: AccountSigninCompletedProps;
     account_password_reset_requested: AccountPasswordResetRequestedProps;
     account_password_reset_failed: AccountPasswordResetFailedProps;
     account_password_reset_completed: AccountPasswordResetCompletedProps;
@@ -152,49 +155,30 @@ type AccountInvitationAcceptedProps = MaybePartial<{
     tenantId: string;
     isNewUser: boolean;
 }>;
-type AccountPasswordResetCompletedProps = MaybePartial<{
-    userEmail: string;
-}>;
-type AccountPasswordResetFailedProps = MaybePartial<{
-    userEmail: string;
-    status: 'needs_second_factor' | 'needs_identifier' | 'needs_first_factor' | 'needs_new_password' | null | any;
+type AccountSignupStartedProps = MaybePartial<{
+    type: 'owner' | 'property_manager' | 'partner';
 }>;
-type AccountPasswordResetRequestedProps = MaybePartial<{
-    userEmail: string;
-}>;
-type AccountSignedOutProps = MaybePartial<{
-    userId: string;
-    userEmail: string;
-    tenantId: string;
-    firstName: string;
-    lastName: string;
-}>;
-type AccountSigninCompletedProps = MaybePartial<{
-    firstName: string;
-    lastName: string;
-    userEmail: string;
-}>;
-type AccountSignupCodeCompletedProps = MaybePartial<{
+type AccountSignupCodeRequestedProps = MaybePartial<{
     firstName: string;
     lastName: string;
     userEmail: string;
     companyName: string;
-    type: 'property_manager' | 'partner';
+    type: 'owner' | 'property_manager' | 'partner';
 }>;
 type AccountSignupCodeFailedProps = MaybePartial<{
     firstName: string;
     lastName: string;
     userEmail: string;
     companyName: string;
-    type: 'property_manager' | 'partner';
+    type: 'owner' | 'property_manager' | 'partner';
     status: 'missing_requirements' | 'abandoned' | null | any;
 }>;
-type AccountSignupCodeRequestedProps = MaybePartial<{
+type AccountSignupCodeCompletedProps = MaybePartial<{
     firstName: string;
     lastName: string;
     userEmail: string;
     companyName: string;
-    type: 'property_manager' | 'partner';
+    type: 'owner' | 'property_manager' | 'partner';
 }>;
 type AccountSignupCompletedProps = MaybePartial<{
     tenantId: string;
@@ -203,25 +187,18 @@ type AccountSignupCompletedProps = MaybePartial<{
     lastName: string;
     userId: string;
 }>;
-type AutomationCreatedProps = MaybePartial<{
-    automationId: string;
-    templateId: string;
-    type?: string | null;
-    uniqueRef: string;
-    userId: string;
-    userEmail: string;
+type OnboardingAccountSettingsSetProps = MaybePartial<{
     tenantId: string;
-}>;
-type AutomationDeletedProps = MaybePartial<{
-    automationId: string;
-    templateId: string;
-    type?: string | null;
-    uniqueRef: string;
     userId: string;
-    userEmail: string;
+    start: Date;
+    country: string;
+    currency: string;
+}>;
+type OnboardingCompletedProps = MaybePartial<{
     tenantId: string;
+    userId: string;
+    listingId: string | null;
 }>;
-type AutomationUpdatedProps = any;
 type ConnectionCreatedProps = MaybePartial<{
     connectionId: string;
     tenantId: string;
@@ -252,6 +229,47 @@ type ConnectionRequestedProps = MaybePartial<{
     userEmail: string;
     tenantId: string;
 }>;
+type AccountPasswordResetCompletedProps = MaybePartial<{
+    userEmail: string;
+}>;
+type AccountPasswordResetFailedProps = MaybePartial<{
+    userEmail: string;
+    status: 'needs_second_factor' | 'needs_identifier' | 'needs_first_factor' | 'needs_new_password' | null | any;
+}>;
+type AccountPasswordResetRequestedProps = MaybePartial<{
+    userEmail: string;
+}>;
+type AccountSignedOutProps = MaybePartial<{
+    userId: string;
+    userEmail: string;
+    tenantId: string;
+    firstName: string;
+    lastName: string;
+}>;
+type AccountSigninCompletedProps = MaybePartial<{
+    firstName: string;
+    lastName: string;
+    userEmail: string;
+}>;
+type AutomationCreatedProps = MaybePartial<{
+    automationId: string;
+    templateId: string;
+    type?: string | null;
+    uniqueRef: string;
+    userId: string;
+    userEmail: string;
+    tenantId: string;
+}>;
+type AutomationDeletedProps = MaybePartial<{
+    automationId: string;
+    templateId: string;
+    type?: string | null;
+    uniqueRef: string;
+    userId: string;
+    userEmail: string;
+    tenantId: string;
+}>;
+type AutomationUpdatedProps = any;
 type GlOwnerStatementDownloadedProps = MaybePartial<{
     ownerStatementId: string;
     ownerStatementUrls: string[];
@@ -593,6 +611,7 @@ type IntercomConversationRated = MaybePartial<{
 }>;
 type MrrReportedProps = MaybePartial<{
     mrr: number;
+    mrrAlt: number;
     listings?: number;
     subscriptionStatus: SubscriptionStatus;
 }>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vrplatform/log",
-  "version": "2.0.81",
+  "version": "2.0.83",
   "main": "build/main/index.js",
   "publishConfig": {
     "access": "public"

package/src/tracking/index.ts

@@ -124,9 +124,9 @@ export type UseTracking = {
     HASURA_GRAPHQL_ADMIN_SECRET?: string;
     HASURA_ADMIN_SECRET?: string;
     MIXPANEL_TOKEN?: string;
-    MIXPANEL_USER?: string;
-    MIXPANEL_PASSWORD?: string;
-    MIXPANEL_PROJECT_ID?: string;
+    MIXPANEL_USER?: string; // only needed for track(..., _import = true)
+    MIXPANEL_PASSWORD?: string; // only needed for track(..., _import = true)
+    MIXPANEL_PROJECT_ID?: string; // only needed for track(..., _import = true)
   } & LogBindings;
   debugging?: boolean;
 };

package/src/tracking/types.ts

@@ -69,14 +69,39 @@ export type GroupProps = OptionalUser<{
   };
 }>;
 
+/* Onboarding Funnel
+0. account_invitation_accepted
+1. account_signup_started
+2. account_signup_code_requested
+2a. account_signup_code_failed
+2b. account_signup_code_requested
+3. account_signup_code_completed
+4. account_signup_completed
+5. connection_created
+6. onboarding_account_settings_set
+8. onboarding_completed
+9. hyperline_trial_started
+10. owner_created
+11. ownership_created
+12. page view - owner statement
+13. hyperline_invoice_ready
+14. hyperline_invoice_settled
+*/
+
 export type TrackingEventProps = {
+  // Signup/Onboarding Funnel
   account_invitation_accepted: AccountInvitationAcceptedProps;
-  account_signed_out: AccountSignedOutProps;
-  account_signin_completed: AccountSigninCompletedProps;
+  account_signup_started: AccountSignupStartedProps;
   account_signup_code_requested: AccountSignupCodeRequestedProps;
-  account_signup_code_completed: AccountSignupCodeCompletedProps;
   account_signup_code_failed: AccountSignupCodeFailedProps;
+  account_signup_code_completed: AccountSignupCodeCompletedProps;
   account_signup_completed: AccountSignupCompletedProps;
+  onboarding_account_settings_set: OnboardingAccountSettingsSetProps;
+  onboarding_completed: OnboardingCompletedProps;
+
+  // Other Events
+  account_signed_out: AccountSignedOutProps;
+  account_signin_completed: AccountSigninCompletedProps;
   account_password_reset_requested: AccountPasswordResetRequestedProps;
   account_password_reset_failed: AccountPasswordResetFailedProps;
   account_password_reset_completed: AccountPasswordResetCompletedProps;
@@ -196,12 +221,7 @@ export type PaymentMethodType =
   | 'transfer_automated'
   | 'external';
 
-// /* GL Tracking Events */
-// type GLOnboardingRoleChoosedProps = MaybePartial<{
-//   userRole: 'owner' | 'propertyManager' | 'partner';
-// }>;
-
-/* Legacy & Other Events */
+// Signup/Onboarding Funnel
 
 type AccountInvitationAcceptedProps = MaybePartial<{
   userId: string;
@@ -211,45 +231,16 @@ type AccountInvitationAcceptedProps = MaybePartial<{
   isNewUser: boolean;
 }>;
 
-type AccountPasswordResetCompletedProps = MaybePartial<{
-  userEmail: string;
-}>;
-
-type AccountPasswordResetFailedProps = MaybePartial<{
-  userEmail: string;
-  status:
-    | 'needs_second_factor'
-    | 'needs_identifier'
-    | 'needs_first_factor'
-    | 'needs_new_password'
-    | null
-    | any;
-}>;
-
-type AccountPasswordResetRequestedProps = MaybePartial<{
-  userEmail: string;
+type AccountSignupStartedProps = MaybePartial<{
+  type: 'owner' | 'property_manager' | 'partner';
 }>;
 
-type AccountSignedOutProps = MaybePartial<{
-  userId: string;
-  userEmail: string;
-  tenantId: string;
-  firstName: string;
-  lastName: string;
-}>;
-
-type AccountSigninCompletedProps = MaybePartial<{
-  firstName: string;
-  lastName: string;
-  userEmail: string;
-}>;
-
-type AccountSignupCodeCompletedProps = MaybePartial<{
+type AccountSignupCodeRequestedProps = MaybePartial<{
   firstName: string;
   lastName: string;
   userEmail: string;
   companyName: string;
-  type: 'property_manager' | 'partner';
+  type: 'owner' | 'property_manager' | 'partner';
 }>;
 
 type AccountSignupCodeFailedProps = MaybePartial<{
@@ -257,16 +248,16 @@ type AccountSignupCodeFailedProps = MaybePartial<{
   lastName: string;
   userEmail: string;
   companyName: string;
-  type: 'property_manager' | 'partner';
+  type: 'owner' | 'property_manager' | 'partner';
   status: 'missing_requirements' | 'abandoned' | null | any;
 }>;
 
-type AccountSignupCodeRequestedProps = MaybePartial<{
+type AccountSignupCodeCompletedProps = MaybePartial<{
   firstName: string;
   lastName: string;
   userEmail: string;
   companyName: string;
-  type: 'property_manager' | 'partner';
+  type: 'owner' | 'property_manager' | 'partner';
 }>;
 
 type AccountSignupCompletedProps = MaybePartial<{
@@ -277,27 +268,21 @@ type AccountSignupCompletedProps = MaybePartial<{
   userId: string;
 }>;
 
-type AutomationCreatedProps = MaybePartial<{
-  automationId: string;
-  templateId: string;
-  type?: string | null;
-  uniqueRef: string;
-  userId: string;
-  userEmail: string;
+type OnboardingAccountSettingsSetProps = MaybePartial<{
   tenantId: string;
+  userId: string;
+  start: Date;
+  country: string;
+  currency: string;
 }>;
 
-type AutomationDeletedProps = MaybePartial<{
-  automationId: string;
-  templateId: string;
-  type?: string | null;
-  uniqueRef: string;
-  userId: string;
-  userEmail: string;
+type OnboardingCompletedProps = MaybePartial<{
   tenantId: string;
+  userId: string;
+  listingId: string | null; // null if skipped
 }>;
 
-type AutomationUpdatedProps = any;
+// Connection Events
 
 type ConnectionCreatedProps = MaybePartial<{
   connectionId: string;
@@ -333,6 +318,63 @@ type ConnectionRequestedProps = MaybePartial<{
   tenantId: string;
 }>;
 
+// Other Events
+
+type AccountPasswordResetCompletedProps = MaybePartial<{
+  userEmail: string;
+}>;
+
+type AccountPasswordResetFailedProps = MaybePartial<{
+  userEmail: string;
+  status:
+    | 'needs_second_factor'
+    | 'needs_identifier'
+    | 'needs_first_factor'
+    | 'needs_new_password'
+    | null
+    | any;
+}>;
+
+type AccountPasswordResetRequestedProps = MaybePartial<{
+  userEmail: string;
+}>;
+
+type AccountSignedOutProps = MaybePartial<{
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+  firstName: string;
+  lastName: string;
+}>;
+
+type AccountSigninCompletedProps = MaybePartial<{
+  firstName: string;
+  lastName: string;
+  userEmail: string;
+}>;
+
+type AutomationCreatedProps = MaybePartial<{
+  automationId: string;
+  templateId: string;
+  type?: string | null;
+  uniqueRef: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+}>;
+
+type AutomationDeletedProps = MaybePartial<{
+  automationId: string;
+  templateId: string;
+  type?: string | null;
+  uniqueRef: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+}>;
+
+type AutomationUpdatedProps = any;
+
 type GlOwnerStatementDownloadedProps = MaybePartial<{
   ownerStatementId: string;
   ownerStatementUrls: string[];
@@ -742,6 +784,7 @@ type IntercomConversationRated = MaybePartial<{
 
 type MrrReportedProps = MaybePartial<{
   mrr: number;
+  mrrAlt: number;
   listings?: number;
   subscriptionStatus: SubscriptionStatus;
 }>;