@smartico/public-api 0.0.275 → 0.0.276

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 (48) hide show
  1. package/dist/Jackpots/JackpotPot.d.ts +8 -10
  2. package/dist/Raffle/GetDrawRunResponse.d.ts +1 -0
  3. package/dist/Raffle/GetRaffleDrawRunsHistoryResponse.d.ts +1 -0
  4. package/dist/Raffle/GetRafflesResponse.d.ts +5 -0
  5. package/dist/Raffle/Raffle.d.ts +1 -1
  6. package/dist/Raffle/RaffleClaimPrizeResponse.d.ts +1 -0
  7. package/dist/Raffle/RafflePrize.d.ts +1 -1
  8. package/dist/Raffle/index.d.ts +1 -0
  9. package/dist/WSAPI/WSAPITypes.d.ts +2 -2
  10. package/dist/index.js +17 -7
  11. package/dist/index.js.map +1 -1
  12. package/dist/index.modern.mjs +16 -6
  13. package/dist/index.modern.mjs.map +1 -1
  14. package/docs/README.md +11 -128
  15. package/docs/classes/WSAPI.md +1 -1
  16. package/docs/enums/AchCustomSectionType.md +67 -0
  17. package/docs/enums/BuyStoreItemErrorCode.md +2 -2
  18. package/docs/enums/InboxCategories.md +19 -0
  19. package/docs/enums/JackPotTemparature.md +33 -0
  20. package/docs/enums/PrizeModifiers.md +49 -0
  21. package/docs/enums/SAWAcknowledgeTypeName.md +25 -0
  22. package/docs/enums/SAWAskForUsername.md +13 -0
  23. package/docs/enums/SAWGameLayout.md +13 -0
  24. package/docs/enums/SAWSpinErrorCode.md +2 -2
  25. package/docs/interfaces/JackpotPot.md +1 -4
  26. package/docs/interfaces/Raffle.md +1 -1
  27. package/docs/interfaces/RaffleDraw.md +1 -1
  28. package/docs/interfaces/RaffleDrawPublicMeta.md +65 -0
  29. package/docs/interfaces/RaffleDrawRun.md +1 -1
  30. package/docs/interfaces/RafflePrize.md +1 -1
  31. package/docs/interfaces/RafflePrizePublicMeta.md +25 -0
  32. package/docs/interfaces/RafflePublicMeta.md +59 -0
  33. package/docs/interfaces/SAWTemplateUI.md +284 -0
  34. package/docs/interfaces/TInboxMessage.md +1 -1
  35. package/docs/interfaces/TMiniGamePrize.md +2 -2
  36. package/docs/interfaces/TMiniGameTemplate.md +1 -1
  37. package/docs/interfaces/TUICustomSection.md +1 -1
  38. package/package.json +1 -1
  39. package/src/Jackpots/JackpotPot.ts +8 -10
  40. package/src/Raffle/GetDrawRunResponse.ts +1 -1
  41. package/src/Raffle/GetRaffleDrawRunsHistoryResponse.ts +1 -0
  42. package/src/Raffle/GetRafflesResponse.ts +5 -0
  43. package/src/Raffle/Raffle.ts +1 -1
  44. package/src/Raffle/RaffleClaimPrizeResponse.ts +1 -1
  45. package/src/Raffle/RafflePrize.ts +1 -1
  46. package/src/Raffle/index.ts +1 -0
  47. package/src/SmarticoAPI.ts +2 -2
  48. package/src/WSAPI/WSAPITypes.ts +5 -3
@@ -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 };
@@ -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';
@@ -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
@@ -1665,6 +1665,7 @@ var GetLevelMapResponseTransform = function GetLevelMapResponseTransform(levels)
1665
1665
  });
1666
1666
  };
1667
1667
 
1668
+ /** @hidden */
1668
1669
  var ticketsTransform = function ticketsTransform(items) {
1669
1670
  return items.map(function (item) {
1670
1671
  return {
@@ -1673,6 +1674,7 @@ var ticketsTransform = function ticketsTransform(items) {
1673
1674
  };
1674
1675
  });
1675
1676
  };
1677
+ /** @hidden */
1676
1678
  var winnersTransform = function winnersTransform(items) {
1677
1679
  return items.map(function (item) {
1678
1680
  return {
@@ -1688,6 +1690,7 @@ var winnersTransform = function winnersTransform(items) {
1688
1690
  };
1689
1691
  });
1690
1692
  };
1693
+ /** @hidden */
1691
1694
  var prizeTransform = function prizeTransform(items) {
1692
1695
  return items.map(function (item) {
1693
1696
  return {
@@ -1709,6 +1712,7 @@ var prizeTransform = function prizeTransform(items) {
1709
1712
  };
1710
1713
  });
1711
1714
  };
1715
+ /** @hidden */
1712
1716
  var drawTransform = function drawTransform(items) {
1713
1717
  return items.map(function (item) {
1714
1718
  return {
@@ -1736,6 +1740,7 @@ var drawTransform = function drawTransform(items) {
1736
1740
  };
1737
1741
  });
1738
1742
  };
1743
+ /** @hidden */
1739
1744
  var raffleTransform = function raffleTransform(items) {
1740
1745
  return items.map(function (item) {
1741
1746
  return {
@@ -1755,6 +1760,7 @@ var raffleTransform = function raffleTransform(items) {
1755
1760
  });
1756
1761
  };
1757
1762
 
1763
+ /** @hidden */
1758
1764
  var drawRunTransform = function drawRunTransform(res) {
1759
1765
  return {
1760
1766
  id: res.draw.draw_id,
@@ -1804,6 +1810,7 @@ var RaffleDrawTypeExecution;
1804
1810
  RaffleDrawTypeExecution[RaffleDrawTypeExecution["Grand"] = 2] = "Grand";
1805
1811
  })(RaffleDrawTypeExecution || (RaffleDrawTypeExecution = {}));
1806
1812
 
1813
+ /** @hidden */
1807
1814
  var drawRunHistoryTransform = function drawRunHistoryTransform(res) {
1808
1815
  return res.draw_runs.map(function (item) {
1809
1816
  return {
@@ -1826,6 +1833,7 @@ var drawRunHistoryTransform = function drawRunHistoryTransform(res) {
1826
1833
  });
1827
1834
  };
1828
1835
 
1836
+ /** @hidden */
1829
1837
  var raffleClaimPrizeResponseTransform = function raffleClaimPrizeResponseTransform(info) {
1830
1838
  return {
1831
1839
  errorCode: info.errCode,
@@ -3602,7 +3610,7 @@ var SmarticoAPI = /*#__PURE__*/function () {
3602
3610
  try {
3603
3611
  var tsBaseRQ = _this3.buildMessage(user_ext_id, exports.ClassId.GET_TRANSLATIONS_REQUEST, {
3604
3612
  lang_code: DEFAULT_LANG_EN,
3605
- hash_code: 0,
3613
+ hash_code: null,
3606
3614
  areas: areas
3607
3615
  });
3608
3616
  return Promise.resolve(_this3.send(tsBaseRQ, exports.ClassId.GET_TRANSLATIONS_RESPONSE)).then(function (trBase) {
@@ -3610,7 +3618,7 @@ var SmarticoAPI = /*#__PURE__*/function () {
3610
3618
  if (lang_code !== DEFAULT_LANG_EN) {
3611
3619
  var trUserRQ = _this3.buildMessage(user_ext_id, exports.ClassId.GET_TRANSLATIONS_REQUEST, {
3612
3620
  lang_code: lang_code,
3613
- hash_code: 0,
3621
+ hash_code: null,
3614
3622
  areas: areas
3615
3623
  });
3616
3624
  return Promise.resolve(_this3.send(trUserRQ, exports.ClassId.GET_TRANSLATIONS_RESPONSE)).then(function (trUser) {
@@ -4936,15 +4944,17 @@ exports.JackpotContributionType = void 0;
4936
4944
  JackpotContributionType[JackpotContributionType["Percentage"] = 2] = "Percentage";
4937
4945
  })(exports.JackpotContributionType || (exports.JackpotContributionType = {}));
4938
4946
 
4939
- var JackPotTemparature;
4947
+ exports.JackPotTemparature = void 0;
4940
4948
  (function (JackPotTemparature) {
4941
- /** cold */
4949
+ /** cold, seed amount < current pot < (min amount - seed amount)/2 */
4942
4950
  JackPotTemparature[JackPotTemparature["COLD"] = 0] = "COLD";
4943
- /** warm */
4951
+ /** warm, (min amount - seed amount)/2 < current pot < min amount */
4944
4952
  JackPotTemparature[JackPotTemparature["WARM"] = 1] = "WARM";
4945
- /** hot */
4953
+ /** hot, current pot > min amount, entered explosion range */
4946
4954
  JackPotTemparature[JackPotTemparature["HOT"] = 2] = "HOT";
4947
- })(JackPotTemparature || (JackPotTemparature = {}));
4955
+ /** burning, current pot > min amount + 0.5 * (max amount - min amount). E.g. mid of allowed explosion range */
4956
+ JackPotTemparature[JackPotTemparature["BURNING"] = 3] = "BURNING";
4957
+ })(exports.JackPotTemparature || (exports.JackPotTemparature = {}));
4948
4958
 
4949
4959
  exports.JackpotType = void 0;
4950
4960
  (function (JackpotType) {