@moonpay/platform-protocol 1.0.2 → 1.4.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  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  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":[]}

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

@@ -3,6 +3,8 @@ import { FrameTransaction } from '../models/transaction.cjs';
 import { FrameError } from '../protocol.cjs';
 
 interface MessageMap {
+    /** Frame's UI is rendered and ready to be shown. */
+    ready: void;
     complete: {
         transaction: FrameTransaction;
     };

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

@@ -3,6 +3,8 @@ import { FrameTransaction } from '../models/transaction.js';
 import { FrameError } from '../protocol.js';
 
 interface MessageMap {
+    /** Frame's UI is rendered and ready to be shown. */
+    ready: void;
     complete: {
         transaction: FrameTransaction;
     };

package/dist/models/transaction.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/models/transaction.ts"],"sourcesContent":["/**\n * Transaction shape as sent within frame postMessage payloads.\n * Two variants: happy path (`{ id, status }`) and explicit failed path with\n * `failureReason` for partner-facing diagnostics.\n */\nexport type FrameTransaction =\n  | { id: string; status: string }\n  | { id?: string; status: 'failed'; failureReason: string };\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/models/transaction.ts"],"sourcesContent":["export type FrameTransactionStatus = 'pending' | 'completed' | 'failed';\n\nexport type FrameTransactionFailureCode =\n  | 'applePayMerchantUnavailable'\n  | 'authorizationDeclined'\n  | 'serviceUnavailable'\n  | 'transactionDeclined'\n  | 'transactionNotAllowed'\n  | 'unknown'\n  | 'validationError';\n\n/**\n * Transaction shape as sent within frame postMessage payloads.\n * Two variants: happy path (`{ id, status }`) and explicit failed path with\n * `failureReason` for partner-facing diagnostics.\n */\nexport type FrameTransaction =\n  | { id: string; status: FrameTransactionStatus }\n  | {\n      id?: string;\n      status: 'failed';\n      failureReason: string;\n      failureCode: FrameTransactionFailureCode;\n    };\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/models/transaction.d.cts

@@ -1,3 +1,5 @@
+type FrameTransactionStatus = 'pending' | 'completed' | 'failed';
+type FrameTransactionFailureCode = 'applePayMerchantUnavailable' | 'authorizationDeclined' | 'serviceUnavailable' | 'transactionDeclined' | 'transactionNotAllowed' | 'unknown' | 'validationError';
 /**
  * Transaction shape as sent within frame postMessage payloads.
  * Two variants: happy path (`{ id, status }`) and explicit failed path with
@@ -5,11 +7,12 @@
  */
 type FrameTransaction = {
     id: string;
-    status: string;
+    status: FrameTransactionStatus;
 } | {
     id?: string;
     status: 'failed';
     failureReason: string;
+    failureCode: FrameTransactionFailureCode;
 };
 
-export type { FrameTransaction };
+export type { FrameTransaction, FrameTransactionFailureCode, FrameTransactionStatus };

package/dist/models/transaction.d.ts

@@ -1,3 +1,5 @@
+type FrameTransactionStatus = 'pending' | 'completed' | 'failed';
+type FrameTransactionFailureCode = 'applePayMerchantUnavailable' | 'authorizationDeclined' | 'serviceUnavailable' | 'transactionDeclined' | 'transactionNotAllowed' | 'unknown' | 'validationError';
 /**
  * Transaction shape as sent within frame postMessage payloads.
  * Two variants: happy path (`{ id, status }`) and explicit failed path with
@@ -5,11 +7,12 @@
  */
 type FrameTransaction = {
     id: string;
-    status: string;
+    status: FrameTransactionStatus;
 } | {
     id?: string;
     status: 'failed';
     failureReason: string;
+    failureCode: FrameTransactionFailureCode;
 };
 
-export type { FrameTransaction };
+export type { FrameTransaction, FrameTransactionFailureCode, FrameTransactionStatus };

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: '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: '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":[]}

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

@@ -4,6 +4,8 @@ import '../models/transaction.cjs';
 import '../protocol.cjs';
 
 type Event = {
+    kind: 'ready';
+} | {
     kind: 'complete';
     payload: MessageMap['complete'];
 } | {

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

@@ -4,6 +4,8 @@ import '../models/transaction.js';
 import '../protocol.js';
 
 type Event = {
+    kind: 'ready';
+} | {
     kind: 'complete';
     payload: MessageMap['complete'];
 } | {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moonpay/platform-protocol",
-  "version": "1.0.2",
+  "version": "1.4.0",
   "description": "Shared protocol types for the MoonPay Developer Platform",
   "type": "module",
   "exports": {