@smartico/public-api 0.0.432 → 0.0.433

package/dist/Jackpots/GetJackpotWinnersResponse.d.ts

@@ -5,6 +5,8 @@ export interface GetJackpotWinnersResponse extends ProtocolResponse {
     winners: JackpotWinnerHistory[];
     /** Whether there are more winners to fetch */
     has_more: boolean;
+    /** Win statistics of the jackpot template */
+    win_stats?: JackpotWinStats;
 }
 export interface JackpotWinnerHistory {
     /** Id of the jackpot pot */
@@ -14,7 +16,33 @@ export interface JackpotWinnerHistory {
     /** Info about jackpot winner */
     winner: JackPotWinner;
 }
+export interface JackpotWinStats {
+    /** Total number of issued wins of the jackpot template. Wins waiting for manual approval are not counted */
+    total_wins: number;
+    /** The biggest win of the jackpot template, `null` when there are no wins yet */
+    highest_win: JackpotWin | null;
+    /** The most recent win of the jackpot template, `null` when there are no wins yet */
+    last_win: JackpotWin | null;
+}
+export interface JackpotWin {
+    /** Won amount in the Jackpot currency */
+    winning_amount: number;
+    /** Date of winning in milliseconds */
+    win_date_ts: number;
+    /** Name of the winner, masked by default. `null` when the jackpot template doesn't expose winners over API */
+    public_username: string | null;
+}
+export interface TGetJackpotWinStatsResponse {
+    /** The list of jackpot winners */
+    winners: JackpotWinnerHistory[];
+    /** Win statistics of the jackpot template */
+    win_stats: JackpotWinStats;
+}
 /**
  * @ignore
  */
 export declare const GetJackpotWinnersResponseTransform: (items: JackpotWinnerHistory[]) => JackpotWinnerHistory[];
+/**
+ * @ignore
+ */
+export declare const GetJackpotWinStatsResponseTransform: (response: GetJackpotWinnersResponse) => TGetJackpotWinStatsResponse;

package/dist/SmarticoAPI.d.ts

@@ -29,7 +29,7 @@ import { GetAvatarsCustomizedResponse } from './Avatars/GetAvatarsCustomizedResp
 import { GetAvatarPromptsResponse } from './Avatars/GetAvatarPromptsResponse';
 import { SetAvatarResponse } from './Avatars';
 import { AvatarCustomizeResponse } from './Avatars/AvatarCustomizeResponse';
-import { GetJackpotWinnersResponse, JackpotWinnerHistory } from './Jackpots/GetJackpotWinnersResponse';
+import { GetJackpotWinnersResponse, JackpotWinnerHistory, TGetJackpotWinStatsResponse } from './Jackpots/GetJackpotWinnersResponse';
 import { GetJackpotEligibleGamesResponse, TGetJackpotEligibleGamesResponse } from './Jackpots/GetJackpotEligibleGamesResponse';
 import { GamePickGameInfo, GamePickRound, GamePickRoundBoard, GamePickUserInfo, GamesApiResponse } from './GamePick';
 interface Tracker {
@@ -113,6 +113,7 @@ declare class SmarticoAPI {
     }): Promise<JackpotsOptoutResponse>;
     getJackpotWinners(user_ext_id: string, limit: number, offset: number, jp_template_id: number): Promise<GetJackpotWinnersResponse>;
     getJackpotWinnersT(user_ext_id: string, limit: number, offset: number, jp_template_id: number): Promise<JackpotWinnerHistory[]>;
+    getJackpotWinStatsT(user_ext_id: string, limit: number, offset: number, jp_template_id: number): Promise<TGetJackpotWinStatsResponse>;
     getJackpotEligibleGames(user_ext_id: string, { jp_template_id }: {
         jp_template_id: number;
     }): Promise<GetJackpotEligibleGamesResponse>;

package/dist/WSAPI/WSAPIJackpots.d.ts

@@ -1,5 +1,6 @@
 import { JackpotDetails, JackpotWinnerHistory, JackpotsOptinResponse, JackpotsOptoutResponse } from '../Jackpots';
 import { TGetJackpotEligibleGamesResponse } from '../Jackpots/GetJackpotEligibleGamesResponse';
+import { TGetJackpotWinStatsResponse } from '../Jackpots/GetJackpotWinnersResponse';
 import { WSAPIClans } from './WSAPIClans';
 /** @group Jackpots */
 export declare class WSAPIJackpots extends WSAPIClans {
@@ -288,6 +289,81 @@ export declare class WSAPIJackpots extends WSAPIClans {
         /** Jackpot template ID (required). */
         jp_template_id?: number;
     }): Promise<JackpotWinnerHistory[]>;
+    /**
+     * Returns past winners of a specific jackpot template, paginated, together
+     * with the win statistics of that template: total number of wins, the
+     * biggest win and the most recent win. Use it for a jackpot info modal /
+     * tooltip that shows "Total wins", "Highest win" and "Latest win" next to
+     * the winners list.
+     *
+     * @remarks
+     * **Preconditions**
+     * - User must be authenticated. Visitor mode not supported.
+     * - `jp_template_id` is mandatory.
+     * - The consumer SHOULD check
+     *   `JackpotDetails.expose_winners_over_api` before calling, since
+     *   the server does not enforce it.
+     *
+     * **Statistics**
+     * - `win_stats` describes the whole jackpot template and does not depend
+     *   on `limit` / `offset`. Pass `limit: 1` when only the statistics are needed.
+     * - Only issued wins are counted — a pot that exploded but still waits for
+     *   manual approval is not included.
+     * - `highest_win` / `last_win` are `null` while the jackpot has no wins,
+     *   `total_wins` is `0` in that case.
+     * - `public_username` of `highest_win` / `last_win` is masked by the same
+     *   label setting as the winners list, and is `null` when the template
+     *   doesn't expose winners over API.
+     * - The server refreshes the statistics once per minute.
+     *
+     * **Currency caveat**
+     * All amounts (`win_stats.*.winning_amount`,
+     * `winners[].winner.winning_amount_jp_currency`) are in the jackpot's
+     * NATIVE currency, NOT the user's wallet currency.
+     *
+     * **Refresh**
+     * - The SDK caches each page separately (per `jp_template_id` +
+     *   `limit` + `offset`) for 30 seconds.
+     * - Caches clear on jackpot-win push events and on opt-in / opt-out.
+     *
+     * **Error handling**
+     * Non-zero `errCode` on control-group users or generic server errors. The
+     * SDK does NOT enumerate distinct codes — branch on `errCode === 0` and
+     * surface `errMsg` on failure.
+     *
+     * **Visitor mode**: not supported.
+     *
+     * @returns {@link TGetJackpotWinStatsResponse} —
+     * `{ winners: JackpotWinnerHistory[], win_stats: JackpotWinStats }`.
+     *
+     * @example
+     * ```ts
+     * const [jp] = await window._smartico.api.jackpotGet({ jp_template_id: 42 });
+     *
+     * if (!jp || !jp.expose_winners_over_api) {
+     *     console.log('[smartico] winners hidden by operator config — hide the stats');
+     *     return;
+     * }
+     *
+     * const { winners, win_stats } = await window._smartico.api.getJackpotWinStats({
+     *     jp_template_id: 42,
+     *     limit:          10,
+     *     offset:         0,
+     * });
+     * console.log('[smartico] total wins', win_stats.total_wins);
+     * console.log('[smartico] highest win', win_stats.highest_win?.winning_amount, jp.jp_currency);
+     * console.log('[smartico] latest win', win_stats.last_win?.public_username, win_stats.last_win?.win_date_ts);
+     * console.log('[smartico] render', winners.length, 'recent winner rows');
+     * ```
+     */
+    getJackpotWinStats({ limit, offset, jp_template_id, }: {
+        /** Page size of the winners list (default 20). */
+        limit?: number;
+        /** Pagination offset of the winners list (default 0). */
+        offset?: number;
+        /** Jackpot template ID (required). */
+        jp_template_id?: number;
+    }): Promise<TGetJackpotWinStatsResponse>;
     /**
      * Returns the casino games eligible to contribute to a specific jackpot —
      * the catalog the user must play to grow the pot. Use to power an