How bigcommerce/checkout-js works
Checkout JS is BigCommerce’s browser-based, one-page checkout for shoppers. The principal workflow is entering customer, address, shipping, and payment details and completing checkout; the README establishes the shopper-facing purpose, while the tree shows the distinct checkout stages and payment-provider integrations. The graph also highlights checkout context, hosted card fields, and extension handling as internal layers. Most implementation files were not sampled, so links between checkout stages and provider packages are omitted rather than inferred; extension and hosted-card links reflect the supplied source excerpts.
Main entry points: ExtensionService.ts Extension service · useHostedCreditCard.tsx Hosted card fields · CheckoutApp.tsx Checkout app · index.ts Extension handlers
Components 21
Checkout experience
- Checkout app
packages/core/src/app/checkout/CheckoutApp.tsx - Checkout steps
packages/core/src/app/checkout/CheckoutStep.tsx - Cart summary
packages/core/src/app/cart/CartSummary.tsx - Billing
packages/core/src/app/billing/Billing.tsx - Shipping
packages/core/src/app/shipping/hooks/useShipping.ts - Coupons and gifts
packages/core/src/app/coupon/components/ManageCouponsAndGiftCertificates.tsx - Payment step
packages/core/src/app/checkout/components/PaymentStep.tsx
Customer and addresses
- Customer details
packages/core/src/app/customer/Customer.tsx - Address forms
packages/core/src/app/address/AddressForm.tsx - Company address search
packages/core/src/app/address/useCompanyAddressSearch.ts
Payment methods
- Payment form API
packages/payment-integration-api/src/PaymentFormService.ts - Hosted card fields
packages/hosted-credit-card-integration/src/hooks/useHostedCreditCard.tsx - Card integrations
packages/credit-card-integration/src/CreditCardPaymentMethodComponent.tsx - Wallet integrations
packages/apple-pay-integration/src/ApplePayPaymentMethod.tsx - Provider integrations
packages/adyen-integration/src/adyenv3/AdyenV3PaymentMethod.tsx
Checkout platform
- Checkout context
packages/contexts/src/checkout/useCheckout.tsx - Extension service
packages/checkout-extension/src/ExtensionService.ts - Extension handlers
packages/checkout-extension/src/handler/commandHandlers/index.ts - Extension queries
packages/checkout-extension/src/handler/queryHandlers/QueryHandler.ts - Extension regions
packages/checkout-extension/src/ExtensionRegionContainer.ts
Other components
- Shopper
Connections 8
- Shopper → Checkout app: uses
README.md - Checkout app → Shopper: checkout UI
README.md - Company address search → Checkout context: gets service
packages/core/src/app/address/useCompanyAddressSearch.ts - Hosted card fields → Payment form API: uses form
- Hosted card fields → Extension handlers: renders validation
packages/hosted-credit-card-integration/src/hooks/useHostedCreditCard.tsx - Extension service → Extension handlers: registers commands
packages/checkout-extension/src/ExtensionService.ts - Extension service → Extension queries: registers queries
packages/checkout-extension/src/ExtensionService.ts - Extension service → Extension regions: renders region