speedruncom.js 1.1.1 → 1.2.1

package/dist/Client.js

@@ -0,0 +1,664 @@
+import axios from 'axios';
+const BASE_USER_AGENT = 'speedruncom.js';
+const BASE_URL = 'https://www.speedrun.com/api/v2/';
+const HEADERS = {
+    'Accept-Language': 'en',
+    'Accept': 'application/json'
+};
+const isBrowser = typeof window !== 'undefined';
+const objectToBase64 = (obj) => {
+    const jsonString = JSON.stringify(obj).replace(/\s+/g, '');
+    return Buffer.from(jsonString).toString('base64');
+};
+class APIError extends Error {
+    constructor(message, status) {
+        super(message);
+        this.message = message;
+        this.status = status;
+    }
+}
+class Client {
+    constructor(config) {
+        /**
+         * `AxiosInstance` used on instance-called methods (called with `POST`).
+         */
+        this.axiosClient = axios.create({
+            baseURL: BASE_URL,
+            method: 'POST',
+            withCredentials: true,
+            headers: HEADERS
+        });
+        this.headers = this.axiosClient.defaults.headers.common;
+        if (config)
+            this.config(config);
+        this.axiosClient.interceptors.response.use((response) => response, (error) => {
+            const data = error.response.data;
+            throw new APIError(data.error || 'Unknown error', error.response.status);
+        });
+    }
+    config(config) {
+        if (!isBrowser)
+            this.headers['User-Agent'] = BASE_USER_AGENT + (config.userAgent ? `/${config.userAgent}` : '');
+        if (config.PHPSESSID) {
+            if (isBrowser) {
+                console.error('You cannot use a PHPSESSID to authenticate in a browser environment.');
+            }
+            else {
+                this.headers['Cookie'] = `PHPSESSID=${config.PHPSESSID}`;
+            }
+        }
+    }
+    async request(endpoint, params = {}) {
+        const response = await this.axiosClient.post(endpoint, params);
+        const cookie = response.headers['set-cookie'];
+        if (cookie && !isBrowser)
+            this.headers['Cookie'] = cookie[0].split(';')[0];
+        return response.data;
+    }
+    static async request(endpoint, params = {}) {
+        return (await this.axiosClient.get(`${endpoint}?_r=${objectToBase64(params)}`)).data;
+    }
+    //Built-in endpoints for auth
+    /**
+     * Attempts to authorize your cookies if using a browser, or authorizes this Client if otherwise.
+     * If the account has two factor authentication, you have to use `setToken` with the token sent to the account's email address.
+     */
+    async login(username, password) {
+        this.username = username;
+        this.password = password;
+        return await this.request('PutAuthLogin', {
+            name: username,
+            password
+        });
+    }
+    /**
+     * Attempts to authorize your cookies if using a browser, or authorizes this Client if otherwise, with the token that `login()` sent to the account's email address.
+     * @param token The 5-digit code sent to your email after a successful `login()`.
+     */
+    async setToken(token) {
+        return await this.request('PutAuthLogin', {
+            name: this.username,
+            password: this.password,
+            token
+        });
+    }
+    /**
+     * Attempts to remove the PHPSESSID cookie if using a browser, otherwise removes your Client's authentication.
+     */
+    async logout() {
+        if (isBrowser)
+            return await this.request('PutAuthLogout');
+        delete this.headers['Cookie'];
+    }
+    // Endpoints (auto-generated with build-client)
+    async GetGameLeaderboard2(params) {
+        return await this.request('GetGameLeaderboard2', params);
+    }
+    static async GetGameLeaderboard2(params) {
+        return await this.request('GetGameLeaderboard2', params);
+    }
+    async GetGameLeaderboard(params) {
+        return await this.request('GetGameLeaderboard', params);
+    }
+    static async GetGameLeaderboard(params) {
+        return await this.request('GetGameLeaderboard', params);
+    }
+    async GetGameData(params) {
+        return await this.request('GetGameData', params);
+    }
+    static async GetGameData(params) {
+        return await this.request('GetGameData', params);
+    }
+    async GetGameSummary(params) {
+        return await this.request('GetGameSummary', params);
+    }
+    static async GetGameSummary(params) {
+        return await this.request('GetGameSummary', params);
+    }
+    async GetGameRecordHistory(params) {
+        return await this.request('GetGameRecordHistory', params);
+    }
+    static async GetGameRecordHistory(params) {
+        return await this.request('GetGameRecordHistory', params);
+    }
+    async GetSearch(params) {
+        return await this.request('GetSearch', params);
+    }
+    static async GetSearch(params) {
+        return await this.request('GetSearch', params);
+    }
+    async GetLatestLeaderboard(params) {
+        return await this.request('GetLatestLeaderboard', params);
+    }
+    static async GetLatestLeaderboard(params) {
+        return await this.request('GetLatestLeaderboard', params);
+    }
+    async GetRun(params) {
+        return await this.request('GetRun', params);
+    }
+    static async GetRun(params) {
+        return await this.request('GetRun', params);
+    }
+    async GetUserSummary(params) {
+        return await this.request('GetUserSummary', params);
+    }
+    static async GetUserSummary(params) {
+        return await this.request('GetUserSummary', params);
+    }
+    async GetUserComments(params) {
+        return await this.request('GetUserComments', params);
+    }
+    static async GetUserComments(params) {
+        return await this.request('GetUserComments', params);
+    }
+    async GetUserThreads(params) {
+        return await this.request('GetUserThreads', params);
+    }
+    static async GetUserThreads(params) {
+        return await this.request('GetUserThreads', params);
+    }
+    async GetUserPopoverData(params) {
+        return await this.request('GetUserPopoverData', params);
+    }
+    static async GetUserPopoverData(params) {
+        return await this.request('GetUserPopoverData', params);
+    }
+    async GetTitleList() {
+        return await this.request('GetTitleList');
+    }
+    static async GetTitleList() {
+        return await this.request('GetTitleList');
+    }
+    async GetTitle(params) {
+        return await this.request('GetTitle', params);
+    }
+    static async GetTitle(params) {
+        return await this.request('GetTitle', params);
+    }
+    async GetArticleList(params) {
+        return await this.request('GetArticleList', params);
+    }
+    static async GetArticleList(params) {
+        return await this.request('GetArticleList', params);
+    }
+    async GetArticle(params) {
+        return await this.request('GetArticle', params);
+    }
+    static async GetArticle(params) {
+        return await this.request('GetArticle', params);
+    }
+    async GetGameList(params) {
+        return await this.request('GetGameList', params);
+    }
+    static async GetGameList(params) {
+        return await this.request('GetGameList', params);
+    }
+    async GetPlatformList() {
+        return await this.request('GetPlatformList');
+    }
+    static async GetPlatformList() {
+        return await this.request('GetPlatformList');
+    }
+    async GetHomeSummary() {
+        return await this.request('GetHomeSummary');
+    }
+    static async GetHomeSummary() {
+        return await this.request('GetHomeSummary');
+    }
+    async GetSeriesList(params) {
+        return await this.request('GetSeriesList', params);
+    }
+    static async GetSeriesList(params) {
+        return await this.request('GetSeriesList', params);
+    }
+    async GetSeriesSummary(params) {
+        return await this.request('GetSeriesSummary', params);
+    }
+    static async GetSeriesSummary(params) {
+        return await this.request('GetSeriesSummary', params);
+    }
+    async GetGameLevelSummary(params) {
+        return await this.request('GetGameLevelSummary', params);
+    }
+    static async GetGameLevelSummary(params) {
+        return await this.request('GetGameLevelSummary', params);
+    }
+    async GetGameRandom() {
+        return await this.request('GetGameRandom');
+    }
+    static async GetGameRandom() {
+        return await this.request('GetGameRandom');
+    }
+    async GetGuideList(params) {
+        return await this.request('GetGuideList', params);
+    }
+    static async GetGuideList(params) {
+        return await this.request('GetGuideList', params);
+    }
+    async GetGuide(params) {
+        return await this.request('GetGuide', params);
+    }
+    static async GetGuide(params) {
+        return await this.request('GetGuide', params);
+    }
+    async GetNewsList(params) {
+        return await this.request('GetNewsList', params);
+    }
+    static async GetNewsList(params) {
+        return await this.request('GetNewsList', params);
+    }
+    async GetNews(params) {
+        return await this.request('GetNews', params);
+    }
+    static async GetNews(params) {
+        return await this.request('GetNews', params);
+    }
+    async GetResourceList(params) {
+        return await this.request('GetResourceList', params);
+    }
+    static async GetResourceList(params) {
+        return await this.request('GetResourceList', params);
+    }
+    async GetStreamList(params) {
+        return await this.request('GetStreamList', params);
+    }
+    static async GetStreamList(params) {
+        return await this.request('GetStreamList', params);
+    }
+    async GetThreadList(params) {
+        return await this.request('GetThreadList', params);
+    }
+    static async GetThreadList(params) {
+        return await this.request('GetThreadList', params);
+    }
+    async GetThreadStateByCommentId(params) {
+        return await this.request('GetThreadStateByCommentId', params);
+    }
+    static async GetThreadStateByCommentId(params) {
+        return await this.request('GetThreadStateByCommentId', params);
+    }
+    async GetChallenge(params) {
+        return await this.request('GetChallenge', params);
+    }
+    static async GetChallenge(params) {
+        return await this.request('GetChallenge', params);
+    }
+    async GetChallengeLeaderboard(params) {
+        return await this.request('GetChallengeLeaderboard', params);
+    }
+    static async GetChallengeLeaderboard(params) {
+        return await this.request('GetChallengeLeaderboard', params);
+    }
+    async GetChallengeGlobalRankingList() {
+        return await this.request('GetChallengeGlobalRankingList');
+    }
+    static async GetChallengeGlobalRankingList() {
+        return await this.request('GetChallengeGlobalRankingList');
+    }
+    async GetChallengeRun(params) {
+        return await this.request('GetChallengeRun', params);
+    }
+    static async GetChallengeRun(params) {
+        return await this.request('GetChallengeRun', params);
+    }
+    async GetUserLeaderboard(params) {
+        return await this.request('GetUserLeaderboard', params);
+    }
+    static async GetUserLeaderboard(params) {
+        return await this.request('GetUserLeaderboard', params);
+    }
+    async GetUserModeration(params) {
+        return await this.request('GetUserModeration', params);
+    }
+    static async GetUserModeration(params) {
+        return await this.request('GetUserModeration', params);
+    }
+    async GetCommentList(params) {
+        return await this.request('GetCommentList', params);
+    }
+    static async GetCommentList(params) {
+        return await this.request('GetCommentList', params);
+    }
+    async GetThread(params) {
+        return await this.request('GetThread', params);
+    }
+    static async GetThread(params) {
+        return await this.request('GetThread', params);
+    }
+    async GetStaticData() {
+        return await this.request('GetStaticData');
+    }
+    static async GetStaticData() {
+        return await this.request('GetStaticData');
+    }
+    async GetForumList() {
+        return await this.request('GetForumList');
+    }
+    static async GetForumList() {
+        return await this.request('GetForumList');
+    }
+    async PutAuthLogin(params) {
+        return await this.request('PutAuthLogin', params);
+    }
+    async GetSession() {
+        return await this.request('GetSession');
+    }
+    async PutSessionPing() {
+        return await this.request('PutSessionPing');
+    }
+    async GetAuditLogList(params) {
+        return await this.request('GetAuditLogList', params);
+    }
+    async GetGameSettings(params) {
+        return await this.request('GetGameSettings', params);
+    }
+    async PutGameSettings(params) {
+        return await this.request('PutGameSettings', params);
+    }
+    async PutCategory(params) {
+        return await this.request('PutCategory', params);
+    }
+    async PutCategoryUpdate(params) {
+        return await this.request('PutCategoryUpdate', params);
+    }
+    async PutCategoryArchive(params) {
+        return await this.request('PutCategoryArchive', params);
+    }
+    async PutCategoryRestore(params) {
+        return await this.request('PutCategoryRestore', params);
+    }
+    async PutCategoryOrder(params) {
+        return await this.request('PutCategoryOrder', params);
+    }
+    async PutLevel(params) {
+        return await this.request('PutLevel', params);
+    }
+    async PutLevelUpdate(params) {
+        return await this.request('PutLevelUpdate', params);
+    }
+    async PutLevelArchive(params) {
+        return await this.request('PutLevelArchive', params);
+    }
+    async PutLevelRestore(params) {
+        return await this.request('PutLevelRestore', params);
+    }
+    async PutLevelOrder(params) {
+        return await this.request('PutLevelOrder', params);
+    }
+    async PutVariable(params) {
+        return await this.request('PutVariable', params);
+    }
+    async PutVariableUpdate(params) {
+        return await this.request('PutVariableUpdate', params);
+    }
+    async PutVariableArchive(params) {
+        return await this.request('PutVariableArchive', params);
+    }
+    async PutVariableRestore(params) {
+        return await this.request('PutVariableRestore', params);
+    }
+    async PutVariableOrder(params) {
+        return await this.request('PutVariableOrder', params);
+    }
+    async PutVariableApplyDefault(params) {
+        return await this.request('PutVariableApplyDefault', params);
+    }
+    async PutNews(params) {
+        return await this.request('PutNews', params);
+    }
+    async PutNewsUpdate(params) {
+        return await this.request('PutNewsUpdate', params);
+    }
+    async PutNewsDelete(params) {
+        return await this.request('PutNewsDelete', params);
+    }
+    async PutGuide(params) {
+        return await this.request('PutGuide', params);
+    }
+    async PutGuideUpdate(params) {
+        return await this.request('PutGuideUpdate', params);
+    }
+    async PutGuideDelete(params) {
+        return await this.request('PutGuideDelete', params);
+    }
+    async PutResource(params) {
+        return await this.request('PutResource', params);
+    }
+    async PutResourceUpdate(params) {
+        return await this.request('PutResourceUpdate', params);
+    }
+    async PutResourceDelete(params) {
+        return await this.request('PutResourceDelete', params);
+    }
+    async GetModerationGames() {
+        return await this.request('GetModerationGames');
+    }
+    async GetModerationRuns(params) {
+        return await this.request('GetModerationRuns', params);
+    }
+    async PutRunAssignee(params) {
+        return await this.request('PutRunAssignee', params);
+    }
+    async PutRunDelete(params) {
+        return await this.request('PutRunDelete', params);
+    }
+    async PutRunVerification(params) {
+        return await this.request('PutRunVerification', params);
+    }
+    async PutRunVideoState(params) {
+        return await this.request('PutRunVideoState', params);
+    }
+    async GetRunSettings(params) {
+        return await this.request('GetRunSettings', params);
+    }
+    async PutRunSettings(params) {
+        return await this.request('PutRunSettings', params);
+    }
+    async GetConversations() {
+        return await this.request('GetConversations');
+    }
+    async GetConversationMessages(params) {
+        return await this.request('GetConversationMessages', params);
+    }
+    async PutConversation(params) {
+        return await this.request('PutConversation', params);
+    }
+    async PutConversationMessage(params) {
+        return await this.request('PutConversationMessage', params);
+    }
+    async PutConversationLeave(params) {
+        return await this.request('PutConversationLeave', params);
+    }
+    async PutConversationReport(params) {
+        return await this.request('PutConversationReport', params);
+    }
+    async GetNotifications() {
+        return await this.request('GetNotifications');
+    }
+    async PutNotificationsRead() {
+        return await this.request('PutNotificationsRead');
+    }
+    async PutGameFollower(params) {
+        return await this.request('PutGameFollower', params);
+    }
+    async PutGameFollowerDelete(params) {
+        return await this.request('PutGameFollowerDelete', params);
+    }
+    async PutUserFollower(params) {
+        return await this.request('PutUserFollower', params);
+    }
+    async PutUserFollowerDelete(params) {
+        return await this.request('PutUserFollowerDelete', params);
+    }
+    async GetUserSettings(params) {
+        return await this.request('GetUserSettings', params);
+    }
+    async PutUserSettings(params) {
+        return await this.request('PutUserSettings', params);
+    }
+    async PutUserUpdateFeaturedRun(params) {
+        return await this.request('PutUserUpdateFeaturedRun', params);
+    }
+    async PutUserUpdateGameOrdering(params) {
+        return await this.request('PutUserUpdateGameOrdering', params);
+    }
+    async GetUserApiKey(params) {
+        return await this.request('GetUserApiKey', params);
+    }
+    async GetUserFollowers(params) {
+        return await this.request('GetUserFollowers', params);
+    }
+    async GetUserFollowingGames(params) {
+        return await this.request('GetUserFollowingGames', params);
+    }
+    async GetUserFollowingUsers(params) {
+        return await this.request('GetUserFollowingUsers', params);
+    }
+    async GetUserGameBoostData(params) {
+        return await this.request('GetUserGameBoostData', params);
+    }
+    async GetUserDataExport(params) {
+        return await this.request('GetUserDataExport', params);
+    }
+    async PutGameFollowerOrder(params) {
+        return await this.request('PutGameFollowerOrder', params);
+    }
+    async PutArticleSubmission(params) {
+        return await this.request('PutArticleSubmission', params);
+    }
+    async GetCommentable(params) {
+        return await this.request('GetCommentable', params);
+    }
+    async PutComment(params) {
+        return await this.request('PutComment', params);
+    }
+    async PutLike(params) {
+        return await this.request('PutLike', params);
+    }
+    async PutCommentableSettings(params) {
+        return await this.request('PutCommentableSettings', params);
+    }
+    async GetThreadReadStatus(params) {
+        return await this.request('GetThreadReadStatus', params);
+    }
+    async PutThreadRead(params) {
+        return await this.request('PutThreadRead', params);
+    }
+    async GetForumReadStatus(params) {
+        return await this.request('GetForumReadStatus', params);
+    }
+    async GetThemeSettings(params) {
+        return await this.request('GetThemeSettings', params);
+    }
+    async PutThemeSettings(params) {
+        return await this.request('PutThemeSettings', params);
+    }
+    async GetUserSupporterData(params) {
+        return await this.request('GetUserSupporterData', params);
+    }
+    async PutUserSupporterNewSubscription(params) {
+        return await this.request('PutUserSupporterNewSubscription', params);
+    }
+    async PutGameBoostGrant(params) {
+        return await this.request('PutGameBoostGrant', params);
+    }
+    async PutAdvertiseContact(params) {
+        return await this.request('PutAdvertiseContact', params);
+    }
+    async GetTickets(params) {
+        return await this.request('GetTickets', params);
+    }
+    async GetSeriesSettings(params) {
+        return await this.request('GetSeriesSettings', params);
+    }
+    async GetUserBlocks() {
+        return await this.request('GetUserBlocks');
+    }
+    async PutUserBlock(params) {
+        return await this.request('PutUserBlock', params);
+    }
+    async PutGame(params) {
+        return await this.request('PutGame', params);
+    }
+    async PutGameModerator() {
+        return await this.request('PutGameModerator');
+    }
+    async PutGameModeratorDelete(params) {
+        return await this.request('PutGameModeratorDelete', params);
+    }
+    async PutSeriesGame(params) {
+        return await this.request('PutSeriesGame', params);
+    }
+    async PutSeriesGameDelete(params) {
+        return await this.request('PutSeriesGameDelete', params);
+    }
+    async PutSeriesModerator() {
+        return await this.request('PutSeriesModerator');
+    }
+    async PutSeriesModeratorUpdate() {
+        return await this.request('PutSeriesModeratorUpdate');
+    }
+    async PutSeriesModeratorDelete() {
+        return await this.request('PutSeriesModeratorDelete');
+    }
+    async PutSeriesSettings(params) {
+        return await this.request('PutSeriesSettings', params);
+    }
+    async PutTicket(params) {
+        return await this.request('PutTicket', params);
+    }
+    async PutTicketNote(params) {
+        return await this.request('PutTicketNote', params);
+    }
+    async PutUserSocialConnection(params) {
+        return await this.request('PutUserSocialConnection', params);
+    }
+    async PutUserSocialConnectionDelete(params) {
+        return await this.request('PutUserSocialConnectionDelete', params);
+    }
+    async PutUserSocialConnectionSsoExchange(params) {
+        return await this.request('PutUserSocialConnectionSsoExchange', params);
+    }
+    async PutUserUpdatePassword(params) {
+        return await this.request('PutUserUpdatePassword', params);
+    }
+    async PutUserUpdateEmail(params) {
+        return await this.request('PutUserUpdateEmail', params);
+    }
+    async PutUserUpdateName(params) {
+        return await this.request('PutUserUpdateName', params);
+    }
+    async PutUserDelete(params) {
+        return await this.request('PutUserDelete', params);
+    }
+    async PutCommentUpdate(params) {
+        return await this.request('PutCommentUpdate', params);
+    }
+    async PutCommentDelete(params) {
+        return await this.request('PutCommentDelete', params);
+    }
+    async PutCommentRestore(params) {
+        return await this.request('PutCommentRestore', params);
+    }
+    async PutThread(params) {
+        return await this.request('PutThread', params);
+    }
+    async PutThreadLocked(params) {
+        return await this.request('PutThreadLocked', params);
+    }
+    async PutThreadSticky(params) {
+        return await this.request('PutThreadSticky', params);
+    }
+    async PutThreadDelete(params) {
+        return await this.request('PutThreadDelete', params);
+    }
+}
+/**
+ * `AxiosInstance` used on Client-called methods (called with `GET`).
+ */
+Client.axiosClient = axios.create({
+    baseURL: BASE_URL,
+    method: 'GET',
+    headers: HEADERS
+});
+export default Client;

package/dist/build-client.d.ts

@@ -0,0 +1 @@
+export {};