@smartico/public-api 0.0.107 → 0.0.108

package/dist/index.modern.mjs

@@ -480,6 +480,51 @@ var TranslationArea;
   TranslationArea[TranslationArea["AffIliateAdminNew"] = 7] = "AffIliateAdminNew";
 })(TranslationArea || (TranslationArea = {}));
 
+const InboxMessagesTransform = items => {
+  return items.map(item => {
+    const x = {
+      sent_date: item.createDate,
+      message_guid: item.engagement_uid,
+      read: item.is_read,
+      favorite: item.is_starred
+    };
+    return x;
+  });
+};
+
+const InboxMessageBodyTransform = item => {
+  const x = {
+    action: item.action,
+    icon: item.image,
+    title: item.title,
+    preview_body: item.body
+  };
+  if (item.action === 'dp:inbox') {
+    if (item.additional_buttons && item.additional_buttons.length) {
+      x.buttons = item.additional_buttons.map(b => ({
+        action: b.action,
+        text: b.inbox_cta_text
+      }));
+    }
+    x.html_body = (item == null ? void 0 : item.html_body) || null;
+  }
+  return x;
+};
+
+var InboxMessageType;
+(function (InboxMessageType) {
+  InboxMessageType[InboxMessageType["Custom"] = 0] = "Custom";
+  InboxMessageType[InboxMessageType["MissionCompleted"] = 1] = "MissionCompleted";
+  InboxMessageType[InboxMessageType["MissionUnlocked"] = 2] = "MissionUnlocked";
+  InboxMessageType[InboxMessageType["LeaderboardWon"] = 3] = "LeaderboardWon";
+  InboxMessageType[InboxMessageType["LevelChanged"] = 4] = "LevelChanged";
+  InboxMessageType[InboxMessageType["BonusGiven"] = 5] = "BonusGiven";
+  InboxMessageType[InboxMessageType["PointsAdded"] = 6] = "PointsAdded";
+  InboxMessageType[InboxMessageType["PointsUsed"] = 7] = "PointsUsed";
+  InboxMessageType[InboxMessageType["PersonalMessage"] = 8] = "PersonalMessage";
+})(InboxMessageType || (InboxMessageType = {}));
+// keep in sync with BO enum
+
 var BuyStoreItemErrorCode;
 (function (BuyStoreItemErrorCode) {
   BuyStoreItemErrorCode[BuyStoreItemErrorCode["FAILED_TO_BUY_SHOP_ITEM"] = 121] = "FAILED_TO_BUY_SHOP_ITEM";
@@ -872,6 +917,7 @@ var onUpdateContextKey;
   onUpdateContextKey["Saw"] = "saw";
   onUpdateContextKey["Missions"] = "missions";
   onUpdateContextKey["TournamentList"] = "tournamentList";
+  onUpdateContextKey["InboxMessages"] = "inboxMessages";
 })(onUpdateContextKey || (onUpdateContextKey = {}));
 /** @group General API */
 class WSAPI {
@@ -886,6 +932,7 @@ class WSAPI {
     on(ClassId.SAW_DO_SPIN_RESPONSE, data => on(ClassId.SAW_AKNOWLEDGE_RESPONSE, () => this.updateOnPrizeWin(data)));
     on(ClassId.MISSION_OPTIN_RESPONSE, () => this.updateMissionsOnOptIn());
     on(ClassId.TOURNAMENT_REGISTER_RESPONSE, () => this.updateTournamentsOnRegistration());
+    on(ClassId.CLIENT_ENGAGEMENT_EVENT_NEW, () => this.updateInboxMessages());
   }
   /** Returns information about current user */
   getUserProfile() {
@@ -985,7 +1032,7 @@ class WSAPI {
     }
     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 */
+  /** Returns details information of specific tournament instance, the response will include tournament info and the leaderboard of players */
   async getTournamentInstanceInfo(tournamentInstanceId) {
     return this.api.tournamentsGetInfoT(null, tournamentInstanceId);
   }
@@ -998,6 +1045,71 @@ class WSAPI {
     };
     return o;
   }
+  /** 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.
+  * This functions return list of messages without the body of the message.
+  * To get the body of the message you need to call getInboxMessageBody function and pass the message guid contained in each message of this request.
+  * All other action like mark as read, favorite, delete, etc. can be done using this message GUID.
+  * The "onUpdate" callback will be triggered when the user receives a new message. It will provide an updated list of messages, ranging from 0 to 20, to the onUpdate callback function. */
+  /**
+  * @param params
+  */
+  async getInboxMessages({
+    from,
+    to,
+    onlyFavorite,
+    onUpdate
+  } = {}) {
+    if (onUpdate) {
+      this.onUpdateCallback.set(onUpdateContextKey.InboxMessages, onUpdate);
+    }
+    return await this.api.getInboxMessagesT(null, from, to, onlyFavorite);
+  }
+  /** Returns the message body of the specified message guid. */
+  async getInboxMessageBody(messageGuid) {
+    return await this.api.getInboxMessageBodyT(messageGuid);
+  }
+  /** Requests to mark inbox message with specified guid as read */
+  async markInboxMessageAsRead(messageGuid) {
+    const r = await this.api.markInboxMessageRead(null, messageGuid);
+    return {
+      err_code: r.errCode,
+      err_message: r.errMsg
+    };
+  }
+  /** Requests to mark all inbox messages as read */
+  async markAllInboxMessagesAsRead() {
+    const r = await this.api.markAllInboxMessageRead(null);
+    return {
+      err_code: r.errCode,
+      err_message: r.errMsg
+    };
+  }
+  /** Requests to mark inbox message with specified guid as favorite. Pass mark true to add message to favorite and false to remove. */
+  async markUnmarkInboxMessageAsFavorite(messageGuid, mark) {
+    const r = await this.api.markUnmarkInboxMessageAsFavorite(null, messageGuid, mark);
+    return {
+      err_code: r.errCode,
+      err_message: r.errMsg
+    };
+  }
+  /** Requests to delete inbox message */
+  async deleteInboxMessage(messageGuid) {
+    const r = await this.api.deleteInboxMessage(null, messageGuid);
+    return {
+      err_code: r.errCode,
+      err_message: r.errMsg
+    };
+  }
+  /** Requests to delete all inbox messages */
+  async deleteAllInboxMessages() {
+    const r = await this.api.deleteAllInboxMessages(null);
+    return {
+      err_code: r.errCode,
+      err_message: r.errMsg
+    };
+  }
   /** Requests translations for the given language. Returns the object including translation key/translation value pairs. All possible translation keys defined in the back office. */
   async getTranslations(lang_code) {
     const r = await this.api.getTranslationsT(null, lang_code, []);
@@ -1035,6 +1147,10 @@ class WSAPI {
     const payload = await this.api.tournamentsGetLobbyT(null);
     this.updateEntity(onUpdateContextKey.TournamentList, payload);
   }
+  async updateInboxMessages() {
+    const payload = await this.api.getInboxMessagesT(null);
+    this.updateEntity(onUpdateContextKey.InboxMessages, payload);
+  }
   async updateEntity(contextKey, payload) {
     OCache.set(contextKey, payload, ECacheContext.WSAPI);
     const onUpdate = this.onUpdateCallback.get(contextKey);
@@ -1056,6 +1172,7 @@ class SmarticoAPI {
     this.messageSender = void 0;
     this.publicUrl = void 0;
     this.wsUrl = void 0;
+    this.inboxCdnUrl = void 0;
     this.partnerUrl = void 0;
     this.avatarDomain = void 0;
     this.logger = void 0;
@@ -1430,6 +1547,77 @@ class SmarticoAPI {
   async getTranslationsT(user_ext_id, lang_code, areas, cacheSec = 60) {
     return await this.coreGetTranslations(user_ext_id, lang_code, areas, 30);
   }
+  async getInboxMessages(user_ext_id, limit = 20, offset = 0, starred_only) {
+    const message = this.buildMessage(user_ext_id, ClassId.GET_INBOX_MESSAGES_REQUEST, {
+      limit,
+      offset,
+      starred_only
+    });
+    return await this.send(message, ClassId.GET_INBOX_MESSAGES_RESPONSE);
+  }
+  async getInboxMessagesT(user_ext_id, from = 0, to = 20, favoriteOnly = false) {
+    const limit = to - from > 20 ? 20 : to - from;
+    const offset = from;
+    return InboxMessagesTransform((await this.getInboxMessages(user_ext_id, limit, offset, favoriteOnly)).log);
+  }
+  async getInboxMessageBody(messageGuid) {
+    var _this3 = this;
+    const getMessageBody = async function getMessageBody(messageGuid) {
+      const inboxCdnUrl = _this3.tracker.getLabelSetting(PublicLabelSettings.INBOX_PUBLIC_CDN);
+      try {
+        const url = `${inboxCdnUrl}${messageGuid}.json`;
+        const response = await fetch(url, {
+          method: 'GET',
+          headers: {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+            'Access-Control-Allow-Origin': '*'
+          }
+        });
+        const data = await response.json();
+        return data || {};
+      } catch (error) {
+        _this3.logger.error('Error fetching inbox message body:', error);
+        return null;
+      }
+    };
+    return await getMessageBody(messageGuid);
+  }
+  async getInboxMessageBodyT(messageGuid) {
+    const message = await this.getInboxMessageBody(messageGuid);
+    return InboxMessageBodyTransform(message);
+  }
+  async markInboxMessageRead(user_ext_id, messageGuid) {
+    const message = this.buildMessage(user_ext_id, ClassId.MARK_INBOX_READ_REQUEST, {
+      engagement_uid: messageGuid
+    });
+    return await this.send(message, ClassId.MARK_INBOX_READ_RESPONSE);
+  }
+  async markAllInboxMessageRead(user_ext_id) {
+    const message = this.buildMessage(user_ext_id, ClassId.MARK_INBOX_READ_REQUEST, {
+      all_read: true
+    });
+    return await this.send(message, ClassId.MARK_INBOX_READ_RESPONSE);
+  }
+  async markUnmarkInboxMessageAsFavorite(user_ext_id, messageGuid, mark) {
+    const message = this.buildMessage(user_ext_id, ClassId.MARK_INBOX_STARRED_REQUEST, {
+      engagement_uid: messageGuid,
+      is_starred: mark
+    });
+    return await this.send(message, ClassId.MARK_INBOX_STARRED_RESPONSE);
+  }
+  async deleteInboxMessage(user_ext_id, messageGuid) {
+    const message = this.buildMessage(user_ext_id, ClassId.MARK_INBOX_DELETED_REQUEST, {
+      engagement_uid: messageGuid
+    });
+    return await this.send(message, ClassId.MARK_INBOX_DELETED_RESPONSE);
+  }
+  async deleteAllInboxMessages(user_ext_id) {
+    const message = this.buildMessage(user_ext_id, ClassId.MARK_INBOX_DELETED_REQUEST, {
+      all_deleted: true
+    });
+    return await this.send(message, ClassId.MARK_INBOX_DELETED_RESPONSE);
+  }
   getWSCalls() {
     return new WSAPI(this);
   }
@@ -1446,20 +1634,6 @@ class CookieStore {
 }
 CookieStore.cookieStore = new TSMap();
 
-var InboxMessageType;
-(function (InboxMessageType) {
-  InboxMessageType[InboxMessageType["Custom"] = 0] = "Custom";
-  InboxMessageType[InboxMessageType["MissionCompleted"] = 1] = "MissionCompleted";
-  InboxMessageType[InboxMessageType["MissionUnlocked"] = 2] = "MissionUnlocked";
-  InboxMessageType[InboxMessageType["LeaderboardWon"] = 3] = "LeaderboardWon";
-  InboxMessageType[InboxMessageType["LevelChanged"] = 4] = "LevelChanged";
-  InboxMessageType[InboxMessageType["BonusGiven"] = 5] = "BonusGiven";
-  InboxMessageType[InboxMessageType["PointsAdded"] = 6] = "PointsAdded";
-  InboxMessageType[InboxMessageType["PointsUsed"] = 7] = "PointsUsed";
-  InboxMessageType[InboxMessageType["PersonalMessage"] = 8] = "PersonalMessage";
-})(InboxMessageType || (InboxMessageType = {}));
-// keep in sync with BO enum
-
 var LeaderBoardPeriodType;
 (function (LeaderBoardPeriodType) {
   LeaderBoardPeriodType[LeaderBoardPeriodType["DAILY"] = 1] = "DAILY";
@@ -1467,5 +1641,5 @@ var LeaderBoardPeriodType;
   LeaderBoardPeriodType[LeaderBoardPeriodType["MONTHLY"] = 3] = "MONTHLY";
 })(LeaderBoardPeriodType || (LeaderBoardPeriodType = {}));
 
-export { AchievementStatus, AchievementTaskType, AchievementType, ActivityTypeLimited, BuyStoreItemErrorCode, ClassId, CookieStore, CoreUtils, GetLevelMapResponseTransform, InboxMessageType, 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 };
+export { 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