@vrplatform/log 2.0.0 → 2.0.1

package/src/tracking/types.ts

@@ -1,97 +1,622 @@
-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;
+export type TrackProps<T extends TrackingEvent> = OptionalUser<{
+  groupId: string;
+  timestamp?: Date;
+  event: T;
+  properties: TrackingEventProps[T];
+}>;
+
+export type IdentifyProps = {
+  userId: string;
+  traits?: {
+    id?: string;
+    email?: string;
+    avatar?: string;
+    name?: string;
+    firstName?: string;
+    lastName?: string;
+    createdAt?: string;
+    country?: string;
+    isSuperAdmin?: boolean;
+    isVrpAdmin?: boolean;
+    isPartnerAdmin?: boolean;
+    isTeamAdmin?: boolean;
+    role?: UserRole;
+    [key: string]: string | number | boolean | null | undefined;
+  };
+  disableGeoip?: boolean;
+  timestamp?: Date;
+};
+
+export type GroupProps = OptionalUser<{
+  groupId: string;
+  traits?: {
+    name?: string;
+    type?: TenantType;
+    avatar?: string;
+    createdAt?: string;
+    partner?: string;
+    partnerId?: string;
+    billingCustomerId?: string;
+    billingSubscriptionStatus?: string; // todo: update type as enum
+    status?: TenantStatus;
+    isOnboarding?: boolean;
+    accountingPartner?: string;
+    billingPartner?: string;
+    pms?: string;
+    apps?: string;
+    accountingSoftware?: string;
+    activeListings?: number;
+    mrr?: number;
+    plan?: string;
+    paymentMethodType?: string;
+    [key: string]: string | number | boolean | null | undefined;
+  };
+  timestamp?: Date;
+}>;
+
+type TrackingEventProps = {
+  account_invitation_accepted: AccountInvitationAcceptedProps;
+  account_signed_out: AccountSignedOutProps;
+  account_signin_completed: AccountSigninCompletedProps;
+  account_signup_code_requested: AccountSignupCodeRequestedProps;
+  account_signup_code_completed: AccountSignupCodeCompletedProps;
+  account_signup_code_failed: AccountSignupCodeFailedProps;
+  account_signup_completed: AccountSignupCompletedProps;
+  account_password_reset_requested: AccountPasswordResetRequestedProps;
+  account_password_reset_failed: AccountPasswordResetFailedProps;
+  account_password_reset_completed: AccountPasswordResetCompletedProps;
+  connection_created: ConnectionCreatedProps;
+  connection_reconnected: ConnectionReconnectedProps;
+  connection_deleted: ConnectionDeletedProps;
+  connection_requested: ConnectionRequestedProps;
+  ownership_created: OwnershipCreatedProps;
+  ownership_updated: OwnershipUpdatedProps;
+  ownership_deleted: OwnershipDeletedProps;
+  owner_created: OwnerCreatedProps;
+  owner_updated: OwnerUpdatedProps;
+  owner_deleted: OwnerDeletedProps;
+  owner_tax_info_modal_opened: OwnerTaxInfoModalOpenedProps;
+  owner_tax_info_modal_submitted: OwnerTaxInfoModalSubmittedProps;
+  setup_classes_set: SetupClassesSetProps;
+  setup_entities_set: SetupEntitiesSetProps;
+  setup_reservation_imported: SetupReservationImportedProps;
+  setup_vendors_set: SetupVendorsSetProps;
+  setup_accounting_version_completed: SetupAccountingVersionCompletedProps;
+  setup_accounting_config_completed: SetupAccountingConfigCompletedProps;
+  setup_owner_imported: SetupOwnerImportedProps;
+  setup_listing_imported: SetupListingImportedProps;
+  automation_created: AutomationCreatedProps;
+  automation_updated: AutomationUpdatedProps;
+  automation_deleted: AutomationDeletedProps;
+  tax_statement_preview_opened: TaxStatementPreviewOpenedProps;
+  tax_statement_downloaded: TaxStatementDownloadedProps;
+  team_added: TeamAddedProps;
+  team_deleted: TeamDeletedProps;
+  team_info_updated: TeamInfoUpdatedProps;
+  team_member_removed: TeamMemberRemovedProps;
+  gl_owner_statement_preview_opened: GlOwnerStatementPreviewOpenedProps;
+  gl_owner_statement_downloaded: GlOwnerStatementDownloadedProps;
+  hyperline_invoice_ready: HyperlineInvoiceReadyProps;
+  hyperline_invoice_settled: HyperlineInvoiceSettledProps;
+  hyperline_trial_started: HyperlineTrialStartedProps;
+  hyperline_trial_ended: HyperlineTrialEndedProps;
+  hyperline_subscription_activated: HyperlineSubscriptionActivatedProps;
+  hyperline_subscription_cancelled: HyperlineSubscriptionCancelledProps;
+  hyperline_subscription_created: HyperlineSubscriptionCreatedProps;
+  hyperline_subscription_errored: HyperlineSubscriptionErroredProps;
+  hyperline_subscription_paused: HyperlineSubscriptionPausedProps;
+  hyperline_subscription_voided: HyperlineSubscriptionVoidedProps;
+  hyperline_subscription_charged: HyperlineSubscriptionChargedProps;
+  hyperline_customer_created: HyperlineCustomerCreatedProps;
+  hyperline_customer_updated: HyperlineCustomerUpdatedProps;
+  hyperline_payment_method_created: HyperlinePaymentMethodCreatedProps;
+  hyperline_payment_method_errored: HyperlinePaymentMethodErroredProps;
+  hyperline_payment_method_deleted: HyperlinePaymentMethodDeletedProps;
+  listing_activated: ListingActivatedProps;
+  listing_deactivated: ListingDeactivatedProps;
+  listings_reported: ListingsReportedProps;
+  update_refresh_accepted: UpdateRefreshAcceptedProps;
+  owner_statement_opened: OwnerStatementOpenedProps;
+  test_event: TestEventProps;
+  test_error: TestErrorProps;
+};
+export type TrackingEvent = keyof TrackingEventProps;
+
+type OptionalUser<T> = T &
+  (
+    | { userId: string; anonymousId?: string }
+    | {
+        userId?: string;
+        anonymousId: string;
+      }
+  );
+
+export type UserRole =
+  | 'super-admin'
+  | 'vrp-admin'
+  | 'partner-admin'
+  | 'team-admin'
+  | 'admin'
+  | 'owner'
+  | 'user';
+export type TenantType = 'admin' | 'partner' | 'propertyManager';
+export type TenantStatus = 'active' | 'inactive';
+export type WebhookEventType =
+  | 'customer.created'
+  | 'customer.updated'
+  | 'subscription.activated'
+  | 'subscription.cancelled'
+  | 'subscription.created'
+  | 'subscription.errored'
+  | 'subscription.paused'
+  | 'subscription.voided'
+  | 'subscription.charged'
+  | 'payment_method.created'
+  | 'payment_method.errored'
+  | 'payment_method.deleted';
+
+type AccountInvitationAcceptedProps = Partial<{
+  userId: string;
+  userEmail: string;
+  userRole: 'owner' | 'user' | 'admin';
+  tenantId: string;
+  isNewUser: boolean;
+}>;
+
+type AccountPasswordResetCompletedProps = Partial<{
+  userEmail: string;
+}>;
+
+type AccountPasswordResetFailedProps = Partial<{
+  userEmail: string;
+  status:
+    | 'needs_second_factor'
+    | 'needs_identifier'
+    | 'needs_first_factor'
+    | 'needs_new_password'
+    | null
+    | any;
+}>;
+
+type AccountPasswordResetRequestedProps = Partial<{
+  userEmail: string;
+}>;
+
+type AccountSignedOutProps = Partial<{
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+  firstName: string;
+  lastName: string;
+}>;
+
+type AccountSigninCompletedProps = Partial<{
+  firstName: string;
+  lastName: string;
+  userEmail: string;
+}>;
+
+type AccountSignupCodeCompletedProps = Partial<{
+  firstName: string;
+  lastName: string;
+  userEmail: string;
+  companyName: string;
+  type: 'property_manager' | 'partner';
+}>;
+
+type AccountSignupCodeFailedProps = Partial<{
+  firstName: string;
+  lastName: string;
+  userEmail: string;
+  companyName: string;
+  type: 'property_manager' | 'partner';
+  status: 'missing_requirements' | 'abandoned' | null | any;
+}>;
+
+type AccountSignupCodeRequestedProps = Partial<{
+  firstName: string;
+  lastName: string;
+  userEmail: string;
+  companyName: string;
+  type: 'property_manager' | 'partner';
+}>;
+
+type AccountSignupCompletedProps = Partial<{
+  tenantId: string;
+  userEmail: string;
+  firstName: string;
+  lastName: string;
+  userId: string;
+}>;
+
+type AutomationCreatedProps = Partial<{
+  automationId: string;
+  templateId: string;
+  type?: string | null;
+  uniqueRef: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+}>;
+
+type AutomationDeletedProps = Partial<{
+  automationId: string;
+  templateId: string;
+  type?: string | null;
+  uniqueRef: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+}>;
+
+type AutomationUpdatedProps = any;
+
+type ConnectionCreatedProps = Partial<{
+  connectionId: string;
+  tenantId: string;
+  userId: string;
+  userEmail: string;
+  appId: string;
+  type?: string;
+}>;
+
+type ConnectionDeletedProps = Partial<{
+  connectionId: string;
+  tenantId: string;
+  type?: string;
+  userId: string;
+  appId: string;
+  userEmail: string;
+}>;
+
+type ConnectionReconnectedProps = Partial<{
+  connectionId: string;
+  tenantId: string;
+  userId: string;
+  userEmail: string;
+  appId: string;
+}>;
+
+type ConnectionRequestedProps = Partial<{
+  type: 'PMS' | 'Accounting';
+  website: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+}>;
+
+type GlOwnerStatementDownloadedProps = Partial<{
+  ownerStatementId: string;
+  ownerStatementUrls: string[];
+  userType: 'owner' | 'property_manager';
+}>;
+
+type GlOwnerStatementPreviewOpenedProps = Partial<{
+  ownerStatementStatus: string;
+  ownerStatementId: string;
+  ownerStatementUrls: string[];
+  userType: 'owner' | 'property_manager';
+}>;
+
+type HyperlineCustomerCreatedProps = Partial<{
+  userId: string;
+  tenantId: string;
+  customerId: string;
+  billingEmail: string;
+  billingAddress: string;
+  externalId: string;
+  name: string;
+  vatNumber: string;
+}>;
+
+type HyperlineCustomerUpdatedProps = HyperlineCustomerCreatedProps;
+
+type HyperlineInvoiceReadyProps = Partial<{
+  status: 'ready';
+  paymentMethodType: string;
+  invoiceId: string;
+  amount: number;
+  amountOrigin: number;
+  currency: string;
+  customerId: string;
+  taxAmount: number;
+  readyAt: string;
+}>;
+
+type HyperlineInvoiceSettledProps = Partial<{
+  status: 'settled';
+  paymentMethodType: string;
+  invoiceId: string;
+  amount: number;
+  amountOrigin: number;
+  currency: string;
+  customerId: string;
+  taxAmount: number;
+  settledAt: string;
+}>;
+
+type HyperlinePaymentMethodCreatedProps = Partial<{
+  userId: string;
+  tenantId: string;
+  payloadCreatedAt: string;
+  payloadType:
+    | 'card'
+    | 'direct_debit_sepa'
+    | 'direct_debit_ach'
+    | 'direct_debit_bacs';
+  payloadState: 'active' | 'pending';
+  payloadId: string;
+  payloadCustomerId: string;
+  webhookEventType: 'payment_method.created';
+}>;
+
+type HyperlinePaymentMethodDeletedProps = Partial<{
+  userId: string;
+  tenantId: string;
+  payloadCreatedAt: string;
+  payloadType:
+    | 'card'
+    | 'direct_debit_sepa'
+    | 'direct_debit_ach'
+    | 'direct_debit_bacs';
+  payloadState: 'active' | 'pending';
+  payloadId: string;
+  payloadCustomerId: string;
+  webhookEventType: 'payment_method.deleted';
+}>;
+
+type HyperlinePaymentMethodErroredProps = Partial<{
+  userId: string;
+  tenantId: string;
+  payloadCreatedAt: string;
+  payloadType:
+    | 'card'
+    | 'direct_debit_sepa'
+    | 'direct_debit_ach'
+    | 'direct_debit_bacs';
+  payloadState: 'active' | 'pending';
+  payloadId: string;
+  payloadCustomerId: string;
+  webhookEventType: 'payment_method.errored';
+}>;
+
+type HyperlineSubscriptionActivatedProps = Partial<{
+  userId: string;
+  tenantId: string;
+  tenantBillingStatus: 'pending' | 'active' | 'canceled';
+  webhookEventType: 'subscription.activated';
+}>;
+
+type HyperlineSubscriptionCancelledProps = Partial<{
+  trialEndAt: string;
+  plan: string;
+  subscriptionId: string;
+  subscriptionStartDate: string;
+  subscriptionStatus: string;
+  paymentMethodType: string;
+  customerId: string;
+  userId: string;
+  tenantId: string;
+  webhookEventType: 'subscription.cancelled';
+  tenantBillingStatus: 'pending' | 'active' | 'canceled';
+}>;
+
+type HyperlineSubscriptionChargedProps = Partial<{
+  plan: string;
+  subscriptionId: string;
+  subscriptionStartDate: string;
+  subscriptionStatus: string;
+  paymentMethodType: string;
+  customerId: string;
+}>;
+
+type HyperlineSubscriptionCreatedProps = Partial<{
+  trialStartDate: string;
+  plan: string;
+  subscriptionId: string;
+  subscriptionStartDate: string;
+  subscriptionStatus: string;
+  paymentMethodType: string;
+  customerId: string;
+}>;
+
+type HyperlineSubscriptionErroredProps = Partial<{
+  userId: string;
+  tenantId: string;
+  tenantBillingStatus: 'pending' | 'active' | 'canceled';
+  webhookEventType: 'subscription.errored';
+}>;
+
+type HyperlineSubscriptionPausedProps = Partial<{
+  userId: string;
+  tenantId: string;
+  tenantBillingStatus: 'pending' | 'active' | 'canceled';
+  webhookEventType: 'subscription.paused';
+}>;
+
+type HyperlineSubscriptionVoidedProps = Partial<{
+  userId: string;
+  tenantId: string;
+  tenantBillingStatus: 'pending' | 'active' | 'canceled';
+  webhookEventType: 'subscription.voided';
+}>;
+
+type HyperlineTrialEndedProps = Partial<{
+  trialStartDate: string;
+  trialEndDate: string;
+  plan: string;
+  subscriptionId: string;
+  subscriptionStartDate: string;
+  subscriptionStatus: string;
+  paymentMethodType: 'card';
+}>;
+
+type HyperlineTrialStartedProps = Partial<{
+  tenantId: string;
+  userId: string;
+  tenantBillingStatus: 'pending' | 'active' | 'canceled';
+  webhookEventType: 'payment_method.created';
+}>;
+
+type OwnerCreatedProps = Partial<{
+  userId: string;
+  tenantId: string;
+  ownerId: string;
+  type:
+    | 'individual'
+    | 'company'
+    | 'c_corporation'
+    | 's_corporation'
+    | 'partnership'
+    | 'trust_estate'
+    | 'limited_liability_company';
+  withUserInvite: boolean;
+  userEmail: string;
+}>;
+
+type OwnerDeletedProps = Partial<{
+  userId: string;
+  tenantId: string;
+  ownerId: string;
+  userEmail: string;
+  listingId: string;
+  ownershipId: string;
+}>;
+
+type OwnerTaxInfoModalOpenedProps = Partial<{
+  flag: string;
+}>;
+
+type OwnerTaxInfoModalSubmittedProps = Partial<{
+  flag: string;
+}>;
+
+type OwnerUpdatedProps = Partial<{
+  userId: string;
+  tenantId: string;
+  ownerId: string;
+}>;
+
+type OwnershipCreatedProps = Partial<{
+  ownershipId: string;
+  ownerId: string;
+  listingId: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+}>;
+
+type OwnershipDeletedProps = Partial<{
+  ownershipId: string;
+  ownerId: string;
+  listingId: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+}>;
+
+type OwnershipUpdatedProps = Partial<{
+  ownershipId: string;
+  ownerId: string;
+  listingId: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+}>;
+
+type SetupAccountingConfigCompletedProps = any;
+
+type SetupAccountingVersionCompletedProps = any;
+
+type SetupClassesSetProps = any;
+
+type SetupEntitiesSetProps = any;
+
+type SetupListingImportedProps = Partial<{
+  appId: string;
+}>;
+
+type SetupOwnerImportedProps = Partial<{
+  appId: string;
+}>;
+
+type SetupReservationImportedProps = Partial<{
+  appId: string;
+}>;
+
+type SetupVendorsSetProps = any;
+
+type TaxStatementDownloadedProps = Partial<{
+  taxStatementStatus?: 'draft' | 'ignored' | 'inReview' | 'ready' | 'submitted';
+  taxStatementId: string;
+  taxStatementUrl: string;
+  userType: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+}>;
+
+type TaxStatementPreviewOpenedProps = Partial<{
+  taxStatementStatus?: 'draft' | 'ignored' | 'inReview' | 'ready' | 'submitted';
+  taxStatementId: string;
+  taxStatementUrl: string;
+  userType: string;
+  userId: string;
+  userEmail: string;
+  tenantId: string;
+}>;
+
+type TeamAddedProps = Partial<{
+  tenantId: string;
+  tenantName: string;
+  partnerId: string;
+  userType: string;
+  userId: string;
+  userEmail: string;
+}>;
+
+type TeamDeletedProps = Partial<{
+  tenantId: string;
+  userId: string;
+  userEmail: string;
+}>;
+
+type TeamInfoUpdatedProps = Partial<{
+  userId: string;
+  tenantId: string;
+  userEmail: string;
+}>;
+
+type TeamMemberRemovedProps = Partial<{
+  userId: string;
+  removedUserId: string;
+  tenantId: string;
+  userEmail: string;
+}>;
+
+type TestErrorProps = Partial<{
+  userId: string;
+  tenantId: string;
+}>;
+
+type TestEventProps = Partial<{
+  success: boolean;
+}>;
+
+type UpdateRefreshAcceptedProps = Partial<{
+  appName: string;
+}>;
+
+type OwnerStatementOpenedProps = Partial<{
+  userId: string;
+  tenantId: string;
+  userEmail: string;
+  listingId: string;
+  startAt: string;
+}>;
+
+type ListingActivatedProps = any;
+
+type ListingDeactivatedProps = any;
+
+type ListingsReportedProps = any;