@riverbankcms/sdk 0.84.0 → 0.84.1

package/dist/_dts/blocks/src/system/runtime/nodes/event-registration/event-registration.headless.state.d.ts

@@ -1,303 +1,3 @@
-import type { BlockApiConfig } from '../../api';
-import type { PaymentMethod } from '../../api/types';
-import type { EventRegistrationContentEntry } from '../event-registration.interactive';
-import type { EligibilityData, FormData, Guest, GuestErrors, OccurrenceContext, PaymentSelection, PaymentStepState, PublicEvent, RegistrationEvent, RegistrationResult, RegistrationStep } from './types';
-import type { SelectableEventTicketType } from './utils';
-import type { PortalAuthState, PortalProfile } from './hooks';
-import type { UseWaitlistClaimResult } from '../../shared/useWaitlistClaim';
-import type { UseEventRegistrationWizardResult } from './useEventRegistrationWizard';
-import type { EventRegistrationSubmitOptions, EventRegistrationSubmitResult } from './useEventRegistrationSubmit';
-export declare const DEFAULT_EVENT_REGISTRATION_MAX_TICKETS = 5;
-export type EventRegistrationLoadState<T> = Readonly<{
-    tag: 'idle';
-    value: T | null;
-}> | Readonly<{
-    tag: 'loading';
-    value: T | null;
-}> | Readonly<{
-    tag: 'loaded';
-    value: T;
-}>;
-export type EventRegistrationSubmitArgs = Readonly<{
-    method: PaymentMethod;
-    passId?: string;
-    membershipId?: string;
-    selection?: PaymentSelection;
-}>;
-export type EventRegistrationSubmitPlan = Readonly<{
-    ok: true;
-    args: EventRegistrationSubmitArgs;
-}> | Readonly<{
-    ok: false;
-    reason: 'payment-selection-required';
-    message: string;
-}>;
-export type EventRegistrationFlowStatus = Readonly<{
-    tag: 'ready';
-}> | Readonly<{
-    tag: 'submitting';
-}> | Readonly<{
-    tag: 'redirecting';
-}> | Readonly<{
-    tag: 'verifying-payment';
-}> | Readonly<{
-    tag: 'verifying-timeout';
-}> | Readonly<{
-    tag: 'payment-failed';
-    message: string;
-}> | Readonly<{
-    tag: 'success';
-    result: RegistrationResult;
-}> | Readonly<{
-    tag: 'error';
-    message: string;
-}>;
-export type EventRegistrationFlowView = Readonly<{
-    kind: 'empty';
-    message: string;
-}> | Readonly<{
-    kind: 'unavailable';
-    message: string;
-}> | Readonly<{
-    kind: 'form';
-}> | Readonly<{
-    kind: 'verifying';
-    message: string;
-}> | Readonly<{
-    kind: 'success';
-    result: RegistrationResult;
-}> | Readonly<{
-    kind: 'error';
-    message: string;
-}>;
-export type EventRegistrationFlowStepId = 'select-event' | 'select-tickets' | 'enter-details' | 'select-payment';
-export type EventRegistrationFlowStepState = 'complete' | 'active' | 'available' | 'blocked';
-export type EventRegistrationFlowStep = Readonly<{
-    id: EventRegistrationFlowStepId;
-    label: string;
-    state: EventRegistrationFlowStepState;
-    index: number;
-    canEnter: boolean;
-    canLeave: boolean;
-}>;
-export type EventRegistrationFlowActionResult = Readonly<{
-    ok: true;
-}> | Readonly<{
-    ok: false;
-    reason: 'blocked' | 'validation-failed' | 'submission-failed';
-    message: string;
-}>;
-export type EventRegistrationEventsModel = Readonly<{
-    items: readonly PublicEvent[];
-    scoped: readonly RegistrationEvent[];
-    selected: RegistrationEvent | null;
-    preSelected: RegistrationEvent | null;
-    hasPreSelectedContext: boolean;
-    target: UseEventRegistrationWizardResult['registrationTarget'];
-    occurrenceContext: OccurrenceContext | null | undefined;
-    contentEntry: EventRegistrationContentEntry | null | undefined;
-}>;
-export type EventRegistrationTicketsModel = Readonly<{
-    count: number;
-    max: number;
-    selectedTicketTypeId: string | null;
-    selectedTicketType: SelectableEventTicketType | null;
-    visibleTicketTypes: readonly SelectableEventTicketType[];
-    selectionRequired: boolean;
-    hasValidSelection: boolean;
-    eventRequiresPayment: boolean;
-    selectedAttendanceMode: 'in_person' | 'online' | null;
-}>;
-export type EventRegistrationAttendeeModel = Readonly<{
-    values: FormData;
-    errors: Partial<Record<keyof FormData, string>>;
-}>;
-export type EventRegistrationGuestsModel = Readonly<{
-    required: boolean;
-    items: readonly Guest[];
-    errors: GuestErrors;
-    shake: boolean;
-}>;
-export type EventRegistrationPaymentSelection = Readonly<{
-    method: 'none';
-}> | Readonly<{
-    method: 'free';
-}> | Readonly<{
-    method: 'stripe';
-}> | Readonly<{
-    method: 'pass';
-    passId: string;
-    productName?: string;
-}> | Readonly<{
-    method: 'membership';
-    membershipId: string;
-    productName?: string;
-}> | Readonly<{
-    method: 'pass_bundle';
-    passId: string;
-    productName?: string;
-}> | Readonly<{
-    method: 'membership_bundle';
-    membershipId: string;
-    productName?: string;
-}>;
-export type EventRegistrationPaymentModel = Readonly<{
-    kind: 'hidden';
-    selection: EventRegistrationPaymentSelection;
-    stepState: PaymentStepState;
-}> | Readonly<{
-    kind: 'loading' | 'error' | 'not-eligible' | 'ready';
-    selection: EventRegistrationPaymentSelection;
-    stepState: PaymentStepState;
-    eligibility: EligibilityData | null;
-    eligibilityError: string | null | undefined;
-}>;
-export type EventRegistrationDiscountModel = Readonly<{
-    code: string;
-    isOpen: boolean;
-    available: boolean;
-    manualCodeEntryAllowed: boolean;
-    loading: boolean;
-    autoAppliedDiscount: UseEventRegistrationWizardResult['autoAppliedDiscount'];
-}>;
-export type EventRegistrationPortalAuthModel = Readonly<{
-    state: PortalAuthState;
-    profile: PortalProfile | null;
-    isAuthenticated: boolean;
-    showMagicLinkModal: boolean;
-}>;
-export type EventRegistrationSpamProtectionModel = Readonly<{
-    enabled: false;
-}> | Readonly<{
-    enabled: true;
-    provider: 'altcha';
-    challenge: {
-        url: string;
-        auto: 'onfocus';
-    };
-    solution: string | null;
-}>;
-export type EventRegistrationTerminalModel = Readonly<{
-    result: RegistrationResult | null;
-    errorMessage: string;
-    verification: UseEventRegistrationWizardResult['verification'];
-}>;
-export type EventRegistrationFlowActions = Readonly<{
-    selectEvent: (event: RegistrationEvent) => void;
-    selectAttendanceMode: (mode: 'in_person' | 'online' | null) => void;
-    selectTicketType: (ticketTypeId: string | null) => void;
-    setTicketsCount: (count: number) => void;
-    updateAttendee: (values: FormData) => void;
-    updateGuests: (guests: Guest[]) => void;
-    selectPayment: (selection: EventRegistrationPaymentSelection) => void;
-    setDiscountCode: (code: string) => void;
-    setDiscountOpen: (isOpen: boolean) => void;
-    setAltchaSolution: (solution: string | null) => void;
-    requestLogin: () => void;
-    logout: () => void;
-    next: () => Promise<EventRegistrationFlowActionResult>;
-    back: () => void;
-    submit: (options?: EventRegistrationSubmitOptions) => Promise<EventRegistrationSubmitResult>;
-    retry: () => void;
-}>;
-export type HeadlessEventRegistrationFlow = Readonly<{
-    status: EventRegistrationFlowStatus;
-    view: EventRegistrationFlowView;
-    steps: readonly EventRegistrationFlowStep[];
-    currentStep: EventRegistrationFlowStep | null;
-    events: EventRegistrationEventsModel;
-    tickets: EventRegistrationTicketsModel;
-    attendee: EventRegistrationAttendeeModel;
-    guests: EventRegistrationGuestsModel;
-    payment: EventRegistrationPaymentModel;
-    discount: EventRegistrationDiscountModel;
-    portalAuth: EventRegistrationPortalAuthModel;
-    existingRegistration: Readonly<{
-        state: EventRegistrationLoadState<UseEventRegistrationWizardResult['existingRegistration']>;
-        registration: UseEventRegistrationWizardResult['existingRegistration'];
-    }>;
-    waitlistClaim: UseWaitlistClaimResult;
-    spamProtection: EventRegistrationSpamProtectionModel;
-    terminal: EventRegistrationTerminalModel;
-    actions: EventRegistrationFlowActions;
-}>;
-export type EventRegistrationOverrideData = Readonly<{
-    events?: readonly PublicEvent[] | null;
-}>;
-export type EventRegistrationOverridePropsLike = Readonly<{
-    content?: Partial<{
-        maxTickets: string | null;
-        showVenue: boolean | null;
-        showCapacity: boolean | null;
-        successMessage: string | null;
-        waitlistMessage: string | null;
-        buttonVariant: 'primary' | 'secondary' | 'outline' | null;
-        buttonText: string | null;
-        spamProtectionEnabled: boolean | null;
-        supportEmail: string | null;
-    }> | null;
-    data?: EventRegistrationOverrideData | Record<string, unknown> | null;
-    siteId?: string;
-    apiBaseUrl?: string;
-    portalToken?: string | null;
-    previewToken?: string | null;
-    stage?: 'preview' | 'published';
-    occurrenceContext?: OccurrenceContext | null;
-    contentEntry?: Record<string, unknown> | null;
-    blockId?: string | null;
-}>;
-export type EventRegistrationOverrideInput = Readonly<{
-    siteId: string;
-    apiBaseUrl: string;
-    portalToken: string | null;
-    previewToken: string | null;
-    stage?: 'preview' | 'published';
-    occurrenceContext?: OccurrenceContext | null;
-    contentEntry?: EventRegistrationContentEntry | null;
-    events: readonly PublicEvent[];
-    maxTickets?: string;
-    showVenue?: boolean;
-    showCapacity?: boolean;
-    successMessage?: string;
-    waitlistMessage?: string;
-    buttonText?: string | null;
-    buttonVariant?: 'primary' | 'secondary' | 'outline';
-    spamProtectionEnabled?: boolean;
-    supportEmail?: string;
-    blockId?: string | null;
-}>;
-export type EventRegistrationOverrideInputResult = Readonly<{
-    ok: true;
-    value: EventRegistrationOverrideInput;
-}> | Readonly<{
-    ok: false;
-    reason: 'missing-site-id' | 'missing-api-base-url';
-    message: string;
-}>;
-export declare function createEventRegistrationBlockApiConfig(input: Readonly<{
-    siteId: string;
-    apiBaseUrl: string;
-    portalToken?: string | null;
-    previewToken?: string | null;
-    stage?: 'preview' | 'published';
-}>): BlockApiConfig;
-export declare function getRegistrableStatuses(isPreview: boolean | undefined): readonly PublicEvent['status'][];
-export declare function normalizeEventRegistrationMaxTickets(value: string | number | undefined): number;
-export declare function getEventRegistrationOverrideInput(props: EventRegistrationOverridePropsLike): EventRegistrationOverrideInputResult;
-export declare function toHeadlessPaymentSelection(selection: PaymentSelection): EventRegistrationPaymentSelection;
-export declare function toInternalPaymentSelection(selection: EventRegistrationPaymentSelection): PaymentSelection;
-export declare function resolveEventRegistrationSubmitPlan(input: Readonly<{
-    paymentSelection: PaymentSelection;
-    eventRequiresPayment: boolean;
-    canJoinWaitlist?: boolean | null;
-}>): EventRegistrationSubmitPlan;
-export declare function resolveHeadlessEventRegistrationStatus(wizard: Pick<UseEventRegistrationWizardResult, 'step' | 'registrationResult' | 'errorMessage'>): EventRegistrationFlowStatus;
-export declare function resolveHeadlessEventRegistrationView(wizard: Readonly<Pick<UseEventRegistrationWizardResult, 'step' | 'scopedEvents' | 'occurrenceContext' | 'registrationResult' | 'errorMessage'> & {
-    api: Pick<UseEventRegistrationWizardResult['api'], 'config'>;
-}>): EventRegistrationFlowView;
-export declare function deriveEventRegistrationSteps(input: Readonly<{
-    step: RegistrationStep;
-    hasPreSelectedContext: boolean;
-    eventRequiresPayment: boolean;
-    paymentSelection: PaymentSelection;
-}>): readonly EventRegistrationFlowStep[];
+export * from './event-registration.headless.contract';
+export * from './event-registration.headless.override';
+export * from './event-registration.headless.planning';

package/dist/_dts/blocks/src/system/runtime/nodes/event-registration/useEventRegistrationWizard.d.ts

@@ -1,5 +1,13 @@
 import type { DiscountContext } from '../../api/types';
 import type { EventRegistrationClientProps, FormData, Guest, GuestErrors, PaymentSelection, PaymentStepState, PublicEvent, RegistrationEvent, RegistrationResult, RegistrationStep } from './types';
+export type EventRegistrationDetailsCompleteResult = Readonly<{
+    ok: true;
+    outcome: 'payment-step' | 'submitted';
+}> | Readonly<{
+    ok: false;
+    reason: 'blocked' | 'validation-failed' | 'submission-failed';
+    message: string;
+}>;
 export declare function useEventRegistrationWizard(options: {
     anchorId: string;
     occurrenceContext: EventRegistrationClientProps['occurrenceContext'];
@@ -90,7 +98,7 @@ export declare function useEventRegistrationWizard(options: {
     discountContext: DiscountContext | null;
     shouldShowDiscountToggle: boolean;
     verification: import("../../hooks/usePaymentVerification").PaymentVerificationResult;
-    handleDetailsComplete: () => Promise<void>;
+    handleDetailsComplete: () => Promise<EventRegistrationDetailsCompleteResult>;
     handlePaymentSelect: () => Promise<void>;
     handleUseCardInsteadOfPass: () => void;
     handleBookForSomeoneElse: () => void;

package/dist/_dts/blocks/src/system/runtime/nodes/event-registration.interactive.d.ts

@@ -8,7 +8,9 @@ export type EventRegistrationContentEntry = Readonly<{
     contentTypeSlug: string;
 }>;
 export declare const EVENT_REGISTRATION_GENERIC_SHELL_STEP_LABELS: readonly ["Date", "Tickets", "Details"];
+declare const EVENT_REGISTRATION_SHELL_STEP_LABELS: readonly ["Event", "Date", "Tickets", "Details", "Payment"];
 export type EventRegistrationGenericShellStepLabels = typeof EVENT_REGISTRATION_GENERIC_SHELL_STEP_LABELS;
+type EventRegistrationShellStepLabel = typeof EVENT_REGISTRATION_SHELL_STEP_LABELS[number];
 export type EventRegistrationSourceProps = Readonly<{
     siteId?: string;
     apiBaseUrl?: string;
@@ -35,7 +37,7 @@ export type EventRegistrationDisplay = Readonly<{
     className: string | null;
     titleText: string;
     bodyText: string;
-    stepLabels: EventRegistrationGenericShellStepLabels;
+    stepLabels: readonly EventRegistrationShellStepLabel[];
     summaryButtonText: string;
 }>;
 export type EventRegistrationHydration = Readonly<Omit<InternalEventRegistrationClientProps, 'siteId' | 'stage' | 'registrationEndpoint' | 'eligibilityEndpoint' | 'checkoutEndpoint' | 'buttonText' | 'className'>>;
@@ -80,7 +82,7 @@ export declare const eventRegistrationBlockRuntime: Readonly<{
             className: string | null;
             titleText: string;
             bodyText: string;
-            stepLabels: EventRegistrationGenericShellStepLabels;
+            stepLabels: readonly EventRegistrationShellStepLabel[];
             summaryButtonText: string;
         }>;
         hydration: Readonly<Omit<InternalEventRegistrationClientProps, "siteId" | "stage" | "className" | "buttonText" | "registrationEndpoint" | "eligibilityEndpoint" | "checkoutEndpoint">>;
@@ -144,7 +146,7 @@ export declare const eventRegistrationBlockRuntime: Readonly<{
                     className: string | null;
                     titleText: string;
                     bodyText: string;
-                    stepLabels: EventRegistrationGenericShellStepLabels;
+                    stepLabels: readonly EventRegistrationShellStepLabel[];
                     summaryButtonText: string;
                 }>;
                 hydration: Readonly<Omit<InternalEventRegistrationClientProps, "siteId" | "stage" | "className" | "buttonText" | "registrationEndpoint" | "eligibilityEndpoint" | "checkoutEndpoint">>;
@@ -156,7 +158,7 @@ export declare const eventRegistrationBlockRuntime: Readonly<{
                     className: string | null;
                     titleText: string;
                     bodyText: string;
-                    stepLabels: EventRegistrationGenericShellStepLabels;
+                    stepLabels: readonly EventRegistrationShellStepLabel[];
                     summaryButtonText: string;
                 }>;
                 hydration: Readonly<Omit<InternalEventRegistrationClientProps, "siteId" | "stage" | "className" | "buttonText" | "registrationEndpoint" | "eligibilityEndpoint" | "checkoutEndpoint">>;
@@ -182,7 +184,7 @@ export declare const eventRegistrationInteractiveIslandPropsCodec: Readonly<{
                 className: string | null;
                 titleText: string;
                 bodyText: string;
-                stepLabels: EventRegistrationGenericShellStepLabels;
+                stepLabels: readonly EventRegistrationShellStepLabel[];
                 summaryButtonText: string;
             }>;
             hydration: Readonly<Omit<InternalEventRegistrationClientProps, "siteId" | "stage" | "className" | "buttonText" | "registrationEndpoint" | "eligibilityEndpoint" | "checkoutEndpoint">>;
@@ -205,7 +207,7 @@ export declare const eventRegistrationInteractiveIslandPropsCodec: Readonly<{
                 className: string | null;
                 titleText: string;
                 bodyText: string;
-                stepLabels: EventRegistrationGenericShellStepLabels;
+                stepLabels: readonly EventRegistrationShellStepLabel[];
                 summaryButtonText: string;
             }>;
             hydration: Readonly<Omit<InternalEventRegistrationClientProps, "siteId" | "stage" | "className" | "buttonText" | "registrationEndpoint" | "eligibilityEndpoint" | "checkoutEndpoint">>;

package/dist/_dts/editor-blocks/src/BlockForm.d.ts

@@ -4,7 +4,7 @@ import type { BlockManifest, Theme } from '../../blocks/src/index';
 import { type PageDesignEditorBlock } from '../../theme-core/src/site-styles/index';
 import { type EditorBlockId } from '../../core/src/index';
 import type { ArrayKeysManager, DraftsSlice, UiStore as BlockEditorUiStore } from './block-editor/types';
-type UiStoreState = {
+export type BlockFormUiStoreState = {
     setActivePreviewField: (field: {
         kind: 'block';
         blockId: EditorBlockId;
@@ -16,10 +16,12 @@ type UiStoreState = {
         showAllValidation: (blockId: EditorBlockId) => boolean;
         getBlockSaveability: (blockId: EditorBlockId) => BlockDraftSaveability;
     };
-    drafts: Pick<DraftsSlice, 'getBlockSnapshot' | 'getCurrentValues' | 'initNewBlock' | 'updateBlockBaseline' | 'clearError' | 'setAtPath' | 'getAtPath'>;
+    drafts: Pick<DraftsSlice, 'getBlockSnapshot' | 'getCurrentValues' | 'clearError' | 'setAtPath' | 'getAtPath'> & {
+        updateBlockBaseline?: (blockId: EditorBlockId, data: Record<string, unknown> | null) => void;
+    };
     arrayKeys: ArrayKeysManager;
 };
-type UiStore = BlockEditorUiStore<UiStoreState>;
+export type BlockFormUiStore = BlockEditorUiStore<BlockFormUiStoreState>;
 type BlockItem = {
     id?: string | null;
     kind: string;
@@ -37,7 +39,7 @@ export declare function BlockForm({ siteId: _siteId, block, manifest, uiStore, h
     siteId: string;
     block: BlockItem;
     manifest: BlockManifest;
-    uiStore: UiStore;
+    uiStore: BlockFormUiStore;
     hasRecoveryConflict?: boolean;
     focusSignal?: BlockFormFocusSignal | null;
     onFocusHandled?: (requestId: number) => void;

package/dist/_dts/sdk/src/version.d.ts

@@ -8,4 +8,4 @@
  * 1. This constant
  * 2. The "version" field in package.json
  */
-export declare const SDK_VERSION = "0.84.0";
+export declare const SDK_VERSION = "0.84.1";