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