@funnelsgrove/runtime 0.7.13 → 0.7.15

package/dist/runtime/posthog-flags.d.ts

@@ -1,12 +1,17 @@
 import type { PostHog } from 'posthog-js';
 export declare const POSTHOG_FEATURE_FLAG_READY_TIMEOUT_MS = 2500;
 export declare const POSTHOG_SCOPED_FLAG_RELOAD_RETRY_MS = 300;
+export declare const shouldRecordPostHogSession: (distinctId: string, sampleRate: number) => boolean;
 type BootstrapConfig = {
     apiKey: string;
     apiHost: string;
     distinctId: string;
     projectId?: string;
     funnelId?: string;
+    sessionReplay?: {
+        enabled: boolean;
+        sampleRate: number;
+    };
 };
 export declare const bootstrapPostHog: (config: BootstrapConfig) => Promise<void>;
 export declare const isPostHogReady: () => boolean;

package/dist/runtime/posthog-flags.js

@@ -5,6 +5,15 @@ let readyPromise = null;
 export const POSTHOG_FEATURE_FLAG_READY_TIMEOUT_MS = 2500;
 export const POSTHOG_SCOPED_FLAG_RELOAD_RETRY_MS = 300;
 const STORED_PERSON_PROPERTIES_KEY = '$stored_person_properties';
+export const shouldRecordPostHogSession = (distinctId, sampleRate) => {
+    const normalizedRate = Math.min(100, Math.max(0, Math.round(sampleRate)));
+    let hash = 2166136261;
+    for (let index = 0; index < distinctId.length; index += 1) {
+        hash ^= distinctId.charCodeAt(index);
+        hash = Math.imul(hash, 16777619);
+    }
+    return (hash >>> 0) % 100 < normalizedRate;
+};
 const buildFlagScopeProperties = (config) => {
     var _a, _b;
     const properties = {};
@@ -59,6 +68,7 @@ export const bootstrapPostHog = (config) => {
         return readyPromise;
     }
     readyPromise = new Promise((resolve) => {
+        var _a;
         if (!config.apiKey || !config.apiHost) {
             resolve();
             return;
@@ -76,6 +86,8 @@ export const bootstrapPostHog = (config) => {
         };
         readyTimeoutId = setTimeout(markReady, POSTHOG_FEATURE_FLAG_READY_TIMEOUT_MS);
         const scopeProperties = buildFlagScopeProperties(config);
+        const sessionReplayEnabled = ((_a = config.sessionReplay) === null || _a === void 0 ? void 0 : _a.enabled) === true
+            && shouldRecordPostHogSession(config.distinctId, config.sessionReplay.sampleRate);
         primePostHogFlagScopePersistence(config.apiKey, scopeProperties);
         posthog.init(config.apiKey, {
             api_host: config.apiHost,
@@ -89,11 +101,17 @@ export const bootstrapPostHog = (config) => {
             capture_exceptions: false,
             capture_heatmaps: false,
             capture_performance: false,
-            disable_session_recording: true,
+            disable_session_recording: !sessionReplayEnabled,
+            session_recording: {
+                maskAllInputs: true,
+            },
             disable_surveys: true,
             advanced_disable_feature_flags_on_first_load: true,
             bootstrap: { distinctID: config.distinctId },
             loaded: () => {
+                if (Object.keys(scopeProperties).length > 0) {
+                    posthog.register(scopeProperties);
+                }
                 let unsubscribe = null;
                 let scopedReloadRetried = false;
                 unsubscribe = posthog.onFeatureFlags((flags) => {

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

@@ -118,6 +118,10 @@ type UseFunnelFlowControllerInput<StepId extends string> = {
     stepById: Record<string, FunnelStepMeta>;
     stepComponentById: StepComponentRegistry;
     funnelExperiments: readonly FunnelFlowControllerExperiment<StepId>[];
+    sessionReplay?: {
+        enabled: boolean;
+        sampleRate: number;
+    };
     getPathForStep: (stepId: StepId) => string;
     getStepIdFromPath: (pathname: string) => StepId | null;
     getSequentialNextStepId: (stepId: StepId) => StepId | null;
@@ -179,5 +183,5 @@ export declare function resolveRenderedExperimentStepId(input: {
     resolveRenderableStepId: (stepId: string | null | undefined) => string | null;
     safeActiveStepId: string;
 }): string;
-export declare function useFunnelFlowController<StepId extends string>({ api, analytics, stepContractVersion, initialStepId, initialAttributes, lockToInitialStep, defaultStepId, stepSequence, stepById, stepComponentById, funnelExperiments, getPathForStep, getStepIdFromPath, getSequentialNextStepId, getChoiceTargetsForStep, isFunnelStepId, resolveConfiguredNextStep, resolveRuntimeInitialStepId, }: UseFunnelFlowControllerInput<StepId>): UseFunnelFlowControllerResult<StepId>;
+export declare function useFunnelFlowController<StepId extends string>({ api, analytics, stepContractVersion, initialStepId, initialAttributes, lockToInitialStep, defaultStepId, stepSequence, stepById, stepComponentById, funnelExperiments, sessionReplay, getPathForStep, getStepIdFromPath, getSequentialNextStepId, getChoiceTargetsForStep, isFunnelStepId, resolveConfiguredNextStep, resolveRuntimeInitialStepId, }: UseFunnelFlowControllerInput<StepId>): UseFunnelFlowControllerResult<StepId>;
 export {};

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

@@ -278,7 +278,7 @@ export function resolveRenderedExperimentStepId(input) {
     const variantStepId = resolveRenderableStepId(assignment.routeToStepId);
     return variantStepId !== null && variantStepId !== void 0 ? variantStepId : safeActiveStepId;
 }
-export function useFunnelFlowController({ api = apiService, analytics, stepContractVersion, initialStepId, initialAttributes, lockToInitialStep = false, defaultStepId, stepSequence, stepById, stepComponentById, funnelExperiments, getPathForStep, getStepIdFromPath, getSequentialNextStepId, getChoiceTargetsForStep, isFunnelStepId, resolveConfiguredNextStep, resolveRuntimeInitialStepId, }) {
+export function useFunnelFlowController({ api = apiService, analytics, stepContractVersion, initialStepId, initialAttributes, lockToInitialStep = false, defaultStepId, stepSequence, stepById, stepComponentById, funnelExperiments, sessionReplay, getPathForStep, getStepIdFromPath, getSequentialNextStepId, getChoiceTargetsForStep, isFunnelStepId, resolveConfiguredNextStep, resolveRuntimeInitialStepId, }) {
     var _a, _b, _c;
     const [runtimeMode] = useRuntimeMode();
     const [editorModeEnabled, setEditorModeEnabled] = useState(() => isEditorEnabled());
@@ -287,6 +287,8 @@ export function useFunnelFlowController({ api = apiService, analytics, stepContr
     const [editorVariantOverrides, setEditorVariantOverrides] = useState({});
     const shouldLockToInitialStep = lockToInitialStep || isPreviewStepLockRequested();
     const isPreviewRuntime = useMemo(() => isPreviewFrameRuntime(), []);
+    const sessionReplayEnabled = sessionReplay === null || sessionReplay === void 0 ? void 0 : sessionReplay.enabled;
+    const sessionReplaySampleRate = sessionReplay === null || sessionReplay === void 0 ? void 0 : sessionReplay.sampleRate;
     const resolveRenderableStepId = useCallback((stepId) => {
         if (!stepId || !isFunnelStepId(stepId)) {
             return null;
@@ -540,6 +542,12 @@ export function useFunnelFlowController({ api = apiService, analytics, stepContr
             distinctId: localUserId,
             projectId: PROJECT_ID,
             funnelId: FUNNEL_ID,
+            sessionReplay: sessionReplayEnabled !== undefined && sessionReplaySampleRate !== undefined
+                ? {
+                    enabled: sessionReplayEnabled,
+                    sampleRate: sessionReplaySampleRate,
+                }
+                : undefined,
         })
             .then(() => setPostHogReady(true))
             .catch((error) => {
@@ -598,7 +606,13 @@ export function useFunnelFlowController({ api = apiService, analytics, stepContr
             logger.error('Failed to identify PostHog user:', error);
         });
         return cancelAttributionFailOpen;
-    }, [api, isPreviewRuntime, isSubscriptionManagementRuntime]);
+    }, [
+        api,
+        isPreviewRuntime,
+        isSubscriptionManagementRuntime,
+        sessionReplayEnabled,
+        sessionReplaySampleRate,
+    ]);
     const recordStepCompletion = useCallback((intent, options = {}) => {
         var _a;
         const meta = stepById[intent.visit.stepId];

package/dist/services/funnel-runtime-config.d.ts

@@ -4,14 +4,23 @@ export type FunnelRuntimeConfig = {
     schemaVersion: 2;
     funnelId: string;
     projectId: string;
+    sessionReplay?: {
+        enabled?: unknown;
+        sampleRate?: unknown;
+    };
     offerSets: unknown[];
     experiments: unknown[];
 };
+export type FunnelSessionReplayConfig = {
+    enabled: boolean;
+    sampleRate: number;
+};
 export type ResolvedFunnelRuntimeConfig = {
     revisionId: string;
     sourceDeploymentId: string;
     sourceVersionId: string;
     publishedAt: string;
+    sessionReplay?: FunnelSessionReplayConfig;
     offerSets: readonly GeneratedOfferSet[];
     experiments: readonly FunnelExperimentDefinition[];
 };

package/dist/services/funnel-runtime-config.js

@@ -26,6 +26,19 @@ const pick = (record, ...keys) => {
 const pickString = (record, ...keys) => (readString(pick(record, ...keys)));
 const pickNumber = (record, ...keys) => (readNumber(pick(record, ...keys)));
 const pickBoolean = (record, ...keys) => (readBoolean(pick(record, ...keys)));
+const normalizeSessionReplay = (value) => {
+    var _a;
+    if (!isRecord(value)) {
+        return { enabled: false, sampleRate: 10 };
+    }
+    const sampleRate = readNumber(value.sampleRate);
+    return {
+        enabled: (_a = readBoolean(value.enabled)) !== null && _a !== void 0 ? _a : false,
+        sampleRate: sampleRate === null
+            ? 10
+            : Math.min(100, Math.max(1, Math.round(sampleRate))),
+    };
+};
 const deepFreeze = (value) => {
     if (!value || typeof value !== 'object' || Object.isFrozen(value)) {
         return value;
@@ -234,6 +247,7 @@ export const resolvePublishedFunnelRuntimeConfig = (published, options = {}) =>
         sourceDeploymentId: published.sourceDeploymentId,
         sourceVersionId: published.sourceVersionId,
         publishedAt: published.publishedAt,
+        sessionReplay: normalizeSessionReplay(published.config.sessionReplay),
         offerSets,
         experiments: normalizePublishedExperiments(published.config, published.publishedAt, offerSets),
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@funnelsgrove/runtime",
-  "version": "0.7.13",
+  "version": "0.7.15",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/The-Solid-Grove/funnelsgrove.git",