@smartico/public-api 0.0.355 → 0.0.356

package/docs/api/interfaces/GamePickRoundRequestParams.md

@@ -0,0 +1,65 @@
+# Interface: GamePickRoundRequestParams
+
+GamePickRoundRequestParams extends base params with a specific round ID
+
+## Hierarchy
+
+- [`GamePickRequestParams`](GamePickRequestParams.md)
+
+  ↳ **`GamePickRoundRequestParams`**
+
+## Properties
+
+### saw\_template\_id
+
+• **saw\_template\_id**: `number`
+
+ID of the MatchX or Quiz game template
+
+#### Inherited from
+
+[GamePickRequestParams](GamePickRequestParams.md).[saw_template_id](GamePickRequestParams.md#saw_template_id)
+
+___
+
+### ext\_user\_id
+
+• **ext\_user\_id**: `string`
+
+External user ID
+
+#### Inherited from
+
+[GamePickRequestParams](GamePickRequestParams.md).[ext_user_id](GamePickRequestParams.md#ext_user_id)
+
+___
+
+### smartico\_ext\_user\_id
+
+• **smartico\_ext\_user\_id**: `string`
+
+Smartico external user ID used for platform API calls
+
+#### Inherited from
+
+[GamePickRequestParams](GamePickRequestParams.md).[smartico_ext_user_id](GamePickRequestParams.md#smartico_ext_user_id)
+
+___
+
+### lang
+
+• `Optional` **lang**: `string`
+
+Language code for translations (e.g. 'EN', 'DE')
+
+#### Inherited from
+
+[GamePickRequestParams](GamePickRequestParams.md).[lang](GamePickRequestParams.md#lang)
+
+___
+
+### round\_id
+
+• **round\_id**: `number`
+
+ID of the specific round

package/docs/api/interfaces/GamePickUserInfo.md

@@ -0,0 +1,107 @@
+# Interface: GamePickUserInfo
+
+GamePickUserInfo describes the current user's profile in the games system
+
+## Properties
+
+### ext\_user\_id
+
+• **ext\_user\_id**: `string`
+
+External user ID (Smartico numeric user ID)
+
+___
+
+### int\_user\_id
+
+• **int\_user\_id**: `number`
+
+Internal user ID within the games system
+
+___
+
+### public\_username
+
+• **public\_username**: `string`
+
+Display name
+
+___
+
+### avatar\_url
+
+• **avatar\_url**: `string`
+
+URL of the user's avatar image
+
+___
+
+### gp\_position
+
+• `Optional` **gp\_position**: `number`
+
+User's leaderboard rank position
+
+___
+
+### full\_wins\_count
+
+• `Optional` **full\_wins\_count**: `number`
+
+Number of fully correct predictions
+
+___
+
+### part\_wins\_count
+
+• `Optional` **part\_wins\_count**: `number`
+
+Number of partially correct predictions
+
+___
+
+### resolution\_score
+
+• `Optional` **resolution\_score**: `number`
+
+User's total score
+
+___
+
+### last\_wallet\_sync\_time
+
+• `Optional` **last\_wallet\_sync\_time**: `Date`
+
+Last time the user's balance was synced from the Smartico platform
+
+___
+
+### ach\_points\_balance
+
+• `Optional` **ach\_points\_balance**: `number`
+
+User's current points balance
+
+___
+
+### ach\_gems\_balance
+
+• `Optional` **ach\_gems\_balance**: `number`
+
+User's current gems balance
+
+___
+
+### ach\_diamonds\_balance
+
+• `Optional` **ach\_diamonds\_balance**: `number`
+
+User's current diamonds balance
+
+___
+
+### pubic\_username\_set
+
+• `Optional` **pubic\_username\_set**: `boolean`
+
+Whether the user has set a custom public username

package/docs/api/interfaces/GamesApiResponse.md

@@ -0,0 +1,33 @@
+# Interface: GamesApiResponse\<T\>
+
+GamesApiResponse is the standard response wrapper for all GamePick/Quiz API calls
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Properties
+
+### errCode
+
+• **errCode**: `number`
+
+Error code: 0 on success, non-zero on failure
+
+___
+
+### errMessage
+
+• `Optional` **errMessage**: `string`
+
+Human-readable error message when errCode is non-zero
+
+___
+
+### data
+
+• `Optional` **data**: `T`
+
+Response payload, present on success

package/docs/api/interfaces/QuizEventMeta.md

@@ -0,0 +1,41 @@
+# Interface: QuizEventMeta
+
+QuizEventMeta describes metadata for a quiz-type event (custom question with answer options)
+
+## Hierarchy
+
+- **`QuizEventMeta`**
+
+  ↳ [`GamePickEventMeta`](GamePickEventMeta.md)
+
+## Properties
+
+### answers
+
+• `Optional` **answers**: \{ `value`: `string` ; `text`: `string` ; `_translations`: \{ `[key: string]`: \{ `text`: `string`  };  }  }[]
+
+List of possible answer options for the quiz question
+
+___
+
+### question\_image
+
+• `Optional` **question\_image**: `string`
+
+URL of an image associated with the question
+
+___
+
+### result
+
+• `Optional` **result**: [`QuizAnswersValueType`](../enums/QuizAnswersValueType.md)
+
+Correct answer value after resolution
+
+___
+
+### custom\_question
+
+• **custom\_question**: `string`
+
+Custom question text displayed to the user

package/docs/api/interfaces/TInboxMessageBody.md

@@ -22,7 +22,7 @@ ___
 
 • **icon**: `string`
 
-Message icon
+Message icon, 128x128px
 
 ___
 

package/docs/api/interfaces/TLevel.md

@@ -41,7 +41,7 @@ ___
 
 • **image**: `string`
 
-The URL of the image of the Level
+The URL of the image of the Level, 256x256px
 
 ___
 

package/docs/api/interfaces/TLevelCurrent.md

@@ -50,7 +50,7 @@ ___
 
 • **image**: `string`
 
-The URL of the image of the Level
+The URL of the image of the Level, 256x256px
 
 #### Inherited from
 

package/docs/api/interfaces/TMiniGamePrize.md

@@ -57,7 +57,7 @@ ___
 
 • `Optional` **icon**: `string`
 
-The URL of the icon of the prize
+The URL of the icon of the prize, aspect ratio 1:1
 
 ___
 

package/docs/api/interfaces/TMiniGameTemplate.md

@@ -32,7 +32,7 @@ ___
 
 • **thumbnail**: `string`
 
-URL of the icon of the mini-game template
+URL of the icon of the mini-game template, 256x256px
 
 ___
 
@@ -147,7 +147,7 @@ ___
 
 • **promo\_image**: `string`
 
-The promo image
+The promo image, 500x240px
 
 ___
 

package/docs/api/interfaces/TMissionOrBadge.md

@@ -56,7 +56,7 @@ ___
 
 • **image**: `string`
 
-URL of the image of the mission or badge
+URL of the image of the mission or badge, 256x256px
 
 ___
 
@@ -228,7 +228,7 @@ ___
 
 • `Optional` **ribbon**: `string`
 
-The ribbon of the mission/badge item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon
+The ribbon of the mission/badge item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon, 250x300px
 
 ___
 

package/docs/api/interfaces/TRaffle.md

@@ -38,7 +38,7 @@ ___
 
 • **image\_url**: `string`
 
-URL of the image that represents the raffle
+URL of the image that represents the raffle, 890x193px
 
 ___
 
@@ -46,7 +46,7 @@ ___
 
 • **image\_url\_mobile**: `string`
 
-URL of the mobile image that represents the raffle
+URL of the mobile image that represents the raffle, 300x142px
 
 ___
 

package/docs/api/interfaces/TRaffleDraw.md

@@ -31,7 +31,7 @@ ___
 
 • **image\_url**: `string`
 
-URL of the image that represents the draw
+URL of the image that represents the draw, 365x175px
 
 ___
 
@@ -39,7 +39,7 @@ ___
 
 • **image\_url\_mobile**: `string`
 
-URL of the moible image that represents the draw
+URL of the moible image that represents the draw, 300x145px
 
 ___
 
@@ -49,6 +49,10 @@ ___
 
 URL of the icon that represents the draw
 
+**`Remarks`**
+
+Square icon target **256×256 px**
+
 ___
 
 ### background\_image\_url
@@ -57,6 +61,10 @@ ___
 
 URL of the background image that will be used in the draw list item
 
+**`Remarks`**
+
+Desktop draw list strip: **900×85 px**.
+
 ___
 
 ### background\_image\_url\_mobile
@@ -65,6 +73,10 @@ ___
 
 URL of the moible background image that will be used in the draw list item
 
+**`Remarks`**
+
+Mobile draw list background: **1328×240 px**.
+
 ___
 
 ### is\_grand

package/docs/api/interfaces/TRaffleDrawRun.md

@@ -41,6 +41,10 @@ ___
 
 URL of the image that represents the draw
 
+**`Remarks`**
+
+Same as [image_url](TRaffleDraw.md#image_url): **365×175 px** desktop promo.
+
 ___
 
 ### image\_url\_mobile
@@ -49,6 +53,10 @@ ___
 
 URL of the moible image that represents the draw
 
+**`Remarks`**
+
+Same as [image_url_mobile](TRaffleDraw.md#image_url_mobile): **300×145 px** mobile promo.
+
 ___
 
 ### icon\_url
@@ -57,6 +65,10 @@ ___
 
 URL of the icon that represents the draw
 
+**`Remarks`**
+
+Same as [icon_url](TRaffleDraw.md#icon_url): **256×256 px** square.
+
 ___
 
 ### background\_image\_url
@@ -65,6 +77,10 @@ ___
 
 URL of the background image that will be used in the draw list item
 
+**`Remarks`**
+
+Same as [background_image_url](TRaffleDraw.md#background_image_url): **900×85 px**.
+
 ___
 
 ### background\_image\_url\_mobile
@@ -73,6 +89,10 @@ ___
 
 URL of the moible background image that will be used in the draw list item
 
+**`Remarks`**
+
+Same as [background_image_url_mobile](TRaffleDraw.md#background_image_url_mobile): **1328×240 px**.
+
 ___
 
 ### is\_grand

package/docs/api/interfaces/TRafflePrize.md

@@ -30,7 +30,7 @@ ___
 
 • **image\_url**: `string`
 
-URL of the image that represents the prize
+URL of the image that represents the prize, 256x256px
 
 ___
 

package/docs/api/interfaces/TStoreItem.md

@@ -32,7 +32,7 @@ ___
 
 • **image**: `string`
 
-URL of the image of the store item
+URL of the image of the store item, 256x256px
 
 ___
 
@@ -56,7 +56,7 @@ ___
 
 • **ribbon**: `string`
 
-The ribbon of the store item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon
+The ribbon of the store item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon, 250x300px
 
 ___
 
@@ -213,7 +213,7 @@ ___
 
 • `Optional` **custom\_ribbon\_image**: `string`
 
-The custom ribbon image of the discounted price.
+The custom ribbon image of the discounted price, 250x300px
 
 ___
 

package/docs/api/interfaces/TTournament.md

@@ -46,7 +46,7 @@ ___
 
 • **image1**: `string`
 
-1st image URL representing the tournament
+1st image URL representing the tournament, 544×216px
 
 ___
 
@@ -54,7 +54,7 @@ ___
 
 • **image2**: `string`
 
-2nd image URL representing the tournament
+2nd image URL representing the tournament, 920x200px
 
 ___
 
@@ -62,7 +62,7 @@ ___
 
 • **image2\_mobile**: `string`
 
-2nd image URL representing the tournament for mobile
+2nd image URL representing the tournament for mobile, 720x400px
 
 ___
 
@@ -119,7 +119,7 @@ ___
 
 • **ribbon**: `string`
 
-The ribbon of the tournament item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon
+The ribbon of the tournament item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon, 250×300px
 
 ___
 

package/docs/api/interfaces/TTournamentDetailed.md

@@ -62,7 +62,7 @@ ___
 
 • **image1**: `string`
 
-1st image URL representing the tournament
+1st image URL representing the tournament, 544×216px
 
 #### Inherited from
 
@@ -74,7 +74,7 @@ ___
 
 • **image2**: `string`
 
-2nd image URL representing the tournament
+2nd image URL representing the tournament, 920x200px
 
 #### Inherited from
 
@@ -86,7 +86,7 @@ ___
 
 • **image2\_mobile**: `string`
 
-2nd image URL representing the tournament for mobile
+2nd image URL representing the tournament for mobile, 720x400px
 
 #### Inherited from
 
@@ -171,7 +171,7 @@ ___
 
 • **ribbon**: `string`
 
-The ribbon of the tournament item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon
+The ribbon of the tournament item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon, 250×300px
 
 #### Inherited from
 

package/docs/api/interfaces/TUICustomSection.md

@@ -22,7 +22,7 @@ ___
 
 • `Optional` **menu\_img**: `string`
 
-The image of the custom section
+The image of the custom section, 64x64px
 
 ___
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@smartico/public-api",
-	"version": "0.0.355",
+	"version": "0.0.356",
 	"description": "Smartico public API",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -33,13 +33,13 @@
 		"typescript-map": "^0.1.0"
 	},
 	"devDependencies": {
-		"@types/node": "^18.19.130",
 		"@types/node-fetch": "^2.6.2",
 		"microbundle": "0.15.0",
 		"npm-run-all": "4.1.5",
-		"typedoc": "^0.24.8",
-		"typedoc-plugin-markdown": "^3.15.4",
-		"typedoc-plugin-merge-modules": "^5.0.1",
-		"typescript": "~5.1.0"
+		"typedoc": "^0.28.17",
+		"typedoc-plugin-markdown": "^4.11.0",
+		"typedoc-plugin-merge-modules": "^7.0.0",
+		"typescript": "~5.1.0",
+		"@types/node": "^18.19.130"
 	}
 }

package/src/SmarticoAPI.ts

@@ -139,7 +139,7 @@ import {
 	GamePickRoundBoard,
 	GamePickUserInfo,
 	GamePickGameInfo,
-} from './GamePick';
+} 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';

package/src/WSAPI/WSAPI.ts

@@ -39,8 +39,6 @@ import {
 	TLevelCurrent,
 	TActivityLog,
 	TRaffleOptinResponse,
-} from './WSAPITypes';
-import {
 	GamesApiResponse,
 	GamePickRound,
 	GamePickRoundBoard,
@@ -48,7 +46,7 @@ import {
 	GamePickGameInfo,
 	GamePickRequestParams,
 	GamePickRoundRequestParams,
-} from '../GamePick';
+} from './WSAPITypes';
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import {
 	JackpotDetails,
@@ -1403,40 +1401,6 @@ export class WSAPI {
 		return this.api.gpGetGameInfo(props.saw_template_id);
 	}
 
-	/**
-	 * Returns translations for the MatchX/Quiz game UI.
-	 * Translations are returned as a key-value map for the Gamification and RetentionGames areas,
-	 * resolved to the current user's language.
-	 *
-	 * @param props.saw_template_id - The ID of the MatchX or Quiz game template
-	 *
-	 * **Response** `GamesApiResponse<any>`:
-	 * - `errCode` - 0 on success
-	 * - `data`:
-	 *   - `translations` - Key-value map of translation strings (e.g. `rgSubmitSelection`, `rgLeaderboardTitle`, `quizConfirmAnswer`, etc.)
-	 *   - `hash_code` - Hash for cache invalidation
-	 *   - `lang_code` - Resolved language code (e.g. 'EN')
-	 *
-	 * **Example**:
-	 * ```
-	 * _smartico.api.getGamePickTranslations({
-	 *      saw_template_id: 1083,
-	 * }).then((result) => {
-	 *      const tr = result.data.translations;
-	 *      console.log(tr.rgSubmitSelection);   // "Submit selection"
-	 *      console.log(tr.rgLeaderboardTitle);  // "Leaderboard"
-	 * });
-	 * ```
-	 *
-	 * **Visitor mode: not supported**
-	 */
-	public async getGamePickTranslations(props: GamePickRequestParams): Promise<GamesApiResponse<any>> {
-		if (!props.saw_template_id) {
-			throw new Error('saw_template_id is required');
-		}
-		return this.api.gpGetTranslations(props.saw_template_id);
-	}
-
 	/**
 	 * Returns round data with events and picks for a specific user (identified by their internal user ID).
 	 * Useful for viewing another user's predictions from the leaderboard.