chore: Add totalSubSteps property and funnelStepError event (#1354)

cloudscape-design · Jul 21, 2023 · 66fc217 · 66fc217
1 parent afe73ee
commit 66fc217
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 2 deletions.
diff --git a/src/internal/analytics/__tests__/mocks.ts b/src/internal/analytics/__tests__/mocks.ts
@@ -14,6 +14,7 @@ export function mockFunnelMetrics() {
     funnelStepStart: jest.fn(),
     funnelStepComplete: jest.fn(),
     funnelStepNavigation: jest.fn(),
+    funnelStepError: jest.fn(),
     funnelSubStepStart: jest.fn(),
     funnelSubStepComplete: jest.fn(),
     funnelSubStepError: jest.fn(),

diff --git a/src/internal/analytics/index.ts b/src/internal/analytics/index.ts
@@ -24,6 +24,7 @@ export let FunnelMetrics: IFunnelMetrics = {
   funnelStepStart(): void {},
   funnelStepComplete(): void {},
   funnelStepNavigation(): void {},
+  funnelStepError(): void {},
   funnelSubStepStart(): void {},
   funnelSubStepComplete(): void {},
   funnelSubStepError(): void {},

diff --git a/src/internal/analytics/interfaces.ts b/src/internal/analytics/interfaces.ts
@@ -38,9 +38,21 @@ export interface FunnelStepProps extends BaseFunnelProps {
   subStepAllSelector: string;
 }
 
+export interface FunnelStepStartProps extends FunnelStepProps {
+  totalSubSteps?: number;
+}
+export interface FunnelStepCompleteProps extends FunnelStepProps {
+  totalSubSteps?: number;
+}
+
 export interface FunnelStepNavigationProps extends FunnelStepProps {
   destinationStepNumber: number;
   navigationType: string;
+  totalSubSteps?: number;
+}
+
+export interface FunnelStepErrorProps extends FunnelStepProps {
+  stepErrorSelector: string;
 }
 
 export interface FunnelSubStepProps extends FunnelStepProps {
@@ -70,9 +82,10 @@ export interface IFunnelMetrics {
   funnelComplete: FunnelMethod<BaseFunnelProps>;
   funnelSuccessful: FunnelMethod<BaseFunnelProps>;
   funnelCancelled: FunnelMethod<BaseFunnelProps>;
-  funnelStepStart: FunnelMethod<FunnelStepProps>;
-  funnelStepComplete: FunnelMethod<FunnelStepProps>;
+  funnelStepStart: FunnelMethod<FunnelStepStartProps>;
+  funnelStepComplete: FunnelMethod<FunnelStepCompleteProps>;
   funnelStepNavigation: FunnelMethod<FunnelStepNavigationProps>;
+  funnelStepError: FunnelMethod<FunnelStepErrorProps>;
   funnelSubStepStart: FunnelMethod<FunnelSubStepProps>;
   funnelSubStepComplete: FunnelMethod<FunnelSubStepProps>;
   funnelSubStepError: FunnelMethod<OptionalFunnelSubStepErrorProps>;

diff --git a/src/wizard/__tests__/analytics.test.tsx b/src/wizard/__tests__/analytics.test.tsx
@@ -22,6 +22,7 @@ function mockFunnelMetrics() {
     funnelStepStart: jest.fn(),
     funnelStepComplete: jest.fn(),
     funnelStepNavigation: jest.fn(),
+    funnelStepError: jest.fn(),
     funnelSubStepStart: jest.fn(),
     funnelSubStepComplete: jest.fn(),
     funnelSubStepError: jest.fn(),