@fun-xyz/fiat-contract 0.21.0 → 0.22.0

package/README.md

@@ -111,7 +111,7 @@ handoff to a provider other than the response's own, and a handoff that still of
 `{ provider, acceptances: [{ documentId, version, contentDigest, acceptedAt }] }`, each document at
 most once; `FiatTermsResponse` is `{ recorded }`, the recorded document ids. A fault is a
 `FiatTermsErrorBody`: the shared `errorCode`, `errorMsg` and `reqId`, plus `reason` (`STALE_TERMS`,
-`IN_PROGRESS`, `INVALID_REQUEST`, `RATE_LIMITED`, `PROVIDER_UNAVAILABLE`) and `recovery`.
+`INVALID_REQUEST`, `RATE_LIMITED`, `PROVIDER_UNAVAILABLE`) and `recovery`.
 
 The package publishes every document as a constant, so the client and the backend read the same
 text. `PROVIDER_CHECKOUT_DOCUMENTS` maps each provider to its current `CHECKOUT` documents.
@@ -126,8 +126,8 @@ three kinds:
 | `kind` | Carries | A repeat |
 | --- | --- | --- |
 | `observe` | `checkout`, and `credentials` (`customerId`, `accessToken`) once the SDK has them | writes nothing new |
-| `kyc` | `checkout`, `credentials`, `values` keyed by `KycFieldId` (no form id) | drops values MoonPay no longer asks for; a concurrent one gets `409 IN_PROGRESS` |
-| `order` | `orderId`, `transactionId` | returns the claimed order |
+| `kyc` | `checkout`, `credentials`, `values` keyed by `KycFieldId` (no form id) | drops values MoonPay no longer asks for |
+| `order` | `orderId`, `transactionId?`, `quotedAmount` | returns the recorded order |
 
 `observe` and `kyc` answer a `MoonPayStepResponse`, which says what the backend needs next:
 
@@ -140,7 +140,11 @@ three kinds:
 | `READY` | `orderId`, `quoteInput` | mounts Apple Pay, then sends `order` after the charge |
 | `REFUSED` | `reason` (`NOT_ELIGIBLE`, `DOCUMENTS_REQUIRED`, `FINAL_REJECTION`, `CUSTOMER_MISMATCH`), `recovery: REQUOTE \| NONE` | exits the provider flow |
 
-`order` runs after the charge and answers a `MoonPayOrderResponse`:
+`order` runs after every charge attempt, a failed one too, and answers a `MoonPayOrderResponse`.
+`transactionId` is optional because a failed charge may have none; without it the backend records the
+failed charges MoonPay lists for `orderId`. `quotedAmount` is the fiat amount the quote showed. A
+failed charge answers `DONE` with the order in `FAILED`, and the client requotes for a new `orderId`.
+After a failed charge with no `transactionId`, the client caps its `PENDING` polls.
 
 | `status` | Carries | The client then |
 | --- | --- | --- |
@@ -151,8 +155,8 @@ three kinds:
 `MoonPayIntentResponseFor` maps each `kind` to its union, and `MoonPayIntentResponse` is both.
 
 A fault is a 4xx or 5xx with a `MoonPayErrorBody`: the shared `errorCode`, `errorMsg` and `reqId`,
-plus `reason` (`SESSION_BUDGET_SPENT`, `RATE_LIMITED`, `PROVIDER_UNAVAILABLE`, `IN_PROGRESS`,
-`INVALID_REQUEST`) and `recovery`:
+plus `reason` (`SESSION_BUDGET_SPENT`, `RATE_LIMITED`, `PROVIDER_UNAVAILABLE`, `INVALID_REQUEST`)
+and `recovery`:
 `RETRY` (send the same request again), `REQUOTE`, or `NONE`. A field error is a `KYC`
 response, not a fault. The zod schemas (`MoonPay*Schema`, `TermsDocumentSchema`, `FiatTerms*Schema`)
 are exported from the root only.

package/dist/{chunk-N6GHUS2K.mjs → chunk-5GRPYE2U.mjs}

@@ -41,4 +41,4 @@ export {
   FUN_KYC_CONSENT_DOCUMENTS,
   PUBLISHED_TERMS_DOCUMENTS
 };
-//# sourceMappingURL=chunk-N6GHUS2K.mjs.map
+//# sourceMappingURL=chunk-5GRPYE2U.mjs.map

package/dist/{chunk-LBYBZDOW.mjs → chunk-7OUDI3JX.mjs}

@@ -1,5 +1,5 @@
 // package.json
-var version = "0.21.0";
+var version = "0.22.0";
 
 // src/table.ts
 var TABLE_VERSION = version;
@@ -514,4 +514,4 @@ export {
   tableEntry,
   isTerminal
 };
-//# sourceMappingURL=chunk-LBYBZDOW.mjs.map
+//# sourceMappingURL=chunk-7OUDI3JX.mjs.map

package/dist/{chunk-YOMQWXTD.mjs → chunk-SJ7V3YOM.mjs}

@@ -6,4 +6,4 @@ var MOONPAY_ENDPOINTS = {
 export {
   MOONPAY_ENDPOINTS
 };
-//# sourceMappingURL=chunk-YOMQWXTD.mjs.map
+//# sourceMappingURL=chunk-SJ7V3YOM.mjs.map

package/dist/index.js

@@ -1004,7 +1004,7 @@ var $termsErrorBody = obj({
   errorCode: $nonBlank,
   errorMsg: import_zod.z.string(),
   reqId: import_zod.z.string().optional(),
-  reason: import_zod.z.enum(["STALE_TERMS", "IN_PROGRESS", "INVALID_REQUEST", "RATE_LIMITED", "PROVIDER_UNAVAILABLE"]),
+  reason: import_zod.z.enum(["STALE_TERMS", "INVALID_REQUEST", "RATE_LIMITED", "PROVIDER_UNAVAILABLE"]),
   recovery: import_zod.z.enum(["RETRY", "REQUOTE", "NONE"])
 });
 var FiatTermsErrorBodySchema = $termsErrorBody;
@@ -1067,7 +1067,7 @@ var $stepResponse = import_zod.z.union([$providerBoundStepResponse, $blockedStep
 var FiatStepResponseSchema = $stepResponse;
 
 // package.json
-var version = "0.21.0";
+var version = "0.22.0";
 
 // src/table.ts
 var TABLE_VERSION = version;
@@ -2698,7 +2698,7 @@ var $intentRequest = import_zod2.z.discriminatedUnion("kind", [
     credentials: $credentials,
     values: import_zod2.z.record(KycFieldIdSchema, import_zod2.z.string()).refine((values) => Object.keys(values).length > 0, "values must not be empty")
   }),
-  obj2({ kind: import_zod2.z.literal("order"), orderId: $nonEmpty, transactionId: $nonEmpty })
+  obj2({ kind: import_zod2.z.literal("order"), orderId: $nonEmpty, transactionId: $nonEmpty.optional(), quotedAmount: FiatAmountSchema })
 ]);
 var MoonPayIntentRequestSchema = $intentRequest;
 var $quoteInput = obj2({
@@ -2750,13 +2750,7 @@ var MoonPayOrderResponseSchema = $orderResponse;
 var $intentResponse = import_zod2.z.union([$stepResponse2, $orderResponse]);
 var MoonPayIntentResponseSchema = $intentResponse;
 var $faultFields = {
-  reason: import_zod2.z.enum([
-    "SESSION_BUDGET_SPENT",
-    "RATE_LIMITED",
-    "PROVIDER_UNAVAILABLE",
-    "IN_PROGRESS",
-    "INVALID_REQUEST"
-  ]),
+  reason: import_zod2.z.enum(["SESSION_BUDGET_SPENT", "RATE_LIMITED", "PROVIDER_UNAVAILABLE", "INVALID_REQUEST"]),
   recovery: import_zod2.z.enum(["RETRY", "REQUOTE", "NONE"])
 };
 var $fault = obj2($faultFields);

package/dist/index.mjs

@@ -12,16 +12,16 @@ import {
   tableEntry,
   unofferedEndpoints,
   unreachableStates
-} from "./chunk-LBYBZDOW.mjs";
+} from "./chunk-7OUDI3JX.mjs";
 import {
   MOONPAY_ENDPOINTS
-} from "./chunk-YOMQWXTD.mjs";
+} from "./chunk-SJ7V3YOM.mjs";
 import {
   FIAT_TERMS_ENDPOINT,
   FUN_KYC_CONSENT_DOCUMENTS,
   PROVIDER_CHECKOUT_DOCUMENTS,
   PUBLISHED_TERMS_DOCUMENTS
-} from "./chunk-N6GHUS2K.mjs";
+} from "./chunk-5GRPYE2U.mjs";
 
 // src/codes.ts
 var US_STATE_CODES = [
@@ -888,7 +888,7 @@ var $termsErrorBody = obj({
   errorCode: $nonBlank,
   errorMsg: z.string(),
   reqId: z.string().optional(),
-  reason: z.enum(["STALE_TERMS", "IN_PROGRESS", "INVALID_REQUEST", "RATE_LIMITED", "PROVIDER_UNAVAILABLE"]),
+  reason: z.enum(["STALE_TERMS", "INVALID_REQUEST", "RATE_LIMITED", "PROVIDER_UNAVAILABLE"]),
   recovery: z.enum(["RETRY", "REQUOTE", "NONE"])
 });
 var FiatTermsErrorBodySchema = $termsErrorBody;
@@ -2038,7 +2038,7 @@ var $intentRequest = z2.discriminatedUnion("kind", [
     credentials: $credentials,
     values: z2.record(KycFieldIdSchema, z2.string()).refine((values) => Object.keys(values).length > 0, "values must not be empty")
   }),
-  obj2({ kind: z2.literal("order"), orderId: $nonEmpty, transactionId: $nonEmpty })
+  obj2({ kind: z2.literal("order"), orderId: $nonEmpty, transactionId: $nonEmpty.optional(), quotedAmount: FiatAmountSchema })
 ]);
 var MoonPayIntentRequestSchema = $intentRequest;
 var $quoteInput = obj2({
@@ -2090,13 +2090,7 @@ var MoonPayOrderResponseSchema = $orderResponse;
 var $intentResponse = z2.union([$stepResponse2, $orderResponse]);
 var MoonPayIntentResponseSchema = $intentResponse;
 var $faultFields = {
-  reason: z2.enum([
-    "SESSION_BUDGET_SPENT",
-    "RATE_LIMITED",
-    "PROVIDER_UNAVAILABLE",
-    "IN_PROGRESS",
-    "INVALID_REQUEST"
-  ]),
+  reason: z2.enum(["SESSION_BUDGET_SPENT", "RATE_LIMITED", "PROVIDER_UNAVAILABLE", "INVALID_REQUEST"]),
   recovery: z2.enum(["RETRY", "REQUOTE", "NONE"])
 };
 var $fault = obj2($faultFields);

package/dist/providers/moonpay.d.ts

@@ -57,11 +57,16 @@ export type MoonPayIntentRequest =
     credentials: MoonPaySdkCredentials;
     values: Partial<Record<KycFieldId, string>>;
 }
-/** After the Apple Pay sheet. `transactionId` is from the Apple Pay completion event. */
+/**
+ * After every charge attempt, a failed one too. `transactionId` is from the Apple Pay event when it
+ * has one; without it the backend records the failed charges MoonPay lists for `orderId`.
+ * `quotedAmount` is the fiat amount the buyer saw on the quote.
+ */
  | {
     kind: 'order';
     orderId: string;
-    transactionId: string;
+    transactionId?: string;
+    quotedAmount: FiatAmount;
 };
 export type MoonPayIntentKind = MoonPayIntentRequest['kind'];
 /**
@@ -138,14 +143,20 @@ export type MoonPayStepResponse =
     reason: MoonPayStepRefusal;
     recovery: 'REQUOTE' | 'NONE';
 };
-/** The answer to `order`, which runs after the charge. */
+/**
+ * The answer to `order`, which runs after each charge attempt. A failed charge is recorded too: it
+ * answers `DONE` with the order in `FAILED`, and the client requotes for a new `orderId`.
+ */
 export type MoonPayOrderResponse = 
 /** The `GET /fiat/orders/:orderId` response; the shared order screen renders it. */
 {
     status: 'DONE';
     order: FiatStepResponse;
 }
-/** MoonPay does not show the transaction yet. Send the same `order` after the delay. */
+/**
+ * MoonPay does not list the transaction yet. Send the same `order` after the delay. After a failed
+ * charge with no `transactionId`, the client caps these polls.
+ */
  | {
     status: 'PENDING';
     retryAfterMs: number;
@@ -167,10 +178,10 @@ export type MoonPayIntentStatus = MoonPayIntentResponse['status'];
 export type MoonPayRecovery = 'RETRY' | 'REQUOTE' | 'NONE';
 /**
  * `SESSION_BUDGET_SPENT`: the per-login SDK session mint budget (429). `RATE_LIMITED`: the kind's
- * request budget (429). `PROVIDER_UNAVAILABLE`: MoonPay or Sumsub is down. `IN_PROGRESS`: a `kyc`
- * for this buyer is still running (409). `INVALID_REQUEST`: a bad body (400).
+ * request budget (429). `PROVIDER_UNAVAILABLE`: MoonPay or Sumsub is down. `INVALID_REQUEST`: a bad
+ * body (400).
  */
-export type MoonPayFaultReason = 'SESSION_BUDGET_SPENT' | 'RATE_LIMITED' | 'PROVIDER_UNAVAILABLE' | 'IN_PROGRESS' | 'INVALID_REQUEST';
+export type MoonPayFaultReason = 'SESSION_BUDGET_SPENT' | 'RATE_LIMITED' | 'PROVIDER_UNAVAILABLE' | 'INVALID_REQUEST';
 /** The fields a MoonPay fault adds to the shared error body. */
 export interface MoonPayFault {
     reason: MoonPayFaultReason;

package/dist/providers/moonpay.mjs

@@ -1,6 +1,6 @@
 import {
   MOONPAY_ENDPOINTS
-} from "../chunk-YOMQWXTD.mjs";
+} from "../chunk-SJ7V3YOM.mjs";
 export {
   MOONPAY_ENDPOINTS
 };

package/dist/table.js

@@ -36,7 +36,7 @@ __export(table_exports, {
 module.exports = __toCommonJS(table_exports);
 
 // package.json
-var version = "0.21.0";
+var version = "0.22.0";
 
 // src/table.ts
 var TABLE_VERSION = version;

package/dist/table.mjs

@@ -11,7 +11,7 @@ import {
   tableEntry,
   unofferedEndpoints,
   unreachableStates
-} from "./chunk-LBYBZDOW.mjs";
+} from "./chunk-7OUDI3JX.mjs";
 export {
   DOCUMENTED_ENDPOINTS,
   STATE_KEYS,

package/dist/terms.d.ts

@@ -45,11 +45,11 @@ export interface FiatTermsResponse {
 }
 /**
  * `STALE_TERMS`: an unpublished version, a wrong digest, or an `acceptedAt` older than 5 minutes
- * (400). `IN_PROGRESS`: the same request is still running (409). `INVALID_REQUEST`: a bad body (400).
+ * (400). `INVALID_REQUEST`: a bad body (400).
  * `RATE_LIMITED`: the per-login terms budget is spent (429). `PROVIDER_UNAVAILABLE`: the KYC service
  * or a store is down (503); nothing is recorded, so retry.
  */
-export type FiatTermsFaultReason = 'STALE_TERMS' | 'IN_PROGRESS' | 'INVALID_REQUEST' | 'RATE_LIMITED' | 'PROVIDER_UNAVAILABLE';
+export type FiatTermsFaultReason = 'STALE_TERMS' | 'INVALID_REQUEST' | 'RATE_LIMITED' | 'PROVIDER_UNAVAILABLE';
 /** `RETRY` sends the same request again. `REQUOTE` goes back to `POST /fiat/quote`. `NONE` ends the flow. */
 export type FiatTermsRecovery = 'RETRY' | 'REQUOTE' | 'NONE';
 /** The 4xx/5xx body of `POST /fiat/terms`: the shared error body plus `reason` and `recovery`. */

package/dist/terms.mjs

@@ -3,7 +3,7 @@ import {
   FUN_KYC_CONSENT_DOCUMENTS,
   PROVIDER_CHECKOUT_DOCUMENTS,
   PUBLISHED_TERMS_DOCUMENTS
-} from "./chunk-N6GHUS2K.mjs";
+} from "./chunk-5GRPYE2U.mjs";
 export {
   FIAT_TERMS_ENDPOINT,
   FUN_KYC_CONSENT_DOCUMENTS,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fun-xyz/fiat-contract",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "description": "Published conformance contract for Fun's headless fiat onramp: FlowState/Transition types, zod schemas, the transition table as data, recorded fixtures, assertion helpers.",
   "license": "MIT",
   "repository": {