@smartico/public-api 0.0.252 → 0.0.253

package/dist/index.modern.mjs

@@ -123,6 +123,8 @@ var ClassId;
   ClassId[ClassId["JP_OPTOUT_REQUEST"] = 806] = "JP_OPTOUT_REQUEST";
   ClassId[ClassId["JP_OPTOUT_RESPONSE"] = 807] = "JP_OPTOUT_RESPONSE";
   ClassId[ClassId["JP_WIN_PUSH"] = 808] = "JP_WIN_PUSH";
+  ClassId[ClassId["JP_GET_WINNERS_REQUEST"] = 809] = "JP_GET_WINNERS_REQUEST";
+  ClassId[ClassId["JP_GET_WINNERS_RESPONSE"] = 810] = "JP_GET_WINNERS_RESPONSE";
   ClassId[ClassId["RAF_GET_RAFFLES_REQUEST"] = 902] = "RAF_GET_RAFFLES_REQUEST";
   ClassId[ClassId["RAF_GET_RAFFLES_RESPONSE"] = 903] = "RAF_GET_RAFFLES_RESPONSE";
   ClassId[ClassId["RAF_GET_DRAW_RUN_REQUEST"] = 904] = "RAF_GET_DRAW_RUN_REQUEST";
@@ -1606,10 +1608,179 @@ const GetLevelMapResponseTransform = levels => {
   });
 };
 
+const ticketsTransform = items => {
+  return items.map(item => {
+    return {
+      ticekt_id: item.id,
+      ticket_id_string: item.s
+    };
+  });
+};
+const winnersTransform = items => {
+  return items.map(item => {
+    return {
+      id: item.user_id,
+      username: item.public_username,
+      avatar_url: item.avatar_url,
+      ticket: {
+        ticekt_id: item.ticket.id,
+        ticket_id_string: item.ticket.s
+      },
+      raf_won_id: item.raf_won_id,
+      claimed_date: item.claimed_date
+    };
+  });
+};
+const prizeTransform = items => {
+  return items.map(item => {
+    return {
+      id: item.prize_id,
+      name: item.public_meta.name,
+      description: item.public_meta.description,
+      image_url: item.public_meta.image_url,
+      prizes_per_run: item.prizes_per_run,
+      prizes_per_run_actual: item.prizes_per_run_actual,
+      chances_to_win_perc: item.chances_to_win_perc,
+      min_required_total_tickets: item.min_required_total_tickets,
+      cap_prizes_per_run: item.cap_prizes_per_run,
+      priority: item.priority,
+      stock_items_per_draw: item.stock_items_per_draw,
+      should_claim: item.should_claim,
+      winners: winnersTransform(item.winners),
+      requires_claim: item.requires_claim,
+      min_required_tickets_for_user: item.min_required_tickets_for_user
+    };
+  });
+};
+const drawTransform = items => {
+  return items.map(item => {
+    return {
+      id: item.draw_id,
+      name: item.public_meta.name,
+      description: item.public_meta.description,
+      image_url: item.public_meta.image_url,
+      image_url_mobile: item.public_meta.image_url_mobile,
+      icon_url: item.public_meta.icon_url,
+      background_image_url: item.public_meta.background_image_url,
+      background_image_url_mobile: item.public_meta.background_image_url_mobile,
+      is_grand: item.public_meta.is_grand,
+      prizes: prizeTransform(item.prizes),
+      current_state: item.current_state,
+      run_id: item.run_id,
+      execution_type: item.execution_type,
+      execution_ts: item.execution_ts,
+      previous_run_ts: item.previous_run_ts,
+      previous_run_id: item.previous_run_id,
+      ticket_start_ts: item.ticket_start_ts,
+      allow_multi_prize_per_ticket: item.allow_multi_prize_per_ticket,
+      total_tickets_count: item.total_tickets_count,
+      my_tickets_count: item.my_tickets_count,
+      my_last_tickets: ticketsTransform(item.my_last_tickets)
+    };
+  });
+};
+const raffleTransform = items => {
+  return items.map(item => {
+    return {
+      id: item.raffle_id,
+      name: item.public_meta.name,
+      description: item.public_meta.description,
+      custom_section_id: item.public_meta.custom_section_id,
+      image_url: item.public_meta.image_url,
+      image_url_mobile: item.public_meta.image_url_mobile,
+      custom_data: item.public_meta.custom_data,
+      start_date: item.start_date_ts,
+      end_date: item.end_date_ts,
+      max_tickets_count: item.max_tickets_count,
+      current_tickets_count: item.current_tickets_count,
+      draws: drawTransform(item.draws)
+    };
+  });
+};
+
+const drawRunTransform = res => {
+  return {
+    id: res.draw.draw_id,
+    name: res.draw.public_meta.name,
+    description: res.draw.public_meta.description,
+    image_url: res.draw.public_meta.image_url,
+    image_url_mobile: res.draw.public_meta.image_url_mobile,
+    icon_url: res.draw.public_meta.icon_url,
+    background_image_url: res.draw.public_meta.background_image_url,
+    background_image_url_mobile: res.draw.public_meta.background_image_url_mobile,
+    is_grand: res.draw.public_meta.is_grand,
+    prizes: prizeTransform(res.draw.prizes),
+    current_state: res.draw.current_state,
+    run_id: res.draw.run_id,
+    execution_type: res.draw.execution_type,
+    execution_ts: res.draw.execution_ts,
+    previous_run_ts: res.draw.previous_run_ts,
+    previous_run_id: res.draw.previous_run_id,
+    ticket_start_ts: res.draw.ticket_start_ts,
+    allow_multi_prize_per_ticket: res.draw.allow_multi_prize_per_ticket,
+    total_tickets_count: res.draw.total_tickets_count,
+    my_tickets_count: res.draw.my_tickets_count,
+    my_last_tickets: ticketsTransform(res.draw.my_last_tickets)
+  };
+};
+
+var RaffleDrawInstanceState;
+(function (RaffleDrawInstanceState) {
+  /** Draw is open for the tickets collection */
+  RaffleDrawInstanceState[RaffleDrawInstanceState["Open"] = 1] = "Open";
+  /** Winner selection is in progress */
+  RaffleDrawInstanceState[RaffleDrawInstanceState["WinnerSelection"] = 2] = "WinnerSelection";
+  /** Draw is executed and the winners are selected */
+  RaffleDrawInstanceState[RaffleDrawInstanceState["Executed"] = 3] = "Executed";
+})(RaffleDrawInstanceState || (RaffleDrawInstanceState = {}));
+var RaffleDrawTypeExecution;
+(function (RaffleDrawTypeExecution) {
+  /** Draw is executed only once */
+  RaffleDrawTypeExecution[RaffleDrawTypeExecution["ExecDate"] = 0] = "ExecDate";
+  /** Draw is executed on a recurring basis */
+  RaffleDrawTypeExecution[RaffleDrawTypeExecution["Recurring"] = 1] = "Recurring";
+  /**
+   * Draw is executed once and is marked as grand.
+   * This means it is a special or significant draw,
+   * often with larger prizes or more importance.
+   */
+  RaffleDrawTypeExecution[RaffleDrawTypeExecution["Grand"] = 2] = "Grand";
+})(RaffleDrawTypeExecution || (RaffleDrawTypeExecution = {}));
+
+const drawRunHistoryTransform = res => {
+  return res.draw_runs.map(item => {
+    return {
+      id: item.draw_id,
+      run_id: item.run_id,
+      name: item.public_meta.name,
+      description: item.public_meta.description,
+      image_url: item.public_meta.image_url,
+      image_url_mobile: item.public_meta.image_url_mobile,
+      icon_url: item.public_meta.icon_url,
+      background_image_url: item.public_meta.background_image_url,
+      background_image_url_mobile: item.public_meta.background_image_url_mobile,
+      is_grand: item.public_meta.is_grand,
+      execution_ts: item.execution_ts,
+      actual_execution_ts: item.actual_execution_ts,
+      ticket_start_ts: item.ticket_start_ts,
+      is_winner: item.is_winner,
+      has_unclaimed_prize: item.has_unclaimed_prize
+    };
+  });
+};
+
+const raffleClaimPrizeResponseTransform = info => {
+  return {
+    errorCode: info.errCode,
+    errorMessage: info.errMsg
+  };
+};
+
 /** @hidden */
 const CACHE_DATA_SEC = 30;
 const JACKPOT_TEMPLATE_CACHE_SEC = 30;
 const JACKPOT_POT_CACHE_SEC = 1;
+const JACKPOT_WINNERS_CACHE_SEC = 30;
 /** @hidden */
 var onUpdateContextKey;
 (function (onUpdateContextKey) {
@@ -1631,6 +1802,8 @@ var onUpdateContextKey;
   onUpdateContextKey["CustomSections"] = "customSections";
   onUpdateContextKey["Bonuses"] = "bonuses";
   onUpdateContextKey["SAWHistory"] = "sawHistory";
+  onUpdateContextKey["JackpotWinners"] = "jackpotWinners";
+  onUpdateContextKey["Raffles"] = "raffles";
 })(onUpdateContextKey || (onUpdateContextKey = {}));
 /** @group General API */
 class WSAPI {
@@ -1668,6 +1841,10 @@ class WSAPI {
         this.reloadMiniGameTemplate();
         OCache.clear(ECacheContext.WSAPI, onUpdateContextKey.SAWHistory);
       });
+      on(ClassId.RAF_CLAIM_PRIZE_RESPONSE, () => {
+        this.updateRaffles();
+        OCache.clear(ECacheContext.WSAPI, onUpdateContextKey.Raffles);
+      });
     }
   }
   /** @private */
@@ -2317,6 +2494,10 @@ class WSAPI {
     const payload = await this.api.getInboxMessagesT(null);
     this.updateEntity(onUpdateContextKey.InboxMessages, payload);
   }
+  async updateRaffles() {
+    const payload = await this.api.getRafflesT(null);
+    this.updateEntity(onUpdateContextKey.Raffles, payload);
+  }
   async updateEntity(contextKey, payload) {
     OCache.set(contextKey, payload, ECacheContext.WSAPI);
     const onUpdate = this.onUpdateCallback.get(contextKey);
@@ -2327,6 +2508,7 @@ class WSAPI {
   async jackpotClearCache() {
     OCache.clear(ECacheContext.WSAPI, onUpdateContextKey.Jackpots);
     OCache.clear(ECacheContext.WSAPI, onUpdateContextKey.Pots);
+    OCache.clear(ECacheContext.WSAPI, onUpdateContextKey.JackpotWinners);
   }
   /** Returns list of Jackpots that are active in the systen and matching to the filter definition.
    * If filter is not provided, all active jackpots will be returned.
@@ -2422,6 +2604,28 @@ class WSAPI {
     const result = await this.api.jackpotOptOut(null, filter);
     return result;
   }
+  /**
+   * Returns the winners of the jackpot with the specified jp_template_id.
+   *
+   * **Example**:
+   * ```
+   * _smartico.api.getJackpotWinners({
+   *      jp_template_id: 123,
+   * }).then((result) => {
+   *      console.log(result);
+   * });
+   * ```
+   *
+   * **Visitor mode: not supported**
+   *
+   */
+  async getJackpotWinners({
+    limit,
+    offset,
+    jp_template_id
+  }) {
+    return OCache.use(onUpdateContextKey.JackpotWinners, ECacheContext.WSAPI, () => this.api.getJackpotWinnersT(null, limit, offset, jp_template_id), JACKPOT_WINNERS_CACHE_SEC);
+  }
   /**
    * Returns all the related tournaments and missions for the provided game id for the current user
    * The provided Game ID should correspond to the ID from the Games Catalog - https://help.smartico.ai/welcome/technical-guides/games-catalog-api
@@ -2444,17 +2648,93 @@ class WSAPI {
     const result = await this.api.getRelatedItemsForGame(null, related_game_id);
     return result;
   }
-  async getRaffles() {
-    return await this.api.getRaffles(null);
+  /**
+   * Returns the list of Raffles available for user
+   * The returned list of Raffles is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getRaffles with a new onUpdate callback, the old one will be overwritten by the new one.
+   * The onUpdate callback will be called on claiming prize.  Updated Raffles will be passed to onUpdate callback.
+   *
+   * **Example**:
+   * ```
+   * _smartico.api.getRaffles().then((result) => {
+   *      console.log(result);
+   * });
+   * ```
+   *
+   * **Visitor mode: not supported**
+   *
+   */
+  async getRaffles({
+    onUpdate
+  } = {}) {
+    if (onUpdate) {
+      this.onUpdateCallback.set(onUpdateContextKey.Raffles, onUpdate);
+    }
+    return OCache.use(onUpdateContextKey.Raffles, ECacheContext.WSAPI, () => this.api.getRafflesT(null), CACHE_DATA_SEC);
   }
-  async getDrawRun(payload) {
-    return await this.api.getDrawRun(null, payload);
+  /**
+   * Returns draw run for provided raffle_id and run_id
+   *
+   *
+   * **Example**:
+   * ```
+   * _smartico.api.getRaffleDrawRun({raffle_id:156, run_id: 145}).then((result) => {
+   *      console.log(result);
+   * });
+   * ```
+   *
+   * **Visitor mode: not supported**
+   *
+   */
+  async getRaffleDrawRun(props) {
+    const res = await this.api.getRaffleDrawRun(null, props);
+    if (!props.raffle_id || !props.run_id) {
+      throw new Error('both raffle_id and run_id are required');
+    }
+    return drawRunTransform(res);
   }
-  async getRaffleDrawRunsHistory(payload) {
-    return await this.api.getRaffleDrawRunsHistory(null, payload);
+  /**
+   * Returns history of draw runs for the provided raffle_id and draw_id, if the draw_id is not provided will return history of all the draws for the provided raffle_id
+   *
+   *
+   * **Example**:
+   * ```
+   * _smartico.api.getRaffleDrawRunHistory({raffle_id:156, draw_id: 432}).then((result) => {
+   *      console.log(result);
+   * });
+   * ```
+   *
+   * **Visitor mode: not supported**
+   *
+   */
+  async getRaffleDrawRunsHistory(props) {
+    const res = await this.api.getRaffleDrawRunsHistory(null, props);
+    if (!props.raffle_id) {
+      throw new Error('raffle_id is required');
+    }
+    return drawRunHistoryTransform(res);
   }
-  async claimRafflePrize(payload) {
-    return await this.api.claimRafflePrize(null, payload);
+  /**
+   * Returns error code, and error Message after calling the function, error message 0 - means that the request was successful
+   *
+   *
+   * **Example**:
+   * ```
+   * _smartico.api.claimRafflePrize({won_id:251}).then((result) => {
+   *      console.log(result);
+   * });
+   * ```
+   *
+   * **Visitor mode: not supported**
+   *
+   */
+  async claimRafflePrize(props) {
+    if (!props.won_id) {
+      throw new Error('won_id is required');
+    }
+    const res = await this.api.claimRafflePrize(null, {
+      won_id: props.won_id
+    });
+    return raffleClaimPrizeResponseTransform(res);
   }
 }
 
@@ -2546,6 +2826,20 @@ var BonusStatus;
   BonusStatus[BonusStatus["EXPIRED"] = 6] = "EXPIRED";
 })(BonusStatus || (BonusStatus = {}));
 
+/**
+ * @ignore
+ */
+const GetJackpotWinnersResponseTransform = items => {
+  return items.map(item => {
+    const winnerInfo = {
+      winner: item.winner,
+      win_date_ts: item.win_date_ts,
+      jp_pot_id: item.jp_pot_id
+    };
+    return winnerInfo;
+  });
+};
+
 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';
@@ -2794,6 +3088,17 @@ class SmarticoAPI {
     const message = this.buildMessage(user_ext_id, ClassId.JP_OPTOUT_REQUEST, payload);
     return await this.send(message, ClassId.JP_OPTOUT_RESPONSE);
   }
+  async getJackpotWinners(user_ext_id, limit = 20, offset = 0, jp_template_id) {
+    const message = this.buildMessage(user_ext_id, ClassId.JP_GET_WINNERS_REQUEST, {
+      limit,
+      offset,
+      jp_template_id
+    });
+    return await this.send(message, ClassId.JP_GET_WINNERS_RESPONSE);
+  }
+  async getJackpotWinnersT(user_ext_id, limit = 20, offset = 0, jp_template_id) {
+    return GetJackpotWinnersResponseTransform((await this.getJackpotWinners(user_ext_id, limit, offset, jp_template_id)).winners);
+  }
   async sawGetTemplates(user_ext_id, force_language, is_visitor_mode = false) {
     const message = this.buildMessage(user_ext_id, ClassId.SAW_GET_SPINS_REQUEST, {
       is_visitor_mode
@@ -3183,20 +3488,23 @@ class SmarticoAPI {
     });
     return await this.send(message, ClassId.GET_RELATED_ACH_N_TOURNAMENTS_RESPONSE);
   }
+  async getRafflesT(user_ext_id) {
+    return raffleTransform((await this.getRaffles(user_ext_id)).items);
+  }
   async getRaffles(user_ext_id) {
     const message = this.buildMessage(user_ext_id, ClassId.RAF_GET_RAFFLES_REQUEST);
     return await this.send(message, ClassId.RAF_GET_RAFFLES_RESPONSE);
   }
-  async getDrawRun(user_ext_id, payload) {
+  async getRaffleDrawRun(user_ext_id, payload) {
     const message = this.buildMessage(user_ext_id, ClassId.RAF_GET_DRAW_RUN_REQUEST, payload);
     return await this.send(message, ClassId.RAF_GET_DRAW_RUN_RESPONSE);
   }
-  async getRaffleDrawRunsHistory(user_ext_id, payload) {
-    const message = this.buildMessage(user_ext_id, ClassId.RAF_GET_DRAW_HISTORY_REQUEST, payload);
+  async getRaffleDrawRunsHistory(user_ext_id, props) {
+    const message = this.buildMessage(user_ext_id, ClassId.RAF_GET_DRAW_HISTORY_REQUEST, props);
     return await this.send(message, ClassId.RAF_GET_DRAW_HISTORY_RESPONSE);
   }
-  async claimRafflePrize(user_ext_id, payload) {
-    const message = this.buildMessage(user_ext_id, ClassId.RAF_CLAIM_PRIZE_REQUEST, payload);
+  async claimRafflePrize(user_ext_id, props) {
+    const message = this.buildMessage(user_ext_id, ClassId.RAF_CLAIM_PRIZE_REQUEST, props);
     return await this.send(message, ClassId.RAF_CLAIM_PRIZE_RESPONSE);
   }
 }
@@ -3609,5 +3917,5 @@ var JackpotType;
   JackpotType[JackpotType["Personal"] = 2] = "Personal";
 })(JackpotType || (JackpotType = {}));
 
-export { AchCategoryTransform, AchievementAvailabilityStatus, AchievementStatus, AchievementTaskType, AchievementType, ActivityTypeLimited, BonusItemsTransform, BonusStatus, BuyStoreItemErrorCode, ClassId, CookieStore, CoreUtils, ECacheContext, GetLevelMapResponseTransform, InboxCategories, InboxMessageBodyTransform, InboxMessageType, InboxMessagesTransform, JackpotContributionType, JackpotType, LeaderBoardPeriodType, MiniGamePrizeTypeName, MiniGamePrizeTypeNamed, OCache, OpenLinksType, PrizeModifiers, PrizeModifiersKeysNames, PublicLabelSettings, QuizAnswersValueType, QuizMarketPerSport, QuizSportType, SAWAcknowledgeType, SAWAcknowledgeTypeName, SAWAcknowledgeTypeNamed, SAWAskForUsername, SAWBuyInType, SAWBuyInTypeName, SAWBuyInTypeNamed, SAWGPMarketType, SAWGameLayout, SAWGameType, SAWGameTypeName, SAWGameTypeNamed, SAWHistoryTransform, SAWPrizeType, SAWSpinErrorCode, SAWTemplatesTransform, SAWUtils, SAWWheelLayout, SAWWinSoundFiles, SAWWinSoundType, ScheduledMissionType, SmarticoAPI, StoreCategoryTransform, StoreItemPurchaseType, StoreItemPurchasedTransform, StoreItemTransform, StoreItemType, StoreItemTypeName, StoreItemTypeNamed, TournamentInstanceStatus, TournamentInstanceStatusName, TournamentItemsTransform, TournamentRegistrationError, TournamentRegistrationStatus, TournamentRegistrationStatusName, TournamentRegistrationStatusNamed, TournamentRegistrationType, TournamentRegistrationTypeGetName, TournamentType, TournamentUtils, TranslationArea, UserAchievementTransform, getLeaderBoardTransform, marketsInfo, quizAnswerAwayTeamReplacementText, quizAnswerHomeTeamReplacementText, quizAnswersTrKeys, quizDrawReplacementText, quizEvenReplacementText, quizNoGoalsReplacementText, quizNoReplacementText, quizOddReplacementText, quizOrReplacementText, quizSupportedSports, quizYesReplacementText, tournamentInfoItemTransform };
+export { AchCategoryTransform, AchievementAvailabilityStatus, AchievementStatus, AchievementTaskType, AchievementType, ActivityTypeLimited, BonusItemsTransform, BonusStatus, BuyStoreItemErrorCode, ClassId, CookieStore, CoreUtils, ECacheContext, GetJackpotWinnersResponseTransform, GetLevelMapResponseTransform, InboxCategories, InboxMessageBodyTransform, InboxMessageType, InboxMessagesTransform, JackpotContributionType, JackpotType, LeaderBoardPeriodType, MiniGamePrizeTypeName, MiniGamePrizeTypeNamed, OCache, OpenLinksType, PrizeModifiers, PrizeModifiersKeysNames, PublicLabelSettings, QuizAnswersValueType, QuizMarketPerSport, QuizSportType, SAWAcknowledgeType, SAWAcknowledgeTypeName, SAWAcknowledgeTypeNamed, SAWAskForUsername, SAWBuyInType, SAWBuyInTypeName, SAWBuyInTypeNamed, SAWGPMarketType, SAWGameLayout, SAWGameType, SAWGameTypeName, SAWGameTypeNamed, SAWHistoryTransform, SAWPrizeType, SAWSpinErrorCode, SAWTemplatesTransform, SAWUtils, SAWWheelLayout, SAWWinSoundFiles, SAWWinSoundType, ScheduledMissionType, SmarticoAPI, StoreCategoryTransform, StoreItemPurchaseType, StoreItemPurchasedTransform, StoreItemTransform, StoreItemType, StoreItemTypeName, StoreItemTypeNamed, TournamentInstanceStatus, TournamentInstanceStatusName, TournamentItemsTransform, TournamentRegistrationError, TournamentRegistrationStatus, TournamentRegistrationStatusName, TournamentRegistrationStatusNamed, TournamentRegistrationType, TournamentRegistrationTypeGetName, TournamentType, TournamentUtils, TranslationArea, UserAchievementTransform, getLeaderBoardTransform, marketsInfo, quizAnswerAwayTeamReplacementText, quizAnswerHomeTeamReplacementText, quizAnswersTrKeys, quizDrawReplacementText, quizEvenReplacementText, quizNoGoalsReplacementText, quizNoReplacementText, quizOddReplacementText, quizOrReplacementText, quizSupportedSports, quizYesReplacementText, tournamentInfoItemTransform };
 //# sourceMappingURL=index.modern.mjs.map