@benji-money/connect-sdk 1.1.0-beta.2 → 1.1.0-beta.4

package/README.md

@@ -86,6 +86,8 @@ The SDK accepts the following configuration options:
 
 - `environment` (required): One of `local`, `development`, `sandbox`, or `production`
 - `token` (required): Your API connect token
+- `mode` (optional): `BenjiConnectMode` — `CONNECT` (default), `TRANSFER`, `REDEEM`, or `LOGIN`
+- `authType` (optional): `PartnerIntegrationType` — LOGIN only; omit or set `DUMMY` for the visible modal iframe; set to your partner type (1–6) for popup-only auth
 - `onSuccess` (optional): Callback function called when connect completed successfully
 - `onError` (optional): Callback function called when error occurs in the connect flow
 - `onExit` (optional): Callback function called when the user exits the connect flow
@@ -94,6 +96,14 @@ The SDK accepts the following configuration options:
 - `placement` (optional): Placement relative to `anchor` — see [Placement](#placement) below
 - `offset` (optional): Pixel gap after placement — `{ top?: number; left?: number }` (default `{ top: 0, left: 0 }`)
 
+### Modes
+
+| Mode | Visible UX | Notes |
+| ---- | ---------- | ----- |
+| **CONNECT** (default) | Centered or anchored modal iframe | No `authType`; standard connect / verify flow |
+| **LOGIN + DUMMY / no `authType`** | Same visible modal iframe | Partner auth runs in a nested iframe inside Benji Connect |
+| **LOGIN + non-DUMMY** | Partner popup only | Pass `authType`; Benji Connect iframe is headless — see [LOGIN popup example](#login-popup-example) below |
+
 ### Placement
 
 Placement uses [Floating UI](https://floating-ui.com/docs/computePosition#placement) / CSS logical naming (`start` / `end`). In **LTR** layouts:
@@ -104,6 +114,11 @@ Placement uses [Floating UI](https://floating-ui.com/docs/computePosition#placem
 | `bottom-end` | Below the anchor, right edge aligned with anchor's right edge |
 | `bottom-start` | Below the anchor, left edge aligned with anchor's left edge |
 
+**What `anchor` positions:**
+
+- **CONNECT, TRANSFER, REDEEM, and LOGIN + DUMMY:** the modal iframe
+- **LOGIN + non-DUMMY:** the partner-auth popup window (modal iframe stays headless)
+
 **Defaults:**
 
 - No `anchor` → centered modal (unchanged behavior for existing integrations)
@@ -129,30 +144,35 @@ Prefer selector, ref, or getter when the anchor can re-render (e.g. disabled/loa
 - **Anchored** popovers use the full design size when width and height checks pass; otherwise they fall back to a scaled centered modal
 - Scroll, resize, and visual viewport changes while open recompute placement and size
 
-**LOGIN popover example** (dropdown under a top-right button):
+#### LOGIN popup example
+
+Popup below a top-right login button; pass `authType` for non-DUMMY partners:
 
 ```typescript
 import {
   ConnectSDK,
   BenjiConnectMode,
   BenjiConnectPlacement,
+  PartnerIntegrationType,
 } from "@benji-money/connect-sdk";
 
-// Prefer a live binding (selector or ref) when the button may re-render before open()
 const sdk = new ConnectSDK({
   environment: "sandbox",
   token: connectToken,
   mode: BenjiConnectMode.LOGIN,
+  authType: PartnerIntegrationType.OAUTH_PKCE,
   anchor: "#login-btn",
   placement: BenjiConnectPlacement.BOTTOM_END,
   offset: { top: 8 },
   onSuccess: (token) => { /* ... */ },
+  onError: (error) => { /* popup blocked, etc. */ },
+  onExit: (metadata) => { /* POPUP_CLOSED when user dismisses popup */ },
 });
 
 await sdk.open();
 ```
 
-> **`bottom-end`** opens below the anchor with the modal's right edge aligned to the anchor's right edge — matching a dropdown under a top-right LOGIN button.
+> **`bottom-end`** positions the **partner popup** below the anchor with its right edge aligned to the anchor's right edge. The Benji Connect iframe stays headless (not visible).
 
 ### Environments