@smartico/public-api 0.0.55 → 0.0.57

package/src/Tournaments/TournamentRegistrationStatus.ts

@@ -10,18 +10,27 @@ export enum TournamentRegistrationStatus {
     QUALIFIED_PENDING_REGISTRATION = 6
 }
 
-export type TournamentRegistrationStatusName = 'NOT_REGISTERED' | 'REGISTERED' | 'FINISHED' | 'PENDING' | 'CANCELLED' | 'REGISTERED_PENDING_QUALIFICATION' | 'QUALIFIED_PENDING_REGISTRATION';
+export enum TournamentRegistrationStatusName {
+    NOT_REGISTERED = 'NOT_REGISTERED',
+    REGISTERED = 'REGISTERED',
+    FINISHED = 'FINISHED',
+    PENDING = 'PENDING',
+    CANCELLED = 'CANCELLED',
+    REGISTERED_PENDING_QUALIFICATION = 'REGISTERED_PENDING_QUALIFICATION',
+    QUALIFIED_PENDING_REGISTRATION = 'QUALIFIED_PENDING_REGISTRATION',
+    UNKNOWN = "UNKNOWN"
+}
 
 /** @hidden */
-export const TournamentRegistrationStatusName = (type: TournamentRegistrationStatus): TournamentRegistrationStatusName => {
+export const TournamentRegistrationStatusNamed = (type: TournamentRegistrationStatus): TournamentRegistrationStatusName => {
     return ({
-        [TournamentRegistrationStatus.CANCELLED]: 'CANCELLED',
-        [TournamentRegistrationStatus.FINISHED]: 'FINISHED',
-        [TournamentRegistrationStatus.NOT_REGISTERED]: 'NOT_REGISTERED',
-        [TournamentRegistrationStatus.PENDING]: 'PENDING',
-        [TournamentRegistrationStatus.QUALIFIED_PENDING_REGISTRATION]: 'QUALIFIED_PENDING_REGISTRATION',
-        [TournamentRegistrationStatus.REGISTERED]: 'REGISTERED',
-        [TournamentRegistrationStatus.REGISTERED_PENDING_QUALIFICATION]: 'REGISTERED_PENDING_QUALIFICATION',
-    }[type] || 'UNKNOWN') as TournamentRegistrationStatusName;
+        [TournamentRegistrationStatus.CANCELLED]: TournamentRegistrationStatusName.CANCELLED,
+        [TournamentRegistrationStatus.FINISHED]: TournamentRegistrationStatusName.FINISHED,
+        [TournamentRegistrationStatus.NOT_REGISTERED]: TournamentRegistrationStatusName.NOT_REGISTERED,
+        [TournamentRegistrationStatus.PENDING]: TournamentRegistrationStatusName.PENDING,
+        [TournamentRegistrationStatus.QUALIFIED_PENDING_REGISTRATION]: TournamentRegistrationStatusName.QUALIFIED_PENDING_REGISTRATION,
+        [TournamentRegistrationStatus.REGISTERED]: TournamentRegistrationStatusName.REGISTERED,
+        [TournamentRegistrationStatus.REGISTERED_PENDING_QUALIFICATION]: TournamentRegistrationStatusName.REGISTERED_PENDING_QUALIFICATION
+    }[type] || TournamentRegistrationStatusName.UNKNOWN) as TournamentRegistrationStatusName;
 }    
 

package/src/WSAPI/WSAPI.ts

@@ -1,7 +1,7 @@
 import { CoreUtils } from "../Core";
 import { SmarticoAPI } from "../SmarticoAPI";
 
-import { TLevel, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TUserProfile } from "./WSAPITypes";
+import { TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TUserProfile } from "./WSAPITypes";
 
 /** @group General API */
 export class WSAPI {
@@ -11,7 +11,7 @@ export class WSAPI {
     }
 
     /** Returns information about current user */
-    public async getUserProfile(): Promise<TUserProfile> {
+    public getUserProfile(): TUserProfile {
         if (this.api.tracker) {
             const o: TUserProfile = Object.assign({}, this.api.tracker.userPublicProps);
             o.avatar_url = CoreUtils.avatarUrl(this.api.tracker.userPublicProps.avatar_id, this.api.avatarDomain);
@@ -41,6 +41,16 @@ export class WSAPI {
         return this.api.storeGetItemsT(null);
     }
 
+    /** Returns store categories */
+    public async getStoreCategories(): Promise<TStoreItem[]> {
+        return this.api.storeGetItemsT(null);
+    }    
+
+    /** Returns the list of mini-games available for user */
+    public async getMiniGames(): Promise<TMiniGameTemplate[]> {
+        return this.api.sawGetTemplatesT(null);
+    }        
+
     /** Returns all the active instances of tournaments */
     public async getTournamentsList(): Promise<TTournament[]> {
         return this.api.tournamentsGetLobbyT(null);

package/src/WSAPI/WSAPITypes.ts

@@ -1,7 +1,73 @@
-import { TournamentRegistrationStatus, TournamentRegistrationStatusName, TournamentRegistrationType, TournamentRegistrationTypeName } from "../Tournaments";
+import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWPrizeType, SAWPrizeUI } from "../MiniGames";
+import { TournamentRegistrationStatusName, TournamentRegistrationTypeName } from "../Tournaments";
 
 type TRibbon = 'sale' | 'hot' | 'new' | 'vip' | string
 
+
+/**
+ * TMiniGamePrize interface describes the information of prize in the array of prizes in the TMiniGameTemplate
+*/
+export interface TMiniGamePrize {
+    /** ID of the prize */
+    id: number;
+    /** The visual name of the prize */
+    name: string;
+    /** The type of the prize,  no-prize, points, bonus, manual, spin, jackpot */
+    prize_type: MiniGamePrizeTypeName;
+    /** Numeric value of the prize in case it's pints or spin type */
+    prize_value?: number;
+    /** Custom font size for the prize */
+    font_size?: number;
+    /** The URL of the icon of the prize */
+    icon?: string;
+}
+
+
+
+/**
+ * TMiniGameTemplate interface describes the information of mini-games available for the user
+*/
+export interface TMiniGameTemplate {
+    /** ID of the mini-game template */
+    id: number;
+    /** Name of the mini-game template, translated to the user language */
+    name: string;
+    /** Description of the mini-game template, translated to the user language */
+    description: string;
+    /** URL of the icon of the mini-game template */
+    thumbnail: string;
+
+    /** The type of the game, e.g. Spin the Wheel, Gift Box, Scratch card, MatchX etc */
+    saw_game_type: SAWGameTypeName;
+    /** How the user is charged for each game attempt e.g. Free, Points or Spin attempts */
+    saw_buyin_type: SAWBuyInTypeName;    
+
+    // in case of charging type 'Points', what is the points amount will be deducted from user balance
+    buyin_cost_points: number;
+    // in case of charging type 'Spin attempts', shows the current number of spin attempts that user has
+    spin_count?: number; 
+
+
+    /** 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 */
+    over_limit_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. */
+    no_attempts_message: string;
+
+    /** Current jackpont amount, if jackpot is enabled. */
+    jackpot_current: 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_add_on_attempt: number;
+    /** 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'.
+     */
+    jackpot_symbol: string;
+        
+    prizes: TMiniGamePrize[];
+
+}
+
+
+
+
 /**
  * TUser interface describes the information of the user
  * The user object is returned by _smartico.api.getUserProfile() method.
@@ -178,6 +244,14 @@ export interface TTournamentDetailed extends TTournament {
 
 };
 
+/** 
+ * TStoreCategory interface describes the store category item. Each store item can be assigned to 1 or more categories
+ */
+export interface TStoreCategory {
+    id: number;
+    name: string;
+    order: number
+}
 
 /** 
  * TStoreItem interface describes the information of the store item defined in the system

package/tsconfig.json

@@ -18,7 +18,10 @@
         "entryPoints": [
             "src/WSAPI/WSAPI.ts", "src/WSAPI/WSAPITypes.ts", 
             "src/Tournaments/TournamentRegistrationStatus.ts",
-            "src/Tournaments/TournamentRegistrationType.ts"
+            "src/Tournaments/TournamentRegistrationType.ts",
+            "src/MiniGames/SAWBuyInType.ts",
+            "src/MiniGames/SAWGameType.ts",
+            "src/MiniGames/SAWPrizeType.ts",
         ],
         "out": "docs",
         "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-merge-modules"],