@ughuuu/game_server 1.0.1050 → 1.0.1053

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (201) hide show
  1. package/README.md +23 -12
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/AchievementsApi.js +1 -1
  4. package/dist/api/AdminAchievementsApi.js +1 -1
  5. package/dist/api/AdminChatApi.js +1 -1
  6. package/dist/api/AdminGroupsApi.js +1 -1
  7. package/dist/api/AdminKVApi.js +1 -1
  8. package/dist/api/AdminLeaderboardsApi.js +1 -1
  9. package/dist/api/AdminLobbiesApi.js +1 -1
  10. package/dist/api/AdminMatchmakingApi.js +1 -1
  11. package/dist/api/AdminNotificationsApi.js +1 -1
  12. package/dist/api/AdminSessionsApi.js +1 -1
  13. package/dist/api/AdminStorageApi.js +212 -0
  14. package/dist/api/AdminTournamentsApi.js +1 -1
  15. package/dist/api/AdminUsersApi.js +1 -1
  16. package/dist/api/AuthenticationApi.js +1 -1
  17. package/dist/api/ChatApi.js +1 -1
  18. package/dist/api/FriendsApi.js +1 -1
  19. package/dist/api/GroupsApi.js +1 -1
  20. package/dist/api/HealthApi.js +1 -1
  21. package/dist/api/HooksApi.js +1 -1
  22. package/dist/api/KVApi.js +1 -1
  23. package/dist/api/LeaderboardsApi.js +1 -1
  24. package/dist/api/LobbiesApi.js +1 -1
  25. package/dist/api/MatchmakingApi.js +1 -1
  26. package/dist/api/NotificationsApi.js +1 -1
  27. package/dist/api/PartiesApi.js +1 -1
  28. package/dist/api/PaymentsApi.js +1 -1
  29. package/dist/api/TournamentsApi.js +132 -132
  30. package/dist/api/UsersApi.js +81 -3
  31. package/dist/index.js +63 -21
  32. package/dist/model/AcceptPartyInvite200Response.js +1 -1
  33. package/dist/model/AcceptPartyInvite200ResponseMembersInner.js +1 -1
  34. package/dist/model/AcceptPartyInviteRequest.js +1 -1
  35. package/dist/model/AdminCancelMatchmakingTicket200Response.js +1 -1
  36. package/dist/model/AdminCreateAchievementRequest.js +1 -1
  37. package/dist/model/AdminCreateLeaderboard200Response.js +1 -1
  38. package/dist/model/AdminCreateLeaderboard200ResponseData.js +1 -1
  39. package/dist/model/AdminCreateLeaderboardRequest.js +1 -1
  40. package/dist/model/AdminCreateNotificationRequest.js +1 -1
  41. package/dist/model/AdminDeleteChatConversation200Response.js +1 -1
  42. package/dist/model/AdminDrawTournament200Response.js +1 -1
  43. package/dist/model/AdminDrawTournament200ResponseData.js +1 -1
  44. package/dist/model/AdminGrantAchievementRequest.js +1 -1
  45. package/dist/model/AdminIncrementAchievementRequest.js +1 -1
  46. package/dist/model/AdminListAchievements200Response.js +1 -1
  47. package/dist/model/AdminListAchievements200ResponseDataInner.js +1 -1
  48. package/dist/model/AdminListChatMessages200Response.js +1 -1
  49. package/dist/model/AdminListChatMessages200ResponseDataInner.js +1 -1
  50. package/dist/model/AdminListGroups200Response.js +1 -1
  51. package/dist/model/AdminListKvEntries200Response.js +1 -1
  52. package/dist/model/AdminListLobbies200Response.js +1 -1
  53. package/dist/model/AdminListLobbies200ResponseDataInner.js +1 -1
  54. package/dist/model/AdminListMatchmakingTickets200Response.js +1 -1
  55. package/dist/model/AdminListMatchmakingTickets200ResponseDataInner.js +1 -1
  56. package/dist/model/AdminListNotifications200Response.js +1 -1
  57. package/dist/model/AdminListNotifications200ResponseDataInner.js +1 -1
  58. package/dist/model/AdminListSessions200Response.js +1 -1
  59. package/dist/model/AdminListSessions200ResponseDataInner.js +1 -1
  60. package/dist/model/AdminListStorageObjects200Response.js +132 -0
  61. package/dist/model/AdminListStorageObjects200ResponseDataInner.js +105 -0
  62. package/dist/model/AdminListStorageObjects200ResponseUsage.js +93 -0
  63. package/dist/model/AdminMatchmakingStats200Response.js +1 -1
  64. package/dist/model/AdminMatchmakingStats200ResponseData.js +1 -1
  65. package/dist/model/AdminResolveTournamentMatchRequest.js +1 -1
  66. package/dist/model/AdminRevokeAchievementRequest.js +1 -1
  67. package/dist/model/AdminSubmitLeaderboardScoreRequest.js +1 -1
  68. package/dist/model/AdminUpdateAchievementRequest.js +1 -1
  69. package/dist/model/AdminUpdateGroup200Response.js +1 -1
  70. package/dist/model/AdminUpdateGroupRequest.js +1 -1
  71. package/dist/model/AdminUpdateKvEntryRequest.js +1 -1
  72. package/dist/model/AdminUpdateLeaderboardRecord200Response.js +1 -1
  73. package/dist/model/AdminUpdateLeaderboardRecord200ResponseData.js +1 -1
  74. package/dist/model/AdminUpdateLeaderboardRecordRequest.js +1 -1
  75. package/dist/model/AdminUpdateLeaderboardRequest.js +1 -1
  76. package/dist/model/AdminUpdateLobby200Response.js +1 -1
  77. package/dist/model/AdminUpdateLobbyRequest.js +1 -1
  78. package/dist/model/AdminUpdateTournamentRequest.js +1 -1
  79. package/dist/model/AdminUpdateUser200Response.js +1 -1
  80. package/dist/model/AdminUpdateUser200ResponseData.js +1 -1
  81. package/dist/model/AdminUpdateUserRequest.js +1 -1
  82. package/dist/model/AdminUpsertKv200Response.js +1 -1
  83. package/dist/model/AdminUpsertKv200ResponseData.js +1 -1
  84. package/dist/model/AdminUpsertKvRequest.js +1 -1
  85. package/dist/model/ApproveJoinRequest200Response.js +1 -1
  86. package/dist/model/CallHook200Response.js +1 -1
  87. package/dist/model/CallHookRequest.js +1 -1
  88. package/dist/model/CancelJoinRequest200Response.js +1 -1
  89. package/dist/model/CancelPartyInviteRequest.js +1 -1
  90. package/dist/model/ChatUnreadCount200Response.js +1 -1
  91. package/dist/model/CreateCurrentUserAvatarUploadUrlRequest.js +124 -0
  92. package/dist/model/CreateFriendRequestRequest.js +1 -1
  93. package/dist/model/CreateGroupRequest.js +1 -1
  94. package/dist/model/CreateLobbyRequest.js +1 -1
  95. package/dist/model/CreatePartyRequest.js +1 -1
  96. package/dist/model/DeclineGroupInvite200Response.js +1 -1
  97. package/dist/model/DeclinePartyInviteRequest.js +1 -1
  98. package/dist/model/DeleteNotifications200Response.js +1 -1
  99. package/dist/model/DeleteNotificationsRequest.js +1 -1
  100. package/dist/model/DemoteGroupMemberRequest.js +1 -1
  101. package/dist/model/DeviceLoginRequest.js +1 -1
  102. package/dist/model/ErrorResponse.js +1 -1
  103. package/dist/model/GetCurrentUser200Response.js +1 -1
  104. package/dist/model/GetCurrentUser200ResponseLinkedProviders.js +1 -1
  105. package/dist/model/GetKv200Response.js +1 -1
  106. package/dist/model/GetLobby200Response.js +1 -1
  107. package/dist/model/GetMyRecord200Response.js +1 -1
  108. package/dist/model/GetMyRecord200ResponseData.js +1 -1
  109. package/dist/model/HealthResponse.js +1 -1
  110. package/dist/model/InviteToGroup200Response.js +1 -1
  111. package/dist/model/InviteToGroupRequest.js +1 -1
  112. package/dist/model/InviteToPartyRequest.js +1 -1
  113. package/dist/model/KickGroupMemberRequest.js +1 -1
  114. package/dist/model/KickPartyMemberRequest.js +1 -1
  115. package/dist/model/LinkDeviceRequest.js +1 -1
  116. package/dist/model/ListBlacklistedUsers200Response.js +1 -1
  117. package/dist/model/ListBlacklistedUsers200ResponseDataInner.js +1 -1
  118. package/dist/model/ListBlockedFriends200Response.js +1 -1
  119. package/dist/model/ListBlockedFriends200ResponseDataInner.js +1 -1
  120. package/dist/model/ListChatMessages200Response.js +1 -1
  121. package/dist/model/ListChatMessages200ResponseDataInner.js +1 -1
  122. package/dist/model/ListFriendRequests200Response.js +1 -1
  123. package/dist/model/ListFriendRequests200ResponseIncomingInner.js +1 -1
  124. package/dist/model/ListFriendRequests200ResponseIncomingInnerRequester.js +1 -1
  125. package/dist/model/ListFriendRequests200ResponseMeta.js +1 -1
  126. package/dist/model/ListFriends200Response.js +1 -1
  127. package/dist/model/ListFriends200ResponseDataInner.js +1 -1
  128. package/dist/model/ListFriends200ResponseMeta.js +1 -1
  129. package/dist/model/ListGroupInvitations200Response.js +1 -1
  130. package/dist/model/ListGroupInvitations200ResponseDataInner.js +1 -1
  131. package/dist/model/ListGroupMembers200Response.js +1 -1
  132. package/dist/model/ListJoinRequests200Response.js +1 -1
  133. package/dist/model/ListLeaderboardRecords200Response.js +1 -1
  134. package/dist/model/ListLeaderboards200Response.js +1 -1
  135. package/dist/model/ListLobbies200Response.js +1 -1
  136. package/dist/model/ListLobbies200ResponseDataInner.js +1 -1
  137. package/dist/model/ListMyGroups200Response.js +1 -1
  138. package/dist/model/ListMyGroups200ResponseDataInner.js +1 -1
  139. package/dist/model/ListNotifications200Response.js +1 -1
  140. package/dist/model/ListNotifications200ResponseDataInner.js +1 -1
  141. package/dist/model/ListPartyInvitations200ResponseInner.js +1 -1
  142. package/dist/model/ListRecordsAroundUser200Response.js +1 -1
  143. package/dist/model/ListSentInvitations200Response.js +1 -1
  144. package/dist/model/ListSentInvitations200ResponseDataInner.js +1 -1
  145. package/dist/model/{GameServerWebApiV1TournamentControllerIndex200Response.js → ListTournaments200Response.js} +22 -22
  146. package/dist/model/{GameServerWebApiV1TournamentControllerIndex200ResponseDataInner.js → ListTournaments200ResponseDataInner.js} +34 -34
  147. package/dist/model/Login200Response.js +1 -1
  148. package/dist/model/Login200ResponseData.js +1 -1
  149. package/dist/model/LoginRequest.js +1 -1
  150. package/dist/model/MarkChatReadRequest.js +1 -1
  151. package/dist/model/MatchmakingCancel200Response.js +1 -1
  152. package/dist/model/MatchmakingJoin201Response.js +1 -1
  153. package/dist/model/MatchmakingJoin201ResponseData.js +1 -1
  154. package/dist/model/MatchmakingJoinRequest.js +1 -1
  155. package/dist/model/MatchmakingMyTicket200Response.js +1 -1
  156. package/dist/model/MatchmakingMyTicket200ResponseData.js +1 -1
  157. package/dist/model/MatchmakingStats200Response.js +1 -1
  158. package/dist/model/MatchmakingStats200ResponseData.js +1 -1
  159. package/dist/model/MatchmakingStats200ResponseDataQueuesInner.js +1 -1
  160. package/dist/model/MyAchievements200Response.js +1 -1
  161. package/dist/model/MyAchievements200ResponseDataInner.js +1 -1
  162. package/dist/model/NotifyGroup200Response.js +1 -1
  163. package/dist/model/NotifyGroupRequest.js +1 -1
  164. package/dist/model/OAuthSessionData.js +1 -1
  165. package/dist/model/OAuthSessionDataDetails.js +1 -1
  166. package/dist/model/OAuthSessionStatus.js +1 -1
  167. package/dist/model/OauthApiCallback200Response.js +1 -1
  168. package/dist/model/OauthApiCallbackRequest.js +1 -1
  169. package/dist/model/OauthCallbackApiAppleIosRequest.js +1 -1
  170. package/dist/model/OauthGoogleIdTokenRequest.js +1 -1
  171. package/dist/model/OauthRequest200Response.js +1 -1
  172. package/dist/model/OauthSessionStatus404Response.js +1 -1
  173. package/dist/model/PartyCreateLobbyRequest.js +1 -1
  174. package/dist/model/PartyJoinLobbyRequest.js +1 -1
  175. package/dist/model/PaymentsEntitlements401Response.js +1 -1
  176. package/dist/model/PaymentsSteamCheckoutRequest.js +1 -1
  177. package/dist/model/PaymentsSteamFinalizeRequest.js +1 -1
  178. package/dist/model/PaymentsStripeCheckoutRequest.js +1 -1
  179. package/dist/model/PromoteGroupMemberRequest.js +1 -1
  180. package/dist/model/QuickJoinRequest.js +1 -1
  181. package/dist/model/RefreshToken200Response.js +1 -1
  182. package/dist/model/RefreshToken200ResponseData.js +1 -1
  183. package/dist/model/RefreshTokenRequest.js +1 -1
  184. package/dist/model/ResolveLeaderboardSlugs200Response.js +1 -1
  185. package/dist/model/ResolveLeaderboardSlugs200ResponseDataValue.js +1 -1
  186. package/dist/model/ResolveLeaderboardSlugsRequest.js +1 -1
  187. package/dist/model/SearchUsers200Response.js +1 -1
  188. package/dist/model/SearchUsers200ResponseDataInner.js +1 -1
  189. package/dist/model/SendChatMessageRequest.js +1 -1
  190. package/dist/model/SendNotificationRequest.js +1 -1
  191. package/dist/model/SetCurrentUserAvatarRequest.js +112 -0
  192. package/dist/model/{GameServerWebApiV1TournamentControllerMyMatch200Response.js → TournamentMyMatch200Response.js} +27 -27
  193. package/dist/model/UpdateChatMessageRequest.js +1 -1
  194. package/dist/model/UpdateCurrentUserDisplayName400Response.js +1 -1
  195. package/dist/model/UpdateCurrentUserDisplayNameRequest.js +1 -1
  196. package/dist/model/UpdateCurrentUserPasswordRequest.js +1 -1
  197. package/dist/model/UpdateCurrentUserUsernameRequest.js +1 -1
  198. package/dist/model/UpdateGroupRequest.js +1 -1
  199. package/dist/model/UpdateLobbyRequest.js +1 -1
  200. package/dist/model/UpdatePartyRequest.js +1 -1
  201. package/package.json +1 -1
@@ -5,10 +5,10 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
- var _GameServerWebApiV1TournamentControllerIndex200Response = _interopRequireDefault(require("../model/GameServerWebApiV1TournamentControllerIndex200Response"));
9
- var _GameServerWebApiV1TournamentControllerIndex200ResponseDataInner = _interopRequireDefault(require("../model/GameServerWebApiV1TournamentControllerIndex200ResponseDataInner"));
10
- var _GameServerWebApiV1TournamentControllerMyMatch200Response = _interopRequireDefault(require("../model/GameServerWebApiV1TournamentControllerMyMatch200Response"));
8
+ var _ListTournaments200Response = _interopRequireDefault(require("../model/ListTournaments200Response"));
9
+ var _ListTournaments200ResponseDataInner = _interopRequireDefault(require("../model/ListTournaments200ResponseDataInner"));
11
10
  var _PaymentsEntitlements401Response = _interopRequireDefault(require("../model/PaymentsEntitlements401Response"));
11
+ var _TournamentMyMatch200Response = _interopRequireDefault(require("../model/TournamentMyMatch200Response"));
12
12
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
13
13
  function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
14
14
  function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -19,7 +19,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
19
19
  * Game Server API
20
20
  * 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, tournaments, matchmaking, payments, 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. Tournaments** Single-elimination bracket tournaments, server-structured and game-judged: - **Registration window → seeded draw → timed rounds → champions**; recurring tournaments (cron) create one occurrence per cycle sharing a slug; a nil starts_at keeps registration open until an admin draws manually - **Join/leave** as an entry leader (`POST`/`DELETE /tournaments/:id/join`); team composition is game policy - **Browse**: list/filter tournaments, standings, full bracket view, and the caller's current match (`GET /tournaments/:id/my-match`) - **Match verdicts are server-side** (game hooks) — no public resolve endpoint; clients get `tournament_match_ready` / `tournament_match_resolved` / `tournament_updated` / `tournament_finished` on the user channel - **Admin management** over HTTP: create/update/delete, cancel, draw now, finish, and force match verdicts under `/api/v1/admin/tournaments` ## **13. Matchmaking** Ticket-based queueing that turns waiting players into hidden, locked lobbies: - **Join over HTTP** (`POST /matchmaking/tickets` with a `match_params` string map); only tickets with identical params match together — encode mode/map/skill band as parameter values - **A match forms** when a group reaches `max_players`, or has at least `min_players` and the oldest ticket outwaited the timeout; the server creates a hidden lobby, seats everyone and locks it - **The result is a push, not a poll**: matched players receive `match_found` (`lobby_id`, `match_params`) on their user channel; disconnecting cancels your tickets - **Inspect**: `GET /matchmaking/tickets/me` for your ticket, `GET /matchmaking/stats` for queue depths - **Admin management** over HTTP: list/filter tickets, force-cancel, and stats under `/api/v1/admin/matchmaking` ## **14. 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. ### **14.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() ``` ### **14.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites, tournament events, KV subscriptions - **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 ### **14.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` ## **15. 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). ### **15.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 ### **15.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **15.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 })) ```
21
21
  *
22
- * The version of the OpenAPI document: 1.0.1050
22
+ * The version of the OpenAPI document: 1.0.1053
23
23
  *
24
24
  *
25
25
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -46,105 +46,118 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
46
46
  }
47
47
 
48
48
  /**
49
- * Brackets and their matches (paginated by bracket)
49
+ * Tournament details (with the caller's participation when authenticated)
50
50
  * @param {String} id
51
- * @param {Object} opts Optional parameters
52
- * @param {Number} [index] Return only this bracket
53
- * @param {Number} [page = 1)]
54
- * @param {Number} [pageSize = 10)]
55
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
51
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListTournaments200ResponseDataInner} and HTTP response
56
52
  */
57
53
  return _createClass(TournamentsApi, [{
58
- key: "gameServerWebApiV1TournamentControllerBracketWithHttpInfo",
59
- value: function gameServerWebApiV1TournamentControllerBracketWithHttpInfo(id, opts) {
60
- opts = opts || {};
54
+ key: "getTournamentWithHttpInfo",
55
+ value: function getTournamentWithHttpInfo(id) {
61
56
  var postBody = null;
62
57
  // verify the required parameter 'id' is set
63
58
  if (id === undefined || id === null) {
64
- throw new Error("Missing the required parameter 'id' when calling gameServerWebApiV1TournamentControllerBracket");
59
+ throw new Error("Missing the required parameter 'id' when calling getTournament");
65
60
  }
66
61
  var pathParams = {
67
62
  'id': id
68
63
  };
69
- var queryParams = {
70
- 'index': opts['index'],
71
- 'page': opts['page'],
72
- 'page_size': opts['pageSize']
64
+ var queryParams = {};
65
+ var headerParams = {};
66
+ var formParams = {};
67
+ var authNames = [];
68
+ var contentTypes = [];
69
+ var accepts = ['application/json'];
70
+ var returnType = _ListTournaments200ResponseDataInner["default"];
71
+ return this.apiClient.callApi('/api/v1/tournaments/{id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
72
+ }
73
+
74
+ /**
75
+ * Tournament details (with the caller's participation when authenticated)
76
+ * @param {String} id
77
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListTournaments200ResponseDataInner}
78
+ */
79
+ }, {
80
+ key: "getTournament",
81
+ value: function getTournament(id) {
82
+ return this.getTournamentWithHttpInfo(id).then(function (response_and_data) {
83
+ return response_and_data.data;
84
+ });
85
+ }
86
+
87
+ /**
88
+ * Register as an entry leader
89
+ * @param {String} id
90
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
91
+ */
92
+ }, {
93
+ key: "joinTournamentWithHttpInfo",
94
+ value: function joinTournamentWithHttpInfo(id) {
95
+ var postBody = null;
96
+ // verify the required parameter 'id' is set
97
+ if (id === undefined || id === null) {
98
+ throw new Error("Missing the required parameter 'id' when calling joinTournament");
99
+ }
100
+ var pathParams = {
101
+ 'id': id
73
102
  };
103
+ var queryParams = {};
74
104
  var headerParams = {};
75
105
  var formParams = {};
76
106
  var authNames = [];
77
107
  var contentTypes = [];
78
108
  var accepts = ['application/json'];
79
109
  var returnType = Object;
80
- return this.apiClient.callApi('/api/v1/tournaments/{id}/bracket', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
110
+ return this.apiClient.callApi('/api/v1/tournaments/{id}/join', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
81
111
  }
82
112
 
83
113
  /**
84
- * Brackets and their matches (paginated by bracket)
114
+ * Register as an entry leader
85
115
  * @param {String} id
86
- * @param {Object} opts Optional parameters
87
- * @param {Number} opts.index Return only this bracket
88
- * @param {Number} opts.page (default to 1)
89
- * @param {Number} opts.pageSize (default to 10)
90
116
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
91
117
  */
92
118
  }, {
93
- key: "gameServerWebApiV1TournamentControllerBracket",
94
- value: function gameServerWebApiV1TournamentControllerBracket(id, opts) {
95
- return this.gameServerWebApiV1TournamentControllerBracketWithHttpInfo(id, opts).then(function (response_and_data) {
119
+ key: "joinTournament",
120
+ value: function joinTournament(id) {
121
+ return this.joinTournamentWithHttpInfo(id).then(function (response_and_data) {
96
122
  return response_and_data.data;
97
123
  });
98
124
  }
99
125
 
100
126
  /**
101
- * Registered entries (paginated)
127
+ * Withdraw the caller's entry (before the draw)
102
128
  * @param {String} id
103
- * @param {Object} opts Optional parameters
104
- * @param {module:model/String} [state]
105
- * @param {Number} [page = 1)]
106
- * @param {Number} [pageSize = 25)]
107
129
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
108
130
  */
109
131
  }, {
110
- key: "gameServerWebApiV1TournamentControllerEntriesWithHttpInfo",
111
- value: function gameServerWebApiV1TournamentControllerEntriesWithHttpInfo(id, opts) {
112
- opts = opts || {};
132
+ key: "leaveTournamentWithHttpInfo",
133
+ value: function leaveTournamentWithHttpInfo(id) {
113
134
  var postBody = null;
114
135
  // verify the required parameter 'id' is set
115
136
  if (id === undefined || id === null) {
116
- throw new Error("Missing the required parameter 'id' when calling gameServerWebApiV1TournamentControllerEntries");
137
+ throw new Error("Missing the required parameter 'id' when calling leaveTournament");
117
138
  }
118
139
  var pathParams = {
119
140
  'id': id
120
141
  };
121
- var queryParams = {
122
- 'state': opts['state'],
123
- 'page': opts['page'],
124
- 'page_size': opts['pageSize']
125
- };
142
+ var queryParams = {};
126
143
  var headerParams = {};
127
144
  var formParams = {};
128
145
  var authNames = [];
129
146
  var contentTypes = [];
130
147
  var accepts = ['application/json'];
131
148
  var returnType = Object;
132
- return this.apiClient.callApi('/api/v1/tournaments/{id}/entries', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
149
+ return this.apiClient.callApi('/api/v1/tournaments/{id}/join', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
133
150
  }
134
151
 
135
152
  /**
136
- * Registered entries (paginated)
153
+ * Withdraw the caller's entry (before the draw)
137
154
  * @param {String} id
138
- * @param {Object} opts Optional parameters
139
- * @param {module:model/String} opts.state
140
- * @param {Number} opts.page (default to 1)
141
- * @param {Number} opts.pageSize (default to 25)
142
155
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
143
156
  */
144
157
  }, {
145
- key: "gameServerWebApiV1TournamentControllerEntries",
146
- value: function gameServerWebApiV1TournamentControllerEntries(id, opts) {
147
- return this.gameServerWebApiV1TournamentControllerEntriesWithHttpInfo(id, opts).then(function (response_and_data) {
158
+ key: "leaveTournament",
159
+ value: function leaveTournament(id) {
160
+ return this.leaveTournamentWithHttpInfo(id).then(function (response_and_data) {
148
161
  return response_and_data.data;
149
162
  });
150
163
  }
@@ -156,11 +169,11 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
156
169
  * @param {String} [slug] Occurrence history
157
170
  * @param {Number} [page = 1)]
158
171
  * @param {Number} [pageSize = 25)]
159
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GameServerWebApiV1TournamentControllerIndex200Response} and HTTP response
172
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListTournaments200Response} and HTTP response
160
173
  */
161
174
  }, {
162
- key: "gameServerWebApiV1TournamentControllerIndexWithHttpInfo",
163
- value: function gameServerWebApiV1TournamentControllerIndexWithHttpInfo(opts) {
175
+ key: "listTournamentsWithHttpInfo",
176
+ value: function listTournamentsWithHttpInfo(opts) {
164
177
  opts = opts || {};
165
178
  var postBody = null;
166
179
  var pathParams = {};
@@ -175,7 +188,7 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
175
188
  var authNames = [];
176
189
  var contentTypes = [];
177
190
  var accepts = ['application/json'];
178
- var returnType = _GameServerWebApiV1TournamentControllerIndex200Response["default"];
191
+ var returnType = _ListTournaments200Response["default"];
179
192
  return this.apiClient.callApi('/api/v1/tournaments', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
180
193
  }
181
194
 
@@ -186,90 +199,116 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
186
199
  * @param {String} opts.slug Occurrence history
187
200
  * @param {Number} opts.page (default to 1)
188
201
  * @param {Number} opts.pageSize (default to 25)
189
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GameServerWebApiV1TournamentControllerIndex200Response}
202
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListTournaments200Response}
190
203
  */
191
204
  }, {
192
- key: "gameServerWebApiV1TournamentControllerIndex",
193
- value: function gameServerWebApiV1TournamentControllerIndex(opts) {
194
- return this.gameServerWebApiV1TournamentControllerIndexWithHttpInfo(opts).then(function (response_and_data) {
205
+ key: "listTournaments",
206
+ value: function listTournaments(opts) {
207
+ return this.listTournamentsWithHttpInfo(opts).then(function (response_and_data) {
195
208
  return response_and_data.data;
196
209
  });
197
210
  }
198
211
 
199
212
  /**
200
- * Register as an entry leader
213
+ * Brackets and their matches (paginated by bracket)
201
214
  * @param {String} id
215
+ * @param {Object} opts Optional parameters
216
+ * @param {Number} [index] Return only this bracket
217
+ * @param {Number} [page = 1)]
218
+ * @param {Number} [pageSize = 10)]
202
219
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
203
220
  */
204
221
  }, {
205
- key: "gameServerWebApiV1TournamentControllerJoinWithHttpInfo",
206
- value: function gameServerWebApiV1TournamentControllerJoinWithHttpInfo(id) {
222
+ key: "tournamentBracketWithHttpInfo",
223
+ value: function tournamentBracketWithHttpInfo(id, opts) {
224
+ opts = opts || {};
207
225
  var postBody = null;
208
226
  // verify the required parameter 'id' is set
209
227
  if (id === undefined || id === null) {
210
- throw new Error("Missing the required parameter 'id' when calling gameServerWebApiV1TournamentControllerJoin");
228
+ throw new Error("Missing the required parameter 'id' when calling tournamentBracket");
211
229
  }
212
230
  var pathParams = {
213
231
  'id': id
214
232
  };
215
- var queryParams = {};
233
+ var queryParams = {
234
+ 'index': opts['index'],
235
+ 'page': opts['page'],
236
+ 'page_size': opts['pageSize']
237
+ };
216
238
  var headerParams = {};
217
239
  var formParams = {};
218
240
  var authNames = [];
219
241
  var contentTypes = [];
220
242
  var accepts = ['application/json'];
221
243
  var returnType = Object;
222
- return this.apiClient.callApi('/api/v1/tournaments/{id}/join', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
244
+ return this.apiClient.callApi('/api/v1/tournaments/{id}/bracket', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
223
245
  }
224
246
 
225
247
  /**
226
- * Register as an entry leader
248
+ * Brackets and their matches (paginated by bracket)
227
249
  * @param {String} id
250
+ * @param {Object} opts Optional parameters
251
+ * @param {Number} opts.index Return only this bracket
252
+ * @param {Number} opts.page (default to 1)
253
+ * @param {Number} opts.pageSize (default to 10)
228
254
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
229
255
  */
230
256
  }, {
231
- key: "gameServerWebApiV1TournamentControllerJoin",
232
- value: function gameServerWebApiV1TournamentControllerJoin(id) {
233
- return this.gameServerWebApiV1TournamentControllerJoinWithHttpInfo(id).then(function (response_and_data) {
257
+ key: "tournamentBracket",
258
+ value: function tournamentBracket(id, opts) {
259
+ return this.tournamentBracketWithHttpInfo(id, opts).then(function (response_and_data) {
234
260
  return response_and_data.data;
235
261
  });
236
262
  }
237
263
 
238
264
  /**
239
- * Withdraw the caller's entry (before the draw)
265
+ * Registered entries (paginated)
240
266
  * @param {String} id
267
+ * @param {Object} opts Optional parameters
268
+ * @param {module:model/String} [state]
269
+ * @param {Number} [page = 1)]
270
+ * @param {Number} [pageSize = 25)]
241
271
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
242
272
  */
243
273
  }, {
244
- key: "gameServerWebApiV1TournamentControllerLeaveWithHttpInfo",
245
- value: function gameServerWebApiV1TournamentControllerLeaveWithHttpInfo(id) {
274
+ key: "tournamentEntriesWithHttpInfo",
275
+ value: function tournamentEntriesWithHttpInfo(id, opts) {
276
+ opts = opts || {};
246
277
  var postBody = null;
247
278
  // verify the required parameter 'id' is set
248
279
  if (id === undefined || id === null) {
249
- throw new Error("Missing the required parameter 'id' when calling gameServerWebApiV1TournamentControllerLeave");
280
+ throw new Error("Missing the required parameter 'id' when calling tournamentEntries");
250
281
  }
251
282
  var pathParams = {
252
283
  'id': id
253
284
  };
254
- var queryParams = {};
285
+ var queryParams = {
286
+ 'state': opts['state'],
287
+ 'page': opts['page'],
288
+ 'page_size': opts['pageSize']
289
+ };
255
290
  var headerParams = {};
256
291
  var formParams = {};
257
292
  var authNames = [];
258
293
  var contentTypes = [];
259
294
  var accepts = ['application/json'];
260
295
  var returnType = Object;
261
- return this.apiClient.callApi('/api/v1/tournaments/{id}/join', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
296
+ return this.apiClient.callApi('/api/v1/tournaments/{id}/entries', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
262
297
  }
263
298
 
264
299
  /**
265
- * Withdraw the caller's entry (before the draw)
300
+ * Registered entries (paginated)
266
301
  * @param {String} id
302
+ * @param {Object} opts Optional parameters
303
+ * @param {module:model/String} opts.state
304
+ * @param {Number} opts.page (default to 1)
305
+ * @param {Number} opts.pageSize (default to 25)
267
306
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
268
307
  */
269
308
  }, {
270
- key: "gameServerWebApiV1TournamentControllerLeave",
271
- value: function gameServerWebApiV1TournamentControllerLeave(id) {
272
- return this.gameServerWebApiV1TournamentControllerLeaveWithHttpInfo(id).then(function (response_and_data) {
309
+ key: "tournamentEntries",
310
+ value: function tournamentEntries(id, opts) {
311
+ return this.tournamentEntriesWithHttpInfo(id, opts).then(function (response_and_data) {
273
312
  return response_and_data.data;
274
313
  });
275
314
  }
@@ -277,15 +316,15 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
277
316
  /**
278
317
  * The caller's current unresolved match, if any
279
318
  * @param {String} id
280
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GameServerWebApiV1TournamentControllerMyMatch200Response} and HTTP response
319
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TournamentMyMatch200Response} and HTTP response
281
320
  */
282
321
  }, {
283
- key: "gameServerWebApiV1TournamentControllerMyMatchWithHttpInfo",
284
- value: function gameServerWebApiV1TournamentControllerMyMatchWithHttpInfo(id) {
322
+ key: "tournamentMyMatchWithHttpInfo",
323
+ value: function tournamentMyMatchWithHttpInfo(id) {
285
324
  var postBody = null;
286
325
  // verify the required parameter 'id' is set
287
326
  if (id === undefined || id === null) {
288
- throw new Error("Missing the required parameter 'id' when calling gameServerWebApiV1TournamentControllerMyMatch");
327
+ throw new Error("Missing the required parameter 'id' when calling tournamentMyMatch");
289
328
  }
290
329
  var pathParams = {
291
330
  'id': id
@@ -296,58 +335,19 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
296
335
  var authNames = [];
297
336
  var contentTypes = [];
298
337
  var accepts = ['application/json'];
299
- var returnType = _GameServerWebApiV1TournamentControllerMyMatch200Response["default"];
338
+ var returnType = _TournamentMyMatch200Response["default"];
300
339
  return this.apiClient.callApi('/api/v1/tournaments/{id}/my-match', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
301
340
  }
302
341
 
303
342
  /**
304
343
  * The caller's current unresolved match, if any
305
344
  * @param {String} id
306
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GameServerWebApiV1TournamentControllerMyMatch200Response}
307
- */
308
- }, {
309
- key: "gameServerWebApiV1TournamentControllerMyMatch",
310
- value: function gameServerWebApiV1TournamentControllerMyMatch(id) {
311
- return this.gameServerWebApiV1TournamentControllerMyMatchWithHttpInfo(id).then(function (response_and_data) {
312
- return response_and_data.data;
313
- });
314
- }
315
-
316
- /**
317
- * Tournament details (with the caller's participation when authenticated)
318
- * @param {String} id
319
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GameServerWebApiV1TournamentControllerIndex200ResponseDataInner} and HTTP response
320
- */
321
- }, {
322
- key: "gameServerWebApiV1TournamentControllerShowWithHttpInfo",
323
- value: function gameServerWebApiV1TournamentControllerShowWithHttpInfo(id) {
324
- var postBody = null;
325
- // verify the required parameter 'id' is set
326
- if (id === undefined || id === null) {
327
- throw new Error("Missing the required parameter 'id' when calling gameServerWebApiV1TournamentControllerShow");
328
- }
329
- var pathParams = {
330
- 'id': id
331
- };
332
- var queryParams = {};
333
- var headerParams = {};
334
- var formParams = {};
335
- var authNames = [];
336
- var contentTypes = [];
337
- var accepts = ['application/json'];
338
- var returnType = _GameServerWebApiV1TournamentControllerIndex200ResponseDataInner["default"];
339
- return this.apiClient.callApi('/api/v1/tournaments/{id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
340
- }
341
-
342
- /**
343
- * Tournament details (with the caller's participation when authenticated)
344
- * @param {String} id
345
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GameServerWebApiV1TournamentControllerIndex200ResponseDataInner}
345
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TournamentMyMatch200Response}
346
346
  */
347
347
  }, {
348
- key: "gameServerWebApiV1TournamentControllerShow",
349
- value: function gameServerWebApiV1TournamentControllerShow(id) {
350
- return this.gameServerWebApiV1TournamentControllerShowWithHttpInfo(id).then(function (response_and_data) {
348
+ key: "tournamentMyMatch",
349
+ value: function tournamentMyMatch(id) {
350
+ return this.tournamentMyMatchWithHttpInfo(id).then(function (response_and_data) {
351
351
  return response_and_data.data;
352
352
  });
353
353
  }
@@ -358,12 +358,12 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
358
358
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
359
359
  */
360
360
  }, {
361
- key: "gameServerWebApiV1TournamentControllerStandingsWithHttpInfo",
362
- value: function gameServerWebApiV1TournamentControllerStandingsWithHttpInfo(id) {
361
+ key: "tournamentStandingsWithHttpInfo",
362
+ value: function tournamentStandingsWithHttpInfo(id) {
363
363
  var postBody = null;
364
364
  // verify the required parameter 'id' is set
365
365
  if (id === undefined || id === null) {
366
- throw new Error("Missing the required parameter 'id' when calling gameServerWebApiV1TournamentControllerStandings");
366
+ throw new Error("Missing the required parameter 'id' when calling tournamentStandings");
367
367
  }
368
368
  var pathParams = {
369
369
  'id': id
@@ -384,9 +384,9 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
384
384
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
385
385
  */
386
386
  }, {
387
- key: "gameServerWebApiV1TournamentControllerStandings",
388
- value: function gameServerWebApiV1TournamentControllerStandings(id) {
389
- return this.gameServerWebApiV1TournamentControllerStandingsWithHttpInfo(id).then(function (response_and_data) {
387
+ key: "tournamentStandings",
388
+ value: function tournamentStandings(id) {
389
+ return this.tournamentStandingsWithHttpInfo(id).then(function (response_and_data) {
390
390
  return response_and_data.data;
391
391
  });
392
392
  }
@@ -5,10 +5,12 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _CreateCurrentUserAvatarUploadUrlRequest = _interopRequireDefault(require("../model/CreateCurrentUserAvatarUploadUrlRequest"));
8
9
  var _GetCurrentUser200Response = _interopRequireDefault(require("../model/GetCurrentUser200Response"));
9
10
  var _PaymentsEntitlements401Response = _interopRequireDefault(require("../model/PaymentsEntitlements401Response"));
10
11
  var _SearchUsers200Response = _interopRequireDefault(require("../model/SearchUsers200Response"));
11
12
  var _SearchUsers200ResponseDataInner = _interopRequireDefault(require("../model/SearchUsers200ResponseDataInner"));
13
+ var _SetCurrentUserAvatarRequest = _interopRequireDefault(require("../model/SetCurrentUserAvatarRequest"));
12
14
  var _UpdateCurrentUserDisplayName400Response = _interopRequireDefault(require("../model/UpdateCurrentUserDisplayName400Response"));
13
15
  var _UpdateCurrentUserDisplayNameRequest = _interopRequireDefault(require("../model/UpdateCurrentUserDisplayNameRequest"));
14
16
  var _UpdateCurrentUserPasswordRequest = _interopRequireDefault(require("../model/UpdateCurrentUserPasswordRequest"));
@@ -23,7 +25,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
23
25
  * Game Server API
24
26
  * 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, tournaments, matchmaking, payments, 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. Tournaments** Single-elimination bracket tournaments, server-structured and game-judged: - **Registration window → seeded draw → timed rounds → champions**; recurring tournaments (cron) create one occurrence per cycle sharing a slug; a nil starts_at keeps registration open until an admin draws manually - **Join/leave** as an entry leader (`POST`/`DELETE /tournaments/:id/join`); team composition is game policy - **Browse**: list/filter tournaments, standings, full bracket view, and the caller's current match (`GET /tournaments/:id/my-match`) - **Match verdicts are server-side** (game hooks) — no public resolve endpoint; clients get `tournament_match_ready` / `tournament_match_resolved` / `tournament_updated` / `tournament_finished` on the user channel - **Admin management** over HTTP: create/update/delete, cancel, draw now, finish, and force match verdicts under `/api/v1/admin/tournaments` ## **13. Matchmaking** Ticket-based queueing that turns waiting players into hidden, locked lobbies: - **Join over HTTP** (`POST /matchmaking/tickets` with a `match_params` string map); only tickets with identical params match together — encode mode/map/skill band as parameter values - **A match forms** when a group reaches `max_players`, or has at least `min_players` and the oldest ticket outwaited the timeout; the server creates a hidden lobby, seats everyone and locks it - **The result is a push, not a poll**: matched players receive `match_found` (`lobby_id`, `match_params`) on their user channel; disconnecting cancels your tickets - **Inspect**: `GET /matchmaking/tickets/me` for your ticket, `GET /matchmaking/stats` for queue depths - **Admin management** over HTTP: list/filter tickets, force-cancel, and stats under `/api/v1/admin/matchmaking` ## **14. 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. ### **14.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() ``` ### **14.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites, tournament events, KV subscriptions - **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 ### **14.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` ## **15. 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). ### **15.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 ### **15.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **15.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 })) ```
25
27
  *
26
- * The version of the OpenAPI document: 1.0.1050
28
+ * The version of the OpenAPI document: 1.0.1053
27
29
  *
28
30
  *
29
31
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -50,11 +52,49 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
50
52
  }
51
53
 
52
54
  /**
53
- * Delete current user
54
- * Deletes the authenticated user's account
55
+ * Request an avatar upload ticket
56
+ * Returns an upload ticket. Upload the image bytes to `url` with `method`/`headers`, then confirm with `POST /me/avatar` using the returned `key`.
57
+ * @param {Object} opts Optional parameters
58
+ * @param {module:model/CreateCurrentUserAvatarUploadUrlRequest} [createCurrentUserAvatarUploadUrlRequest] Upload metadata
55
59
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
56
60
  */
57
61
  return _createClass(UsersApi, [{
62
+ key: "createCurrentUserAvatarUploadUrlWithHttpInfo",
63
+ value: function createCurrentUserAvatarUploadUrlWithHttpInfo(opts) {
64
+ opts = opts || {};
65
+ var postBody = opts['createCurrentUserAvatarUploadUrlRequest'];
66
+ var pathParams = {};
67
+ var queryParams = {};
68
+ var headerParams = {};
69
+ var formParams = {};
70
+ var authNames = ['authorization'];
71
+ var contentTypes = ['application/json'];
72
+ var accepts = ['application/json'];
73
+ var returnType = Object;
74
+ return this.apiClient.callApi('/api/v1/me/avatar/upload-url', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
75
+ }
76
+
77
+ /**
78
+ * Request an avatar upload ticket
79
+ * Returns an upload ticket. Upload the image bytes to `url` with `method`/`headers`, then confirm with `POST /me/avatar` using the returned `key`.
80
+ * @param {Object} opts Optional parameters
81
+ * @param {module:model/CreateCurrentUserAvatarUploadUrlRequest} opts.createCurrentUserAvatarUploadUrlRequest Upload metadata
82
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
83
+ */
84
+ }, {
85
+ key: "createCurrentUserAvatarUploadUrl",
86
+ value: function createCurrentUserAvatarUploadUrl(opts) {
87
+ return this.createCurrentUserAvatarUploadUrlWithHttpInfo(opts).then(function (response_and_data) {
88
+ return response_and_data.data;
89
+ });
90
+ }
91
+
92
+ /**
93
+ * Delete current user
94
+ * Deletes the authenticated user's account
95
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
96
+ */
97
+ }, {
58
98
  key: "deleteCurrentUserWithHttpInfo",
59
99
  value: function deleteCurrentUserWithHttpInfo() {
60
100
  var postBody = null;
@@ -198,6 +238,44 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
198
238
  });
199
239
  }
200
240
 
241
+ /**
242
+ * Confirm an uploaded avatar
243
+ * Records a previously uploaded object (`key`) as the user's avatar.
244
+ * @param {Object} opts Optional parameters
245
+ * @param {module:model/SetCurrentUserAvatarRequest} [setCurrentUserAvatarRequest] Uploaded object key
246
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
247
+ */
248
+ }, {
249
+ key: "setCurrentUserAvatarWithHttpInfo",
250
+ value: function setCurrentUserAvatarWithHttpInfo(opts) {
251
+ opts = opts || {};
252
+ var postBody = opts['setCurrentUserAvatarRequest'];
253
+ var pathParams = {};
254
+ var queryParams = {};
255
+ var headerParams = {};
256
+ var formParams = {};
257
+ var authNames = ['authorization'];
258
+ var contentTypes = ['application/json'];
259
+ var accepts = ['application/json'];
260
+ var returnType = Object;
261
+ return this.apiClient.callApi('/api/v1/me/avatar', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
262
+ }
263
+
264
+ /**
265
+ * Confirm an uploaded avatar
266
+ * Records a previously uploaded object (`key`) as the user's avatar.
267
+ * @param {Object} opts Optional parameters
268
+ * @param {module:model/SetCurrentUserAvatarRequest} opts.setCurrentUserAvatarRequest Uploaded object key
269
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
270
+ */
271
+ }, {
272
+ key: "setCurrentUserAvatar",
273
+ value: function setCurrentUserAvatar(opts) {
274
+ return this.setCurrentUserAvatarWithHttpInfo(opts).then(function (response_and_data) {
275
+ return response_and_data.data;
276
+ });
277
+ }
278
+
201
279
  /**
202
280
  * Update current user's display name
203
281
  * @param {Object} opts Optional parameters