plugin-hubtype-analytics: add an enum for webviewEndFailType (#2923)

## Description Add an enum for webviewEndFailType ## Testing Fix test
hubtype · Oct 9, 2024 · f9d4f76 · f9d4f76
1 parent 2c0540c
commit f9d4f76
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 6 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/botonic-plugin-hubtype-analytics/package.json b/packages/botonic-plugin-hubtype-analytics/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@botonic/plugin-hubtype-analytics",
-  "version": "0.30.0",
+  "version": "0.30.1",
   "description": "Plugin for tracking in the Hubtype backend to see the results in the Hubtype Dashbord",
   "main": "./lib/cjs/index.js",
   "module": "./lib/esm/index.js",

diff --git a/packages/botonic-plugin-hubtype-analytics/src/types.ts b/packages/botonic-plugin-hubtype-analytics/src/types.ts
@@ -147,10 +147,15 @@ export interface EventWebviewEnd extends HtBaseEventProps {
   webviewName: string
   webviewStepName?: string
   webviewStepNumber?: number
-  webviewEndFailType?: string
+  webviewEndFailType?: WebviewEndFailType
   webviewEndFailMessage?: string
 }
 
+export enum WebviewEndFailType {
+  CanceledByUser = 'canceled_by_user',
+  ApiError = 'api_error',
+}
+
 export interface EventCustom extends HtBaseEventProps {
   action: EventAction.Custom
   customFields?: Record<string, any>

diff --git a/packages/botonic-plugin-hubtype-analytics/tests/event-webview.test.ts b/packages/botonic-plugin-hubtype-analytics/tests/event-webview.test.ts
@@ -1,4 +1,9 @@
-import { createHtEvent, EventAction, EventType } from '../src'
+import {
+  createHtEvent,
+  EventAction,
+  EventType,
+  WebviewEndFailType,
+} from '../src'
 import { getRequestData } from './helpers'
 
 describe('Create webview events', () => {
@@ -34,7 +39,7 @@ describe('Create webview events', () => {
       webviewName: 'ADD_A_BAG',
       webviewStepName: 'summary_step',
       webviewStepNumber: 3,
-      webviewEndFailType: 'canceled_by_user',
+      webviewEndFailType: WebviewEndFailType.CanceledByUser,
       webviewEndFailMessage: 'Closed by user',
     })
 
@@ -48,7 +53,7 @@ describe('Create webview events', () => {
       webview_name: 'ADD_A_BAG',
       webview_end_step_name: 'summary_step',
       webview_end_step_n: 3,
-      webview_end_fail_type: 'canceled_by_user',
+      webview_end_fail_type: WebviewEndFailType.CanceledByUser,
       webview_end_fail_message: 'Closed by user',
       type: EventType.WebEvent,
       bot_interaction_id: 'testInteractionId',