@voyant-travel/catalog-react 0.117.2

package/dist/hooks/use-catalog-offers.js

@@ -0,0 +1,105 @@
+"use client";
+import { keepPreviousData, useQuery } from "@tanstack/react-query";
+import { fetchCatalogSlots, fetchCruiseContent, fetchCruisePrice, fetchCruiseSailingPricing, fetchDepartureAirports, fetchPackageDetail, fetchPackageSearch, } from "../catalog-offers-client.js";
+import { useVoyantCatalogContext } from "../provider.js";
+/**
+ * Departure airports for a destination — probed before a full availability
+ * search so the operator can pick where they fly from.
+ */
+export function useDepartureAirports(options) {
+    const { baseUrl, fetcher } = useVoyantCatalogContext();
+    const { countryCode, surface = "admin", enabled = true, staleTime = 60_000 } = options;
+    return useQuery({
+        queryKey: ["catalog-departure-airports", surface, countryCode],
+        queryFn: ({ signal }) => fetchDepartureAirports({ baseUrl, fetcher, surface }, { countryCode }, signal),
+        enabled: enabled && !!countryCode,
+        staleTime,
+    });
+}
+/** Dynamic package search by destination/dates/occupancy → live offers. */
+export function usePackageSearch(options) {
+    const { baseUrl, fetcher } = useVoyantCatalogContext();
+    const { countryCode, departureDateFrom, departureDateTo, adults, nights, surface = "admin", enabled = true, staleTime = 30_000, } = options;
+    return useQuery({
+        queryKey: [
+            "catalog-package-search",
+            surface,
+            countryCode,
+            departureDateFrom,
+            departureDateTo,
+            adults,
+            nights.min,
+            nights.max,
+        ],
+        queryFn: ({ signal }) => fetchPackageSearch({ baseUrl, fetcher, surface }, { countryCode, departureDateFrom, departureDateTo, adults, nights }, signal),
+        enabled: enabled && !!countryCode,
+        staleTime,
+        placeholderData: keepPreviousData,
+    });
+}
+/** Full product detail (source content + live dated offers). */
+export function usePackageDetail(options) {
+    const { baseUrl, fetcher } = useVoyantCatalogContext();
+    const { productId, departureDateFrom, departureDateTo, adults, nights, locale, surface = "admin", enabled = true, staleTime = 30_000, } = options;
+    return useQuery({
+        queryKey: [
+            "catalog-package-detail",
+            surface,
+            productId,
+            departureDateFrom,
+            departureDateTo,
+            adults,
+            nights.min,
+            nights.max,
+            locale,
+        ],
+        queryFn: ({ signal }) => fetchPackageDetail({ baseUrl, fetcher, surface }, { productId, departureDateFrom, departureDateTo, adults, nights, locale }, signal),
+        enabled: enabled && !!productId,
+        staleTime,
+    });
+}
+/** Cruise-level "from" price (Connect). */
+export function useCruisePrice(options) {
+    const { baseUrl, fetcher } = useVoyantCatalogContext();
+    const { cruiseId, surface = "admin", enabled = true, staleTime = 60_000 } = options;
+    return useQuery({
+        queryKey: ["catalog-cruise-price", surface, cruiseId],
+        queryFn: ({ signal }) => fetchCruisePrice({ baseUrl, fetcher, surface }, { cruiseId }, signal),
+        enabled: enabled && !!cruiseId,
+        staleTime,
+        retry: false,
+    });
+}
+/** Live per-cabin pricing for one sailing (lazy — enable on row expand). */
+export function useCruiseSailingPricing(options) {
+    const { baseUrl, fetcher } = useVoyantCatalogContext();
+    const { cruiseId, sailingRef, surface = "admin", enabled = true, staleTime = 0 } = options;
+    return useQuery({
+        queryKey: ["catalog-cruise-sailing-pricing", surface, cruiseId, sailingRef],
+        queryFn: ({ signal }) => fetchCruiseSailingPricing({ baseUrl, fetcher, surface }, { cruiseId, sailingRef }, signal),
+        enabled: enabled && !!cruiseId && !!sailingRef,
+        staleTime,
+    });
+}
+/** Rich cruise content (gallery/sailings/cabins/itinerary) from the source. */
+export function useCruiseContent(options) {
+    const { baseUrl, fetcher } = useVoyantCatalogContext();
+    const { cruiseId, locale, surface = "admin", enabled = true, staleTime = 60_000 } = options;
+    return useQuery({
+        queryKey: ["catalog-cruise-content", surface, cruiseId, locale],
+        queryFn: ({ signal }) => fetchCruiseContent({ baseUrl, fetcher, surface }, { cruiseId, locale }, signal),
+        enabled: enabled && !!cruiseId,
+        staleTime,
+    });
+}
+/** Per-departure availability slots for an entity. */
+export function useCatalogSlots(options) {
+    const { baseUrl, fetcher } = useVoyantCatalogContext();
+    const { entityModule, entityId, surface = "admin", enabled = true, staleTime = 30_000 } = options;
+    return useQuery({
+        queryKey: ["catalog-slots", surface, entityModule, entityId],
+        queryFn: ({ signal }) => fetchCatalogSlots({ baseUrl, fetcher, surface }, { entityModule, entityId }, signal),
+        enabled: enabled && !!entityId,
+        staleTime,
+    });
+}

package/dist/hooks/use-catalog-search.d.ts

@@ -0,0 +1,109 @@
+export type CatalogSearchMode = "keyword" | "hybrid" | "semantic";
+export type CatalogSearchSort = "relevance" | "price-asc" | "price-desc" | "departure-asc" | "newest";
+export type CatalogSearchProjection = "raw" | "storefront-card";
+export interface CatalogSearchFilter {
+    field: string;
+    [key: string]: any;
+}
+export interface UseCatalogSearchOptions {
+    vertical: string;
+    query?: string;
+    mode?: CatalogSearchMode;
+    sort?: CatalogSearchSort;
+    projection?: CatalogSearchProjection;
+    filters?: CatalogSearchFilter[];
+    facets?: Array<{
+        field: string;
+    }>;
+    pagination?: {
+        limit?: number;
+        cursor?: string;
+    };
+    /** Hybrid-mode rank-fusion weight (0..1). 0 keyword-only, 1 semantic-only. */
+    alpha?: number;
+    /** Cosine-distance cutoff (0..2) for semantic hits. */
+    distance_threshold?: number;
+    /** Caller-supplied query embedding (skips on-the-fly vectorization). */
+    query_embedding?: number[];
+    /** Override `defaultScope.market`. */
+    market?: string;
+    /** Override `defaultScope.locale`. */
+    locale?: string;
+    /**
+     * Surface to call against. Operator dashboards pass `"admin"`
+     * (default); storefront / partner / embedded surfaces pass
+     * `"public"`. Switches the path between
+     * `/v1/admin/catalog/search` and `/v1/public/catalog/search`.
+     */
+    surface?: "admin" | "public";
+    /** Disable the query — useful when `query` is empty and you don't want to hit the network. */
+    enabled?: boolean;
+    /** TanStack Query stale time, milliseconds. Default 30s. */
+    staleTime?: number;
+}
+export declare function useCatalogSearch(options: UseCatalogSearchOptions): import("@tanstack/react-query").UseQueryResult<{
+    vertical: string;
+    mode: "keyword" | "hybrid" | "semantic";
+    total: number;
+    hits: {
+        id: string;
+        score: number;
+        document: {
+            id: string;
+            fields: Record<string, unknown>;
+            embeddings?: Record<string, number[]> | undefined;
+            embedding_model_id?: string | undefined;
+        };
+        highlights?: Record<string, unknown> | undefined;
+    }[];
+    cards?: {
+        id: string;
+        name: string | null;
+        slug: string | null;
+        primaryCategory: {
+            id: string | null;
+            name: string | null;
+            slug: string | null;
+        } | null;
+        media: {
+            thumbnailUrl: string | null;
+            coverMediaUrl: string | null;
+        };
+        priceFrom: {
+            amountCents: number;
+            currency: string | null;
+            originalAmountCents: number | null;
+        } | null;
+        offerBadges: {
+            id: string | null;
+            name: string | null;
+            discountKind: string | null;
+            discountPercent: number | null;
+            discountAmountCents: number | null;
+            minPax?: number | null | undefined;
+        }[];
+        departures: {
+            upcomingCount: number | null;
+            nextDepartureAt: string | null;
+            nextDepartureDate: string | null;
+            months: string[];
+            dates: string[];
+        };
+        destinations: {
+            regions: string[];
+            countries: string[];
+            cities: string[];
+            ids: string[];
+            slugs: string[];
+        };
+        coordinates: {
+            latitude: number;
+            longitude: number;
+        } | null;
+    }[] | undefined;
+    facets?: Record<string, {
+        value: string | number;
+        count: number;
+    }[]> | undefined;
+}, Error>;
+//# sourceMappingURL=use-catalog-search.d.ts.map

package/dist/hooks/use-catalog-search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-catalog-search.d.ts","sourceRoot":"","sources":["../../src/hooks/use-catalog-search.ts"],"names":[],"mappings":"AAQA,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,CAAA;AACjE,MAAM,MAAM,iBAAiB,GACzB,WAAW,GACX,WAAW,GACX,YAAY,GACZ,eAAe,GACf,QAAQ,CAAA;AACZ,MAAM,MAAM,uBAAuB,GAAG,KAAK,GAAG,iBAAiB,CAAA;AAE/D,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAA;IAEb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,iBAAiB,CAAA;IACxB,IAAI,CAAC,EAAE,iBAAiB,CAAA;IACxB,UAAU,CAAC,EAAE,uBAAuB,CAAA;IACpC,OAAO,CAAC,EAAE,mBAAmB,EAAE,CAAA;IAC/B,MAAM,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACjC,UAAU,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAChD,8EAA8E;IAC9E,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,uDAAuD;IACvD,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,wEAAwE;IACxE,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAA;IAC5B,8FAA8F;IAC9F,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAsEhE"}

package/dist/hooks/use-catalog-search.js

@@ -0,0 +1,52 @@
+"use client";
+import { keepPreviousData, useQuery } from "@tanstack/react-query";
+import { fetchWithValidation } from "../client.js";
+import { useVoyantCatalogContext } from "../provider.js";
+import { catalogSearchResponseSchema } from "../schemas.js";
+export function useCatalogSearch(options) {
+    const { baseUrl, fetcher } = useVoyantCatalogContext();
+    const { vertical, query = "", mode = "keyword", sort, projection, filters, facets, pagination, alpha, distance_threshold, query_embedding, market, locale, surface = "admin", enabled = true, staleTime = 30_000, } = options;
+    return useQuery({
+        queryKey: [
+            "catalog-search",
+            surface,
+            vertical,
+            query,
+            mode,
+            sort,
+            projection,
+            filters,
+            facets,
+            pagination,
+            alpha,
+            distance_threshold,
+            query_embedding,
+            market,
+            locale,
+        ],
+        queryFn: () => fetchWithValidation(`/v1/${surface}/catalog/search`, catalogSearchResponseSchema, { baseUrl, fetcher }, {
+            method: "POST",
+            body: JSON.stringify({
+                vertical,
+                query,
+                mode,
+                sort,
+                projection,
+                filters,
+                facets,
+                pagination,
+                alpha,
+                distance_threshold,
+                query_embedding,
+                market,
+                locale,
+            }),
+        }),
+        enabled: enabled && !!vertical,
+        staleTime,
+        // Keep the previous page/filter's results on screen while the next query
+        // loads, so paging/filtering doesn't flash a skeleton or shift layout.
+        // `isFetching` + `isPlaceholderData` let the UI show a subtle busy state.
+        placeholderData: keepPreviousData,
+    });
+}

package/dist/i18n/en.d.ts

@@ -0,0 +1,397 @@
+export declare const catalogUiEn: {
+    catalogPage: {
+        title: string;
+        description: string;
+        searchPlaceholder: string;
+        tabs: {
+            products: string;
+            extras: string;
+            cruises: string;
+            charters: string;
+            accommodations: string;
+        };
+        actions: {
+            bookThis: string;
+            openEditor: string;
+        };
+        columns: {
+            name: string;
+            status: string;
+            active: string;
+            source: string;
+            supplier: string;
+            bookingMode: string;
+            pax: string;
+            price: string;
+            selection: string;
+            pricing: string;
+            defaultQuantity: string;
+            type: string;
+            days: string;
+            nights: string;
+            availableDepartures: string;
+            yacht: string;
+            from: string;
+            class: string;
+            maxPax: string;
+            bedrooms: string;
+        };
+        filters: {
+            status: string;
+            source: string;
+            supplier: string;
+            bookingMode: string;
+            departureMonth: string;
+            destination: string;
+            country: string;
+            board: string;
+            stars: string;
+            transport: string;
+            type: string;
+            capacity: string;
+            visibility: string;
+            facility: string;
+            price: string;
+            pax: string;
+            any: string;
+            active: string;
+            selection: string;
+            pricingMode: string;
+            perPerson: string;
+            minQuantity: string;
+            maxQuantity: string;
+            ship: string;
+            embark: string;
+            disembark: string;
+            region: string;
+            theme: string;
+            nights: string;
+            yacht: string;
+            apaPercent: string;
+            inventory: string;
+            class: string;
+            smoking: string;
+            property: string;
+            maxPax: string;
+            bedrooms: string;
+            bathrooms: string;
+        };
+        fallbacks: {
+            productName: string;
+            extraName: string;
+            cruiseName: string;
+            charterName: string;
+            roomName: string;
+            detailName: string;
+        };
+        sourceKinds: {
+            owned: string;
+            voyantConnect: string;
+            manual: string;
+            gdsAmadeus: string;
+            gdsSabre: string;
+            gdsTravelport: string;
+            bedbankHotelbeds: string;
+            bedbankExpedia: string;
+            directSuffix: string;
+        };
+        search: {
+            noTabsConfigured: string;
+            clearAll: string;
+            noResults: string;
+            yourFilters: string;
+            resultSingular: string;
+            resultPlural: string;
+            showing: string;
+            previous: string;
+            next: string;
+            page: string;
+        };
+        filtersUi: {
+            min: string;
+            max: string;
+            to: string;
+            clear: string;
+            apply: string;
+            noResults: string;
+            clearFilter: string;
+        };
+        view: {
+            grid: string;
+            list: string;
+            filters: string;
+            sort: string;
+            sortRelevance: string;
+            sortPriceAsc: string;
+            sortPriceDesc: string;
+            sortSoonest: string;
+            sortNewest: string;
+            showAll: string;
+            showLess: string;
+        };
+        card: {
+            from: string;
+            viewDetails: string;
+            nextDeparture: string;
+            departures: string;
+            oneDeparture: string;
+            daysNights: string;
+            nights: string;
+            flightIncluded: string;
+        };
+        boards: {
+            RO: string;
+            BB: string;
+            HB: string;
+            FB: string;
+            AI: string;
+        };
+        detail: {
+            loadingFullContent: string;
+            matchPrefix: string;
+            stale: string;
+            system: string;
+            highlights: string;
+            supplier: string;
+            itinerary: string;
+            ship: string;
+            tagsThemes: string;
+            attributes: string;
+            departures: string;
+            sailings: string;
+            ends: string;
+            book: string;
+            options: string;
+            cabins: string;
+            policies: string;
+            brochure: string;
+            media: string;
+            day: string;
+            unlimited: string;
+            leftWithCapacity: string;
+            left: string;
+            capacity: string;
+            wheelchairAccessible: string;
+            floorPlan: string;
+            deckPlan: string;
+            openDeckPlan: string;
+            shipSpecs: {
+                type: string;
+                capacity: string;
+                capacityGuests: string;
+                decks: string;
+                yearBuilt: string;
+            };
+            tabs: {
+                overview: string;
+            };
+            attributeLabels: {
+                sellAmount: string;
+                supplierId: string;
+            };
+            tagsInputPlaceholder: string;
+            addTag: string;
+            arrayLabels: {
+                categories: string;
+            };
+            priceFromLabel: string;
+            noUpcomingDepartures: string;
+            noUpcomingSailings: string;
+            departuresTable: {
+                date: string;
+                status: string;
+                availability: string;
+                priceFrom: string;
+                soldOut: string;
+                closed: string;
+                cancelled: string;
+                open: string;
+                viewDetails: string;
+                optionsHeading: string;
+                noOptions: string;
+                anyMonth: string;
+                anyStatus: string;
+                minAvailability: string;
+                clearFilters: string;
+                noResults: string;
+                noResultsSailings: string;
+                remainingLabel: string;
+            };
+        };
+        values: {
+            active: string;
+            inactive: string;
+            empty: string;
+            yes: string;
+            no: string;
+            open: string;
+        };
+    };
+    catalogBookingPage: {
+        title: string;
+        descriptionPrefix: string;
+        actions: {
+            backToCatalog: string;
+            refreshPrice: string;
+            addTraveler: string;
+            removeTraveler: string;
+            cancel: string;
+            booking: string;
+            confirmBooking: string;
+        };
+        summary: {
+            untitled: string;
+            departure: string;
+            available: string;
+            livePrice: string;
+            quoteExpires: string;
+            quoteFailed: string;
+        };
+        values: {
+            loading: string;
+            empty: string;
+            yes: string;
+            no: string;
+        };
+        contact: {
+            title: string;
+            description: string;
+            firstName: string;
+            lastName: string;
+            email: string;
+            phone: string;
+            firstNamePlaceholder: string;
+            lastNamePlaceholder: string;
+            emailPlaceholder: string;
+            phonePlaceholder: string;
+        };
+        travelers: {
+            title: string;
+            description: string;
+            firstNameLabel: string;
+            lastNameLabel: string;
+            emailLabel: string;
+            firstNamePlaceholder: string;
+            lastNamePlaceholder: string;
+            emailPlaceholder: string;
+        };
+        notes: {
+            title: string;
+            description: string;
+            placeholder: string;
+        };
+        payment: {
+            title: string;
+            description: string;
+            intent: string;
+            hold: string;
+            cardComingSoon: string;
+        };
+        review: {
+            total: string;
+        };
+        validation: {
+            waitingForPrice: string;
+            notBookable: string;
+            contactNameRequired: string;
+            contactEmailRequired: string;
+            travelerNameRequired: string;
+        };
+    };
+    catalogBrowser: {
+        detail: {
+            datesAndPrices: string;
+            datesError: string;
+            availabilityUnavailable: string;
+            noDepartures: string;
+            selectDate: string;
+            roomType: string;
+            roomTypes: string;
+            roomsTitle: string;
+            notFound: string;
+            loadError: string;
+            about: string;
+            cabins: string;
+            itinerary: string;
+            ship: string;
+            day: string;
+            atSea: string;
+            capacity: string;
+            decks: string;
+            soldOut: string;
+            highlights: string;
+            location: string;
+            guestReviews: string;
+            reviewsWord: string;
+            book: string;
+            freeCancellation: string;
+            photos: string;
+            from: string;
+            nightsFlightIncluded: string;
+            max: string;
+            room: string;
+            perPerson: string;
+            mealPlan: string;
+            close: string;
+            prevPhoto: string;
+            nextPhoto: string;
+            boards: {
+                RO: string;
+                BB: string;
+                HB: string;
+                FB: string;
+                AI: string;
+                standard: string;
+            };
+        };
+        search: {
+            searchLabel: string;
+            searchPlaceholder: string;
+            destination: string;
+            chooseCountry: string;
+            when: string;
+            anyTime: string;
+            flyingFrom: string;
+            finding: string;
+            loading: string;
+            allAirports: string;
+            departureAirport: string;
+            duration: string;
+            nights: string;
+            adults: string;
+            searchAvailability: string;
+            searching: string;
+            clear: string;
+            error: string;
+            availabilityUnavailable: string;
+            noDepartures: string;
+            thisDestination: string;
+            departureDate: string;
+            departureDates: string;
+            in: string;
+            holiday: string;
+            holidays: string;
+            departing: string;
+            selectDay: string;
+            flightIncluded: string;
+            viewDates: string;
+            perPerson: string;
+            cruiseType: string;
+            allTypes: string;
+            typeRiver: string;
+            typeOcean: string;
+            cruisePlaceholder: string;
+            sailing: string;
+            sailings: string;
+            viewCruise: string;
+            noSailings: string;
+        };
+        calendar: {
+            prevMonth: string;
+            nextMonth: string;
+            offer: string;
+            offers: string;
+        };
+    };
+};
+//# sourceMappingURL=en.d.ts.map

package/dist/i18n/en.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"en.d.ts","sourceRoot":"","sources":["../../src/i18n/en.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6YK,CAAA"}