@funnelsgrove/runtime 0.7.12 → 0.7.14

package/dist/config/env.config.d.ts

@@ -7,6 +7,8 @@ export declare const RUNTIME_ENV_KEYS: {
     readonly projectId: "NEXT_PUBLIC_PROJECT_ID";
     readonly funnelVersionId: "NEXT_PUBLIC_FUNNEL_VERSION_ID";
     readonly posthogProjectApiKey: "NEXT_PUBLIC_POSTHOG_PROJECT_API_KEY";
+    readonly posthogSessionReplayEnabled: "NEXT_PUBLIC_POSTHOG_SESSION_REPLAY_ENABLED";
+    readonly posthogSessionReplaySampleRate: "NEXT_PUBLIC_POSTHOG_SESSION_REPLAY_SAMPLE_RATE";
     readonly supportEmail: "NEXT_PUBLIC_FUNNEL_SUPPORT_EMAIL";
     readonly iosAppStoreUrl: "NEXT_PUBLIC_IOS_APP_STORE_URL";
     readonly androidPlayStoreUrl: "NEXT_PUBLIC_ANDROID_PLAY_STORE_URL";

package/dist/config/env.config.js

@@ -18,6 +18,8 @@ export const RUNTIME_ENV_KEYS = {
     projectId: 'NEXT_PUBLIC_PROJECT_ID',
     funnelVersionId: 'NEXT_PUBLIC_FUNNEL_VERSION_ID',
     posthogProjectApiKey: 'NEXT_PUBLIC_POSTHOG_PROJECT_API_KEY',
+    posthogSessionReplayEnabled: 'NEXT_PUBLIC_POSTHOG_SESSION_REPLAY_ENABLED',
+    posthogSessionReplaySampleRate: 'NEXT_PUBLIC_POSTHOG_SESSION_REPLAY_SAMPLE_RATE',
     supportEmail: 'NEXT_PUBLIC_FUNNEL_SUPPORT_EMAIL',
     iosAppStoreUrl: 'NEXT_PUBLIC_IOS_APP_STORE_URL',
     androidPlayStoreUrl: 'NEXT_PUBLIC_ANDROID_PLAY_STORE_URL',
@@ -79,6 +81,8 @@ const RUNTIME_ENV_VALUES = {
     NEXT_PUBLIC_FUNNEL_VERSION_ID: readRuntimeEnv(() => process.env.NEXT_PUBLIC_FUNNEL_VERSION_ID),
     NEXT_PUBLIC_PROJECT_ID: readRuntimeEnv(() => process.env.NEXT_PUBLIC_PROJECT_ID),
     NEXT_PUBLIC_POSTHOG_PROJECT_API_KEY: readRuntimeEnv(() => process.env.NEXT_PUBLIC_POSTHOG_PROJECT_API_KEY),
+    NEXT_PUBLIC_POSTHOG_SESSION_REPLAY_ENABLED: readRuntimeEnv(() => process.env.NEXT_PUBLIC_POSTHOG_SESSION_REPLAY_ENABLED),
+    NEXT_PUBLIC_POSTHOG_SESSION_REPLAY_SAMPLE_RATE: readRuntimeEnv(() => process.env.NEXT_PUBLIC_POSTHOG_SESSION_REPLAY_SAMPLE_RATE),
     NEXT_PUBLIC_FUNNEL_SUPPORT_EMAIL: readRuntimeEnv(() => process.env.NEXT_PUBLIC_FUNNEL_SUPPORT_EMAIL),
     NEXT_PUBLIC_IOS_APP_STORE_URL: readRuntimeEnv(() => process.env.NEXT_PUBLIC_IOS_APP_STORE_URL),
     NEXT_PUBLIC_ANDROID_PLAY_STORE_URL: readRuntimeEnv(() => process.env.NEXT_PUBLIC_ANDROID_PLAY_STORE_URL),

package/dist/runtime/funnel-attribution.js

@@ -28,7 +28,25 @@ const EVENT_ATTRIBUTION_FILTER_KEYS = new Set([
     'utm_campaign',
     'utm_content',
     'utm_term',
+    'utm_id',
+    'utm_ad',
+    'utm_adset',
+    'campaign_id',
+    'campaign_name',
+    'facebook_campaign_id',
     'adset_id',
+    'adset_name',
+    'ad_set_id',
+    'facebook_adset_id',
+    'ad_id',
+    'ad_name',
+    'facebook_ad_id',
+    'creative_id',
+    'creative_name',
+    'facebook_creative_id',
+    'placement',
+    'site_source_name',
+    'media_source',
 ]);
 const MAX_EVENT_ATTRIBUTION_FILTER_VALUE_CODE_POINTS = 256;
 const POSTHOG_CONTEXT_MAPPINGS = {
@@ -257,7 +275,7 @@ export const mergeFunnelUserAttribution = (current, incoming) => {
         context: deepMergeRecords(currentContext, nextContext),
     };
 };
-export const buildFunnelAttributionEventMetadata = (attribution) => normalizeEventAttributionTouch(attribution === null || attribution === void 0 ? void 0 : attribution.firstTouch);
+export const buildFunnelAttributionEventMetadata = (attribution) => normalizeEventAttributionTouch(attribution === null || attribution === void 0 ? void 0 : attribution.lastTouch);
 export const getFunnelUserAttribution = (document) => {
     if (!isRecord(document) || !isRecord(document.attribution)) {
         return null;

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

@@ -1,6 +1,7 @@
 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;

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 = {};
@@ -76,6 +85,8 @@ export const bootstrapPostHog = (config) => {
         };
         readyTimeoutId = setTimeout(markReady, POSTHOG_FEATURE_FLAG_READY_TIMEOUT_MS);
         const scopeProperties = buildFlagScopeProperties(config);
+        const sessionReplayEnabled = runtimePublicConfig.posthogSessionReplayEnabled
+            && shouldRecordPostHogSession(config.distinctId, runtimePublicConfig.posthogSessionReplaySampleRate);
         primePostHogFlagScopePersistence(config.apiKey, scopeProperties);
         posthog.init(config.apiKey, {
             api_host: config.apiHost,
@@ -89,11 +100,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.js

@@ -8,7 +8,7 @@ import { buildHostedStepLocation, dispatchFunnelLocationChange, dispatchWindowCu
 import { isPreviewStepLockRequested, resolveNextStepFromContext, shouldRunAutoAdvanceTimer, } from './funnel-flow.js';
 import { usePreviewBridge } from './preview-bridge.js';
 import { resolveExperimentAssignment, resolveForcedExperimentAssignment, } from './experiment-assignment.js';
-import { buildFunnelAttributionEventMetadata, collectCurrentFunnelAttribution, getFunnelUserAttribution, } from './funnel-attribution.js';
+import { buildFunnelAttributionEventMetadata, collectCurrentFunnelAttribution, getFunnelUserAttribution, mergeFunnelUserAttribution, } from './funnel-attribution.js';
 import { resolveUrlUserAttributes } from './url-user-attributes.js';
 import { bootstrapPostHog, identifyPostHog, isPostHogReady, resolveExperimentVariant, } from './posthog-flags.js';
 import { getRuntimeMode, isEditorEnabled, useRuntimeMode } from '../services/runtime-mode.service.js';
@@ -24,8 +24,17 @@ const isTerminalCompletion = (stepMeta, outcome) => {
         && Boolean(stepMeta && ((_a = FUNNEL_STEP_CONTRACTS[stepMeta.type]) === null || _a === void 0 ? void 0 : _a.terminal) === true));
 };
 export function resolveFunnelEventAttribution(document, provisionalAttribution) {
-    var _a;
-    return (_a = getFunnelUserAttribution(document)) !== null && _a !== void 0 ? _a : provisionalAttribution;
+    const persistedAttribution = getFunnelUserAttribution(document);
+    if (!persistedAttribution) {
+        return provisionalAttribution;
+    }
+    if (!provisionalAttribution) {
+        return persistedAttribution;
+    }
+    return Object.assign(Object.assign({}, mergeFunnelUserAttribution(persistedAttribution, provisionalAttribution)), { 
+        // This event describes the page load happening now. An empty current URL is
+        // intentionally direct; never revive a paid click from an older visit.
+        lastTouch: Object.assign({}, provisionalAttribution.lastTouch) });
 }
 export function buildReadyFunnelAttributionEventMetadata(attributionReady, attribution) {
     return attributionReady ? buildFunnelAttributionEventMetadata(attribution) : null;

package/dist/services/project-env.d.ts

@@ -4,6 +4,8 @@ export declare const PROJECT_ENV_STANDARD_KEYS: {
     readonly funnelVersionId: "NEXT_PUBLIC_FUNNEL_VERSION_ID";
     readonly projectId: "NEXT_PUBLIC_PROJECT_ID";
     readonly posthogProjectApiKey: "NEXT_PUBLIC_POSTHOG_PROJECT_API_KEY";
+    readonly posthogSessionReplayEnabled: "NEXT_PUBLIC_POSTHOG_SESSION_REPLAY_ENABLED";
+    readonly posthogSessionReplaySampleRate: "NEXT_PUBLIC_POSTHOG_SESSION_REPLAY_SAMPLE_RATE";
     readonly stripeEnabled: "STRIPE_ENABLED";
     readonly stripeActiveMode: "NEXT_PUBLIC_STRIPE_ACTIVE_MODE";
     readonly stripeTestPublishableKey: "NEXT_PUBLIC_STRIPE_TEST_PUBLISHABLE_KEY";

package/dist/services/project-env.js

@@ -4,6 +4,8 @@ export const PROJECT_ENV_STANDARD_KEYS = {
     funnelVersionId: 'NEXT_PUBLIC_FUNNEL_VERSION_ID',
     projectId: 'NEXT_PUBLIC_PROJECT_ID',
     posthogProjectApiKey: 'NEXT_PUBLIC_POSTHOG_PROJECT_API_KEY',
+    posthogSessionReplayEnabled: 'NEXT_PUBLIC_POSTHOG_SESSION_REPLAY_ENABLED',
+    posthogSessionReplaySampleRate: 'NEXT_PUBLIC_POSTHOG_SESSION_REPLAY_SAMPLE_RATE',
     stripeEnabled: 'STRIPE_ENABLED',
     stripeActiveMode: 'NEXT_PUBLIC_STRIPE_ACTIVE_MODE',
     stripeTestPublishableKey: 'NEXT_PUBLIC_STRIPE_TEST_PUBLISHABLE_KEY',
@@ -78,6 +80,8 @@ const buildProjectStandardValues = (envMap) => {
         funnelVersionId: getProjectEnvValue(envMap, PROJECT_ENV_STANDARD_KEYS.funnelVersionId),
         projectId: getProjectEnvValue(envMap, PROJECT_ENV_STANDARD_KEYS.projectId),
         posthogProjectApiKey: getProjectEnvValue(envMap, PROJECT_ENV_STANDARD_KEYS.posthogProjectApiKey),
+        posthogSessionReplayEnabled: getProjectEnvValue(envMap, PROJECT_ENV_STANDARD_KEYS.posthogSessionReplayEnabled),
+        posthogSessionReplaySampleRate: getProjectEnvValue(envMap, PROJECT_ENV_STANDARD_KEYS.posthogSessionReplaySampleRate),
         stripeEnabled: getProjectEnvValue(envMap, PROJECT_ENV_STANDARD_KEYS.stripeEnabled),
         stripeActiveMode: getProjectEnvValue(envMap, PROJECT_ENV_STANDARD_KEYS.stripeActiveMode),
         stripeTestPublishableKey: getProjectEnvValue(envMap, PROJECT_ENV_STANDARD_KEYS.stripeTestPublishableKey),

package/dist/services/public-env.d.ts

@@ -7,6 +7,8 @@ export declare const RUNTIME_PUBLIC_ENV_KEYS: {
     readonly funnelVersionId: "NEXT_PUBLIC_FUNNEL_VERSION_ID";
     readonly projectId: "NEXT_PUBLIC_PROJECT_ID";
     readonly posthogProjectApiKey: "NEXT_PUBLIC_POSTHOG_PROJECT_API_KEY";
+    readonly posthogSessionReplayEnabled: "NEXT_PUBLIC_POSTHOG_SESSION_REPLAY_ENABLED";
+    readonly posthogSessionReplaySampleRate: "NEXT_PUBLIC_POSTHOG_SESSION_REPLAY_SAMPLE_RATE";
     readonly supportEmail: "NEXT_PUBLIC_FUNNEL_SUPPORT_EMAIL";
     readonly iosAppStoreUrl: "NEXT_PUBLIC_IOS_APP_STORE_URL";
     readonly androidPlayStoreUrl: "NEXT_PUBLIC_ANDROID_PLAY_STORE_URL";
@@ -34,6 +36,8 @@ export type RuntimePublicConfig = {
     funnelVersionId: string;
     projectId: string;
     posthogProjectApiKey: string;
+    posthogSessionReplayEnabled: boolean;
+    posthogSessionReplaySampleRate: number;
     supportEmail: string;
     iosAppStoreUrl: string | null;
     androidPlayStoreUrl: string | null;

package/dist/services/public-env.js

@@ -1,3 +1,4 @@
+var _a, _b;
 import { RUNTIME_ENV_KEYS, isDevelopmentRuntime, readRuntimeEnv, runtimeEnvConfig, } from '../config/env.config.js';
 import { PROJECT_ENV_STANDARD_KEYS } from './project-env.js';
 export { isDevelopmentRuntime, readRuntimeEnv };
@@ -30,6 +31,8 @@ export const RUNTIME_PUBLIC_ENV_KEYS = {
     funnelVersionId: RUNTIME_ENV_KEYS.funnelVersionId,
     projectId: RUNTIME_ENV_KEYS.projectId,
     posthogProjectApiKey: RUNTIME_ENV_KEYS.posthogProjectApiKey,
+    posthogSessionReplayEnabled: RUNTIME_ENV_KEYS.posthogSessionReplayEnabled,
+    posthogSessionReplaySampleRate: RUNTIME_ENV_KEYS.posthogSessionReplaySampleRate,
     supportEmail: RUNTIME_ENV_KEYS.supportEmail,
     iosAppStoreUrl: RUNTIME_ENV_KEYS.iosAppStoreUrl,
     androidPlayStoreUrl: RUNTIME_ENV_KEYS.androidPlayStoreUrl,
@@ -59,6 +62,8 @@ export const runtimePublicConfig = Object.freeze({
     funnelVersionId: readRequiredRuntimeValue(runtimeEnvConfig.funnelVersionId, ''),
     projectId: readRequiredRuntimeValue(runtimeEnvConfig.projectId, ''),
     posthogProjectApiKey: readRequiredRuntimeValue(runtimeEnvConfig.posthogProjectApiKey, ''),
+    posthogSessionReplayEnabled: ((_a = runtimeEnvConfig.posthogSessionReplayEnabled) === null || _a === void 0 ? void 0 : _a.trim()) === 'true',
+    posthogSessionReplaySampleRate: Math.min(100, Math.max(1, Number.parseInt(((_b = runtimeEnvConfig.posthogSessionReplaySampleRate) === null || _b === void 0 ? void 0 : _b.trim()) || '10', 10) || 10)),
     supportEmail: readRequiredRuntimeValue(runtimeEnvConfig.supportEmail, DEFAULT_SUPPORT_EMAIL),
     iosAppStoreUrl: toOptionalEnv(runtimeEnvConfig.iosAppStoreUrl) || toIosAppStoreUrlFromId(appStoreId),
     androidPlayStoreUrl: toOptionalEnv(runtimeEnvConfig.androidPlayStoreUrl) ||

package/package.json

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