@duffel/components 2.7.19 → 3.0.0-canary

package/src/types/CreateOrderPayload.ts

@@ -0,0 +1,99 @@
+import {
+  Offer,
+  OfferAvailableCancelForAnyReasonServiceMetadata,
+  OfferAvailableServiceBaggageMetadata,
+} from "./Offer";
+
+export interface CreateOrderPayload {
+  selected_offers: Array<Offer["id"]>;
+  passengers: CreateOrderPayloadPassengers;
+  services: CreateOrderPayloadServices;
+  payments: Array<CreateOrderPayloadPayment>;
+  type: "instant";
+  metadata: Record<string, string>;
+}
+
+export interface CreateOrderPayloadPassenger {
+  id: string;
+  given_name: string;
+  family_name: string;
+  gender: string;
+  title: string;
+  born_on: string;
+  email?: string;
+  phone_number?: string;
+}
+
+export type CreateOrderPayloadPassengers = Array<CreateOrderPayloadPassenger>;
+
+export type CreateOrderPayloadPaymentType = "balance";
+
+export interface CreateOrderPayloadPayment {
+  type: CreateOrderPayloadPaymentType;
+  amount: string;
+  currency: string;
+}
+
+export type CreateOrderPayloadServices = CreateOrderPayloadService[];
+
+export interface CreateOrderPayloadService {
+  id: string;
+  quantity: number;
+
+  /** `serviceInformation` is meant for:
+   * 1. internal use within the Duffel Ancillaries component, so it is convenient to augument selected services with data about it.
+   * 2. When `onPayloadReady` is ready, we'll return selected bags and seat services along with the `serviceInformation` to allow consumer to enrich their price breakdown.
+   *
+   * Note: `serviceInformation` is not known by the Duffel API.
+   */
+  serviceInformation?: CreateOrderPayloadServiceInformation;
+}
+
+export interface CreateOrderPayloadSeatService {
+  id: string;
+  quantity: number;
+
+  /** `serviceInformation` is meant for:
+   * 1. internal use within the Duffel Ancillaries component, so it is convenient to augument selected services with data about it.
+   * 2. When `onPayloadReady` is ready, we'll return selected bags and seat services along with the `serviceInformation` to allow consumer to enrich their price breakdown.
+   *
+   * Note: `serviceInformation` is not known by the Duffel API.
+   */
+  serviceInformation?: CreateOrderPayloadServiceInformationForSeats;
+}
+
+type CreateOrderPayloadServiceInformation =
+  | CreateOrderPayloadServiceInformationForSeats
+  | CreateOrderPayloadServiceInformationForBags
+  | CreateOrderPayloadServiceInformationForCancelForAnyReason;
+
+interface CreateOrderPayloadCommonServiceInformation {
+  segmentId: string;
+  passengerId: string;
+  passengerName: string;
+  total_amount: string;
+  total_currency: string;
+}
+
+export interface CreateOrderPayloadServiceInformationForSeats
+  extends CreateOrderPayloadCommonServiceInformation {
+  type: "seat";
+  designator: string;
+  disclosures: string[];
+}
+
+export type CreateOrderPayloadServiceInformationForBags =
+  CreateOrderPayloadCommonServiceInformation &
+    OfferAvailableServiceBaggageMetadata;
+
+export type CreateOrderPayloadServiceInformationForCancelForAnyReason = {
+  type: "cancel_for_any_reason";
+} & Pick<
+  CreateOrderPayloadCommonServiceInformation,
+  /**
+   * only using `total_amount` and `total_currency` from `CreateOrderPayloadCommonServiceInformation`
+   * because the cancel for any reason service applies to the whole order, not a specific segment or passenger
+   */
+  "total_amount" | "total_currency"
+> &
+  OfferAvailableCancelForAnyReasonServiceMetadata;

package/src/types/CurrencyConversion.ts

@@ -0,0 +1,10 @@
+export interface CurrencyConversion {
+  /**
+   * currency The ISO-4217 currency code to be used
+   */
+  currency: string;
+  /**
+   * Conversion multiple to be applied to all prices
+   */
+  rate: number;
+}

package/src/types/DuffelAncillariesProps.ts

@@ -0,0 +1,108 @@
+import {
+  CreateOrderPayload,
+  CreateOrderPayloadServices,
+} from "./CreateOrderPayload";
+import {
+  Offer,
+  OfferAvailableServiceBaggage,
+  OfferAvailableServiceCancelForAnyReason,
+} from "./Offer";
+import { SeatMap, SeatMapCabinRowSectionAvailableService } from "./SeatMap";
+
+export type DuffelAncillariesProps =
+  | DuffelAncillariesPropsWithOfferIdForFixture
+  | DuffelAncillariesPropsWithClientKeyAndOfferId
+  | DuffelAncillariesPropWithOfferAndClientKey
+  | DuffelAncillariesPropsWithOffersAndSeatMaps;
+
+export interface DuffelAncillariesCommonProps {
+  styles?: CustomStyles;
+  onPayloadReady: OnPayloadReady;
+  passengers: CreateOrderPayload["passengers"];
+  services: Ancillaries[];
+  markup?: DuffelAncillariesMarkup;
+  priceFormatters?: DuffelAncillariesPriceFormatters;
+  debug?: boolean;
+}
+
+export interface DuffelAncillariesPropsWithOfferIdForFixture
+  extends DuffelAncillariesCommonProps {
+  offer_id: `fixture_${string}`;
+}
+
+export interface DuffelAncillariesPropsWithClientKeyAndOfferId
+  extends DuffelAncillariesCommonProps {
+  offer_id: string;
+  client_key: string;
+}
+
+export interface DuffelAncillariesPropWithOfferAndClientKey
+  extends DuffelAncillariesCommonProps {
+  offer: Offer;
+  client_key: string;
+}
+
+export interface DuffelAncillariesPropsWithOffersAndSeatMaps
+  extends DuffelAncillariesCommonProps {
+  offer: Offer;
+  seat_maps: SeatMap[];
+}
+
+export type DuffelAncillariesMarkupDefinition = {
+  rate: number;
+  amount: number;
+};
+
+export interface DuffelAncillariesMarkup {
+  bags?: DuffelAncillariesMarkupDefinition;
+  seats?: DuffelAncillariesMarkupDefinition;
+  cancel_for_any_reason?: DuffelAncillariesMarkupDefinition;
+}
+
+export type DuffelAncillariesPriceFormatterForBags = (
+  amount: number,
+  currency: string,
+  service: OfferAvailableServiceBaggage
+) => { amount: number; currency?: string };
+
+export type DuffelAncillariesPriceFormatterForSeats = (
+  amount: number,
+  currency: string,
+  service: SeatMapCabinRowSectionAvailableService
+) => { amount: number; currency?: string };
+
+export type DuffelAncillariesPriceFormatterForCancelForAnyReason = (
+  amount: number,
+  currency: string,
+  service: OfferAvailableServiceCancelForAnyReason
+) => { amount: number; currency: string };
+
+export interface DuffelAncillariesPriceFormatters {
+  bags?: DuffelAncillariesPriceFormatterForBags;
+  seats?: DuffelAncillariesPriceFormatterForSeats;
+  cancel_for_any_reason?: DuffelAncillariesPriceFormatterForCancelForAnyReason;
+}
+
+export interface CustomStyles {
+  accentColor?: string;
+  buttonCornerRadius?: string;
+  fontFamily?: string;
+}
+
+export type OnPayloadReady = (
+  data: CreateOrderPayload,
+  metadata: OnPayloadReadyMetadata
+) => void;
+
+export interface OnPayloadReadyMetadata {
+  offer_total_amount: Offer["total_amount"];
+  offer_total_currency: Offer["total_currency"];
+  offer_tax_amount: Offer["tax_amount"];
+  offer_tax_currency: Offer["tax_currency"];
+
+  baggage_services: CreateOrderPayloadServices;
+  seat_services: CreateOrderPayloadServices;
+  cancel_for_any_reason_services: CreateOrderPayloadServices;
+}
+
+export type Ancillaries = "bags" | "seats" | "cancel_for_any_reason";