@zkp2p/pay-shared 5.0.0 → 7.0.0

package/dist/types.js

@@ -231,12 +231,40 @@ export const WebhookEventType = {
     PAYMENT_CHARGEBACKED: 'PAYMENT_CHARGEBACKED',
     ORDER_PARTIALLY_CHARGEBACKED: 'ORDER_PARTIALLY_CHARGEBACKED',
     ORDER_CHARGEBACKED: 'ORDER_CHARGEBACKED',
-};
+    PAYOUT_ORDER_CREATED: 'PAYOUT_ORDER_CREATED',
+    PAYOUT_ORDER_CANCELLED: 'PAYOUT_ORDER_CANCELLED',
+    PAYOUT_ORDER_PARTIALLY_FUNDED: 'PAYOUT_ORDER_PARTIALLY_FUNDED',
+    PAYOUT_ORDER_FUNDED: 'PAYOUT_ORDER_FUNDED',
+    PAYOUT_ORDER_MATCHED: 'PAYOUT_ORDER_MATCHED',
+    PAYOUT_ORDER_PARTIALLY_PAID: 'PAYOUT_ORDER_PARTIALLY_PAID',
+    PAYOUT_ORDER_SETTLED: 'PAYOUT_ORDER_SETTLED',
+    PAYOUT_ORDER_EXPIRED: 'PAYOUT_ORDER_EXPIRED',
+};
+/** Payout events carry a PayoutView, not the order envelope. */
+export const PAYOUT_WEBHOOK_EVENT_TYPES = [
+    WebhookEventType.PAYOUT_ORDER_CREATED,
+    WebhookEventType.PAYOUT_ORDER_CANCELLED,
+    WebhookEventType.PAYOUT_ORDER_PARTIALLY_FUNDED,
+    WebhookEventType.PAYOUT_ORDER_FUNDED,
+    WebhookEventType.PAYOUT_ORDER_MATCHED,
+    WebhookEventType.PAYOUT_ORDER_PARTIALLY_PAID,
+    WebhookEventType.PAYOUT_ORDER_SETTLED,
+    WebhookEventType.PAYOUT_ORDER_EXPIRED,
+];
+const CASHOUT_WEBHOOK_EVENT_TYPE_SET = new Set(PAYOUT_WEBHOOK_EVENT_TYPES);
+export function isPayoutWebhookEventType(type) {
+    return CASHOUT_WEBHOOK_EVENT_TYPE_SET.has(type);
+}
 export const WebhookDeliveryStatus = {
     PENDING: 'PENDING',
     DELIVERED: 'DELIVERED',
     FAILED: 'FAILED',
 };
+/** Bumped only on a breaking change to a payout payload. */
+export const PAYOUT_WEBHOOK_VERSION = 2;
+export function isPayoutWebhook(payload) {
+    return isPayoutWebhookEventType(payload.type);
+}
 /**
  * Wallet-snapshot fence rejections (ownership-transfer era rule). PR 4-6 add keys to this object.
  * MERCHANT_OWNERSHIP_CHANGED is retryable: an order insert lost the era it read its wallet in.
@@ -318,3 +346,117 @@ export function maskOwnershipTransferEmail(email) {
         throw new Error('Cannot mask an address without a local part');
     return `${email.slice(0, 1)}•••${email.slice(at)}`;
 }
+// ============ Payout Types (merchant → player payouts) ============
+export const PayoutStatus = {
+    AWAITING_FUNDING: 'AWAITING_FUNDING',
+    FUNDED: 'FUNDED',
+    READY: 'READY',
+    LISTING: 'LISTING',
+    PAYING: 'PAYING',
+    SETTLED: 'SETTLED',
+    CANCELLED: 'CANCELLED',
+    EXPIRED: 'EXPIRED',
+};
+export const PayoutFundingStatus = {
+    AWAITING_FUNDING: 'AWAITING_FUNDING',
+    PARTIALLY_FUNDED: 'PARTIALLY_FUNDED',
+    FUNDED: 'FUNDED',
+    FUNDING_EXPIRED: 'FUNDING_EXPIRED',
+};
+export const PayoutCancelSource = {
+    MERCHANT: 'MERCHANT',
+    PEER_APP: 'PEER_APP',
+};
+export const PayoutKind = { ESCROW: 'ESCROW', CRYPTO: 'CRYPTO' };
+export const PayoutAttemptStatus = {
+    ACTIVE: 'ACTIVE',
+    CLOSED: 'CLOSED',
+    SETTLED: 'SETTLED',
+    FAILED: 'FAILED',
+};
+/** Fiat payout methods, in the order players see them: SAR rails, then buyer-proof rails. */
+export const PayoutFiatRail = {
+    VENMO: 'venmo',
+    CASHAPP: 'cashapp',
+    PAYPAL: 'paypal',
+    ZELLE: 'zelle',
+    REVOLUT: 'revolut',
+    CHIME: 'chime',
+};
+/** One rail per crypto payout network, with checkout's rail ids (any-coin spec "Cashout rails"); the player sees them as one "Crypto" option. */
+export const PayoutCryptoRail = {
+    RELAY_1: 'relay_1',
+    RELAY_10: 'relay_10',
+    RELAY_56: 'relay_56',
+    RELAY_137: 'relay_137',
+    RELAY_480: 'relay_480',
+    RELAY_999: 'relay_999',
+    RELAY_5042: 'relay_5042',
+    RELAY_8453: 'relay_8453',
+    RELAY_42161: 'relay_42161',
+    RELAY_8253038: 'relay_8253038',
+    RELAY_728126428: 'relay_728126428',
+    RELAY_792703809: 'relay_792703809',
+    /** ZEC on Zcash through NEAR Intents (Zcash spec "Catalog, route and address"); checkout's ZCASH_RAIL. */
+    NEAR_INTENTS_133701: 'near_intents_133701',
+};
+/** Every payout rail, in rail order: fiat, then the crypto networks. */
+export const PayoutRail = { ...PayoutFiatRail, ...PayoutCryptoRail };
+export const PayoutProvider = { RELAY: 'RELAY', NEAR_INTENTS: 'NEAR_INTENTS' };
+export const CashoutPayoutBridgeStatus = {
+    QUOTED: 'QUOTED', NOT_SENT: 'NOT_SENT', BRIDGING: 'BRIDGING', DELIVERED: 'DELIVERED', REFUNDED: 'REFUNDED',
+};
+// ============ Merchant Dashboard Payout Types ============
+/** A moment on a payout's dashboard timeline. */
+export const PayoutTimelineEventType = {
+    CREATED: 'CREATED',
+    PARTIALLY_FUNDED: 'PARTIALLY_FUNDED',
+    FUNDED: 'FUNDED',
+    FUNDING_EXPIRED: 'FUNDING_EXPIRED',
+    SIGNED_IN: 'SIGNED_IN',
+    METHOD_READY: 'METHOD_READY',
+    LISTED: 'LISTED',
+    TRANSFER_SENT: 'TRANSFER_SENT',
+    MATCHED: 'MATCHED',
+    /** A buyer paid part of the listing; the rest is listed again or left for the player. */
+    PARTIALLY_PAID: 'PARTIALLY_PAID',
+    /** Pay set the deposit's intent range to what is left, so another buyer can take it. */
+    RELISTED: 'RELISTED',
+    BUYER_DROPPED: 'BUYER_DROPPED',
+    RECONNECT_NEEDED: 'RECONNECT_NEEDED',
+    /** The listing came back to the player's wallet so they can pick another payout method. */
+    LISTING_WITHDRAWN: 'LISTING_WITHDRAWN',
+    SETTLED: 'SETTLED',
+    CANCELLED: 'CANCELLED',
+    FUNDING_ISSUE: 'FUNDING_ISSUE',
+    PAYOUT_REFUNDED: 'PAYOUT_REFUNDED',
+};
+/** Largest merchant payout step, in whole USDC. The smallest is the API's CASHOUT_MIN_USDC (10 in production). */
+export const PAYOUT_STEP_MAX_USDC = 1000;
+export const PayoutFundingIssueKind = {
+    LATE_FUNDS: 'LATE_FUNDS',
+    OVERPAYMENT: 'OVERPAYMENT',
+    ROUTE_REFUND: 'ROUTE_REFUND',
+};
+export const PayoutFundingIssueResolution = {
+    RETURNED: 'RETURNED',
+    CLAIMED: 'CLAIMED',
+};
+// ============ Cashout Player Checkout Types ============
+/** What the player can do next; drives every checkout button and every 409. */
+export const CashoutPlayerAction = {
+    SET_METHOD: 'SET_METHOD',
+    CONNECT_RAIL: 'CONNECT_RAIL',
+    SKIP_CONNECT: 'SKIP_CONNECT',
+    CONFIRM: 'CONFIRM',
+    CHANGE_METHOD: 'CHANGE_METHOD',
+    SEND_TO_ADDRESS: 'SEND_TO_ADDRESS',
+    RELIST: 'RELIST',
+};
+/** What Pay is sending from the player's wallet. */
+export const CashoutSending = { LISTING: 'LISTING', TRANSFER: 'TRANSFER', WITHDRAW: 'WITHDRAW', RELISTING: 'RELISTING' };
+export const CashoutCredentialStatus = {
+    ACTIVE: 'active',
+    INACTIVE: 'inactive',
+    MISSING: 'missing',
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zkp2p/pay-shared",
-  "version": "5.0.0",
+  "version": "7.0.0",
   "description": "Shared TypeScript types, enums, and chain utilities used by ZKP2P Pay API, SDK, and frontend apps.",
   "type": "module",
   "main": "dist/index.js",
@@ -37,7 +37,7 @@
   "scripts": {
     "build": "rm -rf dist && tsc -p tsconfig.json",
     "lint": "eslint . --ext .ts,.tsx",
-    "test": "vitest run",
+    "test": "vitest run && tsc -p tsconfig.test.json",
     "prepack": "npm run build",
     "prepublishOnly": "npm run lint"
   },