@fanfare-io/fanfare-sdk-solid 0.1.0

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

@@ -0,0 +1,127 @@
+import { BotMitigationState, RoutingChallenge } from '@fanfare-io/fanfare-sdk-core/challenges';
+import { JourneyHandle, JourneySnapshot, JourneyView, 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';
+type ParticipationType = "queue" | "draw" | "auction" | "timed_release" | "appointment";
+type EnterableSlotSequence = Extract<SequenceView, {
+    phase: "enterable";
+    mechanism: ParticipationType;
+}>;
+type ParticipatingSlotSequence = Extract<SequenceView, {
+    phase: "participating";
+    mechanism: ParticipationType;
+}>;
+type GrantedSlotSequence = Extract<SequenceView, {
+    phase: "granted";
+}>;
+export interface SlotProps {
+    snapshot: JourneySnapshot | null;
+    view: JourneyView | null;
+    error: string | null;
+}
+export interface StartSlotProps extends SlotProps {
+    onStart: () => void;
+    isStarting: boolean;
+}
+export interface AuthSlotProps extends SlotProps {
+    onSubmit: (credential: string, type: AuthInputMode) => Promise<void>;
+    onVerify: (otp: string) => Promise<void>;
+    onSkip?: () => void;
+}
+export interface AccessCodeSlotProps extends SlotProps {
+    onSubmit: (code: string) => Promise<void>;
+    onSkip?: () => void;
+}
+export interface UpcomingSlotProps extends SlotProps {
+    startsAt?: Date;
+    canEnter: boolean;
+    onEnter: () => void;
+    isEntering: boolean;
+}
+export interface WaitlistSlotProps extends SlotProps {
+    startsAt?: Date;
+    onLeave: () => void;
+    isLeaving: boolean;
+}
+export interface EnterableSlotProps extends SlotProps {
+    sequence: EnterableSlotSequence;
+    participationType: ParticipationType;
+}
+export interface ParticipatingSlotProps extends SlotProps {
+    sequence: ParticipatingSlotSequence;
+    participationType: ParticipationType;
+    position?: number;
+}
+export interface GrantedSlotProps extends SlotProps {
+    sequence: GrantedSlotSequence;
+    grant?: string;
+    expiresAt?: number;
+}
+export interface ExpiredSlotProps extends SlotProps {
+    reason: string;
+    endedAt?: Date;
+}
+export interface EndedSlotProps extends SlotProps {
+    reason: string;
+    endedAt?: Date;
+}
+export interface ErrorSlotProps extends SlotProps {
+    error: string;
+    onRetry: () => void;
+}
+export interface LoadingSlotProps extends SlotProps {
+    /** Stage-specific message (e.g. routing). `undefined` for generic loading — show just a spinner. */
+    message?: string;
+}
+export interface ChallengeSlotProps extends SlotProps {
+    challenge: RoutingChallenge | null;
+    botMitigation?: BotMitigationState;
+    onVerifyToken: (token: string) => Promise<void>;
+    onRetry: () => void;
+}
+export interface ExperienceWidgetSlots {
+    start?: (props: StartSlotProps) => JSX.Element;
+    loading?: (props: LoadingSlotProps) => JSX.Element;
+    auth?: (props: AuthSlotProps) => JSX.Element;
+    accessCode?: (props: AccessCodeSlotProps) => JSX.Element;
+    challenge?: (props: ChallengeSlotProps) => JSX.Element;
+    upcoming?: (props: UpcomingSlotProps) => JSX.Element;
+    waitlist?: (props: WaitlistSlotProps) => JSX.Element;
+    enterable?: (props: EnterableSlotProps) => JSX.Element;
+    participating?: (props: ParticipatingSlotProps) => JSX.Element;
+    granted?: (props: GrantedSlotProps) => JSX.Element;
+    expired?: (props: ExpiredSlotProps) => JSX.Element;
+    ended?: (props: EndedSlotProps) => JSX.Element;
+    error?: (props: ErrorSlotProps) => JSX.Element;
+}
+export interface ExperienceRenderProps {
+    journey: JourneyHandle | null;
+    view: JourneyView | null;
+    snapshot: JourneySnapshot | null;
+    error: string | null;
+    start: () => Promise<void>;
+    isStarting: boolean;
+}
+export interface ExperienceWidgetProps {
+    experienceId: string;
+    autoStart?: boolean;
+    accessCode?: string;
+    autoEnterWaitlist?: boolean;
+    theme?: BrandTheme;
+    variant?: WidgetVariant;
+    slots?: ExperienceWidgetSlots;
+    children?: (props: ExperienceRenderProps) => JSX.Element;
+    checkoutUrl?: string;
+    onJourneyChange?: (snapshot: JourneySnapshot) => void;
+    onGranted?: (grant: string) => void;
+    onError?: (error: Error) => void;
+    class?: string;
+    className?: string;
+}
+export declare function ExperienceWidget(props: ExperienceWidgetProps): JSX.Element;
+export declare namespace ExperienceWidget {
+    var displayName: string;
+}
+export {};

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

@@ -0,0 +1,11 @@
+/**
+ * Widget Components
+ *
+ * Complete, self-contained experiences that orchestrate the full journey flow.
+ * Widgets support variants, slots, and render props for customization.
+ *
+ * @packageDocumentation
+ */
+export { ExperienceWidget, type AccessCodeSlotProps, type AuthSlotProps, type ChallengeSlotProps, type EndedSlotProps, type EnterableSlotProps, type ErrorSlotProps, type ExperienceRenderProps, type ExperienceWidgetProps, type ExperienceWidgetSlots, type ExpiredSlotProps, type GrantedSlotProps, type LoadingSlotProps, type ParticipatingSlotProps, 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/components/widgets/queue/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Queue Widget Internal Components
+ *
+ * Building blocks for the QueueWidget.
+ */
+export { QueueActions, type QueueActionsProps, type QueueStatus } from './queue-actions';

package/dist/components/widgets/queue/queue-actions.d.ts

@@ -0,0 +1,20 @@
+export type QueueStatus = "enterable" | "queued" | "granted" | "error";
+export interface QueueActionsProps {
+    status: QueueStatus;
+    onEnter?: () => void;
+    onLeave?: () => void;
+    onShare?: () => void;
+    isEntering?: boolean;
+    isLeaving?: boolean;
+    enterLabel?: string;
+    leaveLabel?: string;
+    shareLabel?: string;
+    showShare?: boolean;
+    layout?: "horizontal" | "vertical";
+    class?: string;
+    className?: string;
+}
+export declare function QueueActions(props: QueueActionsProps): import("solid-js").JSX.Element;
+export declare namespace QueueActions {
+    var displayName: string;
+}

package/dist/components/widgets/timed-release/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Timed Release Widget Internal Components
+ *
+ * Building blocks for the TimedReleaseWidget.
+ */
+export { TimedReleaseActions, type TimedReleaseActionsProps, type TimedReleaseStatus } from './timed-release-actions';

package/dist/components/widgets/timed-release/timed-release-actions.d.ts

@@ -0,0 +1,21 @@
+export type TimedReleaseStatus = "open" | "entered" | "shopping" | "completed" | "expired" | "ended";
+export interface TimedReleaseActionsProps {
+    status: TimedReleaseStatus;
+    onEnter?: () => void;
+    onShop?: () => void;
+    onComplete?: () => void;
+    onExit?: () => void;
+    isEntering?: boolean;
+    isExiting?: boolean;
+    enterLabel?: string;
+    shopLabel?: string;
+    completeLabel?: string;
+    exitLabel?: string;
+    layout?: "horizontal" | "vertical";
+    class?: string;
+    className?: string;
+}
+export declare function TimedReleaseActions(props: TimedReleaseActionsProps): import("solid-js").JSX.Element;
+export declare namespace TimedReleaseActions {
+    var displayName: string;
+}

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

@@ -0,0 +1,6 @@
+/**
+ * Waitlist Widget Internal Components
+ *
+ * Building blocks for the WaitlistWidget.
+ */
+export { WaitlistActions, type WaitlistActionsProps, type WaitlistStatus } from './waitlist-actions';

package/dist/components/widgets/waitlist/waitlist-actions.d.ts

@@ -0,0 +1,22 @@
+export type WaitlistStatus = "available" | "entered" | "opening" | "opened";
+export interface WaitlistActionsProps {
+    status: WaitlistStatus;
+    onEnter?: () => void;
+    onLeave?: () => void;
+    onShare?: () => void;
+    onProceed?: () => void;
+    isEntering?: boolean;
+    isLeaving?: boolean;
+    enterLabel?: string;
+    leaveLabel?: string;
+    shareLabel?: string;
+    proceedLabel?: string;
+    showShare?: boolean;
+    layout?: "horizontal" | "vertical";
+    class?: string;
+    className?: string;
+}
+export declare function WaitlistActions(props: WaitlistActionsProps): import("solid-js").JSX.Element;
+export declare namespace WaitlistActions {
+    var displayName: string;
+}

package/dist/hooks/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * SolidJS Hooks
+ *
+ * Reactive wrappers around the core SDK modules.
+ *
+ * @packageDocumentation
+ */
+export { useFanfareAuth } from './use-auth';
+export { useExperienceJourney } from './use-experience-journey';
+export type { ExperienceJourneyOptions, UseExperienceJourneyOptions, UseExperienceJourneyResult, } from './use-experience-journey';
+export { useJourneySnapshot } from './use-journey-snapshot';
+export { useNanostore } from './use-nanostore';

package/dist/hooks/use-auth.d.ts

@@ -0,0 +1,11 @@
+import { AuthStatus, OtpRequest, OtpVerify } from '@fanfare-io/fanfare-sdk-core/auth';
+export declare function useFanfareAuth(): {
+    authStatus: import('solid-js').Accessor<AuthStatus>;
+    isAuthenticated: import('solid-js').Accessor<boolean>;
+    isGuest: import('solid-js').Accessor<boolean | undefined>;
+    session: import('solid-js').Accessor<import('@fanfare-io/fanfare-sdk-core/auth').Session | undefined>;
+    guest: () => Promise<import('@fanfare-io/fanfare-sdk-core/auth').GuestSession>;
+    requestOtp: (options: OtpRequest) => Promise<void>;
+    verifyOtp: (options: OtpVerify) => Promise<import('@fanfare-io/fanfare-sdk-core/auth').AuthenticatedSession>;
+    logout: () => Promise<void>;
+};

package/dist/hooks/use-experience-journey.d.ts

@@ -0,0 +1,17 @@
+import { JourneyHandle, JourneySnapshot, JourneyView } from '@fanfare-io/fanfare-sdk-core/experiences';
+import { MaybeAccessor } from '../utils/to-accessor';
+export interface ExperienceJourneyOptions {
+    accessCode?: MaybeAccessor<string | undefined>;
+    autoEnterWaitlist?: MaybeAccessor<boolean | undefined>;
+}
+export interface UseExperienceJourneyOptions extends ExperienceJourneyOptions {
+    autoStart?: MaybeAccessor<boolean | undefined>;
+}
+export interface UseExperienceJourneyResult {
+    journey: () => JourneyHandle | null;
+    view: () => JourneyView | null;
+    snapshot: () => JourneySnapshot | null;
+    error: () => string | null;
+    start: (options?: ExperienceJourneyOptions) => Promise<JourneyView>;
+}
+export declare function useExperienceJourney(experienceId: MaybeAccessor<string | undefined>, options?: UseExperienceJourneyOptions): UseExperienceJourneyResult;

package/dist/hooks/use-journey-snapshot.d.ts

@@ -0,0 +1,8 @@
+import { JourneyHandle, JourneySnapshot } from '@fanfare-io/fanfare-sdk-core/experiences';
+import { Accessor } from 'solid-js';
+/**
+ * Subscribe to the full journey snapshot. Re-renders on every snapshot change.
+ * Use this for exhaustive DU switching or when you need the complete snapshot.
+ * Prefer `useNanostore(handle.view$)` for view-level subscriptions.
+ */
+export declare function useJourneySnapshot(handle: JourneyHandle): Accessor<JourneySnapshot>;

package/dist/hooks/use-nanostore.d.ts

@@ -0,0 +1,7 @@
+import { ReadableAtom } from 'nanostores';
+import { Accessor } from 'solid-js';
+/**
+ * Subscribe to a nanostores `ReadableAtom` and return a Solid accessor.
+ * Re-renders only when the atom's value changes.
+ */
+export declare function useNanostore<T>(atom: ReadableAtom<T> | Accessor<ReadableAtom<T>>): Accessor<T>;

package/dist/i18n/i18n-context.d.ts

@@ -0,0 +1,19 @@
+import { Locale, PartialTranslationMessages, TextDirection, TranslateFunction, TranslationKey, TranslationMessageKey, TranslationMessages } from '@fanfare-io/fanfare-sdk-i18n';
+import { Accessor } from 'solid-js';
+export interface I18nContextValue {
+    locale: Accessor<Locale>;
+    messages: Accessor<TranslationMessages<TranslationMessageKey>>;
+    isRoot: boolean;
+    t: TranslateFunction<TranslationKey>;
+    dir: Accessor<TextDirection>;
+    experienceTranslations: Accessor<PartialTranslationMessages<TranslationMessageKey> | null>;
+    setExperienceTranslations: (translations: PartialTranslationMessages<TranslationMessageKey> | null) => void;
+}
+export declare const I18nContext: import('solid-js').Context<I18nContextValue>;
+export declare function useI18nContext(): I18nContextValue;
+export declare function useTranslations(): {
+    t: TranslateFunction<TranslationKey>;
+    locale: Accessor<Locale>;
+    dir: Accessor<TextDirection>;
+};
+export declare function createMergedTranslations(parent: I18nContextValue, locale: Accessor<Locale | undefined>, translations: Accessor<PartialTranslationMessages<TranslationMessageKey> | undefined>, experienceTranslations: Accessor<PartialTranslationMessages<TranslationMessageKey> | null>, setExperienceTranslations: (translations: PartialTranslationMessages<TranslationMessageKey> | null) => void): I18nContextValue;

package/dist/i18n/i18n-provider.d.ts

@@ -0,0 +1,16 @@
+import { Locale, PartialTranslationMessages, TranslationMessageKey } from '@fanfare-io/fanfare-sdk-i18n';
+import { JSX } from 'solid-js';
+export interface I18nProviderProps {
+    /**
+     * The locale to use for translations.
+     * @default "en"
+     */
+    locale?: Locale;
+    /**
+     * Custom translations to merge with or override defaults.
+     * Keys should match the default translation keys.
+     */
+    translations?: PartialTranslationMessages<TranslationMessageKey>;
+    children: JSX.Element;
+}
+export declare function I18nProvider(props: I18nProviderProps): JSX.Element;

package/dist/i18n/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * i18n Module
+ *
+ * Re-exports core i18n utilities from @fanfare-io/fanfare-sdk-i18n.
+ *
+ * @packageDocumentation
+ */
+export { RTL_LOCALES, TRANSLATION_KEYS, createTranslateFunction, en, interpolate, isRTLLocale, mergeTranslations, type I18nConfig, type Locale, type PartialTranslationMessages, type RTLLocale, type TextDirection, type TranslateFunction, type TranslateOptions, type TranslationKey, type TranslationMessageKey, type TranslationMessages, } from '@fanfare-io/fanfare-sdk-i18n';
+export { I18nContext, createMergedTranslations, useI18nContext, useTranslations } from './i18n-context';
+export type { I18nContextValue } from './i18n-context';
+export { I18nProvider } from './i18n-provider';
+export type { I18nProviderProps } from './i18n-provider';

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Fanfare SolidJS Web Components
+ *
+ * Web components for integrating Fanfare experiences
+ *
+ * @packageDocumentation
+ */
+export { FanfareProvider, useFanfare } from './components/provider';
+export * from './hooks';
+export * from './i18n';
+export * from './theme';
+export * from './components/auth';
+export * from './components/compositions';
+export * from './components/module';
+export * from './components/primitives';
+export * from './components/widgets';
+export * from './styles';
+export { registerWebComponents } from './register';