Fascinated/beatsaber-helpers
Archived
1
0
Fork 0
Code Issues Pull Requests 1 Actions Projects Wiki Activity

add scoresaber base

Browse Source
This commit is contained in:
Lee 2023-03-29 18:33:44 +01:00
parent bfb8a22eff
commit 2d057ffbc8
10 changed files with 5943 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
__tests__/scoresaber.js Normal file
View File

@ -0,0 +1,20 @@
const ScoreSaber = require("../dist/scoresaber/scoresaber");
const PREFIX = "ScoreSaber -";
const TEST_PLAYER = "76561198449412074";
test(`${PREFIX} Validate getPlayers`, async () => {
const response = await ScoreSaber.getPlayers("ImFascinated", 1, ["GB"]);
const players = response.players;
expect(players.length).toBeGreaterThan(0);
});
test(`${PREFIX} Validate getActivePlayerCount`, async () => {
const response = await ScoreSaber.getActivePlayerCount();
expect(response).toBeGreaterThan(0);
});
test(`${PREFIX} Validate getPlayer`, async () => {
const response = await ScoreSaber.getPlayer(TEST_PLAYER);
expect(response.id).toBe(TEST_PLAYER);
});

5665
package-lock.json generated Normal file
View File

File diff suppressed because it is too large Load Diff

24
package.json Normal file
View File

@ -0,0 +1,24 @@
{
"name": "@fascinated/beatsaber-helpers",
"version": "1.0.0",
"description": "Simple util library to fetch data from beatsaber websites",
"main": "dist/index.js",
"scripts": {
"build": "tsc",
"test": "jest"
},
"repository": {
"type": "git",
"url": "https://git.fascinated.cc/Fascinated/beatsaber-helpers.git"
},
"author": "Fascinated",
"license": "ISC",
"dependencies": {
"axios": "^1.3.4",
"jest": "^29.5.0",
"typescript": "^5.0.2"
},
"devDependencies": {
"@types/node": "^18.15.11"
}
}

2
src/index.ts Normal file
View File

@ -0,0 +1,2 @@
import ScoreSaber from "./scoresaber/ScoreSaber";
export { ScoreSaber };

82
src/scoresaber/ScoreSaber.ts Normal file
View File

@ -0,0 +1,82 @@
import axios from "axios";
import { ScoresaberPlayer } from "./models/PlayerModel";
import { ScoresaberPlayerSearch } from "./models/ScoresaberPlayerSearch";
const CONSTS = {
BASE_URL: "https://scoresaber.com/api",
PLAYER_COUNT: "players/count",
PLAYERS: "players",
PLAYER: "player/{playerId}",
};
enum PlayerDataType {
BASIC = "basic",
FULL = "full",
SCORES = "scores",
}
/**
* Gets players based on the search query, page, and countries
*
* @param search the search query
* @param page the page number
* @param countries the countries to search
* @param withMetadata whether to include metadata
* @returns the players
*/
export async function getPlayers(
search: string,
page: number,
countries: string[],
withMetadata: boolean = true
): Promise<ScoresaberPlayerSearch> {
const url = `${CONSTS.BASE_URL}/${
CONSTS.PLAYERS
}?search=${search}&page=${page}&countries=${countries.join(
","
)}&withMetadata=${withMetadata}`;
const response = await axios.get(url);
return response.data;
}
/**
* Gets the number of active players on ScoreSaber
*
* @returns the number of active players
*/
export async function getActivePlayerCount(): Promise<number> {
const url = `${CONSTS.BASE_URL}/${CONSTS.PLAYER_COUNT}`;
const response = await axios.get(url);
return response.data;
}
/**
* Gets a players player data from ScoreSaber
*
* @param playerId the players id (not the name)
* @param type the type of data to get
* @returns the player data
*/
export async function getPlayer(
playerId: string,
type: PlayerDataType = PlayerDataType.BASIC
): Promise<ScoresaberPlayer> {
const url = `${CONSTS.BASE_URL}/${CONSTS.PLAYER.replace(
"{playerId}",
playerId
)}/${type}`;
const response = await axios.get(url);
return response.data;
}
// Leaderboard API
// ---------
export default {
// Player API
getPlayers,
getActivePlayerCount,
getPlayer,
// Leaderboard API
};

19
src/scoresaber/models/PlayerModel.ts Normal file
View File

@ -0,0 +1,19 @@
import { ScoresaberBadge } from "./ScoresaberBadge";
import { ScoresaberScoreStats } from "./ScoresaberScoreStats";
export type ScoresaberPlayer = {
id: string;
name: string;
profilePicture: string;
country: string;
pp: number;
rank: number;
countryRank: number;
role: string;
badges: ScoresaberBadge[];
histories: string;
scoreStats: ScoresaberScoreStats;
permissions: number;
banned: boolean;
inactive: boolean;
};

4
src/scoresaber/models/ScoresaberBadge.ts Normal file
View File

@ -0,0 +1,4 @@
export type ScoresaberBadge = {
description: string;
image: string;
};

10
src/scoresaber/models/ScoresaberPlayerSearch.ts Normal file
View File

@ -0,0 +1,10 @@
import { ScoresaberPlayer } from "./PlayerModel";
export type ScoresaberPlayerSearch = {
players: ScoresaberPlayer[];
metadata: {
total: number;
page: number;
itemsPerPage: number;
};
};

8
src/scoresaber/models/ScoresaberScoreStats.ts Normal file
View File

@ -0,0 +1,8 @@
export type ScoresaberScoreStats = {
totalScore: number;
totalRankedScore: number;
averageRankedAccuracy: number;
totalPlayCount: number;
rankedPlayCount: number;
replaysWatched: number;
};

109
tsconfig.json Normal file
View File

@ -0,0 +1,109 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "ESNext" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "commonjs" /* Specify what module code is generated. */,
"rootDir": "./src" /* Specify the root folder within your source files. */,
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "./dist" /* Specify an output folder for all emitted files. */,
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
/* Type Checking */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}