@retroachievements/api 1.0.0-rc.0 → 1.0.0-rc.2
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/dist/__playground.d.ts +2 -1
- package/dist/achievement/getAchievementUnlocks.d.ts +2 -1
- package/dist/achievement/models/achievement-unlock-entity.model.d.ts +23 -0
- package/dist/achievement/models/get-achievement-unlocks-response.model.d.ts +23 -1
- package/dist/api.cjs.development.js +597 -853
- package/dist/api.cjs.development.js.map +1 -1
- package/dist/api.cjs.production.min.js +1 -1
- package/dist/api.cjs.production.min.js.map +1 -1
- package/dist/api.esm.js +597 -853
- package/dist/api.esm.js.map +1 -1
- package/dist/console/getGameList.d.ts +2 -1
- package/dist/console/models/game-list.model.d.ts +1 -1
- package/dist/console/models/get-console-ids-response.model.d.ts +1 -1
- package/dist/console/models/get-game-list-response.model.d.ts +1 -1
- package/dist/feed/getTicketData.d.ts +4 -3
- package/dist/feed/models/get-active-claims-response.model.d.ts +1 -1
- package/dist/feed/models/get-top-ten-users-response.model.d.ts +1 -1
- package/dist/feed/models/most-ticketed-games.model.d.ts +1 -2
- package/dist/feed/models/top-ten-users.model.d.ts +1 -1
- package/dist/game/getAchievementCount.d.ts +2 -1
- package/dist/game/getAchievementDistribution.d.ts +2 -1
- package/dist/game/getGame.d.ts +2 -1
- package/dist/game/getGameExtended.d.ts +2 -1
- package/dist/game/getGameRankAndScore.d.ts +2 -1
- package/dist/game/getGameRating.d.ts +2 -1
- package/dist/game/models/get-achievement-distribution-response.model.d.ts +1 -1
- package/dist/game/models/get-game-rank-and-score-response.model.d.ts +1 -1
- package/dist/user/getAchievementsEarnedBetween.d.ts +19 -19
- package/dist/user/getGameInfoAndUserProgress.d.ts +2 -1
- package/dist/user/getUserClaims.d.ts +1 -1
- package/dist/user/getUserCompletedGames.d.ts +1 -1
- package/dist/user/getUserGameRankAndScore.d.ts +2 -1
- package/dist/user/getUserPoints.d.ts +1 -1
- package/dist/user/getUserProgress.d.ts +5 -4
- package/dist/user/models/dated-user-achievement.model.d.ts +1 -1
- package/dist/user/models/dated-user-achievements-response.model.d.ts +1 -1
- package/dist/user/models/game-info-and-user-progress.model.d.ts +1 -1
- package/dist/user/models/get-game-info-and-user-progress-response.model.d.ts +2 -2
- package/dist/user/models/get-user-completed-games-response.model.d.ts +1 -1
- package/dist/user/models/get-user-game-rank-and-score-response.model.d.ts +1 -1
- package/dist/user/models/get-user-progress-response.model.d.ts +1 -1
- package/dist/user/models/get-user-recently-played-games-response.model.d.ts +2 -1
- package/dist/user/models/user-claims-response.model.d.ts +1 -1
- package/dist/user/models/user-claims.model.d.ts +1 -1
- package/dist/user/models/user-completed-games.model.d.ts +2 -3
- package/dist/user/models/user-game-rank-and-score.model.d.ts +2 -3
- package/dist/user/models/user-progress.model.d.ts +2 -3
- package/dist/user/models/user-recently-played-games.model.d.ts +3 -3
- package/dist/user/models/user-summary.model.d.ts +5 -6
- package/dist/utils/internal/id.model.d.ts +1 -0
- package/dist/utils/internal/index.d.ts +1 -0
- package/package.json +32 -27
- package/src/__playground.ts +25 -12
- package/src/achievement/getAchievementUnlocks.test.ts +48 -16
- package/src/achievement/getAchievementUnlocks.ts +4 -3
- package/src/achievement/models/achievement-unlock-entity.model.ts +19 -0
- package/src/achievement/models/get-achievement-unlocks-response.model.ts +17 -1
- package/src/console/getGameList.ts +2 -2
- package/src/feed/getTicketData.ts +4 -3
- package/src/feed/models/most-ticketed-games.model.ts +1 -1
- package/src/game/getAchievementCount.ts +2 -1
- package/src/game/getAchievementDistribution.test.ts +2 -4
- package/src/game/getAchievementDistribution.ts +2 -1
- package/src/game/getGame.ts +2 -1
- package/src/game/getGameExtended.ts +2 -1
- package/src/game/getGameRankAndScore.ts +2 -1
- package/src/game/getGameRating.ts +2 -1
- package/src/user/getAchievementsEarnedBetween.ts +19 -19
- package/src/user/getGameInfoAndUserProgress.ts +2 -1
- package/src/user/getUserClaims.ts +1 -1
- package/src/user/getUserCompletedGames.ts +1 -1
- package/src/user/getUserGameRankAndScore.ts +2 -1
- package/src/user/getUserPoints.ts +1 -1
- package/src/user/getUserProgress.ts +5 -4
- package/src/user/getUserRecentlyPlayedGames.test.ts +4 -2
- package/src/user/getUserRecentlyPlayedGames.ts +2 -1
- package/src/user/models/get-user-recently-played-games-response.model.ts +1 -0
- package/src/user/models/user-completed-games.model.ts +1 -1
- package/src/user/models/user-game-rank-and-score.model.ts +1 -1
- package/src/user/models/user-progress.model.ts +1 -1
- package/src/user/models/user-recently-played-games.model.ts +2 -1
- package/src/user/models/user-summary.model.ts +5 -5
- package/src/utils/internal/id.model.ts +1 -0
- package/src/utils/internal/index.ts +1 -0
- package/src/utils/internal/serializeProperties.ts +1 -1
package/dist/__playground.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { ID } from "../utils/internal";
|
|
1
2
|
import type { AuthObject } from "../utils/public";
|
|
2
3
|
import type { AchievementUnlockEntity } from "./models";
|
|
3
4
|
/**
|
|
@@ -39,7 +40,7 @@ import type { AchievementUnlockEntity } from "./models";
|
|
|
39
40
|
* ```
|
|
40
41
|
*/
|
|
41
42
|
export declare const getAchievementUnlocks: (authorization: AuthObject, payload: {
|
|
42
|
-
achievementId:
|
|
43
|
+
achievementId: ID;
|
|
43
44
|
offset?: number;
|
|
44
45
|
count?: number;
|
|
45
46
|
}) => Promise<AchievementUnlockEntity[]>;
|
|
@@ -4,3 +4,26 @@ export interface AchievementUnlockEntity {
|
|
|
4
4
|
dateAwarded: string;
|
|
5
5
|
hardcoreMode: boolean;
|
|
6
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
|
+
}
|
|
@@ -4,5 +4,27 @@ interface AchievementUnlocksResponseEntity {
|
|
|
4
4
|
DateAwarded: string;
|
|
5
5
|
HardcoreMode: string;
|
|
6
6
|
}
|
|
7
|
-
export
|
|
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
|
+
}
|
|
8
30
|
export {};
|