@voyant-travel/catalog-react 0.117.2

package/dist/booking-engine/use-booking-quote.d.ts

@@ -0,0 +1,711 @@
+import { type BookingDraftV1 } from "@voyant-travel/catalog-contracts/booking-engine/contracts";
+import { type BookingJourneyApiOptions } from "./use-booking-journey-api.js";
+export interface UseBookingQuoteOptions extends BookingJourneyApiOptions {
+    draft: BookingDraftV1 | null;
+    /** Locale / audience / market scope — defaults sensible per surface. */
+    scope?: {
+        locale?: string;
+        audience?: "staff" | "customer" | "partner" | "supplier";
+        market?: string;
+        currency?: string;
+    };
+    /** Debounce window in ms — default 250 (per booking-journey-architecture §5). */
+    debounceMs?: number;
+    /** Disable auto-refetch — caller drives via `mutate()`. */
+    enabled?: boolean;
+}
+/**
+ * Live-quote a draft. Re-fetches on every meaningful draft change,
+ * with a 250ms debounce. Per booking-journey-architecture §5.
+ *
+ * Returns:
+ *   - `data`         — the latest QuoteResponseV1 (or `null` while loading)
+ *   - `isQuoting`    — true while a fetch is in flight
+ *   - `requote`      — manual trigger (e.g. for "refresh price" buttons)
+ */
+export declare function useBookingQuote(options: UseBookingQuoteOptions): {
+    data: {
+        quoteId: string;
+        quotedAt: string;
+        expiresAt: string;
+        available: boolean;
+        invalidReason?: string | undefined;
+        shape?: {
+            showsConfigure: boolean;
+            showsBilling: boolean;
+            showsTravelers: boolean;
+            showsAccommodation: boolean;
+            showsAddons: boolean;
+            showsPayment: boolean;
+            showsReview: true;
+            paxBands: {
+                code: string;
+                label: string;
+                minCount: number;
+                maxCount: number;
+                minAge?: number | undefined;
+                maxAge?: number | undefined;
+            }[];
+            paxBandsAllowedTotal: {
+                min: number;
+                max: number;
+            };
+            travelerFields: {
+                key: string;
+                label: string;
+                type: string;
+                required: boolean;
+                options?: {
+                    value: string;
+                    label: string;
+                }[] | undefined;
+                appliesToBands?: string[] | undefined;
+            }[];
+            bookingFields: {
+                key: string;
+                label: string;
+                type: string;
+                required: boolean;
+                group: "billing" | "company" | "preferences";
+            }[];
+            paymentIntents: ("card" | "hold" | "bank_transfer" | "ticket_on_credit" | "inquiry")[];
+            configureSubSteps?: ({
+                kind: "departure";
+                required: true;
+            } | {
+                kind: "product-option";
+                options: {
+                    id: string;
+                    name: string;
+                    code?: string | null | undefined;
+                    description?: string | null | undefined;
+                    isDefault?: boolean | undefined;
+                    units?: {
+                        id: string;
+                        name: string;
+                        description?: string | null | undefined;
+                        unitType?: string | null | undefined;
+                        minQuantity?: number | null | undefined;
+                        maxQuantity?: number | null | undefined;
+                    }[] | undefined;
+                }[];
+            } | {
+                kind: "option-units";
+            } | {
+                kind: "cabin-category";
+                categories: {
+                    id: string;
+                    name: string;
+                    code?: string | undefined;
+                    type?: string | undefined;
+                    capacityMin?: number | undefined;
+                    capacityMax?: number | undefined;
+                    description?: string | undefined;
+                }[];
+            } | {
+                kind: "cabin-number";
+                perCategory: Record<string, {
+                    id: string;
+                    label: string;
+                    code?: string | undefined;
+                    capacity?: number | undefined;
+                    hasAccessibilityFeatures?: boolean | undefined;
+                }[]>;
+            } | {
+                kind: "date-range";
+                minNights: number;
+                maxNights: number;
+            } | {
+                kind: "occupancy";
+                bands: {
+                    code: string;
+                    label: string;
+                    minCount: number;
+                    maxCount: number;
+                    minAge?: number | undefined;
+                    maxAge?: number | undefined;
+                }[];
+            } | {
+                kind: "air-arrangement";
+                required?: boolean | undefined;
+            })[] | undefined;
+            paxBandDependencies?: {
+                dependentCode: string;
+                masterCode: string;
+                type: "requires" | "limits_per_master" | "limits_sum" | "excludes";
+                maxPerMaster?: number | undefined;
+                maxDependentSum?: number | undefined;
+            }[] | undefined;
+            accommodation?: {
+                sharedRoomAllowed: boolean;
+                roomOptions?: {
+                    id: string;
+                    name: string;
+                    description?: string | null | undefined;
+                    capacity?: number | null | undefined;
+                    baseRateHint?: number | null | undefined;
+                    ratePlans?: {
+                        id: string;
+                        name: string;
+                        description?: string | null | undefined;
+                        chargeFrequency?: "per_night" | "per_stay" | undefined;
+                        cancellationPolicy?: string | null | undefined;
+                        inclusions?: string[] | undefined;
+                        currency?: string | undefined;
+                    }[] | undefined;
+                }[] | undefined;
+                subSteps?: ({
+                    kind: "rooms";
+                    options: {
+                        id: string;
+                        name: string;
+                        description?: string | null | undefined;
+                        capacity?: number | null | undefined;
+                        baseRateHint?: number | null | undefined;
+                        ratePlans?: {
+                            id: string;
+                            name: string;
+                            description?: string | null | undefined;
+                            chargeFrequency?: "per_night" | "per_stay" | undefined;
+                            cancellationPolicy?: string | null | undefined;
+                            inclusions?: string[] | undefined;
+                            currency?: string | undefined;
+                        }[] | undefined;
+                    }[];
+                    sharedRoomAllowed: boolean;
+                } | {
+                    kind: "extensions";
+                    options: {
+                        id: string;
+                        name: string;
+                        side: "pre" | "post";
+                        city?: string | null | undefined;
+                        nights?: number | null | undefined;
+                        pricePerPersonHint?: number | null | undefined;
+                    }[];
+                    allowsPre: boolean;
+                    allowsPost: boolean;
+                })[] | undefined;
+            } | undefined;
+            addons?: {
+                catalog?: {
+                    id: string;
+                    name: string;
+                    kind: "extras" | "excursions" | "insurance";
+                    description?: string | null | undefined;
+                    groupKey?: string | null | undefined;
+                    pricingMode?: string | null | undefined;
+                    unitAmountCents?: number | null | undefined;
+                    currency?: string | null | undefined;
+                    pricedPerPerson?: boolean | null | undefined;
+                    selectionType?: "optional" | "required" | "unavailable" | "default_selected" | null | undefined;
+                    minQuantity?: number | null | undefined;
+                    maxQuantity?: number | null | undefined;
+                    defaultQuantity?: number | null | undefined;
+                }[] | undefined;
+                groups?: {
+                    kind: "extras" | "excursions" | "insurance";
+                    label: string;
+                    perGuestSelection: boolean;
+                    items: {
+                        id: string;
+                        name: string;
+                        kind: "extras" | "excursions" | "insurance";
+                        description?: string | null | undefined;
+                        groupKey?: string | null | undefined;
+                        pricingMode?: string | null | undefined;
+                        unitAmountCents?: number | null | undefined;
+                        currency?: string | null | undefined;
+                        pricedPerPerson?: boolean | null | undefined;
+                        selectionType?: "optional" | "required" | "unavailable" | "default_selected" | null | undefined;
+                        minQuantity?: number | null | undefined;
+                        maxQuantity?: number | null | undefined;
+                        defaultQuantity?: number | null | undefined;
+                    }[];
+                    groupBy?: "day" | "port" | undefined;
+                }[] | undefined;
+            } | undefined;
+        } | undefined;
+        pricing?: {
+            currency: string;
+            lines: {
+                kind: "base" | "accommodation" | "fee" | "discount" | "addon" | "supplement";
+                label: string;
+                unitAmount: number;
+                totalAmount: number;
+                quantity?: number | undefined;
+                taxIncluded?: boolean | undefined;
+            }[];
+            taxes: {
+                code: string;
+                label: string;
+                rate: number;
+                amount: number;
+                base: number;
+                includedInPrice?: boolean | undefined;
+                scope?: "included" | "excluded" | "withheld" | undefined;
+            }[];
+            subtotal: number;
+            taxTotal: number;
+            total: number;
+        } | undefined;
+        upstreamPayload?: Record<string, unknown> | undefined;
+    } | null;
+    isQuoting: boolean;
+    error: Error | null;
+    requote: () => Promise<{
+        quoteId: string;
+        quotedAt: string;
+        expiresAt: string;
+        available: boolean;
+        invalidReason?: string | undefined;
+        shape?: {
+            showsConfigure: boolean;
+            showsBilling: boolean;
+            showsTravelers: boolean;
+            showsAccommodation: boolean;
+            showsAddons: boolean;
+            showsPayment: boolean;
+            showsReview: true;
+            paxBands: {
+                code: string;
+                label: string;
+                minCount: number;
+                maxCount: number;
+                minAge?: number | undefined;
+                maxAge?: number | undefined;
+            }[];
+            paxBandsAllowedTotal: {
+                min: number;
+                max: number;
+            };
+            travelerFields: {
+                key: string;
+                label: string;
+                type: string;
+                required: boolean;
+                options?: {
+                    value: string;
+                    label: string;
+                }[] | undefined;
+                appliesToBands?: string[] | undefined;
+            }[];
+            bookingFields: {
+                key: string;
+                label: string;
+                type: string;
+                required: boolean;
+                group: "billing" | "company" | "preferences";
+            }[];
+            paymentIntents: ("card" | "hold" | "bank_transfer" | "ticket_on_credit" | "inquiry")[];
+            configureSubSteps?: ({
+                kind: "departure";
+                required: true;
+            } | {
+                kind: "product-option";
+                options: {
+                    id: string;
+                    name: string;
+                    code?: string | null | undefined;
+                    description?: string | null | undefined;
+                    isDefault?: boolean | undefined;
+                    units?: {
+                        id: string;
+                        name: string;
+                        description?: string | null | undefined;
+                        unitType?: string | null | undefined;
+                        minQuantity?: number | null | undefined;
+                        maxQuantity?: number | null | undefined;
+                    }[] | undefined;
+                }[];
+            } | {
+                kind: "option-units";
+            } | {
+                kind: "cabin-category";
+                categories: {
+                    id: string;
+                    name: string;
+                    code?: string | undefined;
+                    type?: string | undefined;
+                    capacityMin?: number | undefined;
+                    capacityMax?: number | undefined;
+                    description?: string | undefined;
+                }[];
+            } | {
+                kind: "cabin-number";
+                perCategory: Record<string, {
+                    id: string;
+                    label: string;
+                    code?: string | undefined;
+                    capacity?: number | undefined;
+                    hasAccessibilityFeatures?: boolean | undefined;
+                }[]>;
+            } | {
+                kind: "date-range";
+                minNights: number;
+                maxNights: number;
+            } | {
+                kind: "occupancy";
+                bands: {
+                    code: string;
+                    label: string;
+                    minCount: number;
+                    maxCount: number;
+                    minAge?: number | undefined;
+                    maxAge?: number | undefined;
+                }[];
+            } | {
+                kind: "air-arrangement";
+                required?: boolean | undefined;
+            })[] | undefined;
+            paxBandDependencies?: {
+                dependentCode: string;
+                masterCode: string;
+                type: "requires" | "limits_per_master" | "limits_sum" | "excludes";
+                maxPerMaster?: number | undefined;
+                maxDependentSum?: number | undefined;
+            }[] | undefined;
+            accommodation?: {
+                sharedRoomAllowed: boolean;
+                roomOptions?: {
+                    id: string;
+                    name: string;
+                    description?: string | null | undefined;
+                    capacity?: number | null | undefined;
+                    baseRateHint?: number | null | undefined;
+                    ratePlans?: {
+                        id: string;
+                        name: string;
+                        description?: string | null | undefined;
+                        chargeFrequency?: "per_night" | "per_stay" | undefined;
+                        cancellationPolicy?: string | null | undefined;
+                        inclusions?: string[] | undefined;
+                        currency?: string | undefined;
+                    }[] | undefined;
+                }[] | undefined;
+                subSteps?: ({
+                    kind: "rooms";
+                    options: {
+                        id: string;
+                        name: string;
+                        description?: string | null | undefined;
+                        capacity?: number | null | undefined;
+                        baseRateHint?: number | null | undefined;
+                        ratePlans?: {
+                            id: string;
+                            name: string;
+                            description?: string | null | undefined;
+                            chargeFrequency?: "per_night" | "per_stay" | undefined;
+                            cancellationPolicy?: string | null | undefined;
+                            inclusions?: string[] | undefined;
+                            currency?: string | undefined;
+                        }[] | undefined;
+                    }[];
+                    sharedRoomAllowed: boolean;
+                } | {
+                    kind: "extensions";
+                    options: {
+                        id: string;
+                        name: string;
+                        side: "pre" | "post";
+                        city?: string | null | undefined;
+                        nights?: number | null | undefined;
+                        pricePerPersonHint?: number | null | undefined;
+                    }[];
+                    allowsPre: boolean;
+                    allowsPost: boolean;
+                })[] | undefined;
+            } | undefined;
+            addons?: {
+                catalog?: {
+                    id: string;
+                    name: string;
+                    kind: "extras" | "excursions" | "insurance";
+                    description?: string | null | undefined;
+                    groupKey?: string | null | undefined;
+                    pricingMode?: string | null | undefined;
+                    unitAmountCents?: number | null | undefined;
+                    currency?: string | null | undefined;
+                    pricedPerPerson?: boolean | null | undefined;
+                    selectionType?: "optional" | "required" | "unavailable" | "default_selected" | null | undefined;
+                    minQuantity?: number | null | undefined;
+                    maxQuantity?: number | null | undefined;
+                    defaultQuantity?: number | null | undefined;
+                }[] | undefined;
+                groups?: {
+                    kind: "extras" | "excursions" | "insurance";
+                    label: string;
+                    perGuestSelection: boolean;
+                    items: {
+                        id: string;
+                        name: string;
+                        kind: "extras" | "excursions" | "insurance";
+                        description?: string | null | undefined;
+                        groupKey?: string | null | undefined;
+                        pricingMode?: string | null | undefined;
+                        unitAmountCents?: number | null | undefined;
+                        currency?: string | null | undefined;
+                        pricedPerPerson?: boolean | null | undefined;
+                        selectionType?: "optional" | "required" | "unavailable" | "default_selected" | null | undefined;
+                        minQuantity?: number | null | undefined;
+                        maxQuantity?: number | null | undefined;
+                        defaultQuantity?: number | null | undefined;
+                    }[];
+                    groupBy?: "day" | "port" | undefined;
+                }[] | undefined;
+            } | undefined;
+        } | undefined;
+        pricing?: {
+            currency: string;
+            lines: {
+                kind: "base" | "accommodation" | "fee" | "discount" | "addon" | "supplement";
+                label: string;
+                unitAmount: number;
+                totalAmount: number;
+                quantity?: number | undefined;
+                taxIncluded?: boolean | undefined;
+            }[];
+            taxes: {
+                code: string;
+                label: string;
+                rate: number;
+                amount: number;
+                base: number;
+                includedInPrice?: boolean | undefined;
+                scope?: "included" | "excluded" | "withheld" | undefined;
+            }[];
+            subtotal: number;
+            taxTotal: number;
+            total: number;
+        } | undefined;
+        upstreamPayload?: Record<string, unknown> | undefined;
+    }>;
+    refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
+        quoteId: string;
+        quotedAt: string;
+        expiresAt: string;
+        available: boolean;
+        invalidReason?: string | undefined;
+        shape?: {
+            showsConfigure: boolean;
+            showsBilling: boolean;
+            showsTravelers: boolean;
+            showsAccommodation: boolean;
+            showsAddons: boolean;
+            showsPayment: boolean;
+            showsReview: true;
+            paxBands: {
+                code: string;
+                label: string;
+                minCount: number;
+                maxCount: number;
+                minAge?: number | undefined;
+                maxAge?: number | undefined;
+            }[];
+            paxBandsAllowedTotal: {
+                min: number;
+                max: number;
+            };
+            travelerFields: {
+                key: string;
+                label: string;
+                type: string;
+                required: boolean;
+                options?: {
+                    value: string;
+                    label: string;
+                }[] | undefined;
+                appliesToBands?: string[] | undefined;
+            }[];
+            bookingFields: {
+                key: string;
+                label: string;
+                type: string;
+                required: boolean;
+                group: "billing" | "company" | "preferences";
+            }[];
+            paymentIntents: ("card" | "hold" | "bank_transfer" | "ticket_on_credit" | "inquiry")[];
+            configureSubSteps?: ({
+                kind: "departure";
+                required: true;
+            } | {
+                kind: "product-option";
+                options: {
+                    id: string;
+                    name: string;
+                    code?: string | null | undefined;
+                    description?: string | null | undefined;
+                    isDefault?: boolean | undefined;
+                    units?: {
+                        id: string;
+                        name: string;
+                        description?: string | null | undefined;
+                        unitType?: string | null | undefined;
+                        minQuantity?: number | null | undefined;
+                        maxQuantity?: number | null | undefined;
+                    }[] | undefined;
+                }[];
+            } | {
+                kind: "option-units";
+            } | {
+                kind: "cabin-category";
+                categories: {
+                    id: string;
+                    name: string;
+                    code?: string | undefined;
+                    type?: string | undefined;
+                    capacityMin?: number | undefined;
+                    capacityMax?: number | undefined;
+                    description?: string | undefined;
+                }[];
+            } | {
+                kind: "cabin-number";
+                perCategory: Record<string, {
+                    id: string;
+                    label: string;
+                    code?: string | undefined;
+                    capacity?: number | undefined;
+                    hasAccessibilityFeatures?: boolean | undefined;
+                }[]>;
+            } | {
+                kind: "date-range";
+                minNights: number;
+                maxNights: number;
+            } | {
+                kind: "occupancy";
+                bands: {
+                    code: string;
+                    label: string;
+                    minCount: number;
+                    maxCount: number;
+                    minAge?: number | undefined;
+                    maxAge?: number | undefined;
+                }[];
+            } | {
+                kind: "air-arrangement";
+                required?: boolean | undefined;
+            })[] | undefined;
+            paxBandDependencies?: {
+                dependentCode: string;
+                masterCode: string;
+                type: "requires" | "limits_per_master" | "limits_sum" | "excludes";
+                maxPerMaster?: number | undefined;
+                maxDependentSum?: number | undefined;
+            }[] | undefined;
+            accommodation?: {
+                sharedRoomAllowed: boolean;
+                roomOptions?: {
+                    id: string;
+                    name: string;
+                    description?: string | null | undefined;
+                    capacity?: number | null | undefined;
+                    baseRateHint?: number | null | undefined;
+                    ratePlans?: {
+                        id: string;
+                        name: string;
+                        description?: string | null | undefined;
+                        chargeFrequency?: "per_night" | "per_stay" | undefined;
+                        cancellationPolicy?: string | null | undefined;
+                        inclusions?: string[] | undefined;
+                        currency?: string | undefined;
+                    }[] | undefined;
+                }[] | undefined;
+                subSteps?: ({
+                    kind: "rooms";
+                    options: {
+                        id: string;
+                        name: string;
+                        description?: string | null | undefined;
+                        capacity?: number | null | undefined;
+                        baseRateHint?: number | null | undefined;
+                        ratePlans?: {
+                            id: string;
+                            name: string;
+                            description?: string | null | undefined;
+                            chargeFrequency?: "per_night" | "per_stay" | undefined;
+                            cancellationPolicy?: string | null | undefined;
+                            inclusions?: string[] | undefined;
+                            currency?: string | undefined;
+                        }[] | undefined;
+                    }[];
+                    sharedRoomAllowed: boolean;
+                } | {
+                    kind: "extensions";
+                    options: {
+                        id: string;
+                        name: string;
+                        side: "pre" | "post";
+                        city?: string | null | undefined;
+                        nights?: number | null | undefined;
+                        pricePerPersonHint?: number | null | undefined;
+                    }[];
+                    allowsPre: boolean;
+                    allowsPost: boolean;
+                })[] | undefined;
+            } | undefined;
+            addons?: {
+                catalog?: {
+                    id: string;
+                    name: string;
+                    kind: "extras" | "excursions" | "insurance";
+                    description?: string | null | undefined;
+                    groupKey?: string | null | undefined;
+                    pricingMode?: string | null | undefined;
+                    unitAmountCents?: number | null | undefined;
+                    currency?: string | null | undefined;
+                    pricedPerPerson?: boolean | null | undefined;
+                    selectionType?: "optional" | "required" | "unavailable" | "default_selected" | null | undefined;
+                    minQuantity?: number | null | undefined;
+                    maxQuantity?: number | null | undefined;
+                    defaultQuantity?: number | null | undefined;
+                }[] | undefined;
+                groups?: {
+                    kind: "extras" | "excursions" | "insurance";
+                    label: string;
+                    perGuestSelection: boolean;
+                    items: {
+                        id: string;
+                        name: string;
+                        kind: "extras" | "excursions" | "insurance";
+                        description?: string | null | undefined;
+                        groupKey?: string | null | undefined;
+                        pricingMode?: string | null | undefined;
+                        unitAmountCents?: number | null | undefined;
+                        currency?: string | null | undefined;
+                        pricedPerPerson?: boolean | null | undefined;
+                        selectionType?: "optional" | "required" | "unavailable" | "default_selected" | null | undefined;
+                        minQuantity?: number | null | undefined;
+                        maxQuantity?: number | null | undefined;
+                        defaultQuantity?: number | null | undefined;
+                    }[];
+                    groupBy?: "day" | "port" | undefined;
+                }[] | undefined;
+            } | undefined;
+        } | undefined;
+        pricing?: {
+            currency: string;
+            lines: {
+                kind: "base" | "accommodation" | "fee" | "discount" | "addon" | "supplement";
+                label: string;
+                unitAmount: number;
+                totalAmount: number;
+                quantity?: number | undefined;
+                taxIncluded?: boolean | undefined;
+            }[];
+            taxes: {
+                code: string;
+                label: string;
+                rate: number;
+                amount: number;
+                base: number;
+                includedInPrice?: boolean | undefined;
+                scope?: "included" | "excluded" | "withheld" | undefined;
+            }[];
+            subtotal: number;
+            taxTotal: number;
+            total: number;
+        } | undefined;
+        upstreamPayload?: Record<string, unknown> | undefined;
+    } | null, Error>>;
+};
+//# sourceMappingURL=use-booking-quote.d.ts.map