@epicgames-ps/lib-pixelstreamingfrontend-ue5.5 0.3.0 → 0.3.1

package/dist/esm/Config/SettingBase.js

@@ -1,95 +1,95 @@
-// Copyright Epic Games, Inc. All Rights Reserved.
-/**
- * Base class for a setting that has a text label and an arbitrary setting value it stores.
- */
-export class SettingBase {
-    constructor(id, label, description, defaultSettingValue, 
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    defaultOnChangeListener = () => {
-        /* Do nothing, to be overridden. */
-    }) {
-        this.parseURLParams();
-        this.onChange = defaultOnChangeListener;
-        this.onChangeEmit = () => {
-            /* Do nothing, to be overridden. */
-        };
-        this.id = id;
-        this.description = description;
-        this.label = label;
-        this.value = defaultSettingValue;
-    }
-    /**
-     * Set the label text for the setting.
-     * @param label setting label.
-     */
-    set label(inLabel) {
-        this._label = inLabel;
-        this.onChangeEmit(this._value);
-    }
-    /**
-     * @returns The label text for the setting.
-     */
-    get label() {
-        return this._label;
-    }
-    /**
-     * @return The setting's value.
-     */
-    get value() {
-        return this._value;
-    }
-    /**
-     * Update the setting's stored value.
-     * @param inValue The new value for the setting.
-     */
-    set value(inValue) {
-        this._value = inValue;
-        this.onChange(this._value, this);
-        this.onChangeEmit(this._value);
-    }
-    /**
-     * Persist the setting value in URL.
-     */
-    updateURLParams() {
-        if (this.useUrlParams) {
-            // set url params
-            const urlParams = new URLSearchParams(window.location.search);
-            const valueString = this.getValueAsString();
-            let set = false;
-            for (const [name, _value] of urlParams) {
-                if (name.toLowerCase() == this.id.toLowerCase()) {
-                    urlParams.set(name, valueString);
-                    set = true;
-                    break;
-                }
-            }
-            if (!set) {
-                urlParams.set(this.id, valueString);
-            }
-            window.history.replaceState({}, '', urlParams.toString() !== '' ? `${location.pathname}?${urlParams}` : `${location.pathname}`);
-        }
-    }
-    /**
-     * Allows sub types to provide their value for the url search params.
-     */
-    getValueAsString() {
-        return '';
-    }
-    parseURLParams() {
-        this._urlParams = {};
-        const params = new URLSearchParams(window.location.search);
-        for (const [name, value] of params) {
-            this._urlParams[name.toLowerCase()] = value;
-        }
-    }
-    hasURLParam(name) {
-        return name.toLowerCase() in this._urlParams;
-    }
-    getURLParam(name) {
-        if (this.hasURLParam(name)) {
-            return this._urlParams[name.toLowerCase()];
-        }
-        return '';
-    }
-}
+// Copyright Epic Games, Inc. All Rights Reserved.
+/**
+ * Base class for a setting that has a text label and an arbitrary setting value it stores.
+ */
+export class SettingBase {
+    constructor(id, label, description, defaultSettingValue, 
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    defaultOnChangeListener = () => {
+        /* Do nothing, to be overridden. */
+    }) {
+        this.parseURLParams();
+        this.onChange = defaultOnChangeListener;
+        this.onChangeEmit = () => {
+            /* Do nothing, to be overridden. */
+        };
+        this.id = id;
+        this.description = description;
+        this.label = label;
+        this.value = defaultSettingValue;
+    }
+    /**
+     * Set the label text for the setting.
+     * @param label setting label.
+     */
+    set label(inLabel) {
+        this._label = inLabel;
+        this.onChangeEmit(this._value);
+    }
+    /**
+     * @returns The label text for the setting.
+     */
+    get label() {
+        return this._label;
+    }
+    /**
+     * @return The setting's value.
+     */
+    get value() {
+        return this._value;
+    }
+    /**
+     * Update the setting's stored value.
+     * @param inValue The new value for the setting.
+     */
+    set value(inValue) {
+        this._value = inValue;
+        this.onChange(this._value, this);
+        this.onChangeEmit(this._value);
+    }
+    /**
+     * Persist the setting value in URL.
+     */
+    updateURLParams() {
+        if (this.useUrlParams) {
+            // set url params
+            const urlParams = new URLSearchParams(window.location.search);
+            const valueString = this.getValueAsString();
+            let set = false;
+            for (const [name, _value] of urlParams) {
+                if (name.toLowerCase() == this.id.toLowerCase()) {
+                    urlParams.set(name, valueString);
+                    set = true;
+                    break;
+                }
+            }
+            if (!set) {
+                urlParams.set(this.id, valueString);
+            }
+            window.history.replaceState({}, '', urlParams.toString() !== '' ? `${location.pathname}?${urlParams}` : `${location.pathname}`);
+        }
+    }
+    /**
+     * Allows sub types to provide their value for the url search params.
+     */
+    getValueAsString() {
+        return '';
+    }
+    parseURLParams() {
+        this._urlParams = {};
+        const params = new URLSearchParams(window.location.search);
+        for (const [name, value] of params) {
+            this._urlParams[name.toLowerCase()] = value;
+        }
+    }
+    hasURLParam(name) {
+        return name.toLowerCase() in this._urlParams;
+    }
+    getURLParam(name) {
+        if (this.hasURLParam(name)) {
+            return this._urlParams[name.toLowerCase()];
+        }
+        return '';
+    }
+}
 //# sourceMappingURL=SettingBase.js.map

package/dist/esm/Config/SettingFlag.js

@@ -1,46 +1,46 @@
-// Copyright Epic Games, Inc. All Rights Reserved.
-import { SettingBase } from './SettingBase';
-/**
- * A boolean flag setting object with a text label.
- */
-export class SettingFlag extends SettingBase {
-    constructor(id, label, description, defaultFlagValue, useUrlParams, 
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    defaultOnChangeListener = () => {
-        /* Do nothing, to be overridden. */
-    }) {
-        super(id, label, description, defaultFlagValue, defaultOnChangeListener);
-        if (!useUrlParams || !this.hasURLParam(this.id)) {
-            this.flag = defaultFlagValue;
-        }
-        else {
-            // parse flag from url parameters
-            const urlParamFlag = this.getURLParam(this.id);
-            this.flag = urlParamFlag.toLowerCase() != 'false';
-        }
-        this.useUrlParams = useUrlParams;
-    }
-    getValueAsString() {
-        return this.flag ? 'true' : 'false';
-    }
-    /**
-     * Enables this flag.
-     */
-    enable() {
-        this.flag = true;
-    }
-    /**
-     * @return The setting's value.
-     */
-    get flag() {
-        return !!this.value;
-    }
-    /**
-     * Update the setting's stored value.
-     * @param inValue The new value for the setting.
-     */
-    set flag(inValue) {
-        this.value = inValue;
-    }
-}
+// Copyright Epic Games, Inc. All Rights Reserved.
+import { SettingBase } from './SettingBase';
+/**
+ * A boolean flag setting object with a text label.
+ */
+export class SettingFlag extends SettingBase {
+    constructor(id, label, description, defaultFlagValue, useUrlParams, 
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    defaultOnChangeListener = () => {
+        /* Do nothing, to be overridden. */
+    }) {
+        super(id, label, description, defaultFlagValue, defaultOnChangeListener);
+        if (!useUrlParams || !this.hasURLParam(this.id)) {
+            this.flag = defaultFlagValue;
+        }
+        else {
+            // parse flag from url parameters
+            const urlParamFlag = this.getURLParam(this.id);
+            this.flag = urlParamFlag.toLowerCase() != 'false';
+        }
+        this.useUrlParams = useUrlParams;
+    }
+    getValueAsString() {
+        return this.flag ? 'true' : 'false';
+    }
+    /**
+     * Enables this flag.
+     */
+    enable() {
+        this.flag = true;
+    }
+    /**
+     * @return The setting's value.
+     */
+    get flag() {
+        return !!this.value;
+    }
+    /**
+     * Update the setting's stored value.
+     * @param inValue The new value for the setting.
+     */
+    set flag(inValue) {
+        this.value = inValue;
+    }
+}
 //# sourceMappingURL=SettingFlag.js.map

package/dist/esm/Config/SettingNumber.js

@@ -1,80 +1,80 @@
-// Copyright Epic Games, Inc. All Rights Reserved.
-import { SettingBase } from './SettingBase';
-/**
- * A number setting object with a text label. Min and max limit the range of allowed values.
- */
-export class SettingNumber extends SettingBase {
-    constructor(id, label, description, min, max, defaultNumber, useUrlParams, 
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    defaultOnChangeListener = () => {
-        /* Do nothing, to be overridden. */
-    }) {
-        super(id, label, description, defaultNumber, defaultOnChangeListener);
-        this._min = min;
-        this._max = max;
-        // attempt to read the number from the url params
-        if (!useUrlParams || !this.hasURLParam(this.id)) {
-            this.number = defaultNumber;
-        }
-        else {
-            const parsedValue = Number.parseFloat(this.getURLParam(this.id));
-            this.number = Number.isNaN(parsedValue) ? defaultNumber : parsedValue;
-        }
-        this.useUrlParams = useUrlParams;
-    }
-    getValueAsString() {
-        return this.number.toString();
-    }
-    /**
-     * Set the number value (will be clamped within range).
-     */
-    set number(newNumber) {
-        this.value = this.clamp(newNumber);
-    }
-    /**
-     * @returns The number stored.
-     */
-    get number() {
-        return this.value;
-    }
-    /**
-     * Clamps a number between the min and max values (inclusive).
-     * @param inNumber The number to clamp.
-     * @returns The clamped number.
-     */
-    clamp(inNumber) {
-        if (this._min == null && this._max == null) {
-            return inNumber;
-        }
-        else if (this._min == null) {
-            return Math.min(this._max, inNumber);
-        }
-        else if (this._max == null) {
-            return Math.max(this._min, inNumber);
-        }
-        else {
-            return Math.max(Math.min(this._max, inNumber), this._min);
-        }
-    }
-    /**
-     * Returns the minimum value
-     * @returns The minimum value
-     */
-    get min() {
-        return this._min;
-    }
-    /**
-     * Returns the maximum value
-     * @returns The maximum value
-     */
-    get max() {
-        return this._max;
-    }
-    /**
-     * Add a change listener to the number object.
-     */
-    addOnChangedListener(onChangedFunc) {
-        this.onChange = onChangedFunc;
-    }
-}
+// Copyright Epic Games, Inc. All Rights Reserved.
+import { SettingBase } from './SettingBase';
+/**
+ * A number setting object with a text label. Min and max limit the range of allowed values.
+ */
+export class SettingNumber extends SettingBase {
+    constructor(id, label, description, min, max, defaultNumber, useUrlParams, 
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    defaultOnChangeListener = () => {
+        /* Do nothing, to be overridden. */
+    }) {
+        super(id, label, description, defaultNumber, defaultOnChangeListener);
+        this._min = min;
+        this._max = max;
+        // attempt to read the number from the url params
+        if (!useUrlParams || !this.hasURLParam(this.id)) {
+            this.number = defaultNumber;
+        }
+        else {
+            const parsedValue = Number.parseFloat(this.getURLParam(this.id));
+            this.number = Number.isNaN(parsedValue) ? defaultNumber : parsedValue;
+        }
+        this.useUrlParams = useUrlParams;
+    }
+    getValueAsString() {
+        return this.number.toString();
+    }
+    /**
+     * Set the number value (will be clamped within range).
+     */
+    set number(newNumber) {
+        this.value = this.clamp(newNumber);
+    }
+    /**
+     * @returns The number stored.
+     */
+    get number() {
+        return this.value;
+    }
+    /**
+     * Clamps a number between the min and max values (inclusive).
+     * @param inNumber The number to clamp.
+     * @returns The clamped number.
+     */
+    clamp(inNumber) {
+        if (this._min == null && this._max == null) {
+            return inNumber;
+        }
+        else if (this._min == null) {
+            return Math.min(this._max, inNumber);
+        }
+        else if (this._max == null) {
+            return Math.max(this._min, inNumber);
+        }
+        else {
+            return Math.max(Math.min(this._max, inNumber), this._min);
+        }
+    }
+    /**
+     * Returns the minimum value
+     * @returns The minimum value
+     */
+    get min() {
+        return this._min;
+    }
+    /**
+     * Returns the maximum value
+     * @returns The maximum value
+     */
+    get max() {
+        return this._max;
+    }
+    /**
+     * Add a change listener to the number object.
+     */
+    addOnChangedListener(onChangedFunc) {
+        this.onChange = onChangedFunc;
+    }
+}
 //# sourceMappingURL=SettingNumber.js.map

package/dist/esm/Config/SettingOption.js

@@ -1,81 +1,81 @@
-// Copyright Epic Games, Inc. All Rights Reserved.
-import { Logger } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';
-import { SettingBase } from './SettingBase';
-/**
- * An Option setting object with a text label. Allows you to specify an array of options and select one of them.
- */
-export class SettingOption extends SettingBase {
-    constructor(id, label, description, defaultTextValue, options, useUrlParams, 
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    defaultUrlParamResolver = function (value) {
-        /* Return the string as-is by default */
-        return value;
-    }, 
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    defaultOnChangeListener = () => {
-        /* Do nothing, to be overridden. */
-    }) {
-        super(id, label, description, defaultTextValue, defaultOnChangeListener);
-        this._urlParamResolver = defaultUrlParamResolver;
-        const stringToMatch = this.hasURLParam(this.id)
-            ? this._urlParamResolver(this.getURLParam(this.id))
-            : defaultTextValue;
-        this.options = options !== null && options !== void 0 ? options : [stringToMatch];
-        this.selected = stringToMatch;
-        this.useUrlParams = useUrlParams;
-    }
-    getValueAsString() {
-        return this.selected;
-    }
-    /**
-     * Add a change listener to the select element.
-     */
-    addOnChangedListener(onChangedFunc) {
-        this.onChange = onChangedFunc;
-    }
-    /**
-     * @returns All available options as an array
-     */
-    get options() {
-        return this._options;
-    }
-    /**
-     * Set options
-     * @param values Array of options
-     */
-    set options(values) {
-        this._options = values;
-        this.onChangeEmit(this.selected);
-    }
-    /**
-     * @returns Selected option as a string
-     */
-    get selected() {
-        return this.value;
-    }
-    /**
-     * Set selected option if it matches one of the available options
-     * @param value Selected option
-     */
-    set selected(value) {
-        if (value === undefined) {
-            return;
-        }
-        // If options contains the value, then set that as selected
-        if (this.options.includes(value)) {
-            this.value = value;
-        }
-        else {
-            Logger.Error(`Could not set "${value}" as the selected option for ${this.id} because it wasn't one of the options.`);
-        }
-    }
-    /**
-     * Set the url parameter resolver to do some transformation to the string value
-     * that is extracted from the url parameters.
-     * @param urlParam A function that transforms the extracted url parameter string for this setting to something else.
-     */
-    set urlParamResolver(value) {
-        this._urlParamResolver = value;
-    }
-}
+// Copyright Epic Games, Inc. All Rights Reserved.
+import { Logger } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';
+import { SettingBase } from './SettingBase';
+/**
+ * An Option setting object with a text label. Allows you to specify an array of options and select one of them.
+ */
+export class SettingOption extends SettingBase {
+    constructor(id, label, description, defaultTextValue, options, useUrlParams, 
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    defaultUrlParamResolver = function (value) {
+        /* Return the string as-is by default */
+        return value;
+    }, 
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    defaultOnChangeListener = () => {
+        /* Do nothing, to be overridden. */
+    }) {
+        super(id, label, description, defaultTextValue, defaultOnChangeListener);
+        this._urlParamResolver = defaultUrlParamResolver;
+        const stringToMatch = this.hasURLParam(this.id)
+            ? this._urlParamResolver(this.getURLParam(this.id))
+            : defaultTextValue;
+        this.options = options !== null && options !== void 0 ? options : [stringToMatch];
+        this.selected = stringToMatch;
+        this.useUrlParams = useUrlParams;
+    }
+    getValueAsString() {
+        return this.selected;
+    }
+    /**
+     * Add a change listener to the select element.
+     */
+    addOnChangedListener(onChangedFunc) {
+        this.onChange = onChangedFunc;
+    }
+    /**
+     * @returns All available options as an array
+     */
+    get options() {
+        return this._options;
+    }
+    /**
+     * Set options
+     * @param values Array of options
+     */
+    set options(values) {
+        this._options = values;
+        this.onChangeEmit(this.selected);
+    }
+    /**
+     * @returns Selected option as a string
+     */
+    get selected() {
+        return this.value;
+    }
+    /**
+     * Set selected option if it matches one of the available options
+     * @param value Selected option
+     */
+    set selected(value) {
+        if (value === undefined) {
+            return;
+        }
+        // If options contains the value, then set that as selected
+        if (this.options.includes(value)) {
+            this.value = value;
+        }
+        else {
+            Logger.Error(`Could not set "${value}" as the selected option for ${this.id} because it wasn't one of the options.`);
+        }
+    }
+    /**
+     * Set the url parameter resolver to do some transformation to the string value
+     * that is extracted from the url parameters.
+     * @param urlParam A function that transforms the extracted url parameter string for this setting to something else.
+     */
+    set urlParamResolver(value) {
+        this._urlParamResolver = value;
+    }
+}
 //# sourceMappingURL=SettingOption.js.map