@ughuuu/game_server 1.0.1001 → 1.0.1004
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 +24 -24
- package/dist/ApiClient.js +1 -1
- package/dist/api/AchievementsApi.js +15 -15
- package/dist/api/AdminAchievementsApi.js +16 -16
- package/dist/api/AdminChatApi.js +6 -6
- package/dist/api/AdminGroupsApi.js +2 -2
- package/dist/api/AdminKVApi.js +19 -19
- package/dist/api/AdminLeaderboardsApi.js +19 -19
- package/dist/api/AdminLobbiesApi.js +2 -2
- package/dist/api/AdminNotificationsApi.js +2 -2
- package/dist/api/AdminSessionsApi.js +2 -2
- package/dist/api/AdminUsersApi.js +2 -2
- package/dist/api/AuthenticationApi.js +2 -2
- package/dist/api/ChatApi.js +11 -11
- package/dist/api/FriendsApi.js +7 -7
- package/dist/api/GroupsApi.js +41 -41
- 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 +6 -6
- package/dist/api/LobbiesApi.js +6 -6
- package/dist/api/NotificationsApi.js +6 -6
- package/dist/api/PartiesApi.js +25 -25
- package/dist/api/PaymentsApi.js +2 -2
- package/dist/api/UsersApi.js +3 -3
- package/dist/index.js +133 -133
- package/dist/model/{ShowParty200Response.js → AcceptPartyInvite200Response.js} +27 -27
- package/dist/model/{ShowParty200ResponseMembersInner.js → AcceptPartyInvite200ResponseMembersInner.js} +23 -23
- package/dist/model/AcceptPartyInviteRequest.js +1 -1
- package/dist/model/AdminCreateAchievementRequest.js +1 -1
- package/dist/model/{AdminCreateKvEntry200Response.js → AdminCreateLeaderboard200Response.js} +22 -22
- package/dist/model/{AdminEndLeaderboard200ResponseData.js → AdminCreateLeaderboard200ResponseData.js} +32 -32
- package/dist/model/AdminCreateLeaderboardRequest.js +1 -1
- package/dist/model/AdminCreateNotificationRequest.js +1 -1
- package/dist/model/{DeleteNotifications200Response.js → AdminDeleteChatConversation200Response.js} +18 -19
- package/dist/model/{AdminUnlockAchievementRequest.js → AdminGrantAchievementRequest.js} +21 -21
- package/dist/model/AdminIncrementAchievementRequest.js +1 -1
- package/dist/model/AdminListAchievements200Response.js +5 -5
- package/dist/model/{AdminUpdateAchievement200Response.js → AdminListAchievements200ResponseDataInner.js} +28 -28
- package/dist/model/AdminListChatMessages200Response.js +5 -5
- package/dist/model/AdminListChatMessages200ResponseDataInner.js +1 -1
- package/dist/model/AdminListGroups200Response.js +5 -5
- package/dist/model/AdminListKvEntries200Response.js +9 -9
- package/dist/model/AdminListLobbies200Response.js +5 -5
- package/dist/model/AdminListLobbies200ResponseDataInner.js +1 -1
- package/dist/model/AdminListNotifications200Response.js +5 -5
- package/dist/model/AdminListNotifications200ResponseDataInner.js +1 -1
- package/dist/model/AdminListSessions200Response.js +5 -5
- package/dist/model/AdminListSessions200ResponseDataInner.js +1 -1
- package/dist/model/AdminRevokeAchievementRequest.js +1 -1
- 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/{AdminSubmitLeaderboardScore200Response.js → AdminUpdateLeaderboardRecord200Response.js} +22 -22
- package/dist/model/{AdminSubmitLeaderboardScore200ResponseData.js → AdminUpdateLeaderboardRecord200ResponseData.js} +26 -26
- package/dist/model/AdminUpdateLeaderboardRecordRequest.js +1 -1
- package/dist/model/AdminUpdateLeaderboardRequest.js +1 -1
- package/dist/model/AdminUpdateLobby200Response.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/{AdminEndLeaderboard200Response.js → AdminUpsertKv200Response.js} +22 -22
- package/dist/model/{AdminListKvEntries200ResponseDataInner.js → AdminUpsertKv200ResponseData.js} +25 -25
- package/dist/model/{AdminCreateKvEntryRequest.js → AdminUpsertKvRequest.js} +24 -24
- package/dist/model/{ListGroupMembers200ResponseDataInner.js → ApproveJoinRequest200Response.js} +28 -28
- package/dist/model/CallHook200Response.js +1 -1
- package/dist/model/CallHookRequest.js +1 -1
- package/dist/model/CancelJoinRequest200Response.js +1 -1
- package/dist/model/ChatUnreadCount200Response.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/{InviteToGroup200Response.js → DeclineGroupInvite200Response.js} +18 -19
- package/dist/model/DeleteNotificationsRequest.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/GetKv200Response.js +1 -1
- package/dist/model/GetLobby200Response.js +5 -5
- package/dist/model/GetMyRecord200Response.js +5 -5
- package/dist/model/{ListLeaderboardRecords200ResponseDataInner.js → GetMyRecord200ResponseData.js} +23 -23
- package/dist/model/HealthResponse.js +1 -1
- package/dist/model/{InviteToGroupRequest.js → InviteToPartyRequest.js} +22 -22
- package/dist/model/ListBlockedFriends200Response.js +5 -5
- package/dist/model/ListBlockedFriends200ResponseDataInner.js +1 -1
- package/dist/model/ListBlockedFriends200ResponseDataInnerRequester.js +1 -1
- package/dist/model/ListChatMessages200Response.js +5 -5
- package/dist/model/{GetChatMessage200Response.js → ListChatMessages200ResponseDataInner.js} +28 -28
- 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 +5 -5
- package/dist/model/ListFriends200ResponseDataInner.js +1 -1
- package/dist/model/{AdminListNotifications200ResponseMeta.js → ListFriends200ResponseMeta.js} +23 -23
- package/dist/model/ListGroupMembers200Response.js +9 -9
- package/dist/model/ListJoinRequests200Response.js +5 -5
- package/dist/model/ListLeaderboardRecords200Response.js +9 -9
- package/dist/model/ListLeaderboards200Response.js +9 -9
- package/dist/model/ListLobbies200Response.js +5 -5
- package/dist/model/ListLobbies200ResponseDataInner.js +1 -1
- package/dist/model/ListMyGroups200Response.js +5 -5
- package/dist/model/ListMyGroups200ResponseDataInner.js +1 -1
- package/dist/model/ListPartyInvitations200ResponseInner.js +1 -1
- package/dist/model/ListRecordsAroundUser200Response.js +5 -5
- package/dist/model/ListSentInvitations200Response.js +5 -5
- package/dist/model/ListSentInvitations200ResponseDataInner.js +1 -1
- package/dist/model/LoginRequest.js +1 -1
- package/dist/model/MarkChatReadRequest.js +1 -1
- package/dist/model/{UserAchievements200Response.js → MyAchievements200Response.js} +27 -27
- package/dist/model/{UserAchievements200ResponseDataInner.js → MyAchievements200ResponseDataInner.js} +28 -28
- 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/{AdminCreateNotification400Response.js → PaymentsEntitlements401Response.js} +18 -18
- package/dist/model/PaymentsSteamCheckoutRequest.js +1 -1
- package/dist/model/PaymentsSteamFinalizeRequest.js +1 -1
- package/dist/model/PaymentsStripeCheckoutRequest.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 +4 -4
- package/dist/model/{ListLeaderboards200ResponseDataInner.js → ResolveLeaderboardSlugs200ResponseDataValue.js} +33 -33
- package/dist/model/ResolveLeaderboardSlugsRequest.js +1 -1
- package/dist/model/SearchUsers200Response.js +5 -5
- package/dist/model/SearchUsers200ResponseDataInner.js +1 -1
- package/dist/model/SendChatMessageRequest.js +1 -1
- package/dist/model/SendNotificationRequest.js +1 -1
- package/dist/model/UpdateChatMessageRequest.js +1 -1
- package/dist/model/{UpdateCurrentUserPassword400Response.js → UpdateCurrentUserDisplayName400Response.js} +19 -19
- package/dist/model/UpdateCurrentUserDisplayNameRequest.js +1 -1
- package/dist/model/UpdateCurrentUserPasswordRequest.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/dist/api/ChatApi.js
CHANGED
|
@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
8
|
var _ChatUnreadCount200Response = _interopRequireDefault(require("../model/ChatUnreadCount200Response"));
|
|
9
|
-
var _GetChatMessage200Response = _interopRequireDefault(require("../model/GetChatMessage200Response"));
|
|
10
9
|
var _ListChatMessages200Response = _interopRequireDefault(require("../model/ListChatMessages200Response"));
|
|
10
|
+
var _ListChatMessages200ResponseDataInner = _interopRequireDefault(require("../model/ListChatMessages200ResponseDataInner"));
|
|
11
11
|
var _MarkChatReadRequest = _interopRequireDefault(require("../model/MarkChatReadRequest"));
|
|
12
12
|
var _SendChatMessageRequest = _interopRequireDefault(require("../model/SendChatMessageRequest"));
|
|
13
13
|
var _UpdateChatMessageRequest = _interopRequireDefault(require("../model/UpdateChatMessageRequest"));
|
|
@@ -21,7 +21,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
21
21
|
* Game Server API
|
|
22
22
|
* API for the Gamend Game Server. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, achievements, leaderboards, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements: - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements ## **12. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **12.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **12.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **12.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix` ## **13. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **13.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **13.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **13.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
|
|
23
23
|
*
|
|
24
|
-
* The version of the OpenAPI document: 1.0.
|
|
24
|
+
* The version of the OpenAPI document: 1.0.1004
|
|
25
25
|
*
|
|
26
26
|
*
|
|
27
27
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -140,7 +140,7 @@ var ChatApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
140
140
|
* Get a single chat message
|
|
141
141
|
* Retrieve a single chat message by ID. Useful for refreshing a message after an update notification.
|
|
142
142
|
* @param {Number} id Message ID
|
|
143
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
143
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListChatMessages200ResponseDataInner} and HTTP response
|
|
144
144
|
*/
|
|
145
145
|
}, {
|
|
146
146
|
key: "getChatMessageWithHttpInfo",
|
|
@@ -159,7 +159,7 @@ var ChatApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
159
159
|
var authNames = [];
|
|
160
160
|
var contentTypes = [];
|
|
161
161
|
var accepts = ['application/json'];
|
|
162
|
-
var returnType =
|
|
162
|
+
var returnType = _ListChatMessages200ResponseDataInner["default"];
|
|
163
163
|
return this.apiClient.callApi('/api/v1/chat/messages/{id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
164
164
|
}
|
|
165
165
|
|
|
@@ -167,7 +167,7 @@ var ChatApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
167
167
|
* Get a single chat message
|
|
168
168
|
* Retrieve a single chat message by ID. Useful for refreshing a message after an update notification.
|
|
169
169
|
* @param {Number} id Message ID
|
|
170
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
170
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListChatMessages200ResponseDataInner}
|
|
171
171
|
*/
|
|
172
172
|
}, {
|
|
173
173
|
key: "getChatMessage",
|
|
@@ -277,7 +277,7 @@ var ChatApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
277
277
|
* Send a message to a lobby, group, party, or friend conversation. Requires authentication and membership/friendship.
|
|
278
278
|
* @param {Object} opts Optional parameters
|
|
279
279
|
* @param {module:model/SendChatMessageRequest} [sendChatMessageRequest] Chat message
|
|
280
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
280
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListChatMessages200ResponseDataInner} and HTTP response
|
|
281
281
|
*/
|
|
282
282
|
}, {
|
|
283
283
|
key: "sendChatMessageWithHttpInfo",
|
|
@@ -291,7 +291,7 @@ var ChatApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
291
291
|
var authNames = [];
|
|
292
292
|
var contentTypes = ['application/json'];
|
|
293
293
|
var accepts = ['application/json'];
|
|
294
|
-
var returnType =
|
|
294
|
+
var returnType = _ListChatMessages200ResponseDataInner["default"];
|
|
295
295
|
return this.apiClient.callApi('/api/v1/chat/messages', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
296
296
|
}
|
|
297
297
|
|
|
@@ -300,7 +300,7 @@ var ChatApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
300
300
|
* Send a message to a lobby, group, party, or friend conversation. Requires authentication and membership/friendship.
|
|
301
301
|
* @param {Object} opts Optional parameters
|
|
302
302
|
* @param {module:model/SendChatMessageRequest} opts.sendChatMessageRequest Chat message
|
|
303
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
303
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListChatMessages200ResponseDataInner}
|
|
304
304
|
*/
|
|
305
305
|
}, {
|
|
306
306
|
key: "sendChatMessage",
|
|
@@ -316,7 +316,7 @@ var ChatApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
316
316
|
* @param {Number} id Message ID
|
|
317
317
|
* @param {Object} opts Optional parameters
|
|
318
318
|
* @param {module:model/UpdateChatMessageRequest} [updateChatMessageRequest] Message update
|
|
319
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
319
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListChatMessages200ResponseDataInner} and HTTP response
|
|
320
320
|
*/
|
|
321
321
|
}, {
|
|
322
322
|
key: "updateChatMessageWithHttpInfo",
|
|
@@ -336,7 +336,7 @@ var ChatApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
336
336
|
var authNames = [];
|
|
337
337
|
var contentTypes = ['application/json'];
|
|
338
338
|
var accepts = ['application/json'];
|
|
339
|
-
var returnType =
|
|
339
|
+
var returnType = _ListChatMessages200ResponseDataInner["default"];
|
|
340
340
|
return this.apiClient.callApi('/api/v1/chat/messages/{id}', 'PATCH', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
341
341
|
}
|
|
342
342
|
|
|
@@ -346,7 +346,7 @@ var ChatApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
346
346
|
* @param {Number} id Message ID
|
|
347
347
|
* @param {Object} opts Optional parameters
|
|
348
348
|
* @param {module:model/UpdateChatMessageRequest} opts.updateChatMessageRequest Message update
|
|
349
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
349
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListChatMessages200ResponseDataInner}
|
|
350
350
|
*/
|
|
351
351
|
}, {
|
|
352
352
|
key: "updateChatMessage",
|
package/dist/api/FriendsApi.js
CHANGED
|
@@ -5,12 +5,12 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
-
var
|
|
9
|
-
var _InviteToGroupRequest = _interopRequireDefault(require("../model/InviteToGroupRequest"));
|
|
8
|
+
var _InviteToPartyRequest = _interopRequireDefault(require("../model/InviteToPartyRequest"));
|
|
10
9
|
var _ListBlockedFriends200Response = _interopRequireDefault(require("../model/ListBlockedFriends200Response"));
|
|
11
10
|
var _ListFriendRequests200Response = _interopRequireDefault(require("../model/ListFriendRequests200Response"));
|
|
12
11
|
var _ListFriends200Response = _interopRequireDefault(require("../model/ListFriends200Response"));
|
|
13
|
-
var
|
|
12
|
+
var _PaymentsEntitlements401Response = _interopRequireDefault(require("../model/PaymentsEntitlements401Response"));
|
|
13
|
+
var _UpdateCurrentUserDisplayName400Response = _interopRequireDefault(require("../model/UpdateCurrentUserDisplayName400Response"));
|
|
14
14
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
15
15
|
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); }
|
|
16
16
|
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
@@ -21,7 +21,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
21
21
|
* Game Server API
|
|
22
22
|
* API for the Gamend Game Server. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, achievements, leaderboards, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements: - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements ## **12. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **12.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **12.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **12.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix` ## **13. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **13.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **13.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **13.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
|
|
23
23
|
*
|
|
24
|
-
* The version of the OpenAPI document: 1.0.
|
|
24
|
+
* The version of the OpenAPI document: 1.0.1004
|
|
25
25
|
*
|
|
26
26
|
*
|
|
27
27
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -128,14 +128,14 @@ var FriendsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
128
128
|
/**
|
|
129
129
|
* Send a friend request
|
|
130
130
|
* @param {Object} opts Optional parameters
|
|
131
|
-
* @param {module:model/
|
|
131
|
+
* @param {module:model/InviteToPartyRequest} [inviteToPartyRequest] Friend request
|
|
132
132
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
|
|
133
133
|
*/
|
|
134
134
|
}, {
|
|
135
135
|
key: "createFriendRequestWithHttpInfo",
|
|
136
136
|
value: function createFriendRequestWithHttpInfo(opts) {
|
|
137
137
|
opts = opts || {};
|
|
138
|
-
var postBody = opts['
|
|
138
|
+
var postBody = opts['inviteToPartyRequest'];
|
|
139
139
|
var pathParams = {};
|
|
140
140
|
var queryParams = {};
|
|
141
141
|
var headerParams = {};
|
|
@@ -150,7 +150,7 @@ var FriendsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
150
150
|
/**
|
|
151
151
|
* Send a friend request
|
|
152
152
|
* @param {Object} opts Optional parameters
|
|
153
|
-
* @param {module:model/
|
|
153
|
+
* @param {module:model/InviteToPartyRequest} opts.inviteToPartyRequest Friend request
|
|
154
154
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
|
|
155
155
|
*/
|
|
156
156
|
}, {
|
package/dist/api/GroupsApi.js
CHANGED
|
@@ -5,19 +5,19 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
-
var
|
|
8
|
+
var _ApproveJoinRequest200Response = _interopRequireDefault(require("../model/ApproveJoinRequest200Response"));
|
|
9
9
|
var _CancelJoinRequest200Response = _interopRequireDefault(require("../model/CancelJoinRequest200Response"));
|
|
10
10
|
var _CreateGroupRequest = _interopRequireDefault(require("../model/CreateGroupRequest"));
|
|
11
|
-
var
|
|
12
|
-
var
|
|
11
|
+
var _DeclineGroupInvite200Response = _interopRequireDefault(require("../model/DeclineGroupInvite200Response"));
|
|
12
|
+
var _InviteToPartyRequest = _interopRequireDefault(require("../model/InviteToPartyRequest"));
|
|
13
13
|
var _ListGroupMembers200Response = _interopRequireDefault(require("../model/ListGroupMembers200Response"));
|
|
14
|
-
var _ListGroupMembers200ResponseDataInner = _interopRequireDefault(require("../model/ListGroupMembers200ResponseDataInner"));
|
|
15
14
|
var _ListJoinRequests200Response = _interopRequireDefault(require("../model/ListJoinRequests200Response"));
|
|
16
15
|
var _ListMyGroups200Response = _interopRequireDefault(require("../model/ListMyGroups200Response"));
|
|
17
16
|
var _ListMyGroups200ResponseDataInner = _interopRequireDefault(require("../model/ListMyGroups200ResponseDataInner"));
|
|
18
17
|
var _ListSentInvitations200Response = _interopRequireDefault(require("../model/ListSentInvitations200Response"));
|
|
19
18
|
var _NotifyGroup200Response = _interopRequireDefault(require("../model/NotifyGroup200Response"));
|
|
20
19
|
var _NotifyGroupRequest = _interopRequireDefault(require("../model/NotifyGroupRequest"));
|
|
20
|
+
var _PaymentsEntitlements401Response = _interopRequireDefault(require("../model/PaymentsEntitlements401Response"));
|
|
21
21
|
var _UpdateGroupRequest = _interopRequireDefault(require("../model/UpdateGroupRequest"));
|
|
22
22
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
23
23
|
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); }
|
|
@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
29
29
|
* Game Server API
|
|
30
30
|
* API for the Gamend Game Server. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, achievements, leaderboards, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements: - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements ## **12. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **12.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **12.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **12.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix` ## **13. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **13.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **13.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **13.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
|
|
31
31
|
*
|
|
32
|
-
* The version of the OpenAPI document: 1.0.
|
|
32
|
+
* The version of the OpenAPI document: 1.0.1004
|
|
33
33
|
*
|
|
34
34
|
*
|
|
35
35
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -59,7 +59,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
59
59
|
* Accept a group invitation
|
|
60
60
|
* Accept a pending group invitation by invite ID. The authenticated user must be the recipient of the invite.
|
|
61
61
|
* @param {Number} inviteId Invite ID (from the invitations list)
|
|
62
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
62
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ApproveJoinRequest200Response} and HTTP response
|
|
63
63
|
*/
|
|
64
64
|
return _createClass(GroupsApi, [{
|
|
65
65
|
key: "acceptGroupInviteWithHttpInfo",
|
|
@@ -78,7 +78,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
78
78
|
var authNames = ['authorization'];
|
|
79
79
|
var contentTypes = [];
|
|
80
80
|
var accepts = ['application/json'];
|
|
81
|
-
var returnType =
|
|
81
|
+
var returnType = _ApproveJoinRequest200Response["default"];
|
|
82
82
|
return this.apiClient.callApi('/api/v1/groups/invitations/{invite_id}/accept', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
83
83
|
}
|
|
84
84
|
|
|
@@ -86,7 +86,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
86
86
|
* Accept a group invitation
|
|
87
87
|
* Accept a pending group invitation by invite ID. The authenticated user must be the recipient of the invite.
|
|
88
88
|
* @param {Number} inviteId Invite ID (from the invitations list)
|
|
89
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
89
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ApproveJoinRequest200Response}
|
|
90
90
|
*/
|
|
91
91
|
}, {
|
|
92
92
|
key: "acceptGroupInvite",
|
|
@@ -101,7 +101,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
101
101
|
* Approve a pending join request. The user becomes a member.
|
|
102
102
|
* @param {Number} id Group ID
|
|
103
103
|
* @param {Number} requestId Join request ID
|
|
104
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
104
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ApproveJoinRequest200Response} and HTTP response
|
|
105
105
|
*/
|
|
106
106
|
}, {
|
|
107
107
|
key: "approveJoinRequestWithHttpInfo",
|
|
@@ -125,7 +125,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
125
125
|
var authNames = ['authorization'];
|
|
126
126
|
var contentTypes = [];
|
|
127
127
|
var accepts = ['application/json'];
|
|
128
|
-
var returnType =
|
|
128
|
+
var returnType = _ApproveJoinRequest200Response["default"];
|
|
129
129
|
return this.apiClient.callApi('/api/v1/groups/{id}/join_requests/{request_id}/approve', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
130
130
|
}
|
|
131
131
|
|
|
@@ -134,7 +134,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
134
134
|
* Approve a pending join request. The user becomes a member.
|
|
135
135
|
* @param {Number} id Group ID
|
|
136
136
|
* @param {Number} requestId Join request ID
|
|
137
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
137
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ApproveJoinRequest200Response}
|
|
138
138
|
*/
|
|
139
139
|
}, {
|
|
140
140
|
key: "approveJoinRequest",
|
|
@@ -148,7 +148,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
148
148
|
* Cancel a sent group invitation
|
|
149
149
|
* Cancel (delete) a group invitation that the authenticated user sent.
|
|
150
150
|
* @param {Number} inviteId ID of the GroupInvite to cancel
|
|
151
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
151
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeclineGroupInvite200Response} and HTTP response
|
|
152
152
|
*/
|
|
153
153
|
}, {
|
|
154
154
|
key: "cancelGroupInviteWithHttpInfo",
|
|
@@ -167,7 +167,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
167
167
|
var authNames = ['authorization'];
|
|
168
168
|
var contentTypes = [];
|
|
169
169
|
var accepts = ['application/json'];
|
|
170
|
-
var returnType =
|
|
170
|
+
var returnType = _DeclineGroupInvite200Response["default"];
|
|
171
171
|
return this.apiClient.callApi('/api/v1/groups/sent_invitations/{invite_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
172
172
|
}
|
|
173
173
|
|
|
@@ -175,7 +175,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
175
175
|
* Cancel a sent group invitation
|
|
176
176
|
* Cancel (delete) a group invitation that the authenticated user sent.
|
|
177
177
|
* @param {Number} inviteId ID of the GroupInvite to cancel
|
|
178
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
178
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeclineGroupInvite200Response}
|
|
179
179
|
*/
|
|
180
180
|
}, {
|
|
181
181
|
key: "cancelGroupInvite",
|
|
@@ -275,7 +275,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
275
275
|
* Decline a group invitation
|
|
276
276
|
* Decline a pending group invitation by invite ID. Only the recipient can decline. The invite is marked as declined (not deleted).
|
|
277
277
|
* @param {Number} inviteId Invite ID (from the invitations list)
|
|
278
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
278
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeclineGroupInvite200Response} and HTTP response
|
|
279
279
|
*/
|
|
280
280
|
}, {
|
|
281
281
|
key: "declineGroupInviteWithHttpInfo",
|
|
@@ -294,7 +294,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
294
294
|
var authNames = ['authorization'];
|
|
295
295
|
var contentTypes = [];
|
|
296
296
|
var accepts = ['application/json'];
|
|
297
|
-
var returnType =
|
|
297
|
+
var returnType = _DeclineGroupInvite200Response["default"];
|
|
298
298
|
return this.apiClient.callApi('/api/v1/groups/invitations/{invite_id}/decline', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
299
299
|
}
|
|
300
300
|
|
|
@@ -302,7 +302,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
302
302
|
* Decline a group invitation
|
|
303
303
|
* Decline a pending group invitation by invite ID. Only the recipient can decline. The invite is marked as declined (not deleted).
|
|
304
304
|
* @param {Number} inviteId Invite ID (from the invitations list)
|
|
305
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
305
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeclineGroupInvite200Response}
|
|
306
306
|
*/
|
|
307
307
|
}, {
|
|
308
308
|
key: "declineGroupInvite",
|
|
@@ -317,14 +317,14 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
317
317
|
* Demote an admin to regular member. Only admins can demote.
|
|
318
318
|
* @param {Number} id Group ID
|
|
319
319
|
* @param {Object} opts Optional parameters
|
|
320
|
-
* @param {module:model/
|
|
321
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
320
|
+
* @param {module:model/InviteToPartyRequest} [inviteToPartyRequest] Demote parameters
|
|
321
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ApproveJoinRequest200Response} and HTTP response
|
|
322
322
|
*/
|
|
323
323
|
}, {
|
|
324
324
|
key: "demoteGroupMemberWithHttpInfo",
|
|
325
325
|
value: function demoteGroupMemberWithHttpInfo(id, opts) {
|
|
326
326
|
opts = opts || {};
|
|
327
|
-
var postBody = opts['
|
|
327
|
+
var postBody = opts['inviteToPartyRequest'];
|
|
328
328
|
// verify the required parameter 'id' is set
|
|
329
329
|
if (id === undefined || id === null) {
|
|
330
330
|
throw new Error("Missing the required parameter 'id' when calling demoteGroupMember");
|
|
@@ -338,7 +338,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
338
338
|
var authNames = ['authorization'];
|
|
339
339
|
var contentTypes = ['application/json'];
|
|
340
340
|
var accepts = ['application/json'];
|
|
341
|
-
var returnType =
|
|
341
|
+
var returnType = _ApproveJoinRequest200Response["default"];
|
|
342
342
|
return this.apiClient.callApi('/api/v1/groups/{id}/demote', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
343
343
|
}
|
|
344
344
|
|
|
@@ -347,8 +347,8 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
347
347
|
* Demote an admin to regular member. Only admins can demote.
|
|
348
348
|
* @param {Number} id Group ID
|
|
349
349
|
* @param {Object} opts Optional parameters
|
|
350
|
-
* @param {module:model/
|
|
351
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
350
|
+
* @param {module:model/InviteToPartyRequest} opts.inviteToPartyRequest Demote parameters
|
|
351
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ApproveJoinRequest200Response}
|
|
352
352
|
*/
|
|
353
353
|
}, {
|
|
354
354
|
key: "demoteGroupMember",
|
|
@@ -404,14 +404,14 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
404
404
|
* Send an invitation to a user for a group. Creates a GroupInvite record and sends an informational notification. The invite is independent of notifications. If the target user already has a pending join request for this group, the request is automatically approved instead of creating an invite (status: \"request_approved\").
|
|
405
405
|
* @param {Number} id Group ID
|
|
406
406
|
* @param {Object} opts Optional parameters
|
|
407
|
-
* @param {module:model/
|
|
408
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
407
|
+
* @param {module:model/InviteToPartyRequest} [inviteToPartyRequest] Invite parameters
|
|
408
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeclineGroupInvite200Response} and HTTP response
|
|
409
409
|
*/
|
|
410
410
|
}, {
|
|
411
411
|
key: "inviteToGroupWithHttpInfo",
|
|
412
412
|
value: function inviteToGroupWithHttpInfo(id, opts) {
|
|
413
413
|
opts = opts || {};
|
|
414
|
-
var postBody = opts['
|
|
414
|
+
var postBody = opts['inviteToPartyRequest'];
|
|
415
415
|
// verify the required parameter 'id' is set
|
|
416
416
|
if (id === undefined || id === null) {
|
|
417
417
|
throw new Error("Missing the required parameter 'id' when calling inviteToGroup");
|
|
@@ -425,7 +425,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
425
425
|
var authNames = ['authorization'];
|
|
426
426
|
var contentTypes = ['application/json'];
|
|
427
427
|
var accepts = ['application/json'];
|
|
428
|
-
var returnType =
|
|
428
|
+
var returnType = _DeclineGroupInvite200Response["default"];
|
|
429
429
|
return this.apiClient.callApi('/api/v1/groups/{id}/invite', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
430
430
|
}
|
|
431
431
|
|
|
@@ -434,8 +434,8 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
434
434
|
* Send an invitation to a user for a group. Creates a GroupInvite record and sends an informational notification. The invite is independent of notifications. If the target user already has a pending join request for this group, the request is automatically approved instead of creating an invite (status: \"request_approved\").
|
|
435
435
|
* @param {Number} id Group ID
|
|
436
436
|
* @param {Object} opts Optional parameters
|
|
437
|
-
* @param {module:model/
|
|
438
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
437
|
+
* @param {module:model/InviteToPartyRequest} opts.inviteToPartyRequest Invite parameters
|
|
438
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeclineGroupInvite200Response}
|
|
439
439
|
*/
|
|
440
440
|
}, {
|
|
441
441
|
key: "inviteToGroup",
|
|
@@ -449,7 +449,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
449
449
|
* Join a group
|
|
450
450
|
* Join a group. For public groups the user is added immediately. For private groups a join request is created (an admin must approve it). Hidden groups require an invite and cannot be joined directly.
|
|
451
451
|
* @param {Number} id Group ID
|
|
452
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
452
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ApproveJoinRequest200Response} and HTTP response
|
|
453
453
|
*/
|
|
454
454
|
}, {
|
|
455
455
|
key: "joinGroupWithHttpInfo",
|
|
@@ -468,7 +468,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
468
468
|
var authNames = ['authorization'];
|
|
469
469
|
var contentTypes = [];
|
|
470
470
|
var accepts = ['application/json'];
|
|
471
|
-
var returnType =
|
|
471
|
+
var returnType = _ApproveJoinRequest200Response["default"];
|
|
472
472
|
return this.apiClient.callApi('/api/v1/groups/{id}/join', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
473
473
|
}
|
|
474
474
|
|
|
@@ -476,7 +476,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
476
476
|
* Join a group
|
|
477
477
|
* Join a group. For public groups the user is added immediately. For private groups a join request is created (an admin must approve it). Hidden groups require an invite and cannot be joined directly.
|
|
478
478
|
* @param {Number} id Group ID
|
|
479
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
479
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ApproveJoinRequest200Response}
|
|
480
480
|
*/
|
|
481
481
|
}, {
|
|
482
482
|
key: "joinGroup",
|
|
@@ -491,14 +491,14 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
491
491
|
* Remove a member from the group. Only group admins can kick.
|
|
492
492
|
* @param {Number} id Group ID
|
|
493
493
|
* @param {Object} opts Optional parameters
|
|
494
|
-
* @param {module:model/
|
|
494
|
+
* @param {module:model/InviteToPartyRequest} [inviteToPartyRequest] Kick parameters
|
|
495
495
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
|
|
496
496
|
*/
|
|
497
497
|
}, {
|
|
498
498
|
key: "kickGroupMemberWithHttpInfo",
|
|
499
499
|
value: function kickGroupMemberWithHttpInfo(id, opts) {
|
|
500
500
|
opts = opts || {};
|
|
501
|
-
var postBody = opts['
|
|
501
|
+
var postBody = opts['inviteToPartyRequest'];
|
|
502
502
|
// verify the required parameter 'id' is set
|
|
503
503
|
if (id === undefined || id === null) {
|
|
504
504
|
throw new Error("Missing the required parameter 'id' when calling kickGroupMember");
|
|
@@ -521,7 +521,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
521
521
|
* Remove a member from the group. Only group admins can kick.
|
|
522
522
|
* @param {Number} id Group ID
|
|
523
523
|
* @param {Object} opts Optional parameters
|
|
524
|
-
* @param {module:model/
|
|
524
|
+
* @param {module:model/InviteToPartyRequest} opts.inviteToPartyRequest Kick parameters
|
|
525
525
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
|
|
526
526
|
*/
|
|
527
527
|
}, {
|
|
@@ -916,14 +916,14 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
916
916
|
* Promote a member to admin role. Only admins can promote.
|
|
917
917
|
* @param {Number} id Group ID
|
|
918
918
|
* @param {Object} opts Optional parameters
|
|
919
|
-
* @param {module:model/
|
|
920
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
919
|
+
* @param {module:model/InviteToPartyRequest} [inviteToPartyRequest] Promote parameters
|
|
920
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ApproveJoinRequest200Response} and HTTP response
|
|
921
921
|
*/
|
|
922
922
|
}, {
|
|
923
923
|
key: "promoteGroupMemberWithHttpInfo",
|
|
924
924
|
value: function promoteGroupMemberWithHttpInfo(id, opts) {
|
|
925
925
|
opts = opts || {};
|
|
926
|
-
var postBody = opts['
|
|
926
|
+
var postBody = opts['inviteToPartyRequest'];
|
|
927
927
|
// verify the required parameter 'id' is set
|
|
928
928
|
if (id === undefined || id === null) {
|
|
929
929
|
throw new Error("Missing the required parameter 'id' when calling promoteGroupMember");
|
|
@@ -937,7 +937,7 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
937
937
|
var authNames = ['authorization'];
|
|
938
938
|
var contentTypes = ['application/json'];
|
|
939
939
|
var accepts = ['application/json'];
|
|
940
|
-
var returnType =
|
|
940
|
+
var returnType = _ApproveJoinRequest200Response["default"];
|
|
941
941
|
return this.apiClient.callApi('/api/v1/groups/{id}/promote', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
942
942
|
}
|
|
943
943
|
|
|
@@ -946,8 +946,8 @@ var GroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
946
946
|
* Promote a member to admin role. Only admins can promote.
|
|
947
947
|
* @param {Number} id Group ID
|
|
948
948
|
* @param {Object} opts Optional parameters
|
|
949
|
-
* @param {module:model/
|
|
950
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
949
|
+
* @param {module:model/InviteToPartyRequest} opts.inviteToPartyRequest Promote parameters
|
|
950
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ApproveJoinRequest200Response}
|
|
951
951
|
*/
|
|
952
952
|
}, {
|
|
953
953
|
key: "promoteGroupMember",
|
package/dist/api/HealthApi.js
CHANGED
|
@@ -16,7 +16,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
16
16
|
* Game Server API
|
|
17
17
|
* API for the Gamend Game Server. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, achievements, leaderboards, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements: - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements ## **12. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **12.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **12.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **12.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix` ## **13. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **13.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **13.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **13.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
|
|
18
18
|
*
|
|
19
|
-
* The version of the OpenAPI document: 1.0.
|
|
19
|
+
* The version of the OpenAPI document: 1.0.1004
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api/HooksApi.js
CHANGED
|
@@ -5,9 +5,9 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
-
var _AdminCreateNotification400Response = _interopRequireDefault(require("../model/AdminCreateNotification400Response"));
|
|
9
8
|
var _CallHook200Response = _interopRequireDefault(require("../model/CallHook200Response"));
|
|
10
9
|
var _CallHookRequest = _interopRequireDefault(require("../model/CallHookRequest"));
|
|
10
|
+
var _PaymentsEntitlements401Response = _interopRequireDefault(require("../model/PaymentsEntitlements401Response"));
|
|
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, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation hooks**: `before_chat_message` pipeline hook for filtering/blocking ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Achievements** Track player accomplishments with progress-based or instant-unlock achievements: - **Achievement definitions**: admin-created with slug, title, description, icon, sort order, and optional progress target - **Progress tracking**: increment progress toward a target; auto-unlocks when progress reaches the target - **Instant unlock**: directly unlock achievements without progress tracking - **Hidden achievements**: details obscured (\"???\") until unlocked by the user - **Public listings**: paginated, optionally filtered; authenticated users see their own progress - **Admin management**: create, update, delete, grant, revoke, unlock, and increment achievements ## **12. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **12.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **12.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, achievement unlocks, party/group invites - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **12.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix` ## **13. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **13.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **13.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **13.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/game_server' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
|
|
20
20
|
*
|
|
21
|
-
* The version of the OpenAPI document: 1.0.
|
|
21
|
+
* The version of the OpenAPI document: 1.0.1004
|
|
22
22
|
*
|
|
23
23
|
*
|
|
24
24
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|