@funnelsgrove/runtime 0.1.4 → 0.1.6

package/dist/index.d.ts

@@ -17,6 +17,7 @@ export * from './runtime/preview-definition-overrides.js';
 export * from './runtime/route-resolver.js';
 export * from './runtime/subscription-handoff.js';
 export * from './runtime/url-user-attributes.js';
+export * from './runtime/use-url-user-attributes-sync.js';
 export * from './services/api.service.js';
 export * from './services/funnel-state.service.js';
 export * from './services/logger.js';

package/dist/index.js

@@ -17,6 +17,7 @@ export * from './runtime/preview-definition-overrides.js';
 export * from './runtime/route-resolver.js';
 export * from './runtime/subscription-handoff.js';
 export * from './runtime/url-user-attributes.js';
+export * from './runtime/use-url-user-attributes-sync.js';
 export * from './services/api.service.js';
 export * from './services/funnel-state.service.js';
 export * from './services/logger.js';

package/dist/runtime/url-user-attributes.d.ts

@@ -1,15 +1,21 @@
 import type { FunnelUserAnswers } from '../sdk/userAnswers.js';
 export type UrlUserAttributes = {
+    userId: string | null;
     email: string | null;
+    name: string | null;
+    stripeCustomerId: string | null;
 };
 export type UrlUserAttributeUser = {
     email: string;
+    name: string;
     attributes?: FunnelUserAnswers;
     document?: Record<string, unknown>;
 };
 export declare function normalizeUrlUserEmail(value: string | null | undefined): string | null;
+export declare function normalizeUrlUserAttribute(value: string | null | undefined): string | null;
 export declare function resolveUrlUserAttributes(search?: string): UrlUserAttributes;
 export declare function hasUrlUserAttributes(urlAttributes: UrlUserAttributes | null | undefined): boolean;
+export declare function hasUrlUserProfileAttributes(urlAttributes: UrlUserAttributes | null | undefined): boolean;
 export declare function applyUrlUserAttributesToUser<TUser extends UrlUserAttributeUser>(input: {
     user: TUser;
     attributes?: FunnelUserAnswers;

package/dist/runtime/url-user-attributes.js

@@ -1,4 +1,7 @@
 const EMAIL_QUERY_KEY = 'email';
+const USER_ID_QUERY_KEY = 'user_id';
+const STRIPE_CUSTOMER_ID_QUERY_KEY = 'stripe_customer_id';
+const NAME_QUERY_KEYS = ['name', 'fullName', 'full_name'];
 const EMAIL_PATTERN = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
 export function normalizeUrlUserEmail(value) {
     const email = value === null || value === void 0 ? void 0 : value.trim();
@@ -7,32 +10,54 @@ export function normalizeUrlUserEmail(value) {
     }
     return email;
 }
+export function normalizeUrlUserAttribute(value) {
+    const normalized = value === null || value === void 0 ? void 0 : value.trim();
+    return normalized || null;
+}
 export function resolveUrlUserAttributes(search) {
+    var _a;
     if (typeof window === 'undefined' && typeof search !== 'string') {
         return {
+            userId: null,
             email: null,
+            name: null,
+            stripeCustomerId: null,
         };
     }
     try {
         const params = new URLSearchParams(search !== null && search !== void 0 ? search : window.location.search);
+        const name = (_a = NAME_QUERY_KEYS.map((key) => normalizeUrlUserAttribute(params.get(key))).find(Boolean)) !== null && _a !== void 0 ? _a : null;
         return {
+            userId: normalizeUrlUserAttribute(params.get(USER_ID_QUERY_KEY)),
             email: normalizeUrlUserEmail(params.get(EMAIL_QUERY_KEY)),
+            name,
+            stripeCustomerId: normalizeUrlUserAttribute(params.get(STRIPE_CUSTOMER_ID_QUERY_KEY)),
         };
     }
-    catch (_a) {
+    catch (_b) {
         return {
+            userId: null,
             email: null,
+            name: null,
+            stripeCustomerId: null,
         };
     }
 }
 export function hasUrlUserAttributes(urlAttributes) {
-    return Boolean(urlAttributes === null || urlAttributes === void 0 ? void 0 : urlAttributes.email);
+    return Boolean((urlAttributes === null || urlAttributes === void 0 ? void 0 : urlAttributes.userId) ||
+        (urlAttributes === null || urlAttributes === void 0 ? void 0 : urlAttributes.email) ||
+        (urlAttributes === null || urlAttributes === void 0 ? void 0 : urlAttributes.name) ||
+        (urlAttributes === null || urlAttributes === void 0 ? void 0 : urlAttributes.stripeCustomerId));
+}
+export function hasUrlUserProfileAttributes(urlAttributes) {
+    return Boolean((urlAttributes === null || urlAttributes === void 0 ? void 0 : urlAttributes.email) || (urlAttributes === null || urlAttributes === void 0 ? void 0 : urlAttributes.name));
 }
 export function applyUrlUserAttributesToUser(input) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e;
     const email = (_a = input.urlAttributes) === null || _a === void 0 ? void 0 : _a.email;
-    if (!email) {
+    const name = (_b = input.urlAttributes) === null || _b === void 0 ? void 0 : _b.name;
+    if (!email && !name) {
         return input.user;
     }
-    return Object.assign(Object.assign({}, input.user), { email, attributes: Object.assign(Object.assign({}, ((_b = input.attributes) !== null && _b !== void 0 ? _b : {})), ((_c = input.user.attributes) !== null && _c !== void 0 ? _c : {})), document: (_d = input.user.document) !== null && _d !== void 0 ? _d : {} });
+    return Object.assign(Object.assign({}, input.user), { email: email !== null && email !== void 0 ? email : input.user.email, name: name !== null && name !== void 0 ? name : input.user.name, attributes: Object.assign(Object.assign({}, ((_c = input.attributes) !== null && _c !== void 0 ? _c : {})), ((_d = input.user.attributes) !== null && _d !== void 0 ? _d : {})), document: (_e = input.user.document) !== null && _e !== void 0 ? _e : {} });
 }

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

@@ -9,6 +9,7 @@ import { isPreviewStepLockRequested, resolveNextStepFromContext, shouldRunAutoAd
 import { usePreviewBridge } from './preview-bridge.js';
 import { resolveExperimentAssignment } from './experiment-assignment.js';
 import { collectCurrentFunnelAttribution } from './funnel-attribution.js';
+import { resolveUrlUserAttributes } from './url-user-attributes.js';
 import { bootstrapPostHog, getPostHog, identifyPostHog, isPostHogReady, resolveExperimentVariant, } from './posthog-flags.js';
 import { isEditorEnabled, useRuntimeMode } from '../services/runtime-mode.service.js';
 import { isPreviewFrameRuntime } from '../services/preview-frame.service.js';
@@ -244,6 +245,7 @@ export function useFunnelFlowController({ initialStepId, lockToInitialStep = fal
     }, [goToStep, resolveNextStepId, safeActiveStepId]);
     useEffect(() => {
         const localUserId = apiService.getOrCreateClientUserId();
+        const urlUserAttributes = resolveUrlUserAttributes();
         const bootstrapCandidateUserId = apiService.getBootstrapCandidateUserId(localUserId);
         const initialAttribution = collectCurrentFunnelAttribution();
         setUser((prev) => (Object.assign(Object.assign({}, prev), { id: localUserId })));
@@ -263,6 +265,8 @@ export function useFunnelFlowController({ initialStepId, lockToInitialStep = fal
         const sessionBootstrap = apiService
             .bootstrapSession({
             userId: bootstrapCandidateUserId || localUserId,
+            email: urlUserAttributes.email || undefined,
+            name: urlUserAttributes.name || undefined,
             attribution: initialAttribution,
         })
             .then((sessionUser) => {

package/dist/runtime/use-url-user-attributes-sync.d.ts

@@ -0,0 +1,13 @@
+import type { FunnelUser } from '../components/FunnelContext.js';
+import type { FunnelUserAnswers } from '../sdk/userAnswers.js';
+import { type FunnelUserAttribution } from './funnel-attribution.js';
+import { type UrlUserAttributes } from './url-user-attributes.js';
+export type UseUrlUserAttributesSyncInput = {
+    user: FunnelUser;
+    attributes: FunnelUserAnswers;
+    setUser: (user: FunnelUser) => void;
+    disabled?: boolean;
+    urlAttributes?: UrlUserAttributes | null;
+    getAttribution?: () => FunnelUserAttribution;
+};
+export declare function useUrlUserAttributesSync({ user, attributes, setUser, disabled, urlAttributes, getAttribution, }: UseUrlUserAttributesSyncInput): UrlUserAttributes;

package/dist/runtime/use-url-user-attributes-sync.js

@@ -0,0 +1,54 @@
+'use client';
+import { useEffect, useMemo, useRef } from 'react';
+import { apiService } from '../services/api.service.js';
+import { logger } from '../services/logger.js';
+import { collectCurrentFunnelAttribution, } from './funnel-attribution.js';
+import { applyUrlUserAttributesToUser, hasUrlUserProfileAttributes, resolveUrlUserAttributes, } from './url-user-attributes.js';
+export function useUrlUserAttributesSync({ user, attributes, setUser, disabled = false, urlAttributes, getAttribution = collectCurrentFunnelAttribution, }) {
+    const resolvedUrlAttributes = useMemo(() => urlAttributes !== null && urlAttributes !== void 0 ? urlAttributes : resolveUrlUserAttributes(), [urlAttributes]);
+    const syncedUrlUserAttributesRef = useRef(null);
+    useEffect(() => {
+        var _a, _b;
+        if (disabled || !hasUrlUserProfileAttributes(resolvedUrlAttributes)) {
+            return;
+        }
+        const nextUser = applyUrlUserAttributesToUser({
+            user,
+            attributes,
+            urlAttributes: resolvedUrlAttributes,
+        });
+        const currentEmail = user.email.trim();
+        const nextEmail = nextUser.email.trim();
+        const currentName = user.name.trim();
+        const nextName = nextUser.name.trim();
+        if (currentEmail !== nextEmail || currentName !== nextName) {
+            setUser(nextUser);
+        }
+        const syncKey = [
+            nextUser.id,
+            (_a = resolvedUrlAttributes.email) !== null && _a !== void 0 ? _a : '',
+            (_b = resolvedUrlAttributes.name) !== null && _b !== void 0 ? _b : '',
+        ].join(':');
+        if (syncedUrlUserAttributesRef.current === syncKey) {
+            return;
+        }
+        syncedUrlUserAttributesRef.current = syncKey;
+        apiService
+            .syncUrlUserAttributes({
+            user: nextUser,
+            attributes,
+            urlAttributes: resolvedUrlAttributes,
+            attribution: getAttribution(),
+        })
+            .then((updatedUser) => {
+            if (updatedUser) {
+                setUser(updatedUser);
+            }
+        })
+            .catch((error) => {
+            syncedUrlUserAttributesRef.current = null;
+            logger.error('Failed to persist URL attributes onto funnel user:', error);
+        });
+    }, [attributes, disabled, getAttribution, resolvedUrlAttributes, setUser, user]);
+    return resolvedUrlAttributes;
+}

package/dist/services/api.service.d.ts

@@ -8,6 +8,9 @@ export type AppUser = {
     attributes: FunnelUserAnswers;
     document: Record<string, unknown>;
 };
+type AppUserInput = Omit<AppUser, 'document'> & {
+    document?: Record<string, unknown>;
+};
 export type FunnelEvent = {
     userId: string;
     eventType: string;
@@ -76,7 +79,7 @@ declare class ApiService {
         attribution?: FunnelUserAttribution;
     }): Promise<AppUser>;
     syncUrlUserAttributes(input: {
-        user: AppUser;
+        user: AppUserInput;
         attributes?: FunnelUserAnswers;
         urlAttributes?: UrlUserAttributes | null;
         attribution?: FunnelUserAttribution;

package/dist/services/api.service.js

@@ -1,9 +1,7 @@
 import { buildMainApiUrl, buildSdkHeaders, FUNNEL_ID, FUNNEL_VERSION_ID, getFunnelSdkPublishableKey, } from './runtime-api.config.js';
 import { mergeFunnelUserAttribution, } from '../runtime/funnel-attribution.js';
-import { applyUrlUserAttributesToUser, hasUrlUserAttributes, } from '../runtime/url-user-attributes.js';
+import { applyUrlUserAttributesToUser, hasUrlUserProfileAttributes, resolveUrlUserAttributes, } from '../runtime/url-user-attributes.js';
 const DEFAULT_USER_ID_STORAGE_KEY = 'funnel:user-id';
-const LOCATION_USER_ID_QUERY_KEYS = ['user_id'];
-const LOCATION_STRIPE_CUSTOMER_ID_QUERY_KEYS = ['stripe_customer_id'];
 const canUseDom = () => {
     return typeof window !== 'undefined';
 };
@@ -63,42 +61,6 @@ const persistUserId = (value, funnelId = FUNNEL_ID) => {
     }
     return normalized;
 };
-const readLocationUserId = () => {
-    if (!canUseDom()) {
-        return null;
-    }
-    try {
-        const searchParams = new URLSearchParams(window.location.search);
-        for (const key of LOCATION_USER_ID_QUERY_KEYS) {
-            const candidate = normalizeUserId(searchParams.get(key));
-            if (candidate) {
-                return candidate;
-            }
-        }
-    }
-    catch (_a) {
-        return null;
-    }
-    return null;
-};
-const readLocationStripeCustomerId = () => {
-    if (!canUseDom()) {
-        return null;
-    }
-    try {
-        const searchParams = new URLSearchParams(window.location.search);
-        for (const key of LOCATION_STRIPE_CUSTOMER_ID_QUERY_KEYS) {
-            const candidate = asString(searchParams.get(key));
-            if (candidate) {
-                return candidate;
-            }
-        }
-    }
-    catch (_a) {
-        return null;
-    }
-    return null;
-};
 const buildSdkEvent = (event) => {
     return {
         eventType: event.eventType,
@@ -178,7 +140,7 @@ class ApiService {
         return persistUserId(generateUserId(), FUNNEL_ID);
     }
     getSubscriptionManagementUserId() {
-        const locationUserId = readLocationUserId();
+        const locationUserId = resolveUrlUserAttributes().userId;
         if (locationUserId) {
             return persistUserId(locationUserId, FUNNEL_ID);
         }
@@ -188,10 +150,10 @@ class ApiService {
         return this.getOrCreateClientUserId();
     }
     getSubscriptionManagementStripeCustomerId() {
-        return readLocationStripeCustomerId();
+        return resolveUrlUserAttributes().stripeCustomerId;
     }
     getBootstrapCandidateUserId(fallbackUserId) {
-        return readLocationUserId() || normalizeUserId(fallbackUserId);
+        return resolveUrlUserAttributes().userId || normalizeUserId(fallbackUserId);
     }
     async fetchCurrentUserState(userId) {
         const publishableKey = getFunnelSdkPublishableKey();
@@ -236,13 +198,16 @@ class ApiService {
     }
     async bootstrapSession(input) {
         var _a;
-        const userId = await this.resolveBootstrapUserId(input === null || input === void 0 ? void 0 : input.userId);
+        const urlUserAttributes = resolveUrlUserAttributes();
+        const inputEmail = (input === null || input === void 0 ? void 0 : input.email) || urlUserAttributes.email || undefined;
+        const inputName = (input === null || input === void 0 ? void 0 : input.name) || urlUserAttributes.name || undefined;
+        const userId = await this.resolveBootstrapUserId((input === null || input === void 0 ? void 0 : input.userId) || urlUserAttributes.userId);
         const publishableKey = getFunnelSdkPublishableKey();
         if (!publishableKey) {
             return toAppUser({
                 userId,
-                fallbackName: input === null || input === void 0 ? void 0 : input.name,
-                fallbackEmail: input === null || input === void 0 ? void 0 : input.email,
+                fallbackName: inputName,
+                fallbackEmail: inputEmail,
                 fallbackDocument: withMergedAttributionDocument({}, input === null || input === void 0 ? void 0 : input.attribution),
             });
         }
@@ -256,8 +221,8 @@ class ApiService {
                 funnelId: FUNNEL_ID || undefined,
                 funnelVersionId: FUNNEL_VERSION_ID || undefined,
                 user_id: userId,
-                email: (input === null || input === void 0 ? void 0 : input.email) || undefined,
-                fullName: (input === null || input === void 0 ? void 0 : input.name) || undefined,
+                email: inputEmail,
+                fullName: inputName,
                 metadata: {
                     source: 'funnel-session',
                 },
@@ -275,8 +240,8 @@ class ApiService {
         return toAppUser({
             apiUser: payload.user,
             userId: persistedUserId,
-            fallbackName: input === null || input === void 0 ? void 0 : input.name,
-            fallbackEmail: input === null || input === void 0 ? void 0 : input.email,
+            fallbackName: inputName,
+            fallbackEmail: inputEmail,
             fallbackDocument: withMergedAttributionDocument({}, input === null || input === void 0 ? void 0 : input.attribution),
         });
     }
@@ -328,7 +293,8 @@ class ApiService {
         });
     }
     async syncUrlUserAttributes(input) {
-        if (!hasUrlUserAttributes(input.urlAttributes)) {
+        var _a;
+        if (!hasUrlUserProfileAttributes(input.urlAttributes)) {
             return null;
         }
         const nextUser = applyUrlUserAttributesToUser({
@@ -336,7 +302,7 @@ class ApiService {
             attributes: input.attributes,
             urlAttributes: input.urlAttributes,
         });
-        const updatedUser = await this.updateUser(nextUser, {
+        const updatedUser = await this.updateUser(Object.assign(Object.assign({}, nextUser), { document: (_a = nextUser.document) !== null && _a !== void 0 ? _a : {} }), {
             attribution: input.attribution,
         });
         return applyUrlUserAttributesToUser({

package/package.json

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