speedruncom.js 2.0.1 → 2.0.2

package/lib/endpoints/endpoints.get.d.ts

@@ -185,6 +185,17 @@ export default interface GETEndpoints {
          * ID of the user.
          */
         userId: string;
+        /**
+         * The maximum amount of comments to fetch.
+         *
+         * @max Unknown - likely around 99999.
+         * @default Unknown - likely around 99999.
+         */
+        limit?: number;
+        /**
+         * The comment list page, in relation to `limit`.
+         */
+        page?: number;
     };
     /**
      * Gets threads created by a specific user.
@@ -194,6 +205,17 @@ export default interface GETEndpoints {
          * ID of the user.
          */
         userId: string;
+        /**
+         * The maximum amount of comments to fetch.
+         *
+         * @max Unknown - likely around 99999.
+         * @default Unknown - likely around 99999.
+         */
+        limit?: number;
+        /**
+         * The thread list page, in relation to `limit`.
+         */
+        page?: number;
     };
     /**
      * Gets data for user popovers (when you hover over a username).
@@ -204,6 +226,63 @@ export default interface GETEndpoints {
          */
         userId: string;
     };
+    /**
+     * Gets users following a user.
+     */
+    GetUserFollowers: {
+        /**
+         * ID of the user to get followers of.
+         */
+        userId: string;
+        /**
+         * The maximum amount of followers to fetch.
+         *
+         * @max Unknown - likely around 99999.
+         * @default Unknown - likely around 99999.
+         */
+        limit?: number;
+        /**
+         * The follower list page, in relation to `limit`.
+         */
+        page?: number;
+    };
+    /**
+     * Gets games that a user follows.
+     */
+    GetUserFollowingGames: {
+        /**
+         * ID of the user to fetch followed games from.
+         */
+        userId: string;
+        /**
+         * The maximum amount of games to fetch.
+         *
+         * @max Unknown - likely around 99999.
+         * @default Unknown - likely around 99999.
+         */
+        limit?: number;
+        /**
+         * The game list page, in relation to `limit`.
+         */
+        page?: number;
+    };
+    GetUserFollowingUsers: {
+        /**
+         * ID of the user to fetch followed users from.
+         */
+        userId: string;
+        /**
+         * The maximum amount of users to fetch.
+         *
+         * @max Unknown - likely around 99999.
+         * @default Unknown - likely around 99999.
+         */
+        limit?: number;
+        /**
+         * The users list page, in relation to `limit`.
+         */
+        page?: number;
+    };
     /**
      * Gets all Titles in the site.
      */
@@ -497,9 +576,9 @@ export default interface GETEndpoints {
          */
         itemId: string;
         /**
-         * `ItemType` of the item referenced in `itemId`.
+         * `CommentableItemType` of the item referenced in `itemId`.
          */
-        itemType: Enums.ItemType;
+        itemType: Enums.CommentableItemType;
         /**
          * The maximum amount of `Comment`s per page.
          *

package/lib/endpoints/endpoints.post.d.ts

@@ -605,21 +605,6 @@ export default interface POSTEndpoints {
          */
         regenerate: boolean;
     };
-    GetUserFollowers: {
-        userId: string;
-        limit?: number;
-        page?: number;
-    };
-    GetUserFollowingGames: {
-        userId: string;
-        limit?: number;
-        page?: number;
-    };
-    GetUserFollowingUsers: {
-        userId: string;
-        limit?: number;
-        page?: number;
-    };
     /**
      * Get a list of games that a user has boosted.
      */
@@ -657,14 +642,14 @@ export default interface POSTEndpoints {
      */
     GetCommentable: {
         itemId: string;
-        itemType: Enums.ItemType;
+        itemType: Enums.CommentableItemType;
     };
     /**
      * Posts a comment on an item.
      */
     PutComment: {
         itemId: string;
-        itemType: Enums.ItemType;
+        itemType: Enums.CommentableItemType;
         text: string;
     };
     /**
@@ -676,9 +661,9 @@ export default interface POSTEndpoints {
          */
         itemId: string;
         /**
-         * `ItemType` of the item you are liking or removing your like from.
+         * Comment `ItemType`.
          */
-        itemType: Enums.ItemType;
+        itemType: Enums.ItemType.Comment;
         /**
          * Whether you are liking a comment (`true`) or removing your like from a comment (`false`).
          *
@@ -697,7 +682,7 @@ export default interface POSTEndpoints {
         /**
          * `itemType` of the item you are modifying the comment settings on.
          */
-        itemType: Enums.ItemType;
+        itemType: Enums.CommentableItemType;
         disabled: boolean;
         locked: boolean;
     };

package/lib/enums.d.ts

@@ -32,6 +32,13 @@ export declare enum ItemType {
     Challenge = 32,
     ChallengeRun = 33
 }
+export declare enum CommentableItemType {
+    Run = 2,
+    Thread = 7,
+    News = 27,
+    Article = 30,
+    ChallengeRun = 33
+}
 export declare enum ForumType {
     FrontPage = 1,
     Supporter = 2,
@@ -65,14 +72,18 @@ export declare enum SitePowerLevel {
 }
 export declare enum EventType {
     None = "",
+    CategoryArchived = "category-archived",
     CategoryCreated = "category-created",
+    /**
+     * @deprecated Categories can only be archived as of the site revamp.
+     */
     CategoryRemoved = "category-removed",
     CategoryRestored = "category-restored",
     CategoryUpdated = "category-updated",
     CommentCreated = "comment-created",
     CommentDeleted = "comment-deleted",
     /**
-     * New comment updates are not recognized as events as of a few years ago.
+     * @deprecated New comment updates are not recognized as events as of a few years ago.
      */
     CommentUpdated = "comment-updated",
     GameCoversUpdated = "game-covers-updated",
@@ -86,7 +97,53 @@ export declare enum EventType {
     GameRestored = "game-restored",
     GameUpdated = "game-updated",
     GameRequestReviewed = "gamerequest-reviewed",
-    LevelCreated = "level-created"
+    GuideCreated = "guide-created",
+    GuideDeleted = "guide-deleted",
+    LevelArchived = "level-archived",
+    LevelCreated = "level-created",
+    /**
+     * @deprecated Levels can only be archived as of the site revamp.
+     */
+    LevelRemoved = "level-removed",
+    LevelUpdated = "level-updated",
+    ResourceCreated = "resource-created",
+    ResourceDeleted = "resource-deleted",
+    ResourceUpdated = "resource-updated",
+    RunCommentCreated = "run-comment-created",
+    RunCommentDeleted = "run-comment-deleted",
+    RunCommentUpdated = "run-comment-updated",
+    RunAtRiskUpdated = "run-atrisk-updated",
+    RunCreated = "run-created",
+    RunDeleted = "run-deleted",
+    RunReviewed = "run-reviewed",
+    RunUpdated = "run-updated",
+    ThemeCreated = "theme-created",
+    ThemeDeleted = "theme-deleted",
+    ThemeFileDeleted = "theme-file-deleted",
+    ThemeFileUpdated = "theme-file-updated",
+    ThemeUpdated = "theme-updated",
+    ThreadCreated = "thread-created",
+    UserApiKeyUpdated = "user-apikey-updated",
+    UserBanned = "user-banned",
+    UserCommentsWiped = "user-comments-wiped",
+    UserDeleted = "user-deleted",
+    UserModNote = "user-modnote",
+    UserRestored = "user-restored",
+    UserUnbanned = "user-unbanned",
+    UserUpdated = "user-updated",
+    ValueCreated = "value-created",
+    /**
+     * @deprecated Variables can only be archived as of the site revamp.
+     */
+    ValueRemoved = "value-removed",
+    ValueUpdated = "value-updated",
+    VariableArchived = "variable-archived",
+    VariableCreated = "variable-created",
+    /**
+     * @deprecated Variables can only be archived as of the site revamp.
+     */
+    VariableRemoved = "variable-removed",
+    VariableUpdated = "variable-updated"
 }
 export declare enum ChallengeState {
     Draft = 0,

package/lib/enums.js

@@ -35,6 +35,14 @@ export var ItemType;
     ItemType[ItemType["Challenge"] = 32] = "Challenge";
     ItemType[ItemType["ChallengeRun"] = 33] = "ChallengeRun";
 })(ItemType || (ItemType = {}));
+export var CommentableItemType;
+(function (CommentableItemType) {
+    CommentableItemType[CommentableItemType["Run"] = 2] = "Run";
+    CommentableItemType[CommentableItemType["Thread"] = 7] = "Thread";
+    CommentableItemType[CommentableItemType["News"] = 27] = "News";
+    CommentableItemType[CommentableItemType["Article"] = 30] = "Article";
+    CommentableItemType[CommentableItemType["ChallengeRun"] = 33] = "ChallengeRun";
+})(CommentableItemType || (CommentableItemType = {}));
 export var ForumType;
 (function (ForumType) {
     ForumType[ForumType["FrontPage"] = 1] = "FrontPage";
@@ -73,14 +81,18 @@ export var SitePowerLevel;
 export var EventType;
 (function (EventType) {
     EventType["None"] = "";
+    EventType["CategoryArchived"] = "category-archived";
     EventType["CategoryCreated"] = "category-created";
+    /**
+     * @deprecated Categories can only be archived as of the site revamp.
+     */
     EventType["CategoryRemoved"] = "category-removed";
     EventType["CategoryRestored"] = "category-restored";
     EventType["CategoryUpdated"] = "category-updated";
     EventType["CommentCreated"] = "comment-created";
     EventType["CommentDeleted"] = "comment-deleted";
     /**
-     * New comment updates are not recognized as events as of a few years ago.
+     * @deprecated New comment updates are not recognized as events as of a few years ago.
      */
     EventType["CommentUpdated"] = "comment-updated";
     EventType["GameCoversUpdated"] = "game-covers-updated";
@@ -94,7 +106,53 @@ export var EventType;
     EventType["GameRestored"] = "game-restored";
     EventType["GameUpdated"] = "game-updated";
     EventType["GameRequestReviewed"] = "gamerequest-reviewed";
+    EventType["GuideCreated"] = "guide-created";
+    EventType["GuideDeleted"] = "guide-deleted";
+    EventType["LevelArchived"] = "level-archived";
     EventType["LevelCreated"] = "level-created";
+    /**
+     * @deprecated Levels can only be archived as of the site revamp.
+     */
+    EventType["LevelRemoved"] = "level-removed";
+    EventType["LevelUpdated"] = "level-updated";
+    EventType["ResourceCreated"] = "resource-created";
+    EventType["ResourceDeleted"] = "resource-deleted";
+    EventType["ResourceUpdated"] = "resource-updated";
+    EventType["RunCommentCreated"] = "run-comment-created";
+    EventType["RunCommentDeleted"] = "run-comment-deleted";
+    EventType["RunCommentUpdated"] = "run-comment-updated";
+    EventType["RunAtRiskUpdated"] = "run-atrisk-updated";
+    EventType["RunCreated"] = "run-created";
+    EventType["RunDeleted"] = "run-deleted";
+    EventType["RunReviewed"] = "run-reviewed";
+    EventType["RunUpdated"] = "run-updated";
+    EventType["ThemeCreated"] = "theme-created";
+    EventType["ThemeDeleted"] = "theme-deleted";
+    EventType["ThemeFileDeleted"] = "theme-file-deleted";
+    EventType["ThemeFileUpdated"] = "theme-file-updated";
+    EventType["ThemeUpdated"] = "theme-updated";
+    EventType["ThreadCreated"] = "thread-created";
+    EventType["UserApiKeyUpdated"] = "user-apikey-updated";
+    EventType["UserBanned"] = "user-banned";
+    EventType["UserCommentsWiped"] = "user-comments-wiped";
+    EventType["UserDeleted"] = "user-deleted";
+    EventType["UserModNote"] = "user-modnote";
+    EventType["UserRestored"] = "user-restored";
+    EventType["UserUnbanned"] = "user-unbanned";
+    EventType["UserUpdated"] = "user-updated";
+    EventType["ValueCreated"] = "value-created";
+    /**
+     * @deprecated Variables can only be archived as of the site revamp.
+     */
+    EventType["ValueRemoved"] = "value-removed";
+    EventType["ValueUpdated"] = "value-updated";
+    EventType["VariableArchived"] = "variable-archived";
+    EventType["VariableCreated"] = "variable-created";
+    /**
+     * @deprecated Variables can only be archived as of the site revamp.
+     */
+    EventType["VariableRemoved"] = "variable-removed";
+    EventType["VariableUpdated"] = "variable-updated";
 })(EventType || (EventType = {}));
 export var ChallengeState;
 (function (ChallengeState) {

package/lib/interfaces.d.ts

@@ -295,7 +295,7 @@ export interface CommentableProperties {
     readonly locked: boolean;
 }
 export interface Commentable {
-    readonly itemType: Enums.ItemType;
+    readonly itemType: Enums.CommentableItemType;
     readonly itemId: string;
     readonly properties: CommentableProperties;
     /**Permissions of the logged in user. If not logged in; `canPostComments` is `false`.*/
@@ -303,7 +303,7 @@ export interface Commentable {
 }
 export interface Comment {
     readonly id: string;
-    readonly itemType: Enums.ItemType;
+    readonly itemType: Enums.ItemType.Comment;
     readonly itemId: string;
     readonly date: number;
     readonly userId: string;
@@ -314,7 +314,7 @@ export interface Comment {
     readonly deletedUserId?: string;
 }
 export interface Like {
-    readonly itemType: Enums.ItemType;
+    readonly itemType: Enums.ItemType.Comment;
     readonly itemId: string;
     readonly userId: string;
     readonly date: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "speedruncom.js",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "WIP NodeJS module for Speedrun's version 2 API.",
   "type": "module",
   "author": {

package/src/endpoints/endpoints.get.ts

@@ -225,6 +225,19 @@ export default interface GETEndpoints {
          * ID of the user.
          */
         userId: string;
+
+        /**
+         * The maximum amount of comments to fetch.
+         * 
+         * @max Unknown - likely around 99999.
+         * @default Unknown - likely around 99999.
+         */
+        limit?: number;
+
+        /**
+         * The comment list page, in relation to `limit`.
+         */
+        page?: number;
     };
 
     /**
@@ -236,6 +249,19 @@ export default interface GETEndpoints {
          * ID of the user.
          */
         userId: string;
+
+        /**
+         * The maximum amount of comments to fetch.
+         * 
+         * @max Unknown - likely around 99999.
+         * @default Unknown - likely around 99999.
+         */
+        limit?: number;
+
+        /**
+         * The thread list page, in relation to `limit`.
+         */
+        page?: number;
     };
 
     /**
@@ -249,6 +275,75 @@ export default interface GETEndpoints {
         userId: string;
     };
 
+    /**
+     * Gets users following a user.
+     */
+    GetUserFollowers: {
+
+        /**
+         * ID of the user to get followers of.
+         */
+        userId: string;
+
+        /**
+         * The maximum amount of followers to fetch.
+         * 
+         * @max Unknown - likely around 99999.
+         * @default Unknown - likely around 99999.
+         */
+        limit?: number;
+
+        /**
+         * The follower list page, in relation to `limit`.
+         */
+        page?: number;
+    };
+
+    /**
+     * Gets games that a user follows.
+     */
+    GetUserFollowingGames: {
+
+        /**
+         * ID of the user to fetch followed games from.
+         */
+        userId: string;
+
+        /**
+         * The maximum amount of games to fetch.
+         * 
+         * @max Unknown - likely around 99999.
+         * @default Unknown - likely around 99999.
+         */
+        limit?: number;
+
+        /**
+         * The game list page, in relation to `limit`.
+         */
+        page?: number;
+    };
+
+    GetUserFollowingUsers: {
+
+        /**
+         * ID of the user to fetch followed users from.
+         */
+        userId: string;
+
+        /**
+         * The maximum amount of users to fetch.
+         * 
+         * @max Unknown - likely around 99999.
+         * @default Unknown - likely around 99999.
+         */
+        limit?: number;
+
+        /**
+         * The users list page, in relation to `limit`.
+         */
+        page?: number;
+    };
+
     /**
      * Gets all Titles in the site.
      */
@@ -606,9 +701,9 @@ export default interface GETEndpoints {
         itemId: string;
 
         /**
-         * `ItemType` of the item referenced in `itemId`.
+         * `CommentableItemType` of the item referenced in `itemId`.
          */
-        itemType: Enums.ItemType;
+        itemType: Enums.CommentableItemType;
 
         /**
          * The maximum amount of `Comment`s per page.

package/src/endpoints/endpoints.post.ts

@@ -732,24 +732,6 @@ export default interface POSTEndpoints {
         regenerate: boolean;
     };
 
-    GetUserFollowers: {
-        userId: string;
-        limit?: number;
-        page?: number;
-    };
-
-    GetUserFollowingGames: {
-        userId: string;
-        limit?: number;
-        page?: number;
-    };
-
-    GetUserFollowingUsers: {
-        userId: string;
-        limit?: number;
-        page?: number;
-    };
-
     /**
      * Get a list of games that a user has boosted.
      */
@@ -792,7 +774,7 @@ export default interface POSTEndpoints {
      */
     GetCommentable: {
         itemId: string;
-        itemType: Enums.ItemType;
+        itemType: Enums.CommentableItemType;
     };
 
     /**
@@ -800,7 +782,7 @@ export default interface POSTEndpoints {
      */
     PutComment: {
         itemId: string;
-        itemType: Enums.ItemType;
+        itemType: Enums.CommentableItemType;
         text: string;
     };
 
@@ -815,9 +797,9 @@ export default interface POSTEndpoints {
         itemId: string;
 
         /**
-         * `ItemType` of the item you are liking or removing your like from.
+         * Comment `ItemType`.
          */
-        itemType: Enums.ItemType;
+        itemType: Enums.ItemType.Comment;
 
         /**
          * Whether you are liking a comment (`true`) or removing your like from a comment (`false`).
@@ -840,7 +822,7 @@ export default interface POSTEndpoints {
         /**
          * `itemType` of the item you are modifying the comment settings on.
          */
-        itemType: Enums.ItemType;
+        itemType: Enums.CommentableItemType;
         disabled: boolean;
         locked: boolean;
     };

package/src/enums.ts

@@ -35,6 +35,14 @@ export enum ItemType {
     ChallengeRun
 }
 
+export enum CommentableItemType {
+    Run = 2,
+    Thread = 7,
+    News = 27,
+    Article = 30,
+    ChallengeRun = 33
+}
+
 export enum ForumType {
     FrontPage = 1,
     Supporter,
@@ -73,14 +81,20 @@ export enum SitePowerLevel {
 
 export enum EventType {
     None = "",
+    CategoryArchived = "category-archived",
     CategoryCreated = "category-created",
+    
+    /**
+     * @deprecated Categories can only be archived as of the site revamp.
+     */
     CategoryRemoved = "category-removed",
     CategoryRestored = "category-restored",
     CategoryUpdated = "category-updated",
     CommentCreated = "comment-created",
     CommentDeleted = "comment-deleted",
+
     /**
-     * New comment updates are not recognized as events as of a few years ago.
+     * @deprecated New comment updates are not recognized as events as of a few years ago.
      */
     CommentUpdated = "comment-updated",
     GameCoversUpdated = "game-covers-updated",
@@ -94,7 +108,56 @@ export enum EventType {
     GameRestored = "game-restored",
     GameUpdated = "game-updated",
     GameRequestReviewed = "gamerequest-reviewed",
-    LevelCreated = "level-created"
+    GuideCreated = 'guide-created',
+    GuideDeleted = 'guide-deleted',
+    LevelArchived = 'level-archived',
+    LevelCreated = 'level-created',
+
+    /**
+     * @deprecated Levels can only be archived as of the site revamp.
+     */
+    LevelRemoved = 'level-removed',
+    LevelUpdated = 'level-updated',
+    ResourceCreated = 'resource-created',
+    ResourceDeleted = 'resource-deleted',
+    ResourceUpdated = 'resource-updated',
+    RunCommentCreated = 'run-comment-created',
+    RunCommentDeleted = 'run-comment-deleted',
+    RunCommentUpdated = 'run-comment-updated',
+    RunAtRiskUpdated = 'run-atrisk-updated',
+    RunCreated = 'run-created',
+    RunDeleted = 'run-deleted',
+    RunReviewed = 'run-reviewed',
+    RunUpdated = 'run-updated',
+    ThemeCreated = 'theme-created',
+    ThemeDeleted = 'theme-deleted',
+    ThemeFileDeleted = 'theme-file-deleted',
+    ThemeFileUpdated = 'theme-file-updated',
+    ThemeUpdated = 'theme-updated',
+    ThreadCreated = 'thread-created',
+    UserApiKeyUpdated = 'user-apikey-updated',
+    UserBanned = 'user-banned',
+    UserCommentsWiped = 'user-comments-wiped',
+    UserDeleted = 'user-deleted',
+    UserModNote = 'user-modnote',
+    UserRestored = 'user-restored',
+    UserUnbanned = 'user-unbanned',
+    UserUpdated = 'user-updated',
+    ValueCreated = 'value-created',
+
+    /**
+     * @deprecated Variables can only be archived as of the site revamp.
+     */
+    ValueRemoved = 'value-removed',
+    ValueUpdated = 'value-updated',
+    VariableArchived = 'variable-archived',
+    VariableCreated = 'variable-created',
+
+    /**
+     * @deprecated Variables can only be archived as of the site revamp.
+     */
+    VariableRemoved = 'variable-removed',
+    VariableUpdated = 'variable-updated'
 }
 
 export enum ChallengeState {

package/src/interfaces.ts

@@ -364,7 +364,7 @@ export interface CommentableProperties {
 }
 
 export interface Commentable {
-    readonly itemType: Enums.ItemType;
+    readonly itemType: Enums.CommentableItemType;
     readonly itemId: string;
     readonly properties: CommentableProperties;
     /**Permissions of the logged in user. If not logged in; `canPostComments` is `false`.*/
@@ -373,7 +373,7 @@ export interface Commentable {
 
 export interface Comment {
     readonly id: string;
-    readonly itemType: Enums.ItemType;
+    readonly itemType: Enums.ItemType.Comment;
     readonly itemId: string;
     readonly date: number;
     readonly userId: string;
@@ -385,7 +385,7 @@ export interface Comment {
 }
 
 export interface Like {
-    readonly itemType: Enums.ItemType;
+    readonly itemType: Enums.ItemType.Comment;
     readonly itemId: string;
     readonly userId: string;
     readonly date: number;