@smartico/public-api 0.0.252 → 0.0.253

package/src/Raffle/GetRafflesResponse.ts

@@ -1,6 +1,103 @@
+import { TRaffle, TRaffleDraw, TRafflePrize, TRafflePrizeWinner, TRaffleTicket } from 'src/WSAPI/WSAPITypes';
 import { ProtocolResponse } from '../Base/ProtocolResponse';
 import { Raffle } from './Raffle';
+import { RaffleDraw } from './RaffleDraw';
+import { RafflePrize } from './RafflePrize';
+import { RafflePrizeWinner } from './RafflePrizeWinner';
+import { CoreUtils } from 'src/Core';
+import { RaffleTicket } from './RaffleTicket';
 
 export interface GetRafflesResponse extends ProtocolResponse {
 	items: Raffle[];
 }
+
+export const ticketsTransform = (items: RaffleTicket[]): TRaffleTicket[] => {
+	return items.map((item) => {
+		return {
+			ticekt_id: item.id,
+			ticket_id_string: item.s,
+		};
+	});
+};
+
+export const winnersTransform = (items: RafflePrizeWinner[]): TRafflePrizeWinner[] => {
+	return items.map((item) => {
+		return {
+			id: item.user_id,
+			username: item.public_username,
+			avatar_url: item.avatar_url,
+			ticket: { ticekt_id: item.ticket.id, ticket_id_string: item.ticket.s },
+			raf_won_id: item.raf_won_id,
+			claimed_date: item.claimed_date,
+		};
+	});
+};
+
+export const prizeTransform = (items: RafflePrize[]): TRafflePrize[] => {
+	return items.map((item) => {
+		return {
+			id: item.prize_id,
+			name: item.public_meta.name,
+			description: item.public_meta.description,
+			image_url: item.public_meta.image_url,
+			prizes_per_run: item.prizes_per_run,
+			prizes_per_run_actual: item.prizes_per_run_actual,
+			chances_to_win_perc: item.chances_to_win_perc,
+			min_required_total_tickets: item.min_required_total_tickets,
+			cap_prizes_per_run: item.cap_prizes_per_run,
+			priority: item.priority,
+			stock_items_per_draw: item.stock_items_per_draw,
+			should_claim: item.should_claim,
+			winners: winnersTransform(item.winners),
+			requires_claim: item.requires_claim,
+			min_required_tickets_for_user: item.min_required_tickets_for_user,
+		};
+	});
+};
+
+export const drawTransform = (items: RaffleDraw[]): TRaffleDraw[] => {
+	return items.map((item) => {
+		return {
+			id: item.draw_id,
+			name: item.public_meta.name,
+			description: item.public_meta.description,
+			image_url: item.public_meta.image_url,
+			image_url_mobile: item.public_meta.image_url_mobile,
+			icon_url: item.public_meta.icon_url,
+			background_image_url: item.public_meta.background_image_url,
+			background_image_url_mobile: item.public_meta.background_image_url_mobile,
+			is_grand: item.public_meta.is_grand,
+			prizes: prizeTransform(item.prizes),
+			current_state: item.current_state,
+			run_id: item.run_id,
+			execution_type: item.execution_type,
+			execution_ts: item.execution_ts,
+			previous_run_ts: item.previous_run_ts,
+			previous_run_id: item.previous_run_id,
+			ticket_start_ts: item.ticket_start_ts,
+			allow_multi_prize_per_ticket: item.allow_multi_prize_per_ticket,
+			total_tickets_count: item.total_tickets_count,
+			my_tickets_count: item.my_tickets_count,
+			my_last_tickets: ticketsTransform(item.my_last_tickets),
+		};
+	});
+};
+
+export const raffleTransform = (items: Raffle[]): TRaffle[] => {
+	return items.map((item) => {
+		return {
+			id: item.raffle_id,
+			name: item.public_meta.name,
+			description: item.public_meta.description,
+			custom_section_id: item.public_meta.custom_section_id,
+			image_url: item.public_meta.image_url,
+			image_url_mobile: item.public_meta.image_url_mobile,
+			custom_data: item.public_meta.custom_data,
+			start_date: item.start_date_ts,
+			end_date: item.end_date_ts,
+			max_tickets_count: item.max_tickets_count,
+			current_tickets_count: item.current_tickets_count,
+			draws: drawTransform(item.draws),
+		};
+	});
+};

package/src/Raffle/RaffleClaimPrizeResponse.ts

@@ -1,3 +1,18 @@
+import { TransformedRaffleClaimPrizeResponse } from "src/WSAPI/WSAPITypes";
 import { ProtocolResponse } from "../Base/ProtocolResponse";
 
-export interface RaffleClaimPrizeResponse extends ProtocolResponse { }
+export interface RaffleClaimPrizeResponse extends ProtocolResponse { 
+    errCode: number
+    errMsg?: string
+}
+
+
+export const raffleClaimPrizeResponseTransform = (info: RaffleClaimPrizeResponse): TransformedRaffleClaimPrizeResponse => {
+    return {
+        errorCode: info.errCode,
+        errorMessage: info.errMsg
+    }
+}
+
+
+

package/src/Raffle/RaffleDraw.ts

@@ -2,7 +2,7 @@ import { RaffleDrawPublicMeta } from "./RaffleDrawPublicMeta";
 import { RafflePrize } from "./RafflePrize";
 import { RaffleTicket } from "./RaffleTicket";
 
-enum RaffleDrawInstanceState {
+export enum RaffleDrawInstanceState {
     /** Draw is open for the tickets collection */
     Open = 1,
     /** Winner selection is in progress */
@@ -11,7 +11,7 @@ enum RaffleDrawInstanceState {
     Executed = 3,
 }
 
-enum RaffleDrawTypeExecution {
+export enum RaffleDrawTypeExecution {
     /** Draw is executed only once */
     ExecDate = 0,
     /** Draw is executed on a recurring basis */

package/src/SmarticoAPI.ts

@@ -95,6 +95,7 @@ import {
 	TUICustomSection,
 	TBonus,
 	TSawHistory,
+	TRaffle,
 } from './WSAPI/WSAPITypes';
 import { getLeaderBoardTransform } from './Leaderboard/LeaderBoards';
 import { GetAchievementsUserInfoResponse } from './Core/GetAchievementsUserInfoResponse';
@@ -105,8 +106,6 @@ import {
 	GetJackpotsPotsResponse,
 	GetJackpotsRequest,
 	GetJackpotsResponse,
-	JackpotDetails,
-	JackpotPot,
 	JackpotsOptinRequest,
 	JackpotsOptinResponse,
 	JackpotsOptoutRequest,
@@ -121,10 +120,12 @@ import { SAWDoAcknowledgeBatchRequest } from './MiniGames/SAWDoAcknowledgeBatchR
 import { SAWDoAcknowledgeBatchResponse } from './MiniGames/SAWDoAcknowledgeBatchResponse';
 import { GetRelatedAchTourRequest } from './Missions/GetRelatedAchTourRequest';
 import { GetRelatedAchTourResponse } from './Missions/GetRelatedAchTourResponse';
-import { GetRafflesResponse } from './Raffle/GetRafflesResponse';
+import { GetRafflesResponse, raffleTransform } from './Raffle/GetRafflesResponse';
 import { GetRafflesRequest } from './Raffle/GetRafflesRequest';
 import { InboxCategories } from './Inbox/InboxCategories';
 import { GetDrawRunRequest, GetDrawRunResponse, GetRaffleDrawRunsHistoryRequest, GetRaffleDrawRunsHistoryResponse, RaffleClaimPrizeRequest, RaffleClaimPrizeResponse } from './Raffle';
+import { GetJackpotWinnersResponse, GetJackpotWinnersResponseTransform, JackpotWinnerHistory } from './Jackpots/GetJackpotWinnersResponse';
+import { GetJackpotWinnersRequest } from './Jackpots/GetJackpotWinnersRequest';
 
 const PUBLIC_API_URL = 'https://papi{ENV_ID}.smartico.ai/services/public';
 const C_SOCKET_PROD = 'wss://api{ENV_ID}.smartico.ai/websocket/services';
@@ -487,6 +488,23 @@ class SmarticoAPI {
 		return await this.send<JackpotsOptoutResponse>(message, ClassId.JP_OPTOUT_RESPONSE);
 	}
 
+	public async getJackpotWinners(user_ext_id: string, limit: number = 20, offset: number = 0, jp_template_id: number ): Promise<GetJackpotWinnersResponse> {
+		const message = this.buildMessage<GetJackpotWinnersRequest, GetJackpotWinnersResponse>(
+			user_ext_id,
+			ClassId.JP_GET_WINNERS_REQUEST,
+			{
+				limit,
+				offset,
+				jp_template_id,
+			},
+		);
+		return await this.send<GetJackpotWinnersResponse>(message, ClassId.JP_GET_WINNERS_RESPONSE);
+	}
+
+	public async getJackpotWinnersT(user_ext_id: string, limit: number = 20, offset: number = 0, jp_template_id: number ): Promise<JackpotWinnerHistory[]> {
+		return GetJackpotWinnersResponseTransform((await this.getJackpotWinners(user_ext_id, limit, offset, jp_template_id)).winners);
+	}
+
 	public async sawGetTemplates(
 		user_ext_id: string,
 		force_language?: string,
@@ -1149,47 +1167,50 @@ class SmarticoAPI {
 		);
 		
 		return await this.send<GetRelatedAchTourResponse>(message, ClassId.GET_RELATED_ACH_N_TOURNAMENTS_RESPONSE);
+	}
 
+	public async getRafflesT(user_ext_id: string): Promise<TRaffle[]> {
+		return raffleTransform((await this.getRaffles(user_ext_id)).items);
 	}
 
 	public async getRaffles(user_ext_id: string): Promise<GetRafflesResponse> {
-		const message = this.buildMessage< GetRafflesRequest, GetRafflesResponse>(
-			user_ext_id,
-			ClassId.RAF_GET_RAFFLES_REQUEST
-		);
-		
-		return await this.send<GetRafflesResponse>(message, ClassId.RAF_GET_RAFFLES_RESPONSE);
-	}	
+		const message = this.buildMessage<GetRafflesRequest, GetRafflesResponse>(user_ext_id, ClassId.RAF_GET_RAFFLES_REQUEST);
 
+		return await this.send<GetRafflesResponse>(message, ClassId.RAF_GET_RAFFLES_RESPONSE);
+	}
 
-	public async getDrawRun(user_ext_id: string, payload: GetDrawRunRequest): Promise<GetDrawRunResponse> {
+	public async getRaffleDrawRun(user_ext_id: string, payload: { raffle_id: number; run_id: number }): Promise<GetDrawRunResponse> {
 		const message = this.buildMessage<GetDrawRunRequest, GetDrawRunResponse>(
 			user_ext_id,
-			ClassId.RAF_GET_DRAW_RUN_REQUEST ,
+			ClassId.RAF_GET_DRAW_RUN_REQUEST,
 			payload,
 		);
-		
+
 		return await this.send<GetDrawRunResponse>(message, ClassId.RAF_GET_DRAW_RUN_RESPONSE);
-	}	
+	}
 
-	public async getRaffleDrawRunsHistory(user_ext_id: string, payload: GetRaffleDrawRunsHistoryRequest): Promise<GetRaffleDrawRunsHistoryResponse> {
+	public async getRaffleDrawRunsHistory(
+		user_ext_id: string,
+		props: { raffle_id: number; draw_id?: number },
+	): Promise<GetRaffleDrawRunsHistoryResponse> {
 		const message = this.buildMessage<GetRaffleDrawRunsHistoryRequest, GetRaffleDrawRunsHistoryResponse>(
 			user_ext_id,
-			ClassId.RAF_GET_DRAW_HISTORY_REQUEST ,
-			payload,
+			ClassId.RAF_GET_DRAW_HISTORY_REQUEST,
+			props,
 		);
-		
+
 		return await this.send<GetRaffleDrawRunsHistoryResponse>(message, ClassId.RAF_GET_DRAW_HISTORY_RESPONSE);
-	}	
+	}
 
-	public async claimRafflePrize (user_ext_id:string, payload: RaffleClaimPrizeRequest):Promise <RaffleClaimPrizeResponse>{
-		const message = this.buildMessage<RaffleClaimPrizeRequest,RaffleClaimPrizeResponse>(
+	public async claimRafflePrize(user_ext_id: string, props: { won_id: number }): Promise<RaffleClaimPrizeResponse> {
+		const message = this.buildMessage<RaffleClaimPrizeRequest, RaffleClaimPrizeResponse>(
 			user_ext_id,
-			ClassId.RAF_CLAIM_PRIZE_REQUEST ,
-			payload
+			ClassId.RAF_CLAIM_PRIZE_REQUEST,
+			props,
 		);
 
-		return await this.send<RaffleClaimPrizeResponse>(message,ClassId.RAF_CLAIM_PRIZE_RESPONSE);
+		return await this.send<RaffleClaimPrizeResponse>(message, ClassId.RAF_CLAIM_PRIZE_RESPONSE);
+
 	}
 }
 

package/src/WSAPI/WSAPI.ts

@@ -38,12 +38,17 @@ import {
 	TClaimBonusResult,
 	TMiniGamePlayBatchResult,
 	TSawHistory,
+	TRaffle,
+	TRaffleDraw,
+	TRaffleDrawRun,
+	TransformedRaffleClaimPrizeResponse,
 } from './WSAPITypes';
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import {
 	JackpotDetails,
 	JackpotPot,
 	JackpotWinPush,
+	JackpotWinnerHistory,
 	JackpotsOptinResponse,
 	JackpotsOptoutRequest,
 	JackpotsOptoutResponse,
@@ -51,15 +56,18 @@ import {
 import { GetTournamentsResponse } from '../Tournaments';
 import { GetAchievementMapResponse } from '../Missions';
 import { GetRelatedAchTourResponse } from '../Missions/GetRelatedAchTourResponse';
-import { GetRafflesResponse } from '../Raffle/GetRafflesResponse';
+import { drawTransform, GetRafflesResponse, prizeTransform, ticketsTransform } from '../Raffle/GetRafflesResponse';
 import { InboxCategories } from '../Inbox/InboxCategories';
 import {
+	drawRunHistoryTransform,
+	drawRunTransform,
 	GetDrawRunRequest,
 	GetDrawRunResponse,
 	GetRaffleDrawRunsHistoryRequest,
 	GetRaffleDrawRunsHistoryResponse,
 	RaffleClaimPrizeRequest,
 	RaffleClaimPrizeResponse,
+	raffleClaimPrizeResponseTransform,
 } from '../Raffle';
 import { IntUtils } from '../IntUtils';
 
@@ -68,6 +76,7 @@ const CACHE_DATA_SEC = 30;
 
 const JACKPOT_TEMPLATE_CACHE_SEC = 30;
 const JACKPOT_POT_CACHE_SEC = 1;
+const JACKPOT_WINNERS_CACHE_SEC = 30;
 
 /** @hidden */
 enum onUpdateContextKey {
@@ -89,6 +98,8 @@ enum onUpdateContextKey {
 	CustomSections = 'customSections',
 	Bonuses = 'bonuses',
 	SAWHistory = 'sawHistory',
+	JackpotWinners = 'jackpotWinners',
+	Raffles = 'raffles',
 }
 
 /** @group General API */
@@ -126,6 +137,10 @@ export class WSAPI {
 				this.reloadMiniGameTemplate();
 				OCache.clear(ECacheContext.WSAPI, onUpdateContextKey.SAWHistory);
 			});
+			on(ClassId.RAF_CLAIM_PRIZE_RESPONSE, () => {
+				this.updateRaffles();
+				OCache.clear(ECacheContext.WSAPI, onUpdateContextKey.Raffles);
+			});
 		}
 	}
 
@@ -911,6 +926,11 @@ export class WSAPI {
 		this.updateEntity(onUpdateContextKey.InboxMessages, payload);
 	}
 
+	private async updateRaffles() {
+		const payload = await this.api.getRafflesT(null);
+		this.updateEntity(onUpdateContextKey.Raffles, payload);
+	}
+
 	private async updateEntity(contextKey: onUpdateContextKey, payload: any) {
 		OCache.set(contextKey, payload, ECacheContext.WSAPI);
 
@@ -923,6 +943,7 @@ export class WSAPI {
 	private async jackpotClearCache() {
 		OCache.clear(ECacheContext.WSAPI, onUpdateContextKey.Jackpots);
 		OCache.clear(ECacheContext.WSAPI, onUpdateContextKey.Pots);
+		OCache.clear(ECacheContext.WSAPI, onUpdateContextKey.JackpotWinners);
 	}
 
 	/** Returns list of Jackpots that are active in the systen and matching to the filter definition.
@@ -1040,6 +1061,40 @@ export class WSAPI {
 
 		return result;
 	}
+
+	/**
+	 * Returns the winners of the jackpot with the specified jp_template_id.
+	 *
+	 * **Example**:
+	 * ```
+	 * _smartico.api.getJackpotWinners({
+	 *      jp_template_id: 123,
+	 * }).then((result) => {
+	 *      console.log(result);
+	 * });
+	 * ```
+	 * 
+	 * **Visitor mode: not supported**
+	 * 
+	 */
+
+	public async getJackpotWinners({
+		limit,
+		offset,
+		jp_template_id,
+	} : {
+		limit?: number;
+		offset?: number;
+		jp_template_id?: number;
+	}): Promise<JackpotWinnerHistory[]> {
+		return OCache.use(
+			onUpdateContextKey.JackpotWinners,
+			ECacheContext.WSAPI,
+			() => this.api.getJackpotWinnersT(null, limit, offset, jp_template_id),
+			JACKPOT_WINNERS_CACHE_SEC,
+		);
+	}
+
 	/**
 	 * Returns all the related tournaments and missions for the provided game id for the current user
 	 * The provided Game ID should correspond to the ID from the Games Catalog - https://help.smartico.ai/welcome/technical-guides/games-catalog-api
@@ -1063,19 +1118,99 @@ export class WSAPI {
 		return result;
 	}
 
-	public async getRaffles(): Promise<GetRafflesResponse> {
-		return await this.api.getRaffles(null);
+	/**
+	 * Returns the list of Raffles available for user
+	 * The returned list of Raffles is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getRaffles with a new onUpdate callback, the old one will be overwritten by the new one.
+	 * The onUpdate callback will be called on claiming prize.  Updated Raffles will be passed to onUpdate callback.
+	 *
+	 * **Example**:
+	 * ```
+	 * _smartico.api.getRaffles().then((result) => {
+	 *      console.log(result);
+	 * });
+	 * ```
+	 *
+	 * **Visitor mode: not supported**
+	 *
+	 */
+
+	public async getRaffles({ onUpdate }: { onUpdate?: (data: TRaffle[]) => void } = {}): Promise<TRaffle[]> {
+		if (onUpdate) {
+			this.onUpdateCallback.set(onUpdateContextKey.Raffles, onUpdate);
+		}
+
+		return OCache.use(onUpdateContextKey.Raffles, ECacheContext.WSAPI, () => this.api.getRafflesT(null), CACHE_DATA_SEC);
 	}
 
-	public async getDrawRun(payload: GetDrawRunRequest): Promise<GetDrawRunResponse> {
-		return await this.api.getDrawRun(null, payload);
+	/**
+	 * Returns draw run for provided raffle_id and run_id
+	 *
+	 *
+	 * **Example**:
+	 * ```
+	 * _smartico.api.getRaffleDrawRun({raffle_id:156, run_id: 145}).then((result) => {
+	 *      console.log(result);
+	 * });
+	 * ```
+	 *
+	 * **Visitor mode: not supported**
+	 *
+	 */
+
+	public async getRaffleDrawRun(props: { raffle_id: number; run_id: number }): Promise<TRaffleDraw> {
+		const res = await this.api.getRaffleDrawRun(null, props);
+
+		if (!props.raffle_id || !props.run_id) {
+			throw new Error('both raffle_id and run_id are required');
+		}
+
+		return drawRunTransform(res);
 	}
 
-	public async getRaffleDrawRunsHistory(payload: GetRaffleDrawRunsHistoryRequest): Promise<GetRaffleDrawRunsHistoryResponse> {
-		return await this.api.getRaffleDrawRunsHistory(null, payload);
+	/**
+	 * Returns history of draw runs for the provided raffle_id and draw_id, if the draw_id is not provided will return history of all the draws for the provided raffle_id
+	 *
+	 *
+	 * **Example**:
+	 * ```
+	 * _smartico.api.getRaffleDrawRunHistory({raffle_id:156, draw_id: 432}).then((result) => {
+	 *      console.log(result);
+	 * });
+	 * ```
+	 *
+	 * **Visitor mode: not supported**
+	 *
+	 */
+
+	public async getRaffleDrawRunsHistory(props: { raffle_id: number; draw_id?: number }): Promise<TRaffleDrawRun[]> {
+		const res = await this.api.getRaffleDrawRunsHistory(null, props);
+
+		if (!props.raffle_id) {
+			throw new Error('raffle_id is required');
+		}
+
+		return drawRunHistoryTransform(res);
 	}
 
-	public async claimRafflePrize(payload: RaffleClaimPrizeRequest): Promise<RaffleClaimPrizeResponse> {
-		return await this.api.claimRafflePrize(null, payload);
+	/**
+	 * Returns error code, and error Message after calling the function, error message 0 - means that the request was successful
+	 *
+	 *
+	 * **Example**:
+	 * ```
+	 * _smartico.api.claimRafflePrize({won_id:251}).then((result) => {
+	 *      console.log(result);
+	 * });
+	 * ```
+	 *
+	 * **Visitor mode: not supported**
+	 *
+	 */
+	public async claimRafflePrize(props: { won_id: number }): Promise<TransformedRaffleClaimPrizeResponse> {
+		if (!props.won_id) {
+			throw new Error('won_id is required');
+		}
+		const res = await this.api.claimRafflePrize(null, { won_id: props.won_id });
+		return raffleClaimPrizeResponseTransform(res);
 	}
 }