@smartico/public-api 0.0.55 → 0.0.56

package/docs/README.md

@@ -1,11 +1,21 @@
 # Smartico API documentation
 
+## Enumerations
+
+- [SAWBuyInTypeName](enums/SAWBuyInTypeName.md)
+- [SAWGameTypeName](enums/SAWGameTypeName.md)
+- [MiniGamePrizeTypeName](enums/MiniGamePrizeTypeName.md)
+- [TournamentRegistrationStatusName](enums/TournamentRegistrationStatusName.md)
+
 ## Interfaces
 
+- [TMiniGamePrize](interfaces/TMiniGamePrize.md)
+- [TMiniGameTemplate](interfaces/TMiniGameTemplate.md)
 - [TUserProfile](interfaces/TUserProfile.md)
 - [TLevel](interfaces/TLevel.md)
 - [TTournament](interfaces/TTournament.md)
 - [TTournamentDetailed](interfaces/TTournamentDetailed.md)
+- [TStoreCategory](interfaces/TStoreCategory.md)
 - [TStoreItem](interfaces/TStoreItem.md)
 - [TMissionOrBadge](interfaces/TMissionOrBadge.md)
 - [TMissionOrBadgeTask](interfaces/TMissionOrBadgeTask.md)
@@ -16,12 +26,6 @@
 
 ## Type Aliases
 
-### TournamentRegistrationStatusName
-
-Ƭ **TournamentRegistrationStatusName**: ``"NOT_REGISTERED"`` \| ``"REGISTERED"`` \| ``"FINISHED"`` \| ``"PENDING"`` \| ``"CANCELLED"`` \| ``"REGISTERED_PENDING_QUALIFICATION"`` \| ``"QUALIFIED_PENDING_REGISTRATION"``
-
-___
-
 ### TournamentRegistrationTypeName
 
 Ƭ **TournamentRegistrationTypeName**: ``"AUTO"`` \| ``"OPT_IN"`` \| ``"BUY_IN_POINTS"`` \| ``"MANUAL_APPROVAL"`` \| ``"REQUIRES_QUALIFICATION"`` \| ``"UNKNOWN"``

package/docs/classes/WSAPI.md

@@ -62,6 +62,30 @@ Returns all the store items available the current user
 
 ___
 
+### getStoreCategories
+
+▸ **getStoreCategories**(): `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
+
+Returns store categories
+
+#### Returns
+
+`Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
+
+___
+
+### getMiniGames
+
+▸ **getMiniGames**(): `Promise`<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
+
+Returns the list of mini-games available for user
+
+#### Returns
+
+`Promise`<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
+
+___
+
 ### getTournamentsList
 
 ▸ **getTournamentsList**(): `Promise`<[`TTournament`](../interfaces/TTournament.md)[]\>

package/docs/enums/MiniGamePrizeTypeName.md

@@ -0,0 +1,43 @@
+# Enumeration: MiniGamePrizeTypeName
+
+## Enumeration Members
+
+### NO\_PRIZE
+
+• **NO\_PRIZE** = ``"no-prize"``
+
+___
+
+### POINTS
+
+• **POINTS** = ``"points"``
+
+___
+
+### BONUS
+
+• **BONUS** = ``"bonus"``
+
+___
+
+### MANUAL
+
+• **MANUAL** = ``"manual"``
+
+___
+
+### SPIN
+
+• **SPIN** = ``"spin"``
+
+___
+
+### JACKPOT
+
+• **JACKPOT** = ``"jackpot"``
+
+___
+
+### UNKNOWN
+
+• **UNKNOWN** = ``"unknown"``

package/docs/enums/SAWBuyInTypeName.md

@@ -0,0 +1,25 @@
+# Enumeration: SAWBuyInTypeName
+
+## Enumeration Members
+
+### Free
+
+• **Free** = ``"free"``
+
+___
+
+### Points
+
+• **Points** = ``"points"``
+
+___
+
+### Spins
+
+• **Spins** = ``"spins"``
+
+___
+
+### Unknown
+
+• **Unknown** = ``"unknown"``

package/docs/enums/SAWGameTypeName.md

@@ -0,0 +1,31 @@
+# Enumeration: SAWGameTypeName
+
+## Enumeration Members
+
+### SpinAWheel
+
+• **SpinAWheel** = ``"wheel"``
+
+___
+
+### ScratchCard
+
+• **ScratchCard** = ``"scratch"``
+
+___
+
+### MatchX
+
+• **MatchX** = ``"matchx"``
+
+___
+
+### GiftBox
+
+• **GiftBox** = ``"giftbox"``
+
+___
+
+### Unknown
+
+• **Unknown** = ``"unknown"``

package/docs/enums/TournamentRegistrationStatusName.md

@@ -0,0 +1,49 @@
+# Enumeration: TournamentRegistrationStatusName
+
+## Enumeration Members
+
+### NOT\_REGISTERED
+
+• **NOT\_REGISTERED** = ``"NOT_REGISTERED"``
+
+___
+
+### REGISTERED
+
+• **REGISTERED** = ``"REGISTERED"``
+
+___
+
+### FINISHED
+
+• **FINISHED** = ``"FINISHED"``
+
+___
+
+### PENDING
+
+• **PENDING** = ``"PENDING"``
+
+___
+
+### CANCELLED
+
+• **CANCELLED** = ``"CANCELLED"``
+
+___
+
+### REGISTERED\_PENDING\_QUALIFICATION
+
+• **REGISTERED\_PENDING\_QUALIFICATION** = ``"REGISTERED_PENDING_QUALIFICATION"``
+
+___
+
+### QUALIFIED\_PENDING\_REGISTRATION
+
+• **QUALIFIED\_PENDING\_REGISTRATION** = ``"QUALIFIED_PENDING_REGISTRATION"``
+
+___
+
+### UNKNOWN
+
+• **UNKNOWN** = ``"UNKNOWN"``

package/docs/interfaces/TMiniGamePrize.md

@@ -0,0 +1,51 @@
+# Interface: TMiniGamePrize
+
+TMiniGamePrize interface describes the information of prize in the array of prizes in the TMiniGameTemplate
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+ID of the prize
+
+___
+
+### name
+
+• **name**: `string`
+
+The visual name of the prize
+
+___
+
+### prize\_type
+
+• **prize\_type**: [`MiniGamePrizeTypeName`](../enums/MiniGamePrizeTypeName.md)
+
+The type of the prize,  no-prize, points, bonus, manual, spin, jackpot
+
+___
+
+### prize\_value
+
+• `Optional` **prize\_value**: `number`
+
+Numeric value of the prize in case it's pints or spin type
+
+___
+
+### font\_size
+
+• `Optional` **font\_size**: `number`
+
+Custom font size for the prize
+
+___
+
+### icon
+
+• `Optional` **icon**: `string`
+
+The URL of the icon of the prize

package/docs/interfaces/TMiniGameTemplate.md

@@ -0,0 +1,109 @@
+# Interface: TMiniGameTemplate
+
+TMiniGameTemplate interface describes the information of mini-games available for the user
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+ID of the mini-game template
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of the mini-game template, translated to the user language
+
+___
+
+### description
+
+• **description**: `string`
+
+Description of the mini-game template, translated to the user language
+
+___
+
+### thumbnail
+
+• **thumbnail**: `string`
+
+URL of the icon of the mini-game template
+
+___
+
+### saw\_game\_type
+
+• **saw\_game\_type**: [`SAWGameTypeName`](../enums/SAWGameTypeName.md)
+
+The type of the game, e.g. Spin the Wheel, Gift Box, Scratch card, MatchX etc
+
+___
+
+### saw\_buyin\_type
+
+• **saw\_buyin\_type**: [`SAWBuyInTypeName`](../enums/SAWBuyInTypeName.md)
+
+How the user is charged for each game attempt e.g. Free, Points or Spin attempts
+
+___
+
+### buyin\_cost\_points
+
+• **buyin\_cost\_points**: `number`
+
+___
+
+### spin\_count
+
+• `Optional` **spin\_count**: `number`
+
+___
+
+### over\_limit\_message
+
+• **over\_limit\_message**: `string`
+
+The message that should be shown to the user when he cannot play the game, server rejected attempt with error code SAWSpinErrorCode.SAW_FAILED_MAX_SPINS_REACHED
+
+___
+
+### no\_attempts\_message
+
+• **no\_attempts\_message**: `string`
+
+The message that should be shown to the user when he cannot play the game because he doesn't have spin attempts or points.
+
+___
+
+### jackpot\_current
+
+• **jackpot\_current**: `number`
+
+Current jackpont amount, if jackpot is enabled.
+
+___
+
+### jackpot\_add\_on\_attempt
+
+• **jackpot\_add\_on\_attempt**: `number`
+
+The amount that will be added to the jackpot every time when somebody plays the game. Note that the contribution amount is abstract, means that no money or points are deducted from the user balance.
+
+___
+
+### jackpot\_symbol
+
+• **jackpot\_symbol**: `string`
+
+The symbol of jackpot that is giving the sense to the 'amount' E.g. the symbol could be EUR and connected to the amount it can indicate that amount is monetary, e.g. '100 EUR'. Or the symbol can be 'Free spins' and connected to the amount it can indicate that amount is number of free spins, e.g. '100 Free spins'.
+
+___
+
+### prizes
+
+• **prizes**: [`TMiniGamePrize`](TMiniGamePrize.md)[]

package/docs/interfaces/TStoreCategory.md

@@ -0,0 +1,21 @@
+# Interface: TStoreCategory
+
+TStoreCategory interface describes the store category item. Each store item can be assigned to 1 or more categories
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+___
+
+### name
+
+• **name**: `string`
+
+___
+
+### order
+
+• **order**: `number`

package/docs/interfaces/TTournament.md

@@ -165,7 +165,7 @@ ___
 
 ### registration\_status
 
-• **registration\_status**: `TournamentRegistrationStatusName`
+• **registration\_status**: [`TournamentRegistrationStatusName`](../enums/TournamentRegistrationStatusName.md)
 
 Status of registration in the tournament for current user
 

package/docs/interfaces/TTournamentDetailed.md

@@ -245,7 +245,7 @@ ___
 
 ### registration\_status
 
-• **registration\_status**: `TournamentRegistrationStatusName`
+• **registration\_status**: [`TournamentRegistrationStatusName`](../enums/TournamentRegistrationStatusName.md)
 
 Status of registration in the tournament for current user
 

package/package.json

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

package/src/MiniGames/SAWBuyInType.ts

@@ -1,11 +1,22 @@
+/** @hidden */
 export enum SAWBuyInType {
     Free = 1,
     Points = 2,
     Spins = 3
 }
 
-export const SAWBuyInTypeName = {
-    [SAWBuyInType.Free]: "free",
-    [SAWBuyInType.Points]: "points",
-    [SAWBuyInType.Spins]: "spins",
+export enum SAWBuyInTypeName {
+    Free = 'free',
+    Points = 'points',
+    Spins = 'spins',
+    Unknown = 'unknown'
+}
+
+/** @hidden */
+export const SAWBuyInTypeNamed = (type: SAWBuyInType): SAWBuyInTypeName => {
+    return {
+        [SAWBuyInType.Free]: SAWBuyInTypeName.Free,
+        [SAWBuyInType.Points]: SAWBuyInTypeName.Points,
+        [SAWBuyInType.Spins]: SAWBuyInTypeName.Spins
+    }[type] || SAWBuyInTypeName.Unknown;
 }

package/src/MiniGames/SAWGameType.ts

@@ -1,3 +1,5 @@
+/** @hidden */
+
 export enum SAWGameType {
     SpinAWheel = 1,
     ScratchCard = 2,
@@ -5,9 +7,20 @@ export enum SAWGameType {
     GiftBox = 4
 }
 
-export const SAWGameTypeName = {
-    [SAWGameType.SpinAWheel]: "wheel",
-    [SAWGameType.ScratchCard]: "scratch",
-    [SAWGameType.MatchX]: "matchx",
-    [SAWGameType.GiftBox]: "giftbox",
+export enum SAWGameTypeName {
+    SpinAWheel = "wheel",
+    ScratchCard = "scratch",
+    MatchX = "matchx",
+    GiftBox = "giftbox",
+    Unknown = "unknown"
+}
+
+/** @hidden */
+export const SAWGameTypeNamed = (type: SAWGameType): SAWGameTypeName => {
+    return {
+        [SAWGameType.SpinAWheel]: SAWGameTypeName.SpinAWheel,
+        [SAWGameType.ScratchCard]: SAWGameTypeName.ScratchCard,
+        [SAWGameType.MatchX]: SAWGameTypeName.MatchX,
+        [SAWGameType.GiftBox]: SAWGameTypeName.GiftBox
+    }[type] || SAWGameTypeName.Unknown;
 }

package/src/MiniGames/SAWGetTemplatesResponse.ts

@@ -1,8 +1,55 @@
+import { TMiniGamePrize, TMiniGameTemplate } from "../WSAPI/WSAPITypes";
 import { ProtocolResponse } from "./../Base/ProtocolResponse";
+import { SAWBuyInTypeNamed } from "./SAWBuyInType";
+import { SAWGameTypeNamed } from "./SAWGameType";
+import { MiniGamePrizeTypeName, MiniGamePrizeTypeNamed } from "./SAWPrizeType";
 import { SAWTemplate } from "./SAWTemplate";
+import { SAWUtils } from "./SAWUtils";
 
 
 export interface SAWGetTemplatesResponse extends ProtocolResponse {
 
     templates: SAWTemplate[];
 }
+
+
+export const SAWTemplatesTransform = (items: SAWTemplate[]): TMiniGameTemplate[] => {    
+    
+    
+    return items.map( r => {
+
+        const x: TMiniGameTemplate =  {
+            
+            id: r.saw_template_id,
+            name: r.saw_template_ui_definition.name,
+            description: r.saw_template_ui_definition.description,
+            thumbnail: 
+                r.saw_skin_ui_definition?.skin_folder
+                ? r.saw_skin_ui_definition?.skin_folder + '/ico.png'
+                : `https://libs.smartico.ai/gf/images/saw/${r.saw_skin_key}/ico.png`
+                ,
+            over_limit_message: r.saw_template_ui_definition.over_limit_message,
+            no_attempts_message: r.saw_template_ui_definition.no_attempts_message,
+            jackpot_symbol: r.saw_template_ui_definition.jackpot_symbol,
+            saw_game_type: SAWGameTypeNamed[r.saw_game_type_id],
+            saw_buyin_type: SAWBuyInTypeNamed[r.saw_buyin_type_id],
+            buyin_cost_points: r.buyin_cost_points,
+            jackpot_add_on_attempt: r.jackpot_add_on_attempt,
+            jackpot_current: r.jackpot_current,
+
+            prizes: r.prizes.map( p => {
+                const y: TMiniGamePrize = {
+                    id: p.saw_prize_id,
+                    name: p.saw_prize_ui_definition.name,
+                    prize_type: MiniGamePrizeTypeNamed(p.prize_type_id),
+                    prize_value: p.prize_value,
+                    font_size: p.saw_prize_ui_definition.font_size,
+                    icon: p.saw_prize_ui_definition.icon
+                }
+                return y;
+            })
+        };
+        return x;
+    });
+}
+

package/src/MiniGames/SAWPrizeType.ts

@@ -1,3 +1,4 @@
+/** @hidden */
 export enum SAWPrizeType {
 
     NO_PRIZE = 1,
@@ -7,3 +8,25 @@ export enum SAWPrizeType {
     SPIN = 5,
     JACKPOT = 6
 }
+
+export enum MiniGamePrizeTypeName {
+    NO_PRIZE = 'no-prize',
+    POINTS = 'points',
+    BONUS = 'bonus',
+    MANUAL = 'manual',
+    SPIN = 'spin',
+    JACKPOT = 'jackpot',
+    UNKNOWN = "unknown"
+}
+
+/** @hidden */
+export const MiniGamePrizeTypeNamed = (type: SAWPrizeType): MiniGamePrizeTypeName => {
+    return {
+        [SAWPrizeType.NO_PRIZE]: MiniGamePrizeTypeName.NO_PRIZE,
+        [SAWPrizeType.POINTS]: MiniGamePrizeTypeName.POINTS,
+        [SAWPrizeType.BONUS]: MiniGamePrizeTypeName.BONUS,
+        [SAWPrizeType.MANUAL]: MiniGamePrizeTypeName.MANUAL,
+        [SAWPrizeType.SPIN]: MiniGamePrizeTypeName.SPIN,
+        [SAWPrizeType.JACKPOT]: MiniGamePrizeTypeName.JACKPOT,        
+    }[type] || MiniGamePrizeTypeName.UNKNOWN;
+}

package/src/SmarticoAPI.ts

@@ -5,19 +5,19 @@ import { SAWGetTemplatesResponse } from './MiniGames/SAWGetTemplatesResponse';
 import { SAWGetTemplatesRequest } from './MiniGames/SAWGetTemplatesRequest';
 import { IntUtils } from './IntUtils';
 import { ILogger } from './ILogger';
-import { SAWDoSpinRequest, SAWDoSpinResponse, SAWSpinErrorCode } from './MiniGames';
+import { SAWDoSpinRequest, SAWDoSpinResponse, SAWSpinErrorCode, SAWTemplatesTransform } from './MiniGames';
 import { ECacheContext, OCache } from './OCache';
 import { CoreUtils, GetTranslationsRequest, GetTranslationsResponse, ResponseIdentify, TranslationArea } from './Core';
 import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
 import { GetLabelInfoRequest } from './Core/GetLabelInfoRequest';
 import { GetInboxMessagesRequest, GetInboxMessagesResponse } from './Inbox';
-import { GetStoreItemsResponse, StoreItemTransform } from './Store';
+import { GetCategoriesStoreResponse, GetStoreItemsResponse, StoreCategoryTransform, StoreItemTransform } from './Store';
 import { AchievementType, GetAchievementMapRequest, GetAchievementMapResponse, UserAchievementTransform } from './Missions';
 import { GetTournamentInfoRequest, GetTournamentInfoResponse, GetTournamentsRequest, GetTournamentsResponse, TournamentItemsTransform, tournamentInfoItemTransform } from './Tournaments';
 import { GetLeaderBoardsRequest, GetLeaderBoardsResponse, LeaderBoardDetails, LeaderBoardPeriodType } from "./Leaderboard";
 import { GetLevelMapResponse, GetLevelMapResponseTransform } from "./Level";
 import { WSAPI } from "./WSAPI/WSAPI";
-import { TLevel, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed } from "./WSAPI/WSAPITypes";
+import { TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed } from "./WSAPI/WSAPITypes";
 
 const PUBLIC_API_URL = 'https://papi{ENV_ID}.smartico.ai/services/public';
 const C_SOCKET_PROD = 'wss://api{ENV_ID}.smartico.ai/websocket/services';
@@ -289,9 +289,12 @@ class SmarticoAPI {
         }
 
         return response;
-
     }
 
+    public async sawGetTemplatesT(user_ext_id: string): Promise<TMiniGameTemplate[]> {
+        return SAWTemplatesTransform((await this.sawGetTemplates(user_ext_id)).templates);
+    }    
+
     public async sawSpinRequest(user_ext_id: string, saw_template_id: number, round_id: number): Promise<SAWDoSpinResponse> {
 
         const message = this.buildMessage<SAWDoSpinRequest, SAWDoSpinResponse>(user_ext_id, ClassId.SAW_DO_SPIN_REQUEST, {
@@ -336,12 +339,21 @@ class SmarticoAPI {
 
         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);
-
     }
 
     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> {
+
+        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);
+    }
+
+    public async storeGetCategoriesT(user_ext_id: string): Promise<TStoreCategory[]> {
+        return StoreCategoryTransform((await this.storeGetCategories(user_ext_id)).categories);
+    }        
 
     public async missionsGetItems(user_ext_id: string): Promise<GetAchievementMapResponse> {
 

package/src/Store/StoreCategory.ts

@@ -1,7 +1,19 @@
+import { TStoreCategory } from "../WSAPI/WSAPITypes";
 import { StoreCategoryPublicMeta } from "./StoreCategoryPublicMeta";
 
 export interface StoreCategory {
 
     id?: number;
     publicMeta?: StoreCategoryPublicMeta;
+}
+
+export const StoreCategoryTransform = (items: StoreCategory[]): TStoreCategory[] => {    
+    return items.map( r => {
+        const x: TStoreCategory = {
+            id: r.id,
+            name: r.publicMeta?.name,
+            order: r.publicMeta?.order
+        }
+        return x;
+    })
 }

package/src/Tournaments/Tournament.ts

@@ -1,6 +1,6 @@
 import {TournamentRegistrationType, TournamentRegistrationTypeGetName} from "./TournamentRegistrationType";
 import {TournamentInstanceStatus} from "./TournamentInstanceStatus";
-import { TournamentRegistrationStatus, TournamentRegistrationStatusName } from "./TournamentRegistrationStatus";
+import { TournamentRegistrationStatus, TournamentRegistrationStatusName, TournamentRegistrationStatusNamed } from "./TournamentRegistrationStatus";
 import { TournamentType } from "./TournamentType";
 import { TournamentPublicMeta } from "./TournamentPublicMeta";
 import { TTournament } from "../WSAPI/WSAPITypes";
@@ -77,7 +77,7 @@ export const TournamentItemsTransform = (items: Tournament[]): TTournament[] =>
             is_user_registered: r.isUserRegistered,
             players_min_count: r.playersMinCount,
             players_max_count: r.playersMaxCount,
-            registration_status: TournamentRegistrationStatusName(r.tournamentRegistrationStatus),
+            registration_status: TournamentRegistrationStatusNamed(r.tournamentRegistrationStatus),
 
             registration_type: TournamentRegistrationTypeGetName(r.registrationType),
             registration_cost_points: r.buyInAmount,