@smartico/public-api 0.0.137 → 0.0.139

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -83,8 +83,8 @@ declare class SmarticoAPI {
83
83
  storeGetItemsT(user_ext_id: string): Promise<TStoreItem[]>;
84
84
  storeGetCategories(user_ext_id: string): Promise<GetCategoriesStoreResponse>;
85
85
  storeGetCategoriesT(user_ext_id: string): Promise<TStoreCategory[]>;
86
- storeGetPurchasedItems(user_ext_id: string): Promise<GetStoreHistoryResponse>;
87
- storeGetPurchasedItemsT(user_ext_id: string): Promise<TStoreItem[]>;
86
+ storeGetPurchasedItems(user_ext_id: string, limit?: number, offset?: number): Promise<GetStoreHistoryResponse>;
87
+ storeGetPurchasedItemsT(user_ext_id: string, limit?: number, offset?: number): Promise<TStoreItem[]>;
88
88
  missionsGetItems(user_ext_id: string): Promise<GetAchievementMapResponse>;
89
89
  missionsGetItemsT(user_ext_id: string): Promise<TMissionOrBadge[]>;
90
90
  getUserGamificationInfo(user_ext_id: string): Promise<GetAchievementsUserInfoResponse>;
@@ -1,5 +1,5 @@
1
1
  import { ProtocolMessage } from "../Base/ProtocolMessage";
2
2
  export interface GetStoreHistoryRequest extends ProtocolMessage {
3
- offset?: number;
4
3
  limit?: number;
4
+ offset?: number;
5
5
  }
@@ -2,5 +2,5 @@ import { ProtocolResponse } from "../Base/ProtocolResponse";
2
2
  import { StoreItemPurchased } from "./StoreItemPurchased";
3
3
  export interface GetStoreHistoryResponse extends ProtocolResponse {
4
4
  items: StoreItemPurchased[];
5
- hasMore: boolean;
5
+ hasMore?: boolean;
6
6
  }
@@ -1,4 +1,16 @@
1
1
  export declare enum StoreItemType {
2
2
  Bonus = 1,
3
- Manual = 2
3
+ Tangible = 2,
4
+ MiniGameSpin = 3,
5
+ ChangeLevel = 4,
6
+ PrizeDrop = 5
4
7
  }
8
+ export declare enum StoreItemTypeName {
9
+ Bonus = "bonus",
10
+ Tangible = "tangible",
11
+ MiniGameSpin = "minigamespin",
12
+ ChangeLevel = "changelevel",
13
+ PrizeDrop = "prizedrop",
14
+ Unknown = "unknown"
15
+ }
16
+ export declare const StoreItemTypeNamed: (type: StoreItemType) => StoreItemTypeName;
@@ -93,15 +93,21 @@ export declare class WSAPI {
93
93
  buyStoreItem(item_id: number): Promise<TBuyStoreItemResult>;
94
94
  /** Returns store categories */
95
95
  getStoreCategories(): Promise<TStoreCategory[]>;
96
- /** Returns all the purchased store items available the current user
97
- * Example usage:
98
- * ```
99
- * _smartico.api.getStorePurchasedItems().then((result) => {
100
- * console.log(result);
101
- * });
102
- * ```
103
- */
104
- getStorePurchasedItems(): Promise<TStoreItem[]>;
96
+ /** Returns purchased items based on the provided parameters. "Limit" and "offset" indicate the range of items to be fetched.
97
+ * The maximum number of items per request is limited to 20.
98
+ * You can leave this params empty and by default it will return list of purchased items ranging from 0 to 20.
99
+ * Example usage:
100
+ * ```
101
+ * _smartico.api.getStorePurchasedItems().then((result) => {
102
+ * console.log(result);
103
+ * });
104
+ * ```
105
+ */
106
+ getStorePurchasedItems({ limit, offset, onUpdate }?: {
107
+ limit?: number;
108
+ offset?: number;
109
+ onUpdate?: (data: TStoreItem[]) => void;
110
+ }): Promise<TStoreItem[]>;
105
111
  /** Returns missions & badges categories */
106
112
  getAchCategories(): Promise<TAchCategory[]>;
107
113
  /** Returns the list of mini-games available for user
@@ -307,8 +307,8 @@ export interface TStoreItem {
307
307
  description: string;
308
308
  /** URL of the image of the store item */
309
309
  image: string;
310
- /** Type of the store item. Can be 'bonus' or 'manual'. Manual, means it's tangible item, e.g. iPhone */
311
- type: 'bonus' | 'manual';
310
+ /** Type of the store item. Can be 'bonus' or 'tangible' or different others. */
311
+ type: 'bonus' | 'tangible' | 'minigamespin' | 'changelevel' | 'prizedrop' | "unknown";
312
312
  /** The price of the store item in the gamification points */
313
313
  price: number;
314
314
  /** The ribbon of the store item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon */
package/dist/index.js CHANGED
@@ -672,14 +672,30 @@ var StoreCategoryTransform = function StoreCategoryTransform(items) {
672
672
  exports.StoreItemType = void 0;
673
673
  (function (StoreItemType) {
674
674
  StoreItemType[StoreItemType["Bonus"] = 1] = "Bonus";
675
- StoreItemType[StoreItemType["Manual"] = 2] = "Manual";
675
+ StoreItemType[StoreItemType["Tangible"] = 2] = "Tangible";
676
+ StoreItemType[StoreItemType["MiniGameSpin"] = 3] = "MiniGameSpin";
677
+ StoreItemType[StoreItemType["ChangeLevel"] = 4] = "ChangeLevel";
678
+ StoreItemType[StoreItemType["PrizeDrop"] = 5] = "PrizeDrop";
676
679
  })(exports.StoreItemType || (exports.StoreItemType = {}));
680
+ exports.StoreItemTypeName = void 0;
681
+ (function (StoreItemTypeName) {
682
+ StoreItemTypeName["Bonus"] = "bonus";
683
+ StoreItemTypeName["Tangible"] = "tangible";
684
+ StoreItemTypeName["MiniGameSpin"] = "minigamespin";
685
+ StoreItemTypeName["ChangeLevel"] = "changelevel";
686
+ StoreItemTypeName["PrizeDrop"] = "prizedrop";
687
+ StoreItemTypeName["Unknown"] = "unknown";
688
+ })(exports.StoreItemTypeName || (exports.StoreItemTypeName = {}));
689
+ var StoreItemTypeNamed = function StoreItemTypeNamed(type) {
690
+ var _StoreItemType$Bonus$;
691
+ return (_StoreItemType$Bonus$ = {}, _StoreItemType$Bonus$[exports.StoreItemType.Bonus] = exports.StoreItemTypeName.Bonus, _StoreItemType$Bonus$[exports.StoreItemType.Tangible] = exports.StoreItemTypeName.Bonus, _StoreItemType$Bonus$[exports.StoreItemType.MiniGameSpin] = exports.StoreItemTypeName.MiniGameSpin, _StoreItemType$Bonus$[exports.StoreItemType.ChangeLevel] = exports.StoreItemTypeName.ChangeLevel, _StoreItemType$Bonus$[exports.StoreItemType.PrizeDrop] = exports.StoreItemTypeName.PrizeDrop, _StoreItemType$Bonus$)[type] || exports.StoreItemTypeName.Unknown;
692
+ };
677
693
 
678
694
  var StoreItemTransform = function StoreItemTransform(items) {
679
695
  return items.filter(function (r) {
680
696
  return r.id >= 1;
681
697
  }).map(function (r) {
682
- var _StoreItemType$Bonus$, _r$categoryIds;
698
+ var _r$itemPublicMeta$pri, _r$categoryIds;
683
699
  var x = {
684
700
  id: r.id,
685
701
  name: r.itemPublicMeta.name,
@@ -688,10 +704,10 @@ var StoreItemTransform = function StoreItemTransform(items) {
688
704
  description: r.itemPublicMeta.description,
689
705
  ribbon: r.itemPublicMeta.label_tag === 'custom' ? r.itemPublicMeta.custom_label_tag : r.itemPublicMeta.label_tag,
690
706
  limit_message: r.itemPublicMeta.limit_message,
691
- priority: r.itemPublicMeta.priority,
707
+ priority: (_r$itemPublicMeta$pri = r.itemPublicMeta.priority) != null ? _r$itemPublicMeta$pri : 0,
692
708
  related_item_ids: r.itemPublicMeta.related_items,
693
709
  hint_text: r.itemPublicMeta.hint_text,
694
- type: (_StoreItemType$Bonus$ = {}, _StoreItemType$Bonus$[exports.StoreItemType.Bonus] = 'bonus', _StoreItemType$Bonus$[exports.StoreItemType.Manual] = 'manual', _StoreItemType$Bonus$)[r.itemTypeId],
710
+ type: StoreItemTypeNamed(r.itemTypeId),
695
711
  can_buy: r.canBuy,
696
712
  category_ids: (_r$categoryIds = r.categoryIds) != null ? _r$categoryIds : [],
697
713
  pool: r.shopPool
@@ -704,7 +720,7 @@ var StoreItemPurchasedTransform = function StoreItemPurchasedTransform(items) {
704
720
  return items.filter(function (r) {
705
721
  return r.id >= 1;
706
722
  }).map(function (r) {
707
- var _StoreItemType$Bonus$, _r$categoryIds;
723
+ var _r$itemPublicMeta$pri, _r$categoryIds;
708
724
  var purchasedToday = r.purchase_ts ? IntUtils.isWithinPeriod(r.purchase_ts, 'today') : false;
709
725
  var purchasedThisWeek = r.purchase_ts ? IntUtils.isWithinPeriod(r.purchase_ts, 'thisWeek') : false;
710
726
  var purchasedThisMonth = r.purchase_ts ? IntUtils.isWithinPeriod(r.purchase_ts, 'thisMonth') : false;
@@ -716,10 +732,10 @@ var StoreItemPurchasedTransform = function StoreItemPurchasedTransform(items) {
716
732
  description: r.itemPublicMeta.description,
717
733
  ribbon: r.itemPublicMeta.label_tag === 'custom' ? r.itemPublicMeta.custom_label_tag : r.itemPublicMeta.label_tag,
718
734
  limit_message: r.itemPublicMeta.limit_message,
719
- priority: r.itemPublicMeta.priority,
735
+ priority: (_r$itemPublicMeta$pri = r.itemPublicMeta.priority) != null ? _r$itemPublicMeta$pri : 0,
720
736
  related_item_ids: r.itemPublicMeta.related_items,
721
737
  hint_text: r.itemPublicMeta.hint_text,
722
- type: (_StoreItemType$Bonus$ = {}, _StoreItemType$Bonus$[exports.StoreItemType.Bonus] = 'bonus', _StoreItemType$Bonus$[exports.StoreItemType.Manual] = 'manual', _StoreItemType$Bonus$)[r.itemTypeId],
738
+ type: StoreItemTypeNamed(r.itemTypeId),
723
739
  can_buy: r.canBuy,
724
740
  category_ids: (_r$categoryIds = r.categoryIds) != null ? _r$categoryIds : [],
725
741
  pool: r.shopPool,
@@ -1347,7 +1363,9 @@ var WSAPI = /*#__PURE__*/function () {
1347
1363
  return Promise.reject(e);
1348
1364
  }
1349
1365
  }
1350
- /** Returns all the purchased store items available the current user
1366
+ /** Returns purchased items based on the provided parameters. "Limit" and "offset" indicate the range of items to be fetched.
1367
+ * The maximum number of items per request is limited to 20.
1368
+ * You can leave this params empty and by default it will return list of purchased items ranging from 0 to 20.
1351
1369
  * Example usage:
1352
1370
  * ```
1353
1371
  * _smartico.api.getStorePurchasedItems().then((result) => {
@@ -1356,11 +1374,18 @@ var WSAPI = /*#__PURE__*/function () {
1356
1374
  * ```
1357
1375
  */
1358
1376
  ;
1359
- _proto.getStorePurchasedItems = function getStorePurchasedItems() {
1377
+ _proto.getStorePurchasedItems = function getStorePurchasedItems(_temp2) {
1378
+ var _ref2 = _temp2 === void 0 ? {} : _temp2,
1379
+ limit = _ref2.limit,
1380
+ offset = _ref2.offset,
1381
+ onUpdate = _ref2.onUpdate;
1360
1382
  try {
1361
1383
  var _this11 = this;
1362
- return Promise.resolve(OCache.use(onUpdateContextKey.StoreItems, exports.ECacheContext.WSAPI, function () {
1363
- return _this11.api.storeGetPurchasedItemsT(null);
1384
+ if (onUpdate) {
1385
+ _this11.onUpdateCallback.set(onUpdateContextKey.StoreHistory, onUpdate);
1386
+ }
1387
+ return Promise.resolve(OCache.use(onUpdateContextKey.StoreHistory, exports.ECacheContext.WSAPI, function () {
1388
+ return _this11.api.storeGetPurchasedItemsT(null, limit, offset);
1364
1389
  }, CACHE_DATA_SEC));
1365
1390
  } catch (e) {
1366
1391
  return Promise.reject(e);
@@ -1384,9 +1409,9 @@ var WSAPI = /*#__PURE__*/function () {
1384
1409
  * @param params
1385
1410
  */
1386
1411
  ;
1387
- _proto.getMiniGames = function getMiniGames(_temp2) {
1388
- var _ref2 = _temp2 === void 0 ? {} : _temp2,
1389
- onUpdate = _ref2.onUpdate;
1412
+ _proto.getMiniGames = function getMiniGames(_temp3) {
1413
+ var _ref3 = _temp3 === void 0 ? {} : _temp3,
1414
+ onUpdate = _ref3.onUpdate;
1390
1415
  try {
1391
1416
  var _this13 = this;
1392
1417
  if (onUpdate) {
@@ -1450,9 +1475,9 @@ var WSAPI = /*#__PURE__*/function () {
1450
1475
  * @param params
1451
1476
  */
1452
1477
  ;
1453
- _proto.getTournamentsList = function getTournamentsList(_temp3) {
1454
- var _ref3 = _temp3 === void 0 ? {} : _temp3,
1455
- onUpdate = _ref3.onUpdate;
1478
+ _proto.getTournamentsList = function getTournamentsList(_temp4) {
1479
+ var _ref4 = _temp4 === void 0 ? {} : _temp4,
1480
+ onUpdate = _ref4.onUpdate;
1456
1481
  try {
1457
1482
  var _this17 = this;
1458
1483
  if (onUpdate) {
@@ -1512,12 +1537,12 @@ var WSAPI = /*#__PURE__*/function () {
1512
1537
  * @param params
1513
1538
  */
1514
1539
  ;
1515
- _proto.getInboxMessages = function getInboxMessages(_temp4) {
1516
- var _ref4 = _temp4 === void 0 ? {} : _temp4,
1517
- from = _ref4.from,
1518
- to = _ref4.to,
1519
- onlyFavorite = _ref4.onlyFavorite,
1520
- onUpdate = _ref4.onUpdate;
1540
+ _proto.getInboxMessages = function getInboxMessages(_temp5) {
1541
+ var _ref5 = _temp5 === void 0 ? {} : _temp5,
1542
+ from = _ref5.from,
1543
+ to = _ref5.to,
1544
+ onlyFavorite = _ref5.onlyFavorite,
1545
+ onUpdate = _ref5.onUpdate;
1521
1546
  try {
1522
1547
  var _this21 = this;
1523
1548
  if (onUpdate) {
@@ -1642,7 +1667,7 @@ var WSAPI = /*#__PURE__*/function () {
1642
1667
  _proto.updateOnPrizeWin = function updateOnPrizeWin(data) {
1643
1668
  try {
1644
1669
  var _this31 = this;
1645
- var _temp6 = function () {
1670
+ var _temp7 = function () {
1646
1671
  if (data.errCode === exports.SAWSpinErrorCode.SAW_OK) {
1647
1672
  return Promise.resolve(OCache.use(onUpdateContextKey.Saw, exports.ECacheContext.WSAPI, function () {
1648
1673
  return _this31.api.sawGetTemplatesT(null);
@@ -1656,18 +1681,18 @@ var WSAPI = /*#__PURE__*/function () {
1656
1681
  var prizeType = (_template$prizes$find = template.prizes.find(function (p) {
1657
1682
  return p.id === data.saw_prize_id;
1658
1683
  })) == null ? void 0 : _template$prizes$find.prize_type;
1659
- var _temp5 = function () {
1684
+ var _temp6 = function () {
1660
1685
  if (template.jackpot_add_on_attempt || template.spin_count === 1 || prizeType === exports.MiniGamePrizeTypeName.JACKPOT || prizeType === exports.MiniGamePrizeTypeName.SPIN) {
1661
1686
  return Promise.resolve(_this31.api.sawGetTemplatesT(null)).then(function (updatedTemplates) {
1662
1687
  _this31.updateEntity(onUpdateContextKey.Saw, updatedTemplates);
1663
1688
  });
1664
1689
  }
1665
1690
  }();
1666
- if (_temp5 && _temp5.then) return _temp5.then(function () {});
1691
+ if (_temp6 && _temp6.then) return _temp6.then(function () {});
1667
1692
  });
1668
1693
  }
1669
1694
  }();
1670
- return Promise.resolve(_temp6 && _temp6.then ? _temp6.then(function () {}) : void 0);
1695
+ return Promise.resolve(_temp7 && _temp7.then ? _temp7.then(function () {}) : void 0);
1671
1696
  } catch (e) {
1672
1697
  return Promise.reject(e);
1673
1698
  }
@@ -1759,7 +1784,7 @@ var WSAPI = /*#__PURE__*/function () {
1759
1784
  return Promise.reject(e);
1760
1785
  }
1761
1786
  }, JACKPOT_TEMPLATE_CACHE_SEC)).then(function (_OCache$use) {
1762
- function _temp8() {
1787
+ function _temp9() {
1763
1788
  return jackpots.map(function (jp) {
1764
1789
  var _jp = _extends({}, jp, {
1765
1790
  pot: pots.find(function (p) {
@@ -1770,7 +1795,7 @@ var WSAPI = /*#__PURE__*/function () {
1770
1795
  });
1771
1796
  }
1772
1797
  jackpots = _OCache$use;
1773
- var _temp7 = function () {
1798
+ var _temp8 = function () {
1774
1799
  if (jackpots.length > 0) {
1775
1800
  return Promise.resolve(OCache.use(onUpdateContextKey.Pots, exports.ECacheContext.WSAPI, function () {
1776
1801
  try {
@@ -1788,7 +1813,7 @@ var WSAPI = /*#__PURE__*/function () {
1788
1813
  });
1789
1814
  }
1790
1815
  }();
1791
- return _temp7 && _temp7.then ? _temp7.then(_temp8) : _temp8(_temp7);
1816
+ return _temp8 && _temp8.then ? _temp8.then(_temp9) : _temp9(_temp8);
1792
1817
  });
1793
1818
  } catch (e) {
1794
1819
  return Promise.reject(e);
@@ -2409,19 +2434,28 @@ var SmarticoAPI = /*#__PURE__*/function () {
2409
2434
  return Promise.reject(e);
2410
2435
  }
2411
2436
  };
2412
- _proto.storeGetPurchasedItems = function storeGetPurchasedItems(user_ext_id) {
2437
+ _proto.storeGetPurchasedItems = function storeGetPurchasedItems(user_ext_id, limit, offset) {
2438
+ if (limit === void 0) {
2439
+ limit = 20;
2440
+ }
2441
+ if (offset === void 0) {
2442
+ offset = 0;
2443
+ }
2413
2444
  try {
2414
2445
  var _this25 = this;
2415
- var message = _this25.buildMessage(user_ext_id, exports.ClassId.ACH_SHOP_ITEM_HISTORY_REQUEST);
2446
+ var message = _this25.buildMessage(user_ext_id, exports.ClassId.ACH_SHOP_ITEM_HISTORY_REQUEST, {
2447
+ limit: limit,
2448
+ offset: offset
2449
+ });
2416
2450
  return Promise.resolve(_this25.send(message, exports.ClassId.ACH_SHOP_ITEM_HISTORY_RESPONSE));
2417
2451
  } catch (e) {
2418
2452
  return Promise.reject(e);
2419
2453
  }
2420
2454
  };
2421
- _proto.storeGetPurchasedItemsT = function storeGetPurchasedItemsT(user_ext_id) {
2455
+ _proto.storeGetPurchasedItemsT = function storeGetPurchasedItemsT(user_ext_id, limit, offset) {
2422
2456
  try {
2423
2457
  var _this26 = this;
2424
- return Promise.resolve(_this26.storeGetPurchasedItems(user_ext_id)).then(function (_this26$storeGetPurch) {
2458
+ return Promise.resolve(_this26.storeGetPurchasedItems(user_ext_id, limit, offset)).then(function (_this26$storeGetPurch) {
2425
2459
  return StoreItemPurchasedTransform(_this26$storeGetPurch.items);
2426
2460
  });
2427
2461
  } catch (e) {
@@ -3167,6 +3201,7 @@ exports.SmarticoAPI = SmarticoAPI;
3167
3201
  exports.StoreCategoryTransform = StoreCategoryTransform;
3168
3202
  exports.StoreItemPurchasedTransform = StoreItemPurchasedTransform;
3169
3203
  exports.StoreItemTransform = StoreItemTransform;
3204
+ exports.StoreItemTypeNamed = StoreItemTypeNamed;
3170
3205
  exports.TournamentInstanceStatusName = TournamentInstanceStatusName;
3171
3206
  exports.TournamentItemsTransform = TournamentItemsTransform;
3172
3207
  exports.TournamentRegistrationStatusNamed = TournamentRegistrationStatusNamed;