@riverbankcms/sdk 0.121.0 → 0.124.0

package/dist/_dts/api/src/publicExperience/sharedTypes.d.ts

@@ -0,0 +1,152 @@
+/**
+ * Shared request, response and loader-parameter types for the public-experience API surface.
+ *
+ * Re-exported from `../publicExperienceEndpoints`, which stays the public import site.
+ */
+import type { AutoAppliedDiscountPreview } from '../bookingRecords';
+export declare const PUBLIC_EVENT_TICKET_SELECTION_CONTRACT_VERSION: "public-event-ticket-selection.v2";
+export type EventTicketSelectionRequest = {
+    ticketTypeId?: string | null;
+    quantity: number;
+};
+export type EventTicketLineSummaryResponse = {
+    ticketTypeId: string | null;
+    label: string;
+    description: string | null;
+    quantity: number;
+    unitPriceCents: number;
+    subtotalCents: number;
+    currency: string;
+};
+export type { PublicCoursePriceDisplay, PublicEventPriceDisplay, PublicEventPricing, } from '../../../core/src/index';
+/** Query parameters accepted by the public event list loaders. */
+export type PublicEventLoaderParams = {
+    limit?: string;
+    from?: string;
+    to?: string;
+    afterStartsAt?: string;
+    afterId?: string;
+    categoryIds?: string;
+    venueId?: string;
+    staffMemberId?: string;
+    eventSurface?: string;
+    eventPresets?: string;
+    scheduleScope?: string;
+    seriesId?: string;
+    seriesSlug?: string;
+    includeOccurrenceId?: string;
+    detailLevel?: string;
+    readProfile?: string;
+};
+export type NewsletterSignupPublicDestinationRef = {
+    tag: 'block_ref';
+    blockId: string;
+} | {
+    tag: 'signed_destination_ref';
+    token: string;
+};
+export type NewsletterSubscribeTarget = {
+    tag: 'legacy_riverbank_list';
+    listId: string;
+    destinationRef?: NewsletterSignupPublicDestinationRef;
+} | {
+    tag: 'published_block_ref';
+    destinationRef: NewsletterSignupPublicDestinationRef;
+};
+type NewsletterSubscribeFields = {
+    email: string;
+    firstName?: string | null;
+    lastName?: string | null;
+    name?: string | null;
+    company?: string | null;
+    phone?: string | null;
+    tags?: string[];
+    meta?: {
+        honeypot?: string;
+        altchaSolution?: string | null;
+    };
+};
+export type NewsletterSubscribeBody = NewsletterSubscribeFields & ({
+    target: NewsletterSubscribeTarget;
+} | {
+    listId: string;
+    destinationRef?: NewsletterSignupPublicDestinationRef;
+});
+export type PublicEventScheduleScope = 'any' | 'recurring' | 'oneOff';
+export type PublicEventRecurrence = Readonly<{
+    kind: 'weekly';
+    interval: number;
+    weekdays: ReadonlyArray<'MO' | 'TU' | 'WE' | 'TH' | 'FR' | 'SA' | 'SU'>;
+}> | Readonly<{
+    kind: 'other';
+}>;
+export type PublicEventSurfaceScope = 'all' | 'regularClassSchedule' | 'specialDatedEvents' | 'custom';
+export type PublicEventDetailsLoaderParams = Omit<PublicEventLoaderParams, 'detailLevel' | 'readProfile'>;
+export type PublicRouteCandidate = Readonly<{
+    entityId: string;
+    path: string;
+    title: string;
+    kind: 'page' | 'content';
+    contentTypeKey?: string | null;
+}>;
+type PublicEventDiscountContext = {
+    type: 'event';
+    eventSeriesId: string;
+    eventCategoryId: string | null;
+    ticketsCount?: number;
+};
+type PublicProductDiscountContext = {
+    type: 'product';
+    productId: string;
+    productCategoryId: string | null;
+};
+export type PublicDiscountContext = PublicEventDiscountContext | {
+    type: 'appointment';
+    serviceId: string;
+} | {
+    type: 'whole_series';
+    eventSeriesId: string;
+} | {
+    type: 'pass';
+    passId: string;
+} | {
+    type: 'membership';
+    membershipId: string;
+} | PublicProductDiscountContext;
+export type WholeSeriesEligibilityResponse = {
+    eventSeriesId: string;
+    canEnroll: boolean;
+    canJoinWaitlist: boolean;
+    reason?: string;
+    availableSpots: number | null;
+    isFull: boolean;
+    isOnWaitlist: boolean;
+    waitlistEnabled: boolean;
+    price: {
+        cents: number | null;
+        currency: string;
+    };
+    paymentOptions: {
+        free: boolean;
+        membership: boolean;
+        stripe: boolean;
+    };
+    eligibleMemberships?: Array<{
+        customerMembershipId: string;
+        membershipName: string;
+    }>;
+};
+export type DiscountsAvailableResponse = Readonly<{
+    type: 'none';
+}> | Readonly<{
+    type: 'manual';
+    manualCodeEntryAllowed: true;
+}> | Readonly<{
+    type: 'auto';
+    manualCodeEntryAllowed: false;
+    autoAppliedDiscount: AutoAppliedDiscountPreview;
+}> | Readonly<{
+    type: 'auto_and_manual';
+    manualCodeEntryAllowed: true;
+    autoAppliedDiscount: AutoAppliedDiscountPreview;
+}>;

package/dist/_dts/api/src/publicExperience/siteEndpoints.d.ts

@@ -0,0 +1,95 @@
+/**
+ * Public site-level endpoints: team members, block loaders, icons and route resolution.
+ *
+ * Merged into `PublicExperienceAPIEndpoints` by `../publicExperienceEndpoints`.
+ */
+import type { APIEndpoint } from '../apiEndpointTypes';
+import type { PublicTeamMemberBlockItem } from '../teamMembers';
+import type { GeneratedIconRenderAssetsRequest, GeneratedIconRenderAssetsResponse } from '../siteIcons';
+import type { PublicEventDetailsLoaderParams, PublicEventLoaderParams } from './sharedTypes';
+export type PublicSiteAPIEndpoints = {
+    listPublicTeamMembers: APIEndpoint<never, {
+        siteId: string;
+        stage?: string;
+    }, {
+        teamMembers: PublicTeamMemberBlockItem[];
+    }>;
+    batchBlockLoaders: APIEndpoint<{
+        requests: Array<{
+            id: string;
+            endpoint: 'listPublicEvents';
+            params?: PublicEventLoaderParams;
+        } | {
+            id: string;
+            endpoint: 'getPublicEventDetails';
+            params?: PublicEventDetailsLoaderParams;
+        } | {
+            id: string;
+            endpoint: 'listPublicWholeSeriesOfferings';
+            params?: {
+                limit?: string;
+            };
+        } | {
+            id: string;
+            endpoint: 'listPublicTeamMembers';
+            params?: {
+                siteId?: string;
+                stage?: string;
+            };
+        } | {
+            id: string;
+            endpoint: 'listPublicRouteCandidates';
+            params?: never;
+        } | {
+            id: string;
+            endpoint: 'listPublicProducts';
+            params?: {
+                categorySelector?: {
+                    kind: 'category';
+                    productCategoryId: string;
+                } | {
+                    kind: 'current-category-page';
+                    productCategoryEntryId: string;
+                };
+            };
+        } | {
+            id: string;
+            endpoint: 'getPublicBookingServices';
+            params?: {
+                ids?: string;
+            };
+        } | {
+            id: string;
+            endpoint: 'getPublicWeeklySlotAvailability';
+            params: {
+                serviceId: string;
+                resourceId?: string;
+                horizonWeeks?: number;
+                timezone?: string;
+            };
+        } | {
+            id: string;
+            endpoint: 'getPublicFormById';
+            params: {
+                formId: string;
+            };
+        }>;
+    }, {
+        siteId: string;
+        stage?: string;
+    }, {
+        results: Record<string, {
+            ok: true;
+            data: unknown;
+        } | {
+            ok: false;
+            error: {
+                code: string;
+                message: string;
+            };
+        }>;
+    }>;
+    getGeneratedIconRenderAssets: APIEndpoint<GeneratedIconRenderAssetsRequest, {
+        siteId: string;
+    }, GeneratedIconRenderAssetsResponse>;
+};

package/dist/_dts/api/src/publicExperience/wholeSeriesEndpoints.d.ts

@@ -0,0 +1,154 @@
+/**
+ * Public whole-series listing, registration, eligibility and checkout endpoints.
+ *
+ * Merged into `PublicExperienceAPIEndpoints` by `../publicExperienceEndpoints`.
+ */
+import type { APIEndpoint } from '../apiEndpointTypes';
+import type { BookingPaymentTermsConfig, BookingPricing } from '../bookingConfig';
+import type { PublicCourseDetails } from '../courses';
+import type { PublicTeamMemberSummary } from '../teamMembers';
+import type { WholeSeriesEligibilityResponse } from './sharedTypes';
+export type PublicWholeSeriesAPIEndpoints = {
+    listPublicWholeSeriesOfferings: APIEndpoint<never, {
+        siteId: string;
+        limit?: string;
+        stage?: string;
+    }, Array<{
+        eventSeriesId: string;
+        eventOfferingId: string;
+        title: string;
+        slug: string;
+        description: unknown;
+        teamMembers?: PublicTeamMemberSummary[];
+        enrollmentOpen: boolean;
+        pricing: BookingPricing;
+        currency: string;
+        paymentTerms: BookingPaymentTermsConfig;
+        enrollmentCapacity: number | null;
+        acceptsMemberships: boolean;
+        status: string;
+        sessionsCount: number;
+        enrolledCount: number;
+        availableSpots: number | null;
+        sessions: Array<{
+            id: string;
+            startsAt: string;
+            endsAt: string;
+            timeZone: string;
+            capacityOverride?: number | null;
+            overrides?: Record<string, unknown> | null;
+        }>;
+        venue: {
+            id: string;
+            name: string;
+            address: string | null;
+        } | null;
+    }>>;
+    getPublicWholeSeriesOffering: APIEndpoint<never, {
+        siteId: string;
+        eventSeriesId: string;
+        stage?: string;
+    }, {
+        offering: PublicCourseDetails;
+    }>;
+    registerForWholeSeries: APIEndpoint<{
+        eventSeriesId: string;
+        pricingOptionId?: string;
+        selectedSlidingAmount?: number;
+        email: string;
+        name: string;
+        phone?: string;
+        formData?: Record<string, unknown>;
+        altchaSolution?: string | null;
+        stage?: 'preview' | 'published';
+        paymentMethod?: 'free' | 'membership';
+        customerMembershipId?: string;
+        claimToken?: string;
+    }, {
+        siteId: string;
+    }, {
+        enrollmentId: string;
+        status: 'enrolled';
+        waitlistPosition?: number | null;
+        courseTitle: string;
+        sessionsCount: number;
+        paymentMethod: 'free' | 'membership' | 'stripe';
+        pendingPayment: boolean;
+        message: string;
+    } | {
+        status: 'waitlist';
+        waitlistPosition?: number | null;
+        courseTitle: string;
+        sessionsCount: number;
+        paymentMethod: 'free';
+        pendingPayment: false;
+        message: string;
+    }>;
+    resolveWaitlistClaim: APIEndpoint<{
+        claimToken: string;
+    }, {
+        siteId: string;
+    }, {
+        subject: {
+            kind: 'event_occurrence';
+            occurrenceId: string;
+        } | {
+            kind: 'whole_series';
+            eventSeriesId: string;
+        };
+        expiresAt: string;
+        customer: {
+            email: string;
+            name: string;
+            phone: string | null;
+        };
+        prefill: {
+            email: string;
+            name: string;
+            phone: string | null;
+            notes: string | null;
+            guests: Array<{
+                name: string;
+                email?: string | null;
+                phone: string | null;
+            }>;
+        };
+    }>;
+    checkWholeSeriesEligibility: APIEndpoint<{
+        eventSeriesId: string;
+    }, {
+        siteId: string;
+    }, WholeSeriesEligibilityResponse>;
+    createWholeSeriesCheckout: APIEndpoint<{
+        eventSeriesId: string;
+        pricingOptionId?: string;
+        selectedSlidingAmount?: number;
+        email: string;
+        name: string;
+        phone?: string;
+        formData?: Record<string, unknown>;
+        altchaSolution?: string | null;
+        discountCode?: string;
+        successUrl: string;
+        cancelUrl: string;
+        claimToken?: string;
+    }, {
+        siteId: string;
+    }, {
+        checkoutUrl: string | null;
+        sessionId: string | null;
+        enrollmentId: string;
+        bypassed: boolean;
+    }>;
+    getWholeSeriesRegistrationStatus: APIEndpoint<never, {
+        siteId: string;
+        sessionId: string;
+    }, {
+        enrollmentId: string;
+        eventSeriesId: string;
+        courseTitle: string;
+        status: 'pending_payment' | 'enrolled' | 'waitlist' | 'cancelled' | 'completed';
+        paymentMethod: 'free' | 'membership' | 'stripe' | null;
+        paymentStatus: 'pending' | 'completed' | 'failed' | 'not_required' | 'refunded' | null;
+    }>;
+};