@melio-eng/web-sdk 1.0.40 → 1.1.0-pr.92.a38482a

package/README.md

@@ -135,6 +135,25 @@ Host Melio account settings within your product.
 melioSDK.openSettings(config: SettingsConfig): FlowInstance
 ```
 
+#### Entry Point (`entryPoint`)
+
+`PayFlowConfig`, `JustPayFlowConfig` and `OnboardingConfig` accept an optional `entryPoint` — which
+page of your product the user came from. Melio uses it to word the button that ends the flow:
+
+| `entryPoint` | return button reads |
+|---|---|
+| `"bills"` | "Back to bills" |
+| `"contacts"` | "Back to contacts" |
+| `"quickpayment"` | "Back to quick payment" |
+| `"managepayments"` | "Back to manage payments" |
+| `"home"` | "Back to homepage" |
+| `"generic"` | "Finish and return" |
+| _omitted_ | today's default wording |
+
+It's wording only — the `completed` event carries no destination, so your app still handles
+navigation. On the Pay Flow, it has no effect when `billIdType` is `"melio"`. See
+[Entry point](./guides/pay-flow-integration.md#entry-point) in the full guide for a worked example.
+
 ### Event Handling
 
 Each flow method returns a `FlowInstance` that allows you to register event listeners:

package/dist/types.d.ts

@@ -42,10 +42,26 @@ export interface UserDetails {
     dateOfBirth?: string;
 }
 /**
- * Entry point context for the flow, used to construct the externalOrigin parameter.
- * When provided, the externalOrigin becomes `${partnerName}-${entryPoint}` (e.g., 'your-partner-name-contacts').
- */
-export type ExternalEntryPoint = 'contacts';
+ * Which page of your product the user came from. Melio uses it to word the button that
+ * ends the flow:
+ *
+ * | `entryPoint` | return button reads |
+ * | --- | --- |
+ * | `'bills'` | "Back to bills" |
+ * | `'contacts'` | "Back to contacts" |
+ * | `'quickpayment'` | "Back to quick payment" |
+ * | `'managepayments'` | "Back to manage payments" |
+ * | `'home'` | "Back to homepage" |
+ * | `'generic'` | "Finish and return" |
+ *
+ * Use `'generic'` when your page has no single destination; omit `entryPoint` for the
+ * default wording.
+ *
+ * @remarks
+ * Wording only — it does not navigate. The `completed` event carries no destination, so your
+ * application still decides where the click lands.
+ */
+export type ExternalEntryPoint = 'bills' | 'contacts' | 'quickpayment' | 'managepayments' | 'home' | 'generic';
 /**
  * Configuration for onboarding flow
  */
@@ -53,7 +69,7 @@ export interface OnboardingConfig extends BaseFlowConfig {
     userDetails?: UserDetails;
     organizationDetails?: OrganizationDetails;
     enforceOnboarding?: boolean;
-    /** Optional entry point context — affects the externalOrigin passed to the platform */
+    /** Which page of your product the user came from; words the button that ends the flow. See {@link ExternalEntryPoint}. */
     entryPoint?: ExternalEntryPoint;
 }
 /**
@@ -61,7 +77,10 @@ export interface OnboardingConfig extends BaseFlowConfig {
  */
 export interface PayFlowConfig extends BaseFlowConfig {
     billIds: Array<string>;
-    /** Optional entry point context — affects the externalOrigin passed to the platform */
+    /**
+     * Which page of your product the user came from; words the button that ends the flow.
+     * Has no effect when `billIdType` is `'melio'`. See {@link ExternalEntryPoint}.
+     */
     entryPoint?: ExternalEntryPoint;
     /**
      * How the platform should resolve the provided `billIds`. Defaults to `'accounting'`.
@@ -82,7 +101,7 @@ export interface JustPayFlowConfig extends BaseFlowConfig {
     externalVendorIds: Array<string>;
     /** Optional amount to prefill in the payment flow */
     amount?: number;
-    /** Optional entry point context — affects the externalOrigin passed to the platform */
+    /** Which page of your product the user came from; words the button that ends the flow. See {@link ExternalEntryPoint}. */
     entryPoint?: ExternalEntryPoint;
 }
 /**

package/package.json

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