@fanfare-io/fanfare-sdk-solid 0.24.0 → 0.25.0

package/README.md

@@ -44,6 +44,27 @@ Solid applications can use `FanfareProvider`, `ExperienceWidget`, and `useExperi
 
 `slots` override targeted states while keeping the default widget flow. `children` receives `{ journey, view, snapshot, error, start, isStarting }` when you want to render the full state yourself. Solid `ExperienceWidget` accepts both `class` and `className`.
 
+Marketing consent in `AuthForm` requires both `showMarketingSmsConsent` and a nonempty
+`marketingSmsMerchantName`. The built-in widget reads the merchant name from the public experience
+response, including before an authenticated experience session exists. Custom auth slots receive
+`marketingSmsMerchantName`; pass it through to `AuthForm` or `JourneyGate` to offer consent for that
+merchant. Sign-in remains available when the merchant name is unavailable.
+
+`AuthForm` keeps marketing copy off the initial phone screen. Continue opens an optional panel
+with the named merchant, Fanfare sender, phone number and full disclosure before any OTP request.
+Only "Yes, text me" opts in. It captures the displayed merchant, phone, disclosure, legal text,
+policy links and affirmative label in `marketingSmsConsentText`, then preserves that snapshot through
+OTP verification and resend. "No thanks" continues without marketing consent. Change number,
+returning from verification or changing the consent scope clears the choice and snapshot.
+Implicit submission can open the panel but cannot choose consent. Custom auth handlers must
+preserve the received choice and text through verification; a custom consent UI supplies its own
+actual displayed agreement. The server requires a nonblank text snapshot of at most 4,096 characters
+to record consent. Missing or invalid evidence leaves sign-in available without granting consent.
+This is client-reported audit evidence, not proof of what pixels were displayed.
+Release a matching core and adapter together: the built-in panel uses core's shared policy URLs
+and consent-text formatter. Deploy the generated database migration and server support before
+releasing SDK callers that supply the text.
+
 Mounted inside a shadow root, the widget's styleable elements export CSS parts named after their
 `data-slot`, so a page styles them with `::part()` — `fanfare-host::part(auction-cta)`. The
 attribution footer and every element that contains its "Powered by Fanfare" row are

package/dist/components/auth/auth-form.d.ts

@@ -4,6 +4,7 @@ import { AuthInputMode } from './auth-input';
 export interface AuthFormProps {
     onSubmit?: (credential: string, type: AuthInputMode, options?: {
         marketingSmsConsent: boolean;
+        marketingSmsConsentText?: string;
     }) => Promise<void>;
     onVerify?: (otp: string) => Promise<void>;
     onSkip?: () => void | Promise<void>;
@@ -16,17 +17,21 @@ export interface AuthFormProps {
     description?: string;
     /** When set, renders a countdown above the form. */
     countdownTo?: Date;
+    /** When set and `countdownTo` is not, renders the close time and a sign-in hint above the form. */
+    endedAt?: Date;
     submitLabel?: string;
     verifyLabel?: string;
     allowSkip?: boolean;
     skipLabel?: string;
     showBranding?: boolean;
     /**
-     * Shows the marketing SMS consent checkbox, its disclosure and legal line on the credential step in
-     * phone mode. Off by default: set it only when `onSubmit` reads its third argument, since a tick
-     * the handler never reads is a consent silently dropped.
+     * Offers a separate optional marketing SMS panel after credential entry in
+     * phone mode. Off by default: set it only when `onSubmit` preserves its third argument through
+     * verification, so the explicit consent choice and displayed text are not silently dropped.
      */
     showMarketingSmsConsent?: boolean;
+    /** Merchant named in the consent disclosure. Consent is offered only when this is nonempty. */
+    marketingSmsMerchantName?: string;
     /** Initial step when mounting. Useful for SSR-resume or storybook lanes that need the verify step. */
     defaultStep?: "credential" | "verify";
     /** Initial credential (email or E.164 phone) — pairs with `defaultStep="verify"`. */

package/dist/components/compositions/journey-gate.d.ts

@@ -5,6 +5,7 @@ export interface JourneyGateProps {
     stage: JourneyGateStage;
     onAuthSubmit?: (credential: string, type: AuthInputMode, options?: {
         marketingSmsConsent: boolean;
+        marketingSmsConsentText?: string;
     }) => Promise<void>;
     onAuthVerify?: (otp: string) => Promise<void>;
     onAuthSkip?: () => void | Promise<void>;
@@ -14,12 +15,16 @@ export interface JourneyGateProps {
     allowAuthSkip?: boolean;
     authSkipLabel?: string;
     allowAccessCodeSkip?: boolean;
+    /** Merchant identity from the experience for marketing SMS consent. */
+    marketingSmsMerchantName?: string;
     authTitle?: string;
     authDescription?: string;
     accessCodeTitle?: string;
     accessCodeDescription?: string;
     /** When the upcoming sequence opens — drives the countdown above the form. */
     startsAt?: Date;
+    /** When the drop closed — drives the ended line on the auth stage. */
+    endedAt?: Date;
     class?: string;
     className?: string;
     children?: JSX.Element;

package/dist/components/internal/draw-module.d.ts

@@ -8,6 +8,7 @@ import { OutcomeReason } from '../module';
 export interface DrawModuleProps {
     display$?: ReadableAtom<DrawDisplayState>;
     sequencePhase: "enterable" | "participating" | "settling" | "granted" | "ended";
+    loyaltyBiasEnabled?: boolean;
     canEnter: boolean;
     canLeave: boolean;
     /** Enter action handler; carries the entry pick on a selection-bearing draw. */

package/dist/components/internal/queue-module.d.ts

@@ -10,6 +10,7 @@ export interface QueueModuleProps {
     sequencePhase: "enterable" | "participating" | "granted" | "ended";
     /** Hide live rank-derived queue metrics while the canonical queue is still pre-open. */
     hideQueueMetrics?: boolean;
+    loyaltyBiasEnabled?: boolean;
     canEnter: boolean;
     canLeave: boolean;
     onEnter: () => Promise<void>;

package/dist/components/module/fanfair-attribution.d.ts

@@ -0,0 +1,3 @@
+export declare function FanfairAttribution(props: {
+    enabled: boolean;
+}): import("solid-js").JSX.Element;

package/dist/components/widgets/experience-widget.d.ts

@@ -33,14 +33,17 @@ export interface StartSlotProps extends SlotProps {
 export interface AuthSlotProps extends SlotProps {
     onSubmit: (credential: string, type: AuthInputMode, options?: {
         marketingSmsConsent: boolean;
+        marketingSmsConsentText?: string;
     }) => Promise<void>;
     onVerify: (otp: string) => Promise<void>;
     onSkip?: () => void;
     /**
-     * Whether the sign-in should offer the marketing SMS consent checkbox. The widget sets it because its
+     * Whether the sign-in should offer the optional marketing SMS panel. The widget sets it because its
      * `onSubmit` reads the consent from its third argument; pass it to `AuthForm` with `onSubmit`.
      */
     showMarketingSmsConsent?: boolean;
+    /** Merchant identity to pass to AuthForm beside showMarketingSmsConsent. */
+    marketingSmsMerchantName?: string;
 }
 export interface AccessCodeSlotProps extends SlotProps {
     onSubmit: (code: string) => Promise<void>;

package/dist/hooks/use-auth-gate-experience-details.d.ts

@@ -0,0 +1,10 @@
+import { ExperienceTiming } from '@fanfare-io/fanfare-sdk-core/experiences';
+import { Accessor } from 'solid-js';
+/**
+ * Auth can gate routing before an experience session exists, so its merchant identity and timing
+ * come from the public read until the session's own details name the merchant.
+ */
+export declare function useAuthGateExperienceDetails(experienceId: Accessor<string>, sessionName: Accessor<string | undefined>, sessionTiming: Accessor<ExperienceTiming | null | undefined>, enabled: Accessor<boolean>): {
+    merchantName: Accessor<string | undefined>;
+    timing: Accessor<ExperienceTiming | null | undefined>;
+};