@ughuuu/game_server 1.0.999 → 1.0.1003

package/dist/model/ListGroupMembers200ResponseDataInner.js

@@ -1,180 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
-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); }
-function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
-function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
-function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
-function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
-function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
- * Game Server API
- * 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, 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 })) ``` 
- *
- * The version of the OpenAPI document: 1.0.999
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- *
- */
-/**
- * The ListGroupMembers200ResponseDataInner model module.
- * @module model/ListGroupMembers200ResponseDataInner
- * @version 1.0.0
- */
-var ListGroupMembers200ResponseDataInner = /*#__PURE__*/function () {
-  /**
-   * Constructs a new <code>ListGroupMembers200ResponseDataInner</code>.
-   * @alias module:model/ListGroupMembers200ResponseDataInner
-   */
-  function ListGroupMembers200ResponseDataInner() {
-    _classCallCheck(this, ListGroupMembers200ResponseDataInner);
-    ListGroupMembers200ResponseDataInner.initialize(this);
-  }
-
-  /**
-   * Initializes the fields of this object.
-   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
-   * Only for internal use.
-   */
-  return _createClass(ListGroupMembers200ResponseDataInner, null, [{
-    key: "initialize",
-    value: function initialize(obj) {}
-
-    /**
-     * Constructs a <code>ListGroupMembers200ResponseDataInner</code> from a plain JavaScript object, optionally creating a new instance.
-     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
-     * @param {Object} data The plain JavaScript object bearing properties of interest.
-     * @param {module:model/ListGroupMembers200ResponseDataInner} obj Optional instance to populate.
-     * @return {module:model/ListGroupMembers200ResponseDataInner} The populated <code>ListGroupMembers200ResponseDataInner</code> instance.
-     */
-  }, {
-    key: "constructFromObject",
-    value: function constructFromObject(data, obj) {
-      if (data) {
-        obj = obj || new ListGroupMembers200ResponseDataInner();
-        if (data.hasOwnProperty('display_name')) {
-          obj['display_name'] = _ApiClient["default"].convertToType(data['display_name'], 'String');
-        }
-        if (data.hasOwnProperty('group_id')) {
-          obj['group_id'] = _ApiClient["default"].convertToType(data['group_id'], 'Number');
-        }
-        if (data.hasOwnProperty('id')) {
-          obj['id'] = _ApiClient["default"].convertToType(data['id'], 'Number');
-        }
-        if (data.hasOwnProperty('inserted_at')) {
-          obj['inserted_at'] = _ApiClient["default"].convertToType(data['inserted_at'], 'Date');
-        }
-        if (data.hasOwnProperty('is_online')) {
-          obj['is_online'] = _ApiClient["default"].convertToType(data['is_online'], 'Boolean');
-        }
-        if (data.hasOwnProperty('last_seen_at')) {
-          obj['last_seen_at'] = _ApiClient["default"].convertToType(data['last_seen_at'], 'Date');
-        }
-        if (data.hasOwnProperty('profile_url')) {
-          obj['profile_url'] = _ApiClient["default"].convertToType(data['profile_url'], 'String');
-        }
-        if (data.hasOwnProperty('role')) {
-          obj['role'] = _ApiClient["default"].convertToType(data['role'], 'String');
-        }
-        if (data.hasOwnProperty('user_id')) {
-          obj['user_id'] = _ApiClient["default"].convertToType(data['user_id'], 'Number');
-        }
-      }
-      return obj;
-    }
-
-    /**
-     * Validates the JSON data with respect to <code>ListGroupMembers200ResponseDataInner</code>.
-     * @param {Object} data The plain JavaScript object bearing properties of interest.
-     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>ListGroupMembers200ResponseDataInner</code>.
-     */
-  }, {
-    key: "validateJSON",
-    value: function validateJSON(data) {
-      // ensure the json data is a string
-      if (data['display_name'] && !(typeof data['display_name'] === 'string' || data['display_name'] instanceof String)) {
-        throw new Error("Expected the field `display_name` to be a primitive type in the JSON string but got " + data['display_name']);
-      }
-      // ensure the json data is a string
-      if (data['profile_url'] && !(typeof data['profile_url'] === 'string' || data['profile_url'] instanceof String)) {
-        throw new Error("Expected the field `profile_url` to be a primitive type in the JSON string but got " + data['profile_url']);
-      }
-      // ensure the json data is a string
-      if (data['role'] && !(typeof data['role'] === 'string' || data['role'] instanceof String)) {
-        throw new Error("Expected the field `role` to be a primitive type in the JSON string but got " + data['role']);
-      }
-      return true;
-    }
-  }]);
-}();
-/**
- * @member {String} display_name
- */
-ListGroupMembers200ResponseDataInner.prototype['display_name'] = undefined;
-
-/**
- * @member {Number} group_id
- */
-ListGroupMembers200ResponseDataInner.prototype['group_id'] = undefined;
-
-/**
- * Membership ID
- * @member {Number} id
- */
-ListGroupMembers200ResponseDataInner.prototype['id'] = undefined;
-
-/**
- * @member {Date} inserted_at
- */
-ListGroupMembers200ResponseDataInner.prototype['inserted_at'] = undefined;
-
-/**
- * @member {Boolean} is_online
- */
-ListGroupMembers200ResponseDataInner.prototype['is_online'] = undefined;
-
-/**
- * @member {Date} last_seen_at
- */
-ListGroupMembers200ResponseDataInner.prototype['last_seen_at'] = undefined;
-
-/**
- * @member {String} profile_url
- */
-ListGroupMembers200ResponseDataInner.prototype['profile_url'] = undefined;
-
-/**
- * @member {module:model/ListGroupMembers200ResponseDataInner.RoleEnum} role
- */
-ListGroupMembers200ResponseDataInner.prototype['role'] = undefined;
-
-/**
- * @member {Number} user_id
- */
-ListGroupMembers200ResponseDataInner.prototype['user_id'] = undefined;
-
-/**
- * Allowed values for the <code>role</code> property.
- * @enum {String}
- * @readonly
- */
-ListGroupMembers200ResponseDataInner['RoleEnum'] = {
-  /**
-   * value: "admin"
-   * @const
-   */
-  "admin": "admin",
-  /**
-   * value: "member"
-   * @const
-   */
-  "member": "member"
-};
-var _default = exports["default"] = ListGroupMembers200ResponseDataInner;

package/dist/model/ListLeaderboardRecords200ResponseDataInner.js

@@ -1,134 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
-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); }
-function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
-function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
-function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
-function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
-function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
- * Game Server API
- * 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, 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 })) ``` 
- *
- * The version of the OpenAPI document: 1.0.999
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- *
- */
-/**
- * The ListLeaderboardRecords200ResponseDataInner model module.
- * @module model/ListLeaderboardRecords200ResponseDataInner
- * @version 1.0.0
- */
-var ListLeaderboardRecords200ResponseDataInner = /*#__PURE__*/function () {
-  /**
-   * Constructs a new <code>ListLeaderboardRecords200ResponseDataInner</code>.
-   * @alias module:model/ListLeaderboardRecords200ResponseDataInner
-   */
-  function ListLeaderboardRecords200ResponseDataInner() {
-    _classCallCheck(this, ListLeaderboardRecords200ResponseDataInner);
-    ListLeaderboardRecords200ResponseDataInner.initialize(this);
-  }
-
-  /**
-   * Initializes the fields of this object.
-   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
-   * Only for internal use.
-   */
-  return _createClass(ListLeaderboardRecords200ResponseDataInner, null, [{
-    key: "initialize",
-    value: function initialize(obj) {}
-
-    /**
-     * Constructs a <code>ListLeaderboardRecords200ResponseDataInner</code> from a plain JavaScript object, optionally creating a new instance.
-     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
-     * @param {Object} data The plain JavaScript object bearing properties of interest.
-     * @param {module:model/ListLeaderboardRecords200ResponseDataInner} obj Optional instance to populate.
-     * @return {module:model/ListLeaderboardRecords200ResponseDataInner} The populated <code>ListLeaderboardRecords200ResponseDataInner</code> instance.
-     */
-  }, {
-    key: "constructFromObject",
-    value: function constructFromObject(data, obj) {
-      if (data) {
-        obj = obj || new ListLeaderboardRecords200ResponseDataInner();
-        if (data.hasOwnProperty('display_name')) {
-          obj['display_name'] = _ApiClient["default"].convertToType(data['display_name'], 'String');
-        }
-        if (data.hasOwnProperty('metadata')) {
-          obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], Object);
-        }
-        if (data.hasOwnProperty('rank')) {
-          obj['rank'] = _ApiClient["default"].convertToType(data['rank'], 'Number');
-        }
-        if (data.hasOwnProperty('score')) {
-          obj['score'] = _ApiClient["default"].convertToType(data['score'], 'Number');
-        }
-        if (data.hasOwnProperty('updated_at')) {
-          obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
-        }
-        if (data.hasOwnProperty('user_id')) {
-          obj['user_id'] = _ApiClient["default"].convertToType(data['user_id'], 'Number');
-        }
-      }
-      return obj;
-    }
-
-    /**
-     * Validates the JSON data with respect to <code>ListLeaderboardRecords200ResponseDataInner</code>.
-     * @param {Object} data The plain JavaScript object bearing properties of interest.
-     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>ListLeaderboardRecords200ResponseDataInner</code>.
-     */
-  }, {
-    key: "validateJSON",
-    value: function validateJSON(data) {
-      // ensure the json data is a string
-      if (data['display_name'] && !(typeof data['display_name'] === 'string' || data['display_name'] instanceof String)) {
-        throw new Error("Expected the field `display_name` to be a primitive type in the JSON string but got " + data['display_name']);
-      }
-      return true;
-    }
-  }]);
-}();
-/**
- * Human-readable name (user display name or label text)
- * @member {String} display_name
- */
-ListLeaderboardRecords200ResponseDataInner.prototype['display_name'] = undefined;
-
-/**
- * Per-record metadata
- * @member {Object} metadata
- */
-ListLeaderboardRecords200ResponseDataInner.prototype['metadata'] = undefined;
-
-/**
- * Player's rank on this leaderboard
- * @member {Number} rank
- */
-ListLeaderboardRecords200ResponseDataInner.prototype['rank'] = undefined;
-
-/**
- * Score value
- * @member {Number} score
- */
-ListLeaderboardRecords200ResponseDataInner.prototype['score'] = undefined;
-
-/**
- * @member {Date} updated_at
- */
-ListLeaderboardRecords200ResponseDataInner.prototype['updated_at'] = undefined;
-
-/**
- * User ID (-1 for non-user/label-based records)
- * @member {Number} user_id
- */
-ListLeaderboardRecords200ResponseDataInner.prototype['user_id'] = undefined;
-var _default = exports["default"] = ListLeaderboardRecords200ResponseDataInner;

package/dist/model/ListLeaderboards200ResponseDataInner.js

@@ -1,247 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
-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); }
-function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
-function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
-function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
-function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
-function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
- * Game Server API
- * 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, 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 })) ``` 
- *
- * The version of the OpenAPI document: 1.0.999
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- *
- */
-/**
- * The ListLeaderboards200ResponseDataInner model module.
- * @module model/ListLeaderboards200ResponseDataInner
- * @version 1.0.0
- */
-var ListLeaderboards200ResponseDataInner = /*#__PURE__*/function () {
-  /**
-   * Constructs a new <code>ListLeaderboards200ResponseDataInner</code>.
-   * @alias module:model/ListLeaderboards200ResponseDataInner
-   */
-  function ListLeaderboards200ResponseDataInner() {
-    _classCallCheck(this, ListLeaderboards200ResponseDataInner);
-    ListLeaderboards200ResponseDataInner.initialize(this);
-  }
-
-  /**
-   * Initializes the fields of this object.
-   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
-   * Only for internal use.
-   */
-  return _createClass(ListLeaderboards200ResponseDataInner, null, [{
-    key: "initialize",
-    value: function initialize(obj) {}
-
-    /**
-     * Constructs a <code>ListLeaderboards200ResponseDataInner</code> from a plain JavaScript object, optionally creating a new instance.
-     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
-     * @param {Object} data The plain JavaScript object bearing properties of interest.
-     * @param {module:model/ListLeaderboards200ResponseDataInner} obj Optional instance to populate.
-     * @return {module:model/ListLeaderboards200ResponseDataInner} The populated <code>ListLeaderboards200ResponseDataInner</code> instance.
-     */
-  }, {
-    key: "constructFromObject",
-    value: function constructFromObject(data, obj) {
-      if (data) {
-        obj = obj || new ListLeaderboards200ResponseDataInner();
-        if (data.hasOwnProperty('description')) {
-          obj['description'] = _ApiClient["default"].convertToType(data['description'], 'String');
-        }
-        if (data.hasOwnProperty('ends_at')) {
-          obj['ends_at'] = _ApiClient["default"].convertToType(data['ends_at'], 'Date');
-        }
-        if (data.hasOwnProperty('id')) {
-          obj['id'] = _ApiClient["default"].convertToType(data['id'], 'Number');
-        }
-        if (data.hasOwnProperty('inserted_at')) {
-          obj['inserted_at'] = _ApiClient["default"].convertToType(data['inserted_at'], 'Date');
-        }
-        if (data.hasOwnProperty('is_active')) {
-          obj['is_active'] = _ApiClient["default"].convertToType(data['is_active'], 'Boolean');
-        }
-        if (data.hasOwnProperty('metadata')) {
-          obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], Object);
-        }
-        if (data.hasOwnProperty('operator')) {
-          obj['operator'] = _ApiClient["default"].convertToType(data['operator'], 'String');
-        }
-        if (data.hasOwnProperty('slug')) {
-          obj['slug'] = _ApiClient["default"].convertToType(data['slug'], 'String');
-        }
-        if (data.hasOwnProperty('sort_order')) {
-          obj['sort_order'] = _ApiClient["default"].convertToType(data['sort_order'], 'String');
-        }
-        if (data.hasOwnProperty('starts_at')) {
-          obj['starts_at'] = _ApiClient["default"].convertToType(data['starts_at'], 'Date');
-        }
-        if (data.hasOwnProperty('title')) {
-          obj['title'] = _ApiClient["default"].convertToType(data['title'], 'String');
-        }
-        if (data.hasOwnProperty('updated_at')) {
-          obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
-        }
-      }
-      return obj;
-    }
-
-    /**
-     * Validates the JSON data with respect to <code>ListLeaderboards200ResponseDataInner</code>.
-     * @param {Object} data The plain JavaScript object bearing properties of interest.
-     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>ListLeaderboards200ResponseDataInner</code>.
-     */
-  }, {
-    key: "validateJSON",
-    value: function validateJSON(data) {
-      // ensure the json data is a string
-      if (data['description'] && !(typeof data['description'] === 'string' || data['description'] instanceof String)) {
-        throw new Error("Expected the field `description` to be a primitive type in the JSON string but got " + data['description']);
-      }
-      // ensure the json data is a string
-      if (data['operator'] && !(typeof data['operator'] === 'string' || data['operator'] instanceof String)) {
-        throw new Error("Expected the field `operator` to be a primitive type in the JSON string but got " + data['operator']);
-      }
-      // ensure the json data is a string
-      if (data['slug'] && !(typeof data['slug'] === 'string' || data['slug'] instanceof String)) {
-        throw new Error("Expected the field `slug` to be a primitive type in the JSON string but got " + data['slug']);
-      }
-      // ensure the json data is a string
-      if (data['sort_order'] && !(typeof data['sort_order'] === 'string' || data['sort_order'] instanceof String)) {
-        throw new Error("Expected the field `sort_order` to be a primitive type in the JSON string but got " + data['sort_order']);
-      }
-      // ensure the json data is a string
-      if (data['title'] && !(typeof data['title'] === 'string' || data['title'] instanceof String)) {
-        throw new Error("Expected the field `title` to be a primitive type in the JSON string but got " + data['title']);
-      }
-      return true;
-    }
-  }]);
-}();
-/**
- * Description
- * @member {String} description
- */
-ListLeaderboards200ResponseDataInner.prototype['description'] = undefined;
-
-/**
- * @member {Date} ends_at
- */
-ListLeaderboards200ResponseDataInner.prototype['ends_at'] = undefined;
-
-/**
- * Leaderboard ID
- * @member {Number} id
- */
-ListLeaderboards200ResponseDataInner.prototype['id'] = undefined;
-
-/**
- * @member {Date} inserted_at
- */
-ListLeaderboards200ResponseDataInner.prototype['inserted_at'] = undefined;
-
-/**
- * Whether the leaderboard is still active
- * @member {Boolean} is_active
- */
-ListLeaderboards200ResponseDataInner.prototype['is_active'] = undefined;
-
-/**
- * Arbitrary metadata
- * @member {Object} metadata
- */
-ListLeaderboards200ResponseDataInner.prototype['metadata'] = undefined;
-
-/**
- * Score operator
- * @member {module:model/ListLeaderboards200ResponseDataInner.OperatorEnum} operator
- */
-ListLeaderboards200ResponseDataInner.prototype['operator'] = undefined;
-
-/**
- * Human-readable identifier (reusable across seasons)
- * @member {String} slug
- */
-ListLeaderboards200ResponseDataInner.prototype['slug'] = undefined;
-
-/**
- * Sort order - desc (higher is better) or asc (lower is better)
- * @member {module:model/ListLeaderboards200ResponseDataInner.SortOrderEnum} sort_order
- */
-ListLeaderboards200ResponseDataInner.prototype['sort_order'] = undefined;
-
-/**
- * @member {Date} starts_at
- */
-ListLeaderboards200ResponseDataInner.prototype['starts_at'] = undefined;
-
-/**
- * Display title
- * @member {String} title
- */
-ListLeaderboards200ResponseDataInner.prototype['title'] = undefined;
-
-/**
- * @member {Date} updated_at
- */
-ListLeaderboards200ResponseDataInner.prototype['updated_at'] = undefined;
-
-/**
- * Allowed values for the <code>operator</code> property.
- * @enum {String}
- * @readonly
- */
-ListLeaderboards200ResponseDataInner['OperatorEnum'] = {
-  /**
-   * value: "set"
-   * @const
-   */
-  "set": "set",
-  /**
-   * value: "best"
-   * @const
-   */
-  "best": "best",
-  /**
-   * value: "incr"
-   * @const
-   */
-  "incr": "incr",
-  /**
-   * value: "decr"
-   * @const
-   */
-  "decr": "decr"
-};
-
-/**
- * Allowed values for the <code>sort_order</code> property.
- * @enum {String}
- * @readonly
- */
-ListLeaderboards200ResponseDataInner['SortOrderEnum'] = {
-  /**
-   * value: "desc"
-   * @const
-   */
-  "desc": "desc",
-  /**
-   * value: "asc"
-   * @const
-   */
-  "asc": "asc"
-};
-var _default = exports["default"] = ListLeaderboards200ResponseDataInner;