@arcware-cloud/pixelstreaming-websdk 1.3.15 → 1.3.18

package/README.md

@@ -80,9 +80,14 @@ For more detailed examples and advanced usage, please refer to our documentation
 
 # Changelog
 
-### 1.3.14
+### 1.3.17
+
+- added support for videos in white labelling
+
+### 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
 

package/index.cjs.js

@@ -23360,6 +23360,7 @@ 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
@@ -23375,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.
@@ -23423,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.15";
+        this.VERSION = "1.3.18";
+        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;
@@ -23445,58 +23460,54 @@ class ArcwareConfig extends lib_pixelstreamingfrontend_ue5_5_1.Config {
             this.settings.infoButton = qs.has("i") || qs.has("info");
         }
     }
-    static getWhiteLabelling(ShareId, URL = "https://signalling-client.arcware.cloud/whiteLabel/") {
+    getWhiteLabelling(ShareId) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const qs = new URLSearchParams(window.location.search);
-            if (qs.has("wl") && qs.get("wl") === "") {
-                // Build final URL safely (trim trailing slashes, encode ShareId)
-                const base = URL.replace(/\/+$/, "");
-                const requestUrl = `${base}/${encodeURIComponent(ShareId)}`;
-                const controller = new AbortController();
-                const timeoutId = setTimeout(() => controller.abort(), 1000);
+            // 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 {
-                    const res = yield fetch(requestUrl, {
-                        method: "GET",
-                        signal: controller.signal,
-                        headers: { Accept: "application/json, text/plain" },
-                        credentials: "omit"
-                    });
-                    if (!res.ok) {
-                        // Non-2xx: treat as “no white label”
-                        return undefined;
-                    }
-                    // We read as text first to detect empty-string payloads
-                    const text = yield res.text();
-                    if (!text || text.trim() === "") {
-                        return undefined;
-                    }
-                    // If there is content, try to parse JSON
-                    let json;
-                    try {
-                        json = JSON.parse(text);
-                    }
-                    catch (_a) {
-                        // Not valid JSON → ignore
-                        return undefined;
-                    }
-                    // Validate against the allowlisted schema
-                    const parsed = ZWhiteLabel_1.ZWhiteLabel.safeParse(json);
-                    if (!parsed.success) {
-                        // Optionally log parsed.error for diagnostics
-                        return undefined;
-                    }
-                    return parsed.data;
+                    json = JSON.parse(text);
                 }
-                catch (err) {
-                    // Abort or network error → treat as “no white label”
-                    // if (err?.name !== "AbortError") console.warn("getWhiteLabelling failed", err);
+                catch (_a) {
                     return undefined;
                 }
-                finally {
-                    clearTimeout(timeoutId);
+                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);
             }
-            return undefined;
         });
     }
     /** Setup connection string. */
@@ -23573,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) {
@@ -23612,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 });
@@ -23780,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({
@@ -23961,7 +24000,7 @@ class ArcwarePixelStreaming extends lib_pixelstreamingfrontend_ue5_5_1.PixelStre
                 });
             }
         }
-        this.applyBrandingFromSettings();
+        //this.applyBrandingFromSettings();
         this.handleMouseLock();
         this.injectCustomUI();
     }
@@ -24012,34 +24051,38 @@ class ArcwarePixelStreaming extends lib_pixelstreamingfrontend_ue5_5_1.PixelStre
         }
     }
     runPostInitSideEffectsOnce() {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f, _g, _h;
         if (this._postInitSideEffectsDone)
             return;
         this._postInitSideEffectsDone = true;
         try {
             (_a = this.handleMouseLock) === null || _a === void 0 ? void 0 : _a.call(this);
         }
-        catch (_h) { }
+        catch (_j) { }
         try {
             (_b = this.handleResolutionChange) === null || _b === void 0 ? void 0 : _b.call(this);
         }
-        catch (_j) { }
+        catch (_k) { }
         try {
             (_c = this.handleRemoveLoveLetters) === null || _c === void 0 ? void 0 : _c.call(this);
         }
-        catch (_k) { }
+        catch (_l) { }
         try {
             (_e = (_d = this.microphoneOverlay) === null || _d === void 0 ? void 0 : _d.toggleVisibility) === null || _e === void 0 ? void 0 : _e.call(_d, false);
         }
-        catch (_l) { }
+        catch (_m) { }
         try {
             (_f = this.applyResolutionIfPlaying) === null || _f === void 0 ? void 0 : _f.call(this);
         }
-        catch (_m) { }
+        catch (_o) { }
         try {
             (_g = this.removeXRIconIfDisabled) === null || _g === void 0 ? void 0 : _g.call(this);
         }
-        catch (_o) { }
+        catch (_p) { }
+        try {
+            (_h = this.hideSplashVideo) === null || _h === void 0 ? void 0 : _h.call(this);
+        }
+        catch (_q) { } // ← hide splash video when streaming
     }
     onVideoInitialized() {
         if (this.videoInitializedSent) {
@@ -24303,8 +24346,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) {
@@ -24421,7 +24462,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, _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
+        // Loader
         try {
             if (this.logoLoader) {
                 (_d = (_c = this.logoLoader).setImage) === null || _d === void 0 ? void 0 : _d.call(_c, cfg.loadingIconUrl);
@@ -24429,68 +24470,149 @@ class ArcwarePixelStreaming extends lib_pixelstreamingfrontend_ue5_5_1.PixelStre
             }
         }
         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;
-            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 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";
-                        s.backgroundRepeat = "no-repeat";
-                        break;
-                    case "cover":
-                        s.backgroundSize = "cover";
-                        s.backgroundRepeat = "no-repeat";
-                        break;
-                    case "stretch":
-                        s.backgroundSize = "100% 100%";
-                        s.backgroundRepeat = "no-repeat";
-                        break;
-                    case "repeat":
-                        s.backgroundSize = "auto"; // intrinsic
-                        s.backgroundRepeat = "repeat";
-                        break;
-                }
-                // Position
-                s.backgroundPosition = cfg.splashScreenPosition || "center center";
-                // Image last (longhand so it won't reset color)
-                // Use quotes to be safe with URLs containing parentheses/spaces
-                s.backgroundImage = `url("${cfg.splashScreenUrl}")`;
+        const host = (_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 (!host)
+            return;
+        const s = host.style;
+        // Reset background longhands (never use shorthand to avoid nuking color)
+        s.removeProperty("background-image");
+        s.removeProperty("background-size");
+        s.removeProperty("background-repeat");
+        s.removeProperty("background-position");
+        s.removeProperty("background-color");
+        s.setProperty("background", "initial");
+        host.classList.remove("aw-splash");
+        // Clear any previous splash video unless re-used below
+        this.destroySplashVideo();
+        const haveUrl = !!cfg.splashScreenUrl;
+        const haveColor = !!cfg.splashScreenBgColor;
+        // Nothing to apply?
+        if (!haveUrl && !haveColor)
+            return;
+        host.classList.add("aw-splash");
+        // Always apply color (visible behind image/video / letterboxing)
+        const bgColor = (_o = cfg.splashScreenBgColor) !== null && _o !== void 0 ? _o : "var(--color0)";
+        s.setProperty("background-color", bgColor, "important");
+        // Decide: video or image from the same URL
+        const isVideo = this.isVideoUrl(cfg.splashScreenUrl);
+        if (haveUrl && isVideo) {
+            // map splashScreenMode to object-fit
+            const fit = cfg.splashScreenMode === "cover" ? "cover" : cfg.splashScreenMode === "stretch" ? "fill" : "contain";
+            const pos = cfg.splashScreenPosition || "center center";
+            this.upsertSplashVideo(cfg.splashScreenUrl, { fit, position: pos, bgColor });
+            // keep background image cleared to avoid layering
+            s.backgroundImage = "none";
+            s.backgroundRepeat = "no-repeat";
+            s.backgroundPosition = "center center";
+            s.backgroundSize = "auto";
+        }
+        else if (haveUrl) {
+            // IMAGE path
+            const mode = ((_p = cfg.splashScreenMode) !== null && _p !== void 0 ? _p : "contain");
+            switch (mode) {
+                case "contain":
+                    s.backgroundSize = "contain";
+                    s.backgroundRepeat = "no-repeat";
+                    break;
+                case "cover":
+                    s.backgroundSize = "cover";
+                    s.backgroundRepeat = "no-repeat";
+                    break;
+                case "stretch":
+                    s.backgroundSize = "100% 100%";
+                    s.backgroundRepeat = "no-repeat";
+                    break;
+                case "repeat":
+                    s.backgroundSize = "auto";
+                    s.backgroundRepeat = "repeat";
+                    break;
             }
-            else {
-                // No image → ensure any previous image is cleared
-                s.backgroundImage = "none";
-                s.backgroundRepeat = "no-repeat";
-                s.backgroundPosition = "center center";
-                s.backgroundSize = "auto";
+            s.backgroundPosition = cfg.splashScreenPosition || "center center";
+            s.backgroundImage = `url("${cfg.splashScreenUrl}")`;
+        }
+        else {
+            // COLOR only
+            s.backgroundImage = "none";
+            s.backgroundRepeat = "no-repeat";
+            s.backgroundPosition = "center center";
+            s.backgroundSize = "auto";
+        }
+    }
+    ensureSplashHost() {
+        var _a, _b, _c, _d, _e, _f;
+        const el = (_f = (_a = this.loveLettersContainer) !== null && _a !== void 0 ? _a : (_e = (_d = (_c = (_b = this.webRtcController) === null || _b === void 0 ? void 0 : _b.videoPlayer) === null || _c === void 0 ? void 0 : _c.getVideoParentElement) === null || _d === void 0 ? void 0 : _d.call(_c)) === null || _e === void 0 ? void 0 : _e.parentElement) !== null && _f !== void 0 ? _f : null;
+        if (!el)
+            return null;
+        this._splashHost = el;
+        // ensure stacking works
+        if (getComputedStyle(this._splashHost).position === "static")
+            this._splashHost.style.position = "relative";
+        return this._splashHost;
+    }
+    destroySplashVideo() {
+        if (this._splashVideo) {
+            try {
+                this._splashVideo.pause();
+            }
+            catch (_a) { }
+            try {
+                this._splashVideo.remove();
             }
+            catch (_b) { }
+            this._splashVideo = undefined;
         }
-        catch (_r) { }
+    }
+    upsertSplashVideo(url, opts) {
+        var _a, _b;
+        const host = this.ensureSplashHost();
+        if (!host)
+            return;
+        let v = this._splashVideo;
+        if (!v) {
+            v = document.createElement("video");
+            v.playsInline = true;
+            v.setAttribute("webkit-playsinline", "true");
+            v.muted = true; // for autoplay
+            v.autoplay = true;
+            v.loop = true;
+            v.style.position = "absolute";
+            v.style.inset = "0";
+            v.style.width = "100%";
+            v.style.height = "100%";
+            v.style.objectFit = "contain";
+            v.style.objectPosition = "center center";
+            v.style.pointerEvents = "none";
+            v.style.zIndex = "0";
+            host.appendChild(v);
+            this._splashVideo = v;
+        }
+        v.src = url;
+        v.style.objectFit = (_a = opts.fit) !== null && _a !== void 0 ? _a : "contain";
+        v.style.objectPosition = (_b = opts.position) !== null && _b !== void 0 ? _b : "center center";
+        if (opts.bgColor)
+            host.style.setProperty("background-color", opts.bgColor, "important");
+        v.style.display = "";
+        v.play().catch(() => { });
+    }
+    hideSplashVideo() {
+        if (this._splashVideo) {
+            try {
+                this._splashVideo.pause();
+            }
+            catch (_a) { }
+            this._splashVideo.style.display = "none";
+        }
+    }
+    isVideoUrl(u) {
+        if (!u)
+            return false;
+        const s = u.split("?")[0].toLowerCase();
+        return (s.startsWith("blob:") ||
+            s.endsWith(".mp4") ||
+            s.endsWith(".webm") ||
+            s.endsWith(".ogg") ||
+            s.endsWith(".ogv") ||
+            s.endsWith(".m3u8"));
     }
 }
 exports.ArcwarePixelStreaming = ArcwarePixelStreaming;