Merge pull request #651 from bigcapitalhq/bank-transactions-events

feat: Track banking service events

packages/server/src/constants/event-tracker.ts

@@ -34,6 +34,12 @@ export const ITEM_EVENT_DELETED = 'Item deleted';
 export const AUTH_SIGNED_UP = 'Auth Signed-up';
 export const AUTH_RESET_PASSWORD = 'Auth reset password';
 
+export const BANK_TRANSACTION_MATCHED = 'Bank transaction matching deleted';
+export const BANK_TRANSACTION_EXCLUDED = 'Bank transaction excluded';
+export const BANK_TRANSACTION_CATEGORIZED = 'Bank transaction categorized';
+export const BANK_TRANSACTION_UNCATEGORIZED = 'Bank transaction uncategorized';
+export const BANK_ACCOUNT_DISCONNECTED = 'Bank account disconnected';
+
 export const ACCOUNT_GROUP = 'Account';
 export const ITEM_GROUP = 'Item';
 export const AUTH_GROUP = 'Auth';

packages/server/src/services/EventsTracker/events/BankTransactionEventsTracker.ts

@@ -0,0 +1,97 @@
+import { Inject, Service } from 'typedi';
+import { EventSubscriber } from '@/lib/EventPublisher/EventPublisher';
+import { PosthogService } from '../PostHog';
+import events from '@/subscribers/events';
+import {
+ BANK_TRANSACTION_MATCHED,
+ BANK_TRANSACTION_EXCLUDED,
+ BANK_TRANSACTION_CATEGORIZED,
+ BANK_TRANSACTION_UNCATEGORIZED,
+ BANK_ACCOUNT_DISCONNECTED,
+} from '@/constants/event-tracker';
+import { IBankTransactionMatchedEventPayload } from '@/services/Banking/Matching/types';
+import { IBankAccountDisconnectedEventPayload } from '@/services/Banking/BankAccounts/types';
+import {
+ ICashflowTransactionCategorizedPayload,
+ ICashflowTransactionUncategorizedPayload,
+} from '@/interfaces';
+import { IBankTransactionExcludedEventPayload } from '@/services/Banking/Exclude/_types';
+
+@Service()
+export class BankTransactionEventsTracker extends EventSubscriber {
+ @Inject()
+ private posthog: PosthogService;
+
+ public attach(bus) {
+ bus.subscribe(
+ events.bankMatch.onMatched,
+ this.handleTrackBankTransactionMatchedEvent
+ );
+ bus.subscribe(
+ events.bankTransactions.onExcluded,
+ this.handleTrackBankTransactionExcludedEvent
+ );
+ bus.subscribe(
+ events.cashflow.onTransactionCategorized,
+ this.handleTrackBankTransactionCategorizedEvent
+ );
+ bus.subscribe(
+ events.cashflow.onTransactionUncategorized,
+ this.handleTrackBankTransactionUncategorizedEvent
+ );
+ bus.subscribe(
+ events.bankAccount.onDisconnected,
+ this.handleTrackBankAccountDisconnectedEvent
+ );
+ }
+
+ private handleTrackBankTransactionMatchedEvent = ({
+ tenantId,
+ }: IBankTransactionMatchedEventPayload) => {
+ this.posthog.trackEvent({
+ distinctId: `tenant-${tenantId}`,
+ event: BANK_TRANSACTION_MATCHED,
+ properties: {},
+ });
+ };
+
+ private handleTrackBankTransactionExcludedEvent = ({
+ tenantId,
+ }: IBankTransactionExcludedEventPayload) => {
+ this.posthog.trackEvent({
+ distinctId: `tenant-${tenantId}`,
+ event: BANK_TRANSACTION_EXCLUDED,
+ properties: {},
+ });
+ };
+
+ private handleTrackBankTransactionCategorizedEvent = ({
+ tenantId,
+ }: ICashflowTransactionCategorizedPayload) => {
+ this.posthog.trackEvent({
+ distinctId: `tenant-${tenantId}`,
+ event: BANK_TRANSACTION_CATEGORIZED,
+ properties: {},
+ });
+ };
+
+ private handleTrackBankTransactionUncategorizedEvent = ({
+ tenantId,
+ }: ICashflowTransactionUncategorizedPayload) => {
+ this.posthog.trackEvent({
+ distinctId: `tenant-${tenantId}`,
+ event: BANK_TRANSACTION_UNCATEGORIZED,
+ properties: {},
+ });
+ };
+
+ private handleTrackBankAccountDisconnectedEvent = ({
+ tenantId,
+ }: IBankAccountDisconnectedEventPayload) => {
+ this.posthog.trackEvent({
+ distinctId: `tenant-${tenantId}`,
+ event: BANK_ACCOUNT_DISCONNECTED,
+ properties: {},
+ });
+ };
+}

packages/server/src/services/EventsTracker/events/events.ts

@@ -7,6 +7,7 @@ import { ExpenseEventsTracker } from './ExpenseEventsTracker';
 import { AccountEventsTracker } from './AccountEventsTracker';
 import { AuthenticationEventsTracker } from './AuthenticationEventsTracker';
 import { ItemEventsTracker } from './ItemEventsTracker';
+import { BankTransactionEventsTracker } from './BankTransactionEventsTracker';
 import { CustomerEventsTracker } from './CustomerEventsTracker';
 import { VendorEventsTracker } from './VendorEventsTracker';
 import { ManualJournalEventsTracker } from './ManualJournalEventsTracker';
@@ -22,6 +23,7 @@ export const EventsTrackerListeners = [
  ExpenseEventsTracker,
  AuthenticationEventsTracker,
  ItemEventsTracker,
+ BankTransactionEventsTracker,
  CustomerEventsTracker,
  VendorEventsTracker,
  ManualJournalEventsTracker,