@smartico/public-api 0.0.111 → 0.0.113

package/dist/index.modern.mjs

@@ -322,6 +322,7 @@ var SAWWinSoundType;
   SAWWinSoundType[SAWWinSoundType["Positive"] = 2] = "Positive";
   SAWWinSoundType[SAWWinSoundType["HighlyPositive"] = 3] = "HighlyPositive";
   SAWWinSoundType[SAWWinSoundType["NoSound"] = 4] = "NoSound";
+  SAWWinSoundType[SAWWinSoundType["Custom"] = 5] = "Custom";
 })(SAWWinSoundType || (SAWWinSoundType = {}));
 const SAWWinSoundFiles = {
   [SAWWinSoundType.NoSound]: null,
@@ -380,12 +381,12 @@ class OCache {
   static get(oKey, cacheContext) {
     const key = cacheContext.toString() + '_' + JSON.stringify(oKey);
     this.init(cacheContext);
-    return this.cache[cacheContext].get(key);
+    return deepClone(this.cache[cacheContext].get(key));
   }
   static set(oKey, o, cacheContext, ttlSeconds = 60) {
     const key = cacheContext.toString() + '_' + JSON.stringify(oKey);
     this.init(cacheContext);
-    this.cache[cacheContext].set(key, o, ttlSeconds);
+    this.cache[cacheContext].set(key, deepClone(o), ttlSeconds);
   }
   static async use(oKey, cacheContext, f, ttlSeconds = 60) {
     if (ttlSeconds <= 0) {
@@ -406,6 +407,12 @@ class OCache {
   }
 }
 OCache.cache = {};
+const deepClone = o => {
+  if (o) {
+    return JSON.parse(JSON.stringify(o));
+  }
+  return o;
+};
 
 var ActivityTypeLimited;
 (function (ActivityTypeLimited) {
@@ -571,6 +578,7 @@ const StoreItemTransform = items => {
       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',
         [StoreItemType.Manual]: 'manual'
@@ -608,10 +616,11 @@ var AchievementType;
 const UserAchievementTransform = items => {
   return items.filter(r => r.ach_id >= 1).map(r => {
     var _r$ach_categories;
-    return {
+    const x = {
       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,
@@ -651,6 +660,7 @@ const UserAchievementTransform = items => {
       })),
       category_ids: (_r$ach_categories = r.ach_categories) != null ? _r$ach_categories : []
     };
+    return x;
   });
 };
 
@@ -914,6 +924,13 @@ var TournamentType;
   TournamentType[TournamentType["TEST"] = 3] = "TEST";
 })(TournamentType || (TournamentType = {}));
 
+var LeaderBoardPeriodType;
+(function (LeaderBoardPeriodType) {
+  LeaderBoardPeriodType[LeaderBoardPeriodType["DAILY"] = 1] = "DAILY";
+  LeaderBoardPeriodType[LeaderBoardPeriodType["WEEKLY"] = 2] = "WEEKLY";
+  LeaderBoardPeriodType[LeaderBoardPeriodType["MONTHLY"] = 3] = "MONTHLY";
+})(LeaderBoardPeriodType || (LeaderBoardPeriodType = {}));
+
 const GetLevelMapResponseTransform = levels => {
   return levels == null ? void 0 : levels.levels.map(l => {
     var _l$level_public_meta;
@@ -940,6 +957,12 @@ var onUpdateContextKey;
   onUpdateContextKey["Missions"] = "missions";
   onUpdateContextKey["TournamentList"] = "tournamentList";
   onUpdateContextKey["InboxMessages"] = "inboxMessages";
+  onUpdateContextKey["Badges"] = "badges";
+  onUpdateContextKey["Levels"] = "levels";
+  onUpdateContextKey["StoreItems"] = "storeItems";
+  onUpdateContextKey["StoreCategories"] = "storeCategories";
+  onUpdateContextKey["AchCategories"] = "achCategories";
+  onUpdateContextKey["LeaderBoards"] = "leaderBoards";
 })(onUpdateContextKey || (onUpdateContextKey = {}));
 /** @group General API */
 class WSAPI {
@@ -970,7 +993,7 @@ class WSAPI {
   }
   /** Returns all the levels available the current user */
   async getLevels() {
-    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.
    * 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.
@@ -988,11 +1011,11 @@ class WSAPI {
   }
   /** Returns all the badges available the current user */
   async getBadges() {
-    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 */
   async getStoreItems() {
-    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.*/
   async buyStoreItem(item_id) {
@@ -1005,11 +1028,11 @@ class WSAPI {
   }
   /** Returns store categories */
   async getStoreCategories() {
-    return this.api.storeGetCategoriesT(null);
+    return OCache.use(onUpdateContextKey.StoreCategories, ECacheContext.WSAPI, () => this.api.storeGetCategoriesT(null), CACHE_DATA_SEC);
   }
   /** Returns ach categories */
   async getAchCategories() {
-    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
    * 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.
@@ -1073,6 +1096,12 @@ 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.
+   */
+  async getLeaderBoard(periodType, getPreviousPeriod) {
+    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.
@@ -1188,6 +1217,48 @@ class WSAPI {
   }
 }
 
+const pointsRewardTransform = reward_points => {
+  if (reward_points && reward_points.length) {
+    return reward_points.map((r, i) => ({
+      place: i + 1,
+      points: r
+    }));
+  }
+  return null;
+};
+const getLeaderBoardPlayerTransformed = (user, isMe) => {
+  if (user) {
+    const x = {
+      public_username: (user == null ? void 0 : 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;
+};
+const getLeaderBoardTransform = board => {
+  if (board) {
+    const x = {
+      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;
+};
+
 const PUBLIC_API_URL = 'https://papi{ENV_ID}.smartico.ai/services/public';
 const C_SOCKET_PROD = 'wss://api{ENV_ID}.smartico.ai/websocket/services';
 const AVATAR_DOMAIN = 'https://img{ENV_ID}.smr.vc';
@@ -1494,10 +1565,12 @@ class SmarticoAPI {
   async missionsGetItems(user_ext_id) {
     const message = this.buildMessage(user_ext_id, ClassId.GET_ACHIEVEMENT_MAP_REQUEST);
     const response = await this.send(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 = _extends({}, response);
+    if (responseClone.achievements) {
+      responseClone.achievements = responseClone.achievements.filter(a => a.ach_type_id === AchievementType.Mission);
     }
-    return response;
+    return responseClone;
   }
   async missionsGetItemsT(user_ext_id) {
     return UserAchievementTransform((await this.missionsGetItems(user_ext_id)).achievements);
@@ -1512,10 +1585,12 @@ class SmarticoAPI {
   async badgetsGetItems(user_ext_id) {
     const message = this.buildMessage(user_ext_id, ClassId.GET_ACHIEVEMENT_MAP_REQUEST);
     const response = await this.send(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 = _extends({}, response);
+    if (responseClone.achievements) {
+      responseClone.achievements = responseClone.achievements.filter(a => a.ach_type_id === AchievementType.Badge);
     }
-    return response;
+    return responseClone;
   }
   async badgetsGetItemsT(user_ext_id) {
     return UserAchievementTransform((await this.badgetsGetItems(user_ext_id)).achievements);
@@ -1572,6 +1647,9 @@ class SmarticoAPI {
     }
     return response.map[boardKey];
   }
+  async leaderboardsGetT(user_ext_id, period_type_id = LeaderBoardPeriodType.DAILY, prevPeriod = false) {
+    return getLeaderBoardTransform(await this.leaderboardGet(user_ext_id, period_type_id, prevPeriod));
+  }
   async levelsGet(user_ext_id) {
     const message = this.buildMessage(user_ext_id, ClassId.GET_LEVEL_MAP_REQUEST);
     return await this.send(message, ClassId.GET_LEVEL_MAP_RESPONSE);
@@ -1669,12 +1747,5 @@ class CookieStore {
 }
 CookieStore.cookieStore = new TSMap();
 
-var LeaderBoardPeriodType;
-(function (LeaderBoardPeriodType) {
-  LeaderBoardPeriodType[LeaderBoardPeriodType["DAILY"] = 1] = "DAILY";
-  LeaderBoardPeriodType[LeaderBoardPeriodType["WEEKLY"] = 2] = "WEEKLY";
-  LeaderBoardPeriodType[LeaderBoardPeriodType["MONTHLY"] = 3] = "MONTHLY";
-})(LeaderBoardPeriodType || (LeaderBoardPeriodType = {}));
-
 export { AchCategoryTransform, AchievementStatus, AchievementTaskType, AchievementType, ActivityTypeLimited, BuyStoreItemErrorCode, ClassId, CookieStore, CoreUtils, GetLevelMapResponseTransform, InboxMessageBodyTransform, InboxMessageType, InboxMessagesTransform, LeaderBoardPeriodType, MiniGamePrizeTypeName, MiniGamePrizeTypeNamed, PublicLabelSettings, SAWAcknowledgeType, SAWAskForUsername, SAWBuyInType, SAWBuyInTypeName, SAWBuyInTypeNamed, SAWGameType, SAWGameTypeName, SAWGameTypeNamed, SAWPrizeType, SAWSpinErrorCode, SAWTemplatesTransform, SAWUtils, SAWWinSoundFiles, SAWWinSoundType, ScheduledMissionType, SmarticoAPI, StoreCategoryTransform, StoreItemTransform, StoreItemType, TournamentInstanceStatus, TournamentInstanceStatusName, TournamentItemsTransform, TournamentRegistrationError, TournamentRegistrationStatus, TournamentRegistrationStatusName, TournamentRegistrationStatusNamed, TournamentRegistrationType, TournamentRegistrationTypeGetName, TournamentType, TournamentUtils, TranslationArea, UserAchievementTransform, tournamentInfoItemTransform };
 //# sourceMappingURL=index.modern.mjs.map