@ughuuu/game_server 1.0.1025 → 1.0.1028

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 (151) hide show
  1. package/README.md +2 -1
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/AchievementsApi.js +3 -3
  4. package/dist/api/AdminAchievementsApi.js +5 -5
  5. package/dist/api/AdminChatApi.js +9 -9
  6. package/dist/api/AdminGroupsApi.js +5 -5
  7. package/dist/api/AdminKVApi.js +13 -13
  8. package/dist/api/AdminLeaderboardsApi.js +21 -21
  9. package/dist/api/AdminLobbiesApi.js +5 -5
  10. package/dist/api/AdminNotificationsApi.js +3 -3
  11. package/dist/api/AdminSessionsApi.js +5 -5
  12. package/dist/api/AdminUsersApi.js +5 -5
  13. package/dist/api/AuthenticationApi.js +1 -1
  14. package/dist/api/ChatApi.js +7 -7
  15. package/dist/api/FriendsApi.js +7 -7
  16. package/dist/api/GroupsApi.js +27 -27
  17. package/dist/api/HealthApi.js +1 -1
  18. package/dist/api/HooksApi.js +1 -1
  19. package/dist/api/KVApi.js +1 -1
  20. package/dist/api/LeaderboardsApi.js +1 -1
  21. package/dist/api/LobbiesApi.js +3 -3
  22. package/dist/api/NotificationsApi.js +1 -1
  23. package/dist/api/PartiesApi.js +3 -3
  24. package/dist/api/PaymentsApi.js +1 -1
  25. package/dist/api/UsersApi.js +3 -3
  26. package/dist/index.js +7 -0
  27. package/dist/model/AcceptPartyInvite200Response.js +13 -5
  28. package/dist/model/AcceptPartyInvite200ResponseMembersInner.js +7 -3
  29. package/dist/model/AcceptPartyInviteRequest.js +8 -4
  30. package/dist/model/AdminCreateAchievementRequest.js +1 -1
  31. package/dist/model/AdminCreateLeaderboard200Response.js +1 -1
  32. package/dist/model/AdminCreateLeaderboard200ResponseData.js +7 -3
  33. package/dist/model/AdminCreateLeaderboardRequest.js +1 -1
  34. package/dist/model/AdminCreateNotificationRequest.js +15 -7
  35. package/dist/model/AdminDeleteChatConversation200Response.js +1 -1
  36. package/dist/model/AdminGrantAchievementRequest.js +8 -4
  37. package/dist/model/AdminIncrementAchievementRequest.js +8 -4
  38. package/dist/model/AdminListAchievements200Response.js +1 -1
  39. package/dist/model/AdminListAchievements200ResponseDataInner.js +7 -3
  40. package/dist/model/AdminListChatMessages200Response.js +1 -1
  41. package/dist/model/AdminListChatMessages200ResponseDataInner.js +19 -7
  42. package/dist/model/AdminListGroups200Response.js +1 -1
  43. package/dist/model/AdminListKvEntries200Response.js +1 -1
  44. package/dist/model/AdminListLobbies200Response.js +1 -1
  45. package/dist/model/AdminListLobbies200ResponseDataInner.js +13 -5
  46. package/dist/model/AdminListNotifications200Response.js +1 -1
  47. package/dist/model/AdminListNotifications200ResponseDataInner.js +19 -7
  48. package/dist/model/AdminListSessions200Response.js +1 -1
  49. package/dist/model/AdminListSessions200ResponseDataInner.js +13 -5
  50. package/dist/model/AdminRevokeAchievementRequest.js +15 -7
  51. package/dist/model/AdminSubmitLeaderboardScoreRequest.js +7 -3
  52. package/dist/model/AdminUpdateAchievementRequest.js +1 -1
  53. package/dist/model/AdminUpdateGroup200Response.js +7 -3
  54. package/dist/model/AdminUpdateGroupRequest.js +1 -1
  55. package/dist/model/AdminUpdateKvEntryRequest.js +13 -5
  56. package/dist/model/AdminUpdateLeaderboardRecord200Response.js +1 -1
  57. package/dist/model/AdminUpdateLeaderboardRecord200ResponseData.js +19 -7
  58. package/dist/model/AdminUpdateLeaderboardRecordRequest.js +1 -1
  59. package/dist/model/AdminUpdateLeaderboardRequest.js +1 -1
  60. package/dist/model/AdminUpdateLobby200Response.js +1 -1
  61. package/dist/model/AdminUpdateUser200Response.js +1 -1
  62. package/dist/model/AdminUpdateUser200ResponseData.js +13 -5
  63. package/dist/model/AdminUpdateUserRequest.js +1 -1
  64. package/dist/model/AdminUpsertKv200Response.js +1 -1
  65. package/dist/model/AdminUpsertKv200ResponseData.js +7 -3
  66. package/dist/model/AdminUpsertKvRequest.js +13 -5
  67. package/dist/model/ApproveJoinRequest200Response.js +19 -7
  68. package/dist/model/CallHook200Response.js +1 -1
  69. package/dist/model/CallHookRequest.js +1 -1
  70. package/dist/model/CancelJoinRequest200Response.js +19 -7
  71. package/dist/model/ChatUnreadCount200Response.js +1 -1
  72. package/dist/model/CreateFriendRequestRequest.js +109 -0
  73. package/dist/model/CreateGroupRequest.js +1 -1
  74. package/dist/model/CreateLobbyRequest.js +1 -1
  75. package/dist/model/CreatePartyRequest.js +1 -1
  76. package/dist/model/DeclineGroupInvite200Response.js +1 -1
  77. package/dist/model/DeleteNotificationsRequest.js +1 -1
  78. package/dist/model/DeviceLoginRequest.js +1 -1
  79. package/dist/model/ErrorResponse.js +1 -1
  80. package/dist/model/GetCurrentUser200Response.js +7 -3
  81. package/dist/model/GetCurrentUser200ResponseLinkedProviders.js +1 -1
  82. package/dist/model/GetKv200Response.js +1 -1
  83. package/dist/model/GetLobby200Response.js +1 -1
  84. package/dist/model/GetMyRecord200Response.js +1 -1
  85. package/dist/model/GetMyRecord200ResponseData.js +1 -1
  86. package/dist/model/HealthResponse.js +1 -1
  87. package/dist/model/InviteToPartyRequest.js +8 -4
  88. package/dist/model/ListBlockedFriends200Response.js +1 -1
  89. package/dist/model/ListBlockedFriends200ResponseDataInner.js +7 -3
  90. package/dist/model/ListBlockedFriends200ResponseDataInnerRequester.js +7 -3
  91. package/dist/model/ListChatMessages200Response.js +1 -1
  92. package/dist/model/ListChatMessages200ResponseDataInner.js +13 -5
  93. package/dist/model/ListFriendRequests200Response.js +1 -1
  94. package/dist/model/ListFriendRequests200ResponseIncomingInner.js +7 -3
  95. package/dist/model/ListFriendRequests200ResponseIncomingInnerRequester.js +7 -3
  96. package/dist/model/ListFriendRequests200ResponseMeta.js +1 -1
  97. package/dist/model/ListFriends200Response.js +1 -1
  98. package/dist/model/ListFriends200ResponseDataInner.js +13 -5
  99. package/dist/model/ListFriends200ResponseMeta.js +1 -1
  100. package/dist/model/ListGroupMembers200Response.js +1 -1
  101. package/dist/model/ListJoinRequests200Response.js +1 -1
  102. package/dist/model/ListLeaderboardRecords200Response.js +1 -1
  103. package/dist/model/ListLeaderboards200Response.js +1 -1
  104. package/dist/model/ListLobbies200Response.js +1 -1
  105. package/dist/model/ListLobbies200ResponseDataInner.js +13 -5
  106. package/dist/model/ListMyGroups200Response.js +1 -1
  107. package/dist/model/ListMyGroups200ResponseDataInner.js +7 -3
  108. package/dist/model/ListPartyInvitations200ResponseInner.js +25 -9
  109. package/dist/model/ListRecordsAroundUser200Response.js +1 -1
  110. package/dist/model/ListSentInvitations200Response.js +1 -1
  111. package/dist/model/ListSentInvitations200ResponseDataInner.js +25 -9
  112. package/dist/model/LoginRequest.js +1 -1
  113. package/dist/model/MarkChatReadRequest.js +15 -7
  114. package/dist/model/MyAchievements200Response.js +1 -1
  115. package/dist/model/MyAchievements200ResponseDataInner.js +7 -3
  116. package/dist/model/NotifyGroup200Response.js +1 -1
  117. package/dist/model/NotifyGroupRequest.js +1 -1
  118. package/dist/model/OAuthSessionData.js +1 -1
  119. package/dist/model/OAuthSessionDataDetails.js +1 -1
  120. package/dist/model/OAuthSessionStatus.js +1 -1
  121. package/dist/model/OauthApiCallback200Response.js +1 -1
  122. package/dist/model/OauthApiCallbackRequest.js +1 -1
  123. package/dist/model/OauthCallbackApiAppleIosRequest.js +1 -1
  124. package/dist/model/OauthGoogleIdTokenRequest.js +1 -1
  125. package/dist/model/OauthRequest200Response.js +1 -1
  126. package/dist/model/OauthSessionStatus404Response.js +1 -1
  127. package/dist/model/PartyCreateLobbyRequest.js +1 -1
  128. package/dist/model/PartyJoinLobbyRequest.js +1 -1
  129. package/dist/model/PaymentsEntitlements401Response.js +1 -1
  130. package/dist/model/PaymentsSteamCheckoutRequest.js +7 -3
  131. package/dist/model/PaymentsSteamFinalizeRequest.js +1 -1
  132. package/dist/model/PaymentsStripeCheckoutRequest.js +7 -3
  133. package/dist/model/QuickJoinRequest.js +1 -1
  134. package/dist/model/RefreshToken200Response.js +1 -1
  135. package/dist/model/RefreshToken200ResponseData.js +7 -3
  136. package/dist/model/RefreshTokenRequest.js +1 -1
  137. package/dist/model/ResolveLeaderboardSlugs200Response.js +1 -1
  138. package/dist/model/ResolveLeaderboardSlugs200ResponseDataValue.js +7 -3
  139. package/dist/model/ResolveLeaderboardSlugsRequest.js +1 -1
  140. package/dist/model/SearchUsers200Response.js +1 -1
  141. package/dist/model/SearchUsers200ResponseDataInner.js +7 -3
  142. package/dist/model/SendChatMessageRequest.js +1 -1
  143. package/dist/model/SendNotificationRequest.js +1 -1
  144. package/dist/model/UpdateChatMessageRequest.js +1 -1
  145. package/dist/model/UpdateCurrentUserDisplayName400Response.js +1 -1
  146. package/dist/model/UpdateCurrentUserDisplayNameRequest.js +1 -1
  147. package/dist/model/UpdateCurrentUserPasswordRequest.js +1 -1
  148. package/dist/model/UpdateGroupRequest.js +1 -1
  149. package/dist/model/UpdateLobbyRequest.js +1 -1
  150. package/dist/model/UpdatePartyRequest.js +1 -1
  151. package/package.json +1 -1
package/README.md CHANGED
@@ -177,7 +177,7 @@ webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 }))
177
177
 
178
178
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
179
179
 
180
- - API version: 1.0.1025
180
+ - API version: 1.0.1028
181
181
  - Package version: 1.0.0
182
182
  - Generator version: 7.23.0
183
183
  - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
@@ -483,6 +483,7 @@ Class | Method | HTTP request | Description
483
483
  - [UghuuuGameServer.CallHookRequest](docs/CallHookRequest.md)
484
484
  - [UghuuuGameServer.CancelJoinRequest200Response](docs/CancelJoinRequest200Response.md)
485
485
  - [UghuuuGameServer.ChatUnreadCount200Response](docs/ChatUnreadCount200Response.md)
486
+ - [UghuuuGameServer.CreateFriendRequestRequest](docs/CreateFriendRequestRequest.md)
486
487
  - [UghuuuGameServer.CreateGroupRequest](docs/CreateGroupRequest.md)
487
488
  - [UghuuuGameServer.CreateLobbyRequest](docs/CreateLobbyRequest.md)
488
489
  - [UghuuuGameServer.CreatePartyRequest](docs/CreatePartyRequest.md)
package/dist/ApiClient.js CHANGED
@@ -15,7 +15,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
15
15
  * Game Server API
16
16
  * 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, 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. 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 })) ```
17
17
  *
18
- * The version of the OpenAPI document: 1.0.1025
18
+ * The version of the OpenAPI document: 1.0.1028
19
19
  *
20
20
  *
21
21
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -17,7 +17,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
17
17
  * Game Server API
18
18
  * 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, 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. 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 })) ```
19
19
  *
20
- * The version of the OpenAPI document: 1.0.1025
20
+ * The version of the OpenAPI document: 1.0.1028
21
21
  *
22
22
  *
23
23
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -173,7 +173,7 @@ var AchievementsApi = exports["default"] = /*#__PURE__*/function () {
173
173
  /**
174
174
  * List a user's unlocked achievements
175
175
  * List achievements unlocked by a specific user.
176
- * @param {Number} userId
176
+ * @param {String} userId
177
177
  * @param {Object} opts Optional parameters
178
178
  * @param {Number} [page]
179
179
  * @param {Number} [pageSize]
@@ -207,7 +207,7 @@ var AchievementsApi = exports["default"] = /*#__PURE__*/function () {
207
207
  /**
208
208
  * List a user's unlocked achievements
209
209
  * List achievements unlocked by a specific user.
210
- * @param {Number} userId
210
+ * @param {String} userId
211
211
  * @param {Object} opts Optional parameters
212
212
  * @param {Number} opts.page
213
213
  * @param {Number} opts.pageSize
@@ -23,7 +23,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
23
23
  * Game Server API
24
24
  * 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, 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. 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 })) ```
25
25
  *
26
- * The version of the OpenAPI document: 1.0.1025
26
+ * The version of the OpenAPI document: 1.0.1028
27
27
  *
28
28
  *
29
29
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -87,7 +87,7 @@ var AdminAchievementsApi = exports["default"] = /*#__PURE__*/function () {
87
87
 
88
88
  /**
89
89
  * Delete achievement (admin)
90
- * @param {Number} id
90
+ * @param {String} id
91
91
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
92
92
  */
93
93
  }, {
@@ -113,7 +113,7 @@ var AdminAchievementsApi = exports["default"] = /*#__PURE__*/function () {
113
113
 
114
114
  /**
115
115
  * Delete achievement (admin)
116
- * @param {Number} id
116
+ * @param {String} id
117
117
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
118
118
  */
119
119
  }, {
@@ -311,7 +311,7 @@ var AdminAchievementsApi = exports["default"] = /*#__PURE__*/function () {
311
311
 
312
312
  /**
313
313
  * Update achievement (admin)
314
- * @param {Number} id
314
+ * @param {String} id
315
315
  * @param {Object} opts Optional parameters
316
316
  * @param {module:model/AdminUpdateAchievementRequest} [adminUpdateAchievementRequest] Achievement
317
317
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminListAchievements200ResponseDataInner} and HTTP response
@@ -340,7 +340,7 @@ var AdminAchievementsApi = exports["default"] = /*#__PURE__*/function () {
340
340
 
341
341
  /**
342
342
  * Update achievement (admin)
343
- * @param {Number} id
343
+ * @param {String} id
344
344
  * @param {Object} opts Optional parameters
345
345
  * @param {module:model/AdminUpdateAchievementRequest} opts.adminUpdateAchievementRequest Achievement
346
346
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminListAchievements200ResponseDataInner}
@@ -18,7 +18,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
18
18
  * Game Server API
19
19
  * 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, 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. 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 })) ```
20
20
  *
21
- * The version of the OpenAPI document: 1.0.1025
21
+ * The version of the OpenAPI document: 1.0.1028
22
22
  *
23
23
  *
24
24
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -48,7 +48,7 @@ var AdminChatApi = exports["default"] = /*#__PURE__*/function () {
48
48
  * Delete all messages in a conversation (admin)
49
49
  * Delete all messages for a given chat_type and chat_ref_id.
50
50
  * @param {module:model/String} chatType
51
- * @param {Number} chatRefId
51
+ * @param {String} chatRefId
52
52
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminDeleteChatConversation200Response} and HTTP response
53
53
  */
54
54
  return _createClass(AdminChatApi, [{
@@ -81,7 +81,7 @@ var AdminChatApi = exports["default"] = /*#__PURE__*/function () {
81
81
  * Delete all messages in a conversation (admin)
82
82
  * Delete all messages for a given chat_type and chat_ref_id.
83
83
  * @param {module:model/String} chatType
84
- * @param {Number} chatRefId
84
+ * @param {String} chatRefId
85
85
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminDeleteChatConversation200Response}
86
86
  */
87
87
  }, {
@@ -95,7 +95,7 @@ var AdminChatApi = exports["default"] = /*#__PURE__*/function () {
95
95
  /**
96
96
  * Delete a chat message (admin)
97
97
  * Admin-level message deletion by ID.
98
- * @param {Number} id
98
+ * @param {String} id
99
99
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
100
100
  */
101
101
  }, {
@@ -122,7 +122,7 @@ var AdminChatApi = exports["default"] = /*#__PURE__*/function () {
122
122
  /**
123
123
  * Delete a chat message (admin)
124
124
  * Admin-level message deletion by ID.
125
- * @param {Number} id
125
+ * @param {String} id
126
126
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
127
127
  */
128
128
  }, {
@@ -137,9 +137,9 @@ var AdminChatApi = exports["default"] = /*#__PURE__*/function () {
137
137
  * List all chat messages (admin)
138
138
  * List all chat messages with optional filters. Returns paginated results sorted by newest first.
139
139
  * @param {Object} opts Optional parameters
140
- * @param {Number} [senderId]
140
+ * @param {String} [senderId]
141
141
  * @param {module:model/String} [chatType]
142
- * @param {Number} [chatRefId]
142
+ * @param {String} [chatRefId]
143
143
  * @param {String} [content]
144
144
  * @param {module:model/String} [sortBy]
145
145
  * @param {Number} [page]
@@ -174,9 +174,9 @@ var AdminChatApi = exports["default"] = /*#__PURE__*/function () {
174
174
  * List all chat messages (admin)
175
175
  * List all chat messages with optional filters. Returns paginated results sorted by newest first.
176
176
  * @param {Object} opts Optional parameters
177
- * @param {Number} opts.senderId
177
+ * @param {String} opts.senderId
178
178
  * @param {module:model/String} opts.chatType
179
- * @param {Number} opts.chatRefId
179
+ * @param {String} opts.chatRefId
180
180
  * @param {String} opts.content
181
181
  * @param {module:model/String} opts.sortBy
182
182
  * @param {Number} opts.page
@@ -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, 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. 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 })) ```
21
21
  *
22
- * The version of the OpenAPI document: 1.0.1025
22
+ * The version of the OpenAPI document: 1.0.1028
23
23
  *
24
24
  *
25
25
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -48,7 +48,7 @@ var AdminGroupsApi = exports["default"] = /*#__PURE__*/function () {
48
48
  /**
49
49
  * Delete a group (admin)
50
50
  * Admin-level group deletion.
51
- * @param {Number} id
51
+ * @param {String} id
52
52
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
53
53
  */
54
54
  return _createClass(AdminGroupsApi, [{
@@ -75,7 +75,7 @@ var AdminGroupsApi = exports["default"] = /*#__PURE__*/function () {
75
75
  /**
76
76
  * Delete a group (admin)
77
77
  * Admin-level group deletion.
78
- * @param {Number} id
78
+ * @param {String} id
79
79
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
80
80
  */
81
81
  }, {
@@ -147,7 +147,7 @@ var AdminGroupsApi = exports["default"] = /*#__PURE__*/function () {
147
147
  /**
148
148
  * Update a group (admin)
149
149
  * Admin-level group update. No membership check.
150
- * @param {Number} id
150
+ * @param {String} id
151
151
  * @param {Object} opts Optional parameters
152
152
  * @param {module:model/AdminUpdateGroupRequest} [adminUpdateGroupRequest] Update parameters
153
153
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminUpdateGroup200Response} and HTTP response
@@ -177,7 +177,7 @@ var AdminGroupsApi = exports["default"] = /*#__PURE__*/function () {
177
177
  /**
178
178
  * Update a group (admin)
179
179
  * Admin-level group update. No membership check.
180
- * @param {Number} id
180
+ * @param {String} id
181
181
  * @param {Object} opts Optional parameters
182
182
  * @param {module:model/AdminUpdateGroupRequest} opts.adminUpdateGroupRequest Update parameters
183
183
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminUpdateGroup200Response}
@@ -20,7 +20,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
20
20
  * Game Server API
21
21
  * 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, 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. 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 })) ```
22
22
  *
23
- * The version of the OpenAPI document: 1.0.1025
23
+ * The version of the OpenAPI document: 1.0.1028
24
24
  *
25
25
  *
26
26
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -86,8 +86,8 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
86
86
  * Delete KV by key (admin)
87
87
  * @param {String} key
88
88
  * @param {Object} opts Optional parameters
89
- * @param {Number} [userId]
90
- * @param {Number} [lobbyId]
89
+ * @param {String} [userId]
90
+ * @param {String} [lobbyId]
91
91
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
92
92
  */
93
93
  }, {
@@ -118,8 +118,8 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
118
118
  * Delete KV by key (admin)
119
119
  * @param {String} key
120
120
  * @param {Object} opts Optional parameters
121
- * @param {Number} opts.userId
122
- * @param {Number} opts.lobbyId
121
+ * @param {String} opts.userId
122
+ * @param {String} opts.lobbyId
123
123
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
124
124
  */
125
125
  }, {
@@ -132,7 +132,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
132
132
 
133
133
  /**
134
134
  * Delete KV entry by id (admin)
135
- * @param {Number} id
135
+ * @param {String} id
136
136
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
137
137
  */
138
138
  }, {
@@ -158,7 +158,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
158
158
 
159
159
  /**
160
160
  * Delete KV entry by id (admin)
161
- * @param {Number} id
161
+ * @param {String} id
162
162
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
163
163
  */
164
164
  }, {
@@ -175,8 +175,8 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
175
175
  * @param {Number} [page]
176
176
  * @param {Number} [pageSize]
177
177
  * @param {String} [key]
178
- * @param {Number} [userId]
179
- * @param {Number} [lobbyId]
178
+ * @param {String} [userId]
179
+ * @param {String} [lobbyId]
180
180
  * @param {Boolean} [globalOnly]
181
181
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminListKvEntries200Response} and HTTP response
182
182
  */
@@ -209,8 +209,8 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
209
209
  * @param {Number} opts.page
210
210
  * @param {Number} opts.pageSize
211
211
  * @param {String} opts.key
212
- * @param {Number} opts.userId
213
- * @param {Number} opts.lobbyId
212
+ * @param {String} opts.userId
213
+ * @param {String} opts.lobbyId
214
214
  * @param {Boolean} opts.globalOnly
215
215
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminListKvEntries200Response}
216
216
  */
@@ -224,7 +224,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
224
224
 
225
225
  /**
226
226
  * Update KV entry by id (admin)
227
- * @param {Number} id
227
+ * @param {String} id
228
228
  * @param {Object} opts Optional parameters
229
229
  * @param {module:model/AdminUpdateKvEntryRequest} [adminUpdateKvEntryRequest] KV entry patch
230
230
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminUpsertKv200Response} and HTTP response
@@ -253,7 +253,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
253
253
 
254
254
  /**
255
255
  * Update KV entry by id (admin)
256
- * @param {Number} id
256
+ * @param {String} id
257
257
  * @param {Object} opts Optional parameters
258
258
  * @param {module:model/AdminUpdateKvEntryRequest} opts.adminUpdateKvEntryRequest KV entry patch
259
259
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminUpsertKv200Response}
@@ -22,7 +22,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
22
22
  * Game Server API
23
23
  * 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, 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. 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 })) ```
24
24
  *
25
- * The version of the OpenAPI document: 1.0.1025
25
+ * The version of the OpenAPI document: 1.0.1028
26
26
  *
27
27
  *
28
28
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -86,7 +86,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
86
86
 
87
87
  /**
88
88
  * Delete leaderboard (admin)
89
- * @param {Number} id
89
+ * @param {String} id
90
90
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
91
91
  */
92
92
  }, {
@@ -112,7 +112,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
112
112
 
113
113
  /**
114
114
  * Delete leaderboard (admin)
115
- * @param {Number} id
115
+ * @param {String} id
116
116
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
117
117
  */
118
118
  }, {
@@ -125,8 +125,8 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
125
125
 
126
126
  /**
127
127
  * Delete leaderboard record (admin)
128
- * @param {Number} id
129
- * @param {Number} recordId
128
+ * @param {String} id
129
+ * @param {String} recordId
130
130
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
131
131
  */
132
132
  }, {
@@ -157,8 +157,8 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
157
157
 
158
158
  /**
159
159
  * Delete leaderboard record (admin)
160
- * @param {Number} id
161
- * @param {Number} recordId
160
+ * @param {String} id
161
+ * @param {String} recordId
162
162
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
163
163
  */
164
164
  }, {
@@ -171,8 +171,8 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
171
171
 
172
172
  /**
173
173
  * Delete a user's record (admin)
174
- * @param {Number} id
175
- * @param {Number} userId
174
+ * @param {String} id
175
+ * @param {String} userId
176
176
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
177
177
  */
178
178
  }, {
@@ -203,8 +203,8 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
203
203
 
204
204
  /**
205
205
  * Delete a user's record (admin)
206
- * @param {Number} id
207
- * @param {Number} userId
206
+ * @param {String} id
207
+ * @param {String} userId
208
208
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
209
209
  */
210
210
  }, {
@@ -217,7 +217,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
217
217
 
218
218
  /**
219
219
  * End leaderboard (admin)
220
- * @param {Number} id
220
+ * @param {String} id
221
221
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminCreateLeaderboard200Response} and HTTP response
222
222
  */
223
223
  }, {
@@ -243,7 +243,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
243
243
 
244
244
  /**
245
245
  * End leaderboard (admin)
246
- * @param {Number} id
246
+ * @param {String} id
247
247
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminCreateLeaderboard200Response}
248
248
  */
249
249
  }, {
@@ -256,7 +256,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
256
256
 
257
257
  /**
258
258
  * Submit score (admin)
259
- * @param {Number} id
259
+ * @param {String} id
260
260
  * @param {Object} opts Optional parameters
261
261
  * @param {module:model/AdminSubmitLeaderboardScoreRequest} [adminSubmitLeaderboardScoreRequest] Score submission
262
262
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminUpdateLeaderboardRecord200Response} and HTTP response
@@ -285,7 +285,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
285
285
 
286
286
  /**
287
287
  * Submit score (admin)
288
- * @param {Number} id
288
+ * @param {String} id
289
289
  * @param {Object} opts Optional parameters
290
290
  * @param {module:model/AdminSubmitLeaderboardScoreRequest} opts.adminSubmitLeaderboardScoreRequest Score submission
291
291
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminUpdateLeaderboardRecord200Response}
@@ -300,7 +300,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
300
300
 
301
301
  /**
302
302
  * Update leaderboard (admin)
303
- * @param {Number} id
303
+ * @param {String} id
304
304
  * @param {Object} opts Optional parameters
305
305
  * @param {module:model/AdminUpdateLeaderboardRequest} [adminUpdateLeaderboardRequest] Leaderboard patch
306
306
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminCreateLeaderboard200Response} and HTTP response
@@ -329,7 +329,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
329
329
 
330
330
  /**
331
331
  * Update leaderboard (admin)
332
- * @param {Number} id
332
+ * @param {String} id
333
333
  * @param {Object} opts Optional parameters
334
334
  * @param {module:model/AdminUpdateLeaderboardRequest} opts.adminUpdateLeaderboardRequest Leaderboard patch
335
335
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminCreateLeaderboard200Response}
@@ -344,8 +344,8 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
344
344
 
345
345
  /**
346
346
  * Update leaderboard record (admin)
347
- * @param {Number} id
348
- * @param {Number} recordId
347
+ * @param {String} id
348
+ * @param {String} recordId
349
349
  * @param {Object} opts Optional parameters
350
350
  * @param {module:model/AdminUpdateLeaderboardRecordRequest} [adminUpdateLeaderboardRecordRequest] Record patch
351
351
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminUpdateLeaderboardRecord200Response} and HTTP response
@@ -379,8 +379,8 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
379
379
 
380
380
  /**
381
381
  * Update leaderboard record (admin)
382
- * @param {Number} id
383
- * @param {Number} recordId
382
+ * @param {String} id
383
+ * @param {String} recordId
384
384
  * @param {Object} opts Optional parameters
385
385
  * @param {module:model/AdminUpdateLeaderboardRecordRequest} opts.adminUpdateLeaderboardRecordRequest Record patch
386
386
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminUpdateLeaderboardRecord200Response}