@arcware-cloud/pixelstreaming-websdk 1.0.2 → 1.0.6

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.0.2",
+  "version": "1.0.6",
   "type": "commonjs",
   "main": "./index.umd.js",
   "module": "./index.umd.js",
@@ -18,15 +18,5 @@
     "email": "info@arcware.com",
     "url": "https://www.arcware.com"
   },
-  "license": "MIT",
-  "dependencies": {},
-  "peerDependencies": {
-    "@epicgames-ps/lib-pixelstreamingfrontend-ue5.5": "0.4.7",
-    "@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.5": "0.4.7",
-    "lodash": "4.17.21",
-    "lottie-web": "5.10.2",
-    "moment": "2.29.4",
-    "zod": "3.22.4"
-  },
-  "cjs": "./index.cjs.js"
+  "license": "MIT"
 }

package/types/lib/ArcwareConfig.d.ts

@@ -26,10 +26,10 @@ export declare class ArcwareConfig extends Config {
     readonly session: Session;
     readonly settings: Settings;
     private _initialSettings;
-    readonly VERSION = "1.0.2";
+    readonly VERSION = "1.0.6";
     constructor(config: ArcwareConfigParams);
     /** Setup connection string. */
     get urlFlags(): string;
-    get initialSettings(): Partial<import("@epicgames-ps/lib-pixelstreamingfrontend-ue5.5").AllSettings>;
+    get initialSettings(): any;
     modifyInitialSettings(mouseLock: boolean): void;
 }

package/types/lib/ArcwarePixelStreaming.d.ts

@@ -35,32 +35,31 @@ export declare class ArcwarePixelStreaming extends PixelStreaming {
     private onStreamInfo;
     /** On ping the session creation timestamp will be updated. */
     readonly queueHandler: EventHandler<{
-        type: "queue";
-        queue: {
-            valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
-            index?: number | undefined;
-            queueLength?: number | undefined;
-            waited?: number | undefined;
-            /** As soon as upstream is fixed, we got to adjust the url building process. */
-            estimatedWaitTime?: number | undefined;
-            averageWaitTime?: number | undefined;
+        type?: "queue";
+        queue?: {
+            index?: number;
+            queueLength?: number;
+            waited?: number;
+            estimatedWaitTime?: number;
+            averageWaitTime?: number;
+            valueType?: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
         };
     }>;
     private onQueue;
     /** Error receiver. */
     readonly errorHandler: EventHandler<{
-        type: "error";
-        code: number;
-        reason: string;
-        verbosity: number;
+        type?: "error";
+        code?: number;
+        reason?: string;
+        verbosity?: number;
     }>;
     private onError;
     /** LoveLetter */
     readonly loveLetterHandler: EventHandler<{
-        type: "letter";
-        code: number;
-        reason: string;
-        verbosity: number;
+        type?: "letter";
+        reason?: string;
+        code?: number;
+        verbosity?: number;
     }>;
     private onLoveLetter;
     /** SessionId */

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

@@ -16,60 +16,63 @@ export declare const ArcwareSettingsSchema: z.ZodObject<{
         reason: z.ZodString;
         verbosity: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
-        type: "error";
-        code: number;
-        reason: string;
-        verbosity: number;
+        type?: "error";
+        code?: number;
+        reason?: string;
+        verbosity?: number;
     }, {
-        type: "error";
-        code: number;
-        reason: string;
-        verbosity: number;
+        type?: "error";
+        code?: number;
+        reason?: string;
+        verbosity?: number;
     }>], z.ZodUnknown>, z.ZodVoid>>;
     /** Handler for queue events. */
     queueHandler: z.ZodOptional<z.ZodFunction<z.ZodTuple<[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.ZodOptional<z.ZodNumber>;
             averageWaitTime: z.ZodOptional<z.ZodNumber>;
             valueType: z.ZodEnum<["milliseconds", "seconds", "minutes", "hours", "days"]>;
         }, "strip", z.ZodTypeAny, {
-            valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
-            index?: number | undefined;
-            queueLength?: number | undefined;
-            waited?: number | undefined;
-            estimatedWaitTime?: number | undefined;
-            averageWaitTime?: number | undefined;
+            index?: number;
+            queueLength?: number;
+            waited?: number;
+            estimatedWaitTime?: number;
+            averageWaitTime?: number;
+            valueType?: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
         }, {
-            valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
-            index?: number | undefined;
-            queueLength?: number | undefined;
-            waited?: number | undefined;
-            estimatedWaitTime?: number | undefined;
-            averageWaitTime?: number | undefined;
-        }>; /** Show or hide the connectionStrengthIcon button. */
+            index?: number;
+            queueLength?: number;
+            waited?: number;
+            estimatedWaitTime?: number;
+            averageWaitTime?: number;
+            valueType?: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
+        }>;
     }, "strip", z.ZodTypeAny, {
-        type: "queue";
-        queue: {
-            valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
-            index?: number | undefined;
-            queueLength?: number | undefined;
-            waited?: number | undefined;
-            estimatedWaitTime?: number | undefined;
-            averageWaitTime?: number | undefined;
+        type?: "queue";
+        queue?: {
+            index?: number;
+            queueLength?: number;
+            waited?: number;
+            estimatedWaitTime?: number;
+            averageWaitTime?: number;
+            valueType?: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
         };
     }, {
-        type: "queue";
-        queue: {
-            valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
-            index?: number | undefined;
-            queueLength?: number | undefined;
-            waited?: number | undefined;
-            estimatedWaitTime?: number | undefined;
-            averageWaitTime?: number | undefined;
+        type?: "queue";
+        queue?: {
+            index?: number;
+            queueLength?: number;
+            waited?: number;
+            estimatedWaitTime?: number;
+            averageWaitTime?: number;
+            valueType?: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
         };
     }>], z.ZodUnknown>, z.ZodVoid>>;
     /** Handler for sessionId message. */
@@ -82,15 +85,15 @@ export declare const ArcwareSettingsSchema: z.ZodObject<{
         code: z.ZodNumber;
         verbosity: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
-        type: "letter";
-        code: number;
-        reason: string;
-        verbosity: number;
+        type?: "letter";
+        reason?: string;
+        code?: number;
+        verbosity?: number;
     }, {
-        type: "letter";
-        code: number;
-        reason: string;
-        verbosity: number;
+        type?: "letter";
+        reason?: string;
+        code?: number;
+        verbosity?: number;
     }>], z.ZodUnknown>, z.ZodVoid>>;
     /** Show or hide the fullscreen button. */
     fullscreenButton: z.ZodOptional<z.ZodBoolean>;
@@ -117,82 +120,82 @@ export declare const ArcwareSettingsSchema: z.ZodObject<{
     /** Enable/Disable Connection Identifier logging to the console. */
     connectionIdentifierLoggingDisabled: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
-    session?: string | undefined;
-    token?: string | undefined;
-    bypass?: boolean | undefined;
-    errorHandler?: ((args_0: {
-        type: "error";
-        code: number;
-        reason: string;
-        verbosity: number;
-    }, ...args_1: unknown[]) => void) | undefined;
-    queueHandler?: ((args_0: {
-        type: "queue";
-        queue: {
-            valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
-            index?: number | undefined;
-            queueLength?: number | undefined;
-            waited?: number | undefined;
-            estimatedWaitTime?: number | undefined;
-            averageWaitTime?: number | undefined;
+    session?: string;
+    token?: string;
+    bypass?: boolean;
+    errorHandler?: (args_0: {
+        type?: "error";
+        code?: number;
+        reason?: string;
+        verbosity?: number;
+    }, ...args_1: unknown[]) => void;
+    queueHandler?: (args_0: {
+        type?: "queue";
+        queue?: {
+            index?: number;
+            queueLength?: number;
+            waited?: number;
+            estimatedWaitTime?: number;
+            averageWaitTime?: number;
+            valueType?: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
         };
-    }, ...args_1: unknown[]) => void) | undefined;
-    sessionIdHandler?: ((args_0: string, ...args_1: unknown[]) => void) | undefined;
-    loveLetterHandler?: ((args_0: {
-        type: "letter";
-        code: number;
-        reason: string;
-        verbosity: number;
-    }, ...args_1: unknown[]) => void) | undefined;
-    fullscreenButton?: boolean | undefined;
-    settingsButton?: boolean | undefined;
-    infoButton?: boolean | undefined;
-    audioButton?: boolean | undefined;
-    micButton?: boolean | undefined;
-    stopButton?: boolean | undefined;
-    connectionStrengthIcon?: boolean | undefined;
-    shareId?: string | undefined;
-    projectId?: string | undefined;
-    loveLetterLogging?: boolean | undefined;
-    connectionIdentifierLoggingDisabled?: boolean | undefined;
+    }, ...args_1: unknown[]) => void;
+    sessionIdHandler?: (args_0: string, ...args_1: unknown[]) => void;
+    loveLetterHandler?: (args_0: {
+        type?: "letter";
+        reason?: string;
+        code?: number;
+        verbosity?: number;
+    }, ...args_1: unknown[]) => void;
+    fullscreenButton?: boolean;
+    settingsButton?: boolean;
+    infoButton?: boolean;
+    audioButton?: boolean;
+    micButton?: boolean;
+    stopButton?: boolean;
+    connectionStrengthIcon?: boolean;
+    shareId?: string;
+    projectId?: string;
+    loveLetterLogging?: boolean;
+    connectionIdentifierLoggingDisabled?: boolean;
 }, {
-    session?: string | undefined;
-    token?: string | undefined;
-    bypass?: boolean | undefined;
-    errorHandler?: ((args_0: {
-        type: "error";
-        code: number;
-        reason: string;
-        verbosity: number;
-    }, ...args_1: unknown[]) => void) | undefined;
-    queueHandler?: ((args_0: {
-        type: "queue";
-        queue: {
-            valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
-            index?: number | undefined;
-            queueLength?: number | undefined;
-            waited?: number | undefined;
-            estimatedWaitTime?: number | undefined;
-            averageWaitTime?: number | undefined;
+    session?: string;
+    token?: string;
+    bypass?: boolean;
+    errorHandler?: (args_0: {
+        type?: "error";
+        code?: number;
+        reason?: string;
+        verbosity?: number;
+    }, ...args_1: unknown[]) => void;
+    queueHandler?: (args_0: {
+        type?: "queue";
+        queue?: {
+            index?: number;
+            queueLength?: number;
+            waited?: number;
+            estimatedWaitTime?: number;
+            averageWaitTime?: number;
+            valueType?: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
         };
-    }, ...args_1: unknown[]) => void) | undefined;
-    sessionIdHandler?: ((args_0: string, ...args_1: unknown[]) => void) | undefined;
-    loveLetterHandler?: ((args_0: {
-        type: "letter";
-        code: number;
-        reason: string;
-        verbosity: number;
-    }, ...args_1: unknown[]) => void) | undefined;
-    fullscreenButton?: boolean | undefined;
-    settingsButton?: boolean | undefined;
-    infoButton?: boolean | undefined;
-    audioButton?: boolean | undefined;
-    micButton?: boolean | undefined;
-    stopButton?: boolean | undefined;
-    connectionStrengthIcon?: boolean | undefined;
-    shareId?: string | undefined;
-    projectId?: string | undefined;
-    loveLetterLogging?: boolean | undefined;
-    connectionIdentifierLoggingDisabled?: boolean | undefined;
+    }, ...args_1: unknown[]) => void;
+    sessionIdHandler?: (args_0: string, ...args_1: unknown[]) => void;
+    loveLetterHandler?: (args_0: {
+        type?: "letter";
+        reason?: string;
+        code?: number;
+        verbosity?: number;
+    }, ...args_1: unknown[]) => void;
+    fullscreenButton?: boolean;
+    settingsButton?: boolean;
+    infoButton?: boolean;
+    audioButton?: boolean;
+    micButton?: boolean;
+    stopButton?: boolean;
+    connectionStrengthIcon?: boolean;
+    shareId?: string;
+    projectId?: string;
+    loveLetterLogging?: boolean;
+    connectionIdentifierLoggingDisabled?: boolean;
 }>;
 export type Settings = z.infer<typeof ArcwareSettingsSchema>;

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

@@ -3,11 +3,11 @@ declare const ZOptions: z.ZodObject<{
     localStorageKey: z.ZodDefault<z.ZodString>;
     keepSession: z.ZodDefault<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    localStorageKey: string;
-    keepSession: number;
+    localStorageKey?: string;
+    keepSession?: number;
 }, {
-    localStorageKey?: string | undefined;
-    keepSession?: number | undefined;
+    localStorageKey?: string;
+    keepSession?: number;
 }>;
 type Options = z.infer<typeof ZOptions>;
 /** The sessionId is stored in the localStorage to allow for reconnection and
@@ -15,7 +15,7 @@ type Options = z.infer<typeof ZOptions>;
  */
 export declare class Session {
     private _current?;
-    get current(): string | undefined;
+    get current(): string;
     get noSession(): boolean;
     get id(): string | null;
     private options;

package/types/shared/lib/Messages/ErrorMessage.d.ts

@@ -5,14 +5,14 @@ export declare const ZErrorMessage: z.ZodObject<{
     reason: z.ZodString;
     verbosity: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    type: "error";
-    code: number;
-    reason: string;
-    verbosity: number;
+    type?: "error";
+    code?: number;
+    reason?: string;
+    verbosity?: number;
 }, {
-    type: "error";
-    code: number;
-    reason: string;
-    verbosity: number;
+    type?: "error";
+    code?: number;
+    reason?: string;
+    verbosity?: number;
 }>;
 export type ErrorMessage = z.infer<typeof ZErrorMessage>;

package/types/shared/lib/Messages/LoveLetter.d.ts

@@ -5,14 +5,14 @@ export declare const ZLoveLetter: z.ZodObject<{
     code: z.ZodNumber;
     verbosity: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    type: "letter";
-    code: number;
-    reason: string;
-    verbosity: number;
+    type?: "letter";
+    reason?: string;
+    code?: number;
+    verbosity?: number;
 }, {
-    type: "letter";
-    code: number;
-    reason: string;
-    verbosity: number;
+    type?: "letter";
+    reason?: string;
+    code?: number;
+    verbosity?: number;
 }>;
 export type LoveLetter = z.infer<typeof ZLoveLetter>;

package/types/shared/lib/Messages/Ping.d.ts

@@ -3,10 +3,10 @@ export declare const ZPing: z.ZodObject<{
     type: z.ZodLiteral<"ping">;
     message: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    type: "ping";
-    message: string;
+    type?: "ping";
+    message?: string;
 }, {
-    type: "ping";
-    message: string;
+    type?: "ping";
+    message?: string;
 }>;
 export type Ping = z.infer<typeof ZPing>;

package/types/shared/lib/Messages/Queue.d.ts

@@ -20,39 +20,39 @@ export declare const ZQueue: z.ZodObject<{
         /** Type of all time-values in the que. */
         valueType: z.ZodEnum<["milliseconds", "seconds", "minutes", "hours", "days"]>;
     }, "strip", z.ZodTypeAny, {
-        valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
-        index?: number | undefined;
-        queueLength?: number | undefined;
-        waited?: number | undefined;
-        estimatedWaitTime?: number | undefined;
-        averageWaitTime?: number | undefined;
+        index?: number;
+        queueLength?: number;
+        waited?: number;
+        estimatedWaitTime?: number;
+        averageWaitTime?: number;
+        valueType?: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
     }, {
-        valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
-        index?: number | undefined;
-        queueLength?: number | undefined;
-        waited?: number | undefined;
-        estimatedWaitTime?: number | undefined;
-        averageWaitTime?: number | undefined;
+        index?: number;
+        queueLength?: number;
+        waited?: number;
+        estimatedWaitTime?: number;
+        averageWaitTime?: number;
+        valueType?: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
     }>;
 }, "strip", z.ZodTypeAny, {
-    type: "queue";
-    queue: {
-        valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
-        index?: number | undefined;
-        queueLength?: number | undefined;
-        waited?: number | undefined;
-        estimatedWaitTime?: number | undefined;
-        averageWaitTime?: number | undefined;
+    type?: "queue";
+    queue?: {
+        index?: number;
+        queueLength?: number;
+        waited?: number;
+        estimatedWaitTime?: number;
+        averageWaitTime?: number;
+        valueType?: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
     };
 }, {
-    type: "queue";
-    queue: {
-        valueType: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
-        index?: number | undefined;
-        queueLength?: number | undefined;
-        waited?: number | undefined;
-        estimatedWaitTime?: number | undefined;
-        averageWaitTime?: number | undefined;
+    type?: "queue";
+    queue?: {
+        index?: number;
+        queueLength?: number;
+        waited?: number;
+        estimatedWaitTime?: number;
+        averageWaitTime?: number;
+        valueType?: "milliseconds" | "seconds" | "minutes" | "hours" | "days";
     };
 }>;
 export type Queue = z.infer<typeof ZQueue>;

package/types/shared/lib/Messages/SessionId.d.ts

@@ -3,10 +3,10 @@ export declare const ZSessionId: z.ZodObject<{
     type: z.ZodLiteral<"sessionId">;
     sessionId: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    type: "sessionId";
-    sessionId: string;
+    type?: "sessionId";
+    sessionId?: string;
 }, {
-    type: "sessionId";
-    sessionId: string;
+    type?: "sessionId";
+    sessionId?: string;
 }>;
 export type SessionId = z.infer<typeof ZSessionId>;