@invonetwork/web-sdk 3.27.0 → 3.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,1369 +1,1389 @@
1
- # Changelog
2
-
3
- ## 3.27.0
4
-
5
- ### Minor Changes
6
-
7
- - Loyalty: `InvoServer.reportGameEvent({ playerEmail, eventType, eventId?, occurredAt?, payload? })` (`POST /api/sdk/loyalty/server-events`, game secret, trusted for rewards) and `InvoClient.reportGameEvent(...)` (`POST /api/sdk/loyalty/events`, player token). `eventId` is generated when omitted and returned; the server call retries with it. Types `GameEventType`, `ReportGameEventInput`, `ReportServerGameEventInput`, `ReportGameEventResult`.
8
- - New entry `@invonetwork/web-sdk/game-server`: the server half of a browser game's economy. `invoGameServerFromEnv` / `createInvoGameServer` serve sessions, the premium wallet (read from INVO), a soft-currency ledger, hosted checkout, signed-webhook crediting processed exactly once, idempotent item purchases (premium through `purchaseItem`, soft through the ledger), rate-limited earnings, loyalty events and rewards, under `/api/invo`. `createFileGameStore` (atomic JSON file) and `createMemoryGameStore`; `toNodeListener` adapts it to `node:http`. With secrets missing it answers `503 INVO_SETUP_REQUIRED` and keeps `/health` and `/catalog` up.
9
- - New entry `@invonetwork/web-sdk/game`: `InvoGameEconomy` (the browser client for that server: sign-in, wallet events, `buyItem`, `buyPremium` with popup or redirect checkout, batched `earn`, `reportEvent`) and `mountInvoUI`, a framework-free DOM kit (balance HUD, buy-currency modal, shop grid, sign-in, toasts) in the INVO palette, themeable by CSS variables. Holds no secret. Used by `@invonetwork/phaser` and `@invonetwork/three`.
10
- - `invoGameServerFromEnv` accepts `projectId` (sent to the sandbox as `X-Invo-Project-Id` on every call, never in production) and `fetch`. `InvoGameEconomy.checkSetup()` re-asks the server whether its INVO secrets are set; the UI kit's developer setup guide uses it to notice when the keys arrive.
11
- - The UI kit ships the INVO design: a glass wallet HUD with animated balance changes, a tabbed shop with lit item cards, ownership chips and stack pips, premium packs with a best-value ribbon, sign-in with field icons, a step-by-step developer setup guide, toasts, and bottom sheets on phones. It respects `prefers-reduced-motion`.
12
- - Nothing removed or renamed; the `.` and `./server` entries are unchanged apart from the two new methods.
13
-
14
- ## 3.26.1
15
-
16
- ### Patch Changes
17
-
18
- - Types: `Payee` gains `payable` and `payable_blockers` (`PayableBlocker`, exported from the server entry). Check `payable` before offering a payout to a creator.
19
- - Docs: refusals add `PAYEE_TERMS_NOT_ACCEPTED` (the creator hasn't accepted INVO's current Payee Terms yet), and removing a creator with a payout still being processed reports `payouts_in_flight_by_status`.
20
- - Nothing removed or renamed.
21
-
22
- ## 3.26.0
23
-
24
- ### Minor Changes
25
-
26
- - Server: `invo.payouts.removePayee(payeeId)` (`POST /api/partner-payees/{payeeId}/remove`): remove a creator from your program; the status becomes `closed`.
27
- - Types: `PayeeStatus` gains `closed`; `Payee` gains `erased`; `Payout` and `PayoutStatusChangedData` gain `return_reason_code` (typed `ReturnReasonCode`), `partner_message` and `owner_confirmation_required` (`Payout` also `owner_confirmed_at`). `PayoutStatusChangedData.status` and `previous_status` are typed `PayoutStatus`. `PayoutStatus` and `ReturnReasonCode` are exported from the server entry and from webhooks.
28
- - Docs: `requestPayout` takes exactly one of `payeeId` or `bankAccountId`; the comment no longer says a request without either defaults to your own bank. Refusal codes listed in full.
29
- - Behaviour on the API, not the SDK: partner payout reads and `payout.status_changed` no longer carry INVO's internal notes (`admin_note`), admin ids (`reviewed_by_admin_id`, `initiated_by_admin_id`) or the accounting provider's fields (`qb_vendor_id`, `qb_bill_id`, `qb_payment_reference`). They were never part of the documented contract; read `partner_message` for a note INVO writes for you.
30
- - Nothing in the SDK removed or renamed.
31
-
32
- ## 3.25.0
33
-
34
- ### Minor Changes
35
-
36
- - Server: `InvoServer.payouts`, partner payouts and creator payouts. `registerPayee` (`POST /api/partner-payees`), `listPayees`, `getPayee`, `resendPayeeInvite`, `requestPayout` (`POST /api/partner-payouts/request`, with `payeeId` to have INVO pay a verified creator from the earnings INVO owes you, or `bankAccountId` for your own verified bank), `getPayout`, `listPayouts` (optional `payeeId`) and `cancelPayout` (a creator payout still `requested`). Results keep the API's snake_case fields. Creators are INVO's customers: you see their status only, never their documents, tax id or bank details.
37
- - Webhook types: `payee.status_changed` is typed as `PayeeStatusChangedData`. `PayoutStatusChangedData` gains `payee_id`, `payout_method` and `returned_at`. Payout statuses now include `cancelled` and `returned`.
38
- - Nothing removed or renamed.
39
-
40
- ## 3.24.1
41
-
42
- ### Patch Changes
43
-
44
- - Player activity: on the recipient's entry for a send or transfer from another game, `grossAmount` and `feeAmount` are now filled in the recipient's currency (`grossAmount - feeAmount === amount`). They were `null` on every cross-game entry. Doc comment updated; no type change.
45
-
46
- ## 3.24.0
47
-
48
- ### Minor Changes
49
-
50
- - Player activity: send and transfer entries from `getPlayerActivity` / `iteratePlayerActivity` carry the fee. On the sender's entry `feeAmount` and `netAmount` (what the recipient gets) sit beside the gross `amount`; on the recipient's entry `grossAmount` and `feeAmount` sit beside `amount` (what arrived). While a send waits to be collected they show the fee that will apply; `null` when it ended without being collected, and on the recipient side of a currency-converting transfer. Purchases do not carry them.
51
- - Errors: initiate-send and initiate-transfer amount-limit refusals now carry `error_code` `AMOUNT_BELOW_MINIMUM` / `AMOUNT_ABOVE_MAXIMUM` with the limit. `err.isAmountBelowMinimum` (now also true for these, and on the wallet transfer route where `err.code` stays `INVALID_AMOUNT`), new `err.isAmountAboveMaximum`, `err.minimumAmount`, `err.maximumAmount` and `err.limitCurrencyName`. A sender phone that does not match the one on file now carries `PHONE_MISMATCH` (400); `err.isPhoneMismatch` covers it as well as `registerPlayer`'s 409.
52
- - Webhook types: `identity.passkey_reset` is typed as `IdentityPasskeyResetData` (`identity_id`, `reset_via`, `cooldown_until`, `deactivated_count`). It now also fires for an in-app recovery (`reset_via: "sdk"`) and can be subscribed to by name.
53
- - Nothing removed or renamed.
54
-
55
- ## 3.23.0
56
-
57
- ### Minor Changes
58
-
59
- - Webhook types: `PurchaseEventData` gains `dispute_fee_usd` (`string | null`, USD decimal such as `"15.00"`, `"0.00"` when INVO bears the fee) and `dispute_fee_charged_to_partner` (`boolean | null`), carried on a card `purchase.disputed` when the dispute closes. From November 8, 2026 the card dispute fee on Open-tier card sales (coin purchases, Platform Commerce card sales and subscription charges) is passed through to you at cost. A lost dispute is `purchase.disputed` with `dispute_status: "lost"`, not a separate event. README updated. Both fields optional; nothing removed or renamed.
60
-
61
- ## 3.22.0
62
-
63
- ### Minor Changes
64
-
65
- - e3895ab: 2026-10 pricing and new reads. Server: `getPlayerActivity({ playerEmail, limit?, cursor?, types? })`
66
- (`GET /api/sdk/players/activity`), one merged, newest-first page of a player's currency purchases,
67
- item purchases, Platform Commerce purchases, sends and transfers, and `iteratePlayerActivity`, which
68
- follows `nextCursor`. `platformCommerce.getPurchaseHistory({ playerEmail, limit?, cursor? })`
69
- (`GET /api/platform-commerce/purchase-history`, entries shaped like `getStatus`) and
70
- `platformCommerce.iteratePurchaseHistory`. `getTransferStatus` / `getSendStatus` results carry
71
- `expiryReason` once expired. Webhook types: `TransferEventData` gains `order_id`,
72
- `net_transfer_amount`, `claim_code_expires_at`, `from_game_id`, `to_game_id`, `from_player_id`,
73
- `expired_at`, `reason`, `expiry_reason` and `refunded_amount`; `payout.status_changed` is typed as
74
- `PayoutStatusChangedData`, with the payout fee fields `offboarding_fee_pct`, `offboarding_fee_usd`,
75
- `offboarding_fee_cap_usd` and `net_payout_usd`. New additive `err.publicCode`: the
76
- provider-neutral twin of a code (INVO's `error_code_public` on errors from the API). The SDK's own
77
- pre-network refusal of a Platform Commerce card total under $0.50 keeps `err.code` exactly as
78
- before and now also carries `err.publicCode === "BELOW_CARD_MINIMUM"` and `err.minUsd === "0.50"`;
79
- `err.isBelowCardMinimum` is true as before and accepts both spellings. Nothing removed or renamed. README: the
80
- Open card fee is 3.5% + $0.30 (was 4.5%); the chargeback guarantee is a Merchant of Record term
81
- (Open-tier card payments made before November 8, 2026 keep it); transfers are 10% (3.5% / 3.5% /
82
- 3%); payouts carry a 1% fee capped at $500 per payout; the hosted checkout reports a finished
83
- purchase as status `"completed"`; on `phoneMismatch`, call `updatePlayerPhone`. Additive only.
84
- - Player-confirmed phone change. Server: `requestPhoneChange({ playerEmail, newPhone })`
85
- (`POST /api/sdk/players/phone/change-requests`, 202, never auto-retried) returns
86
- `changeRequestId`, `status`, `expiresAt`, `delivery`, `confirmation` and `message`; INVO emails
87
- the player, who confirms on INVO's page (plus their passkey or enrolled device when they have
88
- one). `getPhoneChange(changeRequestId)` reads the request. Browser, with the player token, on
89
- the player's enrolled device: `listPhoneChangeApprovals()` and
90
- `approvePhoneChange(changeRequestId, { deviceFingerprint, decision?, sign | deviceSignal })`,
91
- which sends a `device_signal` over `phone-change|<id>|<nonce>|<timestamp>` (or
92
- `phone-change-deny|...`); new `phoneChangeSignalMessage()` builds that message. No method sends
93
- a confirmation code: games never collect it. `err.changeRequestEndpoint` on
94
- `PHONE_CHANGE_REQUIRES_VERIFICATION`; new error predicates `isConfirmOnInvoPage`,
95
- `isChangeRequestNotFound`, `isChangeRequestNotReady`, `isChangeRequestNotPending` (with
96
- `changeRequestStatus`), `isChangeRequestInProgress`, `isPhoneChangeLocked`,
97
- `isTooManyChangeRequests`, `isPhoneChangeUnavailable`, `isDeviceSignalRejected`,
98
- `isPhoneChangeRecoveryCooldown` (`PHONE_CHANGE_RECOVERY_COOLDOWN`, 409 on create and approve:
99
- a recent sign-in recovery; retry later, declining still works) and
100
- `isDeviceEnrolledAfterRequest` (`DEVICE_ENROLLED_AFTER_REQUEST`, 409 on approve). New
101
- `isPendingTransfersToOldPhone` / `isPendingTransfersToNewPhone`, which `updatePlayerPhone`
102
- now also answers (409, no counts) as well as the change request routes. Webhook
103
- type: `player.phone_changed` as `PlayerPhoneChangedData` (`new_phone` only for the requesting
104
- game). README section "Player-confirmed phone change": on `phoneMismatch` or
105
- `player.phone_changed`, never push a stored number back; ask the player. Additive only.
106
-
107
- ## 3.21.0
108
-
109
- ### Minor Changes
110
-
111
- - 0238b53: Player registration, phone changes and identity re-key. Server: `mintPlayerToken` takes optional
112
- `playerPhone` and `playerName`; with a phone, a player new to your title is created, and the
113
- result now carries `created` and `phoneMismatch` (previously dropped). New
114
- `registerPlayer({ playerEmail, playerPhone, playerName? })` (`POST /api/sdk/players`) and
115
- `updatePlayerPhone({ playerEmail, newPhone })` (`POST /api/sdk/players/phone`, never
116
- auto-retried). `initiateSend` / `initiateTransfer` results expose `identityRekeyed`,
117
- `playerToken`, `playerTokenExpiresAt`, `identityId` and `claimDeliveryPlanned`; approve results
118
- expose `claimDelivery`. New error predicates `isPlayerTokenStale`,
119
- `isPhoneChangeRequiresVerification`, `isPhoneMismatch`, `isPhoneShareRefused`;
120
- `isPlayerNotFound` also recognises the codeless `player_not_found` 404. A 403
121
- `PLAYER_TOKEN_STALE` on approve is surfaced, never auto-retried: re-mint and retry once.
122
- Additive only. README section "Registering players and changing their phone".
123
-
124
- ## 3.20.0
125
-
126
- ### Minor Changes
127
-
128
- - 1dc07df: Loyalty and rewards. Server: `InvoServer.getPlayerRewards(playerEmail)` reads one player's
129
- loyalty cards with the game secret (`GET /api/sdk/loyalty/players/rewards`). Browser, with the
130
- player token: `InvoClient.getMyRewards()` (the player's cards), `getMyVault()`,
131
- `redeemReward(vaultEntryId)` (the only response with a code; never auto-retried) and
132
- `getRewardsPageLink()` (INVO's hosted "My rewards" page). Every card step carries `progress`,
133
- `{ current, target }`, or `null` when unavailable; `state` decides completion. New error
134
- predicates `isRewardAlreadyRedeemed`, `isRewardNotFound`, `isRewardExpired`,
135
- `isRewardUnavailable` (`inventory_exhausted` / `conflict`); the server read's
136
- `PLAYER_NOT_FOUND` and `INVALID_PLAYER_EMAIL` use the existing `isPlayerNotFound` and
137
- `isInvalidPlayerEmail`. Additive only. README section "Loyalty and rewards".
138
-
139
- ## 3.19.0
140
-
141
- ### Minor Changes
142
-
143
- - 6940139: D-PRICE-012: a subscription card refund, and a lost chargeback not covered by the chargeback guarantee, now cost the partner the whole refunded amount, INVO's card fee included, exactly as a Platform Commerce card refund does. There is no separate payment processor fee on a refund any more: `processingFeeUsd` reads `"0.00"` and `processingFeeBasis` `"none"`.
144
-
145
- Additive, optional fields:
146
-
147
- - `RefundResult.cardFeeChargedToPartnerUsd` and `RefundResult.partnerDebitedUsd` on `subscriptions.refund` (the 200 receipt and the 202 `pending_approval` body). `undefined` on a receipt stored before this release.
148
- - `card_fee_charged_to_partner_usd` and `partner_debited_usd` on the `refund` block of `subscription.refunded` (`SubscriptionRefundDetail`) and on `purchase.disputed` (`PurchaseEventData`, subscription and Platform Commerce losses; `null` where not applicable).
149
-
150
- README: subscription refund costs, lost chargebacks and the "What did I earn?" answer updated.
151
-
152
- ## 3.18.0
153
-
154
- ### Minor Changes
155
-
156
- - 432fb75: INVO's 2026-09 card pricing. On card purchases the partner now pays INVO's card fee (4.5% + $0.30 on Open, 5.5% + $0.50 on Merchant of Record, plus 1.5% of the listed price (before tax) on a card issued outside the US); the player pays the listed price (plus tax where owed) and receives the listed coins. Fraud screening and a chargeback guarantee (a fraud chargeback on a card sale is covered by INVO) are included. Minimum card purchase $2.99 on coin purchases and Platform Commerce card sales, enforced from 2026-10-27. Card purchases only; purchases through a third-party storefront or payment rail are unaffected. All additive:
157
-
158
- - `PurchaseResult` and `CurrencyPurchaseQuote` gain `partnerFeeUsd`, `internationalCardFeeUsd` and `minPurchaseWarning` (`MinPurchaseWarning`: `{ code, minUsd, enforcedFrom, message?, enforced?, raw }`), each set only when INVO sends it. `processingFeeUsd` stays and reads `"0.00"`.
159
- - `FeeTakenFrom` gains `"partner"`. `UnacknowledgedPurchaseOutcome.feeTakenFrom` stays required; INVO always sends it, and should it ever be missing the SDK reads `"partner"` when the quote carries `partner_fee_usd`, otherwise `"coins"` as before.
160
- - `err.minUsd` and `err.enforcedFrom` on `BELOW_CARD_MINIMUM` (`err.isBelowCardMinimum`, which now also covers INVO's minimum card purchase). `err.isAmountBelowFee` is deprecated: `AMOUNT_BELOW_FEE` is no longer returned.
161
- - `acknowledgedTotalUsd` is still honored: INVO never charges more than it, and an older, higher fee-inclusive total is accepted with the true, lower total charged. Only a total below the true total is refused (`QUOTE_STALE`).
162
- - `partnerFeeUsd` and `internationalCardFeeUsd` are `string | null`: `null` only when the fee could not be booked when the purchase completed (the purchase succeeded; INVO books the fee shortly after). `internationalCardFeeUsd` is `"0.00"` on a US card or one whose country is unknown, and always `null` on a quote (no card yet). The quote also carries `feeTakenFrom`, and `ifUnacknowledged.partnerFeeUsd`.
163
- - `createCheckout()` and the Platform Commerce card leg of `platformCommerce.purchase()` return `minPurchaseWarning` while an amount under the minimum card purchase is still accepted. `BELOW_CARD_MINIMUM` also answers a card charge under the $0.50 card floor at any date, on coin purchases, hosted checkout and Platform Commerce: `err.minUsd` reads `"0.50"` there, with no `err.enforcedFrom`.
164
- - `purchaseCurrency()` accepts `country` and `subdivision`, the place you quoted with. On Merchant of Record INVO uses it only when it cannot read the buyer's tax location from the card; without it such a purchase is refused with `409 TAX_PLACE_UNAVAILABLE` (new `err.isTaxPlaceUnavailable`, `err.untaxedTotalUsd`), nothing charged.
165
- - Platform Commerce card refunds: `cardFeeChargedToPartnerUsd` and `partnerDebitedUsd` on the refund result and `card_fee_charged_to_partner_usd` / `partner_debited_usd` on `platform_commerce.refunded` (the card fee is not returned on a refund; it stays charged to you).
166
- - Webhook types: `purchase.completed` gains `partner_fee_usd` and `international_card_fee_usd` (nullable); `purchase.disputed` gains `guarantee_covered` (lost Platform Commerce card sale and subscription disputes only; never on a coin purchase dispute), `order_type`, `developer_revenue_reversed_usd`, `subscription_id`, `period_seq` and `processing_fee_usd` (the processor fee a non-fraud lost subscription chargeback charges you, as a refund does); `platform_commerce.purchased` gains `international_card_fee_usd` (already included in `fee_breakdown.platform_fee`); `subscription.renewed`'s split gains `international_card_fee_usd` (the same figure as `pass_through_fees_usd`, never add them; `partner_revenue_usd` stays gross).
167
- - Behaviour to notice: an unacknowledged $10.00 coin purchase now credits the full 100.00 coins (93.70 under the earlier pricing); an older fee-inclusive acknowledged total is accepted and the lower true total charged; `AMOUNT_BELOW_FEE` is no longer returned.
168
- - README and doc comments: every card fee figure, the Tiers table (card rates, international fee, who pays, fraud screening, chargeback guarantee, minimum card purchase) and the quote example ($10.00 charges the player $10.00; your fee is $0.75 on Open).
169
-
170
- ## 3.17.0
171
-
172
- ### Minor Changes
173
-
174
- - 28a96bf: Webhook payload types: `PurchaseEventData` gains `payment_intent_id` / `charge_id` / `dispute_id` (`string | null`: `null` on a Steam chargeback), `rail`, `steam_transid`, `fully_refunded`, `currency_debited` and `new_balance`. Steam chargebacks now arrive as `purchase.disputed` with the same keys as a lost card dispute, and a Steam partial refund arrives as `purchase.refunded` with `fully_refunded: false`. README: if you revoke on `purchase.refunded`, handle `purchase.disputed` the same way. All additive and optional.
175
-
176
- ## 3.16.1
177
-
178
- ### Patch Changes
179
-
180
- - 9dd2bf5: README: the `isDuplicateClientRequestId` note describes only what the caller sees. Documentation only.
181
-
182
- ## 3.16.0
183
-
184
- ### Minor Changes
185
-
186
- - 58143c2: `warnings` on `createCheckout()` results (typed `CheckoutWarning[]`, mapped from the additive `warnings` field): a checkout session sells game currency, and `metadata` carrying `item_id` / `item_name` now returns `ITEM_METADATA_ON_CURRENCY_SESSION`, pointing to `platformCommerce.purchase` for item sales. New error helpers: `err.isDuplicateClientRequestId` (409 `DUPLICATE_CLIENT_REQUEST_ID` on a Platform Commerce card purchase, with `order_id` / `order_status`; `err.isDuplicateRequest` is also true), `err.isTrialAmountBelowFeeFloor` (400 `TRIAL_AMOUNT_BELOW_FEE_FLOOR`; the message names the smallest accepted trial price) and `err.isIdentityCheckUnavailable` (503 `IDENTITY_CHECK_UNAVAILABLE` on claims and confirm-receipt, retryable). `err.isAmountBelowMinimum` now also covers `purchaseItem`, whose `totalPrice` is rounded to cents. README: refunds take back only the coins still held from that purchase, chargebacks up to the purchase's coins from the available balance, never below zero. All additive and optional.
187
-
188
- ## 3.15.0
189
-
190
- ### Minor Changes
191
-
192
- - 5adf010: `cards.createSetupSession()` takes optional `playerName` and `playerPhone` (mapped to `player_name` / `player_phone`). When the member is new to the game and `playerName` is sent, INVO creates the member exactly as `subscriptions.create` does and then mints the card link, so a brand-new signup can save a card before a paid trial (`subscriptions.create` with `trialAmountUsd` and `playerCardId`). Without `playerName` an unknown member is still `err.isPlayerNotFound` (404). A known member is never re-created or renamed by this call. New `err.isPlayerCreateFailed` (503 `PLAYER_CREATE_FAILED`); a phone already on another member answers `err.isPhoneShareApprovalRequired` (409). The SDK refuses a blank or over-255-character `playerName` and a non-E.164 `playerPhone` before the network (`INVALID_INPUT`, status 0). README: the card page and paid-trial sections show the new-signup order. All additive and optional.
193
-
194
- ## 3.14.2
195
-
196
- ### Patch Changes
197
-
198
- - README: the Merchant of Record chargeback threshold is measured on the previous complete calendar month. Documentation only.
199
-
200
- ## 3.14.1
201
-
202
- ### Patch Changes
203
-
204
- - README: Merchant of Record is applied for from the Selling & Tax page in the INVO console (the page name was wrong in 3.14.0). Documentation only.
205
-
206
- ## 3.14.0
207
-
208
- ### Minor Changes
209
-
210
- - 8f2298b: `credited` and `reasonCode` on `confirmPayment()` and `steamFinalizePurchase()` results (mapped from the additive `credited` / `reason_code` response fields; `status` is unchanged and still means the payment succeeded, so report a completed purchase only when `credited` is `true`). Merchant of Record receipt fields `receiptNumber` / `receiptUrl` on `purchaseCurrency()`, `getOrderDetails()`, `CheckoutClient.getPurchaseStatus()`, `platformCommerce.getStatus()` and `firstCharge`, and `receipt_number` / `receipt_url` (plus `tax_treatment` on `purchase.completed`) on the purchase, Platform Commerce and subscription webhook payload types. README: the tier's effect on responses (`tax_treatment: "partner_responsible"` on Open, receipts and the chargeback reserve on Merchant of Record). Platform Commerce card refunds in parts: optional `refundRemaining` / `confirmAdditionalRefund` on `platformCommerce.refund()`, optional `partialRefund` / `adopted` / `refundedTotalUsd` / `chargeTotalUsd` / `remainingUsd` on its result, and `err.isRefundRemainingRequiresConfirmation` / `err.isRefundRecentlyIssued` / `err.isRefundNotCompleted` (`err.isAlreadyRefunded` is now false for the two refund-in-parts refusals). All additive and optional. README: subscription card charges are 4% + $0.30 on Open and 5% + $0.50 on Merchant of Record (were 7% + $0.30 and 8.5% + $0.30); international card and currency conversion costs on subscriptions pass through at cost; chargebacks by tier; Merchant of Record is applied for from the console.
211
-
212
- ## 3.13.0
213
-
214
- ### Minor Changes
215
-
216
- - INVO's card fee on coin purchases, paid trials, and the two tiers.
217
-
218
- **Coin purchases carry INVO's card fee: 3.5% + $0.30** of the price (on the Open tier), never less than the card cost. `purchaseCurrency` charges in the same request, so there are now two shapes and you pick one by what you send:
219
-
220
- - **Quote, show, acknowledge.** New `server.quoteCurrencyPurchase({ playerEmail, usdAmount, country?, subdivision? })` calls `POST /api/currency-purchases/quote`. It moves no money and creates nothing, and returns `totalUsd`, `amountCents`, `subtotalUsd`, `processingFeeUsd`, `coins`, `currencyName`, a camelCase `breakdown` and `ifUnacknowledged`. Show the player `totalUsd`, then pass it as the new optional `acknowledgedTotalUsd` on `purchaseCurrency`: the card is charged that total, to the cent, and the coins are priced off `usdAmount`. $10.00 quotes $10.65.
221
- - **Send only `usdAmount`.** The card is charged exactly `usdAmount`, never more, and the fee comes out of the coins: $10.00 credits 93.70 coins at the default 10 per USD.
222
-
223
- A `success` result now also carries `processingFeeUsd`, `feeTakenFrom` (`"charge"` or `"coins"`), `coinsCredited` and `chargeTotalUsd`. New error helpers: `err.isQuoteStale` (409 `QUOTE_STALE`, with `err.expectedTotalUsd` and `err.acknowledgedTotalUsd`) and `err.isAmountBelowFee` (400 `AMOUNT_BELOW_FEE`). Nothing is charged on either. `acknowledgedTotalUsd` is shape-checked locally (a positive two-decimal amount) with a ceiling above the largest price, because the fee rides above INVO's card maximum.
224
-
225
- **Refunds of coin purchases:** only unspent coins are refundable; spent coins are never refunded. Documented; no SDK call refunds a coin purchase.
226
-
227
- **Paid trials on card subscriptions.** `subscriptions.create` accepts `trialAmountUsd` (with `trialDays` or `trialEnd`, card only, at least 0.50 and less than `amountUsd`): period 1 is charged the trial price inside the call and `amountUsd` from period 2. The consent object accepts `disclosedTrialAmountUsd`, `disclosedTrialDays` and `disclosedTrialEnd`, and returns `disclosed_trial_amount_usd`, `disclosed_trial_days` and `disclosed_trial_end`. The subscription gains `trialAmountUsd` and, on create and finalize bodies, `trialAmountCoinsEstimate`. Webhook types: `is_trial` on `subscription.renewed`; `is_trial` and `trial_amount_usd` on the trial period's `payment_failed`, `past_due`, `authentication_required` and `expired` (new `SubscriptionTrialEventFields`); `expire_cause` (`"trial_payment_failed"`) on `subscription.expired`. New error helpers: `isPaymentMethodRequired`, `isTrialAmountInvalid`, `isTrialAmountRequiresTrial`, `isTrialAmountNotSupportedForFunding`, `isConsentDisclosedTrialInvalid`. The SDK refuses, before the network and with INVO's own codes, a `trialAmountUsd` without a trial, with `walletOnly: true`, or on `steamInit`; the $0.50 floor and the "less than `amountUsd`" rule are left to INVO.
228
-
229
- **README:** a new Tiers section (Open by default: you are the seller and handle tax; Merchant of Record by application: INVO is the seller and handles tax; fees per tier), the coin fee flow, the refund rule and paid trials. Every statement that INVO is the merchant of record on the card rail for everyone is removed.
230
-
231
- All additive: no export was removed, renamed or retyped, and every new field on an existing type is optional.
232
-
233
- ## 3.12.1
234
-
235
- ### Patch Changes
236
-
237
- - Docs: subscription packages.
238
-
239
- The README's Subscriptions section gains a **Subscription packages** part. A package (the API calls it a plan) is what a developer sells: a name, a price, a billing interval and the `item_id` the game checks. Packages are created, edited, closed and reopened in the INVO dashboard with the developer's own sign-in, never with the game secret or a player token, so this SDK does not wrap them and has no `packages` or `plans` namespace. That is deliberate.
240
-
241
- Nothing about an integration changes. `server.subscriptions.create(...)` and `steamInit(...)` still subscribe a member to an `itemId`, webhooks carry the same payloads, and entitlement still comes from `subscription.renewed`. A package's subscriber counts and monthly revenue are measured per title and `item_id`, so a new package immediately shows the members already subscribed to its item. The section also covers the two counts (`subscriber_count` on basis `active`, `live_subscriber_count` on basis `live`), who a price change applies to, and that closing a package cancels nobody. Full guide: https://docs.invo.network/docs/subscriptions-packages/
242
-
243
- Doc correction: the subscription refund daily limit. The README and the `subscriptions.refund` JSDoc said a game's daily self-serve refund limit is $500 by default. It no longer is: by default the limit is never lower than the largest single subscription charge (`25000.00` USD today), so any single period can always be refunded on its own, and if INVO raises the per-charge maximum the limit rises with it. INVO can still set a specific limit for one game, which applies as set, even if lower. Everything else about refunds is unchanged: reaching the limit exactly still runs, going over it answers HTTP 202 `pending_approval`, and approved requests do not count toward the day. The sandbox recipe now says how to see a 202 (ask INVO for a low limit on the sandbox game).
244
-
245
- Documentation only. No export was added, removed, renamed or retyped.
246
-
247
- ## 3.12.0
248
-
249
- ### Minor Changes
250
-
251
- - The card maximum is INVO's, not the SDK's.
252
-
253
- **INVO raised the maximum single card charge from $999.99 to $100,000.00 on 2026-09-18, and this package was refusing it.** The old limit was enforced client-side and threw before any network call, so a partner charging $50,000 failed inside the SDK and INVO never saw the request. The backend raise was invisible to every SDK user until this release. Per-customer velocity limits rose with it, to 100,000 per hour, 200,000 per day and 1,000,000 per month, all enforced by INVO.
254
-
255
- **The design decision: the floor is a fact, the ceiling is a policy, and only facts belong in a client.**
256
-
257
- $0.50 is the card rail's own minimum charge. Below it nothing settles in any environment, INVO holds it as a plain constant rather than a setting, and no configuration makes a smaller amount chargeable. That check stays exactly where it was and still throws before any request (`BELOW_STRIPE_MINIMUM`, `err.isBelowCardMinimum`).
258
-
259
- The maximum is the opposite. It is a runtime setting an INVO admin edits without a deploy, and it differs between sandbox and production. Any number pinned in a published package is stale the moment somebody changes it, and the only remedy is a release, which is precisely the failure this release is repairing. So the local ceiling is **removed** rather than re-pinned at $100,000.00. It was not replaced by a fetch of the live limits either: that would turn one purchase call into two network calls, add a failure mode and a cache to a money path, and still be a snapshot rather than the truth at the moment of charge, because only the request itself is evaluated against the setting in force.
260
-
261
- What remains is a structural bound. `usdAmount` and a card `totalPrice` must still be a positive amount with at most two decimals, and must still be at most `999999.99`, the same house ceiling every other money field in this SDK uses. That figure is deliberately **above** the largest value INVO's setting is permitted to take, so it can never refuse an amount INVO would have accepted. The invariant for anyone editing this later: the local bound must never be tighter than the server's maximum possible limit. This SDK may cost you a wasted round trip. It must never cost you a sale that a package upgrade would have allowed.
262
-
263
- **What changed for you**
264
-
265
- - Amounts between `999.99` and `999999.99` are now sent instead of being rejected locally. Nothing that worked before stops working; the validation only loosened.
266
- - `err.isAboveCardMaximum` is unchanged and still means what it always meant, but it now arrives only from INVO (a `400`), never from the SDK. Nothing was charged.
267
- - An amount above `999999.99` now throws `INVALID_INPUT` where it previously threw `ABOVE_CARD_MAXIMUM`. That range is malformed input, not a policy refusal, and INVO classifies it the same way.
268
-
269
- **When INVO refuses an amount the SDK allowed**, catch `err.isAboveCardMaximum`. `err.message` carries the figure that was in force for that request, for example "Card purchases must be $100,000.00 or less." Do not retry it unchanged: lower the amount, split the sale, or ask INVO to raise the setting. The live figure for a tenant is also the `max_amount` of the hosted checkout's `validate-game` read, next to `min_amount`; read that if you want to show a limit in your own UI, and re-read it, because it can change under you. A velocity limit is a `429` with `err.retryAfter`, not this error.
270
-
271
- **README: the minimum is $0.50.** The docs said only `0 < x <= 999.99` and left the floor unstated. They now state $0.50, which is what INVO advertises and what the card rail actually enforces. A $1.00 minimum was advertised by INVO's own checkout read until 2026-09-18 and was enforced nowhere; it is gone rather than enforced, because enforcing it would newly refuse charges between $0.50 and $0.99 that settle today.
272
-
273
- No export was added, removed, renamed or retyped.
274
-
275
- ## 3.11.0
276
-
277
- ### Minor Changes
278
-
279
- - The purchase status read, and the subscription fee is 7%.
280
-
281
- **A buyer can always be told what happened to the money they paid.** `invo.checkout` (and the standalone `CheckoutClient`, for a page with no player token) reads `GET /api/checkout/sessions/<id>`, authenticated by the SESSION token; the id in the path is a label, not a credential. `getPurchaseStatus({ sessionId, sessionToken })` reads once; `waitForPurchase({ ..., intervalMs, timeoutMs, maxAttempts, signal, onUpdate })` polls until INVO says it is finished and returns that result. Six statuses, four of them terminal, plus `orderId`, `coinsCredited` / `transactionId` / `newBalance` on a credit, `reasonCode` + a player-safe `message` on a refusal, and both money figures (`amountChargedUsd`, `listedUsd`) so a buyer billed 206.29 for a 200 pack can be shown where the 6.29 went.
282
-
283
- `terminal` is read off the response and is NEVER recomputed from `status`, so a status a later backend introduces cannot make this build decide a purchase finished, or finished well. A status it does not recognise is not terminal and is never a success. `paid_pending_credit` is deliberately not terminal at any age: INVO's reconciler recovers a stalled credit. A failed poll is not a failed purchase: network, timeout, 429 and 5xx are polled through; 401, 403 and 410 are raised at once (`isWrongSessionPurpose`, `isCheckoutSessionMismatch`, `isCheckoutSessionExpired`). On the cap `waitForPurchase` returns the last result it read rather than throwing, so the page keeps showing something true.
284
-
285
- `CheckoutPurchaseStatus` is a widened union (`… | (string & {})`), not a literal one, and a tsc test pins that partner code storing or comparing an unknown status still compiles, which is the fix 3.10.0 had to make to `RefundResult` after the fact. It is named `Checkout…` because `PurchaseStatus` is already the direct `purchaseCurrency` result and is unchanged. New: `CheckoutClient`, `InvoClient.checkout`, `isPurchaseCredited` / `isPurchaseRefused` / `isPurchaseRefunded` / `isPurchaseExpired`, `nothingWasCharged` (true only where INVO said no money was taken; everything else, an unknown code included, happened after the card was charged, so never put a Try again on it), and the types `PurchaseStatusResult`, `PurchaseStatusInput`, `WaitForPurchaseInput`, `PurchaseRefusalReason`, `PurchaseCredited` / `PurchaseRefused` / `PurchaseRefunded` / `PurchaseExpired`, `CheckoutClientConfig`.
286
-
287
- `createCheckout()` now also returns `sessionToken`, read from INVO's `session_token` field (backend commit `856fa266`) and falling back to the `checkout_url` query string only for a server that predates it, so nothing has to parse a URL to use the read. The two cannot disagree, and if a response ever carried both and they differed the field wins, because a query-key spelling is not a contract.
288
-
289
- **Doc fix: INVO's subscription fee is 7% plus $0.30, not 10%** ($9.99 pays INVO $1.00 and you $8.99). Subscriptions became their own rate on 2026-09-17; item purchases stay at 10/90. No code change.
290
-
291
- **Not included: withdrawals.** INVO's withdrawal request and history reads gained additive `kyc_hold`, `kyc_hold_reason` and `next_steps` fields on 2026-09-17. This package exposes no withdrawal surface at all, so there is nowhere for them to go, and adding one is a separate decision rather than part of a documentation pass.
292
-
293
- **Fixed: the User-Agent version had drifted.** `SDK_VERSION` was left at `3.10.0` when 3.10.1 published, so every server call from 3.10.1 reported a version that was not the one running, and the test pinning it to `package.json` was failing on `main`. Back in step, and the pin is green.
294
-
295
- ## 3.10.1
296
-
297
- ### Patch Changes
298
-
299
- - `linkDevice()` takes no arguments. The server mints the link id, so requiring one was wrong: callers had to invent a placeholder. The parameter stays optional and any value passed is still sent and ignored by the server, so code written against 3.10 keeps working unchanged. The README now also states that a tenant whose players enrol a passkey on the tenant's own domain MUST offer `linkDevice()`, because that credential can only be asserted on that tenant's origin, and that recovery is never the answer to `ENROLLMENT_REQUIRES_PROOF`.
300
-
301
- ## 3.10.0
302
-
303
- ### Minor Changes
304
-
305
- - f66103c: Card-only subscriptions and subscription refund guardrails (INVO backend, 2026-09-17). Everything here is additive: no field, type or behaviour of an existing call was removed or renamed.
306
-
307
- **Card-only subscriptions (behaviour change on INVO's side, no type changes).** A card subscription's card is now charged the full price every period; the member's coin wallet never pays for it and never moves. Steam subscriptions are unchanged (wallet first, Steam tops up the shortfall).
308
-
309
- - `subscription.renewed` on the card rail: `funding.balance_applied_coins` is always `"0.00"`, `funding.card_charged_usd` is the price, `mint_order_id` is never `null`.
310
- - Every paid card renewal also emits `purchase.completed` with `data.metadata.source === "subscription_renewal"`. Do not grant currency from it; `subscription.renewed` is the entitlement signal.
311
- - A member with no saved card fails with `failure_code: "no_payment_method"` whatever their balance. New additive `failure_code`: `wallet_negative`.
312
- - `walletOnly` is marked `@deprecated` (still accepted and returned): a wallet-only card subscription can never be paid (`failure_code: "wallet_only"`).
313
- - `subscription.authentication_required`: `card_amount_usd` now equals `amount_due_usd` on card challenges.
314
- - Doc fix: the `amountUsd` JSDoc now states the per-charge ceiling of `25000.00` (it still said `500.00`), and `SubscriptionExpiredData` no longer says `steam_containment` is sent.
315
-
316
- **Subscription refund guardrails.**
317
-
318
- - `subscriptions.refund` can now return a refund request. `RefundResult` stays a single interface (its `status` is typed `"refunded" | "pending_approval" | (string & {})`, so any string still assigns and compares); branch with the new `isRefundPendingApproval(r)` type guard, which narrows to `RefundPendingApproval`. `"pending_approval"` is the new HTTP 202: the refund would exceed the game's daily self-serve limit ($500 by default), nothing moved, and INVO reviews it as a refund request (`requestId`, `requestStatus`, `requestedAmountUsd`, `requestedAt`, `dailyCapUsd`, `executedTodayUsd`, `message`). Both carry every receipt field; the `request*` fields are optional on `RefundResult` and required on `RefundPendingApproval`. The status string is passed through from INVO unchanged.
319
- - New optional result fields: `warnings` (`REASON_RECOMMENDED`, `REASON_TRUNCATED`), `subscriptionCanceled`, `subscriptionStatus`, `processingFeeUsd`, `processingFeeBasis`, `processingFeeBorneBy`, `processingFeeTransactionId`, `partnerTotalReversedUsd`, `initiation`, `refundRequestId`. `undefined` on receipts stored before the change.
320
- - `reason` is documented as recommended now and required after a notice period. Refunds run within 30 days of the charge. A full refund cancels the subscription. Card-only periods are refunded in cash, partial included. The partner bears the card processor fee. INVO emails the member.
321
- - New `InvoError` classifiers: `isRefundsNotEnabled` (403), `isRefundWindowClosed` (409), `isRefundRequestPending` (409), `isRefundRequestRejected` (409), `isConcurrentRequest` (409), `isRefundMismatch` (502), with body accessors `refundRequestId`, `decisionReason`, `periodChargedAt`, `refundWindowDays`, `refundWindowClosedAt`.
322
- - New webhook types: `subscription.refund_requested`, `subscription.refund_approved`, `subscription.refund_rejected` (`SubscriptionRefundRequestData`, `SubscriptionRefundApprovedData`, `SubscriptionRefundRejectedData`). Additive fields on `subscription.refunded` (`refund.processing_fee_*`, `refund.partner_total_reversed_usd`, `initiation`, `refund_request_id`, `subscription_canceled`) and `subscription.canceled` (`cancel_cause: "full_refund"`).
323
- - New exports: `isRefundPendingApproval`; types `RefundReceipt`, `RefundPendingApproval` (both extend `RefundResult`), `RefundWarning`, `RefundInitiation`, `RefundProcessingFeeBasis`.
324
-
325
- **Compatibility.** Additive only. Code that compares `status` to any string, builds `RefundResult` mocks with a `string` status, or `extends`/`implements` `RefundResult` keeps compiling (pinned by a tsc test). `subscription.refunded`, `subscription.refund_approved` and, on a full refund, `subscription.canceled` are sent together and may arrive in any order.
326
-
327
- README: the Subscriptions section states card-only funding, the renewal `purchase.completed` trap, the refund limits and the 202, the new events and classifiers, and "what did I earn" now subtracts `partner_total_reversed_usd`.
328
-
329
- ## 3.9.0
330
-
331
- ### Minor Changes
332
-
333
- - The INVO-hosted card page is the recommended way to save a card for a subscription.
334
-
335
- New on `invo.cards`:
336
-
337
- - **`createSetupSession({ playerEmail, successUrl?, cancelUrl?, metadata? })`** ->
338
- `{ sessionId, cardSetupUrl, expiresAt, raw }` (`POST /api/checkout/card-setup-sessions`,
339
- game secret header). Mint a 10-minute link server-side, send the member to `cardSetupUrl`
340
- (top-level, never framed), and read the saved card's `id` back from `cards.list`; it appears
341
- there immediately, carries the off-session consent a subscription needs, and no event fires
342
- for it. No browser code, no client secret, no card processor named anywhere, so INVO can change
343
- processor without partners changing anything. Never auto-retried: each call mints a fresh link.
344
- Script-scheme `successUrl` / `cancelUrl` values are refused before the network (`INVALID_INPUT`,
345
- status 0), matching INVO's own rule.
346
- - `beginSetup` / `confirmSetup` are now documented as the **processor-bound alternative**: they
347
- hand back a `clientSecret` only the current processor's client library can consume, so a card
348
- form built on them needs rework when INVO changes processor.
349
-
350
- New error classifiers: `isPlayerNotFound` (404 `PLAYER_NOT_FOUND`: the card page never creates
351
- players), `isInvalidPlayerEmail` (400 `INVALID_PLAYER_EMAIL`), `isInvalidInput` (`INVALID_INPUT`,
352
- at status 0 from the SDK's own guards or 400 from INVO for a script-scheme URL).
353
-
354
- Fixed: `subscriptions.get(id, { includePlayer: true })` never populated `player`. INVO puts
355
- `player_email` / `player_name` on the subscription object itself, not in a separate block; they
356
- are now surfaced as `subscription.playerEmail` / `subscription.playerName`, and `player` is
357
- derived from them.
358
-
359
- README: a "Cards for subscriptions" section a partner can follow start to finish (mint, send,
360
- read the card back, subscribe, what each error means, the 10-minute session, no browser code).
361
-
362
- README corrections that ride along in this release: `subscription.expired` no longer carries
363
- `failure_code: "steam_containment"` (a balance is spendable in any title whatever rail bought
364
- it, so the "wallet value that cannot be spent in this game" deferral is gone from the deferrals
365
- paragraph and the event table); the Steam transfer-policy note now says it is a rule about
366
- currency moving between titles, not about spending (an item purchase never fails on origin);
367
- and "game" reads "title" in a few places so a platform tenant is not misled by the word.
368
- Line endings: a `.gitattributes` (`* text=auto eol=lf`) keeps the packed README, CHANGELOG and
369
- package.json LF on every checkout (3.9.0's first build packed CRLF from a Windows checkout).
370
-
371
- ## 3.8.1
372
-
373
- ### Patch Changes
374
-
375
- - Subscription docs: the per-charge ceiling is 25000.00, not 500.00, and it is
376
- per CHARGE rather than per month. An annual plan bills the whole year in one
377
- go, so a $500 a month plan sold as a 12-month plan is a single $6,000 charge
378
- and is chargeable. The old number quietly refused every annual plan above
379
- $41.66 a month.
380
-
381
- ## 3.8.0
382
-
383
- ### Minor Changes
384
-
385
- - Subscriptions are a first-class server surface, on both rails, with the card capture and the
386
- sandbox clock tools beside them.
387
-
388
- New on `InvoServer`:
389
-
390
- - **`invo.subscriptions`**: `create` (card rail; charges the first period before answering,
391
- idempotent on `clientRequestId`, a repeat is a typed `idempotentReplay: true` result),
392
- `get`, `listForPlayer`, `cancel` (an already-terminal row is a 200 `alreadyCanceled`, never
393
- thrown), `changeAmount` (staged for the next renewal), `setPaymentMethod`, `refund`
394
- (idempotent; the receipt replays), `steamInit` and `steamFinalize` (Steam rail;
395
- `alreadyProcessed` is a result, not an error).
396
- - **`invo.cards`**: `beginSetup` / `confirmSetup` / `list`: the off-session card capture a
397
- card subscription needs. The hosted checkout does not save a card for subscriptions.
398
- - **`invo.sandbox.subscriptions`**: `advanceClock` / `forceRenewal` / `forceFailure` /
399
- `forceAuthChallenge`. These post to `/subscriptions/<id>/...` **relative to the sandbox
400
- base URL, not under `/api`**, and send `X-Sandbox-Clock-Key` from the new
401
- `sandboxClockKey` config; a missing key throws before the network.
402
-
403
- Typed results: `SubscriptionResult` (the subscription object with its TWO clocks,
404
- `firstCharge` with `paidPeriodSeq`, `card`, `idempotentReplay`), `FirstCharge` (`paid` |
405
- `requires_action` | `skipped_trial` | `failed` | `pending` | `pending_authorization`),
406
- `SteamInitResult` (`steamOrderId` for the client callback, `amountCoins`, `pendingReuse`),
407
- `CancelResult`, `ChangeAmountResult`, `RefundResult`, `CardSetupResult`, `SandboxClockResult`
408
- (`engineStats`), and typed `data` for all seven `subscription.*` webhook events.
409
-
410
- Error classifiers: `isActiveSubscriptionExists` (+ `existingSubscriptionId`),
411
- `isIdempotentReplayMismatch` (+ `mismatchedFields`), `isSteamReauthorizationRequired`,
412
- `isNotACardSubscription`, `isSteamChannelRequired`, `isSubscriptionTerminal`,
413
- `isNotAuthorized`, `isSandboxClockUnauthorized`, `isSteamRefundNotSupported`, `isFlowPaused`,
414
- `isGameNotLive`; `isSteamAuthorizationPending` now also covers the subscription 409.
415
-
416
- Also: the server `User-Agent` version now derives from the package version (it had read
417
- `3.0.0` since 3.0.0), pinned by a test.
418
-
419
- ## 3.7.0
420
-
421
- ### Minor Changes
422
-
423
- - Device approval grant (RFC 8628) is now a first-class server surface — including **the
424
- step that moves the money**.
425
-
426
- An integrator followed the README, polled a grant to `approved`, and stopped. Nothing
427
- moved: an approved grant is a _factor_, and the transaction sat at
428
- `pending_pin_verification` until it expired and was refunded. The README's section ended
429
- at the poll and neither package had a method for the step after it. Both halves of that
430
- are fixed here.
431
-
432
- New on `InvoServer` (all authenticate with the **player token** — on a console the game
433
- server holds the token it minted, and the game secret is never sent):
434
-
435
- - `beginDeviceApproval({ playerToken, transactionId, flow, channel? })` → the RFC 8628
436
- §3.2 grant (`deviceCode`, `userCode`, `verificationUriComplete`, `expiresIn`,
437
- `interval`, `channel`). `channel: "popup"` is refused before the network — it is
438
- browser-only (`InvoClient.approveHosted`).
439
- - `pollDeviceApproval({ playerToken, deviceCode })` → a typed outcome
440
- (`authorization_pending` / `slow_down` / `approved` / `access_denied` /
441
- `expired_token`), plus the `enrollment` object while a first-time phone waits on the
442
- game screen. `invalid_grant` throws.
443
- - `confirmDeviceEnrollment({ playerToken, deviceCode, decision })` → answers the
444
- on-screen match-code prompt (`"approve"` | `"deny"`).
445
- - **`approveWithDeviceCode({ playerToken, transactionId, flow, deviceCode })` — the money
446
- step.** Routes by flow: `send` → `/api/sdk/send/{id}/approve`, `transfer` →
447
- `/api/sdk/transfers/{id}/approve`, `send_receipt` →
448
- `/api/sdk/send/{id}/confirm-receipt`, `transfer_receipt` →
449
- `/api/sdk/transfers/{id}/confirm-receipt`. Never auto-retried.
450
- - `completeDeviceApproval(...)` — convenience loop: polls honouring `interval` and
451
- `slow_down`, surfaces the enrollment prompt, then calls `approveWithDeviceCode`.
452
-
453
- **`TRANSACTION_NOT_PENDING` is a result, not a throw.** `approveWithDeviceCode` returns
454
- `{ status: "not_pending", alreadySettled, currentStatus }` so "your earlier attempt
455
- already landed" is distinguishable from a real refusal **without string-matching** — the
456
- difference between "the guard worked" and "her currency is stuck". Every other refusal
457
- stays a typed thrown `InvoError`.
458
-
459
- `alreadySettled` is **flow-aware and fails closed**. The four endpoints gate on different
460
- status sets — the sender approves accept `pending_pin_verification` /
461
- `pending_verification`, the two receipt endpoints accept `pending_claim` / `verified` — so
462
- a receipt settle landing on `pending_pin_verification` means the SENDER has not approved
463
- yet (possibly held at a guardian 202). That is _before_ the step, not past it, and calling
464
- it settled would tell a game to hand over goods for value never credited. It is an
465
- allow-list per flow rather than a "not expired/failed" deny-list, so a status INVO adds
466
- later answers `alreadySettled: false` with `currentStatus` set — go read the transaction —
467
- instead of defaulting to "the money moved" in already-deployed copies of this SDK.
468
-
469
- Older backend bodies that carried only the message ("Transaction not pending…", "…cannot
470
- be confirmed…") with no machine code are matched too, but narrowly: HTTP 400, one of those
471
- two phrases, **and** a readable `(current status: …)` / `(status: …)` clause. "cannot be
472
- confirmed" is ordinary English, so a phrase match alone can never assert that money moved.
473
-
474
- New `InvoError` predicates: `isTransactionNotPending`, `currentTransactionStatus`,
475
- `isDeviceApprovalNotApproved`, `isDeviceApprovalAlreadyPending`,
476
- `deviceApprovalExpiresAt`, `isSettleFault`, `errorRef`. The RFC 8628 §3.5 tokens are
477
- promoted onto `err.code`.
478
-
479
- Two safety fixes in `completeDeviceApproval`: `transactionId` is validated **before** the
480
- loop (an empty id used to poll for minutes, let the player approve, and only then throw —
481
- an approved grant with nothing settled), and the `respond` callable handed to
482
- `onEnrollment` now resolves quietly for every "the prompt is moot" refusal
483
- (`expired_token`, `invalid_grant`, and the two enrollment 409s) instead of rejecting. A
484
- prompt on a TV routinely outlives its ten-minute grant, callers fire `respond` without
485
- awaiting it, and an unhandled rejection exits a Node process.
486
-
487
- README: the console section is rewritten around begin → show the QR → poll → **call
488
- `approveWithDeviceCode`** → webhooks, with the supersede-vs-409 begin semantics corrected
489
- and "consumed when used" replaced by _when_ the code is spent. A new top-level **Sends and
490
- transfers, stage by stage** section covers both flows and both sides with a
491
- call-order table, an error table, and a common-mistakes box led by "polling to `approved`
492
- and stopping". The error tables now also carry the receipt-flow-only refusals a console
493
- recipient meets (`receiver_not_enrolled_use_claim_code`, `not_intended_receiver`, the
494
- phone-share 409, `RECIPIENT_IDENTITY_PENDING` / `_DECLINED`) and a warning that a settle
495
- FAILURE is ambiguous about the money — INVO commits and then reads the transaction back to
496
- build its 200, so a `*_FAILED` or a timeout can both describe money that already moved:
497
- read the transaction status before telling the player it failed, and never auto-start a
498
- replacement. SMS is now confined to a clearly-labelled legacy-fallback subsection.
499
-
500
- ## 3.6.0
501
-
502
- ### Minor Changes
503
-
504
- - New: `InvoClient.approveHosted({ transactionId, flow })` — web games approve on INVO's
505
- hosted identity page. The browser is the RFC 8628 client: with the player token it already
506
- holds, the SDK calls `POST /api/sdk/approvals/device/begin` with `channel: "popup"` (INVO
507
- records the page's `Origin` as the popup's opener), opens the hosted page in a popup
508
- (synchronously, inside your click handler), polls `poll` honouring `interval` and
509
- `slow_down` (+5 s), drives the INVO-branded match-code prompt from the poll's `enrollment`
510
- object ("Set up INVO on iPhone? Code 48-27. Say Yes only if the phone you just
511
- scanned/opened shows this code." → `confirm-enrollment`; `confirmed` shows "Finishing on
512
- iPhone… / Stop it, wrong code"; a 409 already-decided takes it down quietly), and when the
513
- poll says `approved` calls the flow's approve endpoint with the `device_code` —
514
- `transfers/{id}/approve`, `send/{id}/approve`, `send/{id}/confirm-receipt`,
515
- `transfers/{id}/confirm-receipt`. Resolves `{ status: "approved", approval }` (the same
516
- `ApproveResult` / `ConfirmReceiptResult` the in-app calls return) or `denied` / `expired` /
517
- `closed` / `blocked` / `redirected`; rejects with `InvoError` when the backend refuses.
518
- `device_code` lives in the call's closure only — never on the result, never logged. The
519
- page's `postMessage` is a wake-up that triggers an immediate poll (accepted only from the
520
- hosted page's https origin and only from the popup the SDK opened), never a result. A
521
- popup blocked by the browser resolves `blocked` before anything is started (default);
522
- `popupBlocked: "redirect"` opts in to a full-tab redirect. A page sending
523
- `Cross-Origin-Opener-Policy: same-origin` is detected and reported as `blocked` with a
524
- hint. Your server does nothing new; its `device_approval.approved` webhook still fires.
525
- In-app partner-domain passkeys are unchanged and remain supported. `onEnrollment(e,
526
- respond)` + `renderPrompt:false` let a game draw its own prompt.
527
-
528
- Docs: new "Web games — approving on INVO's hosted page" section; the console-flow poll
529
- example now shows `match_code`. Test-only devDependency added: `happy-dom`.
530
-
531
- Docs (hosted identity pages, Phase 7): the console section documents `channel` on
532
- `begin` (`qr` default | `popup` — the browser must call `begin` itself, its https `Origin`
533
- becomes the popup's opener, server-to-server callers are refused | `app_browser` — the
534
- mobile plugins; the return scheme `invo-sdk-<game_id>` is derived server-side), the echoed
535
- `channel` on the begin body, `recovery` on the poll's `enrollment` object, the hosted
536
- passkey-recovery flow (screen confirm + emailed single-use link → old INVO passkeys
537
- deactivated, `identity.passkey_reset` webhook, 24-hour `PASSKEY_RECOVERY_COOLDOWN` on
538
- money out; receiving unaffected), the mobile auto-confirm note (`app_browser` enrolment is
539
- confirmed by INVO, no prompt), and `ENROLLMENT_REQUIRES_PROOF` on the page. Sends &
540
- transfers: guardian approval now goes by email first (`consent_channel` and
541
- `resend_endpoint` on the raw 202 `guardian_approval` block; `decision_source: "email_link"`),
542
- the once-per-approval `POST /api/sdk/approvals/guardian/{approvalId}/resend` `{channel:"sms"}`
543
- contract (initiator's token; 403/409/410/503 codes), and phone-share / recipient-identity
544
- consents on the same hosted page (unchanged 409 / 202 codes, `consent_channel` on the
545
- phone-share body). Passkeys: the partner-domain freeze — new titles have nothing to verify
546
- (`409 PARTNER_RP_FROZEN`; `WEBAUTHN_NOT_ENABLED_FOR_TENANT` is the expected state, use
547
- `approveHosted`), tenants with a domain verified before the freeze keep it, removal is
548
- irreversible. The "SMS first, then email" fallback sentence corrected to "email first, SMS
549
- on request". Documentation only.
550
-
551
- ### Patch Changes
552
-
553
- - Docs: the device-approval page (RFC 8628, consoles / TVs / native Steam and desktop
554
- clients) now enrols the player's INVO passkey on the **first** scan, and the proof is the
555
- game screen: the phone says "confirm on your game screen", the game shows "Set up INVO on
556
- this phone: iPhone?", the player presses Yes on the console, and the phone's biometric
557
- creates the passkey and approves — no code to type, no SMS; every later scan is scan,
558
- biometric, done. The "the player needs an INVO passkey" bullet is replaced accordingly.
559
- Documents the two integrator-facing additions: the `enrollment` object
560
- (`state` / `device_label` / `requested_at`) on the `authorization_pending` poll body while
561
- a phone is waiting, and `POST /api/sdk/approvals/device/confirm-enrollment`
562
- (`{device_code, decision: "approve" | "deny"}`, same auth as begin/poll; deny ends the
563
- grant with `access_denied`), plus the backup email. Also documents two backend
564
- behaviours: `begin` extends the transaction's own approval window past the code's expiry
565
- (`transfer` / `send`), and `begin` may be called again for the same transaction once an
566
- approved code's window has passed. Documentation only — no code or type changes; the
567
- `begin`/`poll` endpoints, the `device_approval.approved` webhook and its `method` value
568
- are unchanged.
569
-
570
- Also on the send side: the claim SMS now carries a link to a hosted INVO claim page where
571
- a recipient without the game collects with one email + an emailed code + their phone's
572
- passkey (in-game claim unchanged; `transfer.received` fires the same); documents the
573
- sender-token REST call `POST /api/sdk/send/{transactionId}/resend-claim` (30-second
574
- cooldown, 10 per transaction per hour — no SDK method); and that an uncollected send is
575
- still refunded at 24 hours but the sender is now emailed and the recipient texted, with
576
- `transfer.claim_expired` / `transfer.refunded` as the source of truth. The `transfer.*`
577
- rows were added to the event-types table.
578
-
579
- - df2efe9: Docs: add an explicit per-platform verification/approval recommendation. The
580
- "gold standard" section now spells out which method fits which client — a passkey
581
- directly on mobile app/web and desktop web, and the QR device-approval flow
582
- (RFC 8628) on consoles **and** on native Steam / desktop game clients (Mac &
583
- Windows), where it is the embedded game client, not the OS, that can't invoke the
584
- platform authenticator. Also documents the SMS-first-then-email fallback for
585
- remote approvals with no passkey path. Documentation only — no code or type
586
- changes; the `VerificationMethod` union and the device-approval REST flow are
587
- unchanged.
588
-
589
- All notable changes to `@invonetwork/web-sdk` are documented here. This project follows
590
- [Semantic Versioning](https://semver.org/). Releases are managed with
591
- [changesets](https://github.com/changesets/changesets).
592
-
593
- ## [3.5.0] - 2026-09-01
594
-
595
- **The Steam purchase flow is now first-class SDK surface: `steamPacks()`, `steamInitPurchase()`, `steamFinalizePurchase()`** — plus browser-based checkout for platforms where the Steam overlay does not render, a finalize-poller error taxonomy, and webhook `channel` typing. No breaking changes.
596
-
597
- Until now the SDK only _steered away_ from Steam (`purchaseCurrency` fails fast on `rail: "steam"`); the dedicated endpoints had to be called by hand. All three are typed methods now, and the fail-fast message names them.
598
-
599
- ### Added
600
-
601
- - **`InvoServer.steamPacks(query?)`** — the pack catalogue. `currencyAmount` is per-player (VAT and the storefront's revenue share come out of the sticker before currency is derived — a $4.99 pack yields 34, not 50, units at $1 = 10). Render it verbatim; never compute currency from price and never cache one answer for all players.
602
- - **`InvoServer.steamInitPurchase(input)`** — start the purchase. Idempotent on `purchaseReference` (retries, including manual retries after a 409, MUST reuse it). New authorization modes:
603
- - `usersession: "client"` (default, unchanged): Steam overlay in-game. The SDK sends **no** `usersession` key at all in this mode, pinned by test, so existing behaviour cannot shift.
604
- - `usersession: "web"`: for platforms where the overlay does not render (observed: Electron on macOS). Requires `playerIp` — the PLAYER's address, never your server's; refused client-side before the network without it. Returns `steamCheckoutUrl`: Steam's own hosted approval page, which must open as a **top-level tab** (it cannot be iframed). _Note: Steam's sandbox issues checkout URLs its production host will not serve, so web-session approval is provable only against production; the rest of the flow is identical to client-session._
605
- - `metadata` — echoed on the `purchase.completed` webhook (`data.metadata`) — the way to correlate your own player/order ids. The Steam rail merges its own context keys (`steam_wallet_currency`, `steam_country`, `steam_account_status`, `vat_rate_pct`) into the echoed object; avoid those names in yours.
606
- - **`InvoServer.steamFinalizePurchase({orderId})`** — capture + credit. Idempotent: a replay returns `alreadyProcessed: true` and never credits twice.
607
- - **Finalize poller taxonomy on `InvoError`** — because _not every 409 means "not yet"_, and a poller that assumes so polls a dead order forever:
608
- - `isSteamAuthorizationPending` — player has not approved yet (Steam reports `Init`). The normal wait state; poll again.
609
- - `isSteamAuthorizationDead` — any settled status — `Cancelled`, `Failed`, `Refunded`, `Chargedback`, and every other non-Init outcome (pending is the CLOSED set: only `Init` means "not yet"). Stop; no later call can succeed.
610
- - The two are mutually exclusive by construction, and a test pins that they can never both answer true.
611
- - **`InvoError.isPartnerCreditUnavailable`** (`PARTNER_CREDIT_UNAVAILABLE`, 409) — the studio's settlement float cannot cover the purchase. Structure is fine; the money is not. Plain failure toast; do **not** hot-poll init (each attempt briefly re-reserves headroom), and reuse the same `purchaseReference` on manual retry.
612
- - **`InvoError.isPartnerRailSuspended`** (`PARTNER_RAIL_SUSPENDED`, 409) — terminal from the game's seat. The umbrella `isPartnerSettlementUnavailable` still covers both.
613
- - **`InvoError.isUnknownSteamPack`** (400) — re-fetch `steamPacks()`; the body's `valid_pack_ids` lists what exists.
614
- - **`InvoError.isMissingPlayerIp`** (400) — always an integration bug on web sessions.
615
- - **`PurchaseCompletedData.channel`** — which storefront the purchase came from (`"steam"` / `"ios"` / `"android"` / `"web"` / `"console"`), beside `rail`. `null` means a legacy game key: a real answer ("unattributed"), read it as one.
616
-
617
- ### Changed
618
-
619
- - `purchaseCurrency`'s `rail: "steam"` fail-fast message now names the real methods instead of vaguely citing "dedicated endpoints".
620
-
621
- ## [3.4.0] - 2026-09-01
622
-
623
- **A Steam title now bills through its OWN Steam application.** New error helpers;
624
- no breaking changes to any existing method or type.
625
-
626
- ### Why this is a real change and not a doc tidy
627
-
628
- Steam pays whoever owns the Steam application. Until now, INVO documented a
629
- single INVO-owned Steam app that billed every title on the network — so a studio
630
- had nothing to register and the money reached them through INVO. That model is
631
- gone. Each title sells through the studio's own Steam app, the money lands in
632
- their own Steamworks account, and INVO issues the player's currency immediately
633
- and settles with the studio afterwards against a payment method on file.
634
-
635
- If you shipped against 3.3.0 or earlier and your Steam integration works today,
636
- nothing in your code needs to change. What changes is the **studio's** one-time
637
- setup, and the errors you may now see if they have not done it.
638
-
639
- ### Added
640
-
641
- - `InvoError.isSteamNotConfigured` — the title has no Steam application
642
- registered with INVO yet (`STEAM_NOT_CONFIGURED`, 503).
643
- - `InvoError.isPartnerBillingNotSetUp` — the studio has not finished INVO billing
644
- setup (`PARTNER_BILLING_NOT_SET_UP`, 409).
645
- - `InvoError.isPartnerSettlementUnavailable` — settlement suspended or over
646
- limit (`PARTNER_RAIL_SUSPENDED` / `PARTNER_CREDIT_UNAVAILABLE`, 409). Show a
647
- neutral "purchases are unavailable right now": it is not the player's problem.
648
- - `InvoError.isSteamAppChanged` — the order was started against a different
649
- Steam application than the title is configured for now (`STEAM_APP_CHANGED`,
650
- 409). Only reachable if a studio swaps apps mid-flight.
651
-
652
- All four are refused **before the player is charged**, which is the point.
653
-
654
- ### Changed
655
-
656
- - README: the Steam section now documents the studio's Steamworks setup
657
- (microtransactions enabled, a publisher-GROUP Web API key that includes the
658
- app, appid + key entered in the INVO dashboard, payment method on file).
659
- - README: removed the claim that no Steam-side registration was required.
660
-
661
- ## [3.3.0] - 2026-08-31
662
-
663
- **Documentation only. No code changes, no API changes.**
664
-
665
- Documents **Device Approval** — passkey step-up for consoles, TVs and any device
666
- with no browser. It is the OAuth 2.0 Device Authorization Grant
667
- ([RFC 8628](https://datatracker.ietf.org/doc/html/rfc8628)), so a standard
668
- client library understands the responses.
669
-
670
- - The device shows a short code and a QR (`verification_uri_complete`); the
671
- player approves on their phone; your **server** polls
672
- `POST /api/sdk/approvals/device/poll` until it hears back.
673
- - **One approval authorises one transaction.** Unlike the plain RFC 8628 grant,
674
- which authorises a _client_, an INVO device code is bound to the transaction
675
- you named and is consumed when used — it cannot approve anything else and
676
- cannot be reused.
677
- - `user_code` is meant to be seen; `device_code` is not. Poll from your backend.
678
- - Subscribe to `device_approval.approved` to learn the moment an approval lands
679
- instead of waiting for the next poll. Polling still works alone.
680
- - Available to every title with nothing to configure — the constraint is a
681
- property of the _device_, not the game, so a title with a website and a
682
- console build uses the normal ceremony in the browser and this one on console.
683
- - Currency purchases on a console go through that console's store, as the
684
- platform holder requires; this flow is for approving transfers and sends.
685
-
686
- Minor rather than patch because it documents a new API surface. The snippets are
687
- pinned by a test against this file, for the same reason the Steam ones are: a
688
- REST flow with no SDK method behind it is the one thing no other test can see.
689
-
690
- ## [3.2.3] - 2026-08-28
691
-
692
- **Documentation only. No code changes, no API changes.** Corrects two errors in
693
- the 3.2.2 Steam snippets that made them fail if copied.
694
-
695
- - **Base path.** The snippets said `/api/enhanced-purchase/...`. The routes are
696
- mounted at **`/api/currency-purchases/...`** -- `enhanced_purchase_api` is the
697
- module name, not the mount point. Copying 3.2.2 returned `404 Resource not
698
- found`, which reads like the Steam rail is unavailable rather than like a
699
- wrong URL.
700
- - **Auth header.** The snippets sent `X-Game-Secret`. The header is
701
- **`X-Game-Secret-Key`**, as it is everywhere else in this document. An unknown
702
- header is ignored, so the request arrived unauthenticated.
703
-
704
- Both were confined to the Steam section added in 3.2.2; every other snippet was
705
- correct. The Steam flow itself is unchanged -- pack catalogue, `pack_id`,
706
- VAT-aware amounts, all exactly as 3.2.2 describes.
707
-
708
- The paths and header are now pinned by a test against this file, because the
709
- Steam section is the one snippet with no SDK method behind it and so was the one
710
- thing no test could see.
711
-
712
- ## [3.2.2] - 2026-08-28
713
-
714
- **Documentation only. No code changes, no API changes.**
715
-
716
- Steam currency purchases now work on a **pack model**, and this documents it. The
717
- 3.2.1 notes described an earlier design that has been replaced -- read this
718
- instead.
719
-
720
- - **INVO owns the Steam pack catalogue.** You do not set prices and you never
721
- send an amount. Fetch `GET /steam/packs?steamid=...`, render it, and pass a
722
- `pack_id` to `/steam/init-purchase`. An amount is refused with
723
- `400 UNKNOWN_STEAM_PACK`.
724
- - **The price is identical everywhere; the currency inside is not.** Steam prices
725
- are VAT-inclusive wherever VAT is collected, so more of a fixed price goes to
726
- tax in a high-VAT country -- the same $9.99 pack yields 69 units in the US and
727
- 58 in France.
728
- - **Always pass `steamid`** when fetching the catalogue. Without it amounts are
729
- quoted with no VAT deducted, so a store promises more than the purchase
730
- delivers. Do not cache one catalogue for all players.
731
- - A Steam-distributed title may only sell currency on the `steam` rail
732
- (`409 STEAM_PURCHASE_LAYER_REQUIRED`), and a locked Steam account is refused up
733
- front (`409 STEAM_ACCOUNT_LOCKED`).
734
-
735
- Steam remains a server-to-server REST flow rather than an SDK method, because the
736
- purchase is authorised inside the Steam client and your game relays that.
737
-
738
- ## [3.2.1] - 2026-08-28
739
-
740
- **Documentation only. No code changes, no API changes.**
741
-
742
- Documents two things about the Steam rail that the SDK does not change but every
743
- Steam integration has to handle:
744
-
745
- - **Currency for a Steam-distributed title must be bought on the `steam` rail.**
746
- Any other rail is refused with `409 STEAM_PURCHASE_LAYER_REQUIRED`. This is a
747
- platform requirement and it applies across every storefront the title ships on,
748
- because a player's balance is shared between them.
749
- - **The player is charged more than the value you request.** Steam's platform
750
- commission is priced into the charge rather than absorbed, so the Steam
751
- init-purchase response now carries `charged_usd` alongside `value_usd`. Show
752
- `charged_usd` in your store. The currency the player receives is unchanged, so a
753
- pack is worth the same in-game on every rail, and the rate is configuration --
754
- read the response rather than hard-coding a multiplier.
755
-
756
- ## [3.2.0] — 2026-08-24
757
-
758
- **Storefront keys.** A game that ships on more than one storefront now gets one SDK
759
- key per storefront -- `steam`, `ios`, `android`, `web`, `console` -- all valid at the
760
- same time, and the key determines the payment rail. Construct one client per key and
761
- use whichever matches where the player is buying. **Additive: no behavior changes, no
762
- API removals.** A single existing key keeps working exactly as it does today, `rail`
763
- included, with no deadline and no migration.
764
-
765
- Three new typed error predicates for refusals this SDK previously surfaced only as a
766
- raw `code` string:
767
-
768
- - `InvoError.isRailChannelMismatch` -- the `rail` you sent disagrees with the storefront key
769
- you authenticated with (400). The fix is to stop sending `rail`; the key already
770
- determines it. INVO refuses rather than silently overriding, because overriding
771
- would bill a player through a route you did not ask for.
772
- - `InvoError.isSteamRailNotEntitled` -- a Steam purchase was attempted for a title INVO has
773
- not registered as distributed on Steam (403). Holding a `steam` storefront key does
774
- not by itself register the title.
775
- - `InvoError.isSteamPurchaseLayerRequired` -- a title distributed on Steam tried to sell currency
776
- on a non-Steam rail (409). Use the dedicated Steam purchase flow.
777
-
778
- Also in this release: the 3-D Secure completion method's documentation no longer names
779
- a payment processor. INVO does not name processors in developer-facing surfaces, and
780
- this line had been an exception to that for some time.
781
-
782
- Also in 3.2.0: **provider-neutral error codes.** INVO stamps a neutral alias
783
- (`error_code_public`) beside any machine code that carries a payment
784
- processor's name. This SDK previously read only the raw code, so a partner
785
- branching on `err.code` had to hard-code a vendor name INVO's own public
786
- documentation is not allowed to print. `err.code` is now the neutral alias when
787
- one exists (`STRIPE_ERROR` becomes `PROCESSOR_ERROR`), and the literal wire value stays reachable on
788
- `err.rawCode` for anyone already matching it. Refund reads prefer
789
- `processor_refund_reference` over the vendor-named field, with a fallback.
790
-
791
- **Storefront keys are still server-side keys.** A storefront key names where the
792
- _purchase_ came from, not where the key lives. It belongs in your backend exactly like
793
- your original key -- never in a game client, an app bundle, or browser code.
794
-
795
- ## [3.1.0] — 2026-08-04
796
-
797
- **Passkeys are the gold standard; the SMS-PIN path is deprecated.** This release makes INVO's
798
- authentication guidance explicit in the two places developers actually look — the README and IDE
799
- autocomplete. **No behavior changes, no API removals, no runtime warnings.** Upgrading and
800
- changing nothing produces byte-identical runtime behavior.
801
-
802
- A passkey is a phishing-resistant, origin-bound WebAuthn assertion. An SMS PIN is a shared secret
803
- on a channel exposed to SIM swap and interception. They were documented as interchangeable
804
- verification options; they are not, and the docs said so in a way that produced PIN-first
805
- integrations.
806
-
807
- ### Added — error-contract classifiers
808
-
809
- Three 403s that previously arrived as a generic `InvoError` (correct `status`/`code`/`message`,
810
- but no typed branch) now have classifiers:
811
-
812
- - **`err.isSourceGameNotLive`** — the caller's OWN game is in testing. Self-serve: switch it to
813
- Live in the console (Game Settings → Status).
814
- - **`err.isTargetGameNotLive`** — the DESTINATION game is in testing. Usually another
815
- developer's game, so the caller **cannot** fix it. **Deliberately distinct** from the source
816
- case: collapsing them into one "not live" branch yields a "go fix it" CTA that dead-ends half
817
- the time.
818
- - **`err.gameStatus`** — the `game_status` field from either refusal (e.g. `"testing"`).
819
- - **`err.isWebauthnNotEnabledForTenant`** — tenant has no verified WebAuthn RP ID. **This is
820
- configuration state, not a failure**: fall back to the SMS/in-app path instead of surfacing an
821
- error. Currently the common case — 4/23 sandbox and **0/3 production** tenants are configured.
822
-
823
- Note the backend splits field names across these: the `*_GAME_NOT_LIVE` pair uses
824
- `error_code`/`message`, while `WEBAUTHN_NOT_ENABLED_FOR_TENANT` uses `code`/`error`. The SDK
825
- already read both, so `err.code` is populated either way — the new tests pin both shapes.
826
-
827
- ### Clarified — the SDK does not, and did not, collapse non-2xx into transport errors
828
-
829
- Following a report of a `403` being debugged as a network outage: verified end-to-end that a
830
- non-2xx always surfaces with its real `status`, `code`, and `message`, and that `status: 0` is
831
- reserved for a genuine absence of an HTTP response. **No fix was needed in the SDK** — the loss
832
- happened in an integration-layer catch-all. Added regression tests pinning the behavior, plus a
833
- README section (**"`.status === 0` means 'no HTTP response' — and nothing else"**) showing the
834
- anti-pattern and the correct handler, and a note that `409` is a retryable not-ready state
835
- rather than a failure.
836
-
837
- ### Deprecated
838
-
839
- - **`InvoServer.verifySmsTransfer` / `InvoServer.verifySmsSend`** — marked `@deprecated`. They
840
- still work exactly as before and still hit the same endpoints. A **future major version will
841
- remove them**; no date is committed yet. Keep them only as a genuine last resort for users who
842
- cannot enroll a passkey (unsupported device, no platform authenticator) or who decline.
843
- **Migration:** when `initiateSend`/`initiateTransfer` returns `verificationMethod: "sms"`, read
844
- it as _"this sender has no passkey"_ — prompt `InvoClient.enrollPasskey()` and then
845
- `InvoClient.approveSend` / `approveTransfer`, instead of routing to a PIN pad.
846
-
847
- ### Changed (documentation only)
848
-
849
- - New README section — **"Passkeys are the gold standard — don't build on SMS"** — with the
850
- do/don't table, the deprecation notice, and an explicit list of the OTP surfaces that are
851
- **not** discouraged.
852
- - `VerificationMethod`, `InitiateResult.verificationMethod` and `SmsVerifyResult` doc comments
853
- reframed: `"in_app"` and `"sms"` are no longer presented as peer options.
854
- - "Before you go live" now stresses configuring RP ID / origins _before_ launch, since an
855
- unconfigured tenant silently drops every sender onto the deprecated path.
856
- - **New "Prerequisite: passkeys are dark until your tenant verifies a domain" subsection.**
857
- Recommending passkeys without saying what unlocks them would send developers straight into a
858
- `403` on their first `enrollPasskey()` call — with 0/3 prod tenants configured, that is
859
- currently _everyone_. The deprecation carries no removal date for the same reason.
860
- - Stability section corrected — it still claimed `2.0.0` was the only major, which `3.0.0`
861
- made false.
862
- - Design doc: `docs/features/passkey-first-authentication.md`.
863
-
864
- ### Not affected — still recommended
865
-
866
- `enrollmentBegin`/`enrollmentVerify`, `recoveryBegin`/`recoveryComplete`, and
867
- `phoneShareInitiate`/`phoneShareApprove` all involve a one-time code but are the on-ramp _to_ a
868
- passkey (or phone-ownership consent), not a substitute for one. They are **not** deprecated.
869
-
870
- ### Upgrade note
871
-
872
- The only way this release can surface in a pipeline is a lint rule that treats `@deprecated`
873
- usage as an error (e.g. `deprecation/deprecation` with `--max-warnings 0`). That is a lint-level
874
- signal, not a build or runtime break, and it is the intended notice.
875
-
876
- ## [3.0.0] — 2026-07-20
877
-
878
- **BREAKING — the Platform Commerce card leg moved to INVO's hosted checkout.** The backend now
879
- hosts the entire card flow (card fields, Apple Pay / Google Pay, billing-address collection,
880
- 3-D Secure) on its own checkout page, so the browser card-element surface shipped in 2.5.x is
881
- gone. Card sales are simpler AND safer: server creates → buyer pays on `checkoutUrl` → fulfill
882
- on the `platform_commerce.purchased` webhook. Note: the card leg is pending final enablement on
883
- the backend (sandbox payment test) — the balance leg is fully live.
884
-
885
- ### Migration from 2.5.x (card leg only — balance/status/refund/webhooks unchanged)
886
-
887
- - `platformCommerce.purchase({ fundingSource: "card" })`: **remove `billingAddress`** (the type
888
- is gone; the hosted page collects it) and optionally pass `successUrl` / `cancelUrl` /
889
- `metadata`. The result now carries `checkoutUrl` / `sessionId` / `expiresAt` (unix seconds) /
890
- `idempotentReplay` — **`clientSecret` no longer exists.**
891
- - Browser: **`confirmCardPayment` and `mountCardPayment` are removed** (with all card-element
892
- types and the `commercePublishableKey` config). Replace with a redirect
893
- (`location.href = checkoutUrl`) or the new optional embed:
894
- `invo.platformCommerce.mountCheckout(el, checkoutUrl, { onComplete })` — an iframe plus an
895
- origin-checked listener for the page's `INVO_CHECKOUT_COMPLETE` message.
896
- - Card duplicates no longer 409: retrying `purchase` with the same `clientRequestId` **replays
897
- the same checkout session** (`idempotentReplay: true`), so a lost response is recoverable.
898
-
899
- ### Added
900
-
901
- - `PlatformPurchaseInput.successUrl/cancelUrl/metadata`; result fields
902
- `sessionId/checkoutUrl/expiresAt/idempotentReplay`.
903
- - `InvoClient.platformCommerce.mountCheckout(el, checkoutUrl, opts)` → `{ iframe, destroy() }`.
904
- - `err.isAboveCardMaximum` (`ABOVE_CARD_MAXIMUM`, card > $999.99) + client-side card USD
905
- bounds fail-fast ($0.50–$999.99).
906
- - Card `requires_payment` responses without a `checkout_url` fail closed (`INVALID_RESPONSE`).
907
-
908
- ### Removed
909
-
910
- - `confirmCardPayment`, `mountCardPayment`, `commercePublishableKey`, `BillingAddress`, and the
911
- card-element/processor types + the runtime CDN script loader (no more processor touchpoints
912
- in this SDK at all).
913
-
914
- ## [2.5.1] — 2026-07-20
915
-
916
- Hardening patch from a second, independent post-release audit (correctness vs the backend
917
- blueprint + security red-team) of the 2.5.0 Platform Commerce feature. No API breaks.
918
-
919
- ### Fixed
920
-
921
- - **Card-confirm script loader could hang forever on retry.** After a transient CDN failure
922
- (or a pre-existing processor `<script>` tag whose events already fired), the next
923
- `mountCardPayment`/`confirmCardPayment` attached listeners to a dead tag and never settled —
924
- checkout silently dead until page reload. The loader now removes failed tags and polls
925
- (bounded, 10s) when a tag pre-exists.
926
- - **Orphaned card element on submit-lookup failure.** `confirmCardPayment` now destroys the
927
- mounted Payment Element before rethrowing when the `submit` selector can't be resolved
928
- (previously a retry stacked a second live card iframe).
929
- - **Billing-address validation errors no longer echo the submitted values** (cardholder PII
930
- could otherwise land in logs/Sentry); optional billing fields (`name`/`line2`/`state`) are
931
- now type-checked.
932
- - **`playerPhone` on `platformCommerce.purchase` is now E.164-validated** — this endpoint can
933
- create the player identity, so a national-format phone must never reach the wire.
934
- - **`err.isInsufficientBalance` now also classifies the zero-balance 400** ("Player has no
935
- balance in this tenant", which carries only `current_balance`).
936
- - **Breaker-open 503 keeps its human message** (`err.code === "service_unavailable"`, message
937
- no longer collapses to the bare token).
938
- - **Webhook types:** `platform_commerce.refunded` `player_email` is nullable + `identity_id`
939
- added; (2.5.0 already made card-leg `total_price` optional on `purchased`).
940
- - **Refund result surfaces `newBalance`** (balance leg) **and `processorRefundId`** (card leg)
941
- instead of leaving them `raw`-only.
942
- - Platform-commerce error tests now assert the REAL backend envelopes
943
- (`{status,error_code,message}` / bare `{message}`), not idealized shapes.
944
-
945
- ### Docs
946
-
947
- - Card-leg lost-response caveat on `purchase` (duplicate 409 can strand a `clientSecret`-less
948
- pending order — reconcile via webhook/`getStatus`, retry with a NEW `clientRequestId`).
949
- - `confirmCardPayment`: bank-redirect return-leg guidance + remount-after-decline note;
950
- `CardPaymentResult.raw` log-redaction note.
951
-
952
- ## [2.5.0] — 2026-07-20
953
-
954
- **Platform Commerce (ecommerce).** A new flow for **platform** tenants (non-game apps: vertical
955
- video, creator merch, marketplace) to sell items funded by **INVO balance or a real card**, with
956
- INVO as merchant of record and full refunds. This is **distinct from item purchase** — that is a
957
- _game_ tenant spending a player's _existing game currency_ on an _in-game_ item (balance only, no
958
- card, no refund). Additive; only platform tenants can call it (a game tenant gets `403
959
- NOT_A_PLATFORM_TENANT`). (Backend handoff: BE-PIP-009 `PLATFORM_COMMERCE_SDK.md`.)
960
-
961
- - **Server** (`InvoServer.platformCommerce`, mirrored in the Python SDK as
962
- `server.platform_commerce`):
963
- - `purchase(input)` — `fundingSource: "balance"` settles synchronously (`status:"success"`);
964
- `"card"` returns `status:"requires_payment"` + a `clientSecret` and **requires a
965
- `billingAddress`**. Idempotent on `clientRequestId`.
966
- - `getStatus(orderId)` — `completed` | `pending_payment` | `refunded`.
967
- - `refund({ orderId | clientRequestId, reason? })` — INVO retains its fee; a second refund
968
- throws `409` (`err.isAlreadyRefunded`).
969
- - **Browser** (`InvoClient.platformCommerce`):
970
- - `confirmCardPayment(clientSecret, { mount, publishableKey?, returnUrl?, submit? })` — mounts
971
- the card element and confirms; returns `{ status: "succeeded" | "requires_action" |
972
- "processing" | "failed" }`. The processor JS is **lazy-loaded from its CDN — no bundled
973
- dependency**; pass its publishable key (or set `commercePublishableKey` on the client config).
974
- - `mountCardPayment(clientSecret, opts)` — the primitive: `{ element, confirm(), destroy() }`
975
- to confirm from your own Pay button.
976
- - **Webhooks:** new typed `platform_commerce.purchased` / `platform_commerce.refunded` events.
977
- **Fulfill card orders on `platform_commerce.purchased`, never on the browser confirmation.**
978
- - **New `InvoError` classifiers:** `isNotPlatformTenant` (403), `isAmountBelowMinimum`,
979
- `isBelowCardMinimum` (card < $0.50), `isAlreadyRefunded` (409).
980
- - Docs: README now leads the flow list with an explicit **item purchase vs Platform Commerce**
981
- contrast; new "Platform Commerce (ecommerce)" section.
982
-
983
- ## [2.4.1] — 2026-07-10
984
-
985
- Docs only, no code change — corrects stale README prose that the 2.4.0 publish still carried:
986
- the status line led with an old version, and the Stability section still cited the `2.0.0`
987
- `playerPhone` requirement as the standing breaking change (2.2.0 relaxed it back to optional).
988
- Republished so the package-bundled README is accurate.
989
-
990
- ## [2.4.0] — 2026-07-10
991
-
992
- **Steam transfer policy.** Steam-purchased currency is locked to Steam titles; the backend now
993
- enforces this at transfer/send initiate and annotates destinations. Additive, and inert until a
994
- title is flagged Steam-distributed. (Design doc: `docs/features/steam-transfer-policy.md`.)
995
-
996
- - New `InvoError` classifiers on `initiateSend`/`initiateTransfer` 409s:
997
- `isSteamValueNonTransferable` (with `steamTransferableMax` / `steamOriginAmount` — decimal
998
- strings) and `isNonSteamValueIntoSteamBlocked`. Surface `err.message` verbatim.
999
- - New `DestinationGame.acceptsSteamOriginValue` (maps `accepts_steam_origin_value`; `false` when
1000
- omitted) — disable non-Steam destinations for a player holding Steam value so they never hit
1001
- the 409.
1002
-
1003
- No breaking changes.
1004
-
1005
- ## [2.3.0] — 2026-07-07
1006
-
1007
- **Claim-time phone-share approval.** The backend closed a security gap: claiming/collecting a
1008
- phone-routed transfer now authorizes the collecting identity against the receiver phone before
1009
- crediting. So `confirmReceiptSend`/`confirmReceiptTransfer` and `claimTransfer`/`claimCurrency`
1010
- can now return the phone-share `409 PHONE_SHARE_APPROVAL_REQUIRED` (previously only
1011
- registration/mint did). The existing `InvoError.isPhoneShareApprovalRequired` already classifies
1012
- it — no consumer code must change — but:
1013
-
1014
- - New **`InvoError.phoneShareLast4`** surfaces the `phone_last4` from the 409 body for the UI
1015
- ("we texted the phone ending 1234").
1016
- - `isPhoneShareApprovalRequired` docs + the `confirmReceipt*`/claim method docs + README now
1017
- spell out the claim-time path: it's **not a failure** — the funds are held and the phone owner
1018
- is texted; show `err.message` verbatim, then **retry the same call** once approved (it succeeds
1019
- idempotently); on denial/expiry the sender is refunded.
1020
-
1021
- Additive, no breaking changes; affects all rails' claim paths (transfer, currency send, amazon).
1022
-
1023
- ## [2.2.0] — 2026-07-07
1024
-
1025
- **Backend reconciliation** — a full audit of the SDK against the live backend surfaced three
1026
- places the SDK didn't match reality. All changes are backward-compatible (relaxing required
1027
- inputs / adding surface); no working call breaks.
1028
-
1029
- - **`mintPlayerToken` no longer requires `playerPhone`.** `/api/sdk/player-token` is a
1030
- session-token mint for an **existing** player (looked up by email) — not a registration call.
1031
- It reads only `player_email` and ignores `player_phone`. The 2.0.0 hard E.164 requirement was
1032
- a bug: it could **block a valid token mint for an existing email-only player**. `playerPhone`
1033
- is now optional and validated only if provided. Phone stays enforced where it matters — the
1034
- sender's phone on `initiateSend`/`initiateTransfer`, and at player creation.
1035
- - **Send by phone alone.** `receiverPlayerEmail` (send) and `targetPlayerEmail` (transfer) are
1036
- now **optional** — you can send to a recipient's phone; they supply their email at claim
1037
- (claim still requires it, since that's where the recipient establishes identity).
1038
- - **`getPlayerBalance` is by email only.** There is no by-`playerId` balance route on the
1039
- backend, so passing `playerId` threw a confusing 404. It now throws a clear `INVALID_INPUT`
1040
- pointing you to `InvoClient.getBalance()` (client-side) or `playerEmail` (server-side).
1041
- - **New `InvoError.isUserVerificationRequired`** for the `WEBAUTHN_UV_REQUIRED` (401) approve
1042
- failure — re-run the passkey ceremony requiring UV.
1043
- - Fixed `iterateItemPurchaseHistory` to read the backend's `total_count` pagination key (was
1044
- `total`; the loop already terminated via the short-page guard, so behavior is unchanged).
1045
-
1046
- **Migration:** none required. If you were passing `playerPhone` to `mintPlayerToken` it still
1047
- works; you can now also omit it. Replace any `getPlayerBalance({ playerId })` with an email
1048
- lookup or `InvoClient.getBalance()`.
1049
-
1050
- ## [2.1.2] — 2026-07-07
1051
-
1052
- **Hosted-checkout reconciliation** (the create-session API contract is unchanged; the hosted
1053
- page was rebuilt). Additive + docs only.
1054
-
1055
- - `createCheckout` now surfaces `expiresInSeconds` (the `checkout_url` token TTL, e.g. 900) as
1056
- a first-class field on `CreateCheckoutResult` — previously only on `.raw`.
1057
- - README: the `platform` rail is described as cards + Apple Pay / Google Pay / Link +
1058
- international billing (no app-store commission), and the checkout note now says reloading the
1059
- URL after a completed payment is idempotent (an already-complete success screen), not an
1060
- error. No API/signature changes.
1061
-
1062
- ## [2.1.1] — 2026-07-06
1063
-
1064
- **Security & correctness hardening** from a full audit + red-team of both SDKs. No API changes;
1065
- upgrade recommended.
1066
-
1067
- - **Fail closed on HTTP redirects (security).** The transport now sends `redirect:"manual"` and
1068
- throws `UNEXPECTED_REDIRECT` on any 3xx instead of following it. Previously a redirect from
1069
- the API host could cause the game-secret header to be re-sent to an unvalidated URL (matches
1070
- the Python SDK fix, where the leak also covered the player token and an `http://` downgrade).
1071
- - **`retryAfter` no longer treats a blank `retry_after` as `0`.** An empty/whitespace
1072
- `retry_after` string used to become `0` (`Number("")===0`) — an immediate, no-backoff retry.
1073
- It's now correctly `undefined`, in both `InvoError.retryAfter` and the retry layer.
1074
- - **Whitespace OTP codes rejected client-side.** `recoveryComplete`/`enrollmentVerify` now
1075
- reject a whitespace-only `code` before the network call, so it can't burn an attempt against
1076
- the attempt-capped endpoints (parity with the Python SDK).
1077
- - **Webhook verify uses `crypto.timingSafeEqual`** on the sync path (parity with Python's
1078
- `hmac.compare_digest`); the runtime-agnostic async/edge path keeps its string compare.
1079
- - **WebAuthn option mappers fail cleanly.** A malformed `register/begin` body now throws
1080
- `WEBAUTHN_OPTIONS_MALFORMED` (an `InvoError`) instead of a raw `TypeError`.
1081
-
1082
- ## [2.1.0] — 2026-07-02
1083
-
1084
- **Passkey recovery ("lost or replaced my passkey").** Deleting a passkey on the device never
1085
- tells the server the key is gone, so re-enrollment was dead-ended by the anti-takeover gate
1086
- (`ENROLLMENT_REQUIRES_PROOF`) with nothing left to prove possession with. The backend shipped
1087
- a self-serve, possession-proofed recovery flow; this release wires the client side.
1088
-
1089
- - `InvoClient.recoveryBegin()` — sends a one-time code to the phone/email on file
1090
- (`{ status: "sent", channels }`); `InvoClient.recoveryComplete(code)` — deactivates the
1091
- stale server-side passkey and authorizes a fresh enrollment
1092
- (`{ status: "recovered", deactivatedCount, next }`). Then retry the same `enrollPasskey()`.
1093
- - New `InvoError` classifiers: `isEnrollmentCodeInvalid`, `isPasskeyRecoveryCooldown`, and
1094
- `retryAfterAt` (the ISO timestamp on the 403 cooldown — distinct from the numeric
1095
- `retryAfter` throttle field). Bare `no_channel_on_file` / `rate_limited` error tokens are
1096
- now promoted to `err.code`.
1097
- - **24-hour money cooldown surfaced:** a recovery-enrolled passkey logs in and collects
1098
- funds immediately, but `approveSend`/`approveTransfer` throw 403
1099
- `PASSKEY_RECOVERY_COOLDOWN` for 24h (SIM-swap protection). Branch on
1100
- `isPasskeyRecoveryCooldown`, show the pause message with `retryAfterAt`, don't retry-loop.
1101
- - README: recovery subsection under Passkeys, incl. the password-manager cleanup tip for
1102
- "there is a problem saving your passkey" (stale orphan entry).
1103
-
1104
- Additive, no breaking changes. Routes require SDK verification enabled for the tenant
1105
- (dark 503 otherwise).
1106
-
1107
- ## [2.0.0] — 2026-07-02
1108
-
1109
- **BREAKING — `mintPlayerToken` now requires `playerPhone` (E.164).** Requested by the INVO
1110
- backend after a live incident: a player registered email-only couldn't receive a cross-game
1111
- transfer (incoming transfers are matched by phone) and never got the account-linking consent
1112
- SMS (also phone-triggered). The network identity is derived from **email + phone together**,
1113
- so the phone must be present on the FIRST registration call — attaching it later changes the
1114
- identity and forces device re-enrollment.
1115
-
1116
- - `mintPlayerToken({ playerEmail, playerPhone })` — `playerPhone` is required and validated
1117
- as E.164 (`+15555550100`: leading `+`, country code, digits only) before any network call;
1118
- the body now posts `player_phone` alongside `player_email`.
1119
- - **Pending approval is surfaced, not an error to swallow:** minting with a phone that
1120
- already belongs to another INVO account (same person, new email) throws the existing
1121
- `isPhoneShareApprovalRequired` 409 — the phone holder got a consent SMS. New
1122
- `InvoError.phoneShareApprovalId` exposes the `approval_id` from the 409 body for the
1123
- `phoneShareApprove` OTP fallback. Docs updated to cover the registration path (previously
1124
- documented for claims only).
1125
- - README: new "Player registration (email + phone, required)" section; examples updated
1126
- (`proxy-server.ts` token route now rejects a phoneless actor with a clear 400).
1127
-
1128
- **Migration:** collect the player's phone in your enrollment UI before the first
1129
- `mintPlayerToken` call and pass it as `playerPhone` in E.164. Handle the
1130
- `isPhoneShareApprovalRequired` error as a "pending approval" UI state.
1131
-
1132
- ## [1.2.1] — 2026-07-01
1133
-
1134
- **Fix — browser "Illegal invocation".** The SDK invoked its fetch as `this.fetchImpl(...)`,
1135
- so the browser's native `fetch` ran with the wrong `this` and threw
1136
- `TypeError: Illegal invocation` — breaking every browser `InvoClient` read
1137
- (balance/destinations/pending) and the passkey ceremonies when using the default global
1138
- `fetch` (retries then made it slow on top). The fetch impl is now bound to `globalThis`
1139
- (harmless for a custom `fetch`). No API change. Node/tests were unaffected, which is why it
1140
- slipped through — added a `this`-sensitive regression test.
1141
-
1142
- ## [1.2.0] — 2026-07-01
1143
-
1144
- Two more server-side capabilities on `InvoServer`.
1145
-
1146
- - **Phone-share OTP handshake** — `phoneShareInitiate` / `phoneShareApprove` / `phoneShareStatus`
1147
- resolve a `409 PHONE_SHARE_APPROVAL_REQUIRED`. Unauthenticated (phone-owner-driven — no game
1148
- secret, no player token), relayed by a partner backend; after approve, re-issue the identical
1149
- original request (the grant is server-side + auto-consumed). Adds
1150
- `InvoError.isPhoneShareAlreadyApproved`.
1151
- - **Server-side `getDestinations`** — game-secret variant of the browser
1152
- `InvoClient.getDestinations`; pass `{ sourceGameId, direction }` (default `"transfer"`), rows
1153
- share the same `DestinationGame` shape.
1154
-
1155
- ## [1.1.0] — 2026-07-01
1156
-
1157
- Four additive server-side flows on `InvoServer` (the SMS-PIN / claim-code / status /
1158
- guardian paths partners still need alongside the passkey path).
1159
-
1160
- - **SMS-PIN completion** — `verifySmsTransfer` / `verifySmsSend` (for `verificationMethod: "sms"`).
1161
- - **Claim-by-code** — `claimTransfer` / `claimCurrency`, incl. the `needsAccountSelection`
1162
- multi-account disambiguation (a `200` with `candidates`, not an error).
1163
- - **Status reads** — `getTransferStatus` / `getSendStatus` (surface `verificationState`).
1164
- - **Guardian approval-status poll** — `getGuardianApprovalStatus` (poll a hold to `state`).
1165
- - New typed results (`SmsVerifyResult`, `ClaimResult`, `TransactionStatusResult`,
1166
- `GuardianApprovalStatusResult`) + `InvoError.isPhoneShareApprovalRequired`.
1167
-
1168
- ## [1.0.0] — 2026-07-01
1169
-
1170
- **1.0 — stable.** The public API is now covered by a stability commitment: it follows
1171
- semver and no breaking change ships without a major bump + migration note. This is a
1172
- milestone release, **not a breaking change** — code on `0.8.x` continues to work unchanged.
1173
-
1174
- Also in this release (docs + DX):
1175
-
1176
- - **Integration modes** documented — **browser-direct** (default) and **behind your proxy**
1177
- (keep the INVO player token server-side via a custom `baseUrl`/`fetch`; no CORS or
1178
- security-posture change). Plus a token-bootstrap example and a CORS + RP-ID/origins
1179
- go-live checklist.
1180
- - `linkDevice` called out as the lowest-risk first adoption (additive, no refactor).
1181
-
1182
- ## [0.8.0] — 2026-07-01
1183
-
1184
- Completes the **discovery layer** for send/transfer UIs.
1185
-
1186
- - **`InvoClient.getBalance()`** (browser, player-token, `GET /api/sdk/balance`) — the
1187
- player's balances for the token's game: `balances[]` (`currencyId`, `currencyName`,
1188
- `currencySymbol`/`currencySymbolUrl` (nullable), `availableBalance`/`reservedBalance`/
1189
- `totalBalance` as decimal strings) plus `totalValue` / `currencyCount` / `hasFunds`. A
1190
- player who hasn't transacted here yet returns an empty `balances` array (a `200`, not an
1191
- error); `404 GAME_NOT_FOUND` throws.
1192
- - **`InvoServer.getLinkedIdentities({ playerEmail | playerPhone })`** (server-only,
1193
- game-secret) — a player's linked wallet identities (game-scoped). Provide one identifier
1194
- (phone wins if both); no in-game match returns `notFound: true` with empty `emails`
1195
- instead of throwing. **Returns first-party PII — never expose to the browser.**
1196
-
1197
- ## [0.7.0] — 2026-07-01
1198
-
1199
- Start of the **discovery layer** for send/transfer UIs.
1200
-
1201
- - **`InvoClient.getDestinations({ direction })`** — one player-token call
1202
- (`GET /api/sdk/destinations`) returns every game the player can send/transfer to, with
1203
- all display metadata **inline** (game name, icon, currency name/symbol, min/max transfer
1204
- limits) — no per-game lookup. Includes source game/currency info and `transferMode`
1205
- (`universal`/`linked` + `linkedGameIds`).
1206
- - _(Coming in 0.7.x: `getBalance` single-game player-token read; `getLinkedIdentities`
1207
- server-side.)_
1208
-
1209
- ## [0.6.0] — 2026-07-01
1210
-
1211
- Three additive browser flows for partner front-ends, built to the live backend contracts.
1212
-
1213
- - **`InvoClient.getPendingCollect()`** — the player's own pending-to-collect list
1214
- (player-token `GET /api/sdk/transfers/pending`), PII-free. Each row's `kind`
1215
- (`identity_gate` → `approve*`, `receiving_confirm` → `confirmReceipt*`) tells you the
1216
- action; typed fields incl. `held` / `holdReason` / `stepUpRequired`.
1217
- - **First-enrollment OTP grant** — `enrollmentBegin()` / `enrollmentVerify(code)` for
1218
- `ENROLLMENT_REQUIRES_AUTHORIZATION` (send OTP to phone+email, verify, then retry the
1219
- same `enrollPasskey()` — the server grant is auto-consumed). New `InvoError` helpers
1220
- `isEnrollmentAuthorizationRequired` / `isEnrollmentProofRequired`.
1221
- - **Typed approve/confirm holds** — `approve*`/`confirmReceipt*` now surface a typed
1222
- `holdReason` (from `error_code ?? code`) on HTTP 202 holds, plus `risk` /
1223
- `guardianApproval` / `pollEndpoint` on approve. `RECIPIENT_IDENTITY_PENDING` correctly
1224
- surfaces on confirm-receipt. Success carries no `holdReason`.
1225
-
1226
- ## [0.5.0] — 2026-07-01
1227
-
1228
- Support partner `metadata` end-to-end on the purchase flow (additive, backward-compatible).
1229
-
1230
- - **`PurchaseCompletedData.metadata?`** — the `purchase.completed` webhook now echoes your
1231
- metadata back (all rails); `event.data.metadata` is typed.
1232
- - **`purchaseCurrency`** now accepts and forwards `metadata` (the direct `/purchase-currency`
1233
- endpoint accepts it too, matching `createCheckout`).
1234
-
1235
- ## [0.4.2] — 2026-06-30
1236
-
1237
- Fixes from an independent line-by-line audit against the live backend.
1238
-
1239
- - **`linkDevice` now works.** `device/link/webauthn/begin` returns a wrapped
1240
- `{ link_id, options }` body (challenge nested under `options`) and binds the
1241
- challenge to a server-generated `link_id`. The client now unwraps `options` and
1242
- echoes the server's `link_id` to `/complete` (it previously threw on an undefined
1243
- challenge and sent the wrong id).
1244
- - **`InvoError.code` is now populated for the direct purchase rail + guardian flows.**
1245
- `errorFromResponse` reads `error_code` (SecureErrorHandler + `/purchase-currency`)
1246
- in addition to `code`, and promotes known no-code tokens (`flow_paused`,
1247
- `spending_limit_exceeded`, `receiver_not_enrolled_use_claim_code`) to `.code`. Fixes
1248
- `isDuplicateRequest` on the direct rail.
1249
- - **Guardian/minor routing.** The 202 guardian body also carries
1250
- `verification_method:"sms"`; the SDK now suppresses it (reports
1251
- `verificationMethod: undefined`) so a guardian-pending minor isn't routed into the
1252
- SMS-PIN UI. README example reordered to branch on `guardianApproval` first.
1253
-
1254
- ## [0.4.1] — 2026-06-30
1255
-
1256
- Docs only — replaced the README's internal-leaking "Deployment prerequisites"
1257
- (backend flag names, DB columns, gating mechanics) with a partner-facing
1258
- "Before you go live"; republished so the npm page README is current.
1259
-
1260
- ## [0.4.0] — 2026-06-30
1261
-
1262
- Additive release — more server reads, edge-ready webhooks, cancellation, and tooling.
1263
-
1264
- - **`getInboundPending({ playerEmail | playerPhone })`** — live, unclaimed inbound
1265
- sends/transfers for a player (the source of truth behind the "you have X to collect"
1266
- badge; pairs with `transfer.claim_pending`).
1267
- - **`verifyWebhookAsync`** — Web Crypto variant of `verifyWebhook` that runs on
1268
- Cloudflare Workers / Deno / Vercel+Netlify Edge / Bun / browsers; and
1269
- **`createWebhookHandler`** — a zero-dep Fetch-API `(Request) => Promise<Response>`
1270
- webhook route handler (Next.js App Router, Workers, Deno, Hono, Bun).
1271
- - **`iterateItemPurchaseHistory`** — async iterator that pages through a player's
1272
- full item-purchase history.
1273
- - **Per-call `AbortSignal`** — every method accepts an optional `{ signal }`; an
1274
- aborted call throws `InvoError` code `ABORTED` and is never retried.
1275
- - **Tooling**: ESLint (+ lint in CI), changesets release automation, `SECURITY.md`,
1276
- and `CODEOWNERS`.
1277
-
1278
- ## [0.3.0] — 2026-06-30
1279
-
1280
- Additive release — new server capabilities plus transport resilience/observability.
1281
-
1282
- - **Webhook verification** (`/server`): `verifyWebhook(rawBody, signatureHeader, secret | secrets, opts?)`
1283
- — constant-time HMAC-SHA256 over `${t}.${rawBody}`, 5-minute replay window,
1284
- multi-secret rotation; returns a typed `InvoWebhookEvent` discriminated union
1285
- (`purchase.*`, `item.purchased`, `transfer.*`, `payout.status_changed`, `webhook.test`).
1286
- Throws `InvoError` (`WEBHOOK_SIGNATURE_INVALID` / `WEBHOOK_TIMESTAMP_EXPIRED` /
1287
- `WEBHOOK_MALFORMED` / `WEBHOOK_SECRET_MISSING`). Server-only; the browser bundle
1288
- stays crypto-free. Independently security-audited.
1289
- - **`getPlayerBalance({ playerEmail | playerId })`** (`/server`): typed `player` / `balances` / `summary`.
1290
- - **Automatic retries**: network errors/timeouts, `429` (honoring `retry_after`), and
1291
- `5xx` are retried with exponential backoff + jitter. New config `maxRetries`
1292
- (default 2, `0` disables) and `retryBaseDelayMs` (default 250).
1293
- - **Observability hooks**: optional `onRequest` / `onResponse` / `onError` on both
1294
- entries (best-effort/non-throwing); `InvoError.requestId` carries the backend
1295
- request id for support/tracing.
1296
- - **Typed reads**: `confirmPayment` → `ConfirmPaymentResult`; `getOrderDetails` /
1297
- `getItemOrderDetails` → `OrderDetailsResult`; `getItemPurchaseHistory` →
1298
- `ItemHistoryResult` (previously untyped `Record`). All keep `raw`.
1299
- - **Light validation**: `mintPlayerToken` and `createCheckout` require a non-blank
1300
- `playerEmail` (throws `INVALID_INPUT` before the network call).
1301
- - **License**: `package.json` `license` is now `SEE LICENSE IN LICENSE` (was
1302
- `UNLICENSED`); `LICENSE` rewritten as an explicit install-and-use grant for
1303
- building INVO integrations.
1304
-
1305
- ## [0.2.1] — 2026-06-30
1306
-
1307
- Docs only — no code change (republished so the npm page README is current).
1308
-
1309
- - Rewrote the README into a complete integration/deployment guide: capability
1310
- overview, architecture, deployment prerequisites, per-flow sections (currency
1311
- purchase, item purchase, sends, transfers, passkeys), webhooks, errors, and a
1312
- full API reference for both entries.
1313
- - Added INVO console onboarding: `https://console.invo.network` (production) and
1314
- `https://dev.console.invo.network` (testing/sandbox), mapped to their API base URLs.
1315
-
1316
- ## [0.2.0] — 2026-06-30
1317
-
1318
- Adds **item purchase** (spend existing game currency on an in-game item, §4.8) — an
1319
- additive, server-only surface.
1320
-
1321
- - `InvoServer` (`/server`): `purchaseItem`, `getItemPurchaseHistory`, `getItemOrderDetails`.
1322
- - Server-side, game-secret auth — no passkey, no real money, no payment rail (it's a
1323
- balance debit). Grant the item off the `item.purchased` webhook.
1324
- - Client-side guards: required fields (trim-checked), `itemQuantity` integer `1..1000`,
1325
- prices `> 0` and `<= 999999.99` (magnitude-safe 2-decimal check), and
1326
- `totalPrice == unitPrice × itemQuantity (±0.01)` compared in integer cents.
1327
- - Load-bearing response fields (`transaction_id`, `order_id`) throw `INVALID_RESPONSE`
1328
- if missing on a 200.
1329
- - `InvoError` helpers: `isInsufficientBalance` (gated to 400; not the `429` throttle),
1330
- `isDuplicateRequest` (409), `retryAfter` (numeric or string `retry_after`); all
1331
- null-safe against non-JSON error bodies.
1332
- - Independently audited (2 agents) against handoff doc §4.8/§6/§8; contract verified,
1333
- error-classification edge cases fixed.
1334
-
1335
- ## [0.1.0] — 2026-06-30
1336
-
1337
- Initial scaffold.
1338
-
1339
- - `InvoServer` (`/server`): `mintPlayerToken`, `initiateSend`, `initiateTransfer`,
1340
- `createCheckout`, `purchaseCurrency`, `confirmPayment`, `getOrderDetails`.
1341
- - Client-side purchase guards (§4.7): USD amount `0 < x ≤ 999.99`, required
1342
- `purchaseReference`, and `rail:"steam"` rejected before the network call
1343
- (`INVALID_INPUT` / `MISSING_PURCHASE_REFERENCE` / `WRONG_RAIL_ENDPOINT`).
1344
- - `InvoClient` (browser): `enrollPasskey`, `approveSend`/`approveTransfer`,
1345
- `confirmReceiptSend`/`confirmReceiptTransfer`, and `linkDevice` for the
1346
- interchangeable-methods flow (§4.6).
1347
- - Optional `refreshToken` hook: transparently re-mints and retries once on
1348
- `SDK_TOKEN_EXPIRED` (§11.2).
1349
- - Shared: typed `InvoError`, isomorphic HTTP client, WebAuthn JSON⇄binary helpers.
1350
- - Tests: HTTP layer, server request mapping + purchase guards, browser client
1351
- flows (enroll/approve/link/token-refresh), and WebAuthn serialization.
1352
- - Contracts extracted + auditor-verified against the INVO backend.
1353
-
1354
- ### Hardening (independent red-team pass)
1355
-
1356
- - **Guardian/minor `202` path no longer mismapped to `verificationMethod:"sms"`** —
1357
- `initiateSend`/`initiateTransfer` now return `verificationMethod: undefined` and a
1358
- `guardianApproval` block on the guardian path, so callers don't route into the
1359
- PIN UI by mistake (§4.3).
1360
- - `usdAmount` validation tightened: rejects non-plain-decimal strings
1361
- (`"0x10"`, `"1e2"`, whitespace) and >2 decimal places before any network call.
1362
- - Load-bearing response fields (`token`, `checkout_url`) now throw `INVALID_RESPONSE`
1363
- instead of silently surfacing as empty strings.
1364
- - `getOrderDetails` requires at least one of `orderId`/`transactionId`.
1365
- - Token refresh now re-runs the **whole** passkey ceremony on `SDK_TOKEN_EXPIRED`
1366
- (never replays a single-use assertion) and single-flights concurrent refreshes.
1367
- - `baseUrl` must be `https://` (localhost exempt) so the token/secret can't travel
1368
- in cleartext.
1369
- - Published tarball excludes sourcemaps (no proprietary source shipped).
1
+ # Changelog
2
+
3
+ ## 3.29.0
4
+
5
+ ### Minor Changes
6
+
7
+ - Public demo sandbox (INVO game templates): on the demo key, `invoGameServerFromEnv` maps every sign-in to the demo sandbox's player email format for the fork's project (`toDemoEmail`) and gives the player a fictional 555-01XX phone (`demoPhoneFor`), so no real address or number reaches INVO. The project id comes from `INVO_PROJECT_ID`, else `.invo/project.json` (option `projectFile`), else a new one written there; a copied file on a different public host (a remix) gets a fresh id.
8
+ - New `registerProject({ gameSecret, webhookUrl, file? })` (game-server entry): registers the fork on every start, stores the webhook signing secret and the registration token in the project file the first time, and handles a remix's `409 PROJECT_REGISTERED` by taking a fresh project id. `invoGameServerFromEnv` reads the webhook secret from that file when `INVO_WEBHOOK_SECRET` is not set, or from the new `webhookSecret` option.
9
+ - `verifyInvoSignature(rawBody, header, secrets)`: the INVO webhook signature check under the name the template guide uses (same as `verifyWebhook`).
10
+ - The key-environment lookup is retried on each call until it succeeds (a failure at boot no longer wedges the server), and a production error falls through to the sandbox lookup.
11
+ - `InvoGameServerSetup.environment` is `"sandbox"`, `"production"` or `"resolving"`; `sandbox` is no longer `true` for a live key whose environment is still being looked up.
12
+ - Nothing removed or renamed.
13
+
14
+ ## 3.28.0
15
+
16
+ ### Minor Changes
17
+
18
+ - Going live is swapping the key. `invoGameServerFromEnv` now picks the environment from `INVO_GAME_SECRET`: the public demo key (`ivsdk_demo_...`, baked into INVO's game templates) is the sandbox; any other key is looked up once with `GET /api/sdk/key-environment` (production first, then the sandbox) and cached. `INVO_ENV` and `INVO_BASE_URL` still override it.
19
+ - `X-Invo-Project-Id` is now sent on every call in both environments, so the first live call after go-live links the template project to your INVO account. `INVO_PROJECT_ID` is read when `projectId` is not passed. The id format is `proj_` + a 26-character uppercase Crockford ULID; `newProjectId()` (game-server entry) makes one.
20
+ - New exports (server and game-server entries): `resolveEnvironment`, `baseUrlForKey`, `isDemoKey`, `EnvironmentUnknownError`, `PRODUCTION_BASE_URL`, `SANDBOX_BASE_URL`, `DEMO_KEY_PREFIX`.
21
+ - Nothing removed or renamed.
22
+
23
+ ## 3.27.0
24
+
25
+ ### Minor Changes
26
+
27
+ - Loyalty: `InvoServer.reportGameEvent({ playerEmail, eventType, eventId?, occurredAt?, payload? })` (`POST /api/sdk/loyalty/server-events`, game secret, trusted for rewards) and `InvoClient.reportGameEvent(...)` (`POST /api/sdk/loyalty/events`, player token). `eventId` is generated when omitted and returned; the server call retries with it. Types `GameEventType`, `ReportGameEventInput`, `ReportServerGameEventInput`, `ReportGameEventResult`.
28
+ - New entry `@invonetwork/web-sdk/game-server`: the server half of a browser game's economy. `invoGameServerFromEnv` / `createInvoGameServer` serve sessions, the premium wallet (read from INVO), a soft-currency ledger, hosted checkout, signed-webhook crediting processed exactly once, idempotent item purchases (premium through `purchaseItem`, soft through the ledger), rate-limited earnings, loyalty events and rewards, under `/api/invo`. `createFileGameStore` (atomic JSON file) and `createMemoryGameStore`; `toNodeListener` adapts it to `node:http`. With secrets missing it answers `503 INVO_SETUP_REQUIRED` and keeps `/health` and `/catalog` up.
29
+ - New entry `@invonetwork/web-sdk/game`: `InvoGameEconomy` (the browser client for that server: sign-in, wallet events, `buyItem`, `buyPremium` with popup or redirect checkout, batched `earn`, `reportEvent`) and `mountInvoUI`, a framework-free DOM kit (balance HUD, buy-currency modal, shop grid, sign-in, toasts) in the INVO palette, themeable by CSS variables. Holds no secret. Used by `@invonetwork/phaser` and `@invonetwork/three`.
30
+ - `invoGameServerFromEnv` accepts `projectId` (sent to the sandbox as `X-Invo-Project-Id` on every call, never in production) and `fetch`. `InvoGameEconomy.checkSetup()` re-asks the server whether its INVO secrets are set; the UI kit's developer setup guide uses it to notice when the keys arrive.
31
+ - The UI kit ships the INVO design: a glass wallet HUD with animated balance changes, a tabbed shop with lit item cards, ownership chips and stack pips, premium packs with a best-value ribbon, sign-in with field icons, a step-by-step developer setup guide, toasts, and bottom sheets on phones. It respects `prefers-reduced-motion`.
32
+ - Nothing removed or renamed; the `.` and `./server` entries are unchanged apart from the two new methods.
33
+
34
+ ## 3.26.1
35
+
36
+ ### Patch Changes
37
+
38
+ - Types: `Payee` gains `payable` and `payable_blockers` (`PayableBlocker`, exported from the server entry). Check `payable` before offering a payout to a creator.
39
+ - Docs: refusals add `PAYEE_TERMS_NOT_ACCEPTED` (the creator hasn't accepted INVO's current Payee Terms yet), and removing a creator with a payout still being processed reports `payouts_in_flight_by_status`.
40
+ - Nothing removed or renamed.
41
+
42
+ ## 3.26.0
43
+
44
+ ### Minor Changes
45
+
46
+ - Server: `invo.payouts.removePayee(payeeId)` (`POST /api/partner-payees/{payeeId}/remove`): remove a creator from your program; the status becomes `closed`.
47
+ - Types: `PayeeStatus` gains `closed`; `Payee` gains `erased`; `Payout` and `PayoutStatusChangedData` gain `return_reason_code` (typed `ReturnReasonCode`), `partner_message` and `owner_confirmation_required` (`Payout` also `owner_confirmed_at`). `PayoutStatusChangedData.status` and `previous_status` are typed `PayoutStatus`. `PayoutStatus` and `ReturnReasonCode` are exported from the server entry and from webhooks.
48
+ - Docs: `requestPayout` takes exactly one of `payeeId` or `bankAccountId`; the comment no longer says a request without either defaults to your own bank. Refusal codes listed in full.
49
+ - Behaviour on the API, not the SDK: partner payout reads and `payout.status_changed` no longer carry INVO's internal notes (`admin_note`), admin ids (`reviewed_by_admin_id`, `initiated_by_admin_id`) or the accounting provider's fields (`qb_vendor_id`, `qb_bill_id`, `qb_payment_reference`). They were never part of the documented contract; read `partner_message` for a note INVO writes for you.
50
+ - Nothing in the SDK removed or renamed.
51
+
52
+ ## 3.25.0
53
+
54
+ ### Minor Changes
55
+
56
+ - Server: `InvoServer.payouts`, partner payouts and creator payouts. `registerPayee` (`POST /api/partner-payees`), `listPayees`, `getPayee`, `resendPayeeInvite`, `requestPayout` (`POST /api/partner-payouts/request`, with `payeeId` to have INVO pay a verified creator from the earnings INVO owes you, or `bankAccountId` for your own verified bank), `getPayout`, `listPayouts` (optional `payeeId`) and `cancelPayout` (a creator payout still `requested`). Results keep the API's snake_case fields. Creators are INVO's customers: you see their status only, never their documents, tax id or bank details.
57
+ - Webhook types: `payee.status_changed` is typed as `PayeeStatusChangedData`. `PayoutStatusChangedData` gains `payee_id`, `payout_method` and `returned_at`. Payout statuses now include `cancelled` and `returned`.
58
+ - Nothing removed or renamed.
59
+
60
+ ## 3.24.1
61
+
62
+ ### Patch Changes
63
+
64
+ - Player activity: on the recipient's entry for a send or transfer from another game, `grossAmount` and `feeAmount` are now filled in the recipient's currency (`grossAmount - feeAmount === amount`). They were `null` on every cross-game entry. Doc comment updated; no type change.
65
+
66
+ ## 3.24.0
67
+
68
+ ### Minor Changes
69
+
70
+ - Player activity: send and transfer entries from `getPlayerActivity` / `iteratePlayerActivity` carry the fee. On the sender's entry `feeAmount` and `netAmount` (what the recipient gets) sit beside the gross `amount`; on the recipient's entry `grossAmount` and `feeAmount` sit beside `amount` (what arrived). While a send waits to be collected they show the fee that will apply; `null` when it ended without being collected, and on the recipient side of a currency-converting transfer. Purchases do not carry them.
71
+ - Errors: initiate-send and initiate-transfer amount-limit refusals now carry `error_code` `AMOUNT_BELOW_MINIMUM` / `AMOUNT_ABOVE_MAXIMUM` with the limit. `err.isAmountBelowMinimum` (now also true for these, and on the wallet transfer route where `err.code` stays `INVALID_AMOUNT`), new `err.isAmountAboveMaximum`, `err.minimumAmount`, `err.maximumAmount` and `err.limitCurrencyName`. A sender phone that does not match the one on file now carries `PHONE_MISMATCH` (400); `err.isPhoneMismatch` covers it as well as `registerPlayer`'s 409.
72
+ - Webhook types: `identity.passkey_reset` is typed as `IdentityPasskeyResetData` (`identity_id`, `reset_via`, `cooldown_until`, `deactivated_count`). It now also fires for an in-app recovery (`reset_via: "sdk"`) and can be subscribed to by name.
73
+ - Nothing removed or renamed.
74
+
75
+ ## 3.23.0
76
+
77
+ ### Minor Changes
78
+
79
+ - Webhook types: `PurchaseEventData` gains `dispute_fee_usd` (`string | null`, USD decimal such as `"15.00"`, `"0.00"` when INVO bears the fee) and `dispute_fee_charged_to_partner` (`boolean | null`), carried on a card `purchase.disputed` when the dispute closes. From November 8, 2026 the card dispute fee on Open-tier card sales (coin purchases, Platform Commerce card sales and subscription charges) is passed through to you at cost. A lost dispute is `purchase.disputed` with `dispute_status: "lost"`, not a separate event. README updated. Both fields optional; nothing removed or renamed.
80
+
81
+ ## 3.22.0
82
+
83
+ ### Minor Changes
84
+
85
+ - e3895ab: 2026-10 pricing and new reads. Server: `getPlayerActivity({ playerEmail, limit?, cursor?, types? })`
86
+ (`GET /api/sdk/players/activity`), one merged, newest-first page of a player's currency purchases,
87
+ item purchases, Platform Commerce purchases, sends and transfers, and `iteratePlayerActivity`, which
88
+ follows `nextCursor`. `platformCommerce.getPurchaseHistory({ playerEmail, limit?, cursor? })`
89
+ (`GET /api/platform-commerce/purchase-history`, entries shaped like `getStatus`) and
90
+ `platformCommerce.iteratePurchaseHistory`. `getTransferStatus` / `getSendStatus` results carry
91
+ `expiryReason` once expired. Webhook types: `TransferEventData` gains `order_id`,
92
+ `net_transfer_amount`, `claim_code_expires_at`, `from_game_id`, `to_game_id`, `from_player_id`,
93
+ `expired_at`, `reason`, `expiry_reason` and `refunded_amount`; `payout.status_changed` is typed as
94
+ `PayoutStatusChangedData`, with the payout fee fields `offboarding_fee_pct`, `offboarding_fee_usd`,
95
+ `offboarding_fee_cap_usd` and `net_payout_usd`. New additive `err.publicCode`: the
96
+ provider-neutral twin of a code (INVO's `error_code_public` on errors from the API). The SDK's own
97
+ pre-network refusal of a Platform Commerce card total under $0.50 keeps `err.code` exactly as
98
+ before and now also carries `err.publicCode === "BELOW_CARD_MINIMUM"` and `err.minUsd === "0.50"`;
99
+ `err.isBelowCardMinimum` is true as before and accepts both spellings. Nothing removed or renamed. README: the
100
+ Open card fee is 3.5% + $0.30 (was 4.5%); the chargeback guarantee is a Merchant of Record term
101
+ (Open-tier card payments made before November 8, 2026 keep it); transfers are 10% (3.5% / 3.5% /
102
+ 3%); payouts carry a 1% fee capped at $500 per payout; the hosted checkout reports a finished
103
+ purchase as status `"completed"`; on `phoneMismatch`, call `updatePlayerPhone`. Additive only.
104
+ - Player-confirmed phone change. Server: `requestPhoneChange({ playerEmail, newPhone })`
105
+ (`POST /api/sdk/players/phone/change-requests`, 202, never auto-retried) returns
106
+ `changeRequestId`, `status`, `expiresAt`, `delivery`, `confirmation` and `message`; INVO emails
107
+ the player, who confirms on INVO's page (plus their passkey or enrolled device when they have
108
+ one). `getPhoneChange(changeRequestId)` reads the request. Browser, with the player token, on
109
+ the player's enrolled device: `listPhoneChangeApprovals()` and
110
+ `approvePhoneChange(changeRequestId, { deviceFingerprint, decision?, sign | deviceSignal })`,
111
+ which sends a `device_signal` over `phone-change|<id>|<nonce>|<timestamp>` (or
112
+ `phone-change-deny|...`); new `phoneChangeSignalMessage()` builds that message. No method sends
113
+ a confirmation code: games never collect it. `err.changeRequestEndpoint` on
114
+ `PHONE_CHANGE_REQUIRES_VERIFICATION`; new error predicates `isConfirmOnInvoPage`,
115
+ `isChangeRequestNotFound`, `isChangeRequestNotReady`, `isChangeRequestNotPending` (with
116
+ `changeRequestStatus`), `isChangeRequestInProgress`, `isPhoneChangeLocked`,
117
+ `isTooManyChangeRequests`, `isPhoneChangeUnavailable`, `isDeviceSignalRejected`,
118
+ `isPhoneChangeRecoveryCooldown` (`PHONE_CHANGE_RECOVERY_COOLDOWN`, 409 on create and approve:
119
+ a recent sign-in recovery; retry later, declining still works) and
120
+ `isDeviceEnrolledAfterRequest` (`DEVICE_ENROLLED_AFTER_REQUEST`, 409 on approve). New
121
+ `isPendingTransfersToOldPhone` / `isPendingTransfersToNewPhone`, which `updatePlayerPhone`
122
+ now also answers (409, no counts) as well as the change request routes. Webhook
123
+ type: `player.phone_changed` as `PlayerPhoneChangedData` (`new_phone` only for the requesting
124
+ game). README section "Player-confirmed phone change": on `phoneMismatch` or
125
+ `player.phone_changed`, never push a stored number back; ask the player. Additive only.
126
+
127
+ ## 3.21.0
128
+
129
+ ### Minor Changes
130
+
131
+ - 0238b53: Player registration, phone changes and identity re-key. Server: `mintPlayerToken` takes optional
132
+ `playerPhone` and `playerName`; with a phone, a player new to your title is created, and the
133
+ result now carries `created` and `phoneMismatch` (previously dropped). New
134
+ `registerPlayer({ playerEmail, playerPhone, playerName? })` (`POST /api/sdk/players`) and
135
+ `updatePlayerPhone({ playerEmail, newPhone })` (`POST /api/sdk/players/phone`, never
136
+ auto-retried). `initiateSend` / `initiateTransfer` results expose `identityRekeyed`,
137
+ `playerToken`, `playerTokenExpiresAt`, `identityId` and `claimDeliveryPlanned`; approve results
138
+ expose `claimDelivery`. New error predicates `isPlayerTokenStale`,
139
+ `isPhoneChangeRequiresVerification`, `isPhoneMismatch`, `isPhoneShareRefused`;
140
+ `isPlayerNotFound` also recognises the codeless `player_not_found` 404. A 403
141
+ `PLAYER_TOKEN_STALE` on approve is surfaced, never auto-retried: re-mint and retry once.
142
+ Additive only. README section "Registering players and changing their phone".
143
+
144
+ ## 3.20.0
145
+
146
+ ### Minor Changes
147
+
148
+ - 1dc07df: Loyalty and rewards. Server: `InvoServer.getPlayerRewards(playerEmail)` reads one player's
149
+ loyalty cards with the game secret (`GET /api/sdk/loyalty/players/rewards`). Browser, with the
150
+ player token: `InvoClient.getMyRewards()` (the player's cards), `getMyVault()`,
151
+ `redeemReward(vaultEntryId)` (the only response with a code; never auto-retried) and
152
+ `getRewardsPageLink()` (INVO's hosted "My rewards" page). Every card step carries `progress`,
153
+ `{ current, target }`, or `null` when unavailable; `state` decides completion. New error
154
+ predicates `isRewardAlreadyRedeemed`, `isRewardNotFound`, `isRewardExpired`,
155
+ `isRewardUnavailable` (`inventory_exhausted` / `conflict`); the server read's
156
+ `PLAYER_NOT_FOUND` and `INVALID_PLAYER_EMAIL` use the existing `isPlayerNotFound` and
157
+ `isInvalidPlayerEmail`. Additive only. README section "Loyalty and rewards".
158
+
159
+ ## 3.19.0
160
+
161
+ ### Minor Changes
162
+
163
+ - 6940139: D-PRICE-012: a subscription card refund, and a lost chargeback not covered by the chargeback guarantee, now cost the partner the whole refunded amount, INVO's card fee included, exactly as a Platform Commerce card refund does. There is no separate payment processor fee on a refund any more: `processingFeeUsd` reads `"0.00"` and `processingFeeBasis` `"none"`.
164
+
165
+ Additive, optional fields:
166
+
167
+ - `RefundResult.cardFeeChargedToPartnerUsd` and `RefundResult.partnerDebitedUsd` on `subscriptions.refund` (the 200 receipt and the 202 `pending_approval` body). `undefined` on a receipt stored before this release.
168
+ - `card_fee_charged_to_partner_usd` and `partner_debited_usd` on the `refund` block of `subscription.refunded` (`SubscriptionRefundDetail`) and on `purchase.disputed` (`PurchaseEventData`, subscription and Platform Commerce losses; `null` where not applicable).
169
+
170
+ README: subscription refund costs, lost chargebacks and the "What did I earn?" answer updated.
171
+
172
+ ## 3.18.0
173
+
174
+ ### Minor Changes
175
+
176
+ - 432fb75: INVO's 2026-09 card pricing. On card purchases the partner now pays INVO's card fee (4.5% + $0.30 on Open, 5.5% + $0.50 on Merchant of Record, plus 1.5% of the listed price (before tax) on a card issued outside the US); the player pays the listed price (plus tax where owed) and receives the listed coins. Fraud screening and a chargeback guarantee (a fraud chargeback on a card sale is covered by INVO) are included. Minimum card purchase $2.99 on coin purchases and Platform Commerce card sales, enforced from 2026-10-27. Card purchases only; purchases through a third-party storefront or payment rail are unaffected. All additive:
177
+
178
+ - `PurchaseResult` and `CurrencyPurchaseQuote` gain `partnerFeeUsd`, `internationalCardFeeUsd` and `minPurchaseWarning` (`MinPurchaseWarning`: `{ code, minUsd, enforcedFrom, message?, enforced?, raw }`), each set only when INVO sends it. `processingFeeUsd` stays and reads `"0.00"`.
179
+ - `FeeTakenFrom` gains `"partner"`. `UnacknowledgedPurchaseOutcome.feeTakenFrom` stays required; INVO always sends it, and should it ever be missing the SDK reads `"partner"` when the quote carries `partner_fee_usd`, otherwise `"coins"` as before.
180
+ - `err.minUsd` and `err.enforcedFrom` on `BELOW_CARD_MINIMUM` (`err.isBelowCardMinimum`, which now also covers INVO's minimum card purchase). `err.isAmountBelowFee` is deprecated: `AMOUNT_BELOW_FEE` is no longer returned.
181
+ - `acknowledgedTotalUsd` is still honored: INVO never charges more than it, and an older, higher fee-inclusive total is accepted with the true, lower total charged. Only a total below the true total is refused (`QUOTE_STALE`).
182
+ - `partnerFeeUsd` and `internationalCardFeeUsd` are `string | null`: `null` only when the fee could not be booked when the purchase completed (the purchase succeeded; INVO books the fee shortly after). `internationalCardFeeUsd` is `"0.00"` on a US card or one whose country is unknown, and always `null` on a quote (no card yet). The quote also carries `feeTakenFrom`, and `ifUnacknowledged.partnerFeeUsd`.
183
+ - `createCheckout()` and the Platform Commerce card leg of `platformCommerce.purchase()` return `minPurchaseWarning` while an amount under the minimum card purchase is still accepted. `BELOW_CARD_MINIMUM` also answers a card charge under the $0.50 card floor at any date, on coin purchases, hosted checkout and Platform Commerce: `err.minUsd` reads `"0.50"` there, with no `err.enforcedFrom`.
184
+ - `purchaseCurrency()` accepts `country` and `subdivision`, the place you quoted with. On Merchant of Record INVO uses it only when it cannot read the buyer's tax location from the card; without it such a purchase is refused with `409 TAX_PLACE_UNAVAILABLE` (new `err.isTaxPlaceUnavailable`, `err.untaxedTotalUsd`), nothing charged.
185
+ - Platform Commerce card refunds: `cardFeeChargedToPartnerUsd` and `partnerDebitedUsd` on the refund result and `card_fee_charged_to_partner_usd` / `partner_debited_usd` on `platform_commerce.refunded` (the card fee is not returned on a refund; it stays charged to you).
186
+ - Webhook types: `purchase.completed` gains `partner_fee_usd` and `international_card_fee_usd` (nullable); `purchase.disputed` gains `guarantee_covered` (lost Platform Commerce card sale and subscription disputes only; never on a coin purchase dispute), `order_type`, `developer_revenue_reversed_usd`, `subscription_id`, `period_seq` and `processing_fee_usd` (the processor fee a non-fraud lost subscription chargeback charges you, as a refund does); `platform_commerce.purchased` gains `international_card_fee_usd` (already included in `fee_breakdown.platform_fee`); `subscription.renewed`'s split gains `international_card_fee_usd` (the same figure as `pass_through_fees_usd`, never add them; `partner_revenue_usd` stays gross).
187
+ - Behaviour to notice: an unacknowledged $10.00 coin purchase now credits the full 100.00 coins (93.70 under the earlier pricing); an older fee-inclusive acknowledged total is accepted and the lower true total charged; `AMOUNT_BELOW_FEE` is no longer returned.
188
+ - README and doc comments: every card fee figure, the Tiers table (card rates, international fee, who pays, fraud screening, chargeback guarantee, minimum card purchase) and the quote example ($10.00 charges the player $10.00; your fee is $0.75 on Open).
189
+
190
+ ## 3.17.0
191
+
192
+ ### Minor Changes
193
+
194
+ - 28a96bf: Webhook payload types: `PurchaseEventData` gains `payment_intent_id` / `charge_id` / `dispute_id` (`string | null`: `null` on a Steam chargeback), `rail`, `steam_transid`, `fully_refunded`, `currency_debited` and `new_balance`. Steam chargebacks now arrive as `purchase.disputed` with the same keys as a lost card dispute, and a Steam partial refund arrives as `purchase.refunded` with `fully_refunded: false`. README: if you revoke on `purchase.refunded`, handle `purchase.disputed` the same way. All additive and optional.
195
+
196
+ ## 3.16.1
197
+
198
+ ### Patch Changes
199
+
200
+ - 9dd2bf5: README: the `isDuplicateClientRequestId` note describes only what the caller sees. Documentation only.
201
+
202
+ ## 3.16.0
203
+
204
+ ### Minor Changes
205
+
206
+ - 58143c2: `warnings` on `createCheckout()` results (typed `CheckoutWarning[]`, mapped from the additive `warnings` field): a checkout session sells game currency, and `metadata` carrying `item_id` / `item_name` now returns `ITEM_METADATA_ON_CURRENCY_SESSION`, pointing to `platformCommerce.purchase` for item sales. New error helpers: `err.isDuplicateClientRequestId` (409 `DUPLICATE_CLIENT_REQUEST_ID` on a Platform Commerce card purchase, with `order_id` / `order_status`; `err.isDuplicateRequest` is also true), `err.isTrialAmountBelowFeeFloor` (400 `TRIAL_AMOUNT_BELOW_FEE_FLOOR`; the message names the smallest accepted trial price) and `err.isIdentityCheckUnavailable` (503 `IDENTITY_CHECK_UNAVAILABLE` on claims and confirm-receipt, retryable). `err.isAmountBelowMinimum` now also covers `purchaseItem`, whose `totalPrice` is rounded to cents. README: refunds take back only the coins still held from that purchase, chargebacks up to the purchase's coins from the available balance, never below zero. All additive and optional.
207
+
208
+ ## 3.15.0
209
+
210
+ ### Minor Changes
211
+
212
+ - 5adf010: `cards.createSetupSession()` takes optional `playerName` and `playerPhone` (mapped to `player_name` / `player_phone`). When the member is new to the game and `playerName` is sent, INVO creates the member exactly as `subscriptions.create` does and then mints the card link, so a brand-new signup can save a card before a paid trial (`subscriptions.create` with `trialAmountUsd` and `playerCardId`). Without `playerName` an unknown member is still `err.isPlayerNotFound` (404). A known member is never re-created or renamed by this call. New `err.isPlayerCreateFailed` (503 `PLAYER_CREATE_FAILED`); a phone already on another member answers `err.isPhoneShareApprovalRequired` (409). The SDK refuses a blank or over-255-character `playerName` and a non-E.164 `playerPhone` before the network (`INVALID_INPUT`, status 0). README: the card page and paid-trial sections show the new-signup order. All additive and optional.
213
+
214
+ ## 3.14.2
215
+
216
+ ### Patch Changes
217
+
218
+ - README: the Merchant of Record chargeback threshold is measured on the previous complete calendar month. Documentation only.
219
+
220
+ ## 3.14.1
221
+
222
+ ### Patch Changes
223
+
224
+ - README: Merchant of Record is applied for from the Selling & Tax page in the INVO console (the page name was wrong in 3.14.0). Documentation only.
225
+
226
+ ## 3.14.0
227
+
228
+ ### Minor Changes
229
+
230
+ - 8f2298b: `credited` and `reasonCode` on `confirmPayment()` and `steamFinalizePurchase()` results (mapped from the additive `credited` / `reason_code` response fields; `status` is unchanged and still means the payment succeeded, so report a completed purchase only when `credited` is `true`). Merchant of Record receipt fields `receiptNumber` / `receiptUrl` on `purchaseCurrency()`, `getOrderDetails()`, `CheckoutClient.getPurchaseStatus()`, `platformCommerce.getStatus()` and `firstCharge`, and `receipt_number` / `receipt_url` (plus `tax_treatment` on `purchase.completed`) on the purchase, Platform Commerce and subscription webhook payload types. README: the tier's effect on responses (`tax_treatment: "partner_responsible"` on Open, receipts and the chargeback reserve on Merchant of Record). Platform Commerce card refunds in parts: optional `refundRemaining` / `confirmAdditionalRefund` on `platformCommerce.refund()`, optional `partialRefund` / `adopted` / `refundedTotalUsd` / `chargeTotalUsd` / `remainingUsd` on its result, and `err.isRefundRemainingRequiresConfirmation` / `err.isRefundRecentlyIssued` / `err.isRefundNotCompleted` (`err.isAlreadyRefunded` is now false for the two refund-in-parts refusals). All additive and optional. README: subscription card charges are 4% + $0.30 on Open and 5% + $0.50 on Merchant of Record (were 7% + $0.30 and 8.5% + $0.30); international card and currency conversion costs on subscriptions pass through at cost; chargebacks by tier; Merchant of Record is applied for from the console.
231
+
232
+ ## 3.13.0
233
+
234
+ ### Minor Changes
235
+
236
+ - INVO's card fee on coin purchases, paid trials, and the two tiers.
237
+
238
+ **Coin purchases carry INVO's card fee: 3.5% + $0.30** of the price (on the Open tier), never less than the card cost. `purchaseCurrency` charges in the same request, so there are now two shapes and you pick one by what you send:
239
+
240
+ - **Quote, show, acknowledge.** New `server.quoteCurrencyPurchase({ playerEmail, usdAmount, country?, subdivision? })` calls `POST /api/currency-purchases/quote`. It moves no money and creates nothing, and returns `totalUsd`, `amountCents`, `subtotalUsd`, `processingFeeUsd`, `coins`, `currencyName`, a camelCase `breakdown` and `ifUnacknowledged`. Show the player `totalUsd`, then pass it as the new optional `acknowledgedTotalUsd` on `purchaseCurrency`: the card is charged that total, to the cent, and the coins are priced off `usdAmount`. $10.00 quotes $10.65.
241
+ - **Send only `usdAmount`.** The card is charged exactly `usdAmount`, never more, and the fee comes out of the coins: $10.00 credits 93.70 coins at the default 10 per USD.
242
+
243
+ A `success` result now also carries `processingFeeUsd`, `feeTakenFrom` (`"charge"` or `"coins"`), `coinsCredited` and `chargeTotalUsd`. New error helpers: `err.isQuoteStale` (409 `QUOTE_STALE`, with `err.expectedTotalUsd` and `err.acknowledgedTotalUsd`) and `err.isAmountBelowFee` (400 `AMOUNT_BELOW_FEE`). Nothing is charged on either. `acknowledgedTotalUsd` is shape-checked locally (a positive two-decimal amount) with a ceiling above the largest price, because the fee rides above INVO's card maximum.
244
+
245
+ **Refunds of coin purchases:** only unspent coins are refundable; spent coins are never refunded. Documented; no SDK call refunds a coin purchase.
246
+
247
+ **Paid trials on card subscriptions.** `subscriptions.create` accepts `trialAmountUsd` (with `trialDays` or `trialEnd`, card only, at least 0.50 and less than `amountUsd`): period 1 is charged the trial price inside the call and `amountUsd` from period 2. The consent object accepts `disclosedTrialAmountUsd`, `disclosedTrialDays` and `disclosedTrialEnd`, and returns `disclosed_trial_amount_usd`, `disclosed_trial_days` and `disclosed_trial_end`. The subscription gains `trialAmountUsd` and, on create and finalize bodies, `trialAmountCoinsEstimate`. Webhook types: `is_trial` on `subscription.renewed`; `is_trial` and `trial_amount_usd` on the trial period's `payment_failed`, `past_due`, `authentication_required` and `expired` (new `SubscriptionTrialEventFields`); `expire_cause` (`"trial_payment_failed"`) on `subscription.expired`. New error helpers: `isPaymentMethodRequired`, `isTrialAmountInvalid`, `isTrialAmountRequiresTrial`, `isTrialAmountNotSupportedForFunding`, `isConsentDisclosedTrialInvalid`. The SDK refuses, before the network and with INVO's own codes, a `trialAmountUsd` without a trial, with `walletOnly: true`, or on `steamInit`; the $0.50 floor and the "less than `amountUsd`" rule are left to INVO.
248
+
249
+ **README:** a new Tiers section (Open by default: you are the seller and handle tax; Merchant of Record by application: INVO is the seller and handles tax; fees per tier), the coin fee flow, the refund rule and paid trials. Every statement that INVO is the merchant of record on the card rail for everyone is removed.
250
+
251
+ All additive: no export was removed, renamed or retyped, and every new field on an existing type is optional.
252
+
253
+ ## 3.12.1
254
+
255
+ ### Patch Changes
256
+
257
+ - Docs: subscription packages.
258
+
259
+ The README's Subscriptions section gains a **Subscription packages** part. A package (the API calls it a plan) is what a developer sells: a name, a price, a billing interval and the `item_id` the game checks. Packages are created, edited, closed and reopened in the INVO dashboard with the developer's own sign-in, never with the game secret or a player token, so this SDK does not wrap them and has no `packages` or `plans` namespace. That is deliberate.
260
+
261
+ Nothing about an integration changes. `server.subscriptions.create(...)` and `steamInit(...)` still subscribe a member to an `itemId`, webhooks carry the same payloads, and entitlement still comes from `subscription.renewed`. A package's subscriber counts and monthly revenue are measured per title and `item_id`, so a new package immediately shows the members already subscribed to its item. The section also covers the two counts (`subscriber_count` on basis `active`, `live_subscriber_count` on basis `live`), who a price change applies to, and that closing a package cancels nobody. Full guide: https://docs.invo.network/docs/subscriptions-packages/
262
+
263
+ Doc correction: the subscription refund daily limit. The README and the `subscriptions.refund` JSDoc said a game's daily self-serve refund limit is $500 by default. It no longer is: by default the limit is never lower than the largest single subscription charge (`25000.00` USD today), so any single period can always be refunded on its own, and if INVO raises the per-charge maximum the limit rises with it. INVO can still set a specific limit for one game, which applies as set, even if lower. Everything else about refunds is unchanged: reaching the limit exactly still runs, going over it answers HTTP 202 `pending_approval`, and approved requests do not count toward the day. The sandbox recipe now says how to see a 202 (ask INVO for a low limit on the sandbox game).
264
+
265
+ Documentation only. No export was added, removed, renamed or retyped.
266
+
267
+ ## 3.12.0
268
+
269
+ ### Minor Changes
270
+
271
+ - The card maximum is INVO's, not the SDK's.
272
+
273
+ **INVO raised the maximum single card charge from $999.99 to $100,000.00 on 2026-09-18, and this package was refusing it.** The old limit was enforced client-side and threw before any network call, so a partner charging $50,000 failed inside the SDK and INVO never saw the request. The backend raise was invisible to every SDK user until this release. Per-customer velocity limits rose with it, to 100,000 per hour, 200,000 per day and 1,000,000 per month, all enforced by INVO.
274
+
275
+ **The design decision: the floor is a fact, the ceiling is a policy, and only facts belong in a client.**
276
+
277
+ $0.50 is the card rail's own minimum charge. Below it nothing settles in any environment, INVO holds it as a plain constant rather than a setting, and no configuration makes a smaller amount chargeable. That check stays exactly where it was and still throws before any request (`BELOW_STRIPE_MINIMUM`, `err.isBelowCardMinimum`).
278
+
279
+ The maximum is the opposite. It is a runtime setting an INVO admin edits without a deploy, and it differs between sandbox and production. Any number pinned in a published package is stale the moment somebody changes it, and the only remedy is a release, which is precisely the failure this release is repairing. So the local ceiling is **removed** rather than re-pinned at $100,000.00. It was not replaced by a fetch of the live limits either: that would turn one purchase call into two network calls, add a failure mode and a cache to a money path, and still be a snapshot rather than the truth at the moment of charge, because only the request itself is evaluated against the setting in force.
280
+
281
+ What remains is a structural bound. `usdAmount` and a card `totalPrice` must still be a positive amount with at most two decimals, and must still be at most `999999.99`, the same house ceiling every other money field in this SDK uses. That figure is deliberately **above** the largest value INVO's setting is permitted to take, so it can never refuse an amount INVO would have accepted. The invariant for anyone editing this later: the local bound must never be tighter than the server's maximum possible limit. This SDK may cost you a wasted round trip. It must never cost you a sale that a package upgrade would have allowed.
282
+
283
+ **What changed for you**
284
+
285
+ - Amounts between `999.99` and `999999.99` are now sent instead of being rejected locally. Nothing that worked before stops working; the validation only loosened.
286
+ - `err.isAboveCardMaximum` is unchanged and still means what it always meant, but it now arrives only from INVO (a `400`), never from the SDK. Nothing was charged.
287
+ - An amount above `999999.99` now throws `INVALID_INPUT` where it previously threw `ABOVE_CARD_MAXIMUM`. That range is malformed input, not a policy refusal, and INVO classifies it the same way.
288
+
289
+ **When INVO refuses an amount the SDK allowed**, catch `err.isAboveCardMaximum`. `err.message` carries the figure that was in force for that request, for example "Card purchases must be $100,000.00 or less." Do not retry it unchanged: lower the amount, split the sale, or ask INVO to raise the setting. The live figure for a tenant is also the `max_amount` of the hosted checkout's `validate-game` read, next to `min_amount`; read that if you want to show a limit in your own UI, and re-read it, because it can change under you. A velocity limit is a `429` with `err.retryAfter`, not this error.
290
+
291
+ **README: the minimum is $0.50.** The docs said only `0 < x <= 999.99` and left the floor unstated. They now state $0.50, which is what INVO advertises and what the card rail actually enforces. A $1.00 minimum was advertised by INVO's own checkout read until 2026-09-18 and was enforced nowhere; it is gone rather than enforced, because enforcing it would newly refuse charges between $0.50 and $0.99 that settle today.
292
+
293
+ No export was added, removed, renamed or retyped.
294
+
295
+ ## 3.11.0
296
+
297
+ ### Minor Changes
298
+
299
+ - The purchase status read, and the subscription fee is 7%.
300
+
301
+ **A buyer can always be told what happened to the money they paid.** `invo.checkout` (and the standalone `CheckoutClient`, for a page with no player token) reads `GET /api/checkout/sessions/<id>`, authenticated by the SESSION token; the id in the path is a label, not a credential. `getPurchaseStatus({ sessionId, sessionToken })` reads once; `waitForPurchase({ ..., intervalMs, timeoutMs, maxAttempts, signal, onUpdate })` polls until INVO says it is finished and returns that result. Six statuses, four of them terminal, plus `orderId`, `coinsCredited` / `transactionId` / `newBalance` on a credit, `reasonCode` + a player-safe `message` on a refusal, and both money figures (`amountChargedUsd`, `listedUsd`) so a buyer billed 206.29 for a 200 pack can be shown where the 6.29 went.
302
+
303
+ `terminal` is read off the response and is NEVER recomputed from `status`, so a status a later backend introduces cannot make this build decide a purchase finished, or finished well. A status it does not recognise is not terminal and is never a success. `paid_pending_credit` is deliberately not terminal at any age: INVO's reconciler recovers a stalled credit. A failed poll is not a failed purchase: network, timeout, 429 and 5xx are polled through; 401, 403 and 410 are raised at once (`isWrongSessionPurpose`, `isCheckoutSessionMismatch`, `isCheckoutSessionExpired`). On the cap `waitForPurchase` returns the last result it read rather than throwing, so the page keeps showing something true.
304
+
305
+ `CheckoutPurchaseStatus` is a widened union (`… | (string & {})`), not a literal one, and a tsc test pins that partner code storing or comparing an unknown status still compiles, which is the fix 3.10.0 had to make to `RefundResult` after the fact. It is named `Checkout…` because `PurchaseStatus` is already the direct `purchaseCurrency` result and is unchanged. New: `CheckoutClient`, `InvoClient.checkout`, `isPurchaseCredited` / `isPurchaseRefused` / `isPurchaseRefunded` / `isPurchaseExpired`, `nothingWasCharged` (true only where INVO said no money was taken; everything else, an unknown code included, happened after the card was charged, so never put a Try again on it), and the types `PurchaseStatusResult`, `PurchaseStatusInput`, `WaitForPurchaseInput`, `PurchaseRefusalReason`, `PurchaseCredited` / `PurchaseRefused` / `PurchaseRefunded` / `PurchaseExpired`, `CheckoutClientConfig`.
306
+
307
+ `createCheckout()` now also returns `sessionToken`, read from INVO's `session_token` field (backend commit `856fa266`) and falling back to the `checkout_url` query string only for a server that predates it, so nothing has to parse a URL to use the read. The two cannot disagree, and if a response ever carried both and they differed the field wins, because a query-key spelling is not a contract.
308
+
309
+ **Doc fix: INVO's subscription fee is 7% plus $0.30, not 10%** ($9.99 pays INVO $1.00 and you $8.99). Subscriptions became their own rate on 2026-09-17; item purchases stay at 10/90. No code change.
310
+
311
+ **Not included: withdrawals.** INVO's withdrawal request and history reads gained additive `kyc_hold`, `kyc_hold_reason` and `next_steps` fields on 2026-09-17. This package exposes no withdrawal surface at all, so there is nowhere for them to go, and adding one is a separate decision rather than part of a documentation pass.
312
+
313
+ **Fixed: the User-Agent version had drifted.** `SDK_VERSION` was left at `3.10.0` when 3.10.1 published, so every server call from 3.10.1 reported a version that was not the one running, and the test pinning it to `package.json` was failing on `main`. Back in step, and the pin is green.
314
+
315
+ ## 3.10.1
316
+
317
+ ### Patch Changes
318
+
319
+ - `linkDevice()` takes no arguments. The server mints the link id, so requiring one was wrong: callers had to invent a placeholder. The parameter stays optional and any value passed is still sent and ignored by the server, so code written against 3.10 keeps working unchanged. The README now also states that a tenant whose players enrol a passkey on the tenant's own domain MUST offer `linkDevice()`, because that credential can only be asserted on that tenant's origin, and that recovery is never the answer to `ENROLLMENT_REQUIRES_PROOF`.
320
+
321
+ ## 3.10.0
322
+
323
+ ### Minor Changes
324
+
325
+ - f66103c: Card-only subscriptions and subscription refund guardrails (INVO backend, 2026-09-17). Everything here is additive: no field, type or behaviour of an existing call was removed or renamed.
326
+
327
+ **Card-only subscriptions (behaviour change on INVO's side, no type changes).** A card subscription's card is now charged the full price every period; the member's coin wallet never pays for it and never moves. Steam subscriptions are unchanged (wallet first, Steam tops up the shortfall).
328
+
329
+ - `subscription.renewed` on the card rail: `funding.balance_applied_coins` is always `"0.00"`, `funding.card_charged_usd` is the price, `mint_order_id` is never `null`.
330
+ - Every paid card renewal also emits `purchase.completed` with `data.metadata.source === "subscription_renewal"`. Do not grant currency from it; `subscription.renewed` is the entitlement signal.
331
+ - A member with no saved card fails with `failure_code: "no_payment_method"` whatever their balance. New additive `failure_code`: `wallet_negative`.
332
+ - `walletOnly` is marked `@deprecated` (still accepted and returned): a wallet-only card subscription can never be paid (`failure_code: "wallet_only"`).
333
+ - `subscription.authentication_required`: `card_amount_usd` now equals `amount_due_usd` on card challenges.
334
+ - Doc fix: the `amountUsd` JSDoc now states the per-charge ceiling of `25000.00` (it still said `500.00`), and `SubscriptionExpiredData` no longer says `steam_containment` is sent.
335
+
336
+ **Subscription refund guardrails.**
337
+
338
+ - `subscriptions.refund` can now return a refund request. `RefundResult` stays a single interface (its `status` is typed `"refunded" | "pending_approval" | (string & {})`, so any string still assigns and compares); branch with the new `isRefundPendingApproval(r)` type guard, which narrows to `RefundPendingApproval`. `"pending_approval"` is the new HTTP 202: the refund would exceed the game's daily self-serve limit ($500 by default), nothing moved, and INVO reviews it as a refund request (`requestId`, `requestStatus`, `requestedAmountUsd`, `requestedAt`, `dailyCapUsd`, `executedTodayUsd`, `message`). Both carry every receipt field; the `request*` fields are optional on `RefundResult` and required on `RefundPendingApproval`. The status string is passed through from INVO unchanged.
339
+ - New optional result fields: `warnings` (`REASON_RECOMMENDED`, `REASON_TRUNCATED`), `subscriptionCanceled`, `subscriptionStatus`, `processingFeeUsd`, `processingFeeBasis`, `processingFeeBorneBy`, `processingFeeTransactionId`, `partnerTotalReversedUsd`, `initiation`, `refundRequestId`. `undefined` on receipts stored before the change.
340
+ - `reason` is documented as recommended now and required after a notice period. Refunds run within 30 days of the charge. A full refund cancels the subscription. Card-only periods are refunded in cash, partial included. The partner bears the card processor fee. INVO emails the member.
341
+ - New `InvoError` classifiers: `isRefundsNotEnabled` (403), `isRefundWindowClosed` (409), `isRefundRequestPending` (409), `isRefundRequestRejected` (409), `isConcurrentRequest` (409), `isRefundMismatch` (502), with body accessors `refundRequestId`, `decisionReason`, `periodChargedAt`, `refundWindowDays`, `refundWindowClosedAt`.
342
+ - New webhook types: `subscription.refund_requested`, `subscription.refund_approved`, `subscription.refund_rejected` (`SubscriptionRefundRequestData`, `SubscriptionRefundApprovedData`, `SubscriptionRefundRejectedData`). Additive fields on `subscription.refunded` (`refund.processing_fee_*`, `refund.partner_total_reversed_usd`, `initiation`, `refund_request_id`, `subscription_canceled`) and `subscription.canceled` (`cancel_cause: "full_refund"`).
343
+ - New exports: `isRefundPendingApproval`; types `RefundReceipt`, `RefundPendingApproval` (both extend `RefundResult`), `RefundWarning`, `RefundInitiation`, `RefundProcessingFeeBasis`.
344
+
345
+ **Compatibility.** Additive only. Code that compares `status` to any string, builds `RefundResult` mocks with a `string` status, or `extends`/`implements` `RefundResult` keeps compiling (pinned by a tsc test). `subscription.refunded`, `subscription.refund_approved` and, on a full refund, `subscription.canceled` are sent together and may arrive in any order.
346
+
347
+ README: the Subscriptions section states card-only funding, the renewal `purchase.completed` trap, the refund limits and the 202, the new events and classifiers, and "what did I earn" now subtracts `partner_total_reversed_usd`.
348
+
349
+ ## 3.9.0
350
+
351
+ ### Minor Changes
352
+
353
+ - The INVO-hosted card page is the recommended way to save a card for a subscription.
354
+
355
+ New on `invo.cards`:
356
+
357
+ - **`createSetupSession({ playerEmail, successUrl?, cancelUrl?, metadata? })`** ->
358
+ `{ sessionId, cardSetupUrl, expiresAt, raw }` (`POST /api/checkout/card-setup-sessions`,
359
+ game secret header). Mint a 10-minute link server-side, send the member to `cardSetupUrl`
360
+ (top-level, never framed), and read the saved card's `id` back from `cards.list`; it appears
361
+ there immediately, carries the off-session consent a subscription needs, and no event fires
362
+ for it. No browser code, no client secret, no card processor named anywhere, so INVO can change
363
+ processor without partners changing anything. Never auto-retried: each call mints a fresh link.
364
+ Script-scheme `successUrl` / `cancelUrl` values are refused before the network (`INVALID_INPUT`,
365
+ status 0), matching INVO's own rule.
366
+ - `beginSetup` / `confirmSetup` are now documented as the **processor-bound alternative**: they
367
+ hand back a `clientSecret` only the current processor's client library can consume, so a card
368
+ form built on them needs rework when INVO changes processor.
369
+
370
+ New error classifiers: `isPlayerNotFound` (404 `PLAYER_NOT_FOUND`: the card page never creates
371
+ players), `isInvalidPlayerEmail` (400 `INVALID_PLAYER_EMAIL`), `isInvalidInput` (`INVALID_INPUT`,
372
+ at status 0 from the SDK's own guards or 400 from INVO for a script-scheme URL).
373
+
374
+ Fixed: `subscriptions.get(id, { includePlayer: true })` never populated `player`. INVO puts
375
+ `player_email` / `player_name` on the subscription object itself, not in a separate block; they
376
+ are now surfaced as `subscription.playerEmail` / `subscription.playerName`, and `player` is
377
+ derived from them.
378
+
379
+ README: a "Cards for subscriptions" section a partner can follow start to finish (mint, send,
380
+ read the card back, subscribe, what each error means, the 10-minute session, no browser code).
381
+
382
+ README corrections that ride along in this release: `subscription.expired` no longer carries
383
+ `failure_code: "steam_containment"` (a balance is spendable in any title whatever rail bought
384
+ it, so the "wallet value that cannot be spent in this game" deferral is gone from the deferrals
385
+ paragraph and the event table); the Steam transfer-policy note now says it is a rule about
386
+ currency moving between titles, not about spending (an item purchase never fails on origin);
387
+ and "game" reads "title" in a few places so a platform tenant is not misled by the word.
388
+ Line endings: a `.gitattributes` (`* text=auto eol=lf`) keeps the packed README, CHANGELOG and
389
+ package.json LF on every checkout (3.9.0's first build packed CRLF from a Windows checkout).
390
+
391
+ ## 3.8.1
392
+
393
+ ### Patch Changes
394
+
395
+ - Subscription docs: the per-charge ceiling is 25000.00, not 500.00, and it is
396
+ per CHARGE rather than per month. An annual plan bills the whole year in one
397
+ go, so a $500 a month plan sold as a 12-month plan is a single $6,000 charge
398
+ and is chargeable. The old number quietly refused every annual plan above
399
+ $41.66 a month.
400
+
401
+ ## 3.8.0
402
+
403
+ ### Minor Changes
404
+
405
+ - Subscriptions are a first-class server surface, on both rails, with the card capture and the
406
+ sandbox clock tools beside them.
407
+
408
+ New on `InvoServer`:
409
+
410
+ - **`invo.subscriptions`**: `create` (card rail; charges the first period before answering,
411
+ idempotent on `clientRequestId`, a repeat is a typed `idempotentReplay: true` result),
412
+ `get`, `listForPlayer`, `cancel` (an already-terminal row is a 200 `alreadyCanceled`, never
413
+ thrown), `changeAmount` (staged for the next renewal), `setPaymentMethod`, `refund`
414
+ (idempotent; the receipt replays), `steamInit` and `steamFinalize` (Steam rail;
415
+ `alreadyProcessed` is a result, not an error).
416
+ - **`invo.cards`**: `beginSetup` / `confirmSetup` / `list`: the off-session card capture a
417
+ card subscription needs. The hosted checkout does not save a card for subscriptions.
418
+ - **`invo.sandbox.subscriptions`**: `advanceClock` / `forceRenewal` / `forceFailure` /
419
+ `forceAuthChallenge`. These post to `/subscriptions/<id>/...` **relative to the sandbox
420
+ base URL, not under `/api`**, and send `X-Sandbox-Clock-Key` from the new
421
+ `sandboxClockKey` config; a missing key throws before the network.
422
+
423
+ Typed results: `SubscriptionResult` (the subscription object with its TWO clocks,
424
+ `firstCharge` with `paidPeriodSeq`, `card`, `idempotentReplay`), `FirstCharge` (`paid` |
425
+ `requires_action` | `skipped_trial` | `failed` | `pending` | `pending_authorization`),
426
+ `SteamInitResult` (`steamOrderId` for the client callback, `amountCoins`, `pendingReuse`),
427
+ `CancelResult`, `ChangeAmountResult`, `RefundResult`, `CardSetupResult`, `SandboxClockResult`
428
+ (`engineStats`), and typed `data` for all seven `subscription.*` webhook events.
429
+
430
+ Error classifiers: `isActiveSubscriptionExists` (+ `existingSubscriptionId`),
431
+ `isIdempotentReplayMismatch` (+ `mismatchedFields`), `isSteamReauthorizationRequired`,
432
+ `isNotACardSubscription`, `isSteamChannelRequired`, `isSubscriptionTerminal`,
433
+ `isNotAuthorized`, `isSandboxClockUnauthorized`, `isSteamRefundNotSupported`, `isFlowPaused`,
434
+ `isGameNotLive`; `isSteamAuthorizationPending` now also covers the subscription 409.
435
+
436
+ Also: the server `User-Agent` version now derives from the package version (it had read
437
+ `3.0.0` since 3.0.0), pinned by a test.
438
+
439
+ ## 3.7.0
440
+
441
+ ### Minor Changes
442
+
443
+ - Device approval grant (RFC 8628) is now a first-class server surface — including **the
444
+ step that moves the money**.
445
+
446
+ An integrator followed the README, polled a grant to `approved`, and stopped. Nothing
447
+ moved: an approved grant is a _factor_, and the transaction sat at
448
+ `pending_pin_verification` until it expired and was refunded. The README's section ended
449
+ at the poll and neither package had a method for the step after it. Both halves of that
450
+ are fixed here.
451
+
452
+ New on `InvoServer` (all authenticate with the **player token** — on a console the game
453
+ server holds the token it minted, and the game secret is never sent):
454
+
455
+ - `beginDeviceApproval({ playerToken, transactionId, flow, channel? })` → the RFC 8628
456
+ §3.2 grant (`deviceCode`, `userCode`, `verificationUriComplete`, `expiresIn`,
457
+ `interval`, `channel`). `channel: "popup"` is refused before the network — it is
458
+ browser-only (`InvoClient.approveHosted`).
459
+ - `pollDeviceApproval({ playerToken, deviceCode })` → a typed outcome
460
+ (`authorization_pending` / `slow_down` / `approved` / `access_denied` /
461
+ `expired_token`), plus the `enrollment` object while a first-time phone waits on the
462
+ game screen. `invalid_grant` throws.
463
+ - `confirmDeviceEnrollment({ playerToken, deviceCode, decision })` → answers the
464
+ on-screen match-code prompt (`"approve"` | `"deny"`).
465
+ - **`approveWithDeviceCode({ playerToken, transactionId, flow, deviceCode })` — the money
466
+ step.** Routes by flow: `send` → `/api/sdk/send/{id}/approve`, `transfer` →
467
+ `/api/sdk/transfers/{id}/approve`, `send_receipt` →
468
+ `/api/sdk/send/{id}/confirm-receipt`, `transfer_receipt` →
469
+ `/api/sdk/transfers/{id}/confirm-receipt`. Never auto-retried.
470
+ - `completeDeviceApproval(...)` — convenience loop: polls honouring `interval` and
471
+ `slow_down`, surfaces the enrollment prompt, then calls `approveWithDeviceCode`.
472
+
473
+ **`TRANSACTION_NOT_PENDING` is a result, not a throw.** `approveWithDeviceCode` returns
474
+ `{ status: "not_pending", alreadySettled, currentStatus }` so "your earlier attempt
475
+ already landed" is distinguishable from a real refusal **without string-matching** — the
476
+ difference between "the guard worked" and "her currency is stuck". Every other refusal
477
+ stays a typed thrown `InvoError`.
478
+
479
+ `alreadySettled` is **flow-aware and fails closed**. The four endpoints gate on different
480
+ status sets — the sender approves accept `pending_pin_verification` /
481
+ `pending_verification`, the two receipt endpoints accept `pending_claim` / `verified` — so
482
+ a receipt settle landing on `pending_pin_verification` means the SENDER has not approved
483
+ yet (possibly held at a guardian 202). That is _before_ the step, not past it, and calling
484
+ it settled would tell a game to hand over goods for value never credited. It is an
485
+ allow-list per flow rather than a "not expired/failed" deny-list, so a status INVO adds
486
+ later answers `alreadySettled: false` with `currentStatus` set — go read the transaction —
487
+ instead of defaulting to "the money moved" in already-deployed copies of this SDK.
488
+
489
+ Older backend bodies that carried only the message ("Transaction not pending…", "…cannot
490
+ be confirmed…") with no machine code are matched too, but narrowly: HTTP 400, one of those
491
+ two phrases, **and** a readable `(current status: …)` / `(status: …)` clause. "cannot be
492
+ confirmed" is ordinary English, so a phrase match alone can never assert that money moved.
493
+
494
+ New `InvoError` predicates: `isTransactionNotPending`, `currentTransactionStatus`,
495
+ `isDeviceApprovalNotApproved`, `isDeviceApprovalAlreadyPending`,
496
+ `deviceApprovalExpiresAt`, `isSettleFault`, `errorRef`. The RFC 8628 §3.5 tokens are
497
+ promoted onto `err.code`.
498
+
499
+ Two safety fixes in `completeDeviceApproval`: `transactionId` is validated **before** the
500
+ loop (an empty id used to poll for minutes, let the player approve, and only then throw —
501
+ an approved grant with nothing settled), and the `respond` callable handed to
502
+ `onEnrollment` now resolves quietly for every "the prompt is moot" refusal
503
+ (`expired_token`, `invalid_grant`, and the two enrollment 409s) instead of rejecting. A
504
+ prompt on a TV routinely outlives its ten-minute grant, callers fire `respond` without
505
+ awaiting it, and an unhandled rejection exits a Node process.
506
+
507
+ README: the console section is rewritten around begin → show the QR → poll → **call
508
+ `approveWithDeviceCode`** → webhooks, with the supersede-vs-409 begin semantics corrected
509
+ and "consumed when used" replaced by _when_ the code is spent. A new top-level **Sends and
510
+ transfers, stage by stage** section covers both flows and both sides with a
511
+ call-order table, an error table, and a common-mistakes box led by "polling to `approved`
512
+ and stopping". The error tables now also carry the receipt-flow-only refusals a console
513
+ recipient meets (`receiver_not_enrolled_use_claim_code`, `not_intended_receiver`, the
514
+ phone-share 409, `RECIPIENT_IDENTITY_PENDING` / `_DECLINED`) and a warning that a settle
515
+ FAILURE is ambiguous about the money — INVO commits and then reads the transaction back to
516
+ build its 200, so a `*_FAILED` or a timeout can both describe money that already moved:
517
+ read the transaction status before telling the player it failed, and never auto-start a
518
+ replacement. SMS is now confined to a clearly-labelled legacy-fallback subsection.
519
+
520
+ ## 3.6.0
521
+
522
+ ### Minor Changes
523
+
524
+ - New: `InvoClient.approveHosted({ transactionId, flow })` — web games approve on INVO's
525
+ hosted identity page. The browser is the RFC 8628 client: with the player token it already
526
+ holds, the SDK calls `POST /api/sdk/approvals/device/begin` with `channel: "popup"` (INVO
527
+ records the page's `Origin` as the popup's opener), opens the hosted page in a popup
528
+ (synchronously, inside your click handler), polls `poll` honouring `interval` and
529
+ `slow_down` (+5 s), drives the INVO-branded match-code prompt from the poll's `enrollment`
530
+ object ("Set up INVO on iPhone? Code 48-27. Say Yes only if the phone you just
531
+ scanned/opened shows this code." → `confirm-enrollment`; `confirmed` shows "Finishing on
532
+ iPhone… / Stop it, wrong code"; a 409 already-decided takes it down quietly), and when the
533
+ poll says `approved` calls the flow's approve endpoint with the `device_code` —
534
+ `transfers/{id}/approve`, `send/{id}/approve`, `send/{id}/confirm-receipt`,
535
+ `transfers/{id}/confirm-receipt`. Resolves `{ status: "approved", approval }` (the same
536
+ `ApproveResult` / `ConfirmReceiptResult` the in-app calls return) or `denied` / `expired` /
537
+ `closed` / `blocked` / `redirected`; rejects with `InvoError` when the backend refuses.
538
+ `device_code` lives in the call's closure only — never on the result, never logged. The
539
+ page's `postMessage` is a wake-up that triggers an immediate poll (accepted only from the
540
+ hosted page's https origin and only from the popup the SDK opened), never a result. A
541
+ popup blocked by the browser resolves `blocked` before anything is started (default);
542
+ `popupBlocked: "redirect"` opts in to a full-tab redirect. A page sending
543
+ `Cross-Origin-Opener-Policy: same-origin` is detected and reported as `blocked` with a
544
+ hint. Your server does nothing new; its `device_approval.approved` webhook still fires.
545
+ In-app partner-domain passkeys are unchanged and remain supported. `onEnrollment(e,
546
+ respond)` + `renderPrompt:false` let a game draw its own prompt.
547
+
548
+ Docs: new "Web games — approving on INVO's hosted page" section; the console-flow poll
549
+ example now shows `match_code`. Test-only devDependency added: `happy-dom`.
550
+
551
+ Docs (hosted identity pages, Phase 7): the console section documents `channel` on
552
+ `begin` (`qr` default | `popup` — the browser must call `begin` itself, its https `Origin`
553
+ becomes the popup's opener, server-to-server callers are refused | `app_browser` — the
554
+ mobile plugins; the return scheme `invo-sdk-<game_id>` is derived server-side), the echoed
555
+ `channel` on the begin body, `recovery` on the poll's `enrollment` object, the hosted
556
+ passkey-recovery flow (screen confirm + emailed single-use link → old INVO passkeys
557
+ deactivated, `identity.passkey_reset` webhook, 24-hour `PASSKEY_RECOVERY_COOLDOWN` on
558
+ money out; receiving unaffected), the mobile auto-confirm note (`app_browser` enrolment is
559
+ confirmed by INVO, no prompt), and `ENROLLMENT_REQUIRES_PROOF` on the page. Sends &
560
+ transfers: guardian approval now goes by email first (`consent_channel` and
561
+ `resend_endpoint` on the raw 202 `guardian_approval` block; `decision_source: "email_link"`),
562
+ the once-per-approval `POST /api/sdk/approvals/guardian/{approvalId}/resend` `{channel:"sms"}`
563
+ contract (initiator's token; 403/409/410/503 codes), and phone-share / recipient-identity
564
+ consents on the same hosted page (unchanged 409 / 202 codes, `consent_channel` on the
565
+ phone-share body). Passkeys: the partner-domain freeze — new titles have nothing to verify
566
+ (`409 PARTNER_RP_FROZEN`; `WEBAUTHN_NOT_ENABLED_FOR_TENANT` is the expected state, use
567
+ `approveHosted`), tenants with a domain verified before the freeze keep it, removal is
568
+ irreversible. The "SMS first, then email" fallback sentence corrected to "email first, SMS
569
+ on request". Documentation only.
570
+
571
+ ### Patch Changes
572
+
573
+ - Docs: the device-approval page (RFC 8628, consoles / TVs / native Steam and desktop
574
+ clients) now enrols the player's INVO passkey on the **first** scan, and the proof is the
575
+ game screen: the phone says "confirm on your game screen", the game shows "Set up INVO on
576
+ this phone: iPhone?", the player presses Yes on the console, and the phone's biometric
577
+ creates the passkey and approves — no code to type, no SMS; every later scan is scan,
578
+ biometric, done. The "the player needs an INVO passkey" bullet is replaced accordingly.
579
+ Documents the two integrator-facing additions: the `enrollment` object
580
+ (`state` / `device_label` / `requested_at`) on the `authorization_pending` poll body while
581
+ a phone is waiting, and `POST /api/sdk/approvals/device/confirm-enrollment`
582
+ (`{device_code, decision: "approve" | "deny"}`, same auth as begin/poll; deny ends the
583
+ grant with `access_denied`), plus the backup email. Also documents two backend
584
+ behaviours: `begin` extends the transaction's own approval window past the code's expiry
585
+ (`transfer` / `send`), and `begin` may be called again for the same transaction once an
586
+ approved code's window has passed. Documentation only — no code or type changes; the
587
+ `begin`/`poll` endpoints, the `device_approval.approved` webhook and its `method` value
588
+ are unchanged.
589
+
590
+ Also on the send side: the claim SMS now carries a link to a hosted INVO claim page where
591
+ a recipient without the game collects with one email + an emailed code + their phone's
592
+ passkey (in-game claim unchanged; `transfer.received` fires the same); documents the
593
+ sender-token REST call `POST /api/sdk/send/{transactionId}/resend-claim` (30-second
594
+ cooldown, 10 per transaction per hour — no SDK method); and that an uncollected send is
595
+ still refunded at 24 hours but the sender is now emailed and the recipient texted, with
596
+ `transfer.claim_expired` / `transfer.refunded` as the source of truth. The `transfer.*`
597
+ rows were added to the event-types table.
598
+
599
+ - df2efe9: Docs: add an explicit per-platform verification/approval recommendation. The
600
+ "gold standard" section now spells out which method fits which client — a passkey
601
+ directly on mobile app/web and desktop web, and the QR device-approval flow
602
+ (RFC 8628) on consoles **and** on native Steam / desktop game clients (Mac &
603
+ Windows), where it is the embedded game client, not the OS, that can't invoke the
604
+ platform authenticator. Also documents the SMS-first-then-email fallback for
605
+ remote approvals with no passkey path. Documentation only — no code or type
606
+ changes; the `VerificationMethod` union and the device-approval REST flow are
607
+ unchanged.
608
+
609
+ All notable changes to `@invonetwork/web-sdk` are documented here. This project follows
610
+ [Semantic Versioning](https://semver.org/). Releases are managed with
611
+ [changesets](https://github.com/changesets/changesets).
612
+
613
+ ## [3.5.0] - 2026-09-01
614
+
615
+ **The Steam purchase flow is now first-class SDK surface: `steamPacks()`, `steamInitPurchase()`, `steamFinalizePurchase()`** — plus browser-based checkout for platforms where the Steam overlay does not render, a finalize-poller error taxonomy, and webhook `channel` typing. No breaking changes.
616
+
617
+ Until now the SDK only _steered away_ from Steam (`purchaseCurrency` fails fast on `rail: "steam"`); the dedicated endpoints had to be called by hand. All three are typed methods now, and the fail-fast message names them.
618
+
619
+ ### Added
620
+
621
+ - **`InvoServer.steamPacks(query?)`** — the pack catalogue. `currencyAmount` is per-player (VAT and the storefront's revenue share come out of the sticker before currency is derived — a $4.99 pack yields 34, not 50, units at $1 = 10). Render it verbatim; never compute currency from price and never cache one answer for all players.
622
+ - **`InvoServer.steamInitPurchase(input)`** — start the purchase. Idempotent on `purchaseReference` (retries, including manual retries after a 409, MUST reuse it). New authorization modes:
623
+ - `usersession: "client"` (default, unchanged): Steam overlay in-game. The SDK sends **no** `usersession` key at all in this mode, pinned by test, so existing behaviour cannot shift.
624
+ - `usersession: "web"`: for platforms where the overlay does not render (observed: Electron on macOS). Requires `playerIp` — the PLAYER's address, never your server's; refused client-side before the network without it. Returns `steamCheckoutUrl`: Steam's own hosted approval page, which must open as a **top-level tab** (it cannot be iframed). _Note: Steam's sandbox issues checkout URLs its production host will not serve, so web-session approval is provable only against production; the rest of the flow is identical to client-session._
625
+ - `metadata` — echoed on the `purchase.completed` webhook (`data.metadata`) — the way to correlate your own player/order ids. The Steam rail merges its own context keys (`steam_wallet_currency`, `steam_country`, `steam_account_status`, `vat_rate_pct`) into the echoed object; avoid those names in yours.
626
+ - **`InvoServer.steamFinalizePurchase({orderId})`** — capture + credit. Idempotent: a replay returns `alreadyProcessed: true` and never credits twice.
627
+ - **Finalize poller taxonomy on `InvoError`** — because _not every 409 means "not yet"_, and a poller that assumes so polls a dead order forever:
628
+ - `isSteamAuthorizationPending` — player has not approved yet (Steam reports `Init`). The normal wait state; poll again.
629
+ - `isSteamAuthorizationDead` — any settled status — `Cancelled`, `Failed`, `Refunded`, `Chargedback`, and every other non-Init outcome (pending is the CLOSED set: only `Init` means "not yet"). Stop; no later call can succeed.
630
+ - The two are mutually exclusive by construction, and a test pins that they can never both answer true.
631
+ - **`InvoError.isPartnerCreditUnavailable`** (`PARTNER_CREDIT_UNAVAILABLE`, 409) — the studio's settlement float cannot cover the purchase. Structure is fine; the money is not. Plain failure toast; do **not** hot-poll init (each attempt briefly re-reserves headroom), and reuse the same `purchaseReference` on manual retry.
632
+ - **`InvoError.isPartnerRailSuspended`** (`PARTNER_RAIL_SUSPENDED`, 409) — terminal from the game's seat. The umbrella `isPartnerSettlementUnavailable` still covers both.
633
+ - **`InvoError.isUnknownSteamPack`** (400) — re-fetch `steamPacks()`; the body's `valid_pack_ids` lists what exists.
634
+ - **`InvoError.isMissingPlayerIp`** (400) — always an integration bug on web sessions.
635
+ - **`PurchaseCompletedData.channel`** — which storefront the purchase came from (`"steam"` / `"ios"` / `"android"` / `"web"` / `"console"`), beside `rail`. `null` means a legacy game key: a real answer ("unattributed"), read it as one.
636
+
637
+ ### Changed
638
+
639
+ - `purchaseCurrency`'s `rail: "steam"` fail-fast message now names the real methods instead of vaguely citing "dedicated endpoints".
640
+
641
+ ## [3.4.0] - 2026-09-01
642
+
643
+ **A Steam title now bills through its OWN Steam application.** New error helpers;
644
+ no breaking changes to any existing method or type.
645
+
646
+ ### Why this is a real change and not a doc tidy
647
+
648
+ Steam pays whoever owns the Steam application. Until now, INVO documented a
649
+ single INVO-owned Steam app that billed every title on the network — so a studio
650
+ had nothing to register and the money reached them through INVO. That model is
651
+ gone. Each title sells through the studio's own Steam app, the money lands in
652
+ their own Steamworks account, and INVO issues the player's currency immediately
653
+ and settles with the studio afterwards against a payment method on file.
654
+
655
+ If you shipped against 3.3.0 or earlier and your Steam integration works today,
656
+ nothing in your code needs to change. What changes is the **studio's** one-time
657
+ setup, and the errors you may now see if they have not done it.
658
+
659
+ ### Added
660
+
661
+ - `InvoError.isSteamNotConfigured` — the title has no Steam application
662
+ registered with INVO yet (`STEAM_NOT_CONFIGURED`, 503).
663
+ - `InvoError.isPartnerBillingNotSetUp` — the studio has not finished INVO billing
664
+ setup (`PARTNER_BILLING_NOT_SET_UP`, 409).
665
+ - `InvoError.isPartnerSettlementUnavailable` — settlement suspended or over
666
+ limit (`PARTNER_RAIL_SUSPENDED` / `PARTNER_CREDIT_UNAVAILABLE`, 409). Show a
667
+ neutral "purchases are unavailable right now": it is not the player's problem.
668
+ - `InvoError.isSteamAppChanged` — the order was started against a different
669
+ Steam application than the title is configured for now (`STEAM_APP_CHANGED`,
670
+ 409). Only reachable if a studio swaps apps mid-flight.
671
+
672
+ All four are refused **before the player is charged**, which is the point.
673
+
674
+ ### Changed
675
+
676
+ - README: the Steam section now documents the studio's Steamworks setup
677
+ (microtransactions enabled, a publisher-GROUP Web API key that includes the
678
+ app, appid + key entered in the INVO dashboard, payment method on file).
679
+ - README: removed the claim that no Steam-side registration was required.
680
+
681
+ ## [3.3.0] - 2026-08-31
682
+
683
+ **Documentation only. No code changes, no API changes.**
684
+
685
+ Documents **Device Approval** — passkey step-up for consoles, TVs and any device
686
+ with no browser. It is the OAuth 2.0 Device Authorization Grant
687
+ ([RFC 8628](https://datatracker.ietf.org/doc/html/rfc8628)), so a standard
688
+ client library understands the responses.
689
+
690
+ - The device shows a short code and a QR (`verification_uri_complete`); the
691
+ player approves on their phone; your **server** polls
692
+ `POST /api/sdk/approvals/device/poll` until it hears back.
693
+ - **One approval authorises one transaction.** Unlike the plain RFC 8628 grant,
694
+ which authorises a _client_, an INVO device code is bound to the transaction
695
+ you named and is consumed when used — it cannot approve anything else and
696
+ cannot be reused.
697
+ - `user_code` is meant to be seen; `device_code` is not. Poll from your backend.
698
+ - Subscribe to `device_approval.approved` to learn the moment an approval lands
699
+ instead of waiting for the next poll. Polling still works alone.
700
+ - Available to every title with nothing to configure — the constraint is a
701
+ property of the _device_, not the game, so a title with a website and a
702
+ console build uses the normal ceremony in the browser and this one on console.
703
+ - Currency purchases on a console go through that console's store, as the
704
+ platform holder requires; this flow is for approving transfers and sends.
705
+
706
+ Minor rather than patch because it documents a new API surface. The snippets are
707
+ pinned by a test against this file, for the same reason the Steam ones are: a
708
+ REST flow with no SDK method behind it is the one thing no other test can see.
709
+
710
+ ## [3.2.3] - 2026-08-28
711
+
712
+ **Documentation only. No code changes, no API changes.** Corrects two errors in
713
+ the 3.2.2 Steam snippets that made them fail if copied.
714
+
715
+ - **Base path.** The snippets said `/api/enhanced-purchase/...`. The routes are
716
+ mounted at **`/api/currency-purchases/...`** -- `enhanced_purchase_api` is the
717
+ module name, not the mount point. Copying 3.2.2 returned `404 Resource not
718
+ found`, which reads like the Steam rail is unavailable rather than like a
719
+ wrong URL.
720
+ - **Auth header.** The snippets sent `X-Game-Secret`. The header is
721
+ **`X-Game-Secret-Key`**, as it is everywhere else in this document. An unknown
722
+ header is ignored, so the request arrived unauthenticated.
723
+
724
+ Both were confined to the Steam section added in 3.2.2; every other snippet was
725
+ correct. The Steam flow itself is unchanged -- pack catalogue, `pack_id`,
726
+ VAT-aware amounts, all exactly as 3.2.2 describes.
727
+
728
+ The paths and header are now pinned by a test against this file, because the
729
+ Steam section is the one snippet with no SDK method behind it and so was the one
730
+ thing no test could see.
731
+
732
+ ## [3.2.2] - 2026-08-28
733
+
734
+ **Documentation only. No code changes, no API changes.**
735
+
736
+ Steam currency purchases now work on a **pack model**, and this documents it. The
737
+ 3.2.1 notes described an earlier design that has been replaced -- read this
738
+ instead.
739
+
740
+ - **INVO owns the Steam pack catalogue.** You do not set prices and you never
741
+ send an amount. Fetch `GET /steam/packs?steamid=...`, render it, and pass a
742
+ `pack_id` to `/steam/init-purchase`. An amount is refused with
743
+ `400 UNKNOWN_STEAM_PACK`.
744
+ - **The price is identical everywhere; the currency inside is not.** Steam prices
745
+ are VAT-inclusive wherever VAT is collected, so more of a fixed price goes to
746
+ tax in a high-VAT country -- the same $9.99 pack yields 69 units in the US and
747
+ 58 in France.
748
+ - **Always pass `steamid`** when fetching the catalogue. Without it amounts are
749
+ quoted with no VAT deducted, so a store promises more than the purchase
750
+ delivers. Do not cache one catalogue for all players.
751
+ - A Steam-distributed title may only sell currency on the `steam` rail
752
+ (`409 STEAM_PURCHASE_LAYER_REQUIRED`), and a locked Steam account is refused up
753
+ front (`409 STEAM_ACCOUNT_LOCKED`).
754
+
755
+ Steam remains a server-to-server REST flow rather than an SDK method, because the
756
+ purchase is authorised inside the Steam client and your game relays that.
757
+
758
+ ## [3.2.1] - 2026-08-28
759
+
760
+ **Documentation only. No code changes, no API changes.**
761
+
762
+ Documents two things about the Steam rail that the SDK does not change but every
763
+ Steam integration has to handle:
764
+
765
+ - **Currency for a Steam-distributed title must be bought on the `steam` rail.**
766
+ Any other rail is refused with `409 STEAM_PURCHASE_LAYER_REQUIRED`. This is a
767
+ platform requirement and it applies across every storefront the title ships on,
768
+ because a player's balance is shared between them.
769
+ - **The player is charged more than the value you request.** Steam's platform
770
+ commission is priced into the charge rather than absorbed, so the Steam
771
+ init-purchase response now carries `charged_usd` alongside `value_usd`. Show
772
+ `charged_usd` in your store. The currency the player receives is unchanged, so a
773
+ pack is worth the same in-game on every rail, and the rate is configuration --
774
+ read the response rather than hard-coding a multiplier.
775
+
776
+ ## [3.2.0] — 2026-08-24
777
+
778
+ **Storefront keys.** A game that ships on more than one storefront now gets one SDK
779
+ key per storefront -- `steam`, `ios`, `android`, `web`, `console` -- all valid at the
780
+ same time, and the key determines the payment rail. Construct one client per key and
781
+ use whichever matches where the player is buying. **Additive: no behavior changes, no
782
+ API removals.** A single existing key keeps working exactly as it does today, `rail`
783
+ included, with no deadline and no migration.
784
+
785
+ Three new typed error predicates for refusals this SDK previously surfaced only as a
786
+ raw `code` string:
787
+
788
+ - `InvoError.isRailChannelMismatch` -- the `rail` you sent disagrees with the storefront key
789
+ you authenticated with (400). The fix is to stop sending `rail`; the key already
790
+ determines it. INVO refuses rather than silently overriding, because overriding
791
+ would bill a player through a route you did not ask for.
792
+ - `InvoError.isSteamRailNotEntitled` -- a Steam purchase was attempted for a title INVO has
793
+ not registered as distributed on Steam (403). Holding a `steam` storefront key does
794
+ not by itself register the title.
795
+ - `InvoError.isSteamPurchaseLayerRequired` -- a title distributed on Steam tried to sell currency
796
+ on a non-Steam rail (409). Use the dedicated Steam purchase flow.
797
+
798
+ Also in this release: the 3-D Secure completion method's documentation no longer names
799
+ a payment processor. INVO does not name processors in developer-facing surfaces, and
800
+ this line had been an exception to that for some time.
801
+
802
+ Also in 3.2.0: **provider-neutral error codes.** INVO stamps a neutral alias
803
+ (`error_code_public`) beside any machine code that carries a payment
804
+ processor's name. This SDK previously read only the raw code, so a partner
805
+ branching on `err.code` had to hard-code a vendor name INVO's own public
806
+ documentation is not allowed to print. `err.code` is now the neutral alias when
807
+ one exists (`STRIPE_ERROR` becomes `PROCESSOR_ERROR`), and the literal wire value stays reachable on
808
+ `err.rawCode` for anyone already matching it. Refund reads prefer
809
+ `processor_refund_reference` over the vendor-named field, with a fallback.
810
+
811
+ **Storefront keys are still server-side keys.** A storefront key names where the
812
+ _purchase_ came from, not where the key lives. It belongs in your backend exactly like
813
+ your original key -- never in a game client, an app bundle, or browser code.
814
+
815
+ ## [3.1.0] — 2026-08-04
816
+
817
+ **Passkeys are the gold standard; the SMS-PIN path is deprecated.** This release makes INVO's
818
+ authentication guidance explicit in the two places developers actually look — the README and IDE
819
+ autocomplete. **No behavior changes, no API removals, no runtime warnings.** Upgrading and
820
+ changing nothing produces byte-identical runtime behavior.
821
+
822
+ A passkey is a phishing-resistant, origin-bound WebAuthn assertion. An SMS PIN is a shared secret
823
+ on a channel exposed to SIM swap and interception. They were documented as interchangeable
824
+ verification options; they are not, and the docs said so in a way that produced PIN-first
825
+ integrations.
826
+
827
+ ### Added — error-contract classifiers
828
+
829
+ Three 403s that previously arrived as a generic `InvoError` (correct `status`/`code`/`message`,
830
+ but no typed branch) now have classifiers:
831
+
832
+ - **`err.isSourceGameNotLive`** — the caller's OWN game is in testing. Self-serve: switch it to
833
+ Live in the console (Game Settings → Status).
834
+ - **`err.isTargetGameNotLive`** — the DESTINATION game is in testing. Usually another
835
+ developer's game, so the caller **cannot** fix it. **Deliberately distinct** from the source
836
+ case: collapsing them into one "not live" branch yields a "go fix it" CTA that dead-ends half
837
+ the time.
838
+ - **`err.gameStatus`** — the `game_status` field from either refusal (e.g. `"testing"`).
839
+ - **`err.isWebauthnNotEnabledForTenant`** — tenant has no verified WebAuthn RP ID. **This is
840
+ configuration state, not a failure**: fall back to the SMS/in-app path instead of surfacing an
841
+ error. Currently the common case — 4/23 sandbox and **0/3 production** tenants are configured.
842
+
843
+ Note the backend splits field names across these: the `*_GAME_NOT_LIVE` pair uses
844
+ `error_code`/`message`, while `WEBAUTHN_NOT_ENABLED_FOR_TENANT` uses `code`/`error`. The SDK
845
+ already read both, so `err.code` is populated either way — the new tests pin both shapes.
846
+
847
+ ### Clarified — the SDK does not, and did not, collapse non-2xx into transport errors
848
+
849
+ Following a report of a `403` being debugged as a network outage: verified end-to-end that a
850
+ non-2xx always surfaces with its real `status`, `code`, and `message`, and that `status: 0` is
851
+ reserved for a genuine absence of an HTTP response. **No fix was needed in the SDK** — the loss
852
+ happened in an integration-layer catch-all. Added regression tests pinning the behavior, plus a
853
+ README section (**"`.status === 0` means 'no HTTP response' — and nothing else"**) showing the
854
+ anti-pattern and the correct handler, and a note that `409` is a retryable not-ready state
855
+ rather than a failure.
856
+
857
+ ### Deprecated
858
+
859
+ - **`InvoServer.verifySmsTransfer` / `InvoServer.verifySmsSend`** — marked `@deprecated`. They
860
+ still work exactly as before and still hit the same endpoints. A **future major version will
861
+ remove them**; no date is committed yet. Keep them only as a genuine last resort for users who
862
+ cannot enroll a passkey (unsupported device, no platform authenticator) or who decline.
863
+ **Migration:** when `initiateSend`/`initiateTransfer` returns `verificationMethod: "sms"`, read
864
+ it as _"this sender has no passkey"_ — prompt `InvoClient.enrollPasskey()` and then
865
+ `InvoClient.approveSend` / `approveTransfer`, instead of routing to a PIN pad.
866
+
867
+ ### Changed (documentation only)
868
+
869
+ - New README section — **"Passkeys are the gold standard — don't build on SMS"** — with the
870
+ do/don't table, the deprecation notice, and an explicit list of the OTP surfaces that are
871
+ **not** discouraged.
872
+ - `VerificationMethod`, `InitiateResult.verificationMethod` and `SmsVerifyResult` doc comments
873
+ reframed: `"in_app"` and `"sms"` are no longer presented as peer options.
874
+ - "Before you go live" now stresses configuring RP ID / origins _before_ launch, since an
875
+ unconfigured tenant silently drops every sender onto the deprecated path.
876
+ - **New "Prerequisite: passkeys are dark until your tenant verifies a domain" subsection.**
877
+ Recommending passkeys without saying what unlocks them would send developers straight into a
878
+ `403` on their first `enrollPasskey()` call — with 0/3 prod tenants configured, that is
879
+ currently _everyone_. The deprecation carries no removal date for the same reason.
880
+ - Stability section corrected — it still claimed `2.0.0` was the only major, which `3.0.0`
881
+ made false.
882
+ - Design doc: `docs/features/passkey-first-authentication.md`.
883
+
884
+ ### Not affected — still recommended
885
+
886
+ `enrollmentBegin`/`enrollmentVerify`, `recoveryBegin`/`recoveryComplete`, and
887
+ `phoneShareInitiate`/`phoneShareApprove` all involve a one-time code but are the on-ramp _to_ a
888
+ passkey (or phone-ownership consent), not a substitute for one. They are **not** deprecated.
889
+
890
+ ### Upgrade note
891
+
892
+ The only way this release can surface in a pipeline is a lint rule that treats `@deprecated`
893
+ usage as an error (e.g. `deprecation/deprecation` with `--max-warnings 0`). That is a lint-level
894
+ signal, not a build or runtime break, and it is the intended notice.
895
+
896
+ ## [3.0.0] — 2026-07-20
897
+
898
+ **BREAKING — the Platform Commerce card leg moved to INVO's hosted checkout.** The backend now
899
+ hosts the entire card flow (card fields, Apple Pay / Google Pay, billing-address collection,
900
+ 3-D Secure) on its own checkout page, so the browser card-element surface shipped in 2.5.x is
901
+ gone. Card sales are simpler AND safer: server creates → buyer pays on `checkoutUrl` → fulfill
902
+ on the `platform_commerce.purchased` webhook. Note: the card leg is pending final enablement on
903
+ the backend (sandbox payment test) — the balance leg is fully live.
904
+
905
+ ### Migration from 2.5.x (card leg only — balance/status/refund/webhooks unchanged)
906
+
907
+ - `platformCommerce.purchase({ fundingSource: "card" })`: **remove `billingAddress`** (the type
908
+ is gone; the hosted page collects it) and optionally pass `successUrl` / `cancelUrl` /
909
+ `metadata`. The result now carries `checkoutUrl` / `sessionId` / `expiresAt` (unix seconds) /
910
+ `idempotentReplay` — **`clientSecret` no longer exists.**
911
+ - Browser: **`confirmCardPayment` and `mountCardPayment` are removed** (with all card-element
912
+ types and the `commercePublishableKey` config). Replace with a redirect
913
+ (`location.href = checkoutUrl`) or the new optional embed:
914
+ `invo.platformCommerce.mountCheckout(el, checkoutUrl, { onComplete })` — an iframe plus an
915
+ origin-checked listener for the page's `INVO_CHECKOUT_COMPLETE` message.
916
+ - Card duplicates no longer 409: retrying `purchase` with the same `clientRequestId` **replays
917
+ the same checkout session** (`idempotentReplay: true`), so a lost response is recoverable.
918
+
919
+ ### Added
920
+
921
+ - `PlatformPurchaseInput.successUrl/cancelUrl/metadata`; result fields
922
+ `sessionId/checkoutUrl/expiresAt/idempotentReplay`.
923
+ - `InvoClient.platformCommerce.mountCheckout(el, checkoutUrl, opts)` → `{ iframe, destroy() }`.
924
+ - `err.isAboveCardMaximum` (`ABOVE_CARD_MAXIMUM`, card > $999.99) + client-side card USD
925
+ bounds fail-fast ($0.50–$999.99).
926
+ - Card `requires_payment` responses without a `checkout_url` fail closed (`INVALID_RESPONSE`).
927
+
928
+ ### Removed
929
+
930
+ - `confirmCardPayment`, `mountCardPayment`, `commercePublishableKey`, `BillingAddress`, and the
931
+ card-element/processor types + the runtime CDN script loader (no more processor touchpoints
932
+ in this SDK at all).
933
+
934
+ ## [2.5.1] — 2026-07-20
935
+
936
+ Hardening patch from a second, independent post-release audit (correctness vs the backend
937
+ blueprint + security red-team) of the 2.5.0 Platform Commerce feature. No API breaks.
938
+
939
+ ### Fixed
940
+
941
+ - **Card-confirm script loader could hang forever on retry.** After a transient CDN failure
942
+ (or a pre-existing processor `<script>` tag whose events already fired), the next
943
+ `mountCardPayment`/`confirmCardPayment` attached listeners to a dead tag and never settled —
944
+ checkout silently dead until page reload. The loader now removes failed tags and polls
945
+ (bounded, 10s) when a tag pre-exists.
946
+ - **Orphaned card element on submit-lookup failure.** `confirmCardPayment` now destroys the
947
+ mounted Payment Element before rethrowing when the `submit` selector can't be resolved
948
+ (previously a retry stacked a second live card iframe).
949
+ - **Billing-address validation errors no longer echo the submitted values** (cardholder PII
950
+ could otherwise land in logs/Sentry); optional billing fields (`name`/`line2`/`state`) are
951
+ now type-checked.
952
+ - **`playerPhone` on `platformCommerce.purchase` is now E.164-validated** — this endpoint can
953
+ create the player identity, so a national-format phone must never reach the wire.
954
+ - **`err.isInsufficientBalance` now also classifies the zero-balance 400** ("Player has no
955
+ balance in this tenant", which carries only `current_balance`).
956
+ - **Breaker-open 503 keeps its human message** (`err.code === "service_unavailable"`, message
957
+ no longer collapses to the bare token).
958
+ - **Webhook types:** `platform_commerce.refunded` `player_email` is nullable + `identity_id`
959
+ added; (2.5.0 already made card-leg `total_price` optional on `purchased`).
960
+ - **Refund result surfaces `newBalance`** (balance leg) **and `processorRefundId`** (card leg)
961
+ instead of leaving them `raw`-only.
962
+ - Platform-commerce error tests now assert the REAL backend envelopes
963
+ (`{status,error_code,message}` / bare `{message}`), not idealized shapes.
964
+
965
+ ### Docs
966
+
967
+ - Card-leg lost-response caveat on `purchase` (duplicate 409 can strand a `clientSecret`-less
968
+ pending order — reconcile via webhook/`getStatus`, retry with a NEW `clientRequestId`).
969
+ - `confirmCardPayment`: bank-redirect return-leg guidance + remount-after-decline note;
970
+ `CardPaymentResult.raw` log-redaction note.
971
+
972
+ ## [2.5.0] — 2026-07-20
973
+
974
+ **Platform Commerce (ecommerce).** A new flow for **platform** tenants (non-game apps: vertical
975
+ video, creator merch, marketplace) to sell items funded by **INVO balance or a real card**, with
976
+ INVO as merchant of record and full refunds. This is **distinct from item purchase** — that is a
977
+ _game_ tenant spending a player's _existing game currency_ on an _in-game_ item (balance only, no
978
+ card, no refund). Additive; only platform tenants can call it (a game tenant gets `403
979
+ NOT_A_PLATFORM_TENANT`). (Backend handoff: BE-PIP-009 `PLATFORM_COMMERCE_SDK.md`.)
980
+
981
+ - **Server** (`InvoServer.platformCommerce`, mirrored in the Python SDK as
982
+ `server.platform_commerce`):
983
+ - `purchase(input)` — `fundingSource: "balance"` settles synchronously (`status:"success"`);
984
+ `"card"` returns `status:"requires_payment"` + a `clientSecret` and **requires a
985
+ `billingAddress`**. Idempotent on `clientRequestId`.
986
+ - `getStatus(orderId)` — `completed` | `pending_payment` | `refunded`.
987
+ - `refund({ orderId | clientRequestId, reason? })` — INVO retains its fee; a second refund
988
+ throws `409` (`err.isAlreadyRefunded`).
989
+ - **Browser** (`InvoClient.platformCommerce`):
990
+ - `confirmCardPayment(clientSecret, { mount, publishableKey?, returnUrl?, submit? })` — mounts
991
+ the card element and confirms; returns `{ status: "succeeded" | "requires_action" |
992
+ "processing" | "failed" }`. The processor JS is **lazy-loaded from its CDN — no bundled
993
+ dependency**; pass its publishable key (or set `commercePublishableKey` on the client config).
994
+ - `mountCardPayment(clientSecret, opts)` — the primitive: `{ element, confirm(), destroy() }`
995
+ to confirm from your own Pay button.
996
+ - **Webhooks:** new typed `platform_commerce.purchased` / `platform_commerce.refunded` events.
997
+ **Fulfill card orders on `platform_commerce.purchased`, never on the browser confirmation.**
998
+ - **New `InvoError` classifiers:** `isNotPlatformTenant` (403), `isAmountBelowMinimum`,
999
+ `isBelowCardMinimum` (card < $0.50), `isAlreadyRefunded` (409).
1000
+ - Docs: README now leads the flow list with an explicit **item purchase vs Platform Commerce**
1001
+ contrast; new "Platform Commerce (ecommerce)" section.
1002
+
1003
+ ## [2.4.1] — 2026-07-10
1004
+
1005
+ Docs only, no code change — corrects stale README prose that the 2.4.0 publish still carried:
1006
+ the status line led with an old version, and the Stability section still cited the `2.0.0`
1007
+ `playerPhone` requirement as the standing breaking change (2.2.0 relaxed it back to optional).
1008
+ Republished so the package-bundled README is accurate.
1009
+
1010
+ ## [2.4.0] — 2026-07-10
1011
+
1012
+ **Steam transfer policy.** Steam-purchased currency is locked to Steam titles; the backend now
1013
+ enforces this at transfer/send initiate and annotates destinations. Additive, and inert until a
1014
+ title is flagged Steam-distributed. (Design doc: `docs/features/steam-transfer-policy.md`.)
1015
+
1016
+ - New `InvoError` classifiers on `initiateSend`/`initiateTransfer` 409s:
1017
+ `isSteamValueNonTransferable` (with `steamTransferableMax` / `steamOriginAmount` — decimal
1018
+ strings) and `isNonSteamValueIntoSteamBlocked`. Surface `err.message` verbatim.
1019
+ - New `DestinationGame.acceptsSteamOriginValue` (maps `accepts_steam_origin_value`; `false` when
1020
+ omitted) — disable non-Steam destinations for a player holding Steam value so they never hit
1021
+ the 409.
1022
+
1023
+ No breaking changes.
1024
+
1025
+ ## [2.3.0] — 2026-07-07
1026
+
1027
+ **Claim-time phone-share approval.** The backend closed a security gap: claiming/collecting a
1028
+ phone-routed transfer now authorizes the collecting identity against the receiver phone before
1029
+ crediting. So `confirmReceiptSend`/`confirmReceiptTransfer` and `claimTransfer`/`claimCurrency`
1030
+ can now return the phone-share `409 PHONE_SHARE_APPROVAL_REQUIRED` (previously only
1031
+ registration/mint did). The existing `InvoError.isPhoneShareApprovalRequired` already classifies
1032
+ it — no consumer code must change — but:
1033
+
1034
+ - New **`InvoError.phoneShareLast4`** surfaces the `phone_last4` from the 409 body for the UI
1035
+ ("we texted the phone ending 1234").
1036
+ - `isPhoneShareApprovalRequired` docs + the `confirmReceipt*`/claim method docs + README now
1037
+ spell out the claim-time path: it's **not a failure** — the funds are held and the phone owner
1038
+ is texted; show `err.message` verbatim, then **retry the same call** once approved (it succeeds
1039
+ idempotently); on denial/expiry the sender is refunded.
1040
+
1041
+ Additive, no breaking changes; affects all rails' claim paths (transfer, currency send, amazon).
1042
+
1043
+ ## [2.2.0] — 2026-07-07
1044
+
1045
+ **Backend reconciliation** — a full audit of the SDK against the live backend surfaced three
1046
+ places the SDK didn't match reality. All changes are backward-compatible (relaxing required
1047
+ inputs / adding surface); no working call breaks.
1048
+
1049
+ - **`mintPlayerToken` no longer requires `playerPhone`.** `/api/sdk/player-token` is a
1050
+ session-token mint for an **existing** player (looked up by email) — not a registration call.
1051
+ It reads only `player_email` and ignores `player_phone`. The 2.0.0 hard E.164 requirement was
1052
+ a bug: it could **block a valid token mint for an existing email-only player**. `playerPhone`
1053
+ is now optional and validated only if provided. Phone stays enforced where it matters — the
1054
+ sender's phone on `initiateSend`/`initiateTransfer`, and at player creation.
1055
+ - **Send by phone alone.** `receiverPlayerEmail` (send) and `targetPlayerEmail` (transfer) are
1056
+ now **optional** — you can send to a recipient's phone; they supply their email at claim
1057
+ (claim still requires it, since that's where the recipient establishes identity).
1058
+ - **`getPlayerBalance` is by email only.** There is no by-`playerId` balance route on the
1059
+ backend, so passing `playerId` threw a confusing 404. It now throws a clear `INVALID_INPUT`
1060
+ pointing you to `InvoClient.getBalance()` (client-side) or `playerEmail` (server-side).
1061
+ - **New `InvoError.isUserVerificationRequired`** for the `WEBAUTHN_UV_REQUIRED` (401) approve
1062
+ failure — re-run the passkey ceremony requiring UV.
1063
+ - Fixed `iterateItemPurchaseHistory` to read the backend's `total_count` pagination key (was
1064
+ `total`; the loop already terminated via the short-page guard, so behavior is unchanged).
1065
+
1066
+ **Migration:** none required. If you were passing `playerPhone` to `mintPlayerToken` it still
1067
+ works; you can now also omit it. Replace any `getPlayerBalance({ playerId })` with an email
1068
+ lookup or `InvoClient.getBalance()`.
1069
+
1070
+ ## [2.1.2] — 2026-07-07
1071
+
1072
+ **Hosted-checkout reconciliation** (the create-session API contract is unchanged; the hosted
1073
+ page was rebuilt). Additive + docs only.
1074
+
1075
+ - `createCheckout` now surfaces `expiresInSeconds` (the `checkout_url` token TTL, e.g. 900) as
1076
+ a first-class field on `CreateCheckoutResult` — previously only on `.raw`.
1077
+ - README: the `platform` rail is described as cards + Apple Pay / Google Pay / Link +
1078
+ international billing (no app-store commission), and the checkout note now says reloading the
1079
+ URL after a completed payment is idempotent (an already-complete success screen), not an
1080
+ error. No API/signature changes.
1081
+
1082
+ ## [2.1.1] — 2026-07-06
1083
+
1084
+ **Security & correctness hardening** from a full audit + red-team of both SDKs. No API changes;
1085
+ upgrade recommended.
1086
+
1087
+ - **Fail closed on HTTP redirects (security).** The transport now sends `redirect:"manual"` and
1088
+ throws `UNEXPECTED_REDIRECT` on any 3xx instead of following it. Previously a redirect from
1089
+ the API host could cause the game-secret header to be re-sent to an unvalidated URL (matches
1090
+ the Python SDK fix, where the leak also covered the player token and an `http://` downgrade).
1091
+ - **`retryAfter` no longer treats a blank `retry_after` as `0`.** An empty/whitespace
1092
+ `retry_after` string used to become `0` (`Number("")===0`) — an immediate, no-backoff retry.
1093
+ It's now correctly `undefined`, in both `InvoError.retryAfter` and the retry layer.
1094
+ - **Whitespace OTP codes rejected client-side.** `recoveryComplete`/`enrollmentVerify` now
1095
+ reject a whitespace-only `code` before the network call, so it can't burn an attempt against
1096
+ the attempt-capped endpoints (parity with the Python SDK).
1097
+ - **Webhook verify uses `crypto.timingSafeEqual`** on the sync path (parity with Python's
1098
+ `hmac.compare_digest`); the runtime-agnostic async/edge path keeps its string compare.
1099
+ - **WebAuthn option mappers fail cleanly.** A malformed `register/begin` body now throws
1100
+ `WEBAUTHN_OPTIONS_MALFORMED` (an `InvoError`) instead of a raw `TypeError`.
1101
+
1102
+ ## [2.1.0] — 2026-07-02
1103
+
1104
+ **Passkey recovery ("lost or replaced my passkey").** Deleting a passkey on the device never
1105
+ tells the server the key is gone, so re-enrollment was dead-ended by the anti-takeover gate
1106
+ (`ENROLLMENT_REQUIRES_PROOF`) with nothing left to prove possession with. The backend shipped
1107
+ a self-serve, possession-proofed recovery flow; this release wires the client side.
1108
+
1109
+ - `InvoClient.recoveryBegin()` — sends a one-time code to the phone/email on file
1110
+ (`{ status: "sent", channels }`); `InvoClient.recoveryComplete(code)` — deactivates the
1111
+ stale server-side passkey and authorizes a fresh enrollment
1112
+ (`{ status: "recovered", deactivatedCount, next }`). Then retry the same `enrollPasskey()`.
1113
+ - New `InvoError` classifiers: `isEnrollmentCodeInvalid`, `isPasskeyRecoveryCooldown`, and
1114
+ `retryAfterAt` (the ISO timestamp on the 403 cooldown — distinct from the numeric
1115
+ `retryAfter` throttle field). Bare `no_channel_on_file` / `rate_limited` error tokens are
1116
+ now promoted to `err.code`.
1117
+ - **24-hour money cooldown surfaced:** a recovery-enrolled passkey logs in and collects
1118
+ funds immediately, but `approveSend`/`approveTransfer` throw 403
1119
+ `PASSKEY_RECOVERY_COOLDOWN` for 24h (SIM-swap protection). Branch on
1120
+ `isPasskeyRecoveryCooldown`, show the pause message with `retryAfterAt`, don't retry-loop.
1121
+ - README: recovery subsection under Passkeys, incl. the password-manager cleanup tip for
1122
+ "there is a problem saving your passkey" (stale orphan entry).
1123
+
1124
+ Additive, no breaking changes. Routes require SDK verification enabled for the tenant
1125
+ (dark 503 otherwise).
1126
+
1127
+ ## [2.0.0] — 2026-07-02
1128
+
1129
+ **BREAKING — `mintPlayerToken` now requires `playerPhone` (E.164).** Requested by the INVO
1130
+ backend after a live incident: a player registered email-only couldn't receive a cross-game
1131
+ transfer (incoming transfers are matched by phone) and never got the account-linking consent
1132
+ SMS (also phone-triggered). The network identity is derived from **email + phone together**,
1133
+ so the phone must be present on the FIRST registration call — attaching it later changes the
1134
+ identity and forces device re-enrollment.
1135
+
1136
+ - `mintPlayerToken({ playerEmail, playerPhone })` — `playerPhone` is required and validated
1137
+ as E.164 (`+15555550100`: leading `+`, country code, digits only) before any network call;
1138
+ the body now posts `player_phone` alongside `player_email`.
1139
+ - **Pending approval is surfaced, not an error to swallow:** minting with a phone that
1140
+ already belongs to another INVO account (same person, new email) throws the existing
1141
+ `isPhoneShareApprovalRequired` 409 — the phone holder got a consent SMS. New
1142
+ `InvoError.phoneShareApprovalId` exposes the `approval_id` from the 409 body for the
1143
+ `phoneShareApprove` OTP fallback. Docs updated to cover the registration path (previously
1144
+ documented for claims only).
1145
+ - README: new "Player registration (email + phone, required)" section; examples updated
1146
+ (`proxy-server.ts` token route now rejects a phoneless actor with a clear 400).
1147
+
1148
+ **Migration:** collect the player's phone in your enrollment UI before the first
1149
+ `mintPlayerToken` call and pass it as `playerPhone` in E.164. Handle the
1150
+ `isPhoneShareApprovalRequired` error as a "pending approval" UI state.
1151
+
1152
+ ## [1.2.1] — 2026-07-01
1153
+
1154
+ **Fix — browser "Illegal invocation".** The SDK invoked its fetch as `this.fetchImpl(...)`,
1155
+ so the browser's native `fetch` ran with the wrong `this` and threw
1156
+ `TypeError: Illegal invocation` — breaking every browser `InvoClient` read
1157
+ (balance/destinations/pending) and the passkey ceremonies when using the default global
1158
+ `fetch` (retries then made it slow on top). The fetch impl is now bound to `globalThis`
1159
+ (harmless for a custom `fetch`). No API change. Node/tests were unaffected, which is why it
1160
+ slipped through — added a `this`-sensitive regression test.
1161
+
1162
+ ## [1.2.0] — 2026-07-01
1163
+
1164
+ Two more server-side capabilities on `InvoServer`.
1165
+
1166
+ - **Phone-share OTP handshake** — `phoneShareInitiate` / `phoneShareApprove` / `phoneShareStatus`
1167
+ resolve a `409 PHONE_SHARE_APPROVAL_REQUIRED`. Unauthenticated (phone-owner-driven — no game
1168
+ secret, no player token), relayed by a partner backend; after approve, re-issue the identical
1169
+ original request (the grant is server-side + auto-consumed). Adds
1170
+ `InvoError.isPhoneShareAlreadyApproved`.
1171
+ - **Server-side `getDestinations`** — game-secret variant of the browser
1172
+ `InvoClient.getDestinations`; pass `{ sourceGameId, direction }` (default `"transfer"`), rows
1173
+ share the same `DestinationGame` shape.
1174
+
1175
+ ## [1.1.0] — 2026-07-01
1176
+
1177
+ Four additive server-side flows on `InvoServer` (the SMS-PIN / claim-code / status /
1178
+ guardian paths partners still need alongside the passkey path).
1179
+
1180
+ - **SMS-PIN completion** — `verifySmsTransfer` / `verifySmsSend` (for `verificationMethod: "sms"`).
1181
+ - **Claim-by-code** — `claimTransfer` / `claimCurrency`, incl. the `needsAccountSelection`
1182
+ multi-account disambiguation (a `200` with `candidates`, not an error).
1183
+ - **Status reads** — `getTransferStatus` / `getSendStatus` (surface `verificationState`).
1184
+ - **Guardian approval-status poll** — `getGuardianApprovalStatus` (poll a hold to `state`).
1185
+ - New typed results (`SmsVerifyResult`, `ClaimResult`, `TransactionStatusResult`,
1186
+ `GuardianApprovalStatusResult`) + `InvoError.isPhoneShareApprovalRequired`.
1187
+
1188
+ ## [1.0.0] — 2026-07-01
1189
+
1190
+ **1.0 — stable.** The public API is now covered by a stability commitment: it follows
1191
+ semver and no breaking change ships without a major bump + migration note. This is a
1192
+ milestone release, **not a breaking change** — code on `0.8.x` continues to work unchanged.
1193
+
1194
+ Also in this release (docs + DX):
1195
+
1196
+ - **Integration modes** documented — **browser-direct** (default) and **behind your proxy**
1197
+ (keep the INVO player token server-side via a custom `baseUrl`/`fetch`; no CORS or
1198
+ security-posture change). Plus a token-bootstrap example and a CORS + RP-ID/origins
1199
+ go-live checklist.
1200
+ - `linkDevice` called out as the lowest-risk first adoption (additive, no refactor).
1201
+
1202
+ ## [0.8.0] — 2026-07-01
1203
+
1204
+ Completes the **discovery layer** for send/transfer UIs.
1205
+
1206
+ - **`InvoClient.getBalance()`** (browser, player-token, `GET /api/sdk/balance`) — the
1207
+ player's balances for the token's game: `balances[]` (`currencyId`, `currencyName`,
1208
+ `currencySymbol`/`currencySymbolUrl` (nullable), `availableBalance`/`reservedBalance`/
1209
+ `totalBalance` as decimal strings) plus `totalValue` / `currencyCount` / `hasFunds`. A
1210
+ player who hasn't transacted here yet returns an empty `balances` array (a `200`, not an
1211
+ error); `404 GAME_NOT_FOUND` throws.
1212
+ - **`InvoServer.getLinkedIdentities({ playerEmail | playerPhone })`** (server-only,
1213
+ game-secret) — a player's linked wallet identities (game-scoped). Provide one identifier
1214
+ (phone wins if both); no in-game match returns `notFound: true` with empty `emails`
1215
+ instead of throwing. **Returns first-party PII — never expose to the browser.**
1216
+
1217
+ ## [0.7.0] — 2026-07-01
1218
+
1219
+ Start of the **discovery layer** for send/transfer UIs.
1220
+
1221
+ - **`InvoClient.getDestinations({ direction })`** — one player-token call
1222
+ (`GET /api/sdk/destinations`) returns every game the player can send/transfer to, with
1223
+ all display metadata **inline** (game name, icon, currency name/symbol, min/max transfer
1224
+ limits) — no per-game lookup. Includes source game/currency info and `transferMode`
1225
+ (`universal`/`linked` + `linkedGameIds`).
1226
+ - _(Coming in 0.7.x: `getBalance` single-game player-token read; `getLinkedIdentities`
1227
+ server-side.)_
1228
+
1229
+ ## [0.6.0] — 2026-07-01
1230
+
1231
+ Three additive browser flows for partner front-ends, built to the live backend contracts.
1232
+
1233
+ - **`InvoClient.getPendingCollect()`** — the player's own pending-to-collect list
1234
+ (player-token `GET /api/sdk/transfers/pending`), PII-free. Each row's `kind`
1235
+ (`identity_gate` → `approve*`, `receiving_confirm` → `confirmReceipt*`) tells you the
1236
+ action; typed fields incl. `held` / `holdReason` / `stepUpRequired`.
1237
+ - **First-enrollment OTP grant** — `enrollmentBegin()` / `enrollmentVerify(code)` for
1238
+ `ENROLLMENT_REQUIRES_AUTHORIZATION` (send OTP to phone+email, verify, then retry the
1239
+ same `enrollPasskey()` — the server grant is auto-consumed). New `InvoError` helpers
1240
+ `isEnrollmentAuthorizationRequired` / `isEnrollmentProofRequired`.
1241
+ - **Typed approve/confirm holds** — `approve*`/`confirmReceipt*` now surface a typed
1242
+ `holdReason` (from `error_code ?? code`) on HTTP 202 holds, plus `risk` /
1243
+ `guardianApproval` / `pollEndpoint` on approve. `RECIPIENT_IDENTITY_PENDING` correctly
1244
+ surfaces on confirm-receipt. Success carries no `holdReason`.
1245
+
1246
+ ## [0.5.0] — 2026-07-01
1247
+
1248
+ Support partner `metadata` end-to-end on the purchase flow (additive, backward-compatible).
1249
+
1250
+ - **`PurchaseCompletedData.metadata?`** — the `purchase.completed` webhook now echoes your
1251
+ metadata back (all rails); `event.data.metadata` is typed.
1252
+ - **`purchaseCurrency`** now accepts and forwards `metadata` (the direct `/purchase-currency`
1253
+ endpoint accepts it too, matching `createCheckout`).
1254
+
1255
+ ## [0.4.2] — 2026-06-30
1256
+
1257
+ Fixes from an independent line-by-line audit against the live backend.
1258
+
1259
+ - **`linkDevice` now works.** `device/link/webauthn/begin` returns a wrapped
1260
+ `{ link_id, options }` body (challenge nested under `options`) and binds the
1261
+ challenge to a server-generated `link_id`. The client now unwraps `options` and
1262
+ echoes the server's `link_id` to `/complete` (it previously threw on an undefined
1263
+ challenge and sent the wrong id).
1264
+ - **`InvoError.code` is now populated for the direct purchase rail + guardian flows.**
1265
+ `errorFromResponse` reads `error_code` (SecureErrorHandler + `/purchase-currency`)
1266
+ in addition to `code`, and promotes known no-code tokens (`flow_paused`,
1267
+ `spending_limit_exceeded`, `receiver_not_enrolled_use_claim_code`) to `.code`. Fixes
1268
+ `isDuplicateRequest` on the direct rail.
1269
+ - **Guardian/minor routing.** The 202 guardian body also carries
1270
+ `verification_method:"sms"`; the SDK now suppresses it (reports
1271
+ `verificationMethod: undefined`) so a guardian-pending minor isn't routed into the
1272
+ SMS-PIN UI. README example reordered to branch on `guardianApproval` first.
1273
+
1274
+ ## [0.4.1] — 2026-06-30
1275
+
1276
+ Docs only — replaced the README's internal-leaking "Deployment prerequisites"
1277
+ (backend flag names, DB columns, gating mechanics) with a partner-facing
1278
+ "Before you go live"; republished so the npm page README is current.
1279
+
1280
+ ## [0.4.0] — 2026-06-30
1281
+
1282
+ Additive release — more server reads, edge-ready webhooks, cancellation, and tooling.
1283
+
1284
+ - **`getInboundPending({ playerEmail | playerPhone })`** — live, unclaimed inbound
1285
+ sends/transfers for a player (the source of truth behind the "you have X to collect"
1286
+ badge; pairs with `transfer.claim_pending`).
1287
+ - **`verifyWebhookAsync`** — Web Crypto variant of `verifyWebhook` that runs on
1288
+ Cloudflare Workers / Deno / Vercel+Netlify Edge / Bun / browsers; and
1289
+ **`createWebhookHandler`** — a zero-dep Fetch-API `(Request) => Promise<Response>`
1290
+ webhook route handler (Next.js App Router, Workers, Deno, Hono, Bun).
1291
+ - **`iterateItemPurchaseHistory`** — async iterator that pages through a player's
1292
+ full item-purchase history.
1293
+ - **Per-call `AbortSignal`** — every method accepts an optional `{ signal }`; an
1294
+ aborted call throws `InvoError` code `ABORTED` and is never retried.
1295
+ - **Tooling**: ESLint (+ lint in CI), changesets release automation, `SECURITY.md`,
1296
+ and `CODEOWNERS`.
1297
+
1298
+ ## [0.3.0] — 2026-06-30
1299
+
1300
+ Additive release — new server capabilities plus transport resilience/observability.
1301
+
1302
+ - **Webhook verification** (`/server`): `verifyWebhook(rawBody, signatureHeader, secret | secrets, opts?)`
1303
+ — constant-time HMAC-SHA256 over `${t}.${rawBody}`, 5-minute replay window,
1304
+ multi-secret rotation; returns a typed `InvoWebhookEvent` discriminated union
1305
+ (`purchase.*`, `item.purchased`, `transfer.*`, `payout.status_changed`, `webhook.test`).
1306
+ Throws `InvoError` (`WEBHOOK_SIGNATURE_INVALID` / `WEBHOOK_TIMESTAMP_EXPIRED` /
1307
+ `WEBHOOK_MALFORMED` / `WEBHOOK_SECRET_MISSING`). Server-only; the browser bundle
1308
+ stays crypto-free. Independently security-audited.
1309
+ - **`getPlayerBalance({ playerEmail | playerId })`** (`/server`): typed `player` / `balances` / `summary`.
1310
+ - **Automatic retries**: network errors/timeouts, `429` (honoring `retry_after`), and
1311
+ `5xx` are retried with exponential backoff + jitter. New config `maxRetries`
1312
+ (default 2, `0` disables) and `retryBaseDelayMs` (default 250).
1313
+ - **Observability hooks**: optional `onRequest` / `onResponse` / `onError` on both
1314
+ entries (best-effort/non-throwing); `InvoError.requestId` carries the backend
1315
+ request id for support/tracing.
1316
+ - **Typed reads**: `confirmPayment` → `ConfirmPaymentResult`; `getOrderDetails` /
1317
+ `getItemOrderDetails` → `OrderDetailsResult`; `getItemPurchaseHistory` →
1318
+ `ItemHistoryResult` (previously untyped `Record`). All keep `raw`.
1319
+ - **Light validation**: `mintPlayerToken` and `createCheckout` require a non-blank
1320
+ `playerEmail` (throws `INVALID_INPUT` before the network call).
1321
+ - **License**: `package.json` `license` is now `SEE LICENSE IN LICENSE` (was
1322
+ `UNLICENSED`); `LICENSE` rewritten as an explicit install-and-use grant for
1323
+ building INVO integrations.
1324
+
1325
+ ## [0.2.1] — 2026-06-30
1326
+
1327
+ Docs only — no code change (republished so the npm page README is current).
1328
+
1329
+ - Rewrote the README into a complete integration/deployment guide: capability
1330
+ overview, architecture, deployment prerequisites, per-flow sections (currency
1331
+ purchase, item purchase, sends, transfers, passkeys), webhooks, errors, and a
1332
+ full API reference for both entries.
1333
+ - Added INVO console onboarding: `https://console.invo.network` (production) and
1334
+ `https://dev.console.invo.network` (testing/sandbox), mapped to their API base URLs.
1335
+
1336
+ ## [0.2.0] — 2026-06-30
1337
+
1338
+ Adds **item purchase** (spend existing game currency on an in-game item, §4.8) — an
1339
+ additive, server-only surface.
1340
+
1341
+ - `InvoServer` (`/server`): `purchaseItem`, `getItemPurchaseHistory`, `getItemOrderDetails`.
1342
+ - Server-side, game-secret auth — no passkey, no real money, no payment rail (it's a
1343
+ balance debit). Grant the item off the `item.purchased` webhook.
1344
+ - Client-side guards: required fields (trim-checked), `itemQuantity` integer `1..1000`,
1345
+ prices `> 0` and `<= 999999.99` (magnitude-safe 2-decimal check), and
1346
+ `totalPrice == unitPrice × itemQuantity (±0.01)` compared in integer cents.
1347
+ - Load-bearing response fields (`transaction_id`, `order_id`) throw `INVALID_RESPONSE`
1348
+ if missing on a 200.
1349
+ - `InvoError` helpers: `isInsufficientBalance` (gated to 400; not the `429` throttle),
1350
+ `isDuplicateRequest` (409), `retryAfter` (numeric or string `retry_after`); all
1351
+ null-safe against non-JSON error bodies.
1352
+ - Independently audited (2 agents) against handoff doc §4.8/§6/§8; contract verified,
1353
+ error-classification edge cases fixed.
1354
+
1355
+ ## [0.1.0] — 2026-06-30
1356
+
1357
+ Initial scaffold.
1358
+
1359
+ - `InvoServer` (`/server`): `mintPlayerToken`, `initiateSend`, `initiateTransfer`,
1360
+ `createCheckout`, `purchaseCurrency`, `confirmPayment`, `getOrderDetails`.
1361
+ - Client-side purchase guards (§4.7): USD amount `0 < x ≤ 999.99`, required
1362
+ `purchaseReference`, and `rail:"steam"` rejected before the network call
1363
+ (`INVALID_INPUT` / `MISSING_PURCHASE_REFERENCE` / `WRONG_RAIL_ENDPOINT`).
1364
+ - `InvoClient` (browser): `enrollPasskey`, `approveSend`/`approveTransfer`,
1365
+ `confirmReceiptSend`/`confirmReceiptTransfer`, and `linkDevice` for the
1366
+ interchangeable-methods flow (§4.6).
1367
+ - Optional `refreshToken` hook: transparently re-mints and retries once on
1368
+ `SDK_TOKEN_EXPIRED` (§11.2).
1369
+ - Shared: typed `InvoError`, isomorphic HTTP client, WebAuthn JSON⇄binary helpers.
1370
+ - Tests: HTTP layer, server request mapping + purchase guards, browser client
1371
+ flows (enroll/approve/link/token-refresh), and WebAuthn serialization.
1372
+ - Contracts extracted + auditor-verified against the INVO backend.
1373
+
1374
+ ### Hardening (independent red-team pass)
1375
+
1376
+ - **Guardian/minor `202` path no longer mismapped to `verificationMethod:"sms"`** —
1377
+ `initiateSend`/`initiateTransfer` now return `verificationMethod: undefined` and a
1378
+ `guardianApproval` block on the guardian path, so callers don't route into the
1379
+ PIN UI by mistake (§4.3).
1380
+ - `usdAmount` validation tightened: rejects non-plain-decimal strings
1381
+ (`"0x10"`, `"1e2"`, whitespace) and >2 decimal places before any network call.
1382
+ - Load-bearing response fields (`token`, `checkout_url`) now throw `INVALID_RESPONSE`
1383
+ instead of silently surfacing as empty strings.
1384
+ - `getOrderDetails` requires at least one of `orderId`/`transactionId`.
1385
+ - Token refresh now re-runs the **whole** passkey ceremony on `SDK_TOKEN_EXPIRED`
1386
+ (never replays a single-use assertion) and single-flights concurrent refreshes.
1387
+ - `baseUrl` must be `https://` (localhost exempt) so the token/secret can't travel
1388
+ in cleartext.
1389
+ - Published tarball excludes sourcemaps (no proprietary source shipped).