framepayments-react-native 3.0.0 → 4.0.0

package/src/native.ts

@@ -1,232 +0,0 @@
-/**
- * Native module bridge. Uses NativeModules for classic React Native bridge.
- */
-
-import { NativeModules, Platform } from 'react-native';
-import type {
-  FrameCartItem,
-  FrameTheme,
-  OnboardingCapability,
-  OnboardingResult,
-  PresentApplePayOptions,
-  PresentGooglePayOptions,
-} from './types';
-import { ErrorCodes } from './errors';
-
-const LINKING_ERROR =
-  `The package 'framepayments-react-native' doesn't seem to be linked. Make sure you have run 'pod install' (iOS) or rebuilt the app (Android).`;
-
-const FrameSDK = NativeModules.FrameSDK
-  ? NativeModules.FrameSDK
-  : new Proxy(
-      {},
-      {
-        get() {
-          throw new Error(LINKING_ERROR);
-        },
-      }
-    );
-
-/**
- * Throw a coded error from synchronous JS validation. Mirrors the `code`/`message`
- * shape that native rejections produce so consumers can catch `e.code === 'INVALID_*'`
- * uniformly.
- */
-function throwCoded(code: string, message: string): never {
-  const err = new Error(message) as Error & { code: string };
-  err.code = code;
-  throw err;
-}
-
-// theme is iOS-only today: frame-android does not yet have a matching theme API,
-// so the field is accepted on both platforms but ignored on Android until it does.
-
-let isInitialized = false;
-
-export function initialize(options: {
-  secretKey: string;
-  publishableKey: string;
-  debugMode?: boolean;
-  /**
-   * Optional theme applied SDK-wide to Frame's reusable iOS components
-   * (checkout, cart, onboarding). Pass any subset — unspecified tokens fall
-   * back to SDK defaults. No-op on Android until frame-android ships a
-   * matching theme API.
-   */
-  theme?: FrameTheme;
-}): Promise<void> {
-  if (!options?.secretKey) {
-    throwCoded(ErrorCodes.INIT_FAILED, 'Frame.initialize requires secretKey');
-  }
-  if (!options?.publishableKey) {
-    throwCoded(ErrorCodes.INIT_FAILED, 'Frame.initialize requires publishableKey');
-  }
-  if (options.theme !== undefined && (typeof options.theme !== 'object' || Array.isArray(options.theme))) {
-    throwCoded(ErrorCodes.INIT_FAILED, 'Frame.initialize: theme must be an object');
-  }
-  return wrapPromise(
-    FrameSDK.initialize(
-      options.secretKey,
-      options.publishableKey,
-      options.debugMode ?? false,
-      options.theme ?? null
-    )
-  ).then(() => {
-    isInitialized = true;
-  });
-}
-
-function guardInitialized(): void {
-  if (!isInitialized) {
-    const message =
-      'Frame SDK must be initialized before calling presentCheckout, presentCart, or presentOnboarding. Call Frame.initialize({ apiKey }) first.';
-    const err = new Error(message) as Error & { code: string };
-    err.code = ErrorCodes.NOT_INITIALIZED;
-    throw err;
-  }
-}
-
-function wrapPromise<T>(p: Promise<T>): Promise<T> {
-  return p.catch((err) => {
-    let code = 'UNKNOWN_ERROR';
-    let message = String(err?.message ?? err);
-    if (err?.code) code = err.code;
-    if (typeof err === 'object' && err !== null && 'message' in err) {
-      message = String((err as { message: string }).message);
-    }
-    throw Object.assign(new Error(message), { code, message });
-  });
-}
-
-/**
- * Presents the Frame checkout sheet for the given account. Resolves with the
- * created Transfer's id string on success, or rejects with `USER_CANCELED` if
- * the user dismisses the sheet.
- *
- * `accountId` is required: the bundled checkout creates a `Transfer`, which is
- * account-scoped. Callers needing a customer/ChargeIntent flow should use
- * `presentApplePay` / `presentGooglePay` directly with a customer owner.
- */
-export function presentCheckout(options: {
-  accountId: string;
-  amount: number;
-}): Promise<string> {
-  guardInitialized();
-  if (!options?.accountId) {
-    throwCoded(ErrorCodes.INVALID_ACCOUNT, 'Frame.presentCheckout requires accountId');
-  }
-  return wrapPromise(
-    FrameSDK.presentCheckout(options.accountId, options.amount)
-  );
-}
-
-/**
- * Presents the Frame cart UI; tapping checkout routes through the same flow
- * as `presentCheckout` and resolves with the created Transfer's id string.
- *
- * `accountId` is required for the same reason as `presentCheckout`.
- */
-export function presentCart(options: {
-  accountId: string;
-  items: FrameCartItem[];
-  shippingAmountInCents: number;
-}): Promise<string> {
-  guardInitialized();
-  if (!options?.accountId) {
-    throwCoded(ErrorCodes.INVALID_ACCOUNT, 'Frame.presentCart requires accountId');
-  }
-  return wrapPromise(
-    FrameSDK.presentCart(
-      options.accountId,
-      options.items,
-      options.shippingAmountInCents
-    )
-  );
-}
-
-export function presentOnboarding(options: {
-  accountId?: string | null;
-  capabilities?: OnboardingCapability[];
-  applePayMerchantId?: string | null;
-  googlePayMerchantId?: string | null;
-}): Promise<OnboardingResult> {
-  guardInitialized();
-  if (Platform.OS === 'ios') {
-    return wrapPromise(
-      FrameSDK.presentOnboarding(
-        options.accountId ?? null,
-        options.capabilities ?? [],
-        options.applePayMerchantId ?? null
-      )
-    );
-  }
-  return wrapPromise(
-    FrameSDK.presentOnboarding(
-      options.accountId ?? null,
-      options.capabilities ?? [],
-      options.googlePayMerchantId ?? null
-    )
-  );
-}
-
-/**
- * Presents the Apple Pay sheet and creates a charge from the resulting wallet
- * payment method. Resolves with the created resource's id string on success,
- * or rejects with `USER_CANCELED` if the sheet is dismissed.
- *
- *  - `owner.type === 'customer'` → creates a `ChargeIntent`; resolves with its id.
- *  - `owner.type === 'account'`  → creates a `Transfer`;     resolves with its id.
- */
-export function presentApplePay(options: PresentApplePayOptions): Promise<string> {
-  guardInitialized();
-  if (Platform.OS !== 'ios') {
-    throwCoded('PLATFORM_UNSUPPORTED', 'Frame.presentApplePay is iOS-only; use presentGooglePay on Android.');
-  }
-  if (!options?.owner || (options.owner.type !== 'customer' && options.owner.type !== 'account')) {
-    throwCoded(ErrorCodes.INVALID_OWNER, 'Frame.presentApplePay requires owner: { type: "customer" | "account", id: string }');
-  }
-  if (!options.owner.id) {
-    throwCoded(ErrorCodes.INVALID_OWNER, 'Frame.presentApplePay requires owner.id');
-  }
-  if (!options.merchantId) {
-    throwCoded(ErrorCodes.INVALID_MERCHANT_ID, 'Frame.presentApplePay requires merchantId');
-  }
-  return wrapPromise(
-    FrameSDK.presentApplePay(
-      options.owner.type,
-      options.owner.id,
-      options.amount,
-      options.currency ?? 'usd',
-      options.merchantId
-    )
-  );
-}
-
-/**
- * Presents Google Pay and creates a charge from the resulting wallet payment method.
- * Resolves with the created resource's id string on success.
- *
- *  - `owner.type === 'customer'` → creates a `ChargeIntent`; resolves with its id.
- *  - `owner.type === 'account'`  → creates a `Transfer`;     resolves with its id.
- */
-export function presentGooglePay(options: PresentGooglePayOptions): Promise<string> {
-  guardInitialized();
-  if (Platform.OS !== 'android') {
-    throwCoded('PLATFORM_UNSUPPORTED', 'Frame.presentGooglePay is Android-only; use presentApplePay on iOS.');
-  }
-  if (!options?.owner || (options.owner.type !== 'customer' && options.owner.type !== 'account')) {
-    throwCoded(ErrorCodes.INVALID_OWNER, 'Frame.presentGooglePay requires owner: { type: "customer" | "account", id: string }');
-  }
-  if (!options.owner.id) {
-    throwCoded(ErrorCodes.INVALID_OWNER, 'Frame.presentGooglePay requires owner.id');
-  }
-  return wrapPromise(
-    FrameSDK.presentGooglePay(
-      options.amountCents,
-      options.owner.type,
-      options.owner.id,
-      options.currencyCode ?? 'USD',
-      options.googlePayMerchantId ?? null
-    )
-  );
-}

package/src/types.ts

@@ -1,187 +0,0 @@
-/**
- * Types for the Frame React Native SDK modal APIs.
- * For other types (Customer, Refund, etc.), use the framepayments (frame-node) package when calling APIs from JS.
- */
-
-/** Cart item for presentCart({ items }) */
-export interface FrameCartItem {
-  id: string;
-  title: string;
-  amountInCents: number;
-  imageUrl: string;
-}
-
-export interface BillingAddress {
-  city?: string;
-  country?: string;
-  state?: string;
-  postalCode: string;
-  addressLine1?: string;
-  addressLine2?: string;
-}
-
-export interface PaymentCard {
-  brand: string;
-  expirationMonth: string;
-  expirationYear: string;
-  lastFourDigits: string;
-  issuer?: string;
-  currency?: string;
-  type?: string;
-}
-
-export interface BankAccount {
-  bankName?: string;
-  lastFour?: string;
-  accountType?: string;
-}
-
-export interface PaymentMethod {
-  id: string;
-  type: 'card' | 'ach';
-  status: string;
-  created: number;
-  updated: number;
-  livemode: boolean;
-  object: string;
-  customerId?: string;
-  card?: PaymentCard;
-  ach?: BankAccount;
-  billing?: BillingAddress;
-}
-
-/** Error shape when native module rejects (same as FrameErrorShape from errors.ts) */
-export interface FrameError {
-  code: string;
-  message: string;
-  nativeError?: string;
-}
-
-/** Capabilities that drive which onboarding steps are shown */
-export type OnboardingCapability =
-  | 'kyc'
-  | 'kyc_prefill'
-  | 'phone_verification'
-  | 'creator_shield'
-  | 'card_verification'
-  | 'card_send'
-  | 'card_receive'
-  | 'address_verification'
-  | 'bank_account_verification'
-  | 'bank_account_send'
-  | 'bank_account_receive'
-  | 'geo_compliance'
-  | 'age_verification';
-
-export type OnboardingResultStatus = 'completed' | 'cancelled';
-
-/** Result returned from presentOnboarding */
-export interface OnboardingResult {
-  status: OnboardingResultStatus;
-  /** Present when status === 'completed' and a payment method was created/verified */
-  paymentMethodId?: string;
-}
-
-/**
- * Identifies who the wallet payment method belongs to and which downstream
- * resource is created when the user authorizes payment. Used by both
- * `presentApplePay` and `presentGooglePay`.
- *
- *  - `{ type: 'customer', id }` → creates a `ChargeIntent`; promise resolves with the ChargeIntent id.
- *  - `{ type: 'account',  id }` → creates a `Transfer`;     promise resolves with the Transfer id.
- *
- * The promise always resolves with a string id; the caller knows which resource
- * it refers to based on the owner type they passed in.
- */
-export type WalletOwner =
-  | { type: 'customer'; id: string }
-  | { type: 'account'; id: string };
-
-/** @deprecated Use {@link WalletOwner}. Retained as an alias for source compatibility. */
-export type ApplePayOwner = WalletOwner;
-
-/** Options for Frame.presentApplePay. */
-export interface PresentApplePayOptions {
-  /** Payment amount in cents. */
-  amount: number;
-  /** ISO 4217 currency code. Defaults to 'usd'. */
-  currency?: string;
-  /** Customer or account that owns the resulting payment method and charge. */
-  owner: WalletOwner;
-  /** Apple Pay merchant ID configured in your Apple Developer account. */
-  merchantId: string;
-}
-
-/** Options for Frame.presentGooglePay. */
-export interface PresentGooglePayOptions {
-  /** Payment amount in cents. */
-  amountCents: number;
-  /** Customer or account that owns the resulting payment method and charge. */
-  owner: WalletOwner;
-  /** ISO 4217 currency code. Defaults to 'USD'. */
-  currencyCode?: string;
-  /** Optional override for the Google Pay merchant ID. */
-  googlePayMerchantId?: string;
-}
-
-/**
- * Theming for Frame's reusable iOS components (checkout, cart, onboarding).
- * iOS-only: on Android, Frame.setTheme() resolves immediately and has no effect
- * until frame-android ships a matching theme API.
- *
- * Pass any subset — unspecified tokens fall back to SDK defaults.
- */
-
-/** Hex color: '#RGB', '#RRGGBB', or '#RRGGBBAA' (with or without leading '#'). */
-export type FrameThemeColor = string;
-
-/**
- * Custom font reference. `name` must be a PostScript font name registered in
- * the host app's Info.plist `UIAppFonts` and bundled as a resource. Pass
- * `name: 'system'` to use the system font at the given size.
- */
-export interface FrameThemeFont {
-  name: string;
-  size: number;
-}
-
-export interface FrameThemeColors {
-  primaryButton?: FrameThemeColor;
-  primaryButtonText?: FrameThemeColor;
-  secondaryButton?: FrameThemeColor;
-  secondaryButtonText?: FrameThemeColor;
-  disabledButton?: FrameThemeColor;
-  disabledButtonStroke?: FrameThemeColor;
-  disabledButtonText?: FrameThemeColor;
-  surface?: FrameThemeColor;
-  surfaceStroke?: FrameThemeColor;
-  textPrimary?: FrameThemeColor;
-  textSecondary?: FrameThemeColor;
-  error?: FrameThemeColor;
-  onboardingHeaderBackground?: FrameThemeColor;
-  onboardingProgressFilledOnBrand?: FrameThemeColor;
-  onboardingProgressEmptyOnBrand?: FrameThemeColor;
-}
-
-export interface FrameThemeFonts {
-  title?: FrameThemeFont;
-  heading?: FrameThemeFont;
-  headline?: FrameThemeFont;
-  body?: FrameThemeFont;
-  bodySmall?: FrameThemeFont;
-  label?: FrameThemeFont;
-  caption?: FrameThemeFont;
-  button?: FrameThemeFont;
-}
-
-export interface FrameThemeRadii {
-  small?: number;
-  medium?: number;
-  large?: number;
-}
-
-export interface FrameTheme {
-  colors?: FrameThemeColors;
-  fonts?: FrameThemeFonts;
-  radii?: FrameThemeRadii;
-}