@j4ckofalltrades/steam-webapi-ts
Version:
Isomorphic Steam WebAPI wrapper in TypeScript
166 lines (165 loc) • 7.79 kB
JavaScript
"use strict";
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 };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ISteamUserWrapper = exports.RESOLVE_VANITY_URL = exports.GET_USER_GROUP_LIST = exports.GET_PLAYER_BANS = exports.GET_FRIEND_LIST = exports.GET_PLAYER_SUMMARIES = void 0;
var webApiClient_1 = require("../core/webApiClient");
exports.GET_PLAYER_SUMMARIES = "/ISteamUser/GetPlayerSummaries/v2";
exports.GET_FRIEND_LIST = "ISteamUser/GetFriendList/v1";
exports.GET_PLAYER_BANS = "ISteamUser/GetPlayerBans/v1";
exports.GET_USER_GROUP_LIST = "ISteamUser/GetUserGroupList/v1";
exports.RESOLVE_VANITY_URL = "ISteamUser/ResolveVanityURL/v1";
/**
* Used to access information and interact with users.
*/
var ISteamUserWrapper = /** @class */ (function () {
/* istanbul ignore next */
/**
* @param apiKey Steam Web API key.
* @param webApiClient Http client.
*/
function ISteamUserWrapper(apiKey, webApiClient) {
if (webApiClient === void 0) { webApiClient = webApiClient_1.defaultWebApiClient; }
this.apiKey = apiKey;
this.webApiClient = webApiClient;
}
/**
* User friend list.
*
* @param steamid The 64-bit ID of the user to retrieve a list for.
* @param relationship Filter by a given role. Possible options are *all* (All roles), *friend*.
* */
ISteamUserWrapper.prototype.getFriendList = function (steamid, relationship) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.webApiClient.get(exports.GET_FRIEND_LIST, {
params: {
key: this.apiKey,
steamid: steamid,
relationship: relationship,
},
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Player ban/probation status.
*
* @param steamids Comma-delimited list of steam IDs.
*/
ISteamUserWrapper.prototype.getPlayerBans = function (steamids) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.webApiClient.get(exports.GET_PLAYER_BANS, {
params: {
key: this.apiKey,
steamids: JSON.stringify(steamids),
},
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* User profile data.
*
* @param steamids Comma-delimited list of steam IDs.
*/
ISteamUserWrapper.prototype.getPlayerSummaries = function (steamids) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.webApiClient.get(exports.GET_PLAYER_SUMMARIES, {
params: {
key: this.apiKey,
steamids: JSON.stringify(steamids),
},
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Lists Group ID(s) linked with 64-bit ID.
*
* @param steamid The 64-bit ID of the user.
*/
ISteamUserWrapper.prototype.getUserGroupList = 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(exports.GET_USER_GROUP_LIST, {
params: {
key: this.apiKey,
steamid: steamid,
},
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Resolve vanity URL parts to a 64-bit ID.
*
* @param vanityurl The user's vanity URL that you would like to retrieve a steam ID for,
* e.g. http://steamcommunity.com/id/gabelogannewell would use "gabelogannewell".
*/
ISteamUserWrapper.prototype.resolveVanityURL = function (vanityurl) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.webApiClient.get(exports.RESOLVE_VANITY_URL, {
params: {
key: this.apiKey,
vanityurl: vanityurl,
},
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
return ISteamUserWrapper;
}());
exports.ISteamUserWrapper = ISteamUserWrapper;