@smartico/public-api 0.0.69 → 0.0.71

package/README.md

@@ -23,6 +23,21 @@ _smartico.api.levelsGet().then( levels => {
 
 ```
 
+Some methods can be called with onUpdate callback, which is executed when there are changes in the underlying data.
+Example:
+
+```javascript
+
+var miniGamesUpdates = (games) => {
+    console.log('There are ' + games.length + ' games available now');
+}
+
+_smartico.api.getMiniGames( { onUpdate: miniGamesUpdates} ).then( games => {
+    console.log('There are ' + games.length + ' games available');
+});
+
+```
+
 See the [API documentation](docs/classes/WSAPI.md) for all available methods and returning data.
 
 

package/dist/OCache.d.ts

@@ -1,9 +1,11 @@
 export declare enum ECacheContext {
     Translations = 0,
-    LabelInfo = 1
+    LabelInfo = 1,
+    WSAPI = 2
 }
 export declare class OCache {
     private static cache;
+    private static init;
     static get<T>(oKey: any, cacheContext: ECacheContext): T | undefined;
     static set(oKey: any, o: any, cacheContext: ECacheContext, ttlSeconds?: number): void;
     static use<T>(oKey: any, cacheContext: ECacheContext, f: () => Promise<T>, ttlSeconds?: number): Promise<T>;

package/dist/SmarticoAPI.d.ts

@@ -1,7 +1,7 @@
 import { ClassId } from "./Base/ClassId";
 import { SAWGetTemplatesResponse } from './MiniGames/SAWGetTemplatesResponse';
 import { ILogger } from './ILogger';
-import { SAWDoSpinResponse } from './MiniGames';
+import { SAWDoAknowledgeResponse, SAWDoSpinResponse } from './MiniGames';
 import { GetTranslationsResponse, ResponseIdentify, TranslationArea } from './Core';
 import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
 import { GetInboxMessagesResponse } from './Inbox';
@@ -15,6 +15,7 @@ import { TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TStoreItem,
 interface Tracker {
     label_api_key: string;
     userPublicProps: any;
+    on: (callBackKey: ClassId, func: (data: any) => void) => void;
 }
 interface IOptions {
     logger?: ILogger;
@@ -53,6 +54,7 @@ declare class SmarticoAPI {
     }>;
     sawGetTemplates(user_ext_id: string, lang?: string, is_visitor_mode?: boolean): Promise<SAWGetTemplatesResponse>;
     sawGetTemplatesT(user_ext_id: string): Promise<TMiniGameTemplate[]>;
+    doAcknowledgeRequest(user_ext_id: string, request_id: string): Promise<SAWDoAknowledgeResponse>;
     sawSpinRequest(user_ext_id: string, saw_template_id: number, round_id?: number): Promise<SAWDoSpinResponse>;
     inboxGetMessages(user_ext_id: string, limit?: number, offset?: number): Promise<GetInboxMessagesResponse>;
     storeGetItems(user_ext_id: string): Promise<GetStoreItemsResponse>;

package/dist/WSAPI/WSAPI.d.ts

@@ -3,26 +3,44 @@ import { TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionOrBadge, TStore
 /** @group General API */
 export declare class WSAPI {
     private api;
+    private onUpdateCallback;
     /** @private */
     constructor(api: SmarticoAPI);
     /** Returns information about current user */
     getUserProfile(): TUserProfile;
     /** Returns all the levels available the current user */
     getLevels(): Promise<TLevel[]>;
-    /** Returns all the missions available the current user */
-    getMissions(): Promise<TMissionOrBadge[]>;
+    /** 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. */
+    getMissions({ onUpdate }?: {
+        onUpdate?: (data: TMissionOrBadge[]) => void;
+    }): Promise<TMissionOrBadge[]>;
     /** Returns all the badges available the current user */
     getBadges(): Promise<TMissionOrBadge[]>;
     /** Returns all the store items available the current user */
     getStoreItems(): Promise<TStoreItem[]>;
     /** Returns store categories */
     getStoreCategories(): Promise<TStoreItem[]>;
-    /** Returns the list of mini-games available for user */
-    getMiniGames(): Promise<TMiniGameTemplate[]>;
+    /** 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. */
+    getMiniGames({ onUpdate }?: {
+        onUpdate?: (data: TMiniGameTemplate[]) => void;
+    }): Promise<TMiniGameTemplate[]>;
     /** Plays the specified by template_id mini-game on behalf of user and returns prize_id or err_code  */
     playMiniGame(template_id: number): Promise<TMiniGamePlayResult>;
-    /** Returns all the active instances of tournaments */
-    getTournamentsList(): Promise<TTournament[]>;
+    /** 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.*/
+    getTournamentsList({ onUpdate }?: {
+        onUpdate?: (data: TTournament[]) => void;
+    }): Promise<TTournament[]>;
     /** Returns details information of specific tournament instance, the response will includ tournamnet info and the leaderboard of players */
     getTournamentInstanceInfo(tournamentInstanceId: number): Promise<TTournamentDetailed>;
+    private updateOnSpin;
+    private updateOnPrizeWin;
+    private updateMissionsOnOptIn;
+    private updateTournamentsOnRegistration;
+    private updateEntity;
 }

package/dist/WSAPI/WSAPITypes.d.ts

@@ -45,8 +45,11 @@ export interface TMiniGameTemplate {
     saw_game_type: SAWGameTypeName;
     /** 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 */
     buyin_cost_points: number;
+    /** 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 */
     next_available_spin_ts: number;
     /** The message that should be shown to the user when he cannot play the game, server rejected attempt with error code SAWSpinErrorCode.SAW_FAILED_MAX_SPINS_REACHED */
     over_limit_message: string;