@epicgames-ps/lib-pixelstreamingsignalling-ue5.8 0.1.0

package/.lintstagedrc.mjs

@@ -0,0 +1,7 @@
+import baseConfig from '../.lintstagedrc.mjs'
+
+export default {
+    ...baseConfig,
+    '*.ts': 'eslint --fix',
+}
+

package/CHANGELOG.md

@@ -0,0 +1,21 @@
+# @epicgames-ps/lib-pixelstreamingsignalling-ue5.6
+
+## 0.2.1
+
+### Patch Changes
+
+- 812a419: - Addressing security issues raised by dependabot. (glob, js-yaml, playwright)
+    - Added lint npm script to the root project. Running `npm run lint` will now run linting over all packages.
+- Updated dependencies [812a419]
+    - @epicgames-ps/lib-pixelstreamingcommon-ue5.7@0.1.4
+
+## 0.2.0
+
+### Minor Changes
+
+- 05bebea: Add: Ability to access player id on the frontend.
+  QoL: Remove player id stripping from the signalling library.
+
+    It is useful to be able to use the player id as a unique identifier that is common between UE side stats and frontend side stats; however, the player id is not actually exposed to TS/JS because the SS strips it out of signalling messages.
+
+    This change is a backport of "Exposed playerid" (#728)

package/README.md

@@ -0,0 +1,32 @@
+
+# @epicgames-ps/lib-pixelstreamingsignalling
+
+A library for developers wanting to implement tools and applications that signal Pixel Streaming applications.
+
+## Building
+
+To build the `Signalling` module invoke the following commands in the `Common` and `Signalling` directories.
+
+```bash
+npm install
+npm run build
+```
+
+This will result in a `/dist` output directory.
+
+**Note:** If you just want to get a signalling server up and running refer to ["Getting Started"](https://github.com/EpicGames/PixelStreamingInfrastructure?tab=readme-ov-file#getting-started).
+
+### NPM package contents
+- ES6 module
+- CommonJS
+- Type definitions
+- Source maps
+
+## Documentation
+
+- [Protocol Notes](https://github.com/EpicGames/PixelStreamingInfrastructure/blob/master/Common/docs/Protocol.md)
+- [Protocol Messages](https://github.com/EpicGames/PixelStreamingInfrastructure/blob/master/Common/docs/messages.md)
+
+The API documentation is [here](https://github.com/EpicGames/PixelStreamingInfrastructure/tree/master/Signalling/docs) and covers details of all exported components of the library.
+
+

package/dist/cjs/Logger.js

@@ -0,0 +1,148 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+exports.InitLogging = InitLogging;
+// Copyright Epic Games, Inc. All Rights Reserved.
+const Utils_1 = require("./Utils");
+const path_1 = __importDefault(require("path"));
+const winston_1 = __importDefault(require("winston"));
+require("winston-daily-rotate-file");
+const lib_pixelstreamingcommon_ue5_8_1 = require("@epicgames-ps/lib-pixelstreamingcommon-ue5.8");
+const { combine, timestamp, printf, colorize, splat } = winston_1.default.format;
+/**
+ * The actual logger object. This is just a winston logger.
+ * You can use InitLogging to get a decent result, or you can
+ * completely create your own winston logger and assign it.
+ */
+exports.Logger = createDefaultLogger();
+/**
+ * A wrapper for the log calls in Common lib
+ */
+class CommonLogger {
+    constructor(winstonLogger) {
+        this.logger = winstonLogger;
+    }
+    InitLogging(_logLevel, _includeStack) { }
+    Debug(message) {
+        this.logger.debug(message);
+    }
+    Info(message) {
+        this.logger.info(message);
+    }
+    Warning(message) {
+        this.logger.warn(message);
+    }
+    Error(message) {
+        this.logger.error(message);
+    }
+}
+/**
+ * Call this as early as possible to setup the logging module with your
+ * preferred settings.
+ * @param config - The settings to init the logger with. See IConfig interface
+ */
+function InitLogging(config) {
+    const logDir = config.logDir || 'logs';
+    const logLevelConsole = config.logLevelConsole || 'info';
+    const logLevelFile = config.logLevelFile || 'info';
+    logMessagesToConsole = config.logMessagesToConsole || 'none';
+    exports.Logger = winston_1.default.createLogger({
+        transports: [createConsoleTransport(logLevelConsole), createFileTransport(logDir, logLevelFile)]
+    });
+    const commonLogger = new CommonLogger(exports.Logger);
+    (0, lib_pixelstreamingcommon_ue5_8_1.overrideLogger)(commonLogger);
+}
+let logMessagesToConsole = 'none';
+function createDefaultLogger() {
+    return winston_1.default.createLogger({
+        level: 'info',
+        format: winston_1.default.format.cli(),
+        transports: [new winston_1.default.transports.Console()]
+    });
+}
+function createConsoleTransport(logLevel) {
+    return new winston_1.default.transports.Console({
+        level: logLevel,
+        format: combine(createProtoMessageFilter()(), timestamp({ format: 'HH:mm:ss.SSS' }), colorize(), splat(), createConsoleFormat())
+    });
+}
+function isLogObject(object) {
+    /* eslint-disable @typescript-eslint/no-unsafe-member-access */
+    return ('event' in object &&
+        object.event == 'proto_message' &&
+        'direction' in object &&
+        'protoMessage' in object);
+    /* eslint-enable @typescript-eslint/no-unsafe-member-access */
+}
+function createConsoleFormat() {
+    return printf((logObj) => {
+        const prefix = `[${String(logObj['timestamp'])}] ${logObj.level}: `;
+        if (typeof logObj.message === 'string') {
+            return prefix + logObj.message;
+        }
+        else if (isLogObject(logObj.message)) {
+            const { direction, receiver, sender, target, protoMessage } = logObj.message;
+            switch (direction) {
+                case 'incoming':
+                    return prefix + `> ${receiver} :: ${formatMessageForConsole(protoMessage)}`;
+                case 'outgoing':
+                    return prefix + `< ${sender} :: ${formatMessageForConsole(protoMessage)}`;
+                case 'forward':
+                    return prefix + `${receiver} > ${target} :: ${formatMessageForConsole(protoMessage)}`;
+                default:
+                    return prefix + `Unknown proto direction: ${direction}`;
+            }
+        }
+        return '';
+    });
+}
+function formatMessageForConsole(message) {
+    switch (logMessagesToConsole) {
+        case 'verbose':
+            return (0, Utils_1.stringify)(message);
+        case 'formatted':
+            return (0, Utils_1.beautify)(message);
+        default:
+            return `[${message.type}]`;
+    }
+}
+function createProtoMessageFilter() {
+    return winston_1.default.format((info, _opts) => {
+        if (typeof info.message !== 'string' && isLogObject(info.message) && logMessagesToConsole == 'none') {
+            return false;
+        }
+        return info;
+    });
+}
+function createFileTransport(logDirPath, logLevel) {
+    return new winston_1.default.transports.DailyRotateFile({
+        level: logLevel,
+        filename: path_1.default.join(logDirPath, 'server-%DATE%.log'),
+        datePattern: 'YYYY-MM-DD',
+        maxFiles: '14d',
+        format: combine(timestamp({ format: 'YYYY-MM-DD HH:mm:ss.SSS' }), splat(), createFileFormat())
+    });
+}
+function createFileFormat() {
+    return printf((logObj) => {
+        if (typeof logObj.message === 'string') {
+            const { timestamp, level, message } = logObj;
+            return JSON.stringify({
+                timestamp,
+                level,
+                event: 'message',
+                message
+            });
+        }
+        else if (isLogObject(logObj.message)) {
+            const { timestamp, level, message } = logObj;
+            return JSON.stringify(Object.assign({ timestamp,
+                level }, message));
+        }
+        return '';
+    });
+}
+//# sourceMappingURL=Logger.js.map

package/dist/cjs/Logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logger.js","sourceRoot":"","sources":["../../src/Logger.ts"],"names":[],"mappings":";;;;;;AAoEA,kCAYC;AAhFD,kDAAkD;AAClD,mCAA8C;AAE9C,gDAAwB;AACxB,sDAA8B;AAC9B,qCAAmC;AAEnC,iGAAoG;AAEpG,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,iBAAO,CAAC,MAAM,CAAC;AAIvE;;;;GAIG;AACQ,QAAA,MAAM,GAAG,mBAAmB,EAAE,CAAC;AAgB1C;;GAEG;AACH,MAAM,YAAY;IAGd,YAAY,aAA4B;QACpC,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC;IAChC,CAAC;IAED,WAAW,CAAC,SAAiB,EAAE,aAAsB,IAAS,CAAC;IAE/D,KAAK,CAAC,OAAe;QACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,IAAI,CAAC,OAAe;QAChB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED,OAAO,CAAC,OAAe;QACnB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,OAAe;QACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;CACJ;AAED;;;;GAIG;AACH,SAAgB,WAAW,CAAC,MAAe;IACvC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC;IACvC,MAAM,eAAe,GAAG,MAAM,CAAC,eAAe,IAAI,MAAM,CAAC;IACzD,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC;IACnD,oBAAoB,GAAG,MAAM,CAAC,oBAAoB,IAAI,MAAM,CAAC;IAE7D,cAAM,GAAG,iBAAO,CAAC,YAAY,CAAC;QAC1B,UAAU,EAAE,CAAC,sBAAsB,CAAC,eAAe,CAAC,EAAE,mBAAmB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;KACnG,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,cAAM,CAAC,CAAC;IAC9C,IAAA,+CAAc,EAAC,YAAY,CAAC,CAAC;AACjC,CAAC;AAED,IAAI,oBAAoB,GAAG,MAAM,CAAC;AAElC,SAAS,mBAAmB;IACxB,OAAO,iBAAO,CAAC,YAAY,CAAC;QACxB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,GAAG,EAAE;QAC5B,UAAU,EAAE,CAAC,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;KACjD,CAAC,CAAC;AACP,CAAC;AAED,SAAS,sBAAsB,CAAC,QAAgB;IAC5C,OAAO,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,CAAC;QAClC,KAAK,EAAE,QAAQ;QACf,MAAM,EAAE,OAAO,CACX,wBAAwB,EAAE,EAAE,EAC5B,SAAS,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,EACrC,QAAQ,EAAE,EACV,KAAK,EAAE,EACP,mBAAmB,EAAE,CACxB;KACJ,CAAC,CAAC;AACP,CAAC;AAED,SAAS,WAAW,CAAC,MAAW;IAC5B,+DAA+D;IAC/D,OAAO,CACH,OAAO,IAAI,MAAM;QACjB,MAAM,CAAC,KAAK,IAAI,eAAe;QAC/B,WAAW,IAAI,MAAM;QACrB,cAAc,IAAI,MAAM,CAC3B,CAAC;IACF,8DAA8D;AAClE,CAAC;AAED,SAAS,mBAAmB;IACxB,OAAO,MAAM,CAAC,CAAC,MAAyB,EAAE,EAAE;QACxC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,KAAK,MAAM,CAAC,KAAK,IAAI,CAAC;QACpE,IAAI,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YACrC,OAAO,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC;QACnC,CAAC;aAAM,IAAI,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;YAC7E,QAAQ,SAAS,EAAE,CAAC;gBAChB,KAAK,UAAU;oBACX,OAAO,MAAM,GAAG,KAAK,QAAQ,OAAO,uBAAuB,CAAC,YAAY,CAAC,EAAE,CAAC;gBAChF,KAAK,UAAU;oBACX,OAAO,MAAM,GAAG,KAAK,MAAM,OAAO,uBAAuB,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC9E,KAAK,SAAS;oBACV,OAAO,MAAM,GAAG,GAAG,QAAQ,MAAM,MAAM,OAAO,uBAAuB,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC1F;oBACI,OAAO,MAAM,GAAG,4BAA4B,SAAS,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QACD,OAAO,EAAE,CAAC;IACd,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,uBAAuB,CAAC,OAAoB;IACjD,QAAQ,oBAAoB,EAAE,CAAC;QAC3B,KAAK,SAAS;YACV,OAAO,IAAA,iBAAS,EAAC,OAAO,CAAC,CAAC;QAC9B,KAAK,WAAW;YACZ,OAAO,IAAA,gBAAQ,EAAC,OAAO,CAAC,CAAC;QAC7B;YACI,OAAO,IAAI,OAAO,CAAC,IAAI,GAAG,CAAC;IACnC,CAAC;AACL,CAAC;AAED,SAAS,wBAAwB;IAC7B,OAAO,iBAAO,CAAC,MAAM,CAAC,CAAC,IAAuB,EAAE,KAAU,EAAE,EAAE;QAC1D,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,oBAAoB,IAAI,MAAM,EAAE,CAAC;YAClG,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,mBAAmB,CAAC,UAAkB,EAAE,QAAgB;IAC7D,OAAO,IAAI,iBAAO,CAAC,UAAU,CAAC,eAAe,CAAC;QAC1C,KAAK,EAAE,QAAQ;QACf,QAAQ,EAAE,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,mBAAmB,CAAC;QACpD,WAAW,EAAE,YAAY;QACzB,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,yBAAyB,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,gBAAgB,EAAE,CAAC;KACjG,CAAC,CAAC;AACP,CAAC;AAED,SAAS,gBAAgB;IACrB,OAAO,MAAM,CAAC,CAAC,MAAyB,EAAE,EAAE;QACxC,IAAI,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YACrC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;YAC7C,OAAO,IAAI,CAAC,SAAS,CAAC;gBAClB,SAAS;gBACT,KAAK;gBACL,KAAK,EAAE,SAAS;gBAChB,OAAO;aACV,CAAC,CAAC;QACP,CAAC;aAAM,IAAI,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;YAC7C,OAAO,IAAI,CAAC,SAAS,iBACjB,SAAS;gBACT,KAAK,IACF,OAAO,EACZ,CAAC;QACP,CAAC;QACD,OAAO,EAAE,CAAC;IACd,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/cjs/LoggingUtils.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logIncoming = logIncoming;
+exports.logOutgoing = logOutgoing;
+exports.logForward = logForward;
+exports.createHandlerListener = createHandlerListener;
+const Logger_1 = require("./Logger");
+/**
+ * Call to log messages received on a connection that we will handle here at the server.
+ * Do not call this for messages being forwarded to another connection.
+ * @param recvr - IMessageLogger The connection the message was received on.
+ */
+function logIncoming(recvr, message) {
+    const logObj = {
+        event: 'proto_message',
+        direction: 'incoming',
+        receiver: recvr.getReadableIdentifier(),
+        protoMessage: message
+    };
+    Logger_1.Logger.info(logObj);
+}
+/**
+ * Call to log messages created here at the server and being sent to the connection.
+ * Do not call this for messages being forwarded to this connection.
+ * @param sender - IMessageLogger The connection the message is being sent to.
+ */
+function logOutgoing(sender, message) {
+    Logger_1.Logger.info({
+        event: 'proto_message',
+        direction: 'outgoing',
+        sender: sender.getReadableIdentifier(),
+        protoMessage: message
+    });
+}
+/**
+ * Call this for messages being forwarded to this connection. That is messages received on
+ * one connection and being sent to another with only minor changes being made.
+ * @param recvr - The connection the message was received on.
+ * @param target - The connection the message is being sent to.
+ */
+function logForward(recvr, target, message) {
+    Logger_1.Logger.info({
+        event: 'proto_message',
+        direction: 'forward',
+        receiver: recvr.getReadableIdentifier(),
+        target: target.getReadableIdentifier(),
+        protoMessage: message
+    });
+}
+/**
+ * We don't want to log every incoming and outgoing messages. This is because some messages are simply
+ * forwarded to other connections. This results in duplicated spam. So we only want to log incoming
+ * messages that we handle internally, and any messages that we forward we only log once for the recv
+ * and send events.
+ * This creation method allows a simple way to enforce this. Any events we handle directly will
+ * be preceded by the logging call.
+ */
+function createHandlerListener(obj, handler) {
+    return (message) => {
+        logIncoming(obj, message);
+        handler.bind(obj)(message);
+    };
+}
+//# sourceMappingURL=LoggingUtils.js.map

package/dist/cjs/LoggingUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LoggingUtils.js","sourceRoot":"","sources":["../../src/LoggingUtils.ts"],"names":[],"mappings":";;AA0BA,kCAQC;AAOD,kCAOC;AAQD,gCAQC;AAUD,sDAKC;AA7ED,qCAAkC;AAmBlC;;;;GAIG;AACH,SAAgB,WAAW,CAAC,KAAqB,EAAE,OAAoB;IACnE,MAAM,MAAM,GAAiB;QACzB,KAAK,EAAE,eAAe;QACtB,SAAS,EAAE,UAAU;QACrB,QAAQ,EAAE,KAAK,CAAC,qBAAqB,EAAE;QACvC,YAAY,EAAE,OAAO;KACxB,CAAC;IACF,eAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACxB,CAAC;AAED;;;;GAIG;AACH,SAAgB,WAAW,CAAC,MAAsB,EAAE,OAAoB;IACpE,eAAM,CAAC,IAAI,CAAC;QACR,KAAK,EAAE,eAAe;QACtB,SAAS,EAAE,UAAU;QACrB,MAAM,EAAE,MAAM,CAAC,qBAAqB,EAAE;QACtC,YAAY,EAAE,OAAO;KACxB,CAAC,CAAC;AACP,CAAC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,KAAqB,EAAE,MAAsB,EAAE,OAAoB;IAC1F,eAAM,CAAC,IAAI,CAAC;QACR,KAAK,EAAE,eAAe;QACtB,SAAS,EAAE,SAAS;QACpB,QAAQ,EAAE,KAAK,CAAC,qBAAqB,EAAE;QACvC,MAAM,EAAE,MAAM,CAAC,qBAAqB,EAAE;QACtC,YAAY,EAAE,OAAO;KACxB,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CAAC,GAAmB,EAAE,OAA+B;IACtF,OAAO,CAAC,OAAoB,EAAE,EAAE;QAC5B,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC1B,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC,CAAC;AACN,CAAC"}

package/dist/cjs/PlayerConnection.js

@@ -0,0 +1,220 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlayerConnection = void 0;
+const lib_pixelstreamingcommon_ue5_8_1 = require("@epicgames-ps/lib-pixelstreamingcommon-ue5.8");
+const Logger_1 = require("./Logger");
+const LogUtils = __importStar(require("./LoggingUtils"));
+/**
+ * A connection between the signalling server and a player connection.
+ * This is where messages expected to be handled by the player come in
+ * and where messages are sent to the player.
+ *
+ * Interesting internals:
+ * playerId: The unique id string of this player.
+ * transport: The ITransport where transport events can be subscribed to
+ * protocol: The SignallingProtocol where signalling messages can be
+ * subscribed to.
+ */
+class PlayerConnection {
+    /**
+     * Initializes a new connection with given and sane values. Adds listeners for the
+     * websocket close and error so it can react by unsubscribing and resetting itself.
+     * @param server - The signalling server object that spawned this player.
+     * @param ws - The websocket coupled to this player connection.
+     * @param remoteAddress - The remote address of this connection. Only used as display.
+     * @param request - The HTTP upgrade request that opened this connection, if available.
+     */
+    constructor(server, ws, remoteAddress, request) {
+        this.server = server;
+        this.playerId = '';
+        this.subscribedStreamer = null;
+        this.transport = new lib_pixelstreamingcommon_ue5_8_1.WebSocketTransportNJS(ws);
+        this.protocol = new lib_pixelstreamingcommon_ue5_8_1.SignallingProtocol(this.transport);
+        this.remoteAddress = remoteAddress;
+        this.request = request;
+        this.transport.on('error', this.onTransportError.bind(this));
+        this.transport.on('close', this.onTransportClose.bind(this));
+        this.streamerIdChangeListener = this.onStreamerIdChanged.bind(this);
+        this.streamerDisconnectedListener = this.onStreamerDisconnected.bind(this);
+        this.registerMessageHandlers();
+    }
+    /**
+     * Returns an identifier that is displayed in logs.
+     * @returns A string describing this connection.
+     */
+    getReadableIdentifier() {
+        return this.playerId;
+    }
+    /**
+     * Sends a signalling message to the player.
+     * @param message - The message to send.
+     */
+    sendMessage(message) {
+        LogUtils.logOutgoing(this, message);
+        this.protocol.sendMessage(message);
+    }
+    /**
+     * Returns a descriptive object for the REST API inspection operations.
+     * @returns An IPlayerInfo object containing viewable information about this connection.
+     */
+    getPlayerInfo() {
+        var _a;
+        return {
+            playerId: this.playerId,
+            type: 'Player',
+            subscribedTo: (_a = this.subscribedStreamer) === null || _a === void 0 ? void 0 : _a.streamerId,
+            remoteAddress: this.remoteAddress
+        };
+    }
+    registerMessageHandlers() {
+        /* eslint-disable @typescript-eslint/unbound-method */
+        this.protocol.on(lib_pixelstreamingcommon_ue5_8_1.Messages.subscribe.typeName, LogUtils.createHandlerListener(this, this.onSubscribeMessage));
+        this.protocol.on(lib_pixelstreamingcommon_ue5_8_1.Messages.unsubscribe.typeName, LogUtils.createHandlerListener(this, this.onUnsubscribeMessage));
+        this.protocol.on(lib_pixelstreamingcommon_ue5_8_1.Messages.listStreamers.typeName, LogUtils.createHandlerListener(this, this.onListStreamers));
+        this.protocol.on(lib_pixelstreamingcommon_ue5_8_1.Messages.ping.typeName, LogUtils.createHandlerListener(this, this.onPingMessage));
+        /* eslint-enable @typescript-eslint/unbound-method */
+        this.protocol.on(lib_pixelstreamingcommon_ue5_8_1.Messages.offer.typeName, this.sendToStreamer.bind(this));
+        this.protocol.on(lib_pixelstreamingcommon_ue5_8_1.Messages.answer.typeName, this.sendToStreamer.bind(this));
+        this.protocol.on(lib_pixelstreamingcommon_ue5_8_1.Messages.iceCandidate.typeName, this.sendToStreamer.bind(this));
+        this.protocol.on(lib_pixelstreamingcommon_ue5_8_1.Messages.dataChannelRequest.typeName, this.sendToStreamer.bind(this));
+        this.protocol.on(lib_pixelstreamingcommon_ue5_8_1.Messages.peerDataChannelsReady.typeName, this.sendToStreamer.bind(this));
+        this.protocol.on(lib_pixelstreamingcommon_ue5_8_1.Messages.layerPreference.typeName, this.sendToStreamer.bind(this));
+        this.protocol.on('unhandled', (message) => {
+            Logger_1.Logger.warn(`Unhandled player protocol message: ${JSON.stringify(message)}`);
+        });
+    }
+    sendToStreamer(message) {
+        if (!this.subscribedStreamer) {
+            Logger_1.Logger.warn(`Player ${this.playerId} tried to send to a streamer but they're not subscribed to any.`);
+            const streamerId = this.server.streamerRegistry.getFirstStreamerId();
+            if (!streamerId) {
+                Logger_1.Logger.error('There are no streamers to force a subscription. Disconnecting.');
+                this.disconnect();
+                return;
+            }
+            else {
+                Logger_1.Logger.warn(`Subscribing to ${streamerId}`);
+                this.subscribe(streamerId);
+            }
+        }
+        message.playerId = this.playerId;
+        LogUtils.logForward(this, this.subscribedStreamer, message);
+        this.subscribedStreamer.protocol.sendMessage(message);
+    }
+    subscribe(streamerId) {
+        const streamer = this.server.streamerRegistry.find(streamerId);
+        if (!streamer) {
+            Logger_1.Logger.error(`subscribe: Player ${this.playerId} tried to subscribe to a non-existent streamer ${streamerId}`);
+            const failureMessage = lib_pixelstreamingcommon_ue5_8_1.MessageHelpers.createMessage(lib_pixelstreamingcommon_ue5_8_1.Messages.subscribeFailed, {
+                message: `Streamer ${streamerId} does not exist.`
+            });
+            this.protocol.sendMessage(failureMessage);
+            return;
+        }
+        if (this.subscribedStreamer) {
+            Logger_1.Logger.warn(`subscribe: Player ${this.playerId} is resubscribing to a streamer but is already subscribed to ${this.subscribedStreamer.streamerId}`);
+            this.unsubscribe();
+        }
+        if (streamer.maxSubscribers > 0 && streamer.subscribers.size >= streamer.maxSubscribers) {
+            Logger_1.Logger.error(`subscribe: Player ${this.playerId} could not subscribe to ${streamerId}. Max players (${streamer.maxSubscribers}) reached.`);
+            const failureMessage = lib_pixelstreamingcommon_ue5_8_1.MessageHelpers.createMessage(lib_pixelstreamingcommon_ue5_8_1.Messages.subscribeFailed, {
+                message: `Streamer ${streamerId} is full. Max players = ${streamer.maxSubscribers}.`
+            });
+            this.protocol.sendMessage(failureMessage);
+            return;
+        }
+        this.subscribedStreamer = streamer;
+        this.subscribedStreamer.subscribers.add(this.playerId);
+        this.subscribedStreamer.on('id_changed', this.streamerIdChangeListener);
+        this.subscribedStreamer.on('disconnect', this.streamerDisconnectedListener);
+        const connectedMessage = lib_pixelstreamingcommon_ue5_8_1.MessageHelpers.createMessage(lib_pixelstreamingcommon_ue5_8_1.Messages.playerConnected, {
+            playerId: this.playerId,
+            dataChannel: true,
+            sfu: false
+        });
+        this.sendToStreamer(connectedMessage);
+    }
+    unsubscribe() {
+        if (!this.subscribedStreamer) {
+            return;
+        }
+        this.subscribedStreamer.subscribers.delete(this.playerId);
+        const disconnectedMessage = lib_pixelstreamingcommon_ue5_8_1.MessageHelpers.createMessage(lib_pixelstreamingcommon_ue5_8_1.Messages.playerDisconnected, {
+            playerId: this.playerId
+        });
+        this.sendToStreamer(disconnectedMessage);
+        this.subscribedStreamer.off('id_changed', this.streamerIdChangeListener);
+        this.subscribedStreamer.off('disconnect', this.streamerDisconnectedListener);
+        this.subscribedStreamer = null;
+    }
+    disconnect() {
+        this.unsubscribe();
+        this.protocol.disconnect();
+    }
+    onStreamerDisconnected() {
+        this.disconnect();
+    }
+    onTransportError(error) {
+        Logger_1.Logger.error(`Player (${this.playerId}) transport error ${error.message}`);
+    }
+    onTransportClose(_event) {
+        Logger_1.Logger.debug('PlayerConnection transport close.');
+        this.disconnect();
+    }
+    onSubscribeMessage(message) {
+        this.subscribe(message.streamerId);
+    }
+    onUnsubscribeMessage(_message) {
+        this.unsubscribe();
+    }
+    onListStreamers(_message) {
+        const listMessage = lib_pixelstreamingcommon_ue5_8_1.MessageHelpers.createMessage(lib_pixelstreamingcommon_ue5_8_1.Messages.streamerList, {
+            ids: this.server.streamerRegistry.streamers
+                .filter((streamer) => streamer.streaming)
+                .map((streamer) => streamer.streamerId)
+        });
+        this.sendMessage(listMessage);
+    }
+    onStreamerIdChanged(newId) {
+        const renameMessage = lib_pixelstreamingcommon_ue5_8_1.MessageHelpers.createMessage(lib_pixelstreamingcommon_ue5_8_1.Messages.streamerIdChanged, { newID: newId });
+        this.sendMessage(renameMessage);
+    }
+    onPingMessage(message) {
+        this.sendMessage(lib_pixelstreamingcommon_ue5_8_1.MessageHelpers.createMessage(lib_pixelstreamingcommon_ue5_8_1.Messages.pong, { time: message.time }));
+    }
+}
+exports.PlayerConnection = PlayerConnection;
+//# sourceMappingURL=PlayerConnection.js.map

package/dist/cjs/PlayerConnection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlayerConnection.js","sourceRoot":"","sources":["../../src/PlayerConnection.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,iGAOsD;AAGtD,qCAAkC;AAClC,yDAA2C;AAG3C;;;;;;;;;;GAUG;AACH,MAAa,gBAAgB;IAkBzB;;;;;;;OAOG;IACH,YAAY,MAAwB,EAAE,EAAa,EAAE,aAAsB,EAAE,OAAyB;QAClG,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,sDAAqB,CAAC,EAAE,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,GAAG,IAAI,mDAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7D,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAE7D,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpE,IAAI,CAAC,4BAA4B,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE3E,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,qBAAqB;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,OAAoB;QAC5B,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACpC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,aAAa;;QACT,OAAO;YACH,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,MAAA,IAAI,CAAC,kBAAkB,0CAAE,UAAU;YACjD,aAAa,EAAE,IAAI,CAAC,aAAa;SACpC,CAAC;IACN,CAAC;IAEO,uBAAuB;QAC3B,sDAAsD;QACtD,IAAI,CAAC,QAAQ,CAAC,EAAE,CACZ,yCAAQ,CAAC,SAAS,CAAC,QAAQ,EAC3B,QAAQ,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAChE,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,CACZ,yCAAQ,CAAC,WAAW,CAAC,QAAQ,EAC7B,QAAQ,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAClE,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,CACZ,yCAAQ,CAAC,aAAa,CAAC,QAAQ,EAC/B,QAAQ,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,CAC7D,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,yCAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;QACnG,qDAAqD;QAErD,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,yCAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,yCAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3E,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,yCAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACjF,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,yCAAQ,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACvF,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,yCAAQ,CAAC,qBAAqB,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1F,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,yCAAQ,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEpF,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,OAAoB,EAAE,EAAE;YACnD,eAAM,CAAC,IAAI,CAAC,sCAAsC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACjF,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,cAAc,CAAC,OAAoB;QACvC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC3B,eAAM,CAAC,IAAI,CACP,UAAU,IAAI,CAAC,QAAQ,iEAAiE,CAC3F,CAAC;YACF,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;YACrE,IAAI,CAAC,UAAU,EAAE,CAAC;gBACd,eAAM,CAAC,KAAK,CAAC,gEAAgE,CAAC,CAAC;gBAC/E,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClB,OAAO;YACX,CAAC;iBAAM,CAAC;gBACJ,eAAM,CAAC,IAAI,CAAC,kBAAkB,UAAU,EAAE,CAAC,CAAC;gBAC5C,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAC/B,CAAC;QACL,CAAC;QAED,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QACjC,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,kBAAmB,EAAE,OAAO,CAAC,CAAC;QAC7D,IAAI,CAAC,kBAAmB,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAC3D,CAAC;IAEO,SAAS,CAAC,UAAkB;QAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,eAAM,CAAC,KAAK,CACR,qBAAqB,IAAI,CAAC,QAAQ,kDAAkD,UAAU,EAAE,CACnG,CAAC;YACF,MAAM,cAAc,GAAG,+CAAc,CAAC,aAAa,CAAC,yCAAQ,CAAC,eAAe,EAAE;gBAC1E,OAAO,EAAE,YAAY,UAAU,kBAAkB;aACpD,CAAC,CAAC;YACH,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;YAC1C,OAAO;QACX,CAAC;QAED,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC1B,eAAM,CAAC,IAAI,CACP,qBAAqB,IAAI,CAAC,QAAQ,gEAAgE,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,CACzI,CAAC;YACF,IAAI,CAAC,WAAW,EAAE,CAAC;QACvB,CAAC;QAED,IAAI,QAAQ,CAAC,cAAc,GAAG,CAAC,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YACtF,eAAM,CAAC,KAAK,CACR,qBAAqB,IAAI,CAAC,QAAQ,2BAA2B,UAAU,kBAAkB,QAAQ,CAAC,cAAc,YAAY,CAC/H,CAAC;YACF,MAAM,cAAc,GAAG,+CAAc,CAAC,aAAa,CAAC,yCAAQ,CAAC,eAAe,EAAE;gBAC1E,OAAO,EAAE,YAAY,UAAU,2BAA2B,QAAQ,CAAC,cAAc,GAAG;aACvF,CAAC,CAAC;YACH,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;YAC1C,OAAO;QACX,CAAC;QAED,IAAI,CAAC,kBAAkB,GAAG,QAAQ,CAAC;QACnC,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,YAAY,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC;QACxE,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,YAAY,EAAE,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAE5E,MAAM,gBAAgB,GAAG,+CAAc,CAAC,aAAa,CAAC,yCAAQ,CAAC,eAAe,EAAE;YAC5E,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,WAAW,EAAE,IAAI;YACjB,GAAG,EAAE,KAAK;SACb,CAAC,CAAC;QACH,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAC1C,CAAC;IAEO,WAAW;QACf,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC3B,OAAO;QACX,CAAC;QAED,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE1D,MAAM,mBAAmB,GAAG,+CAAc,CAAC,aAAa,CAAC,yCAAQ,CAAC,kBAAkB,EAAE;YAClF,QAAQ,EAAE,IAAI,CAAC,QAAQ;SAC1B,CAAC,CAAC;QACH,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QAEzC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC;QACzE,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAC7E,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;IACnC,CAAC;IAEO,UAAU;QACd,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;IAC/B,CAAC;IAEO,sBAAsB;QAC1B,IAAI,CAAC,UAAU,EAAE,CAAC;IACtB,CAAC;IAEO,gBAAgB,CAAC,KAAiB;QACtC,eAAM,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC,QAAQ,qBAAqB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAEO,gBAAgB,CAAC,MAAkB;QACvC,eAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAClD,IAAI,CAAC,UAAU,EAAE,CAAC;IACtB,CAAC;IAEO,kBAAkB,CAAC,OAA2B;QAClD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvC,CAAC;IAEO,oBAAoB,CAAC,QAA8B;QACvD,IAAI,CAAC,WAAW,EAAE,CAAC;IACvB,CAAC;IAEO,eAAe,CAAC,QAAgC;QACpD,MAAM,WAAW,GAAG,+CAAc,CAAC,aAAa,CAAC,yCAAQ,CAAC,YAAY,EAAE;YACpE,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS;iBACtC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC;iBACxC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC;SAC9C,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAClC,CAAC;IAEO,mBAAmB,CAAC,KAAa;QACrC,MAAM,aAAa,GAAG,+CAAc,CAAC,aAAa,CAAC,yCAAQ,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QACjG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IACpC,CAAC;IAEO,aAAa,CAAC,OAAsB;QACxC,IAAI,CAAC,WAAW,CAAC,+CAAc,CAAC,aAAa,CAAC,yCAAQ,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC1F,CAAC;CACJ;AApOD,4CAoOC"}

package/dist/cjs/PlayerRegistry.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlayerRegistry = void 0;
+const lib_pixelstreamingcommon_ue5_8_1 = require("@epicgames-ps/lib-pixelstreamingcommon-ue5.8");
+const Logger_1 = require("./Logger");
+/**
+ * Handles all the player connections of a signalling server and
+ * can be used to lookup connections by id etc.
+ * Fires events when players are added or removed.
+ * Events:
+ *   'added': (playerId: string) Player was added.
+ *   'removed': (playerId: string) Player was removed.
+ */
+class PlayerRegistry extends lib_pixelstreamingcommon_ue5_8_1.EventEmitter {
+    constructor() {
+        super();
+        this.players = new Map();
+        this.players = new Map();
+        this.nextPlayerId = 0;
+    }
+    /**
+     * Assigns a unique id to the player and adds it to the registry
+     */
+    add(player) {
+        player.playerId = this.getUniquePlayerId();
+        this.players.set(player.playerId, player);
+        this.emit('added', player.playerId);
+        Logger_1.Logger.info(`Registered new player: ${player.playerId}`);
+    }
+    /**
+     * Removes a player from the registry. Does nothing if the id
+     * does not exist.
+     */
+    remove(player) {
+        if (!this.players.has(player.playerId)) {
+            return;
+        }
+        this.emit('removed', player.playerId);
+        this.players.delete(player.playerId);
+        Logger_1.Logger.info(`Unregistered player: ${player.playerId}`);
+    }
+    /**
+     * Tests if a player id exists in the registry.
+     */
+    has(playerId) {
+        return this.players.has(playerId);
+    }
+    /**
+     * Gets a player from the registry using the player id.
+     * Returns undefined if the player doesn't exist.
+     */
+    get(playerId) {
+        return this.players.get(playerId);
+    }
+    listPlayers() {
+        return Array.from(this.players.values());
+    }
+    /**
+     * Returns true when the registry is empty.
+     */
+    empty() {
+        return this.players.size === 0;
+    }
+    /**
+     * Gets the total number of connected players.
+     */
+    count() {
+        return this.players.size;
+    }
+    getUniquePlayerId() {
+        const newPlayerId = `Player${this.nextPlayerId}`;
+        this.nextPlayerId++;
+        return newPlayerId;
+    }
+}
+exports.PlayerRegistry = PlayerRegistry;
+//# sourceMappingURL=PlayerRegistry.js.map

package/dist/cjs/PlayerRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlayerRegistry.js","sourceRoot":"","sources":["../../src/PlayerRegistry.ts"],"names":[],"mappings":";;;AAEA,iGAA6G;AAC7G,qCAAkC;AA+BlC;;;;;;;GAOG;AACH,MAAa,cAAe,SAAQ,6CAAY;IAI5C;QACI,KAAK,EAAE,CAAC;QAJJ,YAAO,GAAyB,IAAI,GAAG,EAAE,CAAC;QAK9C,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,MAAe;QACf,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QACpC,eAAM,CAAC,IAAI,CAAC,0BAA0B,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,MAAe;QAClB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrC,OAAO;QACX,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAErC,eAAM,CAAC,IAAI,CAAC,wBAAwB,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,QAAgB;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,QAAgB;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED,WAAW;QACP,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,KAAK;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,KAAK;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC7B,CAAC;IAEO,iBAAiB;QACrB,MAAM,WAAW,GAAG,SAAS,IAAI,CAAC,YAAY,EAAE,CAAC;QACjD,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,OAAO,WAAW,CAAC;IACvB,CAAC;CACJ;AAzED,wCAyEC"}