@arcware-cloud/pixelstreaming-websdk 1.2.18 → 1.3.0

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.2.18",
+  "version": "1.3.0",
   "type": "commonjs",
   "main": "./index.umd.js",
   "module": "./index.umd.js",

package/types/lib/ArcwareApplication.d.ts

@@ -9,6 +9,8 @@ export declare class ArcwareApplication extends Application {
     private videoElementParent;
     private parentElement;
     private responseCallback;
+    private analyticsEventCallback;
+    private fileDownloadCallback;
     private webRtcController;
     get rootElement(): HTMLElement;
     private ArcwareSection;
@@ -45,4 +47,6 @@ export declare class ArcwareApplication extends Application {
      */
     emitUIInteraction(descriptor: object | string): void;
     private addTextToConnectOverlay;
+    analyticsEvent(response: unknown): void;
+    private fileDownload;
 }

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.2.18";
+    readonly VERSION = "1.3.0";
     constructor(config: ArcwareConfigParams);
     /** Setup connection string. */
     get urlFlags(): string;

package/types/lib/ArcwarePixelStreaming.d.ts

@@ -1,5 +1,6 @@
 import { Messages } from "@arcware-cloud/shared-pixelstreaming-websdk";
 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";
@@ -79,7 +80,12 @@ export declare class ArcwarePixelStreaming extends PixelStreaming {
      * * * * * *
      */
     private sendStats;
-    private send;
+    send<T extends {
+        type: string;
+    }>(message: T): void;
+    send<K extends keyof typeof Messages.Send>(message: {
+        type: K;
+    } & z.infer<(typeof Messages.Send)[K]>): void;
     private handleResolutionChange;
     private applyResolutionIfPlaying;
     removePlayer(): void;

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

@@ -0,0 +1,28 @@
+export type AnalyticsEvent = {
+    type: string;
+    customName: string;
+    payload?: string;
+};
+type Ok<T> = {
+    ok: true;
+    value: T;
+};
+type Err = {
+    ok: false;
+    error: string;
+};
+export type Result<T> = Ok<T> | Err;
+/**
+ * Build an AnalyticsEvent from unknown input.
+ * - accepts object or JSON/JSON-ish string
+ * - drops extra fields
+ * - requires non-empty string `type` and `customName`
+ * - accepts `payload` only if it's a string; truncates by **bytes**
+ */
+export declare function toAnalyticsEvent(input: unknown, opts?: {
+    maxPayloadBytes?: number;
+    allowJsonish?: boolean;
+}): Result<AnalyticsEvent>;
+/** Type guard */
+export declare function isAnalyticsEvent(x: unknown): x is AnalyticsEvent;
+export {};

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

@@ -0,0 +1,13 @@
+import { z } from "zod";
+export declare const ZFileTransfer: z.ZodObject<{
+    type: z.ZodLiteral<"fileTransfer">;
+    filename: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type?: "fileTransfer";
+    filename?: string;
+}, {
+    type?: "fileTransfer";
+    filename?: string;
+}>;
+export type FileTransferMsg = z.infer<typeof ZFileTransfer>;
+export declare function parseControl<T extends z.ZodTypeAny>(input: unknown, schema: T): z.infer<T>;

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

@@ -0,0 +1,13 @@
+/** Conservative normalizer: accepts object, strict JSON string, or JSON-ish like {foo: "bar"} */
+export declare function parseUnknownToObject(input: unknown, opts?: {
+    allowJsonish?: boolean;
+}): Record<string, unknown>;
+/** Byte-safe string truncation (no broken unicode) */
+export declare function truncateByBytes(input: string, maxBytes: number): string;
+/** Cross-platform safe filename */
+export declare function sanitizeFilename(input: string): string;
+/** MIME -> extension */
+export declare function extFromMime(mime: string): string;
+/** Short random fallback */
+export declare function randomHash(): string;
+export declare function normalizeType(v: unknown): string;