@smartico/public-api 0.0.386 → 0.0.387

package/dist/index.modern.mjs

@@ -1616,6 +1616,8 @@ const UserAchievementTransform = items => {
           id: t.task_id,
           name: (_t$task_public_meta = t.task_public_meta) == null ? void 0 : _t$task_public_meta.name,
           points_reward: t.points_reward,
+          gems_reward: t.gems_reward,
+          diamonds_reward: t.diamonds_reward,
           is_completed: t.isCompleted,
           progress: t.userProgress,
           execution_count_expected: t.executionCount,
@@ -7531,6 +7533,116 @@ class WSAPIAvatars extends WSAPIMiniGames {
       err_message: r.errMsg
     };
   }
+  /**
+   * Generates an AI-customized variant of a base avatar by applying an
+   * operator-defined style prompt, returning the CDN URL of the result.
+   * This is a paid, generate-only step: it does NOT change the user's
+   * active avatar — pass the returned `cdn_url` to {@link setAvatar} to
+   * activate it.
+   *
+   * @remarks
+   * **Preconditions**
+   * - Authenticated session required; not available in visitor mode (throws).
+   * - All five fields are mandatory — the SDK throws synchronously
+   *   (`Error("<field> is required")`) if any is missing or zero.
+   * - `prompt_id` must be one of the prompts from {@link getAvatarPrompts};
+   *   `avatar_url` / `avatar_real_id` identify the base avatar to style.
+   *
+   * **Cost**
+   * Each generation costs the currency the operator configured on the
+   * chosen prompt (points, gems, or diamonds — some prompts are free; read
+   * `cost_currency_type_id` / `cost_value` from the {@link getAvatarPrompts}
+   * entry to gate the UI before calling). The cost is charged only on
+   * success; if the user can't afford it the call fails with `errCode -1`
+   * and nothing is generated or charged.
+   *
+   * **Latency**
+   * Generation runs server-side AI image synthesis and is synchronous from
+   * the caller's side — expect several seconds (roughly 5–20 s) before the
+   * promise resolves. There is no SDK cache and no push/subscription; show
+   * a loading state for the full duration and disable the trigger to
+   * prevent duplicate submissions.
+   *
+   * **Result & error codes**
+   * On success the result has `cdn_url` set; on failure it has `errCode` /
+   * `errMessage` set and no `cdn_url`. Branch on `errCode` — the generic
+   * message is fixed text, not cause-specific:
+   * - `12001` (`AvatarCustomizeErrorCode.AVATAR_USER_LIMIT`) — the user hit
+   *   their monthly per-user generation cap. Nothing is generated or charged.
+   * - `12002` (`AvatarCustomizeErrorCode.AVATAR_LABEL_LIMIT`) — the brand's
+   *   shared monthly pool is exhausted. Nothing is generated or charged;
+   *   surface a "try again later" message.
+   * - `-1` — generic failure: insufficient balance, an unavailable prompt,
+   *   or a generation error. Nothing is charged. Allow the user to retry.
+   *
+   * Both monthly caps are operator-configured and reset at the start of
+   * each calendar month.
+   *
+   * **Side effects (on success)**
+   * The generated variant is persisted to the user's customization history
+   * and counts toward the monthly caps **whether or not** it is later
+   * activated — generation is not reversible. The SDK clears the
+   * {@link getAvatarsCustomized} cache so the next call surfaces the new
+   * variant. The user's active avatar is unchanged until you call
+   * {@link setAvatar} with the returned `cdn_url`.
+   *
+   * **Idempotency**: not idempotent — each successful call generates (and
+   * charges for) a new variant. Guard the call site against double-clicks.
+   *
+   * **UI guidance**: see [UI Guide — `avatarsCustomize`](../../docs/ui/avatars/UIGuide_avatarsCustomize.md).
+   *
+   * **Visitor mode**: not supported (throws).
+   *
+   * @param props.label_id        Numeric Smartico label (brand) ID the user belongs to.
+   * @param props.user_id         Numeric Smartico user ID.
+   * @param props.prompt_id       Style-prompt ID (`prompt_id`) from {@link getAvatarPrompts}.
+   * @param props.avatar_url      CDN URL of the base avatar to customize.
+   * @param props.avatar_real_id  `avatar_real_id` of the base avatar.
+   * @returns {@link AvatarCustomizeResponse} — `cdn_url` set on success;
+   *          `errCode` / `errMessage` set on failure.
+   *
+   * @example
+   * ```ts
+   * // label_id / user_id identify the Smartico user being customized.
+   * const prompts = await window._smartico.api.getAvatarPrompts();
+   * const prompt = prompts[0];
+   *
+   * console.log('[smartico] generating avatar — show a spinner for ~5-20s and disable the Generate button');
+   * const result = await window._smartico.api.avatarsCustomize({
+   *   label_id,
+   *   user_id,
+   *   prompt_id: prompt.prompt_id,
+   *   avatar_url: baseAvatar.avatar_url,
+   *   avatar_real_id: baseAvatar.avatar_real_id,
+   * });
+   *
+   * if (result.cdn_url) {
+   *   console.log('[smartico] generation succeeded — preview this URL, then call setAvatar to apply it:', result.cdn_url);
+   *   // await window._smartico.api.setAvatar({ avatar_url: result.cdn_url, avatar_real_id: baseAvatar.avatar_real_id });
+   * } else if (result.errCode === 12001) {
+   *   console.error('[smartico] user monthly limit reached — show "you have used all your custom avatars this month"');
+   * } else if (result.errCode === 12002) {
+   *   console.error('[smartico] brand monthly pool exhausted — show "custom avatars are unavailable right now, try later"');
+   * } else {
+   *   console.error('[smartico] generation failed (e.g. not enough balance) — let the user retry:', result.errMessage);
+   * }
+   * ```
+   */
+  async avatarsCustomize(props) {
+    const required = ['label_id', 'user_id', 'prompt_id', 'avatar_url', 'avatar_real_id'];
+    for (const field of required) {
+      if (!props[field]) {
+        throw new Error(`${field} is required`);
+      }
+    }
+    const r = await this.api.avatarsCustomize(props);
+    // On success a new variant is persisted server-side — drop the cached
+    // list so the next getAvatarsCustomized() surfaces it.
+    if (r.cdn_url) {
+      OCache.clear(ECacheContext.WSAPI, onUpdateContextKey.AvatarsCustomized);
+    }
+    return r;
+  }
 }
 
 /** @group GamePick */
@@ -9297,7 +9409,7 @@ const AVATAR_DOMAIN = 'https://img{ENV_ID}.smr.vc';
 const DEFAULT_LANG_EN = 'EN';
 class SmarticoAPI {
   constructor(label_api_key, brand_api_key, messageSender, options = {}) {
-    var _options$tracker;
+    var _options$tracker, _options$tracker2;
     this.label_api_key = void 0;
     this.brand_api_key = void 0;
     this.messageSender = void 0;
@@ -9308,6 +9420,7 @@ class SmarticoAPI {
     this.gamesApiUrl = void 0;
     this.baseRgApiParams = void 0;
     this.avatarDomain = void 0;
+    this.avatarOriginDomain = void 0;
     this.envId = void 0;
     this.logger = void 0;
     this.logCIDs = void 0;
@@ -9335,6 +9448,7 @@ class SmarticoAPI {
       };
     }
     this.avatarDomain = SmarticoAPI.getAvatarUrl(label_api_key || ((_options$tracker = options.tracker) == null ? void 0 : _options$tracker.label_api_key));
+    this.avatarOriginDomain = SmarticoAPI.getAvatarOriginUrl(label_api_key || ((_options$tracker2 = options.tracker) == null ? void 0 : _options$tracker2.label_api_key));
     this.label_api_key = SmarticoAPI.getCleanLabelApiKey(label_api_key);
   }
   static getEnvDnsSuffix(label_api_key) {
@@ -9391,6 +9505,9 @@ class SmarticoAPI {
     const avatarUrl = AVATAR_DOMAIN.replace('{ENV_ID}', SmarticoAPI.getEnvDnsSuffix(label_api_key));
     return SmarticoAPI.replaceSmrDomainsWithCloudfront(avatarUrl);
   }
+  static getAvatarOriginUrl(label_api_key) {
+    return AVATAR_DOMAIN.replace('{ENV_ID}', SmarticoAPI.getEnvDnsSuffix(label_api_key));
+  }
   async send(message, expectCID, force_language) {
     if (this.logCIDs.includes(message.cid)) {
       this.logger.info('REQ', message);
@@ -10145,6 +10262,33 @@ class SmarticoAPI {
       throw new Error(`Failed to call games API: ${method}. ${e.message}`);
     }
   }
+  async sendAvatarApi({
+    method,
+    body
+  }) {
+    if (!this.tracker) {
+      throw new Error(`Avatar APIs are not available in the visitor mode`);
+    }
+    const url = `${this.avatarOriginDomain}/${method}`;
+    try {
+      const response = await fetch(url, {
+        method: 'POST',
+        headers: {
+          'Accept': 'application/json',
+          'Content-Type': 'application/json'
+        },
+        body: JSON.stringify(body)
+      });
+      const data = await response.json();
+      return SmarticoAPI.replaceSmrDomainsWithCloudfront(data);
+    } catch (e) {
+      this.logger.error(`Failed to call avatar API: ${method}`, {
+        url,
+        error: e.message
+      });
+      throw new Error(`Failed to call avatar API: ${method}. ${e.message}`);
+    }
+  }
   async gpGetActiveRounds(saw_template_id) {
     const params = {
       ext_game_id: saw_template_id
@@ -10252,6 +10396,21 @@ class SmarticoAPI {
     });
     return await this.send(message, ClassId.CLIENT_SET_AVATAR_RESPONSE);
   }
+  async avatarsCustomize(params) {
+    var _this$tracker, _this$tracker2;
+    return this.sendAvatarApi({
+      method: 'avatar-customize',
+      body: {
+        label_id: params.label_id,
+        user_id: params.user_id,
+        user_ext_id: (_this$tracker = this.tracker) == null ? void 0 : _this$tracker.getExtUserId(),
+        brand_key: this.brand_api_key || ((_this$tracker2 = this.tracker) == null || (_this$tracker2 = _this$tracker2.params) == null ? void 0 : _this$tracker2.brand_key),
+        prompt_id: params.prompt_id,
+        avatar_url: params.avatar_url,
+        avatar_real_id: params.avatar_real_id
+      }
+    });
+  }
   async avatarsGetListT(user_ext_id) {
     var _await$this$avatarsGe;
     return avatarDefinitionTransform((_await$this$avatarsGe = (await this.avatarsGetList(user_ext_id)).avatars) != null ? _await$this$avatarsGe : [], this.avatarDomain);
@@ -10925,15 +11084,18 @@ var JackpotType;
   JackpotType[JackpotType["Personal"] = 2] = "Personal";
 })(JackpotType || (JackpotType = {}));
 
+/**
+ * Limit error codes returned in `errCode` by the `avatarsCustomize` method.
+ * See the `avatarsCustomize` TSDoc for the full table (including the generic
+ * `-1` failure, which has no named member here).
+ */
 var AvatarCustomizeErrorCode;
 (function (AvatarCustomizeErrorCode) {
+  /** The user has reached the operator-configured per-user monthly cap on custom-avatar generations. */
   AvatarCustomizeErrorCode[AvatarCustomizeErrorCode["AVATAR_USER_LIMIT"] = 12001] = "AVATAR_USER_LIMIT";
+  /** The brand's operator-configured shared monthly pool of custom-avatar generations is exhausted. */
   AvatarCustomizeErrorCode[AvatarCustomizeErrorCode["AVATAR_LABEL_LIMIT"] = 12002] = "AVATAR_LABEL_LIMIT";
 })(AvatarCustomizeErrorCode || (AvatarCustomizeErrorCode = {}));
-const AvatarCustomizeErrorMessage = {
-  [AvatarCustomizeErrorCode.AVATAR_USER_LIMIT]: 'You have exceeded number of custom avatars creation, please try later',
-  [AvatarCustomizeErrorCode.AVATAR_LABEL_LIMIT]: 'The custom avatars are not available, please try again later'
-};
 
 /**
  * Error codes returned in `errCode` by the `joinClan` method (also carried
@@ -10969,5 +11131,5 @@ var JoinClanErrorCode;
   JoinClanErrorCode[JoinClanErrorCode["JOIN_CLAN_JOINED_AFTER_TOURNAMENT_START"] = 1011] = "JOIN_CLAN_JOINED_AFTER_TOURNAMENT_START";
 })(JoinClanErrorCode || (JoinClanErrorCode = {}));
 
-export { AchCategoryTransform, AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter, AchievementAvailabilityStatus, AchievementClaimPeriodTypeId, AchievementStatus, AchievementTaskType, AchievementType, ActivityLogTransform, ActivityTypeLimited, AllRoundsGameBoardID, AnalyticsInboxSubScreenNameId, AnalyticsInterfaceType, AnalyticsScreenNameId, AnalyticsTournamentsLobbySubScreenNameId, AttemptPeriodType, AvatarCustomizeErrorCode, AvatarCustomizeErrorMessage, BadgesTimeLimitStates, BonusItemsTransform, BonusStatus, BuyStoreItemErrorCode, ClassId, CookieStore, CoreUtils, ECacheContext, GPRoundStatus, GamePickMarketType, GamePickResolutionType, GamePickScoreType, GamePickSportType, GameRoundOrderType, GetJackpotEligibleGamesResponseTransform, GetJackpotWinnersResponseTransform, GetLevelMapResponseTransform, InboxCategories, InboxMessageBodyTransform, InboxMessageType, InboxMessagesTransform, InboxReadStatus, JackPotTemparature, JackpotContributionType, JackpotType, JoinClanErrorCode, LeaderBoardPeriodType, LiquidEntityData, MiniGamePrizeTypeName, MiniGamePrizeTypeNamed, MissionCategory, MissionUtils, OCache, OpenLinksType, PointChangeSourceType, PrizeModifiers, PrizeModifiersKeysNames, PublicLabelSettings, QuizAnswersValueType, QuizMarketPerSport, QuizSportType, RaffleDrawInstanceState, RaffleDrawTypeExecution, RaffleTicketCapVisualization, SAWAcknowledgeType, SAWAcknowledgeTypeName, SAWAcknowledgeTypeNamed, SAWAskForUsername, SAWBuyInType, SAWBuyInTypeName, SAWBuyInTypeNamed, SAWExposeUserSpinId, SAWExposeUserSpinIdName, SAWExposeUserSpinIdNamed, SAWGPMarketType, SAWGameDifficultyType, SAWGameDifficultyTypeName, SAWGameLayout, SAWGameLayoutName, SAWGameLayoutNamed, SAWGameType, SAWGameTypeName, SAWGameTypeNamed, SAWHistoryTransform, SAWPrizeType, SAWSpinErrorCode, SAWTemplatesTransform, SAWUtils, SAWWheelLayout, SAWWinSoundFiles, SAWWinSoundType, SawGameDifficultyTypeNamed, ScheduledMissionType, SmarticoAPI, StoreCategoryTransform, StoreItemPurchaseType, StoreItemPurchasedTransform, StoreItemTransform, StoreItemType, StoreItemTypeName, StoreItemTypeNamed, TournamentInstanceStatus, TournamentInstanceStatusName, TournamentItemsTransform, TournamentRegistrationError, TournamentRegistrationStatus, TournamentRegistrationStatusName, TournamentRegistrationStatusNamed, TournamentRegistrationType, TournamentRegistrationTypeGetName, TournamentType, TournamentUtils, TranslationArea, UICustomSectionTransform, UserAchievementTransform, UserBalanceType, WSAPI, avatarCustomizedTransform, avatarDefinitionTransform, avatarPromptTransform, clanTournamentPlayersTransform, drawRunHistoryTransform, drawRunTransform, drawTransform, enrichUserAchievementsWithBadgeState, getLeaderBoardTransform, marketsInfo, prizeTransform, quizAnswerAwayTeamReplacementText, quizAnswerHomeTeamReplacementText, quizAnswersTrKeys, quizDrawReplacementText, quizEvenReplacementText, quizNoGoalsReplacementText, quizNoReplacementText, quizOddReplacementText, quizOrReplacementText, quizSupportedSports, quizYesReplacementText, raffleClaimPrizeResponseTransform, raffleTransform, ticketsTransform, tournamentInfoItemTransform, winnersTransform };
+export { AchCategoryTransform, AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter, AchievementAvailabilityStatus, AchievementClaimPeriodTypeId, AchievementStatus, AchievementTaskType, AchievementType, ActivityLogTransform, ActivityTypeLimited, AllRoundsGameBoardID, AnalyticsInboxSubScreenNameId, AnalyticsInterfaceType, AnalyticsScreenNameId, AnalyticsTournamentsLobbySubScreenNameId, AttemptPeriodType, AvatarCustomizeErrorCode, BadgesTimeLimitStates, BonusItemsTransform, BonusStatus, BuyStoreItemErrorCode, ClassId, CookieStore, CoreUtils, ECacheContext, GPRoundStatus, GamePickMarketType, GamePickResolutionType, GamePickScoreType, GamePickSportType, GameRoundOrderType, GetJackpotEligibleGamesResponseTransform, GetJackpotWinnersResponseTransform, GetLevelMapResponseTransform, InboxCategories, InboxMessageBodyTransform, InboxMessageType, InboxMessagesTransform, InboxReadStatus, JackPotTemparature, JackpotContributionType, JackpotType, JoinClanErrorCode, LeaderBoardPeriodType, LiquidEntityData, MiniGamePrizeTypeName, MiniGamePrizeTypeNamed, MissionCategory, MissionUtils, OCache, OpenLinksType, PointChangeSourceType, PrizeModifiers, PrizeModifiersKeysNames, PublicLabelSettings, QuizAnswersValueType, QuizMarketPerSport, QuizSportType, RaffleDrawInstanceState, RaffleDrawTypeExecution, RaffleTicketCapVisualization, SAWAcknowledgeType, SAWAcknowledgeTypeName, SAWAcknowledgeTypeNamed, SAWAskForUsername, SAWBuyInType, SAWBuyInTypeName, SAWBuyInTypeNamed, SAWExposeUserSpinId, SAWExposeUserSpinIdName, SAWExposeUserSpinIdNamed, SAWGPMarketType, SAWGameDifficultyType, SAWGameDifficultyTypeName, SAWGameLayout, SAWGameLayoutName, SAWGameLayoutNamed, SAWGameType, SAWGameTypeName, SAWGameTypeNamed, SAWHistoryTransform, SAWPrizeType, SAWSpinErrorCode, SAWTemplatesTransform, SAWUtils, SAWWheelLayout, SAWWinSoundFiles, SAWWinSoundType, SawGameDifficultyTypeNamed, ScheduledMissionType, SmarticoAPI, StoreCategoryTransform, StoreItemPurchaseType, StoreItemPurchasedTransform, StoreItemTransform, StoreItemType, StoreItemTypeName, StoreItemTypeNamed, TournamentInstanceStatus, TournamentInstanceStatusName, TournamentItemsTransform, TournamentRegistrationError, TournamentRegistrationStatus, TournamentRegistrationStatusName, TournamentRegistrationStatusNamed, TournamentRegistrationType, TournamentRegistrationTypeGetName, TournamentType, TournamentUtils, TranslationArea, UICustomSectionTransform, UserAchievementTransform, UserBalanceType, WSAPI, avatarCustomizedTransform, avatarDefinitionTransform, avatarPromptTransform, clanTournamentPlayersTransform, drawRunHistoryTransform, drawRunTransform, drawTransform, enrichUserAchievementsWithBadgeState, getLeaderBoardTransform, marketsInfo, prizeTransform, quizAnswerAwayTeamReplacementText, quizAnswerHomeTeamReplacementText, quizAnswersTrKeys, quizDrawReplacementText, quizEvenReplacementText, quizNoGoalsReplacementText, quizNoReplacementText, quizOddReplacementText, quizOrReplacementText, quizSupportedSports, quizYesReplacementText, raffleClaimPrizeResponseTransform, raffleTransform, ticketsTransform, tournamentInfoItemTransform, winnersTransform };
 //# sourceMappingURL=index.modern.mjs.map