@smartico/public-api 0.0.409 → 0.0.411

package/docs/api/classes/WSAPIJackpots.md

@@ -400,7 +400,7 @@ Optional callback; not auto-invoked today.
 #### Remarks
 
 **Preconditions**
-- User must be authenticated. Visitor mode not supported.
+- No authentication required — works in both identified and visitor mode.
 - `jp_template_id` is mandatory.
 
 **`onUpdate` caveat**
@@ -418,7 +418,12 @@ Treat it as a no-op for now.
 Non-zero `errCode` on control-group users or generic server errors.
 Branch on `errCode === 0` and surface `errMsg` on failure.
 
-**Visitor mode**: not supported.
+**Visitor mode**: supported via
+`_smartico.vapi(lang).getJackpotEligibleGames(...)`. The eligible-games
+list is template-level (which games contribute to the pot) and carries no
+per-user fields, so a visitor session receives the same list an identified
+user would. The `lang` passed to `_smartico.vapi(lang)` drives the
+translation of game names.
 
 **UI guidance**: see [UI Guide — `getJackpotEligibleGames`](../_media/UIGuide_getJackpotEligibleGames.md).
 
@@ -434,6 +439,10 @@ if (jp?.ach_related_game_allow_all) {
 
 const r = await window._smartico.api.getJackpotEligibleGames({ jp_template_id: 42 });
 console.log('[smartico] render', r.eligible_games.length, 'eligible game tiles');
+
+// Visitor mode — same shape, language driven by the vapi(lang) argument
+const visitor = await window._smartico.vapi('EN').getJackpotEligibleGames({ jp_template_id: 42 });
+console.log('[smartico] visitor eligible games:', visitor.eligible_games.length);
 ```
 
 ***

package/docs/api/classes/WSAPIMiniGames.md

@@ -78,6 +78,27 @@ played via [playMiniGame](#playminigame); the exceptions are:
   games server (not this SDK); the SAW spin is fired
   server-internally to deduct the buy-in.
 
+**Per-prize statistics (`expose_game_stat_on_api`)**
+Each template's `prizes` array always carries the definition
+fields — name, icon, `prize_type`, `prize_value`, acknowledge
+configuration. The stock-statistics fields are gated by an
+operator template setting, surfaced as
+`expose_game_stat_on_api`:
+- Populated when enabled: `pool` (remaining stock),
+  `wins_count` (total wins across all players), `weekdays`
+  (ISO 1–7 days the prize can be won), `active_from_ts` /
+  `active_till_ts` (prize availability window).
+- Omitted when disabled (the default) — this keeps the live
+  prize economy (stock levels, win rates, schedules) hidden
+  from players.
+- Exception: `pool` is always populated for `MatchX` / `Quiz`
+  templates, whose game flow needs the remaining stock.
+- `pool_initial` is populated regardless of the setting.
+When enabled, the values are also kept current — the server
+refreshes the prize rows on each fetch and drops its template
+caches after every play, so `pool` / `wins_count` are safe to
+drive an "X prizes left" scarcity UI.
+
 **Cache TTL**: the SDK caches the response for 30 seconds. Cache
 is fully cleared on login / logout.
 
@@ -345,14 +366,19 @@ without waiting for the win to be marked delivered. You finalise
 it later by calling [miniGameWinAcknowledgeRequest](#minigamewinacknowledgerequest) with the
 `request_id` returned on this result.
 
-What `acknowledge: false` does and does NOT defer:
-- For STANDARD prizes the value is credited at spin time
-  regardless, so opting out does NOT delay the balance change —
-  it only defers the "delivered" bookkeeping and the `is_claimed`
-  flag flipping in [getMiniGamesHistory](#getminigameshistory).
-- For operator-configured "explicit claim" prizes the credit IS
-  deferred until the spin is acknowledged, so those require an
-  explicit acknowledge to finalise.
+What `acknowledge: false` defers:
+- For STANDARD prizes the value is credited when the spin is
+  finalised — by your later acknowledge or, failing that, by the
+  server-side fallback below — so opting out delays the balance
+  change by at most that fallback window. The `is_claimed` flag in
+  [getMiniGamesHistory](#getminigameshistory) flips on the same finalisation.
+- For operator-configured "explicit claim" prizes the credit is
+  deferred until your explicit acknowledge — the fallback does not
+  cover them.
+
+While the spin is un-finalised it can also be finalised as LOST —
+prize discarded back to the pool — via
+[miniGameWinAcknowledgeRequest](#minigamewinacknowledgerequest) with `{ lose: true }`.
 
 A server-side fallback auto-acknowledges ordinary un-acknowledged
 spins after a short delay (about 1–3 minutes), so an ordinary
@@ -383,8 +409,10 @@ refreshed array.
   time the call resolves. Balance updates flow via the
   user-properties channel (observe via [getUserProfile](WSAPIUser.md#getuserprofile)).
 - Prize value credited per the prize's type (see "Prize handling"
-  above). Standard prizes are credited at spin time; "explicit
-  claim" prizes are credited when the spin is acknowledged.
+  above) when the spin is finalised — with the default
+  auto-acknowledge that happens before the call resolves;
+  "explicit claim" prizes are credited only by an explicit
+  acknowledge.
 - The play is recorded server-side for analytics / reporting.
 
 **UI guidance**: see [UI Guide — `playMiniGame`](../_media/UIGuide_playMiniGame.md).
@@ -432,18 +460,24 @@ if (r.err_code === 0) {
 ```
 
 Manual finalisation (`acknowledge: false`) — e.g. an explicit
-"Claim" CTA, or finalising on your own schedule:
+"Claim" CTA, a decline/forfeit flow, or finalising on your own
+schedule:
 ```ts
 const r = await window._smartico.api.playMiniGame(game.id, { acknowledge: false });
 if (r.err_code === 0) {
-  // Spin resolved but not yet acknowledged. For standard prizes the
-  // balance already changed server-side; "explicit claim" prizes
-  // are credited only by the acknowledge below.
+  // Spin resolved but not yet finalised — the prize is not credited
+  // yet. Your acknowledge below credits it (for standard prizes the
+  // server-side fallback would eventually do the same).
   console.log('[smartico] prize won — show the result / Claim CTA, then finalise');
 
   // On the user's Claim click, finalise with the request_id from the result.
   await window._smartico.api.miniGameWinAcknowledgeRequest(r.request_id);
   console.log('[smartico] win finalised — refresh getUserProfile / getMiniGames to reflect it');
+
+  // Or, if the game flow ends in the player declining / losing the
+  // drawn prize, finalise the spin as lost instead — the prize is
+  // not credited and returns to the prize pool:
+  // await window._smartico.api.miniGameWinAcknowledgeRequest(r.request_id, { lose: true });
 }
 ```
 
@@ -451,12 +485,13 @@ if (r.err_code === 0) {
 
 ### miniGameWinAcknowledgeRequest()
 
-> **miniGameWinAcknowledgeRequest**(`request_id`): `Promise`\<[`SAWDoAknowledgeResponse`](../interfaces/SAWDoAknowledgeResponse.md)\>
+> **miniGameWinAcknowledgeRequest**(`request_id`, `__namedParameters?`): `Promise`\<[`SAWDoAknowledgeResponse`](../interfaces/SAWDoAknowledgeResponse.md)\>
 
 Manually acknowledges a mini-game spin — marks the win delivered
-server-side. Most consumers do NOT need this: [playMiniGame](#playminigame)
-acknowledges by default (`acknowledge: true`) and
-[playMiniGameBatch](#playminigamebatch) acknowledges automatically. Call this
+server-side, or (with `lose: true`) finalises it as lost and
+returns the prize to the pool. Most consumers do NOT need this:
+[playMiniGame](#playminigame) acknowledges by default (`acknowledge: true`)
+and [playMiniGameBatch](#playminigamebatch) acknowledges automatically. Call this
 directly only when you took ownership of the acknowledge step or
 need to recover a lost one.
 
@@ -472,6 +507,12 @@ Correlation id of the spin to finalise: the
                    `client_request_id` of a
                    [getMiniGamesHistory](#getminigameshistory) row.
 
+##### \_\_namedParameters?
+
+###### lose?
+
+`boolean`
+
 #### Returns
 
 `Promise`\<[`SAWDoAknowledgeResponse`](../interfaces/SAWDoAknowledgeResponse.md)\>
@@ -496,6 +537,27 @@ The `request_id` on a [playMiniGame](#playminigame) result and the
 `client_request_id` on a [getMiniGamesHistory](#getminigameshistory) row are the
 same correlation id — this method accepts either.
 
+**Finalising as lost (`lose: true`)**
+Pass `{ lose: true }` to finalise the spin as LOST instead of won:
+the prize is NOT credited and is returned to the game's prize pool
+(available again for other players), and the spin fires the
+mini-game "lose" engagement event instead of the win one. On the
+next [getMiniGamesHistory](#getminigameshistory) fetch the row shows `is_claimed:
+true` with no prize attached. Use this for game mechanics where the
+player can decline or forfeit the drawn prize — e.g. a
+gamble/discard step, or a client-driven game where the user's final
+action decides whether the pre-drawn prize is actually won (the
+default Smartico UI does this for the Voyager game: failing the
+star-collection run finalises the spin as lost). When configured,
+the prize's `aknowledge_message_lose` is the operator's result copy
+for this case — show it instead of `aknowledge_message`. It only
+works on a spin that is not yet finalised, so it requires playing
+with `acknowledge: false` and calling promptly — once the automatic
+acknowledge or the server-side fallback (below) has finalised the
+spin, `lose: true` is a no-op and the prize stays credited.
+("Explicit claim" prizes are exempt from the fallback, so for them
+there is no time pressure.)
+
 **Idempotency**: safe. Acknowledging a spin that is already
 finalised — by you, by the automatic acknowledge, or by the
 fallback — is a no-op with no double credit. Acknowledging a
@@ -510,13 +572,16 @@ exception — excluded from the fallback, they require an explicit
 call here.
 
 **Side effects** (first successful call for an un-acknowledged spin)
-- For "explicit claim" prizes, the prize value is credited on this
-  call. For standard prizes the value was already credited at spin
-  time (see [playMiniGame](#playminigame) "Prize handling"); this call only
-  marks the win delivered.
-- The spin's `is_claimed` flips to `true` on the next
+- Default (win): the prize value is credited on this call — this is
+  the finalisation step that credits standard and "explicit claim"
+  prizes alike (see [playMiniGame](#playminigame) "Prize handling").
+- With `lose: true`: no credit; the prize returns to the prize pool
+  and the "lose" engagement event fires.
+- Either way the spin's `is_claimed` flips to `true` on the next
   [getMiniGamesHistory](#getminigameshistory) fetch.
 
+**UI guidance**: see [UI Guide — `miniGameWinAcknowledgeRequest`](../_media/UIGuide_miniGameWinAcknowledgeRequest.md).
+
 **Visitor mode**: not supported.
 
 #### Example
@@ -529,6 +594,10 @@ if (r.err_code === 0) {
   await window._smartico.api.miniGameWinAcknowledgeRequest(r.request_id);
 }
 
+// Decline / forfeit — finalise the same spin as lost instead:
+// the prize is not credited and goes back to the prize pool.
+await window._smartico.api.miniGameWinAcknowledgeRequest(r.request_id, { lose: true });
+
 // Recovery — re-acknowledge any spins a batch acknowledge missed.
 const history = await window._smartico.api.getMiniGamesHistory({ limit: 20 });
 for (const row of history.filter(h => !h.is_claimed)) {

package/docs/api/interfaces/SAWDoAknowledgeRequest.md

@@ -39,3 +39,11 @@
 ### request\_id
 
 > **request\_id**: `string`
+
+***
+
+### lose?
+
+> `optional` **lose?**: `boolean`
+
+When true, finalises the spin as lost: the prize is not credited and is returned to the prize pool.

package/docs/api/interfaces/SAWPrize.md

@@ -6,102 +6,136 @@
 
 > **saw\_prize\_id**: `number`
 
+ID of the prize
+
 ***
 
 ### saw\_prize\_ui\_definition
 
 > **saw\_prize\_ui\_definition**: [`SAWPrizeUI`](SAWPrizeUI.md)
 
+Visual definition of the prize (name, icon, win-modal buttons, per-game rendering hints)
+
 ***
 
 ### prize\_value?
 
 > `optional` **prize\_value?**: `number`
 
+Numeric value for 'points' / 'spin' prize types (e.g. 100 for "100 points"); not relevant for other types
+
 ***
 
 ### prize\_type\_id
 
 > **prize\_type\_id**: [`SAWPrizeType`](../enumerations/SAWPrizeType.md)
 
+The type of the prize — see [SAWPrizeType](../enumerations/SAWPrizeType.md)
+
 ***
 
 ### place\_from?
 
 > `optional` **place\_from?**: `number`
 
+Competition games (MatchX / Quiz): first finishing place this prize applies to
+
 ***
 
 ### place\_to?
 
 > `optional` **place\_to?**: `number`
 
+Competition games (MatchX / Quiz): last finishing place this prize applies to; equals `place_from` for a single-place prize
+
 ***
 
 ### sawUniqueWinId?
 
 > `optional` **sawUniqueWinId?**: `string`
 
+Client-side only — unique id of a win instance generated by the default Smartico UI to dedupe render effects; never sent by the server
+
 ***
 
 ### pool?
 
 > `optional` **pool?**: `number`
 
+Remaining stock. Present only when the template's `expose_game_stat_on_api` is enabled; always present for MatchX / Quiz games
+
 ***
 
 ### pool\_initial?
 
 > `optional` **pool\_initial?**: `number`
 
+Initial (configured) stock. Present regardless of `expose_game_stat_on_api`
+
 ***
 
 ### wins\_count?
 
 > `optional` **wins\_count?**: `number`
 
+Times the prize has been won, across all players. Present only when `expose_game_stat_on_api` is enabled
+
 ***
 
 ### weekdays?
 
 > `optional` **weekdays?**: `number`[]
 
+ISO weekday numbers (1 = Monday … 7 = Sunday) the prize can be won on; absent = any day. Present only when `expose_game_stat_on_api` is enabled
+
 ***
 
 ### active\_from\_ts?
 
 > `optional` **active\_from\_ts?**: `number`
 
+Prize availability window start (epoch ms), evaluated against `relative_period_timezone`. Present only when `expose_game_stat_on_api` is enabled
+
 ***
 
 ### active\_till\_ts?
 
 > `optional` **active\_till\_ts?**: `number`
 
+Prize availability window end (epoch ms), evaluated against `relative_period_timezone`. Present only when `expose_game_stat_on_api` is enabled
+
 ***
 
 ### relative\_period\_timezone?
 
 > `optional` **relative\_period\_timezone?**: `number`
 
+Timezone offset in minutes for `weekdays` / active-window evaluation (UTC minus local, as in JS `Date.getTimezoneOffset()`)
+
 ***
 
 ### is\_surcharge?
 
 > `optional` **is\_surcharge?**: `boolean`
 
+When true, the prize stays winnable at `pool` 0 (unlimited stock)
+
 ***
 
 ### is\_deleted?
 
 > `optional` **is\_deleted?**: `boolean`
 
+Always `false` in API responses — deleted prizes are excluded server-side
+
 ***
 
 ### prize\_details\_json?
 
 > `optional` **prize\_details\_json?**: `object`
 
+Type-specific prize details — e.g. `gems` / `_gems_diamonds_type` for gems-and-diamonds prizes, `tickets_count` for raffle-ticket prizes
+
 #### Index Signature
 
 \[`key`: `string`\]: `any`
@@ -111,3 +145,5 @@
 ### max\_give\_period\_type\_id?
 
 > `optional` **max\_give\_period\_type\_id?**: [`AttemptPeriodType`](../enumerations/AttemptPeriodType.md)
+
+Period basis for the prize availability restriction — see [AttemptPeriodType](../enumerations/AttemptPeriodType.md)

package/docs/api/interfaces/SAWPrizeUI.md

@@ -36,6 +36,8 @@
 
 > `optional` **aknowledge\_message\_lose?**: `string`
 
+Message shown instead of `aknowledge_message` when the spin is finalised as lost (`lose: true` acknowledge — games with a client-decided outcome, e.g. Voyager)
+
 ***
 
 ### sectors?

package/docs/api/interfaces/SAWTemplate.md

@@ -6,108 +6,144 @@
 
 > **saw\_template\_id**: `number`
 
+ID of the mini-game template
+
 ***
 
 ### saw\_game\_type\_id
 
 > **saw\_game\_type\_id**: [`SAWGameType`](../enumerations/SAWGameType.md)
 
+The type of the game — see [SAWGameType](../enumerations/SAWGameType.md)
+
 ***
 
 ### saw\_template\_ui\_definition
 
 > **saw\_template\_ui\_definition**: [`SAWTemplateUI`](SAWTemplateUI.md)
 
+Full UI definition of the mini-game (name, description, skin, colors, per-game visual settings)
+
 ***
 
 ### saw\_buyin\_type\_id
 
 > **saw\_buyin\_type\_id**: [`SAWBuyInType`](../enumerations/SAWBuyInType.md)
 
+How the user is charged per attempt — see [SAWBuyInType](../enumerations/SAWBuyInType.md)
+
 ***
 
 ### buyin\_cost\_points?
 
 > `optional` **buyin\_cost\_points?**: `number`
 
+Cost per attempt in the buy-in currency (points, gems or diamonds per `saw_buyin_type_id`)
+
 ***
 
 ### visibile\_when\_can\_spin
 
 > **visibile\_when\_can\_spin**: `boolean`
 
+Operator hint: show the game only while the user can actually play it (has attempts / sufficient balance)
+
 ***
 
 ### spin\_count?
 
 > `optional` **spin\_count?**: `number`
 
+Number of spin attempts the user currently has (initial value; later changes arrive as spin-count pushes)
+
 ***
 
 ### prizes
 
 > **prizes**: [`SAWPrize`](SAWPrize.md)[]
 
+Prizes configured for this game — see [SAWPrize](SAWPrize.md)
+
 ***
 
 ### is\_visible
 
 > **is\_visible**: `boolean`
 
+Operator visibility flag for the template
+
 ***
 
 ### activeFromDate?
 
 > `optional` **activeFromDate?**: `number`
 
+Time from which the template becomes available (epoch ms); absent when not restricted
+
 ***
 
 ### activeTillDate?
 
 > `optional` **activeTillDate?**: `number`
 
+Time until which the template stays available (epoch ms); absent when not restricted
+
 ***
 
 ### jackpot\_add\_on\_attempt
 
 > **jackpot\_add\_on\_attempt**: `number`
 
+Amount added to the jackpot on every play (abstract contribution — nothing is deducted from the player)
+
 ***
 
 ### jackpot\_current
 
 > **jackpot\_current**: `number`
 
+Current jackpot accumulator value
+
 ***
 
 ### jackpot\_guaranteed
 
 > **jackpot\_guaranteed**: `number`
 
+Seed value of the jackpot — the accumulator starts at (and resets to) this amount after a jackpot win
+
 ***
 
 ### maxActiveSpinsAllowed
 
 > **maxActiveSpinsAllowed**: `number`
 
+Maximum number of unspent spin attempts a user can accumulate
+
 ***
 
 ### maxSpinsCount
 
 > **maxSpinsCount**: `number`
 
+Maximum number of attempts a user can make during `maxSpinsPediodMs`
+
 ***
 
 ### maxSpinsPediodMs
 
 > **maxSpinsPediodMs**: `number`
 
+Length of the attempt-limit period in ms (note the field-name spelling)
+
 ***
 
 ### next\_available\_spin\_ts?
 
 > `optional` **next\_available\_spin\_ts?**: `number`
 
+Epoch-ms time when the next attempt becomes available; populated only when the operator enabled the "show time to the next available spin" setting and max attempts per period is 1
+
 ***
 
 ### earliest\_expiration\_dt?
@@ -130,12 +166,16 @@ Latest-expiring spin's expiration time for this user (epoch ms); `null`/absent w
 
 > **saw\_skin\_key**: `string`
 
+Key of the visual skin the operator selected for the game
+
 ***
 
 ### saw\_skin\_ui\_definition
 
 > **saw\_skin\_ui\_definition**: `object`
 
+Skin assets of the game: `skin_folder` is the base URL for the skin's images, `skin_css` custom CSS overrides, plus optional popup/animation tweaks
+
 #### skin\_folder
 
 > **skin\_folder**: `string`
@@ -158,20 +198,28 @@ Latest-expiring spin's expiration time for this user (epoch ms); `null`/absent w
 
 > `optional` **expose\_game\_stat\_on\_api?**: `boolean`
 
+Operator template setting. When enabled, the per-prize stock statistics (`pool`, `wins_count`, `weekdays`, `active_from_ts` / `active_till_ts`) are populated on `prizes`; when disabled (default) the server strips them from the response (`pool` is kept for MatchX / Quiz games).
+
 ***
 
 ### requires\_prize\_claim?
 
 > `optional` **requires\_prize\_claim?**: `boolean`
 
+Prize Drop only: when true, the pushed prize requires an explicit claim by the user before it is credited
+
 ***
 
 ### relative\_period\_timezone?
 
 > `optional` **relative\_period\_timezone?**: `number`
 
+Timezone offset in minutes used to evaluate the template's period-based rules (UTC minus local, as in JS `Date.getTimezoneOffset()`)
+
 ***
 
 ### show\_prize\_history?
 
 > `optional` **show\_prize\_history?**: `boolean`
+
+Operator setting: show a prize-history entry point (icon / button) on this game's view