@melio-eng/web-sdk 1.0.40-pr.88.ea95f3d → 1.0.40-pr.92.83c7b28

package/README.md

@@ -135,6 +135,46 @@ 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. The SDK composes it into the `externalOrigin` query param as
+`${partnerName}-${entryPoint}`, and Melio uses that value to word the button that ends the flow. Omit
+it and `externalOrigin` stays the bare partner name.
+
+| `entryPoint` | resulting `externalOrigin` (partner `xero`) | return button reads |
+|---|---|---|
+| `"bills"` | `xero-bills` | "Back to bills" |
+| `"contacts"` | `xero-contacts` | "Back to contacts" |
+| `"quickpayment"` | `xero-quickpayment` | "Back to quick payment" |
+| `"managepayments"` | `xero-managepayments` | "Back to manage payments" |
+| `"home"` | `xero-home` | "Back to homepage" |
+| `"generic"` | `xero-generic` | "Finish and return" |
+| _omitted_ | `xero` | today's default wording |
+
+```typescript
+const payFlow = melioSDK.openPayFlow({
+  containerId: "melio-payflow-container",
+  billIds: ["ext-bill-1"],   // accounting ids — the default billIdType
+  entryPoint: "bills",       // -> externalOrigin=<partnerName>-bills, "Back to bills"
+});
+
+// The entry point only labels the button — you still navigate:
+payFlow.on("completed", () => router.push("/bills"));
+```
+
+Pass the value **unprefixed**: the SDK adds `${partnerName}-` for you. Use `"generic"` when your host
+page cannot name a single destination. Labels are owned by the Melio platform and may be reworded, so
+treat the third column as indicative rather than contractual.
+
+> **Descriptive only — the entry point does not route the user.** It affects the button's wording and
+> nothing else. The `completed` event carries no destination, so **your** application still decides
+> where the click actually lands. Entry point and real destination stay coupled by convention alone:
+> don't assume Melio navigates the user back for you.
+
+On the Pay Flow, `entryPoint` only reaches the platform for the default `billIdType: "accounting"`
+target; with `billIdType: "melio"` the payment screen opens directly and no `externalOrigin` is sent.
+
 ### Event Handling
 
 Each flow method returns a `FlowInstance` that allows you to register event listeners:

package/dist/types.d.ts

@@ -24,53 +24,66 @@ export interface BaseFlowConfig {
     /** Optional authorization code for the flow */
     authCode?: string;
 }
-export type BusinessType = 'soleProprietorship' | 'partnership' | 'limitedLiabilityCompany' | 'corporation' | 'nonProfit' | 'nonGovernmentalOrganization' | 'municipalCorporation' | 'trustOrEstate';
-export type TaxIdType = 'ssn' | 'itin' | 'ein';
-/**
- * A US mailing address used to prefill business address fields
- */
-export interface Address {
-    street1?: string;
-    street2?: string;
-    city?: string;
-    state?: string;
-    zipCode?: string;
-}
-export interface Industry {
-    name?: string;
-    /** NAICS industry code */
-    code?: number;
-}
+export type BusinessType = 'partnership' | 'limitedLiabilityCompany' | 'corporation' | 'nonProfit';
 export interface OrganizationDetails {
     companyName?: string;
-    /** Doing-business-as name, if different from companyName */
-    dbaName?: string;
     businessType?: BusinessType;
     companyLegalName?: string;
-    taxIdType?: TaxIdType;
     taxId?: string;
     legalDateOfBirth?: string;
     website?: string;
     description?: string;
     contactPhone?: string;
-    /** Physical/operating address of the business */
-    businessAddress?: Address;
-    /** Registered legal address of the business, if different from businessAddress */
-    legalAddress?: Address;
-    industry?: Industry;
 }
 export interface UserDetails {
     email?: string;
     firstName?: string;
     lastName?: string;
     dateOfBirth?: string;
-    phone?: 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').
+ * Entry point context for the flow — which page in your product the user came from.
+ *
+ * When provided, the `externalOrigin` query param passed to the platform becomes
+ * `${partnerName}-${entryPoint}`; when omitted it stays the bare `partnerName`.
+ * Melio uses that value to choose the wording of the button that ends the flow, so pick
+ * the value naming the page the user came from (and will be returned to):
+ *
+ * | `entryPoint` | resulting `externalOrigin` (partner `xero`) | return button reads |
+ * | --- | --- | --- |
+ * | `'bills'` | `xero-bills` | "Back to bills" |
+ * | `'contacts'` | `xero-contacts` | "Back to contacts" |
+ * | `'quickpayment'` | `xero-quickpayment` | "Back to quick payment" |
+ * | `'managepayments'` | `xero-managepayments` | "Back to manage payments" |
+ * | `'home'` | `xero-home` | "Back to homepage" |
+ * | `'generic'` | `xero-generic` | "Finish and return" |
+ *
+ * Use `'generic'` as the catch-all when your host page cannot name a single destination.
+ * The values are deliberately unprefixed — the SDK prepends `${partnerName}-` itself.
+ * Labels are owned by the Melio platform and may be reworded; treat the table as
+ * indicative rather than contractual.
+ *
+ * @remarks
+ * **Descriptive only — the entry point does not route the user.** It only tells Melio how to
+ * label the button that ends the flow. The `completed` event (`FLOW_COMPLETED`) carries no
+ * destination, so your application still decides where the click actually lands. Entry point
+ * and real destination stay coupled by convention alone: do not assume Melio navigates the
+ * user back for you.
+ *
+ * @example
+ * ```typescript
+ * // User started from the bills list, so the flow ends with a "Back to bills" button.
+ * const payFlow = melioSDK.openPayFlow({
+ *   containerId: "melio-payflow-container",
+ *   billIds: ["bill_abc123"],
+ *   entryPoint: "bills",
+ * });
+ *
+ * // ...and your app still performs the actual navigation:
+ * payFlow.on("completed", () => router.push("/bills"));
+ * ```
  */
-export type ExternalEntryPoint = 'contacts';
+export type ExternalEntryPoint = 'bills' | 'contacts' | 'quickpayment' | 'managepayments' | 'home' | 'generic';
 /**
  * Configuration for onboarding flow
  */
@@ -78,7 +91,14 @@ export interface OnboardingConfig extends BaseFlowConfig {
     userDetails?: UserDetails;
     organizationDetails?: OrganizationDetails;
     enforceOnboarding?: boolean;
-    /** Optional entry point context — affects the externalOrigin passed to the platform */
+    /**
+     * Optional entry point context — which page in your product the user came from.
+     * Affects the `externalOrigin` passed to the platform (`${partnerName}-${entryPoint}`),
+     * which Melio uses to label the button that ends the flow. Accepts `'bills'`, `'contacts'`,
+     * `'quickpayment'`, `'managepayments'`, `'home'` or `'generic'`; omit it to send the bare
+     * partner name. Descriptive only — it does not route the user; your app still handles where
+     * the click lands. See {@link ExternalEntryPoint}.
+     */
     entryPoint?: ExternalEntryPoint;
 }
 /**
@@ -86,7 +106,17 @@ export interface OnboardingConfig extends BaseFlowConfig {
  */
 export interface PayFlowConfig extends BaseFlowConfig {
     billIds: Array<string>;
-    /** Optional entry point context — affects the externalOrigin passed to the platform */
+    /**
+     * Optional entry point context — which page in your product the user came from.
+     * Affects the `externalOrigin` passed to the platform (`${partnerName}-${entryPoint}`),
+     * which Melio uses to label the button that ends the flow. Accepts `'bills'`, `'contacts'`,
+     * `'quickpayment'`, `'managepayments'`, `'home'` or `'generic'`; omit it to send the bare
+     * partner name. Descriptive only — it does not route the user; your app still handles where
+     * the click lands. See {@link ExternalEntryPoint}.
+     *
+     * Only reaches the platform for the default `billIdType: 'accounting'` target; with
+     * `billIdType: 'melio'` the payment screen opens directly and no `externalOrigin` is sent.
+     */
     entryPoint?: ExternalEntryPoint;
     /**
      * How the platform should resolve the provided `billIds`. Defaults to `'accounting'`.
@@ -107,7 +137,14 @@ 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 */
+    /**
+     * Optional entry point context — which page in your product the user came from.
+     * Affects the `externalOrigin` passed to the platform (`${partnerName}-${entryPoint}`),
+     * which Melio uses to label the button that ends the flow. Accepts `'bills'`, `'contacts'`,
+     * `'quickpayment'`, `'managepayments'`, `'home'` or `'generic'`; omit it to send the bare
+     * partner name. Descriptive only — it does not route the user; your app still handles where
+     * the click lands. See {@link ExternalEntryPoint}.
+     */
     entryPoint?: ExternalEntryPoint;
 }
 /**

package/package.json

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