@moonpay/platform-protocol 1.24.2 → 1.25.0

package/dist/frames/buy-button.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/frames/buy-button.ts"],"sourcesContent":["import type { ChallengeRequired } from '../models/challenge.js';\nimport type { FrameTransaction } from '../models/transaction.js';\nimport type { FrameError } from '../protocol.js';\n\nexport interface MessageMap {\n  /** Frame's UI is rendered and ready to be shown. */\n  ready: void;\n  /**\n   * Fired the instant the user taps the native wallet-pay button (Apple Pay /\n   * Google Pay) rendered by the buy button frame, BEFORE the OS payment sheet is\n   * presented. This is an intent-to-buy / tap signal, distinct from `complete`\n   * (the purchase outcome). It fires unconditionally on tap, even if the user\n   * later cancels the sheet.\n   */\n  buttonPressed: void;\n  complete: { transaction: FrameTransaction };\n  /** Signals that the pipeline requires a challenge step. Load `url` in a challenge frame. */\n  challenge: ChallengeRequired;\n  error: FrameError;\n}\n\nexport interface OutboundMessageMap {\n  setQuote: { quote: { signature: string } };\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/frames/buy-button.ts"],"sourcesContent":["import type { ChallengeRequired } from '../models/challenge.js';\nimport type { FrameTransaction } from '../models/transaction.js';\nimport type { FrameError } from '../protocol.js';\n\nexport interface MessageMap {\n  /** Frame's UI is rendered and ready to be shown. */\n  ready: void;\n  /**\n   * Fired the instant the user taps the native wallet-pay button (Apple Pay /\n   * Google Pay) rendered by the buy button frame, BEFORE the OS payment sheet is\n   * presented. This is an intent-to-buy / tap signal, distinct from `complete`\n   * (the purchase outcome). It fires unconditionally on tap, even if the user\n   * later cancels the sheet.\n   */\n  buttonPressed: void;\n  complete: { transaction: FrameTransaction };\n  /** Signals that the pipeline requires a challenge step. Load `url` in a challenge frame. */\n  challenge: ChallengeRequired;\n  /**\n   * Fired when the user dismisses the Apple Pay / Google Pay payment sheet\n   * without completing the purchase. Not a failure: the flow can be re-initiated.\n   */\n  cancelled: FrameError<'payment_sheet_dismissed'>;\n  /** `unsupportedPaymentMethod`: the quote's payment method has no button in this frame. */\n  error: FrameError<\n    | 'configurationError'\n    | 'invalidQuote'\n    | 'quoteExpired'\n    | 'applePayUnavailable'\n    | 'googlePayUnavailable'\n    | 'unsupportedPaymentMethod'\n    | 'generic'\n  >;\n}\n\nexport interface OutboundMessageMap {\n  setQuote: { quote: { signature: string } };\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/frames/buy-button.d.cts

@@ -18,7 +18,13 @@ interface MessageMap {
     };
     /** Signals that the pipeline requires a challenge step. Load `url` in a challenge frame. */
     challenge: ChallengeRequired;
-    error: FrameError;
+    /**
+     * Fired when the user dismisses the Apple Pay / Google Pay payment sheet
+     * without completing the purchase. Not a failure: the flow can be re-initiated.
+     */
+    cancelled: FrameError<'payment_sheet_dismissed'>;
+    /** `unsupportedPaymentMethod`: the quote's payment method has no button in this frame. */
+    error: FrameError<'configurationError' | 'invalidQuote' | 'quoteExpired' | 'applePayUnavailable' | 'googlePayUnavailable' | 'unsupportedPaymentMethod' | 'generic'>;
 }
 interface OutboundMessageMap {
     setQuote: {

package/dist/frames/buy-button.d.ts

@@ -18,7 +18,13 @@ interface MessageMap {
     };
     /** Signals that the pipeline requires a challenge step. Load `url` in a challenge frame. */
     challenge: ChallengeRequired;
-    error: FrameError;
+    /**
+     * Fired when the user dismisses the Apple Pay / Google Pay payment sheet
+     * without completing the purchase. Not a failure: the flow can be re-initiated.
+     */
+    cancelled: FrameError<'payment_sheet_dismissed'>;
+    /** `unsupportedPaymentMethod`: the quote's payment method has no button in this frame. */
+    error: FrameError<'configurationError' | 'invalidQuote' | 'quoteExpired' | 'applePayUnavailable' | 'googlePayUnavailable' | 'unsupportedPaymentMethod' | 'generic'>;
 }
 interface OutboundMessageMap {
     setQuote: {

package/dist/frames/challenge.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/frames/challenge.ts"],"sourcesContent":["import type { FrameTransaction } from '../models/transaction.js';\nimport type { FrameError } from '../protocol.js';\n\n/**\n * Mirrors the MoonPay API's `GuestCheckoutLimitUpgradeStatus` — a durable,\n * poll-any-time-later fact rather than a short-lived value: `upgraded` and\n * `rejected` reflect a persisted review outcome, not a transient in-progress signal.\n */\nexport type GuestCheckoutLimitUpgradeStatus = 'pending' | 'upgraded' | 'rejected';\n\nexport type CompleteResult = (\n  | { flow: 'buy'; transaction: FrameTransaction }\n  | { flow: 'identity'; identityId: string }\n  | { flow: 'guest_checkout_limit_upgrade'; status: GuestCheckoutLimitUpgradeStatus }\n) & {\n  sessionUpgraded?: true;\n};\n\nexport type Cancellation =\n  | { flow: 'buy'; transactionId?: string; challengeToken?: string }\n  | { flow: 'identity' }\n  | { flow: 'guest_checkout_limit_upgrade' };\n\n/**\n * The challenge frame is fully self-contained — it is driven by the\n * `challengeToken` URL param. There is no parent → child message map.\n */\nexport interface MessageMap {\n  ready: void;\n  /**\n   * Fired the instant the user taps the native pay button inside the challenge\n   * frame's payment sheet (Apple Pay / Google Pay), BEFORE the OS payment sheet\n   * is presented. This is an intent-to-buy / tap signal, distinct from\n   * `complete` (the purchase outcome). It fires unconditionally on tap, even if\n   * the user later cancels the sheet.\n   */\n  buttonPressed: void;\n  complete: CompleteResult;\n  /** User dismissed the challenge. Carry `transactionId` / `challengeToken` to resume. */\n  cancelled: Cancellation;\n  error: FrameError;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/frames/challenge.ts"],"sourcesContent":["import type { FrameTransaction } from '../models/transaction.js';\nimport type { FrameError } from '../protocol.js';\n\n/**\n * Mirrors the MoonPay API's `GuestCheckoutLimitUpgradeStatus` — a durable,\n * poll-any-time-later fact rather than a short-lived value: `upgraded` and\n * `rejected` reflect a persisted review outcome, not a transient in-progress signal.\n */\nexport type GuestCheckoutLimitUpgradeStatus = 'pending' | 'upgraded' | 'rejected';\n\n/**\n * Set on an identity `complete` when the customer cannot be verified yet\n * (`pending`, the same wording as the connect frame) or at all (`unavailable`).\n * Absent when verification finished.\n */\nexport type IdentityChallengeStatus = 'pending' | 'unavailable';\n\nexport type CompleteResult = (\n  | { flow: 'buy'; transaction: FrameTransaction }\n  | { flow: 'identity'; identityId: string; status?: IdentityChallengeStatus }\n  | { flow: 'guest_checkout_limit_upgrade'; status: GuestCheckoutLimitUpgradeStatus }\n) & {\n  sessionUpgraded?: true;\n};\n\nexport type Cancellation =\n  | { flow: 'buy'; transactionId?: string; challengeToken?: string }\n  | { flow: 'identity' }\n  | { flow: 'guest_checkout_limit_upgrade' };\n\n/**\n * Known `error` codes. `error.code` stays `string` because the identity flow\n * forwards the identity API's own codes, so treat this list as non-exhaustive.\n * The snake_case codes are already published and keep their spelling.\n * A failed payment is a `complete` with a failed transaction, not an `error`.\n */\nexport type ErrorCode =\n  | 'configurationError'\n  | 'generic'\n  | 'invalid_token'\n  | 'invalid_challenge'\n  | 'unsupported_flow'\n  | 'missing_quote'\n  | 'quoteExpired'\n  | 'unsupportedPaymentMethod'\n  | 'applePayUnavailable'\n  | 'googlePayUnavailable'\n  | 'customer_status_pending'\n  | 'customer_status_unavailable';\n\n/**\n * The challenge frame is fully self-contained — it is driven by the\n * `challengeToken` URL param. There is no parent → child message map.\n */\nexport interface MessageMap {\n  ready: void;\n  /**\n   * Fired the instant the user taps the native pay button inside the challenge\n   * frame's payment sheet (Apple Pay / Google Pay), BEFORE the OS payment sheet\n   * is presented. This is an intent-to-buy / tap signal, distinct from\n   * `complete` (the purchase outcome). It fires unconditionally on tap, even if\n   * the user later cancels the sheet.\n   */\n  buttonPressed: void;\n  complete: CompleteResult;\n  /** User dismissed the challenge. Carry `transactionId` / `challengeToken` to resume. */\n  cancelled: Cancellation;\n  error: FrameError;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/frames/challenge.d.cts

@@ -7,12 +7,19 @@ import { FrameError } from '../protocol.cjs';
  * `rejected` reflect a persisted review outcome, not a transient in-progress signal.
  */
 type GuestCheckoutLimitUpgradeStatus = 'pending' | 'upgraded' | 'rejected';
+/**
+ * Set on an identity `complete` when the customer cannot be verified yet
+ * (`pending`, the same wording as the connect frame) or at all (`unavailable`).
+ * Absent when verification finished.
+ */
+type IdentityChallengeStatus = 'pending' | 'unavailable';
 type CompleteResult = ({
     flow: 'buy';
     transaction: FrameTransaction;
 } | {
     flow: 'identity';
     identityId: string;
+    status?: IdentityChallengeStatus;
 } | {
     flow: 'guest_checkout_limit_upgrade';
     status: GuestCheckoutLimitUpgradeStatus;
@@ -28,6 +35,13 @@ type Cancellation = {
 } | {
     flow: 'guest_checkout_limit_upgrade';
 };
+/**
+ * Known `error` codes. `error.code` stays `string` because the identity flow
+ * forwards the identity API's own codes, so treat this list as non-exhaustive.
+ * The snake_case codes are already published and keep their spelling.
+ * A failed payment is a `complete` with a failed transaction, not an `error`.
+ */
+type ErrorCode = 'configurationError' | 'generic' | 'invalid_token' | 'invalid_challenge' | 'unsupported_flow' | 'missing_quote' | 'quoteExpired' | 'unsupportedPaymentMethod' | 'applePayUnavailable' | 'googlePayUnavailable' | 'customer_status_pending' | 'customer_status_unavailable';
 /**
  * The challenge frame is fully self-contained — it is driven by the
  * `challengeToken` URL param. There is no parent → child message map.
@@ -48,4 +62,4 @@ interface MessageMap {
     error: FrameError;
 }
 
-export type { Cancellation, CompleteResult, GuestCheckoutLimitUpgradeStatus, MessageMap };
+export type { Cancellation, CompleteResult, ErrorCode, GuestCheckoutLimitUpgradeStatus, IdentityChallengeStatus, MessageMap };

package/dist/frames/challenge.d.ts

@@ -7,12 +7,19 @@ import { FrameError } from '../protocol.js';
  * `rejected` reflect a persisted review outcome, not a transient in-progress signal.
  */
 type GuestCheckoutLimitUpgradeStatus = 'pending' | 'upgraded' | 'rejected';
+/**
+ * Set on an identity `complete` when the customer cannot be verified yet
+ * (`pending`, the same wording as the connect frame) or at all (`unavailable`).
+ * Absent when verification finished.
+ */
+type IdentityChallengeStatus = 'pending' | 'unavailable';
 type CompleteResult = ({
     flow: 'buy';
     transaction: FrameTransaction;
 } | {
     flow: 'identity';
     identityId: string;
+    status?: IdentityChallengeStatus;
 } | {
     flow: 'guest_checkout_limit_upgrade';
     status: GuestCheckoutLimitUpgradeStatus;
@@ -28,6 +35,13 @@ type Cancellation = {
 } | {
     flow: 'guest_checkout_limit_upgrade';
 };
+/**
+ * Known `error` codes. `error.code` stays `string` because the identity flow
+ * forwards the identity API's own codes, so treat this list as non-exhaustive.
+ * The snake_case codes are already published and keep their spelling.
+ * A failed payment is a `complete` with a failed transaction, not an `error`.
+ */
+type ErrorCode = 'configurationError' | 'generic' | 'invalid_token' | 'invalid_challenge' | 'unsupported_flow' | 'missing_quote' | 'quoteExpired' | 'unsupportedPaymentMethod' | 'applePayUnavailable' | 'googlePayUnavailable' | 'customer_status_pending' | 'customer_status_unavailable';
 /**
  * The challenge frame is fully self-contained — it is driven by the
  * `challengeToken` URL param. There is no parent → child message map.
@@ -48,4 +62,4 @@ interface MessageMap {
     error: FrameError;
 }
 
-export type { Cancellation, CompleteResult, GuestCheckoutLimitUpgradeStatus, MessageMap };
+export type { Cancellation, CompleteResult, ErrorCode, GuestCheckoutLimitUpgradeStatus, IdentityChallengeStatus, MessageMap };

package/dist/sdks/buy-button.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/sdks/buy-button.ts"],"sourcesContent":["import type * as BuyButtonFrame from '../frames/buy-button.js';\n\nexport type Event =\n  | { kind: 'ready' }\n  | { kind: 'buttonPressed' }\n  | { kind: 'complete'; payload: BuyButtonFrame.MessageMap['complete'] }\n  | { kind: 'challenge'; payload: BuyButtonFrame.MessageMap['challenge'] }\n  | { kind: 'error'; payload: BuyButtonFrame.MessageMap['error'] };\n\nexport interface SetupError {\n  kind: 'configurationError' | 'genericError';\n  message: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/sdks/buy-button.ts"],"sourcesContent":["import type * as BuyButtonFrame from '../frames/buy-button.js';\n\nexport type Event =\n  | { kind: 'ready' }\n  | { kind: 'buttonPressed' }\n  | { kind: 'complete'; payload: BuyButtonFrame.MessageMap['complete'] }\n  | { kind: 'challenge'; payload: BuyButtonFrame.MessageMap['challenge'] }\n  | { kind: 'cancelled'; payload: BuyButtonFrame.MessageMap['cancelled'] }\n  | { kind: 'error'; payload: BuyButtonFrame.MessageMap['error'] };\n\nexport interface SetupError {\n  kind: 'configurationError' | 'genericError';\n  message: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/sdks/buy-button.d.cts

@@ -13,6 +13,9 @@ type Event = {
 } | {
     kind: 'challenge';
     payload: MessageMap['challenge'];
+} | {
+    kind: 'cancelled';
+    payload: MessageMap['cancelled'];
 } | {
     kind: 'error';
     payload: MessageMap['error'];

package/dist/sdks/buy-button.d.ts

@@ -13,6 +13,9 @@ type Event = {
 } | {
     kind: 'challenge';
     payload: MessageMap['challenge'];
+} | {
+    kind: 'cancelled';
+    payload: MessageMap['cancelled'];
 } | {
     kind: 'error';
     payload: MessageMap['error'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moonpay/platform-protocol",
-  "version": "1.24.2",
+  "version": "1.25.0",
   "description": "Shared protocol types for the MoonPay Developer Platform",
   "type": "module",
   "exports": {
@@ -332,6 +332,10 @@
   },
   "sideEffects": false,
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/moonpay/moonpay-platform-sdk.git"
+  },
   "publishConfig": {
     "access": "public"
   }