@smartico/public-api 0.0.380 → 0.0.382

package/CLAUDE.md

@@ -0,0 +1,103 @@
+# public-api (`@smartico/public-api`)
+
+Smartico's public WebSocket SDK. This code is compiled (by the `tracker`
+repo's Rollup) straight into the browser bundles served from CloudFront —
+**every line here ships to end users' browsers.**
+
+## Conventions / footguns
+
+- **Keep code compact — it's bundle size.** This SDK is shipped to the
+  browser, so added code is added download weight for every end user. Prefer
+  the smallest implementation that does the job:
+  - **Don't write a transform that is ~1:1 with the wire shape.** If a
+    protocol response is already the shape consumers need, expose the
+    `…Response` protocol type directly instead of defining a parallel `T…`
+    interface plus a `…Transform()` mapper. Reserve transforms for cases
+    that genuinely reshape, flatten, rename, or compute (e.g.
+    `raffleTransform`, `drawRunTransform`).
+  - Don't add parallel type hierarchies, defensive copies, or wrapper layers
+    that don't earn their bytes.
+  - Favor reusing existing helpers/types over introducing near-duplicates.
+  - TSDoc/comments are stripped from the bundle — document generously; it's
+    only runtime code that counts against size.
+
+## Documentation (`docs/`)
+
+The SDK ships a documentation set under `docs/`. It mixes **TypeDoc-generated
+reference** with **hand-authored concept/guide docs**. Build wiring lives in
+`package.json` (the `doc` script) and `tsconfig.json` (`typedocOptions`).
+
+### Layout — what is generated vs hand-authored
+
+| Path | Created by | What it is |
+|---|---|---|
+| `docs/api/` | **Generated** by `typedoc` | The API reference — one page per WSAPI class / interface / enum / type / function, built from the TSDoc in `src/`. Subfolders: `classes/`, `interfaces/`, `enumerations/`, `type-aliases/`, `functions/`, `variables/`, `documents/`. Wiped and rebuilt on every `npm run doc` (`cleanOutputDir: true`). **Never hand-edit — changes are overwritten.** To add a page, add the source `.ts` to `typedocOptions.entryPoints` in `tsconfig.json`; never hand-create the `.md`. |
+| `docs/ui/<domain>/UIGuide_<method>.md` | Hand-authored | Per-method UI guidance (rendering patterns, polling cadence, CTA gating). Method TSDoc links here via a relative `[UI Guide](../../docs/ui/...)` reference instead of inlining long UI prose. One folder per domain (`raffles`, `store`, `missions`, …). |
+| `docs/SmarticoObject.md` | Hand-authored | Reference for the global `_smartico` object's **core** methods (`init`, identify, deep links, widget embedding, push). Sourced from the tracker repo's `../tracker/src/tracker/Smartico.ts` — these methods live in the tracker, not here. |
+| `docs/Callbacks.md` | Hand-authored | The `_smartico.on(...)` lifecycle/engagement event catalogue. Sourced from the tracker's external-callback enum + its `triggerExternalCallBack` sites. |
+| `docs/Transforms.md` | Hand-authored | Concept doc for the raw-protocol → friendly-`T`-type transform layer (the `T`-type / `*Transform` fn / `*T` method convention described above). |
+| `docs/native/PROTOCOL.md`, `docs/native/ADDING_METHODS.md` | Hand-authored | Raw WebSocket protocol spec for native (Kotlin/Swift) clients, which speak the wire directly and do **not** get the JS transforms. Documents raw request/response shapes + `ClassId`s — the one place `ClassId` values are allowed in docs. |
+
+The three concept docs (`SmarticoObject.md`, `Callbacks.md`, `Transforms.md`)
+are wired into TypeDoc via `typedocOptions.projectDocuments`, so they render
+inside the generated `docs/api` site alongside the reference.
+
+### Build
+
+- `npm run doc` = `typedoc && node scripts/postdoc-cleanup.js`.
+- `typedoc` is driven entirely by `typedocOptions` in `tsconfig.json`:
+  `entryPoints` (the `src/**` files whose exports become reference pages —
+  **add new public types/classes here or they won't appear in `docs/api`**),
+  `out: docs/api`, `projectDocuments`, the markdown + merge-modules plugins, and
+  flags (`excludePrivate`, `excludeProtected`, `disableSources`,
+  `cleanOutputDir`, …).
+- `scripts/postdoc-cleanup.js` post-processes what TypeDoc can't configure away:
+  strips inheritance-chain "Extends / Extended by" blocks, strips methods
+  duplicated onto every subclass by the prototype chain, and rewrites the
+  `_media/`-copied UI-guide links back to `docs/ui/` (single source of truth).
+- **`npm run doc` is human-triggered after a batch of approved doc edits — do
+  not run it as part of a code change, and never edit `docs/api/**` by hand.**
+
+### Authoring rules (from the `api-tsdoc` / `api-tsdoc-final` skills)
+
+These docs are the **public SDK contract** read by 3rd-party integrators, so all
+TSDoc and concept-doc content is strictly consumer-facing:
+
+- **No internal references** in `/** */` blocks or concept docs: no DB
+  schemas/tables, server class/file refs, `ClassId` values (except in
+  `PROTOCOL.md`, the raw spec), internal enum/status numbers, cache/infra names,
+  Jira refs, or BO admin paths. Describe *behavior*, not implementation. Call
+  the in-tracker reference UI **"the default Smartico UI."**
+- **Type docs vs method docs split.** `WSAPITypes.ts` field comments are terse
+  one-line definitions ("what is this field"); the `WSAPI<Domain>.ts` method
+  TSDoc carries narrative usage prose ("what you do with it" — preconditions,
+  error tables, refresh/cache semantics, idempotency, visitor mode). Don't
+  duplicate a field-by-field reference into the method TSDoc.
+- **Wrapper result types** (`err_code` / `err_message`) get a one-line pointer
+  to the owning method's TSDoc, not a duplicated error table.
+- `@example` blocks use `console.log` / `console.error` with descriptive
+  messages stating what the consumer's UI should do — never pseudo-handlers
+  (`toast`, `showError`) or internal types.
+- `/api-tsdoc <method>` enriches one method (+ its UI guide); `/api-tsdoc-final`
+  runs the whole release doc batch (callbacks, `_smartico` object, native
+  protocol, transforms, method TSDocs) and stops at a prepared commit message.
+  Both **never commit and never run `npm run doc`.**
+
+### Relationship to the `tracker` repo (`../tracker`)
+
+This package is published to npm as `@smartico/public-api` and **consumed** by
+the sibling `../tracker` repo, which is what actually ships to browsers. In
+`../tracker/src/tracker/Smartico.ts` the tracker constructs a `SmarticoAPI` and
+exposes its `getWSCalls()` result as `_smartico.api` (the `WSAPI` surface these
+docs document), plus a visitor-mode `_smartico.vapi`. Consequences:
+
+- The `docs/api` reference documents exactly the `_smartico.api.*` methods the
+  tracker re-exports. A method added here (e.g. `getRaffleWonPrizes`) reaches
+  `_smartico.api` only once the tracker bumps its dependency
+  (`npm run bump-tracker`, i.e. `npm install @smartico/public-api@latest` in
+  `../tracker`) and re-bundles.
+- `docs/SmarticoObject.md` documents the *other* half — the core `_smartico.*`
+  methods that live in the tracker's `Smartico.ts`, not in this repo. Keeping it
+  current means reading that tracker file (the `api-tsdoc-final` batch diffs it).
+- `docs/Callbacks.md` likewise tracks the tracker's external-callback enum and
+  emit sites.

package/README.md

@@ -38,29 +38,51 @@ _smartico.api.getMiniGames( { onUpdate: miniGamesUpdates} ).then( games => {
 
 ```
 
+## The `_smartico` object
+
+Beyond `_smartico.api.*`, the global `_smartico` object exposes core methods for initialization, user identity, language, deep links, embedding widgets, and push — `_smartico.init(...)`, `_smartico.online(...)`, `_smartico.dp(...)`, `_smartico.showWidget(...)`, etc.
+
+See the [**`_smartico` object reference**](docs/SmarticoObject.md) for the most important core methods, their arguments, and usage notes.
+
+## Event callbacks
+
+Beyond the `_smartico.api.*` request/response methods, the SDK emits lifecycle and engagement events (user identified, balance changed, gamification widget opened, mini-game won, jackpot hit, …). Subscribe with `_smartico.on('<event>', handler)`:
+
+```javascript
+
+_smartico.on('props_change', (props) => {
+    console.log('User properties changed', props);
+});
+
+```
+
+See the [**Event callbacks reference**](docs/Callbacks.md) for the full list of events, when each fires, and the handler arguments.
+
 ## API reference
 
 The SDK surface is split across one class per feature area, joined by an internal inheritance chain. Consumers always call `_smartico.api.<methodName>(...)` — the chain is an implementation detail; never import the domain classes directly.
 
 | Domain | Reference | Methods | UI Guides |
 |---|---|---|---|
-| **User / Profile / Levels** | [`WSAPIUser`](docs/api/classes/WSAPIUser.md) | `getUserProfile`, `checkSegmentMatch`, `checkSegmentListMatch`, `getLevels`, `getCurrentLevel`, `getUserLevelExtraCounters`, `getActivityLog` | [`getUserProfile`](docs/ui/user/UIGuide_getUserProfile.md) · [`getLevels`](docs/ui/user/UIGuide_getLevels.md) |
-| **General / Utility** | [`WSAPIGeneral`](docs/api/classes/WSAPIGeneral.md) | `getCustomSections`, `getTranslations`, `getRelatedItemsForGame` | — |
+| **User / Profile / Levels** | [`WSAPIUser`](docs/api/classes/WSAPIUser.md) | `getUserProfile`, `checkSegmentMatch`, `checkSegmentListMatch`, `getLevels`, `getCurrentLevel`, `getUserLevelExtraCounters`, `getActivityLog` | [`getUserProfile`](docs/ui/user/UIGuide_getUserProfile.md) · [`getLevels`](docs/ui/user/UIGuide_getLevels.md) · [`getActivityLog`](docs/ui/user/UIGuide_getActivityLog.md) |
+| **General / Utility** | [`WSAPIGeneral`](docs/api/classes/WSAPIGeneral.md) | `getCustomSections`, `getTranslations`, `getRelatedItemsForGame` | [`getCustomSections`](docs/ui/general/UIGuide_getCustomSections.md) · [`getRelatedItemsForGame`](docs/ui/general/UIGuide_getRelatedItemsForGame.md) |
 | **Missions & Badges** | [`WSAPIMissions`](docs/api/classes/WSAPIMissions.md) | `getMissions`, `getBadges`, `getAchCategories`, `requestMissionOptIn`, `requestMissionClaimReward` | [`getMissions`](docs/ui/missions/UIGuide_getMissions.md) · [`getBadges`](docs/ui/missions/UIGuide_getBadges.md) · [`getAchCategories`](docs/ui/missions/UIGuide_getAchCategories.md) · [`requestMissionOptIn`](docs/ui/missions/UIGuide_requestMissionOptIn.md) · [`requestMissionClaimReward`](docs/ui/missions/UIGuide_requestMissionClaimReward.md) |
-| **Bonuses** | [`WSAPIBonuses`](docs/api/classes/WSAPIBonuses.md) | `getBonuses`, `claimBonus` | — |
+| **Bonuses** | [`WSAPIBonuses`](docs/api/classes/WSAPIBonuses.md) | `getBonuses`, `claimBonus` | [`getBonuses`](docs/ui/bonuses/UIGuide_getBonuses.md) · [`claimBonus`](docs/ui/bonuses/UIGuide_claimBonus.md) |
 | **Store / Shop** | [`WSAPIStore`](docs/api/classes/WSAPIStore.md) | `getStoreItems`, `buyStoreItem`, `getStoreCategories`, `getStorePurchasedItems` | [`getStoreItems`](docs/ui/store/UIGuide_getStoreItems.md) · [`buyStoreItem`](docs/ui/store/UIGuide_buyStoreItem.md) · [`getStoreCategories`](docs/ui/store/UIGuide_getStoreCategories.md) · [`getStorePurchasedItems`](docs/ui/store/UIGuide_getStorePurchasedItems.md) |
 | **Tournaments** | [`WSAPITournaments`](docs/api/classes/WSAPITournaments.md) | `getTournamentsList`, `getTournamentInstanceInfo`, `registerInTournament`, `getClanTournamentPlayers` | [`getTournamentsList`](docs/ui/tournaments/UIGuide_getTournamentsList.md) · [`getTournamentInstanceInfo`](docs/ui/tournaments/UIGuide_getTournamentInstanceInfo.md) · [`registerInTournament`](docs/ui/tournaments/UIGuide_registerInTournament.md) · [`getClanTournamentPlayers`](docs/ui/tournaments/UIGuide_getClanTournamentPlayers.md) |
 | **Clans** | [`WSAPIClans`](docs/api/classes/WSAPIClans.md) | `getClans`, `getClanInfo`, `joinClan` | [`getClans`](docs/ui/clans/UIGuide_getClans.md) · [`getClanInfo`](docs/ui/clans/UIGuide_getClanInfo.md) · [`joinClan`](docs/ui/clans/UIGuide_joinClan.md) |
-| **Jackpots** | [`WSAPIJackpots`](docs/api/classes/WSAPIJackpots.md) | `jackpotGet`, `jackpotOptIn`, `jackpotOptOut`, `getJackpotWinners`, `getJackpotEligibleGames` | — |
-| **Raffles / Draws** | [`WSAPIRaffles`](docs/api/classes/WSAPIRaffles.md) | `getRaffles`, `getRaffleDrawRun`, `getRaffleDrawRunsHistory`, `claimRafflePrize`, `requestRaffleOptin` | — |
-| **MiniGames / SAW** | [`WSAPIMiniGames`](docs/api/classes/WSAPIMiniGames.md) | `getMiniGames`, `getMiniGamesHistory`, `playMiniGame`, `miniGameWinAcknowledgeRequest`, `playMiniGameBatch` | — |
-| **Avatars** | [`WSAPIAvatars`](docs/api/classes/WSAPIAvatars.md) | `getAvatarsList`, `getAvatarsCustomized`, `getAvatarPrompts`, `setAvatar` | — |
-| **Game Pick (sports / quiz)** | [`WSAPIGamePick`](docs/api/classes/WSAPIGamePick.md) | `gamePickGet*`, `gamePickSubmit*` (9 methods) | — |
-| **Leaderboard** | [`WSAPILeaderBoard`](docs/api/classes/WSAPILeaderBoard.md) | `getLeaderBoard` | — |
-| **Inbox / Messages / Engagement** | [`WSAPIInbox`](docs/api/classes/WSAPIInbox.md) | `getInboxMessages`, `getInboxUnreadCount`, `getInboxMessageBody`, `markInboxMessageAsRead`, `markAllInboxMessagesAsRead`, `markUnmarkInboxMessageAsFavorite`, `deleteInboxMessage`, `deleteAllInboxMessages`, `reportImpressionEvent`, `reportClickEvent` | — |
+| **Jackpots** | [`WSAPIJackpots`](docs/api/classes/WSAPIJackpots.md) | `jackpotGet`, `jackpotOptIn`, `jackpotOptOut`, `getJackpotWinners`, `getJackpotEligibleGames` | [`jackpotGet`](docs/ui/jackpots/UIGuide_jackpotGet.md) · [`jackpotOptIn`](docs/ui/jackpots/UIGuide_jackpotOptIn.md) · [`jackpotOptOut`](docs/ui/jackpots/UIGuide_jackpotOptOut.md) · [`getJackpotWinners`](docs/ui/jackpots/UIGuide_getJackpotWinners.md) · [`getJackpotEligibleGames`](docs/ui/jackpots/UIGuide_getJackpotEligibleGames.md) |
+| **Raffles / Draws** | [`WSAPIRaffles`](docs/api/classes/WSAPIRaffles.md) | `getRaffles`, `getRaffleDrawRun`, `getRaffleDrawRunsHistory`, `claimRafflePrize`, `requestRaffleOptin`, `getRaffleWonPrizes` | [`getRaffles`](docs/ui/raffles/UIGuide_getRaffles.md) · [`getRaffleDrawRun`](docs/ui/raffles/UIGuide_getRaffleDrawRun.md) · [`getRaffleDrawRunsHistory`](docs/ui/raffles/UIGuide_getRaffleDrawRunsHistory.md) · [`claimRafflePrize`](docs/ui/raffles/UIGuide_claimRafflePrize.md) · [`requestRaffleOptin`](docs/ui/raffles/UIGuide_requestRaffleOptin.md) · [`getRaffleWonPrizes`](docs/ui/raffles/UIGuide_getRaffleWonPrizes.md) |
+| **MiniGames / SAW** | [`WSAPIMiniGames`](docs/api/classes/WSAPIMiniGames.md) | `getMiniGames`, `getMiniGamesHistory`, `playMiniGame`, `miniGameWinAcknowledgeRequest`, `playMiniGameBatch` | [`getMiniGames`](docs/ui/minigames/UIGuide_getMiniGames.md) · [`getMiniGamesHistory`](docs/ui/minigames/UIGuide_getMiniGamesHistory.md) · [`playMiniGame`](docs/ui/minigames/UIGuide_playMiniGame.md) · [`playMiniGameBatch`](docs/ui/minigames/UIGuide_playMiniGameBatch.md) |
+| **Avatars** | [`WSAPIAvatars`](docs/api/classes/WSAPIAvatars.md) | `getAvatarsList`, `getAvatarsCustomized`, `getAvatarPrompts`, `setAvatar` | [`getAvatarsList`](docs/ui/avatars/UIGuide_getAvatarsList.md) · [`getAvatarsCustomized`](docs/ui/avatars/UIGuide_getAvatarsCustomized.md) · [`getAvatarPrompts`](docs/ui/avatars/UIGuide_getAvatarPrompts.md) · [`setAvatar`](docs/ui/avatars/UIGuide_setAvatar.md) |
+| **Game Pick (sports / quiz)** | [`WSAPIGamePick`](docs/api/classes/WSAPIGamePick.md) | `gamePickGet*`, `gamePickSubmit*` (9 methods) | [`gamePickGetActiveRounds`](docs/ui/gamepick/UIGuide_gamePickGetActiveRounds.md) · [`gamePickGetActiveRound`](docs/ui/gamepick/UIGuide_gamePickGetActiveRound.md) · [`gamePickGetHistory`](docs/ui/gamepick/UIGuide_gamePickGetHistory.md) · [`gamePickGetBoard`](docs/ui/gamepick/UIGuide_gamePickGetBoard.md) · [`gamePickSubmitSelection`](docs/ui/gamepick/UIGuide_gamePickSubmitSelection.md) · [`gamePickSubmitSelectionQuiz`](docs/ui/gamepick/UIGuide_gamePickSubmitSelectionQuiz.md) · [`gamePickGetUserInfo`](docs/ui/gamepick/UIGuide_gamePickGetUserInfo.md) · [`gamePickGetGameInfo`](docs/ui/gamepick/UIGuide_gamePickGetGameInfo.md) · [`gamePickGetRoundInfoForUser`](docs/ui/gamepick/UIGuide_gamePickGetRoundInfoForUser.md) |
+| **Leaderboard** | [`WSAPILeaderBoard`](docs/api/classes/WSAPILeaderBoard.md) | `getLeaderBoard` | [`getLeaderBoard`](docs/ui/leaderboard/UIGuide_getLeaderBoard.md) |
+| **Inbox / Messages / Engagement** | [`WSAPIInbox`](docs/api/classes/WSAPIInbox.md) | `getInboxMessages`, `getInboxUnreadCount`, `getInboxMessageBody`, `markInboxMessageAsRead`, `markAllInboxMessagesAsRead`, `markUnmarkInboxMessageAsFavorite`, `deleteInboxMessage`, `deleteAllInboxMessages`, `reportImpressionEvent`, `reportClickEvent` | [`getInboxMessages`](docs/ui/inbox/UIGuide_getInboxMessages.md) · [`getInboxMessageBody`](docs/ui/inbox/UIGuide_getInboxMessageBody.md) · [`markInboxMessageAsRead`](docs/ui/inbox/UIGuide_markInboxMessageAsRead.md) · [`markUnmarkInboxMessageAsFavorite`](docs/ui/inbox/UIGuide_markUnmarkInboxMessageAsFavorite.md) · [`deleteInboxMessage`](docs/ui/inbox/UIGuide_deleteInboxMessage.md) |
 
 The shared return / param types live in [`WSAPITypes`](docs/api/classes/WSAPITypes.md). For the full type / enum / interface listing, see [`docs/api/globals.md`](docs/api/globals.md).
 
+These friendly `T`-prefixed types (`TStoreItem`, `TAvatarDefinition`, …) are produced by the SDK's **transform functions**, which normalize the raw WebSocket protocol shapes into a cleaner form. See [**Transform functions**](docs/Transforms.md) for the concept and naming conventions (`T`-types, `*Transform` functions, `*T` methods).
+
 ### Where to look for working examples
 
 The class reference pages above describe **API behavior** — preconditions, error codes, refresh semantics, cache, idempotency, side effects, visitor mode. They do not include long-form UI prescriptions.

package/dist/Base/ClassId.d.ts

@@ -129,6 +129,8 @@ export declare enum ClassId {
     RAF_CLAIM_PRIZE_RESPONSE = 909,
     RAF_OPTIN_REQUEST = 916,
     RAF_OPTIN_RESPONSE = 917,
+    RAF_GET_WON_PRIZES_REQUEST = 920,
+    RAF_GET_WON_PRIZES_RESPONSE = 921,
     BNR_GET_BANNER_PLACEMENTS_REQUEST = 950,
     BNR_GET_BANNER_PLACEMENTS_RESPONSE = 951,
     BNR_GET_BANNER_CONTENT_REQUEST = 952,

package/dist/Jackpots/JackpotDetails.d.ts

@@ -3,34 +3,33 @@ import { JackpotPot } from './JackpotPot';
 import { JackpotPublicMeta } from './JackpotPublicMeta';
 import { JackpotType } from './JackpotType';
 /**
- * JackpotDetails the information about Jackpot template
- * It also includes JackpotPot object that holds the current value of the jackpot
- * Flag is_opted_in indicates if the current user is opted in to the jackpot
+ * One jackpot template the user is eligible for, with its live pot snapshot.
+ * Returned by `jackpotGet()`.
  */
 interface JackpotDetails {
-    /** ID of the jackpot template */
+    /** Stable numeric ID of the template; pass to opt-in / opt-out / winners / eligible-games methods. */
     jp_template_id: number;
-    /** Type of jackpot logic */
+    /** Whether the jackpot has a shared pot or one independent per user; see {@link JackpotType}. */
     jp_type_id: JackpotType;
-    /** UI information of jackpot, like name, description, etc. */
+    /** Display data: name, description, image_url, winner / not-winner HTML templates, custom_data (JSON-parsed). */
     jp_public_meta: JackpotPublicMeta;
-    /** Base currency of the jackpot */
+    /** Native jackpot currency (ISO 4217). Used for winner-history amounts. */
     jp_currency: string;
-    /** Wallet currency of currently logged in user */
+    /** Current user's wallet currency. Used to display the pot via `pot.current_pot_amount_user_currency`. */
     user_currency: string;
-    /** Type of the user contribution to the jackpot */
+    /** Whether the contribution is a fixed amount or a percentage of the bet; see {@link JackpotContributionType}. */
     contribution_type: JackpotContributionType;
-    /** Value of the user contribution. Fixed amount or percentage of bet depending on the contribution type */
+    /** Amount of contribution per qualifying bet — fixed value or percentage depending on `contribution_type`. */
     contribution_value: number;
-    /** Information of current value of the jackpot */
+    /** Live pot snapshot (amount, temperature, last explosion timestamp). */
     pot: JackpotPot;
-    /** Indication if the current user is opted in to the jackpot */
+    /** `true` when the current user is currently opted in. */
     is_opted_in: boolean;
-    /** Indicates whether all games are eligible for the jackpot */
+    /** `true` when every game in the operator catalog contributes; if `true`, skip `getJackpotEligibleGames`. */
     ach_related_game_allow_all: boolean;
-    /** The number of users who have opted in to participate in the jackpot */
+    /** Number of users currently opted in; always `1` for `JackpotType.Personal`. */
     registration_count: number;
-    /** Show winners in widget and over API */
+    /** Operator flag: whether the winners list should be displayed. Enforced client-side only — gate `getJackpotWinners` calls on this. */
     expose_winners_over_api: boolean;
 }
 export { JackpotDetails };

package/dist/Jackpots/JackpotPot.d.ts

@@ -8,18 +8,22 @@ declare enum JackPotTemparature {
     /** burning, current pot > min amount + 0.5 * (max amount - min amount). E.g. mid of allowed explosion range */
     BURNING = 3
 }
+/**
+ * Live snapshot of one jackpot pot's value and temperature.
+ * Embedded on `JackpotDetails.pot`; refreshed at the 1 s SDK cache TTL.
+ */
 interface JackpotPot {
-    /** ID of the jackpot template */
+    /** Template ID this pot belongs to. */
     jp_template_id: number;
-    /** ID of the jackpot pot */
+    /** Stable numeric ID of the current pot instance (rotates when the pot explodes). */
     jp_pot_id: number;
-    /** currency of the jackpot pot in the Jackput base currency */
+    /** Current pot amount in the jackpot's native currency (`jp_currency`). */
     current_pot_amount: number;
-    /** currency of the jackpot pot in the user wallet currency */
+    /** Current pot amount converted to the user's wallet currency (`user_currency`). */
     current_pot_amount_user_currency: number;
-    /** the date/time when this pot exploded */
+    /** Unix ms timestamp of when this pot last exploded; `0` if it has never exploded. */
     explode_date_ts: number;
-    /** current pot temperature */
+    /** Heat band of the pot relative to its explosion range; see {@link JackPotTemparature}. */
     current_pot_temperature: JackPotTemparature;
 }
 export { JackpotPot, JackPotTemparature };

package/dist/MiniGames/SAWGameType.d.ts

@@ -10,7 +10,8 @@ export declare enum SAWGameType {
     TreasureHunt = 9,
     Voyager = 10,
     Plinko = 11,
-    CoinFlip = 12
+    CoinFlip = 12,
+    CustomMinigame = 13
 }
 export declare enum SAWGameTypeName {
     SpinAWheel = "wheel",
@@ -25,6 +26,7 @@ export declare enum SAWGameTypeName {
     Voyager = "voyager",
     Plinko = "plinko",
     CoinFlip = "coin_flip",
+    CustomMinigame = "custom_minigame",
     Unknown = "unknown"
 }
 /** @hidden */

package/dist/MiniGames/SAWTemplateUI.d.ts

@@ -363,6 +363,13 @@ export interface SAWTemplateUI {
      * | `SAWGameDifficultyType.HARD = 3` | Hard |
      */
     game_difficulty?: SAWGameDifficultyType;
+    /**
+     * URL of the operator-hosted custom mini-game, loaded inside an iframe by
+     * the widget for `SAWGameType.CustomMinigame`.  The operator is trusted, so
+     * the iframe is rendered without a sandbox.
+     * Back-Office label: _"Game URL"_.
+     */
+    custom_game_url?: string;
     /**
      * Minutes for the Voyager seed window.
      * The seed window is the range of seeds that can be used to generate the map.

package/dist/Raffle/GetRaffleWonPrizesRequest.d.ts

@@ -0,0 +1,9 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+export interface GetRaffleWonPrizesRequest extends ProtocolMessage {
+    /** ID of the raffle to fetch the current user's won prizes for. */
+    raffle_id: number;
+    /** Zero-based index of the first won-prize row to return (pagination). */
+    offset: number;
+    /** Maximum number of won-prize rows to return (pagination). */
+    limit: number;
+}

package/dist/Raffle/GetRaffleWonPrizesResponse.d.ts

@@ -0,0 +1,52 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+/** Presentation meta for a won prize. */
+export interface RaffleWonPrizePublicMeta {
+    /** Name of the prize, e.g. '1 $'. */
+    name: string;
+    /** Indicates whether the chance to win should be hidden in the UI. */
+    hide_chance_to_win: boolean;
+    /** URL of the image that represents the prize. */
+    image_url: string;
+}
+/** A single prize the user won within the raffle. */
+export interface RaffleWonPrize {
+    /** Unique ID of the winning row (pass to `claimRafflePrize` when `requires_claim` is `true`). */
+    raf_won_id: number;
+    /** ID of the prize definition. */
+    prize_id: number;
+    /** Run-instance ID of the draw that awarded this prize. */
+    raffle_run_id: number;
+    /** Schedule ID of the draw that awarded this prize. */
+    draw_id: number;
+    /** Presentation meta (name / image). */
+    public_meta: RaffleWonPrizePublicMeta;
+    /** Whether this prize requires a claim action from the user. */
+    requires_claim: boolean;
+    /** Epoch ms when the prize was claimed; `null` when not yet claimed. */
+    claimed_date: number | null;
+}
+/** The user the won-prizes list belongs to. */
+export interface RaffleWonPrizeUser {
+    /** Internal user ID. */
+    user_id: number;
+    /** Avatar image: a full URL for a system avatar, otherwise an avatar token to resolve against the widget's avatar domain. */
+    avatar_id: string;
+    /** Numeric ID of the user's selected avatar definition. */
+    avatar_real_id: number;
+    /** Public username; server-masked for other users (e.g. `"32:r*****"`). */
+    public_username?: string;
+    /** Always `null` on the wire — use `avatar_id`. */
+    avatar_url?: string | null;
+}
+export interface GetRaffleWonPrizesResponse extends ProtocolResponse {
+    /** The user the won prizes belong to; `null` when `won_prizes` is empty. */
+    user: RaffleWonPrizeUser | null;
+    /** Page of won prizes for the requested raffle, newest-first. */
+    won_prizes: RaffleWonPrize[];
+    /** Total number of won prizes for this user/raffle across all draws (for pagination). */
+    total: number;
+    /** Zero-based offset of this page (echoes the resolved request). */
+    offset: number;
+    /** Page size (echoes the resolved request). */
+    limit: number;
+}

package/dist/Raffle/index.d.ts

@@ -15,3 +15,5 @@ export * from './RaffleClaimPrizeResponse';
 export * from './RaffleDrawPublicMeta';
 export * from './RaffleOptinRequest';
 export * from './RaffleOptinResponse';
+export * from './GetRaffleWonPrizesRequest';
+export * from './GetRaffleWonPrizesResponse';

package/dist/SmarticoAPI.d.ts

@@ -23,7 +23,7 @@ import { GetRafflesResponse } from './Raffle/GetRafflesResponse';
 import { GetActivityLogResponse } from './ActivityLog';
 import { GetClanListResponse, GetClanInfoResponse } from './Clans';
 import { InboxCategories } from './Inbox/InboxCategories';
-import { GetDrawRunResponse, GetRaffleDrawRunsHistoryResponse, RaffleClaimPrizeResponse, RaffleOptinResponse } from './Raffle';
+import { GetDrawRunResponse, GetRaffleDrawRunsHistoryResponse, RaffleClaimPrizeResponse, RaffleOptinResponse, GetRaffleWonPrizesResponse } from './Raffle';
 import { GetAvatarsListResponse } from './Avatars/GetAvatarsListResponse';
 import { GetAvatarsCustomizedResponse } from './Avatars/GetAvatarsCustomizedResponse';
 import { GetAvatarPromptsResponse } from './Avatars/GetAvatarPromptsResponse';
@@ -214,6 +214,11 @@ declare class SmarticoAPI {
         draw_id: number;
         raffle_run_id: number;
     }): Promise<RaffleOptinResponse>;
+    getRaffleWonPrizes(user_ext_id: string, props: {
+        raffle_id: number;
+        offset: number;
+        limit: number;
+    }): Promise<GetRaffleWonPrizesResponse>;
     getActivityLog(user_ext_id: string, startTimeSeconds: number, endTimeSeconds: number, limit: number, offset: number): Promise<GetActivityLogResponse>;
     getActivityLogT(user_ext_id: string, startTimeSeconds: number, endTimeSeconds: number, from?: number, to?: number): Promise<TActivityLog[]>;
 }

package/dist/SmarticoLib/index.d.ts

@@ -2105,10 +2105,12 @@ declare enum EWidgetType {
 }
 declare enum EXTERNAL_CALLBACK_KEY {
     INIT = "init",
+    LABEL_INIT_COMPLETED = "label_init_completed",
     IDENTIFY = "identify",
     LOGIN = "login",
     LOGOUT = "logout",
     USER_PROPS_CHANGE = "props_change",
+    PAGE_NAVIGATION = "page_navigation",
     SESSION_BASED_DP_DETECTED = "session_based_dp_detected",
     GF_CLOSING = "gf_closing",
     GF_STARTING = "gf_starting",
@@ -2117,7 +2119,9 @@ declare enum EXTERNAL_CALLBACK_KEY {
     INBOX_STARTING = "inbox_starting",
     PROTOCOL_ERROR = "protocol_error",
     MNIGAME_WIN = "mini_game_win",
-    ACH_GAME_OPENING = "ach_game_opening"
+    ACH_GAME_OPENING = "ach_game_opening",
+    JACKPOT_WIN = "jackpot_win",
+    GF_UX = "gf_ux"
 }
 declare enum DpType {
     AskPushPermissions = "ask_push_permissions",