migrate to typescript

Author: tudddorrr

.oxfmtrc.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "semi": false,
+  "singleQuote": true,
+  "jsxSingleQuote": true,
+  "experimentalSortImports": {
+    "groups": [
+      ["side-effect"],
+      ["builtin"],
+      ["external", "type-external"],
+      ["internal", "type-internal"],
+      ["parent", "type-parent"],
+      ["sibling", "type-sibling"],
+      ["index", "type-index"]
+    ],
+    "newlinesBetween": false
+  }
+}

.vscode/settings.json

@@ -1,8 +1,11 @@
 {
-  "[markdown]": {
+  "[markdown,mdx]": {
     "editor.detectIndentation": true,
     "editor.insertSpaces": false,
     "editor.indentSize": "tabSize",
     "editor.tabSize": 4
-  }
+  },
+  "editor.defaultFormatter": "oxc.oxc-vscode",
+  "editor.formatOnSave": true,
+  "editor.formatOnSaveMode": "file"
 }

CLAUDE.md

@@ -7,6 +7,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 This is the **Talo documentation website**, built with Docusaurus. Talo is an open-source game backend that provides features like player management, event tracking, leaderboards, game saves, stats, and feedback for Godot and Unity games.
 
 The documentation is organized into several main sections:
+
 - **Unity**: Unity package documentation (`docs/unity/`)
 - **Godot**: Godot plugin documentation (`docs/godot/`)
 - **HTTP API**: REST API reference documentation (`docs/http/`)
@@ -17,24 +18,31 @@ The documentation is organized into several main sections:
 ## Development Commands
 
 **Start development server:**
+
 ```bash
 npm start
 ```
+
 This starts a local development server on port 3009 with live reload.
 
 **Build for production:**
+
 ```bash
 npm run build
 ```
+
 Generates static content in the `build/` directory.
 
 **Clear cache:**
+
 ```bash
 npm clear
 ```
+
 Clears the Docusaurus cache (useful when experiencing build issues).
 
 **Serve production build locally:**
+
 ```bash
 npm run serve
 ```
@@ -45,14 +53,13 @@ npm run serve
 
 The HTTP API documentation uses a unique architecture that fetches live API route definitions from the Talo backend:
 
-1. **`docusaurus.config.js`**: During build/start, fetches API route metadata from `https://api.trytalo.com/public/docs` (or `http://localhost:3000` in development) and stores it in `customFields.docs.services`
+1. **`docusaurus.config.ts`**: During build/start, fetches API route metadata from `https://api.trytalo.com/public/docs` (or `http://localhost:3000` in development) and stores it in `customFields.docs.services`
 
 2. **Service Documentation Components** (`src/components/documentation/`):
-   - `ServiceDocumentation.js`: React component that renders API routes from the fetched metadata as interactive documentation
-   - `ServiceDocumentationWithTOC.js`: Variant with table of contents
-   - `generateServiceTOC.js`: Generates table of contents from service routes
-   - `useServiceDocs.js`: Hook to access service data from Docusaurus context
-   - `Sample.js`: Renders code samples for API endpoints
+   - `ServiceDocumentation.tsx`: React component that renders API routes from the fetched metadata as interactive documentation
+   - `generateServiceTOC.ts`: Generates table of contents from service routes
+   - `useServiceDocs.ts`: Hook to access service data from Docusaurus context
+   - `Sample.tsx`: Renders code samples for API endpoints
 
 3. **MDX Files** (`docs/http/*.mdx`): Use the `<ServiceDocumentation service='ServiceName' />` component to render live API docs. Examples: `event-api.mdx`, `game-channel-api.mdx`, etc.
 
@@ -62,7 +69,7 @@ The benefit of this architecture is that API documentation automatically stays i
 
 - **Markdown files** (`docs/**/*.md`): Standard documentation pages written in Markdown
 - **MDX files** (`docs/**/*.mdx`): Documentation pages that use React components (primarily for API docs)
-- **Sidebars** (`sidebars.js`): Uses Docusaurus auto-generated sidebars from the directory structure
+- **Sidebars** (`sidebars.ts`): Uses Docusaurus auto-generated sidebars from the directory structure
 - **Static assets** (`static/`): Images and other static files referenced in docs
 
 ### Node Version
@@ -72,6 +79,7 @@ This project requires **Node.js 20.x** (specified in `package.json` engines fiel
 ## Documentation Conventions
 
 - Use frontmatter for page metadata:
+
   ```yaml
   ---
   sidebar_position: 1
@@ -81,9 +89,9 @@ This project requires **Node.js 20.x** (specified in `package.json` engines fiel
 
 - Cross-reference other docs using relative paths: `/docs/unity/install`
 
-- Include code samples in fenced code blocks with language identifiers (e.g., ```csharp, ```gdscript, ```bash)
+- Include code samples in fenced code blocks with language identifiers (e.g., `csharp, `gdscript, ```bash)
 
-- The site supports C# and GDScript syntax highlighting via Prism (configured in `docusaurus.config.js`)
+- The site supports C# and GDScript syntax highlighting via Prism (configured in `docusaurus.config.ts`)
 
 ## Important Notes
 

babel.config.js

@@ -205,6 +205,7 @@ var is_last_page := members_page.is_last_page
 ```
 
 You can provide the following filtering options:
+
 - `page`: the current pagination index
 - `player_id`: find channel members with this player ID
 - `alias_id`: find a channel member with this ID
@@ -234,6 +235,7 @@ func _on_message_received(channel: TaloChannel, player_alias: TaloPlayerAlias, m
 ### Listening for other signals
 
 You can also listen for the following signals:
+
 - `Talo.channels.player_joined`: Emitted when a player joins a channel. Returns the `TaloChannel` and the `TaloPlayerAlias` that joined.
 
 - `Talo.channels.player_left`: Emitted when a player leaves a channel. Returns the `TaloChannel`, the `TaloPlayerAlias` that left and a `Talo.channels.ChannelLeavingReason`.

docs/godot/channels.mdx

@@ -38,6 +38,7 @@ Events are sent off in batches to prevent issues around rate limiting or using t
 ## Meta props
 
 Talo sends through some extra props with each event. These props are made up of the following metadata:
+
 - The player's operating system
 - The version of the game
 - The window mode (fullscreen, fullscreen windowed, maximized window or windowed)

docs/godot/events.mdx

@@ -47,6 +47,7 @@ socket_url="wss://api.trytalo.com"
 ```
 
 You can also add the following section for logging:
+
 ```gdscript title="addons/talo/settings.cfg"
 ...
 

docs/godot/install.md

@@ -14,7 +14,6 @@ To create a leaderboard, head over to [the dashboard](https://dashboard.trytalo.
 Check out this blog post on [how to build quick & easy leaderboards in Godot](https://trytalo.com/blog/leaderboards-godot?utm_source=docs&utm_medium=tip) for a detailed walkthrough
 :::
 
-
 ## Creating entries
 
 <ScopeBadges scope='leaderboards' write />

docs/godot/leaderboards.mdx

@@ -44,6 +44,7 @@ Once a player is registered, a session will automatically be created for them an
 To start a session, call the `Talo.player_auth.login()` function with the username and password the player provided.
 
 The `login()` function returns a `Talo.player_auth.LoginResult` which maps to:
+
 1. A successful login
 2. A successful login but the player must verify their details before creating the session
 3. An unsuccessful login attempt
@@ -142,7 +143,7 @@ if res != OK:
 		TaloAuthError.ErrorCode.NEW_PASSWORD_MATCHES_CURRENT_PASSWORD:
 			validation_label.text = "New password must be different from the current password"
 		_:
-			validation_label.text = Talo.player_auth.last_error.get_string()    
+			validation_label.text = Talo.player_auth.last_error.get_string()
 else:
 	password_change_success.emit()
 ```

docs/godot/player-authentication.mdx

@@ -44,7 +44,7 @@ var res := await Talo.player_presence.update_presence(online, custom_status)
 
 This function returns a `TaloPlayerPresence` object.
 
-## Subscribing to presence 
+## Subscribing to presence
 
 <ScopeBadges scope='playerPresence' read />