roku-deploy - npm Package Compare versions

Comparing version 3.10.5 to 3.11.0

CHANGELOG.md

@@ -9,2 +9,8 @@ # Changelog
 
+## [3.11.0](https://github.com/rokucommunity/roku-deploy/compare/v3.10.5...v3.11.0) - 2023-11-28
+### Changed
+ - Add public function `normalizeDeviceInfoFieldValue` to normalize device-info field values ([#129](https://github.com/rokucommunity/roku-deploy/pull/129))
+
+
+
 ## [3.10.5](https://github.com/rokucommunity/roku-deploy/compare/v3.10.4...v3.10.5) - 2023-11-14
@@ -11,0 +17,0 @@ ### Changed

dist/RokuDeploy.d.ts

@@ -197,2 +197,8 @@ /// <reference types="node" />
     getDeviceInfo(options?: GetDeviceInfoOptions): Promise<DeviceInfoRaw>;
+    /**
+     * Normalize a deviceInfo field value. This includes things like converting boolean strings to booleans, number strings to numbers,
+     * decoding HtmlEntities, etc.
+     * @param deviceInfo
+     */
+    normalizeDeviceInfoFieldValue(value: any): string | number | boolean;
     getDevId(options?: RokuDeployOptions): Promise<any>;
@@ -199,0 +205,0 @@ parseManifest(manifestPath: string): Promise<ManifestData>;

dist/RokuDeploy.js

@@ -886,23 +886,7 @@ "use strict";
             if (options.enhance) {
-                // convert 'true' and 'false' string values to boolean
+                const result = {};
+                // sanitize/normalize values to their native formats, and also convert property names to camelCase
                 for (let key in deviceInfo) {
-                    if (deviceInfo[key] === 'true') {
-                        deviceInfo[key] = true;
-                    }
-                    else if (deviceInfo[key] === 'false') {
-                        deviceInfo[key] = false;
-                    }
+                    result[lodash.camelCase(key)] = this.normalizeDeviceInfoFieldValue(deviceInfo[key]);
                 }
-                // convert the following string values into numbers
-                const numberFields = ['software-build', 'uptime', 'trc-version', 'av-sync-calibration-enabled', 'time-zone-offset'];
-                for (const field of numberFields) {
-                    if (deviceInfo.hasOwnProperty(field)) {
-                        deviceInfo[field] = parseInt(deviceInfo[field]);
-                    }
-                }
-                //convert the property names to camel case
-                const result = {};
-                for (const key in deviceInfo) {
-                    result[lodash.camelCase(key)] = deviceInfo[key];
-                }
                 deviceInfo = result;
@@ -916,2 +900,23 @@ }
     }
+    /**
+     * Normalize a deviceInfo field value. This includes things like converting boolean strings to booleans, number strings to numbers,
+     * decoding HtmlEntities, etc.
+     * @param deviceInfo
+     */
+    normalizeDeviceInfoFieldValue(value) {
+        let num;
+        // convert 'true' and 'false' string values to boolean
+        if (value === 'true') {
+            return true;
+        }
+        else if (value === 'false') {
+            return false;
+        }
+        else if (value.trim() !== '' && !isNaN(num = Number(value))) {
+            return num;
+        }
+        else {
+            return util_1.util.decodeHtmlEntities(value);
+        }
+    }
     async getDevId(options) {
@@ -918,0 +923,0 @@ const deviceInfo = await this.getDeviceInfo(options);

dist/util.d.ts

@@ -54,2 +54,6 @@ export declare class Util {
     private dnsCache;
+    /**
+     * Decode HTML entities like   ' to its original character
+     */
+    decodeHtmlEntities(encodedString: string): string;
 }
@@ -56,0 +60,0 @@ export declare let util: Util;

dist/util.js

@@ -201,2 +201,21 @@ "use strict";
     }
+    /**
+     * Decode HTML entities like   ' to its original character
+     */
+    decodeHtmlEntities(encodedString) {
+        let translateRegex = /&(nbsp|amp|quot|lt|gt);/g;
+        let translate = {
+            'nbsp': ' ',
+            'amp': '&',
+            'quot': '"',
+            'lt': '<',
+            'gt': '>'
+        };
+        return encodedString.replace(translateRegex, (match, entity) => {
+            return translate[entity];
+        }).replace(/&#(\d+);/gi, (match, numStr) => {
+            let num = parseInt(numStr, 10);
+            return String.fromCharCode(num);
+        });
+    }
 }
@@ -203,0 +222,0 @@ exports.Util = Util;

package.json

 {
     "name": "roku-deploy",
-    "version": "3.10.5",
+    "version": "3.11.0",
     "description": "Package and publish a Roku application using Node.js",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

No alert changes

Improved metrics

Total package byte prevSize

182449

0.92%

Lines of code

2385

1.45%

No dependency changes