speedruncom.js 1.0.0 → 1.1.1

package/dist/build-client.js

@@ -1,42 +0,0 @@
-import { Project } from 'ts-morph';
-const project = new Project({
-    tsConfigFilePath: "tsconfig.json",
-});
-const baseClient = project.getSourceFileOrThrow('src/BaseClient.ts');
-const clientFile = project.createSourceFile('src/Client.ts', baseClient.getFullText(), { overwrite: true });
-const clientClass = clientFile.getClasses()[1];
-const getEndpointsFile = project.getSourceFileOrThrow('src/endpoints/endpoints.get.ts');
-const postEndpointsFile = project.getSourceFileOrThrow('src/endpoints/endpoints.post.ts');
-const responsesFile = project.getSourceFileOrThrow('src/responses.ts');
-const getEndpointNames = Array.from(getEndpointsFile.getExportedDeclarations().keys());
-const postEndpointNames = Array.from(postEndpointsFile.getExportedDeclarations().keys());
-const responseNames = new Set(Array.from(responsesFile.getExportedDeclarations().keys()));
-for (const endpointName of getEndpointNames) {
-    const returnType = responseNames.has(endpointName) ? `Promise<Responses.${endpointName}>` : 'Promise<void>';
-    clientClass.addMethod({
-        name: endpointName,
-        isAsync: true,
-        parameters: [{ name: 'params', type: `GetEndpoints.${endpointName}` }],
-        returnType,
-        statements: [`return await this.request('${endpointName}', params, 'post');`]
-    });
-    clientClass.addMethod({
-        name: endpointName,
-        isStatic: true,
-        isAsync: true,
-        parameters: [{ name: 'params', type: `GetEndpoints.${endpointName}` }],
-        returnType,
-        statements: [`return await this.request('${endpointName}', params, 'get');`]
-    });
-}
-for (const endpointName of postEndpointNames) {
-    const returnType = responseNames.has(endpointName) ? `Promise<Responses.${endpointName}>` : 'Promise<void>';
-    clientClass.addMethod({
-        name: endpointName,
-        isAsync: true,
-        parameters: [{ name: 'params', type: `PostEndpoints.${endpointName}` }],
-        returnType,
-        statements: [`return await this.request('${endpointName}', params, 'post');`]
-    });
-}
-clientFile.saveSync();

package/dist/endpoints/endpoints.get.d.ts

@@ -1,410 +0,0 @@
-import * as Enums from '../enums.js';
-import * as Interfaces from '../interfaces.js';
-import { AtLeastOne } from '../types.js';
-/**
- * Gets a leaderboard, with Players included.
- * `GetGameLeaderboard` can fetch twice as many runs, and also fetches Games, Platforms, Regions, Values, and Variables.
- */
-export interface GetGameLeaderboard2 {
-    /**
-     * Filtering parameters.
-     */
-    params: Interfaces.LeaderboardParams;
-    /**
-     * The leaderboard page, in relation to `limit`.
-     */
-    page?: number;
-    /**
-     * The limit of Runs per page.
-     * Max: 100
-     * @default 100
-     */
-    limit?: number;
-}
-/**
- * Gets a leaderboard, with all relevant items included.
- * `GetGameLeaderboard2` only includes Runs and Players, and has half the maximum `limit`.
- */
-export interface GetGameLeaderboard {
-    /**
-     * Filtering parameters.
-     */
-    params: Interfaces.LeaderboardParams;
-    /**
-     * The leaderboard page, in relation to `limit`.
-     */
-    page?: number;
-    /**
-     * The limit of Runs per page.
-     * Max: 200
-     * @default 100
-     */
-    limit?: number;
-}
-/**
- * Gets mostly leaderboard-related data of a game.
- * Both parameters function the same. If both are included, `gameId` will override.
- */
-interface GetGameData_Base {
-    /**
-     * ID of the game.
-     */
-    gameId?: string;
-    /**
-     * Game page URL.
-     */
-    gameUrl?: string;
-}
-export type GetGameData = AtLeastOne<GetGameData_Base, 'gameId' | 'gameUrl'>;
-/**
- * Gets miscellaneous data of a game.
- * Both parameters function the same. If both are included, `gameId` will override.
- */
-interface GetGameSummary_Base {
-    /**
-     * ID of the game.
-     */
-    gameId?: string;
-    /**
-     * Game page URL.
-     */
-    gameUrl?: string;
-}
-export type GetGameSummary = AtLeastOne<GetGameSummary_Base, 'gameId' | 'gameUrl'>;
-/**
- * Gets the world record history of a game leaderboard.
- */
-export interface GetGameRecordHistory {
-    /**
-     * ID of the game. When exempted, both properties will be empty arrays.
-     */
-    gameId?: string;
-    categoryId?: string;
-    values?: Interfaces.VariableValues[];
-    emulator?: Enums.EmulatorFilter;
-    obsolete?: Enums.ObsoleteFilter;
-}
-/**
- * Searches for site items with a query.
- */
-export interface GetSearch {
-    /**
-     * The text you are searching.
-     */
-    query?: string;
-    /**
-     * todo
-     */
-    favorExactMatches?: boolean;
-    /**
-     * Whether or not you are searching for games.
-     */
-    includeGames?: boolean;
-    /**
-     * Whether or not you are searching for news.
-     */
-    includeNews?: boolean;
-    /**
-     * Whether or not you are searching for pages.
-     */
-    includePages?: boolean;
-    /**
-     * Whether or not you are searching for series.
-     */
-    includeSeries?: boolean;
-    /**
-     * Whether or not you are searching for users.
-     */
-    includeUsers?: boolean;
-    /**
-     * Whether or not you are searching for challenges.
-     */
-    includeChallenges?: boolean;
-    /**
-     * The maximum amount of elements in each array.
-     * @default 100
-     * Max: 100
-     */
-    limit?: number;
-}
-/**
- * Gets non-obsolete latest runs.
- */
-export interface GetLatestLeaderboard {
-    gameId?: string;
-    seriesId?: string;
-    /**
-     * The maximum amount of `runs` there will be in the response.
-     *
-     * Warning: Obsolete runs are not included, but still count to the limit.
-     *
-     * If this is `20` and 5 out of the 20 latest runs are obsolete, it will only return the 15 non-obsolete runs.
-     *
-     * @default 25
-     * Max: 99999
-     */
-    limit?: number;
-}
-/**
- * Gets a run.
- */
-export interface GetRun {
-    /**
-     * ID of the run.
-     */
-    runId: string;
-}
-/**
- * Gets non-run related data of a user.
- */
-export interface GetUserSummary {
-    /**
-     * Page URL of the user.
-     */
-    url: string;
-}
-/**
- * Gets comments posted by a user.
- */
-export interface GetUserComments {
-    /**
-     * ID of the user.
-     */
-    userId: string;
-}
-export interface GetUserThreads {
-    userId: string;
-}
-/**
- * Gets data for user popovers (when you hover over a username).
- */
-export interface GetUserPopoverData {
-    /**
-     * ID of the user.
-     */
-    userId: string;
-}
-/**
- * Gets all Titles in the site.
- */
-export interface GetTitleList {
-}
-/**
- * Gets a Title.
- */
-export interface GetTitle {
-    /**
-     * ID of the title.
-     */
-    titleId: string;
-}
-/**
- * Gets articles on the site.
- */
-export interface GetArticleList {
-    /**
-     * Whether or not the article is published (verified by admin).
-     */
-    published?: boolean;
-    /**
-     * Whether or not the article is rejected.
-     */
-    rejected?: boolean;
-    /**
-     * A query to search for articles.
-     */
-    search?: string;
-    /**
-     * Tags an article has.
-     */
-    tags?: string[];
-    /**
-     * The target of an article, either being `news` or a page URL for site information articles.
-     */
-    target?: string;
-    /**
-     * The maximum amount of articles included in the response.
-     *
-     * @default 500
-     * Max: 500
-     */
-    limit?: number;
-}
-/**
- * Gets a specific article from the site.
- */
-export interface GetArticle {
-    id?: string;
-    slug?: string;
-}
-/**
- * Gets a list of all games on the site.
- */
-export interface GetGameList {
-    seriesId?: string;
-    platformId?: string;
-    search?: string;
-    orderType?: 1;
-    limit?: number;
-}
-/**
- * Gets information for the home page. Often empty.
- */
-export interface GetHomeSummary {
-}
-/**
- * Gets a list of series on the site.
- */
-export interface GetSeriesList {
-    search?: string;
-    orderType?: 1;
-    limit?: number;
-}
-/**
- * Gets most information pertinent to a series.
- */
-export interface GetSeriesSummary {
-    seriesUrl?: string;
-}
-/**
- * Gets the top 3 runs from all levels under a level category.
- */
-export interface GetGameLevelSummary {
-    gameId: string;
-    categoryId: string;
-    dateFrom?: string;
-    dateTo?: string;
-    emulator?: Enums.EmulatorFilter;
-    /**
-     * If `categoryId: string` refers to a level category.
-     */
-    levelId?: string;
-    obsolete?: Enums.ObsoleteFilter;
-    platformId?: string;
-    regionId?: string;
-    timer?: Enums.TimingMethod;
-    /**
-     * If runs other than verified should be included.
-     */
-    verified?: Enums.RunStatus;
-    values?: Interfaces.VariableValues[];
-    video?: Enums.VideoFilter;
-    page?: number;
-    limit?: number;
-}
-/**
- * Gets a random Game.
- */
-export interface GetGameRandom {
-}
-/**
- * Gets all guides on a game.
- */
-export interface GetGuideList {
-    gameId: string;
-}
-/**
- * Get a specific guide by id.
- */
-export interface GetGuide {
-    id: string;
-}
-/**
- * Get a list of game news articles.
- */
-export interface GetNewsList {
-    gameId: string;
-}
-/**
- * Get a game news article.
- */
-export interface GetNews {
-    id: string;
-}
-/**
- * Get a list of a game's resources.
- */
-export interface GetResourceList {
-    gameId: string;
-}
-/**
- * Gets a list of live runners.
- */
-export interface GetStreamList {
-    seriesId?: string;
-    gameId?: string;
-}
-/**
- * Get threads on a forum.
- */
-export interface GetThreadList {
-    forumId: string;
-}
-/**
- * Gets a comment post's Thread and Forum.
- */
-export interface GetThreadStateByCommentId {
-    commentId: string;
-}
-/**
- * Get a specific Challenge.
- */
-export interface GetChallenge {
-    id: string;
-}
-/**
- * Get runs from a Challenge board.
- */
-export interface GetChallengeLeaderboard {
-    challengeId: string;
-}
-/**
- * Get a sitewide leaderboard for users who have won the most in Challenges.
- */
-export interface GetChallengeGlobalRankingList {
-}
-/**
- * Get a specific Challenge run (not the same as a normal run!)
- */
-export interface GetChallengeRun {
-    id: string;
-}
-/**
- * Get a user's runs for display on their profile.
- */
-export interface GetUserLeaderboard {
-    userId: string;
-}
-/**
- * Gets game and series moderation stats for any user.
- */
-export interface GetUserModeration {
-    userId: string;
-}
-/**
- * Get a list of comments on an item.
- */
-export interface GetCommentList {
-    itemId: string;
-    /**
-     * ItemType of the above `itemId: string;`
-     */
-    itemType: Enums.ItemType;
-}
-/**
- * Get a specific thread.
- */
-export interface GetThread {
-    id: string;
-}
-/**
- * Get static data for the site. Including all areas, colors, gameTypes, platforms, etc.
- */
-export interface GetStaticData {
-}
-/**
- * Get a list of site-wide forums. When logged in, may include forums of followed games.
- */
-export interface GetForumList {
-}
-export {};

package/dist/endpoints/endpoints.get.js

@@ -1,2 +0,0 @@
-//Endpoints that don't give the "Method Not Allowed" error when called with GET.
-export {};