feat(events): add responder and stepId/Index to flow events (#135)

formsort · Sep 19, 2024 · cb10581 · cb10581
1 parent 90a9d3e
commit cb10581
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 12 deletions.
diff --git a/.gitignore b/.gitignore
@@ -11,6 +11,8 @@ lib/
 
 yarn-debug.log*
 yarn-error.log*
+.yarn/
+.yarnrc.yml
 
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov

diff --git a/packages/constants/src/embed-events/index.ts b/packages/constants/src/embed-events/index.ts
@@ -2,6 +2,11 @@ import { AnalyticsEventType, WebEmbedMessage, IFlowAnswers } from '../';
 
 export interface IBaseEventData {
   answers?: IFlowAnswers;
+  responder: {
+    responderUuid: string;
+    sessionUuid: string;
+    isReturningResponder?: boolean;
+  }
 }
 
 export interface IRedirectEventData extends IBaseEventData {
@@ -19,6 +24,9 @@ export interface IIFrameAnalyticsEventData
   createdAt: Date;
   eventType: AnalyticsEventType;
   variantRevisionUuid: string;
+  // for StepLoaded and StepCompleted events
+  stepId?: string;
+  stepIndex?: number;
 }
 
 export enum TokenRequestPayload {

diff --git a/packages/embed-messaging-manager/src/index.ts b/packages/embed-messaging-manager/src/index.ts
@@ -6,8 +6,7 @@ import {
   TokenRequestPayload,
   type IIFramePushMessage,
   WebEmbedMessage,
-  IBaseEventData,
-  IFlowAnswers,
+  type IBaseEventData,
 } from '@formsort/constants';
 import {
   isIFrameAnalyticsEventData,
@@ -24,10 +23,7 @@ interface IAuthenticationConfig {
   idToken: string;
 }
 
-interface IFlowEventPayload {
-  variantRevisionUuid: string;
-  answers?: IFlowAnswers;
-}
+type IFlowEventPayload = Omit<IIFrameAnalyticsEventData, 'type' | 'createdAt' | 'eventType'>;
 
 export interface IFormsortEmbedConfig {
   autoHeight?: boolean;
@@ -140,13 +136,13 @@ class EmbedMessagingManager {
   };
 
   private onRedirectMessage = (redirectData: IIFrameRedirectEventData) => {
-    const { payload: url, answers } = redirectData;
+    const { payload: url, answers, responder } = redirectData;
 
     if (!isEmpty(this.eventListenersArrayMap.redirect)) {
       let cancelRedirect = false;
       // Cancel redirect if any of the redirect listeners return `{ cancel: true }`
       for (const redirectListener of this.eventListenersArrayMap.redirect) {
-        const { cancel } = redirectListener({ url, answers }) || {};
+        const { cancel } = redirectListener({ url, answers, responder }) || {};
         if (!cancelRedirect && cancel) {
           cancelRedirect = true;
         }
@@ -180,7 +176,7 @@ class EmbedMessagingManager {
   };
 
   private onEventMessage = (eventData: IIFrameAnalyticsEventData) => {
-    const { eventType, answers, variantRevisionUuid } = eventData;
+    const { eventType, answers, variantRevisionUuid, responder, stepId, stepIndex } = eventData;
 
     if (eventType === AnalyticsEventType.FlowClosed) {
       this.onFlowClosed();
@@ -193,7 +189,13 @@ class EmbedMessagingManager {
     }
 
     for (const eventListener of eventListenersArr) {
-      eventListener({ answers, variantRevisionUuid });
+      eventListener({
+        answers,
+        responder,
+        variantRevisionUuid,
+        stepId,
+        stepIndex,
+      });
     }
   };
 

diff --git a/packages/tsconfig/tsconfig.json b/packages/tsconfig/tsconfig.json
@@ -16,7 +16,6 @@
     "importHelpers": true,
     "strictNullChecks": true,
     "strictPropertyInitialization": true,
-    "suppressImplicitAnyIndexErrors": true,
     "resolveJsonModule": true,
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,

diff --git a/yarn.lock b/yarn.lock
@@ -611,6 +611,14 @@
     "@formsort/constants" "^1.7.0"
     events "^3.2.0"
 
+"@formsort/[email protected]":
+  version "2.6.2"
+  resolved "https://registry.yarnpkg.com/@formsort/web-embed-api/-/web-embed-api-2.6.2.tgz#7e5ee7e071af928c3a033d2a86b26a51c26422ae"
+  integrity sha512-3jUiZggAfFl/6ElSy/s1UXYgh4FI+ZeLVODDzNi5bDK1HpiabmTnHIKg1XsE2wT06n3T+OuoFIvPrL+x2GPTlg==
+  dependencies:
+    "@formsort/constants" "^1.10.0"
+    "@formsort/embed-messaging-manager" "^0.1.1"
+
 "@humanwhocodes/config-array@^0.9.2":
   version "0.9.5"
   resolved "https://registry.yarnpkg.com/@humanwhocodes/config-array/-/config-array-0.9.5.tgz#2cbaf9a89460da24b5ca6531b8bbfc23e1df50c7"
@@ -7785,7 +7793,7 @@ write-file-atomic@^4.0.2:
     imurmurhash "^0.1.4"
     signal-exit "^3.0.7"
 
-ws@^8.11.0, ws@^8.16.0, ws@^8.17.1:
+ws@^8.11.0, ws@^8.16.0:
   version "8.17.1"
   resolved "https://registry.yarnpkg.com/ws/-/ws-8.17.1.tgz#9293da530bb548febc95371d90f9c878727d919b"
   integrity sha512-6XQFvXTkbfUOZOKKILFG1PDK2NDQs4azKQl26T0YS5CxqWLgXajbPZ+h4gZekJyRqFU8pvnbAbbs/3TgRPy+GQ==