@smartico/public-api 0.0.56 → 0.0.58

package/dist/MiniGames/SAWSpinErrorCode.d.ts

@@ -1,8 +1,14 @@
 export declare enum SAWSpinErrorCode {
+    /** No error */
     SAW_OK = 0,
+    /** User doesn't have 'spin attempts' to play. In case buy in type for the game is 'spins' based */
     SAW_NO_SPINS = 40001,
+    /** The are no prizes left to play the game */
     SAW_PRIZE_POOL_EMPTY = 40002,
+    /** User doesn't have enough points to play. In case buy in type for the game is 'points' based */
     SAW_NOT_ENOUGH_POINTS = 40003,
+    /** User reached max number of game attempts defined in the BackOffice */
     SAW_FAILED_MAX_SPINS_REACHED = 40004,
+    /** Special code for the 'visitor' mode */
     SAW_VISITOR_STOP_SPIN_REQUEST = -40001
 }

package/dist/SmarticoAPI.d.ts

@@ -53,7 +53,7 @@ declare class SmarticoAPI {
     }>;
     sawGetTemplates(user_ext_id: string, lang?: string, is_visitor_mode?: boolean): Promise<SAWGetTemplatesResponse>;
     sawGetTemplatesT(user_ext_id: string): Promise<TMiniGameTemplate[]>;
-    sawSpinRequest(user_ext_id: string, saw_template_id: number, round_id: number): Promise<SAWDoSpinResponse>;
+    sawSpinRequest(user_ext_id: string, saw_template_id: number, round_id?: number): Promise<SAWDoSpinResponse>;
     inboxGetMessages(user_ext_id: string, limit?: number, offset?: number): Promise<GetInboxMessagesResponse>;
     storeGetItems(user_ext_id: string): Promise<GetStoreItemsResponse>;
     storeGetItemsT(user_ext_id: string): Promise<TStoreItem[]>;

package/dist/WSAPI/WSAPI.d.ts

@@ -1,12 +1,12 @@
 import { SmarticoAPI } from "../SmarticoAPI";
-import { TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TUserProfile } from "./WSAPITypes";
+import { TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TUserProfile } from "./WSAPITypes";
 /** @group General API */
 export declare class WSAPI {
     private api;
     /** @private */
     constructor(api: SmarticoAPI);
     /** Returns information about current user */
-    getUserProfile(): Promise<TUserProfile>;
+    getUserProfile(): TUserProfile;
     /** Returns all the levels available the current user */
     getLevels(): Promise<TLevel[]>;
     /** Returns all the missions available the current user */
@@ -19,6 +19,8 @@ export declare class WSAPI {
     getStoreCategories(): Promise<TStoreItem[]>;
     /** Returns the list of mini-games available for user */
     getMiniGames(): Promise<TMiniGameTemplate[]>;
+    /** Plays the specified by template_id mini-game on behalf of user and returns prize_id or err_code  */
+    playMiniGame(template_id: number): Promise<TMiniGamePlayResult>;
     /** Returns all the active instances of tournaments */
     getTournamentsList(): Promise<TTournament[]>;
     /** Returns details information of specific tournament instance, the response will includ tournamnet info and the leaderboard of players */

package/dist/WSAPI/WSAPITypes.d.ts

@@ -1,8 +1,8 @@
-import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName } from "../MiniGames";
+import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode } 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
+ * TMiniGamePrize describes the information of prize in the array of prizes in the TMiniGameTemplate
 */
 export interface TMiniGamePrize {
     /** ID of the prize */
@@ -19,7 +19,18 @@ export interface TMiniGamePrize {
     icon?: string;
 }
 /**
- * TMiniGameTemplate interface describes the information of mini-games available for the user
+ * TMiniGamePlayResult describes the response of call to _smartico.api.playMiniGame(template_id) method
+*/
+export interface TMiniGamePlayResult {
+    /** Name of the mini-game template, translated to the user language */
+    err_code: SAWSpinErrorCode;
+    /** Name of the mini-game template, translated to the user language */
+    err_message: string;
+    /** The prize_id that user won, details of the prize can be found in the mini-game definition */
+    prize_id: number;
+}
+/**
+ * TMiniGameTemplate describes the information of mini-games available for the user
 */
 export interface TMiniGameTemplate {
     /** ID of the mini-game template */
@@ -50,7 +61,7 @@ export interface TMiniGameTemplate {
     prizes: TMiniGamePrize[];
 }
 /**
- * TUser interface describes the information of the user
+ * TUser describes the information of the user
  * The user object is returned by _smartico.api.getUserProfile() method.
  * If you want to track the changes of the user profile, you can subscribe to the callback in the following way
  *  _smartico.on('props_change', () => console.log(_smartico.api.getUserProfile()) );
@@ -81,7 +92,7 @@ export interface TUserProfile {
     core_inbox_unread_count?: number;
 }
 /**
- * TLevel interface describes the information of each level defined in the system
+ * TLevel describes the information of each level defined in the system
  * There is no order of the levels, but it can be calculated using required_points property
  * The current level of user can be taken from the user object using ach_level_current_id property
  * The progress to the next level can be calculated using ach_points_ever and required_points properties of next level
@@ -115,7 +126,7 @@ export interface TLevel {
     required_level_counter_2: number;
 }
 /**
- * TTournament interface describes the general information of the tournament item
+ * TTournament describes the general information of the tournament item
  */
 export interface TTournament {
     /** ID of tournament instance. Generated every time when tournament based on specific template is scheduled for run */
@@ -177,7 +188,7 @@ export interface TTournament {
     is_upcoming: boolean;
 }
 /**
- * TTournamentDetailed interface describes the information of the tournament item and includes list of participants, their scores and position in the tournament leaderboard
+ * TTournamentDetailed describes the information of the tournament item and includes list of participants, their scores and position in the tournament leaderboard
  */
 export interface TTournamentDetailed extends TTournament {
     /** The list of the tournament participants */
@@ -206,7 +217,7 @@ export interface TTournamentDetailed extends TTournament {
     };
 }
 /**
- * TStoreCategory interface describes the store category item. Each store item can be assigned to 1 or more categories
+ * TStoreCategory describes the store category item. Each store item can be assigned to 1 or more categories
  */
 export interface TStoreCategory {
     id: number;
@@ -214,7 +225,7 @@ export interface TStoreCategory {
     order: number;
 }
 /**
- * TStoreItem interface describes the information of the store item defined in the system
+ * TStoreItem describes the information of the store item defined in the system
  */
 export interface TStoreItem {
     /** ID of the store item  */
@@ -249,7 +260,7 @@ export interface TStoreItem {
     category_ids: number[];
 }
 /**
- * TMissionOrBadge interface describes the information of mission or badge defined in the system
+ * TMissionOrBadge describes the information of mission or badge defined in the system
  */
 export interface TMissionOrBadge {
     /** ID of the mission or badge  */
@@ -303,7 +314,7 @@ export interface TMissionOrBadge {
     tasks: TMissionOrBadgeTask[];
 }
 /**
- * TMissionOrBadgeTask interface describes the information of tasks that belings to mission or badge. See also TMissionOrBadge
+ * TMissionOrBadgeTask describes the information of tasks that belings to mission or badge. See also TMissionOrBadge
  */
 export interface TMissionOrBadgeTask {
     /** ID of the task */

package/dist/index.js

@@ -304,14 +304,23 @@ var SAWTemplatesTransform = function SAWTemplatesTransform(items) {
   });
 };
 
+/*
+*  Possible error codes for the mini-games attempts
+*/
 exports.SAWSpinErrorCode = void 0;
 (function (SAWSpinErrorCode) {
+  /** No error */
   SAWSpinErrorCode[SAWSpinErrorCode["SAW_OK"] = 0] = "SAW_OK";
+  /** User doesn't have 'spin attempts' to play. In case buy in type for the game is 'spins' based */
   SAWSpinErrorCode[SAWSpinErrorCode["SAW_NO_SPINS"] = 40001] = "SAW_NO_SPINS";
+  /** The are no prizes left to play the game */
   SAWSpinErrorCode[SAWSpinErrorCode["SAW_PRIZE_POOL_EMPTY"] = 40002] = "SAW_PRIZE_POOL_EMPTY";
+  /** User doesn't have enough points to play. In case buy in type for the game is 'points' based */
   SAWSpinErrorCode[SAWSpinErrorCode["SAW_NOT_ENOUGH_POINTS"] = 40003] = "SAW_NOT_ENOUGH_POINTS";
+  /** User reached max number of game attempts defined in the BackOffice */
   SAWSpinErrorCode[SAWSpinErrorCode["SAW_FAILED_MAX_SPINS_REACHED"] = 40004] = "SAW_FAILED_MAX_SPINS_REACHED";
-  SAWSpinErrorCode[SAWSpinErrorCode["SAW_VISITOR_STOP_SPIN_REQUEST"] = -40001] = "SAW_VISITOR_STOP_SPIN_REQUEST"; // special code for visitor game mode to stop spin request
+  /** Special code for the 'visitor' mode */
+  SAWSpinErrorCode[SAWSpinErrorCode["SAW_VISITOR_STOP_SPIN_REQUEST"] = -40001] = "SAW_VISITOR_STOP_SPIN_REQUEST";
 })(exports.SAWSpinErrorCode || (exports.SAWSpinErrorCode = {}));
 
 var _SAWWinSoundFiles;
@@ -809,63 +818,74 @@ var WSAPI = /*#__PURE__*/function () {
   /** Returns information about current user */
   var _proto = WSAPI.prototype;
   _proto.getUserProfile = function getUserProfile() {
-    try {
-      var _this = this;
-      if (_this.api.tracker) {
-        var o = Object.assign({}, _this.api.tracker.userPublicProps);
-        o.avatar_url = CoreUtils.avatarUrl(_this.api.tracker.userPublicProps.avatar_id, _this.api.avatarDomain);
-        return Promise.resolve(o);
-      } else {
-        throw new Error('Tracker is not initialized, cannot getUserProfile');
-      }
-    } catch (e) {
-      return Promise.reject(e);
+    if (this.api.tracker) {
+      var o = Object.assign({}, this.api.tracker.userPublicProps);
+      o.avatar_url = CoreUtils.avatarUrl(this.api.tracker.userPublicProps.avatar_id, this.api.avatarDomain);
+      return o;
+    } else {
+      throw new Error('Tracker is not initialized, cannot getUserProfile');
     }
-  } /** Returns all the levels available the current user */;
+  }
+  /** Returns all the levels available the current user */;
   _proto.getLevels = function getLevels() {
     try {
-      var _this2 = this;
-      return Promise.resolve(_this2.api.levelsGetT(null));
+      var _this = this;
+      return Promise.resolve(_this.api.levelsGetT(null));
     } catch (e) {
       return Promise.reject(e);
     }
   } /** Returns all the missions available the current user */;
   _proto.getMissions = function getMissions() {
     try {
-      var _this3 = this;
-      return Promise.resolve(_this3.api.missionsGetItemsT(null));
+      var _this2 = this;
+      return Promise.resolve(_this2.api.missionsGetItemsT(null));
     } catch (e) {
       return Promise.reject(e);
     }
   } /** Returns all the badges available the current user */;
   _proto.getBadges = function getBadges() {
     try {
-      var _this4 = this;
-      return Promise.resolve(_this4.api.badgetsGetItemsT(null));
+      var _this3 = this;
+      return Promise.resolve(_this3.api.badgetsGetItemsT(null));
     } catch (e) {
       return Promise.reject(e);
     }
   } /** Returns all the store items available the current user */;
   _proto.getStoreItems = function getStoreItems() {
     try {
-      var _this5 = this;
-      return Promise.resolve(_this5.api.storeGetItemsT(null));
+      var _this4 = this;
+      return Promise.resolve(_this4.api.storeGetItemsT(null));
     } catch (e) {
       return Promise.reject(e);
     }
   } /** Returns store categories */;
   _proto.getStoreCategories = function getStoreCategories() {
     try {
-      var _this6 = this;
-      return Promise.resolve(_this6.api.storeGetItemsT(null));
+      var _this5 = this;
+      return Promise.resolve(_this5.api.storeGetItemsT(null));
     } catch (e) {
       return Promise.reject(e);
     }
   } /** Returns the list of mini-games available for user */;
   _proto.getMiniGames = function getMiniGames() {
+    try {
+      var _this6 = this;
+      return Promise.resolve(_this6.api.sawGetTemplatesT(null));
+    } catch (e) {
+      return Promise.reject(e);
+    }
+  } /** Plays the specified by template_id mini-game on behalf of user and returns prize_id or err_code  */;
+  _proto.playMiniGame = function playMiniGame(template_id) {
     try {
       var _this7 = this;
-      return Promise.resolve(_this7.api.sawGetTemplatesT(null));
+      return Promise.resolve(_this7.api.sawSpinRequest(null, template_id)).then(function (r) {
+        var o = {
+          err_code: r.errCode,
+          err_message: r.errMsg,
+          prize_id: r.saw_prize_id
+        };
+        return o;
+      });
     } catch (e) {
       return Promise.reject(e);
     }