@swype-org/deposit-mobile 0.2.0

package/dist/react-native.d.cts

@@ -0,0 +1,70 @@
+import { M as MobileDepositStatus, D as DepositResult, a as DepositError, c as DepositRequest, b as MobileDepositConfig } from './types-Df_KwICF.cjs';
+export { j as getDisplayMessage } from './types-Df_KwICF.cjs';
+
+interface UseBlinkMobileDepositReturn {
+    /** Current phase of the deposit flow. */
+    status: MobileDepositStatus;
+    /** Last successful deposit result, or `null`. */
+    result: DepositResult | null;
+    /** Last deposit error, or `null`. */
+    error: DepositError | null;
+    /** User-friendly error message derived from the current error, or `null`. */
+    displayMessage: string | null;
+    /** Whether a deposit flow is currently in progress. */
+    isActive: boolean;
+    /** Start a deposit flow. */
+    requestDeposit: (request: DepositRequest) => Promise<DepositResult>;
+    /**
+     * Pass an incoming deep link URL to the SDK. Returns `true` if the URL
+     * was a Swype callback, `false` otherwise.
+     *
+     * Call this from your deep link listener (e.g. `Linking.addEventListener`).
+     */
+    handleDeepLink: (url: string) => boolean;
+    /** Cancel the current flow and reset to idle. */
+    close: () => void;
+}
+/**
+ * React / React Native hook that wraps {@link MobileDeposit} with reactive state.
+ *
+ * ```tsx
+ * import { useBlinkMobileDeposit } from '@swype-org/deposit-mobile/react-native';
+ * import * as Linking from 'expo-linking';
+ * import * as WebBrowser from 'expo-web-browser';
+ *
+ * function DepositButton() {
+ *   const { status, result, error, displayMessage, requestDeposit, handleDeepLink } =
+ *     useBlinkMobileDeposit({
+ *       signer: 'https://api.merchant.com/sign-payment',
+ *       callbackScheme: 'myapp',
+ *       openUrl: (url) => WebBrowser.openBrowserAsync(url).then(() => {}),
+ *     });
+ *
+ *   useEffect(() => {
+ *     const sub = Linking.addEventListener('url', ({ url }) => handleDeepLink(url));
+ *     return () => sub.remove();
+ *   }, [handleDeepLink]);
+ *
+ *   return (
+ *     <>
+ *       <Button
+ *         title={status === 'signer-loading' ? 'Preparing…' : 'Deposit $50'}
+ *         disabled={status === 'signer-loading'}
+ *         onPress={() =>
+ *           requestDeposit({ amount: 50, chainId: 8453, address: '0x...', token: 'USDC' })
+ *         }
+ *       />
+ *       {error && <Text>{displayMessage}</Text>}
+ *       {result && <Text>Transfer {result.transfer.id} complete!</Text>}
+ *     </>
+ *   );
+ * }
+ * ```
+ */
+declare function useBlinkMobileDeposit(config: MobileDepositConfig): UseBlinkMobileDepositReturn;
+/** @deprecated Use {@link useBlinkMobileDeposit} instead. */
+declare const useSwypeMobileCheckout: typeof useBlinkMobileDeposit;
+/** @deprecated Use {@link UseBlinkMobileDepositReturn} instead. */
+type UseSwypeMobileCheckoutReturn = UseBlinkMobileDepositReturn;
+
+export { DepositError, DepositRequest, DepositResult, MobileDepositConfig, MobileDepositStatus, type UseSwypeMobileCheckoutReturn, useBlinkMobileDeposit, useSwypeMobileCheckout };

package/dist/react-native.d.ts

@@ -0,0 +1,70 @@
+import { M as MobileDepositStatus, D as DepositResult, a as DepositError, c as DepositRequest, b as MobileDepositConfig } from './types-Df_KwICF.js';
+export { j as getDisplayMessage } from './types-Df_KwICF.js';
+
+interface UseBlinkMobileDepositReturn {
+    /** Current phase of the deposit flow. */
+    status: MobileDepositStatus;
+    /** Last successful deposit result, or `null`. */
+    result: DepositResult | null;
+    /** Last deposit error, or `null`. */
+    error: DepositError | null;
+    /** User-friendly error message derived from the current error, or `null`. */
+    displayMessage: string | null;
+    /** Whether a deposit flow is currently in progress. */
+    isActive: boolean;
+    /** Start a deposit flow. */
+    requestDeposit: (request: DepositRequest) => Promise<DepositResult>;
+    /**
+     * Pass an incoming deep link URL to the SDK. Returns `true` if the URL
+     * was a Swype callback, `false` otherwise.
+     *
+     * Call this from your deep link listener (e.g. `Linking.addEventListener`).
+     */
+    handleDeepLink: (url: string) => boolean;
+    /** Cancel the current flow and reset to idle. */
+    close: () => void;
+}
+/**
+ * React / React Native hook that wraps {@link MobileDeposit} with reactive state.
+ *
+ * ```tsx
+ * import { useBlinkMobileDeposit } from '@swype-org/deposit-mobile/react-native';
+ * import * as Linking from 'expo-linking';
+ * import * as WebBrowser from 'expo-web-browser';
+ *
+ * function DepositButton() {
+ *   const { status, result, error, displayMessage, requestDeposit, handleDeepLink } =
+ *     useBlinkMobileDeposit({
+ *       signer: 'https://api.merchant.com/sign-payment',
+ *       callbackScheme: 'myapp',
+ *       openUrl: (url) => WebBrowser.openBrowserAsync(url).then(() => {}),
+ *     });
+ *
+ *   useEffect(() => {
+ *     const sub = Linking.addEventListener('url', ({ url }) => handleDeepLink(url));
+ *     return () => sub.remove();
+ *   }, [handleDeepLink]);
+ *
+ *   return (
+ *     <>
+ *       <Button
+ *         title={status === 'signer-loading' ? 'Preparing…' : 'Deposit $50'}
+ *         disabled={status === 'signer-loading'}
+ *         onPress={() =>
+ *           requestDeposit({ amount: 50, chainId: 8453, address: '0x...', token: 'USDC' })
+ *         }
+ *       />
+ *       {error && <Text>{displayMessage}</Text>}
+ *       {result && <Text>Transfer {result.transfer.id} complete!</Text>}
+ *     </>
+ *   );
+ * }
+ * ```
+ */
+declare function useBlinkMobileDeposit(config: MobileDepositConfig): UseBlinkMobileDepositReturn;
+/** @deprecated Use {@link useBlinkMobileDeposit} instead. */
+declare const useSwypeMobileCheckout: typeof useBlinkMobileDeposit;
+/** @deprecated Use {@link UseBlinkMobileDepositReturn} instead. */
+type UseSwypeMobileCheckoutReturn = UseBlinkMobileDepositReturn;
+
+export { DepositError, DepositRequest, DepositResult, MobileDepositConfig, MobileDepositStatus, type UseSwypeMobileCheckoutReturn, useBlinkMobileDeposit, useSwypeMobileCheckout };

package/dist/react-native.js

@@ -0,0 +1,49 @@
+import { MobileDeposit, getDisplayMessage } from './chunk-QIPX2XQS.js';
+export { DepositError, getDisplayMessage } from './chunk-QIPX2XQS.js';
+import { useRef, useState, useEffect, useCallback } from 'react';
+
+function useBlinkMobileDeposit(config) {
+  const depositRef = useRef(null);
+  const [status, setStatus] = useState("idle");
+  const [result, setResult] = useState(null);
+  const [error, setError] = useState(null);
+  if (!depositRef.current) {
+    depositRef.current = new MobileDeposit(config);
+  }
+  useEffect(() => {
+    const deposit = depositRef.current;
+    const onStatusChange = (s) => setStatus(s);
+    const onComplete = (r) => {
+      setResult(r);
+      setError(null);
+    };
+    const onError = (e) => setError(e);
+    deposit.on("status-change", onStatusChange);
+    deposit.on("complete", onComplete);
+    deposit.on("error", onError);
+    return () => {
+      deposit.off("status-change", onStatusChange);
+      deposit.off("complete", onComplete);
+      deposit.off("error", onError);
+      deposit.destroy();
+      depositRef.current = null;
+    };
+  }, []);
+  const requestDeposit = useCallback(
+    (request) => depositRef.current.requestDeposit(request),
+    []
+  );
+  const handleDeepLink = useCallback(
+    (url) => depositRef.current?.handleDeepLink(url) ?? false,
+    []
+  );
+  const close = useCallback(() => depositRef.current?.close(), []);
+  const displayMessage = error ? getDisplayMessage(error) : null;
+  const isActive = status === "signer-loading" || status === "browser-active";
+  return { status, result, error, displayMessage, isActive, requestDeposit, handleDeepLink, close };
+}
+var useSwypeMobileCheckout = useBlinkMobileDeposit;
+
+export { useBlinkMobileDeposit, useSwypeMobileCheckout };
+//# sourceMappingURL=react-native.js.map
+//# sourceMappingURL=react-native.js.map

package/dist/react-native.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/react-native.ts"],"names":[],"mappings":";;;;AA2EO,SAAS,sBACd,MAAA,EAC6B;AAC7B,EAAA,MAAM,UAAA,GAAa,OAA6B,IAAI,CAAA;AACpD,EAAA,MAAM,CAAC,MAAA,EAAQ,SAAS,CAAA,GAAI,SAA8B,MAAM,CAAA;AAChE,EAAA,MAAM,CAAC,MAAA,EAAQ,SAAS,CAAA,GAAI,SAA+B,IAAI,CAAA;AAC/D,EAAA,MAAM,CAAC,KAAA,EAAO,QAAQ,CAAA,GAAI,SAA8B,IAAI,CAAA;AAE5D,EAAA,IAAI,CAAC,WAAW,OAAA,EAAS;AACvB,IAAA,UAAA,CAAW,OAAA,GAAU,IAAI,aAAA,CAAc,MAAM,CAAA;AAAA,EAC/C;AAEA,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,MAAM,UAAU,UAAA,CAAW,OAAA;AAE3B,IAAA,MAAM,cAAA,GAAiB,CAAC,CAAA,KAA2B,SAAA,CAAU,CAAC,CAAA;AAC9D,IAAA,MAAM,UAAA,GAAa,CAAC,CAAA,KAAqB;AACvC,MAAA,SAAA,CAAU,CAAC,CAAA;AACX,MAAA,QAAA,CAAS,IAAI,CAAA;AAAA,IACf,CAAA;AACA,IAAA,MAAM,OAAA,GAAU,CAAC,CAAA,KAAoB,QAAA,CAAS,CAAC,CAAA;AAE/C,IAAA,OAAA,CAAQ,EAAA,CAAG,iBAAiB,cAAc,CAAA;AAC1C,IAAA,OAAA,CAAQ,EAAA,CAAG,YAAY,UAAU,CAAA;AACjC,IAAA,OAAA,CAAQ,EAAA,CAAG,SAAS,OAAO,CAAA;AAE3B,IAAA,OAAO,MAAM;AACX,MAAA,OAAA,CAAQ,GAAA,CAAI,iBAAiB,cAAc,CAAA;AAC3C,MAAA,OAAA,CAAQ,GAAA,CAAI,YAAY,UAAU,CAAA;AAClC,MAAA,OAAA,CAAQ,GAAA,CAAI,SAAS,OAAO,CAAA;AAC5B,MAAA,OAAA,CAAQ,OAAA,EAAQ;AAChB,MAAA,UAAA,CAAW,OAAA,GAAU,IAAA;AAAA,IACvB,CAAA;AAAA,EACF,CAAA,EAAG,EAAE,CAAA;AAEL,EAAA,MAAM,cAAA,GAAiB,WAAA;AAAA,IACrB,CAAC,OAAA,KAA4B,UAAA,CAAW,OAAA,CAAS,eAAe,OAAO,CAAA;AAAA,IACvE;AAAC,GACH;AAEA,EAAA,MAAM,cAAA,GAAiB,WAAA;AAAA,IACrB,CAAC,GAAA,KAAgB,UAAA,CAAW,OAAA,EAAS,cAAA,CAAe,GAAG,CAAA,IAAK,KAAA;AAAA,IAC5D;AAAC,GACH;AAEA,EAAA,MAAM,KAAA,GAAQ,YAAY,MAAM,UAAA,CAAW,SAAS,KAAA,EAAM,EAAG,EAAE,CAAA;AAE/D,EAAA,MAAM,cAAA,GAAiB,KAAA,GAAQ,iBAAA,CAAkB,KAAK,CAAA,GAAI,IAAA;AAC1D,EAAA,MAAM,QAAA,GAAW,MAAA,KAAW,gBAAA,IAAoB,MAAA,KAAW,gBAAA;AAE3D,EAAA,OAAO,EAAE,QAAQ,MAAA,EAAQ,KAAA,EAAO,gBAAgB,QAAA,EAAU,cAAA,EAAgB,gBAAgB,KAAA,EAAM;AAClG;AAGO,IAAM,sBAAA,GAAyB","file":"react-native.js","sourcesContent":["import { useCallback, useEffect, useRef, useState } from 'react';\n\nimport { MobileDeposit } from './mobile-deposit.ts';\nimport { DepositError, getDisplayMessage } from './errors.ts';\nimport type {\n  MobileDepositConfig,\n  MobileDepositStatus,\n  DepositRequest,\n  DepositResult,\n} from './types.ts';\n\nexport type { MobileDepositConfig, MobileDepositStatus, DepositRequest, DepositResult };\nexport { DepositError, getDisplayMessage };\n\ninterface UseBlinkMobileDepositReturn {\n  /** Current phase of the deposit flow. */\n  status: MobileDepositStatus;\n  /** Last successful deposit result, or `null`. */\n  result: DepositResult | null;\n  /** Last deposit error, or `null`. */\n  error: DepositError | null;\n  /** User-friendly error message derived from the current error, or `null`. */\n  displayMessage: string | null;\n  /** Whether a deposit flow is currently in progress. */\n  isActive: boolean;\n  /** Start a deposit flow. */\n  requestDeposit: (request: DepositRequest) => Promise<DepositResult>;\n  /**\n   * Pass an incoming deep link URL to the SDK. Returns `true` if the URL\n   * was a Swype callback, `false` otherwise.\n   *\n   * Call this from your deep link listener (e.g. `Linking.addEventListener`).\n   */\n  handleDeepLink: (url: string) => boolean;\n  /** Cancel the current flow and reset to idle. */\n  close: () => void;\n}\n\n/**\n * React / React Native hook that wraps {@link MobileDeposit} with reactive state.\n *\n * ```tsx\n * import { useBlinkMobileDeposit } from '@swype-org/deposit-mobile/react-native';\n * import * as Linking from 'expo-linking';\n * import * as WebBrowser from 'expo-web-browser';\n *\n * function DepositButton() {\n *   const { status, result, error, displayMessage, requestDeposit, handleDeepLink } =\n *     useBlinkMobileDeposit({\n *       signer: 'https://api.merchant.com/sign-payment',\n *       callbackScheme: 'myapp',\n *       openUrl: (url) => WebBrowser.openBrowserAsync(url).then(() => {}),\n *     });\n *\n *   useEffect(() => {\n *     const sub = Linking.addEventListener('url', ({ url }) => handleDeepLink(url));\n *     return () => sub.remove();\n *   }, [handleDeepLink]);\n *\n *   return (\n *     <>\n *       <Button\n *         title={status === 'signer-loading' ? 'Preparing…' : 'Deposit $50'}\n *         disabled={status === 'signer-loading'}\n *         onPress={() =>\n *           requestDeposit({ amount: 50, chainId: 8453, address: '0x...', token: 'USDC' })\n *         }\n *       />\n *       {error && <Text>{displayMessage}</Text>}\n *       {result && <Text>Transfer {result.transfer.id} complete!</Text>}\n *     </>\n *   );\n * }\n * ```\n */\nexport function useBlinkMobileDeposit(\n  config: MobileDepositConfig,\n): UseBlinkMobileDepositReturn {\n  const depositRef = useRef<MobileDeposit | null>(null);\n  const [status, setStatus] = useState<MobileDepositStatus>('idle');\n  const [result, setResult] = useState<DepositResult | null>(null);\n  const [error, setError] = useState<DepositError | null>(null);\n\n  if (!depositRef.current) {\n    depositRef.current = new MobileDeposit(config);\n  }\n\n  useEffect(() => {\n    const deposit = depositRef.current!;\n\n    const onStatusChange = (s: MobileDepositStatus) => setStatus(s);\n    const onComplete = (r: DepositResult) => {\n      setResult(r);\n      setError(null);\n    };\n    const onError = (e: DepositError) => setError(e);\n\n    deposit.on('status-change', onStatusChange);\n    deposit.on('complete', onComplete);\n    deposit.on('error', onError);\n\n    return () => {\n      deposit.off('status-change', onStatusChange);\n      deposit.off('complete', onComplete);\n      deposit.off('error', onError);\n      deposit.destroy();\n      depositRef.current = null;\n    };\n  }, []);\n\n  const requestDeposit = useCallback(\n    (request: DepositRequest) => depositRef.current!.requestDeposit(request),\n    [],\n  );\n\n  const handleDeepLink = useCallback(\n    (url: string) => depositRef.current?.handleDeepLink(url) ?? false,\n    [],\n  );\n\n  const close = useCallback(() => depositRef.current?.close(), []);\n\n  const displayMessage = error ? getDisplayMessage(error) : null;\n  const isActive = status === 'signer-loading' || status === 'browser-active';\n\n  return { status, result, error, displayMessage, isActive, requestDeposit, handleDeepLink, close };\n}\n\n/** @deprecated Use {@link useBlinkMobileDeposit} instead. */\nexport const useSwypeMobileCheckout = useBlinkMobileDeposit;\n\n/** @deprecated Use {@link UseBlinkMobileDepositReturn} instead. */\nexport type UseSwypeMobileCheckoutReturn = UseBlinkMobileDepositReturn;\n"]}

package/dist/types-Df_KwICF.d.cts

@@ -0,0 +1,179 @@
+type DepositMobileErrorCode = 'BROWSER_FAILED' | 'BROWSER_DISMISSED' | 'DEEP_LINK_INVALID' | 'SIGNER_REQUEST_FAILED' | 'SIGNER_NETWORK_ERROR' | 'SIGNER_RESPONSE_INVALID' | 'SIGNER_TIMEOUT' | 'FLOW_TIMEOUT' | 'INVALID_REQUEST';
+/**
+ * Structured error thrown by the mobile deposit SDK.
+ *
+ * Every error carries a machine-readable {@link code} so merchants can
+ * branch on failure mode without parsing message strings.
+ */
+declare class DepositError extends Error {
+    readonly code: DepositMobileErrorCode;
+    constructor(code: DepositMobileErrorCode, message: string);
+}
+/**
+ * Return a user-friendly display string for a {@link DepositError}.
+ *
+ * Merchants can show this directly in their UI without maintaining their own
+ * copy for each error code.
+ */
+declare function getDisplayMessage(error: DepositError): string;
+/** @deprecated Use {@link DepositMobileErrorCode} instead. */
+type CheckoutErrorCode = DepositMobileErrorCode;
+/** @deprecated Use {@link DepositError} instead. */
+declare const CheckoutError: typeof DepositError;
+
+/** Current phase of the mobile deposit flow. */
+type MobileDepositStatus = 'idle' | 'signer-loading' | 'browser-active' | 'completed' | 'error';
+/** Configuration for the {@link MobileDeposit} instance. */
+interface MobileDepositConfig {
+    /**
+     * Merchant signer — either a URL string or a custom async function.
+     *
+     * **String:** The SDK sends a `POST` with a JSON `SignerRequest` body to this
+     * URL and expects a `SignerResponse` back. This is the simplest integration.
+     *
+     * **Function:** The SDK calls the function with a `SignerRequest` and expects
+     * a `Promise<SignerResponse>`. Use this when you need control over the HTTP
+     * method, authentication headers, request transformation, or any other
+     * aspect of the signing request.
+     */
+    signer: string | SignerFunction;
+    /**
+     * Base URL of the hosted payment webview app.
+     *
+     * The SDK appends `merchantId`, `payload`, and `signature` query parameters
+     * to this URL and opens it in the in-app browser.
+     *
+     * @default 'https://pay-staging.tryblink.xyz'
+     */
+    webviewBaseUrl?: string;
+    /**
+     * Custom URL scheme registered by the mobile app (e.g. `'myapp'`).
+     *
+     * The hosted payment flow redirects to `{callbackScheme}://swype/callback?...`
+     * when the user completes or cancels the payment. The app must listen for
+     * this deep link and pass it to {@link MobileDeposit.handleDeepLink}.
+     */
+    callbackScheme: string;
+    /**
+     * Path component of the callback deep link.
+     *
+     * @default '/swype/callback'
+     */
+    callbackPath?: string;
+    /**
+     * Function that opens a URL in an in-app browser.
+     *
+     * The SDK calls this to launch the hosted payment flow. Use your preferred
+     * in-app browser implementation:
+     *
+     * - React Native: `expo-web-browser` (`WebBrowser.openBrowserAsync`)
+     * - iOS native: `SFSafariViewController`
+     * - Android native: `CustomTabsIntent`
+     *
+     * The returned promise should resolve when the browser is dismissed
+     * (regardless of whether the user completed payment — the actual result
+     * arrives via deep link).
+     */
+    openUrl: (url: string) => Promise<void>;
+    /**
+     * Maximum time in milliseconds to wait for the signer endpoint to respond.
+     *
+     * @default 15000
+     */
+    signerTimeoutMs?: number;
+    /**
+     * Maximum time in milliseconds for the entire deposit flow (signer + user
+     * completion). When exceeded the promise rejects with a `FLOW_TIMEOUT`
+     * error. `undefined` means no limit.
+     */
+    flowTimeoutMs?: number;
+    /**
+     * When `true`, the SDK logs lifecycle events to `console.debug`.
+     *
+     * @default false
+     */
+    debug?: boolean;
+}
+/** Parameters for a single deposit request. */
+interface DepositRequest {
+    /** USD amount to deposit (must be > 0). */
+    amount: number;
+    /** EVM chain ID for the destination (e.g. 8453 for Base). */
+    chainId: number;
+    /** Destination wallet address (0x-prefixed, 40 hex chars). */
+    address: string;
+    /** Token contract address on the destination chain (e.g. `'0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913'`). */
+    token: string;
+    /** Merchant order or invoice ID for reconciliation. */
+    reference?: string;
+    /** Arbitrary key-value pairs forwarded to the signer endpoint. */
+    metadata?: Record<string, string>;
+}
+/** Result returned when a deposit completes successfully. */
+interface DepositResult {
+    transfer: TransferSummary;
+    /** Idempotency key from the signer response, if available. */
+    idempotencyKey?: string;
+    /** Signer preview echoed back for merchant-side display / logging. */
+    preview?: {
+        amount: number;
+        chainId: number;
+        address: string;
+        token: string;
+    };
+}
+/** Subset of transfer data returned from the hosted flow on completion. */
+interface TransferSummary {
+    id: string;
+    status: string;
+    amount?: {
+        amount: number;
+        currency: string;
+    };
+    destinations?: Array<{
+        chainId: string;
+        address: string;
+        token?: {
+            address?: string;
+            symbol?: string;
+        };
+    }>;
+}
+/** Shape returned by the merchant signer. */
+interface SignerResponse {
+    merchantId: string;
+    payload: string;
+    signature: string;
+    expiresAt?: string;
+    preview: {
+        amount: number;
+        chainId: number;
+        address: string;
+        token: string;
+        idempotencyKey: string;
+    };
+}
+/** Data passed to the merchant signer describing the payment to sign. */
+interface SignerRequest {
+    amount: number;
+    chainId: number;
+    address: string;
+    token: string;
+    callbackScheme: string | null;
+    url: string;
+    version: 'v1';
+    reference?: string;
+    metadata?: Record<string, string>;
+}
+/**
+ * Async function that receives a {@link SignerRequest} and returns a
+ * {@link SignerResponse}. Use this when you need full control over how
+ * the signing request is made (custom HTTP method, auth headers, etc.).
+ */
+type SignerFunction = (data: SignerRequest) => Promise<SignerResponse>;
+/** @deprecated Use {@link MobileDepositStatus} instead. */
+type MobileCheckoutStatus = MobileDepositStatus;
+/** @deprecated Use {@link MobileDepositConfig} instead. */
+type MobileCheckoutConfig = MobileDepositConfig;
+
+export { CheckoutError as C, type DepositResult as D, type MobileDepositStatus as M, type SignerFunction as S, type TransferSummary as T, DepositError as a, type MobileDepositConfig as b, type DepositRequest as c, type CheckoutErrorCode as d, type DepositMobileErrorCode as e, type MobileCheckoutConfig as f, type MobileCheckoutStatus as g, type SignerRequest as h, type SignerResponse as i, getDisplayMessage as j };

package/dist/types-Df_KwICF.d.ts

@@ -0,0 +1,179 @@
+type DepositMobileErrorCode = 'BROWSER_FAILED' | 'BROWSER_DISMISSED' | 'DEEP_LINK_INVALID' | 'SIGNER_REQUEST_FAILED' | 'SIGNER_NETWORK_ERROR' | 'SIGNER_RESPONSE_INVALID' | 'SIGNER_TIMEOUT' | 'FLOW_TIMEOUT' | 'INVALID_REQUEST';
+/**
+ * Structured error thrown by the mobile deposit SDK.
+ *
+ * Every error carries a machine-readable {@link code} so merchants can
+ * branch on failure mode without parsing message strings.
+ */
+declare class DepositError extends Error {
+    readonly code: DepositMobileErrorCode;
+    constructor(code: DepositMobileErrorCode, message: string);
+}
+/**
+ * Return a user-friendly display string for a {@link DepositError}.
+ *
+ * Merchants can show this directly in their UI without maintaining their own
+ * copy for each error code.
+ */
+declare function getDisplayMessage(error: DepositError): string;
+/** @deprecated Use {@link DepositMobileErrorCode} instead. */
+type CheckoutErrorCode = DepositMobileErrorCode;
+/** @deprecated Use {@link DepositError} instead. */
+declare const CheckoutError: typeof DepositError;
+
+/** Current phase of the mobile deposit flow. */
+type MobileDepositStatus = 'idle' | 'signer-loading' | 'browser-active' | 'completed' | 'error';
+/** Configuration for the {@link MobileDeposit} instance. */
+interface MobileDepositConfig {
+    /**
+     * Merchant signer — either a URL string or a custom async function.
+     *
+     * **String:** The SDK sends a `POST` with a JSON `SignerRequest` body to this
+     * URL and expects a `SignerResponse` back. This is the simplest integration.
+     *
+     * **Function:** The SDK calls the function with a `SignerRequest` and expects
+     * a `Promise<SignerResponse>`. Use this when you need control over the HTTP
+     * method, authentication headers, request transformation, or any other
+     * aspect of the signing request.
+     */
+    signer: string | SignerFunction;
+    /**
+     * Base URL of the hosted payment webview app.
+     *
+     * The SDK appends `merchantId`, `payload`, and `signature` query parameters
+     * to this URL and opens it in the in-app browser.
+     *
+     * @default 'https://pay-staging.tryblink.xyz'
+     */
+    webviewBaseUrl?: string;
+    /**
+     * Custom URL scheme registered by the mobile app (e.g. `'myapp'`).
+     *
+     * The hosted payment flow redirects to `{callbackScheme}://swype/callback?...`
+     * when the user completes or cancels the payment. The app must listen for
+     * this deep link and pass it to {@link MobileDeposit.handleDeepLink}.
+     */
+    callbackScheme: string;
+    /**
+     * Path component of the callback deep link.
+     *
+     * @default '/swype/callback'
+     */
+    callbackPath?: string;
+    /**
+     * Function that opens a URL in an in-app browser.
+     *
+     * The SDK calls this to launch the hosted payment flow. Use your preferred
+     * in-app browser implementation:
+     *
+     * - React Native: `expo-web-browser` (`WebBrowser.openBrowserAsync`)
+     * - iOS native: `SFSafariViewController`
+     * - Android native: `CustomTabsIntent`
+     *
+     * The returned promise should resolve when the browser is dismissed
+     * (regardless of whether the user completed payment — the actual result
+     * arrives via deep link).
+     */
+    openUrl: (url: string) => Promise<void>;
+    /**
+     * Maximum time in milliseconds to wait for the signer endpoint to respond.
+     *
+     * @default 15000
+     */
+    signerTimeoutMs?: number;
+    /**
+     * Maximum time in milliseconds for the entire deposit flow (signer + user
+     * completion). When exceeded the promise rejects with a `FLOW_TIMEOUT`
+     * error. `undefined` means no limit.
+     */
+    flowTimeoutMs?: number;
+    /**
+     * When `true`, the SDK logs lifecycle events to `console.debug`.
+     *
+     * @default false
+     */
+    debug?: boolean;
+}
+/** Parameters for a single deposit request. */
+interface DepositRequest {
+    /** USD amount to deposit (must be > 0). */
+    amount: number;
+    /** EVM chain ID for the destination (e.g. 8453 for Base). */
+    chainId: number;
+    /** Destination wallet address (0x-prefixed, 40 hex chars). */
+    address: string;
+    /** Token contract address on the destination chain (e.g. `'0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913'`). */
+    token: string;
+    /** Merchant order or invoice ID for reconciliation. */
+    reference?: string;
+    /** Arbitrary key-value pairs forwarded to the signer endpoint. */
+    metadata?: Record<string, string>;
+}
+/** Result returned when a deposit completes successfully. */
+interface DepositResult {
+    transfer: TransferSummary;
+    /** Idempotency key from the signer response, if available. */
+    idempotencyKey?: string;
+    /** Signer preview echoed back for merchant-side display / logging. */
+    preview?: {
+        amount: number;
+        chainId: number;
+        address: string;
+        token: string;
+    };
+}
+/** Subset of transfer data returned from the hosted flow on completion. */
+interface TransferSummary {
+    id: string;
+    status: string;
+    amount?: {
+        amount: number;
+        currency: string;
+    };
+    destinations?: Array<{
+        chainId: string;
+        address: string;
+        token?: {
+            address?: string;
+            symbol?: string;
+        };
+    }>;
+}
+/** Shape returned by the merchant signer. */
+interface SignerResponse {
+    merchantId: string;
+    payload: string;
+    signature: string;
+    expiresAt?: string;
+    preview: {
+        amount: number;
+        chainId: number;
+        address: string;
+        token: string;
+        idempotencyKey: string;
+    };
+}
+/** Data passed to the merchant signer describing the payment to sign. */
+interface SignerRequest {
+    amount: number;
+    chainId: number;
+    address: string;
+    token: string;
+    callbackScheme: string | null;
+    url: string;
+    version: 'v1';
+    reference?: string;
+    metadata?: Record<string, string>;
+}
+/**
+ * Async function that receives a {@link SignerRequest} and returns a
+ * {@link SignerResponse}. Use this when you need full control over how
+ * the signing request is made (custom HTTP method, auth headers, etc.).
+ */
+type SignerFunction = (data: SignerRequest) => Promise<SignerResponse>;
+/** @deprecated Use {@link MobileDepositStatus} instead. */
+type MobileCheckoutStatus = MobileDepositStatus;
+/** @deprecated Use {@link MobileDepositConfig} instead. */
+type MobileCheckoutConfig = MobileDepositConfig;
+
+export { CheckoutError as C, type DepositResult as D, type MobileDepositStatus as M, type SignerFunction as S, type TransferSummary as T, DepositError as a, type MobileDepositConfig as b, type DepositRequest as c, type CheckoutErrorCode as d, type DepositMobileErrorCode as e, type MobileCheckoutConfig as f, type MobileCheckoutStatus as g, type SignerRequest as h, type SignerResponse as i, getDisplayMessage as j };

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@swype-org/deposit-mobile",
+  "version": "0.2.0",
+  "description": "Lightweight mobile deposit SDK — open a hosted Swype payment flow via in-app browser, handle deep-link completion, zero runtime dependencies",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./react-native": {
+      "import": {
+        "types": "./dist/react-native.d.ts",
+        "default": "./dist/react-native.js"
+      },
+      "require": {
+        "types": "./dist/react-native.d.cts",
+        "default": "./dist/react-native.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "test": "node --experimental-strip-types --test src/*.test.ts",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.14",
+    "tsup": "^8.4.0",
+    "typescript": "5.7.3"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/swype-org/swype.git",
+    "directory": "deposit-mobile-sdk"
+  },
+  "keywords": [
+    "deposit",
+    "payments",
+    "sdk",
+    "merchant",
+    "mobile",
+    "react-native",
+    "deep-link"
+  ]
+}