@smartico/public-api 0.0.142 → 0.0.143

package/docs/README.md

@@ -56,6 +56,7 @@
 - [LeaderBoardUserT](interfaces/LeaderBoardUserT.md)
 - [UserLevelExtraCountersT](interfaces/UserLevelExtraCountersT.md)
 - [TSegmentCheckResult](interfaces/TSegmentCheckResult.md)
+- [TTUICustomSection](interfaces/TUICustomSection.md)
 
 ## General API
 

package/docs/classes/WSAPI.md

@@ -189,6 +189,7 @@ _smartico.api.getStoreItems().then((result) => {
 _smartico.vapi('EN').getStoreItems().then((result) => {
      console.log(result);
 });
+```
 
 #### Returns
 
@@ -240,6 +241,7 @@ _smartico.api.getStoreCategories().then((result) => {
 _smartico.vapi('EN').getStoreCategories().then((result) => {
      console.log(result);
 });
+```
 
 #### Returns
 
@@ -305,6 +307,33 @@ _smartico.vapi('EN').getAchCategories().then((result) => {
 
 ___
 
+### getCustomSections
+
+▸ **getCustomSections**(): `Promise`<[`TUICustomSection`](../interfaces/TUICustomSection.md)[]\>
+
+Returns all custom sections available for the label
+
+**Example**:
+```
+_smartico.api.getCustomSections().then((result) => {
+     console.log(result);
+});
+```
+
+**Example in the Visitor mode**:
+```
+_smartico.vapi('EN').getCustomSections().then((result) => {
+     console.log(result);
+});
+```
+
+#### Returns
+
+`Promise`<[`TUICustomSection`](../interfaces/TUICustomSection.md)[]\>
+
+___
+
+
 ### getMiniGames
 
 ▸ **getMiniGames**(`«destructured»?`): `Promise`<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>

package/docs/enums/AchCustomLayoutTheme.md

@@ -0,0 +1,27 @@
+# Enumeration: AchCustomLayoutTheme
+
+## Enumeration Members
+
+### VALENTINES_LIGHT
+
+• **VALENTINES_LIGHT** = ``valentines-light``
+
+___
+
+### VALENTINES_DARK
+
+• **VALENTINES_DARK** = ``valentines-dark``
+
+___
+
+### EURO_2024
+
+• **EURO_2024** = ``euro-2024``
+
+___
+
+### GENERIC
+
+• **GENERIC** = ``generic``
+
+___

package/docs/enums/AchCustomSectionType.md

@@ -0,0 +1,43 @@
+# Enumeration: AchCustomSectionType
+
+## Enumeration Members
+
+### HTML_PAGE
+
+• **HTML_PAGE** = ``1``
+
+___
+
+### MISSIONS_CATEGORY
+
+• **MISSIONS_CATEGORY** = ``2``
+
+___
+
+### TOURNAMENTS_CATEGORY
+
+• **TOURNAMENTS_CATEGORY** = ``3``
+
+___
+
+### LEVELS
+
+• **LEVELS** = ``4``
+
+___
+
+### MINI_GAMES
+
+• **MINI_GAMES** = ``5``
+
+___
+
+### MISSION_CUSTOM_LAYOUT
+
+• **MISSION_CUSTOM_LAYOUT** = ``6``
+
+___
+
+### MATCH_X
+
+• **MATCH_X** = ``7``

package/docs/enums/AchMissionsTabsOptions.md

@@ -0,0 +1,21 @@
+# Enumeration: AchMissionsTabsOptions
+
+## Enumeration Members
+
+### ONLY_OVERVIEW
+
+• **ONLY_OVERVIEW** = ``1``
+
+___
+
+### NO_OVERVIEW
+
+• **NO_OVERVIEW** = ``2``
+
+___
+
+### ALL
+
+• **ALL** = ``3``
+
+___

package/docs/enums/AchOverviewMissionsFilter.md

@@ -0,0 +1,33 @@
+# Enumeration: AchOverviewMissionsFilter
+
+## Enumeration Members
+
+### ANY
+
+• **ANY** = ``1``
+
+___
+
+### ALL_MISSIONS
+
+• **ALL_MISSIONS** = ``2``
+
+___
+
+### ALL_EXCEPT_COMPLETED
+
+• **ALL_EXCEPT_COMPLETED** = ``3``
+
+___
+
+### ALL_EXCEPT_LOCKED
+
+• **ALL_EXCEPT_LOCKED** = ``4``
+
+___
+
+### ALL_EXCEPT_COMPLETED_AND_LOCKED
+
+• **ALL_EXCEPT_COMPLETED_AND_LOCKED** = ``5``
+
+___

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.142",
+  "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/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/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';
@@ -627,6 +628,15 @@ class SmarticoAPI {
         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);
     }
@@ -720,7 +730,7 @@ class SmarticoAPI {
         return await this.send<MarkInboxMessageDeletedResponse>(message, ClassId.MARK_INBOX_DELETED_RESPONSE);
     }
 
-    
+
     public getWSCalls(): WSAPI {
         return new WSAPI(this);
     }

package/src/WSAPI/WSAPI.ts

@@ -3,7 +3,7 @@ import { CoreUtils } from "../Core";
 import { MiniGamePrizeTypeName, SAWDoSpinResponse, SAWSpinErrorCode, SAWSpinsCountPush } from "../MiniGames";
 import { ECacheContext, OCache } from "../OCache";
 import { SmarticoAPI } from "../SmarticoAPI";
-import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionClaimRewardResult, TMissionOptInResult, TMissionOrBadge, TSegmentCheckResult, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile, UserLevelExtraCountersT } from "./WSAPITypes";
+import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionClaimRewardResult, TMissionOptInResult, TMissionOrBadge, TSegmentCheckResult, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUICustomSection, TUserProfile, UserLevelExtraCountersT } from "./WSAPITypes";
 import { LeaderBoardPeriodType } from "../Leaderboard";
 import { JackpotDetails, JackpotPot, JackpotWinPush, JackpotsOptinResponse, JackpotsOptoutRequest, JackpotsOptoutResponse } from "../Jackpots";
  
@@ -30,6 +30,7 @@ enum onUpdateContextKey {
     StoreHistory = 'storeHistory',
     Jackpots = 'jackpots',
     Pots = 'Pots',
+    CustomSections = 'customSections'
 }
 
 
@@ -200,6 +201,7 @@ export class WSAPI {
      * _smartico.vapi('EN').getStoreItems().then((result) => {
      *      console.log(result);
      * });
+     * ```
     */
 
     public async getStoreItems(): Promise<TStoreItem[]> {
@@ -243,6 +245,7 @@ export class WSAPI {
      * _smartico.vapi('EN').getStoreCategories().then((result) => {
      *      console.log(result);
      * });
+     * ```
      */
     public async getStoreCategories(): Promise<TStoreCategory[]> {
         return OCache.use(onUpdateContextKey.StoreCategories, ECacheContext.WSAPI, () => this.api.storeGetCategoriesT(null), CACHE_DATA_SEC);
@@ -292,6 +295,28 @@ export class WSAPI {
         return OCache.use(onUpdateContextKey.AchCategories, ECacheContext.WSAPI, () => this.api.achGetCategoriesT(null), CACHE_DATA_SEC);
     }
 
+     /**
+     * Returns list of custom sections
+     * 
+     * **Example**:
+     * ```
+     * _smartico.api.getCustomSections().then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     * 
+     * **Example in the Visitor mode**:
+     * ```
+     * _smartico.vapi('EN').getCustomSections().then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     * 
+     * */
+    public async getCustomSections(): Promise<TUICustomSection[]> {
+        return OCache.use(onUpdateContextKey.CustomSections, ECacheContext.WSAPI, () => this.api.getCustomSectionsT(null), CACHE_DATA_SEC);
+    }
+
     /** 
      * Returns the list of mini-games available for user 
      * The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMiniGames with a new onUpdate callback, the old one will be overwritten by the new one. 

package/src/WSAPI/WSAPITypes.ts

@@ -3,6 +3,7 @@ import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorC
 import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from "../Tournaments";
 import { AchCategory } from "../Missions";
 import { LeaderBoardPeriodType } from "../Leaderboard";
+import { AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter } from "../CustomSections";
 
 type TRibbon = 'sale' | 'hot' | 'new' | 'vip' | string
 
@@ -498,6 +499,9 @@ export interface TMissionOrBadge {
 
     /** Flag for mission/badge indicating that mission/badge completed this month */
     completed_this_month?: boolean;
+
+    /** ID of specific Custom Section type */
+    custom_section_type_id?: number;
 }
 
 export interface AchRelatedGame {
@@ -663,4 +667,27 @@ export interface UserLevelExtraCountersT {
 export interface TSegmentCheckResult {
     segment_id: number;
     is_matching: boolean;
+}
+
+export interface TUICustomSection {
+    /** The body of the custom section */
+    body?: string;
+    /** The image of the custom section */
+    menu_img?: string;
+    /** The name of the custom section */
+    menu_name?: string;
+    /** Custom images for custom section */
+    custom_skin_images?: string;
+    /** The particular type of custom section, can be Missions, Tournaments, Lootbox and etc */
+    section_type_id?: AchCustomSectionType;
+    /** Theme of the custom section */
+    theme?: AchCustomLayoutTheme;
+    /** Custom css for the custom section */
+    generic_custom_css?: string;
+    /** Tabs that can be shown in custom section, e.g Overview, No Overview, All tabs */
+    mission_tabs_options?: AchMissionsTabsOptions;
+    /** Filter that allow to show missions by criteria */
+    overview_missions_filter?: AchOverviewMissionsFilter;
+    /** Quantity of missions to be shown in overview */
+    overview_missions_count?: number;
 }