@ughuuu/game_server 1.0.1050 → 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.
- package/README.md +39 -13
- package/dist/ApiClient.js +1 -1
- package/dist/api/AchievementsApi.js +1 -1
- package/dist/api/AdminAchievementsApi.js +2 -2
- package/dist/api/AdminChatApi.js +2 -2
- package/dist/api/AdminEconomyApi.js +327 -0
- package/dist/api/AdminGroupsApi.js +2 -2
- package/dist/api/AdminKVApi.js +2 -2
- package/dist/api/AdminLeaderboardsApi.js +2 -2
- package/dist/api/AdminLobbiesApi.js +2 -2
- package/dist/api/AdminMatchmakingApi.js +2 -2
- package/dist/api/AdminNotificationsApi.js +2 -2
- package/dist/api/AdminSessionsApi.js +2 -2
- package/dist/api/AdminStorageApi.js +212 -0
- package/dist/api/AdminTournamentsApi.js +2 -2
- package/dist/api/AdminUsersApi.js +2 -2
- package/dist/api/AuthenticationApi.js +2 -2
- package/dist/api/ChatApi.js +1 -1
- package/dist/api/EconomyApi.js +153 -0
- package/dist/api/FriendsApi.js +2 -2
- package/dist/api/GroupsApi.js +2 -2
- package/dist/api/HealthApi.js +1 -1
- package/dist/api/HooksApi.js +2 -2
- package/dist/api/KVApi.js +2 -2
- package/dist/api/LeaderboardsApi.js +2 -2
- package/dist/api/LobbiesApi.js +2 -2
- package/dist/api/MatchmakingApi.js +2 -2
- package/dist/api/NotificationsApi.js +2 -2
- package/dist/api/PartiesApi.js +2 -2
- package/dist/api/PaymentsApi.js +2 -2
- package/dist/api/TournamentsApi.js +133 -133
- package/dist/api/UsersApi.js +82 -4
- package/dist/index.js +119 -28
- package/dist/model/AcceptPartyInvite200Response.js +1 -1
- package/dist/model/AcceptPartyInvite200ResponseMembersInner.js +1 -1
- package/dist/model/AcceptPartyInviteRequest.js +1 -1
- package/dist/model/AdminCancelMatchmakingTicket200Response.js +1 -1
- package/dist/model/AdminCreateAchievementRequest.js +1 -1
- package/dist/model/AdminCreateLeaderboard200Response.js +1 -1
- package/dist/model/AdminCreateLeaderboard200ResponseData.js +1 -1
- package/dist/model/AdminCreateLeaderboardRequest.js +1 -1
- package/dist/model/AdminCreateNotificationRequest.js +1 -1
- package/dist/model/AdminDeleteChatConversation200Response.js +1 -1
- package/dist/model/AdminDrawTournament200Response.js +1 -1
- package/dist/model/AdminDrawTournament200ResponseData.js +1 -1
- package/dist/model/AdminGrantAchievementRequest.js +1 -1
- package/dist/model/AdminGrantItemRequest.js +136 -0
- package/dist/model/AdminIncrementAchievementRequest.js +1 -1
- package/dist/model/AdminListAchievements200Response.js +1 -1
- package/dist/model/AdminListAchievements200ResponseDataInner.js +1 -1
- package/dist/model/AdminListChatMessages200Response.js +1 -1
- package/dist/model/AdminListChatMessages200ResponseDataInner.js +1 -1
- package/dist/model/AdminListGroups200Response.js +1 -1
- package/dist/model/AdminListKvEntries200Response.js +1 -1
- package/dist/model/AdminListLobbies200Response.js +1 -1
- package/dist/model/AdminListLobbies200ResponseDataInner.js +1 -1
- package/dist/model/AdminListMatchmakingTickets200Response.js +1 -1
- package/dist/model/AdminListMatchmakingTickets200ResponseDataInner.js +1 -1
- package/dist/model/AdminListNotifications200Response.js +1 -1
- package/dist/model/AdminListNotifications200ResponseDataInner.js +1 -1
- package/dist/model/AdminListSessions200Response.js +1 -1
- package/dist/model/AdminListSessions200ResponseDataInner.js +1 -1
- package/dist/model/AdminListStorageObjects200Response.js +132 -0
- package/dist/model/AdminListStorageObjects200ResponseDataInner.js +105 -0
- package/dist/model/AdminListStorageObjects200ResponseUsage.js +93 -0
- package/dist/model/AdminMatchmakingStats200Response.js +1 -1
- package/dist/model/AdminMatchmakingStats200ResponseData.js +1 -1
- package/dist/model/AdminResolveTournamentMatchRequest.js +1 -1
- package/dist/model/AdminRevokeAchievementRequest.js +1 -1
- package/dist/model/AdminSpendCurrencyRequest.js +160 -0
- package/dist/model/AdminSubmitLeaderboardScoreRequest.js +1 -1
- package/dist/model/AdminUpdateAchievementRequest.js +1 -1
- package/dist/model/AdminUpdateGroup200Response.js +1 -1
- package/dist/model/AdminUpdateGroupRequest.js +1 -1
- package/dist/model/AdminUpdateKvEntryRequest.js +1 -1
- package/dist/model/AdminUpdateLeaderboardRecord200Response.js +1 -1
- package/dist/model/AdminUpdateLeaderboardRecord200ResponseData.js +1 -1
- package/dist/model/AdminUpdateLeaderboardRecordRequest.js +1 -1
- package/dist/model/AdminUpdateLeaderboardRequest.js +1 -1
- package/dist/model/AdminUpdateLobby200Response.js +1 -1
- package/dist/model/AdminUpdateLobbyRequest.js +1 -1
- package/dist/model/AdminUpdateTournamentRequest.js +1 -1
- package/dist/model/AdminUpdateUser200Response.js +1 -1
- package/dist/model/AdminUpdateUser200ResponseData.js +1 -1
- package/dist/model/AdminUpdateUserRequest.js +1 -1
- package/dist/model/AdminUpsertKv200Response.js +1 -1
- package/dist/model/AdminUpsertKv200ResponseData.js +1 -1
- package/dist/model/AdminUpsertKvRequest.js +1 -1
- package/dist/model/ApproveJoinRequest200Response.js +1 -1
- package/dist/model/CallHook200Response.js +1 -1
- package/dist/model/CallHookRequest.js +1 -1
- package/dist/model/CancelJoinRequest200Response.js +1 -1
- package/dist/model/CancelPartyInviteRequest.js +1 -1
- package/dist/model/ChatUnreadCount200Response.js +1 -1
- package/dist/model/CreateCurrentUserAvatarUploadUrlRequest.js +124 -0
- package/dist/model/CreateFriendRequestRequest.js +1 -1
- package/dist/model/CreateGroupRequest.js +1 -1
- package/dist/model/CreateLobbyRequest.js +1 -1
- package/dist/model/CreatePartyRequest.js +1 -1
- package/dist/model/DeclineGroupInvite200Response.js +1 -1
- package/dist/model/DeclinePartyInviteRequest.js +1 -1
- package/dist/model/DeleteNotifications200Response.js +1 -1
- package/dist/model/DeleteNotificationsRequest.js +1 -1
- package/dist/model/DemoteGroupMemberRequest.js +1 -1
- package/dist/model/DeviceLoginRequest.js +1 -1
- package/dist/model/ErrorResponse.js +1 -1
- package/dist/model/GetCurrentUser200Response.js +1 -1
- package/dist/model/GetCurrentUser200ResponseLinkedProviders.js +1 -1
- package/dist/model/GetCurrentUserInventory200Response.js +87 -0
- package/dist/model/GetKv200Response.js +1 -1
- package/dist/model/GetLobby200Response.js +1 -1
- package/dist/model/GetMyRecord200Response.js +1 -1
- package/dist/model/GetMyRecord200ResponseData.js +1 -1
- package/dist/model/HealthResponse.js +1 -1
- package/dist/model/InviteToGroup200Response.js +1 -1
- package/dist/model/InviteToGroupRequest.js +1 -1
- package/dist/model/InviteToPartyRequest.js +1 -1
- package/dist/model/KickGroupMemberRequest.js +1 -1
- package/dist/model/KickPartyMemberRequest.js +1 -1
- package/dist/model/LinkDeviceRequest.js +1 -1
- package/dist/model/ListBlacklistedUsers200Response.js +1 -1
- package/dist/model/ListBlacklistedUsers200ResponseDataInner.js +1 -1
- package/dist/model/ListBlockedFriends200Response.js +1 -1
- package/dist/model/ListBlockedFriends200ResponseDataInner.js +1 -1
- package/dist/model/ListChatMessages200Response.js +1 -1
- package/dist/model/ListChatMessages200ResponseDataInner.js +1 -1
- package/dist/model/{GameServerWebApiV1TournamentControllerIndex200Response.js → ListCurrentUserLedger200Response.js} +30 -22
- package/dist/model/ListCurrentUserLedger200ResponseDataInner.js +145 -0
- package/dist/model/{PaymentsEntitlements401Response.js → ListCurrentUserLedger401Response.js} +18 -18
- package/dist/model/ListFriendRequests200Response.js +1 -1
- package/dist/model/ListFriendRequests200ResponseIncomingInner.js +1 -1
- package/dist/model/ListFriendRequests200ResponseIncomingInnerRequester.js +1 -1
- package/dist/model/ListFriendRequests200ResponseMeta.js +1 -1
- package/dist/model/ListFriends200Response.js +1 -1
- package/dist/model/ListFriends200ResponseDataInner.js +1 -1
- package/dist/model/ListFriends200ResponseMeta.js +1 -1
- package/dist/model/ListGroupInvitations200Response.js +1 -1
- package/dist/model/ListGroupInvitations200ResponseDataInner.js +1 -1
- package/dist/model/ListGroupMembers200Response.js +1 -1
- package/dist/model/ListJoinRequests200Response.js +1 -1
- package/dist/model/ListLeaderboardRecords200Response.js +1 -1
- package/dist/model/ListLeaderboards200Response.js +1 -1
- package/dist/model/ListLobbies200Response.js +1 -1
- package/dist/model/ListLobbies200ResponseDataInner.js +1 -1
- package/dist/model/ListMyGroups200Response.js +1 -1
- package/dist/model/ListMyGroups200ResponseDataInner.js +1 -1
- package/dist/model/ListNotifications200Response.js +1 -1
- package/dist/model/ListNotifications200ResponseDataInner.js +1 -1
- package/dist/model/ListPartyInvitations200ResponseInner.js +1 -1
- package/dist/model/ListRecordsAroundUser200Response.js +1 -1
- package/dist/model/ListSentInvitations200Response.js +1 -1
- package/dist/model/ListSentInvitations200ResponseDataInner.js +1 -1
- package/dist/model/ListTournaments200Response.js +110 -0
- package/dist/model/{GameServerWebApiV1TournamentControllerIndex200ResponseDataInner.js → ListTournaments200ResponseDataInner.js} +34 -34
- package/dist/model/Login200Response.js +1 -1
- package/dist/model/Login200ResponseData.js +1 -1
- package/dist/model/LoginRequest.js +1 -1
- package/dist/model/MarkChatReadRequest.js +1 -1
- package/dist/model/MatchmakingCancel200Response.js +1 -1
- package/dist/model/MatchmakingJoin201Response.js +1 -1
- package/dist/model/MatchmakingJoin201ResponseData.js +1 -1
- package/dist/model/MatchmakingJoinRequest.js +1 -1
- package/dist/model/MatchmakingMyTicket200Response.js +1 -1
- package/dist/model/MatchmakingMyTicket200ResponseData.js +1 -1
- package/dist/model/MatchmakingStats200Response.js +1 -1
- package/dist/model/MatchmakingStats200ResponseData.js +1 -1
- package/dist/model/MatchmakingStats200ResponseDataQueuesInner.js +1 -1
- package/dist/model/MyAchievements200Response.js +1 -1
- package/dist/model/MyAchievements200ResponseDataInner.js +1 -1
- package/dist/model/NotifyGroup200Response.js +1 -1
- package/dist/model/NotifyGroupRequest.js +1 -1
- package/dist/model/OAuthSessionData.js +1 -1
- package/dist/model/OAuthSessionDataDetails.js +1 -1
- package/dist/model/OAuthSessionStatus.js +1 -1
- package/dist/model/OauthApiCallback200Response.js +1 -1
- package/dist/model/OauthApiCallbackRequest.js +1 -1
- package/dist/model/OauthCallbackApiAppleIosRequest.js +1 -1
- package/dist/model/OauthGoogleIdTokenRequest.js +1 -1
- package/dist/model/OauthRequest200Response.js +1 -1
- package/dist/model/OauthSessionStatus404Response.js +1 -1
- package/dist/model/PartyCreateLobbyRequest.js +1 -1
- package/dist/model/PartyJoinLobbyRequest.js +1 -1
- package/dist/model/PaymentsSteamCheckoutRequest.js +1 -1
- package/dist/model/PaymentsSteamFinalizeRequest.js +1 -1
- package/dist/model/PaymentsStripeCheckoutRequest.js +1 -1
- package/dist/model/PromoteGroupMemberRequest.js +1 -1
- package/dist/model/QuickJoinRequest.js +1 -1
- package/dist/model/RefreshToken200Response.js +1 -1
- package/dist/model/RefreshToken200ResponseData.js +1 -1
- package/dist/model/RefreshTokenRequest.js +1 -1
- package/dist/model/ResolveLeaderboardSlugs200Response.js +1 -1
- package/dist/model/ResolveLeaderboardSlugs200ResponseDataValue.js +1 -1
- package/dist/model/ResolveLeaderboardSlugsRequest.js +1 -1
- package/dist/model/SearchUsers200Response.js +1 -1
- package/dist/model/SearchUsers200ResponseDataInner.js +1 -1
- package/dist/model/SendChatMessageRequest.js +1 -1
- package/dist/model/SendNotificationRequest.js +1 -1
- package/dist/model/SetCurrentUserAvatarRequest.js +112 -0
- package/dist/model/{GameServerWebApiV1TournamentControllerMyMatch200Response.js → TournamentMyMatch200Response.js} +27 -27
- package/dist/model/UpdateChatMessageRequest.js +1 -1
- package/dist/model/UpdateCurrentUserDisplayName400Response.js +1 -1
- package/dist/model/UpdateCurrentUserDisplayNameRequest.js +1 -1
- package/dist/model/UpdateCurrentUserPasswordRequest.js +1 -1
- package/dist/model/UpdateCurrentUserUsernameRequest.js +1 -1
- package/dist/model/UpdateGroupRequest.js +1 -1
- package/dist/model/UpdateLobbyRequest.js +1 -1
- package/dist/model/UpdatePartyRequest.js +1 -1
- 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.
|
|
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)
|
|
@@ -354,6 +361,10 @@ Class | Method | HTTP request | Description
|
|
|
354
361
|
*UghuuuGameServer.AdminSessionsApi* | [**adminDeleteSession**](docs/AdminSessionsApi.md#adminDeleteSession) | **DELETE** /api/v1/admin/sessions/{id} | Delete session token by id (admin)
|
|
355
362
|
*UghuuuGameServer.AdminSessionsApi* | [**adminDeleteUserSessions**](docs/AdminSessionsApi.md#adminDeleteUserSessions) | **DELETE** /api/v1/admin/users/{id}/sessions | Delete all session tokens for a user (admin)
|
|
356
363
|
*UghuuuGameServer.AdminSessionsApi* | [**adminListSessions**](docs/AdminSessionsApi.md#adminListSessions) | **GET** /api/v1/admin/sessions | List sessions (admin)
|
|
364
|
+
*UghuuuGameServer.AdminStorageApi* | [**adminDeleteStorageObject**](docs/AdminStorageApi.md#adminDeleteStorageObject) | **DELETE** /api/v1/admin/storage | Delete a stored object (admin)
|
|
365
|
+
*UghuuuGameServer.AdminStorageApi* | [**adminDownloadStorageObject**](docs/AdminStorageApi.md#adminDownloadStorageObject) | **GET** /api/v1/admin/storage/object | Download an object by key (admin)
|
|
366
|
+
*UghuuuGameServer.AdminStorageApi* | [**adminListStorageObjects**](docs/AdminStorageApi.md#adminListStorageObjects) | **GET** /api/v1/admin/storage | List stored objects with usage (admin)
|
|
367
|
+
*UghuuuGameServer.AdminStorageApi* | [**adminUploadStorageObject**](docs/AdminStorageApi.md#adminUploadStorageObject) | **PUT** /api/v1/admin/storage/object | Upload or overwrite an object at any key (admin)
|
|
357
368
|
*UghuuuGameServer.AdminTournamentsApi* | [**adminCancelTournament**](docs/AdminTournamentsApi.md#adminCancelTournament) | **POST** /api/v1/admin/tournaments/{id}/cancel | Cancel tournament (admin; terminal, no recurrence spawn)
|
|
358
369
|
*UghuuuGameServer.AdminTournamentsApi* | [**adminCreateTournament**](docs/AdminTournamentsApi.md#adminCreateTournament) | **POST** /api/v1/admin/tournaments | Create tournament (admin)
|
|
359
370
|
*UghuuuGameServer.AdminTournamentsApi* | [**adminDeleteTournament**](docs/AdminTournamentsApi.md#adminDeleteTournament) | **DELETE** /api/v1/admin/tournaments/{id} | Delete tournament and all its entries/matches (admin)
|
|
@@ -383,6 +394,9 @@ Class | Method | HTTP request | Description
|
|
|
383
394
|
*UghuuuGameServer.ChatApi* | [**markChatRead**](docs/ChatApi.md#markChatRead) | **POST** /api/v1/chat/read | Mark chat as read
|
|
384
395
|
*UghuuuGameServer.ChatApi* | [**sendChatMessage**](docs/ChatApi.md#sendChatMessage) | **POST** /api/v1/chat/messages | Send a chat message
|
|
385
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
|
|
386
400
|
*UghuuuGameServer.FriendsApi* | [**acceptFriendRequest**](docs/FriendsApi.md#acceptFriendRequest) | **POST** /api/v1/friends/{id}/accept | Accept a friend request
|
|
387
401
|
*UghuuuGameServer.FriendsApi* | [**blockFriendRequest**](docs/FriendsApi.md#blockFriendRequest) | **POST** /api/v1/friends/{id}/block | Block a friend request / user
|
|
388
402
|
*UghuuuGameServer.FriendsApi* | [**blockUser**](docs/FriendsApi.md#blockUser) | **POST** /api/v1/users/{user_id}/block | Blacklist a user, with or without an existing friendship
|
|
@@ -464,18 +478,20 @@ Class | Method | HTTP request | Description
|
|
|
464
478
|
*UghuuuGameServer.PaymentsApi* | [**paymentsStripeCheckout**](docs/PaymentsApi.md#paymentsStripeCheckout) | **POST** /api/v1/payments/checkout/stripe | Create a Stripe Checkout Session
|
|
465
479
|
*UghuuuGameServer.PaymentsApi* | [**paymentsStripeWebhook**](docs/PaymentsApi.md#paymentsStripeWebhook) | **POST** /api/v1/payments/webhooks/stripe | Receive Stripe webhook events
|
|
466
480
|
*UghuuuGameServer.PaymentsApi* | [**paymentsValidateStorePurchase**](docs/PaymentsApi.md#paymentsValidateStorePurchase) | **POST** /api/v1/payments/validate/{provider} | Validate an Apple, Google, or Steam purchase
|
|
467
|
-
*UghuuuGameServer.TournamentsApi* | [**
|
|
468
|
-
*UghuuuGameServer.TournamentsApi* | [**
|
|
469
|
-
*UghuuuGameServer.TournamentsApi* | [**
|
|
470
|
-
*UghuuuGameServer.TournamentsApi* | [**
|
|
471
|
-
*UghuuuGameServer.TournamentsApi* | [**
|
|
472
|
-
*UghuuuGameServer.TournamentsApi* | [**
|
|
473
|
-
*UghuuuGameServer.TournamentsApi* | [**
|
|
474
|
-
*UghuuuGameServer.TournamentsApi* | [**
|
|
481
|
+
*UghuuuGameServer.TournamentsApi* | [**getTournament**](docs/TournamentsApi.md#getTournament) | **GET** /api/v1/tournaments/{id} | Tournament details (with the caller's participation when authenticated)
|
|
482
|
+
*UghuuuGameServer.TournamentsApi* | [**joinTournament**](docs/TournamentsApi.md#joinTournament) | **POST** /api/v1/tournaments/{id}/join | Register as an entry leader
|
|
483
|
+
*UghuuuGameServer.TournamentsApi* | [**leaveTournament**](docs/TournamentsApi.md#leaveTournament) | **DELETE** /api/v1/tournaments/{id}/join | Withdraw the caller's entry (before the draw)
|
|
484
|
+
*UghuuuGameServer.TournamentsApi* | [**listTournaments**](docs/TournamentsApi.md#listTournaments) | **GET** /api/v1/tournaments | List tournaments
|
|
485
|
+
*UghuuuGameServer.TournamentsApi* | [**tournamentBracket**](docs/TournamentsApi.md#tournamentBracket) | **GET** /api/v1/tournaments/{id}/bracket | Brackets and their matches (paginated by bracket)
|
|
486
|
+
*UghuuuGameServer.TournamentsApi* | [**tournamentEntries**](docs/TournamentsApi.md#tournamentEntries) | **GET** /api/v1/tournaments/{id}/entries | Registered entries (paginated)
|
|
487
|
+
*UghuuuGameServer.TournamentsApi* | [**tournamentMyMatch**](docs/TournamentsApi.md#tournamentMyMatch) | **GET** /api/v1/tournaments/{id}/my-match | The caller's current unresolved match, if any
|
|
488
|
+
*UghuuuGameServer.TournamentsApi* | [**tournamentStandings**](docs/TournamentsApi.md#tournamentStandings) | **GET** /api/v1/tournaments/{id}/standings | Placements, wins and champions
|
|
489
|
+
*UghuuuGameServer.UsersApi* | [**createCurrentUserAvatarUploadUrl**](docs/UsersApi.md#createCurrentUserAvatarUploadUrl) | **POST** /api/v1/me/avatar/upload-url | Request an avatar upload ticket
|
|
475
490
|
*UghuuuGameServer.UsersApi* | [**deleteCurrentUser**](docs/UsersApi.md#deleteCurrentUser) | **DELETE** /api/v1/me | Delete current user
|
|
476
491
|
*UghuuuGameServer.UsersApi* | [**getCurrentUser**](docs/UsersApi.md#getCurrentUser) | **GET** /api/v1/me | Return current user info
|
|
477
492
|
*UghuuuGameServer.UsersApi* | [**getUser**](docs/UsersApi.md#getUser) | **GET** /api/v1/users/{id} | Get a user by id
|
|
478
493
|
*UghuuuGameServer.UsersApi* | [**searchUsers**](docs/UsersApi.md#searchUsers) | **GET** /api/v1/users | Search users by id, username, or display_name
|
|
494
|
+
*UghuuuGameServer.UsersApi* | [**setCurrentUserAvatar**](docs/UsersApi.md#setCurrentUserAvatar) | **POST** /api/v1/me/avatar | Confirm an uploaded avatar
|
|
479
495
|
*UghuuuGameServer.UsersApi* | [**updateCurrentUserDisplayName**](docs/UsersApi.md#updateCurrentUserDisplayName) | **PATCH** /api/v1/me/display_name | Update current user's display name
|
|
480
496
|
*UghuuuGameServer.UsersApi* | [**updateCurrentUserPassword**](docs/UsersApi.md#updateCurrentUserPassword) | **PATCH** /api/v1/me/password | Update current user password
|
|
481
497
|
*UghuuuGameServer.UsersApi* | [**updateCurrentUserUsername**](docs/UsersApi.md#updateCurrentUserUsername) | **PATCH** /api/v1/me/username | Update current user's username
|
|
@@ -496,6 +512,7 @@ Class | Method | HTTP request | Description
|
|
|
496
512
|
- [UghuuuGameServer.AdminDrawTournament200Response](docs/AdminDrawTournament200Response.md)
|
|
497
513
|
- [UghuuuGameServer.AdminDrawTournament200ResponseData](docs/AdminDrawTournament200ResponseData.md)
|
|
498
514
|
- [UghuuuGameServer.AdminGrantAchievementRequest](docs/AdminGrantAchievementRequest.md)
|
|
515
|
+
- [UghuuuGameServer.AdminGrantItemRequest](docs/AdminGrantItemRequest.md)
|
|
499
516
|
- [UghuuuGameServer.AdminIncrementAchievementRequest](docs/AdminIncrementAchievementRequest.md)
|
|
500
517
|
- [UghuuuGameServer.AdminListAchievements200Response](docs/AdminListAchievements200Response.md)
|
|
501
518
|
- [UghuuuGameServer.AdminListAchievements200ResponseDataInner](docs/AdminListAchievements200ResponseDataInner.md)
|
|
@@ -511,10 +528,14 @@ Class | Method | HTTP request | Description
|
|
|
511
528
|
- [UghuuuGameServer.AdminListNotifications200ResponseDataInner](docs/AdminListNotifications200ResponseDataInner.md)
|
|
512
529
|
- [UghuuuGameServer.AdminListSessions200Response](docs/AdminListSessions200Response.md)
|
|
513
530
|
- [UghuuuGameServer.AdminListSessions200ResponseDataInner](docs/AdminListSessions200ResponseDataInner.md)
|
|
531
|
+
- [UghuuuGameServer.AdminListStorageObjects200Response](docs/AdminListStorageObjects200Response.md)
|
|
532
|
+
- [UghuuuGameServer.AdminListStorageObjects200ResponseDataInner](docs/AdminListStorageObjects200ResponseDataInner.md)
|
|
533
|
+
- [UghuuuGameServer.AdminListStorageObjects200ResponseUsage](docs/AdminListStorageObjects200ResponseUsage.md)
|
|
514
534
|
- [UghuuuGameServer.AdminMatchmakingStats200Response](docs/AdminMatchmakingStats200Response.md)
|
|
515
535
|
- [UghuuuGameServer.AdminMatchmakingStats200ResponseData](docs/AdminMatchmakingStats200ResponseData.md)
|
|
516
536
|
- [UghuuuGameServer.AdminResolveTournamentMatchRequest](docs/AdminResolveTournamentMatchRequest.md)
|
|
517
537
|
- [UghuuuGameServer.AdminRevokeAchievementRequest](docs/AdminRevokeAchievementRequest.md)
|
|
538
|
+
- [UghuuuGameServer.AdminSpendCurrencyRequest](docs/AdminSpendCurrencyRequest.md)
|
|
518
539
|
- [UghuuuGameServer.AdminSubmitLeaderboardScoreRequest](docs/AdminSubmitLeaderboardScoreRequest.md)
|
|
519
540
|
- [UghuuuGameServer.AdminUpdateAchievementRequest](docs/AdminUpdateAchievementRequest.md)
|
|
520
541
|
- [UghuuuGameServer.AdminUpdateGroup200Response](docs/AdminUpdateGroup200Response.md)
|
|
@@ -539,6 +560,7 @@ Class | Method | HTTP request | Description
|
|
|
539
560
|
- [UghuuuGameServer.CancelJoinRequest200Response](docs/CancelJoinRequest200Response.md)
|
|
540
561
|
- [UghuuuGameServer.CancelPartyInviteRequest](docs/CancelPartyInviteRequest.md)
|
|
541
562
|
- [UghuuuGameServer.ChatUnreadCount200Response](docs/ChatUnreadCount200Response.md)
|
|
563
|
+
- [UghuuuGameServer.CreateCurrentUserAvatarUploadUrlRequest](docs/CreateCurrentUserAvatarUploadUrlRequest.md)
|
|
542
564
|
- [UghuuuGameServer.CreateFriendRequestRequest](docs/CreateFriendRequestRequest.md)
|
|
543
565
|
- [UghuuuGameServer.CreateGroupRequest](docs/CreateGroupRequest.md)
|
|
544
566
|
- [UghuuuGameServer.CreateLobbyRequest](docs/CreateLobbyRequest.md)
|
|
@@ -550,11 +572,9 @@ Class | Method | HTTP request | Description
|
|
|
550
572
|
- [UghuuuGameServer.DemoteGroupMemberRequest](docs/DemoteGroupMemberRequest.md)
|
|
551
573
|
- [UghuuuGameServer.DeviceLoginRequest](docs/DeviceLoginRequest.md)
|
|
552
574
|
- [UghuuuGameServer.ErrorResponse](docs/ErrorResponse.md)
|
|
553
|
-
- [UghuuuGameServer.GameServerWebApiV1TournamentControllerIndex200Response](docs/GameServerWebApiV1TournamentControllerIndex200Response.md)
|
|
554
|
-
- [UghuuuGameServer.GameServerWebApiV1TournamentControllerIndex200ResponseDataInner](docs/GameServerWebApiV1TournamentControllerIndex200ResponseDataInner.md)
|
|
555
|
-
- [UghuuuGameServer.GameServerWebApiV1TournamentControllerMyMatch200Response](docs/GameServerWebApiV1TournamentControllerMyMatch200Response.md)
|
|
556
575
|
- [UghuuuGameServer.GetCurrentUser200Response](docs/GetCurrentUser200Response.md)
|
|
557
576
|
- [UghuuuGameServer.GetCurrentUser200ResponseLinkedProviders](docs/GetCurrentUser200ResponseLinkedProviders.md)
|
|
577
|
+
- [UghuuuGameServer.GetCurrentUserInventory200Response](docs/GetCurrentUserInventory200Response.md)
|
|
558
578
|
- [UghuuuGameServer.GetKv200Response](docs/GetKv200Response.md)
|
|
559
579
|
- [UghuuuGameServer.GetLobby200Response](docs/GetLobby200Response.md)
|
|
560
580
|
- [UghuuuGameServer.GetMyRecord200Response](docs/GetMyRecord200Response.md)
|
|
@@ -572,6 +592,9 @@ Class | Method | HTTP request | Description
|
|
|
572
592
|
- [UghuuuGameServer.ListBlockedFriends200ResponseDataInner](docs/ListBlockedFriends200ResponseDataInner.md)
|
|
573
593
|
- [UghuuuGameServer.ListChatMessages200Response](docs/ListChatMessages200Response.md)
|
|
574
594
|
- [UghuuuGameServer.ListChatMessages200ResponseDataInner](docs/ListChatMessages200ResponseDataInner.md)
|
|
595
|
+
- [UghuuuGameServer.ListCurrentUserLedger200Response](docs/ListCurrentUserLedger200Response.md)
|
|
596
|
+
- [UghuuuGameServer.ListCurrentUserLedger200ResponseDataInner](docs/ListCurrentUserLedger200ResponseDataInner.md)
|
|
597
|
+
- [UghuuuGameServer.ListCurrentUserLedger401Response](docs/ListCurrentUserLedger401Response.md)
|
|
575
598
|
- [UghuuuGameServer.ListFriendRequests200Response](docs/ListFriendRequests200Response.md)
|
|
576
599
|
- [UghuuuGameServer.ListFriendRequests200ResponseIncomingInner](docs/ListFriendRequests200ResponseIncomingInner.md)
|
|
577
600
|
- [UghuuuGameServer.ListFriendRequests200ResponseIncomingInnerRequester](docs/ListFriendRequests200ResponseIncomingInnerRequester.md)
|
|
@@ -595,6 +618,8 @@ Class | Method | HTTP request | Description
|
|
|
595
618
|
- [UghuuuGameServer.ListRecordsAroundUser200Response](docs/ListRecordsAroundUser200Response.md)
|
|
596
619
|
- [UghuuuGameServer.ListSentInvitations200Response](docs/ListSentInvitations200Response.md)
|
|
597
620
|
- [UghuuuGameServer.ListSentInvitations200ResponseDataInner](docs/ListSentInvitations200ResponseDataInner.md)
|
|
621
|
+
- [UghuuuGameServer.ListTournaments200Response](docs/ListTournaments200Response.md)
|
|
622
|
+
- [UghuuuGameServer.ListTournaments200ResponseDataInner](docs/ListTournaments200ResponseDataInner.md)
|
|
598
623
|
- [UghuuuGameServer.Login200Response](docs/Login200Response.md)
|
|
599
624
|
- [UghuuuGameServer.Login200ResponseData](docs/Login200ResponseData.md)
|
|
600
625
|
- [UghuuuGameServer.LoginRequest](docs/LoginRequest.md)
|
|
@@ -623,7 +648,6 @@ Class | Method | HTTP request | Description
|
|
|
623
648
|
- [UghuuuGameServer.OauthSessionStatus404Response](docs/OauthSessionStatus404Response.md)
|
|
624
649
|
- [UghuuuGameServer.PartyCreateLobbyRequest](docs/PartyCreateLobbyRequest.md)
|
|
625
650
|
- [UghuuuGameServer.PartyJoinLobbyRequest](docs/PartyJoinLobbyRequest.md)
|
|
626
|
-
- [UghuuuGameServer.PaymentsEntitlements401Response](docs/PaymentsEntitlements401Response.md)
|
|
627
651
|
- [UghuuuGameServer.PaymentsSteamCheckoutRequest](docs/PaymentsSteamCheckoutRequest.md)
|
|
628
652
|
- [UghuuuGameServer.PaymentsSteamFinalizeRequest](docs/PaymentsSteamFinalizeRequest.md)
|
|
629
653
|
- [UghuuuGameServer.PaymentsStripeCheckoutRequest](docs/PaymentsStripeCheckoutRequest.md)
|
|
@@ -639,6 +663,8 @@ Class | Method | HTTP request | Description
|
|
|
639
663
|
- [UghuuuGameServer.SearchUsers200ResponseDataInner](docs/SearchUsers200ResponseDataInner.md)
|
|
640
664
|
- [UghuuuGameServer.SendChatMessageRequest](docs/SendChatMessageRequest.md)
|
|
641
665
|
- [UghuuuGameServer.SendNotificationRequest](docs/SendNotificationRequest.md)
|
|
666
|
+
- [UghuuuGameServer.SetCurrentUserAvatarRequest](docs/SetCurrentUserAvatarRequest.md)
|
|
667
|
+
- [UghuuuGameServer.TournamentMyMatch200Response](docs/TournamentMyMatch200Response.md)
|
|
642
668
|
- [UghuuuGameServer.UpdateChatMessageRequest](docs/UpdateChatMessageRequest.md)
|
|
643
669
|
- [UghuuuGameServer.UpdateCurrentUserDisplayName400Response](docs/UpdateCurrentUserDisplayName400Response.md)
|
|
644
670
|
- [UghuuuGameServer.UpdateCurrentUserDisplayNameRequest](docs/UpdateCurrentUserDisplayNameRequest.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.
|
|
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.
|
|
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
|
|
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.
|
|
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).
|
package/dist/api/AdminChatApi.js
CHANGED
|
@@ -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
|
|
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.
|
|
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).
|