@j4ckofalltrades/steam-webapi-ts
Version:
Isomorphic Steam WebAPI wrapper in TypeScript
202 lines (201 loc) • 9.55 kB
JavaScript
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
import { defaultWebApiClient } from "../core/webApiClient";
export var GET_GLOBAL_ACHIEVEMENT_PERCENTAGES_FOR_APP = "/ISteamUserStats/GetGlobalAchievementPercentagesForApp/v2";
export var GET_GLOBAL_STATS_FOR_GAME = "/ISteamUserStats/GetGlobalStatsForGame/v1";
export var GET_NUMBER_OF_CURRENT_PLAYERS = "/ISteamUserStats/GetNumberOfCurrentPlayers/v1";
export var GET_PLAYER_ACHIEVEMENTS = "/ISteamUserStats/GetPlayerAchievements/v1";
export var GET_SCHEMA_FOR_GAME = "/ISteamUserStats/GetSchemaForGame/v2";
export var GET_USER_STATS_FOR_GAME = "/ISteamUserStats/GetUserStatsForGame/v2";
/**
* Used to access information about users.
*/
var ISteamUserStatsWrapper = /** @class */ (function () {
/* istanbul ignore next */
/**
* @param apiKey Steam Web API key.
* @param webApiClient HTTP client.
*/
function ISteamUserStatsWrapper(apiKey, webApiClient) {
if (webApiClient === void 0) { webApiClient = defaultWebApiClient; }
this.apiKey = apiKey;
this.webApiClient = webApiClient;
}
/**
* Retrieves the global achievement percentages for the specified app.
*
* @param gameid GameID to retrieve the achievement percentages for. This can be the ID of any Steamworks game
* with achievements available.
*/
ISteamUserStatsWrapper.prototype.getGlobalAchievementPercentagesForApp = function (gameid) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.webApiClient.get(GET_GLOBAL_ACHIEVEMENT_PERCENTAGES_FOR_APP, {
params: {
gameid: gameid,
},
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Gets the total number of players currently active in the specified app on Steam.
*
* @param appid AppID that we're getting user count for.
*/
ISteamUserStatsWrapper.prototype.getNumberOfCurrentPlayers = function (appid) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.webApiClient.get(GET_NUMBER_OF_CURRENT_PLAYERS, {
params: {
appid: appid,
},
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Gets the list of achievements the specified user has unlocked in an app.
*
* @param steamid SteamID of user.
* @param appid AppID to get achievements for.
* @param lang Language to return strings for.
*/
ISteamUserStatsWrapper.prototype.getPlayerAchievements = function (steamid, appid, lang) {
return __awaiter(this, void 0, void 0, function () {
var l;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
l = lang !== undefined ? { l: lang } : undefined;
return [4 /*yield*/, this.webApiClient.get(GET_PLAYER_ACHIEVEMENTS, {
params: __assign({ steamid: steamid, appid: appid }, l),
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Gets the complete list of stats and achievements for the specified game.
*
* @param appid AppId of the game.
* @param lang Localized language to return (English, French, etc.).
*/
ISteamUserStatsWrapper.prototype.getSchemaForGame = function (appid, lang) {
return __awaiter(this, void 0, void 0, function () {
var l;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
l = lang !== undefined ? { l: lang } : undefined;
return [4 /*yield*/, this.webApiClient.get(GET_SCHEMA_FOR_GAME, {
params: __assign({ key: this.apiKey, appid: appid }, l),
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Gets the list of stats that the specified user has set in an app.
*
* @param steamid SteamId of user.
* @param appid AppId of game.
*/
ISteamUserStatsWrapper.prototype.getUserStatsForGame = function (steamid, appid) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.webApiClient.get(GET_USER_STATS_FOR_GAME, {
params: {
key: this.apiKey,
steamid: steamid,
appid: appid,
},
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Retrieves the global stats percentages for the specified app.
*
* @param appid AppID that we're getting global stats for.
* @param count Number of stats get data for.
* @param stats Names of stat to get data for.
*/
ISteamUserStatsWrapper.prototype.getGlobalStatsForGame = function (appid, count, stats) {
return __awaiter(this, void 0, void 0, function () {
var requestParams, i;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
requestParams = {};
for (i = 0; i < stats.length; i++) {
requestParams = __assign(__assign({}, requestParams), (_a = {}, _a["name[".concat(i, "]")] = stats[i], _a));
}
return [4 /*yield*/, this.webApiClient.get(GET_GLOBAL_STATS_FOR_GAME, {
params: __assign(__assign({}, requestParams), { appid: appid, count: count }),
})];
case 1: return [2 /*return*/, _b.sent()];
}
});
});
};
return ISteamUserStatsWrapper;
}());
export { ISteamUserStatsWrapper };