@smartico/public-api 0.0.281 → 0.0.283

package/docs/README.md

@@ -106,6 +106,7 @@
 - [TMiniGameTemplate](interfaces/TMiniGameTemplate.md)
 - [TUserProfile](interfaces/TUserProfile.md)
 - [TLevel](interfaces/TLevel.md)
+- [TLevelCurrent](interfaces/TLevelCurrent.md)
 - [TTournament](interfaces/TTournament.md)
 - [TTournamentDetailed](interfaces/TTournamentDetailed.md)
 - [TStoreCategory](interfaces/TStoreCategory.md)

package/docs/classes/WSAPI.md

@@ -98,6 +98,27 @@ _smartico.vapi('EN').getLevels().then((result) => {
 
 ___
 
+### getCurrentLevel
+
+▸ **getCurrentLevel**(): `Promise`\<[`TLevelCurrent`](../interfaces/TLevelCurrent.md)\>
+
+Returns the current level of the user with extended information including ordinal position and progress.
+
+**Example**:
+```
+_smartico.api.getCurrentLevel().then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
+
+#### Returns
+
+`Promise`\<[`TLevelCurrent`](../interfaces/TLevelCurrent.md)\>
+
+___
+
 ### getMissions
 
 ▸ **getMissions**(`«destructured»?`): `Promise`\<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>

package/docs/interfaces/TLevel.md

@@ -5,6 +5,12 @@ There is no order of the levels, but it can be calculated using required_points
 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
 
+## Hierarchy
+
+- **`TLevel`**
+
+  ↳ [`TLevelCurrent`](TLevelCurrent.md)
+
 ## Properties
 
 ### id

package/docs/interfaces/TLevelCurrent.md

@@ -0,0 +1,139 @@
+# Interface: TLevelCurrent
+
+TLevelCurrent describes the information of each level defined in the system along with ordinal position and progress of the current level
+
+## Hierarchy
+
+- [`TLevel`](TLevel.md)
+
+  ↳ **`TLevelCurrent`**
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+The ID of the Level
+
+#### Inherited from
+
+[TLevel](TLevel.md).[id](TLevel.md#id)
+
+___
+
+### name
+
+• **name**: `string`
+
+The name of the Level, translated to the user language
+
+#### Inherited from
+
+[TLevel](TLevel.md).[name](TLevel.md#name)
+
+___
+
+### description
+
+• **description**: `string`
+
+The description of the Level, translated to the user language
+
+#### Inherited from
+
+[TLevel](TLevel.md).[description](TLevel.md#description)
+
+___
+
+### image
+
+• **image**: `string`
+
+The URL of the image of the Level
+
+#### Inherited from
+
+[TLevel](TLevel.md).[image](TLevel.md#image)
+
+___
+
+### required\_points
+
+• **required\_points**: `number`
+
+The amount of points required to reach the Level
+
+#### Inherited from
+
+[TLevel](TLevel.md).[required_points](TLevel.md#required_points)
+
+___
+
+### visibility\_points
+
+• **visibility\_points**: `number`
+
+Number of points that user should collect in order to see this level
+
+#### Inherited from
+
+[TLevel](TLevel.md).[visibility_points](TLevel.md#visibility_points)
+
+___
+
+### required\_level\_counter\_1
+
+• **required\_level\_counter\_1**: `number`
+
+The counter of 1st metric used to reach the Level.
+Relevant in case of using advanced leveling logic
+https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for-leveling-users
+
+#### Inherited from
+
+[TLevel](TLevel.md).[required_level_counter_1](TLevel.md#required_level_counter_1)
+
+___
+
+### required\_level\_counter\_2
+
+• **required\_level\_counter\_2**: `number`
+
+The counter of 2nd metric used to reach the Level.
+Relevant in case of using advanced leveling logic
+https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for-leveling-users
+
+#### Inherited from
+
+[TLevel](TLevel.md).[required_level_counter_2](TLevel.md#required_level_counter_2)
+
+___
+
+### custom\_data
+
+• **custom\_data**: `string`
+
+Custom data as string or JSON string that can be used in API to build custom UI
+You can request from Smartico to define fields for your specific case that will be managed from Smartico BackOffice
+Read more here - https://help.smartico.ai/welcome/products/general-concepts/custom-fields-attributes
+
+#### Inherited from
+
+[TLevel](TLevel.md).[custom_data](TLevel.md#custom_data)
+
+___
+
+### ordinal\_position
+
+• **ordinal\_position**: `number`
+
+The ordinal position of the level
+
+___
+
+### progress
+
+• **progress**: `number`
+
+The progress of the level

package/package.json

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

package/src/Missions/AchievementTaskPublicMeta.ts

@@ -1,4 +1,5 @@
 export interface AchievementTaskPublicMeta {
 	name?: string;
 	display_progress_as_count?: boolean;
+	stage_image?: string;
 }

package/src/Missions/UserAchievement.ts

@@ -92,6 +92,7 @@ export const UserAchievementTransform = (items: UserAchievement[]): TMissionOrBa
 						execution_count_expected: t.executionCount,
 						execution_count_actual: t.userExecutedCount,
 						display_progress_as_count: t.task_public_meta.display_progress_as_count,
+						stage_image: t.task_public_meta.stage_image,
 					})),
 				related_games: (r.related_games || []).map((g) => ({
 					ext_game_id: g.ext_game_id,

package/src/SmarticoAPI.ts

@@ -94,6 +94,7 @@ import {
 	TUICustomSection,
 	TBonus,
 	TRaffle,
+	TLevelCurrent,
 } from './WSAPI/WSAPITypes';
 import { getLeaderBoardTransform } from './Leaderboard/LeaderBoards';
 import { GetAchievementsUserInfoResponse } from './Core/GetAchievementsUserInfoResponse';
@@ -1028,6 +1029,35 @@ class SmarticoAPI {
 		return GetLevelMapResponseTransform(await this.levelsGet(user_ext_id));
 	}
 
+	public async getLevelCurrent(user_ext_id: string): Promise<TLevelCurrent> {
+		const levels = await this.levelsGetT(user_ext_id);
+		const userInfo = await this.getUserGamificationInfo(user_ext_id);
+		if (!levels || levels.length === 0) return null;
+
+		const userPoints = userInfo.points_balance;
+
+		const sortedLevels = levels.sort((a, b) => a.required_points - b.required_points);
+
+		let currentLevelIndex = sortedLevels.findIndex((level, index) => {
+			const nextLevel = sortedLevels[index + 1];
+			return userPoints >= level.required_points && (!nextLevel || userPoints < nextLevel.required_points);
+		});
+
+		if (currentLevelIndex === -1) {
+			currentLevelIndex = sortedLevels.length - 1;
+		}
+
+		const currentLevel = sortedLevels[currentLevelIndex];
+		const nextLevel = sortedLevels[currentLevelIndex + 1];
+		const progress = nextLevel ? ((userPoints - currentLevel.required_points) / (nextLevel.required_points - currentLevel.required_points)) * 100 : 100;
+
+		return {
+			...currentLevel,
+			ordinal_position: currentLevelIndex + 1,
+			progress: Math.min(Math.max(progress, 0), 100)
+		};
+	}
+
 	public async customSectionsGet(user_ext_id: string, force_language?: string): Promise<GetCustomSectionsResponse> {
 		const message = this.buildMessage<GetCustomSectionsRequest, GetCustomSectionsResponse>(
 			user_ext_id,

package/src/WSAPI/WSAPI.ts

@@ -36,6 +36,7 @@ import {
 	TRaffleDraw,
 	TRaffleDrawRun,
 	TransformedRaffleClaimPrizeResponse,
+	TLevelCurrent
 } from './WSAPITypes';
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import {
@@ -88,6 +89,7 @@ enum onUpdateContextKey {
 	JackpotWinners = 'jackpotWinners',
 	Raffles = 'raffles',
 	JackpotEligibleGames = 'jackpotEligibleGames',
+	CurrentLevel = 'currentLevel',
 }
 
 /** @group General API */
@@ -211,6 +213,22 @@ export class WSAPI {
 		return OCache.use(onUpdateContextKey.Levels, ECacheContext.WSAPI, () => this.api.levelsGetT(null), CACHE_DATA_SEC);
 	}
 
+	/**
+	 * Returns the current level of the user with extended information including ordinal position and progress.
+	 *
+	 * **Example**:
+	 * ```
+	 * _smartico.api.getCurrentLevel().then((result) => {
+	 *      console.log(result);
+	 * });
+	 * ```
+	 *
+	 * **Visitor mode: not supported**
+	 */
+	public async getCurrentLevel(): Promise<TLevelCurrent> {
+		return OCache.use(onUpdateContextKey.CurrentLevel, ECacheContext.WSAPI, () => this.api.getLevelCurrent(null), CACHE_DATA_SEC);
+	}
+
 	/** Returns all the missions available the current user.
 	 * The returned missions are cached for 30 seconds. But you can pass the onUpdate callback as a parameter.
 	 * Note that each time you call getMissions with a new onUpdate callback, the old one will be overwritten by the new one.

package/src/WSAPI/WSAPITypes.ts

@@ -260,6 +260,17 @@ export interface TLevel {
 	custom_data: string;
 }
 
+/**
+ * TLevelCurrent describes the information of each level defined in the system along with ordinal position and progress of the current level
+ */
+
+export interface TLevelCurrent extends TLevel {
+	/** The ordinal position of the level */
+	ordinal_position: number;
+	/** The progress of the level */
+	progress: number;
+}
+
 /**
  * TTournament describes the general information of the tournament item
  */