@duffel/components 3.1.3--prototype.12 → 3.1.3--prototype.14

package/types/Order.d.ts

@@ -0,0 +1,8 @@
+export type Order = {
+    id: string;
+    [any: string]: any;
+    slices: {
+        segments: any[];
+    }[];
+};
+export type OrderAvailableService = any;

package/types/Place.d.ts

@@ -0,0 +1,8 @@
+import { Airport } from "./Airport";
+import { City } from "./City";
+export type Place = (Airport & {
+    type?: "airport";
+    airports?: Airport[] | null;
+}) | (City & {
+    type?: "city";
+});

package/types/SeatMap.d.ts

@@ -0,0 +1,190 @@
+/**
+ * Seat maps are used to build a rich experience for your customers so they can select a seat as part of an order.
+ * A seat map includes the data for rendering seats in the relevant cabins, along with their total cost and other information such as disclosures.
+ * @link https://duffel.com/docs/api/seat-maps/schema
+ */
+export interface SeatMap {
+    /**
+     * Duffel's unique identifier for the seat map
+     */
+    id: string;
+    /**
+     * Duffel's unique identifier for the slice. It identifies the slice of an offer (i.e. the same slice across offers will have different ids.)
+     */
+    slice_id: string;
+    /**
+     * Duffel's unique identifier for the segment. It identifies the segment of an offer (i.e. the same segment across offers will have different ids).
+     */
+    segment_id: string;
+    /**
+     * The list of cabins in this seat map.
+     * Cabins are ordered by deck from lowest to highest, and then within each deck from the front to back of the aircraft.
+     */
+    cabins: SeatMapCabin[];
+}
+export interface SeatMapCabin {
+    /**
+     * Level 0 is the main deck and level 1 is the upper deck above that, which is found on some large aircraft.
+     */
+    deck: number;
+    /**
+     * The cabin class that the passenger will travel in on this segment
+     */
+    cabin_class: string;
+    /**
+     * Where the wings of the aircraft are in relation to rows in the cabin.
+     * The numbers correspond to the indices of the first and the last row which are overwing. You can use this to draw a visual representation of the wings to help users get a better idea of what they will see outside their window.
+     * The indices are 0 th-based and are for all rows, not just those that have seats.
+     * This is null when no rows of the cabin are overwing.
+     */
+    wings: {
+        /**
+         * The index of the first row which is overwing, starting from the front of the aircraft.
+         */
+        first_row_index: number;
+        /**
+         * The index of the last row which is overwing, starting from the front of the aircraft.
+         */
+        last_row_index: number;
+    } | null;
+    /**
+     * The number of aisles in this cabin.
+     * If this is set to 1, each row of the cabin is split into two sections. If this is set to 2, each row of the cabin is split into three section.
+     */
+    aisles: number;
+    /**
+     * A list of rows in this cabin.
+     * Row sections are broken up by aisles. Rows are ordered from front to back of the aircraft.
+     */
+    rows: SeatMapCabinRow[];
+}
+export interface SeatMapCabinRow {
+    /**
+     * A list of sections.
+     * Each row is divided into sections by one or more aisles.
+     */
+    sections: SeatMapCabinRowSection[];
+}
+export interface SeatMapCabinRowSection {
+    /**
+     * The elements that make up this section.
+     */
+    elements: SeatMapCabinRowSectionElement[];
+}
+/**
+ * A seat for a passenger. If the available_services list is empty (which will be represented as an empty list : []), the seat is unavailable.
+ * For display, all seats should be displayed with the same static width.
+ */
+export interface SeatMapCabinRowSectionElementSeat {
+    /**
+     * The type of this element.
+     */
+    type: "seat";
+    /**
+     * The designator used to uniquely identify the seat, usually made up of a row number and a column letter
+     */
+    designator: string;
+    /**
+     * A name which describes the type of seat, which you can display in your user interface to help customers to understand its features
+     */
+    name?: string;
+    /**
+     * Each disclosure is text, in English, provided by the airline that describes the terms and conditions of this seat. We recommend showing this in your user interface to make sure that customers understand any restrictions and limitations.
+     */
+    disclosures: string[];
+    /**
+     * Seats are considered a special kind of service. There will be at most one service per seat per passenger. A seat can only be booked for one passenger. If a seat has no available services (which will be represented as an empty list : []) then it's unavailable.
+     */
+    available_services: SeatMapCabinRowSectionAvailableService[];
+}
+export interface SeatMapCabinRowSectionAvailableService {
+    /**
+     * Duffel's unique identifier for the service
+     */
+    id: string;
+    /**
+     * The passenger that this seat is for
+     */
+    passenger_id: string;
+    /**
+     * The total price of the seat, including taxes
+     */
+    total_amount: string;
+    /**
+     * The currency of the total_amount, as an ISO 4217 currency code
+     */
+    total_currency: string;
+}
+/**
+ * A bassinet is a child's cradle. This element will be aligned with the corresponding seat in the following row.
+ * For display, this element should have the same width as a seat for proper alignment.
+ */
+export interface SeatMapCabinRowSectionElementBassinet {
+    /**
+     * The type of this element.
+     */
+    type: "bassinet";
+}
+/**
+ * An empty space used for padding in some non-standard seat arrangements.
+ * For display, this element should have the same dimensions as a seat for proper alignment.
+ */
+export interface SeatMapCabinRowSectionElementEmpty {
+    /**
+     * The type of this element.
+     */
+    type: "empty";
+}
+/**
+ * An exit row represents the extra wide legroom used to reach aircraft exits. There is one exit_row element per row section.
+ * Exit row elements only occur in their own row, so they can be displayed as one element across the whole row. Displaying an exit row element filling all available space in its section or using the same width as the seat is also reasonable.
+ */
+export interface SeatMapCabinRowSectionElementExitRow {
+    /**
+     * The type of this element.
+     */
+    type: "exit_row";
+}
+/**
+ * A lavatory for use by passengers.
+ * For display, this element should ideally fill or shrink to available space in a row section. Displaying it with the same width as seat is also reasonable.
+ */
+export interface SeatMapCabinRowSectionElementLavatory {
+    /**
+     * The type of this element.
+     */
+    type: "lavatory";
+}
+/**
+ * A galley is the compartment where food is cooked or prepared. These are conventionally marked with a teacup symbol.
+ * For display, this element should ideally fill or shrink to available space in a row section. Displaying it with the same width as seat is also reasonable.
+ */
+export interface SeatMapCabinRowSectionElementGalley {
+    /**
+     * The type of this element.
+     */
+    type: "galley";
+}
+/**
+ * A closet used for storage. These are conventionally marked with a clothes hanger symbol.
+ * For display, this element should ideally fill or shrink to available space in a row section. Displaying it with the same width as seat is also reasonable.
+ */
+export interface SeatMapCabinRowSectionElementCloset {
+    /**
+     * The type of this element.
+     */
+    type: "closet";
+}
+/**
+ * A set of stairs to another deck.
+ * For display, this element should ideally fill or shrink to available space in a row section. Displaying it with the same width as seat is also reasonable.
+ */
+export interface SeatMapCabinRowSectionElementStairs {
+    /**
+     * The type of this element.
+     */
+    type: "stairs";
+}
+export type SeatMapCabinRowSectionElement = SeatMapCabinRowSectionElementSeat | SeatMapCabinRowSectionElementBassinet | SeatMapCabinRowSectionElementEmpty | SeatMapCabinRowSectionElementExitRow | SeatMapCabinRowSectionElementLavatory | SeatMapCabinRowSectionElementGalley | SeatMapCabinRowSectionElementCloset | SeatMapCabinRowSectionElementStairs;
+export type SeatMapCabinRowSectionElementType = SeatMapCabinRowSectionElement["type"];
+export type SeatMapCabinRowSectionElementAmenity = Exclude<SeatMapCabinRowSectionElementType, "empty" | "seat">;

package/types/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./Aircraft";
+export * from "./Airline";
+export * from "./Airport";
+export * from "./City";
+export * from "./CreateOrderPayload";
+export * from "./CurrencyConversion";
+export * from "./DuffelAncillariesProps";
+export * from "./Offer";
+export * from "./Order";
+export * from "./Place";
+export * from "./SeatMap";

package/README.md

@@ -1,68 +0,0 @@
-# @duffel/components
-
-This package is a component library to help you build your travel product using the [Duffel API](https://duffel.com/docs).
-
-## Get started
-
-### Installing
-
-```sh
-yarn add @duffel/components
-# -- or --
-npm i @duffel/components
-```
-
-### (alternative) Load from CDN:
-
-```html
-<script src="https://assets.duffel.com/components/VERSION/duffel-ancillaries.js"></script>
-<script src="https://assets.duffel.com/components/VERSION/duffel-payments.js"></script>
-```
-
-## How do I integrate this into my website?
-
-1. Please start by reading our integration guide on https://duffel.com/docs/guides/ancillaries-component
-
-## Integration examples
-
-1. **client-side** | This example loads a local version of the components using a `script` tag. It uses a fixture for the offer and seat maps.
-
-   - [Find it on src/examples/client-side](src/examples/client-side)
-
-2. **full-stack** | This example loads a local version of the components using a `script` tag. It will search and retrieve an offer from the Duffel API and render the ancillaries component custom element with its `offer_id` and `client_key`. As soon as a service modal is closed it will create a test order with the given payload.
-
-   - [Find it on src/examples/full-stack](src/examples/full-stack)
-
-3. **just-typescript** | This example imports a local version of `@duffel/components` and renders the custom element with an offer fixture once the page loads.
-
-   - [Find it on src/examples/just-typescript](src/examples/just-typescript)
-
-4. **react-app** | This example imports a local version of `@duffel/components` and renders the a react element with an offer fixture.
-
-   - [Find it on src/examples/react-app](src/examples/react-app)
-
-5. **payments-custom-element** | This example demonstrates the use of the payments component loaded through a script tag
-
-- [Find it on src/examples/payments-custom-element](src/examples/payments-custom-element)
-
-6. **payments-just-typescript** | This example imports a local version of `@duffel/components` and renders the payments custom element with a fixture of the payment intent.
-
-   - [Find it on src/examples/payments-just-typescript](src/examples/payments-just-typescript)
-
-7. **next** | This example imports and renders `@duffel/components` into a `next.js` project.
-
-   - [Find it on src/examples/payments-just-typescript](src/examples/next)
-
-## What components are available?
-
-### Ancillaries component
-
-The ancillaries component allows your customers to add ancillaries to their order. It's simple to add to your website and can be customised to fit your brand. This component is avaiable through npm and our cdn.
-
-- [Find live demo on codesandbox.io&nbsp;&nbsp;↗](https://codesandbox.io/s/duffel-ancillaries-example-1nxuu7)
-
-### Payments component
-
-The payments component provides a [PCI-compliant](https://help.duffel.com/hc/en-gb/articles/4409049543058) way for you to collect card payments for online bookings from your customers. To learn more about how to work with Duffel payments please visit the [Collecting customer card payments guide](https://duffel.com/docs/guides/collecting-customer-card-payments).
-
-#### more coming soon...