@ughuuu/game_server 1.0.382 → 1.0.790

package/dist/webrtc.js

@@ -0,0 +1,375 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = exports.GameWebRTC = 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 _regenerator() { /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */ var e, t, r = "function" == typeof Symbol ? Symbol : {}, n = r.iterator || "@@iterator", o = r.toStringTag || "@@toStringTag"; function i(r, n, o, i) { var c = n && n.prototype instanceof Generator ? n : Generator, u = Object.create(c.prototype); return _regeneratorDefine2(u, "_invoke", function (r, n, o) { var i, c, u, f = 0, p = o || [], y = !1, G = { p: 0, n: 0, v: e, a: d, f: d.bind(e, 4), d: function d(t, r) { return i = t, c = 0, u = e, G.n = r, a; } }; function d(r, n) { for (c = r, u = n, t = 0; !y && f && !o && t < p.length; t++) { var o, i = p[t], d = G.p, l = i[2]; r > 3 ? (o = l === n) && (u = i[(c = i[4]) ? 5 : (c = 3, 3)], i[4] = i[5] = e) : i[0] <= d && ((o = r < 2 && d < i[1]) ? (c = 0, G.v = n, G.n = i[1]) : d < l && (o = r < 3 || i[0] > n || n > l) && (i[4] = r, i[5] = n, G.n = l, c = 0)); } if (o || r > 1) return a; throw y = !0, n; } return function (o, p, l) { if (f > 1) throw TypeError("Generator is already running"); for (y && 1 === p && d(p, l), c = p, u = l; (t = c < 2 ? e : u) || !y;) { i || (c ? c < 3 ? (c > 1 && (G.n = -1), d(c, u)) : G.n = u : G.v = u); try { if (f = 2, i) { if (c || (o = "next"), t = i[o]) { if (!(t = t.call(i, u))) throw TypeError("iterator result is not an object"); if (!t.done) return t; u = t.value, c < 2 && (c = 0); } else 1 === c && (t = i["return"]) && t.call(i), c < 2 && (u = TypeError("The iterator does not provide a '" + o + "' method"), c = 1); i = e; } else if ((t = (y = G.n < 0) ? u : r.call(n, G)) !== a) break; } catch (t) { i = e, c = 1, u = t; } finally { f = 1; } } return { value: t, done: y }; }; }(r, o, i), !0), u; } var a = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} t = Object.getPrototypeOf; var c = [][n] ? t(t([][n]())) : (_regeneratorDefine2(t = {}, n, function () { return this; }), t), u = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(c); function f(e) { return Object.setPrototypeOf ? Object.setPrototypeOf(e, GeneratorFunctionPrototype) : (e.__proto__ = GeneratorFunctionPrototype, _regeneratorDefine2(e, o, "GeneratorFunction")), e.prototype = Object.create(u), e; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, _regeneratorDefine2(u, "constructor", GeneratorFunctionPrototype), _regeneratorDefine2(GeneratorFunctionPrototype, "constructor", GeneratorFunction), GeneratorFunction.displayName = "GeneratorFunction", _regeneratorDefine2(GeneratorFunctionPrototype, o, "GeneratorFunction"), _regeneratorDefine2(u), _regeneratorDefine2(u, o, "Generator"), _regeneratorDefine2(u, n, function () { return this; }), _regeneratorDefine2(u, "toString", function () { return "[object Generator]"; }), (_regenerator = function _regenerator() { return { w: i, m: f }; })(); }
+function _regeneratorDefine2(e, r, n, t) { var i = Object.defineProperty; try { i({}, "", {}); } catch (e) { i = 0; } _regeneratorDefine2 = function _regeneratorDefine(e, r, n, t) { function o(r, n) { _regeneratorDefine2(e, r, function (e) { return this._invoke(r, n, e); }); } r ? i ? i(e, r, { value: n, enumerable: !t, configurable: !t, writable: !t }) : e[r] = n : (o("next", 0), o("throw", 1), o("return", 2)); }, _regeneratorDefine2(e, r, n, t); }
+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 asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
+function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
+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); }
+/**
+ * GameWebRTC — Browser WebRTC DataChannel client for game_server.
+ *
+ * Uses an existing Phoenix channel (e.g. from GameRealtime.joinUserChannel)
+ * for SDP/ICE signaling. Once connected, named DataChannels carry game data
+ * alongside the WebSocket at lower latency.
+ *
+ * Requires a browser with native WebRTC support (RTCPeerConnection).
+ * Does NOT work in Node.js without a WebRTC polyfill.
+ *
+ * Usage:
+ *
+ *   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, {
+ *     dataChannels: [
+ *       { label: 'events', ordered: true },
+ *       { label: 'state',  ordered: false, maxRetransmits: 0 },
+ *     ],
+ *     onData:         (label, data)  => console.log('data', label, data),
+ *     onChannelOpen:  (label)        => console.log('channel open', label),
+ *     onChannelClose: (label)        => console.log('channel close', label),
+ *     onStateChange:  (state)        => console.log('state', state),
+ *   })
+ *
+ *   await webrtc.connect()
+ *   webrtc.send('events', JSON.stringify({ type: 'player_move', x: 10, y: 20 }))
+ *   webrtc.close()
+ */
+
+/**
+ * Default DataChannel definitions.
+ * - "events": reliable, ordered — important game events
+ * - "state":  unreliable, unordered — high-frequency position/state sync
+ */
+var DEFAULT_DATA_CHANNELS = [{
+  label: 'events',
+  ordered: true
+}, {
+  label: 'state',
+  ordered: false,
+  maxRetransmits: 0
+}];
+var DEFAULT_ICE_SERVERS = [{
+  urls: 'stun:stun.l.google.com:19302'
+}];
+var GameWebRTC = exports.GameWebRTC = /*#__PURE__*/function () {
+  /**
+   * @param {Object} channel — A joined Phoenix channel (e.g. from GameRealtime.joinUserChannel)
+   * @param {Object} opts
+   * @param {Array}    opts.dataChannels   — Array of {label, ordered, maxRetransmits?} definitions
+   * @param {Array}    opts.iceServers     — RTCIceServer configs (default: Google STUN)
+   * @param {Function} opts.onData        — (label: string, data: ArrayBuffer|string) => void
+   * @param {Function} opts.onChannelOpen  — (label: string) => void
+   * @param {Function} opts.onChannelClose — (label: string) => void
+   * @param {Function} opts.onStateChange  — (state: string) => void
+   * @param {Function} opts.onError        — (error: Error) => void
+   */
+  function GameWebRTC(channel) {
+    var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    _classCallCheck(this, GameWebRTC);
+    this.channel = channel;
+    this.opts = opts;
+    this.iceServers = opts.iceServers || DEFAULT_ICE_SERVERS;
+    this.dataChannelDefs = opts.dataChannels || DEFAULT_DATA_CHANNELS;
+
+    /** @type {RTCPeerConnection|null} */
+    this.pc = null;
+    /** @type {Map<string, RTCDataChannel>} label → RTCDataChannel */
+    this.channels = new Map();
+    /** @type {string} */
+    this.connectionState = 'new';
+    this._resolveConnect = null;
+    this._rejectConnect = null;
+    this._setupChannelListeners();
+  }
+
+  // ── Public API ─────────────────────────────────────────────────────────────
+
+  /**
+   * Initiate the WebRTC connection.
+   * Creates an RTCPeerConnection, opens DataChannels, sends an SDP offer
+   * over the Phoenix channel, and exchanges ICE candidates.
+   *
+   * @returns {Promise<void>} Resolves when at least one DataChannel is open.
+   */
+  return _createClass(GameWebRTC, [{
+    key: "connect",
+    value: function () {
+      var _connect = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
+        var _this = this;
+        var _iterator, _step, def, dcOpts, dc, offer;
+        return _regenerator().w(function (_context) {
+          while (1) switch (_context.n) {
+            case 0:
+              this.pc = new RTCPeerConnection({
+                iceServers: this.iceServers
+              });
+              this.pc.onicecandidate = function (event) {
+                return _this._onIceCandidate(event);
+              };
+              this.pc.onconnectionstatechange = function () {
+                return _this._onConnectionStateChange();
+              };
+
+              // Create DataChannels on the client side (client-initiated)
+              _iterator = _createForOfIteratorHelper(this.dataChannelDefs);
+              try {
+                for (_iterator.s(); !(_step = _iterator.n()).done;) {
+                  def = _step.value;
+                  dcOpts = {
+                    ordered: def.ordered !== false
+                  };
+                  if (def.maxRetransmits !== undefined) dcOpts.maxRetransmits = def.maxRetransmits;
+                  if (def.maxPacketLifeTime !== undefined) dcOpts.maxPacketLifeTime = def.maxPacketLifeTime;
+                  dc = this.pc.createDataChannel(def.label, dcOpts);
+                  this._wireDataChannel(dc);
+                  this.channels.set(def.label, dc);
+                }
+
+                // Create and send SDP offer
+              } catch (err) {
+                _iterator.e(err);
+              } finally {
+                _iterator.f();
+              }
+              _context.n = 1;
+              return this.pc.createOffer();
+            case 1:
+              offer = _context.v;
+              _context.n = 2;
+              return this.pc.setLocalDescription(offer);
+            case 2:
+              return _context.a(2, new Promise(function (resolve, reject) {
+                _this.channel.push('webrtc:offer', {
+                  sdp: offer.sdp,
+                  type: offer.type
+                }).receive('ok', function () {
+                  // Offer accepted — wait for webrtc:answer from server
+                  _this._resolveConnect = resolve;
+                  _this._rejectConnect = reject;
+                }).receive('error', function (resp) {
+                  reject(new Error(resp.error || 'webrtc:offer rejected'));
+                });
+
+                // Timeout after 15 seconds
+                setTimeout(function () {
+                  if (_this._resolveConnect) {
+                    _this._resolveConnect = null;
+                    reject(new Error('WebRTC connection timed out'));
+                  }
+                }, 15000);
+              }));
+          }
+        }, _callee, this);
+      }));
+      function connect() {
+        return _connect.apply(this, arguments);
+      }
+      return connect;
+    }()
+    /**
+     * Send data over a named DataChannel.
+     * @param {string} label — channel label (e.g. "events" or "state")
+     * @param {string|ArrayBuffer|Blob} data
+     * @returns {boolean} true if sent, false if channel is not open
+     */
+  }, {
+    key: "send",
+    value: function send(label, data) {
+      var dc = this.channels.get(label);
+      if (!dc || dc.readyState !== 'open') return false;
+      dc.send(data);
+      return true;
+    }
+
+    /**
+     * Check if a specific DataChannel is open.
+     * @param {string} label
+     * @returns {boolean}
+     */
+  }, {
+    key: "isChannelOpen",
+    value: function isChannelOpen(label) {
+      var dc = this.channels.get(label);
+      return dc ? dc.readyState === 'open' : false;
+    }
+
+    /**
+     * Check if the WebRTC connection is active.
+     * @returns {boolean}
+     */
+  }, {
+    key: "isConnected",
+    value: function isConnected() {
+      return this.pc != null && this.connectionState === 'connected';
+    }
+
+    /**
+     * Close the WebRTC connection and all DataChannels.
+     * Notifies the server via the Phoenix channel.
+     */
+  }, {
+    key: "close",
+    value: function close() {
+      this._removeChannelListeners();
+
+      // Close all DataChannels
+      var _iterator2 = _createForOfIteratorHelper(this.channels.values()),
+        _step2;
+      try {
+        for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+          var dc = _step2.value;
+          try {
+            dc.close();
+          } catch (_) {}
+        }
+      } catch (err) {
+        _iterator2.e(err);
+      } finally {
+        _iterator2.f();
+      }
+      this.channels.clear();
+
+      // Close PeerConnection
+      if (this.pc) {
+        try {
+          this.pc.close();
+        } catch (_) {}
+        this.pc = null;
+      }
+
+      // Notify server
+      this.channel.push('webrtc:close', {});
+      this.connectionState = 'closed';
+    }
+
+    // ── Private: signaling channel listeners ──────────────────────────────────
+  }, {
+    key: "_setupChannelListeners",
+    value: function _setupChannelListeners() {
+      var _this2 = this;
+      // Server sends SDP answer
+      this._answerRef = this.channel.on('webrtc:answer', function (payload) {
+        if (_this2.pc) {
+          _this2.pc.setRemoteDescription(new RTCSessionDescription({
+            sdp: payload.sdp,
+            type: payload.type
+          }));
+        }
+      });
+
+      // Server sends ICE candidate
+      this._iceRef = this.channel.on('webrtc:ice', function (payload) {
+        if (_this2.pc && payload.candidate) {
+          _this2.pc.addIceCandidate(new RTCIceCandidate(payload))["catch"](function (err) {
+            return _this2._emitError(err);
+          });
+        }
+      });
+
+      // Server notifies about connection state changes
+      this._stateRef = this.channel.on('webrtc:state', function (payload) {
+        var cb = _this2.opts.onStateChange;
+        if (cb) cb(payload.state);
+      });
+
+      // Server relays DataChannel data back via WebSocket (fallback)
+      this._dataRef = this.channel.on('webrtc:data', function (payload) {
+        var cb = _this2.opts.onData;
+        if (cb) cb(payload.channel, payload.data);
+      });
+
+      // Server confirms channel open
+      this._openRef = this.channel.on('webrtc:channel_open', function (payload) {
+        var cb = _this2.opts.onChannelOpen;
+        if (cb) cb(payload.channel);
+      });
+    }
+  }, {
+    key: "_removeChannelListeners",
+    value: function _removeChannelListeners() {
+      if (this._answerRef) this.channel.off('webrtc:answer', this._answerRef);
+      if (this._iceRef) this.channel.off('webrtc:ice', this._iceRef);
+      if (this._stateRef) this.channel.off('webrtc:state', this._stateRef);
+      if (this._dataRef) this.channel.off('webrtc:data', this._dataRef);
+      if (this._openRef) this.channel.off('webrtc:channel_open', this._openRef);
+    }
+
+    // ── Private: RTCPeerConnection event handlers ─────────────────────────────
+  }, {
+    key: "_onIceCandidate",
+    value: function _onIceCandidate(event) {
+      if (event.candidate) {
+        this.channel.push('webrtc:ice', event.candidate.toJSON());
+      }
+    }
+  }, {
+    key: "_onConnectionStateChange",
+    value: function _onConnectionStateChange() {
+      var state = this.pc.connectionState;
+      this.connectionState = state;
+      var cb = this.opts.onStateChange;
+      if (cb) cb(state);
+      if (state === 'connected' && this._resolveConnect) {
+        this._resolveConnect();
+        this._resolveConnect = null;
+        this._rejectConnect = null;
+      }
+      if (state === 'failed' && this._rejectConnect) {
+        this._rejectConnect(new Error('WebRTC connection failed'));
+        this._resolveConnect = null;
+        this._rejectConnect = null;
+      }
+    }
+
+    // ── Private: DataChannel wiring ───────────────────────────────────────────
+  }, {
+    key: "_wireDataChannel",
+    value: function _wireDataChannel(dc) {
+      var _this3 = this;
+      dc.onopen = function () {
+        var cb = _this3.opts.onChannelOpen;
+        if (cb) cb(dc.label);
+
+        // Resolve connect() promise when the FIRST channel opens
+        if (_this3._resolveConnect) {
+          _this3._resolveConnect();
+          _this3._resolveConnect = null;
+          _this3._rejectConnect = null;
+        }
+      };
+      dc.onclose = function () {
+        var cb = _this3.opts.onChannelClose;
+        if (cb) cb(dc.label);
+      };
+      dc.onmessage = function (event) {
+        var cb = _this3.opts.onData;
+        if (cb) cb(dc.label, event.data);
+      };
+      dc.onerror = function (event) {
+        _this3._emitError(event.error || event);
+      };
+    }
+  }, {
+    key: "_emitError",
+    value: function _emitError(error) {
+      var cb = this.opts.onError;
+      if (cb) cb(error);
+    }
+  }]);
+}();
+var _default = exports["default"] = GameWebRTC;

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "@ughuuu/game_server",
-  "version": "1.0.382",
-  "description": "API for Game Server application  ## Authentication  This API uses JWT (JSON Web Tokens) with access and refresh tokens:  ### 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  ### Using Tokens Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ```  ### Refreshing Tokens When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token.  ## 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  ## 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  ## 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  ## 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 ",
+  "version": "1.0.790",
+  "description": "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 ",
   "license": "MIT",
   "main": "dist/index.js",
-  "repository": { "type": "git", "url": "git+https://github.com/appsinacup/game_server.git" },
   "scripts": {
     "build": "babel src -d dist",
     "prepare": "npm run build",
@@ -41,25 +40,19 @@
     "mocha": "^8.0.1",
     "sinon": "^7.2.0"
   },
-  "keywords": [
-    "game-server",
-    "multiplayer",
-    "lobby",
-    "matchmaking",
-    "leaderboard",
-    "chat",
-    "friends",
-    "parties",
-    "groups",
-    "notifications",
-    "sdk",
-    "api-client",
-    "realtime",
-    "websocket",
-    "jwt"
-  ],
   "files": [
-    "dist",
-    "README.md"
-  ]
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/appsinacup/game_server.git"
+  },
+  "peerDependencies": {
+    "phoenix": ">=1.7.0"
+  },
+  "peerDependenciesMeta": {
+    "phoenix": {
+      "optional": true
+    }
+  }
 }

package/dist/model/CreateLobby401Response.js

@@ -1,89 +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 Game Server application  ## Authentication  This API uses JWT (JSON Web Tokens) with access and refresh tokens:  ### 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  ### Using Tokens Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ```  ### Refreshing Tokens When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token.  ## 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  ## 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  ## 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 
- *
- * The version of the OpenAPI document: 1.0.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- *
- */
-/**
- * The CreateLobby401Response model module.
- * @module model/CreateLobby401Response
- * @version 1.0.0
- */
-var CreateLobby401Response = /*#__PURE__*/function () {
-  /**
-   * Constructs a new <code>CreateLobby401Response</code>.
-   * @alias module:model/CreateLobby401Response
-   */
-  function CreateLobby401Response() {
-    _classCallCheck(this, CreateLobby401Response);
-    CreateLobby401Response.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(CreateLobby401Response, null, [{
-    key: "initialize",
-    value: function initialize(obj) {}
-
-    /**
-     * Constructs a <code>CreateLobby401Response</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/CreateLobby401Response} obj Optional instance to populate.
-     * @return {module:model/CreateLobby401Response} The populated <code>CreateLobby401Response</code> instance.
-     */
-  }, {
-    key: "constructFromObject",
-    value: function constructFromObject(data, obj) {
-      if (data) {
-        obj = obj || new CreateLobby401Response();
-        if (data.hasOwnProperty('error')) {
-          obj['error'] = _ApiClient["default"].convertToType(data['error'], 'String');
-        }
-      }
-      return obj;
-    }
-
-    /**
-     * Validates the JSON data with respect to <code>CreateLobby401Response</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>CreateLobby401Response</code>.
-     */
-  }, {
-    key: "validateJSON",
-    value: function validateJSON(data) {
-      // ensure the json data is a string
-      if (data['error'] && !(typeof data['error'] === 'string' || data['error'] instanceof String)) {
-        throw new Error("Expected the field `error` to be a primitive type in the JSON string but got " + data['error']);
-      }
-      return true;
-    }
-  }]);
-}();
-/**
- * @member {String} error
- */
-CreateLobby401Response.prototype['error'] = undefined;
-var _default = exports["default"] = CreateLobby401Response;

package/dist/model/JoinLobby200Response.js

@@ -1,89 +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 Game Server application  ## Authentication  This API uses JWT (JSON Web Tokens) with access and refresh tokens:  ### Getting Tokens - **Email/Password**: POST to `/api/v1/login` with email and password - **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 (API flow not yet implemented)  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  ### Using Tokens Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ```  ### Refreshing Tokens When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token.  ## Endpoints All API endpoints are under `/api/v1` 
- *
- * The version of the OpenAPI document: 1.0.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- *
- */
-/**
- * The JoinLobby200Response model module.
- * @module model/JoinLobby200Response
- * @version 1.0.0
- */
-var JoinLobby200Response = /*#__PURE__*/function () {
-  /**
-   * Constructs a new <code>JoinLobby200Response</code>.
-   * @alias module:model/JoinLobby200Response
-   */
-  function JoinLobby200Response() {
-    _classCallCheck(this, JoinLobby200Response);
-    JoinLobby200Response.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(JoinLobby200Response, null, [{
-    key: "initialize",
-    value: function initialize(obj) {}
-
-    /**
-     * Constructs a <code>JoinLobby200Response</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/JoinLobby200Response} obj Optional instance to populate.
-     * @return {module:model/JoinLobby200Response} The populated <code>JoinLobby200Response</code> instance.
-     */
-  }, {
-    key: "constructFromObject",
-    value: function constructFromObject(data, obj) {
-      if (data) {
-        obj = obj || new JoinLobby200Response();
-        if (data.hasOwnProperty('message')) {
-          obj['message'] = _ApiClient["default"].convertToType(data['message'], 'String');
-        }
-      }
-      return obj;
-    }
-
-    /**
-     * Validates the JSON data with respect to <code>JoinLobby200Response</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>JoinLobby200Response</code>.
-     */
-  }, {
-    key: "validateJSON",
-    value: function validateJSON(data) {
-      // ensure the json data is a string
-      if (data['message'] && !(typeof data['message'] === 'string' || data['message'] instanceof String)) {
-        throw new Error("Expected the field `message` to be a primitive type in the JSON string but got " + data['message']);
-      }
-      return true;
-    }
-  }]);
-}();
-/**
- * @member {String} message
- */
-JoinLobby200Response.prototype['message'] = undefined;
-var _default = exports["default"] = JoinLobby200Response;