WIP: Autogenerate types from official documentation

.gitignore

@@ -123,3 +123,4 @@ pages/example_output
 examples/**/package-lock.json
 # Ignore certain example files
 examples/**/node_modules
+scripts/cache.html

package.json

@@ -24,6 +24,7 @@
         "madge": "^6.0.0",
         "mocha": "^10.2.0",
         "moment": "^2.29.4",
+        "node-html-parser": "^6.1.5",
         "nyc": "^15.1.0",
         "prettier": "^2.8.8",
         "rimraf": "^5.0.0",
@@ -36,14 +37,15 @@
     "scripts": {
         "build": "tsc",
         "build:check": "tsc --noEmit",
+        "create:osuApiTypes": "ts-node --project tsconfig.eslint.json --esm scripts/createOsuApiTypes.mts",
         "docs": "typedoc --tsconfig tsconfig.json",
         "docs:createPagesExampleOutput": "ts-node --project tsconfig.json --esm pages/create_pages_example_output.mts",
         "format": "prettier --check examples src test",
-        "format:fix": "prettier --write examples pages src test",
-        "lint": "eslint pages src test",
+        "format:fix": "prettier --write examples pages scripts src test",
+        "lint": "eslint pages scripts src test",
         "lint:circular": "madge --circular lib/index.mjs",
         "lint:exports": "ts-unused-exports tsconfig.json --showLineNumber",
-        "lint:fix": "eslint --fix pages src test",
+        "lint:fix": "eslint --fix pages scripts src test",
         "prebuild": "rimraf lib",
         "test": "mocha -- test/**/**/*.test.mts test/**/*.test.mts test/*.test.mts",
         "test:no-refresh-token": "mocha --invert --fgrep refresh-token -- test/**/**/*.test.mts test/**/*.test.mts test/*.test.mts",

scripts/autogen/checkGeneric.mts

@@ -0,0 +1,26 @@
+// Package imports
+import { expect } from "chai"
+
+export interface DefaultCheckResponseOptions {
+    doNotCheckForUncheckedKeys?: boolean
+}
+
+export const genericCheckObjectForUncheckedKeys = <DATA_TYPE extends object>(
+    input: Readonly<DATA_TYPE>,
+    checkedKeys: ReadonlyArray<string>,
+    options?: DefaultCheckResponseOptions,
+): ReadonlyArray<string> => {
+    if (options?.doNotCheckForUncheckedKeys) {
+        return checkedKeys
+    }
+    for (const [key, value] of Object.entries(input)) {
+        if (!checkedKeys.includes(key) && value !== undefined) {
+            expect.fail(
+                `Found unchecked key '${key}': '${JSON.stringify(
+                    value,
+                )}' (${JSON.stringify(input)})`,
+            )
+        }
+    }
+    return checkedKeys
+}

scripts/autogen/generateTypescriptMochaTest.mts

@@ -0,0 +1,9 @@
+// Type imports
+import type { OsuApiV2Types } from "./parseTypes.mjs"
+
+export const generateTypescriptMochaTestString = (
+    type: Readonly<OsuApiV2Types>,
+    typeFilePath: ReadonlyMap<string, string>,
+): string => {
+    return "TODO" + type.name + (typeFilePath.get(type.name) ?? "NOT FOUND!")
+}