@smartico/public-api 0.0.68 → 0.0.70

package/docs/classes/WSAPI.md

@@ -28,9 +28,18 @@ ___
 
 ### getMissions
 
-▸ **getMissions**(): `Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
+▸ **getMissions**(`«destructured»`): `Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
 
-Returns all the missions available the current user
+Returns all the missions available the current user.
+The returned missions is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMissions with a new onUpdate callback, the old one will be overwritten by the new one. 
+The onUpdate callback will be called on mission OptIn and the updated missions will be passed to it.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `onUpdate?` | (`data`: [`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]) => `void` |
 
 #### Returns
 
@@ -76,9 +85,18 @@ ___
 
 ### getMiniGames
 
-▸ **getMiniGames**(): `Promise`<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
+▸ **getMiniGames**(`«destructured»`): `Promise`<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
+
+Returns the list of mini-games available for user 
+The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMiniGames with a new onUpdate callback, the old one will be overwritten by the new one. 
+The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or wined prize is spin/jackpot and if max count of the available user spin equal one . Updated templates will be passed to onUpdate callback.
 
-Returns the list of mini-games available for user
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `onUpdate?` | (`data`: [`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]) => `void` |
 
 #### Returns
 
@@ -106,9 +124,18 @@ ___
 
 ### getTournamentsList
 
-▸ **getTournamentsList**(): `Promise`<[`TTournament`](../interfaces/TTournament.md)[]\>
+▸ **getTournamentsList**(`«destructured»`): `Promise`<[`TTournament`](../interfaces/TTournament.md)[]\>
 
-Returns all the active instances of tournaments
+Returns all the active instances of tournaments 
+The returned list is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getTournamentsList with a new onUpdate callback, the old one will be overwritten by the new one. 
+The onUpdate callback will be called when the user has registered in a tournament. Updated list will be passed to onUpdate callback.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `onUpdate?` | (`data`: [`TTournament`](../interfaces/TTournament.md)[]) => `void` |
 
 #### Returns
 

package/docs/interfaces/TMiniGameTemplate.md

@@ -56,12 +56,24 @@ ___
 
 • **buyin\_cost\_points**: `number`
 
+in case of charging type 'Points', what is the points amount will be deducted from user balance
+
 ___
 
 ### spin\_count
 
 • `Optional` **spin\_count**: `number`
 
+in case of charging type 'Spin attempts', shows the current number of spin attempts that user has
+
+___
+
+### next\_available\_spin\_ts
+
+• **next\_available\_spin\_ts**: `number`
+
+if the game is limit to the number of spins that user can do during period of time, this property shows the epoch time in UTC when the next attempt will be available
+
 ___
 
 ### over\_limit\_message

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartico/public-api",
-  "version": "0.0.68",
+  "version": "0.0.70",
   "description": "Smartico public API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/MiniGames/SAWGetTemplatesResponse.ts

@@ -31,8 +31,8 @@ export const SAWTemplatesTransform = (items: SAWTemplate[]): TMiniGameTemplate[]
             over_limit_message: r.saw_template_ui_definition.over_limit_message,
             no_attempts_message: r.saw_template_ui_definition.no_attempts_message,
             jackpot_symbol: r.saw_template_ui_definition.jackpot_symbol,
-            saw_game_type: SAWGameTypeNamed[r.saw_game_type_id],
-            saw_buyin_type: SAWBuyInTypeNamed[r.saw_buyin_type_id],
+            saw_game_type: SAWGameTypeNamed(r.saw_game_type_id),
+            saw_buyin_type: SAWBuyInTypeNamed(r.saw_buyin_type_id),
             buyin_cost_points: r.buyin_cost_points,
             jackpot_add_on_attempt: r.jackpot_add_on_attempt,
             jackpot_current: r.jackpot_current,

package/src/MiniGames/SAWTemplateUI.ts

@@ -27,6 +27,7 @@ export interface SAWTemplateUI {
     matchx_banner?: string;
     matchx_seasonal_ranking?: boolean;
     matchx_general_board_users_count?: number;
+    matchx_hide_ranking?: boolean;
     ask_for_username?: SAWAskForUsername;
     show_prize_board?: boolean;
 

package/src/OCache.ts

@@ -3,7 +3,8 @@ import { NodeCache } from "./NodeCache";
 
 export enum ECacheContext {
     Translations,
-    LabelInfo
+    LabelInfo,
+    WSAPI,
 }
 
 const WITH_REF_CACHE = [
@@ -12,15 +13,19 @@ const WITH_REF_CACHE = [
 
 export class OCache {
 
-    private static cache: { [key: string] : NodeCache } = {}
+    private static cache: { [key: string]: NodeCache } = {};
+
+    private static init(cacheContext: ECacheContext) {
+        if (this.cache[cacheContext] === undefined) {
+            this.cache[cacheContext] = new NodeCache();
+        }
+    }
 
     public static get<T>(oKey: any, cacheContext: ECacheContext): T | undefined {
 
         const key = cacheContext.toString() + '_' + JSON.stringify(oKey);
 
-        if (this.cache[cacheContext] === undefined) {
-            this.cache[cacheContext] = new NodeCache( );
-        }
+        this.init(cacheContext);
 
         return this.cache[cacheContext].get(key);
     }
@@ -29,6 +34,8 @@ export class OCache {
 
         const key = cacheContext.toString() + '_' + JSON.stringify(oKey);
 
+        this.init(cacheContext);
+
         this.cache[cacheContext].set(key, o, ttlSeconds);
     }
 

package/src/SmarticoAPI.ts

@@ -5,7 +5,7 @@ import { SAWGetTemplatesResponse } from './MiniGames/SAWGetTemplatesResponse';
 import { SAWGetTemplatesRequest } from './MiniGames/SAWGetTemplatesRequest';
 import { IntUtils } from './IntUtils';
 import { ILogger } from './ILogger';
-import { SAWDoSpinRequest, SAWDoSpinResponse, SAWSpinErrorCode, SAWTemplatesTransform } from './MiniGames';
+import { SAWDoAknowledgeRequest, SAWDoAknowledgeResponse, SAWDoSpinRequest, SAWDoSpinResponse, SAWSpinErrorCode, SAWTemplatesTransform } from './MiniGames';
 import { ECacheContext, OCache } from './OCache';
 import { CoreUtils, GetTranslationsRequest, GetTranslationsResponse, ResponseIdentify, TranslationArea } from './Core';
 import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
@@ -27,6 +27,7 @@ const DEFAULT_LANG_EN = "EN";
 interface Tracker {
     label_api_key: string;
     userPublicProps: any;
+    on: (callBackKey: ClassId, func: (data: any) => void) => void;
 }
 interface IOptions {
     logger?: ILogger;
@@ -293,13 +294,22 @@ class SmarticoAPI {
 
     public async sawGetTemplatesT(user_ext_id: string): Promise<TMiniGameTemplate[]> {
         return SAWTemplatesTransform((await this.sawGetTemplates(user_ext_id)).templates);
-    }    
+    }
+
+    public async doAcknowledgeRequest(user_ext_id: string, request_id: string): Promise<SAWDoAknowledgeResponse>{
+        const message = this.buildMessage<SAWDoAknowledgeRequest, SAWDoAknowledgeResponse>(user_ext_id, ClassId.SAW_AKNOWLEDGE_REQUEST, {
+            request_id
+        });
+
+        return await this.send<SAWDoAknowledgeResponse>(message, ClassId.SAW_AKNOWLEDGE_RESPONSE);
+    }
 
     public async sawSpinRequest(user_ext_id: string, saw_template_id: number, round_id?: number): Promise<SAWDoSpinResponse> {
+        const request_id = IntUtils.uuid();
 
         const message = this.buildMessage<SAWDoSpinRequest, SAWDoSpinResponse>(user_ext_id, ClassId.SAW_DO_SPIN_REQUEST, {
             saw_template_id,
-            request_id: IntUtils.uuid()
+            request_id
         });
 
         const spinAttemptResponse = await this.send<SAWDoSpinResponse>(message, ClassId.SAW_DO_SPIN_RESPONSE);
@@ -321,7 +331,7 @@ class SmarticoAPI {
             round_id,
         });
 
-        return spinAttemptResponse;
+        return {...spinAttemptResponse, request_id };
     }
 
     public async inboxGetMessages(user_ext_id: string, limit: number = 10, offset: number = 0): Promise<GetInboxMessagesResponse> {

package/src/WSAPI/WSAPI.ts

@@ -1,13 +1,32 @@
+import { ClassId } from "../Base/ClassId";
 import { CoreUtils } from "../Core";
+import { MiniGamePrizeTypeName, SAWDoSpinResponse, SAWSpinErrorCode, SAWSpinsCountPush } from "../MiniGames";
+import { ECacheContext, OCache } from "../OCache";
 import { SmarticoAPI } from "../SmarticoAPI";
+import { TLevel, TMiniGamePlayResult, TMiniGamePrize, TMiniGameTemplate, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TUserProfile } from "./WSAPITypes";
+ 
+/** @hidden */
+const CACHE_DATA_SEC = 30;
+ /** @hidden */
+enum onUpdateContextKey {
+    Saw = 'saw',
+    Missions = 'missions',
+    TournamentList = 'tournamentList',
+}
 
-import { TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TUserProfile } from "./WSAPITypes";
 
 /** @group General API */
 export class WSAPI {
 
+    private onUpdateCallback: Map<onUpdateContextKey, (data: any) => void> = new Map();
+
     /** @private */
     constructor(private api: SmarticoAPI) {
+        const on = this.api.tracker.on;
+        on(ClassId.SAW_SPINS_COUNT_PUSH, (data: SAWSpinsCountPush) => this.updateOnSpin(data));
+        on(ClassId.SAW_DO_SPIN_RESPONSE, (data: SAWDoSpinResponse) => on(ClassId.SAW_AKNOWLEDGE_RESPONSE, () => this.updateOnPrizeWin(data)));
+        on(ClassId.MISSION_OPTIN_RESPONSE, () => this.updateMissionsOnOptIn());
+        on(ClassId.TOURNAMENT_REGISTER_RESPONSE, () => this.updateTournamentsOnRegistration());
     }
 
     /** Returns information about current user */
@@ -19,16 +38,22 @@ export class WSAPI {
         } else {
             throw new Error('Tracker is not initialized, cannot getUserProfile');
         }
-    }    
+    }
 
     /** Returns all the levels available the current user */
     public async getLevels(): Promise<TLevel[]> {
         return this.api.levelsGetT(null);
     }
 
-    /** Returns all the missions available the current user */
-    public async getMissions(): Promise<TMissionOrBadge[]> {
-        return this.api.missionsGetItemsT(null);
+    /** Returns all the missions available the current user.
+     * The returned missions is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMissions with a new onUpdate callback, the old one will be overwritten by the new one. 
+     * The onUpdate callback will be called on mission OptIn and the updated missions will be passed to it. */ 
+    public async getMissions({ onUpdate }: { onUpdate?: (data: TMissionOrBadge[]) => void }): Promise<TMissionOrBadge[]> {
+        if (onUpdate) {
+            this.onUpdateCallback.set(onUpdateContextKey.Missions, onUpdate);
+        }
+
+        return OCache.use(onUpdateContextKey.Missions, ECacheContext.WSAPI, () => this.api.missionsGetItemsT(null), CACHE_DATA_SEC);
     }
 
     /** Returns all the badges available the current user */
@@ -44,17 +69,23 @@ export class WSAPI {
     /** Returns store categories */
     public async getStoreCategories(): Promise<TStoreItem[]> {
         return this.api.storeGetItemsT(null);
-    }    
+    }
+
+    /** Returns the list of mini-games available for user 
+     * The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMiniGames with a new onUpdate callback, the old one will be overwritten by the new one. 
+     * The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or wined prize is spin/jackpot and if max count of the available user spin equal one . Updated templates will be passed to onUpdate callback. */
+    public async getMiniGames({ onUpdate }: { onUpdate?: (data: TMiniGameTemplate[]) => void }): Promise<TMiniGameTemplate[]> {
+        if (onUpdate) {
+            this.onUpdateCallback.set(onUpdateContextKey.Saw, onUpdate);
+        }
 
-    /** Returns the list of mini-games available for user */
-    public async getMiniGames(): Promise<TMiniGameTemplate[]> {
-        return this.api.sawGetTemplatesT(null);
+        return OCache.use(onUpdateContextKey.Saw, ECacheContext.WSAPI, () => this.api.sawGetTemplatesT(null), CACHE_DATA_SEC);
     }
 
     /** Plays the specified by template_id mini-game on behalf of user and returns prize_id or err_code  */
     public async playMiniGame(template_id: number): Promise<TMiniGamePlayResult> {
-        
         const r = await this.api.sawSpinRequest(null, template_id);
+        this.api.doAcknowledgeRequest(null, r.request_id)
 
         const o: TMiniGamePlayResult = {
             err_code: r.errCode,
@@ -65,9 +96,15 @@ export class WSAPI {
         return o;
     }    
 
-    /** Returns all the active instances of tournaments */
-    public async getTournamentsList(): Promise<TTournament[]> {
-        return this.api.tournamentsGetLobbyT(null);
+    /** Returns all the active instances of tournaments 
+     * The returned list is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getTournamentsList with a new onUpdate callback, the old one will be overwritten by the new one. 
+     * The onUpdate callback will be called when the user has registered in a tournament. Updated list will be passed to onUpdate callback.*/
+    public async getTournamentsList({ onUpdate }: { onUpdate?: (data: TTournament[]) => void }): Promise<TTournament[]> {
+        if (onUpdate) {
+            this.onUpdateCallback.set(onUpdateContextKey.TournamentList, onUpdate);
+        }
+
+        return OCache.use(onUpdateContextKey.TournamentList, ECacheContext.WSAPI, () => this.api.tournamentsGetLobbyT(null), CACHE_DATA_SEC);
     }
 
     /** Returns details information of specific tournament instance, the response will includ tournamnet info and the leaderboard of players */
@@ -75,4 +112,47 @@ export class WSAPI {
         return this.api.tournamentsGetInfoT(null, tournamentInstanceId);
     }
 
+    private async updateOnSpin(data: SAWSpinsCountPush) {
+        const templates: TMiniGameTemplate[] = await OCache.use(onUpdateContextKey.Saw, ECacheContext.WSAPI, () => this.api.sawGetTemplatesT(null), CACHE_DATA_SEC);
+        const index = templates.findIndex(t => t.id === data.saw_template_id);
+        templates[index].spin_count = data.spin_count;
+        this.updateEntity(onUpdateContextKey.Saw, templates)
+    }
+
+    private async updateOnPrizeWin(data: SAWDoSpinResponse) {
+        if (data.errCode === SAWSpinErrorCode.SAW_OK) {
+            const templates: TMiniGameTemplate[] = await OCache.use(onUpdateContextKey.Saw, ECacheContext.WSAPI, () => this.api.sawGetTemplatesT(null), CACHE_DATA_SEC);
+            const template: TMiniGameTemplate = templates.find(t => t.prizes.find(p => p.id === data.saw_prize_id));
+            const prizeType = template.prizes.find(p => p.id === data.saw_prize_id)?.prize_type;
+
+            if (
+                template.jackpot_add_on_attempt ||
+                template.spin_count === 1 ||
+                prizeType === MiniGamePrizeTypeName.JACKPOT ||
+                prizeType === MiniGamePrizeTypeName.SPIN
+            ) {
+                const updatedTemplates = await this.api.sawGetTemplatesT(null);
+                this.updateEntity(onUpdateContextKey.Saw, updatedTemplates)
+            }
+        }
+    }
+
+    private async updateMissionsOnOptIn() {
+        const payload = await this.api.missionsGetItemsT(null);
+        this.updateEntity(onUpdateContextKey.Missions, payload)
+    }
+
+    private async updateTournamentsOnRegistration() {
+        const payload = await this.api.tournamentsGetLobbyT(null);
+        this.updateEntity(onUpdateContextKey.TournamentList, payload)
+    }
+
+    private async updateEntity(contextKey: onUpdateContextKey, payload: any) {
+        OCache.set(contextKey, payload, ECacheContext.WSAPI);
+
+        const onUpdate = this.onUpdateCallback.get(contextKey);
+        if (onUpdate) {
+            onUpdate(payload);
+        }
+    }
 }

package/src/WSAPI/WSAPITypes.ts

@@ -54,12 +54,12 @@ export interface TMiniGameTemplate {
     /** How the user is charged for each game attempt e.g. Free, Points or Spin attempts */
     saw_buyin_type: SAWBuyInTypeName;    
 
-    // in case of charging type 'Points', what is the points amount will be deducted from user balance
+    /** in case of charging type 'Points', what is the points amount will be deducted from user balance */
     buyin_cost_points: number;
-    // in case of charging type 'Spin attempts', shows the current number of spin attempts that user has
+    /** in case of charging type 'Spin attempts', shows the current number of spin attempts that user has */
     spin_count?: number; 
 
-    // if the game is limit to the number of spins that user can do during period of time, this property shows the epoch time in UTC when the next attempt will be available
+    /** if the game is limit to the number of spins that user can do during period of time, this property shows the epoch time in UTC when the next attempt will be available */
     next_available_spin_ts: number;