@swype-org/deposit-mobile 0.2.0

package/dist/index.d.cts

@@ -0,0 +1,139 @@
+import { M as MobileDepositStatus, D as DepositResult, a as DepositError, b as MobileDepositConfig, c as DepositRequest, T as TransferSummary } from './types-Df_KwICF.cjs';
+export { C as CheckoutError, d as CheckoutErrorCode, e as DepositMobileErrorCode, f as MobileCheckoutConfig, g as MobileCheckoutStatus, S as SignerFunction, h as SignerRequest, i as SignerResponse, j as getDisplayMessage } from './types-Df_KwICF.cjs';
+
+declare const DEFAULT_WEBVIEW_BASE_URL = "https://pay-staging.tryblink.xyz";
+type EventMap = {
+    complete: (result: DepositResult) => void;
+    error: (error: DepositError) => void;
+    dismiss: () => void;
+    'status-change': (status: MobileDepositStatus) => void;
+};
+type EventName = keyof EventMap;
+/**
+ * Mobile deposit SDK.
+ *
+ * Opens a hosted payment flow in an in-app browser, waits for the result
+ * via deep link callback, and resolves when the user completes payment.
+ *
+ * ```ts
+ * const deposit = new MobileDeposit({
+ *   signer: 'https://api.merchant.com/sign-payment',
+ *   callbackScheme: 'myapp',
+ *   openUrl: (url) => WebBrowser.openBrowserAsync(url),
+ * });
+ *
+ * // When a deep link arrives, pass it to the SDK:
+ * Linking.addEventListener('url', ({ url }) => deposit.handleDeepLink(url));
+ *
+ * // Start a deposit:
+ * const result = await deposit.requestDeposit({
+ *   amount: 50,
+ *   chainId: 8453,
+ *   address: '0x...',
+ *   token: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913',
+ * });
+ * ```
+ */
+declare class MobileDeposit {
+    private readonly config;
+    private requestId;
+    private destroyed;
+    private _status;
+    private _result;
+    private _error;
+    private flowTimer;
+    private lastSignerResponse;
+    private pendingResolve;
+    private pendingReject;
+    private pendingRequestId;
+    private listeners;
+    /** Current phase of the deposit flow. */
+    get status(): MobileDepositStatus;
+    /** Last successful {@link DepositResult}, available when `status === 'completed'`. */
+    get result(): DepositResult | null;
+    /** Last {@link DepositError}, available when `status === 'error'`. */
+    get error(): DepositError | null;
+    /** Whether a deposit flow is currently in progress. */
+    get isActive(): boolean;
+    constructor(config: MobileDepositConfig);
+    /**
+     * Open the hosted payment flow for the given deposit.
+     *
+     * The returned Promise resolves when the user completes the payment (via
+     * deep link callback) and rejects with a {@link DepositError} on failure.
+     *
+     * The merchant must listen for incoming deep links and pass them to
+     * {@link handleDeepLink} for the promise to resolve.
+     */
+    requestDeposit(request: DepositRequest): Promise<DepositResult>;
+    /**
+     * Feed an incoming deep link URL to the SDK.
+     *
+     * Returns `true` if the URL was a valid Swype callback and the SDK handled
+     * it. Returns `false` if the URL did not match the expected callback pattern
+     * (the merchant should handle it themselves).
+     *
+     * Typically called from `Linking.addEventListener('url', ...)` or the
+     * equivalent deep link handler on the platform.
+     */
+    handleDeepLink(url: string): boolean;
+    /** Register an event listener. */
+    on<K extends EventName>(event: K, handler: EventMap[K]): this;
+    /** Remove a previously registered event listener. */
+    off<K extends EventName>(event: K, handler: EventMap[K]): this;
+    /**
+     * Cancel the current flow. Rejects the pending promise with
+     * `BROWSER_DISMISSED` and resets to idle.
+     */
+    close(): void;
+    /** Tear down the instance and release all resources. */
+    destroy(): void;
+    private log;
+    private setStatus;
+    private runSignerFlow;
+    private cleanup;
+    private emit;
+}
+/** @deprecated Use {@link MobileDeposit} instead. */
+declare const MobileCheckout: typeof MobileDeposit;
+
+/**
+ * Parsed result from a Swype deep link callback.
+ *
+ * @internal
+ */
+interface DeepLinkResult {
+    transferId: string;
+    transferStatus: string;
+    amount?: number;
+    currency?: string;
+    chainId?: string;
+    address?: string;
+    token?: string;
+}
+/**
+ * Check whether a URL matches the expected Swype callback deep link pattern.
+ */
+declare function isSwypeCallback(url: string, callbackScheme: string, callbackPath?: string): boolean;
+/**
+ * Parse a Swype callback deep link URL into a {@link DeepLinkResult}.
+ *
+ * Returns `null` if the URL does not match the expected scheme/path or is
+ * missing the required `transferId` parameter.
+ *
+ * Expected format:
+ * ```
+ * {scheme}://{path}?transferId=xxx&transferStatus=completed&amount=50&currency=USD&chainId=8453&address=0x...&token=USDC
+ * ```
+ */
+declare function parseDeepLink(url: string, callbackScheme: string, callbackPath?: string): DeepLinkResult | null;
+/**
+ * Convert a parsed deep link result into a {@link TransferSummary}.
+ *
+ * @internal
+ */
+declare function toTransferSummary(result: DeepLinkResult): TransferSummary;
+
+declare const VERSION = "0.2.0";
+
+export { DEFAULT_WEBVIEW_BASE_URL, DepositError, DepositRequest, DepositResult, MobileCheckout, MobileDeposit, MobileDepositConfig, MobileDepositStatus, TransferSummary, VERSION, isSwypeCallback, parseDeepLink, toTransferSummary };

package/dist/index.d.ts

@@ -0,0 +1,139 @@
+import { M as MobileDepositStatus, D as DepositResult, a as DepositError, b as MobileDepositConfig, c as DepositRequest, T as TransferSummary } from './types-Df_KwICF.js';
+export { C as CheckoutError, d as CheckoutErrorCode, e as DepositMobileErrorCode, f as MobileCheckoutConfig, g as MobileCheckoutStatus, S as SignerFunction, h as SignerRequest, i as SignerResponse, j as getDisplayMessage } from './types-Df_KwICF.js';
+
+declare const DEFAULT_WEBVIEW_BASE_URL = "https://pay-staging.tryblink.xyz";
+type EventMap = {
+    complete: (result: DepositResult) => void;
+    error: (error: DepositError) => void;
+    dismiss: () => void;
+    'status-change': (status: MobileDepositStatus) => void;
+};
+type EventName = keyof EventMap;
+/**
+ * Mobile deposit SDK.
+ *
+ * Opens a hosted payment flow in an in-app browser, waits for the result
+ * via deep link callback, and resolves when the user completes payment.
+ *
+ * ```ts
+ * const deposit = new MobileDeposit({
+ *   signer: 'https://api.merchant.com/sign-payment',
+ *   callbackScheme: 'myapp',
+ *   openUrl: (url) => WebBrowser.openBrowserAsync(url),
+ * });
+ *
+ * // When a deep link arrives, pass it to the SDK:
+ * Linking.addEventListener('url', ({ url }) => deposit.handleDeepLink(url));
+ *
+ * // Start a deposit:
+ * const result = await deposit.requestDeposit({
+ *   amount: 50,
+ *   chainId: 8453,
+ *   address: '0x...',
+ *   token: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913',
+ * });
+ * ```
+ */
+declare class MobileDeposit {
+    private readonly config;
+    private requestId;
+    private destroyed;
+    private _status;
+    private _result;
+    private _error;
+    private flowTimer;
+    private lastSignerResponse;
+    private pendingResolve;
+    private pendingReject;
+    private pendingRequestId;
+    private listeners;
+    /** Current phase of the deposit flow. */
+    get status(): MobileDepositStatus;
+    /** Last successful {@link DepositResult}, available when `status === 'completed'`. */
+    get result(): DepositResult | null;
+    /** Last {@link DepositError}, available when `status === 'error'`. */
+    get error(): DepositError | null;
+    /** Whether a deposit flow is currently in progress. */
+    get isActive(): boolean;
+    constructor(config: MobileDepositConfig);
+    /**
+     * Open the hosted payment flow for the given deposit.
+     *
+     * The returned Promise resolves when the user completes the payment (via
+     * deep link callback) and rejects with a {@link DepositError} on failure.
+     *
+     * The merchant must listen for incoming deep links and pass them to
+     * {@link handleDeepLink} for the promise to resolve.
+     */
+    requestDeposit(request: DepositRequest): Promise<DepositResult>;
+    /**
+     * Feed an incoming deep link URL to the SDK.
+     *
+     * Returns `true` if the URL was a valid Swype callback and the SDK handled
+     * it. Returns `false` if the URL did not match the expected callback pattern
+     * (the merchant should handle it themselves).
+     *
+     * Typically called from `Linking.addEventListener('url', ...)` or the
+     * equivalent deep link handler on the platform.
+     */
+    handleDeepLink(url: string): boolean;
+    /** Register an event listener. */
+    on<K extends EventName>(event: K, handler: EventMap[K]): this;
+    /** Remove a previously registered event listener. */
+    off<K extends EventName>(event: K, handler: EventMap[K]): this;
+    /**
+     * Cancel the current flow. Rejects the pending promise with
+     * `BROWSER_DISMISSED` and resets to idle.
+     */
+    close(): void;
+    /** Tear down the instance and release all resources. */
+    destroy(): void;
+    private log;
+    private setStatus;
+    private runSignerFlow;
+    private cleanup;
+    private emit;
+}
+/** @deprecated Use {@link MobileDeposit} instead. */
+declare const MobileCheckout: typeof MobileDeposit;
+
+/**
+ * Parsed result from a Swype deep link callback.
+ *
+ * @internal
+ */
+interface DeepLinkResult {
+    transferId: string;
+    transferStatus: string;
+    amount?: number;
+    currency?: string;
+    chainId?: string;
+    address?: string;
+    token?: string;
+}
+/**
+ * Check whether a URL matches the expected Swype callback deep link pattern.
+ */
+declare function isSwypeCallback(url: string, callbackScheme: string, callbackPath?: string): boolean;
+/**
+ * Parse a Swype callback deep link URL into a {@link DeepLinkResult}.
+ *
+ * Returns `null` if the URL does not match the expected scheme/path or is
+ * missing the required `transferId` parameter.
+ *
+ * Expected format:
+ * ```
+ * {scheme}://{path}?transferId=xxx&transferStatus=completed&amount=50&currency=USD&chainId=8453&address=0x...&token=USDC
+ * ```
+ */
+declare function parseDeepLink(url: string, callbackScheme: string, callbackPath?: string): DeepLinkResult | null;
+/**
+ * Convert a parsed deep link result into a {@link TransferSummary}.
+ *
+ * @internal
+ */
+declare function toTransferSummary(result: DeepLinkResult): TransferSummary;
+
+declare const VERSION = "0.2.0";
+
+export { DEFAULT_WEBVIEW_BASE_URL, DepositError, DepositRequest, DepositResult, MobileCheckout, MobileDeposit, MobileDepositConfig, MobileDepositStatus, TransferSummary, VERSION, isSwypeCallback, parseDeepLink, toTransferSummary };

package/dist/index.js

@@ -0,0 +1,8 @@
+export { CheckoutError, DEFAULT_WEBVIEW_BASE_URL, DepositError, MobileCheckout, MobileDeposit, getDisplayMessage, isSwypeCallback, parseDeepLink, toTransferSummary } from './chunk-QIPX2XQS.js';
+
+// src/index.ts
+var VERSION = "0.2.0";
+
+export { VERSION };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;AAiBO,IAAM,OAAA,GAAU","file":"index.js","sourcesContent":["export { MobileDeposit, MobileCheckout, DEFAULT_WEBVIEW_BASE_URL } from './mobile-deposit.ts';\nexport { DepositError, CheckoutError, getDisplayMessage } from './errors.ts';\nexport { isSwypeCallback, parseDeepLink, toTransferSummary } from './deep-link.ts';\nexport type { DepositMobileErrorCode, CheckoutErrorCode } from './errors.ts';\nexport type {\n  MobileDepositConfig,\n  MobileDepositStatus,\n  MobileCheckoutConfig,\n  MobileCheckoutStatus,\n  DepositRequest,\n  DepositResult,\n  SignerFunction,\n  SignerRequest,\n  SignerResponse,\n  TransferSummary,\n} from './types.ts';\n\nexport const VERSION = '0.2.0';\n"]}