@retroachievements/api 1.2.1 → 1.3.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.
- package/README.md +37 -37
- package/dist/__playground.d.ts +8 -8
- package/dist/achievement/getAchievementUnlocks.d.ts +46 -46
- package/dist/achievement/getAchievementUnlocks.test.d.ts +1 -1
- package/dist/achievement/index.d.ts +2 -2
- package/dist/achievement/models/achievement-unlock-entity.model.d.ts +29 -29
- package/dist/achievement/models/get-achievement-unlocks-response.model.d.ts +30 -30
- package/dist/achievement/models/index.d.ts +2 -2
- package/dist/api.cjs +1 -1
- package/dist/api.cjs.map +1 -1
- package/dist/api.modern.js +1 -1
- package/dist/api.modern.js.map +1 -1
- package/dist/api.module.js +1 -1
- package/dist/api.module.js.map +1 -1
- package/dist/api.umd.js +1 -1
- package/dist/api.umd.js.map +1 -1
- package/dist/console/getConsoleIds.d.ts +22 -22
- package/dist/console/getConsoleIds.test.d.ts +1 -1
- package/dist/console/getGameList.d.ts +53 -53
- package/dist/console/getGameList.test.d.ts +1 -1
- package/dist/console/index.d.ts +3 -3
- package/dist/console/models/console-id.model.d.ts +4 -4
- package/dist/console/models/game-list.model.d.ts +15 -15
- package/dist/console/models/get-console-ids-response.model.d.ts +4 -4
- package/dist/console/models/get-game-list-response.model.d.ts +15 -15
- package/dist/console/models/index.d.ts +4 -4
- package/dist/feed/getAchievementOfTheWeek.d.ts +48 -48
- package/dist/feed/getAchievementOfTheWeek.test.d.ts +1 -1
- package/dist/feed/getActiveClaims.d.ts +40 -40
- package/dist/feed/getActiveClaims.test.d.ts +1 -1
- package/dist/feed/getClaims.d.ts +7 -7
- package/dist/feed/getClaims.test.d.ts +1 -1
- package/dist/feed/getTopTenUsers.d.ts +24 -24
- package/dist/feed/getTopTenUsers.test.d.ts +1 -1
- package/dist/feed/index.d.ts +5 -5
- package/dist/feed/models/achievement-of-the-week.model.d.ts +32 -32
- package/dist/feed/models/claim-set-type.enum.d.ts +4 -4
- package/dist/feed/models/claim-status.enum.d.ts +5 -5
- package/dist/feed/models/claim-type.enum.d.ts +4 -4
- package/dist/feed/models/get-achievement-of-the-week-response.model.d.ts +32 -32
- package/dist/feed/models/get-set-claims-response.model.d.ts +21 -21
- package/dist/feed/models/get-top-ten-users-response.model.d.ts +10 -10
- package/dist/feed/models/index.d.ts +10 -10
- package/dist/feed/models/set-claim.model.d.ts +43 -43
- package/dist/feed/models/top-ten-users-entity.model.d.ts +5 -5
- package/dist/feed/models/top-ten-users.model.d.ts +2 -2
- package/dist/game/getAchievementCount.d.ts +32 -32
- package/dist/game/getAchievementCount.test.d.ts +1 -1
- package/dist/game/getAchievementDistribution.d.ts +58 -58
- package/dist/game/getAchievementDistribution.test.d.ts +1 -1
- package/dist/game/getGame.d.ts +49 -49
- package/dist/game/getGame.test.d.ts +1 -1
- package/dist/game/getGameExtended.d.ts +69 -69
- package/dist/game/getGameExtended.test.d.ts +1 -1
- package/dist/game/getGameRankAndScore.d.ts +39 -39
- package/dist/game/getGameRankAndScore.test.d.ts +1 -1
- package/dist/game/getGameRating.d.ts +39 -39
- package/dist/game/getGameRating.test.d.ts +1 -1
- package/dist/game/index.d.ts +7 -7
- package/dist/game/models/achievement-count.model.d.ts +4 -4
- package/dist/game/models/achievement-distribution-flags.enum.d.ts +4 -4
- package/dist/game/models/game-extended-achievement-entity.model.d.ts +15 -15
- package/dist/game/models/game-extended-claim-entity.model.d.ts +7 -7
- package/dist/game/models/game-extended.model.d.ts +25 -25
- package/dist/game/models/game-rank-and-score-entity.model.d.ts +6 -6
- package/dist/game/models/game-rating.model.d.ts +9 -9
- package/dist/game/models/game.model.d.ts +19 -19
- package/dist/game/models/get-achievement-count-response.model.d.ts +4 -4
- package/dist/game/models/get-achievement-distribution-response.model.d.ts +1 -1
- package/dist/game/models/get-game-extended-response.model.d.ts +50 -50
- package/dist/game/models/get-game-rank-and-score-response.model.d.ts +8 -8
- package/dist/game/models/get-game-rating-response.model.d.ts +9 -9
- package/dist/game/models/get-game-response.model.d.ts +19 -19
- package/dist/game/models/index.d.ts +14 -14
- package/dist/index.d.ts +7 -7
- package/dist/ticket/getTicketData.d.ts +159 -159
- package/dist/ticket/getTicketData.test.d.ts +1 -1
- package/dist/ticket/index.d.ts +2 -2
- package/dist/ticket/models/achievement-ticket-stats-response.model.d.ts +7 -7
- package/dist/ticket/models/achievement-ticket-stats.model.d.ts +7 -7
- package/dist/ticket/models/game-ticket-stats.model.d.ts +9 -9
- package/dist/ticket/models/game-tickets-response.model.d.ts +7 -7
- package/dist/ticket/models/index.d.ts +12 -12
- package/dist/ticket/models/most-ticketed-games-response.model.d.ts +12 -12
- package/dist/ticket/models/most-ticketed-games.model.d.ts +11 -11
- package/dist/ticket/models/recent-tickets-response.model.d.ts +6 -6
- package/dist/ticket/models/recent-tickets.model.d.ts +6 -6
- package/dist/ticket/models/response-ticket-entity.model.d.ts +24 -24
- package/dist/ticket/models/ticket-entity.model.d.ts +24 -24
- package/dist/ticket/models/tickets-by-user-response.model.d.ts +8 -8
- package/dist/ticket/models/user-ticket-stats.model.d.ts +8 -8
- package/dist/user/getAchievementsEarnedBetween.d.ts +59 -59
- package/dist/user/getAchievementsEarnedBetween.test.d.ts +1 -1
- package/dist/user/getAchievementsEarnedOnDay.d.ts +57 -57
- package/dist/user/getAchievementsEarnedOnDay.test.d.ts +1 -1
- package/dist/user/getGameInfoAndUserProgress.d.ts +81 -81
- package/dist/user/getGameInfoAndUserProgress.test.d.ts +1 -1
- package/dist/user/getUserAwards.d.ts +49 -47
- package/dist/user/getUserAwards.test.d.ts +1 -1
- package/dist/user/getUserClaims.d.ts +27 -27
- package/dist/user/getUserClaims.test.d.ts +1 -1
- package/dist/user/getUserCompletedGames.d.ts +56 -56
- package/dist/user/getUserCompletedGames.test.d.ts +1 -1
- package/dist/user/getUserGameRankAndScore.d.ts +45 -45
- package/dist/user/getUserGameRankAndScore.test.d.ts +1 -1
- package/dist/user/getUserPoints.d.ts +30 -30
- package/dist/user/getUserPoints.test.d.ts +1 -1
- package/dist/user/getUserProgress.d.ts +50 -50
- package/dist/user/getUserProgress.test.d.ts +1 -1
- package/dist/user/getUserRecentAchievements.d.ts +49 -49
- package/dist/user/getUserRecentAchievements.test.d.ts +1 -1
- package/dist/user/getUserRecentlyPlayedGames.d.ts +50 -50
- package/dist/user/getUserRecentlyPlayedGames.test.d.ts +1 -1
- package/dist/user/getUserSummary.d.ts +32 -32
- package/dist/user/getUserSummary.test.d.ts +1 -1
- package/dist/user/index.d.ts +13 -13
- package/dist/user/models/award-type.model.d.ts +1 -1
- package/dist/user/models/dated-user-achievement.model.d.ts +17 -17
- package/dist/user/models/dated-user-achievements-response.model.d.ts +19 -19
- package/dist/user/models/game-info-and-user-progress.model.d.ts +12 -12
- package/dist/user/models/get-game-info-and-user-progress-response.model.d.ts +14 -14
- package/dist/user/models/get-user-awards-response.model.d.ts +24 -22
- package/dist/user/models/get-user-completed-games-response.model.d.ts +13 -13
- package/dist/user/models/get-user-game-rank-and-score-response.model.d.ts +8 -8
- package/dist/user/models/get-user-points-response.model.d.ts +4 -4
- package/dist/user/models/get-user-progress-response.model.d.ts +10 -10
- package/dist/user/models/get-user-recent-achievements-response.model.d.ts +18 -18
- package/dist/user/models/get-user-recently-played-games-response.model.d.ts +17 -17
- package/dist/user/models/get-user-summary-response.model.d.ts +82 -82
- package/dist/user/models/index.d.ts +23 -23
- package/dist/user/models/user-awards.model.d.ts +24 -22
- package/dist/user/models/user-claims-response.model.d.ts +19 -19
- package/dist/user/models/user-claims.model.d.ts +19 -19
- package/dist/user/models/user-completed-games.model.d.ts +12 -12
- package/dist/user/models/user-game-rank-and-score.model.d.ts +7 -7
- package/dist/user/models/user-points.model.d.ts +4 -4
- package/dist/user/models/user-progress.model.d.ts +9 -9
- package/dist/user/models/user-recent-achievement.model.d.ts +16 -16
- package/dist/user/models/user-recently-played-games.model.d.ts +16 -16
- package/dist/user/models/user-summary.model.d.ts +82 -82
- package/dist/utils/internal/apiBaseUrl.d.ts +1 -1
- package/dist/utils/internal/buildRequestUrl.d.ts +2 -2
- package/dist/utils/internal/buildRequestUrl.test.d.ts +1 -1
- package/dist/utils/internal/call.d.ts +11 -20
- package/dist/utils/internal/call.test.d.ts +1 -1
- package/dist/utils/internal/id.model.d.ts +1 -1
- package/dist/utils/internal/index.d.ts +5 -5
- package/dist/utils/internal/serializeProperties.d.ts +4 -4
- package/dist/utils/internal/serializeProperties.test.d.ts +1 -1
- package/dist/utils/public/buildAuthorization.d.ts +22 -22
- package/dist/utils/public/buildAuthorization.test.d.ts +1 -1
- package/dist/utils/public/index.d.ts +3 -3
- package/dist/utils/public/models/auth-object.model.d.ts +19 -19
- package/dist/utils/public/models/index.d.ts +1 -1
- package/package.json +24 -31
- package/src/achievement/getAchievementUnlocks.test.ts +9 -12
- package/src/console/getConsoleIds.test.ts +3 -3
- package/src/console/getGameList.test.ts +3 -3
- package/src/feed/getAchievementOfTheWeek.test.ts +5 -5
- package/src/feed/getActiveClaims.test.ts +3 -3
- package/src/feed/getClaims.test.ts +3 -3
- package/src/feed/getTopTenUsers.test.ts +3 -3
- package/src/game/getAchievementCount.test.ts +3 -3
- package/src/game/getAchievementDistribution.test.ts +33 -44
- package/src/game/getGame.test.ts +3 -3
- package/src/game/getGameExtended.test.ts +3 -3
- package/src/game/getGameRankAndScore.test.ts +3 -3
- package/src/game/getGameRating.test.ts +3 -3
- package/src/ticket/getTicketData.test.ts +13 -13
- package/src/user/getAchievementsEarnedBetween.test.ts +3 -4
- package/src/user/getAchievementsEarnedOnDay.test.ts +3 -4
- package/src/user/getGameInfoAndUserProgress.test.ts +3 -4
- package/src/user/getUserAwards.test.ts +7 -3
- package/src/user/getUserAwards.ts +2 -0
- package/src/user/getUserClaims.test.ts +3 -3
- package/src/user/getUserCompletedGames.test.ts +3 -3
- package/src/user/getUserGameRankAndScore.test.ts +3 -3
- package/src/user/getUserPoints.test.ts +3 -3
- package/src/user/getUserProgress.test.ts +3 -3
- package/src/user/getUserRecentAchievements.test.ts +3 -4
- package/src/user/getUserRecentlyPlayedGames.test.ts +3 -4
- package/src/user/getUserSummary.test.ts +5 -5
- package/src/user/getUserSummary.ts +1 -3
- package/src/user/models/award-type.model.ts +5 -4
- package/src/user/models/get-user-awards-response.model.ts +2 -0
- package/src/user/models/user-awards.model.ts +2 -0
- package/src/utils/internal/buildRequestUrl.ts +1 -1
- package/src/utils/internal/call.test.ts +9 -10
- package/src/utils/internal/call.ts +1 -12
- 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://
|
|
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://
|
|
32
|
-
- [Get a user's profile information](https://
|
|
33
|
-
- [Look up games a user has completed](https://
|
|
34
|
-
- [Get a game's metadata](https://
|
|
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,51 @@ Click the function names to open their complete docs on the docs site.
|
|
|
76
76
|
|
|
77
77
|
### Users
|
|
78
78
|
|
|
79
|
-
- [`getAchievementsEarnedBetween()`](https://
|
|
80
|
-
- [`getAchievementsEarnedOnDay()`](https://
|
|
81
|
-
- [`getGameInfoAndUserProgress()`](https://
|
|
82
|
-
- [`getUserAwards()`](https://
|
|
83
|
-
- [`getUserClaims()`](https://
|
|
84
|
-
- [`getUserCompletedGames()`](https://
|
|
85
|
-
- [`getUserGameRankAndScore()`](https://
|
|
86
|
-
- [`getUserPoints()`](https://
|
|
87
|
-
- [`getUserProgress()`](https://
|
|
88
|
-
- [`getUserRecentAchievements()`](https://
|
|
89
|
-
- [`getUserRecentlyPlayedGames()`](https://
|
|
90
|
-
- [`getUserSummary()`](https://
|
|
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 profile metadata.
|
|
91
91
|
|
|
92
92
|
### Games
|
|
93
93
|
|
|
94
|
-
- [`getAchievementCount()`](https://
|
|
95
|
-
- [`getAchievementDistribution()`](https://
|
|
96
|
-
- [`getGame()`](https://
|
|
97
|
-
- [`getGameExtended()`](https://
|
|
98
|
-
- [`getGameRankAndScore()`](https://
|
|
99
|
-
- [`getGameRating()`](https://
|
|
94
|
+
- [`getAchievementCount()`](https://api-docs.retroachievements.org/v1/games/get-achievement-count.html) - Get the list of achievement IDs for a game.
|
|
95
|
+
- [`getAchievementDistribution()`](https://api-docs.retroachievements.org/v1/games/get-achievement-distribution.html) - Get how many players have unlocked how many achievements for a game.
|
|
96
|
+
- [`getGame()`](https://api-docs.retroachievements.org/v1/games/get-game.html) - Get basic metadata about a game.
|
|
97
|
+
- [`getGameExtended()`](https://api-docs.retroachievements.org/v1/games/get-game-extended.html) - Get extended metadata about a game.
|
|
98
|
+
- [`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.
|
|
99
|
+
- [`getGameRating()`](https://api-docs.retroachievements.org/v1/games/get-game-rating.html) - Get how users have rated a game.
|
|
100
100
|
|
|
101
101
|
### Achievements
|
|
102
102
|
|
|
103
|
-
- [`getAchievementUnlocks()`](https://
|
|
103
|
+
- [`getAchievementUnlocks()`](https://api-docs.retroachievements.org/v1/achievements/get-achievement-unlocks.html) - Get a list of users who have earned an achievement.
|
|
104
104
|
|
|
105
105
|
### Consoles
|
|
106
106
|
|
|
107
|
-
- [`getConsoleIds()`](https://
|
|
108
|
-
- [`getGameList()`](https://
|
|
107
|
+
- [`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.
|
|
108
|
+
- [`getGameList()`](https://api-docs.retroachievements.org/v1/consoles/get-game-list.html) - Get the complete list of games for a console.
|
|
109
109
|
|
|
110
110
|
### Feed
|
|
111
111
|
|
|
112
|
-
- [`getAchievementOfTheWeek()`](https://
|
|
113
|
-
- [`getActiveClaims()`](https://
|
|
114
|
-
- [`getClaims()`](https://
|
|
115
|
-
- [`getTopTenUsers()`](https://
|
|
112
|
+
- [`getAchievementOfTheWeek()`](https://api-docs.retroachievements.org/v1/feed/get-achievement-of-the-week.html) - Get comprehensive metadata about the current Achievement of the Week.
|
|
113
|
+
- [`getActiveClaims()`](https://api-docs.retroachievements.org/v1/feed/get-active-claims.html) - Get all active set claims on the site.
|
|
114
|
+
- [`getClaims()`](https://api-docs.retroachievements.org/v1/feed/get-claims.html) - Get all claims of other kinds on the site.
|
|
115
|
+
- [`getTopTenUsers()`](https://api-docs.retroachievements.org/v1/feed/get-top-ten-users.html) - Get the list of top ten points earners.
|
|
116
116
|
|
|
117
117
|
### Tickets
|
|
118
118
|
|
|
119
|
-
- [Get Ticket by ID](https://
|
|
120
|
-
- [Get Most Ticketed Games](https://
|
|
121
|
-
- [Get Most Recent Tickets](https://
|
|
122
|
-
- [Get Game Ticket Stats](https://
|
|
123
|
-
- [Get Developer Ticket Stats](https://
|
|
119
|
+
- [Get Ticket by ID](https://api-docs.retroachievements.org/v1/tickets/get-ticket-by-id.html)
|
|
120
|
+
- [Get Most Ticketed Games](https://api-docs.retroachievements.org/v1/tickets/get-most-ticketed-games.html)
|
|
121
|
+
- [Get Most Recent Tickets](https://api-docs.retroachievements.org/v1/tickets/get-most-recent-tickets.html)
|
|
122
|
+
- [Get Game Ticket Stats](https://api-docs.retroachievements.org/v1/tickets/get-game-ticket-stats.html)
|
|
123
|
+
- [Get Developer Ticket Stats](https://api-docs.retroachievements.org/v1/tickets/get-developer-ticket-stats.html)
|
|
124
124
|
|
|
125
125
|
## Examples
|
|
126
126
|
|
|
@@ -128,11 +128,11 @@ TODO
|
|
|
128
128
|
|
|
129
129
|
## Projects Using @retroachievements/api
|
|
130
130
|
|
|
131
|
-
Let us know about yours by [opening an issue](https://github.com/RetroAchievements/
|
|
131
|
+
Let us know about yours by [opening an issue](https://github.com/RetroAchievements/api-js/issues/new)!
|
|
132
132
|
|
|
133
133
|
## How to Contribute
|
|
134
134
|
|
|
135
|
-
Check out [CONTRIBUTING.md](https://github.com/RetroAchievements/
|
|
135
|
+
Check out [CONTRIBUTING.md](https://github.com/RetroAchievements/api-js/blob/main/CONTRIBUTING.md) for how to get started.
|
|
136
136
|
|
|
137
137
|
## Contributors
|
|
138
138
|
|
package/dist/__playground.d.ts
CHANGED
|
@@ -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],A=P[0],f=P[1],y=f;null!=n&&n.includes(A)&&(y=null===f?null:Number(f)),null!=i&&i.includes(A)&&(y=null===f?null:"1"===String(f)),m=o({},m,((v={})[h(A)]=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","Released"]})})}catch(e){return Promise.reject(e)}},exports.getGameExtended=function(o,n){try{var s=r(e,"/API_GetGameExtended.php",o,{i:n.gameId});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.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.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.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
|