@j4ckofalltrades/steam-webapi-ts
Version:
Isomorphic Steam WebAPI wrapper in TypeScript
205 lines (204 loc) • 9.99 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_RECENTLY_PLAYED_GAMES = "/IPlayerService/GetRecentlyPlayedGames/v1";
export var GET_OWNED_GAMES = "/IPlayerService/GetOwnedGames/v1";
export var GET_STEAM_LEVEL = "/IPlayerService/GetSteamLevel/v1";
export var GET_BADGES = "/IPlayerService/GetBadges/v1";
export var GET_COMMUNITY_BADGE_PROGRESS = "/IPlayerService/GetCommunityBadgeProgress/v1";
export var IS_PLAYING_SHARED_GAME = "/IPlayerService/IsPlayingSharedGame/v1";
/**
* Provides additional methods for interacting with Steam Users.
*/
var IPlayerServiceWrapper = /** @class */ (function () {
/* istanbul ignore next */
/**
* @param apiKey Steam Web API key.
* @param webApiClient Http client.
*/
function IPlayerServiceWrapper(apiKey, webApiClient) {
if (webApiClient === void 0) { webApiClient = defaultWebApiClient; }
this.apiKey = apiKey;
this.webApiClient = webApiClient;
}
/**
* Gets information about a player's recently played games.
*
* @param steamid The player we're asking about.
* @param count The number of games to return (0/unset: all).
*/
IPlayerServiceWrapper.prototype.getRecentlyPlayedGames = function (steamid, count) {
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_RECENTLY_PLAYED_GAMES, {
params: {
key: this.apiKey,
steamid: steamid,
count: count,
},
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Return a list of games owned by the player.
*
* @param steamid The player we're asking about.
* @param request (Optional) Additional request parameters.
*/
IPlayerServiceWrapper.prototype.getOwnedGames = function (steamid, request) {
return __awaiter(this, void 0, void 0, function () {
var requestParams, appids, i, include_appinfo, include_played_free_games;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
requestParams = {};
appids = (request === null || request === void 0 ? void 0 : request.appids_filter) !== undefined ? request.appids_filter : [];
for (i = 0; i < appids.length; i++) {
requestParams = __assign(__assign({}, requestParams), (_a = {}, _a["appids_filter[".concat(i, "]")] = appids[i], _a));
}
include_appinfo = (request === null || request === void 0 ? void 0 : request.include_appinfo) !== undefined ? request.include_appinfo : false;
include_played_free_games = (request === null || request === void 0 ? void 0 : request.include_played_free_games) !== undefined ? request.include_played_free_games : false;
return [4 /*yield*/, this.webApiClient.get(GET_OWNED_GAMES, {
params: __assign(__assign({}, requestParams), { key: this.apiKey, steamid: steamid, include_appinfo: include_appinfo, include_played_free_games: include_played_free_games }),
})];
case 1: return [2 /*return*/, _b.sent()];
}
});
});
};
/**
* Returns the Steam Level of a user.
*
* @param steamid The player we're asking about.
*/
IPlayerServiceWrapper.prototype.getSteamLevel = function (steamid) {
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_STEAM_LEVEL, {
params: {
key: this.apiKey,
steamid: steamid,
},
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Gets badges that are owned by a specific user.
*
* @param steamid The player we're asking about.
*/
IPlayerServiceWrapper.prototype.getBadges = function (steamid) {
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_BADGES, {
params: {
key: this.apiKey,
steamid: steamid,
},
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Gets all the quests needed to get the specified badge, and which are completed.
*
* @param steamid The player we're asking about.
* @param badge The badge we're asking about.
*/
IPlayerServiceWrapper.prototype.getCommunityBadgeProgress = function (steamid, badge) {
return __awaiter(this, void 0, void 0, function () {
var badgeid;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
badgeid = badge !== undefined ? { badgeid: badge } : undefined;
return [4 /*yield*/, this.webApiClient.get(GET_COMMUNITY_BADGE_PROGRESS, {
params: __assign({ key: this.apiKey, steamid: steamid }, badgeid),
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Returns valid lender SteamID if game currently played is borrowed.
*
* @param steamid The player we're asking about.
* @param appid_playing The game player is currently playing.
*/
IPlayerServiceWrapper.prototype.isPlayingSharedGame = function (steamid, appid_playing) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.webApiClient.get(IS_PLAYING_SHARED_GAME, {
params: {
key: this.apiKey,
steamid: steamid,
appid_playing: appid_playing,
},
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
return IPlayerServiceWrapper;
}());
export { IPlayerServiceWrapper };