@zkp2p/pay-shared 4.0.0 → 5.0.0

package/dist/types.js

@@ -60,6 +60,7 @@ export const CheckoutMethod = {
 export const FeePayer = {
     MERCHANT: 'MERCHANT',
     PAYEE: 'PAYEE',
+    SPLIT: 'SPLIT',
 };
 export const MerchantPaymentFlowMode = {
     EXCLUSIVE_SAR: 'EXCLUSIVE_SAR',
@@ -112,8 +113,47 @@ export const CheckoutPaymentMemoPolicy = {
     REQUIRED: 'REQUIRED',
     EMPTY: 'EMPTY',
 };
+// ============ Open-amount orders ============
+/** FIXED orders carry an amount from creation; OPEN orders get one when the buyer starts a payment. */
+export const OrderAmountMode = {
+    FIXED: 'FIXED',
+    OPEN: 'OPEN',
+};
+/**
+ * Why the buyer can no longer change an open order's amount. Precedence when several apply:
+ * PAID, then PAYMENT_MAY_SETTLE, then PAYMENT_IN_PROGRESS.
+ */
+export const AmountLockReason = {
+    /** Only CREATED non-Zcash payments lock the amount; cancelling them unlocks it. */
+    PAYMENT_IN_PROGRESS: 'PAYMENT_IN_PROGRESS',
+    /** An EXPIRED payment, a locking Zcash payment or a reopenable FAILED Relay payment can still settle; cancelling cannot unlock it. */
+    PAYMENT_MAY_SETTLE: 'PAYMENT_MAY_SETTLE',
+    /** A SETTLED payment exists. */
+    PAID: 'PAID',
+};
+export const OpenAmountErrorCode = {
+    OPEN_AMOUNT_INVALID: 'OPEN_AMOUNT_INVALID',
+    OPEN_AMOUNT_DISABLED: 'OPEN_AMOUNT_DISABLED',
+    AMOUNT_REQUIRED: 'AMOUNT_REQUIRED',
+    AMOUNT_NOT_ALLOWED: 'AMOUNT_NOT_ALLOWED',
+    AMOUNT_OUT_OF_RANGE: 'AMOUNT_OUT_OF_RANGE',
+    AMOUNT_LOCKED: 'AMOUNT_LOCKED',
+    AMOUNT_CONFLICT: 'AMOUNT_CONFLICT',
+    RESIZE_NOT_SUPPORTED: 'RESIZE_NOT_SUPPORTED',
+};
+export const PaymentPenaltyKind = {
+    PURCHASE_PROTECTION: 'PURCHASE_PROTECTION',
+    CROSS_CURRENCY: 'CROSS_CURRENCY',
+};
+export const MerchantUserRole = {
+    OWNER: 'OWNER',
+    MANAGER: 'MANAGER',
+    CASHIER: 'CASHIER',
+};
 // Structured error codes for Order failures
+export const PAYMENT_CREATION_PAUSED_MESSAGE = 'Payments are temporarily paused. Please try again shortly.';
 export const OrderErrorCode = {
+    PAYMENTS_PAUSED: 'PAYMENTS_PAUSED',
     // Proof verification errors
     PROOF_INVALID: 'PROOF_INVALID', // Proof data failed attestation verification
     PROOF_EXPIRED: 'PROOF_EXPIRED', // Proof timestamp too old
@@ -131,6 +171,8 @@ export const OrderErrorCode = {
     BRIDGE_TIMEOUT: 'BRIDGE_TIMEOUT', // Bridge fill timed out
     // Fee threshold errors (exact-fiat mode)
     FEE_THRESHOLD_EXCEEDED: 'FEE_THRESHOLD_EXCEEDED', // Quote fee exceeds merchant's max
+    // Payment start limits
+    INTENT_ABOVE_MAX: 'INTENT_ABOVE_MAX', // On-chain intent above the per-payment limit (fees included)
     // Generic
     SDK_ERROR: 'SDK_ERROR', // Unknown SDK error
     UNKNOWN_ERROR: 'UNKNOWN_ERROR', // Uncategorized error
@@ -163,12 +205,18 @@ export const OnboardingStepVerifiedBy = {
     AUTO: 'auto',
     MANUAL: 'manual',
 };
+export const MERCHANT_REFERRAL_FEE_BPS_BY_TIER = {
+    BASE: 30,
+    PRO: 50,
+    CONCIERGE: 100,
+};
 // ============ Webhook Types ============
 export const WebhookEventType = {
     ORDER_CREATED: 'ORDER_CREATED',
     ORDER_FULFILLED: 'ORDER_FULFILLED',
     ORDER_CANCELLED: 'ORDER_CANCELLED',
     ORDER_RESIZED: 'ORDER_RESIZED',
+    ORDER_AMOUNT_SET: 'ORDER_AMOUNT_SET',
     PAYMENT_CREATED: 'PAYMENT_CREATED',
     PAYMENT_SETTLED: 'PAYMENT_SETTLED',
     PAYMENT_CANCELLED: 'PAYMENT_CANCELLED',
@@ -189,3 +237,84 @@ export const WebhookDeliveryStatus = {
     DELIVERED: 'DELIVERED',
     FAILED: 'FAILED',
 };
+/**
+ * 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.
+ * ORDER_FROM_PREVIOUS_OWNER is final: the order belongs to an earlier owner's era.
+ */
+export const MerchantOwnershipErrorCode = {
+    MERCHANT_OWNERSHIP_CHANGED: 'MERCHANT_OWNERSHIP_CHANGED',
+    ORDER_FROM_PREVIOUS_OWNER: 'ORDER_FROM_PREVIOUS_OWNER',
+    MEMBER_LOCKED: 'MEMBER_LOCKED',
+    /** 403: the current merchant is not an enabled, LIVE, eligible Master Merchant Account. */
+    MASTER_MERCHANT_NOT_ENABLED: 'MASTER_MERCHANT_NOT_ENABLED',
+    /** 422: the master merchant fee is above the Master Merchant Account's masterMerchantMaxFeeBps, only when the Master Merchant Account has a cap. */
+    MASTER_MERCHANT_FEE_EXCEEDS_CAP: 'MASTER_MERCHANT_FEE_EXCEEDS_CAP',
+    /** 422: a payment method's configured fees for some amount band would exceed the max fee. */
+    MASTER_MERCHANT_FEE_EXCEEDS_MAX_FEE: 'MASTER_MERCHANT_FEE_EXCEEDS_MAX_FEE',
+    /** 409: the Master Merchant Account can no longer change this sub merchant's fee (transferred, or a transfer is pending). */
+    MASTER_MERCHANT_FEE_LOCKED: 'MASTER_MERCHANT_FEE_LOCKED',
+    TRANSFER_ALREADY_PENDING: 'TRANSFER_ALREADY_PENDING',
+    WALLET_SETUP_REQUIRED: 'WALLET_SETUP_REQUIRED',
+    TERMS_CHANGED: 'TERMS_CHANGED',
+    TRANSFER_NOT_FOUND: 'TRANSFER_NOT_FOUND',
+    TRANSFER_EMAIL_MISMATCH: 'TRANSFER_EMAIL_MISMATCH',
+    TRANSFER_UNAVAILABLE: 'TRANSFER_UNAVAILABLE',
+};
+export const MERCHANT_OWNERSHIP_CHANGED_MESSAGE = 'The merchant account changed owners while this order was being created. Retry to create it for the new owner.';
+export const ORDER_FROM_PREVIOUS_OWNER_MESSAGE = 'This order was created before the merchant account changed owners. Ask the merchant for a new payment link.';
+export const ORDER_FROM_PREVIOUS_OWNER_REFUND_MESSAGE = 'This order was created before the merchant account changed owners, so it cannot be refunded from this account.';
+/** Response copy for MEMBER_LOCKED: the Master Merchant Account seat after an ownership transfer can only be removed by an admin. */
+export const MEMBER_LOCKED_MESSAGE = 'Locked merchant member can only be removed by an admin';
+/** One user-facing message per ownership-transfer error; the API and the CLI simulator both send these. */
+export const OWNERSHIP_TRANSFER_ERROR_MESSAGES = {
+    TRANSFER_ALREADY_PENDING: 'A transfer is already pending for this merchant account',
+    WALLET_SETUP_REQUIRED: 'Set up your wallet in the dashboard before accepting this transfer',
+    TERMS_CHANGED: 'The transfer terms changed; review them again before accepting',
+    TRANSFER_NOT_FOUND: 'Ownership transfer not found',
+    TRANSFER_EMAIL_MISMATCH: 'This transfer is for a different email',
+    TRANSFER_UNAVAILABLE: 'This transfer was withdrawn or expired',
+};
+/**
+ * Routing states POST /auth/login returns (HTTP 200, `merchant: null`) instead of auto-claiming an
+ * invite or auto-creating a merchant, while an ownership transfer applies to a user with no merchant.
+ */
+export const OwnershipTransferLoginState = {
+    PENDING_OWNERSHIP_TRANSFER: 'PENDING_OWNERSHIP_TRANSFER',
+    OWNERSHIP_TRANSFER_EMAIL_MISMATCH: 'OWNERSHIP_TRANSFER_EMAIL_MISMATCH',
+    OWNERSHIP_TRANSFER_UNAVAILABLE: 'OWNERSHIP_TRANSFER_UNAVAILABLE',
+};
+/** Discriminator of POST /auth/ownership-transfers/preview. EMAIL_MISMATCH is the spec's `emailMatches: false`. */
+export const OwnershipTransferPreviewState = {
+    PENDING: 'PENDING',
+    EMAIL_MISMATCH: 'EMAIL_MISMATCH',
+    ACCEPTED: 'ACCEPTED',
+};
+/** Mirrors the Prisma enum MerchantOwnershipTransferStatus for pure (Prisma-free) wire schemas. */
+export const OwnershipTransferStatus = {
+    PENDING: 'PENDING',
+    ACCEPTED: 'ACCEPTED',
+    CANCELLED: 'CANCELLED',
+    EXPIRED: 'EXPIRED',
+};
+export const MerchantOwnershipTransferCancelReason = {
+    MASTER_MERCHANT_CANCELLED: 'MASTER_MERCHANT_CANCELLED',
+    TERMS_CHANGED: 'TERMS_CHANGED',
+    MASTER_MERCHANT_FLAG_REMOVED: 'MASTER_MERCHANT_FLAG_REMOVED',
+};
+export const OwnershipTransferMasterMerchantPermission = {
+    CHECKOUT_CONFIG: 'CHECKOUT_CONFIG',
+    TEAM: 'TEAM',
+};
+/** What the Master Merchant Account's locked MANAGER seat keeps after a transfer (spec decisions 2 and 9; refunds are OWNER-only); the accept page lists exactly these. */
+export const OWNERSHIP_TRANSFER_MASTER_MERCHANT_PERMISSIONS = [
+    OwnershipTransferMasterMerchantPermission.CHECKOUT_CONFIG,
+    OwnershipTransferMasterMerchantPermission.TEAM,
+];
+/** "alice@example.com" → "a•••@example.com". The input is a validated, lowercased address. */
+export function maskOwnershipTransferEmail(email) {
+    const at = email.indexOf('@');
+    if (at < 1)
+        throw new Error('Cannot mask an address without a local part');
+    return `${email.slice(0, 1)}•••${email.slice(at)}`;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zkp2p/pay-shared",
-  "version": "4.0.0",
+  "version": "5.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",
@@ -39,7 +39,7 @@
     "lint": "eslint . --ext .ts,.tsx",
     "test": "vitest run",
     "prepack": "npm run build",
-    "prepublishOnly": "npm pack --dry-run"
+    "prepublishOnly": "npm run lint"
   },
   "devDependencies": {
     "vitest": "^1.6.1"