@smartico/public-api 0.0.138 → 0.0.140

package/docs/classes/WSAPI.md

@@ -201,7 +201,7 @@ ___
 
 ### getStorePurchasedItems
 
-▸ **getStorePurchasedItems**(): `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
+▸ **getStorePurchasedItems**(`«destructured»?`): `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
 
 Returns purchased items based on the provided parameters. "Limit" and "offset" indicate the range of items to be fetched. 
 The maximum number of items per request is limited to 20. 
@@ -210,9 +210,18 @@ Example usage:
 ```
 _smartico.api.getStorePurchasedItems().then((result) => {
      console.log(result);
- });
+});
 ```
 
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `limit?` | `number` |
+| › `offset?` | `number` |
+| › `onUpdate?` | (`data`: [`TStoreItem`](../interfaces/TStoreItem.md)[]) => `void` |
+
 #### Returns
 
 `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>

package/docs/interfaces/JackPotWinner.md

@@ -6,26 +6,36 @@
 
 • **is\_me**: `boolean`
 
+Flag indicating that this winner is the currently logged in user
+
 ___
 
 ### public\_username
 
 • **public\_username**: `string`
 
+Name of the winner, note that for all users except is_me, the name is masked by default, but masking can be disabled by request to Smartico AM team
+
 ___
 
 ### winning\_amount\_jp\_currency
 
 • **winning\_amount\_jp\_currency**: `number`
 
+Won amount in the Jackpot currency
+
 ___
 
 ### winning\_amount\_wallet\_currency
 
 • **winning\_amount\_wallet\_currency**: `number`
 
+Won amount in the user Wallet currency
+
 ___
 
 ### winning\_position
 
 • **winning\_position**: `number`
+
+Position of the winner. Relevant for jackpots where there could be multiple winners

package/docs/interfaces/TStoreItem.md

@@ -38,9 +38,9 @@ ___
 
 ### type
 
-• **type**: ``"manual"`` \| ``"bonus"``
+• **type**: ``"unknown"`` \| ``"bonus"`` \| ``"tangible"`` \| ``"minigamespin"`` \| ``"changelevel"`` \| ``"prizedrop"``
 
-Type of the store item. Can be 'bonus' or 'manual'. Manual, means it's tangible item, e.g. iPhone
+Type of the store item. Can be 'bonus' or 'tangible' or different others.
 
 ___
 

package/package.json

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

package/src/Jackpots/JackPotWinner.ts

@@ -1,10 +1,15 @@
 
 interface JackPotWinner {
+    /** Flag indicating that this winner is the currently logged in user */
     is_me: boolean;
+    /** Name of the winner, note that for all users except is_me, the name is masked by default, but masking can be disabled by request to Smartico AM team */
     public_username: string; // masked for all except "is_me"
+    /** Won amount in the Jackpot currency */
     winning_amount_jp_currency: number;
+    /** Won amount in the user Wallet currency */
     winning_amount_wallet_currency: number;
-    winning_position: number
+    /** Position of the winner. Relevant for jackpots where there could be multiple winners */
+    winning_position: number;
 }
 
 export { JackPotWinner }

package/src/Missions/AchievementStatus.ts

@@ -5,5 +5,6 @@ export enum AchievementStatus {
     AvailableLocked = 3,
     Archived = 4,
     FeaturedManually = 5,
-    FeaturedAI = 6
+    FeaturedAI = 6,
+    Recurring = 7
 }

package/src/SmarticoAPI.ts

@@ -173,7 +173,9 @@ class SmarticoAPI {
     private buildMessage<TRequest,TResponse>(user_ext_id: string, cid: ClassId, payload: Partial<TRequest> = {}): TResponse {
 
         const message: ProtocolRequest = {
-            api_key: this.label_api_key,
+            // AA: in fact we need api and brand keys and ext_user_id only in the context of HTTP
+            // its not needed in WebSocket and can be deleted
+            api_key: this.label_api_key, 
             brand_key: this.brand_api_key,
             ext_user_id: user_ext_id,
             cid,

package/src/Store/StoreItem.ts

@@ -1,6 +1,6 @@
 import { TStoreItem } from "../WSAPI/WSAPITypes";
 import { StoreItemPublicMeta } from "./StoreItemPublicMeta";
-import { StoreItemType } from "./StoreItemType";
+import { StoreItemType, StoreItemTypeNamed } from "./StoreItemType";
 
 export interface StoreItem {
     id: number;
@@ -23,15 +23,10 @@ export const StoreItemTransform = (items: StoreItem[]): TStoreItem[] => {
             description: r.itemPublicMeta.description,
             ribbon: r.itemPublicMeta.label_tag === 'custom' ? r.itemPublicMeta.custom_label_tag : r.itemPublicMeta.label_tag,
             limit_message: r.itemPublicMeta.limit_message,
-            priority: r.itemPublicMeta.priority,
+            priority: r.itemPublicMeta.priority ?? 0,
             related_item_ids: r.itemPublicMeta.related_items,
             hint_text: r.itemPublicMeta.hint_text,
-
-            type: {
-                [StoreItemType.Bonus]: 'bonus',
-                [StoreItemType.Manual]: 'manual'
-            }[r.itemTypeId] as 'bonus' | 'manual',
-
+            type: StoreItemTypeNamed(r.itemTypeId),
             can_buy: r.canBuy,
             category_ids: r.categoryIds ?? [],
             pool: r.shopPool,

package/src/Store/StoreItemPurchased.ts

@@ -1,7 +1,7 @@
 import { IntUtils } from "../IntUtils";
 import { TStoreItem } from "../WSAPI/WSAPITypes";
 import { StoreItem } from "./StoreItem";
-import { StoreItemType } from "./StoreItemType";
+import { StoreItemTypeNamed } from "./StoreItemType";
 
 interface StoreItemPurchased extends StoreItem {
     purchase_ts: number;
@@ -26,15 +26,10 @@ export const StoreItemPurchasedTransform = (items: StoreItemPurchased[]): TStore
             description: r.itemPublicMeta.description,
             ribbon: r.itemPublicMeta.label_tag === 'custom' ? r.itemPublicMeta.custom_label_tag : r.itemPublicMeta.label_tag,
             limit_message: r.itemPublicMeta.limit_message,
-            priority: r.itemPublicMeta.priority,
+            priority: r.itemPublicMeta.priority ?? 0,
             related_item_ids: r.itemPublicMeta.related_items,
             hint_text: r.itemPublicMeta.hint_text,
-
-            type: {
-                [StoreItemType.Bonus]: 'bonus',
-                [StoreItemType.Manual]: 'manual'
-            }[r.itemTypeId] as 'bonus' | 'manual',
-
+            type: StoreItemTypeNamed(r.itemTypeId),
             can_buy: r.canBuy,
             category_ids: r.categoryIds ?? [],
             pool: r.shopPool,
@@ -44,6 +39,7 @@ export const StoreItemPurchasedTransform = (items: StoreItemPurchased[]): TStore
             purchased_this_week: purchasedThisWeek,
             purchased_this_month: purchasedThisMonth,
         }
+
         return x;
     });
 

package/src/Store/StoreItemType.ts

@@ -1,5 +1,27 @@
 export enum StoreItemType {
     Bonus = 1,
-    Manual = 2
+    Tangible = 2,
+    MiniGameSpin = 3,
+    ChangeLevel = 4,
+    PrizeDrop = 5,
+}
+
+export enum StoreItemTypeName {
+    Bonus = "bonus",
+    Tangible = "tangible",
+    MiniGameSpin = "minigamespin",
+    ChangeLevel = "changelevel",
+    PrizeDrop = "prizedrop",
+    Unknown = "unknown"
+}
+
+export const StoreItemTypeNamed = (type: StoreItemType): StoreItemTypeName => {
+    return {
+        [StoreItemType.Bonus]: StoreItemTypeName.Bonus,
+        [StoreItemType.Tangible]: StoreItemTypeName.Bonus,
+        [StoreItemType.MiniGameSpin]: StoreItemTypeName.MiniGameSpin,
+        [StoreItemType.ChangeLevel]: StoreItemTypeName.ChangeLevel,
+        [StoreItemType.PrizeDrop]: StoreItemTypeName.PrizeDrop,
+    }[type] || StoreItemTypeName.Unknown;
 }
 

package/src/WSAPI/WSAPI.ts

@@ -5,7 +5,7 @@ import { ECacheContext, OCache } from "../OCache";
 import { SmarticoAPI } from "../SmarticoAPI";
 import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionClaimRewardResult, TMissionOptInResult, TMissionOrBadge, TSegmentCheckResult, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile, UserLevelExtraCountersT } from "./WSAPITypes";
 import { LeaderBoardPeriodType } from "../Leaderboard";
-import { JackpotDetails, JackpotPot, JackpotWinPush, JackpotsOptinResponse, JackpotsOptoutResponse } from "../Jackpots";
+import { JackpotDetails, JackpotPot, JackpotWinPush, JackpotsOptinResponse, JackpotsOptoutRequest, JackpotsOptoutResponse } from "../Jackpots";
  
 /** @hidden */
 const CACHE_DATA_SEC = 30;
@@ -51,6 +51,8 @@ export class WSAPI {
         on(ClassId.LOGOUT_RESPONSE, () => OCache.clearContext(ECacheContext.WSAPI));
         on(ClassId.IDENTIFY_RESPONSE, () => OCache.clearContext(ECacheContext.WSAPI));
         on(ClassId.JP_WIN_PUSH, (data: JackpotWinPush) => this.jackpotClearCache());
+        on(ClassId.JP_OPTOUT_RESPONSE, (data: JackpotsOptoutRequest) => this.jackpotClearCache());
+        on(ClassId.JP_OPTIN_RESPONSE, (data: JackpotsOptinResponse) => this.jackpotClearCache());
     }
 
     /** Returns information about current user
@@ -513,8 +515,6 @@ export class WSAPI {
 
         const result = await this.api.jackpotOptIn(null, filter);
 
-        this.jackpotClearCache();
-
         return result;
     }
 
@@ -535,8 +535,6 @@ export class WSAPI {
 
         const result = await this.api.jackpotOptOut(null, filter);
 
-        this.jackpotClearCache();
-
         return result;
     }
 }

package/src/WSAPI/WSAPITypes.ts

@@ -355,8 +355,8 @@ export interface TStoreItem {
     description: string;
     /** URL of the image of the store item */
     image: string;    
-    /** Type of the store item. Can be 'bonus' or 'manual'. Manual, means it's tangible item, e.g. iPhone */
-    type: 'bonus' | 'manual';
+    /** Type of the store item. Can be 'bonus' or 'tangible' or different others. */
+    type: 'bonus' | 'tangible' | 'minigamespin' | 'changelevel' | 'prizedrop' | "unknown";
     /** The price of the store item in the gamification points */
     price: number;
     /** The ribbon of the store item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon */