npm - @funnelsgrove/runtime - Versions diffs - 0.1.31 → 0.1.33 - Mend

@funnelsgrove/runtime 0.1.31 → 0.1.33

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/dist/config/funnel.manifest.types.d.ts +25 -0
package/dist/config/funnel.manifest.types.js +6 -1
package/dist/runtime/use-funnel-flow-controller.d.ts +34 -0
package/dist/runtime/use-funnel-flow-controller.js +62 -18
package/dist/services/api.service.js +1 -0
package/package.json +1 -1

package/dist/config/funnel.manifest.types.d.ts CHANGED Viewed

@@ -1,5 +1,29 @@
 import type { FunnelStepKind, FunnelStepType } from '../steps/types.js';
 export type TemplateArchitectureVersion = number;
+export type FunnelBreakpointName = 'small' | 'medium' | 'large' | 'desktop-small';
+export type FunnelManifestBreakpoint = {
+    width: number;
+    height: number;
+};
+export type FunnelManifestBreakpoints = Record<FunnelBreakpointName, FunnelManifestBreakpoint>;
+export declare const DEFAULT_FUNNEL_BREAKPOINTS: {
+    readonly small: {
+        readonly width: 375;
+        readonly height: 667;
+    };
+    readonly medium: {
+        readonly width: 393;
+        readonly height: 852;
+    };
+    readonly large: {
+        readonly width: 402;
+        readonly height: 874;
+    };
+    readonly 'desktop-small': {
+        readonly width: 1280;
+        readonly height: 800;
+    };
+};
 export type FunnelManifestStep = {
     id: string;
     path: string;
@@ -59,6 +83,7 @@ export type FunnelManifest = {
         width: number;
         height: number;
     };
+    breakpoints?: FunnelManifestBreakpoints;
     assets: Record<string, FunnelManifestAsset>;
     steps: readonly FunnelManifestStep[];
     entryPoints?: readonly FunnelManifestEntryPoint[];

package/dist/config/funnel.manifest.types.js CHANGED Viewed

@@ -1 +1,6 @@
-export {};
+export const DEFAULT_FUNNEL_BREAKPOINTS = {
+    small: { width: 375, height: 667 },
+    medium: { width: 393, height: 852 },
+    large: { width: 402, height: 874 },
+    'desktop-small': { width: 1280, height: 800 },
+};

package/dist/runtime/use-funnel-flow-controller.d.ts CHANGED Viewed

@@ -10,9 +10,43 @@ export type FunnelFlowControllerExperiment<StepId extends string> = FunnelManife
 };
 type StepComponentRegistry = Record<string, unknown>;
 type FunnelFlowAnalyticsAdapter = {
+    trackStepStarted?: (input: {
+        stepId: string;
+        stepName: string;
+        stepType?: string;
+        startedAt: string;
+        featureFlags?: Record<string, string>;
+    }) => string | null;
+    trackStepCompleted?: (input: {
+        stepId: string;
+        stepName: string;
+        stepType?: string;
+        startedAt: string;
+        endedAt: string;
+        selected?: Record<string, unknown>;
+        featureFlags?: Record<string, string>;
+    }) => string | null;
+    trackStepEngaged?: (input: {
+        stepId: string;
+        stepName: string;
+        stepType?: string;
+        startedAt: string;
+        engagedAt: string;
+        durationMs: number;
+        engagementThresholdMs: number;
+        featureFlags?: Record<string, string>;
+    }) => string | null;
+    trackFunnelStarted?: (input: {
+        stepId: string;
+        stepName: string;
+        stepType?: string;
+        occurredAt: string;
+        featureFlags?: Record<string, string>;
+    }) => string | null;
     trackFirstStepViewed?: (input: {
         stepId: string;
         stepName: string;
+        stepType?: string;
         occurredAt: string;
         featureFlags?: Record<string, string>;
     }) => string | null;

package/dist/runtime/use-funnel-flow-controller.js CHANGED Viewed

@@ -331,6 +331,7 @@ export function useFunnelFlowController({ analytics, initialStepId, lockToInitia
         });
     }, [isPreviewRuntime]);
     const recordStepCompletion = useCallback((stepId, explicitChoices) => {
+        var _a;
         const meta = stepById[stepId];
         if (!meta) {
             return;
@@ -359,16 +360,27 @@ export function useFunnelFlowController({ analytics, initialStepId, lockToInitia
         const durationMs = Math.max(0, new Date(record.completedAt).getTime() - new Date(startedAt).getTime());
         dispatchWindowCustomEvent('funnel:step-completed', record);
         if (!isPreviewRuntime) {
-            apiService.trackStepCompleted({
-                userId: currentUserIdRef.current,
+            (_a = analytics === null || analytics === void 0 ? void 0 : analytics.trackStepCompleted) === null || _a === void 0 ? void 0 : _a.call(analytics, {
                 stepId: record.stepId,
                 stepName: record.stepName,
                 stepType,
                 startedAt,
                 endedAt: record.completedAt,
                 selected: record.choices,
+                featureFlags: postHogFeatureFlagsRef.current,
             });
-            capturePostHogStepEvent('step_completed', Object.assign({ distinct_id: currentUserIdRef.current, funnel_id: FUNNEL_ID || undefined, funnel_version_id: FUNNEL_VERSION_ID || undefined, project_id: PROJECT_ID || undefined, environment: runtimeMode, step_id: record.stepId, step_name: record.stepName, step_type: stepType, started_at: startedAt, ended_at: record.completedAt, duration_ms: Number.isFinite(durationMs) ? durationMs : undefined, selected: record.choices }, buildFeatureFlagProperties(postHogFeatureFlagsRef.current)));
+            if (!(analytics === null || analytics === void 0 ? void 0 : analytics.trackStepCompleted)) {
+                apiService.trackStepCompleted({
+                    userId: currentUserIdRef.current,
+                    stepId: record.stepId,
+                    stepName: record.stepName,
+                    stepType,
+                    startedAt,
+                    endedAt: record.completedAt,
+                    selected: record.choices,
+                });
+                capturePostHogStepEvent('step_completed', Object.assign({ distinct_id: currentUserIdRef.current, funnel_id: FUNNEL_ID || undefined, funnel_version_id: FUNNEL_VERSION_ID || undefined, project_id: PROJECT_ID || undefined, environment: runtimeMode, step_id: record.stepId, step_name: record.stepName, step_type: stepType, started_at: startedAt, ended_at: record.completedAt, duration_ms: Number.isFinite(durationMs) ? durationMs : undefined, selected: record.choices }, buildFeatureFlagProperties(postHogFeatureFlagsRef.current)));
+            }
         }
         setUser((prev) => {
             var _a, _b;
@@ -391,12 +403,12 @@ export function useFunnelFlowController({ analytics, initialStepId, lockToInitia
             }
             return updatedUser;
         });
-    }, [isPreviewRuntime, stepById]);
+    }, [analytics, isPreviewRuntime, runtimeMode, stepById]);
     const completeStep = useCallback((stepId, choices) => {
         recordStepCompletion(stepId, choices);
     }, [recordStepCompletion]);
     useEffect(() => {
-        var _a;
+        var _a, _b, _c;
         if (safeActiveStepId !== activeStepId) {
             logger.warn(`[FunnelFlow] Unknown or non-renderable step "${activeStepId}", falling back to "${safeActiveStepId}".`);
             setActiveStepId(safeActiveStepId);
@@ -417,19 +429,36 @@ export function useFunnelFlowController({ analytics, initialStepId, lockToInitia
         const stepType = renderedStepMeta === null || renderedStepMeta === void 0 ? void 0 : renderedStepMeta.type;
         stepStartedAtByIdRef.current[renderedStepId] = startedAt;
         if (!isPreviewRuntime) {
-            apiService.trackStepStarted({
-                userId: currentUserIdRef.current,
+            (_a = analytics === null || analytics === void 0 ? void 0 : analytics.trackStepStarted) === null || _a === void 0 ? void 0 : _a.call(analytics, {
                 stepId: renderedStepId,
                 stepName,
                 stepType,
                 startedAt,
+                featureFlags: postHogFeatureFlagsRef.current,
             });
-            capturePostHogStepEvent('step_started', Object.assign({ distinct_id: currentUserIdRef.current, funnel_id: FUNNEL_ID || undefined, funnel_version_id: FUNNEL_VERSION_ID || undefined, project_id: PROJECT_ID || undefined, environment: runtimeMode, step_id: renderedStepId, step_name: stepName, step_type: stepType, started_at: startedAt }, buildFeatureFlagProperties(postHogFeatureFlagsRef.current)));
+            if (!(analytics === null || analytics === void 0 ? void 0 : analytics.trackStepStarted)) {
+                apiService.trackStepStarted({
+                    userId: currentUserIdRef.current,
+                    stepId: renderedStepId,
+                    stepName,
+                    stepType,
+                    startedAt,
+                });
+                capturePostHogStepEvent('step_started', Object.assign({ distinct_id: currentUserIdRef.current, funnel_id: FUNNEL_ID || undefined, funnel_version_id: FUNNEL_VERSION_ID || undefined, project_id: PROJECT_ID || undefined, environment: runtimeMode, step_id: renderedStepId, step_name: stepName, step_type: stepType, started_at: startedAt }, buildFeatureFlagProperties(postHogFeatureFlagsRef.current)));
+            }
             if (!firstStepViewedTrackedRef.current && safeActiveStepId === defaultStepId) {
                 firstStepViewedTrackedRef.current = true;
-                (_a = analytics === null || analytics === void 0 ? void 0 : analytics.trackFirstStepViewed) === null || _a === void 0 ? void 0 : _a.call(analytics, {
+                (_b = analytics === null || analytics === void 0 ? void 0 : analytics.trackFunnelStarted) === null || _b === void 0 ? void 0 : _b.call(analytics, {
                     stepId: renderedStepId,
                     stepName,
+                    stepType,
+                    occurredAt: startedAt,
+                    featureFlags: postHogFeatureFlagsRef.current,
+                });
+                (_c = analytics === null || analytics === void 0 ? void 0 : analytics.trackFirstStepViewed) === null || _c === void 0 ? void 0 : _c.call(analytics, {
+                    stepId: renderedStepId,
+                    stepName,
+                    stepType,
                     occurredAt: startedAt,
                     featureFlags: postHogFeatureFlagsRef.current,
                 });
@@ -447,25 +476,38 @@ export function useFunnelFlowController({ analytics, initialStepId, lockToInitia
         const engagedStepName = stepName;
         const engagedStepType = stepType;
         const timer = window.setTimeout(() => {
+            var _a;
             if (prevStepIdRef.current !== engagedStepId || engagedStepIdsRef.current.has(engagedStepId)) {
                 return;
             }
             engagedStepIdsRef.current.add(engagedStepId);
             const engagedAt = new Date().toISOString();
-            apiService.trackFunnelEvent({
-                userId: currentUserIdRef.current,
-                eventType: 'step_engaged',
+            (_a = analytics === null || analytics === void 0 ? void 0 : analytics.trackStepEngaged) === null || _a === void 0 ? void 0 : _a.call(analytics, {
                 stepId: engagedStepId,
                 stepName: engagedStepName,
                 stepType: engagedStepType,
                 startedAt: engagedStartedAt,
-                endedAt: engagedAt,
-                metadata: {
-                    durationMs: FIRST_STEP_ENGAGEMENT_THRESHOLD_MS,
-                    engagementThresholdMs: FIRST_STEP_ENGAGEMENT_THRESHOLD_MS,
-                },
+                engagedAt,
+                durationMs: FIRST_STEP_ENGAGEMENT_THRESHOLD_MS,
+                engagementThresholdMs: FIRST_STEP_ENGAGEMENT_THRESHOLD_MS,
+                featureFlags: postHogFeatureFlagsRef.current,
             });
-            capturePostHogStepEvent('step_engaged', Object.assign({ distinct_id: currentUserIdRef.current, funnel_id: FUNNEL_ID || undefined, funnel_version_id: FUNNEL_VERSION_ID || undefined, project_id: PROJECT_ID || undefined, environment: runtimeMode, step_id: engagedStepId, step_name: engagedStepName, step_type: engagedStepType, started_at: engagedStartedAt, ended_at: engagedAt, duration_ms: FIRST_STEP_ENGAGEMENT_THRESHOLD_MS, engagement_threshold_ms: FIRST_STEP_ENGAGEMENT_THRESHOLD_MS }, buildFeatureFlagProperties(postHogFeatureFlagsRef.current)));
+            if (!(analytics === null || analytics === void 0 ? void 0 : analytics.trackStepEngaged)) {
+                apiService.trackFunnelEvent({
+                    userId: currentUserIdRef.current,
+                    eventType: 'step_engaged',
+                    stepId: engagedStepId,
+                    stepName: engagedStepName,
+                    stepType: engagedStepType,
+                    startedAt: engagedStartedAt,
+                    endedAt: engagedAt,
+                    metadata: {
+                        durationMs: FIRST_STEP_ENGAGEMENT_THRESHOLD_MS,
+                        engagementThresholdMs: FIRST_STEP_ENGAGEMENT_THRESHOLD_MS,
+                    },
+                });
+                capturePostHogStepEvent('step_engaged', Object.assign({ distinct_id: currentUserIdRef.current, funnel_id: FUNNEL_ID || undefined, funnel_version_id: FUNNEL_VERSION_ID || undefined, project_id: PROJECT_ID || undefined, environment: runtimeMode, step_id: engagedStepId, step_name: engagedStepName, step_type: engagedStepType, started_at: engagedStartedAt, ended_at: engagedAt, duration_ms: FIRST_STEP_ENGAGEMENT_THRESHOLD_MS, engagement_threshold_ms: FIRST_STEP_ENGAGEMENT_THRESHOLD_MS }, buildFeatureFlagProperties(postHogFeatureFlagsRef.current)));
+            }
         }, FIRST_STEP_ENGAGEMENT_THRESHOLD_MS);
         return () => window.clearTimeout(timer);
     }, [
@@ -478,6 +520,8 @@ export function useFunnelFlowController({ analytics, initialStepId, lockToInitia
         renderedStepId,
         renderedStepMeta === null || renderedStepMeta === void 0 ? void 0 : renderedStepMeta.name,
         renderedStepMeta === null || renderedStepMeta === void 0 ? void 0 : renderedStepMeta.title,
+        renderedStepMeta === null || renderedStepMeta === void 0 ? void 0 : renderedStepMeta.type,
+        runtimeMode,
         safeActiveStepId,
     ]);
     useEffect(() => {

package/dist/services/api.service.js CHANGED Viewed

@@ -126,6 +126,7 @@ const buildSdkEvent = (event) => {
         eventType: event.eventType,
         stepId: event.stepId || null,
         stepName: event.stepName || null,
+        stepType: event.stepType || null,
         startedAt: event.startedAt || null,
         endedAt: event.endedAt || null,
         selected: event.selected || {},

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@funnelsgrove/runtime",
-  "version": "0.1.31",
+  "version": "0.1.33",
   "type": "module",
   "private": false,
   "main": "./dist/index.js",