@arcware-cloud/pixelstreaming-websdk 1.3.12 → 1.3.13

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@arcware-cloud/pixelstreaming-websdk",
   "description": "WebSDK for easy implementation of pixel streaming with Arcware Cloud Services. Heavily based on the '@epicgames-ps' library.",
-  "version": "1.3.12",
+  "version": "1.3.13",
   "type": "commonjs",
   "main": "./index.umd.js",
   "module": "./index.umd.js",

package/types/lib/ArcwareConfig.d.ts

@@ -26,7 +26,7 @@ export declare class ArcwareConfig extends Config {
     readonly session: Session;
     readonly settings: Settings;
     private _initialSettings;
-    readonly VERSION = "1.3.12";
+    readonly VERSION = "1.3.13";
     constructor(config: ArcwareConfigParams);
     /** Setup connection string. */
     get urlFlags(): string;

package/types/lib/ArcwarePixelStreaming.d.ts

@@ -29,6 +29,7 @@ export declare class ArcwarePixelStreaming extends PixelStreaming {
     private _rVFCArmedForElement?;
     private _mo?;
     private _postInitSideEffectsDone;
+    private logoLoader?;
     private resetInitGuardsAndHooks;
     reconnect(): void;
     private isRetryableClose;
@@ -126,5 +127,6 @@ export declare class ArcwarePixelStreaming extends PixelStreaming {
     onStreamingStateChange(callback: (isStreaming: boolean) => void): void;
     private removeXRIconIfDisabled;
     private injectCustomUI;
+    private applyBrandingFromSettings;
 }
 export {};

package/types/lib/domain/ArcwareSettingsSchema.d.ts

@@ -31,9 +31,6 @@ export declare const ArcwareSettingsSchema: z.ZodObject<{
         type: z.ZodLiteral<"queue">;
         queue: z.ZodObject<{
             index: z.ZodOptional<z.ZodNumber>;
-            /** Can be used to be added to the request in order to verify access to private projects.
-             * For internal use only. => Preview page.
-             */
             queueLength: z.ZodOptional<z.ZodNumber>;
             waited: z.ZodOptional<z.ZodNumber>;
             estimatedWaitTime: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
@@ -134,6 +131,29 @@ export declare const ArcwareSettingsSchema: z.ZodObject<{
         landscape?: number;
         portrait?: number;
     }>>;
+    /** Loader customization */
+    whiteLabelling: z.ZodOptional<z.ZodObject<{
+        loadingIconUrl: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodEffects<z.ZodString, string, string>]>>;
+        loadingIconFadeMs: z.ZodOptional<z.ZodNumber>;
+        splashScreenUrl: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodEffects<z.ZodString, string, string>]>>;
+        splashScreenMode: z.ZodOptional<z.ZodEnum<["contain", "cover", "stretch", "repeat"]>>;
+        splashScreenPosition: z.ZodOptional<z.ZodString>;
+        splashScreenBgColor: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        loadingIconUrl?: string;
+        loadingIconFadeMs?: number;
+        splashScreenUrl?: string;
+        splashScreenMode?: "repeat" | "contain" | "cover" | "stretch";
+        splashScreenPosition?: string;
+        splashScreenBgColor?: string;
+    }, {
+        loadingIconUrl?: string;
+        loadingIconFadeMs?: number;
+        splashScreenUrl?: string;
+        splashScreenMode?: "repeat" | "contain" | "cover" | "stretch";
+        splashScreenPosition?: string;
+        splashScreenBgColor?: string;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     session?: string;
     token?: string;
@@ -179,6 +199,14 @@ export declare const ArcwareSettingsSchema: z.ZodObject<{
         landscape?: number;
         portrait?: number;
     };
+    whiteLabelling?: {
+        loadingIconUrl?: string;
+        loadingIconFadeMs?: number;
+        splashScreenUrl?: string;
+        splashScreenMode?: "repeat" | "contain" | "cover" | "stretch";
+        splashScreenPosition?: string;
+        splashScreenBgColor?: string;
+    };
 }, {
     session?: string;
     token?: string;
@@ -224,5 +252,13 @@ export declare const ArcwareSettingsSchema: z.ZodObject<{
         landscape?: number;
         portrait?: number;
     };
+    whiteLabelling?: {
+        loadingIconUrl?: string;
+        loadingIconFadeMs?: number;
+        splashScreenUrl?: string;
+        splashScreenMode?: "repeat" | "contain" | "cover" | "stretch";
+        splashScreenPosition?: string;
+        splashScreenBgColor?: string;
+    };
 }>;
 export type Settings = z.infer<typeof ArcwareSettingsSchema>;

package/types/lib/features/whiteLabelling.d.ts

@@ -0,0 +1,4 @@
+import { ZWhiteLabel } from "@arcware-cloud/shared-pixelstreaming-websdk";
+import { z } from "zod";
+/** Parse ?wl=... (or ?whitelabel=...) → validated partial settings */
+export declare function readWhiteLabelFromQuery(qs: URLSearchParams): Partial<z.infer<typeof ZWhiteLabel>> | undefined;

package/types/lib/styles/ArcwarePixelStreamingApplicationStyles.d.ts

@@ -17,6 +17,20 @@ export declare const ArcwareStyles: {
             "--color13": string;
             "--colorBoxShadow": string;
         };
+        ".aw-splash": {
+            backgroundRepeat: string;
+            backgroundPosition: string;
+            backgroundSize: string;
+            backgroundColor: string;
+        };
+        "@keyframes aw-loader-fade": {
+            from: {
+                opacity: number;
+            };
+            to: {
+                opacity: number;
+            };
+        };
         "#playerUI *": {
             fontFamily: string;
         };
@@ -209,9 +223,38 @@ export declare const ArcwareStyles: {
         };
         ".arcware-logo-loader": {
             position: string;
+            display: string;
+            alignItems: string;
+            justifyContent: string;
+            width: string;
+            height: string;
+            margin: string;
+            boxSizing: string;
+        };
+        ".arcware-logo-loader img": {
+            maxWidth: string;
+            maxHeight: string;
+            objectFit: string;
+            objectPosition: string;
+            display: string;
+            margin: number;
+            verticalAlign: string;
+        };
+        ".arcware-logo-loader.pulse img": {
+            animation: string;
+        };
+        ".arcware-logo-loader.aw-custom-loader": {
+            width: string;
+            height: string;
+        };
+        ".arcware-logo-loader.aw-custom-loader img": {
             display: string;
             width: string;
             height: string;
+            maxWidth: string;
+            maxHeight: string;
+            objectFit: string;
+            margin: string;
         };
         "#playOverlay img#playButton": {
             width: string;
@@ -474,5 +517,27 @@ export declare const ArcwareStyles: {
             opacity: number;
             transition: string;
         };
+        ".love-letters-box-root .arcware-logo-loader": {
+            display: string;
+            alignItems: string;
+            justifyContent: string;
+        };
+        ".love-letters-box-root .arcware-logo-loader.aw-custom-loader": {
+            width: string;
+            height: string;
+        };
+        ".love-letters-box-root .arcware-logo-loader.aw-custom-loader img": {
+            display: string;
+            margin: string;
+            width: string;
+            height: string;
+            objectFit: string;
+            objectPosition: string;
+        };
+        ".love-letters-box-root .arcware-logo-loader.aw-custom-loader img.alt-40pct": {
+            width: string;
+            maxWidth: string;
+            height: string;
+        };
     };
 };

package/types/lib/ui/ArcwareLogoLoader/index.d.ts

@@ -2,5 +2,13 @@ export declare class ArcwareLogoLoader {
     arcwareLogoLoader: HTMLDivElement;
     constructor();
     private createArcwareLogoLoader;
+    private _imgEl?;
+    private _hostEl?;
+    /** Call this once after you create the wrapper/root that contains the SVG */
+    setHostElement(el: HTMLElement): void;
+    /** Swap the loader image at runtime; pass undefined to go back to SVG */
+    setImage(url?: string): void;
+    /** Enable/disable pulsing fade in ms; 0 disables */
+    setFade(ms?: number): void;
     private getSvg;
 }

package/types/shared/lib/Types/ZWhiteLabel.d.ts

@@ -0,0 +1,24 @@
+import { z } from "zod";
+/** Strict allowlist for white-label brand fields coming from the URL */
+export declare const ZWhiteLabel: z.ZodObject<{
+    loadingIconUrl: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodEffects<z.ZodString, string, string>]>>;
+    loadingIconFadeMs: z.ZodOptional<z.ZodNumber>;
+    splashScreenUrl: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodEffects<z.ZodString, string, string>]>>;
+    splashScreenMode: z.ZodOptional<z.ZodEnum<["contain", "cover", "stretch", "repeat"]>>;
+    splashScreenPosition: z.ZodOptional<z.ZodString>;
+    splashScreenBgColor: z.ZodOptional<z.ZodString>;
+}, "strict", z.ZodTypeAny, {
+    loadingIconUrl?: string;
+    loadingIconFadeMs?: number;
+    splashScreenUrl?: string;
+    splashScreenMode?: "repeat" | "contain" | "cover" | "stretch";
+    splashScreenPosition?: string;
+    splashScreenBgColor?: string;
+}, {
+    loadingIconUrl?: string;
+    loadingIconFadeMs?: number;
+    splashScreenUrl?: string;
+    splashScreenMode?: "repeat" | "contain" | "cover" | "stretch";
+    splashScreenPosition?: string;
+    splashScreenBgColor?: string;
+}>;

package/types/shared/lib/index.d.ts

@@ -1 +1,2 @@
 export * as Messages from "./Messages";
+export { ZWhiteLabel } from "./Types/ZWhiteLabel";