@travories/frontend-sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,633 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React, { ReactNode } from 'react';
+
+interface HttpRequestOptions {
+    method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    headers?: Record<string, string>;
+    body?: unknown;
+    signal?: AbortSignal;
+    silent?: boolean;
+}
+interface HttpClientConfig {
+    baseUrl: string;
+    apiKey?: string;
+    authToken?: string | (() => string | Promise<string | undefined> | undefined);
+    defaultHeaders?: Record<string, string>;
+    fetchImpl?: typeof fetch;
+}
+declare class TravoriesApiError extends Error {
+    status: number;
+    url: string;
+    body: string;
+    constructor(message: string, status: number, url: string, body: string);
+}
+declare class HttpClient {
+    private baseUrl;
+    private apiKey?;
+    private authToken?;
+    private defaultHeaders;
+    private fetchImpl;
+    constructor(config: HttpClientConfig);
+    private resolveAuthToken;
+    request<T>(path: string, options?: HttpRequestOptions): Promise<T | null>;
+}
+
+interface TravoriesImageUrls {
+    original?: string | null;
+    hero?: string | null;
+    hero_fit?: string | null;
+    section?: string | null;
+    portrait?: string | null;
+    general?: string | null;
+    jpeg?: string | null;
+}
+interface TravoriesImage {
+    id: string;
+    key: string;
+    type: string;
+    alt: string;
+    preview: string | null;
+    url: TravoriesImageUrls;
+}
+interface PackageDayLocation {
+    sequence: number;
+    coord: [number, number];
+    displayName: string;
+}
+interface PackageDay {
+    id: string;
+    dayNumber: number;
+    description: string;
+    activities: {
+        activityName: string;
+    }[];
+    locations: PackageDayLocation[];
+    travelDuration: string;
+    difficulty: string;
+    foodService: string[];
+    transportation: string[];
+    accommodation: string;
+}
+interface PackagePriceTier {
+    groupSizeMin: number;
+    groupSizeMax: number;
+    pricePerPerson: number;
+    isNegotiable: boolean;
+}
+interface PackageDiscount {
+    ageMin: number;
+    ageMax: number;
+    discountPercentage: number;
+}
+interface TravoriesPackage {
+    id: string;
+    title: string;
+    packageSlug: string;
+    slug: string;
+    packageType: string;
+    description: string;
+    difficulty: string;
+    packageFlexibility: boolean;
+    packageCategory: string;
+    totalDays: number;
+    media: TravoriesImage[];
+    thumbnail: TravoriesImage | null;
+    days: PackageDay[];
+    prices: PackagePriceTier[];
+    discounts: PackageDiscount[];
+    thingsIncluded: string[];
+    thingsExcluded: string[];
+    thingsToPack: string[];
+    rating: number;
+    maxAllowedPeople: number;
+    minAllowedPeople: number;
+}
+interface PackageHost {
+    userId: string;
+    username: string;
+    agencyCreatedDate: string;
+    rating: number;
+    review: number;
+    description: string;
+    logo: TravoriesImage | null;
+    slug: string;
+}
+interface PackageHostResponse {
+    success: boolean;
+    message: string;
+    host: PackageHost;
+}
+interface MajorAttractionItem {
+    id?: string;
+    name?: string;
+    description?: string;
+    image?: TravoriesImage | null;
+    [key: string]: unknown;
+}
+interface MajorAttractionsResponse {
+    data: MajorAttractionItem[];
+    success?: boolean;
+    message?: string;
+}
+interface PackageRouteGeometry {
+    type: "LineString";
+    coordinates: [number, number][];
+}
+interface PackageRoute {
+    id?: string;
+    fromSegmentId?: string;
+    toSegmentId?: string;
+    travelMode?: string;
+    distanceMeters?: number;
+    durationSeconds?: number;
+    geometryType?: string;
+    geometry: PackageRouteGeometry | string;
+}
+interface PackageRoutesDay {
+    dayId?: string;
+    dayNumber: number;
+    routes: PackageRoute[];
+}
+interface PackageRoutesResponse {
+    success: boolean;
+    message?: string;
+    packageSlug: string;
+    days: PackageRoutesDay[];
+}
+interface PackageBundle {
+    pkg: TravoriesPackage;
+    host: PackageHost | null;
+    attractions: MajorAttractionItem[];
+    routes: PackageRoutesDay[];
+}
+/**
+ * Compact card shape used by home/list sections. Returned by
+ * `client.packages.getHomeSections()`. Doesn't include full details — only
+ * what a card UI needs.
+ */
+interface HomePackageCard {
+    id: string;
+    title: string;
+    slug: string;
+    agencySlug: string;
+    totalDays: number;
+    minPrice: number;
+    maxPrice: number;
+    rating: number;
+    packageCategory: string;
+    thumbnail: TravoriesImage;
+}
+interface HomeSectionsResponse {
+    popular: HomePackageCard[];
+    topRated: HomePackageCard[];
+    trending: HomePackageCard[];
+    moreToExplore: HomePackageCard[];
+}
+
+declare class PackagesResource {
+    private http;
+    constructor(http: HttpClient);
+    /** Fetch a single package by its public slug. Returns null on 404 / network error in silent mode. */
+    getBySlug(slug: string, options?: HttpRequestOptions): Promise<TravoriesPackage | null>;
+    /** Fetch host (agency) information for the package. */
+    getHost(slug: string, options?: HttpRequestOptions): Promise<PackageHostResponse | null>;
+    /** Fetch major attractions tied to the package. */
+    getMajorAttractions(slug: string, options?: HttpRequestOptions): Promise<MajorAttractionsResponse | null>;
+    /**
+     * Fetch the four home/landing sections in one request:
+     *   popular, topRated, trending, moreToExplore.
+     * Each item is a compact card (id, title, slug, thumbnail, price range, rating).
+     */
+    getHomeSections(options?: HttpRequestOptions): Promise<HomeSectionsResponse | null>;
+    /**
+     * Fetch per-day GeoJSON routes for the package. Used by the map on the
+     * itinerary section to draw actual road/trail paths between stops.
+     */
+    getRoutes(slug: string, options?: HttpRequestOptions): Promise<PackageRoutesResponse | null>;
+    /**
+     * Convenience: fetch the package + host + attractions + per-day routes in
+     * parallel. This is the payload `<PackageDetailView />` consumes.
+     */
+    getBundle(slug: string, options?: HttpRequestOptions): Promise<PackageBundle | null>;
+}
+
+interface TravoriesClientConfig extends HttpClientConfig {
+}
+/**
+ * Main entry point for the Travories SDK.
+ *
+ * @example
+ * ```ts
+ * const travories = new TravoriesClient({
+ *   baseUrl: "https://api.travories.com",
+ * });
+ *
+ * const pkg = await travories.packages.getBySlug("everest-base-camp");
+ * ```
+ */
+declare class TravoriesClient {
+    private http;
+    packages: PackagesResource;
+    constructor(config: TravoriesClientConfig);
+    /** Shortcut for `client.packages.getBySlug(slug)`. */
+    getPackageBySlug: (slug: string) => Promise<TravoriesPackage | null>;
+    /** Shortcut for `client.packages.getBundle(slug)` — package + host + attractions in one call. */
+    getPackageBundle: (slug: string) => Promise<PackageBundle | null>;
+}
+/** Factory form, in case you prefer a function over `new`. */
+declare function createTravoriesClient(config: TravoriesClientConfig): TravoriesClient;
+
+interface UsePackageBySlugResult {
+    data: TravoriesPackage | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+interface UsePackageBundleResult {
+    data: PackageBundle | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Fetch a single package by slug. Re-runs when `slug` or `client` changes.
+ *
+ * Aborts the in-flight request when the component unmounts or the inputs change,
+ * so React strict-mode double-renders don't leak responses.
+ */
+declare function usePackageBySlug(client: TravoriesClient, slug: string | null | undefined): UsePackageBySlugResult;
+/**
+ * Same as `usePackageBySlug` but fetches the full bundle (package + host + attractions).
+ */
+declare function usePackageBundle(client: TravoriesClient, slug: string | null | undefined): UsePackageBundleResult;
+
+interface UseHomeSectionsResult {
+    data: HomeSectionsResponse | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Fetch the four home/landing sections (popular, topRated, trending,
+ * moreToExplore) in one request. Re-runs when `client` changes.
+ *
+ * Pass `null` to skip fetching (useful when the consumer already has the data
+ * via SSR / `initialSections` and only needs to satisfy rules-of-hooks).
+ */
+declare function useHomeSections(client: TravoriesClient | null): UseHomeSectionsResult;
+
+interface HomeSectionsProps {
+    /** Required when `initialSections` is not provided. */
+    client?: TravoriesClient;
+    /** Pre-fetched home sections (SSR pattern). When set, skips the client-side fetch. */
+    initialSections?: HomeSectionsResponse | null;
+    currency?: string;
+    /** Called when the user clicks any package card across any section. */
+    onSelect?: (pkg: HomePackageCard) => void;
+    /** When set, cards render as <a href=hrefFor(pkg)> instead of buttons. */
+    hrefFor?: (pkg: HomePackageCard) => string;
+    /** Open each card in a new tab. Requires `hrefFor`. */
+    openInNewTab?: boolean;
+    /** Optional override for section titles (defaults match the frontend's labels). */
+    titles?: {
+        popular?: string;
+        trending?: string;
+        topRated?: string;
+        moreToExplore?: string;
+    };
+    /** Section order (default: popular, trending, topRated, moreToExplore). */
+    order?: Array<"popular" | "trending" | "topRated" | "moreToExplore">;
+    className?: string;
+    renderLoading?: () => React.ReactNode;
+    renderError?: (err: Error) => React.ReactNode;
+}
+/**
+ * Drop-in landing-page block that renders all four home sections. Same dual
+ * usage as `<PackageDetailView />`: pass `client` to let the SDK fetch, OR pass
+ * `initialSections` if you've already fetched (Next.js server component, etc.).
+ */
+declare function HomeSections({ client, initialSections, currency, onSelect, hrefFor, openInNewTab, titles, order, className, renderLoading, renderError, }: HomeSectionsProps): react_jsx_runtime.JSX.Element | null;
+
+interface HomeSectionsContextValue {
+    data: HomeSectionsResponse | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+interface HomeSectionsProviderProps {
+    /** Required if `initialSections` is not provided. */
+    client?: TravoriesClient;
+    /** Pre-fetched data (SSR). When set, no client-side fetch runs. */
+    initialSections?: HomeSectionsResponse | null;
+    children: ReactNode;
+}
+/**
+ * One-shot data fetcher for the four home sections. Drop anywhere in your tree
+ * and place any number of `<PackagesSection>` (or custom consumers via
+ * `useHomeSectionsContext`) inside — they all share the same fetched payload.
+ *
+ *   <HomeSectionsProvider client={client}>
+ *     <Hero />
+ *     <PackagesSection section="trending" onSelect={goTo} />
+ *     <YourFAQ />
+ *     <PackagesSection section="moreToExplore" onSelect={goTo} />
+ *   </HomeSectionsProvider>
+ */
+declare function HomeSectionsProvider({ client, initialSections, children, }: HomeSectionsProviderProps): react_jsx_runtime.JSX.Element;
+/** Hook for any custom consumer (e.g., a stats badge) that wants the raw payload. */
+declare function useHomeSectionsContext(): HomeSectionsContextValue;
+
+type HomeSectionKey = "popular" | "trending" | "topRated" | "moreToExplore";
+interface PackagesSectionProps {
+    /** Which section to render. */
+    section: HomeSectionKey;
+    /** Override the default title for this section. */
+    title?: string;
+    subtitle?: string;
+    currency?: string;
+    onSelect?: (pkg: HomePackageCard) => void;
+    hrefFor?: (pkg: HomePackageCard) => string;
+    /** Open each card in a new tab. Requires `hrefFor`. */
+    openInNewTab?: boolean;
+    /** Hide the whole block while loading (default: show a skeleton). */
+    hideWhenLoading?: boolean;
+    /** Hide when there are no packages for this section (default true). */
+    hideWhenEmpty?: boolean;
+}
+/**
+ * One independent home section, designed to live anywhere inside a
+ * `<HomeSectionsProvider>`. Multiple of these share one fetch.
+ *
+ *   <HomeSectionsProvider client={client}>
+ *     <PackagesSection section="popular" onSelect={goTo} />
+ *     <YourCustomBlock />
+ *     <PackagesSection section="trending" title="Hot picks" onSelect={goTo} />
+ *   </HomeSectionsProvider>
+ */
+declare const PackagesSection: React.FC<PackagesSectionProps>;
+
+interface PackagesCarouselProps {
+    title: string;
+    subtitle?: string;
+    packages: HomePackageCard[];
+    currency?: string;
+    onSelect?: (pkg: HomePackageCard) => void;
+    /** When a package is rendered as a link instead of a button. */
+    hrefFor?: (pkg: HomePackageCard) => string;
+    /** Open each card in a new tab. Requires `hrefFor` to be set. */
+    openInNewTab?: boolean;
+    /** Render nothing when the list is empty (default true). */
+    hideWhenEmpty?: boolean;
+}
+declare const PackagesCarousel: React.FC<PackagesCarouselProps>;
+
+interface PackageCardProps {
+    pkg: HomePackageCard;
+    currency?: string;
+    onSelect?: (pkg: HomePackageCard) => void;
+    /** Renders as <a href> so cmd/ctrl-click opens the package in a new tab. */
+    href?: string;
+    /** When true, the anchor gets `target="_blank"` so a plain click also opens
+     *  in a new tab. Requires `href`. `onSelect` is NOT called on a normal click
+     *  in this mode — the browser handles navigation. */
+    openInNewTab?: boolean;
+    /** When true, show the heart (wishlist) icon. Default true. */
+    showHeart?: boolean;
+    /** Initial wishlist state. */
+    liked?: boolean;
+    /** Called when the user toggles the heart. Receives the new state. */
+    onLike?: (pkg: HomePackageCard, liked: boolean) => void;
+}
+/**
+ * Ported from frontend `Tourist/Package/PackageCard.tsx`.
+ * - Bordered image box with a frosted category badge top-left and an optional
+ *   wishlist heart top-right.
+ * - Title, duration · stars, "Starting from $X" sit on the page background
+ *   (no surrounding card frame — same as the frontend).
+ * - Card-level click handled via an absolutely-positioned anchor overlay so
+ *   browser open-in-new-tab works naturally.
+ */
+declare const PackageCard: React.FC<PackageCardProps>;
+
+interface PackageDetailViewProps {
+    /** Travories SDK client. Required when using `slug`. */
+    client?: TravoriesClient;
+    /** Public package slug. */
+    slug?: string;
+    /** Pre-fetched bundle. When provided, no fetch runs. Use for SSR. */
+    initialBundle?: PackageBundle | null;
+    /** Currency code for prices (default "USD"). */
+    currency?: string;
+    /** Called when the user hits Reserve. If omitted, the button shows a disabled state. */
+    onReserve?: (pkg: TravoriesPackage) => void;
+    /** Optional extra class on the root wrapper. */
+    className?: string;
+    /** Loading state override. */
+    renderLoading?: () => React.ReactNode;
+    /** Not-found state override. */
+    renderNotFound?: () => React.ReactNode;
+}
+declare function PackageDetailView({ client, slug, initialBundle, currency, onReserve, className, renderLoading, renderNotFound, }: PackageDetailViewProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Legacy view-model types — identical shape to frontend's `types/package.ts`.
+ * The SDK consumes the unified API response and projects it into these shapes
+ * because the ported frontend components were written against them.
+ */
+interface ThingItem {
+    category: string;
+    items: string[];
+}
+interface MediaItem {
+    url: string;
+    previewUrl?: string;
+    alt?: string;
+}
+interface TopData {
+    id: string;
+    slug?: string;
+    AgencyName?: string;
+    AgencySlug?: string;
+    Rating: number;
+    ReviewCount: number;
+    AgencyPackageMedias: MediaItem[];
+    PackageTitle: string;
+    PackageType: string;
+    TotalDays: number;
+    PackageCategory: string;
+    Difficulty?: string;
+    MaxAllowedPeople?: number;
+    thingsToDo?: ThingItem[];
+    thingsExcluded?: ThingItem[];
+    thingsToPack?: ThingItem[];
+}
+interface DescriptionData {
+    id?: string;
+    Description: string;
+    Price: Array<{
+        groupSizeMin: number;
+        groupSizeMax: number;
+        pricePerPerson: number;
+        isNegotiable: boolean;
+    }>;
+    Discounts?: Array<{
+        ageMin: number;
+        ageMax: number;
+        discountPercentage: number;
+    }>;
+    TotalDays: number;
+    MaxAllowedPeople: number;
+    MinAllowedPeople: number;
+    Days: Array<{
+        id?: string;
+        dayNumber: number;
+        DayNumber?: number;
+        description: string;
+        activities?: {
+            activityName: string;
+        }[];
+        locations?: Array<{
+            sequence?: number;
+            coord?: [number, number];
+            lat?: number;
+            lng?: number;
+            displayName?: string;
+            name?: string;
+            Sequence?: number;
+            position?: number;
+        }>;
+        travelDuration?: string | number;
+        travelDurationHours?: string | number;
+        difficulty?: string;
+        foodService?: string[];
+        transportation?: string[];
+        accommodation?: string;
+        coverImage?: string;
+        previewCoverImage?: string;
+        nCoverImage?: {
+            original?: string;
+            preview?: string;
+        };
+    }>;
+    thingsToDo?: ThingItem[];
+    thingsExcluded?: ThingItem[];
+    thingsToPack?: ThingItem[];
+}
+
+declare const TopSection: ({ topData }: {
+    topData: TopData;
+}) => react_jsx_runtime.JSX.Element;
+
+interface GallerySectionProps {
+    media: MediaItem[];
+    packageTitle: string;
+}
+declare const GallerySection: React.FC<GallerySectionProps>;
+
+interface PackageOverviewProps {
+    description: string;
+    isMobile: boolean;
+    topData: TopData;
+}
+declare const PackageOverview: React.FC<PackageOverviewProps>;
+
+interface DescriptionSectionProps {
+    DescriptionData: DescriptionData;
+    topData: TopData;
+    currency?: string;
+    onReserve?: (pkg: TravoriesPackage) => void;
+    pkg: TravoriesPackage;
+    routes?: PackageRoutesDay[];
+}
+declare const DescriptionSection: React.FC<DescriptionSectionProps>;
+
+declare const Itinerary: React.FC<{
+    Description: DescriptionData;
+    routes?: PackageRoutesDay[];
+    currency?: string;
+    /** Called from the sticky bar's Reserve button. Typically scrolls to BookingCardLite. */
+    onReserveClick?: () => void;
+}>;
+
+interface PackageMapLocation {
+    coord: [number, number];
+    displayName: string;
+    sequence?: number;
+}
+interface PackageMapProps {
+    locations: PackageMapLocation[];
+    dayNumber?: number;
+    /** Real driving/trail polylines for this day, already flipped to [lat, lng]. */
+    routes?: Array<[number, number][]>;
+    className?: string;
+}
+/**
+ * Lazy Leaflet wrapper. Renders nothing on the server. On the client, dynamically
+ * imports react-leaflet + leaflet so consumers without SSR setup don't blow up.
+ */
+declare function PackageMap({ locations, dayNumber, routes, className, }: PackageMapProps): react_jsx_runtime.JSX.Element;
+
+interface PackageIncludedProps {
+    thingsToDo: ThingItem[] | unknown[];
+}
+declare const PackageIncluded: React.FC<PackageIncludedProps>;
+
+interface PackageExcludedAndToPackProps {
+    thingsExcluded: ThingItem[] | Record<string, string[]> | unknown[];
+    thingsToPack: ThingItem[] | Record<string, string[]> | unknown[];
+}
+declare const PackageExcludedAndToPack: React.FC<PackageExcludedAndToPackProps>;
+
+interface HostCardProps {
+    hostData: PackageHost;
+    className?: string;
+}
+declare const HostCard: React.FC<HostCardProps>;
+
+interface HostAboutProps {
+    hostName: string;
+    description?: string;
+    className?: string;
+}
+declare const HostAbout: React.FC<HostAboutProps>;
+
+type TravelerOption = {
+    id: "Adult" | "Senior Citizen" | "Children" | "Infant";
+    name: string;
+    count: number;
+    ageRange?: {
+        min: number;
+        max: number;
+    };
+    countInTotal: boolean;
+};
+interface BookingCardLiteProps {
+    DescriptionData: DescriptionData;
+    currency?: string;
+    /** Called when user clicks Book/Reserve. Receives the picked values so the
+     *  consumer can wire their own booking flow. */
+    onReserve?: (payload: {
+        arrival: string;
+        departure: string;
+        travelers: TravelerOption[];
+        totalCost: number;
+        pricePerPerson: number;
+    }) => void;
+}
+/**
+ * High-fidelity port of frontend `BookingForm.tsx` — visual only.
+ * Submission, validation, auth, and the booking API are intentionally left to
+ * the consumer (called via `onReserve`) so the SDK stays auth/Redux-free.
+ */
+declare const BookingCardLite: React.FC<BookingCardLiteProps>;
+
+declare const buildGalleryMedia: (pkg: TravoriesPackage) => MediaItem[];
+declare const buildTopData: (pkg: TravoriesPackage, host: PackageHost | null) => TopData;
+declare const buildDescriptionData: (pkg: TravoriesPackage) => DescriptionData;
+
+declare function pickImageUrl(img: TravoriesImage | null | undefined): string;
+declare function startingPrice(prices: PackagePriceTier[] | undefined): number;
+declare function formatCurrency(amount: number, currency?: string): string;
+declare function formatRating(rating: number | undefined): string;
+
+export { BookingCardLite, type DescriptionData, DescriptionSection, GallerySection, type HomePackageCard, type HomeSectionKey, HomeSections, type HomeSectionsContextValue, type HomeSectionsProps, HomeSectionsProvider, type HomeSectionsProviderProps, type HomeSectionsResponse, HostAbout, HostCard, type HttpClientConfig, type HttpRequestOptions, Itinerary, type MajorAttractionItem, type MajorAttractionsResponse, type MediaItem, type PackageBundle, PackageCard, type PackageDay, type PackageDayLocation, PackageDetailView, type PackageDetailViewProps, type PackageDiscount, PackageExcludedAndToPack, type PackageHost, type PackageHostResponse, PackageIncluded, PackageMap, PackageOverview, type PackagePriceTier, type PackageRoute, type PackageRouteGeometry, type PackageRoutesDay, type PackageRoutesResponse, PackagesCarousel, PackagesResource, PackagesSection, type PackagesSectionProps, type ThingItem, type TopData, TopSection, TravoriesApiError, TravoriesClient, type TravoriesClientConfig, type TravoriesImage, type TravoriesImageUrls, type TravoriesPackage, type UseHomeSectionsResult, type UsePackageBundleResult, type UsePackageBySlugResult, buildDescriptionData, buildGalleryMedia, buildTopData, createTravoriesClient, formatCurrency, formatRating, pickImageUrl, startingPrice, useHomeSections, useHomeSectionsContext, usePackageBundle, usePackageBySlug };