@zkp2p/pay-shared 6.0.0 → 7.0.0

package/dist/types.js

@@ -231,28 +231,28 @@ export const WebhookEventType = {
     PAYMENT_CHARGEBACKED: 'PAYMENT_CHARGEBACKED',
     ORDER_PARTIALLY_CHARGEBACKED: 'ORDER_PARTIALLY_CHARGEBACKED',
     ORDER_CHARGEBACKED: 'ORDER_CHARGEBACKED',
-    CASHOUT_ORDER_CREATED: 'CASHOUT_ORDER_CREATED',
-    CASHOUT_ORDER_CANCELLED: 'CASHOUT_ORDER_CANCELLED',
-    CASHOUT_ORDER_PARTIALLY_FUNDED: 'CASHOUT_ORDER_PARTIALLY_FUNDED',
-    CASHOUT_ORDER_FUNDED: 'CASHOUT_ORDER_FUNDED',
-    CASHOUT_ORDER_MATCHED: 'CASHOUT_ORDER_MATCHED',
-    CASHOUT_ORDER_PARTIALLY_PAID: 'CASHOUT_ORDER_PARTIALLY_PAID',
-    CASHOUT_ORDER_SETTLED: 'CASHOUT_ORDER_SETTLED',
-    CASHOUT_ORDER_EXPIRED: 'CASHOUT_ORDER_EXPIRED',
-};
-/** Cashout events carry a CashoutView, not the order envelope. */
-export const CASHOUT_WEBHOOK_EVENT_TYPES = [
-    WebhookEventType.CASHOUT_ORDER_CREATED,
-    WebhookEventType.CASHOUT_ORDER_CANCELLED,
-    WebhookEventType.CASHOUT_ORDER_PARTIALLY_FUNDED,
-    WebhookEventType.CASHOUT_ORDER_FUNDED,
-    WebhookEventType.CASHOUT_ORDER_MATCHED,
-    WebhookEventType.CASHOUT_ORDER_PARTIALLY_PAID,
-    WebhookEventType.CASHOUT_ORDER_SETTLED,
-    WebhookEventType.CASHOUT_ORDER_EXPIRED,
+    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(CASHOUT_WEBHOOK_EVENT_TYPES);
-export function isCashoutWebhookEventType(type) {
+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 = {
@@ -260,10 +260,10 @@ export const WebhookDeliveryStatus = {
     DELIVERED: 'DELIVERED',
     FAILED: 'FAILED',
 };
-/** Bumped only on a breaking change to a cashout payload. */
-export const CASHOUT_WEBHOOK_VERSION = 1;
-export function isCashoutWebhook(payload) {
-    return isCashoutWebhookEventType(payload.type);
+/** 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.
@@ -346,38 +346,36 @@ export function maskOwnershipTransferEmail(email) {
         throw new Error('Cannot mask an address without a local part');
     return `${email.slice(0, 1)}•••${email.slice(at)}`;
 }
-// ============ Cashout Types (merchant → player payouts) ============
-export const CashoutStatus = {
+// ============ Payout Types (merchant → player payouts) ============
+export const PayoutStatus = {
     AWAITING_FUNDING: 'AWAITING_FUNDING',
     FUNDED: 'FUNDED',
     READY: 'READY',
     LISTING: 'LISTING',
     PAYING: 'PAYING',
     SETTLED: 'SETTLED',
-    CANCELLING: 'CANCELLING',
     CANCELLED: 'CANCELLED',
     EXPIRED: 'EXPIRED',
 };
-export const CashoutFundingStatus = {
+export const PayoutFundingStatus = {
     AWAITING_FUNDING: 'AWAITING_FUNDING',
     PARTIALLY_FUNDED: 'PARTIALLY_FUNDED',
     FUNDED: 'FUNDED',
     FUNDING_EXPIRED: 'FUNDING_EXPIRED',
 };
-export const CashoutCancelSource = {
-    CHECKOUT: 'CHECKOUT',
+export const PayoutCancelSource = {
     MERCHANT: 'MERCHANT',
     PEER_APP: 'PEER_APP',
 };
-export const CashoutPayoutKind = { ESCROW: 'ESCROW', CRYPTO: 'CRYPTO' };
-export const CashoutAttemptStatus = {
+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 CashoutFiatRail = {
+export const PayoutFiatRail = {
     VENMO: 'venmo',
     CASHAPP: 'cashapp',
     PAYPAL: 'paypal',
@@ -386,7 +384,7 @@ export const CashoutFiatRail = {
     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 CashoutCryptoRail = {
+export const PayoutCryptoRail = {
     RELAY_1: 'relay_1',
     RELAY_10: 'relay_10',
     RELAY_56: 'relay_56',
@@ -402,15 +400,15 @@ export const CashoutCryptoRail = {
     /** ZEC on Zcash through NEAR Intents (Zcash spec "Catalog, route and address"); checkout's ZCASH_RAIL. */
     NEAR_INTENTS_133701: 'near_intents_133701',
 };
-/** Every cashout rail, in rail order: fiat, then the crypto networks. */
-export const CashoutRail = { ...CashoutFiatRail, ...CashoutCryptoRail };
-export const CashoutPayoutProvider = { RELAY: 'RELAY', NEAR_INTENTS: 'NEAR_INTENTS' };
+/** 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 Cashout Types ============
-/** A moment on a cashout's dashboard timeline. */
-export const CashoutTimelineEventType = {
+// ============ Merchant Dashboard Payout Types ============
+/** A moment on a payout's dashboard timeline. */
+export const PayoutTimelineEventType = {
     CREATED: 'CREATED',
     PARTIALLY_FUNDED: 'PARTIALLY_FUNDED',
     FUNDED: 'FUNDED',
@@ -426,7 +424,6 @@ export const CashoutTimelineEventType = {
     RELISTED: 'RELISTED',
     BUYER_DROPPED: 'BUYER_DROPPED',
     RECONNECT_NEEDED: 'RECONNECT_NEEDED',
-    CANCEL_STARTED: 'CANCEL_STARTED',
     /** The listing came back to the player's wallet so they can pick another payout method. */
     LISTING_WITHDRAWN: 'LISTING_WITHDRAWN',
     SETTLED: 'SETTLED',
@@ -434,14 +431,14 @@ export const CashoutTimelineEventType = {
     FUNDING_ISSUE: 'FUNDING_ISSUE',
     PAYOUT_REFUNDED: 'PAYOUT_REFUNDED',
 };
-/** Largest merchant cashout payout step, in whole USDC. The smallest is the API's CASHOUT_MIN_USDC (10 in production). */
-export const CASHOUT_PAYOUT_STEP_MAX_USDC = 1000;
-export const CashoutFundingIssueKind = {
+/** 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 CashoutFundingIssueResolution = {
+export const PayoutFundingIssueResolution = {
     RETURNED: 'RETURNED',
     CLAIMED: 'CLAIMED',
 };
@@ -452,8 +449,6 @@ export const CashoutPlayerAction = {
     CONNECT_RAIL: 'CONNECT_RAIL',
     SKIP_CONNECT: 'SKIP_CONNECT',
     CONFIRM: 'CONFIRM',
-    CANCEL: 'CANCEL',
-    FINISH_CANCEL: 'FINISH_CANCEL',
     CHANGE_METHOD: 'CHANGE_METHOD',
     SEND_TO_ADDRESS: 'SEND_TO_ADDRESS',
     RELIST: 'RELIST',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zkp2p/pay-shared",
-  "version": "6.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",