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

package/dist/esm/StreamerConnection.js

@@ -0,0 +1,135 @@
+import { SignallingProtocol, WebSocketTransportNJS, Messages, EventEmitter, MessageHelpers } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.8';
+import { stringify } from './Utils';
+import { Logger } from './Logger';
+import * as LogUtils from './LoggingUtils';
+/**
+ * A connection between the signalling server and a streamer connection.
+ * This is where messages expected to be handled by the streamer come in
+ * and where messages are sent to the streamer.
+ *
+ * Interesting internals:
+ * streamerId: The unique id string of this streamer.
+ * transport: The ITransport where transport events can be subscribed to
+ * protocol: The SignallingProtocol where signalling messages can be
+ * subscribed to.
+ * streaming: True when the streamer is ready to accept subscriptions.
+ */
+export class StreamerConnection extends EventEmitter {
+    /**
+     * Initializes a new connection with given and sane values. Adds listeners for the
+     * websocket close and error and will emit a disconnected event when disconneted.
+     * @param server - The signalling server object that spawned this streamer.
+     * @param ws - The websocket coupled to this streamer 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) {
+        super();
+        this.server = server;
+        this.streamerId = '';
+        this.transport = new WebSocketTransportNJS(ws);
+        this.protocol = new SignallingProtocol(this.transport);
+        this.streaming = false;
+        this.remoteAddress = remoteAddress;
+        this.request = request;
+        this.maxSubscribers = 0;
+        this.subscribers = new Set();
+        this.transport.on('error', this.onTransportError.bind(this));
+        this.transport.on('close', this.onTransportClose.bind(this));
+        this.registerMessageHandlers();
+        this.protocol.on('unhandled', (message) => {
+            Logger.warn(`Unhandled streamer protocol message: ${JSON.stringify(message)}`);
+        });
+    }
+    /**
+     * Returns an identifier that is displayed in logs.
+     * @returns A string describing this connection.
+     */
+    getReadableIdentifier() {
+        return this.streamerId;
+    }
+    /**
+     * 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 IStreamerInfo object containing viewable information about this connection.
+     */
+    getStreamerInfo() {
+        return {
+            streamerId: this.streamerId,
+            type: 'Streamer',
+            streaming: this.streaming,
+            remoteAddress: this.remoteAddress,
+            subscribers: this.server.playerRegistry
+                .listPlayers()
+                .filter((player) => player.subscribedStreamer == this)
+                .map((player) => player.getPlayerInfo())
+        };
+    }
+    registerMessageHandlers() {
+        /* eslint-disable @typescript-eslint/unbound-method */
+        this.protocol.on(Messages.endpointId.typeName, LogUtils.createHandlerListener(this, this.onEndpointId));
+        this.protocol.on(Messages.disconnectPlayer.typeName, LogUtils.createHandlerListener(this, this.onDisconnectPlayerRequest));
+        this.protocol.on(Messages.layerPreference.typeName, LogUtils.createHandlerListener(this, this.onLayerPreference));
+        this.protocol.on(Messages.ping.typeName, LogUtils.createHandlerListener(this, this.onPingMessage));
+        /* eslint-enable @typescript-eslint/unbound-method */
+        this.protocol.on(Messages.offer.typeName, this.forwardMessage.bind(this));
+        this.protocol.on(Messages.answer.typeName, this.forwardMessage.bind(this));
+        this.protocol.on(Messages.iceCandidate.typeName, this.forwardMessage.bind(this));
+    }
+    forwardMessage(message) {
+        if (!message.playerId) {
+            Logger.warn(`No playerId specified, cannot forward message: ${stringify(message)}`);
+        }
+        else if (!this.subscribers.has(message.playerId)) {
+            // Only forward to players that are actually subscribed to this streamer. Without this
+            // check a streamer could target any player on the server (resolved via the global player
+            // registry), allowing cross-tenant signalling on a shared signalling server.
+            Logger.warn(`Streamer ${this.streamerId} tried to forward a message to player ${message.playerId} which is not subscribed to it. Ignoring.`);
+        }
+        else {
+            const player = this.server.playerRegistry.get(message.playerId);
+            if (player) {
+                LogUtils.logForward(this, player, message);
+                player.protocol.sendMessage(message);
+            }
+        }
+    }
+    onTransportError(error) {
+        Logger.error(`Streamer (${this.streamerId}) transport error ${error.message}`);
+    }
+    onTransportClose() {
+        Logger.info(`Streamer '${this.streamerId}' - websocket disconnected.`);
+        this.emit('disconnect');
+    }
+    onEndpointId(_message) {
+        this.streaming = true; // we're ready to stream when we id ourselves
+    }
+    onDisconnectPlayerRequest(message) {
+        if (message.playerId) {
+            if (!this.subscribers.has(message.playerId)) {
+                // A streamer may only disconnect its own subscribed players. Otherwise any streamer
+                // could forcibly close arbitrary player connections on a shared signalling server.
+                Logger.warn(`Streamer ${this.streamerId} tried to disconnect player ${message.playerId} which is not subscribed to it. Ignoring.`);
+                return;
+            }
+            const player = this.server.playerRegistry.get(message.playerId);
+            if (player) {
+                player.protocol.disconnect(1011, message.reason);
+            }
+        }
+    }
+    onLayerPreference(message) {
+        this.emit('layer_preference', message);
+    }
+    onPingMessage(message) {
+        this.sendMessage(MessageHelpers.createMessage(Messages.pong, { time: message.time }));
+    }
+}
+//# sourceMappingURL=StreamerConnection.js.map

package/dist/esm/StreamerConnection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StreamerConnection.js","sourceRoot":"","sources":["../../src/StreamerConnection.ts"],"names":[],"mappings":"AAGA,OAAO,EAEH,kBAAkB,EAClB,qBAAqB,EAErB,QAAQ,EACR,YAAY,EACZ,cAAc,EACjB,MAAM,8CAA8C,CAAC;AAEtD,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAC;AAG3C;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IAoBhD;;;;;;;OAOG;IACH,YAAY,MAAwB,EAAE,EAAa,EAAE,aAAsB,EAAE,OAAyB;QAClG,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAqB,CAAC,EAAE,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;QACxB,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAE,CAAC;QAE7B,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,uBAAuB,EAAE,CAAC;QAE/B,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,OAAoB,EAAE,EAAE;YACnD,MAAM,CAAC,IAAI,CAAC,wCAAwC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACH,qBAAqB;QACjB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,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,eAAe;QACX,OAAO;YACH,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,IAAI,EAAE,UAAU;YAChB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,cAAc;iBAClC,WAAW,EAAE;iBACb,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,kBAAkB,IAAI,IAAI,CAAC;iBACrD,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;SAC/C,CAAC;IACN,CAAC;IAEO,uBAAuB;QAC3B,sDAAsD;QACtD,IAAI,CAAC,QAAQ,CAAC,EAAE,CACZ,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAC5B,QAAQ,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAC1D,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,CACZ,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAClC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,yBAAyB,CAAC,CACvE,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,CACZ,QAAQ,CAAC,eAAe,CAAC,QAAQ,EACjC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAC/D,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,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,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3E,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACrF,CAAC;IAEO,cAAc,CAAC,OAAoB;QACvC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YACpB,MAAM,CAAC,IAAI,CAAC,kDAAkD,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACxF,CAAC;aAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjD,sFAAsF;YACtF,yFAAyF;YACzF,6EAA6E;YAC7E,MAAM,CAAC,IAAI,CACP,YAAY,IAAI,CAAC,UAAU,yCAAyC,OAAO,CAAC,QAAQ,2CAA2C,CAClI,CAAC;QACN,CAAC;aAAM,CAAC;YACJ,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAChE,IAAI,MAAM,EAAE,CAAC;gBACT,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;gBAC3C,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YACzC,CAAC;QACL,CAAC;IACL,CAAC;IAEO,gBAAgB,CAAC,KAAiB;QACtC,MAAM,CAAC,KAAK,CAAC,aAAa,IAAI,CAAC,UAAU,qBAAqB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAEO,gBAAgB;QACpB,MAAM,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,UAAU,6BAA6B,CAAC,CAAC;QACvE,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5B,CAAC;IAEO,YAAY,CAAC,QAA6B;QAC9C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,6CAA6C;IACxE,CAAC;IAEO,yBAAyB,CAAC,OAAkC;QAChE,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC1C,oFAAoF;gBACpF,mFAAmF;gBACnF,MAAM,CAAC,IAAI,CACP,YAAY,IAAI,CAAC,UAAU,+BAA+B,OAAO,CAAC,QAAQ,2CAA2C,CACxH,CAAC;gBACF,OAAO;YACX,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAChE,IAAI,MAAM,EAAE,CAAC;gBACT,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;YACrD,CAAC;QACL,CAAC;IACL,CAAC;IAEO,iBAAiB,CAAC,OAAiC;QACvD,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;IAEO,aAAa,CAAC,OAAsB;QACxC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC1F,CAAC;CACJ"}

package/dist/esm/StreamerRegistry.js

@@ -0,0 +1,145 @@
+// Copyright Epic Games, Inc. All Rights Reserved.
+import { Messages, MessageHelpers, EventEmitter } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.8';
+import { Logger } from './Logger';
+/**
+ * Handles all the streamer connections of a signalling server and
+ * can be used to lookup connections by id etc.
+ * Fires events when streamers are added or removed.
+ * Events:
+ *   'added': (playerId: string) Player was added.
+ *   'removed': (playerId: string) Player was removed.
+ */
+export class StreamerRegistry extends EventEmitter {
+    constructor(authorizeStreamerId) {
+        super();
+        this.defaultStreamerIdPrefix = 'UnknownStreamer';
+        this.streamers = [];
+        this.authorizeStreamerId = authorizeStreamerId;
+    }
+    /**
+     * Adds a streamer to the registry. If the streamer already has an id
+     * it will be sanitized (checked against existing ids and altered if
+     * there are collisions), or if it has no id it will be assigned a
+     * default unique id.
+     * @returns True if the add was successful.
+     */
+    add(streamer) {
+        streamer.streamerId = this.sanitizeStreamerId(streamer.streamerId);
+        if (this.find(streamer.streamerId)) {
+            Logger.error(`StreamerRegistry: Tried to register streamer ${streamer.streamerId} but that id already exists.`);
+            return false;
+        }
+        this.streamers.push(streamer);
+        // request that the new streamer id itself.
+        streamer.protocol.on(Messages.endpointId.typeName, this.onEndpointId.bind(this, streamer));
+        streamer.sendMessage(MessageHelpers.createMessage(Messages.identify));
+        this.emit('added', streamer.streamerId);
+        return true;
+    }
+    /**
+     * Removes a streamer from the registry. If the streamer isn't found
+     * it does nothing.
+     * @returns True if the streamer was removed.
+     */
+    remove(streamer) {
+        const index = this.streamers.indexOf(streamer);
+        if (index === -1) {
+            Logger.debug(`StreamerRegistry: Tried to remove streamer ${streamer.streamerId} but it doesn't exist`);
+            return false;
+        }
+        this.streamers.splice(index, 1);
+        this.emit('removed', streamer.streamerId);
+        return true;
+    }
+    /**
+     * Attempts to find the given streamer id in the registry.
+     */
+    find(streamerId) {
+        return this.streamers.find((streamer) => streamer.streamerId === streamerId);
+    }
+    /**
+     * Used by players who haven't subscribed but try to send a message.
+     * This is to cover legacy connections that do not know how to subscribe.
+     * The player will be assigned the first streamer in the list.
+     * @returns The first streamerId in the registry or null if there are none.
+     */
+    getFirstStreamerId() {
+        if (this.empty()) {
+            return null;
+        }
+        return this.streamers[0].streamerId;
+    }
+    /**
+     * Returns true when the registry is empty.
+     */
+    empty() {
+        return this.streamers.length === 0;
+    }
+    /**
+     * Returns the total number of connected streamers.
+     */
+    count() {
+        return this.streamers.length;
+    }
+    onEndpointId(streamer, message) {
+        const oldId = streamer.streamerId;
+        // id might conflict or be invalid so here we sanitize it
+        const sanitizedId = this.sanitizeStreamerId(message.id);
+        let committedId = sanitizedId;
+        if (this.authorizeStreamerId) {
+            // Let the consumer accept the default id, override it (e.g. namespace per tenant), or
+            // reject the registration entirely. This is where anti-squatting policy lives.
+            committedId = this.authorizeStreamerId({
+                streamer,
+                requestedId: message.id,
+                sanitizedId,
+                collided: !!message.id && sanitizedId !== message.id
+            });
+            if (committedId === null) {
+                Logger.warn(`StreamerRegistry: streamer id '${message.id}' (was ${oldId}) rejected by authorizer. Disconnecting.`);
+                this.remove(streamer);
+                streamer.protocol.disconnect(1008, 'streamer id not authorized');
+                return;
+            }
+            // An override must remain unique or it would corrupt id-based lookups. If the consumer
+            // hands back an id already held by a different streamer we reject rather than clobber.
+            const existing = this.find(committedId);
+            if (existing && existing !== streamer) {
+                Logger.error(`StreamerRegistry: authorizer returned id '${committedId}' which is already in use. Disconnecting.`);
+                this.remove(streamer);
+                streamer.protocol.disconnect(1008, 'streamer id not authorized');
+                return;
+            }
+        }
+        streamer.streamerId = committedId;
+        Logger.debug(`StreamerRegistry: Streamer id change. ${oldId} -> ${streamer.streamerId}`);
+        streamer.emit('id_changed', streamer.streamerId);
+        // because we might have sanitized the id, we confirm the id back to the streamer
+        streamer.sendMessage(MessageHelpers.createMessage(Messages.endpointIdConfirm, { committedId: streamer.streamerId }));
+    }
+    sanitizeStreamerId(id) {
+        // create a default id if none supplied
+        if (!id) {
+            id = this.defaultStreamerIdPrefix;
+        }
+        // search for existing streamerId and optionally append a numeric value
+        let maxPostfix = -1;
+        for (const streamer of this.streamers) {
+            const idMatchRegex = /^(.*?)(\d*)$/;
+            const [, baseId, postfix] = streamer.streamerId.match(idMatchRegex);
+            // if the id is numeric then base id will be empty and we need to compare with the postfix
+            if ((baseId !== '' && baseId !== id) || (baseId === '' && postfix !== id)) {
+                continue;
+            }
+            const numPostfix = Number(postfix);
+            if (numPostfix > maxPostfix) {
+                maxPostfix = numPostfix;
+            }
+        }
+        if (maxPostfix >= 0) {
+            return id + (maxPostfix + 1);
+        }
+        return id;
+    }
+}
+//# sourceMappingURL=StreamerRegistry.js.map

package/dist/esm/StreamerRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StreamerRegistry.js","sourceRoot":"","sources":["../../src/StreamerRegistry.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,OAAO,EAGH,QAAQ,EACR,cAAc,EAEd,YAAY,EACf,MAAM,8CAA8C,CAAC;AAEtD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AA+DlC;;;;;;;GAOG;AACH,MAAM,OAAO,gBAAiB,SAAQ,YAAY;IAQ9C,YAAY,mBAA0C;QAClD,KAAK,EAAE,CAAC;QAPZ,4BAAuB,GAAW,iBAAiB,CAAC;QAQhD,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;IACnD,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,QAAmB;QACnB,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAEnE,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACjC,MAAM,CAAC,KAAK,CACR,gDAAgD,QAAQ,CAAC,UAAU,8BAA8B,CACpG,CAAC;YACF,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE9B,2CAA2C;QAC3C,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC3F,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEtE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;QAExC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAmB;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC/C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CACR,8CAA8C,QAAQ,CAAC,UAAU,uBAAuB,CAC3F,CAAC;YACF,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,UAAkB;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,KAAK,UAAU,CAAC,CAAC;IACjF,CAAC;IAED;;;;;OAKG;IACH,kBAAkB;QACd,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YACf,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,KAAK;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,KAAK;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;IACjC,CAAC;IAEO,YAAY,CAAC,QAAmB,EAAE,OAA4B;QAClE,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC;QAElC,yDAAyD;QACzD,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAExD,IAAI,WAAW,GAAkB,WAAW,CAAC;QAC7C,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC3B,sFAAsF;YACtF,+EAA+E;YAC/E,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC;gBACnC,QAAQ;gBACR,WAAW,EAAE,OAAO,CAAC,EAAE;gBACvB,WAAW;gBACX,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,WAAW,KAAK,OAAO,CAAC,EAAE;aACvD,CAAC,CAAC;YAEH,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;gBACvB,MAAM,CAAC,IAAI,CACP,kCAAkC,OAAO,CAAC,EAAE,UAAU,KAAK,0CAA0C,CACxG,CAAC;gBACF,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACtB,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,4BAA4B,CAAC,CAAC;gBACjE,OAAO;YACX,CAAC;YAED,uFAAuF;YACvF,uFAAuF;YACvF,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACxC,IAAI,QAAQ,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACpC,MAAM,CAAC,KAAK,CACR,6CAA6C,WAAW,2CAA2C,CACtG,CAAC;gBACF,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACtB,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,4BAA4B,CAAC,CAAC;gBACjE,OAAO;YACX,CAAC;QACL,CAAC;QAED,QAAQ,CAAC,UAAU,GAAG,WAAW,CAAC;QAElC,MAAM,CAAC,KAAK,CAAC,yCAAyC,KAAK,OAAO,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACzF,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;QAEjD,iFAAiF;QACjF,QAAQ,CAAC,WAAW,CAChB,cAAc,CAAC,aAAa,CAAC,QAAQ,CAAC,iBAAiB,EAAE,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC,CACjG,CAAC;IACN,CAAC;IAEO,kBAAkB,CAAC,EAAU;QACjC,uCAAuC;QACvC,IAAI,CAAC,EAAE,EAAE,CAAC;YACN,EAAE,GAAG,IAAI,CAAC,uBAAuB,CAAC;QACtC,CAAC;QAED,uEAAuE;QACvE,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC;QACpB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,YAAY,GAAG,cAAc,CAAC;YAEpC,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAE,CAAC;YACrE,0FAA0F;YAC1F,IAAI,CAAC,MAAM,KAAK,EAAE,IAAI,MAAM,KAAK,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,EAAE,IAAI,OAAO,KAAK,EAAE,CAAC,EAAE,CAAC;gBACxE,SAAS;YACb,CAAC;YACD,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;YACnC,IAAI,UAAU,GAAG,UAAU,EAAE,CAAC;gBAC1B,UAAU,GAAG,UAAU,CAAC;YAC5B,CAAC;QACL,CAAC;QACD,IAAI,UAAU,IAAI,CAAC,EAAE,CAAC;YAClB,OAAO,EAAE,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,EAAE,CAAC;IACd,CAAC;CACJ"}

package/dist/esm/Utils.js

@@ -0,0 +1,15 @@
+// Copyright Epic Games, Inc. All Rights Reserved.
+import { jsonc } from 'jsonc';
+/**
+ * Cirular reference safe version of JSON.stringify
+ */
+export function stringify(obj) {
+    return jsonc.stringify(obj);
+}
+/**
+ * Circular reference save version of JSON.stringify with extra formatting.
+ */
+export function beautify(obj) {
+    return jsonc.stringify(obj, undefined, '\t');
+}
+//# sourceMappingURL=Utils.js.map

package/dist/esm/Utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../src/Utils.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAE9B;;GAEG;AACH,MAAM,UAAU,SAAS,CAAC,GAAQ;IAC9B,OAAO,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;AAChC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAQ;IAC7B,OAAO,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AACjD,CAAC"}

package/dist/esm/WebServer.js

@@ -0,0 +1,117 @@
+// Copyright Epic Games, Inc. All Rights Reserved.
+import express from 'express';
+import path from 'path';
+import fs from 'fs';
+import http from 'http';
+import https from 'https';
+import helmet from 'helmet';
+import cors from 'cors';
+import { Logger } from './Logger';
+import RateLimit from 'express-rate-limit';
+// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+const hsts = require('hsts');
+/**
+ * An object to manage the initialization of a web server. Used to serve the
+ * pixel streaming frontend.
+ */
+export class WebServer {
+    constructor(app, config) {
+        var _a;
+        Logger.debug('Starting WebServer with config: %s', config);
+        // only listen on the http port if we're not using https or if we want to redirect
+        if (!config.httpsPort || config.https_redirect) {
+            this.httpServer = http.createServer(app);
+            this.httpServer.listen(config.httpPort, () => {
+                Logger.info(`Http server listening on port ${config.httpPort}`);
+            });
+        }
+        /* eslint-disable @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access */
+        // if using https listen on the given ports and setup some details
+        if (config.httpsPort) {
+            const options = { key: config.ssl_key, cert: config.ssl_cert };
+            this.httpsServer = https.createServer(options, app);
+            this.httpsServer.listen(config.httpsPort, () => {
+                Logger.info(`Https server listening on port ${config.httpsPort}`);
+            });
+            app.use(helmet({
+                contentSecurityPolicy: {
+                    directives: {
+                        'connect-src': ['*', "'self'"]
+                    }
+                }
+            }));
+            app.use(hsts({
+                maxAge: 15552000 // 180 days in seconds
+            }));
+            // Setup http -> https redirect if requested
+            if (config.https_redirect) {
+                app.use((req, res, next) => {
+                    if (!req.secure) {
+                        if (req.get('Host')) {
+                            const hostAddressParts = req.get('Host').split(':');
+                            let hostAddress = hostAddressParts[0];
+                            if (config.httpsPort != 443) {
+                                hostAddress = `${hostAddress}:${config.httpsPort}`;
+                            }
+                            return res.redirect(['https://', hostAddress, req.originalUrl].join(''));
+                        }
+                        else {
+                            Logger.error(`Unable to get host name from header. Requestor ${req.ip}, url path: '${req.originalUrl}', available headers ${JSON.stringify(req.headers)}`);
+                            return res.status(400).send('Bad Request');
+                        }
+                    }
+                    next();
+                });
+            }
+        }
+        if ((_a = config.cors) === null || _a === void 0 ? void 0 : _a.enabled) {
+            const corsOptions = {};
+            if (config.cors.allowedOrigins && config.cors.allowedOrigins.length > 0) {
+                corsOptions.origin = config.cors.allowedOrigins;
+            }
+            if (config.cors.allowedMethods && config.cors.allowedMethods.length > 0) {
+                corsOptions.methods = config.cors.allowedMethods;
+            }
+            if (config.cors.allowedHeaders && config.cors.allowedHeaders.length > 0) {
+                corsOptions.allowedHeaders = config.cors.allowedHeaders;
+            }
+            if (config.cors.credentials) {
+                corsOptions.credentials = true;
+            }
+            // Register cors before the rate limiter so that preflight (OPTIONS)
+            // requests are answered with CORS headers even when an origin is
+            // close to the rate limit, and before any route handlers so the
+            // homepage, static files, and the REST API all respond uniformly.
+            app.use(cors(corsOptions));
+            Logger.info(`CORS enabled. Allowed origins: ${corsOptions.origin ? JSON.stringify(corsOptions.origin) : '*'}`);
+        }
+        const limiter = RateLimit({
+            windowMs: 60 * 1000, // 1 minute
+            max: config.perMinuteRateLimit ? config.perMinuteRateLimit : 3000
+        });
+        // apply rate limiter to all requests. Registered before any route
+        // handler so that static files, the homepage route, and any routes
+        // registered on `app` by downstream code are all subject to it.
+        app.use(limiter);
+        if (config.serveStatic) {
+            app.use(express.static(config.root));
+            // Request has been sent to site root, send the homepage file
+            app.get('/', function (req, res) {
+                // Try a few paths, see if any resolve to a homepage file the user has set
+                const p = path.resolve(path.join(config.root, config.homepageFile));
+                if (fs.existsSync(p)) {
+                    // Send the file for browser to display it
+                    res.sendFile(p);
+                    return;
+                }
+                // Catch file doesn't exist, and send back 404 if not
+                const error = 'Unable to locate file ' + config.homepageFile;
+                Logger.error(error);
+                res.status(404).send(error);
+                return;
+            });
+        }
+        /* eslint-enable @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access */
+    }
+}
+//# sourceMappingURL=WebServer.js.map

package/dist/esm/WebServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebServer.js","sourceRoot":"","sources":["../../src/WebServer.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAE3C,mEAAmE;AACnE,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAsE7B;;;GAGG;AACH,MAAM,OAAO,SAAS;IAIlB,YAAY,GAAoB,EAAE,MAAwB;;QACtD,MAAM,CAAC,KAAK,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;QAE3D,kFAAkF;QAClF,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;YAC7C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACzC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,EAAE;gBACzC,MAAM,CAAC,IAAI,CAAC,iCAAiC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;YACpE,CAAC,CAAC,CAAC;QACP,CAAC;QAED,iGAAiG;QAEjG,kEAAkE;QAClE,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,OAAO,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC/D,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACpD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,EAAE;gBAC3C,MAAM,CAAC,IAAI,CAAC,kCAAkC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;YACtE,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,GAAG,CACH,MAAM,CAAC;gBACH,qBAAqB,EAAE;oBACnB,UAAU,EAAE;wBACR,aAAa,EAAE,CAAC,GAAG,EAAE,QAAQ,CAAC;qBACjC;iBACJ;aACJ,CAAC,CACL,CAAC;YAEF,GAAG,CAAC,GAAG,CACH,IAAI,CAAC;gBACD,MAAM,EAAE,QAAQ,CAAC,sBAAsB;aAC1C,CAAC,CACL,CAAC;YAEF,4CAA4C;YAC5C,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;gBACxB,GAAG,CAAC,GAAG,CAAC,CAAC,GAAQ,EAAE,GAAQ,EAAE,IAAS,EAAE,EAAE;oBACtC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;wBACd,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;4BAClB,MAAM,gBAAgB,GAAa,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAa,CAAC;4BAC1E,IAAI,WAAW,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;4BACtC,IAAI,MAAM,CAAC,SAAS,IAAI,GAAG,EAAE,CAAC;gCAC1B,WAAW,GAAG,GAAG,WAAW,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;4BACvD,CAAC;4BAED,OAAO,GAAG,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;wBAC7E,CAAC;6BAAM,CAAC;4BACJ,MAAM,CAAC,KAAK,CACR,kDAAkD,GAAG,CAAC,EAAE,gBAAgB,GAAG,CAAC,WAAW,wBAAwB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAC/I,CAAC;4BAEF,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;wBAC/C,CAAC;oBACL,CAAC;oBACD,IAAI,EAAE,CAAC;gBACX,CAAC,CAAC,CAAC;YACP,CAAC;QACL,CAAC;QAED,IAAI,MAAA,MAAM,CAAC,IAAI,0CAAE,OAAO,EAAE,CAAC;YACvB,MAAM,WAAW,GAAqB,EAAE,CAAC;YAEzC,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACtE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;YACpD,CAAC;YACD,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACtE,WAAW,CAAC,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;YACrD,CAAC;YACD,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACtE,WAAW,CAAC,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;YAC5D,CAAC;YACD,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;gBAC1B,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;YACnC,CAAC;YAED,oEAAoE;YACpE,iEAAiE;YACjE,gEAAgE;YAChE,kEAAkE;YAClE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;YAE3B,MAAM,CAAC,IAAI,CACP,kCAAkC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CACpG,CAAC;QACN,CAAC;QAED,MAAM,OAAO,GAAG,SAAS,CAAC;YACtB,QAAQ,EAAE,EAAE,GAAG,IAAI,EAAE,WAAW;YAChC,GAAG,EAAE,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI;SACpE,CAAC,CAAC;QAEH,kEAAkE;QAClE,mEAAmE;QACnE,gEAAgE;QAChE,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAEjB,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACrB,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAErC,6DAA6D;YAC7D,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,GAAQ,EAAE,GAAQ;gBACrC,0EAA0E;gBAC1E,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;gBACpE,IAAI,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;oBACnB,0CAA0C;oBAC1C,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,qDAAqD;gBACrD,MAAM,KAAK,GAAG,wBAAwB,GAAG,MAAM,CAAC,YAAY,CAAC;gBAC7D,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACpB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC5B,OAAO;YACX,CAAC,CAAC,CAAC;QACP,CAAC;QAED,gGAAgG;IACpG,CAAC;CACJ"}

package/dist/esm/pixelstreamingsignalling.js

@@ -0,0 +1,12 @@
+// Copyright Epic Games, Inc. All Rights Reserved.
+export * from './Logger';
+export * from './LoggingUtils';
+export * from './PlayerConnection';
+export * from './PlayerRegistry';
+export * from './SFUConnection';
+export * from './SignallingServer';
+export * from './StreamerConnection';
+export * from './StreamerRegistry';
+export * from './WebServer';
+// keep Utils internal for now
+//# sourceMappingURL=pixelstreamingsignalling.js.map

package/dist/esm/pixelstreamingsignalling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pixelstreamingsignalling.js","sourceRoot":"","sources":["../../src/pixelstreamingsignalling.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,8BAA8B"}

package/dist/types/Logger.d.ts

@@ -0,0 +1,20 @@
+import winston from 'winston';
+import 'winston-daily-rotate-file';
+/**
+ * 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.
+ */
+export declare let Logger: winston.Logger;
+export interface IConfig {
+    logDir?: string;
+    logMessagesToConsole?: string;
+    logLevelConsole?: string;
+    logLevelFile?: string;
+}
+/**
+ * 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
+ */
+export declare function InitLogging(config: IConfig): void;

package/dist/types/LoggingUtils.d.ts

@@ -0,0 +1,44 @@
+import { BaseMessage } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.8';
+export interface IProtoLogObj {
+    event: string;
+    direction: string;
+    sender?: string;
+    receiver?: string;
+    target?: string;
+    protoMessage: BaseMessage;
+}
+/**
+ * Most methods in here rely on connections implementing this interface so we can identify
+ * who is sending or receiving etc.
+ */
+export interface IMessageLogger {
+    getReadableIdentifier(): string;
+}
+/**
+ * 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.
+ */
+export declare function logIncoming(recvr: IMessageLogger, message: BaseMessage): void;
+/**
+ * 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.
+ */
+export declare function logOutgoing(sender: IMessageLogger, message: BaseMessage): void;
+/**
+ * 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.
+ */
+export declare function logForward(recvr: IMessageLogger, target: IMessageLogger, message: BaseMessage): void;
+/**
+ * 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.
+ */
+export declare function createHandlerListener(obj: IMessageLogger, handler: (message: any) => void): (message: BaseMessage) => void;

package/dist/types/PlayerConnection.d.ts

@@ -0,0 +1,66 @@
+import type { IncomingMessage } from 'http';
+import WebSocket from 'ws';
+import { ITransport, SignallingProtocol, BaseMessage } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.8';
+import { IPlayer, IPlayerInfo } from './PlayerRegistry';
+import { IStreamer } from './StreamerRegistry';
+import * as LogUtils from './LoggingUtils';
+import { SignallingServer } from './SignallingServer';
+/**
+ * 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.
+ */
+export declare class PlayerConnection implements IPlayer, LogUtils.IMessageLogger {
+    playerId: string;
+    transport: ITransport;
+    protocol: SignallingProtocol;
+    subscribedStreamer: IStreamer | null;
+    remoteAddress?: string;
+    request?: IncomingMessage;
+    private server;
+    private streamerIdChangeListener;
+    private streamerDisconnectedListener;
+    /**
+     * 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: SignallingServer, ws: WebSocket, remoteAddress?: string, request?: IncomingMessage);
+    /**
+     * Returns an identifier that is displayed in logs.
+     * @returns A string describing this connection.
+     */
+    getReadableIdentifier(): string;
+    /**
+     * Sends a signalling message to the player.
+     * @param message - The message to send.
+     */
+    sendMessage(message: BaseMessage): void;
+    /**
+     * Returns a descriptive object for the REST API inspection operations.
+     * @returns An IPlayerInfo object containing viewable information about this connection.
+     */
+    getPlayerInfo(): IPlayerInfo;
+    private registerMessageHandlers;
+    private sendToStreamer;
+    private subscribe;
+    private unsubscribe;
+    private disconnect;
+    private onStreamerDisconnected;
+    private onTransportError;
+    private onTransportClose;
+    private onSubscribeMessage;
+    private onUnsubscribeMessage;
+    private onListStreamers;
+    private onStreamerIdChanged;
+    private onPingMessage;
+}