@moonpay/platform-protocol 0.3.0-next.1 → 1.0.0

package/dist/index.js

@@ -1,63 +0,0 @@
-// src/connection.ts
-var ConnectionStatus = /* @__PURE__ */ ((ConnectionStatus2) => {
-  ConnectionStatus2["connectionRequired"] = "connectionRequired";
-  ConnectionStatus2["active"] = "active";
-  ConnectionStatus2["unavailable"] = "unavailable";
-  ConnectionStatus2["pending"] = "pending";
-  ConnectionStatus2["failed"] = "failed";
-  ConnectionStatus2["termsAcceptanceRequired"] = "termsAcceptanceRequired";
-  return ConnectionStatus2;
-})(ConnectionStatus || {});
-
-// src/errors.ts
-var ConnectionErrorCode = /* @__PURE__ */ ((ConnectionErrorCode2) => {
-  ConnectionErrorCode2["validationError"] = "validationError";
-  ConnectionErrorCode2["connectionFailedGeneric"] = "generic";
-  return ConnectionErrorCode2;
-})(ConnectionErrorCode || {});
-var DevPlatformApiErrorCodes = {
-  unknownError: "unknown_error",
-  unauthorized: "unauthorized",
-  forbidden: "forbidden",
-  notFound: "not_found",
-  invalidRequest: "invalid_request",
-  notImplemented: "not_implemented",
-  tooManyRequests: "too_many_requests",
-  notAllowed: "not_allowed",
-  conflict: "conflict",
-  unprocessableEntity: "unprocessable_entity",
-  sseTimeout: "sse_timeout",
-  sseError: "sse_error",
-  connectionRequired: "connection_required",
-  connectionPending: "connection_pending",
-  connectionUnavailable: "connection_unavailable",
-  serviceUnavailable: "service_unavailable",
-  requirementsIncomplete: "requirements_incomplete",
-  verificationRejected: "verification_rejected",
-  countryMismatch: "country_mismatch",
-  unsupportedCountry: "unsupported_country"
-};
-
-// src/message.ts
-var HANDSHAKE_REQUEST_KIND = "handshake";
-var HANDSHAKE_ACK_KIND = "ack";
-
-// src/result.ts
-var ok = (value) => ({
-  ok: true,
-  value
-});
-var err = (error) => ({
-  ok: false,
-  error
-});
-export {
-  ConnectionErrorCode,
-  ConnectionStatus,
-  DevPlatformApiErrorCodes,
-  HANDSHAKE_ACK_KIND,
-  HANDSHAKE_REQUEST_KIND,
-  err,
-  ok
-};
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/connection.ts","../src/errors.ts","../src/message.ts","../src/result.ts"],"sourcesContent":["// ---------------------------------------------------------------------------\n// Connection statuses\n// ---------------------------------------------------------------------------\n\nexport enum ConnectionStatus {\n  /**\n   * New or expired user — needs the full connect flow.\n   */\n  connectionRequired = 'connectionRequired',\n\n  /**\n   * Valid connection — encrypted credentials are included.\n   */\n  active = 'active',\n\n  /**\n   * Restricted location — connection cannot be used.\n   */\n  unavailable = 'unavailable',\n\n  /**\n   * KYC decision delayed — may resolve on a subsequent visit.\n   */\n  pending = 'pending',\n\n  /**\n   * Terminal failure — KYC fail, rejection, etc.\n   */\n  failed = 'failed',\n\n  /**\n   * Customer has no valid Terms of Use attestation on file (headless/Identity API partners).\n   * Display Terms of Use in your own UI, capture acceptance, call\n   * `POST /platform/v1/terms/attestations`, then retry the connection.\n   */\n  termsAcceptanceRequired = 'termsAcceptanceRequired',\n}\n\nexport interface ConnectionRequired {\n  status: ConnectionStatus.connectionRequired;\n  /**\n   * Base64-encoded, X25519+AES-GCM encrypted anonymous token payload.\n   * These are frame-internal tokens used by the connect frame — they cannot be\n   * used to call MoonPay APIs directly. Decrypt via `decryptCredentials()` only\n   * if you need the `clientToken` to bootstrap the connect frame manually.\n   */\n  credentials: string;\n  /**\n   * Capabilities and regulatory requirements available before authentication, if any.\n   * Present when Apple Pay 1TAP is enabled for the partner.\n   */\n  capabilities?: CustomerCapabilities;\n}\n\nexport interface ActiveConnection {\n  status: ConnectionStatus.active;\n  /** The authenticated MoonPay customer. */\n  customer: { id: string };\n  /**\n   * Base64-encoded, X25519+AES-GCM encrypted JSON containing:\n   * ```json\n   * {\n   *   \"accessToken\": \"<token>\",\n   *   \"clientToken\": \"<token>\",\n   *   \"expiresAt\": \"<iso8601>\"\n   * }\n   * ```\n   *\n   * - `accessToken`: A token that can be used to make API requests from the client.\n   * - `clientToken`: A token that can be used to initialize sensitive frames such as Apple Pay.\n   * - `expiresAt`: An ISO 8601 formatted string indicating when the tokens expire.\n   */\n  credentials: string;\n  /**\n   * Capabilities and regulatory requirements for the authenticated customer.\n   */\n  capabilities: CustomerCapabilities;\n}\n\nexport interface UnavailableConnection {\n  status: ConnectionStatus.unavailable;\n}\n\nexport interface PendingConnection {\n  status: ConnectionStatus.pending;\n}\n\nexport interface FailedConnection {\n  status: ConnectionStatus.failed;\n  reason: string;\n}\n\nexport interface TermsAcceptanceRequiredConnection {\n  status: ConnectionStatus.termsAcceptanceRequired;\n}\n\n/** Discriminated union of all connection result statuses. */\nexport type Connection =\n  | ConnectionRequired\n  | ActiveConnection\n  | UnavailableConnection\n  | PendingConnection\n  | FailedConnection\n  | TermsAcceptanceRequiredConnection;\n\n// ---------------------------------------------------------------------------\n// Decrypted credentials (what the SDK exposes after decryption)\n// ---------------------------------------------------------------------------\n\nexport interface DecryptedCredentials {\n  accessToken: string;\n  clientToken: string;\n  expiresAt: string;\n}\n\n// ---------------------------------------------------------------------------\n// Customer capabilities\n// ---------------------------------------------------------------------------\n\n/**\n * Capabilities and regulatory requirements for the authenticated customer.\n */\nexport interface CustomerCapabilities {\n  /** Capabilities for the ramps (buy and sell) product. */\n  ramps?: RampsCapability;\n  /** Capabilities for the Apple Pay 1TAP flow. Present when 1TAP is enabled for the partner and the customer matches. */\n  oneTapApplePay?: RampsCapability;\n}\n\n/**\n * Capabilities and requirements for the ramps (buy and sell) product.\n */\nexport interface RampsCapability {\n  /** Regulatory requirements for ramps operations in the customer's jurisdiction. */\n  requirements: RampsRequirements;\n}\n\n/**\n * Regulatory requirements that apply to ramps operations for the customer.\n */\nexport interface RampsRequirements {\n  /**\n   * Present when the customer's jurisdiction requires payment disclosures\n   * before a ramps transaction. Omitted when no disclosures are required.\n   */\n  paymentDisclosures?: PaymentDisclosuresRequirement;\n}\n\n/**\n * A jurisdiction that requires payment disclosures before a ramps transaction.\n */\nexport interface PaymentDisclosuresRequirement {\n  /** The ISO 3166-1 alpha-3 country code for the jurisdiction. */\n  country: string;\n  /** The state or province code within the country. */\n  administrativeArea: string;\n}\n","// ---------------------------------------------------------------------------\n// Connection errors (from connect/check-connection frames)\n// ---------------------------------------------------------------------------\n\nexport enum ConnectionErrorCode {\n  validationError = 'validationError',\n  /** Wire value is `'generic'`. */\n  connectionFailedGeneric = 'generic',\n}\n\nexport interface ConfigValidationFieldError {\n  code: 'invalidSessionToken' | 'invalidClientToken' | 'invalidPublicKey';\n  message: string;\n}\n\nexport type ConnectionError =\n  | {\n      code: ConnectionErrorCode.validationError;\n      errors: ConfigValidationFieldError[];\n    }\n  | {\n      code: ConnectionErrorCode.connectionFailedGeneric;\n      message?: string;\n    };\n\n// ---------------------------------------------------------------------------\n// API errors\n// ---------------------------------------------------------------------------\n\nexport const DevPlatformApiErrorCodes = {\n  unknownError: 'unknown_error',\n  unauthorized: 'unauthorized',\n  forbidden: 'forbidden',\n  notFound: 'not_found',\n  invalidRequest: 'invalid_request',\n  notImplemented: 'not_implemented',\n  tooManyRequests: 'too_many_requests',\n  notAllowed: 'not_allowed',\n  conflict: 'conflict',\n  unprocessableEntity: 'unprocessable_entity',\n  sseTimeout: 'sse_timeout',\n  sseError: 'sse_error',\n  connectionRequired: 'connection_required',\n  connectionPending: 'connection_pending',\n  connectionUnavailable: 'connection_unavailable',\n  serviceUnavailable: 'service_unavailable',\n  requirementsIncomplete: 'requirements_incomplete',\n  verificationRejected: 'verification_rejected',\n  countryMismatch: 'country_mismatch',\n  unsupportedCountry: 'unsupported_country',\n} as const;\n\nexport type DevPlatformApiErrorCode =\n  (typeof DevPlatformApiErrorCodes)[keyof typeof DevPlatformApiErrorCodes];\n\nexport interface DevPlatformApiErrorDetail {\n  field?: string;\n  message: string;\n}\n\n/** Shape returned by the MoonPay Platform API on error responses. */\nexport interface DevPlatformApiError {\n  code: DevPlatformApiErrorCode;\n  message: string;\n  errors?: DevPlatformApiErrorDetail[];\n}\n\n// ---------------------------------------------------------------------------\n// SDK-level error types\n// ---------------------------------------------------------------------------\n\nexport interface GetConnectionError {\n  message: string;\n}\n\nexport interface ConnectError {\n  message: string;\n}\n\nexport interface SetupWidgetError {\n  kind: 'configurationError' | 'apiError' | 'genericError';\n  message: string;\n}\n\nexport interface SetupApplePayError {\n  kind:\n    | 'invalidQuote'\n    | 'quoteExpired'\n    | 'applePayUnavailable'\n    | 'oneTapApplePaySecondFactorRequired'\n    | 'genericError';\n  message: string;\n}\n\nexport interface SetupGooglePayError {\n  kind: 'invalidQuote' | 'quoteExpired' | 'googlePayUnavailable' | 'genericError';\n  message: string;\n}\n\nexport type GetQuoteError = DevPlatformApiError;\nexport type GetPaymentMethodsError = DevPlatformApiError;\nexport type GetTransactionsError = DevPlatformApiError;\nexport type CreateSessionError = DevPlatformApiError;\nexport type RevokeSessionError = DevPlatformApiError;\nexport type CreateIdentityError = DevPlatformApiError;\nexport type GetIdentityError = DevPlatformApiError;\nexport type UpdateIdentityError = DevPlatformApiError;\nexport type VerifyIdentityError = DevPlatformApiError;\nexport type GetIdentityUploadUrlError = DevPlatformApiError;\nexport type SubmitIdentityFilesError = DevPlatformApiError;\n\nexport interface SetupBuyError {\n  kind: 'configurationError' | 'genericError';\n  message: string;\n}\n\nexport interface SetupBuyButtonError {\n  kind: 'configurationError' | 'genericError';\n  message: string;\n}\n\nexport interface SetupChallengeError {\n  kind: 'configurationError' | 'genericError';\n  message: string;\n}\n\nexport interface SetupAuthError {\n  kind: 'configurationError' | 'genericError';\n  message: string;\n}\n\nexport interface SetupAddCardError {\n  kind: 'configurationError' | 'genericError';\n  message: string;\n}\n\nexport interface ResetConnectionError {\n  message: string;\n}\n","// ---------------------------------------------------------------------------\n// Wire format\n// ---------------------------------------------------------------------------\n\n/** The V2 protocol envelope sent over postMessage between frames and SDK. */\nexport interface ProtocolMessage<K extends string = string, P = unknown> {\n  version: 2;\n  meta: { channelId: string };\n  kind: K;\n  payload?: P;\n}\n\n// ---------------------------------------------------------------------------\n// Handshake\n// ---------------------------------------------------------------------------\n\nexport const HANDSHAKE_REQUEST_KIND = 'handshake' as const;\nexport const HANDSHAKE_ACK_KIND = 'ack' as const;\n\nexport type HandshakeRequest = ProtocolMessage<typeof HANDSHAKE_REQUEST_KIND>;\nexport type HandshakeAck = ProtocolMessage<typeof HANDSHAKE_ACK_KIND>;\n\n// ---------------------------------------------------------------------------\n// Frame → Parent message maps\n// ---------------------------------------------------------------------------\n\n/**\n * Maps message `kind` to its payload type for the widget frame.\n * Frames use this to type-check what they send; SDK uses it to type-check\n * what it receives.\n */\nexport interface WidgetMessageMap {\n  ready: void;\n  error: {\n    code: 'configurationError' | 'apiError' | 'generic';\n    message: string;\n  };\n  transactionCreated: {\n    transaction: { id: string; status: string };\n  };\n  complete: {\n    transaction: FrameTransaction;\n  };\n  close: void;\n}\n\n/**\n * Maps message `kind` to its payload type for the Apple Pay frame\n * (child → parent direction).\n */\nexport interface ApplePayInboundMessageMap {\n  ready: void;\n  error: {\n    code:\n      | 'configurationError'\n      | 'quoteExpired'\n      | 'invalidQuote'\n      | 'applePayUnavailable'\n      | 'generic'\n      | 'oneTapApplePaySecondFactorRequired';\n    message: string;\n  };\n  complete: {\n    transaction: FrameTransaction;\n  };\n}\n\n/**\n * Maps message `kind` to its payload type for the Apple Pay frame\n * (parent → child direction).\n */\nexport interface ApplePayOutboundMessageMap {\n  setQuote: { quote: { signature: string } };\n}\n\n/**\n * Maps message `kind` to its payload type for the Google Pay frame\n * (child → parent direction).\n */\nexport interface GooglePayInboundMessageMap {\n  ready: void;\n  error: {\n    code:\n      | 'configurationError'\n      | 'quoteExpired'\n      | 'invalidQuote'\n      | 'googlePayUnavailable'\n      | 'generic';\n    message: string;\n  };\n  /** Signals that the pipeline requires a challenge step. Load `url` in a challenge frame. */\n  challenge: { kind: 'frame'; url: string };\n  complete: {\n    transaction: FrameTransaction;\n  };\n}\n\n/**\n * Maps message `kind` to its payload type for the Google Pay frame\n * (parent → child direction).\n */\nexport interface GooglePayOutboundMessageMap {\n  setQuote: { quote: { signature: string } };\n}\n\n/**\n * Maps message `kind` to its payload type for the connect/check-connection\n * frame (child → parent direction).\n */\nexport interface ConnectMessageMap {\n  ready: void;\n  error: ConnectionError;\n  complete:\n    | ConnectionRequired\n    | ActiveConnection\n    | UnavailableConnection\n    | PendingConnection\n    | FailedConnection\n    | TermsAcceptanceRequiredConnection;\n}\n\n/**\n * Maps message `kind` to its payload type for the auth frame\n * (child → parent direction).\n *\n * The auth frame is the lighter-weight counterpart to the connect frame:\n * partners (typically headless / Identity-API integrations) drive the\n * customer through email/OTP authentication only, then receive the\n * encrypted credentials. The frame is gated on `clientToken` rather than\n * `sessionToken` — partners obtain the `clientToken` via the prior\n * `getConnection()` probe (it is decrypted into `core.context` on a\n * `connectionRequired` result).\n */\nexport interface AuthMessageMap {\n  ready: void;\n  error: ConnectionError;\n  complete: ActiveConnection | TermsAcceptanceRequiredConnection;\n}\n\n// ---------------------------------------------------------------------------\n// Buy frame\n// ---------------------------------------------------------------------------\n\n/**\n * Maps message `kind` to its payload type for the buy frame\n * (child → parent direction).\n *\n * The buy frame executes the full buy pipeline (pre-check → create →\n * post-check) headlessly. It may escalate to a challenge frame mid-pipeline.\n */\nexport interface BuyMessageMap {\n  ready: void;\n  complete: { transaction: FrameTransaction };\n  /** Signals that the pipeline requires a challenge step. Load `url` in a challenge frame. */\n  challenge: { kind: string; url: string };\n  error: { code: string; message: string };\n}\n\n/**\n * Maps message `kind` to its payload type for the buy frame\n * (parent → child direction).\n */\nexport interface BuyOutboundMessageMap {\n  setQuote: { quote: { signature: string } };\n}\n\n// ---------------------------------------------------------------------------\n// Buy-button frame\n// ---------------------------------------------------------------------------\n\n/**\n * Maps message `kind` to its payload type for the buy-button frame\n * (child → parent direction).\n *\n * The buy-button frame renders a payment button (card, Apple Pay, Google Pay)\n * and runs the buy pipeline on tap. It may escalate to a challenge frame.\n */\nexport interface BuyButtonMessageMap {\n  complete: { transaction: FrameTransaction };\n  /** Signals that the pipeline requires a challenge step. Load `url` in a challenge frame. */\n  challenge: { kind: string; url: string };\n  error: { code: string; message: string };\n}\n\n/**\n * Maps message `kind` to its payload type for the buy-button frame\n * (parent → child direction).\n */\nexport interface BuyButtonOutboundMessageMap {\n  setQuote: { quote: { signature: string } };\n}\n\n// ---------------------------------------------------------------------------\n// Challenge frame\n// ---------------------------------------------------------------------------\n\nexport type ChallengeCompleteResult =\n  | { flow: 'buy'; transaction: FrameTransaction }\n  | { flow: 'identity'; identityId: string };\n\nexport type ChallengeCancellation =\n  | { flow: 'buy'; transactionId?: string; challengeToken?: string }\n  | { flow: 'identity' };\n\n/**\n * Maps message `kind` to its payload type for the challenge frame\n * (child → parent direction).\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 ChallengeMessageMap {\n  ready: void;\n  complete: ChallengeCompleteResult;\n  /** User dismissed the challenge. Carry `transactionId` / `challengeToken` to resume. */\n  cancelled: ChallengeCancellation;\n  error: { code: string; message: string };\n}\n\n// ---------------------------------------------------------------------------\n// Reset frame\n// ---------------------------------------------------------------------------\n\n/**\n * Maps message `kind` to its payload type for the reset frame\n * (child → parent direction).\n *\n * The reset frame clears the customer's MoonPay connection for the partner.\n * It is fully driven by the `sessionToken` URL param. There is no\n * parent → child message map.\n */\nexport interface ResetMessageMap {\n  complete: void;\n  error: { code: string; message: string };\n}\n\n// ---------------------------------------------------------------------------\n// Add-card frame\n// ---------------------------------------------------------------------------\n\n/** Card returned by the add-card frame on successful creation. */\nexport interface CardResponse {\n  id: string;\n  /** Payment method type, e.g. `'card'`. */\n  type: string;\n  /** Card sub-type, e.g. `'credit'` or `'debit'`. */\n  cardType: string;\n  /** Card network brand, e.g. `'visa'` or `'mastercard'`. */\n  brand: string;\n  last4: string;\n  expirationMonth: string;\n  expirationYear: string;\n  availability: { active: true };\n}\n\n/**\n * Maps message `kind` to its payload type for the add-card frame\n * (child → parent direction).\n *\n * There is no parent → child message map for the add-card frame.\n */\nexport interface AddCardMessageMap {\n  complete: { card: CardResponse };\n  error: { code: 'generic' | 'configurationError'; message: string };\n}\n\n// ---------------------------------------------------------------------------\n// Transaction type used inside frame messages\n// ---------------------------------------------------------------------------\n\nimport type {\n  ActiveConnection,\n  ConnectionRequired,\n  FailedConnection,\n  PendingConnection,\n  TermsAcceptanceRequiredConnection,\n  UnavailableConnection,\n} from './connection.js';\nimport type { ConnectionError } from './errors.js';\n\n/** Transaction shape as sent within frame postMessage payloads. */\nexport type FrameTransaction =\n  | { id: string; status: string }\n  | { id?: string; status: 'failed'; failureReason: string };\n\n// ---------------------------------------------------------------------------\n// Typed message constructors (utility types)\n// ---------------------------------------------------------------------------\n\n/** A ProtocolMessage typed to a specific message map entry. */\nexport type TypedMessage<\n  Map extends Record<string, unknown>,\n  K extends keyof Map & string,\n> = Map[K] extends void ? ProtocolMessage<K, undefined> : ProtocolMessage<K, Map[K]>;\n\n/** Union of all typed messages for a given message map. */\nexport type MessageUnion<Map extends Record<string, unknown>> = {\n  [K in keyof Map & string]: TypedMessage<Map, K>;\n}[keyof Map & string];\n","/**\n * A discriminated union representing either a successful value or an error.\n * SDK methods return this type instead of throwing exceptions.\n */\nexport type Result<T, E> = { ok: true; value: T } | { ok: false; error: E };\n\n/** A Result variant for operations that produce no value on success. */\nexport type EmptyResult<E> = { ok: true } | { ok: false; error: E };\n\n/** Construct a successful Result. */\nexport const ok = <T>(value: T): { ok: true; value: T } => ({\n  ok: true,\n  value,\n});\n\n/** Construct a failed Result. */\nexport const err = <E>(error: E): { ok: false; error: E } => ({\n  ok: false,\n  error,\n});\n"],"mappings":";AAIO,IAAK,mBAAL,kBAAKA,sBAAL;AAIL,EAAAA,kBAAA,wBAAqB;AAKrB,EAAAA,kBAAA,YAAS;AAKT,EAAAA,kBAAA,iBAAc;AAKd,EAAAA,kBAAA,aAAU;AAKV,EAAAA,kBAAA,YAAS;AAOT,EAAAA,kBAAA,6BAA0B;AA/BhB,SAAAA;AAAA,GAAA;;;ACAL,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,qBAAkB;AAElB,EAAAA,qBAAA,6BAA0B;AAHhB,SAAAA;AAAA,GAAA;AAyBL,IAAM,2BAA2B;AAAA,EACtC,cAAc;AAAA,EACd,cAAc;AAAA,EACd,WAAW;AAAA,EACX,UAAU;AAAA,EACV,gBAAgB;AAAA,EAChB,gBAAgB;AAAA,EAChB,iBAAiB;AAAA,EACjB,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,qBAAqB;AAAA,EACrB,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,oBAAoB;AAAA,EACpB,mBAAmB;AAAA,EACnB,uBAAuB;AAAA,EACvB,oBAAoB;AAAA,EACpB,wBAAwB;AAAA,EACxB,sBAAsB;AAAA,EACtB,iBAAiB;AAAA,EACjB,oBAAoB;AACtB;;;AClCO,IAAM,yBAAyB;AAC/B,IAAM,qBAAqB;;;ACP3B,IAAM,KAAK,CAAI,WAAsC;AAAA,EAC1D,IAAI;AAAA,EACJ;AACF;AAGO,IAAM,MAAM,CAAI,WAAuC;AAAA,EAC5D,IAAI;AAAA,EACJ;AACF;","names":["ConnectionStatus","ConnectionErrorCode"]}