@moonpay/platform-protocol 0.3.0 → 1.0.2

package/README.md

@@ -0,0 +1,45 @@
+# @moonpay/platform-protocol
+
+Shared protocol and API types for the [MoonPay Developer Platform](https://dev.moonpay.com) SDKs. This package is the single source of truth for the contract between MoonPay frames and partner integrations: wire protocol primitives, per-frame message maps, domain models, REST API types, and the `Result` type all SDK methods return.
+
+It contains types only, plus the tiny `ok()` / `err()` helpers for constructing `Result` values — there is no other runtime code.
+
+## Installation
+
+This package ships as a dependency of the platform SDKs (`@moonpay/platform-sdk-web`, `@moonpay/platform-sdk-react-native`, `@moonpay/platform-sdk-node`), so most integrations don't install it directly. Install it standalone when you need the types on their own:
+
+```bash
+npm install @moonpay/platform-protocol
+```
+
+## Usage
+
+There is no barrel export — import from subpaths:
+
+```typescript
+import type { Result } from '@moonpay/platform-protocol/result';
+import type { Quote, Transaction } from '@moonpay/platform-protocol/api';
+import { ConnectionStatus } from '@moonpay/platform-protocol/models/connection';
+import type { Event as WidgetEvent } from '@moonpay/platform-protocol/sdks/widget';
+```
+
+## Subpath exports
+
+| Subpath | Contents |
+|---------|----------|
+| `./protocol` | Wire format primitives: message envelope, handshake/ack, `FrameError` |
+| `./result` | `Result<T, E>`, `EmptyResult<E>`, `ok()`, `err()` |
+| `./frames/*` | Per-frame message maps (`widget`, `apple-pay`, `google-pay`, `buy`, `buy-button`, `connect`, `auth`, `add-card`, `challenge`, `reset`) |
+| `./sdks/*` | SDK-facing event and setup error types per frame |
+| `./models/*` | Cross-frame domain models (`connection`, `transaction`, `challenge`) |
+| `./api` | REST API types (quotes, transactions, payment methods) |
+| `./api/identity` | Identity API types |
+| `./api/errors` | API error types |
+
+## Documentation
+
+Full guides and API reference: [dev.moonpay.com](https://dev.moonpay.com)
+
+## License
+
+MIT

package/dist/{index.cjs → api/errors.cjs}

@@ -17,36 +17,12 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  ConnectionErrorCode: () => ConnectionErrorCode,
-  ConnectionStatus: () => ConnectionStatus,
-  DevPlatformApiErrorCodes: () => DevPlatformApiErrorCodes,
-  HANDSHAKE_ACK_KIND: () => HANDSHAKE_ACK_KIND,
-  HANDSHAKE_REQUEST_KIND: () => HANDSHAKE_REQUEST_KIND,
-  err: () => err,
-  ok: () => ok
+// src/api/errors.ts
+var errors_exports = {};
+__export(errors_exports, {
+  DevPlatformApiErrorCodes: () => DevPlatformApiErrorCodes
 });
-module.exports = __toCommonJS(src_exports);
-
-// 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 || {});
+module.exports = __toCommonJS(errors_exports);
 var DevPlatformApiErrorCodes = {
   unknownError: "unknown_error",
   unauthorized: "unauthorized",
@@ -69,28 +45,8 @@ var DevPlatformApiErrorCodes = {
   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
-});
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ConnectionErrorCode,
-  ConnectionStatus,
-  DevPlatformApiErrorCodes,
-  HANDSHAKE_ACK_KIND,
-  HANDSHAKE_REQUEST_KIND,
-  err,
-  ok
+  DevPlatformApiErrorCodes
 });
-//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=errors.cjs.map

package/dist/api/errors.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/api/errors.ts"],"sourcesContent":["// ---------------------------------------------------------------------------\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// API call result errors (all alias DevPlatformApiError)\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"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAIO,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;","names":[]}

package/dist/api/errors.d.cts

@@ -0,0 +1,46 @@
+declare const DevPlatformApiErrorCodes: {
+    readonly unknownError: "unknown_error";
+    readonly unauthorized: "unauthorized";
+    readonly forbidden: "forbidden";
+    readonly notFound: "not_found";
+    readonly invalidRequest: "invalid_request";
+    readonly notImplemented: "not_implemented";
+    readonly tooManyRequests: "too_many_requests";
+    readonly notAllowed: "not_allowed";
+    readonly conflict: "conflict";
+    readonly unprocessableEntity: "unprocessable_entity";
+    readonly sseTimeout: "sse_timeout";
+    readonly sseError: "sse_error";
+    readonly connectionRequired: "connection_required";
+    readonly connectionPending: "connection_pending";
+    readonly connectionUnavailable: "connection_unavailable";
+    readonly serviceUnavailable: "service_unavailable";
+    readonly requirementsIncomplete: "requirements_incomplete";
+    readonly verificationRejected: "verification_rejected";
+    readonly countryMismatch: "country_mismatch";
+    readonly unsupportedCountry: "unsupported_country";
+};
+type DevPlatformApiErrorCode = (typeof DevPlatformApiErrorCodes)[keyof typeof DevPlatformApiErrorCodes];
+interface DevPlatformApiErrorDetail {
+    field?: string;
+    message: string;
+}
+/** Shape returned by the MoonPay Platform API on error responses. */
+interface DevPlatformApiError {
+    code: DevPlatformApiErrorCode;
+    message: string;
+    errors?: DevPlatformApiErrorDetail[];
+}
+type GetQuoteError = DevPlatformApiError;
+type GetPaymentMethodsError = DevPlatformApiError;
+type GetTransactionsError = DevPlatformApiError;
+type CreateSessionError = DevPlatformApiError;
+type RevokeSessionError = DevPlatformApiError;
+type CreateIdentityError = DevPlatformApiError;
+type GetIdentityError = DevPlatformApiError;
+type UpdateIdentityError = DevPlatformApiError;
+type VerifyIdentityError = DevPlatformApiError;
+type GetIdentityUploadUrlError = DevPlatformApiError;
+type SubmitIdentityFilesError = DevPlatformApiError;
+
+export { type CreateIdentityError, type CreateSessionError, type DevPlatformApiError, type DevPlatformApiErrorCode, DevPlatformApiErrorCodes, type DevPlatformApiErrorDetail, type GetIdentityError, type GetIdentityUploadUrlError, type GetPaymentMethodsError, type GetQuoteError, type GetTransactionsError, type RevokeSessionError, type SubmitIdentityFilesError, type UpdateIdentityError, type VerifyIdentityError };

package/dist/api/errors.d.ts

@@ -0,0 +1,46 @@
+declare const DevPlatformApiErrorCodes: {
+    readonly unknownError: "unknown_error";
+    readonly unauthorized: "unauthorized";
+    readonly forbidden: "forbidden";
+    readonly notFound: "not_found";
+    readonly invalidRequest: "invalid_request";
+    readonly notImplemented: "not_implemented";
+    readonly tooManyRequests: "too_many_requests";
+    readonly notAllowed: "not_allowed";
+    readonly conflict: "conflict";
+    readonly unprocessableEntity: "unprocessable_entity";
+    readonly sseTimeout: "sse_timeout";
+    readonly sseError: "sse_error";
+    readonly connectionRequired: "connection_required";
+    readonly connectionPending: "connection_pending";
+    readonly connectionUnavailable: "connection_unavailable";
+    readonly serviceUnavailable: "service_unavailable";
+    readonly requirementsIncomplete: "requirements_incomplete";
+    readonly verificationRejected: "verification_rejected";
+    readonly countryMismatch: "country_mismatch";
+    readonly unsupportedCountry: "unsupported_country";
+};
+type DevPlatformApiErrorCode = (typeof DevPlatformApiErrorCodes)[keyof typeof DevPlatformApiErrorCodes];
+interface DevPlatformApiErrorDetail {
+    field?: string;
+    message: string;
+}
+/** Shape returned by the MoonPay Platform API on error responses. */
+interface DevPlatformApiError {
+    code: DevPlatformApiErrorCode;
+    message: string;
+    errors?: DevPlatformApiErrorDetail[];
+}
+type GetQuoteError = DevPlatformApiError;
+type GetPaymentMethodsError = DevPlatformApiError;
+type GetTransactionsError = DevPlatformApiError;
+type CreateSessionError = DevPlatformApiError;
+type RevokeSessionError = DevPlatformApiError;
+type CreateIdentityError = DevPlatformApiError;
+type GetIdentityError = DevPlatformApiError;
+type UpdateIdentityError = DevPlatformApiError;
+type VerifyIdentityError = DevPlatformApiError;
+type GetIdentityUploadUrlError = DevPlatformApiError;
+type SubmitIdentityFilesError = DevPlatformApiError;
+
+export { type CreateIdentityError, type CreateSessionError, type DevPlatformApiError, type DevPlatformApiErrorCode, DevPlatformApiErrorCodes, type DevPlatformApiErrorDetail, type GetIdentityError, type GetIdentityUploadUrlError, type GetPaymentMethodsError, type GetQuoteError, type GetTransactionsError, type RevokeSessionError, type SubmitIdentityFilesError, type UpdateIdentityError, type VerifyIdentityError };

package/dist/api/errors.js

@@ -0,0 +1,27 @@
+// src/api/errors.ts
+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"
+};
+export {
+  DevPlatformApiErrorCodes
+};
+//# sourceMappingURL=errors.js.map

package/dist/api/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/api/errors.ts"],"sourcesContent":["// ---------------------------------------------------------------------------\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// API call result errors (all alias DevPlatformApiError)\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"],"mappings":";AAIO,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;","names":[]}

package/dist/api/identity.cjs

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/api/identity.ts
+var identity_exports = {};
+module.exports = __toCommonJS(identity_exports);
+//# sourceMappingURL=identity.cjs.map

package/dist/api/identity.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/api/identity.ts"],"sourcesContent":["/**\n * Identity API types.\n *\n * Sourced from `moonpay-api/packages/dev-platform/modules/identity/main.tsp`.\n * The TypeSpec is marked `@vnext` and is not yet emitted into the public\n * OpenAPI spec, so these types are hand-rolled. Once the spec ships, replace\n * with aliases re-exported from `./gen/` (same pattern as `Quote`, `Identity`,\n * etc. in `api.ts`).\n */\n\n/** A platform capability a partner wants the customer to unlock. */\nexport type CapabilityProduct = 'ramps';\n\n/** A requested capability scoped to an identity. */\nexport interface IdentityCapability {\n  product: CapabilityProduct;\n}\n\n/** The state of an identity across the KYC lifecycle. */\nexport type IdentityStatus =\n  | 'created'\n  | 'collecting'\n  | 'verifying'\n  | 'challengeRequired'\n  | 'approved'\n  | 'rejected'\n  | 'manualReview'\n  | 'blocked';\n\n/** The completion state of a requirement item. */\nexport type RequirementItemStatus = 'incomplete' | 'complete';\n\n/** A field a customer must provide to fulfil a requirement. */\nexport type RequirementFieldName =\n  | 'firstName'\n  | 'lastName'\n  | 'dateOfBirth'\n  | 'nationality'\n  | 'street'\n  | 'locality'\n  | 'postalCode'\n  | 'country'\n  | 'administrativeArea'\n  | 'ssn'\n  | 'cpf'\n  | 'tin';\n\n/** Status of a single requirement group on an identity. */\nexport interface RequirementEntry {\n  status: RequirementItemStatus;\n  requiredFields?: RequirementFieldName[];\n}\n\n/** Outstanding and completed requirements for the identity, keyed by category. */\nexport interface Requirements {\n  basicDetails?: RequirementEntry;\n  residentialAddress?: RequirementEntry;\n  identityDocuments?: RequirementEntry;\n  selfie?: RequirementEntry;\n  taxIdentifiers?: RequirementEntry;\n  proofOfAddress?: RequirementEntry;\n  phoneNumber?: RequirementEntry;\n}\n\n/** Residential-address fields accepted at identity creation. */\nexport interface CreateIdentityResidentialAddress {\n  /** ISO 3166-1 alpha-3 country code declared by the partner. */\n  country: string;\n}\n\n/** Request body for creating an identity. */\nexport interface CreateIdentityRequestBody {\n  residentialAddress: CreateIdentityResidentialAddress;\n  /** Capabilities the partner wants the customer to unlock. Must contain at least one value. */\n  capabilities: IdentityCapability[];\n}\n\n/** Customer's basic personal details. */\nexport interface IdentityBasicDetailsSubmission {\n  firstName?: string;\n  lastName?: string;\n  nationality?: string;\n  /** YYYY-MM-DD. */\n  dateOfBirth?: string;\n}\n\n/** Customer's residential address. */\nexport interface IdentityResidentialAddressSubmission {\n  country?: string;\n  administrativeArea?: string;\n  locality?: string;\n  street?: string;\n  subStreet?: string;\n  postalCode?: string;\n}\n\n/** Customer's phone number in E.164 format. */\nexport interface IdentityPhoneNumberSubmission {\n  number: string;\n}\n\n/** Type of tax identifier the customer is submitting. */\nexport type IdentityTaxIdentifierType = 'tin' | 'ssn' | 'cpf';\n\n/** Tax Identification Number — country must be supplied. */\nexport interface IdentityTaxIdentifierGenericSubmission {\n  type: 'tin';\n  country: string;\n  value: string;\n}\n\n/** Country-specific tax identifier (SSN/CPF). */\nexport interface IdentityTaxIdentifierSchemeSubmission {\n  type: 'ssn' | 'cpf';\n  value: string;\n}\n\nexport type IdentityTaxIdentifierSubmission =\n  | IdentityTaxIdentifierGenericSubmission\n  | IdentityTaxIdentifierSchemeSubmission;\n\n/** Request body for updating an identity by submitting one or more requirements. */\nexport interface UpdateIdentityRequestBody {\n  residentialAddress?: IdentityResidentialAddressSubmission;\n  basicDetails?: IdentityBasicDetailsSubmission;\n  phoneNumber?: IdentityPhoneNumberSubmission;\n  taxIdentifiers?: IdentityTaxIdentifierSubmission[];\n}\n\n/** A MoonPay-hosted challenge a partner must surface to the customer. */\nexport interface IdentityVerificationChallenge {\n  /** Fully-formed challenge URL. */\n  url: string;\n  /** ISO 8601 expiry. */\n  expiresAt: string;\n}\n\n/** The state of an identity verification request. */\nexport type IdentityVerificationStatus = 'approved' | 'processing' | 'challengeRequired';\n\n/** Outcome of `POST /platform/v1/identities/{id}/verifications`. */\nexport type IdentityVerificationResponse =\n  | { status: 'approved' }\n  | { status: 'processing' }\n  | { status: 'challengeRequired'; challenge: IdentityVerificationChallenge };\n\n/** Type of identity-related file the customer is uploading. */\nexport type IdentityFileType =\n  | 'drivingLicence'\n  | 'nationalIdentityCard'\n  | 'passport'\n  | 'residencePermit'\n  | 'selfie'\n  | 'proofOfAddress';\n\n/** Side of a two-sided identity document. */\nexport type IdentityFileSide = 'front' | 'back';\n\n/** MIME type of the file being uploaded. */\nexport type IdentityFileMimeType = 'image/jpeg' | 'image/png' | 'application/pdf';\n\n/** Request body for issuing a presigned upload URL. */\nexport interface IdentityFileUploadUrlRequestBody {\n  fileType: IdentityFileType;\n  /** Required for two-sided file types (`drivingLicence`, `nationalIdentityCard`, `residencePermit`); omit for single-sided. */\n  side?: IdentityFileSide;\n  /** Must match the `Content-Type` header used on the subsequent upload request. */\n  mimeType: IdentityFileMimeType;\n}\n\n/** Headers the partner must send when uploading the file to the presigned URL. */\nexport interface IdentityFileUploadUrlHeaders {\n  'Content-Type': string;\n}\n\n/** Presigned URL the partner uses to upload an identity-related file. */\nexport interface IdentityFileUploadUrl {\n  uploadId: string;\n  url: string;\n  /** ISO 8601 expiry. */\n  expiresAt: string;\n  headers: IdentityFileUploadUrlHeaders;\n}\n\n/** A single uploaded file the partner is confirming for submission. */\nexport interface IdentityFileSubmission {\n  uploadId: string;\n  fileType: IdentityFileType;\n  side?: IdentityFileSide;\n}\n\n/** Request body for confirming one or more uploaded identity-related files. */\nexport interface SubmitIdentityFilesRequestBody {\n  files: IdentityFileSubmission[];\n}\n\n/** A KYC identity. */\nexport interface Identity {\n  id: string;\n  status: IdentityStatus;\n  capabilities: IdentityCapability[];\n  requirements: Requirements;\n  /** Present only when `status` is `challengeRequired`. */\n  challenge?: IdentityVerificationChallenge;\n  createdAt: string;\n  updatedAt: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/api/identity.d.cts

@@ -0,0 +1,156 @@
+/**
+ * Identity API types.
+ *
+ * Sourced from `moonpay-api/packages/dev-platform/modules/identity/main.tsp`.
+ * The TypeSpec is marked `@vnext` and is not yet emitted into the public
+ * OpenAPI spec, so these types are hand-rolled. Once the spec ships, replace
+ * with aliases re-exported from `./gen/` (same pattern as `Quote`, `Identity`,
+ * etc. in `api.ts`).
+ */
+/** A platform capability a partner wants the customer to unlock. */
+type CapabilityProduct = 'ramps';
+/** A requested capability scoped to an identity. */
+interface IdentityCapability {
+    product: CapabilityProduct;
+}
+/** The state of an identity across the KYC lifecycle. */
+type IdentityStatus = 'created' | 'collecting' | 'verifying' | 'challengeRequired' | 'approved' | 'rejected' | 'manualReview' | 'blocked';
+/** The completion state of a requirement item. */
+type RequirementItemStatus = 'incomplete' | 'complete';
+/** A field a customer must provide to fulfil a requirement. */
+type RequirementFieldName = 'firstName' | 'lastName' | 'dateOfBirth' | 'nationality' | 'street' | 'locality' | 'postalCode' | 'country' | 'administrativeArea' | 'ssn' | 'cpf' | 'tin';
+/** Status of a single requirement group on an identity. */
+interface RequirementEntry {
+    status: RequirementItemStatus;
+    requiredFields?: RequirementFieldName[];
+}
+/** Outstanding and completed requirements for the identity, keyed by category. */
+interface Requirements {
+    basicDetails?: RequirementEntry;
+    residentialAddress?: RequirementEntry;
+    identityDocuments?: RequirementEntry;
+    selfie?: RequirementEntry;
+    taxIdentifiers?: RequirementEntry;
+    proofOfAddress?: RequirementEntry;
+    phoneNumber?: RequirementEntry;
+}
+/** Residential-address fields accepted at identity creation. */
+interface CreateIdentityResidentialAddress {
+    /** ISO 3166-1 alpha-3 country code declared by the partner. */
+    country: string;
+}
+/** Request body for creating an identity. */
+interface CreateIdentityRequestBody {
+    residentialAddress: CreateIdentityResidentialAddress;
+    /** Capabilities the partner wants the customer to unlock. Must contain at least one value. */
+    capabilities: IdentityCapability[];
+}
+/** Customer's basic personal details. */
+interface IdentityBasicDetailsSubmission {
+    firstName?: string;
+    lastName?: string;
+    nationality?: string;
+    /** YYYY-MM-DD. */
+    dateOfBirth?: string;
+}
+/** Customer's residential address. */
+interface IdentityResidentialAddressSubmission {
+    country?: string;
+    administrativeArea?: string;
+    locality?: string;
+    street?: string;
+    subStreet?: string;
+    postalCode?: string;
+}
+/** Customer's phone number in E.164 format. */
+interface IdentityPhoneNumberSubmission {
+    number: string;
+}
+/** Type of tax identifier the customer is submitting. */
+type IdentityTaxIdentifierType = 'tin' | 'ssn' | 'cpf';
+/** Tax Identification Number — country must be supplied. */
+interface IdentityTaxIdentifierGenericSubmission {
+    type: 'tin';
+    country: string;
+    value: string;
+}
+/** Country-specific tax identifier (SSN/CPF). */
+interface IdentityTaxIdentifierSchemeSubmission {
+    type: 'ssn' | 'cpf';
+    value: string;
+}
+type IdentityTaxIdentifierSubmission = IdentityTaxIdentifierGenericSubmission | IdentityTaxIdentifierSchemeSubmission;
+/** Request body for updating an identity by submitting one or more requirements. */
+interface UpdateIdentityRequestBody {
+    residentialAddress?: IdentityResidentialAddressSubmission;
+    basicDetails?: IdentityBasicDetailsSubmission;
+    phoneNumber?: IdentityPhoneNumberSubmission;
+    taxIdentifiers?: IdentityTaxIdentifierSubmission[];
+}
+/** A MoonPay-hosted challenge a partner must surface to the customer. */
+interface IdentityVerificationChallenge {
+    /** Fully-formed challenge URL. */
+    url: string;
+    /** ISO 8601 expiry. */
+    expiresAt: string;
+}
+/** The state of an identity verification request. */
+type IdentityVerificationStatus = 'approved' | 'processing' | 'challengeRequired';
+/** Outcome of `POST /platform/v1/identities/{id}/verifications`. */
+type IdentityVerificationResponse = {
+    status: 'approved';
+} | {
+    status: 'processing';
+} | {
+    status: 'challengeRequired';
+    challenge: IdentityVerificationChallenge;
+};
+/** Type of identity-related file the customer is uploading. */
+type IdentityFileType = 'drivingLicence' | 'nationalIdentityCard' | 'passport' | 'residencePermit' | 'selfie' | 'proofOfAddress';
+/** Side of a two-sided identity document. */
+type IdentityFileSide = 'front' | 'back';
+/** MIME type of the file being uploaded. */
+type IdentityFileMimeType = 'image/jpeg' | 'image/png' | 'application/pdf';
+/** Request body for issuing a presigned upload URL. */
+interface IdentityFileUploadUrlRequestBody {
+    fileType: IdentityFileType;
+    /** Required for two-sided file types (`drivingLicence`, `nationalIdentityCard`, `residencePermit`); omit for single-sided. */
+    side?: IdentityFileSide;
+    /** Must match the `Content-Type` header used on the subsequent upload request. */
+    mimeType: IdentityFileMimeType;
+}
+/** Headers the partner must send when uploading the file to the presigned URL. */
+interface IdentityFileUploadUrlHeaders {
+    'Content-Type': string;
+}
+/** Presigned URL the partner uses to upload an identity-related file. */
+interface IdentityFileUploadUrl {
+    uploadId: string;
+    url: string;
+    /** ISO 8601 expiry. */
+    expiresAt: string;
+    headers: IdentityFileUploadUrlHeaders;
+}
+/** A single uploaded file the partner is confirming for submission. */
+interface IdentityFileSubmission {
+    uploadId: string;
+    fileType: IdentityFileType;
+    side?: IdentityFileSide;
+}
+/** Request body for confirming one or more uploaded identity-related files. */
+interface SubmitIdentityFilesRequestBody {
+    files: IdentityFileSubmission[];
+}
+/** A KYC identity. */
+interface Identity {
+    id: string;
+    status: IdentityStatus;
+    capabilities: IdentityCapability[];
+    requirements: Requirements;
+    /** Present only when `status` is `challengeRequired`. */
+    challenge?: IdentityVerificationChallenge;
+    createdAt: string;
+    updatedAt: string;
+}
+
+export type { CapabilityProduct, CreateIdentityRequestBody, CreateIdentityResidentialAddress, Identity, IdentityBasicDetailsSubmission, IdentityCapability, IdentityFileMimeType, IdentityFileSide, IdentityFileSubmission, IdentityFileType, IdentityFileUploadUrl, IdentityFileUploadUrlHeaders, IdentityFileUploadUrlRequestBody, IdentityPhoneNumberSubmission, IdentityResidentialAddressSubmission, IdentityStatus, IdentityTaxIdentifierGenericSubmission, IdentityTaxIdentifierSchemeSubmission, IdentityTaxIdentifierSubmission, IdentityTaxIdentifierType, IdentityVerificationChallenge, IdentityVerificationResponse, IdentityVerificationStatus, RequirementEntry, RequirementFieldName, RequirementItemStatus, Requirements, SubmitIdentityFilesRequestBody, UpdateIdentityRequestBody };

package/dist/api/identity.d.ts

@@ -0,0 +1,156 @@
+/**
+ * Identity API types.
+ *
+ * Sourced from `moonpay-api/packages/dev-platform/modules/identity/main.tsp`.
+ * The TypeSpec is marked `@vnext` and is not yet emitted into the public
+ * OpenAPI spec, so these types are hand-rolled. Once the spec ships, replace
+ * with aliases re-exported from `./gen/` (same pattern as `Quote`, `Identity`,
+ * etc. in `api.ts`).
+ */
+/** A platform capability a partner wants the customer to unlock. */
+type CapabilityProduct = 'ramps';
+/** A requested capability scoped to an identity. */
+interface IdentityCapability {
+    product: CapabilityProduct;
+}
+/** The state of an identity across the KYC lifecycle. */
+type IdentityStatus = 'created' | 'collecting' | 'verifying' | 'challengeRequired' | 'approved' | 'rejected' | 'manualReview' | 'blocked';
+/** The completion state of a requirement item. */
+type RequirementItemStatus = 'incomplete' | 'complete';
+/** A field a customer must provide to fulfil a requirement. */
+type RequirementFieldName = 'firstName' | 'lastName' | 'dateOfBirth' | 'nationality' | 'street' | 'locality' | 'postalCode' | 'country' | 'administrativeArea' | 'ssn' | 'cpf' | 'tin';
+/** Status of a single requirement group on an identity. */
+interface RequirementEntry {
+    status: RequirementItemStatus;
+    requiredFields?: RequirementFieldName[];
+}
+/** Outstanding and completed requirements for the identity, keyed by category. */
+interface Requirements {
+    basicDetails?: RequirementEntry;
+    residentialAddress?: RequirementEntry;
+    identityDocuments?: RequirementEntry;
+    selfie?: RequirementEntry;
+    taxIdentifiers?: RequirementEntry;
+    proofOfAddress?: RequirementEntry;
+    phoneNumber?: RequirementEntry;
+}
+/** Residential-address fields accepted at identity creation. */
+interface CreateIdentityResidentialAddress {
+    /** ISO 3166-1 alpha-3 country code declared by the partner. */
+    country: string;
+}
+/** Request body for creating an identity. */
+interface CreateIdentityRequestBody {
+    residentialAddress: CreateIdentityResidentialAddress;
+    /** Capabilities the partner wants the customer to unlock. Must contain at least one value. */
+    capabilities: IdentityCapability[];
+}
+/** Customer's basic personal details. */
+interface IdentityBasicDetailsSubmission {
+    firstName?: string;
+    lastName?: string;
+    nationality?: string;
+    /** YYYY-MM-DD. */
+    dateOfBirth?: string;
+}
+/** Customer's residential address. */
+interface IdentityResidentialAddressSubmission {
+    country?: string;
+    administrativeArea?: string;
+    locality?: string;
+    street?: string;
+    subStreet?: string;
+    postalCode?: string;
+}
+/** Customer's phone number in E.164 format. */
+interface IdentityPhoneNumberSubmission {
+    number: string;
+}
+/** Type of tax identifier the customer is submitting. */
+type IdentityTaxIdentifierType = 'tin' | 'ssn' | 'cpf';
+/** Tax Identification Number — country must be supplied. */
+interface IdentityTaxIdentifierGenericSubmission {
+    type: 'tin';
+    country: string;
+    value: string;
+}
+/** Country-specific tax identifier (SSN/CPF). */
+interface IdentityTaxIdentifierSchemeSubmission {
+    type: 'ssn' | 'cpf';
+    value: string;
+}
+type IdentityTaxIdentifierSubmission = IdentityTaxIdentifierGenericSubmission | IdentityTaxIdentifierSchemeSubmission;
+/** Request body for updating an identity by submitting one or more requirements. */
+interface UpdateIdentityRequestBody {
+    residentialAddress?: IdentityResidentialAddressSubmission;
+    basicDetails?: IdentityBasicDetailsSubmission;
+    phoneNumber?: IdentityPhoneNumberSubmission;
+    taxIdentifiers?: IdentityTaxIdentifierSubmission[];
+}
+/** A MoonPay-hosted challenge a partner must surface to the customer. */
+interface IdentityVerificationChallenge {
+    /** Fully-formed challenge URL. */
+    url: string;
+    /** ISO 8601 expiry. */
+    expiresAt: string;
+}
+/** The state of an identity verification request. */
+type IdentityVerificationStatus = 'approved' | 'processing' | 'challengeRequired';
+/** Outcome of `POST /platform/v1/identities/{id}/verifications`. */
+type IdentityVerificationResponse = {
+    status: 'approved';
+} | {
+    status: 'processing';
+} | {
+    status: 'challengeRequired';
+    challenge: IdentityVerificationChallenge;
+};
+/** Type of identity-related file the customer is uploading. */
+type IdentityFileType = 'drivingLicence' | 'nationalIdentityCard' | 'passport' | 'residencePermit' | 'selfie' | 'proofOfAddress';
+/** Side of a two-sided identity document. */
+type IdentityFileSide = 'front' | 'back';
+/** MIME type of the file being uploaded. */
+type IdentityFileMimeType = 'image/jpeg' | 'image/png' | 'application/pdf';
+/** Request body for issuing a presigned upload URL. */
+interface IdentityFileUploadUrlRequestBody {
+    fileType: IdentityFileType;
+    /** Required for two-sided file types (`drivingLicence`, `nationalIdentityCard`, `residencePermit`); omit for single-sided. */
+    side?: IdentityFileSide;
+    /** Must match the `Content-Type` header used on the subsequent upload request. */
+    mimeType: IdentityFileMimeType;
+}
+/** Headers the partner must send when uploading the file to the presigned URL. */
+interface IdentityFileUploadUrlHeaders {
+    'Content-Type': string;
+}
+/** Presigned URL the partner uses to upload an identity-related file. */
+interface IdentityFileUploadUrl {
+    uploadId: string;
+    url: string;
+    /** ISO 8601 expiry. */
+    expiresAt: string;
+    headers: IdentityFileUploadUrlHeaders;
+}
+/** A single uploaded file the partner is confirming for submission. */
+interface IdentityFileSubmission {
+    uploadId: string;
+    fileType: IdentityFileType;
+    side?: IdentityFileSide;
+}
+/** Request body for confirming one or more uploaded identity-related files. */
+interface SubmitIdentityFilesRequestBody {
+    files: IdentityFileSubmission[];
+}
+/** A KYC identity. */
+interface Identity {
+    id: string;
+    status: IdentityStatus;
+    capabilities: IdentityCapability[];
+    requirements: Requirements;
+    /** Present only when `status` is `challengeRequired`. */
+    challenge?: IdentityVerificationChallenge;
+    createdAt: string;
+    updatedAt: string;
+}
+
+export type { CapabilityProduct, CreateIdentityRequestBody, CreateIdentityResidentialAddress, Identity, IdentityBasicDetailsSubmission, IdentityCapability, IdentityFileMimeType, IdentityFileSide, IdentityFileSubmission, IdentityFileType, IdentityFileUploadUrl, IdentityFileUploadUrlHeaders, IdentityFileUploadUrlRequestBody, IdentityPhoneNumberSubmission, IdentityResidentialAddressSubmission, IdentityStatus, IdentityTaxIdentifierGenericSubmission, IdentityTaxIdentifierSchemeSubmission, IdentityTaxIdentifierSubmission, IdentityTaxIdentifierType, IdentityVerificationChallenge, IdentityVerificationResponse, IdentityVerificationStatus, RequirementEntry, RequirementFieldName, RequirementItemStatus, Requirements, SubmitIdentityFilesRequestBody, UpdateIdentityRequestBody };

package/dist/api/identity.js

@@ -0,0 +1 @@
+//# sourceMappingURL=identity.js.map

package/dist/api/identity.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/api/index.cjs

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/api/index.ts
+var api_exports = {};
+module.exports = __toCommonJS(api_exports);
+//# sourceMappingURL=index.cjs.map

package/dist/api/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/api/index.ts"],"sourcesContent":["/**\n * Partner-friendly type aliases re-exported from the generated OpenAPI types.\n * These drop namespace prefixes and provide consistent names across SDK versions.\n */\nexport type {\n  // Assets\n  Asset,\n  AssetBase,\n  // Session\n  CreateSessionTokenRequestBody,\n  CreateSessionTokenResponse as CreateSessionTokenReturnType,\n  // Fees / wallet\n  Fees,\n  // Quotes\n  GetQuoteBody as GetQuoteParams,\n  GetQuoteResponse as Quote,\n  LimitWithAsset,\n  MonetaryFeeAmount,\n  MoonPayCorePaginationInfo as PaginationInfo,\n  // Payment methods — config catalog\n  MoonPayPaymentsListPaymentMethodsResponse as ListPaymentMethodsResponse,\n  MoonPayPaymentsPaymentMethod as PaymentMethodConfig,\n  MoonPayPaymentsPaymentMethodAvailability as PaymentMethodAvailability,\n  MoonPayPaymentsPaymentMethodCapabilities as PaymentMethodCapabilities,\n  MoonPayPaymentsStoredCardPaymentMethod as StoredCardPaymentMethod,\n  // Payment methods — stored cards\n  MoonPayPaymentsStoredPaymentMethod as StoredPaymentMethod,\n  PaymentMethodType,\n  QuoteLimitEntry,\n  QuoteLimits,\n  QuotePaymentMethod,\n  // Stages\n  Stage,\n  StageKind,\n  StageStatus,\n  // Terms\n  TermsAttestation,\n  // Transactions\n  Transaction,\n  TransactionCustomer,\n  TransactionPaymentMethod,\n  TransactionStatus,\n  TransactionWithStages,\n  Wallet,\n} from './gen/index.js';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}