Export the new interfaces and create documentation

TTTaevas · Nov 21, 2023 · 4703820 · 4703820
1 parent 8df8605
commit 4703820
Show file tree

Hide file tree

Showing 69 changed files with 1,041 additions and 299 deletions.
diff --git a/README.md b/README.md
@@ -2,4 +2,41 @@
 
 [**osu-api-v2-js**](https://github.com/TTTaevas/osu-api-v2-js) is a JavaScript & TypeScript package that helps you interact with [osu!api (v2)](https://docs.ppy.sh).
 
-While it is currently unstable as it's under pretty heavy development, documentation is available on [osu-v2.taevas.xyz](https://osu-v2.taevas.xyz/)!
+It is currently unstable as it's under development, but you can find documentation on [osu-v2.taevas.xyz](https://osu-v2.taevas.xyz/) if needed!
+
+## How to install and get started
+
+To install the package, use a command from your package manager:
+
+```bash
+npm i osu-api-v2-js # if using npm
+yarn add osu-api-v2-js # if using yarn
+pnpm add osu-api-v2-js # if using pnpm
+bun a osu-api-v2-js # if using bun
+```
+
+Make sure to add `"type": "module"` to your `package.json`!
+
+To use (import) the package in your project and start interacting with the API, you may do something like that:
+
+```typescript
+// TypeScript
+import * as osu from "osu-api-v2-js"
+
+async function logUserTopPlayBeatmap(username: string) {
+    // Because of how the API server works, it's more convenient to use `osu.API.createAsync()` instead of `new osu.API()`!
+    // In a proper application, you'd use this function as soon as the app starts so you can use that object everywhere
+	const api = await osu.API.createAsync({id: "<client_id>", "<client_secret>"})
+
+    const user = await api.getUser({username}) // We need to get the id of the user in order to request what we want
+    const score = (await api.getUserScores(user, "best", 1, osu.Rulesets.osu))[0] // Specifying the Ruleset is optional
+    const beatmapDifficulty = await api.getBeatmapDifficultyAttributesOsu(score.beatmap, score.mods) // Specifying the mods so the SR is adapted to them
+
+    let x = `${score.beatmapset.artist} - ${score.beatmapset.title} [${score.beatmap.version}]`
+	let y = `+${score.mods.toString()} (${beatmapDifficulty.star_rating.toFixed(2)}*)`
+	console.log(`${username}'s top play is on: ${x} ${y}`)
+	// Doomsday fanboy's top play is on: xi - FREEDOM DiVE [FOUR DIMENSIONS] +HR (8.07*)
+}
+
+logUserTopPlayBeatmap("Doomsday fanboy")
+```
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -1,20 +1,26 @@
 :root {
-    --light-hl-0: #AF00DB;
-    --dark-hl-0: #C586C0;
+    --light-hl-0: #795E26;
+    --dark-hl-0: #DCDCAA;
     --light-hl-1: #000000;
     --dark-hl-1: #D4D4D4;
-    --light-hl-2: #001080;
-    --dark-hl-2: #9CDCFE;
-    --light-hl-3: #795E26;
-    --dark-hl-3: #DCDCAA;
-    --light-hl-4: #098658;
-    --dark-hl-4: #B5CEA8;
-    --light-hl-5: #A31515;
-    --dark-hl-5: #CE9178;
-    --light-hl-6: #0000FF;
-    --dark-hl-6: #569CD6;
-    --light-hl-7: #0070C1;
-    --dark-hl-7: #4FC1FF;
+    --light-hl-2: #A31515;
+    --dark-hl-2: #CE9178;
+    --light-hl-3: #008000;
+    --dark-hl-3: #6A9955;
+    --light-hl-4: #AF00DB;
+    --dark-hl-4: #C586C0;
+    --light-hl-5: #0000FF;
+    --dark-hl-5: #569CD6;
+    --light-hl-6: #001080;
+    --dark-hl-6: #9CDCFE;
+    --light-hl-7: #267F99;
+    --dark-hl-7: #4EC9B0;
+    --light-hl-8: #0070C1;
+    --dark-hl-8: #4FC1FF;
+    --light-hl-9: #098658;
+    --dark-hl-9: #B5CEA8;
+    --light-hl-10: #000000FF;
+    --dark-hl-10: #D4D4D4;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
@@ -28,6 +34,9 @@
     --hl-5: var(--light-hl-5);
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
     --code-background: var(--light-code-background);
 } }
 
@@ -40,6 +49,9 @@
     --hl-5: var(--dark-hl-5);
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
     --code-background: var(--dark-code-background);
 } }
 
@@ -52,6 +64,9 @@
     --hl-5: var(--light-hl-5);
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
     --code-background: var(--light-code-background);
 }
 
@@ -64,6 +79,9 @@
     --hl-5: var(--dark-hl-5);
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
     --code-background: var(--dark-code-background);
 }
 
@@ -75,4 +93,7 @@
 .hl-5 { color: var(--hl-5); }
 .hl-6 { color: var(--hl-6); }
 .hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
+.hl-10 { color: var(--hl-10); }
 pre, code { background: var(--code-background); }
diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/API.html b/docs/classes/API.html
diff --git a/docs/classes/APIError.html b/docs/classes/APIError.html
diff --git a/docs/enums/RankStatus.html b/docs/enums/RankStatus.html
diff --git a/docs/enums/Rulesets.html b/docs/enums/Rulesets.html
diff --git a/docs/functions/generateAuthorizationURL.html b/docs/functions/generateAuthorizationURL.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interfaces/Beatmap.html b/docs/interfaces/Beatmap.html
diff --git a/docs/interfaces/BeatmapDifficultyAttributes.html b/docs/interfaces/BeatmapDifficultyAttributes.html
diff --git a/docs/interfaces/BeatmapDifficultyAttributesFruits.html b/docs/interfaces/BeatmapDifficultyAttributesFruits.html
diff --git a/docs/interfaces/BeatmapDifficultyAttributesMania.html b/docs/interfaces/BeatmapDifficultyAttributesMania.html
diff --git a/docs/interfaces/BeatmapDifficultyAttributesOsu.html b/docs/interfaces/BeatmapDifficultyAttributesOsu.html
diff --git a/docs/interfaces/BeatmapDifficultyAttributesTaiko.html b/docs/interfaces/BeatmapDifficultyAttributesTaiko.html
diff --git a/docs/interfaces/BeatmapExtended.html b/docs/interfaces/BeatmapExtended.html
diff --git a/docs/interfaces/BeatmapExtendedWithFailtimes.html b/docs/interfaces/BeatmapExtendedWithFailtimes.html
diff --git a/docs/interfaces/BeatmapExtendedWithFailtimesBeatmapsetextended.html b/docs/interfaces/BeatmapExtendedWithFailtimesBeatmapsetextended.html
diff --git a/docs/interfaces/BeatmapPack.html b/docs/interfaces/BeatmapPack.html
diff --git a/docs/interfaces/BeatmapUserScore.html b/docs/interfaces/BeatmapUserScore.html
diff --git a/docs/interfaces/BeatmapWithBeatmapset.html b/docs/interfaces/BeatmapWithBeatmapset.html
diff --git a/docs/interfaces/BeatmapWithBeatmapsetChecksumMaxcombo.html b/docs/interfaces/BeatmapWithBeatmapsetChecksumMaxcombo.html
diff --git a/docs/interfaces/Beatmapset.html b/docs/interfaces/Beatmapset.html