@smartico/public-api 0.0.275 → 0.0.277

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.
Files changed (56) hide show
  1. package/dist/Core/ActivityTypeLimited.d.ts +3 -0
  2. package/dist/Jackpots/JackpotPot.d.ts +8 -10
  3. package/dist/MiniGames/SAWPrize.d.ts +3 -0
  4. package/dist/Raffle/GetDrawRunResponse.d.ts +1 -0
  5. package/dist/Raffle/GetRaffleDrawRunsHistoryResponse.d.ts +1 -0
  6. package/dist/Raffle/GetRafflesResponse.d.ts +5 -0
  7. package/dist/Raffle/Raffle.d.ts +1 -1
  8. package/dist/Raffle/RaffleClaimPrizeResponse.d.ts +1 -0
  9. package/dist/Raffle/RafflePrize.d.ts +1 -1
  10. package/dist/Raffle/index.d.ts +1 -0
  11. package/dist/Tournaments/TournamentPrize.d.ts +2 -0
  12. package/dist/Tournaments/TournamentUtils.d.ts +2 -0
  13. package/dist/WSAPI/WSAPITypes.d.ts +2 -2
  14. package/dist/index.js +22 -9
  15. package/dist/index.js.map +1 -1
  16. package/dist/index.modern.mjs +27 -8
  17. package/dist/index.modern.mjs.map +1 -1
  18. package/docs/README.md +11 -128
  19. package/docs/classes/WSAPI.md +1 -1
  20. package/docs/enums/AchCustomSectionType.md +67 -0
  21. package/docs/enums/BuyStoreItemErrorCode.md +2 -2
  22. package/docs/enums/InboxCategories.md +19 -0
  23. package/docs/enums/JackPotTemparature.md +33 -0
  24. package/docs/enums/PrizeModifiers.md +49 -0
  25. package/docs/enums/SAWAcknowledgeTypeName.md +25 -0
  26. package/docs/enums/SAWAskForUsername.md +13 -0
  27. package/docs/enums/SAWGameLayout.md +13 -0
  28. package/docs/enums/SAWSpinErrorCode.md +2 -2
  29. package/docs/interfaces/JackpotPot.md +1 -4
  30. package/docs/interfaces/Raffle.md +1 -1
  31. package/docs/interfaces/RaffleDraw.md +1 -1
  32. package/docs/interfaces/RaffleDrawPublicMeta.md +65 -0
  33. package/docs/interfaces/RaffleDrawRun.md +1 -1
  34. package/docs/interfaces/RafflePrize.md +1 -1
  35. package/docs/interfaces/RafflePrizePublicMeta.md +25 -0
  36. package/docs/interfaces/RafflePublicMeta.md +59 -0
  37. package/docs/interfaces/SAWTemplateUI.md +284 -0
  38. package/docs/interfaces/TInboxMessage.md +1 -1
  39. package/docs/interfaces/TMiniGamePrize.md +2 -2
  40. package/docs/interfaces/TMiniGameTemplate.md +1 -1
  41. package/docs/interfaces/TUICustomSection.md +1 -1
  42. package/package.json +1 -1
  43. package/src/Core/ActivityTypeLimited.ts +3 -0
  44. package/src/Jackpots/JackpotPot.ts +8 -10
  45. package/src/MiniGames/SAWPrize.ts +1 -0
  46. package/src/Raffle/GetDrawRunResponse.ts +1 -1
  47. package/src/Raffle/GetRaffleDrawRunsHistoryResponse.ts +1 -0
  48. package/src/Raffle/GetRafflesResponse.ts +5 -0
  49. package/src/Raffle/Raffle.ts +1 -1
  50. package/src/Raffle/RaffleClaimPrizeResponse.ts +1 -1
  51. package/src/Raffle/RafflePrize.ts +1 -1
  52. package/src/Raffle/index.ts +1 -0
  53. package/src/SmarticoAPI.ts +5 -2
  54. package/src/Tournaments/TournamentPrize.ts +2 -0
  55. package/src/Tournaments/TournamentUtils.ts +3 -0
  56. package/src/WSAPI/WSAPITypes.ts +5 -3
@@ -6,6 +6,9 @@ export declare enum ActivityTypeLimited {
6
6
  MiniGameAttempt = 16,
7
7
  DeductPoints = 21,
8
8
  ResetPoints = 22,
9
+ AddGemsAndDiamonds = 25,
10
+ DeductGemsAndDiamonds = 26,
11
+ ResetGemsAndDiamonds = 27,
9
12
  Popup = 30,
10
13
  Inbox = 31,
11
14
  Slack = 70,
@@ -1,10 +1,12 @@
1
1
  declare enum JackPotTemparature {
2
- /** cold */
2
+ /** cold, seed amount < current pot < (min amount - seed amount)/2 */
3
3
  COLD = 0,
4
- /** warm */
4
+ /** warm, (min amount - seed amount)/2 < current pot < min amount */
5
5
  WARM = 1,
6
- /** hot */
7
- HOT = 2
6
+ /** hot, current pot > min amount, entered explosion range */
7
+ HOT = 2,
8
+ /** burning, current pot > min amount + 0.5 * (max amount - min amount). E.g. mid of allowed explosion range */
9
+ BURNING = 3
8
10
  }
9
11
  interface JackpotPot {
10
12
  /** ID of the jackpot template */
@@ -17,11 +19,7 @@ interface JackpotPot {
17
19
  current_pot_amount_user_currency: number;
18
20
  /** the date/time when this pot exploded */
19
21
  explode_date_ts: number;
20
- /** current pot temperature
21
- * 0 - cold. seed amount < current pot < (min amount - seed amount)/2
22
- * 1 - warm. (min amount - seed amount)/2 < current pot < min amount
23
- * 2 - hot. current pot > min amount
24
- */
22
+ /** current pot temperature */
25
23
  current_pot_temperature: JackPotTemparature;
26
24
  }
27
- export { JackpotPot };
25
+ export { JackpotPot, JackPotTemparature };
@@ -17,4 +17,7 @@ export interface SAWPrize {
17
17
  relative_period_timezone?: number;
18
18
  is_surcharge?: boolean;
19
19
  is_deleted?: boolean;
20
+ prize_details_json?: {
21
+ [key: string]: any;
22
+ };
20
23
  }
@@ -4,4 +4,5 @@ import { RaffleDraw } from './RaffleDraw';
4
4
  export interface GetDrawRunResponse extends ProtocolResponse {
5
5
  draw: RaffleDraw;
6
6
  }
7
+ /** @hidden */
7
8
  export declare const drawRunTransform: (res: GetDrawRunResponse) => TRaffleDraw;
@@ -4,4 +4,5 @@ import { RaffleDrawRun } from './RaffleDrawRun';
4
4
  export interface GetRaffleDrawRunsHistoryResponse extends ProtocolResponse {
5
5
  draw_runs: RaffleDrawRun[];
6
6
  }
7
+ /** @hidden */
7
8
  export declare const drawRunHistoryTransform: (res: GetRaffleDrawRunsHistoryResponse) => TRaffleDrawRun[];
@@ -8,8 +8,13 @@ import { RaffleTicket } from './RaffleTicket';
8
8
  export interface GetRafflesResponse extends ProtocolResponse {
9
9
  items: Raffle[];
10
10
  }
11
+ /** @hidden */
11
12
  export declare const ticketsTransform: (items: RaffleTicket[]) => TRaffleTicket[];
13
+ /** @hidden */
12
14
  export declare const winnersTransform: (items: RafflePrizeWinner[]) => TRafflePrizeWinner[];
15
+ /** @hidden */
13
16
  export declare const prizeTransform: (items: RafflePrize[]) => TRafflePrize[];
17
+ /** @hidden */
14
18
  export declare const drawTransform: (items: RaffleDraw[]) => TRaffleDraw[];
19
+ /** @hidden */
15
20
  export declare const raffleTransform: (items: Raffle[]) => TRaffle[];
@@ -41,4 +41,4 @@ interface Raffle {
41
41
  */
42
42
  draws: RaffleDraw[];
43
43
  }
44
- export { Raffle };
44
+ export { Raffle, RafflePublicMeta };
@@ -4,4 +4,5 @@ export interface RaffleClaimPrizeResponse extends ProtocolResponse {
4
4
  errCode: number;
5
5
  errMsg?: string;
6
6
  }
7
+ /** @hidden */
7
8
  export declare const raffleClaimPrizeResponseTransform: (info: RaffleClaimPrizeResponse) => TransformedRaffleClaimPrizeResponse;
@@ -98,4 +98,4 @@ interface RafflePrize {
98
98
  should_claim: boolean;
99
99
  winners: RafflePrizeWinner[];
100
100
  }
101
- export { RafflePrize };
101
+ export { RafflePrize, RafflePrizePublicMeta, RafflePrizeWinner };
@@ -12,3 +12,4 @@ export * from './GetRaffleDrawRunsHistoryRequest';
12
12
  export * from './GetRaffleDrawRunsHistoryResponse';
13
13
  export * from './RaffleClaimPrizeRequest';
14
14
  export * from './RaffleClaimPrizeResponse';
15
+ export * from './RaffleDrawPublicMeta';
@@ -7,4 +7,6 @@ export interface TournamentPrize {
7
7
  place_to: number;
8
8
  type: ActivityTypeLimited;
9
9
  points: number;
10
+ gems: number;
11
+ diamonds: number;
10
12
  }
@@ -23,5 +23,7 @@ export declare class TournamentUtils {
23
23
  place_from: number;
24
24
  place_to: number;
25
25
  points: number;
26
+ gems: number;
27
+ diamonds: number;
26
28
  };
27
29
  }
@@ -1,5 +1,5 @@
1
1
  import { BuyStoreItemErrorCode } from '../Store';
2
- import { MiniGamePrizeTypeName, SAWAcknowledgeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode, SAWTemplate, SAWTemplateUI } from '../MiniGames';
2
+ import { MiniGamePrizeTypeName, SAWAcknowledgeTypeName, SAWAskForUsername, SAWBuyInTypeName, SAWGameLayout, SAWGameTypeName, SAWSpinErrorCode, SAWTemplate, SAWTemplateUI } from '../MiniGames';
3
3
  import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from '../Tournaments';
4
4
  import { AchievementAvailabilityStatus } from '../Missions';
5
5
  import { LeaderBoardPeriodType } from '../Leaderboard';
@@ -1076,4 +1076,4 @@ export interface TransformedRaffleClaimPrizeResponse {
1076
1076
  /** Error message, will be exposed only if ErrorCode is not 0 */
1077
1077
  errorMessage?: string;
1078
1078
  }
1079
- export {};
1079
+ export { SAWAcknowledgeTypeName, PrizeModifiers, SAWTemplateUI, InboxCategories, AchCustomSectionType, SAWAskForUsername, SAWGameLayout };
package/dist/index.js CHANGED
@@ -733,6 +733,9 @@ exports.ActivityTypeLimited = void 0;
733
733
  ActivityTypeLimited[ActivityTypeLimited["MiniGameAttempt"] = 16] = "MiniGameAttempt";
734
734
  ActivityTypeLimited[ActivityTypeLimited["DeductPoints"] = 21] = "DeductPoints";
735
735
  ActivityTypeLimited[ActivityTypeLimited["ResetPoints"] = 22] = "ResetPoints";
736
+ ActivityTypeLimited[ActivityTypeLimited["AddGemsAndDiamonds"] = 25] = "AddGemsAndDiamonds";
737
+ ActivityTypeLimited[ActivityTypeLimited["DeductGemsAndDiamonds"] = 26] = "DeductGemsAndDiamonds";
738
+ ActivityTypeLimited[ActivityTypeLimited["ResetGemsAndDiamonds"] = 27] = "ResetGemsAndDiamonds";
736
739
  ActivityTypeLimited[ActivityTypeLimited["Popup"] = 30] = "Popup";
737
740
  ActivityTypeLimited[ActivityTypeLimited["Inbox"] = 31] = "Inbox";
738
741
  ActivityTypeLimited[ActivityTypeLimited["Slack"] = 70] = "Slack";
@@ -1477,7 +1480,7 @@ var TournamentInstanceStatusName = function TournamentInstanceStatusName(s) {
1477
1480
 
1478
1481
  var tournamentPrizeTypeToPrizeName = function tournamentPrizeTypeToPrizeName(type) {
1479
1482
  var _ActivityTypeLimited$;
1480
- return (_ActivityTypeLimited$ = {}, _ActivityTypeLimited$[exports.ActivityTypeLimited.DoNothing] = 'TANGIBLE', _ActivityTypeLimited$[exports.ActivityTypeLimited.Points] = 'POINTS_ADD', _ActivityTypeLimited$[exports.ActivityTypeLimited.DeductPoints] = 'POINTS_DEDUCT', _ActivityTypeLimited$[exports.ActivityTypeLimited.ResetPoints] = 'POINTS_RESET', _ActivityTypeLimited$[exports.ActivityTypeLimited.MiniGameAttempt] = 'MINI_GAME_ATTEMPT', _ActivityTypeLimited$[exports.ActivityTypeLimited.Bonus] = 'BONUS', _ActivityTypeLimited$)[type];
1483
+ return (_ActivityTypeLimited$ = {}, _ActivityTypeLimited$[exports.ActivityTypeLimited.DoNothing] = 'TANGIBLE', _ActivityTypeLimited$[exports.ActivityTypeLimited.Points] = 'POINTS_ADD', _ActivityTypeLimited$[exports.ActivityTypeLimited.DeductPoints] = 'POINTS_DEDUCT', _ActivityTypeLimited$[exports.ActivityTypeLimited.ResetPoints] = 'POINTS_RESET', _ActivityTypeLimited$[exports.ActivityTypeLimited.MiniGameAttempt] = 'MINI_GAME_ATTEMPT', _ActivityTypeLimited$[exports.ActivityTypeLimited.Bonus] = 'BONUS', _ActivityTypeLimited$[exports.ActivityTypeLimited.AddGemsAndDiamonds] = 'GEMS_AND_DIAMONDS_ADD', _ActivityTypeLimited$[exports.ActivityTypeLimited.DeductGemsAndDiamonds] = 'GEMS_AND_DIAMONDS_DEDUCT', _ActivityTypeLimited$[exports.ActivityTypeLimited.ResetGemsAndDiamonds] = 'GEMS_AND_DIAMONDS_RESET', _ActivityTypeLimited$)[type];
1481
1484
  };
1482
1485
  var TournamentUtils = function TournamentUtils() {};
1483
1486
  TournamentUtils.isCanRegister = function (tournament) {
@@ -1665,6 +1668,7 @@ var GetLevelMapResponseTransform = function GetLevelMapResponseTransform(levels)
1665
1668
  });
1666
1669
  };
1667
1670
 
1671
+ /** @hidden */
1668
1672
  var ticketsTransform = function ticketsTransform(items) {
1669
1673
  return items.map(function (item) {
1670
1674
  return {
@@ -1673,6 +1677,7 @@ var ticketsTransform = function ticketsTransform(items) {
1673
1677
  };
1674
1678
  });
1675
1679
  };
1680
+ /** @hidden */
1676
1681
  var winnersTransform = function winnersTransform(items) {
1677
1682
  return items.map(function (item) {
1678
1683
  return {
@@ -1688,6 +1693,7 @@ var winnersTransform = function winnersTransform(items) {
1688
1693
  };
1689
1694
  });
1690
1695
  };
1696
+ /** @hidden */
1691
1697
  var prizeTransform = function prizeTransform(items) {
1692
1698
  return items.map(function (item) {
1693
1699
  return {
@@ -1709,6 +1715,7 @@ var prizeTransform = function prizeTransform(items) {
1709
1715
  };
1710
1716
  });
1711
1717
  };
1718
+ /** @hidden */
1712
1719
  var drawTransform = function drawTransform(items) {
1713
1720
  return items.map(function (item) {
1714
1721
  return {
@@ -1736,6 +1743,7 @@ var drawTransform = function drawTransform(items) {
1736
1743
  };
1737
1744
  });
1738
1745
  };
1746
+ /** @hidden */
1739
1747
  var raffleTransform = function raffleTransform(items) {
1740
1748
  return items.map(function (item) {
1741
1749
  return {
@@ -1755,6 +1763,7 @@ var raffleTransform = function raffleTransform(items) {
1755
1763
  });
1756
1764
  };
1757
1765
 
1766
+ /** @hidden */
1758
1767
  var drawRunTransform = function drawRunTransform(res) {
1759
1768
  return {
1760
1769
  id: res.draw.draw_id,
@@ -1804,6 +1813,7 @@ var RaffleDrawTypeExecution;
1804
1813
  RaffleDrawTypeExecution[RaffleDrawTypeExecution["Grand"] = 2] = "Grand";
1805
1814
  })(RaffleDrawTypeExecution || (RaffleDrawTypeExecution = {}));
1806
1815
 
1816
+ /** @hidden */
1807
1817
  var drawRunHistoryTransform = function drawRunHistoryTransform(res) {
1808
1818
  return res.draw_runs.map(function (item) {
1809
1819
  return {
@@ -1826,6 +1836,7 @@ var drawRunHistoryTransform = function drawRunHistoryTransform(res) {
1826
1836
  });
1827
1837
  };
1828
1838
 
1839
+ /** @hidden */
1829
1840
  var raffleClaimPrizeResponseTransform = function raffleClaimPrizeResponseTransform(info) {
1830
1841
  return {
1831
1842
  errorCode: info.errCode,
@@ -3602,7 +3613,7 @@ var SmarticoAPI = /*#__PURE__*/function () {
3602
3613
  try {
3603
3614
  var tsBaseRQ = _this3.buildMessage(user_ext_id, exports.ClassId.GET_TRANSLATIONS_REQUEST, {
3604
3615
  lang_code: DEFAULT_LANG_EN,
3605
- hash_code: 0,
3616
+ hash_code: null,
3606
3617
  areas: areas
3607
3618
  });
3608
3619
  return Promise.resolve(_this3.send(tsBaseRQ, exports.ClassId.GET_TRANSLATIONS_RESPONSE)).then(function (trBase) {
@@ -3610,7 +3621,7 @@ var SmarticoAPI = /*#__PURE__*/function () {
3610
3621
  if (lang_code !== DEFAULT_LANG_EN) {
3611
3622
  var trUserRQ = _this3.buildMessage(user_ext_id, exports.ClassId.GET_TRANSLATIONS_REQUEST, {
3612
3623
  lang_code: lang_code,
3613
- hash_code: 0,
3624
+ hash_code: null,
3614
3625
  areas: areas
3615
3626
  });
3616
3627
  return Promise.resolve(_this3.send(trUserRQ, exports.ClassId.GET_TRANSLATIONS_RESPONSE)).then(function (trUser) {
@@ -3850,7 +3861,7 @@ var SmarticoAPI = /*#__PURE__*/function () {
3850
3861
  var _SAWSpinErrorCode$SAW;
3851
3862
  // to simulate fail
3852
3863
  // response.errCode = SAWSpinErrorCode.SAW_NO_SPINS;
3853
- var status = (_SAWSpinErrorCode$SAW = {}, _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_OK] = 'OK', _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_NO_SPINS] = 'NO SPINS AVAILABLE', _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_PRIZE_POOL_EMPTY] = 'PRIZE POOL IS EMPTY', _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_NOT_ENOUGH_POINTS] = 'NOT ENOUGH POINTS', _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_FAILED_MAX_SPINS_REACHED] = 'MAX SPIN ATTEMPTS REACHED', _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_TEMPLATE_NOT_ACTIVE] = "MINIGAME IS NOT IN ACTIVE PERIOD", _SAWSpinErrorCode$SAW)[spinAttemptResponse.errCode] || 'OTHER';
3864
+ var status = (_SAWSpinErrorCode$SAW = {}, _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_OK] = 'OK', _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_NO_SPINS] = 'NO SPINS AVAILABLE', _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_PRIZE_POOL_EMPTY] = 'PRIZE POOL IS EMPTY', _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_NOT_ENOUGH_POINTS] = 'NOT ENOUGH POINTS', _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_FAILED_MAX_SPINS_REACHED] = 'MAX SPIN ATTEMPTS REACHED', _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_TEMPLATE_NOT_ACTIVE] = "MINIGAME IS NOT IN ACTIVE PERIOD", _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_NOT_IN_SEGMENT] = "USER IS NOT IN SEGMENT", _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_NO_BALANCE_GEMS] = "NOT ENOUGH GEMS", _SAWSpinErrorCode$SAW[exports.SAWSpinErrorCode.SAW_NO_BALANCE_DIAMONDS] = "NOT ENOUGH DIAMONDS", _SAWSpinErrorCode$SAW)[spinAttemptResponse.errCode] || 'OTHER';
3854
3865
  return Promise.resolve(_this19.coreReportCustomEvent(user_ext_id, 'minigame_attempt', {
3855
3866
  saw_template_id: saw_template_id,
3856
3867
  status: status,
@@ -4936,15 +4947,17 @@ exports.JackpotContributionType = void 0;
4936
4947
  JackpotContributionType[JackpotContributionType["Percentage"] = 2] = "Percentage";
4937
4948
  })(exports.JackpotContributionType || (exports.JackpotContributionType = {}));
4938
4949
 
4939
- var JackPotTemparature;
4950
+ exports.JackPotTemparature = void 0;
4940
4951
  (function (JackPotTemparature) {
4941
- /** cold */
4952
+ /** cold, seed amount < current pot < (min amount - seed amount)/2 */
4942
4953
  JackPotTemparature[JackPotTemparature["COLD"] = 0] = "COLD";
4943
- /** warm */
4954
+ /** warm, (min amount - seed amount)/2 < current pot < min amount */
4944
4955
  JackPotTemparature[JackPotTemparature["WARM"] = 1] = "WARM";
4945
- /** hot */
4956
+ /** hot, current pot > min amount, entered explosion range */
4946
4957
  JackPotTemparature[JackPotTemparature["HOT"] = 2] = "HOT";
4947
- })(JackPotTemparature || (JackPotTemparature = {}));
4958
+ /** burning, current pot > min amount + 0.5 * (max amount - min amount). E.g. mid of allowed explosion range */
4959
+ JackPotTemparature[JackPotTemparature["BURNING"] = 3] = "BURNING";
4960
+ })(exports.JackPotTemparature || (exports.JackPotTemparature = {}));
4948
4961
 
4949
4962
  exports.JackpotType = void 0;
4950
4963
  (function (JackpotType) {