Add Analytics Payload

Author: Shailesh351

src/definition/accessors/IAnalytics.ts

@@ -1,3 +1,13 @@
+export interface IAnalyticsPayload {
+    roomId: string;
+    category: string;
+    action: string;
+    eventType: string;
+    timestamp: string;
+    properties?: Record<string, any>;
+    tabId?: string;
+}
+
 /**
  * Provides an accessor to push data for Analytics.
  */
@@ -6,9 +16,8 @@ export interface IAnalytics {
      * Sends event data to server for Analytics
      *
      * @param roomId the roomId of the Room
-     * @param event the event name
      * @param data the analytics data for the event
      * @return true
      */
-    sendEvent(roomId: string, event: string, data?: object): Promise<boolean>;
+    sendEvent(roomId: string, data: IAnalyticsPayload): Promise<boolean>;
 }

src/server/accessors/Analytics.ts

@@ -1,11 +1,11 @@
-import { IAnalytics } from '../../definition/accessors';
+import { IAnalytics, IAnalyticsPayload } from '../../definition/accessors';
 
 import { AnalyticsBridge } from '../bridges/AnalyticsBridge';
 
 export class Analytics implements IAnalytics {
     constructor(private analyticsBridge: AnalyticsBridge, private appId: string) { }
 
-    public sendEvent(roomId: string, event: string, data?: object): Promise<boolean> {
-        return this.analyticsBridge.doSendEvent(this.appId, roomId, event, data);
+    public sendEvent(roomId: string, data: IAnalyticsPayload): Promise<boolean> {
+        return this.analyticsBridge.doSendEvent(roomId, data, this.appId);
     }
 }

src/server/bridges/AnalyticsBridge.ts

@@ -1,16 +1,18 @@
+import { IAnalyticsPayload } from '../../definition/accessors';
+
 import { PermissionDeniedError } from '../errors/PermissionDeniedError';
 import { AppPermissionManager } from '../managers/AppPermissionManager';
 import { AppPermissions } from '../permissions/AppPermissions';
 import { BaseBridge } from './BaseBridge';
 
 export abstract class AnalyticsBridge extends BaseBridge {
-    public async doSendEvent(appId: string, roomId: string, event: string, data?: object): Promise<boolean> {
+    public async doSendEvent(roomId: string, data: IAnalyticsPayload, appId: string): Promise<boolean> {
         if (this.hasAnalyticsPermission(appId)) {
-            return this.sendEvent(appId, roomId, event, data);
+            return this.sendEvent(roomId, data, appId);
         }
     }
 
-    protected abstract sendEvent(appId: string, roomId: string, event: string, data?: object): Promise<boolean>;
+    protected abstract sendEvent(roomId: string, data: IAnalyticsPayload, appId: string): Promise<boolean>;
 
     private hasAnalyticsPermission(appId: string): boolean {
         if (AppPermissionManager.hasPermission(appId, AppPermissions.analytics.default)) {