@fanfare-io/fanfare-sdk-solid 0.12.0 → 0.14.0

package/dist/components/checkout/index.d.ts

@@ -1,4 +1,3 @@
 export { CheckoutProcessingPanel } from './checkout-processing-panel';
 export { PaymentCollectionPanel } from './payment-collection-panel';
 export { ReceiptPanel } from './receipt-panel';
-export { ReservationCheckoutPanel } from './reservation-checkout-panel';

package/dist/components/checkout/payment-collection-panel.d.ts

@@ -1,8 +1,7 @@
 import { JSX } from 'solid-js';
 import { PaymentCollectionSlotProps } from '../widgets/experience-widget';
 /**
- * Default payment-collection panel for pre-auth distributions, rendered both when the consumer is
- * about to enter and when a failed authorization leaves a retry open.
+ * Default payment-collection panel for pre-auth entry/re-entry and grant-keyed at-end checkout.
  *
  * The hold amount is rendered from the view's own figure — the client never derives one.
  *

package/dist/components/checkout/stripe-client.d.ts

@@ -1,11 +1,18 @@
-import { ReservationPaymentAffordance } from '@fanfare-io/fanfare-sdk-core/experiences';
+import { SequenceView } from '@fanfare-io/fanfare-sdk-core/experiences';
 import { Stripe, StripeConstructor, StripeElementStyle } from '@stripe/stripe-js';
+/** How a granted win settles, as the granted views carry it. */
+type GrantedSettlement = Extract<SequenceView, {
+    phase: "granted";
+}>["settlement"];
 /**
  * The wire block a checkout-capable view carries, reached through the adapter's declared
  * dependency on `fanfare-sdk-core` rather than the contracts package: core re-exports the contract
- * types so adapter modules never resolve `@fanfare-io/fanfare-sdk-contracts` directly.
+ * types so adapter modules never resolve `@fanfare-io/fanfare-sdk-contracts` directly. Core names
+ * the shape only within the arms that carry it, so it is read back off one of them.
  */
-type PaymentProviderConfig = NonNullable<ReservationPaymentAffordance["paymentProvider"]>;
+type PaymentProviderConfig = NonNullable<Extract<GrantedSettlement, {
+    mode: "at_end";
+}>["paymentProvider"]>;
 declare global {
     interface Window {
         Stripe?: StripeConstructor;
@@ -62,8 +69,8 @@ export declare function deriveStripeCardStyle(root: HTMLElement): StripeElementS
  *
  * `null` means no usable Stripe client configuration reached this view. On a checkout-capable arm
  * that has exactly one cause — the configuration read failed — because the processor discriminator
- * is the `processor` field (reserved) or `checkoutMode` (enterable), never the presence of this
- * block. The condition is transient and retryable.
+ * is the settlement's `processor`/`mode` pair (granted) or `checkoutMode` (enterable), never the
+ * presence of this block. The condition is transient and retryable.
  */
 export declare function resolveStripeClientConfig(source: PaymentProviderConfig | undefined): StripeClientConfig | null;
 /** Test-only seam over every memo this module holds. Never exported from an adapter's public entry. */

package/dist/components/compositions/granted-panel.d.ts

@@ -2,9 +2,9 @@ import { JSX } from 'solid-js';
 export interface GrantedPanelProps {
     label: JSX.Element;
     fallbackMessage: JSX.Element;
-    ctaLabel: JSX.Element;
+    ctaLabel?: JSX.Element;
     expiresAt?: Date;
-    onCtaClick: () => void;
+    onCtaClick?: () => void;
     class?: string;
     className?: string;
 }

package/dist/components/compositions/index.d.ts

@@ -11,4 +11,4 @@ export { EndedModule, type EndedModuleProps } from './ended-module';
 export { ErrorView, type ErrorViewProps } from './error-view';
 export { GrantedPanel, type GrantedPanelProps } from './granted-panel';
 export { JourneyGate, type JourneyGateProps, type JourneyGateStage } from './journey-gate';
-export { OutcomePanel, type OutcomePanelProps } from './outcome-panel';
+export { OutcomePanel, type OutcomeAction, type OutcomePanelProps } from './outcome-panel';

package/dist/components/compositions/outcome-panel.d.ts

@@ -4,6 +4,15 @@ import { OutcomeReason } from '../module';
  * (e.g. the expired re-enter button label) so each module shows terminology
  * appropriate to its mechanism rather than queue-specific copy.
  */
+/**
+ * A host-provided action for a terminal panel, such as "See what's still
+ * available" after a loss. The widget renders it as a secondary button; the
+ * host decides where it leads.
+ */
+export interface OutcomeAction {
+    label: string;
+    onClick: () => void;
+}
 export type ParticipationType = "queue" | "draw" | "auction" | "timed_release" | "appointment";
 export interface OutcomePanelProps {
     outcomeReason: OutcomeReason;
@@ -14,6 +23,8 @@ export interface OutcomePanelProps {
     participationType?: ParticipationType;
     onReenter?: () => Promise<void>;
     isReentering?: boolean;
+    /** Secondary action offered once the outcome is final. */
+    action?: OutcomeAction;
     class?: string;
     className?: string;
 }

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

@@ -1,5 +1,6 @@
 import { AuctionDisplayState } from '@fanfare-io/fanfare-sdk-core/internals';
 import { ReadableAtom } from 'nanostores';
+import { OutcomeAction } from '../compositions/outcome-panel';
 import { OutcomeReason } from '../module';
 export interface AuctionModuleProps {
     display$?: ReadableAtom<AuctionDisplayState>;
@@ -21,6 +22,8 @@ export interface AuctionModuleProps {
     checkoutUrl?: string;
     onCheckoutClick?: () => void;
     outcomeReason?: OutcomeReason;
+    /** Host-provided action shown on the terminal panel. */
+    outcomeAction?: OutcomeAction;
     onReenter?: () => Promise<void>;
     isReentering?: boolean;
     class?: string;

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

@@ -1,5 +1,6 @@
 import { DrawDisplayState } from '@fanfare-io/fanfare-sdk-core/internals';
 import { ReadableAtom } from 'nanostores';
+import { OutcomeAction } from '../compositions/outcome-panel';
 import { OutcomeReason } from '../module';
 export interface DrawModuleProps {
     display$?: ReadableAtom<DrawDisplayState>;
@@ -16,6 +17,8 @@ export interface DrawModuleProps {
     checkoutUrl?: string;
     onCheckoutClick?: () => void;
     outcomeReason?: OutcomeReason;
+    /** Host-provided action shown on the terminal panel. */
+    outcomeAction?: OutcomeAction;
     onReenter?: () => Promise<void>;
     isReentering?: boolean;
     class?: string;

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

@@ -1,5 +1,6 @@
 import { QueueDisplayState } from '@fanfare-io/fanfare-sdk-core/internals';
 import { ReadableAtom } from 'nanostores';
+import { OutcomeAction } from '../compositions/outcome-panel';
 import { OutcomeReason } from '../module';
 export interface QueueModuleProps {
     display$?: ReadableAtom<QueueDisplayState>;
@@ -17,6 +18,8 @@ export interface QueueModuleProps {
     checkoutUrl?: string;
     onCheckoutClick?: () => void;
     outcomeReason?: OutcomeReason;
+    /** Host-provided action shown on the terminal panel. */
+    outcomeAction?: OutcomeAction;
     onReenter?: () => Promise<void>;
     isReentering?: boolean;
     class?: string;

package/dist/components/internal/timed-release-module.d.ts

@@ -1,5 +1,6 @@
 import { TimedReleaseDisplayState } from '@fanfare-io/fanfare-sdk-core/internals';
 import { ReadableAtom } from 'nanostores';
+import { OutcomeAction } from '../compositions/outcome-panel';
 import { OutcomeReason } from '../module';
 export interface TimedReleaseModuleProps {
     display$?: ReadableAtom<TimedReleaseDisplayState>;
@@ -17,6 +18,8 @@ export interface TimedReleaseModuleProps {
     grant?: string;
     expiresAt?: number | Date;
     outcomeReason?: OutcomeReason;
+    /** Host-provided action shown on the terminal panel. */
+    outcomeAction?: OutcomeAction;
     onReenter?: () => Promise<void>;
     isReentering?: boolean;
     class?: string;

package/dist/components/module/index.d.ts

@@ -3,3 +3,4 @@ export { InfoPanel, type InfoPanelProps } from './info-panel';
 export { normalizeOutcomeReason, normalizeSequenceOutcomeReason, type OutcomeReason } from './outcome-reason';
 export { PanelHeading, type PanelHeadingProps, type PanelHeadingVariant } from './panel-heading';
 export { PanelBody, PanelFooter, PanelLayout, type PanelBodyProps, type PanelFooterProps, type PanelLayoutProps, } from './panel-layout';
+export { StageSteps, type StageStep, type StageStepStatus, type StageStepsProps } from './stage-steps';

package/dist/components/module/stage-steps.d.ts

@@ -0,0 +1,10 @@
+import { JSX } from 'solid-js';
+export type StageStepStatus = "done" | "active" | "pending";
+export interface StageStep {
+    label: string;
+    status: StageStepStatus;
+}
+export interface StageStepsProps extends JSX.HTMLAttributes<HTMLDivElement> {
+    steps: readonly StageStep[];
+}
+export declare function StageSteps(props: StageStepsProps): JSX.Element;

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

@@ -1,9 +1,11 @@
 import { BotMitigationState, RoutingChallenge } from '@fanfare-io/fanfare-sdk-core/challenges';
-import { CheckoutNextAction, CheckoutProcessor, FanfareCheckoutResult, JourneyHandle, JourneySnapshot, JourneyView, PaymentInput, PaymentMethodSummary, ReservationPaymentAffordance, SequenceView } from '@fanfare-io/fanfare-sdk-core/experiences';
+import { SDKEvents } from '@fanfare-io/fanfare-sdk-core/events';
+import { CheckoutNextAction, FanfareCheckoutResult, JourneyHandle, JourneySnapshot, JourneyView, PaymentInput, PaymentMethodSummary, SequenceView } from '@fanfare-io/fanfare-sdk-core/experiences';
 import { BrandTheme } from '@fanfare-io/fanfare-sdk-core/theme';
 import { JSX } from 'solid-js';
 import { WidgetVariant } from '../../theme';
 import { AuthInputMode } from '../auth/auth-input';
+import { OutcomeAction } from '../compositions/outcome-panel';
 type ParticipationType = "queue" | "draw" | "auction" | "timed_release" | "appointment";
 type EnterableSlotSequence = Extract<SequenceView, {
     phase: "enterable";
@@ -16,6 +18,8 @@ type ParticipatingSlotSequence = Extract<SequenceView, {
 type GrantedSlotSequence = Extract<SequenceView, {
     phase: "granted";
 }>;
+/** How a granted win settles: who consumes the grant, and whether money has already moved for it. */
+type GrantedSettlement = GrantedSlotSequence["settlement"];
 export interface SlotProps {
     snapshot: JourneySnapshot | null;
     view: JourneyView | null;
@@ -59,22 +63,17 @@ export interface GrantedSlotProps extends SlotProps {
     grant?: string;
     expiresAt?: number;
 }
-export interface PaymentCollectionSlotProps extends SlotProps {
-    preAuthAmount: string;
-    preAuthCurrencyCode: string;
+interface PaymentCollectionBaseSlotProps extends SlotProps {
     savedPaymentMethods: PaymentMethodSummary[];
-    /** Rejects on a recoverable payment failure (e.g. a declined card) — the panel owns recovery UI for its own submit. */
+    /** Submits pre-auth entry or confirms at-end checkout; rejects when the panel should keep recovery UI mounted. */
     onEnter: (paymentInput: PaymentInput) => Promise<void>;
     isEntering: boolean;
-    /** "enter" collects payment before first entry; "reenter" collects payment to retry after a failed or expired authorization hold. */
-    intent: "enter" | "reenter";
     /**
-     * Client configuration for the processor authorizing this entry, as the server supplied it.
-     * Carried by the enterable arm only — a retry is offered from an ended view, which holds no
-     * configuration.
+     * Client configuration for the internal processor, as the server supplied it. Carried by the
+     * enterable pre-auth and granted at-end arms; an ended retry holds no configuration.
      */
     paymentProvider?: PaymentProviderConfig;
-    /** Present while the processor is waiting on an out-of-band action; re-submitting entry resolves it. */
+    /** Present while the internal processor is waiting on an out-of-band action. */
     pendingAction?: CheckoutNextAction;
     /**
      * Re-reads the consumer's journeys from the server so a provider configuration that was missing
@@ -83,35 +82,22 @@ export interface PaymentCollectionSlotProps extends SlotProps {
      */
     onRetryPaymentConfig?: () => Promise<void>;
 }
+export type PaymentCollectionSlotProps = PaymentCollectionBaseSlotProps & ({
+    intent: "checkout";
+    onResume: () => Promise<void>;
+} | {
+    intent: "enter" | "reenter";
+    preAuthAmount: string;
+    preAuthCurrencyCode: string;
+    onResume?: never;
+});
 /**
- * The processor's client configuration block, named through the affordance that carries it: core
- * re-exports the affordance but not the contract's own name for this shape.
+ * The processor's client configuration block, named through an arm that carries it: core names the
+ * shape only within those arms, not as a standalone export.
  */
-type PaymentProviderConfig = NonNullable<ReservationPaymentAffordance["paymentProvider"]>;
-export interface ReservationCheckoutSlotProps extends SlotProps {
-    reservation: {
-        token: string;
-        expiresAt: number;
-    };
-    savedPaymentMethods: PaymentMethodSummary[];
-    /** Which processor executes this reservation's payment leg; narrow before rendering processor-specific UI. */
-    processor: CheckoutProcessor;
-    /** Client configuration for the processor settling this reservation, as the server supplied it. */
-    paymentProvider?: PaymentProviderConfig;
-    /** Present while the processor is waiting on an out-of-band action; complete it, then call `onResume`. */
-    pendingAction?: CheckoutNextAction;
-    /** Rejects on a recoverable payment failure (e.g. a declined card) — the panel owns recovery UI for its own submit. */
-    onConfirm: (paymentInput: PaymentInput) => Promise<void>;
-    /** Re-submits the paused checkout after `pendingAction` has been completed. Idempotent server-side. */
-    onResume: () => Promise<void>;
-    isConfirming: boolean;
-    /**
-     * Re-reads the consumer's journeys from the server so a provider configuration that was missing
-     * or unreadable at render can arrive. This is the panel's only recovery when `paymentProvider` is
-     * absent — the value is a prop, so nothing the panel does to its own state can produce it.
-     */
-    onRetryPaymentConfig?: () => Promise<void>;
-}
+type PaymentProviderConfig = NonNullable<Extract<GrantedSettlement, {
+    mode: "at_end";
+}>["paymentProvider"]>;
 export type CheckoutProcessingSlotProps = SlotProps;
 /**
  * A Fanfare-managed payment is terminal: it produces a receipt, never an admission credential. The
@@ -137,7 +123,8 @@ export interface EndedSlotProps extends SlotProps {
 }
 export interface ErrorSlotProps extends SlotProps {
     error: string;
-    onRetry: () => void;
+    /** Absent when the refusal cannot be cleared by retrying — render no retry affordance. */
+    onRetry?: () => void;
 }
 export interface LoadingSlotProps extends SlotProps {
     /** Stage-specific message (e.g. routing). `undefined` for generic loading — show just a spinner. */
@@ -161,13 +148,18 @@ export interface ExperienceWidgetSlots {
     participating?: (props: ParticipatingSlotProps) => JSX.Element;
     granted?: (props: GrantedSlotProps) => JSX.Element;
     paymentCollection?: (props: PaymentCollectionSlotProps) => JSX.Element;
-    reservationCheckout?: (props: ReservationCheckoutSlotProps) => JSX.Element;
+    /** Rendered by the at-end checkout surface while a collected payment is settling. */
     checkoutProcessing?: (props: CheckoutProcessingSlotProps) => JSX.Element;
     receipt?: (props: ReceiptSlotProps) => JSX.Element;
     expired?: (props: ExpiredSlotProps) => JSX.Element;
     ended?: (props: EndedSlotProps) => JSX.Element;
     error?: (props: ErrorSlotProps) => JSX.Element;
 }
+/**
+ * Surface the widget is mounted on, named through the bus payload that carries it: core
+ * re-exports the event map but not the contract's own name for this shape.
+ */
+type BeaconPageType = SDKEvents["experience:widget-mounted"]["pageType"];
 export interface ExperienceRenderProps {
     journey: JourneyHandle | null;
     view: JourneyView | null;
@@ -184,14 +176,22 @@ export interface ExperienceWidgetProps {
     theme?: BrandTheme;
     variant?: WidgetVariant;
     slots?: ExperienceWidgetSlots;
+    /**
+     * Surface this widget renders on, carried on the `experience:widget-mounted` announcement.
+     * Defaults to `embed`, the merchant-page case; Fanfare-hosted drop pages pass `hosted`.
+     */
+    pageType?: BeaconPageType;
     children?: (props: ExperienceRenderProps) => JSX.Element;
     checkoutUrl?: string;
+    /**
+     * Action offered on terminal panels (not selected, sold out, closed), such as
+     * a link back to what is still available. Omit to show none.
+     */
+    endedAction?: OutcomeAction;
     onJourneyChange?: (snapshot: JourneySnapshot) => void;
     onGranted?: (grant: string) => void;
-    /** Called when a Fanfare-managed checkout completes (pre-auth capture or post-win reservation checkout) */
+    /** Called when a Fanfare-managed checkout completes */
     onFanfareCheckout?: (result: FanfareCheckoutResult) => void;
-    /** Called when the consumer wins a `post_win` distribution and must complete checkout before `expiresAt` */
-    onReserved?: (expiresAt: number) => void;
     onError?: (error: Error) => void;
     class?: string;
     className?: string;

package/dist/components/widgets/index.d.ts

@@ -6,6 +6,6 @@
  *
  * @packageDocumentation
  */
-export { ExperienceWidget, type AccessCodeSlotProps, type AuthSlotProps, type ChallengeSlotProps, type CheckoutProcessingSlotProps, type EndedSlotProps, type EnterableSlotProps, type ErrorSlotProps, type ExperienceRenderProps, type ExperienceWidgetProps, type ExperienceWidgetSlots, type ExpiredSlotProps, type GrantedSlotProps, type LoadingSlotProps, type ParticipatingSlotProps, type PaymentCollectionSlotProps, type ReceiptSlotProps, type ReservationCheckoutSlotProps, type SlotProps, type StartSlotProps, type UpcomingSlotProps, type WaitlistSlotProps, } from './experience-widget';
+export { ExperienceWidget, type AccessCodeSlotProps, type AuthSlotProps, type ChallengeSlotProps, type CheckoutProcessingSlotProps, type EndedSlotProps, type EnterableSlotProps, type ErrorSlotProps, type ExperienceRenderProps, type ExperienceWidgetProps, type ExperienceWidgetSlots, type ExpiredSlotProps, type GrantedSlotProps, type LoadingSlotProps, type ParticipatingSlotProps, type PaymentCollectionSlotProps, type ReceiptSlotProps, type SlotProps, type StartSlotProps, type UpcomingSlotProps, type WaitlistSlotProps, } from './experience-widget';
 export { LoadingView, StartView, UpcomingModule, WaitlistView, type LoadingViewProps, type StartViewProps, type UpcomingModuleProps, type WaitlistViewProps, } from '../internal';
 export { AppointmentModule, AuctionModule, DrawModule, QueueModule, TimedReleaseModule, type AppointmentModuleProps, type AuctionModuleProps, type DrawModuleProps, type QueueModuleProps, type TimedReleaseModuleProps, } from '../internal';

package/dist/index.d.ts

@@ -21,11 +21,11 @@ export type { InfoPanelProps, OutcomeReason, PanelBodyProps, PanelFooterProps, P
 export { AccessCodeForm, ChallengeGate, EndedModule, ErrorView, GrantedPanel, OutcomePanel, } from './components/compositions';
 export type { AccessCodeFormProps, ChallengeGateProps, EndedModuleProps, ErrorViewProps, GrantedPanelProps, OutcomePanelProps, } from './components/compositions';
 export { ExperienceWidget } from './components/widgets';
-export type { AccessCodeSlotProps, AuthSlotProps, ChallengeSlotProps, CheckoutProcessingSlotProps, EndedSlotProps, EnterableSlotProps, ErrorSlotProps, ExperienceRenderProps, ExperienceWidgetProps, ExperienceWidgetSlots, ExpiredSlotProps, GrantedSlotProps, LoadingSlotProps, ParticipatingSlotProps, PaymentCollectionSlotProps, ReceiptSlotProps, ReservationCheckoutSlotProps, SlotProps, StartSlotProps, UpcomingSlotProps, WaitlistSlotProps, } from './components/widgets';
-export { CheckoutProcessingPanel, PaymentCollectionPanel, ReceiptPanel, ReservationCheckoutPanel, } from './components/checkout';
+export type { AccessCodeSlotProps, AuthSlotProps, ChallengeSlotProps, CheckoutProcessingSlotProps, EndedSlotProps, EnterableSlotProps, ErrorSlotProps, ExperienceRenderProps, ExperienceWidgetProps, ExperienceWidgetSlots, ExpiredSlotProps, GrantedSlotProps, LoadingSlotProps, ParticipatingSlotProps, PaymentCollectionSlotProps, ReceiptSlotProps, SlotProps, StartSlotProps, UpcomingSlotProps, WaitlistSlotProps, } from './components/widgets';
+export { CheckoutProcessingPanel, PaymentCollectionPanel, ReceiptPanel } from './components/checkout';
 export { LoadingView, StartView, UpcomingModule, WaitlistView } from './components/widgets';
 export type { LoadingViewProps, StartViewProps, UpcomingModuleProps, WaitlistViewProps } from './components/widgets';
-export { AuctionModule, DrawModule, QueueModule, TimedReleaseModule } from './components/widgets';
-export type { AuctionModuleProps, DrawModuleProps, QueueModuleProps, TimedReleaseModuleProps, } from './components/widgets';
+export { AppointmentModule, AuctionModule, DrawModule, QueueModule, TimedReleaseModule } from './components/widgets';
+export type { AppointmentModuleProps, AuctionModuleProps, DrawModuleProps, QueueModuleProps, TimedReleaseModuleProps, } from './components/widgets';
 export * from './styles';
 export { registerWebComponents } from './register';