@amos.com/react-amos-js 0.11.14 → 0.11.17

package/README.md

@@ -43,8 +43,8 @@ The following flow is for credit card and bank account payment method types only
 3. **User clicks "Pay now" or presses Enter in the iframe**: call `validateForm({ iframeRef })`, which returns `Promise<true>` if the embedded form is valid and `Promise<false>` otherwise.
 4. **Create payment intent on your server**: use your server-side Amos client to call `POST /payment_intents`. You may also associate this payment intent with a new or existing customer via `POST /customers`. This must be server-side because it uses your private API key.
 5. **Return the payment intent token to the browser**: your backend responds with the embed token (`components["schemas"]["EmbedToken"]`) needed for confirmation.
-6. **Confirm the payment intent from the client**: `await confirmPayment({ iframeRef, token })`. It resolves `{ status: "succeeded", paymentIntent }` or `{ status: "failed", paymentIntent? }`.
-7. **Handle UX**: show the user a "processing" state while awaiting `confirmPayment`. Do not treat `{ status: "succeeded" }` as settlement proof — verify payment success on your backend via webhooks. Recoverable field errors stay in the iframe; `confirmPayment` still resolves `{ status: "failed" }` (with `paymentIntent` when the confirm API returned a body, including `last_payment_error` on declines).
+6. **Confirm the payment intent from the client**: `await confirmPayment({ iframeRef, token })`. It resolves `{ status: "succeeded", paymentIntent }`, `{ status: "failed", paymentIntent? }` on decline, or `{ status: "failed", error: "timeout" }` if the iframe does not respond within 15 seconds (`isConfirmTimeout(result)`).
+7. **Handle UX**: show the user a "processing" state while awaiting `confirmPayment`. Do not treat `{ status: "succeeded" }` as settlement proof — verify payment success on your backend via webhooks. Recoverable field errors stay in the iframe; a processor decline still resolves `{ status: "failed" }` (with `paymentIntent` when the confirm API returned a body — inspect `paymentIntent.state`). A timeout is **not** a decline — the charge may still settle; do not retry as a new payment.
 
 ### Google Pay & Apple Pay
 
@@ -508,7 +508,7 @@ Validates the embedded card/bank iframe form before payment confirmation.
 
 ### `confirmPayment({ iframeRef, token, defaultValues? })`
 
-Confirms a payment intent in the embedded iframe flow. Resolves `{ status: "succeeded", paymentIntent }` or `{ status: "failed", paymentIntent? }`. Optional `defaultValues` are applied immediately before building the payment method (including hidden name and extra billing fields) and do not replace the last `defaultValues` prop used by `resetForm`.
+Confirms a payment intent in the embedded iframe flow. Resolves `{ status: "succeeded", paymentIntent }`, `{ status: "failed", paymentIntent? }` on decline, or `{ status: "failed", error: "timeout" }` if the iframe does not respond within 15 seconds (`CONFIRM_TIMEOUT_MS`). Optional `defaultValues` are applied immediately before building the payment method (including hidden name and extra billing fields) and do not replace the last `defaultValues` prop used by `resetForm`.
 
 **Parameters:**
 
@@ -516,11 +516,11 @@ Confirms a payment intent in the embedded iframe flow. Resolves `{ status: "succ
 - `token` (typed as `Pick<components["schemas"]["EmbedToken"], "token">` — the embed JWT string returned by your server)
 - `defaultValues` (`PaymentMethodFormDefaultValues`, optional)
 
-**Returns:** `Promise<ConfirmPaymentResult>`
+**Returns:** `Promise<ConfirmPaymentResult>` — use `isConfirmTimeout(result)` to treat a timeout as uncertain (do not retry). Embed aborts hung `/confirm` at 10s and posts the same timeout result; the SDK wait is strictly above that.
 
 ### `confirmSetup({ iframeRef, token, defaultValues? })`
 
-Confirms a setup intent in the embedded iframe flow. Use this when saving a payment method for future use. Optional `defaultValues` behave the same as on `confirmPayment`.
+Confirms a setup intent in the embedded iframe flow. Use this when saving a payment method for future use. Optional `defaultValues` behave the same as on `confirmPayment`. Same 15-second timeout window and `isConfirmTimeout` rule as `confirmPayment`.
 
 **Parameters:**
 
@@ -580,7 +580,7 @@ Enter in a card or bank iframe field submits the enclosing host `<form>` via `re
 
 Renders the secure bank account iframe form. A field-shaped skeleton is shown immediately (sized from `appearance`, including resting `.Input` / `.Label` rules) and replaced by the iframe once appearance is applied.
 
-When `requireAchVerification` is true (or `intent` is `"setup"`), and the render token allows verification, the SDK hides the routing/account iframe and mounts [Plaid Embedded Institution Search](https://plaid.com/docs/link/embedded-institution-search/) in the parent. Hosts do not proxy Pay API (`GET /merchants`, `POST /plaid_link_tokens`); embed does that with `PAY_API_KEY`. Do not put Plaid secrets in the browser.
+When `requireAchVerification` is true (or `intent` is `"setup"`), and the render token allows verification, the SDK hides the routing/account iframe and mounts [Plaid Embedded Institution Search](https://plaid.com/docs/link/embedded-institution-search/) in the parent. A **350px pulse skeleton** covers that slot until Plaid's `onLoad` (1.5s fallback). Do not overlay a host loader. Hosts do not proxy Pay API (`GET /merchants`, `POST /plaid_link_tokens`); embed does that with `PAY_API_KEY`. Do not put Plaid secrets in the browser.
 
 **Required props:** same as `AmosCreditCardPaymentMethodForm` — `renderToken`.
 
@@ -695,12 +695,12 @@ Re-export from `@amos.com/amos-js`. Fills omitted Inter `fonts` / `--font-family
 ## Notes and potential gotchas
 
 - **`ref` / `iframeRef`**: for card and bank forms, pass `ref={iframeRef}` to the form component. The same `iframeRef` must be used when calling `validateForm`, `confirmPayment`, `confirmSetup`, `resetForm`, or `focusField`. The component forwards the ref to the inner iframe.
-- **`confirmPayment` / `confirmSetup` are not settlement proof**: `{ status: "succeeded" }` means authorization succeeded (capture may still finish asynchronously). Verify payment or setup success on your backend via webhooks. Recoverable field errors stay in the iframe; the Promise still resolves `{ status: "failed" }`. Declined confirms include the intent so you can read `last_payment_error` without a follow-up GET.
+- **`confirmPayment` / `confirmSetup` are not settlement proof**: `{ status: "succeeded" }` means authorization succeeded (capture may still finish asynchronously). Verify payment or setup success on your backend via webhooks. Recoverable field errors stay in the iframe; a processor decline still resolves `{ status: "failed" }`. Declined confirms include the intent so you can read `state` without a follow-up GET. If the iframe never answers, the Promise resolves `{ status: "failed", error: "timeout" }` after 15 seconds (`CONFIRM_TIMEOUT_MS`, `isConfirmTimeout`) — that is uncertain, not a decline; do not retry as a new payment.
 - **Same components for payment vs setup intents**: `AmosCreditCardPaymentMethodForm` and `AmosBankAccountPaymentMethodForm` support both payment intents and setup intents. The flow differs only by which server call you make and which confirmation function you use (`confirmPayment` vs `confirmSetup`).
 - **Amount format**: for `AmosGooglePayButton` and `AmosApplePayButton`, `amount` is a major-currency decimal string (e.g. `"50.00"` for $50.00). For `components["schemas"]["CreatePaymentIntentInput"]` on the server (card/bank create, and the object the wallet iframe sends to `onConfirm`), `amount` is a number in cents (e.g. `5000`).
 - **Embed host / CSP**: iframes load from `https://js.amos.com` (production) and `https://js-sandbox.amos.com` (sandbox) via `getEmbedOrigin`. Parent pages that pin CSP must allow `frame-src https://js.amos.com https://js-sandbox.amos.com` (and `Permissions-Policy payment=` for those origins) **before** upgrading this package. Older SDK versions still load `embed.amos.com` / `embed-sandbox.amos.com`.
 - **Iframe handshake**: iframe URLs include canonical search params so the embed does not 307. If the document loads but never posts `IFRAME_READY`, the SDK rewrites `src` once with `amosReload`. Appearance is applied after handshake; the iframe stays hidden until `UPDATED_APPEARANCE`, or for 1.5s after `IFRAME_READY` if appearance never acks.
-- **Plaid Embedded Link (ACH verification)**: load `cdn.plaid.com` from the **parent** document (see CSP on `AmosBankAccountPaymentMethodForm`). Merchants do not proxy Pay API; the bank iframe mints link tokens. Pass `requireAchVerification` when the host wants Plaid, or `intent="setup"` to always show it, unless the render token disables verification. Confirm still goes through the bank iframe so Amos can attach `plaid` to the payment method.
+- **Plaid Embedded Link (ACH verification)**: load `cdn.plaid.com` from the **parent** document (see CSP on `AmosBankAccountPaymentMethodForm`). Merchants do not proxy Pay API; the bank iframe mints link tokens. Pass `requireAchVerification` when the host wants Plaid, or `intent="setup"` to always show it, unless the render token disables verification. Confirm still goes through the bank iframe so Amos can attach `plaid` to the payment method. While Link loads, the SDK shows a 350px pulse skeleton until `onLoad` (1.5s fallback) — do not overlay a host loader.
 - **Apple Pay waiting overlay**: on browsers where Apple's QR handoff opens in a popup (non-Safari), `AmosApplePayButton` shows a fixed full-viewport overlay on the host page. **Cancel payment** is available until the buyer authorizes; after that the overlay shows **Completing your payment…** with no Cancel, then hides when `onConfirm` settles. Avoid stacking other fixed UI above it.
 - **Going framework-free**: if you need to use Amos outside of React (vanilla JS, another framework, etc.), use [`@amos.com/amos-js`](../amos-js) directly.
 

package/dist/index.d.ts

@@ -19,6 +19,14 @@ export declare function validateForm({ iframeRef, }: {
  *
  * Pass the embed JWT (`token`) returned by your server's
  * `POST /payment_intents` call.
+ *
+ * Resolves `{ status: "succeeded", paymentIntent }` after authorization,
+ * `{ status: "failed", paymentIntent? }` on decline, or
+ * `{ status: "failed", error: "timeout" }` if the iframe does not post
+ * `CONFIRMATION_RESULT` within 15 seconds (`CONFIRM_TIMEOUT_MS`). Use
+ * `isConfirmTimeout(result)` — a timeout is not a decline; the charge
+ * may still settle. Embed `/confirm` aborts at 10s and posts the same
+ * timeout result.
  */
 export declare function confirmPayment({ iframeRef, token, defaultValues, }: {
     iframeRef: IframeRef;
@@ -30,6 +38,12 @@ export declare function confirmPayment({ iframeRef, token, defaultValues, }: {
  *
  * Pass the embed JWT (`token`) returned by your server's
  * `POST /setup_intents` call.
+ *
+ * Resolves `{ status: "succeeded", setupIntent }` after verification,
+ * `{ status: "failed", setupIntent? }` on decline, or
+ * `{ status: "failed", error: "timeout" }` if the iframe does not
+ * respond within 15 seconds. Same `isConfirmTimeout` rule as
+ * {@link confirmPayment}.
  */
 export declare function confirmSetup({ iframeRef, token, defaultValues, }: {
     iframeRef: IframeRef;
@@ -117,9 +131,10 @@ type AmosBankAccountPaymentMethodFormProps = IframePassthroughProps & {
     defaultValues?: PaymentMethodFormDefaultValues;
     /**
      * When true, hide the routing/account iframe and mount Plaid Embedded
-     * Institution Search in the parent. Ignored when `intent` is `"setup"`
-     * (setup always shows Plaid) or when the render token disables
-     * verification.
+     * Institution Search in the parent. A 350px pulse skeleton covers the
+     * slot until Plaid's `onLoad` (1.5s fallback). Ignored when `intent`
+     * is `"setup"` (setup always shows Plaid) or when the render token
+     * disables verification.
      *
      * @default false
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amos.com/react-amos-js",
-  "version": "0.11.14",
+  "version": "0.11.17",
   "main": "dist/index.js",
   "repository": {
     "type": "git",
@@ -57,7 +57,7 @@
     "vite-plugin-dts": "5.0.3"
   },
   "dependencies": {
-    "@amos.com/amos-js": "0.11.15",
+    "@amos.com/amos-js": "0.11.17",
     "@types/googlepay": "0.7.12"
   },
   "peerDependencies": {

package/src/index.tsx

@@ -63,6 +63,14 @@ export function validateForm({
  *
  * Pass the embed JWT (`token`) returned by your server's
  * `POST /payment_intents` call.
+ *
+ * Resolves `{ status: "succeeded", paymentIntent }` after authorization,
+ * `{ status: "failed", paymentIntent? }` on decline, or
+ * `{ status: "failed", error: "timeout" }` if the iframe does not post
+ * `CONFIRMATION_RESULT` within 15 seconds (`CONFIRM_TIMEOUT_MS`). Use
+ * `isConfirmTimeout(result)` — a timeout is not a decline; the charge
+ * may still settle. Embed `/confirm` aborts at 10s and posts the same
+ * timeout result.
  */
 export function confirmPayment({
   iframeRef,
@@ -88,6 +96,12 @@ export function confirmPayment({
  *
  * Pass the embed JWT (`token`) returned by your server's
  * `POST /setup_intents` call.
+ *
+ * Resolves `{ status: "succeeded", setupIntent }` after verification,
+ * `{ status: "failed", setupIntent? }` on decline, or
+ * `{ status: "failed", error: "timeout" }` if the iframe does not
+ * respond within 15 seconds. Same `isConfirmTimeout` rule as
+ * {@link confirmPayment}.
  */
 export function confirmSetup({
   iframeRef,
@@ -397,9 +411,10 @@ type AmosBankAccountPaymentMethodFormProps = IframePassthroughProps & {
   defaultValues?: PaymentMethodFormDefaultValues;
   /**
    * When true, hide the routing/account iframe and mount Plaid Embedded
-   * Institution Search in the parent. Ignored when `intent` is `"setup"`
-   * (setup always shows Plaid) or when the render token disables
-   * verification.
+   * Institution Search in the parent. A 350px pulse skeleton covers the
+   * slot until Plaid's `onLoad` (1.5s fallback). Ignored when `intent`
+   * is `"setup"` (setup always shows Plaid) or when the render token
+   * disables verification.
    *
    * @default false
    */