@melio-eng/web-sdk 1.1.0-pr.94.438ff96 → 1.2.0-pr.94.cf53d50

package/README.md

@@ -178,14 +178,14 @@ flow.on("navigated", (p)    => console.log("Navigated to:", p.target));
 - `error`: A flow error occurred (e.g. `billsSyncFailed`)
 - `exit`: The user exited the iframe
 - `navigated`: Navigation occurred inside the iframe
-- `partnerActionRequired`: Melio needs your page to navigate somewhere it cannot reach itself (see below)
+- `buttonClicked`: The user clicked a button whose destination is in your product (see below)
 - `authenticationSucceeded` / `authenticationFailed`: emitted on the `init` instance
 
-#### Partner actions (`partnerActionRequired`)
+#### Button clicks (`buttonClicked`)
 
 Some Melio screens contain buttons whose destination lives in **your** product, not in Melio —
 today the "+ Quick payment" button on the payments dashboard, which should take the user to
-your own supplier selection page. Melio cannot navigate the host page, so it emits an event
+your own supplier selection page. Melio cannot navigate the host page, so it reports the click
 and waits for you:
 
 ```typescript
@@ -193,19 +193,21 @@ const dashboard = melioSDK.openPaymentsDashboard({
   containerId: "melio-dashboard-container",
 });
 
-dashboard.on("partnerActionRequired", (action) => {
-  if (action.requiredAction === "NAVIGATE_TO_NEW_PAYMENT") {
+dashboard.on("buttonClicked", ({ type }) => {
+  if (type === "quickPayment") {
     window.location.assign("/suppliers/select");
   }
 });
 ```
 
-| `requiredAction` | Emitted when | What you should do |
+| `type` | Emitted when | What you should do |
 |---|---|---|
-| `NAVIGATE_TO_NEW_PAYMENT` | The user clicks the new payment button on the payments dashboard | Take them to your supplier selection page, then open a pay flow |
+| `quickPayment` | The user clicks the quick payment button on the payments dashboard | Take them to your supplier selection page, then open a pay flow |
 
-Without a listener the button does nothing at all. Further actions ship in minor releases, so
-switch on `requiredAction` and treat an unrecognised value as a no-op.
+Without a listener the button does nothing at all. Only buttons whose destination is in your
+product are reported here — buttons that end a flow keep their existing events, so "Back to
+bills" still arrives as `completed`. Further button types ship in minor releases, so switch on
+`type` and treat an unrecognised value as a no-op.
 
 ## 💡 Examples
 

package/dist/flows/Flow.d.ts

@@ -1,4 +1,4 @@
-import { FlowInstance, FlowEventType, FlowEventCallback, FlowCompletionData, NavigationData, PartnerActionData, BaseFlowConfig, Environment, ErrorData } from '../types.js';
+import { FlowInstance, FlowEventType, FlowEventCallback, FlowCompletionData, NavigationData, ButtonClickedData, BaseFlowConfig, Environment, ErrorData } from '../types.js';
 /**
  * Flow class implementation for handling iframe flows and events
  */
@@ -33,7 +33,7 @@ export declare class Flow implements FlowInstance {
     protected emit(event: 'completed', data: FlowCompletionData): void;
     protected emit(event: 'loaded'): void;
     protected emit(event: 'exit'): void;
-    protected emit(event: 'partnerActionRequired', data: PartnerActionData): void;
+    protected emit(event: 'buttonClicked', data: ButtonClickedData): void;
     protected emit(event: 'navigated', data: NavigationData): void;
     protected emit(event: 'authenticationSucceeded'): void;
     protected emit(event: 'authenticationFailed'): void;
@@ -45,7 +45,7 @@ export declare class Flow implements FlowInstance {
      */
     on(event: 'completed', callback: (data: FlowCompletionData) => void): void;
     on(event: 'exit', callback: () => void): void;
-    on(event: 'partnerActionRequired', callback: (data: PartnerActionData) => void): void;
+    on(event: 'buttonClicked', callback: (data: ButtonClickedData) => void): void;
     on(event: 'navigated', callback: (payload: NavigationData) => void): void;
     on(event: 'authenticationSucceeded', callback: () => void): void;
     on(event: 'authenticationFailed', callback: () => void): void;

package/dist/flows/Flow.js

@@ -78,12 +78,10 @@ export class Flow {
                     this.emit('exit');
                     break;
                 case 'PARTNER_ACTION_REQUIRED':
-                    // Only the new payment request is routed today; every other
-                    // requiredAction is ignored until the SDK declares it.
+                    // Only the quick payment button is reported today; every other
+                    // requiredAction is ignored until the SDK declares a type for it.
                     if (data.data?.requiredAction === 'NAVIGATE_TO_NEW_PAYMENT') {
-                        this.emit('partnerActionRequired', {
-                            requiredAction: 'NAVIGATE_TO_NEW_PAYMENT',
-                        });
+                        this.emit('buttonClicked', { type: 'quickPayment' });
                     }
                     break;
                 case 'NAVIGATED_TO_TARGET':

package/dist/types.d.ts

@@ -130,22 +130,24 @@ export interface NavigationData {
     targetAction: 'schedulePayment' | 'scheduleBatchPayments' | 'viewSubscriptionPlans' | 'viewSettingsCollaborators' | 'viewPayment' | 'viewPaidPayment' | 'viewBill' | 'addNewBill' | 'viewVendors' | 'addVendor' | 'viewSettings' | 'viewArInvoices' | 'redirect';
 }
 /**
- * An action the embedded Melio app cannot perform itself and is asking your page to
- * perform. Delivered by the `partnerActionRequired` event.
+ * Which button the user clicked inside the embedded Melio app, delivered by the
+ * `buttonClicked` event.
  *
- * `'NAVIGATE_TO_NEW_PAYMENT'` is emitted when the user clicks the new payment button on
- * the payments dashboard: take them to your own supplier selection page, from which you
- * open a payment flow.
+ * `'quickPayment'` is the new payment button on the payments dashboard: take the user to
+ * your own supplier selection page, from which you open a payment flow.
  *
  * @remarks
- * Melio cannot navigate your page, so an action with no listener registered is a button
- * that visibly does nothing when clicked.
+ * Melio cannot navigate your page, so a button with no listener registered visibly does
+ * nothing when clicked.
  *
- * Further actions are added in minor releases, so switch on `requiredAction` and treat an
+ * Only buttons whose destination lives in your product are reported here. Buttons that end
+ * a flow keep their existing events — "Back to bills" still arrives as `completed`.
+ *
+ * Further button types are added in minor releases, so switch on `type` and treat an
  * unrecognised value as a no-op rather than an error.
  */
-export interface PartnerActionData {
-    requiredAction: 'NAVIGATE_TO_NEW_PAYMENT';
+export interface ButtonClickedData {
+    type: 'quickPayment';
 }
 /**
  * Flow completion data
@@ -168,11 +170,11 @@ export interface ErrorData {
 /**
  * Event types that can be listened to
  */
-export type FlowEventType = 'completed' | 'exit' | 'partnerActionRequired' | 'navigated' | 'authenticationSucceeded' | 'authenticationFailed' | 'error' | 'loaded' | 'onboardingCompleted' | 'onboardingRequired';
+export type FlowEventType = 'completed' | 'exit' | 'buttonClicked' | 'navigated' | 'authenticationSucceeded' | 'authenticationFailed' | 'error' | 'loaded' | 'onboardingCompleted' | 'onboardingRequired';
 /**
  * Event callback function types
  */
-export type FlowEventCallback = ((data: FlowCompletionData | NavigationData | ErrorData | PartnerActionData) => void) | (() => void);
+export type FlowEventCallback = ((data: FlowCompletionData | NavigationData | ErrorData | ButtonClickedData) => void) | (() => void);
 /**
  * Flow instance interface for event handling
  */
@@ -184,7 +186,7 @@ export interface FlowInstance {
      */
     on(event: 'completed', callback: (data: FlowCompletionData) => void): void;
     on(event: 'exit', callback: () => void): void;
-    on(event: 'partnerActionRequired', callback: (data: PartnerActionData) => void): void;
+    on(event: 'buttonClicked', callback: (data: ButtonClickedData) => void): void;
     on(event: 'navigated', callback: (payload: NavigationData) => void): void;
     on(event: 'authenticationSucceeded', callback: () => void): void;
     on(event: 'authenticationFailed', callback: () => void): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@melio-eng/web-sdk",
-  "version": "1.1.0-pr.94.438ff96",
+  "version": "1.2.0-pr.94.cf53d50",
   "description": "Melio Web SDK - Embed core Melio workflows directly into partner UI with minimal effort",
   "main": "dist/index.js",
   "module": "dist/index.js",