@retroachievements/api 1.2.1 → 1.4.0

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 (214) hide show
  1. package/README.md +38 -49
  2. package/dist/__playground.d.ts +8 -8
  3. package/dist/achievement/getAchievementUnlocks.d.ts +46 -46
  4. package/dist/achievement/getAchievementUnlocks.test.d.ts +1 -1
  5. package/dist/achievement/index.d.ts +2 -2
  6. package/dist/achievement/models/achievement-unlock-entity.model.d.ts +29 -29
  7. package/dist/achievement/models/get-achievement-unlocks-response.model.d.ts +30 -30
  8. package/dist/achievement/models/index.d.ts +2 -2
  9. package/dist/api.cjs +1 -1
  10. package/dist/api.cjs.map +1 -1
  11. package/dist/api.modern.js +1 -1
  12. package/dist/api.modern.js.map +1 -1
  13. package/dist/api.module.js +1 -1
  14. package/dist/api.module.js.map +1 -1
  15. package/dist/api.umd.js +1 -1
  16. package/dist/api.umd.js.map +1 -1
  17. package/dist/console/getConsoleIds.d.ts +22 -22
  18. package/dist/console/getConsoleIds.test.d.ts +1 -1
  19. package/dist/console/getGameList.d.ts +53 -53
  20. package/dist/console/getGameList.test.d.ts +1 -1
  21. package/dist/console/index.d.ts +3 -3
  22. package/dist/console/models/console-id.model.d.ts +4 -4
  23. package/dist/console/models/game-list.model.d.ts +15 -15
  24. package/dist/console/models/get-console-ids-response.model.d.ts +4 -4
  25. package/dist/console/models/get-game-list-response.model.d.ts +15 -15
  26. package/dist/console/models/index.d.ts +4 -4
  27. package/dist/feed/getAchievementOfTheWeek.d.ts +48 -48
  28. package/dist/feed/getAchievementOfTheWeek.test.d.ts +1 -1
  29. package/dist/feed/getActiveClaims.d.ts +40 -40
  30. package/dist/feed/getActiveClaims.test.d.ts +1 -1
  31. package/dist/feed/getClaims.d.ts +7 -7
  32. package/dist/feed/getClaims.test.d.ts +1 -1
  33. package/dist/feed/getTopTenUsers.d.ts +24 -24
  34. package/dist/feed/getTopTenUsers.test.d.ts +1 -1
  35. package/dist/feed/index.d.ts +5 -5
  36. package/dist/feed/models/achievement-of-the-week.model.d.ts +32 -32
  37. package/dist/feed/models/claim-set-type.enum.d.ts +4 -4
  38. package/dist/feed/models/claim-status.enum.d.ts +5 -5
  39. package/dist/feed/models/claim-type.enum.d.ts +4 -4
  40. package/dist/feed/models/get-achievement-of-the-week-response.model.d.ts +32 -32
  41. package/dist/feed/models/get-set-claims-response.model.d.ts +21 -21
  42. package/dist/feed/models/get-top-ten-users-response.model.d.ts +10 -10
  43. package/dist/feed/models/index.d.ts +10 -10
  44. package/dist/feed/models/set-claim.model.d.ts +43 -43
  45. package/dist/feed/models/top-ten-users-entity.model.d.ts +5 -5
  46. package/dist/feed/models/top-ten-users.model.d.ts +2 -2
  47. package/dist/game/getAchievementCount.d.ts +32 -32
  48. package/dist/game/getAchievementCount.test.d.ts +1 -1
  49. package/dist/game/getAchievementDistribution.d.ts +58 -58
  50. package/dist/game/getAchievementDistribution.test.d.ts +1 -1
  51. package/dist/game/getGame.d.ts +49 -49
  52. package/dist/game/getGame.test.d.ts +1 -1
  53. package/dist/game/getGameExtended.d.ts +70 -69
  54. package/dist/game/getGameExtended.test.d.ts +1 -1
  55. package/dist/game/getGameRankAndScore.d.ts +39 -39
  56. package/dist/game/getGameRankAndScore.test.d.ts +1 -1
  57. package/dist/game/getGameRating.d.ts +39 -39
  58. package/dist/game/getGameRating.test.d.ts +1 -1
  59. package/dist/game/index.d.ts +7 -7
  60. package/dist/game/models/achievement-count.model.d.ts +4 -4
  61. package/dist/game/models/achievement-distribution-flags.enum.d.ts +4 -4
  62. package/dist/game/models/game-extended-achievement-entity.model.d.ts +15 -15
  63. package/dist/game/models/game-extended-claim-entity.model.d.ts +7 -7
  64. package/dist/game/models/game-extended.model.d.ts +25 -25
  65. package/dist/game/models/game-rank-and-score-entity.model.d.ts +6 -6
  66. package/dist/game/models/game-rating.model.d.ts +9 -9
  67. package/dist/game/models/game.model.d.ts +19 -19
  68. package/dist/game/models/get-achievement-count-response.model.d.ts +4 -4
  69. package/dist/game/models/get-achievement-distribution-response.model.d.ts +1 -1
  70. package/dist/game/models/get-game-extended-response.model.d.ts +50 -50
  71. package/dist/game/models/get-game-rank-and-score-response.model.d.ts +8 -8
  72. package/dist/game/models/get-game-rating-response.model.d.ts +9 -9
  73. package/dist/game/models/get-game-response.model.d.ts +19 -19
  74. package/dist/game/models/index.d.ts +14 -14
  75. package/dist/index.d.ts +7 -7
  76. package/dist/ticket/getTicketData.d.ts +159 -159
  77. package/dist/ticket/getTicketData.test.d.ts +1 -1
  78. package/dist/ticket/index.d.ts +2 -2
  79. package/dist/ticket/models/achievement-ticket-stats-response.model.d.ts +7 -7
  80. package/dist/ticket/models/achievement-ticket-stats.model.d.ts +7 -7
  81. package/dist/ticket/models/game-ticket-stats.model.d.ts +9 -9
  82. package/dist/ticket/models/game-tickets-response.model.d.ts +7 -7
  83. package/dist/ticket/models/index.d.ts +12 -12
  84. package/dist/ticket/models/most-ticketed-games-response.model.d.ts +12 -12
  85. package/dist/ticket/models/most-ticketed-games.model.d.ts +11 -11
  86. package/dist/ticket/models/recent-tickets-response.model.d.ts +6 -6
  87. package/dist/ticket/models/recent-tickets.model.d.ts +6 -6
  88. package/dist/ticket/models/response-ticket-entity.model.d.ts +24 -24
  89. package/dist/ticket/models/ticket-entity.model.d.ts +24 -24
  90. package/dist/ticket/models/tickets-by-user-response.model.d.ts +8 -8
  91. package/dist/ticket/models/user-ticket-stats.model.d.ts +8 -8
  92. package/dist/user/getAchievementsEarnedBetween.d.ts +59 -59
  93. package/dist/user/getAchievementsEarnedBetween.test.d.ts +1 -1
  94. package/dist/user/getAchievementsEarnedOnDay.d.ts +57 -57
  95. package/dist/user/getAchievementsEarnedOnDay.test.d.ts +1 -1
  96. package/dist/user/getGameInfoAndUserProgress.d.ts +81 -81
  97. package/dist/user/getGameInfoAndUserProgress.test.d.ts +1 -1
  98. package/dist/user/getUserAwards.d.ts +49 -47
  99. package/dist/user/getUserAwards.test.d.ts +1 -1
  100. package/dist/user/getUserClaims.d.ts +27 -27
  101. package/dist/user/getUserClaims.test.d.ts +1 -1
  102. package/dist/user/getUserCompletedGames.d.ts +56 -56
  103. package/dist/user/getUserCompletedGames.test.d.ts +1 -1
  104. package/dist/user/getUserCompletionProgress.d.ts +51 -0
  105. package/dist/user/getUserCompletionProgress.test.d.ts +1 -0
  106. package/dist/user/getUserGameRankAndScore.d.ts +45 -45
  107. package/dist/user/getUserGameRankAndScore.test.d.ts +1 -1
  108. package/dist/user/getUserPoints.d.ts +30 -30
  109. package/dist/user/getUserPoints.test.d.ts +1 -1
  110. package/dist/user/getUserProfile.d.ts +24 -0
  111. package/dist/user/getUserProfile.test.d.ts +1 -0
  112. package/dist/user/getUserProgress.d.ts +50 -50
  113. package/dist/user/getUserProgress.test.d.ts +1 -1
  114. package/dist/user/getUserRecentAchievements.d.ts +49 -49
  115. package/dist/user/getUserRecentAchievements.test.d.ts +1 -1
  116. package/dist/user/getUserRecentlyPlayedGames.d.ts +50 -50
  117. package/dist/user/getUserRecentlyPlayedGames.test.d.ts +1 -1
  118. package/dist/user/getUserSummary.d.ts +32 -32
  119. package/dist/user/getUserSummary.test.d.ts +1 -1
  120. package/dist/user/index.d.ts +15 -13
  121. package/dist/user/models/award-type.model.d.ts +1 -1
  122. package/dist/user/models/dated-user-achievement.model.d.ts +17 -17
  123. package/dist/user/models/dated-user-achievements-response.model.d.ts +19 -19
  124. package/dist/user/models/game-info-and-user-progress.model.d.ts +12 -12
  125. package/dist/user/models/get-game-info-and-user-progress-response.model.d.ts +14 -14
  126. package/dist/user/models/get-user-awards-response.model.d.ts +24 -22
  127. package/dist/user/models/get-user-completed-games-response.model.d.ts +13 -13
  128. package/dist/user/models/get-user-completion-progress-response.model.d.ts +19 -0
  129. package/dist/user/models/get-user-game-rank-and-score-response.model.d.ts +8 -8
  130. package/dist/user/models/get-user-points-response.model.d.ts +4 -4
  131. package/dist/user/models/get-user-profile-response.model.d.ts +17 -0
  132. package/dist/user/models/get-user-progress-response.model.d.ts +10 -10
  133. package/dist/user/models/get-user-recent-achievements-response.model.d.ts +18 -18
  134. package/dist/user/models/get-user-recently-played-games-response.model.d.ts +17 -17
  135. package/dist/user/models/get-user-summary-response.model.d.ts +82 -82
  136. package/dist/user/models/index.d.ts +28 -23
  137. package/dist/user/models/user-awards.model.d.ts +24 -22
  138. package/dist/user/models/user-claims-response.model.d.ts +19 -19
  139. package/dist/user/models/user-claims.model.d.ts +19 -19
  140. package/dist/user/models/user-completed-games.model.d.ts +12 -12
  141. package/dist/user/models/user-completion-progress-entity.model.d.ts +13 -0
  142. package/dist/user/models/user-completion-progress.model.d.ts +6 -0
  143. package/dist/user/models/user-game-rank-and-score.model.d.ts +7 -7
  144. package/dist/user/models/user-points.model.d.ts +4 -4
  145. package/dist/user/models/user-profile.model.d.ts +17 -0
  146. package/dist/user/models/user-progress.model.d.ts +9 -9
  147. package/dist/user/models/user-recent-achievement.model.d.ts +16 -16
  148. package/dist/user/models/user-recently-played-games.model.d.ts +16 -16
  149. package/dist/user/models/user-summary.model.d.ts +82 -82
  150. package/dist/utils/internal/apiBaseUrl.d.ts +1 -1
  151. package/dist/utils/internal/buildRequestUrl.d.ts +2 -2
  152. package/dist/utils/internal/buildRequestUrl.test.d.ts +1 -1
  153. package/dist/utils/internal/call.d.ts +11 -20
  154. package/dist/utils/internal/call.test.d.ts +1 -1
  155. package/dist/utils/internal/id.model.d.ts +1 -1
  156. package/dist/utils/internal/index.d.ts +5 -5
  157. package/dist/utils/internal/serializeProperties.d.ts +4 -4
  158. package/dist/utils/internal/serializeProperties.test.d.ts +1 -1
  159. package/dist/utils/public/buildAuthorization.d.ts +22 -22
  160. package/dist/utils/public/buildAuthorization.test.d.ts +1 -1
  161. package/dist/utils/public/index.d.ts +3 -3
  162. package/dist/utils/public/models/auth-object.model.d.ts +19 -19
  163. package/dist/utils/public/models/index.d.ts +1 -1
  164. package/package.json +24 -31
  165. package/src/achievement/getAchievementUnlocks.test.ts +9 -12
  166. package/src/console/getConsoleIds.test.ts +3 -3
  167. package/src/console/getGameList.test.ts +3 -3
  168. package/src/feed/getAchievementOfTheWeek.test.ts +5 -5
  169. package/src/feed/getActiveClaims.test.ts +3 -3
  170. package/src/feed/getClaims.test.ts +3 -3
  171. package/src/feed/getTopTenUsers.test.ts +3 -3
  172. package/src/game/getAchievementCount.test.ts +3 -3
  173. package/src/game/getAchievementDistribution.test.ts +33 -44
  174. package/src/game/getGame.test.ts +4 -4
  175. package/src/game/getGame.ts +2 -8
  176. package/src/game/getGameExtended.test.ts +4 -4
  177. package/src/game/getGameExtended.ts +13 -8
  178. package/src/game/getGameRankAndScore.test.ts +3 -3
  179. package/src/game/getGameRating.test.ts +3 -3
  180. package/src/game/models/game-extended.model.ts +1 -1
  181. package/src/game/models/game.model.ts +1 -1
  182. package/src/ticket/getTicketData.test.ts +13 -13
  183. package/src/user/getAchievementsEarnedBetween.test.ts +3 -4
  184. package/src/user/getAchievementsEarnedOnDay.test.ts +3 -4
  185. package/src/user/getGameInfoAndUserProgress.test.ts +3 -4
  186. package/src/user/getUserAwards.test.ts +7 -3
  187. package/src/user/getUserAwards.ts +2 -0
  188. package/src/user/getUserClaims.test.ts +3 -3
  189. package/src/user/getUserCompletedGames.test.ts +3 -3
  190. package/src/user/getUserCompletionProgress.test.ts +81 -0
  191. package/src/user/getUserCompletionProgress.ts +83 -0
  192. package/src/user/getUserGameRankAndScore.test.ts +3 -3
  193. package/src/user/getUserPoints.test.ts +3 -3
  194. package/src/user/getUserProfile.test.ts +79 -0
  195. package/src/user/getUserProfile.ts +55 -0
  196. package/src/user/getUserProgress.test.ts +3 -3
  197. package/src/user/getUserRecentAchievements.test.ts +3 -4
  198. package/src/user/getUserRecentlyPlayedGames.test.ts +3 -4
  199. package/src/user/getUserSummary.test.ts +5 -5
  200. package/src/user/getUserSummary.ts +1 -3
  201. package/src/user/index.ts +2 -0
  202. package/src/user/models/award-type.model.ts +5 -4
  203. package/src/user/models/get-user-awards-response.model.ts +2 -0
  204. package/src/user/models/get-user-completion-progress-response.model.ts +25 -0
  205. package/src/user/models/get-user-profile-response.model.ts +17 -0
  206. package/src/user/models/index.ts +5 -0
  207. package/src/user/models/user-awards.model.ts +2 -0
  208. package/src/user/models/user-completion-progress-entity.model.ts +19 -0
  209. package/src/user/models/user-completion-progress.model.ts +7 -0
  210. package/src/user/models/user-profile.model.ts +17 -0
  211. package/src/utils/internal/buildRequestUrl.ts +1 -1
  212. package/src/utils/internal/call.test.ts +9 -10
  213. package/src/utils/internal/call.ts +1 -12
  214. package/src/utils/internal/serializeProperties.ts +4 -4
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
  </p>
7
7
 
8
8
  <p align="center">
9
- <a href="https://retroachievements-api-js.vercel.app/getting-started.html"><strong>Documentation: Get Started</strong></a>
9
+ <a href="https://api-docs.retroachievements.org/getting-started.html"><strong>Documentation: Get Started</strong></a>
10
10
  <br />
11
11
  </p>
12
12
 
@@ -28,10 +28,10 @@
28
28
 
29
29
  Learn how to authenticate and start pulling data from RetroAchievements on our documentation website.
30
30
 
31
- - [Get started](https://retroachievements-api-js.vercel.app/getting-started.html)
32
- - [Get a user's profile information](https://retroachievements-api-js.vercel.app/v1/users/get-user-summary.html)
33
- - [Look up games a user has completed](https://retroachievements-api-js.vercel.app/v1/users/get-user-completed-games.html)
34
- - [Get a game's metadata](https://retroachievements-api-js.vercel.app/v1/games/get-game-extended.html)
31
+ - [Get started](https://api-docs.retroachievements.org/getting-started.html)
32
+ - [Get a user's profile information](https://api-docs.retroachievements.org/v1/users/get-user-summary.html)
33
+ - [Look up games a user has completed](https://api-docs.retroachievements.org/v1/users/get-user-completed-games.html)
34
+ - [Get a game's metadata](https://api-docs.retroachievements.org/v1/games/get-game-extended.html)
35
35
 
36
36
  ## Installation
37
37
 
@@ -76,51 +76,52 @@ Click the function names to open their complete docs on the docs site.
76
76
 
77
77
  ### Users
78
78
 
79
- - [`getAchievementsEarnedBetween()`](https://retroachievements-api-js.vercel.app/v1/users/get-achievements-earned-between.html) - Get a list of achievements earned by a user between two dates.
80
- - [`getAchievementsEarnedOnDay()`](https://retroachievements-api-js.vercel.app/v1/users/get-achievements-earned-on-day.html) - Get a list of achievements earned by a user on a given date.
81
- - [`getGameInfoAndUserProgress()`](https://retroachievements-api-js.vercel.app/v1/users/get-game-info-and-user-progress.html) - Get metadata about a game as well as a user's progress on that game.
82
- - [`getUserAwards()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-awards.html) - Get a list of a user's site awards/badges.
83
- - [`getUserClaims()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-claims.html) - Get a list of set claims made over the lifetime of a user.
84
- - [`getUserCompletedGames()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-completed-games.html) - Get hardcore and softcore completion metadata about games a user has played.
85
- - [`getUserGameRankAndScore()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-game-rank-and-score.html) - Get metadata about how a user has performed on a given game.
86
- - [`getUserPoints()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-points.html) - Get a user's total hardcore and softcore points.
87
- - [`getUserProgress()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-progress.html) - Get a user's progress on a list of specified games.
88
- - [`getUserRecentAchievements()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-recent-achievements.html) - Get a list of achievements recently earned by the user.
89
- - [`getUserRecentlyPlayedGames()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-recently-played-games.html) - Get a list of games a user has recently played.
90
- - [`getUserSummary()`](https://retroachievements-api-js.vercel.app/v1/users/get-user-summary.html) - Get a user's profile metadata.
79
+ - [`getAchievementsEarnedBetween()`](https://api-docs.retroachievements.org/v1/users/get-achievements-earned-between.html) - Get a list of achievements earned by a user between two dates.
80
+ - [`getAchievementsEarnedOnDay()`](https://api-docs.retroachievements.org/v1/users/get-achievements-earned-on-day.html) - Get a list of achievements earned by a user on a given date.
81
+ - [`getGameInfoAndUserProgress()`](https://api-docs.retroachievements.org/v1/users/get-game-info-and-user-progress.html) - Get metadata about a game as well as a user's progress on that game.
82
+ - [`getUserAwards()`](https://api-docs.retroachievements.org/v1/users/get-user-awards.html) - Get a list of a user's site awards/badges.
83
+ - [`getUserClaims()`](https://api-docs.retroachievements.org/v1/users/get-user-claims.html) - Get a list of set claims made over the lifetime of a user.
84
+ - [`getUserCompletedGames()`](https://api-docs.retroachievements.org/v1/users/get-user-completed-games.html) - Get hardcore and softcore completion metadata about games a user has played.
85
+ - [`getUserGameRankAndScore()`](https://api-docs.retroachievements.org/v1/users/get-user-game-rank-and-score.html) - Get metadata about how a user has performed on a given game.
86
+ - [`getUserPoints()`](https://api-docs.retroachievements.org/v1/users/get-user-points.html) - Get a user's total hardcore and softcore points.
87
+ - [`getUserProgress()`](https://api-docs.retroachievements.org/v1/users/get-user-progress.html) - Get a user's progress on a list of specified games.
88
+ - [`getUserRecentAchievements()`](https://api-docs.retroachievements.org/v1/users/get-user-recent-achievements.html) - Get a list of achievements recently earned by the user.
89
+ - [`getUserRecentlyPlayedGames()`](https://api-docs.retroachievements.org/v1/users/get-user-recently-played-games.html) - Get a list of games a user has recently played.
90
+ - [`getUserSummary()`](https://api-docs.retroachievements.org/v1/users/get-user-summary.html) - Get a user's exhaustive profile metadata.
91
+ - [`getUserProfile()`](https://api-docs.retroachievements.org/v1/users/users/profile.html) - Get a thin subset of a user's profile metadata.
91
92
 
92
93
  ### Games
93
94
 
94
- - [`getAchievementCount()`](https://retroachievements-api-js.vercel.app/v1/games/get-achievement-count.html) - Get the list of achievement IDs for a game.
95
- - [`getAchievementDistribution()`](https://retroachievements-api-js.vercel.app/v1/games/get-achievement-distribution.html) - Get how many players have unlocked how many achievements for a game.
96
- - [`getGame()`](https://retroachievements-api-js.vercel.app/v1/games/get-game.html) - Get basic metadata about a game.
97
- - [`getGameExtended()`](https://retroachievements-api-js.vercel.app/v1/games/get-game-extended.html) - Get extended metadata about a game.
98
- - [`getGameRankAndScore()`](https://retroachievements-api-js.vercel.app/v1/games/get-game-rank-and-score.html) - Get a list of either the latest masters or highest points earners for a game.
99
- - [`getGameRating()`](https://retroachievements-api-js.vercel.app/v1/games/get-game-rating.html) - Get how users have rated a game.
95
+ - [`getAchievementCount()`](https://api-docs.retroachievements.org/v1/games/get-achievement-count.html) - Get the list of achievement IDs for a game.
96
+ - [`getAchievementDistribution()`](https://api-docs.retroachievements.org/v1/games/get-achievement-distribution.html) - Get how many players have unlocked how many achievements for a game.
97
+ - [`getGame()`](https://api-docs.retroachievements.org/v1/games/get-game.html) - Get basic metadata about a game.
98
+ - [`getGameExtended()`](https://api-docs.retroachievements.org/v1/games/get-game-extended.html) - Get extended metadata about a game.
99
+ - [`getGameRankAndScore()`](https://api-docs.retroachievements.org/v1/games/get-game-rank-and-score.html) - Get a list of either the latest masters or highest points earners for a game.
100
+ - [`getGameRating()`](https://api-docs.retroachievements.org/v1/games/get-game-rating.html) - Get how users have rated a game.
100
101
 
101
102
  ### Achievements
102
103
 
103
- - [`getAchievementUnlocks()`](https://retroachievements-api-js.vercel.app/v1/achievements/get-achievement-unlocks.html) - Get a list of users who have earned an achievement.
104
+ - [`getAchievementUnlocks()`](https://api-docs.retroachievements.org/v1/achievements/get-achievement-unlocks.html) - Get a list of users who have earned an achievement.
104
105
 
105
106
  ### Consoles
106
107
 
107
- - [`getConsoleIds()`](https://retroachievements-api-js.vercel.app/v1/consoles/get-console-ids.html) - Get the complete list of console ID and name pairs on the site.
108
- - [`getGameList()`](https://retroachievements-api-js.vercel.app/v1/consoles/get-game-list.html) - Get the complete list of games for a console.
108
+ - [`getConsoleIds()`](https://api-docs.retroachievements.org/v1/consoles/get-console-ids.html) - Get the complete list of console ID and name pairs on the site.
109
+ - [`getGameList()`](https://api-docs.retroachievements.org/v1/consoles/get-game-list.html) - Get the complete list of games for a console.
109
110
 
110
111
  ### Feed
111
112
 
112
- - [`getAchievementOfTheWeek()`](https://retroachievements-api-js.vercel.app/v1/feed/get-achievement-of-the-week.html) - Get comprehensive metadata about the current Achievement of the Week.
113
- - [`getActiveClaims()`](https://retroachievements-api-js.vercel.app/v1/feed/get-active-claims.html) - Get all active set claims on the site.
114
- - [`getClaims()`](https://retroachievements-api-js.vercel.app/v1/feed/get-claims.html) - Get all claims of other kinds on the site.
115
- - [`getTopTenUsers()`](https://retroachievements-api-js.vercel.app/v1/feed/get-top-ten-users.html) - Get the list of top ten points earners.
113
+ - [`getAchievementOfTheWeek()`](https://api-docs.retroachievements.org/v1/feed/get-achievement-of-the-week.html) - Get comprehensive metadata about the current Achievement of the Week.
114
+ - [`getActiveClaims()`](https://api-docs.retroachievements.org/v1/feed/get-active-claims.html) - Get all active set claims on the site.
115
+ - [`getClaims()`](https://api-docs.retroachievements.org/v1/feed/get-claims.html) - Get all claims of other kinds on the site.
116
+ - [`getTopTenUsers()`](https://api-docs.retroachievements.org/v1/feed/get-top-ten-users.html) - Get the list of top ten points earners.
116
117
 
117
118
  ### Tickets
118
119
 
119
- - [Get Ticket by ID](https://retroachievements-api-js.vercel.app/v1/tickets/get-ticket-by-id.html)
120
- - [Get Most Ticketed Games](https://retroachievements-api-js.vercel.app/v1/tickets/get-most-ticketed-games.html)
121
- - [Get Most Recent Tickets](https://retroachievements-api-js.vercel.app/v1/tickets/get-most-recent-tickets.html)
122
- - [Get Game Ticket Stats](https://retroachievements-api-js.vercel.app/v1/tickets/get-game-ticket-stats.html)
123
- - [Get Developer Ticket Stats](https://retroachievements-api-js.vercel.app/v1/tickets/get-developer-ticket-stats.html)
120
+ - [Get Ticket by ID](https://api-docs.retroachievements.org/v1/tickets/get-ticket-by-id.html)
121
+ - [Get Most Ticketed Games](https://api-docs.retroachievements.org/v1/tickets/get-most-ticketed-games.html)
122
+ - [Get Most Recent Tickets](https://api-docs.retroachievements.org/v1/tickets/get-most-recent-tickets.html)
123
+ - [Get Game Ticket Stats](https://api-docs.retroachievements.org/v1/tickets/get-game-ticket-stats.html)
124
+ - [Get Developer Ticket Stats](https://api-docs.retroachievements.org/v1/tickets/get-developer-ticket-stats.html)
124
125
 
125
126
  ## Examples
126
127
 
@@ -128,20 +129,8 @@ TODO
128
129
 
129
130
  ## Projects Using @retroachievements/api
130
131
 
131
- Let us know about yours by [opening an issue](https://github.com/RetroAchievements/retroachievements-api-js/issues/new)!
132
+ Let us know about yours by [opening an issue](https://github.com/RetroAchievements/api-js/issues/new)!
132
133
 
133
134
  ## How to Contribute
134
135
 
135
- Check out [CONTRIBUTING.md](https://github.com/RetroAchievements/retroachievements-api-js/blob/main/CONTRIBUTING.md) for how to get started.
136
-
137
- ## Contributors
138
-
139
- <!-- prettier-ignore-start -->
140
- <!-- markdownlint-disable -->
141
- <table>
142
- <tbody>
143
- <tr>
144
- <td align="center"><a href="https://github.com/wescopeland"><img src="https://avatars.githubusercontent.com/u/3984985?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Wes Copeland</b></sub></a><br /><a href="https://github.com/achievements-app/psn-api/commits?author=wescopeland" title="Code">💻</a> <a href="#example-wescopeland" title="Examples">💡</a> <a href="https://github.com/achievements-app/psn-api/commits?author=wescopeland" title="Documentation">📖</a></td>
145
- </tr>
146
- </tbody>
147
- </table>
136
+ Check out [CONTRIBUTING.md](https://github.com/RetroAchievements/api-js/blob/main/CONTRIBUTING.md) for how to get started.
@@ -1,8 +1,8 @@
1
- /**
2
- * PLEASE ONLY COMMIT CHANGES TO THIS FILE IF YOU WANT THEM
3
- * TO DIRECTLY IMPACT EVERY DEV WORKING ON THE PROJECT.
4
- *
5
- * Use this file to test and experiment with changes to the project.
6
- * If changes to this file land in a PR, you probably did something wrong.
7
- */
8
- export {};
1
+ /**
2
+ * PLEASE ONLY COMMIT CHANGES TO THIS FILE IF YOU WANT THEM
3
+ * TO DIRECTLY IMPACT EVERY DEV WORKING ON THE PROJECT.
4
+ *
5
+ * Use this file to test and experiment with changes to the project.
6
+ * If changes to this file land in a PR, you probably did something wrong.
7
+ */
8
+ export {};
@@ -1,46 +1,46 @@
1
- import type { ID } from "../utils/internal";
2
- import type { AuthObject } from "../utils/public";
3
- import type { AchievementUnlocksMetadata } from "./models";
4
- /**
5
- * A call to this function will retrieve a list of users who
6
- * have earned a given achievement, targeted by the achievement's ID.
7
- *
8
- * @param authorization An object containing your userName and webApiKey.
9
- * This can be constructed with `buildAuthorization()`.
10
- *
11
- * @param payload.achievementId The target achievement we want to
12
- * retrieve the unlocks list for. If unknown, this can be found
13
- * by navigating to the achievement's page on the RetroAchievements.org
14
- * website. eg: https://retroachievements.org/achievement/13876 has an
15
- * ID of 13876.
16
- *
17
- * @param payload.offset Defaults to 0. The number of entries to skip.
18
- *
19
- * @param payload.count Defaults to 50, has a max of 500.
20
- *
21
- * @example
22
- * ```
23
- * const achievementUnlocks = await getAchievementUnlocks(
24
- * authorization,
25
- * { achievementId: 13876 }
26
- * );
27
- * ```
28
- *
29
- * @returns An array containing metadata about unlocks for
30
- * the target achievement.
31
- * ```
32
- * [
33
- * {
34
- * user: 'Podgicus0305',
35
- * raPoints: 15544,
36
- * dateAwarded: '2022-07-12 19:06:34',
37
- * hardcoreMode: true
38
- * }
39
- * ]
40
- * ```
41
- */
42
- export declare const getAchievementUnlocks: (authorization: AuthObject, payload: {
43
- achievementId: ID;
44
- offset?: number;
45
- count?: number;
46
- }) => Promise<AchievementUnlocksMetadata>;
1
+ import type { ID } from "../utils/internal";
2
+ import type { AuthObject } from "../utils/public";
3
+ import type { AchievementUnlocksMetadata } from "./models";
4
+ /**
5
+ * A call to this function will retrieve a list of users who
6
+ * have earned a given achievement, targeted by the achievement's ID.
7
+ *
8
+ * @param authorization An object containing your userName and webApiKey.
9
+ * This can be constructed with `buildAuthorization()`.
10
+ *
11
+ * @param payload.achievementId The target achievement we want to
12
+ * retrieve the unlocks list for. If unknown, this can be found
13
+ * by navigating to the achievement's page on the RetroAchievements.org
14
+ * website. eg: https://retroachievements.org/achievement/13876 has an
15
+ * ID of 13876.
16
+ *
17
+ * @param payload.offset Defaults to 0. The number of entries to skip.
18
+ *
19
+ * @param payload.count Defaults to 50, has a max of 500.
20
+ *
21
+ * @example
22
+ * ```
23
+ * const achievementUnlocks = await getAchievementUnlocks(
24
+ * authorization,
25
+ * { achievementId: 13876 }
26
+ * );
27
+ * ```
28
+ *
29
+ * @returns An array containing metadata about unlocks for
30
+ * the target achievement.
31
+ * ```
32
+ * [
33
+ * {
34
+ * user: 'Podgicus0305',
35
+ * raPoints: 15544,
36
+ * dateAwarded: '2022-07-12 19:06:34',
37
+ * hardcoreMode: true
38
+ * }
39
+ * ]
40
+ * ```
41
+ */
42
+ export declare const getAchievementUnlocks: (authorization: AuthObject, payload: {
43
+ achievementId: ID;
44
+ offset?: number;
45
+ count?: number;
46
+ }) => Promise<AchievementUnlocksMetadata>;
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,2 +1,2 @@
1
- export * from "./getAchievementUnlocks";
2
- export * from "./models";
1
+ export * from "./getAchievementUnlocks";
2
+ export * from "./models";
@@ -1,29 +1,29 @@
1
- export interface AchievementUnlockEntity {
2
- user: string;
3
- raPoints: number;
4
- dateAwarded: string;
5
- hardcoreMode: boolean;
6
- }
7
- export interface AchievementUnlocksMetadata {
8
- achievement: {
9
- id: number;
10
- title: string;
11
- description: string;
12
- points: number;
13
- trueRatio: number;
14
- author: string;
15
- dateCreated: string;
16
- dateModified: string;
17
- };
18
- console: {
19
- id: number;
20
- title: string;
21
- };
22
- game: {
23
- id: number;
24
- title: string;
25
- };
26
- unlocksCount: number;
27
- totalPlayers: number;
28
- unlocks: AchievementUnlockEntity[];
29
- }
1
+ export interface AchievementUnlockEntity {
2
+ user: string;
3
+ raPoints: number;
4
+ dateAwarded: string;
5
+ hardcoreMode: boolean;
6
+ }
7
+ export interface AchievementUnlocksMetadata {
8
+ achievement: {
9
+ id: number;
10
+ title: string;
11
+ description: string;
12
+ points: number;
13
+ trueRatio: number;
14
+ author: string;
15
+ dateCreated: string;
16
+ dateModified: string;
17
+ };
18
+ console: {
19
+ id: number;
20
+ title: string;
21
+ };
22
+ game: {
23
+ id: number;
24
+ title: string;
25
+ };
26
+ unlocksCount: number;
27
+ totalPlayers: number;
28
+ unlocks: AchievementUnlockEntity[];
29
+ }
@@ -1,30 +1,30 @@
1
- interface AchievementUnlocksResponseEntity {
2
- User: string;
3
- RAPoints: string;
4
- DateAwarded: string;
5
- HardcoreMode: string;
6
- }
7
- export interface GetAchievementUnlocksResponse {
8
- Achievement: {
9
- ID: string;
10
- Title: string;
11
- Description: string;
12
- Points: string;
13
- TrueRatio: string;
14
- Author: string;
15
- DateCreated: string;
16
- DateModified: string;
17
- };
18
- Console: {
19
- ID: string;
20
- Title: string;
21
- };
22
- Game: {
23
- ID: string;
24
- Title: string;
25
- };
26
- UnlocksCount: number;
27
- TotalPlayers: number;
28
- Unlocks: AchievementUnlocksResponseEntity[];
29
- }
30
- export {};
1
+ interface AchievementUnlocksResponseEntity {
2
+ User: string;
3
+ RAPoints: string;
4
+ DateAwarded: string;
5
+ HardcoreMode: string;
6
+ }
7
+ export interface GetAchievementUnlocksResponse {
8
+ Achievement: {
9
+ ID: string;
10
+ Title: string;
11
+ Description: string;
12
+ Points: string;
13
+ TrueRatio: string;
14
+ Author: string;
15
+ DateCreated: string;
16
+ DateModified: string;
17
+ };
18
+ Console: {
19
+ ID: string;
20
+ Title: string;
21
+ };
22
+ Game: {
23
+ ID: string;
24
+ Title: string;
25
+ };
26
+ UnlocksCount: number;
27
+ TotalPlayers: number;
28
+ Unlocks: AchievementUnlocksResponseEntity[];
29
+ }
30
+ export {};
@@ -1,2 +1,2 @@
1
- export * from "./achievement-unlock-entity.model";
2
- export * from "./get-achievement-unlocks-response.model";
1
+ export * from "./achievement-unlock-entity.model";
2
+ export * from "./get-achievement-unlocks-response.model";
package/dist/api.cjs CHANGED
@@ -1,2 +1,2 @@
1
- function e(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var r=/*#__PURE__*/e(require("isomorphic-unfetch")),t="https://retroachievements.org/API",o=function(e,r,t,o){void 0===o&&(o={});for(var n=(e+"/"+r).replace(/([^:]\/)\/+/g,"$1"),s={z:t.userName,y:t.webApiKey},i=0,a=Object.entries(o);i<a.length;i++){var u=a[i],c=u[0],l=u[1];n.includes(":"+c)?n=n.replace(":"+c,String(l)):void 0!==l&&(s[c]=String(l))}return n+"?"+new URLSearchParams(s).toString()},n=function(e){try{return Promise.resolve(r.default(e.url)).then(function(e){if(!e.ok)throw new Error("HTTP Error: Status "+e.status+" "+e.statusText);return Promise.resolve(e.json())})}catch(e){return Promise.reject(e)}};function s(){return s=Object.assign?Object.assign.bind():function(e){for(var r=1;r<arguments.length;r++){var t=arguments[r];for(var o in t)Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o])}return e},s.apply(this,arguments)}function i(e,r){(null==r||r>e.length)&&(r=e.length);for(var t=0,o=new Array(r);t<r;t++)o[t]=e[t];return o}function a(e,r){var t="undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(t)return(t=t.call(e)).next.bind(t);if(Array.isArray(e)||(t=function(e,r){if(e){if("string"==typeof e)return i(e,r);var t=Object.prototype.toString.call(e).slice(8,-1);return"Object"===t&&e.constructor&&(t=e.constructor.name),"Map"===t||"Set"===t?Array.from(e):"Arguments"===t||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t)?i(e,r):void 0}}(e))||r&&e&&"number"==typeof e.length){t&&(e=t);var o=0;return function(){return o>=e.length?{done:!0}:{done:!1,value:e[o++]}}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}var u,c,l,m,h,d=function e(r,t){void 0===t&&(t={});var o=t.shouldCastToNumbers,n=t.shouldMapToBooleans,i=r;if(Array.isArray(r)){for(var u,c=[],l=a(r);!(u=l()).done;)c.push(e(u.value,t));i=c}else if(!Array.isArray(r)&&r instanceof Object){for(var m={},h=0,d=Object.entries(r);h<d.length;h++){var v,P=d[h],f=P[0],A=P[1],y=A;null!=o&&o.includes(f)&&(y=null===A?null:Number(A)),null!=n&&n.includes(f)&&(y=null===A?null:"1"===String(A)),m=s({},m,((v={})[p(f)]=e(y,t),v))}i=m}return i},p=function(e){if(e.toUpperCase()===e)return e.toLowerCase();var r=e.charAt(0).toLowerCase()+e.slice(1);return(r=(r=(r=r.replace(/ID/g,"Id")).replace(/URL/g,"Url")).replace(/rA/g,"ra")).replace(/visibleUserawards/g,"visibleUserAwards")},v={completed:"1",dropped:"2",expired:"3"};exports.ClaimSetType=void 0,(u=exports.ClaimSetType||(exports.ClaimSetType={}))[u.NewSet=0]="NewSet",u[u.Revision=1]="Revision",exports.ClaimStatus=void 0,(c=exports.ClaimStatus||(exports.ClaimStatus={}))[c.Active=0]="Active",c[c.Complete=1]="Complete",c[c.Dropped=2]="Dropped",exports.ClaimType=void 0,(l=exports.ClaimType||(exports.ClaimType={}))[l.Primary=0]="Primary",l[l.Collaboration=1]="Collaboration",exports.AchievementDistributionFlags=void 0,(m=exports.AchievementDistributionFlags||(exports.AchievementDistributionFlags={}))[m.CoreAchievements=3]="CoreAchievements",m[m.UnofficialAchievements=5]="UnofficialAchievements",function(e){e.Primary="0",e.Collaboration="1"}(h||(h={}));var P=function(e,r){var t=s({},e);return void 0!==r.count&&(t.c=r.count),void 0!==r.offset&&(t.o=r.offset),t};exports.buildAuthorization=function(e){if(!e.userName||!e.webApiKey)throw new Error('\n buildAuthorization() requires an object containing a\n userName and webApiKey. eg:\n\n const authorization = buildAuthorization({\n userName: "myUserName",\n webApiKey: "myWebApiKey"\n })\n ');return e},exports.getAchievementCount=function(e,r){try{var s=o(t,"/API_GetAchievementCount.php",e,{i:r.gameId});return Promise.resolve(n({url:s})).then(d)}catch(e){return Promise.reject(e)}},exports.getAchievementDistribution=function(e,r){try{var s=r.flags,i=r.hardcore,a={i:r.gameId};void 0!==s&&(a.f=s),void 0!==i&&(a.h=!0===i?1:0);var u=o(t,"/API_GetAchievementDistribution.php",e,a);return Promise.resolve(n({url:u}))}catch(e){return Promise.reject(e)}},exports.getAchievementOfTheWeek=function(e){try{var r=o(t,"/API_GetAchievementOfTheWeek.php",e);return Promise.resolve(n({url:r})).then(function(e){return d(e,{shouldCastToNumbers:["ID","Points","TrueRatio","TotalPlayers","RAPoints","UnlocksCount"],shouldMapToBooleans:["HardcoreMode"]})})}catch(e){return Promise.reject(e)}},exports.getAchievementUnlocks=function(e,r){try{var s=r.offset,i=r.count,a={a:r.achievementId};s&&(a.o=s),i&&(a.c=i);var u=o(t,"/API_GetAchievementUnlocks.php",e,a);return Promise.resolve(n({url:u})).then(function(e){return d(e,{shouldCastToNumbers:["ID","Points","TrueRatio","RAPoints"],shouldMapToBooleans:["HardcoreMode"]})})}catch(e){return Promise.reject(e)}},exports.getAchievementsEarnedBetween=function(e,r){try{var s=r.toDate,i=o(t,"/API_GetAchievementsEarnedBetween.php",e,{u:r.userName,f:(r.fromDate.getTime()/1e3).toFixed(0),t:(s.getTime()/1e3).toFixed(0)});return Promise.resolve(n({url:i})).then(function(e){return d(e,{shouldCastToNumbers:["AchievementID","Points","GameID"],shouldMapToBooleans:["HardcoreMode"]})})}catch(e){return Promise.reject(e)}},exports.getAchievementsEarnedOnDay=function(e,r){try{var s=r.onDate,i=o(t,"/API_GetAchievementsEarnedOnDay.php",e,{u:r.userName,d:s.getFullYear()+"-"+(s.getMonth()+1)+"-"+s.getDate()});return Promise.resolve(n({url:i})).then(function(e){return d(e,{shouldCastToNumbers:["AchievementID","Points","GameID"],shouldMapToBooleans:["HardcoreMode"]})})}catch(e){return Promise.reject(e)}},exports.getActiveClaims=function(e){try{var r=o(t,"/API_GetActiveClaims.php",e);return Promise.resolve(n({url:r})).then(function(e){return d(e,{shouldMapToBooleans:["UserIsJrDev"]})})}catch(e){return Promise.reject(e)}},exports.getClaims=function(e,r){try{var s=o(t,"/API_GetClaims.php",e,{k:v[r.claimKind]});return Promise.resolve(n({url:s})).then(function(e){return d(e,{shouldMapToBooleans:["UserIsJrDev"]})})}catch(e){return Promise.reject(e)}},exports.getConsoleIds=function(e){try{var r=o(t,"/API_GetConsoleIDs.php",e);return Promise.resolve(n({url:r})).then(function(e){return d(e,{shouldCastToNumbers:["ID"]})})}catch(e){return Promise.reject(e)}},exports.getGame=function(e,r){try{var s=o(t,"/API_GetGame.php",e,{i:r.gameId});return Promise.resolve(n({url:s})).then(function(e){return d(e,{shouldCastToNumbers:["ID","ForumTopicID","ConsoleID","Flags","Released"]})})}catch(e){return Promise.reject(e)}},exports.getGameExtended=function(e,r){try{var s=o(t,"/API_GetGameExtended.php",e,{i:r.gameId});return Promise.resolve(n({url:s})).then(function(e){return d(e,{shouldCastToNumbers:["ID","NumAwarded","NumAwardedHardcore","Points","TrueRatio","DisplayOrder","NumDistinctPlayersCasual","NumDistinctPlayersHardcore","Released"]})})}catch(e){return Promise.reject(e)}},exports.getGameInfoAndUserProgress=function(e,r){try{var s=o(t,"/API_GetGameInfoAndUserProgress.php",e,{g:r.gameId,u:r.userName});return Promise.resolve(n({url:s})).then(function(e){return d(e,{shouldCastToNumbers:["ID","NumAwarded","NumAwardedHardcore","Points","TrueRatio","DisplayOrder","NumDistinctPlayersCasual","NumDistinctPlayersHardcore","Released"]})})}catch(e){return Promise.reject(e)}},exports.getGameList=function(e,r){try{var i=r.shouldOnlyRetrieveGamesWithAchievements,a=r.shouldRetrieveGameHashes,u={i:r.consoleId};void 0!==i&&(u=s({},u,{f:i?1:0})),a&&(u=s({},u,{h:a?1:0}));var c=o(t,"/API_GetGameList.php",e,u);return Promise.resolve(n({url:c})).then(function(e){return d(e,{shouldCastToNumbers:["ID","ConsoleID"]})})}catch(e){return Promise.reject(e)}},exports.getGameRankAndScore=function(e,r){try{var s=o(t,"/API_GetGameRankAndScore.php",e,{g:r.gameId,t:"latest-masters"===r.type?1:0});return Promise.resolve(n({url:s})).then(function(e){return d(e,{shouldCastToNumbers:["TotalScore"]})})}catch(e){return Promise.reject(e)}},exports.getGameRating=function(e,r){try{var s=o(t,"/API_GetGameRating.php",e,{i:r.gameId});return Promise.resolve(n({url:s})).then(d)}catch(e){return Promise.reject(e)}},exports.getTicketData=function(e,r){void 0===r&&(r={});try{var s=function(e){var r=e.ticketId,t=e.isGettingMostTicketedGames,o=e.userName,n=e.gameId,s=e.isGettingTicketsForUnofficialAchievements,i=e.shouldReturnTicketsList,a=e.achievementId,u={};return void 0!==r?u.i=r:t?(u.f="1",u=P(u,e)):o?u.u=o:n?(u.g=n,s&&(u.f="5"),i&&(u.d="1")):a?u.a=a:u=P(u,e),u}(r),i=o(t,"/API_GetTicketData.php",e,s);return Promise.resolve(n({url:i})).then(function(e){return d(e,{shouldCastToNumbers:["ID","AchievementID","Points","GameID","ReportType","ReportState","OpenTickets"],shouldMapToBooleans:["Hardcore"]})})}catch(e){return Promise.reject(e)}},exports.getTopTenUsers=function(e){try{var r=o(t,"/API_GetTopTenUsers.php",e);return Promise.resolve(n({url:r})).then(function(e){for(var r,t=[],o=a(e);!(r=o()).done;){var n=r.value;t.push({userName:n[1],totalPoints:Number(n[2]),totalRatioPoints:Number(n[3])})}return t})}catch(e){return Promise.reject(e)}},exports.getUserAwards=function(e,r){try{var s=o(t,"/API_GetUserAwards.php",e,{u:r.userName});return Promise.resolve(n({url:s})).then(d)}catch(e){return Promise.reject(e)}},exports.getUserClaims=function(e,r){try{var s=o(t,"/API_GetUserClaims.php",e,{u:r.userName});return Promise.resolve(n({url:s})).then(function(e){return d(e,{shouldCastToNumbers:["ID","GameID","ClaimType","SetType","Status","Extension","Special","MinutesLeft"]})})}catch(e){return Promise.reject(e)}},exports.getUserCompletedGames=function(e,r){try{var s=o(t,"/API_GetUserCompletedGames.php",e,{u:r.userName});return Promise.resolve(n({url:s})).then(function(e){return d(e,{shouldCastToNumbers:["GameID","ConsoleID","MaxPossible","NumAwarded","PctWon"],shouldMapToBooleans:["HardcoreMode"]})})}catch(e){return Promise.reject(e)}},exports.getUserGameRankAndScore=function(e,r){try{var s=o(t,"/API_GetUserGameRankAndScore.php",e,{g:r.gameId,u:r.userName});return Promise.resolve(n({url:s})).then(function(e){return d(e,{shouldCastToNumbers:["TotalScore","UserRank"]})})}catch(e){return Promise.reject(e)}},exports.getUserPoints=function(e,r){try{var s=o(t,"/API_GetUserPoints.php",e,{u:r.userName});return Promise.resolve(n({url:s})).then(d)}catch(e){return Promise.reject(e)}},exports.getUserProgress=function(e,r){try{var s=o(t,"/API_GetUserProgress.php",e,{u:r.userName,i:r.gameIds.join(",")});return Promise.resolve(n({url:s})).then(function(e){return d(e,{shouldCastToNumbers:["NumPossibleAchievements","PossibleScore","NumAchieved","ScoreAchieved","NumAchievedHardcore","ScoreAchievedHardcore"]})})}catch(e){return Promise.reject(e)}},exports.getUserRecentAchievements=function(e,r){try{var s=r.recentMinutes,i={u:r.userName};void 0!==s&&(i.m=s);var a=o(t,"/API_GetUserRecentAchievements.php",e,i);return Promise.resolve(n({url:a})).then(function(e){return d(e,{shouldMapToBooleans:["HardcoreMode"]})})}catch(e){return Promise.reject(e)}},exports.getUserRecentlyPlayedGames=function(e,r){try{var s=r.offset,i=r.count,a={u:r.userName};void 0!==s&&(a.o=s),void 0!==i&&(a.c=i);var u=o(t,"/API_GetUserRecentlyPlayedGames.php",e,a);return Promise.resolve(n({url:u})).then(function(e){return d(e,{shouldCastToNumbers:["GameID","ConsoleID","NumPossibleAchievements","PossibleScore","NumAchieved","ScoreAchieved","NumAchievedHardcore","ScoreAchievedHardcore","MyVote"]})})}catch(e){return Promise.reject(e)}},exports.getUserSummary=function(e,r){try{var s=r.recentGamesCount,i=r.recentAchievementsCount,a={u:r.userName};void 0!==s&&(a.g=s),void 0!==i&&(a.a=i);var u=o(t,"/API_GetUserSummary.php",e,a);return Promise.resolve(n({url:u})).then(function(e){return d(e,{shouldCastToNumbers:["GameID","ConsoleID","ID","LastGameID","ForumTopicID","activitytype","ContribCount","ContribYield","TotalPoints","TotalSoftcorePoints","TotalTruePoints","Permissions","NumPossibleAchievements","PossibleScore","NumAchieved","ScoreAchieved","NumAchievedHardcore","ScoreAchievedHardcore","Points","SoftcorePoints"],shouldMapToBooleans:["Untracked","UserWallActive","IsAwarded","HardcoreAchieved"]})})}catch(e){return Promise.reject(e)}},exports.unsafe_call=n;
1
+ var e="https://retroachievements.org/API",r=function(e,r,t,o){void 0===o&&(o={});for(var n=(e+"/"+r).replaceAll(/([^:]\/)\/+/g,"$1"),s={z:t.userName,y:t.webApiKey},i=0,a=Object.entries(o);i<a.length;i++){var u=a[i],c=u[0],l=u[1];n.includes(":"+c)?n=n.replace(":"+c,String(l)):void 0!==l&&(s[c]=String(l))}return n+"?"+new URLSearchParams(s).toString()},t=function(e){try{return Promise.resolve(fetch(e.url)).then(function(e){if(!e.ok)throw new Error("HTTP Error: Status "+e.status+" "+e.statusText);return Promise.resolve(e.json())})}catch(e){return Promise.reject(e)}};function o(){return o=Object.assign?Object.assign.bind():function(e){for(var r=1;r<arguments.length;r++){var t=arguments[r];for(var o in t)Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o])}return e},o.apply(this,arguments)}function n(e,r){(null==r||r>e.length)&&(r=e.length);for(var t=0,o=new Array(r);t<r;t++)o[t]=e[t];return o}function s(e,r){var t="undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(t)return(t=t.call(e)).next.bind(t);if(Array.isArray(e)||(t=function(e,r){if(e){if("string"==typeof e)return n(e,r);var t=Object.prototype.toString.call(e).slice(8,-1);return"Object"===t&&e.constructor&&(t=e.constructor.name),"Map"===t||"Set"===t?Array.from(e):"Arguments"===t||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t)?n(e,r):void 0}}(e))||r&&e&&"number"==typeof e.length){t&&(e=t);var o=0;return function(){return o>=e.length?{done:!0}:{done:!1,value:e[o++]}}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}var i,a,u,c,l,m=function e(r,t){void 0===t&&(t={});var n=t.shouldCastToNumbers,i=t.shouldMapToBooleans,a=r;if(Array.isArray(r)){for(var u,c=[],l=s(r);!(u=l()).done;)c.push(e(u.value,t));a=c}else if(!Array.isArray(r)&&r instanceof Object){for(var m={},d=0,p=Object.entries(r);d<p.length;d++){var v,P=p[d],f=P[0],A=P[1],y=A;null!=n&&n.includes(f)&&(y=null===A?null:Number(A)),null!=i&&i.includes(f)&&(y=null===A?null:"1"===String(A)),m=o({},m,((v={})[h(f)]=e(y,t),v))}a=m}return a},h=function(e){if(e.toUpperCase()===e)return e.toLowerCase();var r=e.charAt(0).toLowerCase()+e.slice(1);return(r=(r=(r=r.replaceAll("ID","Id")).replaceAll("URL","Url")).replaceAll("rA","ra")).replaceAll("visibleUserawards","visibleUserAwards")},d={completed:"1",dropped:"2",expired:"3"};exports.ClaimSetType=void 0,(i=exports.ClaimSetType||(exports.ClaimSetType={}))[i.NewSet=0]="NewSet",i[i.Revision=1]="Revision",exports.ClaimStatus=void 0,(a=exports.ClaimStatus||(exports.ClaimStatus={}))[a.Active=0]="Active",a[a.Complete=1]="Complete",a[a.Dropped=2]="Dropped",exports.ClaimType=void 0,(u=exports.ClaimType||(exports.ClaimType={}))[u.Primary=0]="Primary",u[u.Collaboration=1]="Collaboration",exports.AchievementDistributionFlags=void 0,(c=exports.AchievementDistributionFlags||(exports.AchievementDistributionFlags={}))[c.CoreAchievements=3]="CoreAchievements",c[c.UnofficialAchievements=5]="UnofficialAchievements",function(e){e.Primary="0",e.Collaboration="1"}(l||(l={}));var p=function(e,r){var t=o({},e);return void 0!==r.count&&(t.c=r.count),void 0!==r.offset&&(t.o=r.offset),t};exports.buildAuthorization=function(e){if(!e.userName||!e.webApiKey)throw new Error('\n buildAuthorization() requires an object containing a\n userName and webApiKey. eg:\n\n const authorization = buildAuthorization({\n userName: "myUserName",\n webApiKey: "myWebApiKey"\n })\n ');return e},exports.getAchievementCount=function(o,n){try{var s=r(e,"/API_GetAchievementCount.php",o,{i:n.gameId});return Promise.resolve(t({url:s})).then(m)}catch(e){return Promise.reject(e)}},exports.getAchievementDistribution=function(o,n){try{var s=n.flags,i=n.hardcore,a={i:n.gameId};void 0!==s&&(a.f=s),void 0!==i&&(a.h=!0===i?1:0);var u=r(e,"/API_GetAchievementDistribution.php",o,a);return Promise.resolve(t({url:u}))}catch(e){return Promise.reject(e)}},exports.getAchievementOfTheWeek=function(o){try{var n=r(e,"/API_GetAchievementOfTheWeek.php",o);return Promise.resolve(t({url:n})).then(function(e){return m(e,{shouldCastToNumbers:["ID","Points","TrueRatio","TotalPlayers","RAPoints","UnlocksCount"],shouldMapToBooleans:["HardcoreMode"]})})}catch(e){return Promise.reject(e)}},exports.getAchievementUnlocks=function(o,n){try{var s=n.offset,i=n.count,a={a:n.achievementId};s&&(a.o=s),i&&(a.c=i);var u=r(e,"/API_GetAchievementUnlocks.php",o,a);return Promise.resolve(t({url:u})).then(function(e){return m(e,{shouldCastToNumbers:["ID","Points","TrueRatio","RAPoints"],shouldMapToBooleans:["HardcoreMode"]})})}catch(e){return Promise.reject(e)}},exports.getAchievementsEarnedBetween=function(o,n){try{var s=n.toDate,i=r(e,"/API_GetAchievementsEarnedBetween.php",o,{u:n.userName,f:(n.fromDate.getTime()/1e3).toFixed(0),t:(s.getTime()/1e3).toFixed(0)});return Promise.resolve(t({url:i})).then(function(e){return m(e,{shouldCastToNumbers:["AchievementID","Points","GameID"],shouldMapToBooleans:["HardcoreMode"]})})}catch(e){return Promise.reject(e)}},exports.getAchievementsEarnedOnDay=function(o,n){try{var s=n.onDate,i=r(e,"/API_GetAchievementsEarnedOnDay.php",o,{u:n.userName,d:s.getFullYear()+"-"+(s.getMonth()+1)+"-"+s.getDate()});return Promise.resolve(t({url:i})).then(function(e){return m(e,{shouldCastToNumbers:["AchievementID","Points","GameID"],shouldMapToBooleans:["HardcoreMode"]})})}catch(e){return Promise.reject(e)}},exports.getActiveClaims=function(o){try{var n=r(e,"/API_GetActiveClaims.php",o);return Promise.resolve(t({url:n})).then(function(e){return m(e,{shouldMapToBooleans:["UserIsJrDev"]})})}catch(e){return Promise.reject(e)}},exports.getClaims=function(o,n){try{var s=r(e,"/API_GetClaims.php",o,{k:d[n.claimKind]});return Promise.resolve(t({url:s})).then(function(e){return m(e,{shouldMapToBooleans:["UserIsJrDev"]})})}catch(e){return Promise.reject(e)}},exports.getConsoleIds=function(o){try{var n=r(e,"/API_GetConsoleIDs.php",o);return Promise.resolve(t({url:n})).then(function(e){return m(e,{shouldCastToNumbers:["ID"]})})}catch(e){return Promise.reject(e)}},exports.getGame=function(o,n){try{var s=r(e,"/API_GetGame.php",o,{i:n.gameId});return Promise.resolve(t({url:s})).then(function(e){return m(e,{shouldCastToNumbers:["ID","ForumTopicID","ConsoleID","Flags"]})})}catch(e){return Promise.reject(e)}},exports.getGameExtended=function(o,n){try{var s={i:n.gameId};n.isRequestingUnofficialAchievements&&(s.f=5);var i=r(e,"/API_GetGameExtended.php",o,s);return Promise.resolve(t({url:i})).then(function(e){return m(e,{shouldCastToNumbers:["ID","NumAwarded","NumAwardedHardcore","Points","TrueRatio","DisplayOrder","NumDistinctPlayersCasual","NumDistinctPlayersHardcore"]})})}catch(e){return Promise.reject(e)}},exports.getGameInfoAndUserProgress=function(o,n){try{var s=r(e,"/API_GetGameInfoAndUserProgress.php",o,{g:n.gameId,u:n.userName});return Promise.resolve(t({url:s})).then(function(e){return m(e,{shouldCastToNumbers:["ID","NumAwarded","NumAwardedHardcore","Points","TrueRatio","DisplayOrder","NumDistinctPlayersCasual","NumDistinctPlayersHardcore","Released"]})})}catch(e){return Promise.reject(e)}},exports.getGameList=function(n,s){try{var i=s.shouldOnlyRetrieveGamesWithAchievements,a=s.shouldRetrieveGameHashes,u={i:s.consoleId};void 0!==i&&(u=o({},u,{f:i?1:0})),a&&(u=o({},u,{h:a?1:0}));var c=r(e,"/API_GetGameList.php",n,u);return Promise.resolve(t({url:c})).then(function(e){return m(e,{shouldCastToNumbers:["ID","ConsoleID"]})})}catch(e){return Promise.reject(e)}},exports.getGameRankAndScore=function(o,n){try{var s=r(e,"/API_GetGameRankAndScore.php",o,{g:n.gameId,t:"latest-masters"===n.type?1:0});return Promise.resolve(t({url:s})).then(function(e){return m(e,{shouldCastToNumbers:["TotalScore"]})})}catch(e){return Promise.reject(e)}},exports.getGameRating=function(o,n){try{var s=r(e,"/API_GetGameRating.php",o,{i:n.gameId});return Promise.resolve(t({url:s})).then(m)}catch(e){return Promise.reject(e)}},exports.getTicketData=function(o,n){void 0===n&&(n={});try{var s=function(e){var r=e.ticketId,t=e.isGettingMostTicketedGames,o=e.userName,n=e.gameId,s=e.isGettingTicketsForUnofficialAchievements,i=e.shouldReturnTicketsList,a=e.achievementId,u={};return void 0!==r?u.i=r:t?(u.f="1",u=p(u,e)):o?u.u=o:n?(u.g=n,s&&(u.f="5"),i&&(u.d="1")):a?u.a=a:u=p(u,e),u}(n),i=r(e,"/API_GetTicketData.php",o,s);return Promise.resolve(t({url:i})).then(function(e){return m(e,{shouldCastToNumbers:["ID","AchievementID","Points","GameID","ReportType","ReportState","OpenTickets"],shouldMapToBooleans:["Hardcore"]})})}catch(e){return Promise.reject(e)}},exports.getTopTenUsers=function(o){try{var n=r(e,"/API_GetTopTenUsers.php",o);return Promise.resolve(t({url:n})).then(function(e){for(var r,t=[],o=s(e);!(r=o()).done;){var n=r.value;t.push({userName:n[1],totalPoints:Number(n[2]),totalRatioPoints:Number(n[3])})}return t})}catch(e){return Promise.reject(e)}},exports.getUserAwards=function(o,n){try{var s=r(e,"/API_GetUserAwards.php",o,{u:n.userName});return Promise.resolve(t({url:s})).then(m)}catch(e){return Promise.reject(e)}},exports.getUserClaims=function(o,n){try{var s=r(e,"/API_GetUserClaims.php",o,{u:n.userName});return Promise.resolve(t({url:s})).then(function(e){return m(e,{shouldCastToNumbers:["ID","GameID","ClaimType","SetType","Status","Extension","Special","MinutesLeft"]})})}catch(e){return Promise.reject(e)}},exports.getUserCompletedGames=function(o,n){try{var s=r(e,"/API_GetUserCompletedGames.php",o,{u:n.userName});return Promise.resolve(t({url:s})).then(function(e){return m(e,{shouldCastToNumbers:["GameID","ConsoleID","MaxPossible","NumAwarded","PctWon"],shouldMapToBooleans:["HardcoreMode"]})})}catch(e){return Promise.reject(e)}},exports.getUserCompletionProgress=function(o,n){try{var s=n.offset,i=n.count,a={u:n.userName};s&&(a.o=s),i&&(a.c=i);var u=r(e,"/API_GetUserCompletionProgress.php",o,a);return Promise.resolve(t({url:u})).then(m)}catch(e){return Promise.reject(e)}},exports.getUserGameRankAndScore=function(o,n){try{var s=r(e,"/API_GetUserGameRankAndScore.php",o,{g:n.gameId,u:n.userName});return Promise.resolve(t({url:s})).then(function(e){return m(e,{shouldCastToNumbers:["TotalScore","UserRank"]})})}catch(e){return Promise.reject(e)}},exports.getUserPoints=function(o,n){try{var s=r(e,"/API_GetUserPoints.php",o,{u:n.userName});return Promise.resolve(t({url:s})).then(m)}catch(e){return Promise.reject(e)}},exports.getUserProfile=function(o,n){try{var s=r(e,"/API_GetUserProfile.php",o,{u:n.userName});return Promise.resolve(t({url:s})).then(function(e){return m(e,{shouldCastToNumbers:["TotalPoints","TotalSoftcorePoints","TotalTruePoints","Permissions"],shouldMapToBooleans:["Untracked","UserWallActive"]})})}catch(e){return Promise.reject(e)}},exports.getUserProgress=function(o,n){try{var s=r(e,"/API_GetUserProgress.php",o,{u:n.userName,i:n.gameIds.join(",")});return Promise.resolve(t({url:s})).then(function(e){return m(e,{shouldCastToNumbers:["NumPossibleAchievements","PossibleScore","NumAchieved","ScoreAchieved","NumAchievedHardcore","ScoreAchievedHardcore"]})})}catch(e){return Promise.reject(e)}},exports.getUserRecentAchievements=function(o,n){try{var s=n.recentMinutes,i={u:n.userName};void 0!==s&&(i.m=s);var a=r(e,"/API_GetUserRecentAchievements.php",o,i);return Promise.resolve(t({url:a})).then(function(e){return m(e,{shouldMapToBooleans:["HardcoreMode"]})})}catch(e){return Promise.reject(e)}},exports.getUserRecentlyPlayedGames=function(o,n){try{var s=n.offset,i=n.count,a={u:n.userName};void 0!==s&&(a.o=s),void 0!==i&&(a.c=i);var u=r(e,"/API_GetUserRecentlyPlayedGames.php",o,a);return Promise.resolve(t({url:u})).then(function(e){return m(e,{shouldCastToNumbers:["GameID","ConsoleID","NumPossibleAchievements","PossibleScore","NumAchieved","ScoreAchieved","NumAchievedHardcore","ScoreAchievedHardcore","MyVote"]})})}catch(e){return Promise.reject(e)}},exports.getUserSummary=function(o,n){try{var s=n.recentGamesCount,i=n.recentAchievementsCount,a={u:n.userName};void 0!==s&&(a.g=s),void 0!==i&&(a.a=i);var u=r(e,"/API_GetUserSummary.php",o,a);return Promise.resolve(t({url:u})).then(function(e){return m(e,{shouldCastToNumbers:["GameID","ConsoleID","ID","LastGameID","ForumTopicID","activitytype","ContribCount","ContribYield","TotalPoints","TotalSoftcorePoints","TotalTruePoints","Permissions","NumPossibleAchievements","PossibleScore","NumAchieved","ScoreAchieved","NumAchievedHardcore","ScoreAchievedHardcore","Points","SoftcorePoints"],shouldMapToBooleans:["Untracked","UserWallActive","IsAwarded","HardcoreAchieved"]})})}catch(e){return Promise.reject(e)}},exports.unsafe_call=t;
2
2
  //# sourceMappingURL=api.cjs.map