@arcware-cloud/pixelstreaming-websdk 1.3.41 → 1.4.4

package/types/core/features/IWhiteLabel.d.ts

@@ -0,0 +1,16 @@
+/** White-label settings allowed via URL */
+export interface WhiteLabel {
+    loadingIconUrl?: string;
+    loadingIconFadeMs?: number;
+    splashScreenUrl?: string;
+    splashScreenMode?: "contain" | "cover" | "stretch" | "repeat";
+    splashScreenPosition?: string;
+    splashScreenBgColor?: string;
+    hideLoveLetters?: boolean;
+    hideAfkOverlay?: boolean;
+}
+/**
+ * Strictly validate and coerce a white-label payload.
+ * Mirrors ZWhiteLabel.strict().safeParse(...)
+ */
+export declare function coerceWhiteLabel(input: unknown): Partial<WhiteLabel> | undefined;

package/types/{lib → core}/features/whiteLabelling.d.ts

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

package/types/core.d.ts

@@ -0,0 +1,5 @@
+export { ArcwarePixelStreaming } from "./core/ArcwarePixelStreaming";
+export { ArcwareConfig } from "./core/ArcwareConfig";
+export { CoreSetup } from "./core/CoreSetup";
+export { WebsocketState } from "./core/ArcwarePixelStreaming";
+export * from "./core/Messages";

package/types/index.d.ts

@@ -1,3 +1,7 @@
-export * from "@epicgames-ps/lib-pixelstreamingfrontend-ue5.5";
-export * from "@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.5";
-export * from "./lib";
+export { ArcwareInit } from "./ui/ArcwareInit";
+export { ArcwareApplication } from "./ui/ArcwareApplication";
+export { ArcwarePixelStreaming } from "./core/ArcwarePixelStreaming";
+export { ArcwareConfig } from "./core/ArcwareConfig";
+export { CoreSetup } from "./core/CoreSetup";
+export { WebsocketState } from "./core/ArcwarePixelStreaming";
+export * from "./core/Messages";

package/types/{lib → ui}/ArcwareApplication.d.ts

@@ -1,5 +1,17 @@
 import { Application, UIOptions } from "@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.5";
-import { ArcwarePixelStreaming } from "./ArcwarePixelStreaming";
+import { ArcwarePixelStreaming } from "../core/ArcwarePixelStreaming";
+/**
+ * Default UI layer built on top of ArcwarePixelStreaming.
+ *
+ * Provides:
+ * - Branded controls
+ * - Audio/Mic/Stop buttons
+ * - Love letter overlay
+ * - Splash screen support
+ * - Automatic file download handling
+ *
+ * Can be replaced with a fully custom UI.
+ */
 export declare class ArcwareApplication extends Application {
     static Flags: {
         new (): {};
@@ -9,16 +21,35 @@ export declare class ArcwareApplication extends Application {
     stream: ArcwarePixelStreaming;
     private videoElementParent;
     private parentElement;
-    private responseCallback;
-    private analyticsEventCallback;
-    private fileDownloadCallback;
     private webRtcController;
+    loveLettersContainer: HTMLDivElement | undefined;
+    private loveLettersList;
+    private loveLettersQueue;
+    private isProcessingQueue;
+    private microphoneOverlay?;
+    private _splashHost?;
+    private _splashVideo?;
+    private logoLoader?;
     get rootElement(): HTMLElement;
     private ArcwareSection;
     constructor(options: UIOptions & {
         stream: ArcwarePixelStreaming;
     });
     addLoveLetterhandler(): void;
+    initLoveLettersContainer(): void;
+    private _loveLettersAttachTimer?;
+    private tryAttachLoveLettersContainer;
+    private pushLetter;
+    private processLoveLetterQueue;
+    private handleRemoveLoveLetters;
+    private createMicrophoneOverlay;
+    private removeXRIconIfDisabled;
+    private applyBrandingFromSettings;
+    private ensureSplashHost;
+    private destroySplashVideo;
+    private upsertSplashVideo;
+    private hideSplashVideo;
+    private isVideoUrl;
     /** Set's and resets hidden state of "additional" UI Elements.
      * For example buttons or connection icon.
      * These will fade in through css animation upon the videoInitialized event.
@@ -33,6 +64,11 @@ export declare class ArcwareApplication extends Application {
     private uiDefaultButtonVisibilty;
     private preventDefaultKeyboardEvents;
     private autoPlayHandler;
+    /**
+     * @deprecated Use onApplicationResponse instead.
+     * Registers a persistent listener for UE responses.
+     */
+    getApplicationResponse(callback: (response: string) => void): void;
     /** Request a response from you UE Application.
      * The returned response depends on the implementation of your UE Application.
      * It can be used to request information from the application, such as:
@@ -41,15 +77,12 @@ export declare class ArcwareApplication extends Application {
      * - the id of the save-game
      * .. anything else you could imagine.
      */
-    getApplicationResponse(callback: (response: string) => void): void;
-    applicationResponse(response: string): void;
+    onApplicationResponse(callback: (response: string) => void): () => void;
     private applyArcwareStyles;
     /** Emit an event towards the UE Application.
      * Mainly used to bubble events like a button press or other command inputs towards the UE Application.
      */
     emitUIInteraction(descriptor: object | string): void;
     private addTextToConnectOverlay;
-    analyticsEvent(response: unknown): void;
-    private fileDownload;
     private syncAfkOverlayFromWhiteLabelling;
 }

package/types/{lib → ui}/ArcwareInit.d.ts

@@ -1,5 +1,5 @@
-import { ArcwareConfig, ArcwareConfigParams } from "./ArcwareConfig";
-import { ArcwarePixelStreaming } from "./ArcwarePixelStreaming";
+import { ArcwareConfig, ArcwareConfigParams } from "../core/ArcwareConfig";
+import { ArcwarePixelStreaming } from "../core/ArcwarePixelStreaming";
 import { ArcwareApplication } from "./ArcwareApplication";
 type ArcwareSettings = ArcwareConfigParams["settings"];
 export type ArcwareInitConfiguration = Partial<Omit<ArcwareConfigParams, "settings">> & {
@@ -15,5 +15,5 @@ export interface ArcwareInitResult {
     PixelStreaming: ArcwarePixelStreaming;
     Application: ArcwareApplication;
 }
-export declare function ArcwareInit(ids: ConnectionInfo, configuration?: ArcwareInitConfiguration, forceRefresh?: boolean): ArcwareInitResult;
+export declare function ArcwareInit(ids: ConnectionInfo, configuration?: ArcwareInitConfiguration, forceRefresh?: boolean, allowMultipleInstances?: boolean): ArcwareInitResult;
 export {};

package/types/{lib/ui → ui/components}/AudioButton/index.d.ts

@@ -1,4 +1,4 @@
-import { ArcwarePixelStreaming } from "../../ArcwarePixelStreaming";
+import { ArcwarePixelStreaming } from "../../../core/ArcwarePixelStreaming";
 export declare class AudioButton {
     private button;
     private stream;

package/types/{lib/ui → ui/components}/MicButton/index.d.ts

@@ -1,4 +1,4 @@
-import { ArcwarePixelStreaming } from "../../ArcwarePixelStreaming";
+import { ArcwarePixelStreaming } from "../../../core/ArcwarePixelStreaming";
 export declare class MicButton {
     private button;
     private stream;

package/types/{lib/ui → ui/components}/MicrophoneOverlay/index.d.ts

@@ -1,4 +1,4 @@
-import { ArcwarePixelStreaming } from "../../ArcwarePixelStreaming";
+import { ArcwarePixelStreaming } from "../../../core/ArcwarePixelStreaming";
 export declare class MicrophoneOverlay {
     private overlay;
     private parentElement;

package/types/{lib/ui → ui/components}/StopButton/index.d.ts

@@ -1,4 +1,4 @@
-import { ArcwarePixelStreaming } from "../../ArcwarePixelStreaming";
+import { ArcwarePixelStreaming } from "../../../core/ArcwarePixelStreaming";
 export declare class StopButton {
     private button;
     private stream;

package/types/{lib → ui}/styles/ArcwarePixelStreamingApplicationStyles.d.ts

@@ -1,7 +1,7 @@
 export declare const CONTROLS_CLASSES: {
     uiFeatures: {
-        buttons_position: Record<'Top-Left' | 'Top-Right' | 'Bottom-Left' | 'Bottom-Right', string>;
-        buttons_orientation: Record<'Horizontal' | 'Vertical', string>;
+        buttons_position: Record<"Top-Left" | "Top-Right" | "Bottom-Left" | "Bottom-Right", string>;
+        buttons_orientation: Record<"Horizontal" | "Vertical", string>;
         buttons_reverse: string;
     };
 };
@@ -38,6 +38,17 @@ export declare const ArcwareStyles: {
                 opacity: number;
             };
         };
+        "#uiFeatures #controls": {
+            display: string;
+            flexDirection: string;
+            position: string;
+            pointerEvents: string;
+            zIndex: number;
+            gap: string;
+        };
+        "#uiFeatures #controls > *": {
+            marginBottom: string;
+        };
         "#playerUI *": {
             fontFamily: string;
         };
@@ -91,53 +102,41 @@ export declare const ArcwareStyles: {
             boxSizing: string;
             background: string;
         };
-        "#uiFeatures #controls": {
-            display: string;
+        "#uiFeatures.controls__position_tl #controls": {
+            top: string;
+            left: string;
+            bottom: string;
+            right: string;
+        };
+        "#uiFeatures.controls__position_tr #controls": {
+            top: string;
+            right: string;
+            bottom: string;
+            left: string;
+        };
+        "#uiFeatures.controls__position_bl #controls": {
+            bottom: string;
+            left: string;
+            top: string;
+            right: string;
+        };
+        "#uiFeatures.controls__position_br #controls": {
+            bottom: string;
+            right: string;
+            top: string;
+            left: string;
+        };
+        "#uiFeatures.controls__orientation_h #controls": {
             flexDirection: string;
         };
-        "#controls": {
-            gap: string;
-            "& > *": {
-                marginBottom: string;
-            };
+        "#uiFeatures.controls__orientation_h.controls__order_reverse #controls": {
+            flexDirection: string;
         };
-        "#uiFeatures": {
-            "&.controls__position_tl #controls": {
-                top: string;
-                left: string;
-                bottom: string;
-                right: string;
-            };
-            "&.controls__position_tr #controls": {
-                top: string;
-                right: string;
-                bottom: string;
-                left: string;
-            };
-            "&.controls__position_bl #controls": {
-                bottom: string;
-                left: string;
-                top: string;
-                right: string;
-            };
-            "&.controls__position_br #controls": {
-                bottom: string;
-                right: string;
-                top: string;
-                left: string;
-            };
-            "&.controls__orientation_h #controls": {
-                flexDirection: string;
-            };
-            "&.controls__orientation_h.controls__order_reverse #controls": {
-                flexDirection: string;
-            };
-            "&.controls__orientation_v #controls": {
-                flexDirection: string;
-            };
-            "&.controls__orientation_v.controls__order_reverse #controls": {
-                flexDirection: string;
-            };
+        "#uiFeatures.controls__orientation_v #controls": {
+            flexDirection: string;
+        };
+        "#uiFeatures.controls__orientation_v.controls__order_reverse #controls": {
+            flexDirection: string;
         };
         "#uiFeatures #connection": {
             bottom: string;

package/types/lib/ArcwarePixelStreaming.d.ts

@@ -1,140 +0,0 @@
-import { Messages } from "../shared/index";
-import { PixelStreaming, PixelStreamingOverrides } from "@epicgames-ps/lib-pixelstreamingfrontend-ue5.5";
-import { z } from "zod";
-import { ArcwareConfig } from "./ArcwareConfig";
-import { EventHandler } from "./domain/EventHandler";
-import { Session } from "./domain/Session";
-type OutboundByKey<K extends keyof typeof Messages.Send> = z.input<(typeof Messages.Send)[K]> & {
-    type: K;
-};
-export declare enum WebsocketState {
-    CONNECTING = 0,
-    OPEN = 1,
-    CLOSING = 2,
-    CLOSED = 3
-}
-export declare class ArcwarePixelStreaming extends PixelStreaming {
-    /** Override default config with ArcwareConfig. */
-    config: ArcwareConfig;
-    streamInfo?: Messages.StreamInfo;
-    loveLettersContainer: HTMLDivElement | undefined;
-    private loveLettersList;
-    private loveLettersQueue;
-    private isProcessingQueue;
-    private microphoneOverlay;
-    private diagnosticsCollector;
-    private _splashHost?;
-    private _splashVideo?;
-    private outbox;
-    private videoInitializedSent;
-    private _boundTransport?;
-    private _onWsOpen?;
-    private _onWsClose?;
-    private _transportWatchTimer?;
-    private _rVFCsupported;
-    private _rvfcHandle?;
-    private _rVFCArmedForElement?;
-    private _mo?;
-    private _postInitSideEffectsDone;
-    private logoLoader?;
-    private resetInitGuardsAndHooks;
-    reconnect(): void;
-    private isRetryableClose;
-    private bindTransportEvents;
-    private get isWsOpen();
-    /** Returns this PixelStreaming Instances websocket state. */
-    get websocketState(): WebsocketState;
-    constructor(config: ArcwareConfig, overrides?: PixelStreamingOverrides);
-    /** Getter for the session object. */
-    get session(): Session;
-    /**
-     * * * * * * *
-     *  Listen   *
-     * * * * * * *
-     */
-    /** On version requested, the version of the WebSDK would be returned. */
-    private onVersion;
-    private isVideoRenderingNow;
-    private waitForFirstFrameWithTimeout;
-    private onRender;
-    /** On ping the session creation timestamp will be updated. */
-    private onPing;
-    /** Handle incoming configurations. */
-    private onStreamInfo;
-    readonly queueHandler: EventHandler<{
-        type?: "queue";
-        queue?: {
-            index?: number;
-            queueLength?: number;
-            waited?: number;
-            estimatedWaitTime?: number;
-            averageWaitTime?: number;
-            valueType?: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
-        };
-    }>;
-    private onQueue;
-    readonly errorHandler: EventHandler<{
-        type?: "error";
-        code?: number;
-        reason?: string;
-        verbosity?: number;
-    }>;
-    private onError;
-    readonly loveLetterHandler: EventHandler<{
-        type?: "letter";
-        code?: number;
-        reason?: string;
-        verbosity?: number;
-    }>;
-    private onLoveLetter;
-    readonly sessionIdHandler: EventHandler<string>;
-    private onSessionId;
-    private sendVideoInitializedOnce;
-    /** VideoInitialized (native Epic event) */
-    readonly videoInitializedHandler: EventHandler<never>;
-    private runPostInitSideEffectsOnce;
-    private onVideoInitialized;
-    private attachFirstRenderedFrameOnce;
-    private cancelFirstRenderedFrameHook;
-    private watchVideoElementReplacement;
-    readonly websocketOnCloseHandler: EventHandler<CloseEvent>;
-    /** Adding a zod-safe handler. */
-    private addMessageHandler;
-    /**
-     * * * * * *
-     *  Send   *
-     * * * * * *
-     */
-    private sendStats;
-    send<K extends keyof typeof Messages.Send>(message: OutboundByKey<K>): void;
-    send(type: string, payload?: Record<string, unknown>): void;
-    send(message: {
-        type: string;
-    } & Record<string, unknown>): void;
-    private _dispatchOrBuffer;
-    private flushOutbox;
-    private handleResolutionChange;
-    private applyResolutionIfPlaying;
-    removePlayer(): void;
-    private startTransportWatcher;
-    private stopTransportWatcher;
-    private handleMouseLock;
-    initLoveLettersContainer(): void;
-    private pushLetter;
-    private processLoveLetterQueue;
-    private handleRemoveLoveLetters;
-    toggleAudio(videoElement: HTMLVideoElement, enabled: boolean): void;
-    private createMicrophoneOverlay;
-    toggleMic(enable: boolean, isDefault: boolean): void;
-    onStreamingStateChange(callback: (isStreaming: boolean) => void): void;
-    private removeXRIconIfDisabled;
-    private injectCustomUI;
-    private applyBrandingFromSettings;
-    private ensureSplashHost;
-    private destroySplashVideo;
-    private upsertSplashVideo;
-    private hideSplashVideo;
-    private isVideoUrl;
-    static clearSessionId(): void;
-}
-export {};

package/types/lib/MessageTypes.d.ts

@@ -1,4 +0,0 @@
-import { Messages } from "../shared/index";
-export type ErrorMessage = Messages.ErrorMessage;
-export type Queue = Messages.Queue;
-export type LoveLetter = Messages.LoveLetter;