@funnelsgrove/payments 0.1.52 → 0.1.53

package/dist/index.d.ts

@@ -9,6 +9,7 @@ export * from './services/checkoutCompletionAnalytics.service.js';
 export * from './hooks/useResolvedPaywallPlans.js';
 export * from './providers/paymentProvider.types.js';
 export * from './providers/stripe/useStripeSubscriptionCheckoutSession.js';
+export * from './providers/stripe/useStripeOneTimeCheckoutSession.js';
 export * from './providers/stripe/WalletSubscriptionCheckoutSlot.js';
 export * from './providers/stripe/ApplePaySubscriptionCheckoutSlot.js';
 export * from './providers/stripe/GooglePaySubscriptionCheckoutSlot.js';

package/dist/index.js

@@ -12,6 +12,7 @@ export * from './hooks/useResolvedPaywallPlans.js';
 // Provider-neutral and Stripe subscription checkout primitives.
 export * from './providers/paymentProvider.types.js';
 export * from './providers/stripe/useStripeSubscriptionCheckoutSession.js';
+export * from './providers/stripe/useStripeOneTimeCheckoutSession.js';
 export * from './providers/stripe/WalletSubscriptionCheckoutSlot.js';
 export * from './providers/stripe/ApplePaySubscriptionCheckoutSlot.js';
 export * from './providers/stripe/GooglePaySubscriptionCheckoutSlot.js';

package/dist/providers/stripe/useStripeOneTimeCheckoutSession.d.ts

@@ -0,0 +1,45 @@
+import type { Stripe } from '@stripe/stripe-js';
+import type { RuntimeMode } from '@funnelsgrove/runtime';
+import { type CheckoutPreparationLoading } from '../paymentProvider.types.js';
+import { type PaywallPlan, type StripeRuntimeConfigOverrides } from '../../services/stripe.service.js';
+type StripeOneTimeCheckoutPlanInput = Pick<PaywallPlan, 'amountCents' | 'analyticsPurchaseValue' | 'description' | 'id' | 'providerPlanId' | 'title'>;
+export type StripeOneTimeCheckoutSessionInput = {
+    analyticsMetadata?: Record<string, unknown> | null;
+    checkoutMode: RuntimeMode;
+    couponId?: string | null;
+    customerEmail?: string | null;
+    enabled?: boolean;
+    onError?: (message: string | null) => void;
+    plan?: StripeOneTimeCheckoutPlanInput | null;
+    returnUrl: string;
+    runtimeConfig?: StripeRuntimeConfigOverrides;
+    userId?: string | null;
+};
+export type StripeOneTimeCheckoutPreparationOptions = {
+    checkoutStartSource?: 'card_click' | 'wallet_click' | 'wallet_render' | (string & {});
+    forceNew?: boolean;
+};
+export type StripeOneTimeCheckoutSession = {
+    activeClientSecret: string | null;
+    checkoutSessionId: string | null;
+    configured: boolean;
+    error: string | null;
+    intentKey: string;
+    loading: CheckoutPreparationLoading;
+    prepareCardCheckout: (options?: StripeOneTimeCheckoutPreparationOptions) => Promise<string | null>;
+    prepareWalletCheckout: (options?: StripeOneTimeCheckoutPreparationOptions) => Promise<string | null>;
+    provider: 'stripe';
+    reset: () => void;
+    restartCardCheckout: (options?: StripeOneTimeCheckoutPreparationOptions) => Promise<string | null>;
+    restartWalletCheckout: (options?: StripeOneTimeCheckoutPreparationOptions) => Promise<string | null>;
+    planKey: string;
+    setError: (message: string | null) => void;
+    stripePromise: Promise<Stripe | null> | null;
+};
+export type StripeOneTimeCheckoutIntentKeyInput = Pick<StripeOneTimeCheckoutSessionInput, 'checkoutMode' | 'couponId' | 'customerEmail' | 'plan' | 'returnUrl' | 'runtimeConfig' | 'userId'> & {
+    analyticsMetadata?: Record<string, unknown> | null;
+};
+export declare function buildStripeOneTimeCheckoutIntentKey({ checkoutMode, couponId, customerEmail, plan, returnUrl, runtimeConfig, userId, }: StripeOneTimeCheckoutIntentKeyInput): string;
+export declare function shouldResetStripeOneTimeCheckoutSessionForIntentKey(previousIntentKey: string | null, nextIntentKey: string): boolean;
+export declare function useStripeOneTimeCheckoutSession({ analyticsMetadata, checkoutMode, couponId, customerEmail, enabled, onError, plan, returnUrl, runtimeConfig, userId, }: StripeOneTimeCheckoutSessionInput): StripeOneTimeCheckoutSession;
+export {};

package/dist/providers/stripe/useStripeOneTimeCheckoutSession.js

@@ -0,0 +1,260 @@
+'use client';
+import { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState, } from 'react';
+import { createEmptyCheckoutPreparationLoading, } from '../paymentProvider.types.js';
+import { createStripeOneTimeCheckout, getStripePromise, isStripeConfigured, } from '../../services/stripe.service.js';
+import { isInactiveCheckoutSessionError } from './useStripeSubscriptionCheckoutSession.js';
+const getFriendlyStripeCheckoutError = (error) => {
+    const message = error instanceof Error ? error.message : 'Unable to initialize checkout';
+    return message === 'Internal server error'
+        ? 'Unable to initialize checkout. Stripe settings may be missing for this funnel.'
+        : message;
+};
+const normalizeRuntimeConfigValue = (value) => (value === null || value === void 0 ? void 0 : value.trim()) || '';
+const useIsomorphicLayoutEffect = typeof window === 'undefined' ? useEffect : useLayoutEffect;
+const buildCheckoutPreparationAnalyticsMetadata = (analyticsMetadata, options = {}) => {
+    var _a;
+    const checkoutStartSource = (_a = options.checkoutStartSource) === null || _a === void 0 ? void 0 : _a.trim();
+    if (!checkoutStartSource) {
+        return analyticsMetadata;
+    }
+    return Object.assign(Object.assign({}, (analyticsMetadata !== null && analyticsMetadata !== void 0 ? analyticsMetadata : {})), { checkoutStartSource });
+};
+export function buildStripeOneTimeCheckoutIntentKey({ checkoutMode, couponId, customerEmail, plan, returnUrl, runtimeConfig, userId, }) {
+    var _a;
+    const runtimeConfigSignature = [
+        normalizeRuntimeConfigValue(runtimeConfig === null || runtimeConfig === void 0 ? void 0 : runtimeConfig.apiBaseUrl),
+        normalizeRuntimeConfigValue(runtimeConfig === null || runtimeConfig === void 0 ? void 0 : runtimeConfig.funnelId),
+        normalizeRuntimeConfigValue(runtimeConfig === null || runtimeConfig === void 0 ? void 0 : runtimeConfig.funnelVersionId),
+        normalizeRuntimeConfigValue(runtimeConfig === null || runtimeConfig === void 0 ? void 0 : runtimeConfig.funnelSdkPublishableKey),
+    ].join('|');
+    const planSignature = [
+        normalizeRuntimeConfigValue(plan === null || plan === void 0 ? void 0 : plan.id),
+        normalizeRuntimeConfigValue(plan === null || plan === void 0 ? void 0 : plan.providerPlanId),
+        (_a = plan === null || plan === void 0 ? void 0 : plan.amountCents) !== null && _a !== void 0 ? _a : '',
+    ].join('|');
+    const customerEmailSignature = normalizeRuntimeConfigValue(customerEmail);
+    const userIdSignature = normalizeRuntimeConfigValue(userId);
+    return [
+        'stripe-one-time',
+        checkoutMode,
+        runtimeConfigSignature,
+        planSignature,
+        customerEmailSignature,
+        userIdSignature,
+        (couponId === null || couponId === void 0 ? void 0 : couponId.trim()) || '',
+        returnUrl.trim(),
+    ].join('|');
+}
+export function shouldResetStripeOneTimeCheckoutSessionForIntentKey(previousIntentKey, nextIntentKey) {
+    return previousIntentKey !== null && previousIntentKey !== nextIntentKey;
+}
+export function useStripeOneTimeCheckoutSession({ analyticsMetadata, checkoutMode, couponId, customerEmail, enabled = true, onError, plan, returnUrl, runtimeConfig, userId, }) {
+    var _a, _b, _c;
+    const [clientSecret, setClientSecret] = useState(null);
+    const [clientSecretIntentKey, setClientSecretIntentKey] = useState(null);
+    const [checkoutSessionId, setCheckoutSessionId] = useState(null);
+    const [error, setErrorState] = useState(null);
+    const [loading, setLoading] = useState(createEmptyCheckoutPreparationLoading);
+    const [runtimeStripePublishableKey, setRuntimeStripePublishableKey] = useState(null);
+    const creatingIntentRef = useRef(null);
+    const requestIdRef = useRef(0);
+    const configured = enabled &&
+        (isStripeConfigured(checkoutMode) ||
+            Boolean(normalizeRuntimeConfigValue(runtimeConfig === null || runtimeConfig === void 0 ? void 0 : runtimeConfig.funnelSdkPublishableKey)));
+    const intentKey = buildStripeOneTimeCheckoutIntentKey({
+        checkoutMode,
+        couponId,
+        customerEmail,
+        plan,
+        returnUrl,
+        runtimeConfig,
+        userId,
+    });
+    const planKey = [
+        (_a = plan === null || plan === void 0 ? void 0 : plan.id) !== null && _a !== void 0 ? _a : '',
+        (_b = plan === null || plan === void 0 ? void 0 : plan.providerPlanId) !== null && _b !== void 0 ? _b : '',
+        (_c = plan === null || plan === void 0 ? void 0 : plan.amountCents) !== null && _c !== void 0 ? _c : '',
+    ].join('|');
+    const activeClientSecret = clientSecretIntentKey === intentKey ? clientSecret : null;
+    const activeCheckoutSessionId = clientSecretIntentKey === intentKey ? checkoutSessionId : null;
+    const stripePromise = useMemo(() => getStripePromise(checkoutMode, runtimeStripePublishableKey !== null && runtimeStripePublishableKey !== void 0 ? runtimeStripePublishableKey : runtimeConfig === null || runtimeConfig === void 0 ? void 0 : runtimeConfig.funnelSdkPublishableKey), [checkoutMode, runtimeConfig === null || runtimeConfig === void 0 ? void 0 : runtimeConfig.funnelSdkPublishableKey, runtimeStripePublishableKey]);
+    const previousIntentKeyRef = useRef(intentKey);
+    const analyticsMetadataRef = useRef(analyticsMetadata);
+    useEffect(() => {
+        analyticsMetadataRef.current = analyticsMetadata;
+    }, [analyticsMetadata]);
+    const clearActiveCheckoutSession = useCallback(() => {
+        requestIdRef.current += 1;
+        creatingIntentRef.current = null;
+        setClientSecret(null);
+        setClientSecretIntentKey(null);
+        setCheckoutSessionId(null);
+    }, []);
+    const setError = useCallback((message) => {
+        if (isInactiveCheckoutSessionError(message)) {
+            clearActiveCheckoutSession();
+            setErrorState(null);
+            onError === null || onError === void 0 ? void 0 : onError(null);
+            return;
+        }
+        setErrorState(message);
+        onError === null || onError === void 0 ? void 0 : onError(message);
+    }, [clearActiveCheckoutSession, onError]);
+    const reset = useCallback(() => {
+        clearActiveCheckoutSession();
+        setLoading(createEmptyCheckoutPreparationLoading());
+        setRuntimeStripePublishableKey(null);
+        setError(null);
+    }, [clearActiveCheckoutSession, setError]);
+    useIsomorphicLayoutEffect(() => {
+        const previousIntentKey = previousIntentKeyRef.current;
+        previousIntentKeyRef.current = intentKey;
+        if (shouldResetStripeOneTimeCheckoutSessionForIntentKey(previousIntentKey, intentKey)) {
+            reset();
+        }
+    }, [intentKey, reset]);
+    const setSourceLoading = useCallback((source, value) => {
+        setLoading((current) => current[source] === value
+            ? current
+            : Object.assign(Object.assign({}, current), { [source]: value }));
+    }, []);
+    const createCheckoutSession = useCallback(async (options = {}) => {
+        var _a;
+        const forceNew = options.forceNew === true;
+        if (!configured || !plan) {
+            return null;
+        }
+        if (!forceNew && activeClientSecret) {
+            return activeClientSecret;
+        }
+        if (!forceNew && ((_a = creatingIntentRef.current) === null || _a === void 0 ? void 0 : _a.key) === intentKey) {
+            return creatingIntentRef.current.promise;
+        }
+        if (forceNew) {
+            clearActiveCheckoutSession();
+        }
+        const requestKey = intentKey;
+        const requestId = requestIdRef.current + 1;
+        requestIdRef.current = requestId;
+        const checkoutRequest = (async () => {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            try {
+                const response = await createStripeOneTimeCheckout({
+                    plan,
+                    analyticsMetadata: buildCheckoutPreparationAnalyticsMetadata(analyticsMetadataRef.current, options),
+                    couponId,
+                    customerEmail,
+                    returnUrl,
+                    user_id: userId,
+                    environment: checkoutMode,
+                    runtimeConfig,
+                });
+                if (((_a = creatingIntentRef.current) === null || _a === void 0 ? void 0 : _a.key) !== requestKey ||
+                    ((_b = creatingIntentRef.current) === null || _b === void 0 ? void 0 : _b.id) !== requestId) {
+                    return response.clientSecret;
+                }
+                const publishableKey = ((_c = response.stripePublishableKey) === null || _c === void 0 ? void 0 : _c.trim()) ||
+                    normalizeRuntimeConfigValue(runtimeConfig === null || runtimeConfig === void 0 ? void 0 : runtimeConfig.funnelSdkPublishableKey);
+                if (publishableKey) {
+                    setRuntimeStripePublishableKey(publishableKey);
+                }
+                setClientSecret(response.clientSecret);
+                setClientSecretIntentKey(requestKey);
+                setCheckoutSessionId(((_d = response.checkoutSessionId) === null || _d === void 0 ? void 0 : _d.trim()) || null);
+                return response.clientSecret;
+            }
+            catch (checkoutError) {
+                if (((_e = creatingIntentRef.current) === null || _e === void 0 ? void 0 : _e.key) === requestKey &&
+                    ((_f = creatingIntentRef.current) === null || _f === void 0 ? void 0 : _f.id) === requestId) {
+                    setError(getFriendlyStripeCheckoutError(checkoutError));
+                }
+                return null;
+            }
+            finally {
+                if (((_g = creatingIntentRef.current) === null || _g === void 0 ? void 0 : _g.key) === requestKey &&
+                    ((_h = creatingIntentRef.current) === null || _h === void 0 ? void 0 : _h.id) === requestId) {
+                    creatingIntentRef.current = null;
+                }
+            }
+        })();
+        creatingIntentRef.current = {
+            id: requestId,
+            key: requestKey,
+            promise: checkoutRequest,
+        };
+        return checkoutRequest;
+    }, [
+        activeClientSecret,
+        checkoutMode,
+        clearActiveCheckoutSession,
+        configured,
+        couponId,
+        customerEmail,
+        intentKey,
+        plan,
+        returnUrl,
+        runtimeConfig,
+        setError,
+        userId,
+    ]);
+    const prepareCheckout = useCallback(async (source, options = {}) => {
+        var _a;
+        if (!configured || !plan) {
+            return null;
+        }
+        if (!options.forceNew && activeClientSecret) {
+            return activeClientSecret;
+        }
+        setSourceLoading(source, true);
+        setError(null);
+        try {
+            return await createCheckoutSession(Object.assign(Object.assign({}, options), { checkoutStartSource: (_a = options.checkoutStartSource) !== null && _a !== void 0 ? _a : (source === 'wallet' ? 'wallet_render' : 'card_click') }));
+        }
+        finally {
+            setSourceLoading(source, false);
+        }
+    }, [
+        activeClientSecret,
+        configured,
+        createCheckoutSession,
+        plan,
+        setError,
+        setSourceLoading,
+    ]);
+    const prepareCardCheckout = useCallback((options = {}) => prepareCheckout('card', options), [prepareCheckout]);
+    const prepareWalletCheckout = useCallback((options = {}) => prepareCheckout('wallet', options), [prepareCheckout]);
+    const restartCardCheckout = useCallback((options = {}) => prepareCheckout('card', Object.assign(Object.assign({}, options), { forceNew: true })), [prepareCheckout]);
+    const restartWalletCheckout = useCallback((options = {}) => prepareCheckout('wallet', Object.assign(Object.assign({}, options), { forceNew: true })), [prepareCheckout]);
+    return useMemo(() => ({
+        activeClientSecret,
+        checkoutSessionId: activeCheckoutSessionId,
+        configured,
+        error,
+        intentKey,
+        loading,
+        prepareCardCheckout,
+        prepareWalletCheckout,
+        provider: 'stripe',
+        reset,
+        restartCardCheckout,
+        restartWalletCheckout,
+        planKey,
+        setError,
+        stripePromise,
+    }), [
+        activeCheckoutSessionId,
+        activeClientSecret,
+        configured,
+        error,
+        intentKey,
+        loading,
+        planKey,
+        prepareCardCheckout,
+        prepareWalletCheckout,
+        reset,
+        restartCardCheckout,
+        restartWalletCheckout,
+        setError,
+        stripePromise,
+    ]);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@funnelsgrove/payments",
-  "version": "0.1.52",
+  "version": "0.1.53",
   "type": "module",
   "private": false,
   "main": "./dist/index.js",