@zkp2p/sdk 0.14.2-rc.4 → 0.14.3

package/README.md

@@ -35,6 +35,11 @@ and chargeback-risk surface. The workspace version lives in `package.json`.
 
 ## Optional Venmo Gmail connection
 
+For partner cash-out integrations, prefer stable `@zkp2p/cash@0.6.1` and its
+[prepare/open/status flow](https://docs.peer.xyz/developer/peer-cash/guide#optional-venmo-receipt-linking).
+It selects the matching environment and keeps linking separate from cash-out.
+The direct SDK helpers below require `@zkp2p/sdk@0.14.2`.
+
 Open Peer's **Link your Venmo** popup for an already-registered account.
 The host passes the selected account hash; the user selects Connect Gmail,
 then chooses their receipt inbox through Google.
@@ -70,6 +75,90 @@ hosts and custom window handling with account-status polling at least ten second
 apart. Deploy the hosted page before using the SDK helper. See the
 [flow specification](https://github.com/zkp2p/zkp2p-clients/blob/main/docs/venmo-gmail-connect.md).
 
+### Native app return
+
+SDK `0.14.3` adds optional `returnUrl` to the URL builder. Partners
+supply their callback directly; no callback registration with Peer or deployment
+setting is required. Deploy the hosted-page update before enabling this flow.
+
+```ts
+import { getVenmoGmailConnectUrl } from '@zkp2p/sdk';
+import * as WebBrowser from 'expo-web-browser';
+
+// Use a callback scheme registered in your app binary.
+const returnUrl = 'partner-app://venmo-linked';
+const connectUrl = getVenmoGmailConnectUrl({ payeeDetails, returnUrl });
+await WebBrowser.openAuthSessionAsync(connectUrl, returnUrl);
+// Re-check your backend's seller-credential/status after return or dismissal.
+```
+
+Use a scheme registered in your Expo app binary; Expo Go is not a substitute
+for testing your app's callback. See Expo's
+[`openAuthSessionAsync` documentation](https://docs.expo.dev/versions/latest/sdk/webbrowser/#webbrowseropenauthsessionasyncurl-redirecturl-options).
+The browser popup helper remains browser-only; native hosts use the URL builder.
+
+Peer keeps Google's OAuth callback on Peer and verifies the selected account
+before navigating to `returnUrl` unchanged. No Google codes, tokens, email,
+account hash, or success flag are appended. If automatic navigation is blocked,
+select **Return to your app**. Consent or verification errors stay visible and
+also offer a manual return. A return, dismissal, or cancellation is not proof of
+linking: only an active `google_oauth` credential from the status API is linked.
+
+Apps that need no SDK can build the same URL themselves:
+`https://app.peer.xyz/connect/venmo?returnUrl=<URL-encoded-callback>#<payeeDetails>`.
+The query parameter must precede the account hash fragment. Malformed URLs,
+unsafe schemes, embedded credentials, and duplicate parameters are rejected
+before consent or credential upload.
+
+Omit `returnUrl` or leave it empty to keep the existing behavior: Peer attempts
+`window.close()` after verification. Script-opened desktop popups can close;
+mobile browser tabs that disallow closure keep the success message visible.
+
+### Popup customization
+
+Pass `appearance` to either hosted-link helper and `popup` to the browser opener:
+
+```ts
+await openVenmoGmailConnect({
+  payeeDetails,
+  popup: { width: 500, height: 620 },
+  appearance: {
+    logoUrl: 'https://your-app.example/logo.png',
+    logoAlt: 'Your app',
+    backgroundColor: '#FFFFFF',
+    textColor: '#172033',
+    secondaryTextColor: '#636B7A',
+    buttonColor: '#6246EA',
+    buttonTextColor: '#FFFFFF',
+    buttonHoverColor: '#5035CC',
+    focusColor: '#6246EA',
+    fontFamily: 'Arial, sans-serif',
+    headingFontFamily: 'Arial, sans-serif',
+    headingTextTransform: 'none',
+    buttonTextTransform: 'none',
+    headingFontSize: 30,
+    buttonBorderRadius: 24,
+    buttonHeight: 52,
+    logoHeight: 44,
+  },
+});
+```
+
+The page centers your hosted logo and Venmo in equal circular frames with connection dots below the explanation, using Peer when no partner logo is supplied. `fontUrl` optionally loads a hosted WOFF/WOFF2 face (the font host must
+allow CORS); a failed font uses the fallback stack. Failed partner images show Peer. Asset URLs require HTTPS, with HTTP localhost allowed for development.
+
+`VenmoGmailAppearance` also exposes `cardBackgroundColor`, `cardBorderRadius`,
+`borderColor`, `contentWidth`, `padding`, `gap`, `fontSize`, `successColor` and
+`errorColor`. Colors use `#RGB` or `#RRGGBB`; sizes are pixels. Invalid options
+throw `ValidationError` before the popup opens. Arbitrary CSS/HTML is not accepted.
+Choose contrasting text, button and focus colors.
+
+Popup width supports 320–1200 px and height 480–1600 px. Mobile still requests a
+regular tab, whose size and presentation are controlled by the browser. Branding
+and styles survive the existing Google callback; account binding, consent copy,
+receipt verification and error codes remain unchanged. Google controls its own
+consent page's appearance.
+
 ## Installation
 
 ```bash

package/dist/build-metadata.json

@@ -2,11 +2,11 @@
   "schemaVersion": 2,
   "source": {
     "repository": "zkp2p/zkp2p-clients",
-    "commitSha": "8f8238e57dadbf8c2dddc5e6a1db1bfaf2d21df2",
+    "commitSha": "e848bb1cab3615498514e767e43ea50ec464a633",
     "kind": "github",
     "distributable": true
   },
-  "sdkPackageVersion": "0.14.2-rc.4",
+  "sdkPackageVersion": "0.14.3",
   "contractsPackageVersion": "0.4.2-rc.2",
   "indexerSchemaPackageVersion": "0.22.0",
   "activeDisputeStack": {

package/dist/{chunk-4SDRVKB5.mjs → chunk-2NJU3MGV.mjs}

@@ -1,5 +1,5 @@
 import { currencyKeccak256, getCurrencyInfoFromHash } from './chunk-ZB22BZLZ.mjs';
-import { __export } from './chunk-U555K2CU.mjs';
+import { __export } from './chunk-BY77PPIP.mjs';
 import { hexToBytes, keccak256, toBytes, bytesToHex } from 'viem';
 
 // src/utils/bigint.ts
@@ -97848,5 +97848,5 @@ function enrichPvIntentView(view, chainId, env = "production") {
 }
 
 export { DISPUTE_PROTECTION_POLICY_ABI, DISPUTE_PROTECTION_POLICY_ABI2, DisputeNullifierRegistry_default3 as DisputeNullifierRegistry_default, DisputeProtectionPolicy_default3 as DisputeProtectionPolicy_default, DisputeVerifier_default3 as DisputeVerifier_default, IntentLifecycleHookV1_default3 as IntentLifecycleHookV1_default, METHOD_NAME_TO_HASH, MultiAttestationVerifier_default3 as MultiAttestationVerifier_default, ORCHESTRATOR_V3_ABI2 as ORCHESTRATOR_V3_ABI, OrchestratorRegistry_default3 as OrchestratorRegistry_default, OrchestratorV3_default3 as OrchestratorV3_default, PAYMENT_PLATFORMS, STAKE_VAULT_ABI2 as STAKE_VAULT_ABI, SUPPORTED_PAYMENT_METHOD_HASHES, StakeVault_default3 as StakeVault_default, WhitelistPolicy_default3 as WhitelistPolicy_default, asciiToBytes32, enrichPvDepositView, enrichPvIntentView, ensureBytes32, getContracts, getDisputeProtectionPolicyContract, getGatingServiceAddress, getIntentGuardianContract, getOrchestratorV3Contract, getPaymentMethodsCatalog, getRateManagerContracts, getStakeVaultContract, hasIntentGuardian, matchesPaymentMethodNameAndHash, matchesQuotePaymentMethod, parseBigIntLike, parseDepositView, parseIntentView, resolveFiatCurrencyBytes32, resolvePaymentMethodHash, resolvePaymentMethodHashFromCatalog, resolvePaymentMethodNameFromHash };
-//# sourceMappingURL=chunk-4SDRVKB5.mjs.map
-//# sourceMappingURL=chunk-4SDRVKB5.mjs.map
+//# sourceMappingURL=chunk-2NJU3MGV.mjs.map
+//# sourceMappingURL=chunk-2NJU3MGV.mjs.map