@arcware-cloud/pixelstreaming-websdk 1.3.13 → 1.3.16

package/README.md

@@ -80,6 +80,11 @@ For more detailed examples and advanced usage, please refer to our documentation
 
 # Changelog
 
+### 1.3.16
+
+- added white labeling options for loader icon and screen
+- options can be loaded via base64 encoded string in URL, fetched via API (configured on platform) or set as properties on the SDK
+
 ### 1.3.12
 
 - added orientationZoom field for managing zoom

package/index.cjs.js

@@ -23353,11 +23353,14 @@ exports.ArcwareApplication = ArcwareApplication;
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.ArcwareConfig = exports.DefaultUrl = void 0;
+const tslib_1 = __webpack_require__(655);
 const zod_1 = __webpack_require__(8754);
 const lib_pixelstreamingfrontend_ue5_5_1 = __webpack_require__(693);
 const Session_1 = __webpack_require__(2469);
 const ArcwareSettingsSchema_1 = __webpack_require__(5602);
 const whiteLabelling_1 = __webpack_require__(3545);
+const ZWhiteLabel_1 = __webpack_require__(467);
+const EventHandler_1 = __webpack_require__(3379);
 /** Default arcware signalling endpoint. */
 exports.DefaultUrl = `wss://signalling-client.ragnarok.arcware.cloud`;
 // The below Logger overrides can likely be removed as PSInfra 5.5 logger supports setting log verbosity
@@ -23373,6 +23376,14 @@ Logger.Error = (message: string) => {
   console.error(message);
 };*/
 lib_pixelstreamingfrontend_ue5_5_1.Logger.InitLogging(2, false);
+function deepEqual(a, b) {
+    try {
+        return JSON.stringify(a) === JSON.stringify(b);
+    }
+    catch (_a) {
+        return false;
+    }
+}
 class ArcwareConfig extends lib_pixelstreamingfrontend_ue5_5_1.Config {
     /**
      * Can be used to fetch projectId and shareId from the current url.
@@ -23421,7 +23432,13 @@ class ArcwareConfig extends lib_pixelstreamingfrontend_ue5_5_1.Config {
         if (!config.initialSettings.ss)
             config.initialSettings.ss = exports.DefaultUrl;
         super(config);
-        this.VERSION = "1.3.13";
+        this.VERSION = "1.3.16";
+        this.whiteLabellingChanged = new EventHandler_1.EventHandler();
+        this.signallingWlURL = "https://signalling-client.arcware.cloud/whiteLabel/";
+        console.log(config);
+        if (config.envName) {
+            this.signallingWlURL = `https://signalling-client.${config.envName}.arcware.cloud/whiteLabel/`;
+        }
         this.settings = settings;
         this.session = new Session_1.Session();
         this._initialSettings = config.initialSettings;
@@ -23433,14 +23450,66 @@ class ArcwareConfig extends lib_pixelstreamingfrontend_ue5_5_1.Config {
         if (this.useUrlParams) {
             // Get the query string from URL
             const qs = new URLSearchParams(window.location.search);
-            // Retrieve image loading from there
-            const wlParsed = this.useUrlParams ? (0, whiteLabelling_1.readWhiteLabelFromQuery)(qs) : undefined; // respect useUrlParams
-            if (wlParsed) {
-                this.settings.whiteLabelling = Object.assign(Object.assign({}, ((_c = this.settings.whiteLabelling) !== null && _c !== void 0 ? _c : {})), wlParsed);
+            if (qs.has("wl") && qs.get("wl") !== "") {
+                // Retrieve image loading from there
+                const wlParsed = this.useUrlParams ? (0, whiteLabelling_1.readWhiteLabelFromQuery)(qs) : undefined; // respect useUrlParams
+                if (wlParsed) {
+                    this.settings.whiteLabelling = Object.assign(Object.assign({}, ((_c = this.settings.whiteLabelling) !== null && _c !== void 0 ? _c : {})), wlParsed);
+                }
             }
             this.settings.infoButton = qs.has("i") || qs.has("info");
         }
     }
+    getWhiteLabelling(ShareId) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const qs = new URLSearchParams(window.location.search);
+            // Only fetch when wl param is present and empty (as before)
+            if (!(qs.has("wl") && qs.get("wl") === ""))
+                return undefined;
+            // Build final URL safely (trim trailing slashes, encode ShareId)
+            const base = this.signallingWlURL.replace(/\/+$/, "");
+            const requestUrl = `${base}/${encodeURIComponent(ShareId)}`;
+            const controller = new AbortController();
+            const timeoutId = setTimeout(() => controller.abort(), 1000);
+            try {
+                const res = yield fetch(requestUrl, {
+                    method: "GET",
+                    signal: controller.signal,
+                    headers: { Accept: "application/json, text/plain" },
+                    credentials: "omit"
+                });
+                if (!res.ok)
+                    return undefined;
+                const text = yield res.text();
+                if (!text || text.trim() === "")
+                    return undefined;
+                let json;
+                try {
+                    json = JSON.parse(text);
+                }
+                catch (_a) {
+                    return undefined;
+                }
+                const parsed = ZWhiteLabel_1.ZWhiteLabel.safeParse(json);
+                if (!parsed.success)
+                    return undefined;
+                // Only apply & emit if it actually changed
+                const prev = this.settings.whiteLabelling;
+                const next = parsed.data;
+                if (!deepEqual(prev, next)) {
+                    this.settings.whiteLabelling = next;
+                    EventHandler_1.EventHandler.Emit(this.whiteLabellingChanged, next);
+                }
+                return parsed.data;
+            }
+            catch (_b) {
+                return undefined;
+            }
+            finally {
+                clearTimeout(timeoutId);
+            }
+        });
+    }
     /** Setup connection string. */
     get urlFlags() {
         var _a;
@@ -23515,6 +23584,7 @@ let globalApplication = null;
 let previousShareId = null;
 let previousProjectId = null;
 function ArcwareInit({ shareId, projectId }, configuration, forceRefresh = false) {
+    var _a;
     if (shareId && !shareId.startsWith("share-"))
         throw new Error(`Unexpected shareId-format: '${shareId}'.`);
     if (shareId && previousShareId !== shareId) {
@@ -23554,7 +23624,8 @@ function ArcwareInit({ shareId, projectId }, configuration, forceRefresh = false
                 splashScreenMode: undefined,
                 splashScreenPosition: undefined,
                 splashScreenBgColor: undefined
-            } }, configuration === null || configuration === void 0 ? void 0 : configuration.settings)
+            } }, configuration === null || configuration === void 0 ? void 0 : configuration.settings),
+        envName: (_a = configuration === null || configuration === void 0 ? void 0 : configuration.envName) !== null && _a !== void 0 ? _a : undefined
     });
     const PixelStreaming = new ArcwarePixelStreaming_1.ArcwarePixelStreaming(Config);
     const Application = new ArcwareApplication_1.ArcwareApplication({ stream: PixelStreaming });
@@ -23722,6 +23793,32 @@ class ArcwarePixelStreaming extends lib_pixelstreamingfrontend_ue5_5_1.PixelStre
         });
         // Set override config.
         this.config = config;
+        // Re-apply branding whenever config's WL changes
+        this.config.whiteLabellingChanged.add(() => {
+            try {
+                this.applyBrandingFromSettings();
+            }
+            catch (_a) { }
+        });
+        // Kick off WL fetch once (if we have a shareId); on success it will emit and re-apply
+        (() => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            try {
+                const sid = this.config.settings.shareId;
+                if (sid) {
+                    yield this.config.getWhiteLabelling(sid); // will emit if it changes
+                }
+            }
+            catch (_d) {
+                // ignore
+            }
+            finally {
+                // Make sure we paint with whatever we have initially
+                try {
+                    this.applyBrandingFromSettings();
+                }
+                catch (_e) { }
+            }
+        }))();
         this.loveLettersList = [];
         this.microphoneOverlay = new MicrophoneOverlay_1.MicrophoneOverlay(this);
         this.diagnosticsCollector = new DiagnosticsCollector_1.DiagnosticsCollector({
@@ -23903,7 +24000,7 @@ class ArcwarePixelStreaming extends lib_pixelstreamingfrontend_ue5_5_1.PixelStre
                 });
             }
         }
-        this.applyBrandingFromSettings();
+        //this.applyBrandingFromSettings();
         this.handleMouseLock();
         this.injectCustomUI();
     }
@@ -24245,8 +24342,6 @@ class ArcwarePixelStreaming extends lib_pixelstreamingfrontend_ue5_5_1.PixelStre
             (_a = logoLoader.setHostElement) === null || _a === void 0 ? void 0 : _a.call(logoLoader, loaderRoot);
             loveLettersContainer.appendChild(lettersBlock);
             lettersBlock.appendChild(lettersWrapper);
-            // apply current (local) settings immediately
-            this.applyBrandingFromSettings();
         }
     }
     pushLetter(letter) {
@@ -24361,7 +24456,7 @@ class ArcwarePixelStreaming extends lib_pixelstreamingfrontend_ue5_5_1.PixelStre
         });
     }
     applyBrandingFromSettings() {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
         const cfg = ((_b = (_a = this === null || this === void 0 ? void 0 : this.config) === null || _a === void 0 ? void 0 : _a.settings.whiteLabelling) !== null && _b !== void 0 ? _b : {});
         // Loader image + fade
         try {
@@ -24370,25 +24465,36 @@ class ArcwarePixelStreaming extends lib_pixelstreamingfrontend_ue5_5_1.PixelStre
                 (_f = (_e = this.logoLoader).setFade) === null || _f === void 0 ? void 0 : _f.call(_e, cfg.loadingIconFadeMs);
             }
         }
-        catch (_p) { }
-        // Splash on loveLettersContainer (preferred), fallback to player parent
+        catch (_q) { }
+        // Pick splash host: loveLettersContainer (preferred) or player parent
         try {
             const el = (_m = (_g = this.loveLettersContainer) !== null && _g !== void 0 ? _g : (_l = (_k = (_j = (_h = this.webRtcController) === null || _h === void 0 ? void 0 : _h.videoPlayer) === null || _j === void 0 ? void 0 : _j.getVideoParentElement) === null || _k === void 0 ? void 0 : _k.call(_j)) === null || _l === void 0 ? void 0 : _l.parentElement) !== null && _m !== void 0 ? _m : null;
             if (!el)
                 return;
-            // Clear previous inline choices
             const s = el.style;
+            // Nuke previous inline styles (longhands only; never touch 'background' shorthand here)
             s.removeProperty("background-image");
             s.removeProperty("background-size");
             s.removeProperty("background-repeat");
             s.removeProperty("background-position");
             s.removeProperty("background-color");
+            // Also clear any earlier 'background' inline shorthand that might have been set elsewhere
+            // (we set to 'initial' first, then re-apply longhands)
+            s.setProperty("background", "initial");
             el.classList.remove("aw-splash");
-            if (cfg.splashScreenUrl) {
-                el.classList.add("aw-splash"); // keeps your global defaults
-                // Compute mode (default to 'contain' if not provided)
-                const mode = ((_o = cfg.splashScreenMode) !== null && _o !== void 0 ? _o : "contain");
-                // Apply sizing/repeat per mode
+            // If neither color nor image is provided, nothing to do
+            const haveColor = !!cfg.splashScreenBgColor;
+            const haveImage = !!cfg.splashScreenUrl;
+            if (!haveColor && !haveImage)
+                return;
+            // Always ensure our class is present when we brand
+            el.classList.add("aw-splash");
+            // Apply color with !important so external 'background: ... !important' can't wipe it
+            const bgColor = (_o = cfg.splashScreenBgColor) !== null && _o !== void 0 ? _o : "var(--color0)";
+            s.setProperty("background-color", bgColor, "important");
+            if (haveImage) {
+                // Mode → size/repeat mapping
+                const mode = ((_p = cfg.splashScreenMode) !== null && _p !== void 0 ? _p : "contain");
                 switch (mode) {
                     case "contain":
                         s.backgroundSize = "contain";
@@ -24403,17 +24509,25 @@ class ArcwarePixelStreaming extends lib_pixelstreamingfrontend_ue5_5_1.PixelStre
                         s.backgroundRepeat = "no-repeat";
                         break;
                     case "repeat":
-                        s.backgroundSize = "auto"; // keep intrinsic px
+                        s.backgroundSize = "auto"; // intrinsic
                         s.backgroundRepeat = "repeat";
                         break;
                 }
-                // Position & color (optional)
+                // Position
                 s.backgroundPosition = cfg.splashScreenPosition || "center center";
-                s.backgroundColor = cfg.splashScreenBgColor || "var(--color0)";
+                // Image last (longhand so it won't reset color)
+                // Use quotes to be safe with URLs containing parentheses/spaces
                 s.backgroundImage = `url("${cfg.splashScreenUrl}")`;
             }
+            else {
+                // No image → ensure any previous image is cleared
+                s.backgroundImage = "none";
+                s.backgroundRepeat = "no-repeat";
+                s.backgroundPosition = "center center";
+                s.backgroundSize = "auto";
+            }
         }
-        catch (_q) { }
+        catch (_r) { }
     }
 }
 exports.ArcwarePixelStreaming = ArcwarePixelStreaming;
@@ -24429,6 +24543,7 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.ArcwareSettingsSchema = void 0;
 const zod_1 = __webpack_require__(8754);
 const shared_pixelstreaming_websdk_1 = __webpack_require__(7910);
+const ZWhiteLabel_1 = __webpack_require__(467);
 /** Arcware Settings. */
 exports.ArcwareSettingsSchema = zod_1.z.object({
     /** Overwrites the Session-Tool and uses the provided session instead. */
@@ -24487,7 +24602,7 @@ exports.ArcwareSettingsSchema = zod_1.z.object({
         .strict()
         .optional(),
     /** Loader customization */
-    whiteLabelling: shared_pixelstreaming_websdk_1.ZWhiteLabel.optional()
+    whiteLabelling: ZWhiteLabel_1.ZWhiteLabel.optional()
 });
 
 
@@ -25278,6 +25393,40 @@ class DiagnosticsCollector {
 exports.DiagnosticsCollector = DiagnosticsCollector;
 
 
+/***/ }),
+
+/***/ 467:
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.ZWhiteLabel = void 0;
+const zod_1 = __webpack_require__(8754);
+/** Absolute HTTPS URL (no http) */
+const AbsoluteHttpsUrl = zod_1.z
+    .string()
+    .url()
+    .refine((u) => u.startsWith("https://"), { message: "URL must use https://" });
+/** Relative path (no scheme like http:, data:, javascript:, etc.) */
+const RelativePath = zod_1.z
+    .string()
+    .min(1)
+    .refine((s) => !/^[a-zA-Z][a-zA-Z0-9+.-]*:/.test(s), { message: "Expected a relative path without a URL scheme" });
+/** Image URL can be absolute (https) or relative (e.g. /assets/logo.png, ./img.png) */
+const ImageUrl = zod_1.z.union([AbsoluteHttpsUrl, RelativePath]);
+/** Strict allowlist for white-label brand fields coming from the URL */
+exports.ZWhiteLabel = zod_1.z
+    .object({
+    loadingIconUrl: ImageUrl.optional(),
+    loadingIconFadeMs: zod_1.z.number().int().positive().optional(),
+    splashScreenUrl: ImageUrl.optional(),
+    splashScreenMode: zod_1.z.enum(["contain", "cover", "stretch", "repeat"]).optional(),
+    splashScreenPosition: zod_1.z.string().optional(),
+    splashScreenBgColor: zod_1.z.string().optional()
+})
+    .strict();
+
+
 /***/ }),
 
 /***/ 2483:
@@ -25414,7 +25563,7 @@ exports.waitForElement = waitForElement;
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.readWhiteLabelFromQuery = void 0;
-const shared_pixelstreaming_websdk_1 = __webpack_require__(7910);
+const ZWhiteLabel_1 = __webpack_require__(467);
 function decodeBase64OrBase64Url(raw) {
     const normalized = raw.replace(/-/g, "+").replace(/_/g, "/");
     const padded = normalized + "===".slice((normalized.length + 3) % 4);
@@ -25425,14 +25574,13 @@ function decodeBase64OrBase64Url(raw) {
 }
 /** Parse ?wl=... (or ?whitelabel=...) → validated partial settings */
 function readWhiteLabelFromQuery(qs) {
-    var _a;
     try {
-        const raw = (_a = qs.get("wl")) !== null && _a !== void 0 ? _a : qs.get("whitelabel");
+        const raw = qs.get("wl");
         if (!raw)
             return undefined;
         const jsonStr = decodeBase64OrBase64Url(raw);
         const obj = JSON.parse(jsonStr);
-        const parsed = shared_pixelstreaming_websdk_1.ZWhiteLabel.safeParse(obj);
+        const parsed = ZWhiteLabel_1.ZWhiteLabel.safeParse(obj);
         if (!parsed.success) {
             //console.warn("[ArcwareConfig] Invalid wl payload:", parsed.error?.flatten?.());
             return undefined;
@@ -27146,40 +27294,6 @@ exports.Send = {
 };
 
 
-/***/ }),
-
-/***/ 6750:
-/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
-
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.ZWhiteLabel = void 0;
-const zod_1 = __webpack_require__(8754);
-/** Absolute HTTPS URL (no http) */
-const AbsoluteHttpsUrl = zod_1.z
-    .string()
-    .url()
-    .refine((u) => u.startsWith("https://"), { message: "URL must use https://" });
-/** Relative path (no scheme like http:, data:, javascript:, etc.) */
-const RelativePath = zod_1.z
-    .string()
-    .min(1)
-    .refine((s) => !/^[a-zA-Z][a-zA-Z0-9+.-]*:/.test(s), { message: "Expected a relative path without a URL scheme" });
-/** Image URL can be absolute (https) or relative (e.g. /assets/logo.png, ./img.png) */
-const ImageUrl = zod_1.z.union([AbsoluteHttpsUrl, RelativePath]);
-/** Strict allowlist for white-label brand fields coming from the URL */
-exports.ZWhiteLabel = zod_1.z
-    .object({
-    loadingIconUrl: ImageUrl.optional(),
-    loadingIconFadeMs: zod_1.z.number().int().positive().optional(),
-    splashScreenUrl: ImageUrl.optional(),
-    splashScreenMode: zod_1.z.enum(["contain", "cover", "stretch", "repeat"]).optional(),
-    splashScreenPosition: zod_1.z.string().optional(),
-    splashScreenBgColor: zod_1.z.string().optional()
-})
-    .strict();
-
-
 /***/ }),
 
 /***/ 318:
@@ -27187,10 +27301,8 @@ exports.ZWhiteLabel = zod_1.z
 
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.ZWhiteLabel = exports.Messages = void 0;
+exports.Messages = void 0;
 exports.Messages = __webpack_require__(5387);
-var ZWhiteLabel_1 = __webpack_require__(6750);
-Object.defineProperty(exports, "ZWhiteLabel", ({ enumerable: true, get: function () { return ZWhiteLabel_1.ZWhiteLabel; } }));
 
 
 /***/ }),