@smartico/public-api 0.0.111 → 0.0.113

package/docs/README.md

@@ -32,6 +32,9 @@
 - [TInboxMessage](interfaces/TInboxMessage.md)
 - [TInboxMessageBody](interfaces/TInboxMessageBody.md)
 - [InboxMarkMessageAction](interfaces/InboxMarkMessageAction.md)
+- [LeaderBoardDetailsT](interfaces/LeaderBoardDetailsT.md)
+- [LeaderBoardsRewardsT](interfaces/LeaderBoardsRewardsT.md)
+- [LeaderBoardUserT](interfaces/LeaderBoardUserT.md)
 
 ## General API
 

package/docs/classes/WSAPI.md

@@ -87,29 +87,28 @@ ___
 
 ### getStoreCategories
 
-▸ **getStoreCategories**(): `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
+▸ **getStoreCategories**(): `Promise`<[`TStoreCategory`](../interfaces/TStoreCategory.md)[]\>
 
 Returns store categories
 
 #### Returns
 
-`Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
+`Promise`<[`TStoreCategory`](../interfaces/TStoreCategory.md)[]\>
 
 ___
 
 ### getAchCategories
 
-▸ **getAchCategories**(): `Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
+▸ **getAchCategories**(): `Promise`<[`TAchCategory`](../interfaces/TAchCategory.md)[]\>
 
-Returns achievement categories
+Returns ach categories
 
 #### Returns
 
-`Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
+`Promise`<[`TAchCategory`](../interfaces/TAchCategory.md)[]\>
 
 ___
 
-
 ### getMiniGames
 
 ▸ **getMiniGames**(`params?`): `Promise`<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
@@ -219,6 +218,26 @@ Requests registration for the specified tournament instance. Returns the err_cod
 
 ___
 
+### getLeaderBoard
+
+▸ **getLeaderBoard**(`periodType`, `getPreviousPeriod?`): `Promise`<[`LeaderBoardDetailsT`](../interfaces/LeaderBoardDetailsT.md)\>
+
+Returns the leaderboard for the current type (default is Daily). If getPreviousPeriod is passed as true, a leaderboard for the previous period for the current type will be returned.
+For example, if the type is Weekly and getPreviousPeriod is true, a leaderboard for the previous week will be returned.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `periodType` | `LeaderBoardPeriodType` |
+| `getPreviousPeriod?` | `boolean` |
+
+#### Returns
+
+`Promise`<[`LeaderBoardDetailsT`](../interfaces/LeaderBoardDetailsT.md)\>
+
+___
+
 ### getInboxMessages
 
 ▸ **getInboxMessages**(`params?`): `Promise`<[`TInboxMessage`](../interfaces/TInboxMessage.md)[]\>

package/docs/interfaces/LeaderBoardDetailsT.md

@@ -0,0 +1,65 @@
+# Interface: LeaderBoardDetailsT
+
+## Properties
+
+### board\_id
+
+• **board\_id**: `number`
+
+ID of the leaderboard
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of the leaderboard
+
+___
+
+### description
+
+• **description**: `string`
+
+Description of the leaderboard
+
+___
+
+### rules
+
+• **rules**: `string`
+
+Rules of the leaderboard
+
+___
+
+### period\_type\_id
+
+• **period\_type\_id**: `LeaderBoardPeriodType`
+
+Leaderboard period type ID
+
+___
+
+### rewards
+
+• **rewards**: [`LeaderBoardsRewardsT`](LeaderBoardsRewardsT.md)[]
+
+Leaderboard points rewards
+
+___
+
+### users
+
+• **users**: [`LeaderBoardUserT`](LeaderBoardUserT.md)[]
+
+Leaderboard users
+
+___
+
+### me
+
+• `Optional` **me**: [`LeaderBoardUserT`](LeaderBoardUserT.md)
+
+Info about current user in leaderboard

package/docs/interfaces/LeaderBoardUserT.md

@@ -0,0 +1,41 @@
+# Interface: LeaderBoardUserT
+
+## Properties
+
+### public\_username
+
+• **public\_username**: `string`
+
+The username of the participant
+
+___
+
+### avatar\_url
+
+• **avatar\_url**: `string`
+
+The URL to the avatar of the participant
+
+___
+
+### position
+
+• **position**: `number`
+
+The position of the participant in the leaderboard
+
+___
+
+### points
+
+• **points**: `number`
+
+The points of the participant in the leaderboard
+
+___
+
+### is\_me
+
+• **is\_me**: `boolean`
+
+The indicator if the participant is current user

package/docs/interfaces/LeaderBoardsRewardsT.md

@@ -0,0 +1,13 @@
+# Interface: LeaderBoardsRewardsT
+
+## Properties
+
+### place
+
+• **place**: `number`
+
+___
+
+### points
+
+• **points**: `number`

package/docs/interfaces/TAchCategory.md

@@ -18,4 +18,4 @@ ___
 
 ### order
 
-• **order**: `number`
+• **order**: `number`

package/docs/interfaces/TMissionOrBadge.md

@@ -181,3 +181,11 @@ ___
 • **category\_ids**: `number`[]
 
 The list of IDs of the categories where the badge item is assigned, information about categories can be retrieved with getAchCategories method
+
+___
+
+### hint\_text
+
+• `Optional` **hint\_text**: `string`
+
+The T&C text for the missions

package/docs/interfaces/TStoreItem.md

@@ -108,3 +108,11 @@ ___
 • `Optional` **pool**: `number`
 
 Number of items in the pool avaliable for the purchase.
+
+___
+
+### hint\_text
+
+• `Optional` **hint\_text**: `string`
+
+The T&C text for the store item

package/package.json

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

package/src/Leaderboard/LeaderBoards.ts

@@ -0,0 +1,51 @@
+import { LeaderBoardDetailsT, LeaderBoardUserT, LeaderBoardsRewardsT } from "src/WSAPI/WSAPITypes";
+import { LeaderBoardDetails } from "./LeaderBoardDetails";
+import { LeaderBoardPeriodType } from "./LeaderBoardPeriodType";
+import { LeaderBoardPosition } from "./LeaderBoardPosition";
+
+const pointsRewardTransform = (reward_points: number[]): LeaderBoardsRewardsT[] => {
+    if (reward_points && reward_points.length) {
+        return reward_points.map((r, i) => ({ place: i + 1, points: r }));
+    }
+
+    return null;
+}
+
+const getLeaderBoardPlayerTransformed = (user: LeaderBoardPosition, isMe?: boolean): LeaderBoardUserT => {
+    if (user) {
+        const x: LeaderBoardUserT= {
+            public_username: user?.public_username || user.user_alt_name,
+            avatar_url: user.avatar_url,
+            position: user.position_in_board,
+            points: user.points_accumulated,
+            is_me: user.is_me,
+        }
+    
+        if (isMe) {
+            delete x.is_me;
+        }
+
+        return x;
+    }
+
+    return null;
+}
+
+export const getLeaderBoardTransform = (board: LeaderBoardDetails): LeaderBoardDetailsT => {
+    if (board) {
+        const x: LeaderBoardDetailsT = {
+            board_id: board.board_id,
+            name: board.board_public_meta.name,
+            description: board.board_public_meta.description,
+            rules: board.board_public_meta.rules,
+            period_type_id: board.period_type_id,
+            rewards: pointsRewardTransform(board.reward_points),
+            users: board.positions.map(p => getLeaderBoardPlayerTransformed(p)),
+            me: getLeaderBoardPlayerTransformed(board.userPosition, true),
+        }
+
+        return x;
+    }
+
+    return null;
+}

package/src/MiniGames/SAWPrizeUI.ts

@@ -13,4 +13,5 @@ export interface SAWPrizeUI {
     icon?: string;
     replace_name_with_image?: boolean;
     acknowledge_action_title?: string;
+    custom_win_sound?: string;
 }

package/src/MiniGames/SAWWinSoundType.ts

@@ -3,7 +3,8 @@ export enum SAWWinSoundType {
     Disappointing = 1,
     Positive = 2,
     HighlyPositive = 3,
-    NoSound = 4
+    NoSound = 4,
+    Custom = 5,
 }
 
 export const SAWWinSoundFiles = {

package/src/Missions/UserAchievement.ts

@@ -37,11 +37,12 @@ export interface UserAchievement {
 
 export const UserAchievementTransform = (items: UserAchievement[]): TMissionOrBadge[] => {
 
-    return items.filter( r => r.ach_id >= 1).map( r => (
-        {
+    return items.filter( r => r.ach_id >= 1).map( r => {
+        const x: TMissionOrBadge = {
             id: r.ach_id,
             name: r.ach_public_meta.name,
             description: r.ach_public_meta.description,
+            hint_text: r.ach_public_meta.hint_text,
             unlock_mission_description: r.ach_public_meta.unlock_mission_description,
             image: r.ach_public_meta.image_url,
             is_completed: r.isCompleted,
@@ -80,6 +81,7 @@ export const UserAchievementTransform = (items: UserAchievement[]): TMissionOrBa
             })),
             category_ids: r.ach_categories ?? [],
         }
-    ));
+        return x;
+});
 }    
 

package/src/OCache.ts

@@ -1,6 +1,5 @@
 import { NodeCache } from "./NodeCache";
 
-
 export enum ECacheContext {
     Translations,
     LabelInfo,
@@ -27,7 +26,7 @@ export class OCache {
 
         this.init(cacheContext);
 
-        return this.cache[cacheContext].get(key);
+        return deepClone(this.cache[cacheContext].get(key));
     }
 
     public static set(oKey: any, o: any, cacheContext: ECacheContext, ttlSeconds: number = 60) {
@@ -36,7 +35,7 @@ export class OCache {
 
         this.init(cacheContext);
 
-        this.cache[cacheContext].set(key, o, ttlSeconds);
+        this.cache[cacheContext].set(key, deepClone(o), ttlSeconds);
     }
 
     public static async use<T>(oKey: any, cacheContext: ECacheContext, f: () => Promise<T>, ttlSeconds: number = 60) {
@@ -60,3 +59,11 @@ export class OCache {
         }
     }
 }
+
+const deepClone = (o: any) => {
+    if (o) {
+        return JSON.parse(JSON.stringify(o));
+    }
+
+    return o;
+}

package/src/SmarticoAPI.ts

@@ -17,7 +17,8 @@ import { GetTournamentInfoRequest, GetTournamentInfoResponse, GetTournamentsRequ
 import { GetLeaderBoardsRequest, GetLeaderBoardsResponse, LeaderBoardDetails, LeaderBoardPeriodType } from "./Leaderboard";
 import { GetLevelMapResponse, GetLevelMapResponseTransform } from "./Level";
 import { WSAPI } from "./WSAPI/WSAPI";
-import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed } from "./WSAPI/WSAPITypes";
+import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed, LeaderBoardDetailsT } from "./WSAPI/WSAPITypes";
+import { getLeaderBoardTransform } from "./Leaderboard/LeaderBoards";
 
 const PUBLIC_API_URL = 'https://papi{ENV_ID}.smartico.ai/services/public';
 const C_SOCKET_PROD = 'wss://api{ENV_ID}.smartico.ai/websocket/services';
@@ -414,10 +415,13 @@ class SmarticoAPI {
 
         const message = this.buildMessage<GetAchievementMapRequest, GetAchievementMapResponse>(user_ext_id, ClassId.GET_ACHIEVEMENT_MAP_REQUEST);
         const response = await this.send<GetAchievementMapResponse>(message, ClassId.GET_ACHIEVEMENT_MAP_RESPONSE);
-        if (response.achievements) { 
-            response.achievements = response.achievements.filter(a => a.ach_type_id === AchievementType.Mission);
+        // we need to clone response to avoid changing original object,for cases when its called together with badgesGetItems (e.g. in Promise.all)
+        const responseClone = { ...response };
+
+        if (responseClone.achievements) { 
+            responseClone.achievements = responseClone.achievements.filter(a => a.ach_type_id === AchievementType.Mission);
         }
-        return response;
+        return responseClone;
     }
 
     public async missionsGetItemsT(user_ext_id: string): Promise<TMissionOrBadge[]> {
@@ -438,10 +442,13 @@ class SmarticoAPI {
 
         const message = this.buildMessage<GetAchievementMapRequest, GetAchievementMapResponse>(user_ext_id, ClassId.GET_ACHIEVEMENT_MAP_REQUEST);
         const response = await this.send<GetAchievementMapResponse>(message, ClassId.GET_ACHIEVEMENT_MAP_RESPONSE);
-        if (response.achievements) { 
-            response.achievements = response.achievements.filter(a => a.ach_type_id === AchievementType.Badge);
+        // we need to clone response to avoid changing original object,for cases when its called together with missionsGetItems (e.g. in Promise.all)
+        const responseClone = { ...response };
+
+        if (responseClone.achievements) { 
+            responseClone.achievements = responseClone.achievements.filter(a => a.ach_type_id === AchievementType.Badge);
         }
-        return response;
+        return responseClone;
     }    
 
     public async badgetsGetItemsT(user_ext_id: string): Promise<TMissionOrBadge[]> {
@@ -524,6 +531,10 @@ class SmarticoAPI {
 
     }
 
+    public async leaderboardsGetT(user_ext_id: string, period_type_id: LeaderBoardPeriodType = LeaderBoardPeriodType.DAILY, prevPeriod: boolean = false): Promise<LeaderBoardDetailsT> { 
+        return getLeaderBoardTransform(await this.leaderboardGet(user_ext_id, period_type_id, prevPeriod));
+    }
+
     public async levelsGet(user_ext_id: string): Promise<GetLevelMapResponse> {
         const message = this.buildMessage<any, GetLevelMapResponse>(user_ext_id, ClassId.GET_LEVEL_MAP_REQUEST);
         return await this.send<GetLevelMapResponse>(message, ClassId.GET_LEVEL_MAP_RESPONSE);

package/src/Store/StoreItem.ts

@@ -25,6 +25,7 @@ export const StoreItemTransform = (items: StoreItem[]): TStoreItem[] => {
             limit_message: r.itemPublicMeta.limit_message,
             priority: r.itemPublicMeta.priority,
             related_item_ids: r.itemPublicMeta.related_items,
+            hint_text: r.itemPublicMeta.hint_text,
 
             type: {
                 [StoreItemType.Bonus]: 'bonus',

package/src/WSAPI/WSAPI.ts

@@ -3,7 +3,8 @@ import { CoreUtils } from "../Core";
 import { MiniGamePrizeTypeName, SAWDoSpinResponse, SAWSpinErrorCode, SAWSpinsCountPush } from "../MiniGames";
 import { ECacheContext, OCache } from "../OCache";
 import { SmarticoAPI } from "../SmarticoAPI";
-import { InboxMarkMessageAction, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionOptInResult, TMissionOrBadge, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile } from "./WSAPITypes";
+import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionOptInResult, TMissionOrBadge, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile } from "./WSAPITypes";
+import { LeaderBoardPeriodType } from "src/Leaderboard";
  
 /** @hidden */
 const CACHE_DATA_SEC = 30;
@@ -13,6 +14,12 @@ enum onUpdateContextKey {
     Missions = 'missions',
     TournamentList = 'tournamentList',
     InboxMessages = 'inboxMessages',
+    Badges = 'badges',
+    Levels = 'levels',
+    StoreItems = 'storeItems',
+    StoreCategories = 'storeCategories',
+    AchCategories = 'achCategories',
+    LeaderBoards = 'leaderBoards',
 }
 
 
@@ -47,7 +54,7 @@ export class WSAPI {
 
     /** Returns all the levels available the current user */
     public async getLevels(): Promise<TLevel[]> {
-        return this.api.levelsGetT(null);
+        return OCache.use(onUpdateContextKey.Levels, ECacheContext.WSAPI, () => this.api.levelsGetT(null), CACHE_DATA_SEC);
     }
 
     /** Returns all the missions available the current user.
@@ -66,12 +73,12 @@ export class WSAPI {
 
     /** Returns all the badges available the current user */
     public async getBadges(): Promise<TMissionOrBadge[]> {
-        return this.api.badgetsGetItemsT(null);
+        return OCache.use(onUpdateContextKey.Badges, ECacheContext.WSAPI, () => this.api.badgetsGetItemsT(null), CACHE_DATA_SEC);
     }
 
     /** Returns all the store items available the current user */
     public async getStoreItems(): Promise<TStoreItem[]> {
-        return this.api.storeGetItemsT(null);
+        return OCache.use(onUpdateContextKey.StoreItems, ECacheContext.WSAPI, () => this.api.storeGetItemsT(null), CACHE_DATA_SEC);
     }
 
     /** Buy the specific shop item by item_id. Returns the err_code.*/
@@ -88,12 +95,12 @@ export class WSAPI {
 
     /** Returns store categories */
     public async getStoreCategories(): Promise<TStoreCategory[]> {
-        return this.api.storeGetCategoriesT(null);
+        return OCache.use(onUpdateContextKey.StoreCategories, ECacheContext.WSAPI, () => this.api.storeGetCategoriesT(null), CACHE_DATA_SEC);
     }
 
     /** Returns ach categories */
     public async getAchCategories(): Promise<TAchCategory[]> {
-        return this.api.achGetCategoriesT(null);
+        return OCache.use(onUpdateContextKey.AchCategories, ECacheContext.WSAPI, () => this.api.achGetCategoriesT(null), CACHE_DATA_SEC);
     }
 
     /** Returns the list of mini-games available for user 
@@ -168,6 +175,13 @@ export class WSAPI {
         return o;
     }
 
+    /** Returns the leaderboard for the current type (default is Daily). If getPreviousPeriod is passed as true, a leaderboard for the previous period for the current type will be returned.
+        For example, if the type is Weekly and getPreviousPeriod is true, a leaderboard for the previous week will be returned.
+     */
+    public async getLeaderBoard(periodType: LeaderBoardPeriodType, getPreviousPeriod?: boolean): Promise<LeaderBoardDetailsT> {
+        return OCache.use(onUpdateContextKey.LeaderBoards, ECacheContext.WSAPI, () => this.api.leaderboardsGetT(null, periodType, getPreviousPeriod), CACHE_DATA_SEC);
+    }
+
     /** Returns inbox messages based on the provided parameters. "From" and "to" indicate the range of messages to be fetched. 
     * The maximum number of messages per request is limited to 20. An indicator "onlyFavorite" can be passed to get only messages marked as favorites. 
     * You can leave this params empty and by default it will return list of messages ranging from 0 to 20.

package/src/WSAPI/WSAPITypes.ts

@@ -2,6 +2,7 @@ import { BuyStoreItemErrorCode } from "../Store";
 import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode } from "../MiniGames";
 import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from "../Tournaments";
 import { AchCategory } from "../Missions";
+import { LeaderBoardPeriodType } from "src/Leaderboard";
 
 type TRibbon = 'sale' | 'hot' | 'new' | 'vip' | string
 
@@ -372,6 +373,8 @@ export interface TStoreItem {
     category_ids: number[];
     /** Number of items in the pool avaliable for the purchase.*/
     pool?: number;
+    /** The T&C text for the store item */
+    hint_text?: string;
 }
 
 /** 
@@ -443,6 +446,9 @@ export interface TMissionOrBadge {
 
     /** The list of IDs of the categories where the badge item is assigned, information about categories can be retrieved with getAchCategories method */
     category_ids: number[];
+
+    /** The T&C text for the missions */
+    hint_text?: string;
 }
 
 export interface AchRelatedGame {
@@ -548,4 +554,42 @@ export interface InboxMarkMessageAction {
     err_code: number;
     /** Optional error message */
     err_message: string;
-}
+}
+
+export interface LeaderBoardDetailsT {
+    /** ID of the leaderboard */
+    board_id: number;
+    /** Name of the leaderboard */
+    name: string;
+    /** Description of the leaderboard */
+    description: string;
+    /** Rules of the leaderboard */
+    rules: string;
+    /** Leaderboard period type ID */
+    period_type_id: LeaderBoardPeriodType;
+    /** Leaderboard points rewards */
+    rewards: LeaderBoardsRewardsT[];
+    /** Leaderboard users */
+    users: LeaderBoardUserT[];
+    /** Info about current user in leaderboard */
+    me?: LeaderBoardUserT;
+}
+
+export interface LeaderBoardsRewardsT {
+    place: number;
+    points: number;
+}
+
+export interface LeaderBoardUserT {
+    /** The username of the participant */
+    public_username: string;
+    /** The URL to the avatar of the participant */
+    avatar_url: string;
+    /** The position of the participant in the leaderboard */
+    position: number;
+    /** The points of the participant in the leaderboard */
+    points: number;
+    /** The indicator if the participant is current user */
+    is_me: boolean;
+}
+