@molecule/api-flights-amadeus

Auto-generated, AI-first package reference for the molecule.dev ecosystem. It is written to be read by coding agents as much as by people, and is generated from this package's source — edit src/index.ts JSDoc, not this file.

Amadeus flights provider for molecule.dev.

Implements the FlightsProvider interface against the Amadeus Self-Service v2 flight-offers and v1 flight-offers pricing endpoints. Defaults to the test sandbox (https://test.api.amadeus.com); set AMADEUS_USE_PRODUCTION=true to route to production.

Quick Start

import { setProvider } from '@molecule/api-flights'
import { provider } from '@molecule/api-flights-amadeus'

setProvider(provider)

Type

provider

Installation

npm install @molecule/api-flights-amadeus @molecule/api-flights @molecule/api-secrets

API

Interfaces

AmadeusFlightOffer

Raw flight-offer object returned by Amadeus search and pricing endpoints. Only the fields the provider maps are typed.

interface AmadeusFlightOffer {
  type: string
  id: string
  itineraries: AmadeusItinerary[]
  price: { total: string; currency: string; grandTotal?: string }
  travelerPricings?: AmadeusTravelerPricing[]
  [key: string]: unknown
}

AmadeusFlightsConfig

Configuration options for the Amadeus flights provider.

Amadeus exposes a free Self-Service "test" environment at https://test.api.amadeus.com (sandbox data, generous rate limits) and a paid production environment at https://api.amadeus.com. Set {@link useProduction} (or AMADEUS_USE_PRODUCTION=true env var) to switch.

interface AmadeusFlightsConfig {
  /**
   * Amadeus API client id (a.k.a. API Key). Falls back to
   * `AMADEUS_CLIENT_ID` env var if omitted.
   */
  clientId?: string

  /**
   * Amadeus API client secret. Falls back to `AMADEUS_CLIENT_SECRET` env
   * var if omitted.
   */
  clientSecret?: string

  /**
   * When `true`, routes requests to the production endpoint
   * (`https://api.amadeus.com`). When `false` or omitted, uses the
   * Self-Service test sandbox (`https://test.api.amadeus.com`).
   */
  useProduction?: boolean

  /**
   * Base URL override. Takes precedence over {@link useProduction}.
   */
  baseUrl?: string

  /**
   * Request timeout in milliseconds. Defaults to `15000`.
   */
  timeout?: number

  /**
   * Maximum number of recently-searched offers to retain in memory for
   * subsequent `getOffer` / `priceOffer` calls. Amadeus requires the
   * original offer payload (not just its id) when pricing, so the
   * provider caches offers by id. Defaults to `1000`.
   */
  offerCacheSize?: number
}

Classes

AmadeusMissingCredentialsError

Error thrown by the Amadeus provider when no client credentials are configured.

Never includes any credential value in its message or properties.

AmadeusRateLimitedError

Error thrown by the Amadeus provider when the upstream API rejects a request with HTTP 429 (Too Many Requests).

The error never includes the configured client id / secret in its message or properties.

AmadeusUnknownOfferError

Error thrown by the Amadeus provider when an offer id is passed to getOffer / priceOffer that has not previously been returned from searchFlights.

AmadeusUpstreamError

Error thrown by the Amadeus provider for any other non-OK upstream HTTP response.

Never includes the configured client id / secret in its message or properties.

Functions

createProvider(config)

Creates an Amadeus flights provider.

function createProvider(config?: AmadeusFlightsConfig): FlightsProvider

• config — Provider configuration. All fields are optional but clientId / clientSecret (or their env vars) MUST be set before any method is invoked.

Returns: A {@link FlightsProvider} backed by the Amadeus Self-Service API.

Constants

flightsAmadeusSecretDefinitions

Secret definitions required by the Amadeus flights bond.

const flightsAmadeusSecretDefinitions: SecretDefinition[]

MISSING_CREDENTIALS

Stable error code emitted by the Amadeus provider when neither clientId nor clientSecret (nor their env-var fallbacks) are configured.

const MISSING_CREDENTIALS: 'MISSING_CREDENTIALS'

provider

The provider implementation, lazily initialized on first use.

Reads AMADEUS_CLIENT_ID, AMADEUS_CLIENT_SECRET, AMADEUS_USE_PRODUCTION, and AMADEUS_BASE_URL from environment variables.

const provider: FlightsProvider

RATE_LIMITED

Stable error code emitted by the Amadeus provider when the upstream API returns HTTP 429 (Too Many Requests).

Catch on this constant rather than parsing error messages — the message text is for humans only.

const RATE_LIMITED: 'RATE_LIMITED'

UNKNOWN_OFFER

Stable error code emitted by the Amadeus provider when an offer id is passed to getOffer / priceOffer that the provider has not previously returned from searchFlights. Amadeus requires the original offer payload to price; consumers MUST searchFlights before getOffer/priceOffer.

const UNKNOWN_OFFER: 'UNKNOWN_OFFER'

UPSTREAM_ERROR

Stable error code emitted by the Amadeus provider for any other non-OK upstream HTTP response.

const UPSTREAM_ERROR: 'UPSTREAM_ERROR'

Core Interface

Implements @molecule/api-flights interface.

Bond Wiring

Setup function to register this provider with the core interface:

import { setProvider } from '@molecule/api-flights'
import { provider } from '@molecule/api-flights-amadeus'

export function setupFlightsAmadeus(): void {
  setProvider(provider)
}

Injection Notes

Requirements

Peer dependencies:

• @molecule/api-flights ^1.0.1
• @molecule/api-secrets ^1.0.1

Environment Variables

• AMADEUS_CLIENT_ID (required) — Amadeus API key
  • Setup: Create an app in Amadeus for Developers (Self-Service) and copy the API Key.
  • Get it here: https://developers.amadeus.com/my-apps
• AMADEUS_CLIENT_SECRET (required) — Amadeus API secret
  • Setup: Copy the API Secret from your Amadeus app page.
  • Get it here: https://developers.amadeus.com/my-apps

Runtime Dependencies

• @molecule/api-flights

• @molecule/api-secrets

• getOffer()/priceOffer() resolve offer ids from an in-process cache populated by searchFlights() (bounded, default 1000 offers, offerCacheSize config). An id from another process/instance, from before a restart, or already evicted throws AmadeusUnknownOfferError — search and price within the same process, and re-run the search rather than replaying stored ids.

• Test keys only work against the TEST host (the default) and production keys only against production — AMADEUS_USE_PRODUCTION=true must match the key type. @molecule/api-hotels-amadeus shares the same AMADEUS_CLIENT_ID/AMADEUS_CLIENT_SECRET AND defaults to the same TEST host, and reads the same AMADEUS_USE_PRODUCTION switch — so one env setting flips both bonds together; no per-bond host alignment needed.

• HTTP 429 throws AmadeusRateLimitedError carrying retryAfter seconds when the upstream provides it — back off; don't retry immediately.

E2E Tests

Integration checklist — drive the real UI (live preview, no mocks), adapt each item to this app's actual search / results screens, and check every box off one by one. A box you can't check is an integration bug to fix — not a skip:

• Searching a real route + future date (e.g. JFK→LHR, a date weeks out) returns REAL searchFlights offers rendered in the results list — each showing an origin, a destination, departure/arrival times, and a price. No empty list, null, or placeholder row is presented as a successful search.
• Results match the query: each offer's first segment.departure.airport and last segment.arrival.airport are the searched cities and the departure.at falls on the requested date — not random routes or dates.
• Every price shows its currency (ISO 4217, formatted with it — never a hardcoded $) and is sane (positive, right order of magnitude). If a checkout/summary step re-prices via priceOffer/getOffer, the displayed total is the re-priced figure, not the stale search-time price.
• Any exposed filter/sort (price, stops, departure/arrival time, cabin) actually narrows or reorders the SAME result set — not a fresh random list.
• An impossible or invalid search — no availability, a past date, or a bad airport code — shows a clear "no flights" / "invalid" state, not a crash and not a blank list presented as a successful search.
• A provider outage or rate-limit (HTTP 429) surfaces as a graceful, retryable error in the UI — not a hung spinner or a silent empty list.
• This contract is search + pricing ONLY (there is no bookFlight). If the app adds a book/hold step it goes OUT-OF-BAND to the vendor — verify the app records the SELECTED offer (its priced total + itinerary), since opaque OfferIds are short-lived and can't be replayed later.
• The provider API key stays server-side: searches run through the API bond and no key or upstream credential is ever exposed to the browser.