@smartico/public-api 0.0.386 → 0.0.387

package/README.md

@@ -74,7 +74,7 @@ The SDK surface is split across one class per feature area, joined by an interna
 | **Jackpots** | [`WSAPIJackpots`](docs/api/classes/WSAPIJackpots.md) | `jackpotGet`, `jackpotOptIn`, `jackpotOptOut`, `getJackpotWinners`, `getJackpotEligibleGames` | [`jackpotGet`](docs/ui/jackpots/UIGuide_jackpotGet.md) · [`jackpotOptIn`](docs/ui/jackpots/UIGuide_jackpotOptIn.md) · [`jackpotOptOut`](docs/ui/jackpots/UIGuide_jackpotOptOut.md) · [`getJackpotWinners`](docs/ui/jackpots/UIGuide_getJackpotWinners.md) · [`getJackpotEligibleGames`](docs/ui/jackpots/UIGuide_getJackpotEligibleGames.md) |
 | **Raffles / Draws** | [`WSAPIRaffles`](docs/api/classes/WSAPIRaffles.md) | `getRaffles`, `getRaffleDrawRun`, `getRaffleDrawRunsHistory`, `claimRafflePrize`, `requestRaffleOptin`, `getRaffleWonPrizes` | [`getRaffles`](docs/ui/raffles/UIGuide_getRaffles.md) · [`getRaffleDrawRun`](docs/ui/raffles/UIGuide_getRaffleDrawRun.md) · [`getRaffleDrawRunsHistory`](docs/ui/raffles/UIGuide_getRaffleDrawRunsHistory.md) · [`claimRafflePrize`](docs/ui/raffles/UIGuide_claimRafflePrize.md) · [`requestRaffleOptin`](docs/ui/raffles/UIGuide_requestRaffleOptin.md) · [`getRaffleWonPrizes`](docs/ui/raffles/UIGuide_getRaffleWonPrizes.md) |
 | **MiniGames / SAW** | [`WSAPIMiniGames`](docs/api/classes/WSAPIMiniGames.md) | `getMiniGames`, `getMiniGamesHistory`, `playMiniGame`, `miniGameWinAcknowledgeRequest`, `playMiniGameBatch` | [`getMiniGames`](docs/ui/minigames/UIGuide_getMiniGames.md) · [`getMiniGamesHistory`](docs/ui/minigames/UIGuide_getMiniGamesHistory.md) · [`playMiniGame`](docs/ui/minigames/UIGuide_playMiniGame.md) · [`playMiniGameBatch`](docs/ui/minigames/UIGuide_playMiniGameBatch.md) |
-| **Avatars** | [`WSAPIAvatars`](docs/api/classes/WSAPIAvatars.md) | `getAvatarsList`, `getAvatarsCustomized`, `getAvatarPrompts`, `setAvatar` | [`getAvatarsList`](docs/ui/avatars/UIGuide_getAvatarsList.md) · [`getAvatarsCustomized`](docs/ui/avatars/UIGuide_getAvatarsCustomized.md) · [`getAvatarPrompts`](docs/ui/avatars/UIGuide_getAvatarPrompts.md) · [`setAvatar`](docs/ui/avatars/UIGuide_setAvatar.md) |
+| **Avatars** | [`WSAPIAvatars`](docs/api/classes/WSAPIAvatars.md) | `getAvatarsList`, `getAvatarsCustomized`, `getAvatarPrompts`, `setAvatar`, `avatarsCustomize` | [`getAvatarsList`](docs/ui/avatars/UIGuide_getAvatarsList.md) · [`getAvatarsCustomized`](docs/ui/avatars/UIGuide_getAvatarsCustomized.md) · [`getAvatarPrompts`](docs/ui/avatars/UIGuide_getAvatarPrompts.md) · [`setAvatar`](docs/ui/avatars/UIGuide_setAvatar.md) · [`avatarsCustomize`](docs/ui/avatars/UIGuide_avatarsCustomize.md) |
 | **Game Pick (sports / quiz)** | [`WSAPIGamePick`](docs/api/classes/WSAPIGamePick.md) | `gamePickGet*`, `gamePickSubmit*` (9 methods) | [`gamePickGetActiveRounds`](docs/ui/gamepick/UIGuide_gamePickGetActiveRounds.md) · [`gamePickGetActiveRound`](docs/ui/gamepick/UIGuide_gamePickGetActiveRound.md) · [`gamePickGetHistory`](docs/ui/gamepick/UIGuide_gamePickGetHistory.md) · [`gamePickGetBoard`](docs/ui/gamepick/UIGuide_gamePickGetBoard.md) · [`gamePickSubmitSelection`](docs/ui/gamepick/UIGuide_gamePickSubmitSelection.md) · [`gamePickSubmitSelectionQuiz`](docs/ui/gamepick/UIGuide_gamePickSubmitSelectionQuiz.md) · [`gamePickGetUserInfo`](docs/ui/gamepick/UIGuide_gamePickGetUserInfo.md) · [`gamePickGetGameInfo`](docs/ui/gamepick/UIGuide_gamePickGetGameInfo.md) · [`gamePickGetRoundInfoForUser`](docs/ui/gamepick/UIGuide_gamePickGetRoundInfoForUser.md) |
 | **Leaderboard** | [`WSAPILeaderBoard`](docs/api/classes/WSAPILeaderBoard.md) | `getLeaderBoard` | [`getLeaderBoard`](docs/ui/leaderboard/UIGuide_getLeaderBoard.md) |
 | **Inbox / Messages / Engagement** | [`WSAPIInbox`](docs/api/classes/WSAPIInbox.md) | `getInboxMessages`, `getInboxUnreadCount`, `getInboxMessageBody`, `markInboxMessageAsRead`, `markAllInboxMessagesAsRead`, `markUnmarkInboxMessageAsFavorite`, `deleteInboxMessage`, `deleteAllInboxMessages`, `reportImpressionEvent`, `reportClickEvent` | [`getInboxMessages`](docs/ui/inbox/UIGuide_getInboxMessages.md) · [`getInboxMessageBody`](docs/ui/inbox/UIGuide_getInboxMessageBody.md) · [`markInboxMessageAsRead`](docs/ui/inbox/UIGuide_markInboxMessageAsRead.md) · [`markUnmarkInboxMessageAsFavorite`](docs/ui/inbox/UIGuide_markUnmarkInboxMessageAsFavorite.md) · [`deleteInboxMessage`](docs/ui/inbox/UIGuide_deleteInboxMessage.md) |

package/dist/Avatars/AvatarCustomizeErrorCode.d.ts

@@ -1,5 +1,11 @@
+/**
+ * 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).
+ */
 export declare enum AvatarCustomizeErrorCode {
+    /** The user has reached the operator-configured per-user monthly cap on custom-avatar generations. */
     AVATAR_USER_LIMIT = 12001,
+    /** The brand's operator-configured shared monthly pool of custom-avatar generations is exhausted. */
     AVATAR_LABEL_LIMIT = 12002
 }
-export declare const AvatarCustomizeErrorMessage: Record<AvatarCustomizeErrorCode, string>;

package/dist/Avatars/AvatarCustomizeResponse.d.ts

@@ -0,0 +1,16 @@
+import { AvatarCustomizeErrorCode } from './AvatarCustomizeErrorCode';
+/**
+ * Result of `_smartico.api.avatarsCustomize()`. On success only `cdn_url` is
+ * set; on failure only `errCode` / `errMessage`.
+ */
+export interface AvatarCustomizeResponse {
+    /** CDN URL of the generated avatar variant. Present on success. */
+    cdn_url?: string;
+    /** Error code. Present on failure. Typed values are members of
+     * {@link AvatarCustomizeErrorCode}; `-1` is a generic failure. See the
+     * `avatarsCustomize` TSDoc for the full table. */
+    errCode?: AvatarCustomizeErrorCode | number;
+    /** Optional error message. Present on failure; the generic (`-1`) message
+     * is fixed text, so branch on `errCode`, not this string. */
+    errMessage?: string;
+}

package/dist/Avatars/index.d.ts

@@ -1,4 +1,5 @@
 export * from './AvatarCustomizeErrorCode';
+export * from './AvatarCustomizeResponse';
 export * from './AvatarDefinition';
 export * from './AvatarCustomized';
 export * from './AvatarPrompt';

package/dist/Missions/UserAchievementTask.d.ts

@@ -5,6 +5,10 @@ export interface UserAchievementTask {
     task_id?: number;
     task_public_meta?: AchievementTaskPublicMeta;
     points_reward?: number;
+    /** Gems awarded when this task is completed. */
+    gems_reward?: number;
+    /** Diamonds awarded when this task is completed. */
+    diamonds_reward?: number;
     task_type_id: AchievementTaskType;
     isCompleted?: boolean;
     userExecutedCount?: number;

package/dist/SmarticoAPI.d.ts

@@ -28,6 +28,7 @@ import { GetAvatarsListResponse } from './Avatars/GetAvatarsListResponse';
 import { GetAvatarsCustomizedResponse } from './Avatars/GetAvatarsCustomizedResponse';
 import { GetAvatarPromptsResponse } from './Avatars/GetAvatarPromptsResponse';
 import { SetAvatarResponse } from './Avatars';
+import { AvatarCustomizeResponse } from './Avatars/AvatarCustomizeResponse';
 import { GetJackpotWinnersResponse, JackpotWinnerHistory } from './Jackpots/GetJackpotWinnersResponse';
 import { GetJackpotEligibleGamesResponse, TGetJackpotEligibleGamesResponse } from './Jackpots/GetJackpotEligibleGamesResponse';
 import { GamePickGameInfo, GamePickRound, GamePickRoundBoard, GamePickUserInfo, GamesApiResponse } from './GamePick';
@@ -61,6 +62,7 @@ declare class SmarticoAPI {
     private gamesApiUrl;
     private baseRgApiParams;
     avatarDomain: string;
+    private avatarOriginDomain;
     private envId;
     private logger;
     private logCIDs;
@@ -76,6 +78,7 @@ declare class SmarticoAPI {
     static getPublicUrl(label_api_key: string): string;
     static getPublicWsUrl(label_api_key: string): string;
     static getAvatarUrl(label_api_key: string): string;
+    static getAvatarOriginUrl(label_api_key: string): string;
     private send;
     private buildMessage;
     coreReportCustomEvent(user_ext_id: string, eventType: string, payload?: any): Promise<any>;
@@ -175,6 +178,7 @@ declare class SmarticoAPI {
     deleteAllInboxMessages(user_ext_id: string): Promise<MarkInboxMessageDeletedResponse>;
     private buildGamesApiParams;
     private sendGamesApi;
+    private sendAvatarApi;
     gpGetActiveRounds(saw_template_id: number): Promise<GamesApiResponse<GamePickRound[]>>;
     gpGetActiveRound(saw_template_id: number, round_id?: number): Promise<GamesApiResponse<GamePickRound>>;
     gpGetGamesHistory(saw_template_id: number): Promise<GamesApiResponse<GamePickRound[]>>;
@@ -188,6 +192,13 @@ declare class SmarticoAPI {
     avatarsGetCustomized(user_ext_id: string): Promise<GetAvatarsCustomizedResponse>;
     avatarsGetPrompts(user_ext_id: string): Promise<GetAvatarPromptsResponse>;
     avatarSetAvatar(user_ext_id: string, avatar_id: string, avatar_real_id: number): Promise<SetAvatarResponse>;
+    avatarsCustomize(params: {
+        label_id: number;
+        user_id: number;
+        prompt_id: number;
+        avatar_url: string;
+        avatar_real_id: number;
+    }): Promise<AvatarCustomizeResponse>;
     avatarsGetListT(user_ext_id: string): Promise<TAvatarDefinition[]>;
     avatarsGetCustomizedT(user_ext_id: string): Promise<TAvatarCustomized[]>;
     avatarsGetPromptsT(user_ext_id: string): Promise<TAvatarPrompt[]>;

package/dist/WSAPI/WSAPIAvatars.d.ts

@@ -1,5 +1,6 @@
 import { TAvatarDefinition, TAvatarCustomized, TAvatarPrompt, TSetAvatarResult } from './WSAPITypes';
 import { WSAPIMiniGames } from './WSAPIMiniGames';
+import { AvatarCustomizeResponse } from '../Avatars/AvatarCustomizeResponse';
 /** @group Avatars */
 export declare class WSAPIAvatars extends WSAPIMiniGames {
     /**
@@ -293,4 +294,106 @@ export declare class WSAPIAvatars extends WSAPIMiniGames {
         avatar_url: string;
         avatar_real_id: number;
     }): Promise<TSetAvatarResult>;
+    /**
+     * 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);
+     * }
+     * ```
+     */
+    avatarsCustomize(props: {
+        label_id: number;
+        user_id: number;
+        prompt_id: number;
+        avatar_url: string;
+        avatar_real_id: number;
+    }): Promise<AvatarCustomizeResponse>;
 }

package/dist/WSAPI/WSAPITypes.d.ts

@@ -899,6 +899,10 @@ export interface TMissionOrBadgeTask {
     progress: number;
     /** Reward for completing the task in points */
     points_reward: number;
+    /** Reward for completing the task in gems */
+    gems_reward?: number;
+    /** Reward for completing the task in diamonds */
+    diamonds_reward?: number;
     /** This is the total number of times the user needs to execute to complete task. e.g. he needs to bet 100 times. Here will be 100 */
     execution_count_expected?: number;
     /** This is the number of times the user has executed 'activity' of the task. e.g. he bet 5 times out of 100. Here will be 5 */
@@ -1675,9 +1679,9 @@ export interface TAvatarPrompt {
     name: string;
     /** Absolute CDN URL of the prompt's preview icon. */
     icon_url: string;
-    /** Currency used to pay for the customization. `0` = points, `1` = gems, `2` = diamonds. */
+    /** Currency used to pay for the customization. `0` = points, `1` = gems, `2` = diamonds, `3` = free. A `cost_value` of `0` is also free. */
     cost_currency_type_id: number;
-    /** Cost amount in the currency named by `cost_currency_type_id`. */
+    /** Cost amount in the currency named by `cost_currency_type_id`. `0` = free. */
     cost_value: number;
 }
 /**