@nauticana/sail 1.1.12 → 1.1.13

package/README.md

@@ -273,7 +273,8 @@ interface SailGuiConfig {
   googleClientId?: string;            // Google Identity Services client ID
   appleServiceId?: string;            // Apple Services ID
   appleRedirectUri?: string;          // Apple Sign-In redirect URI
-  privacyPolicyUrl?: string;          // Linked from ConsentGateComponent
+  privacyPolicyUrl?: string;          // Linked from ConsentGateComponent and the login footer
+  termsUrl?: string;                  // Linked from the SMS-consent disclosure and the login footer
   defaultPolicyVersion?: string;      // Content hash of the deployed policy
   defaultPolicyLanguage?: string;     // ISO 639-1 fallback language
   accountDeletedRoute?: string;       // Route after account deletion (default '/login/local')
@@ -1138,8 +1139,8 @@ The v0.6 / v0.7 line introduced three additive feature groups against keel v0.7.
 
 | From | Export | Purpose |
 |---|---|---|
-| `@nauticana/sail` | `PayoutService` | keel/payout API client — hosted-KYC launch, reuse flow, status |
-| `@nauticana/sail` | `PayoutProviderOnboardingComponent` (`<sail-payout-provider-onboarding>`) | Drop-in onboarding step with reuse picker + hosted-KYC launcher |
+| `@nauticana/sail` | `PayoutService` | keel/payout API client — onboarding, reuse, status, bank-version replacement, beneficiary registration |
+| `@nauticana/sail` | `PayoutProviderOnboardingComponent` (`<sail-payout-provider-onboarding>`) | Drop-in onboarding step with reuse picker, hosted-KYC handoff, and asynchronous-confirmation output |
 | `@nauticana/sail` | `PayoutBankInfoFormComponent` (`<sail-payout-bank-info-form>`) | Tax + payout details form (country / currency / tax ID / billing address / agreement) |
 | `@nauticana/sail` | `UserPaymentMethodService` | Saved-card list / delete / set-default API client |
 | `@nauticana/sail` | `UserPaymentMethodsComponent` (`<sail-user-payment-methods>`) | List of saved cards/wallets with set-default + delete |
@@ -1151,10 +1152,12 @@ Make sure your keel deployment exposes these — they're all under `/api/v1/`:
 
 | Endpoint | Method | Purpose |
 |---|---|---|
-| `/api/v1/payout/onboard/start` | POST | Open hosted-KYC; returns `{ url, externalAccountId, expiresAt }` |
+| `/api/v1/payout/onboard/start` | POST | Start provider onboarding; returns `{ url, externalAccountId, expiresAt }` (`url` is empty when confirmation continues asynchronously) |
 | `/api/v1/payout/reusable` | POST | List provider accounts the user has on other partners |
 | `/api/v1/payout/reusable/link` | POST | Copy a `providerAccountId` onto the active partner's `user_bank_info` row |
 | `/api/v1/payout/status` | POST | `{ complete: true }` once the active partner's row has a `providerAccountId` |
+| `/api/v1/payout/bank/replace` | POST | Supersede the active bank-info version and insert its replacement atomically; the app must wire the handler's `SealTaxID` hook |
+| `/api/v1/payout/beneficiary/register` | POST | Create and link a provider beneficiary from provider-collected details |
 | `/api/v1/payment-methods/set-default` | POST | Atomic multi-row UPDATE — sets one row as default, clears the rest |
 | `/api/v1/{table}/{action_name}` | POST | Per-table custom actions resolved from `basis.table_action` |
 
@@ -1176,6 +1179,7 @@ Drop the two components into a wizard step. Routing between them stays in the co
     <sail-payout-provider-onboarding
         (linked)="step.set('done')"
         (started)="step.set('waiting')"
+        (pending)="step.set('awaiting-confirmation')"
         (skipped)="step.set('done')"
         (back)="step.set('bank')">
     </sail-payout-provider-onboarding>
@@ -1183,7 +1187,9 @@ Drop the two components into a wizard step. Routing between them stays in the co
 }
 ```
 
-`BankInfoFormValue` maps 1:1 to `basis.user_bank_info` columns. The consumer decides where to POST it — typically a direct generic-CRUD insert against `/api/v1/user_bank_info`. The provider account itself is created by `<sail-payout-provider-onboarding>` via `PayoutService.startOnboarding()` → hosted KYC → webhook back to keel.
+`BankInfoFormValue` is application-layer input, not a generic-CRUD row. In particular, its plaintext `taxId` must be sealed into the `tax_id_encrypted` column and must never be sent through the generic `/api/v1/user_bank_info` CRUD surface. First-time setup goes through the consuming app's registration service. Changes to an existing destination use `PayoutService.replaceBankInfo()`, which calls keel's atomic version-replacement endpoint; wire `PayoutHandler.SealTaxID` so that endpoint seals the plaintext before persistence.
+
+`PayoutService.startOnboarding()` returns a `PayoutOnboardingSession`. When `url` is non-empty, the component emits `started` and navigates to the provider's hosted flow. When `url` is empty, as with Wise email recipients, it emits `pending` instead; consumers must show an awaiting-confirmation state while the recipient completes the provider's email flow. Airwallex apps can pass details collected by the embedded beneficiary component to `PayoutService.registerBeneficiary()`.
 
 For apps that operate on a single keel partner, the reuse picker stays empty and only the "Start onboarding" CTA renders. Multi-partner apps get the picker for free.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nauticana/sail",
-  "version": "1.1.12",
+  "version": "1.1.13",
   "description": "Metadata-driven Angular component library for CRUD admin frontends backed by the keel Go backend. Tables, forms, navigation, OTP/2FA/social auth, billing, payout onboarding.",
   "main": "src/index.ts",
   "scripts": {

package/src/component/login/login_component.html

@@ -38,11 +38,17 @@
     <div class="auth-actions">
       <a routerLink="/login/chpass">I forgot my password</a>
     </div>
-    @if (guiConfig.loginFooterLinks && guiConfig.loginFooterLinks.length > 0) {
+    @if (guiConfig.loginFooterLinks?.length || guiConfig.termsUrl || guiConfig.privacyPolicyUrl) {
       <div class="auth-footer">
-        @for (link of guiConfig.loginFooterLinks; track link.routerLink) {
+        @for (link of guiConfig.loginFooterLinks ?? []; track link.routerLink) {
           <a [routerLink]="link.routerLink">{{ link.label }}</a>
         }
+        @if (guiConfig.termsUrl) {
+          <a [href]="guiConfig.termsUrl" target="_blank" rel="noopener">Terms of Service</a>
+        }
+        @if (guiConfig.privacyPolicyUrl) {
+          <a [href]="guiConfig.privacyPolicyUrl" target="_blank" rel="noopener">Privacy Policy</a>
+        }
       </div>
     }
   </div>

package/src/component/payout/bank_info_form.ts

@@ -26,8 +26,10 @@ export const DEFAULT_COUNTRY_PROFILES: CountryProfile[] = [
  *
  * Captures the basis `user_bank_info` fields (country, currency, account
  * holder, tax id, billing address, agreement). Emits the form value via
- * `(submitted)` — the consumer decides whether to POST directly to
- * /api/v1/user_bank_info or pipe through its own registration service.
+ * `(submitted)` — first-time setup POSTs through the app's registration
+ * service; CHANGES to an existing destination go through
+ * PayoutService.replaceBankInfo (atomic version replacement), never a
+ * generic CRUD edit.
  *
  * Ships no CSS — the consuming app styles the classes globally.
  *
@@ -58,7 +60,11 @@ export class PayoutBankInfoFormComponent {
   /** When true, the back button renders alongside submit. */
   readonly showBack = input(true);
 
-  /** Emitted on submit; payload maps 1:1 to basis user_bank_info columns. */
+  /**
+   * Emitted on submit as application-layer input. The consumer must use its
+   * registration service for first-time setup or PayoutService.replaceBankInfo
+   * for changes; never send this payload through generic CRUD.
+   */
   readonly submitted = output<BankInfoFormValue>();
   /** Emitted when the user clicks Back. */
   readonly back = output<void>();

package/src/component/payout/provider_onboarding.ts

@@ -14,12 +14,13 @@ import { ReusableAccount } from '../../model/appdata';
  * two paths:
  *   1. Reuse an existing provider account from another partner row
  *      (zero-KYC; calls /api/v1/payout/reusable/link).
- *   2. Hand off to the provider's hosted-KYC page
- *      (/api/v1/payout/onboard/start).
+ *   2. Start provider onboarding (/api/v1/payout/onboard/start), then
+ *      either hand off to a hosted-KYC page or emit `pending` when the
+ *      provider continues asynchronously without a hosted URL.
  *
- * Routing is consumer-owned via the `(linked)` / `(skipped)` outputs —
- * the component itself never calls Router. Optional `title` and
- * `skipLabel` inputs cover the common UX strings.
+ * Routing is consumer-owned via the `(linked)`, `(pending)`, and
+ * `(skipped)` outputs — the component itself never calls Router.
+ * Optional `title` and `skipLabel` inputs cover the common UX strings.
  *
  * Ships no CSS — the consuming app styles the classes globally.
  *
@@ -47,6 +48,13 @@ export class PayoutProviderOnboardingComponent extends BaseAsync implements OnIn
   readonly back = output<void>();
   /** Emitted just before handing off to the hosted-KYC page. */
   readonly started = output<void>();
+  /**
+   * Emitted when onboarding started but there is no hosted page to open
+   * (Wise email recipients: the account is linked and awaits the
+   * recipient's email confirmation). Consumers show a "linked, awaiting
+   * confirmation" state instead of navigating.
+   */
+  readonly pending = output<void>();
 
   private readonly payoutService = inject(PayoutService);
 
@@ -79,6 +87,10 @@ export class PayoutProviderOnboardingComponent extends BaseAsync implements OnIn
     this.run(
       this.payoutService.startOnboarding(),
       (res) => {
+        if (!res.url) {
+          this.pending.emit();
+          return;
+        }
         this.started.emit();
         // Same-tab handoff: window.open from an async callback is popup-blocked
         // (always on Safari), which used to leave users on a "waiting" screen

package/src/config.ts

@@ -53,9 +53,9 @@ export interface SailGuiConfig {
   appleServiceId?: string;
   /** Apple Sign-In redirect URI. Must match the Services ID configuration. */
   appleRedirectUri?: string;
-  /** Public URL of your privacy policy. Shown as a link in ConsentGateComponent. */
+  /** Public URL of your privacy policy. Linked from ConsentGateComponent and the login footer. */
   privacyPolicyUrl?: string;
-  /** Public URL of your terms of service. Shown in the SMS-consent disclosure. */
+  /** Public URL of your terms of service. Linked from the SMS-consent disclosure and the login footer. */
   termsUrl?: string;
   /** Brand name shown in the SMS/10DLC consent disclosure (e.g. "Daxoom"). */
   appName?: string;

package/src/model/appdata.ts

@@ -377,18 +377,22 @@ export interface ReusableAccount {
 	onboardedAt:       string;
 }
 
-// Result of PayoutService.startOnboarding(). url is opened in a webview /
-// external browser; the provider posts back via webhook when activation
-// lands.
+// Result of PayoutService.startOnboarding(). A non-empty url is opened in a
+// webview / external browser. Some providers have no hosted flow (for example,
+// Wise email recipients); in that case url and expiresAt are empty and
+// PayoutProviderOnboardingComponent emits `pending` while confirmation
+// continues asynchronously.
 export interface PayoutOnboardingSession {
 	url:               string;
 	externalAccountId: string;
 	expiresAt:         string;
 }
 
-// Payload the bank-info form emits. Maps 1:1 to basis user_bank_info
-// columns. The consumer decides where to POST it — typically a direct
-// generic-CRUD insert against /api/v1/user_bank_info.
+// Application-layer payload emitted by the bank-info form. It is not a
+// generic-CRUD row: taxId must be sealed into basis.user_bank_info's
+// tax_id_encrypted column. First-time setup goes through the consuming app's
+// registration service; changes use PayoutService.replaceBankInfo so keel can
+// atomically supersede the active destination version.
 export interface BankInfoFormValue {
 	countryCode:       string;
 	currency:          string;

package/src/service/payout.service.ts

@@ -3,6 +3,7 @@ import { Observable } from 'rxjs';
 import { RestURL } from './rest_url';
 import { BaseRestService } from './base_rest.service';
 import {
+  BankInfoFormValue,
   PayoutOnboardingSession,
   ReusableAccount,
 } from '../model/appdata';
@@ -20,7 +21,11 @@ import {
  */
 @Injectable({ providedIn: 'root' })
 export class PayoutService extends BaseRestService {
-  /** Launch the hosted-KYC flow. Returns a URL to open + provider-side handle. */
+  /**
+   * Start provider onboarding. A non-empty URL is the hosted-KYC handoff;
+   * an empty URL means confirmation continues asynchronously (for example,
+   * a Wise recipient confirming from email).
+   */
   startOnboarding(): Observable<PayoutOnboardingSession> {
     return this.http.post<PayoutOnboardingSession>(this.url(RestURL.payoutOnboardStartURL), {});
   }
@@ -39,4 +44,25 @@ export class PayoutService extends BaseRestService {
   status(): Observable<{ complete: boolean }> {
     return this.http.post<{ complete: boolean }>(this.url(RestURL.payoutStatusURL), {});
   }
+
+  /**
+   * Replace the payout destination with a new bank-info version
+   * (atomic supersede + insert on the backend). Identity changes go
+   * through this, never through generic CRUD edits. `provider` and
+   * `providerAgreement` are server-owned and ignored here.
+   */
+  replaceBankInfo(value: BankInfoFormValue): Observable<{ message: string }> {
+    const { countryCode, currency, accountHolderName, billingAddress, taxIdType, taxId } = value;
+    return this.http.post<{ message: string }>(this.url(RestURL.payoutBankReplaceURL),
+      { countryCode, currency, accountHolderName, billingAddress, taxIdType, taxId });
+  }
+
+  /**
+   * Register a payout beneficiary from provider-collected details
+   * (Airwallex embedded beneficiary component). The payload passes
+   * through to the provider; the backend links the returned id.
+   */
+  registerBeneficiary(beneficiary: unknown): Observable<{ beneficiaryId: string }> {
+    return this.http.post<{ beneficiaryId: string }>(this.url(RestURL.payoutBeneficiaryURL), { beneficiary });
+  }
 }

package/src/service/rest_url.ts

@@ -53,6 +53,8 @@ export const RestURL = {
   payoutReusableURL:     '/api/v1/payout/reusable',
   payoutReusableLinkURL: '/api/v1/payout/reusable/link',
   payoutStatusURL:       '/api/v1/payout/status',
+  payoutBankReplaceURL:  '/api/v1/payout/bank/replace',
+  payoutBeneficiaryURL:  '/api/v1/payout/beneficiary/register',
   // User payment methods — list/delete go through keel's generic REST
   // CRUD against the UserSpecific basis table; set-default is a
   // TableAction (basis table_action row), mounted at the conventional