@ughuuu/game_server 1.0.1053 → 1.0.1055

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 (208) hide show
  1. package/README.md +17 -2
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/AchievementsApi.js +1 -1
  4. package/dist/api/AdminAchievementsApi.js +2 -2
  5. package/dist/api/AdminChatApi.js +2 -2
  6. package/dist/api/AdminEconomyApi.js +327 -0
  7. package/dist/api/AdminGroupsApi.js +2 -2
  8. package/dist/api/AdminKVApi.js +2 -2
  9. package/dist/api/AdminLeaderboardsApi.js +2 -2
  10. package/dist/api/AdminLobbiesApi.js +2 -2
  11. package/dist/api/AdminMatchmakingApi.js +2 -2
  12. package/dist/api/AdminNotificationsApi.js +2 -2
  13. package/dist/api/AdminSessionsApi.js +2 -2
  14. package/dist/api/AdminStorageApi.js +2 -2
  15. package/dist/api/AdminTournamentsApi.js +2 -2
  16. package/dist/api/AdminUsersApi.js +2 -2
  17. package/dist/api/AuthenticationApi.js +2 -2
  18. package/dist/api/ChatApi.js +1 -1
  19. package/dist/api/EconomyApi.js +153 -0
  20. package/dist/api/FriendsApi.js +2 -2
  21. package/dist/api/GroupsApi.js +2 -2
  22. package/dist/api/HealthApi.js +1 -1
  23. package/dist/api/HooksApi.js +2 -2
  24. package/dist/api/KVApi.js +2 -2
  25. package/dist/api/LeaderboardsApi.js +2 -2
  26. package/dist/api/LobbiesApi.js +2 -2
  27. package/dist/api/MatchmakingApi.js +2 -2
  28. package/dist/api/NotificationsApi.js +2 -2
  29. package/dist/api/PartiesApi.js +2 -2
  30. package/dist/api/PaymentsApi.js +2 -2
  31. package/dist/api/TournamentsApi.js +2 -2
  32. package/dist/api/UsersApi.js +2 -2
  33. package/dist/index.js +56 -7
  34. package/dist/model/AcceptPartyInvite200Response.js +1 -1
  35. package/dist/model/AcceptPartyInvite200ResponseMembersInner.js +1 -1
  36. package/dist/model/AcceptPartyInviteRequest.js +1 -1
  37. package/dist/model/AdminCancelMatchmakingTicket200Response.js +1 -1
  38. package/dist/model/AdminCreateAchievementRequest.js +1 -1
  39. package/dist/model/AdminCreateLeaderboard200Response.js +1 -1
  40. package/dist/model/AdminCreateLeaderboard200ResponseData.js +1 -1
  41. package/dist/model/AdminCreateLeaderboardRequest.js +1 -1
  42. package/dist/model/AdminCreateNotificationRequest.js +1 -1
  43. package/dist/model/AdminDeleteChatConversation200Response.js +1 -1
  44. package/dist/model/AdminDrawTournament200Response.js +1 -1
  45. package/dist/model/AdminDrawTournament200ResponseData.js +1 -1
  46. package/dist/model/AdminGrantAchievementRequest.js +1 -1
  47. package/dist/model/AdminGrantItemRequest.js +136 -0
  48. package/dist/model/AdminIncrementAchievementRequest.js +1 -1
  49. package/dist/model/AdminListAchievements200Response.js +1 -1
  50. package/dist/model/AdminListAchievements200ResponseDataInner.js +1 -1
  51. package/dist/model/AdminListChatMessages200Response.js +1 -1
  52. package/dist/model/AdminListChatMessages200ResponseDataInner.js +1 -1
  53. package/dist/model/AdminListGroups200Response.js +1 -1
  54. package/dist/model/AdminListKvEntries200Response.js +1 -1
  55. package/dist/model/AdminListLobbies200Response.js +1 -1
  56. package/dist/model/AdminListLobbies200ResponseDataInner.js +1 -1
  57. package/dist/model/AdminListMatchmakingTickets200Response.js +1 -1
  58. package/dist/model/AdminListMatchmakingTickets200ResponseDataInner.js +1 -1
  59. package/dist/model/AdminListNotifications200Response.js +1 -1
  60. package/dist/model/AdminListNotifications200ResponseDataInner.js +1 -1
  61. package/dist/model/AdminListSessions200Response.js +1 -1
  62. package/dist/model/AdminListSessions200ResponseDataInner.js +1 -1
  63. package/dist/model/AdminListStorageObjects200Response.js +1 -1
  64. package/dist/model/AdminListStorageObjects200ResponseDataInner.js +1 -1
  65. package/dist/model/AdminListStorageObjects200ResponseUsage.js +1 -1
  66. package/dist/model/AdminMatchmakingStats200Response.js +1 -1
  67. package/dist/model/AdminMatchmakingStats200ResponseData.js +1 -1
  68. package/dist/model/AdminResolveTournamentMatchRequest.js +1 -1
  69. package/dist/model/AdminRevokeAchievementRequest.js +1 -1
  70. package/dist/model/AdminSpendCurrencyRequest.js +160 -0
  71. package/dist/model/AdminSubmitLeaderboardScoreRequest.js +1 -1
  72. package/dist/model/AdminUpdateAchievementRequest.js +1 -1
  73. package/dist/model/AdminUpdateGroup200Response.js +1 -1
  74. package/dist/model/AdminUpdateGroupRequest.js +1 -1
  75. package/dist/model/AdminUpdateKvEntryRequest.js +1 -1
  76. package/dist/model/AdminUpdateLeaderboardRecord200Response.js +1 -1
  77. package/dist/model/AdminUpdateLeaderboardRecord200ResponseData.js +1 -1
  78. package/dist/model/AdminUpdateLeaderboardRecordRequest.js +1 -1
  79. package/dist/model/AdminUpdateLeaderboardRequest.js +1 -1
  80. package/dist/model/AdminUpdateLobby200Response.js +1 -1
  81. package/dist/model/AdminUpdateLobbyRequest.js +1 -1
  82. package/dist/model/AdminUpdateTournamentRequest.js +1 -1
  83. package/dist/model/AdminUpdateUser200Response.js +1 -1
  84. package/dist/model/AdminUpdateUser200ResponseData.js +1 -1
  85. package/dist/model/AdminUpdateUserRequest.js +1 -1
  86. package/dist/model/AdminUpsertKv200Response.js +1 -1
  87. package/dist/model/AdminUpsertKv200ResponseData.js +1 -1
  88. package/dist/model/AdminUpsertKvRequest.js +1 -1
  89. package/dist/model/ApproveJoinRequest200Response.js +1 -1
  90. package/dist/model/CallHook200Response.js +1 -1
  91. package/dist/model/CallHookRequest.js +1 -1
  92. package/dist/model/CancelJoinRequest200Response.js +1 -1
  93. package/dist/model/CancelPartyInviteRequest.js +1 -1
  94. package/dist/model/ChatUnreadCount200Response.js +1 -1
  95. package/dist/model/CreateCurrentUserAvatarUploadUrlRequest.js +1 -1
  96. package/dist/model/CreateFriendRequestRequest.js +1 -1
  97. package/dist/model/CreateGroupRequest.js +1 -1
  98. package/dist/model/CreateLobbyRequest.js +1 -1
  99. package/dist/model/CreatePartyRequest.js +1 -1
  100. package/dist/model/DeclineGroupInvite200Response.js +1 -1
  101. package/dist/model/DeclinePartyInviteRequest.js +1 -1
  102. package/dist/model/DeleteNotifications200Response.js +1 -1
  103. package/dist/model/DeleteNotificationsRequest.js +1 -1
  104. package/dist/model/DemoteGroupMemberRequest.js +1 -1
  105. package/dist/model/DeviceLoginRequest.js +1 -1
  106. package/dist/model/ErrorResponse.js +1 -1
  107. package/dist/model/GetCurrentUser200Response.js +1 -1
  108. package/dist/model/GetCurrentUser200ResponseLinkedProviders.js +1 -1
  109. package/dist/model/GetCurrentUserInventory200Response.js +87 -0
  110. package/dist/model/GetKv200Response.js +1 -1
  111. package/dist/model/GetLobby200Response.js +1 -1
  112. package/dist/model/GetMyRecord200Response.js +1 -1
  113. package/dist/model/GetMyRecord200ResponseData.js +1 -1
  114. package/dist/model/HealthResponse.js +1 -1
  115. package/dist/model/InviteToGroup200Response.js +1 -1
  116. package/dist/model/InviteToGroupRequest.js +1 -1
  117. package/dist/model/InviteToPartyRequest.js +1 -1
  118. package/dist/model/KickGroupMemberRequest.js +1 -1
  119. package/dist/model/KickPartyMemberRequest.js +1 -1
  120. package/dist/model/LinkDeviceRequest.js +1 -1
  121. package/dist/model/ListBlacklistedUsers200Response.js +1 -1
  122. package/dist/model/ListBlacklistedUsers200ResponseDataInner.js +1 -1
  123. package/dist/model/ListBlockedFriends200Response.js +1 -1
  124. package/dist/model/ListBlockedFriends200ResponseDataInner.js +1 -1
  125. package/dist/model/ListChatMessages200Response.js +1 -1
  126. package/dist/model/ListChatMessages200ResponseDataInner.js +1 -1
  127. package/dist/model/ListCurrentUserLedger200Response.js +118 -0
  128. package/dist/model/ListCurrentUserLedger200ResponseDataInner.js +145 -0
  129. package/dist/model/{PaymentsEntitlements401Response.js → ListCurrentUserLedger401Response.js} +18 -18
  130. package/dist/model/ListFriendRequests200Response.js +1 -1
  131. package/dist/model/ListFriendRequests200ResponseIncomingInner.js +1 -1
  132. package/dist/model/ListFriendRequests200ResponseIncomingInnerRequester.js +1 -1
  133. package/dist/model/ListFriendRequests200ResponseMeta.js +1 -1
  134. package/dist/model/ListFriends200Response.js +1 -1
  135. package/dist/model/ListFriends200ResponseDataInner.js +1 -1
  136. package/dist/model/ListFriends200ResponseMeta.js +1 -1
  137. package/dist/model/ListGroupInvitations200Response.js +1 -1
  138. package/dist/model/ListGroupInvitations200ResponseDataInner.js +1 -1
  139. package/dist/model/ListGroupMembers200Response.js +1 -1
  140. package/dist/model/ListJoinRequests200Response.js +1 -1
  141. package/dist/model/ListLeaderboardRecords200Response.js +1 -1
  142. package/dist/model/ListLeaderboards200Response.js +1 -1
  143. package/dist/model/ListLobbies200Response.js +1 -1
  144. package/dist/model/ListLobbies200ResponseDataInner.js +1 -1
  145. package/dist/model/ListMyGroups200Response.js +1 -1
  146. package/dist/model/ListMyGroups200ResponseDataInner.js +1 -1
  147. package/dist/model/ListNotifications200Response.js +1 -1
  148. package/dist/model/ListNotifications200ResponseDataInner.js +1 -1
  149. package/dist/model/ListPartyInvitations200ResponseInner.js +1 -1
  150. package/dist/model/ListRecordsAroundUser200Response.js +1 -1
  151. package/dist/model/ListSentInvitations200Response.js +1 -1
  152. package/dist/model/ListSentInvitations200ResponseDataInner.js +1 -1
  153. package/dist/model/ListTournaments200Response.js +1 -1
  154. package/dist/model/ListTournaments200ResponseDataInner.js +1 -1
  155. package/dist/model/Login200Response.js +1 -1
  156. package/dist/model/Login200ResponseData.js +1 -1
  157. package/dist/model/LoginRequest.js +1 -1
  158. package/dist/model/MarkChatReadRequest.js +1 -1
  159. package/dist/model/MatchmakingCancel200Response.js +1 -1
  160. package/dist/model/MatchmakingJoin201Response.js +1 -1
  161. package/dist/model/MatchmakingJoin201ResponseData.js +1 -1
  162. package/dist/model/MatchmakingJoinRequest.js +1 -1
  163. package/dist/model/MatchmakingMyTicket200Response.js +1 -1
  164. package/dist/model/MatchmakingMyTicket200ResponseData.js +1 -1
  165. package/dist/model/MatchmakingStats200Response.js +1 -1
  166. package/dist/model/MatchmakingStats200ResponseData.js +1 -1
  167. package/dist/model/MatchmakingStats200ResponseDataQueuesInner.js +1 -1
  168. package/dist/model/MyAchievements200Response.js +1 -1
  169. package/dist/model/MyAchievements200ResponseDataInner.js +1 -1
  170. package/dist/model/NotifyGroup200Response.js +1 -1
  171. package/dist/model/NotifyGroupRequest.js +1 -1
  172. package/dist/model/OAuthSessionData.js +1 -1
  173. package/dist/model/OAuthSessionDataDetails.js +1 -1
  174. package/dist/model/OAuthSessionStatus.js +1 -1
  175. package/dist/model/OauthApiCallback200Response.js +1 -1
  176. package/dist/model/OauthApiCallbackRequest.js +1 -1
  177. package/dist/model/OauthCallbackApiAppleIosRequest.js +1 -1
  178. package/dist/model/OauthGoogleIdTokenRequest.js +1 -1
  179. package/dist/model/OauthRequest200Response.js +1 -1
  180. package/dist/model/OauthSessionStatus404Response.js +1 -1
  181. package/dist/model/PartyCreateLobbyRequest.js +1 -1
  182. package/dist/model/PartyJoinLobbyRequest.js +1 -1
  183. package/dist/model/PaymentsSteamCheckoutRequest.js +1 -1
  184. package/dist/model/PaymentsSteamFinalizeRequest.js +1 -1
  185. package/dist/model/PaymentsStripeCheckoutRequest.js +1 -1
  186. package/dist/model/PromoteGroupMemberRequest.js +1 -1
  187. package/dist/model/QuickJoinRequest.js +1 -1
  188. package/dist/model/RefreshToken200Response.js +1 -1
  189. package/dist/model/RefreshToken200ResponseData.js +1 -1
  190. package/dist/model/RefreshTokenRequest.js +1 -1
  191. package/dist/model/ResolveLeaderboardSlugs200Response.js +1 -1
  192. package/dist/model/ResolveLeaderboardSlugs200ResponseDataValue.js +1 -1
  193. package/dist/model/ResolveLeaderboardSlugsRequest.js +1 -1
  194. package/dist/model/SearchUsers200Response.js +1 -1
  195. package/dist/model/SearchUsers200ResponseDataInner.js +1 -1
  196. package/dist/model/SendChatMessageRequest.js +1 -1
  197. package/dist/model/SendNotificationRequest.js +1 -1
  198. package/dist/model/SetCurrentUserAvatarRequest.js +1 -1
  199. package/dist/model/TournamentMyMatch200Response.js +1 -1
  200. package/dist/model/UpdateChatMessageRequest.js +1 -1
  201. package/dist/model/UpdateCurrentUserDisplayName400Response.js +1 -1
  202. package/dist/model/UpdateCurrentUserDisplayNameRequest.js +1 -1
  203. package/dist/model/UpdateCurrentUserPasswordRequest.js +1 -1
  204. package/dist/model/UpdateCurrentUserUsernameRequest.js +1 -1
  205. package/dist/model/UpdateGroupRequest.js +1 -1
  206. package/dist/model/UpdateLobbyRequest.js +1 -1
  207. package/dist/model/UpdatePartyRequest.js +1 -1
  208. package/package.json +1 -1
package/README.md CHANGED
@@ -195,7 +195,7 @@ webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 }))
195
195
 
196
196
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
197
197
 
198
- - API version: 1.0.1053
198
+ - API version: 1.0.1055
199
199
  - Package version: 1.0.0
200
200
  - Generator version: 7.24.0
201
201
  - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
@@ -325,6 +325,13 @@ Class | Method | HTTP request | Description
325
325
  *UghuuuGameServer.AdminChatApi* | [**adminDeleteChatConversation**](docs/AdminChatApi.md#adminDeleteChatConversation) | **DELETE** /api/v1/admin/chat/conversation | Delete all messages in a conversation (admin)
326
326
  *UghuuuGameServer.AdminChatApi* | [**adminDeleteChatMessage**](docs/AdminChatApi.md#adminDeleteChatMessage) | **DELETE** /api/v1/admin/chat/{id} | Delete a chat message (admin)
327
327
  *UghuuuGameServer.AdminChatApi* | [**adminListChatMessages**](docs/AdminChatApi.md#adminListChatMessages) | **GET** /api/v1/admin/chat | List all chat messages (admin)
328
+ *UghuuuGameServer.AdminEconomyApi* | [**adminConsumeItem**](docs/AdminEconomyApi.md#adminConsumeItem) | **POST** /api/v1/admin/economy/consume-item | Consume items from a user (admin)
329
+ *UghuuuGameServer.AdminEconomyApi* | [**adminGrantCurrency**](docs/AdminEconomyApi.md#adminGrantCurrency) | **POST** /api/v1/admin/economy/grant | Grant currency to a user (admin)
330
+ *UghuuuGameServer.AdminEconomyApi* | [**adminGrantItem**](docs/AdminEconomyApi.md#adminGrantItem) | **POST** /api/v1/admin/economy/grant-item | Grant items to a user (admin)
331
+ *UghuuuGameServer.AdminEconomyApi* | [**adminListInventory**](docs/AdminEconomyApi.md#adminListInventory) | **GET** /api/v1/admin/economy/items | List inventory item stacks (admin)
332
+ *UghuuuGameServer.AdminEconomyApi* | [**adminListLedger**](docs/AdminEconomyApi.md#adminListLedger) | **GET** /api/v1/admin/economy/ledger | List ledger entries (admin)
333
+ *UghuuuGameServer.AdminEconomyApi* | [**adminListWallets**](docs/AdminEconomyApi.md#adminListWallets) | **GET** /api/v1/admin/economy/wallets | List wallets (admin)
334
+ *UghuuuGameServer.AdminEconomyApi* | [**adminSpendCurrency**](docs/AdminEconomyApi.md#adminSpendCurrency) | **POST** /api/v1/admin/economy/spend | Spend currency from a user (admin)
328
335
  *UghuuuGameServer.AdminGroupsApi* | [**adminDeleteGroup**](docs/AdminGroupsApi.md#adminDeleteGroup) | **DELETE** /api/v1/admin/groups/{id} | Delete a group (admin)
329
336
  *UghuuuGameServer.AdminGroupsApi* | [**adminListGroups**](docs/AdminGroupsApi.md#adminListGroups) | **GET** /api/v1/admin/groups | List all groups (admin)
330
337
  *UghuuuGameServer.AdminGroupsApi* | [**adminUpdateGroup**](docs/AdminGroupsApi.md#adminUpdateGroup) | **PATCH** /api/v1/admin/groups/{id} | Update a group (admin)
@@ -387,6 +394,9 @@ Class | Method | HTTP request | Description
387
394
  *UghuuuGameServer.ChatApi* | [**markChatRead**](docs/ChatApi.md#markChatRead) | **POST** /api/v1/chat/read | Mark chat as read
388
395
  *UghuuuGameServer.ChatApi* | [**sendChatMessage**](docs/ChatApi.md#sendChatMessage) | **POST** /api/v1/chat/messages | Send a chat message
389
396
  *UghuuuGameServer.ChatApi* | [**updateChatMessage**](docs/ChatApi.md#updateChatMessage) | **PATCH** /api/v1/chat/messages/{id} | Update your own chat message
397
+ *UghuuuGameServer.EconomyApi* | [**getCurrentUserInventory**](docs/EconomyApi.md#getCurrentUserInventory) | **GET** /api/v1/me/inventory | Current user's item quantities
398
+ *UghuuuGameServer.EconomyApi* | [**getCurrentUserWallet**](docs/EconomyApi.md#getCurrentUserWallet) | **GET** /api/v1/me/wallet | Current user's currency balances
399
+ *UghuuuGameServer.EconomyApi* | [**listCurrentUserLedger**](docs/EconomyApi.md#listCurrentUserLedger) | **GET** /api/v1/me/wallet/ledger | Current user's ledger history
390
400
  *UghuuuGameServer.FriendsApi* | [**acceptFriendRequest**](docs/FriendsApi.md#acceptFriendRequest) | **POST** /api/v1/friends/{id}/accept | Accept a friend request
391
401
  *UghuuuGameServer.FriendsApi* | [**blockFriendRequest**](docs/FriendsApi.md#blockFriendRequest) | **POST** /api/v1/friends/{id}/block | Block a friend request / user
392
402
  *UghuuuGameServer.FriendsApi* | [**blockUser**](docs/FriendsApi.md#blockUser) | **POST** /api/v1/users/{user_id}/block | Blacklist a user, with or without an existing friendship
@@ -502,6 +512,7 @@ Class | Method | HTTP request | Description
502
512
  - [UghuuuGameServer.AdminDrawTournament200Response](docs/AdminDrawTournament200Response.md)
503
513
  - [UghuuuGameServer.AdminDrawTournament200ResponseData](docs/AdminDrawTournament200ResponseData.md)
504
514
  - [UghuuuGameServer.AdminGrantAchievementRequest](docs/AdminGrantAchievementRequest.md)
515
+ - [UghuuuGameServer.AdminGrantItemRequest](docs/AdminGrantItemRequest.md)
505
516
  - [UghuuuGameServer.AdminIncrementAchievementRequest](docs/AdminIncrementAchievementRequest.md)
506
517
  - [UghuuuGameServer.AdminListAchievements200Response](docs/AdminListAchievements200Response.md)
507
518
  - [UghuuuGameServer.AdminListAchievements200ResponseDataInner](docs/AdminListAchievements200ResponseDataInner.md)
@@ -524,6 +535,7 @@ Class | Method | HTTP request | Description
524
535
  - [UghuuuGameServer.AdminMatchmakingStats200ResponseData](docs/AdminMatchmakingStats200ResponseData.md)
525
536
  - [UghuuuGameServer.AdminResolveTournamentMatchRequest](docs/AdminResolveTournamentMatchRequest.md)
526
537
  - [UghuuuGameServer.AdminRevokeAchievementRequest](docs/AdminRevokeAchievementRequest.md)
538
+ - [UghuuuGameServer.AdminSpendCurrencyRequest](docs/AdminSpendCurrencyRequest.md)
527
539
  - [UghuuuGameServer.AdminSubmitLeaderboardScoreRequest](docs/AdminSubmitLeaderboardScoreRequest.md)
528
540
  - [UghuuuGameServer.AdminUpdateAchievementRequest](docs/AdminUpdateAchievementRequest.md)
529
541
  - [UghuuuGameServer.AdminUpdateGroup200Response](docs/AdminUpdateGroup200Response.md)
@@ -562,6 +574,7 @@ Class | Method | HTTP request | Description
562
574
  - [UghuuuGameServer.ErrorResponse](docs/ErrorResponse.md)
563
575
  - [UghuuuGameServer.GetCurrentUser200Response](docs/GetCurrentUser200Response.md)
564
576
  - [UghuuuGameServer.GetCurrentUser200ResponseLinkedProviders](docs/GetCurrentUser200ResponseLinkedProviders.md)
577
+ - [UghuuuGameServer.GetCurrentUserInventory200Response](docs/GetCurrentUserInventory200Response.md)
565
578
  - [UghuuuGameServer.GetKv200Response](docs/GetKv200Response.md)
566
579
  - [UghuuuGameServer.GetLobby200Response](docs/GetLobby200Response.md)
567
580
  - [UghuuuGameServer.GetMyRecord200Response](docs/GetMyRecord200Response.md)
@@ -579,6 +592,9 @@ Class | Method | HTTP request | Description
579
592
  - [UghuuuGameServer.ListBlockedFriends200ResponseDataInner](docs/ListBlockedFriends200ResponseDataInner.md)
580
593
  - [UghuuuGameServer.ListChatMessages200Response](docs/ListChatMessages200Response.md)
581
594
  - [UghuuuGameServer.ListChatMessages200ResponseDataInner](docs/ListChatMessages200ResponseDataInner.md)
595
+ - [UghuuuGameServer.ListCurrentUserLedger200Response](docs/ListCurrentUserLedger200Response.md)
596
+ - [UghuuuGameServer.ListCurrentUserLedger200ResponseDataInner](docs/ListCurrentUserLedger200ResponseDataInner.md)
597
+ - [UghuuuGameServer.ListCurrentUserLedger401Response](docs/ListCurrentUserLedger401Response.md)
582
598
  - [UghuuuGameServer.ListFriendRequests200Response](docs/ListFriendRequests200Response.md)
583
599
  - [UghuuuGameServer.ListFriendRequests200ResponseIncomingInner](docs/ListFriendRequests200ResponseIncomingInner.md)
584
600
  - [UghuuuGameServer.ListFriendRequests200ResponseIncomingInnerRequester](docs/ListFriendRequests200ResponseIncomingInnerRequester.md)
@@ -632,7 +648,6 @@ Class | Method | HTTP request | Description
632
648
  - [UghuuuGameServer.OauthSessionStatus404Response](docs/OauthSessionStatus404Response.md)
633
649
  - [UghuuuGameServer.PartyCreateLobbyRequest](docs/PartyCreateLobbyRequest.md)
634
650
  - [UghuuuGameServer.PartyJoinLobbyRequest](docs/PartyJoinLobbyRequest.md)
635
- - [UghuuuGameServer.PaymentsEntitlements401Response](docs/PaymentsEntitlements401Response.md)
636
651
  - [UghuuuGameServer.PaymentsSteamCheckoutRequest](docs/PaymentsSteamCheckoutRequest.md)
637
652
  - [UghuuuGameServer.PaymentsSteamFinalizeRequest](docs/PaymentsSteamFinalizeRequest.md)
638
653
  - [UghuuuGameServer.PaymentsStripeCheckoutRequest](docs/PaymentsStripeCheckoutRequest.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, tournaments, matchmaking, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements: - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements ## **12. Tournaments** Single-elimination bracket tournaments, server-structured and game-judged: - **Registration window → seeded draw → timed rounds → champions**; recurring tournaments (cron) create one occurrence per cycle sharing a slug; a nil starts_at keeps registration open until an admin draws manually - **Join/leave** as an entry leader (`POST`/`DELETE /tournaments/:id/join`); team composition is game policy - **Browse**: list/filter tournaments, standings, full bracket view, and the caller's current match (`GET /tournaments/:id/my-match`) - **Match verdicts are server-side** (game hooks) — no public resolve endpoint; clients get `tournament_match_ready` / `tournament_match_resolved` / `tournament_updated` / `tournament_finished` on the user channel - **Admin management** over HTTP: create/update/delete, cancel, draw now, finish, and force match verdicts under `/api/v1/admin/tournaments` ## **13. Matchmaking** Ticket-based queueing that turns waiting players into hidden, locked lobbies: - **Join over HTTP** (`POST /matchmaking/tickets` with a `match_params` string map); only tickets with identical params match together — encode mode/map/skill band as parameter values - **A match forms** when a group reaches `max_players`, or has at least `min_players` and the oldest ticket outwaited the timeout; the server creates a hidden lobby, seats everyone and locks it - **The result is a push, not a poll**: matched players receive `match_found` (`lobby_id`, `match_params`) on their user channel; disconnecting cancels your tickets - **Inspect**: `GET /matchmaking/tickets/me` for your ticket, `GET /matchmaking/stats` for queue depths - **Admin management** over HTTP: list/filter tickets, force-cancel, and stats under `/api/v1/admin/matchmaking` ## **14. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **14.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **14.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites, tournament events, KV subscriptions - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **14.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix` ## **15. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **15.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **15.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **15.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
17
17
  *
18
- * The version of the OpenAPI document: 1.0.1053
18
+ * The version of the OpenAPI document: 1.0.1055
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, tournaments, matchmaking, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements: - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements ## **12. Tournaments** Single-elimination bracket tournaments, server-structured and game-judged: - **Registration window → seeded draw → timed rounds → champions**; recurring tournaments (cron) create one occurrence per cycle sharing a slug; a nil starts_at keeps registration open until an admin draws manually - **Join/leave** as an entry leader (`POST`/`DELETE /tournaments/:id/join`); team composition is game policy - **Browse**: list/filter tournaments, standings, full bracket view, and the caller's current match (`GET /tournaments/:id/my-match`) - **Match verdicts are server-side** (game hooks) — no public resolve endpoint; clients get `tournament_match_ready` / `tournament_match_resolved` / `tournament_updated` / `tournament_finished` on the user channel - **Admin management** over HTTP: create/update/delete, cancel, draw now, finish, and force match verdicts under `/api/v1/admin/tournaments` ## **13. Matchmaking** Ticket-based queueing that turns waiting players into hidden, locked lobbies: - **Join over HTTP** (`POST /matchmaking/tickets` with a `match_params` string map); only tickets with identical params match together — encode mode/map/skill band as parameter values - **A match forms** when a group reaches `max_players`, or has at least `min_players` and the oldest ticket outwaited the timeout; the server creates a hidden lobby, seats everyone and locks it - **The result is a push, not a poll**: matched players receive `match_found` (`lobby_id`, `match_params`) on their user channel; disconnecting cancels your tickets - **Inspect**: `GET /matchmaking/tickets/me` for your ticket, `GET /matchmaking/stats` for queue depths - **Admin management** over HTTP: list/filter tickets, force-cancel, and stats under `/api/v1/admin/matchmaking` ## **14. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **14.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **14.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites, tournament events, KV subscriptions - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **14.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix` ## **15. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **15.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **15.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **15.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
19
19
  *
20
- * The version of the OpenAPI document: 1.0.1053
20
+ * The version of the OpenAPI document: 1.0.1055
21
21
  *
22
22
  *
23
23
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,7 +12,7 @@ var _AdminListAchievements200Response = _interopRequireDefault(require("../model
12
12
  var _AdminListAchievements200ResponseDataInner = _interopRequireDefault(require("../model/AdminListAchievements200ResponseDataInner"));
13
13
  var _AdminRevokeAchievementRequest = _interopRequireDefault(require("../model/AdminRevokeAchievementRequest"));
14
14
  var _AdminUpdateAchievementRequest = _interopRequireDefault(require("../model/AdminUpdateAchievementRequest"));
15
- var _PaymentsEntitlements401Response = _interopRequireDefault(require("../model/PaymentsEntitlements401Response"));
15
+ var _ListCurrentUserLedger401Response = _interopRequireDefault(require("../model/ListCurrentUserLedger401Response"));
16
16
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
17
17
  function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
18
18
  function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -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, tournaments, matchmaking, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements: - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements ## **12. Tournaments** Single-elimination bracket tournaments, server-structured and game-judged: - **Registration window → seeded draw → timed rounds → champions**; recurring tournaments (cron) create one occurrence per cycle sharing a slug; a nil starts_at keeps registration open until an admin draws manually - **Join/leave** as an entry leader (`POST`/`DELETE /tournaments/:id/join`); team composition is game policy - **Browse**: list/filter tournaments, standings, full bracket view, and the caller's current match (`GET /tournaments/:id/my-match`) - **Match verdicts are server-side** (game hooks) — no public resolve endpoint; clients get `tournament_match_ready` / `tournament_match_resolved` / `tournament_updated` / `tournament_finished` on the user channel - **Admin management** over HTTP: create/update/delete, cancel, draw now, finish, and force match verdicts under `/api/v1/admin/tournaments` ## **13. Matchmaking** Ticket-based queueing that turns waiting players into hidden, locked lobbies: - **Join over HTTP** (`POST /matchmaking/tickets` with a `match_params` string map); only tickets with identical params match together — encode mode/map/skill band as parameter values - **A match forms** when a group reaches `max_players`, or has at least `min_players` and the oldest ticket outwaited the timeout; the server creates a hidden lobby, seats everyone and locks it - **The result is a push, not a poll**: matched players receive `match_found` (`lobby_id`, `match_params`) on their user channel; disconnecting cancels your tickets - **Inspect**: `GET /matchmaking/tickets/me` for your ticket, `GET /matchmaking/stats` for queue depths - **Admin management** over HTTP: list/filter tickets, force-cancel, and stats under `/api/v1/admin/matchmaking` ## **14. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **14.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **14.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites, tournament events, KV subscriptions - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **14.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix` ## **15. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **15.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **15.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **15.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
25
25
  *
26
- * The version of the OpenAPI document: 1.0.1053
26
+ * The version of the OpenAPI document: 1.0.1055
27
27
  *
28
28
  *
29
29
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -7,7 +7,7 @@ exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
8
  var _AdminDeleteChatConversation200Response = _interopRequireDefault(require("../model/AdminDeleteChatConversation200Response"));
9
9
  var _AdminListChatMessages200Response = _interopRequireDefault(require("../model/AdminListChatMessages200Response"));
10
- var _PaymentsEntitlements401Response = _interopRequireDefault(require("../model/PaymentsEntitlements401Response"));
10
+ var _ListCurrentUserLedger401Response = _interopRequireDefault(require("../model/ListCurrentUserLedger401Response"));
11
11
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
12
12
  function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
13
13
  function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -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, tournaments, matchmaking, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements: - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements ## **12. Tournaments** Single-elimination bracket tournaments, server-structured and game-judged: - **Registration window → seeded draw → timed rounds → champions**; recurring tournaments (cron) create one occurrence per cycle sharing a slug; a nil starts_at keeps registration open until an admin draws manually - **Join/leave** as an entry leader (`POST`/`DELETE /tournaments/:id/join`); team composition is game policy - **Browse**: list/filter tournaments, standings, full bracket view, and the caller's current match (`GET /tournaments/:id/my-match`) - **Match verdicts are server-side** (game hooks) — no public resolve endpoint; clients get `tournament_match_ready` / `tournament_match_resolved` / `tournament_updated` / `tournament_finished` on the user channel - **Admin management** over HTTP: create/update/delete, cancel, draw now, finish, and force match verdicts under `/api/v1/admin/tournaments` ## **13. Matchmaking** Ticket-based queueing that turns waiting players into hidden, locked lobbies: - **Join over HTTP** (`POST /matchmaking/tickets` with a `match_params` string map); only tickets with identical params match together — encode mode/map/skill band as parameter values - **A match forms** when a group reaches `max_players`, or has at least `min_players` and the oldest ticket outwaited the timeout; the server creates a hidden lobby, seats everyone and locks it - **The result is a push, not a poll**: matched players receive `match_found` (`lobby_id`, `match_params`) on their user channel; disconnecting cancels your tickets - **Inspect**: `GET /matchmaking/tickets/me` for your ticket, `GET /matchmaking/stats` for queue depths - **Admin management** over HTTP: list/filter tickets, force-cancel, and stats under `/api/v1/admin/matchmaking` ## **14. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **14.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **14.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites, tournament events, KV subscriptions - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **14.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix` ## **15. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **15.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **15.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **15.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
20
20
  *
21
- * The version of the OpenAPI document: 1.0.1053
21
+ * The version of the OpenAPI document: 1.0.1055
22
22
  *
23
23
  *
24
24
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,327 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _AdminGrantItemRequest = _interopRequireDefault(require("../model/AdminGrantItemRequest"));
9
+ var _AdminSpendCurrencyRequest = _interopRequireDefault(require("../model/AdminSpendCurrencyRequest"));
10
+ var _ListCurrentUserLedger401Response = _interopRequireDefault(require("../model/ListCurrentUserLedger401Response"));
11
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
12
+ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
13
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
14
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
15
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
16
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
+ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
18
+ * Game Server API
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, tournaments, matchmaking, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements: - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements ## **12. Tournaments** Single-elimination bracket tournaments, server-structured and game-judged: - **Registration window → seeded draw → timed rounds → champions**; recurring tournaments (cron) create one occurrence per cycle sharing a slug; a nil starts_at keeps registration open until an admin draws manually - **Join/leave** as an entry leader (`POST`/`DELETE /tournaments/:id/join`); team composition is game policy - **Browse**: list/filter tournaments, standings, full bracket view, and the caller's current match (`GET /tournaments/:id/my-match`) - **Match verdicts are server-side** (game hooks) — no public resolve endpoint; clients get `tournament_match_ready` / `tournament_match_resolved` / `tournament_updated` / `tournament_finished` on the user channel - **Admin management** over HTTP: create/update/delete, cancel, draw now, finish, and force match verdicts under `/api/v1/admin/tournaments` ## **13. Matchmaking** Ticket-based queueing that turns waiting players into hidden, locked lobbies: - **Join over HTTP** (`POST /matchmaking/tickets` with a `match_params` string map); only tickets with identical params match together — encode mode/map/skill band as parameter values - **A match forms** when a group reaches `max_players`, or has at least `min_players` and the oldest ticket outwaited the timeout; the server creates a hidden lobby, seats everyone and locks it - **The result is a push, not a poll**: matched players receive `match_found` (`lobby_id`, `match_params`) on their user channel; disconnecting cancels your tickets - **Inspect**: `GET /matchmaking/tickets/me` for your ticket, `GET /matchmaking/stats` for queue depths - **Admin management** over HTTP: list/filter tickets, force-cancel, and stats under `/api/v1/admin/matchmaking` ## **14. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **14.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **14.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites, tournament events, KV subscriptions - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **14.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix` ## **15. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **15.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **15.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **15.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
20
+ *
21
+ * The version of the OpenAPI document: 1.0.1055
22
+ *
23
+ *
24
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
25
+ * https://openapi-generator.tech
26
+ * Do not edit the class manually.
27
+ *
28
+ */
29
+ /**
30
+ * AdminEconomy service.
31
+ * @module api/AdminEconomyApi
32
+ * @version 1.0.0
33
+ */
34
+ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
35
+ /**
36
+ * Constructs a new AdminEconomyApi.
37
+ * @alias module:api/AdminEconomyApi
38
+ * @class
39
+ * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
40
+ * default to {@link module:ApiClient#instance} if unspecified.
41
+ */
42
+ function AdminEconomyApi(apiClient) {
43
+ _classCallCheck(this, AdminEconomyApi);
44
+ this.apiClient = apiClient || _ApiClient["default"].instance;
45
+ }
46
+
47
+ /**
48
+ * Consume items from a user (admin)
49
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
50
+ */
51
+ return _createClass(AdminEconomyApi, [{
52
+ key: "adminConsumeItemWithHttpInfo",
53
+ value: function adminConsumeItemWithHttpInfo() {
54
+ var postBody = null;
55
+ var pathParams = {};
56
+ var queryParams = {};
57
+ var headerParams = {};
58
+ var formParams = {};
59
+ var authNames = ['authorization'];
60
+ var contentTypes = [];
61
+ var accepts = ['application/json'];
62
+ var returnType = Object;
63
+ return this.apiClient.callApi('/api/v1/admin/economy/consume-item', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
64
+ }
65
+
66
+ /**
67
+ * Consume items from a user (admin)
68
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
69
+ */
70
+ }, {
71
+ key: "adminConsumeItem",
72
+ value: function adminConsumeItem() {
73
+ return this.adminConsumeItemWithHttpInfo().then(function (response_and_data) {
74
+ return response_and_data.data;
75
+ });
76
+ }
77
+
78
+ /**
79
+ * Grant currency to a user (admin)
80
+ * @param {Object} opts Optional parameters
81
+ * @param {module:model/AdminSpendCurrencyRequest} [adminSpendCurrencyRequest] Wallet change
82
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
83
+ */
84
+ }, {
85
+ key: "adminGrantCurrencyWithHttpInfo",
86
+ value: function adminGrantCurrencyWithHttpInfo(opts) {
87
+ opts = opts || {};
88
+ var postBody = opts['adminSpendCurrencyRequest'];
89
+ var pathParams = {};
90
+ var queryParams = {};
91
+ var headerParams = {};
92
+ var formParams = {};
93
+ var authNames = ['authorization'];
94
+ var contentTypes = ['application/json'];
95
+ var accepts = ['application/json'];
96
+ var returnType = Object;
97
+ return this.apiClient.callApi('/api/v1/admin/economy/grant', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
98
+ }
99
+
100
+ /**
101
+ * Grant currency to a user (admin)
102
+ * @param {Object} opts Optional parameters
103
+ * @param {module:model/AdminSpendCurrencyRequest} opts.adminSpendCurrencyRequest Wallet change
104
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
105
+ */
106
+ }, {
107
+ key: "adminGrantCurrency",
108
+ value: function adminGrantCurrency(opts) {
109
+ return this.adminGrantCurrencyWithHttpInfo(opts).then(function (response_and_data) {
110
+ return response_and_data.data;
111
+ });
112
+ }
113
+
114
+ /**
115
+ * Grant items to a user (admin)
116
+ * @param {Object} opts Optional parameters
117
+ * @param {module:model/AdminGrantItemRequest} [adminGrantItemRequest] Item change
118
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
119
+ */
120
+ }, {
121
+ key: "adminGrantItemWithHttpInfo",
122
+ value: function adminGrantItemWithHttpInfo(opts) {
123
+ opts = opts || {};
124
+ var postBody = opts['adminGrantItemRequest'];
125
+ var pathParams = {};
126
+ var queryParams = {};
127
+ var headerParams = {};
128
+ var formParams = {};
129
+ var authNames = ['authorization'];
130
+ var contentTypes = ['application/json'];
131
+ var accepts = ['application/json'];
132
+ var returnType = Object;
133
+ return this.apiClient.callApi('/api/v1/admin/economy/grant-item', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
134
+ }
135
+
136
+ /**
137
+ * Grant items to a user (admin)
138
+ * @param {Object} opts Optional parameters
139
+ * @param {module:model/AdminGrantItemRequest} opts.adminGrantItemRequest Item change
140
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
141
+ */
142
+ }, {
143
+ key: "adminGrantItem",
144
+ value: function adminGrantItem(opts) {
145
+ return this.adminGrantItemWithHttpInfo(opts).then(function (response_and_data) {
146
+ return response_and_data.data;
147
+ });
148
+ }
149
+
150
+ /**
151
+ * List inventory item stacks (admin)
152
+ * @param {Object} opts Optional parameters
153
+ * @param {String} [userId]
154
+ * @param {String} [item]
155
+ * @param {Number} [page = 1)]
156
+ * @param {Number} [pageSize = 25)]
157
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
158
+ */
159
+ }, {
160
+ key: "adminListInventoryWithHttpInfo",
161
+ value: function adminListInventoryWithHttpInfo(opts) {
162
+ opts = opts || {};
163
+ var postBody = null;
164
+ var pathParams = {};
165
+ var queryParams = {
166
+ 'user_id': opts['userId'],
167
+ 'item': opts['item'],
168
+ 'page': opts['page'],
169
+ 'page_size': opts['pageSize']
170
+ };
171
+ var headerParams = {};
172
+ var formParams = {};
173
+ var authNames = ['authorization'];
174
+ var contentTypes = [];
175
+ var accepts = ['application/json'];
176
+ var returnType = Object;
177
+ return this.apiClient.callApi('/api/v1/admin/economy/items', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
178
+ }
179
+
180
+ /**
181
+ * List inventory item stacks (admin)
182
+ * @param {Object} opts Optional parameters
183
+ * @param {String} opts.userId
184
+ * @param {String} opts.item
185
+ * @param {Number} opts.page (default to 1)
186
+ * @param {Number} opts.pageSize (default to 25)
187
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
188
+ */
189
+ }, {
190
+ key: "adminListInventory",
191
+ value: function adminListInventory(opts) {
192
+ return this.adminListInventoryWithHttpInfo(opts).then(function (response_and_data) {
193
+ return response_and_data.data;
194
+ });
195
+ }
196
+
197
+ /**
198
+ * List ledger entries (admin)
199
+ * @param {Object} opts Optional parameters
200
+ * @param {String} [userId]
201
+ * @param {String} [currency]
202
+ * @param {Number} [page = 1)]
203
+ * @param {Number} [pageSize = 25)]
204
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
205
+ */
206
+ }, {
207
+ key: "adminListLedgerWithHttpInfo",
208
+ value: function adminListLedgerWithHttpInfo(opts) {
209
+ opts = opts || {};
210
+ var postBody = null;
211
+ var pathParams = {};
212
+ var queryParams = {
213
+ 'user_id': opts['userId'],
214
+ 'currency': opts['currency'],
215
+ 'page': opts['page'],
216
+ 'page_size': opts['pageSize']
217
+ };
218
+ var headerParams = {};
219
+ var formParams = {};
220
+ var authNames = ['authorization'];
221
+ var contentTypes = [];
222
+ var accepts = ['application/json'];
223
+ var returnType = Object;
224
+ return this.apiClient.callApi('/api/v1/admin/economy/ledger', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
225
+ }
226
+
227
+ /**
228
+ * List ledger entries (admin)
229
+ * @param {Object} opts Optional parameters
230
+ * @param {String} opts.userId
231
+ * @param {String} opts.currency
232
+ * @param {Number} opts.page (default to 1)
233
+ * @param {Number} opts.pageSize (default to 25)
234
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
235
+ */
236
+ }, {
237
+ key: "adminListLedger",
238
+ value: function adminListLedger(opts) {
239
+ return this.adminListLedgerWithHttpInfo(opts).then(function (response_and_data) {
240
+ return response_and_data.data;
241
+ });
242
+ }
243
+
244
+ /**
245
+ * List wallets (admin)
246
+ * @param {Object} opts Optional parameters
247
+ * @param {String} [userId]
248
+ * @param {String} [currency]
249
+ * @param {Number} [page = 1)]
250
+ * @param {Number} [pageSize = 25)]
251
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
252
+ */
253
+ }, {
254
+ key: "adminListWalletsWithHttpInfo",
255
+ value: function adminListWalletsWithHttpInfo(opts) {
256
+ opts = opts || {};
257
+ var postBody = null;
258
+ var pathParams = {};
259
+ var queryParams = {
260
+ 'user_id': opts['userId'],
261
+ 'currency': opts['currency'],
262
+ 'page': opts['page'],
263
+ 'page_size': opts['pageSize']
264
+ };
265
+ var headerParams = {};
266
+ var formParams = {};
267
+ var authNames = ['authorization'];
268
+ var contentTypes = [];
269
+ var accepts = ['application/json'];
270
+ var returnType = Object;
271
+ return this.apiClient.callApi('/api/v1/admin/economy/wallets', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
272
+ }
273
+
274
+ /**
275
+ * List wallets (admin)
276
+ * @param {Object} opts Optional parameters
277
+ * @param {String} opts.userId
278
+ * @param {String} opts.currency
279
+ * @param {Number} opts.page (default to 1)
280
+ * @param {Number} opts.pageSize (default to 25)
281
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
282
+ */
283
+ }, {
284
+ key: "adminListWallets",
285
+ value: function adminListWallets(opts) {
286
+ return this.adminListWalletsWithHttpInfo(opts).then(function (response_and_data) {
287
+ return response_and_data.data;
288
+ });
289
+ }
290
+
291
+ /**
292
+ * Spend currency from a user (admin)
293
+ * @param {Object} opts Optional parameters
294
+ * @param {module:model/AdminSpendCurrencyRequest} [adminSpendCurrencyRequest] Wallet change
295
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
296
+ */
297
+ }, {
298
+ key: "adminSpendCurrencyWithHttpInfo",
299
+ value: function adminSpendCurrencyWithHttpInfo(opts) {
300
+ opts = opts || {};
301
+ var postBody = opts['adminSpendCurrencyRequest'];
302
+ var pathParams = {};
303
+ var queryParams = {};
304
+ var headerParams = {};
305
+ var formParams = {};
306
+ var authNames = ['authorization'];
307
+ var contentTypes = ['application/json'];
308
+ var accepts = ['application/json'];
309
+ var returnType = Object;
310
+ return this.apiClient.callApi('/api/v1/admin/economy/spend', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
311
+ }
312
+
313
+ /**
314
+ * Spend currency from a user (admin)
315
+ * @param {Object} opts Optional parameters
316
+ * @param {module:model/AdminSpendCurrencyRequest} opts.adminSpendCurrencyRequest Wallet change
317
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
318
+ */
319
+ }, {
320
+ key: "adminSpendCurrency",
321
+ value: function adminSpendCurrency(opts) {
322
+ return this.adminSpendCurrencyWithHttpInfo(opts).then(function (response_and_data) {
323
+ return response_and_data.data;
324
+ });
325
+ }
326
+ }]);
327
+ }();
@@ -8,7 +8,7 @@ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
8
  var _AdminListGroups200Response = _interopRequireDefault(require("../model/AdminListGroups200Response"));
9
9
  var _AdminUpdateGroup200Response = _interopRequireDefault(require("../model/AdminUpdateGroup200Response"));
10
10
  var _AdminUpdateGroupRequest = _interopRequireDefault(require("../model/AdminUpdateGroupRequest"));
11
- var _PaymentsEntitlements401Response = _interopRequireDefault(require("../model/PaymentsEntitlements401Response"));
11
+ var _ListCurrentUserLedger401Response = _interopRequireDefault(require("../model/ListCurrentUserLedger401Response"));
12
12
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
13
13
  function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
14
14
  function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -19,7 +19,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
19
19
  * Game Server API
20
20
  * API for the Gamend Game Server. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, achievements, leaderboards, tournaments, matchmaking, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements: - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements ## **12. Tournaments** Single-elimination bracket tournaments, server-structured and game-judged: - **Registration window → seeded draw → timed rounds → champions**; recurring tournaments (cron) create one occurrence per cycle sharing a slug; a nil starts_at keeps registration open until an admin draws manually - **Join/leave** as an entry leader (`POST`/`DELETE /tournaments/:id/join`); team composition is game policy - **Browse**: list/filter tournaments, standings, full bracket view, and the caller's current match (`GET /tournaments/:id/my-match`) - **Match verdicts are server-side** (game hooks) — no public resolve endpoint; clients get `tournament_match_ready` / `tournament_match_resolved` / `tournament_updated` / `tournament_finished` on the user channel - **Admin management** over HTTP: create/update/delete, cancel, draw now, finish, and force match verdicts under `/api/v1/admin/tournaments` ## **13. Matchmaking** Ticket-based queueing that turns waiting players into hidden, locked lobbies: - **Join over HTTP** (`POST /matchmaking/tickets` with a `match_params` string map); only tickets with identical params match together — encode mode/map/skill band as parameter values - **A match forms** when a group reaches `max_players`, or has at least `min_players` and the oldest ticket outwaited the timeout; the server creates a hidden lobby, seats everyone and locks it - **The result is a push, not a poll**: matched players receive `match_found` (`lobby_id`, `match_params`) on their user channel; disconnecting cancels your tickets - **Inspect**: `GET /matchmaking/tickets/me` for your ticket, `GET /matchmaking/stats` for queue depths - **Admin management** over HTTP: list/filter tickets, force-cancel, and stats under `/api/v1/admin/matchmaking` ## **14. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **14.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **14.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites, tournament events, KV subscriptions - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **14.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix` ## **15. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **15.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **15.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **15.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
21
21
  *
22
- * The version of the OpenAPI document: 1.0.1053
22
+ * The version of the OpenAPI document: 1.0.1055
23
23
  *
24
24
  *
25
25
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).