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

package/dist/cjs/StreamerRegistry.js

@@ -0,0 +1,149 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamerRegistry = void 0;
+// Copyright Epic Games, Inc. All Rights Reserved.
+const lib_pixelstreamingcommon_ue5_8_1 = require("@epicgames-ps/lib-pixelstreamingcommon-ue5.8");
+const Logger_1 = require("./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.
+ */
+class StreamerRegistry extends lib_pixelstreamingcommon_ue5_8_1.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_1.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(lib_pixelstreamingcommon_ue5_8_1.Messages.endpointId.typeName, this.onEndpointId.bind(this, streamer));
+        streamer.sendMessage(lib_pixelstreamingcommon_ue5_8_1.MessageHelpers.createMessage(lib_pixelstreamingcommon_ue5_8_1.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_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_1.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_1.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_1.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(lib_pixelstreamingcommon_ue5_8_1.MessageHelpers.createMessage(lib_pixelstreamingcommon_ue5_8_1.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;
+    }
+}
+exports.StreamerRegistry = StreamerRegistry;
+//# sourceMappingURL=StreamerRegistry.js.map

package/dist/cjs/StreamerRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StreamerRegistry.js","sourceRoot":"","sources":["../../src/StreamerRegistry.ts"],"names":[],"mappings":";;;AAAA,kDAAkD;AAClD,iGAOsD;AAEtD,qCAAkC;AA+DlC;;;;;;;GAOG;AACH,MAAa,gBAAiB,SAAQ,6CAAY;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,eAAM,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,yCAAQ,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,yCAAQ,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,eAAM,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,eAAM,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,eAAM,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,eAAM,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,yCAAQ,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;AA1KD,4CA0KC"}

package/dist/cjs/Utils.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringify = stringify;
+exports.beautify = beautify;
+// Copyright Epic Games, Inc. All Rights Reserved.
+const jsonc_1 = require("jsonc");
+/**
+ * Cirular reference safe version of JSON.stringify
+ */
+function stringify(obj) {
+    return jsonc_1.jsonc.stringify(obj);
+}
+/**
+ * Circular reference save version of JSON.stringify with extra formatting.
+ */
+function beautify(obj) {
+    return jsonc_1.jsonc.stringify(obj, undefined, '\t');
+}
+//# sourceMappingURL=Utils.js.map

package/dist/cjs/Utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../src/Utils.ts"],"names":[],"mappings":";;AAMA,8BAEC;AAKD,4BAEC;AAfD,kDAAkD;AAClD,iCAA8B;AAE9B;;GAEG;AACH,SAAgB,SAAS,CAAC,GAAQ;IAC9B,OAAO,aAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;AAChC,CAAC;AAED;;GAEG;AACH,SAAgB,QAAQ,CAAC,GAAQ;IAC7B,OAAO,aAAK,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AACjD,CAAC"}

package/dist/cjs/WebServer.js

@@ -0,0 +1,124 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebServer = void 0;
+// Copyright Epic Games, Inc. All Rights Reserved.
+const express_1 = __importDefault(require("express"));
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const http_1 = __importDefault(require("http"));
+const https_1 = __importDefault(require("https"));
+const helmet_1 = __importDefault(require("helmet"));
+const cors_1 = __importDefault(require("cors"));
+const Logger_1 = require("./Logger");
+const express_rate_limit_1 = __importDefault(require("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.
+ */
+class WebServer {
+    constructor(app, config) {
+        var _a;
+        Logger_1.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_1.default.createServer(app);
+            this.httpServer.listen(config.httpPort, () => {
+                Logger_1.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_1.default.createServer(options, app);
+            this.httpsServer.listen(config.httpsPort, () => {
+                Logger_1.Logger.info(`Https server listening on port ${config.httpsPort}`);
+            });
+            app.use((0, helmet_1.default)({
+                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_1.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((0, cors_1.default)(corsOptions));
+            Logger_1.Logger.info(`CORS enabled. Allowed origins: ${corsOptions.origin ? JSON.stringify(corsOptions.origin) : '*'}`);
+        }
+        const limiter = (0, express_rate_limit_1.default)({
+            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_1.default.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_1.default.resolve(path_1.default.join(config.root, config.homepageFile));
+                if (fs_1.default.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_1.Logger.error(error);
+                res.status(404).send(error);
+                return;
+            });
+        }
+        /* eslint-enable @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access */
+    }
+}
+exports.WebServer = WebServer;
+//# sourceMappingURL=WebServer.js.map

package/dist/cjs/WebServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebServer.js","sourceRoot":"","sources":["../../src/WebServer.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAkD;AAClD,sDAA8B;AAC9B,gDAAwB;AACxB,4CAAoB;AACpB,gDAAwB;AACxB,kDAA0B;AAC1B,oDAA4B;AAC5B,gDAAwB;AACxB,qCAAkC;AAClC,4EAA2C;AAE3C,mEAAmE;AACnE,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAsE7B;;;GAGG;AACH,MAAa,SAAS;IAIlB,YAAY,GAAoB,EAAE,MAAwB;;QACtD,eAAM,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,cAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACzC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,EAAE;gBACzC,eAAM,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,eAAK,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACpD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,EAAE;gBAC3C,eAAM,CAAC,IAAI,CAAC,kCAAkC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;YACtE,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,GAAG,CACH,IAAA,gBAAM,EAAC;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,eAAM,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,IAAA,cAAI,EAAC,WAAW,CAAC,CAAC,CAAC;YAE3B,eAAM,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,IAAA,4BAAS,EAAC;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,iBAAO,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,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;gBACpE,IAAI,YAAE,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,eAAM,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;AA9HD,8BA8HC"}

package/dist/cjs/pixelstreamingsignalling.js

@@ -0,0 +1,28 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Copyright Epic Games, Inc. All Rights Reserved.
+__exportStar(require("./Logger"), exports);
+__exportStar(require("./LoggingUtils"), exports);
+__exportStar(require("./PlayerConnection"), exports);
+__exportStar(require("./PlayerRegistry"), exports);
+__exportStar(require("./SFUConnection"), exports);
+__exportStar(require("./SignallingServer"), exports);
+__exportStar(require("./StreamerConnection"), exports);
+__exportStar(require("./StreamerRegistry"), exports);
+__exportStar(require("./WebServer"), exports);
+// keep Utils internal for now
+//# sourceMappingURL=pixelstreamingsignalling.js.map

package/dist/cjs/pixelstreamingsignalling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pixelstreamingsignalling.js","sourceRoot":"","sources":["../../src/pixelstreamingsignalling.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAkD;AAClD,2CAAyB;AACzB,iDAA+B;AAC/B,qDAAmC;AACnC,mDAAiC;AACjC,kDAAgC;AAChC,qDAAmC;AACnC,uDAAqC;AACrC,qDAAmC;AACnC,8CAA4B;AAC5B,8BAA8B"}

package/dist/esm/Logger.js

@@ -0,0 +1,141 @@
+// Copyright Epic Games, Inc. All Rights Reserved.
+import { stringify, beautify } from './Utils';
+import path from 'path';
+import winston from 'winston';
+import 'winston-daily-rotate-file';
+import { overrideLogger } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.8';
+const { combine, timestamp, printf, colorize, splat } = winston.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.
+ */
+export let 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
+ */
+export function InitLogging(config) {
+    const logDir = config.logDir || 'logs';
+    const logLevelConsole = config.logLevelConsole || 'info';
+    const logLevelFile = config.logLevelFile || 'info';
+    logMessagesToConsole = config.logMessagesToConsole || 'none';
+    Logger = winston.createLogger({
+        transports: [createConsoleTransport(logLevelConsole), createFileTransport(logDir, logLevelFile)]
+    });
+    const commonLogger = new CommonLogger(Logger);
+    overrideLogger(commonLogger);
+}
+let logMessagesToConsole = 'none';
+function createDefaultLogger() {
+    return winston.createLogger({
+        level: 'info',
+        format: winston.format.cli(),
+        transports: [new winston.transports.Console()]
+    });
+}
+function createConsoleTransport(logLevel) {
+    return new winston.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 stringify(message);
+        case 'formatted':
+            return beautify(message);
+        default:
+            return `[${message.type}]`;
+    }
+}
+function createProtoMessageFilter() {
+    return winston.format((info, _opts) => {
+        if (typeof info.message !== 'string' && isLogObject(info.message) && logMessagesToConsole == 'none') {
+            return false;
+        }
+        return info;
+    });
+}
+function createFileTransport(logDirPath, logLevel) {
+    return new winston.transports.DailyRotateFile({
+        level: logLevel,
+        filename: path.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/esm/Logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logger.js","sourceRoot":"","sources":["../../src/Logger.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE9C,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,2BAA2B,CAAC;AAEnC,OAAO,EAAwB,cAAc,EAAE,MAAM,8CAA8C,CAAC;AAEpG,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;AAIvE;;;;GAIG;AACH,MAAM,CAAC,IAAI,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,MAAM,UAAU,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,MAAM,GAAG,OAAO,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,MAAM,CAAC,CAAC;IAC9C,cAAc,CAAC,YAAY,CAAC,CAAC;AACjC,CAAC;AAED,IAAI,oBAAoB,GAAG,MAAM,CAAC;AAElC,SAAS,mBAAmB;IACxB,OAAO,OAAO,CAAC,YAAY,CAAC;QACxB,KAAK,EAAE,MAAM;QACb,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE;QAC5B,UAAU,EAAE,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;KACjD,CAAC,CAAC;AACP,CAAC;AAED,SAAS,sBAAsB,CAAC,QAAgB;IAC5C,OAAO,IAAI,OAAO,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,SAAS,CAAC,OAAO,CAAC,CAAC;QAC9B,KAAK,WAAW;YACZ,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC7B;YACI,OAAO,IAAI,OAAO,CAAC,IAAI,GAAG,CAAC;IACnC,CAAC;AACL,CAAC;AAED,SAAS,wBAAwB;IAC7B,OAAO,OAAO,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,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC;QAC1C,KAAK,EAAE,QAAQ;QACf,QAAQ,EAAE,IAAI,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/esm/LoggingUtils.js

@@ -0,0 +1,58 @@
+import { Logger } from './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.
+ */
+export function logIncoming(recvr, message) {
+    const logObj = {
+        event: 'proto_message',
+        direction: 'incoming',
+        receiver: recvr.getReadableIdentifier(),
+        protoMessage: message
+    };
+    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.
+ */
+export function logOutgoing(sender, message) {
+    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.
+ */
+export function logForward(recvr, target, message) {
+    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.
+ */
+export function createHandlerListener(obj, handler) {
+    return (message) => {
+        logIncoming(obj, message);
+        handler.bind(obj)(message);
+    };
+}
+//# sourceMappingURL=LoggingUtils.js.map

package/dist/esm/LoggingUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LoggingUtils.js","sourceRoot":"","sources":["../../src/LoggingUtils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAmBlC;;;;GAIG;AACH,MAAM,UAAU,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,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACxB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,MAAsB,EAAE,OAAoB;IACpE,MAAM,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,MAAM,UAAU,UAAU,CAAC,KAAqB,EAAE,MAAsB,EAAE,OAAoB;IAC1F,MAAM,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,MAAM,UAAU,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"}