@rebilly/framepay 5.259.1 → 5.260.0

package/dist/index.d.ts

@@ -44,12 +44,13 @@ export declare class ApplePayElement {
     on: ApplePayElementBusOn;
 }
 
-export declare type ApplePayElementBusOn = <T extends keyof ApplePayElementEventMap>(event: T, fn: (...args: ApplePayElementEventMap[T]) => void) => void;
+export declare type ApplePayElementBusOn = WalletElementBusOn;
 
-export declare interface ApplePayElementEventMap {
-    ready: [];
-    error: [FramepayError];
-}
+/**
+ * The Apple Pay element has the events of every wallet element. These names
+ * are kept for the published types.
+ */
+export declare type ApplePayElementEventMap = WalletElementEventMap;
 
 /**
  * Abstraction layer for the IframeElement set to become a bban account field.
@@ -376,7 +377,12 @@ export declare class FieldNotification {
         readonly blur: "blur";
         readonly ready: "ready";
         readonly clearExternalInvalid: "clear-external-invalid";
+        readonly walletReady: "wallet-ready";
+        readonly walletError: "wallet-error";
     };
+
+
+
     type: FieldNotificationType;
     content: NotificationContent | FieldError;
     constructor({ type, content }: NotificationArgs);
@@ -598,6 +604,10 @@ export declare interface GooglePayConfig {
 /**
  * Abstraction layer for the IframeElement set to become a Google Pay field.
  * Used to hide the internal implementation.
+ *
+ * The button runs in the field frame. The frame tells this element when the
+ * button is displayed, or cannot be, and the element emits that as its
+ * `ready` and `error`: the same contract as the Apple Pay element.
  */
 export declare class GooglePayElement {
     #private;
@@ -605,7 +615,7 @@ export declare class GooglePayElement {
     mount(): void;
     unmount(): void;
     destroy(): void;
-    on(eventType: never, _delegate: never): void;
+    on: WalletElementBusOn;
 }
 
 export declare type GooglePayToken = object;
@@ -783,8 +793,14 @@ export declare class PayPalElement {
 
     mount(): void;
     unmount(): void;
+    /**
+     * Remove the button and stop listening for configuration updates. A
+     * setup still in progress renders nothing, a payment still open in the
+     * PayPal window ends with no token and no error, and a page that still
+     * shows the button loses it.
+     */
     destroy(): void;
-    on(eventType: never, _delegate: never): void;
+    on: WalletElementBusOn;
 }
 
 export declare interface PlaceholdersConfig {
@@ -1051,6 +1067,23 @@ export declare interface UpdateableTransactionData {
 
 export declare type ValueOf<T> = T[keyof T];
 
+export declare type WalletElementBusOn = <T extends keyof WalletElementEventMap>(event: T, fn: (...args: WalletElementEventMap[T]) => void) => void;
+
+/**
+ * The events of a wallet element: Apple Pay, Google Pay, and PayPal.
+ *
+ * `ready` fires once the wallet button is displayed, so the shopper can press
+ * it. `error` fires with the FramePay error when the button cannot be shown:
+ * the device cannot pay, the SDK did not load, or the configuration is
+ * invalid. Failures after `ready` are not element errors: a token request
+ * that fails surfaces on the global `Framepay.on('error')`, and so does a
+ * canceled Apple Pay payment.
+ */
+export declare interface WalletElementEventMap {
+    ready: [];
+    error: [FramepayError];
+}
+
 export declare interface WebskitAutofillStyleConfig {
     fontSize?: FramepayStyleValue;
     webkitTextFillColor?: FramepayStyleValue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rebilly/framepay",
-  "version": "5.259.1",
+  "version": "5.260.0",
   "description": "A wrapper to load Rebilly's FramePay library and provide TypeScript types",
   "type": "module",
   "repository": {