@ughuuu/game_server 1.0.382 → 1.0.790

package/dist/model/UserAchievements200Response.js

@@ -0,0 +1,124 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _AdminListNotifications200ResponseMeta = _interopRequireDefault(require("./AdminListNotifications200ResponseMeta"));
+var _UserAchievements200ResponseDataInner = _interopRequireDefault(require("./UserAchievements200ResponseDataInner"));
+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 _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+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. Has 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 
+ *
+ * The version of the OpenAPI document: 1.0.790
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The UserAchievements200Response model module.
+ * @module model/UserAchievements200Response
+ * @version 1.0.0
+ */
+var UserAchievements200Response = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>UserAchievements200Response</code>.
+   * @alias module:model/UserAchievements200Response
+   */
+  function UserAchievements200Response() {
+    _classCallCheck(this, UserAchievements200Response);
+    UserAchievements200Response.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(UserAchievements200Response, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>UserAchievements200Response</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/UserAchievements200Response} obj Optional instance to populate.
+     * @return {module:model/UserAchievements200Response} The populated <code>UserAchievements200Response</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new UserAchievements200Response();
+        if (data.hasOwnProperty('data')) {
+          obj['data'] = _ApiClient["default"].convertToType(data['data'], [_UserAchievements200ResponseDataInner["default"]]);
+        }
+        if (data.hasOwnProperty('meta')) {
+          obj['meta'] = _AdminListNotifications200ResponseMeta["default"].constructFromObject(data['meta']);
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>UserAchievements200Response</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>UserAchievements200Response</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      if (data['data']) {
+        // data not null
+        // ensure the json data is an array
+        if (!Array.isArray(data['data'])) {
+          throw new Error("Expected the field `data` to be an array in the JSON data but got " + data['data']);
+        }
+        // validate the optional field `data` (array)
+        var _iterator = _createForOfIteratorHelper(data['data']),
+          _step;
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var item = _step.value;
+            _UserAchievements200ResponseDataInner["default"].validateJSON(item);
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
+        }
+        ;
+      }
+      // validate the optional field `meta`
+      if (data['meta']) {
+        // data not null
+        _AdminListNotifications200ResponseMeta["default"].validateJSON(data['meta']);
+      }
+      return true;
+    }
+  }]);
+}();
+/**
+ * @member {Array.<module:model/UserAchievements200ResponseDataInner>} data
+ */
+UserAchievements200Response.prototype['data'] = undefined;
+
+/**
+ * @member {module:model/AdminListNotifications200ResponseMeta} meta
+ */
+UserAchievements200Response.prototype['meta'] = undefined;
+var _default = exports["default"] = UserAchievements200Response;

package/dist/model/UserAchievements200ResponseDataInner.js

@@ -0,0 +1,192 @@
+"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. Has 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 
+ *
+ * The version of the OpenAPI document: 1.0.790
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The UserAchievements200ResponseDataInner model module.
+ * @module model/UserAchievements200ResponseDataInner
+ * @version 1.0.0
+ */
+var UserAchievements200ResponseDataInner = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>UserAchievements200ResponseDataInner</code>.
+   * @alias module:model/UserAchievements200ResponseDataInner
+   */
+  function UserAchievements200ResponseDataInner() {
+    _classCallCheck(this, UserAchievements200ResponseDataInner);
+    UserAchievements200ResponseDataInner.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(UserAchievements200ResponseDataInner, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>UserAchievements200ResponseDataInner</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/UserAchievements200ResponseDataInner} obj Optional instance to populate.
+     * @return {module:model/UserAchievements200ResponseDataInner} The populated <code>UserAchievements200ResponseDataInner</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new UserAchievements200ResponseDataInner();
+        if (data.hasOwnProperty('description')) {
+          obj['description'] = _ApiClient["default"].convertToType(data['description'], 'String');
+        }
+        if (data.hasOwnProperty('hidden')) {
+          obj['hidden'] = _ApiClient["default"].convertToType(data['hidden'], 'Boolean');
+        }
+        if (data.hasOwnProperty('icon_url')) {
+          obj['icon_url'] = _ApiClient["default"].convertToType(data['icon_url'], 'String');
+        }
+        if (data.hasOwnProperty('id')) {
+          obj['id'] = _ApiClient["default"].convertToType(data['id'], 'Number');
+        }
+        if (data.hasOwnProperty('metadata')) {
+          obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], Object);
+        }
+        if (data.hasOwnProperty('progress')) {
+          obj['progress'] = _ApiClient["default"].convertToType(data['progress'], 'Number');
+        }
+        if (data.hasOwnProperty('progress_target')) {
+          obj['progress_target'] = _ApiClient["default"].convertToType(data['progress_target'], 'Number');
+        }
+        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'], 'Number');
+        }
+        if (data.hasOwnProperty('title')) {
+          obj['title'] = _ApiClient["default"].convertToType(data['title'], 'String');
+        }
+        if (data.hasOwnProperty('unlocked_at')) {
+          obj['unlocked_at'] = _ApiClient["default"].convertToType(data['unlocked_at'], 'Date');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>UserAchievements200ResponseDataInner</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>UserAchievements200ResponseDataInner</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['icon_url'] && !(typeof data['icon_url'] === 'string' || data['icon_url'] instanceof String)) {
+        throw new Error("Expected the field `icon_url` to be a primitive type in the JSON string but got " + data['icon_url']);
+      }
+      // 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['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
+ */
+UserAchievements200ResponseDataInner.prototype['description'] = undefined;
+
+/**
+ * Whether hidden until unlocked
+ * @member {Boolean} hidden
+ */
+UserAchievements200ResponseDataInner.prototype['hidden'] = undefined;
+
+/**
+ * Icon URL
+ * @member {String} icon_url
+ */
+UserAchievements200ResponseDataInner.prototype['icon_url'] = undefined;
+
+/**
+ * Achievement ID
+ * @member {Number} id
+ */
+UserAchievements200ResponseDataInner.prototype['id'] = undefined;
+
+/**
+ * Arbitrary metadata
+ * @member {Object} metadata
+ */
+UserAchievements200ResponseDataInner.prototype['metadata'] = undefined;
+
+/**
+ * Current user progress (0 if unauthenticated)
+ * @member {Number} progress
+ */
+UserAchievements200ResponseDataInner.prototype['progress'] = undefined;
+
+/**
+ * Steps to complete (1 = one-shot)
+ * @member {Number} progress_target
+ */
+UserAchievements200ResponseDataInner.prototype['progress_target'] = undefined;
+
+/**
+ * Unique identifier
+ * @member {String} slug
+ */
+UserAchievements200ResponseDataInner.prototype['slug'] = undefined;
+
+/**
+ * Display order
+ * @member {Number} sort_order
+ */
+UserAchievements200ResponseDataInner.prototype['sort_order'] = undefined;
+
+/**
+ * Display title
+ * @member {String} title
+ */
+UserAchievements200ResponseDataInner.prototype['title'] = undefined;
+
+/**
+ * When the user unlocked this (null if not unlocked)
+ * @member {Date} unlocked_at
+ */
+UserAchievements200ResponseDataInner.prototype['unlocked_at'] = undefined;
+var _default = exports["default"] = UserAchievements200ResponseDataInner;

package/dist/realtime.js

@@ -0,0 +1,247 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = exports.GameRealtime = void 0;
+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 ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+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); }
+/**
+ * GameRealtime — Phoenix WebSocket client for game_server.
+ *
+ * Wraps Phoenix.Socket to provide helpers for common game_server channel topics.
+ * Requires the `phoenix` npm package (peer dependency).
+ *
+ * Usage (browser / Node.js with bundler):
+ *
+ *   import { GameRealtime } from '@ughuuu/game_server'
+ *
+ *   const realtime = new GameRealtime('https://your-server.com', accessToken)
+ *
+ *   // Join the authenticated user channel
+ *   const userChannel = realtime.joinUserChannel(userId)
+ *   userChannel.on('notification', (payload) => console.log('notification:', payload))
+ *   userChannel.on('updated', (payload) => console.log('user updated:', payload))
+ *
+ *   // Join a lobby channel
+ *   const lobbyChannel = realtime.joinLobbyChannel(lobbyId)
+ *   lobbyChannel.on('updated', (payload) => console.log('lobby event:', payload))
+ *
+ *   realtime.disconnect()
+ *
+ * Peer dependency:
+ *
+ *   npm install phoenix
+ */
+
+var _Socket = null;
+try {
+  // Works in Node (bundled) and browser environments
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  _Socket = require('phoenix').Socket;
+} catch (_) {
+  // Swallow — will throw a descriptive error at instantiation time
+}
+var GameRealtime = exports.GameRealtime = /*#__PURE__*/function () {
+  /**
+   * @param {string} serverUrl  - Base HTTP(S) or WS(S) server URL,
+   *                              e.g. "https://game.example.com" or "wss://game.example.com"
+   * @param {string} token      - JWT access token from the REST login endpoints
+   * @param {Object} socketOpts - Optional Phoenix.Socket constructor options
+   */
+  function GameRealtime(serverUrl, token) {
+    var socketOpts = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+    _classCallCheck(this, GameRealtime);
+    if (!_Socket) {
+      throw new Error('GameRealtime requires the "phoenix" npm package. Install it: npm install phoenix');
+    }
+
+    // Normalise URL: strip trailing slash, ensure ws(s):// scheme, append /socket
+    var wsUrl = serverUrl.replace(/\/$/, '').replace(/^http(s?):\/\//, function (_m, s) {
+      return "ws".concat(s, "://");
+    }) + '/socket';
+    this._token = token;
+    this._socket = new _Socket(wsUrl, _objectSpread({
+      params: {
+        token: token
+      }
+    }, socketOpts));
+    this._socket.connect();
+    /** @type {Map<string, Object>} topic → Phoenix Channel */
+    this._channels = new Map();
+  }
+
+  // ── Channel helpers ──────────────────────────────────────────────────────
+
+  /**
+   * Join the user channel for notifications, presence, and real-time events.
+   * Topic: `"user:<userId>"`
+   * @param {string|number} userId
+   * @param {Object} params - Extra join params merged with the auth token
+   * @returns {Object} Phoenix Channel
+   */
+  return _createClass(GameRealtime, [{
+    key: "joinUserChannel",
+    value: function joinUserChannel(userId) {
+      var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      return this._join("user:".concat(userId), params);
+    }
+
+    /**
+     * Join a lobby channel for in-lobby events (member joins/leaves, updates).
+     * Topic: `"lobby:<lobbyId>"`
+     * @param {string|number} lobbyId
+     * @param {Object} params
+     * @returns {Object} Phoenix Channel
+     */
+  }, {
+    key: "joinLobbyChannel",
+    value: function joinLobbyChannel(lobbyId) {
+      var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      return this._join("lobby:".concat(lobbyId), params);
+    }
+
+    /**
+     * Join the global lobbies feed (lobby list changes).
+     * Topic: `"lobbies"`
+     * @param {Object} params
+     * @returns {Object} Phoenix Channel
+     */
+  }, {
+    key: "joinLobbiesChannel",
+    value: function joinLobbiesChannel() {
+      var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      return this._join('lobbies', params);
+    }
+
+    /**
+     * Join a group channel for group events.
+     * Topic: `"group:<groupId>"`
+     * @param {string|number} groupId
+     * @param {Object} params
+     * @returns {Object} Phoenix Channel
+     */
+  }, {
+    key: "joinGroupChannel",
+    value: function joinGroupChannel(groupId) {
+      var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      return this._join("group:".concat(groupId), params);
+    }
+
+    /**
+     * Join the global groups feed.
+     * Topic: `"groups"`
+     * @param {Object} params
+     * @returns {Object} Phoenix Channel
+     */
+  }, {
+    key: "joinGroupsChannel",
+    value: function joinGroupsChannel() {
+      var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      return this._join('groups', params);
+    }
+
+    /**
+     * Join a party channel for party events.
+     * Topic: `"party:<partyId>"`
+     * @param {string|number} partyId
+     * @param {Object} params
+     * @returns {Object} Phoenix Channel
+     */
+  }, {
+    key: "joinPartyChannel",
+    value: function joinPartyChannel(partyId) {
+      var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      return this._join("party:".concat(partyId), params);
+    }
+
+    /**
+     * Join an arbitrary channel topic.
+     * @param {string} topic  - Full Phoenix channel topic string
+     * @param {Object} params - Join params merged with the auth token
+     * @returns {Object} Phoenix Channel
+     */
+  }, {
+    key: "joinChannel",
+    value: function joinChannel(topic) {
+      var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      return this._join(topic, params);
+    }
+
+    /**
+     * Leave and remove a channel by topic.
+     * @param {string} topic
+     */
+  }, {
+    key: "leaveChannel",
+    value: function leaveChannel(topic) {
+      var ch = this._channels.get(topic);
+      if (ch) {
+        ch.leave();
+        this._channels["delete"](topic);
+      }
+    }
+
+    /**
+     * Retrieve an already-joined channel by topic.
+     * @param {string} topic
+     * @returns {Object|undefined} Phoenix Channel or undefined if not joined
+     */
+  }, {
+    key: "channel",
+    value: function channel(topic) {
+      return this._channels.get(topic);
+    }
+
+    /**
+     * Access the underlying Phoenix.Socket instance.
+     * @returns {Object}
+     */
+  }, {
+    key: "socket",
+    get: function get() {
+      return this._socket;
+    }
+
+    /**
+     * Disconnect the socket and leave all channels.
+     */
+  }, {
+    key: "disconnect",
+    value: function disconnect() {
+      this._channels.forEach(function (ch) {
+        try {
+          ch.leave();
+        } catch (_) {}
+      });
+      this._channels.clear();
+      this._socket.disconnect();
+    }
+
+    // ── Private ────────────────────────────────────────────────────────────────
+  }, {
+    key: "_join",
+    value: function _join(topic) {
+      var extraParams = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      if (this._channels.has(topic)) {
+        return this._channels.get(topic);
+      }
+      var ch = this._socket.channel(topic, _objectSpread({
+        token: this._token
+      }, extraParams));
+      ch.join().receive('error', function (err) {
+        return console.error("GameRealtime: failed to join channel \"".concat(topic, "\""), err);
+      });
+      this._channels.set(topic, ch);
+      return ch;
+    }
+  }]);
+}();
+var _default = exports["default"] = GameRealtime;