v3.1.1 - Update modules (#252)

* Update modules, node 18 (#250) * Use .nvmrc (Node 16) and update some modules * Fix modules marked as critical vulnerabilities * Update a few more packages * Rev Node version to 18 (LTS) * Replace tslint (deprecated) with eslint * Rev version * Note on full HD and scalable video (#251) * Note on full HD and scalable video * Set scalable video as default in sample app * README correction * adress PR comments * Typo correction --------- Co-authored-by: Ben <[email protected]> --------- Co-authored-by: Ben <[email protected]>
opentok · Jul 14, 2023 · 89c028f · 89c028f
1 parent 6fad234
commit 89c028f
Show file tree

Hide file tree

Showing 19 changed files with 17,481 additions and 16,137 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,151 @@
+module.exports = {
+    "env": {
+        "browser": true,
+        "es6": true,
+        "node": true
+    },
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "project": "tsconfig.json",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint",
+        "@typescript-eslint/tslint"
+    ],
+    "root": true,
+    "rules": {
+        "@typescript-eslint/indent": [
+            "error",
+            2,
+            {
+                "ArrayExpression": "first",
+                "ObjectExpression": "first",
+                "FunctionDeclaration": {
+                    "parameters": "first"
+                },
+                "FunctionExpression": {
+                    "parameters": "first"
+                }
+            }
+        ],
+        "@typescript-eslint/member-delimiter-style": [
+            "error",
+            {
+                "multiline": {
+                    "delimiter": "semi",
+                    "requireLast": true
+                },
+                "singleline": {
+                    "delimiter": "semi",
+                    "requireLast": false
+                }
+            }
+        ],
+        "@typescript-eslint/naming-convention": [
+            "error",
+            {
+                "selector": "variable",
+                "format": [
+                    "camelCase",
+                    "UPPER_CASE"
+                ],
+                "leadingUnderscore": "forbid",
+                "trailingUnderscore": "forbid"
+            }
+        ],
+        "@typescript-eslint/no-array-constructor": "error",
+        "@typescript-eslint/no-this-alias": "error",
+        "@typescript-eslint/no-unnecessary-boolean-literal-compare": "error",
+        "@typescript-eslint/quotes": [
+            "error",
+            "single",
+            {
+                "avoidEscape": true
+            }
+        ],
+        "@typescript-eslint/semi": [
+            "error",
+            "always"
+        ],
+        "arrow-parens": [
+            "off",
+            "always"
+        ],
+        "comma-dangle": [
+            "error",
+            "always-multiline"
+        ],
+        "curly": [
+            "error",
+            "multi-line"
+        ],
+        "eol-last": "error",
+        "eqeqeq": [
+            "error",
+            "smart"
+        ],
+        "id-denylist": "error",
+        "id-match": "error",
+        "indent": "off",
+        "max-len": [
+            "error",
+            {
+                "code": 120
+            }
+        ],
+        "no-array-constructor": "off",
+        "no-duplicate-imports": "error",
+        "no-eval": "error",
+        "no-multiple-empty-lines": "error",
+        "no-new-wrappers": "error",
+        "no-param-reassign": "error",
+        "no-trailing-spaces": "error",
+        "no-underscore-dangle": "error",
+        "no-var": "error",
+        "object-shorthand": "error",
+        "one-var": [
+            "error",
+            "never"
+        ],
+        "prefer-const": "error",
+        "prefer-template": "error",
+        "quote-props": [
+            "error",
+            "as-needed"
+        ],
+        "quotes": "off",
+        "radix": "error",
+        "semi": "off",
+        "space-before-function-paren": [
+            "error",
+            {
+                "anonymous": "always",
+                "named": "never"
+            }
+        ],
+        "spaced-comment": [
+            "error",
+            "always",
+            {
+                "markers": [
+                    "/"
+                ]
+            }
+        ],
+        "@typescript-eslint/tslint/config": [
+            "error",
+            {
+                "rules": {
+                    "whitespace": [
+                        true,
+                        "check-branch",
+                        "check-operator",
+                        "check-separator",
+                        "check-typecast"
+                    ],
+                }
+            }
+        ]
+    }
+};
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+18.16.1
diff --git a/DEVELOPING.md b/DEVELOPING.md
@@ -5,8 +5,10 @@ This document describes tools, tasks and workflow that one needs to be familiar
 ## Tools
 
 This project is developed with [TypeScript](https://www.typescriptlang.org/) and uses [Webpack](https://webpack.js.org/) to compile and bundle code into a browser-friendly UMD module.  To install the dependencies required for development, simply run:
+
 ```
-$ npm install
+nvm use # Or use Node 18 if you do not use nvm
+npm install
 ```
 
 ## Tasks

diff --git a/README.md b/README.md
@@ -256,7 +256,9 @@ The `OTNetworkTest()` constructor includes the following parameters:
     (`true`) or not (`false`, the default). Disabling scalable video
     was added in OpenTok.js version 2.24.7.
 
-  * `fullHd` (Boolean) -- (Optional) Allows publishing with a resolution of 1920x1080. If the camera does not support 1920x1080 resolution, OTNetworkTest.testConnectivity() method is rejected with  `UNSUPPORTED_RESOLUTION_ERROR` error.
+  * `fullHd` (Boolean) -- (Optional) Allows publishing with a resolution of 1920x1080 (1080p).
+    If the camera does not support 1920x1080 resolution, the `OTNetworkTest.testConnectivity()` method
+    is rejected with an `UNSUPPORTED_RESOLUTION_ERROR` error. We highly recommend set `scalableVideo` setting to `true` when testing full HD resolution. Without `scalableVideo`, the client may not reach full HD resolution during the test period.
 
   The `options` parameter is optional.
 
@@ -425,7 +427,7 @@ following properties:
       For example, `'No camera was found.'`
     
     * `qualityLimitationReason` (String) --  Indicates the reason behind
-       the highest resolution tested failing. It can have values: `'cpu'` for CPU overload, `'bandwidth'` for insufficient network bandwidth, or value is `'null'` if there is no limitation.
+       the highest resolution tested failing. It can have values: `'cpu'` for CPU overload, `'bandwidth'` for insufficient network bandwidth, or value is `null` if there is no limitation.
 
     * `bitrate` (Number) -- The average number of video bits per second during the last
       five seconds of the test. If the the test ran in audio-only mode (for example, because