@shortstravelmgmt/component-lib 0.5.0 → 0.5.1-canary.85.gba94682

package/dist/index.d.ts

@@ -3766,6 +3766,8 @@ interface TravelDateRangeProps {
     startDate: string;
     /** Last travel date as `YYYY-MM-DD` */
     endDate: string;
+    /** Follow the range with the trip's length as a pill, both ends counted (`4 days`) */
+    showDays?: boolean;
     /** Additional CSS class */
     className?: string;
 }
@@ -3774,10 +3776,10 @@ declare const ordinalDay: (day: number) => string;
 /**
  * A trip's travel dates as `Sun, Jun 7th ⇢ Tue, Jun 9th, 2026`. The year shows
  * once at the end, or on both dates when the trip crosses a year. A single-day
- * trip shows one date.
+ * trip shows one date. With `showDays`, the trip's length follows as a pill.
  */
 declare const TravelDateRange: {
-    ({ startDate, endDate, className }: TravelDateRangeProps): React.JSX.Element | null;
+    ({ startDate, endDate, showDays, className }: TravelDateRangeProps): React.JSX.Element | null;
     displayName: string;
 };
 
@@ -4167,7 +4169,10 @@ interface AirInvoiceLine {
 /** A selectable invoice version. */
 interface AirInvoiceVersion {
     id: string;
+    /** The version's row in the menu, e.g. `Version 3 — May 19, 2026` */
     label: string;
+    /** When the version was issued, already formatted, e.g. `May 19, 2026`; the header's status pill reads it */
+    date?: string;
 }
 interface AirInvoiceCardProps {
     /** Card heading, e.g. `Air Invoice Details` */
@@ -4178,7 +4183,7 @@ interface AirInvoiceCardProps {
     paymentStatus?: string;
     /** Formatted invoice total */
     total?: string;
-    /** Invoice versions; the Version control appears when there is more than one */
+    /** Invoice versions, newest first; the Version control appears when there is more than one */
     versions?: AirInvoiceVersion[];
     /** Id of the version on screen */
     selectedVersionId?: string;
@@ -5153,6 +5158,12 @@ interface ItinerarySegmentBase {
     loyaltyNumbers?: string[];
     /** Associated booking remarks to display in Notes. */
     notes?: string[];
+    /**
+     * The itinerary day the segment is listed under, as `YYYY-MM-DD`, when the host groups it by more than
+     * its own date: Hub lists a connecting flight under the day its journey began (a 2:30 AM Jul 2 leg
+     * connecting from a Jul 1 flight reads under Jul 1). Defaults to the segment's own date (getSegmentDate).
+     */
+    travelDay?: string;
 }
 /** A flight. Fields follow Hub's `CommercialFlight` plus what the Portal itinerary prints. */
 interface ItineraryAirSegment extends ItinerarySegmentBase {
@@ -5195,6 +5206,11 @@ interface ItineraryAirSegment extends ItinerarySegmentBase {
     cabin?: string;
     /** Shows the online check-in action (the Portal reveals it the day before departure) */
     checkInAvailable?: boolean;
+    /**
+     * The airline's own online check-in page. When set, Check In is a link that opens it in a new tab
+     * (and counts as check-in being available), in place of calling `onCheckIn`.
+     */
+    checkInUrl?: string;
     /** Live flight status note, e.g. `In air — scheduled to arrive on time` */
     flightStatus?: string;
 }
@@ -5227,12 +5243,23 @@ interface ItineraryCarSegment extends ItinerarySegmentBase {
     dropoffLocation: string;
     /** Optional drop-off street address lines. */
     dropoffAddress?: string[];
+    /** Drop-off counter phone, for a one-way rental */
+    dropoffPhone?: string;
     /** Formatted rental duration, e.g. `6d 45m`, shown between pick-up and drop-off */
     duration?: string;
     /** Rental counter phone number */
     phone?: string;
     /** Quoted rate per day */
     dailyRate?: number;
+    /** How the quoted rate is charged, e.g. `Daily` or `Weekly`: it qualifies the rate (`$66.80 daily`) in place of `/ day` */
+    rateCategory?: string;
+    /**
+     * The unit after a rate with no `rateCategory`: `$66.80 / day` by default; `null` or `''` prints the
+     * amount alone (Hub's wording). A `rateCategory` takes its place when given.
+     */
+    rateUnit?: string | null;
+    /** An SUV-class rental: the Estimated Total reads `$65.00 (SUV)`, explaining a total that would otherwise look wrong for the class booked */
+    isSuv?: boolean;
 }
 /** A hotel stay. Fields follow Hub's `AgencyHotelSegment` plus the Portal's hotel block. */
 interface ItineraryHotelSegment extends ItinerarySegmentBase {
@@ -5259,6 +5286,8 @@ interface ItineraryHotelSegment extends ItinerarySegmentBase {
     roomType?: string;
     /** Nightly room rate */
     nightlyRate?: number;
+    /** The unit after the nightly rate: `$187.00 / night` by default; Hub passes `avg night`. `''` prints the amount alone */
+    rateUnit?: string;
     /** Street address lines */
     address?: string[];
     /** City, state and postal code line */
@@ -5287,10 +5316,16 @@ interface ItineraryLimoSegment extends ItinerarySegmentBase {
     cancellationPolicies?: string[];
     /** Remaining remarks not consumed by the parsed fields */
     comments?: string[];
+    /** The car service providing the transfer */
+    vendor?: string;
+    /** The car service's phone number */
+    vendorPhone?: string;
 }
-/** A rail journey using the station and booking fields shown in Hub. */
+/** A rail journey using the station and booking fields shown in Hub; with `mode: 'bus'`, a motor coach. */
 interface ItineraryRailSegment extends ItinerarySegmentBase {
     type: 'rail';
+    /** `bus` makes it a motor coach: the same stations, times and seats, under a bus icon and a Motor Coach label. Defaults to `rail` */
+    mode?: 'rail' | 'bus';
     /** Service or carrier name, e.g. `Amtrak Acela` */
     carrier: string;
     /** Carrier code used by the service icon */
@@ -5346,12 +5381,14 @@ interface ItinerarySegmentCardProps {
     headingLevel?: 2 | 3 | 4;
     /** Called when a traveler starts online check-in for a flight */
     onCheckIn?: (segment: ItineraryAirSegment) => void;
-    /** Shows a blue Check In button beside a flight's vendor name (needs `onCheckIn`); the timeline sets it on each day's first flight */
+    /** Shows a blue Check In button beside a flight's vendor name (needs `onCheckIn` or the flight's `checkInUrl`); the timeline sets it on each day's first flight with check-in */
     showCheckIn?: boolean;
     /** `card` stands alone with its own border; `section` drops the chrome to sit inside a day card */
     variant?: 'card' | 'section';
     /** Extra content rendered below the detail list (notes, agent remarks) */
     footer?: ReactNode;
+    /** `inline` (default) runs "Label: value" pairs along a line; `stacked` sets a small uppercase label over each value */
+    detailsLayout?: 'inline' | 'stacked';
     /**
      * Renders the 48px vendor mark in the card header, replacing the built-in
      * travel-service icon. The set ships marks for only a few vendors; a host
@@ -5360,6 +5397,12 @@ interface ItinerarySegmentCardProps {
      * rail, car or hotel chain). Return `undefined` or `null` for the default.
      */
     renderVendorMark?: (segment: ItinerarySegment, vendorCode: string | undefined) => ReactNode;
+    /**
+     * Formats every amount the card prints — a car's or hotel's rate and estimated total — given the
+     * amount and the segment's `currency`. Defaults to `formatItineraryMoney` (`$66.80`); Hub passes its
+     * own (`USD 66.80`).
+     */
+    formatMoney?: (amount: number, currency?: string) => string;
     /** Additional CSS class */
     className?: string;
 }
@@ -5368,7 +5411,7 @@ interface ItinerarySegmentCardProps {
  * Uses a shared header, journey board and labelled details grounded in Hub.
  */
 declare const ItinerarySegmentCard: {
-    ({ segment, headingLevel, onCheckIn, showCheckIn, variant, footer, renderVendorMark, className, }: ItinerarySegmentCardProps): React.JSX.Element;
+    ({ segment, headingLevel, onCheckIn, showCheckIn, variant, footer, detailsLayout, renderVendorMark, formatMoney, className, }: ItinerarySegmentCardProps): React.JSX.Element;
     displayName: string;
 };
 
@@ -5389,11 +5432,18 @@ interface ItineraryDay {
  * and keeps the legs of a connection in the order they are flown.
  *
  * Day grouping keys off the plain `YYYY-MM-DD` string, so ordering never depends
- * on the reader's time zone. Segments with no stated time sort last, keeping the
- * order they were given.
- */
-declare const groupSegmentsByDay: (segments: ItinerarySegment[]) => ItineraryDay[];
-/** Segment-type filters offered above the first day. Ground covers rental cars and Black Car. */
+ * on the reader's time zone. A segment's `travelDay`, when given, is its day in
+ * place of its own date; within a day, segments order by their own date, then
+ * time. Segments with no stated time sort last, keeping the order they were given.
+ *
+ * `preserveOrder` keeps each day's segments in the order given (days are still
+ * ordered by date), for a host whose order is already right where local clock
+ * times are not — a day that crosses the date line, ordered by UTC.
+ */
+declare const groupSegmentsByDay: (segments: ItinerarySegment[], { preserveOrder }?: {
+    preserveOrder?: boolean;
+}) => ItineraryDay[];
+/** Segment-type filters offered above the first day. Ground covers rental cars, Black Car and motor coaches. */
 type ItinerarySegmentFilter = 'all' | 'air' | 'hotel' | 'ground' | 'rail';
 interface ItineraryTimelineProps {
     /** Every booking on the trip, including Black Car and rail, in any order */
@@ -5408,6 +5458,19 @@ interface ItineraryTimelineProps {
     onCheckIn?: (segment: ItineraryAirSegment) => void;
     /** Draws each card's vendor mark; passed to every ItinerarySegmentCard (see its `renderVendorMark`) */
     renderVendorMark?: ItinerarySegmentCardProps['renderVendorMark'];
+    /**
+     * Extra content for each segment's card, below its own notes (see ItinerarySegmentCard's `footer`):
+     * a host's labelled note sections, policies or charter rows. A card whose footer renders nothing draws none.
+     */
+    renderSegmentFooter?: (segment: ItinerarySegment) => ReactNode;
+    /** Formats every amount on the cards; passed to every ItinerarySegmentCard (see its `formatMoney`) */
+    formatMoney?: ItinerarySegmentCardProps['formatMoney'];
+    /**
+     * Keeps each day's segments in the order given instead of sorting them by start time; days are still
+     * ordered by date. For a host whose order is already right where local clock times mislead — a day
+     * that crosses the date line, which Hub's API orders by UTC.
+     */
+    preserveOrder?: boolean;
     /** Shows All / Flights / Hotels / Ground / Rail tabs above the first day; types with nothing booked are left out */
     showTypeTabs?: boolean;
     /** Additional CSS class */
@@ -5418,7 +5481,7 @@ interface ItineraryTimelineProps {
  * Also covers loading, error and nothing-booked-yet states.
  */
 declare const ItineraryTimeline: {
-    ({ segments, loading, error, emptyMessage, onCheckIn, renderVendorMark, showTypeTabs, className, }: ItineraryTimelineProps): React.JSX.Element;
+    ({ segments, loading, error, emptyMessage, onCheckIn, renderVendorMark, renderSegmentFooter, formatMoney, preserveOrder, showTypeTabs, className, }: ItineraryTimelineProps): React.JSX.Element;
     displayName: string;
 };
 
@@ -8891,6 +8954,12 @@ interface ItineraryPageProps {
     onCheckIn?: (segment: ItineraryAirSegment) => void;
     /** Draws each segment card's vendor mark; see ItinerarySegmentCard's `renderVendorMark` */
     renderVendorMark?: ItinerarySegmentCardProps['renderVendorMark'];
+    /** Extra content for each segment's card; see ItineraryTimeline's `renderSegmentFooter` */
+    renderSegmentFooter?: ItineraryTimelineProps['renderSegmentFooter'];
+    /** Formats every amount on the page — the trip cost and the cards' rates and totals; defaults to `formatItineraryMoney` (`$66.80`) */
+    formatMoney?: ItinerarySegmentCardProps['formatMoney'];
+    /** Keeps each day's segments in the order given; see ItineraryTimeline's `preserveOrder` */
+    preserveOrder?: boolean;
     /** Additional CSS class */
     className?: string;
 }
@@ -8904,7 +8973,7 @@ declare const itineraryPageName: (travelers: string[]) => string;
  * Trip data and print, email, calendar and invoice actions arrive as props.
  */
 declare const ItineraryPage: {
-    ({ tripName, recordLocator, travelers, startDate, endDate, segments, status, sportCode, totalCost, currency, agent, invoice, bookingDetails, loading, error, notice, defaultView, onViewChange, alertBanners, travelNotes, closingBanners, closingNotes, onRetry, sectionName, pageName, onBack, backLabel, onPrint, onEmail, onAddToCalendar, onDownloadInvoice, onCheckIn, renderVendorMark, className, }: ItineraryPageProps): React.JSX.Element;
+    ({ tripName, recordLocator, travelers, startDate, endDate, segments, status, sportCode, totalCost, currency, agent, invoice, bookingDetails, loading, error, notice, defaultView, onViewChange, alertBanners, travelNotes, closingBanners, closingNotes, onRetry, sectionName, pageName, onBack, backLabel, onPrint, onEmail, onAddToCalendar, onDownloadInvoice, onCheckIn, renderVendorMark, renderSegmentFooter, formatMoney, preserveOrder, className, }: ItineraryPageProps): React.JSX.Element;
     displayName: string;
 };