@vrplatform/log 2.0.0-alpha.44 → 2.0.0-alpha.47

package/src/tracking/types.ts

@@ -1,23 +1,267 @@
-import type { LogBindings } from '../log';
-import type { TrackingEvent } from './eventTypes';
-
-export type TrackingProps = {
-  name: string;
-  dataset: string;
-  env: {
-    INTERCOM_TOKEN?: string;
-    JUNESO_TOKEN?: string;
-    POSTHOG_TOKEN?: string;
-  } & LogBindings;
-  debugging?: boolean;
-};
+export type TrackProps = OptionalUser<
+  {
+    groupId: string;
+    timestamp?: Date;
+  } & (
+    | {
+        event: 'account_invitation_accepted';
+        properties: AccountInvitationAcceptedProps;
+      }
+    | {
+        event: 'account_password_reset_completed';
+        properties: AccountPasswordResetCompletedProps;
+      }
+    | {
+        event: 'account_password_reset_failed';
+        properties: AccountPasswordResetFailedProps;
+      }
+    | {
+        event: 'account_password_reset_requested';
+        properties: AccountPasswordResetRequestedProps;
+      }
+    | {
+        event: 'account_signed_out';
+        properties: AccountSignedOutProps;
+      }
+    | {
+        event: 'account_signin_completed';
+        properties: AccountSigninCompletedProps;
+      }
+    | {
+        event: 'account_signup_code_completed';
+        properties: AccountSignupCodeCompletedProps;
+      }
+    | {
+        event: 'account_signup_code_failed';
+        properties: AccountSignupCodeFailedProps;
+      }
+    | {
+        event: 'account_signup_code_requested';
+        properties: AccountSignupCodeRequestedProps;
+      }
+    | {
+        event: 'account_signup_completed';
+        properties: AccountSignupCompletedProps;
+      }
+    | {
+        event: 'automation_created';
+        properties: AutomationCreatedProps;
+      }
+    | {
+        event: 'automation_deleted';
+        properties: AutomationDeletedProps;
+      }
+    | {
+        event: 'automation_updated';
+        properties: AutomationUpdated;
+      }
+    | {
+        event: 'connection_created';
+        properties: ConnectionCreatedProps;
+      }
+    | {
+        event: 'connection_deleted';
+        properties: ConnectionDeletedProps;
+      }
+    | {
+        event: 'connection_reconnected';
+        properties: ConnectionReconnectedProps;
+      }
+    | {
+        event: 'connection_requested';
+        properties: ConnectionRequestedProps;
+      }
+    | {
+        event: 'gl_owner_statement_downloaded';
+        properties: GlOwnerStatementDownloadedProps;
+      }
+    | {
+        event: 'gl_owner_statement_preview_opened';
+        properties: GlOwnerStatementPreviewOpenedProps;
+      }
+    | {
+        event: 'hyperline_customer_created';
+        properties: HyperlineCustomerCreatedProps;
+      }
+    | {
+        event: 'hyperline_customer_updated';
+        properties: HyperlineCustomerUpdatedProps;
+      }
+    | {
+        event: 'hyperline_invoice_ready';
+        properties: HyperlineInvoiceReadyProps;
+      }
+    | {
+        event: 'hyperline_invoice_settled';
+        properties: HyperlineInvoiceSettledProps;
+      }
+    | {
+        event: 'hyperline_payment_method_created';
+        properties: HyperlinePaymentMethodCreatedProps;
+      }
+    | {
+        event: 'hyperline_payment_method_deleted';
+        properties: HyperlinePaymentMethodDeletedProps;
+      }
+    | {
+        event: 'hyperline_payment_method_errored';
+        properties: HyperlinePaymentMethodErroredProps;
+      }
+    | {
+        event: 'hyperline_subscription_activated';
+        properties: HyperlineSubscriptionActivatedProps;
+      }
+    | {
+        event: 'hyperline_subscription_cancelled';
+        properties: HyperlineSubscriptionCancelledProps;
+      }
+    | {
+        event: 'hyperline_subscription_charged';
+        properties: HyperlineSubscriptionChargedProps;
+      }
+    | {
+        event: 'hyperline_subscription_created';
+        properties: HyperlineSubscriptionCreatedProps;
+      }
+    | {
+        event: 'hyperline_subscription_errored';
+        properties: HyperlineSubscriptionErroredProps;
+      }
+    | {
+        event: 'hyperline_subscription_paused';
+        properties: HyperlineSubscriptionPausedProps;
+      }
+    | {
+        event: 'hyperline_subscription_voided';
+        properties: HyperlineSubscriptionVoidedProps;
+      }
+    | {
+        event: 'hyperline_trial_ended';
+        properties: HyperlineTrialEndedProps;
+      }
+    | {
+        event: 'hyperline_trial_started';
+        properties: HyperlineTrialStartedProps;
+      }
+    | {
+        event: 'owner_created';
+        properties: OwnerCreatedProps;
+      }
+    | {
+        event: 'owner_deleted';
+        properties: OwnerDeletedProps;
+      }
+    | {
+        event: 'owner_tax_info_modal_opened';
+        properties: OwnerTaxInfoModalOpenedProps;
+      }
+    | {
+        event: 'owner_tax_info_modal_submitted';
+        properties: OwnerTaxInfoModalSubmittedProps;
+      }
+    | {
+        event: 'owner_updated';
+        properties: OwnerUpdatedProps;
+      }
+    | {
+        event: 'ownership_created';
+        properties: OwnershipCreatedProps;
+      }
+    | {
+        event: 'ownership_deleted';
+        properties: OwnershipDeletedProps;
+      }
+    | {
+        event: 'ownership_updated';
+        properties: OwnershipUpdatedProps;
+      }
+    | {
+        event: 'setup_accounting_config_completed';
+        properties: SetupAccountingConfigCompleted;
+      }
+    | {
+        event: 'setup_accounting_version_completed';
+        properties: SetupAccountingVersionCompleted;
+      }
+    | {
+        event: 'setup_classes_set';
+        properties: SetupClassesSet;
+      }
+    | {
+        event: 'setup_entities_set';
+        properties: SetupEntitiesSet;
+      }
+    | {
+        event: 'setup_listing_imported';
+        properties: SetupListingImportedProps;
+      }
+    | {
+        event: 'setup_owner_imported';
+        properties: SetupOwnerImportedProps;
+      }
+    | {
+        event: 'setup_reservation_imported';
+        properties: SetupReservationImportedProps;
+      }
+    | {
+        event: 'setup_vendors_set';
+        properties: SetupVendorsSet;
+      }
+    | {
+        event: 'tax_statement_downloaded';
+        properties: TaxStatementDownloadedProps;
+      }
+    | {
+        event: 'tax_statement_preview_opened';
+        properties: TaxStatementPreviewOpenedProps;
+      }
+    | {
+        event: 'team_added';
+        properties: TeamAddedProps;
+      }
+    | {
+        event: 'team_deleted';
+        properties: TeamDeletedProps;
+      }
+    | {
+        event: 'team_info_updated';
+        properties: TeamInfoUpdatedProps;
+      }
+    | {
+        event: 'team_member_removed';
+        properties: TeamMemberRemovedProps;
+      }
+    | {
+        event: 'test_error';
+        properties: TestErrorProps;
+      }
+    | {
+        event: 'test_event';
+        properties: TestEventProps;
+      }
+    | {
+        event: 'user_forced_reloaded';
+        properties: UserForcedReloadedProps;
+      }
+    | {
+        event: 'owner_statement_opened';
+        properties: OwnerStatementOpenedProps;
+      }
+    | {
+        event: 'listing_activated';
+        properties: ListingActivated;
+      }
+    | {
+        event: 'listing_deactivated';
+        properties: ListingDeactivated;
+      }
+    | {
+        event: 'listings_reported';
+        properties: ListingsReported;
+      }
+  )
+>;
 
-export type TrackProps = OptionalUser<{
-  groupId: string;
-  event: TrackingEvent;
-  properties: Record<string, string | number | boolean | null | undefined>;
-  timestamp?: Date;
-}>;
 export type IdentifyProps = {
   userId: string;
   traits?: {
@@ -39,10 +283,11 @@ export type IdentifyProps = {
   disableGeoip?: boolean;
   timestamp?: Date;
 };
+
 export type GroupProps = OptionalUser<{
   groupId: string;
-  traits: {
-    name: string;
+  traits?: {
+    name?: string;
     type?: TenantType;
     avatar?: string;
     createdAt?: string;
@@ -85,3 +330,542 @@ type OptionalUser<T> = T &
         anonymousId: string;
       }
   );
+
+type AuthEvent =
+  | 'account_signin_completed'
+  | 'account_signup_code_requested'
+  | 'account_signup_code_completed'
+  | 'account_signup_code_failed'
+  | 'account_signup_completed'
+  | 'account_password_reset_requested'
+  | 'account_password_reset_failed'
+  | 'account_password_reset_completed'
+  | 'account_invitation_accepted'
+  | 'account_signed_out';
+
+type TeamEvent =
+  | 'team_added'
+  | 'team_info_updated'
+  | 'team_deleted'
+  | 'team_member_removed';
+
+type ConnectionEvent =
+  | 'connection_created'
+  | 'connection_reconnected'
+  | 'connection_deleted'
+  | 'connection_requested';
+
+type OwnershipEvent =
+  | 'ownership_created'
+  | 'ownership_updated'
+  | 'ownership_deleted';
+
+type OwnerEvent =
+  | 'owner_created'
+  | 'owner_updated'
+  | 'owner_deleted'
+  | 'owner_tax_info_modal_opened'
+  | 'owner_tax_info_modal_submitted';
+
+type SetupEvent =
+  | 'setup_classes_set'
+  | 'setup_accounting_version_completed'
+  | 'setup_accounting_config_completed'
+  | 'setup_owner_imported'
+  | 'setup_listing_imported';
+
+type AutomationEvent =
+  | 'automation_created'
+  | 'automation_updated'
+  | 'automation_deleted';
+
+type TaxStatementEvent =
+  | 'tax_statement_preview_opened'
+  | 'tax_statement_downloaded';
+
+type GLOwnerStatementEvent =
+  | 'gl_owner_statement_preview_opened'
+  | 'gl_owner_statement_downloaded';
+
+type HyperlineEvent =
+  | 'hyperline_invoice_ready'
+  | 'hyperline_invoice_settled'
+  | 'hyperline_trial_started'
+  | 'hyperline_trial_ended'
+  | 'hyperline_subscription_activated'
+  | 'hyperline_subscription_cancelled'
+  | 'hyperline_subscription_created'
+  | 'hyperline_subscription_errored'
+  | 'hyperline_subscription_paused'
+  | 'hyperline_subscription_voided'
+  | 'hyperline_subscription_charged'
+  | 'hyperline_customer_created'
+  | 'hyperline_customer_updated'
+  | 'hyperline_payment_method_created'
+  | 'hyperline_payment_method_errored'
+  | 'hyperline_payment_method_deleted';
+
+type ListingEvent = 'listing_activated' | 'listing_deactivated';
+
+type ReportEvent = 'listings_reported';
+
+type UserEvent = 'update_refresh_accepted' | 'owner_statement_opened';
+
+type TestEvent = 'test_event' | 'test_error';
+
+export type TrackingEvent =
+  | AuthEvent
+  | TeamEvent
+  | ConnectionEvent
+  | OwnershipEvent
+  | OwnerEvent
+  | SetupEvent
+  | AutomationEvent
+  | TaxStatementEvent
+  | GLOwnerStatementEvent
+  | HyperlineEvent
+  | UserEvent
+  | ListingEvent
+  | ReportEvent
+  | TestEvent;
+
+type AccountInvitationAcceptedProps = {
+  userId: string;
+  userEmail: string;
+  userRole: 'owner' | 'user' | 'admin';
+  tenantId: string;
+  isNewUser: boolean;
+};
+
+type AccountPasswordResetCompletedProps = {
+  userEmail: string;
+};
+
+type AccountPasswordResetFailedProps = {
+  userEmail: string;
+  status: string;
+};
+
+type AccountPasswordResetRequestedProps = {
+  userEmail: string;
+};
+
+type AccountSignedOutProps = {
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+  firstName: string;
+  lastName: string;
+};
+
+type AccountSigninCompletedProps = {
+  firstName: string;
+  lastName: string;
+  userEmail: string;
+};
+
+type AccountSignupCodeCompletedProps = {
+  firstName: string;
+  lastName: string;
+  userEmail: string;
+  companyName: string;
+  type: string;
+};
+
+type AccountSignupCodeFailedProps = {
+  firstName: string;
+  lastName: string;
+  userEmail: string;
+  companyName: string;
+  type: string;
+  status: string;
+};
+
+type AccountSignupCodeRequestedProps = {
+  firstName: string;
+  lastName: string;
+  userEmail: string;
+  companyName: string;
+  type: string;
+};
+
+type AccountSignupCompletedProps = {
+  tenantId: string;
+  userEmail: string;
+  firstName: string;
+  lastName: string;
+  userId: string;
+};
+
+type AutomationCreatedProps = {
+  automationId: string;
+  templateId: string;
+  type: string;
+  uniqueRef: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+};
+
+type AutomationDeletedProps = {
+  automationId: string;
+  templateId: string;
+  type: string;
+  uniqueRef: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+};
+
+type AutomationUpdated = any;
+
+type ConnectionCreatedProps = {
+  connectionId: string;
+  tenantId: string;
+  userId: string;
+  userEmail: string;
+  appId: string;
+  type: string;
+};
+
+type ConnectionDeletedProps = {
+  connectionId: string;
+  tenantId: string;
+  type: string;
+  userId: string;
+  appId: string;
+  userEmail: string;
+};
+
+type ConnectionReconnectedProps = {
+  connectionId: string;
+  tenantId: string;
+  userId: string;
+  userEmail: string;
+  appId: string;
+};
+
+type ConnectionRequestedProps = {
+  type: string;
+  website: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+};
+
+type GlOwnerStatementDownloadedProps = {
+  ownerStatementId: string;
+  ownerStatementUrls: string[];
+  userType: string;
+};
+
+type GlOwnerStatementPreviewOpenedProps = {
+  ownerStatementStatus: string;
+  ownerStatementId: string;
+  ownerStatementUrls: string[];
+  userType: string;
+};
+
+type HyperlineCustomerCreatedProps = {
+  userId: string;
+  tenantId: string;
+  customerId: string;
+};
+
+type HyperlineCustomerUpdatedProps = {
+  userId: string;
+  tenantId: string;
+  customerId: string;
+};
+
+type HyperlineInvoiceReadyProps = {
+  status: string;
+  paymentMethodType: string;
+  invoiceId: string;
+  amount: number;
+  amountOrigin: number;
+  currency: string;
+  customerId: string;
+  taxAmount: string;
+  readyAt: string;
+};
+
+type HyperlineInvoiceSettledProps = {
+  status: string;
+  paymentMethodType: string;
+  invoiceId: string;
+  amount: number;
+  amountOrigin: number;
+  currency: string;
+  customerId: string;
+  taxAmount: string;
+  settledAt: string;
+};
+
+type HyperlinePaymentMethodCreatedProps = {
+  userId: string;
+  tenantId: string;
+  payloadCreatedAt: string;
+  payloadType: string;
+  payloadState: string;
+  payloadId: string;
+  payloadCustomerId: string;
+  webhookEventType: string;
+};
+
+type HyperlinePaymentMethodDeletedProps = {
+  userId: string;
+  tenantId: string;
+  payloadCreatedAt: string;
+  payloadType: string;
+  payloadState: string;
+  payloadId: string;
+  payloadCustomerId: string;
+  webhookEventType: string;
+};
+
+type HyperlinePaymentMethodErroredProps = {
+  userId: string;
+  tenantId: string;
+  payloadCreatedAt: string;
+  payloadType: string;
+  payloadState: string;
+  payloadId: string;
+  payloadCustomerId: string;
+  webhookEventType: string;
+};
+
+type HyperlineSubscriptionActivatedProps = {
+  userId: string;
+  tenantId: string;
+  tenantBillingStatus: string;
+  webhookEventType: string;
+};
+
+type HyperlineSubscriptionCancelledProps = {
+  trialEndAt: string;
+  plan: string;
+  subscriptionId: string;
+  subscriptionStartDate: string;
+  subscriptionStatus: string;
+  paymentMethodType: string;
+  customerId: string;
+  userId: string;
+  tenantId: string;
+  webhookEventType: string;
+  tenantBillingStatus: string;
+};
+
+type HyperlineSubscriptionChargedProps = {
+  plan: string;
+  subscriptionId: string;
+  subscriptionStartDate: string;
+  subscriptionStatus: string;
+  paymentMethodType: string;
+  customerId: string;
+};
+
+type HyperlineSubscriptionCreatedProps = {
+  trialStartDate: string;
+  plan: string;
+  subscriptionId: string;
+  subscriptionStartDate: string;
+  subscriptionStatus: string;
+  paymentMethodType: string;
+  customerId: string;
+};
+
+type HyperlineSubscriptionErroredProps = {
+  userId: string;
+  tenantId: string;
+  tenantBillingStatus: string;
+  webhookEventType: string;
+};
+
+type HyperlineSubscriptionPausedProps = {
+  userId: string;
+  tenantId: string;
+  tenantBillingStatus: string;
+  webhookEventType: string;
+};
+
+type HyperlineSubscriptionVoidedProps = {
+  userId: string;
+  tenantId: string;
+  tenantBillingStatus: string;
+  webhookEventType: string;
+};
+
+type HyperlineTrialEndedProps = {
+  trialStartDate: string;
+  trialEndDate: string;
+  plan: string;
+  subscriptionId: string;
+  subscriptionStartDate: string;
+  subscriptionStatus: string;
+  paymentMethodType: string;
+};
+
+type HyperlineTrialStartedProps = {
+  tenantId: string;
+  userId: string;
+  tenantBillingStatus: string;
+  webhookEventType: string;
+};
+
+type OwnerCreatedProps = {
+  userId: string;
+  tenantId: string;
+  ownerId: string;
+};
+
+type OwnerDeletedProps = {
+  userId: string;
+  tenantId: string;
+  ownerId: string;
+};
+
+type OwnerTaxInfoModalOpenedProps = {
+  userId: string;
+  tenantId: string;
+  ownerId: string;
+  taxId: string;
+};
+
+type OwnerTaxInfoModalSubmittedProps = {
+  userId: string;
+  tenantId: string;
+  ownerId: string;
+  taxId: string;
+  status: string;
+};
+
+type OwnerUpdatedProps = {
+  userId: string;
+  tenantId: string;
+  ownerId: string;
+};
+
+type OwnershipCreatedProps = {
+  ownershipId: string;
+  ownerId: string;
+  listingId: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+};
+
+type OwnershipDeletedProps = {
+  ownershipId: string;
+  ownerId: string;
+  listingId: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+};
+
+type OwnershipUpdatedProps = {
+  ownershipId: string;
+  ownerId: string;
+  listingId: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+};
+
+type SetupAccountingConfigCompleted = any;
+
+type SetupAccountingVersionCompleted = any;
+
+type SetupClassesSet = any;
+
+type SetupEntitiesSet = any;
+
+type SetupListingImportedProps = {
+  appId: string;
+};
+
+type SetupOwnerImportedProps = {
+  appId: string;
+};
+
+type SetupReservationImportedProps = {
+  appId: string;
+};
+
+type SetupVendorsSet = any;
+
+type TaxStatementDownloadedProps = {
+  taxStatementStatus: string;
+  taxStatementId: string;
+  taxStatementUrl: string;
+  userType: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+};
+
+type TaxStatementPreviewOpenedProps = {
+  taxStatementStatus: string;
+  taxStatementId: string;
+  taxStatementUrl: string;
+  userType: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+};
+
+type TeamAddedProps = {
+  tenantId: string;
+  tenantName: string;
+  partnerId: string;
+  userType: string;
+  userId: string;
+  userEmail: string;
+};
+
+type TeamDeletedProps = {
+  tenantId: string;
+  userId: string;
+  userEmail: string;
+};
+
+type TeamInfoUpdatedProps = {
+  userId: string;
+  tenantId: string;
+  userEmail: string;
+};
+
+type TeamMemberRemovedProps = {
+  userId: string;
+  removedUserId: string;
+  tenantId: string;
+  userEmail: string;
+};
+
+type TestErrorProps = {
+  userId: string;
+  tenantId: string;
+};
+
+type TestEventProps = {
+  success: string;
+};
+
+type UserForcedReloadedProps = {
+  appName: string;
+};
+
+type OwnerStatementOpenedProps = {
+  userId: string;
+  tenantId: string;
+  userEmail: string;
+  listingId: string;
+  startAt: string;
+};
+
+type ListingActivated = any;
+
+type ListingDeactivated = any;
+
+type ListingsReported = any;