@retroachievements/api 0.0.0-development → 1.0.0-rc.0

package/dist/api.esm.js

@@ -1925,6 +1925,152 @@ var getGameInfoAndUserProgress = /*#__PURE__*/function () {
   };
 }();
 
+/**
+ * A call to this function will retrieve a list of
+ * achievement set claims made over the lifetime of a given
+ * user, targeted by their username.
+ *
+ * @param authorization An object containing your userName and webApiKey.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.userName The user for which to retrieve the historical
+ * achievement set claims list for.
+ *
+ * @example
+ * ```
+ * const userClaims = await getUserClaims(
+ *   authorization,
+ *   { userName: "xelnia" }
+ * );
+ * ```
+ *
+ * @returns An array containing all the achievement set claims
+ * made over the lifetime of the given user.
+ */
+
+var getUserClaims = /*#__PURE__*/function () {
+  var _ref = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(authorization, payload) {
+    var userName, url, rawResponse;
+    return _regeneratorRuntime().wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            userName = payload.userName;
+            url = buildRequestUrl(apiBaseUrl, "/API_GetUserClaims.php", authorization, {
+              u: userName
+            });
+            _context.next = 4;
+            return call({
+              url: url
+            });
+
+          case 4:
+            rawResponse = _context.sent;
+            return _context.abrupt("return", serializeProperties(rawResponse, {
+              shouldCastToNumbers: ["ID", "GameID", "ClaimType", "SetType", "Status", "Extension", "Special", "MinutesLeft"]
+            }));
+
+          case 6:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+
+  return function getUserClaims(_x, _x2) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+/**
+ * A call to this function will retrieve completion metadata
+ * about the games a given user has played. It returns two
+ * entries per each game: one for the softcore completion and
+ * one for the hardcore completion. These are designated by
+ * the `hardcoreMode` property on the completion object.
+ *
+ * @param authorization An object containing your userName and webApiKey.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.userName The user for which to retrieve the
+ * completion metadata for.
+ *
+ * @example
+ * ```
+ * const userCompletedGames = await getUserCompletedGames(
+ *   authorization,
+ *   { userName: "xelnia" }
+ * );
+ * ```
+ *
+ * @returns An array containing completion metadata objects
+ * for a given user. Each game contains two completion records,
+ * one for softcore and another for hardcore.
+ * ```json
+ * [
+ *   {
+ *     gameId: 14976,
+ *     title: 'Mortal Kombat',
+ *     imageIcon: '/Images/036812.png',
+ *     consoleId: 27,
+ *     consoleName: 'Arcade',
+ *     maxPossible: 35,
+ *     numAwarded: 13,
+ *     pctWon: 0.3714,
+ *     hardcoreMode: false
+ *   },
+ *   {
+ *     gameId: 14976,
+ *     title: 'Mortal Kombat',
+ *     imageIcon: '/Images/036812.png',
+ *     consoleId: 27,
+ *     consoleName: 'Arcade',
+ *     maxPossible: 35,
+ *     numAwarded: 13,
+ *     pctWon: 0.3714,
+ *     hardcoreMode: true
+ *   },
+ * ]
+ * ```
+ */
+
+var getUserCompletedGames = /*#__PURE__*/function () {
+  var _ref = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(authorization, payload) {
+    var userName, url, rawResponse;
+    return _regeneratorRuntime().wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            userName = payload.userName;
+            url = buildRequestUrl(apiBaseUrl, "/API_GetUserCompletedGames.php", authorization, {
+              u: userName
+            });
+            _context.next = 4;
+            return call({
+              url: url
+            });
+
+          case 4:
+            rawResponse = _context.sent;
+            return _context.abrupt("return", serializeProperties(rawResponse, {
+              shouldCastToNumbers: ["GameID", "ConsoleID", "MaxPossible", "NumAwarded", "PctWon"],
+              shouldMapToBooleans: ["HardcoreMode"]
+            }));
+
+          case 6:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+
+  return function getUserCompletedGames(_x, _x2) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
 /**
  * A call to this function will retrieve metadata about
  * how a particular user has performed/ranked on a particular
@@ -1952,7 +2098,7 @@ var getGameInfoAndUserProgress = /*#__PURE__*/function () {
  * @returns An array containing metadata about the user's
  * rank and score for the target game ID. If metadata
  * cannot be found, the array is empty.
- * ```
+ * ```json
  * [
  *   {
  *     user: "xelnia",
@@ -2329,5 +2475,5 @@ var buildAuthorization = function buildAuthorization(options) {
 }; // This function simply returns what it's given, however the return
 // value has the added benefit of type safety.
 
-export { AchievementDistributionFlags, ClaimSetType, ClaimStatus, ClaimType, buildAuthorization, getAchievementCount, getAchievementDistribution, getAchievementOfTheWeek, getAchievementUnlocks, getAchievementsEarnedBetween, getAchievementsEarnedOnDay, getActiveClaims, getConsoleIds, getGame, getGameExtended, getGameInfoAndUserProgress, getGameList, getGameRankAndScore, getGameRating, getTicketData, getTopTenUsers, getUserGameRankAndScore, getUserPoints, getUserProgress, getUserRecentlyPlayedGames, getUserSummary, call as unsafe_call };
+export { AchievementDistributionFlags, ClaimSetType, ClaimStatus, ClaimType, buildAuthorization, getAchievementCount, getAchievementDistribution, getAchievementOfTheWeek, getAchievementUnlocks, getAchievementsEarnedBetween, getAchievementsEarnedOnDay, getActiveClaims, getConsoleIds, getGame, getGameExtended, getGameInfoAndUserProgress, getGameList, getGameRankAndScore, getGameRating, getTicketData, getTopTenUsers, getUserClaims, getUserCompletedGames, getUserGameRankAndScore, getUserPoints, getUserProgress, getUserRecentlyPlayedGames, getUserSummary, call as unsafe_call };
 //# sourceMappingURL=api.esm.js.map