@smartico/public-api 0.0.141 → 0.0.143

package/docs/interfaces/TUICustomSection.md

@@ -0,0 +1,85 @@
+# Interface: TUICustomSection
+
+TUICustomSection describes the information of the custom sections defined in the system
+
+## Properties
+
+### body
+
+• **body**: `string`
+
+The body of the custom section
+
+___
+
+### menu_img
+
+• **menu_img**: `string`
+
+The image of the custom section
+
+___
+
+### menu_name
+
+• **menu_name**: `string`
+
+The name of the custom section
+
+___
+
+### custom_skin_images
+
+• **custom_skin_images**: `string`
+
+Custom images for custom section
+
+___
+
+### section_type_id
+
+• **section_type_id**: [`AchCustomSectionType`](../enums/AchCustomSectionType.md)
+
+The particular type of custom section, can be Missions, Tournaments, Lootbox and etc
+
+___
+
+### theme
+
+• **theme**: [`AchCustomLayoutTheme`](../enums/AchCustomLayoutTheme.md)
+
+Theme of the custom section
+
+___
+
+### generic_custom_css
+
+• **generic_custom_css**: `string`
+
+Custom css for the custom section
+
+___
+
+### mission\_tabs\_options
+
+• **mission\_tabs\_options**: [`AchMissionsTabsOptions`](../enums/AchMissionsTabsOptions.md)
+
+Tabs that can be shown in custom section, e.g Overview, No Overview, All tabs
+
+___
+
+### overview\_missions\_filter
+
+• **overview\_missions\_filter**: [`AchOverviewMissionsFilter`](../enums/AchOverviewMissionsFilter.md)
+
+Filter that allow to show missions by criteria
+
+___
+
+### overview\_missions\_count
+
+• **overview\_missions\_count**: `number`
+
+Quantity of missions to be shown in overview
+
+___

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartico/public-api",
-  "version": "0.0.141",
+  "version": "0.0.143",
   "description": "Smartico public API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/CustomSections/AchCustomSection.ts

@@ -0,0 +1,30 @@
+export enum AchCustomSectionType {
+    HTML_PAGE = 1,
+    MISSIONS_CATEGORY = 2,
+    TOURNAMENTS_CATEGORY = 3,
+    LEVELS = 4,
+    MINI_GAMES = 5,
+    MISSION_CUSTOM_LAYOUT = 6,
+    MATCH_X = 7,
+}
+
+export enum AchCustomLayoutTheme {
+    VALENTINES_LIGHT = 'valentines-light',
+    VALENTINES_DARK = 'valentines-dark',
+    EURO_2024 = 'euro-2024',
+    GENERIC = 'generic',
+}
+
+export enum AchMissionsTabsOptions {
+    ONLY_OVERVIEW = 1,
+    NO_OVERVIEW = 2,
+    ALL = 3,
+}
+
+export enum AchOverviewMissionsFilter {
+    ANY = 1,
+    ALL_MISSIONS = 2,
+    ALL_EXCEPT_COMPLETED = 3,
+    ALL_EXCEPT_LOCKED = 4,
+    ALL_EXCEPT_COMPLETED_AND_LOCKED = 5,
+}

package/src/CustomSections/GetCustomSectionsRequest.ts

@@ -0,0 +1,5 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+
+export interface GetCustomSectionsRequest extends ProtocolMessage {
+
+}

package/src/CustomSections/GetCustomSectionsResponse.ts

@@ -0,0 +1,7 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { UICustomSection } from "./UICustomSection";
+
+export interface GetCustomSectionsResponse extends ProtocolResponse {
+
+    customSections: {[key: string]: UICustomSection};
+}

package/src/CustomSections/UICustomSection.ts

@@ -0,0 +1,34 @@
+import { TUICustomSection } from "../WSAPI/WSAPITypes";
+import { AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter } from "./AchCustomSection";
+
+export interface UICustomSection {
+
+    body?: string;
+    menu_img?: string;
+    menu_name?: string;
+    custom_skin_images?: string;
+    section_type_id?: AchCustomSectionType;
+    theme?: AchCustomLayoutTheme;
+    generic_custom_css?: string;
+    mission_tabs_options?: AchMissionsTabsOptions;
+    overview_missions_filter?: AchOverviewMissionsFilter;
+    overview_missions_count?: number;
+}
+
+export const UICustomSectionTransform = (items: UICustomSection[]): TUICustomSection[] => {
+    return items.filter(r => r.section_type_id !== undefined && r.section_type_id >= 1).map( r => {
+        const x: TUICustomSection = {
+            body: r.body,
+            menu_img: r.menu_img,
+            menu_name: r.menu_name,
+            section_type_id: r.section_type_id,
+            custom_skin_images: r.custom_skin_images,
+            generic_custom_css: r.generic_custom_css,
+            mission_tabs_options: r.mission_tabs_options,
+            overview_missions_count: r.overview_missions_count,
+            overview_missions_filter: r.overview_missions_filter,
+            theme: r.theme
+        }
+        return x;
+    })
+}

package/src/CustomSections/index.ts

@@ -0,0 +1,4 @@
+export * from './AchCustomSection';
+export * from './UICustomSection';
+export * from './GetCustomSectionsRequest';
+export * from './GetCustomSectionsResponse';

package/src/Level/GetLevelMapResponse.ts

@@ -17,7 +17,7 @@ export const GetLevelMapResponseTransform = (levels: GetLevelMapResponse): TLeve
         description: l.level_public_meta.description,
         image: l.level_public_meta.image_url,
         required_points: l.required_points,
-        visibility_points: parseInt(l.level_public_meta.visibility_points as any),
+        visibility_points: l.level_public_meta.visibility_points ? parseInt(l.level_public_meta.visibility_points as any) : null,
         required_level_counter_1: l.required_level_counter_1,
         required_level_counter_2: l.required_level_counter_2,
         custom_data: IntUtils.JsonOrText(l.level_public_meta?.custom_data),

package/src/Missions/AchievementPublicMeta.ts

@@ -18,4 +18,5 @@ export interface AchievementPublicMeta {
     hint_text?: string;
     hide_badge_from_ui?: boolean;
     show_badge_first_task_completed?: boolean;
+    custom_section_type_id?: number;
 }

package/src/Missions/UserAchievement.ts

@@ -41,6 +41,7 @@ export interface UserAchievement {
     completed_today?: boolean;
     completed_this_week?: boolean;
     completed_this_month?: boolean;
+    custom_section_type_id?: number;
 }
 
 
@@ -103,7 +104,8 @@ export const UserAchievementTransform = (items: UserAchievement[]): TMissionOrBa
             complete_date_ts: r.complete_date_ts,
             completed_today: completedToday,
             completed_this_week: completedThisWeek,
-            completed_this_month: completedThisMonth
+            completed_this_month: completedThisMonth,
+            custom_section_type_id: r.ach_public_meta.custom_section_type_id,
         }
         return x;
 });

package/src/OCache.ts

@@ -66,6 +66,11 @@ export class OCache {
             this.cache[cacheContext].flushAll();
         }
     }
+
+    public static async clearAll() {
+        this.cache = {};
+    }    
+
 }
 
 const deepClone = (o: any) => {

package/src/SmarticoAPI.ts

@@ -17,12 +17,13 @@ import { GetTournamentInfoRequest, GetTournamentInfoResponse, GetTournamentsRequ
 import { GetLeaderBoardsRequest, GetLeaderBoardsResponse, LeaderBoardDetails, LeaderBoardPeriodType } from "./Leaderboard";
 import { GetLevelMapResponse, GetLevelMapResponseTransform } from "./Level";
 import { WSAPI } from "./WSAPI/WSAPI";
-import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed, LeaderBoardDetailsT, UserLevelExtraCountersT, TSegmentCheckResult } from "./WSAPI/WSAPITypes";
+import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed, LeaderBoardDetailsT, UserLevelExtraCountersT, TSegmentCheckResult, TUICustomSection } from "./WSAPI/WSAPITypes";
 import { getLeaderBoardTransform } from "./Leaderboard/LeaderBoards";
 import { GetAchievementsUserInfoResponse } from "./Core/GetAchievementsUserInfoResponse";
 import { CheckSegmentMatchResponse } from "./Core/CheckSegmentMatchResponse";
 import { CheckSegmentMatchRequest } from "./Core/CheckSegmentMatchRequest";
 import { GetJackpotsPotsRequest, GetJackpotsPotsResponse, GetJackpotsRequest, GetJackpotsResponse, JackpotDetails, JackpotPot, JackpotsOptinRequest, JackpotsOptinResponse, JackpotsOptoutRequest, JackpotsOptoutResponse } from "./Jackpots";
+import { GetCustomSectionsRequest, GetCustomSectionsResponse, UICustomSectionTransform } from "./CustomSections";
 
 const PUBLIC_API_URL = 'https://papi{ENV_ID}.smartico.ai/services/public';
 const C_SOCKET_PROD = 'wss://api{ENV_ID}.smartico.ai/websocket/services';
@@ -111,13 +112,16 @@ class SmarticoAPI {
         return AVATAR_DOMAIN.replace('{ENV_ID}', SmarticoAPI.getEnvDnsSuffix(label_api_key));    
     }    
 
-    private async send<T>(message: any, expectCID?: ClassId): Promise<T> {
+    private async send<T>(message: any, expectCID?: ClassId, force_language?: string): Promise<T> {
 
 
         if (this.logCIDs.includes(message.cid)) {
             this.logger.info('REQ', message)
         }
 
+        if (force_language) {
+            message.force_language = force_language;
+        }
 
         let result: any;
         
@@ -287,18 +291,15 @@ class SmarticoAPI {
         return results.segments || [];
     }
 
-    public async jackpotGet(user_ext_id: string, filter?: { related_game_id?: string, jp_template_id?: number }): Promise<JackpotDetails[]> {
-        const message = this.buildMessage<GetJackpotsRequest, GetJackpotsResponse>(user_ext_id, ClassId.JP_GET_JACKPOTS_REQUEST, filter);
-        const response = await this.send<GetJackpotsResponse>(message, ClassId.JP_GET_JACKPOTS_RESPONSE);
+    public async jackpotGet(user_ext_id: string, filter?: { related_game_id?: string, jp_template_id?: number }, force_language?: string ): Promise<GetJackpotsResponse> {
 
-        return response?.items || [];
+        const message = this.buildMessage<GetJackpotsRequest, GetJackpotsResponse>(user_ext_id, ClassId.JP_GET_JACKPOTS_REQUEST, filter);
+        return await this.send<GetJackpotsResponse>(message, ClassId.JP_GET_JACKPOTS_RESPONSE, force_language);
     }
 
-    public async potGet(user_ext_id: string, filter: { jp_template_ids: number[] }): Promise<JackpotPot[]> {
+    public async potGet(user_ext_id: string, filter: { jp_template_ids: number[] }): Promise<GetJackpotsPotsResponse> {
         const message = this.buildMessage<GetJackpotsPotsRequest, GetJackpotsPotsResponse>(user_ext_id, ClassId.JP_GET_LATEST_POTS_REQUEST, filter);
-        const response = await this.send<GetJackpotsPotsResponse>(message, ClassId.JP_GET_LATEST_POTS_RESPONSE);
-
-        return response?.items || [];
+        return await this.send<GetJackpotsPotsResponse>(message, ClassId.JP_GET_LATEST_POTS_RESPONSE);
     }
 
     public async jackpotOptIn(user_ext_id: string, payload: { jp_template_id: number }): Promise<JackpotsOptinResponse> {
@@ -311,11 +312,11 @@ class SmarticoAPI {
         return await this.send<JackpotsOptoutResponse>(message, ClassId.JP_OPTOUT_RESPONSE);
     }
 
-    public async sawGetTemplates(user_ext_id: string, lang?: string, is_visitor_mode: boolean = false): Promise<SAWGetTemplatesResponse> {
+    public async sawGetTemplates(user_ext_id: string, force_language?: string, is_visitor_mode: boolean = false): Promise<SAWGetTemplatesResponse> {
 
-        const message = this.buildMessage<SAWGetTemplatesRequest, SAWGetTemplatesResponse>(user_ext_id, ClassId.SAW_GET_SPINS_REQUEST, lang ? { force_language: lang, is_visitor_mode } : { is_visitor_mode });
+        const message = this.buildMessage<SAWGetTemplatesRequest, SAWGetTemplatesResponse>(user_ext_id, ClassId.SAW_GET_SPINS_REQUEST, { is_visitor_mode });
 
-        const response = await this.send<SAWGetTemplatesResponse>(message, ClassId.SAW_GET_SPINS_RESPONSE);
+        const response = await this.send<SAWGetTemplatesResponse>(message, ClassId.SAW_GET_SPINS_RESPONSE, force_language);
 
         if (response && response.templates) {
             response.templates.forEach(t => {
@@ -447,20 +448,18 @@ class SmarticoAPI {
 
     }
 
-    public async storeGetItems(user_ext_id: string): Promise<GetStoreItemsResponse> {
-
+    public async storeGetItems(user_ext_id: string, force_language?: string): Promise<GetStoreItemsResponse> {
         const message = this.buildMessage<any, GetStoreItemsResponse>(user_ext_id, ClassId.GET_SHOP_ITEMS_REQUEST);
-        return await this.send<GetStoreItemsResponse>(message, ClassId.GET_SHOP_ITEMS_RESPONSE);
+        return await this.send<GetStoreItemsResponse>(message, ClassId.GET_SHOP_ITEMS_RESPONSE, force_language);
     }
 
     public async storeGetItemsT(user_ext_id: string): Promise<TStoreItem[]> {
         return StoreItemTransform((await this.storeGetItems(user_ext_id)).items);
     }
 
-    public async storeGetCategories(user_ext_id: string): Promise<GetCategoriesStoreResponse> {
-
+    public async storeGetCategories(user_ext_id: string, force_language?: string): Promise<GetCategoriesStoreResponse> {
         const message = this.buildMessage<any, GetCategoriesStoreResponse>(user_ext_id, ClassId.GET_SHOP_CATEGORIES_REQUEST);
-        return await this.send<GetCategoriesStoreResponse>(message, ClassId.GET_SHOP_CATEGORIES_RESPONSE);
+        return await this.send<GetCategoriesStoreResponse>(message, ClassId.GET_SHOP_CATEGORIES_RESPONSE, force_language);
     }
 
     public async storeGetCategoriesT(user_ext_id: string): Promise<TStoreCategory[]> {
@@ -481,10 +480,10 @@ class SmarticoAPI {
         return StoreItemPurchasedTransform((await this.storeGetPurchasedItems(user_ext_id, limit, offset)).items);
     }
 
-    public async missionsGetItems(user_ext_id: string): Promise<GetAchievementMapResponse> {
+    public async missionsGetItems(user_ext_id: string, force_language?: string): Promise<GetAchievementMapResponse> {
 
         const message = this.buildMessage<GetAchievementMapRequest, GetAchievementMapResponse>(user_ext_id, ClassId.GET_ACHIEVEMENT_MAP_REQUEST);
-        const response = await this.send<GetAchievementMapResponse>(message, ClassId.GET_ACHIEVEMENT_MAP_RESPONSE);
+        const response = await this.send<GetAchievementMapResponse>(message, ClassId.GET_ACHIEVEMENT_MAP_RESPONSE, force_language);
         // 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 = { ...response };
 
@@ -513,20 +512,20 @@ class SmarticoAPI {
         }
     }
 
-    public async achGetCategories(user_ext_id: string): Promise<GetAchCategoriesResponse> {
+    public async achGetCategories(user_ext_id: string, force_language?: string): Promise<GetAchCategoriesResponse> {
 
         const message = this.buildMessage<any, GetAchCategoriesResponse>(user_ext_id, ClassId.GET_ACH_CATEGORIES_REQUEST);
-        return await this.send<GetAchCategoriesResponse>(message, ClassId.GET_ACH_CATEGORIES_RESPONSE);
+        return await this.send<GetAchCategoriesResponse>(message, ClassId.GET_ACH_CATEGORIES_RESPONSE, force_language);
     }
 
     public async achGetCategoriesT(user_ext_id: string): Promise<TAchCategory[]> {
         return AchCategoryTransform((await this.achGetCategories(user_ext_id)).categories);
     }   
 
-    public async badgetsGetItems(user_ext_id: string): Promise<GetAchievementMapResponse> {
+    public async badgetsGetItems(user_ext_id: string, force_language?: string): Promise<GetAchievementMapResponse> {
 
         const message = this.buildMessage<GetAchievementMapRequest, GetAchievementMapResponse>(user_ext_id, ClassId.GET_ACHIEVEMENT_MAP_REQUEST);
-        const response = await this.send<GetAchievementMapResponse>(message, ClassId.GET_ACHIEVEMENT_MAP_RESPONSE);
+        const response = await this.send<GetAchievementMapResponse>(message, ClassId.GET_ACHIEVEMENT_MAP_RESPONSE, force_language);
         // 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 = { ...response };
 
@@ -541,10 +540,10 @@ class SmarticoAPI {
     }    
 
 
-    public async tournamentsGetLobby(user_ext_id: string): Promise<GetTournamentsResponse> {
+    public async tournamentsGetLobby(user_ext_id: string, force_language?: string): Promise<GetTournamentsResponse> {
 
         const message = this.buildMessage<GetTournamentsRequest, GetTournamentsResponse>(user_ext_id, ClassId.GET_TOURNAMENT_LOBBY_REQUEST);
-        return await this.send<GetTournamentsResponse>(message, ClassId.GET_TOURNAMENT_LOBBY_RESPONSE);
+        return await this.send<GetTournamentsResponse>(message, ClassId.GET_TOURNAMENT_LOBBY_RESPONSE, force_language);
 
     }
 
@@ -552,14 +551,14 @@ class SmarticoAPI {
         return TournamentItemsTransform((await this.tournamentsGetLobby(user_ext_id)).tournaments);
     }
 
-    public async tournamentsGetInfo(user_ext_id: string, tournamentInstanceId: number): Promise<GetTournamentInfoResponse> {
+    public async tournamentsGetInfo(user_ext_id: string, tournamentInstanceId: number, force_language?: string): Promise<GetTournamentInfoResponse> {
 
         const message = this.buildMessage<GetTournamentInfoRequest, GetTournamentInfoResponse>(user_ext_id, ClassId.GET_TOURNAMENT_INFO_REQUEST, 
             {
                 tournamentInstanceId
             }
         );
-        const response = await this.send<GetTournamentInfoResponse>(message, ClassId.GET_TOURNAMENT_INFO_RESPONSE);
+        const response = await this.send<GetTournamentInfoResponse>(message, ClassId.GET_TOURNAMENT_INFO_RESPONSE, force_language);
         
         if (response.userPosition?.avatar_id) {
             response.userPosition.avatar_url = CoreUtils.avatarUrl(response.userPosition.avatar_id, this.avatarDomain);
@@ -583,7 +582,7 @@ class SmarticoAPI {
         return tournamentInfoItemTransform(response);
     }    
 
-    public async leaderboardGet(user_ext_id: string, period_type_id?: LeaderBoardPeriodType, prevPeriod: boolean = false): Promise<LeaderBoardDetails> {
+    public async leaderboardGet(user_ext_id: string, period_type_id?: LeaderBoardPeriodType, prevPeriod: boolean = false, force_language?: string): Promise<LeaderBoardDetails> {
 
         const message = this.buildMessage<GetLeaderBoardsRequest, GetLeaderBoardsResponse>(user_ext_id, ClassId.GET_LEADERS_BOARD_REQUEST, 
             {
@@ -593,7 +592,7 @@ class SmarticoAPI {
             }
         );
 
-        const response = await this.send<GetLeaderBoardsResponse>(message, ClassId.GET_LEADERS_BOARD_RESPONSE);
+        const response = await this.send<GetLeaderBoardsResponse>(message, ClassId.GET_LEADERS_BOARD_RESPONSE, force_language);
 
         const boardKey =  Object.keys(response.map).find( k => period_type_id === undefined || k === period_type_id?.toString());
 
@@ -620,15 +619,24 @@ class SmarticoAPI {
         return getLeaderBoardTransform(await this.leaderboardGet(user_ext_id, period_type_id, prevPeriod));
     }
 
-    public async levelsGet(user_ext_id: string): Promise<GetLevelMapResponse> {
+    public async levelsGet(user_ext_id: string, force_language?: string): Promise<GetLevelMapResponse> {
         const message = this.buildMessage<any, GetLevelMapResponse>(user_ext_id, ClassId.GET_LEVEL_MAP_REQUEST);
-        return await this.send<GetLevelMapResponse>(message, ClassId.GET_LEVEL_MAP_RESPONSE);
+        return await this.send<GetLevelMapResponse>(message, ClassId.GET_LEVEL_MAP_RESPONSE, force_language);
     }
 
     public async levelsGetT(user_ext_id: string): Promise<TLevel[]> {
         return GetLevelMapResponseTransform(await this.levelsGet(user_ext_id));
     }
 
+    public async getCustomSections(user_ext_id: string): Promise<GetCustomSectionsResponse> {
+        const message = this.buildMessage<GetCustomSectionsRequest, GetCustomSectionsResponse>(user_ext_id, ClassId.GET_CUSTOM_SECTIONS_REQUEST);
+        return await this.send<GetCustomSectionsResponse>(message, ClassId.GET_CUSTOM_SECTIONS_RESPONSE);
+    }
+
+    public async getCustomSectionsT(user_ext_id: string): Promise<TUICustomSection[]> {
+        return UICustomSectionTransform(Object.values((await this.getCustomSections(user_ext_id)).customSections));
+    }
+
     public async getTranslationsT(user_ext_id: string, lang_code: string, areas: TranslationArea[], cacheSec: number = 60): Promise<GetTranslationsResponse> {
         return await this.coreGetTranslations(user_ext_id, lang_code, areas, 30);
     }
@@ -722,7 +730,7 @@ class SmarticoAPI {
         return await this.send<MarkInboxMessageDeletedResponse>(message, ClassId.MARK_INBOX_DELETED_RESPONSE);
     }
 
-    
+
     public getWSCalls(): WSAPI {
         return new WSAPI(this);
     }