@ughuuu/game_server 1.0.382 → 1.0.791

package/README.md

@@ -1,13 +1,13 @@
 # @ughuuu/game_server
 
 UghuuuGameServer - JavaScript client for @ughuuu/game_server
-API for Game Server application
+API for the Gamend Game Server. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, achievements, leaderboards, server scripting, and admin portal.
 
-## Authentication
+## **1. Authentication**
 
 This API uses JWT (JSON Web Tokens) with access and refresh tokens:
 
-### Getting Tokens
+### **1.1 Getting Tokens**
 - **Email/Password**: POST to `/api/v1/login` with email and password
 - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user)
 - **Discord OAuth**: Use `/api/v1/auth/discord` flow
@@ -20,16 +20,16 @@ Both methods return:
 - `access_token` - Short-lived (15 min), use for API requests
 - `refresh_token` - Long-lived (30 days), use to get new access tokens
 
-### Using Tokens
+### **1.2 Using Tokens**
 Include the access token in the Authorization header:
 ```
 Authorization: Bearer <access_token>
 ```
 
-### Refreshing Tokens
+### **1.3 Refreshing Tokens**
 When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token.
 
-## Users
+## **2. Users**
 Users endpoints cover the user lifecycle and profile features. Key highlights:
 
 - **Registration and login** (email/password, device token for SDKs, and OAuth providers)
@@ -37,14 +37,14 @@ Users endpoints cover the user lifecycle and profile features. Key highlights:
 - **Account lifecycle**: password reset, email confirmation, and account deletion
 - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported
 
-## Friends
+## **3. Friends**
 The Friends domain offers lightweight social features:
 
 - **Friend requests** (send / accept / reject / block flows)
 - **Friend listing & pagination**, with basic privacy controls
 - **Domain helpers** to manage and query friend relationships from API or UI contexts
 
-## Lobbies
+## **4. Lobbies**
 Lobbies provide matchmaking / room management primitives. Highlights:
 
 - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags)
@@ -53,7 +53,7 @@ Lobbies provide matchmaking / room management primitives. Highlights:
 - **Controls & protection**: max users, hidden/locked states, and optional password protection
 - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated
 
-## Notifications
+## **5. Notifications**
 Persistent user-to-user notifications that survive across sessions:
 
 - **Send notifications** to accepted friends with a title, optional content, and optional metadata
@@ -62,11 +62,124 @@ Persistent user-to-user notifications that survive across sessions:
 - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events)
 - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect
 
+## **6. Groups**
+Groups provide persistent community management for players:
+
+- **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed)
+- **Membership roles**: `admin` and `member`, with promote/demote capabilities
+- **Join requests**: for private groups, users submit requests that admins approve or reject
+- **Invitations**: admins can invite users directly (blocked users are rejected)
+- **CRUD operations**: create, update, delete groups with metadata support
+- **Group chat**: integrated via the Chat API with `chat_type: \"group\"`
+
+## **7. Parties**
+Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads):
+
+- **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members
+- **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel`
+- **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`)
+- **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader
+- **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected
+- **Leader management**: the creator is the leader; leadership can be transferred
+- **Lobby integration**: parties can create or join lobbies as a group
+- **Party chat**: integrated via the Chat API with `chat_type: \"party\"`
+- **Real-time events** via the party WebSocket channel
+
+## **8. Chat**
+Real-time messaging across multiple conversation types:
+
+- **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends)
+- **Send messages** with content, optional metadata, and automatic access validation
+- **List messages** with pagination (newest first)
+- **Read tracking**: mark messages as read and get unread counts per conversation
+- **Real-time delivery** via PubSub and WebSocket channels
+- **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking
+
+## **9. Leaderboards**
+Server-managed ranked scoreboards:
+
+- **Multiple leaderboards**: create named leaderboards with configurable sort order
+- **Score submission**: submit scores with optional metadata
+- **Rankings**: retrieve paginated rankings with user details
+- **Reset support**: leaderboards can be reset periodically
+
+## **10. Key-Value Storage**
+Per-user persistent key-value storage for game state, preferences, and settings:
+
+- **Get/set/delete** key-value pairs scoped to the authenticated user
+- **List keys** with optional prefix filtering
+- **Metadata support**: values can include arbitrary JSON metadata
+
+## **11. Achievements**
+Track player accomplishments with progress-based or instant-unlock achievements:
+
+- **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target
+- **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target
+- **Instant unlock**: directly unlock achievements without progress tracking
+- **Hidden achievements**: details obscured (\"???\") until unlocked by the user
+- **Public listings**: paginated, optionally filtered; authenticated users see their own progress
+- **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements
+
+## **12. Real-time: WebSocket Channels**
+The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates.
+
+### **12.1 Connection**
+Connect to `wss://your-server.com/socket` with your JWT token as a parameter:
+```
+const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } })
+socket.connect()
+```
+
+### **12.2 Available Channels**
+- **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites
+- **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat
+- **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted)
+- **Group channel** (`group:<group_id>`): group member changes, group updates, group chat
+- **Groups channel** (`groups`): global group list changes
+- **Party channel** (`party:<party_id>`): party member changes, party updates, party chat
+
+### **12.3 JS SDK Helper**
+The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers:
+```javascript
+import { GameRealtime } from '@ughuuu/game_server'
+const realtime = new GameRealtime('https://your-server.com', accessToken)
+const userChannel = realtime.joinUserChannel(userId)
+userChannel.on('notification', payload => console.log(payload))
+```
+Requires the `phoenix` npm package as a peer dependency: `npm install phoenix`
+
+## **13. Real-time: WebRTC DataChannels**
+For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients).
+
+### **13.1 How It Works**
+1. Client connects via WebSocket and joins the **User channel**
+2. Client sends an SDP offer over the channel (`webrtc:offer` event)
+3. Server responds with an SDP answer (`webrtc:answer` event)
+4. ICE candidates are exchanged (`webrtc:ice` events)
+5. Once connected, named DataChannels carry game data at low latency
+
+### **13.2 Default DataChannels**
+- **`events`** (reliable, ordered): important game events (player actions, state changes)
+- **`state`** (unreliable, unordered): high-frequency position/state sync
+
+### **13.3 JS SDK Helper**
+The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically:
+```javascript
+import { GameRealtime, GameWebRTC } from '@ughuuu/game_server'
+const realtime = new GameRealtime('https://your-server.com', token)
+const userChannel = realtime.joinUserChannel(userId)
+const webrtc = new GameWebRTC(userChannel, {
+  onData: (label, data) => console.log(label, data)
+})
+await webrtc.connect()
+webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 }))
+```
+
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.0.0
+- API version: 1.0.791
 - Package version: 1.0.0
-- Generator version: 7.17.0
+- Generator version: 7.20.0
 - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
 
 ## Installation
@@ -161,15 +274,10 @@ Please follow the [installation](#installation) instruction and execute the foll
 ```javascript
 var UghuuuGameServer = require('@ughuuu/game_server');
 
-var defaultClient = UghuuuGameServer.ApiClient.instance;
-// Configure Bearer (JWT) access token for authorization: authorization
-var authorization = defaultClient.authentications['authorization'];
-authorization.accessToken = "YOUR ACCESS TOKEN"
 
-var api = new UghuuuGameServer.AdminChatApi()
-var chatType = "chatType_example"; // {String} 
-var chatRefId = 56; // {Number} 
-api.adminDeleteChatConversation(chatType, chatRefId).then(function(data) {
+var api = new UghuuuGameServer.AchievementsApi()
+var slug = "slug_example"; // {String} 
+api.getAchievement(slug).then(function(data) {
   console.log('API called successfully. Returned data: ' + data);
 }, function(error) {
   console.error(error);
@@ -184,6 +292,18 @@ All URIs are relative to *http://localhost:4000*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*UghuuuGameServer.AchievementsApi* | [**getAchievement**](docs/AchievementsApi.md#getAchievement) | **GET** /api/v1/achievements/{slug} | Get achievement details
+*UghuuuGameServer.AchievementsApi* | [**listAchievements**](docs/AchievementsApi.md#listAchievements) | **GET** /api/v1/achievements | List achievements
+*UghuuuGameServer.AchievementsApi* | [**myAchievements**](docs/AchievementsApi.md#myAchievements) | **GET** /api/v1/achievements/me | List my unlocked achievements
+*UghuuuGameServer.AchievementsApi* | [**userAchievements**](docs/AchievementsApi.md#userAchievements) | **GET** /api/v1/achievements/user/{user_id} | List a user&#39;s unlocked achievements
+*UghuuuGameServer.AdminAchievementsApi* | [**adminCreateAchievement**](docs/AdminAchievementsApi.md#adminCreateAchievement) | **POST** /api/v1/admin/achievements | Create achievement (admin)
+*UghuuuGameServer.AdminAchievementsApi* | [**adminDeleteAchievement**](docs/AdminAchievementsApi.md#adminDeleteAchievement) | **DELETE** /api/v1/admin/achievements/{id} | Delete achievement (admin)
+*UghuuuGameServer.AdminAchievementsApi* | [**adminGrantAchievement**](docs/AdminAchievementsApi.md#adminGrantAchievement) | **POST** /api/v1/admin/achievements/grant | Grant achievement to user (admin)
+*UghuuuGameServer.AdminAchievementsApi* | [**adminIncrementAchievement**](docs/AdminAchievementsApi.md#adminIncrementAchievement) | **POST** /api/v1/admin/achievements/increment | Increment achievement progress for user (admin)
+*UghuuuGameServer.AdminAchievementsApi* | [**adminListAchievements**](docs/AdminAchievementsApi.md#adminListAchievements) | **GET** /api/v1/admin/achievements | List all achievements (admin, includes hidden)
+*UghuuuGameServer.AdminAchievementsApi* | [**adminRevokeAchievement**](docs/AdminAchievementsApi.md#adminRevokeAchievement) | **POST** /api/v1/admin/achievements/revoke | Revoke achievement from user (admin)
+*UghuuuGameServer.AdminAchievementsApi* | [**adminUnlockAchievement**](docs/AdminAchievementsApi.md#adminUnlockAchievement) | **POST** /api/v1/admin/achievements/unlock | Unlock achievement for user (admin)
+*UghuuuGameServer.AdminAchievementsApi* | [**adminUpdateAchievement**](docs/AdminAchievementsApi.md#adminUpdateAchievement) | **PATCH** /api/v1/admin/achievements/{id} | Update achievement (admin)
 *UghuuuGameServer.AdminChatApi* | [**adminDeleteChatConversation**](docs/AdminChatApi.md#adminDeleteChatConversation) | **DELETE** /api/v1/admin/chat/conversation | Delete all messages in a conversation (admin)
 *UghuuuGameServer.AdminChatApi* | [**adminDeleteChatMessage**](docs/AdminChatApi.md#adminDeleteChatMessage) | **DELETE** /api/v1/admin/chat/{id} | Delete a chat message (admin)
 *UghuuuGameServer.AdminChatApi* | [**adminListChatMessages**](docs/AdminChatApi.md#adminListChatMessages) | **GET** /api/v1/admin/chat | List all chat messages (admin)
@@ -228,9 +348,12 @@ Class | Method | HTTP request | Description
 *UghuuuGameServer.AuthenticationApi* | [**unlinkDevice**](docs/AuthenticationApi.md#unlinkDevice) | **DELETE** /api/v1/me/device | Unlink device ID
 *UghuuuGameServer.AuthenticationApi* | [**unlinkProvider**](docs/AuthenticationApi.md#unlinkProvider) | **DELETE** /api/v1/me/providers/{provider} | Unlink OAuth provider
 *UghuuuGameServer.ChatApi* | [**chatUnreadCount**](docs/ChatApi.md#chatUnreadCount) | **GET** /api/v1/chat/unread | Get unread message count
+*UghuuuGameServer.ChatApi* | [**deleteChatMessage**](docs/ChatApi.md#deleteChatMessage) | **DELETE** /api/v1/chat/messages/{id} | Delete your own chat message
+*UghuuuGameServer.ChatApi* | [**getChatMessage**](docs/ChatApi.md#getChatMessage) | **GET** /api/v1/chat/messages/{id} | Get a single chat message
 *UghuuuGameServer.ChatApi* | [**listChatMessages**](docs/ChatApi.md#listChatMessages) | **GET** /api/v1/chat/messages | List chat messages
 *UghuuuGameServer.ChatApi* | [**markChatRead**](docs/ChatApi.md#markChatRead) | **POST** /api/v1/chat/read | Mark chat as read
 *UghuuuGameServer.ChatApi* | [**sendChatMessage**](docs/ChatApi.md#sendChatMessage) | **POST** /api/v1/chat/messages | Send a chat message
+*UghuuuGameServer.ChatApi* | [**updateChatMessage**](docs/ChatApi.md#updateChatMessage) | **PATCH** /api/v1/chat/messages/{id} | Update your own chat message
 *UghuuuGameServer.FriendsApi* | [**acceptFriendRequest**](docs/FriendsApi.md#acceptFriendRequest) | **POST** /api/v1/friends/{id}/accept | Accept a friend request
 *UghuuuGameServer.FriendsApi* | [**blockFriendRequest**](docs/FriendsApi.md#blockFriendRequest) | **POST** /api/v1/friends/{id}/block | Block a friend request / user
 *UghuuuGameServer.FriendsApi* | [**createFriendRequest**](docs/FriendsApi.md#createFriendRequest) | **POST** /api/v1/friends | Send a friend request
@@ -240,14 +363,15 @@ Class | Method | HTTP request | Description
 *UghuuuGameServer.FriendsApi* | [**rejectFriendRequest**](docs/FriendsApi.md#rejectFriendRequest) | **POST** /api/v1/friends/{id}/reject | Reject a friend request
 *UghuuuGameServer.FriendsApi* | [**removeFriendship**](docs/FriendsApi.md#removeFriendship) | **DELETE** /api/v1/friends/{id} | Remove/cancel a friendship or request
 *UghuuuGameServer.FriendsApi* | [**unblockFriend**](docs/FriendsApi.md#unblockFriend) | **POST** /api/v1/friends/{id}/unblock | Unblock a previously-blocked friendship
-*UghuuuGameServer.GroupsApi* | [**acceptGroupInvite**](docs/GroupsApi.md#acceptGroupInvite) | **POST** /api/v1/groups/{id}/accept_invite | Accept a group invitation
+*UghuuuGameServer.GroupsApi* | [**acceptGroupInvite**](docs/GroupsApi.md#acceptGroupInvite) | **POST** /api/v1/groups/invitations/{invite_id}/accept | Accept a group invitation
 *UghuuuGameServer.GroupsApi* | [**approveJoinRequest**](docs/GroupsApi.md#approveJoinRequest) | **POST** /api/v1/groups/{id}/join_requests/{request_id}/approve | Approve a join request (admin only)
 *UghuuuGameServer.GroupsApi* | [**cancelGroupInvite**](docs/GroupsApi.md#cancelGroupInvite) | **DELETE** /api/v1/groups/sent_invitations/{invite_id} | Cancel a sent group invitation
 *UghuuuGameServer.GroupsApi* | [**cancelJoinRequest**](docs/GroupsApi.md#cancelJoinRequest) | **DELETE** /api/v1/groups/{id}/join_requests/{request_id} | Cancel your own pending join request
 *UghuuuGameServer.GroupsApi* | [**createGroup**](docs/GroupsApi.md#createGroup) | **POST** /api/v1/groups | Create a group
+*UghuuuGameServer.GroupsApi* | [**declineGroupInvite**](docs/GroupsApi.md#declineGroupInvite) | **POST** /api/v1/groups/invitations/{invite_id}/decline | Decline a group invitation
 *UghuuuGameServer.GroupsApi* | [**demoteGroupMember**](docs/GroupsApi.md#demoteGroupMember) | **POST** /api/v1/groups/{id}/demote | Demote admin to member
 *UghuuuGameServer.GroupsApi* | [**getGroup**](docs/GroupsApi.md#getGroup) | **GET** /api/v1/groups/{id} | Get group details
-*UghuuuGameServer.GroupsApi* | [**inviteToGroup**](docs/GroupsApi.md#inviteToGroup) | **POST** /api/v1/groups/{id}/invite | Invite a user to a hidden group (admin only)
+*UghuuuGameServer.GroupsApi* | [**inviteToGroup**](docs/GroupsApi.md#inviteToGroup) | **POST** /api/v1/groups/{id}/invite | Invite a user to a group (admin only)
 *UghuuuGameServer.GroupsApi* | [**joinGroup**](docs/GroupsApi.md#joinGroup) | **POST** /api/v1/groups/{id}/join | Join a group
 *UghuuuGameServer.GroupsApi* | [**kickGroupMember**](docs/GroupsApi.md#kickGroupMember) | **POST** /api/v1/groups/{id}/kick | Kick a member (admin only)
 *UghuuuGameServer.GroupsApi* | [**leaveGroup**](docs/GroupsApi.md#leaveGroup) | **POST** /api/v1/groups/{id}/leave | Leave a group
@@ -270,7 +394,9 @@ Class | Method | HTTP request | Description
 *UghuuuGameServer.LeaderboardsApi* | [**listLeaderboardRecords**](docs/LeaderboardsApi.md#listLeaderboardRecords) | **GET** /api/v1/leaderboards/{id}/records | List leaderboard records
 *UghuuuGameServer.LeaderboardsApi* | [**listLeaderboards**](docs/LeaderboardsApi.md#listLeaderboards) | **GET** /api/v1/leaderboards | List leaderboards
 *UghuuuGameServer.LeaderboardsApi* | [**listRecordsAroundUser**](docs/LeaderboardsApi.md#listRecordsAroundUser) | **GET** /api/v1/leaderboards/{id}/records/around/{user_id} | List records around a user
+*UghuuuGameServer.LeaderboardsApi* | [**resolveLeaderboardSlugs**](docs/LeaderboardsApi.md#resolveLeaderboardSlugs) | **POST** /api/v1/leaderboards/resolve | Resolve multiple slugs to active leaderboards
 *UghuuuGameServer.LobbiesApi* | [**createLobby**](docs/LobbiesApi.md#createLobby) | **POST** /api/v1/lobbies | Create a lobby
+*UghuuuGameServer.LobbiesApi* | [**getLobby**](docs/LobbiesApi.md#getLobby) | **GET** /api/v1/lobbies/{id} | Get a single lobby
 *UghuuuGameServer.LobbiesApi* | [**joinLobby**](docs/LobbiesApi.md#joinLobby) | **POST** /api/v1/lobbies/{id}/join | Join a lobby
 *UghuuuGameServer.LobbiesApi* | [**kickUser**](docs/LobbiesApi.md#kickUser) | **POST** /api/v1/lobbies/kick | Kick a user from the lobby (host only)
 *UghuuuGameServer.LobbiesApi* | [**leaveLobby**](docs/LobbiesApi.md#leaveLobby) | **POST** /api/v1/lobbies/leave | Leave the current lobby
@@ -280,10 +406,15 @@ Class | Method | HTTP request | Description
 *UghuuuGameServer.NotificationsApi* | [**deleteNotifications**](docs/NotificationsApi.md#deleteNotifications) | **DELETE** /api/v1/notifications | Delete notifications by IDs
 *UghuuuGameServer.NotificationsApi* | [**listNotifications**](docs/NotificationsApi.md#listNotifications) | **GET** /api/v1/notifications | List own notifications
 *UghuuuGameServer.NotificationsApi* | [**sendNotification**](docs/NotificationsApi.md#sendNotification) | **POST** /api/v1/notifications | Send a notification to a friend
+*UghuuuGameServer.PartiesApi* | [**acceptPartyInvite**](docs/PartiesApi.md#acceptPartyInvite) | **POST** /api/v1/parties/invite/accept | Accept a party invite
+*UghuuuGameServer.PartiesApi* | [**cancelPartyInvite**](docs/PartiesApi.md#cancelPartyInvite) | **POST** /api/v1/parties/invite/cancel | Cancel a pending party invite (leader only)
 *UghuuuGameServer.PartiesApi* | [**createParty**](docs/PartiesApi.md#createParty) | **POST** /api/v1/parties | Create a party
-*UghuuuGameServer.PartiesApi* | [**joinPartyByCode**](docs/PartiesApi.md#joinPartyByCode) | **POST** /api/v1/parties/join | Join a party by code
+*UghuuuGameServer.PartiesApi* | [**declinePartyInvite**](docs/PartiesApi.md#declinePartyInvite) | **POST** /api/v1/parties/invite/decline | Decline a party invite
+*UghuuuGameServer.PartiesApi* | [**inviteToParty**](docs/PartiesApi.md#inviteToParty) | **POST** /api/v1/parties/invite | Invite a user to the party (leader only)
 *UghuuuGameServer.PartiesApi* | [**kickPartyMember**](docs/PartiesApi.md#kickPartyMember) | **POST** /api/v1/parties/kick | Kick a member from the party (leader only)
 *UghuuuGameServer.PartiesApi* | [**leaveParty**](docs/PartiesApi.md#leaveParty) | **POST** /api/v1/parties/leave | Leave the current party
+*UghuuuGameServer.PartiesApi* | [**listPartyInvitations**](docs/PartiesApi.md#listPartyInvitations) | **GET** /api/v1/parties/invitations | List pending party invites for the current user
+*UghuuuGameServer.PartiesApi* | [**listSentPartyInvitations**](docs/PartiesApi.md#listSentPartyInvitations) | **GET** /api/v1/parties/invitations/sent | List pending party invites sent by the current leader
 *UghuuuGameServer.PartiesApi* | [**partyCreateLobby**](docs/PartiesApi.md#partyCreateLobby) | **POST** /api/v1/parties/create_lobby | Create a lobby with the party (leader only)
 *UghuuuGameServer.PartiesApi* | [**partyJoinLobby**](docs/PartiesApi.md#partyJoinLobby) | **POST** /api/v1/parties/join_lobby/{id} | Join a lobby with the party (leader only)
 *UghuuuGameServer.PartiesApi* | [**showParty**](docs/PartiesApi.md#showParty) | **GET** /api/v1/parties/me | Get current party
@@ -298,6 +429,8 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Models
 
+ - [UghuuuGameServer.AcceptPartyInviteRequest](docs/AcceptPartyInviteRequest.md)
+ - [UghuuuGameServer.AdminCreateAchievementRequest](docs/AdminCreateAchievementRequest.md)
  - [UghuuuGameServer.AdminCreateKvEntry200Response](docs/AdminCreateKvEntry200Response.md)
  - [UghuuuGameServer.AdminCreateKvEntryRequest](docs/AdminCreateKvEntryRequest.md)
  - [UghuuuGameServer.AdminCreateLeaderboardRequest](docs/AdminCreateLeaderboardRequest.md)
@@ -306,6 +439,8 @@ Class | Method | HTTP request | Description
  - [UghuuuGameServer.AdminDeleteChatConversation200Response](docs/AdminDeleteChatConversation200Response.md)
  - [UghuuuGameServer.AdminEndLeaderboard200Response](docs/AdminEndLeaderboard200Response.md)
  - [UghuuuGameServer.AdminEndLeaderboard200ResponseData](docs/AdminEndLeaderboard200ResponseData.md)
+ - [UghuuuGameServer.AdminIncrementAchievementRequest](docs/AdminIncrementAchievementRequest.md)
+ - [UghuuuGameServer.AdminListAchievements200Response](docs/AdminListAchievements200Response.md)
  - [UghuuuGameServer.AdminListChatMessages200Response](docs/AdminListChatMessages200Response.md)
  - [UghuuuGameServer.AdminListChatMessages200ResponseDataInner](docs/AdminListChatMessages200ResponseDataInner.md)
  - [UghuuuGameServer.AdminListGroups200Response](docs/AdminListGroups200Response.md)
@@ -318,9 +453,13 @@ Class | Method | HTTP request | Description
  - [UghuuuGameServer.AdminListNotifications200ResponseMeta](docs/AdminListNotifications200ResponseMeta.md)
  - [UghuuuGameServer.AdminListSessions200Response](docs/AdminListSessions200Response.md)
  - [UghuuuGameServer.AdminListSessions200ResponseDataInner](docs/AdminListSessions200ResponseDataInner.md)
+ - [UghuuuGameServer.AdminRevokeAchievementRequest](docs/AdminRevokeAchievementRequest.md)
  - [UghuuuGameServer.AdminSubmitLeaderboardScore200Response](docs/AdminSubmitLeaderboardScore200Response.md)
  - [UghuuuGameServer.AdminSubmitLeaderboardScore200ResponseData](docs/AdminSubmitLeaderboardScore200ResponseData.md)
  - [UghuuuGameServer.AdminSubmitLeaderboardScoreRequest](docs/AdminSubmitLeaderboardScoreRequest.md)
+ - [UghuuuGameServer.AdminUnlockAchievementRequest](docs/AdminUnlockAchievementRequest.md)
+ - [UghuuuGameServer.AdminUpdateAchievement200Response](docs/AdminUpdateAchievement200Response.md)
+ - [UghuuuGameServer.AdminUpdateAchievementRequest](docs/AdminUpdateAchievementRequest.md)
  - [UghuuuGameServer.AdminUpdateGroup200Response](docs/AdminUpdateGroup200Response.md)
  - [UghuuuGameServer.AdminUpdateGroupRequest](docs/AdminUpdateGroupRequest.md)
  - [UghuuuGameServer.AdminUpdateKvEntryRequest](docs/AdminUpdateKvEntryRequest.md)
@@ -335,23 +474,29 @@ Class | Method | HTTP request | Description
  - [UghuuuGameServer.CallHookRequest](docs/CallHookRequest.md)
  - [UghuuuGameServer.CancelGroupInvite200Response](docs/CancelGroupInvite200Response.md)
  - [UghuuuGameServer.CancelJoinRequest200Response](docs/CancelJoinRequest200Response.md)
+ - [UghuuuGameServer.CancelPartyInviteRequest](docs/CancelPartyInviteRequest.md)
  - [UghuuuGameServer.ChatUnreadCount200Response](docs/ChatUnreadCount200Response.md)
  - [UghuuuGameServer.CreateFriendRequestRequest](docs/CreateFriendRequestRequest.md)
  - [UghuuuGameServer.CreateGroupRequest](docs/CreateGroupRequest.md)
  - [UghuuuGameServer.CreateLobbyRequest](docs/CreateLobbyRequest.md)
  - [UghuuuGameServer.CreatePartyRequest](docs/CreatePartyRequest.md)
+ - [UghuuuGameServer.DeclinePartyInviteRequest](docs/DeclinePartyInviteRequest.md)
  - [UghuuuGameServer.DeleteNotifications200Response](docs/DeleteNotifications200Response.md)
  - [UghuuuGameServer.DeleteNotificationsRequest](docs/DeleteNotificationsRequest.md)
  - [UghuuuGameServer.DemoteGroupMemberRequest](docs/DemoteGroupMemberRequest.md)
  - [UghuuuGameServer.DeviceLoginRequest](docs/DeviceLoginRequest.md)
  - [UghuuuGameServer.ErrorResponse](docs/ErrorResponse.md)
+ - [UghuuuGameServer.GetChatMessage200Response](docs/GetChatMessage200Response.md)
  - [UghuuuGameServer.GetCurrentUser200Response](docs/GetCurrentUser200Response.md)
  - [UghuuuGameServer.GetCurrentUser200ResponseLinkedProviders](docs/GetCurrentUser200ResponseLinkedProviders.md)
  - [UghuuuGameServer.GetKv200Response](docs/GetKv200Response.md)
+ - [UghuuuGameServer.GetLobby200Response](docs/GetLobby200Response.md)
+ - [UghuuuGameServer.GetLobby200ResponseMembersInner](docs/GetLobby200ResponseMembersInner.md)
  - [UghuuuGameServer.GetMyRecord200Response](docs/GetMyRecord200Response.md)
  - [UghuuuGameServer.HealthResponse](docs/HealthResponse.md)
+ - [UghuuuGameServer.InviteToGroup200Response](docs/InviteToGroup200Response.md)
  - [UghuuuGameServer.InviteToGroupRequest](docs/InviteToGroupRequest.md)
- - [UghuuuGameServer.JoinPartyByCodeRequest](docs/JoinPartyByCodeRequest.md)
+ - [UghuuuGameServer.InviteToPartyRequest](docs/InviteToPartyRequest.md)
  - [UghuuuGameServer.KickGroupMemberRequest](docs/KickGroupMemberRequest.md)
  - [UghuuuGameServer.KickUserRequest](docs/KickUserRequest.md)
  - [UghuuuGameServer.LinkDeviceRequest](docs/LinkDeviceRequest.md)
@@ -359,7 +504,6 @@ Class | Method | HTTP request | Description
  - [UghuuuGameServer.ListBlockedFriends200ResponseDataInner](docs/ListBlockedFriends200ResponseDataInner.md)
  - [UghuuuGameServer.ListBlockedFriends200ResponseDataInnerRequester](docs/ListBlockedFriends200ResponseDataInnerRequester.md)
  - [UghuuuGameServer.ListChatMessages200Response](docs/ListChatMessages200Response.md)
- - [UghuuuGameServer.ListChatMessages200ResponseDataInner](docs/ListChatMessages200ResponseDataInner.md)
  - [UghuuuGameServer.ListFriendRequests200Response](docs/ListFriendRequests200Response.md)
  - [UghuuuGameServer.ListFriendRequests200ResponseIncomingInner](docs/ListFriendRequests200ResponseIncomingInner.md)
  - [UghuuuGameServer.ListFriendRequests200ResponseIncomingInnerRequester](docs/ListFriendRequests200ResponseIncomingInnerRequester.md)
@@ -381,6 +525,7 @@ Class | Method | HTTP request | Description
  - [UghuuuGameServer.ListMyGroups200ResponseDataInner](docs/ListMyGroups200ResponseDataInner.md)
  - [UghuuuGameServer.ListNotifications200Response](docs/ListNotifications200Response.md)
  - [UghuuuGameServer.ListNotifications200ResponseDataInner](docs/ListNotifications200ResponseDataInner.md)
+ - [UghuuuGameServer.ListPartyInvitations200ResponseInner](docs/ListPartyInvitations200ResponseInner.md)
  - [UghuuuGameServer.ListRecordsAroundUser200Response](docs/ListRecordsAroundUser200Response.md)
  - [UghuuuGameServer.ListSentInvitations200Response](docs/ListSentInvitations200Response.md)
  - [UghuuuGameServer.ListSentInvitations200ResponseDataInner](docs/ListSentInvitations200ResponseDataInner.md)
@@ -406,18 +551,23 @@ Class | Method | HTTP request | Description
  - [UghuuuGameServer.RefreshToken200Response](docs/RefreshToken200Response.md)
  - [UghuuuGameServer.RefreshToken200ResponseData](docs/RefreshToken200ResponseData.md)
  - [UghuuuGameServer.RefreshTokenRequest](docs/RefreshTokenRequest.md)
+ - [UghuuuGameServer.ResolveLeaderboardSlugs200Response](docs/ResolveLeaderboardSlugs200Response.md)
+ - [UghuuuGameServer.ResolveLeaderboardSlugsRequest](docs/ResolveLeaderboardSlugsRequest.md)
  - [UghuuuGameServer.SearchUsers200Response](docs/SearchUsers200Response.md)
  - [UghuuuGameServer.SearchUsers200ResponseDataInner](docs/SearchUsers200ResponseDataInner.md)
  - [UghuuuGameServer.SendChatMessageRequest](docs/SendChatMessageRequest.md)
  - [UghuuuGameServer.SendNotificationRequest](docs/SendNotificationRequest.md)
  - [UghuuuGameServer.ShowParty200Response](docs/ShowParty200Response.md)
  - [UghuuuGameServer.ShowParty200ResponseMembersInner](docs/ShowParty200ResponseMembersInner.md)
+ - [UghuuuGameServer.UpdateChatMessageRequest](docs/UpdateChatMessageRequest.md)
  - [UghuuuGameServer.UpdateCurrentUserDisplayNameRequest](docs/UpdateCurrentUserDisplayNameRequest.md)
  - [UghuuuGameServer.UpdateCurrentUserPassword400Response](docs/UpdateCurrentUserPassword400Response.md)
  - [UghuuuGameServer.UpdateCurrentUserPasswordRequest](docs/UpdateCurrentUserPasswordRequest.md)
  - [UghuuuGameServer.UpdateGroupRequest](docs/UpdateGroupRequest.md)
  - [UghuuuGameServer.UpdateLobbyRequest](docs/UpdateLobbyRequest.md)
  - [UghuuuGameServer.UpdatePartyRequest](docs/UpdatePartyRequest.md)
+ - [UghuuuGameServer.UserAchievements200Response](docs/UserAchievements200Response.md)
+ - [UghuuuGameServer.UserAchievements200ResponseDataInner](docs/UserAchievements200ResponseDataInner.md)
 
 
 ## Documentation for Authorization

package/dist/ApiClient.js

@@ -13,9 +13,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
  * Game Server API
- * API for Game Server application  ## Authentication  This API uses JWT (JSON Web Tokens) with access and refresh tokens:  ### Getting Tokens - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow  Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens  ### Using Tokens Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ```  ### Refreshing Tokens When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token.  ## Users Users endpoints cover the user lifecycle and profile features. Key highlights:  - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported  ## Friends The Friends domain offers lightweight social features:  - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts  ## Lobbies Lobbies provide matchmaking / room management primitives. Highlights:  - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated  ## Notifications Persistent user-to-user notifications that survive across sessions:  - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect 
+ * API for the Gamend Game Server. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, achievements, leaderboards, server scripting, and admin portal.  ## **1. Authentication**  This API uses JWT (JSON Web Tokens) with access and refresh tokens:  ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow  Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens  ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ```  ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token.  ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights:  - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported  ## **3. Friends** The Friends domain offers lightweight social features:  - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts  ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights:  - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated  ## **5. Notifications** Persistent user-to-user notifications that survive across sessions:  - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect  ## **6. Groups** Groups provide persistent community management for players:  - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"`  ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads):  - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel  ## **8. Chat** Real-time messaging across multiple conversation types:  - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking  ## **9. Leaderboards** Server-managed ranked scoreboards:  - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically  ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings:  - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata  ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements:  - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements  ## **12. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates.  ### **12.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ```  ### **12.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat  ### **12.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix`  ## **13. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients).  ### **13.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency  ### **13.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync  ### **13.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, {   onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ``` 
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.0.791
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).