node-red 2.2.2 → 3.0.0-beta.3

package/CHANGELOG.md

@@ -1,3 +1,154 @@
+#### 3.0.0-beta.3: Beta Release
+
+Editor
+
+ - Add Right-Click content menu (#3678) @knolleary
+ - Fix disable junction (#3671) @HiroyasuNishiyama
+ - Add Japanese translations for v2.2.3 (#3672) @kazuhitoyokoi
+ - Reset mouse state when switching tabs (#3643) @knolleary
+ - Fix uncorrect fix of junction to subflow conversion (#3666) @HiroyasuNishiyama
+ - Fix undoing junction to subflow (#3653) @HiroyasuNishiyama
+ - Fix conversion of junction to subflow (#3652) @HiroyasuNishiyama
+ - Fix to include junction to exported nodes (#3650) @HiroyasuNishiyama
+ - Fix z-index value for shade to cover nodes in palette (#3649) @kazuhitoyokoi
+ - Fix to extend escaped subflow category characters (#3647) @HiroyasuNishiyama
+ - Fix to sanitize tab name (#3646) @HiroyasuNishiyama
+ - Fix selector placement (#3644) @bonanitech
+ - Add Japanese translations for v3.0-beta.2 (#3622) @kazuhitoyokoi
+ - Fix new folder menu of save to library dialog (#3633) @HiroyasuNishiyama
+ - Fix layer of palette node (#3638) @HiroyasuNishiyama
+ - Fix to place a node dragged from palette within the workspace (#3637) @HiroyasuNishiyama
+ - Fix typo in CSS (#3628) @bonanitech
+ - Use the correct variable for the gutter text color (#3615) @bonanitech
+
+
+Runtime
+
+ - Support loading node modules from `nodesdir` (#3676) @Steve-Mcl
+ - fix buffer parse error message of evaluateNodeProperty (#3624) @HiroyasuNishiyama
+
+Nodes
+
+ - File: Further simplify file node filename entry UX (v3) (#3677) @Steve-Mcl
+ - Function: Fix initial cursor position of init/finalize tab of function node (#3674) @HiroyasuNishiyama
+ - Function: Fix ESM module loading in Function node (#3645) @knolleary
+ - Inject: Fix JSONata evaluation of inject button (#3632) @HiroyasuNishiyama
+ - TCP: Dont delete TCP socket twice (#3630) @Steve-Mcl
+ - MQTT Node: define noproxy variable (#3626) @Steve-Mcl
+ - Debug: i18n debug sidebar node label (#3623) @HiroyasuNishiyama
+
+#### 3.0.0-beta.2: Beta Release
+
+**Migration from 2.x**
+
+ - The 'slice wires' action has changed from Ctrl-RightMouseButton to Alt-LeftMouseButton
+
+Editor
+
+ - Rework Junctions to be more node like in their event handling (#3607) @knolleary
+ - Change slicing / slice-junction operations over to mouse button 0 (Left Mouse Button) (#3609) @Steve-Mcl
+ - Do not slice-junction link node wires (#3608) @knolleary
+ - Handle many-to-one slicing of wires (#3604) @knolleary
+ - Ensure ACE worker options are set (#3611) @Steve-Mcl
+ - Remove duplicate history add of ungroup event (#3605) @knolleary
+ - use text width instead of number of characters for deciding select fi… (#3603) @HiroyasuNishiyama
+ - Update Japanese info of link call node reflecting update of English info (#3600) @HiroyasuNishiyama
+ - Fix typedInput label not visible on themes (#3580) @bonanitech
+ - Fix project switching when junctions are present (#3595) @Steve-Mcl
+ - Fix junction: when wiring from a regular nodes INPUT, backwards to a junction (#3591) @Steve-Mcl
+ - Fix error initialising flow tab editor (#3585) @Steve-Mcl
+ - Add Japanese translations for v3.0-beta.1 (#3576) @kazuhitoyokoi
+ - Fix image paths where `red/image/typedInput/XXXX.png` should be `red/image/typedInput/XXXX.svg` (#3592) @kazuhitoyokoi
+ - Fix browser console error Uncaught TypeError when searching certain terms (#3584) @Steve-Mcl
+
+Runtime
+
+ - fix error on system-info action (#3589) @HiroyasuNishiyama
+
+Nodes
+
+ - I18n switch rule selector (#3602) @HiroyasuNishiyama
+ - Handle removal of event handlers to allow mqtt client.end() to work (#3594) @PhilDay-CT
+ - update link-call node info according to current behavior (#3597) @HiroyasuNishiyama
+
+
+#### 3.0.0-beta.1: Beta Release
+
+**Migration from 2.x**
+
+ - Node-RED now requires Node.js 14.x or later.
+ - New installs of Node-RED will default to the monaco editor.
+
+
+Editor
+
+ - Add Junctions (#3462) @knolleary
+ - Allow node name to be auto-generated when added (#3478, #3538) @knolleary
+ - Set monaco as default code editor as of v3.x (#3543) @Steve-Mcl
+ - Update Monaco to V0.33.0 (#3522) @Steve-Mcl
+ - Auto-complete Improvements (#3521) @Steve-Mcl
+ - Add a tooltip to debug sidebar messages to reveal full path to node (#3503) @knolleary
+ - Fix down arrow triggering menu in search box (#3507) @Steve-Mcl
+ - Add Japanese translations for v3.0 (#3512) @kazuhitoyokoi
+ - Add feature: Continuous search tools (search previous, search next) (#3405) @Steve-Mcl
+ - Add feature: split-wire-to-links (#3399, #3476) @Steve-Mcl
+ - Add copy button to node properties tables (#3390) @knolleary
+ - Add info-tab search options dropdown to the regular search (#3395) @Steve-Mcl
+ - New Feature: Add ability to find modified nodes/flows. (#3392) @Steve-Mcl
+ - Code editor ux improvements around remembering state of each code editor in a flow (#3553) @Steve-Mcl
+ - Make it easier to apply themes on SVG icons (#3515) @bonanitech
+ - Add support of property validation message (#3438) @HiroyasuNishiyama
+ - Ensure node validation tooltip is closed when field becomes valid (#3570) @knolleary
+ - Add "search for" buttons to notifications (#3567) @Steve-Mcl
+ - Don't let themes change node config colors (#3564) @bonanitech
+ - Fix gap between typedInput containers borders (#3560) @bonanitech
+ - Fix recording removed links in edit history (#3547) @knolleary
+ - Remove unused SASS vars (#3536) @bonanitech
+ - Add custom style for jQuery widgets borders (#3537) @bonanitech
+ - fix out of scope reference of hasUnusedConfig variable (#3535) @HiroyasuNishiyama
+ - correct "non string" check parenthesis (#3524) @Steve-Mcl
+ - Ensure i18n of scoped package name (#3516) @Steve-Mcl
+ - Prevent shortcut deploy when deploy button shaded (#3517) @Steve-Mcl
+ - Fix: Sidebar "Configuration" filter button tooltip (#3500) @ralphwetzel
+ - Add the ability to customize diff colors even more (#3499) @bonanitech
+ - Do JSON comparison of old value/new value in editor (#3481) @Steve-Mcl
+ - Fix nodes losing their wires when in an iframe (#3484) @zettca
+ - Improve scroll into view (#3468) @Steve-Mcl
+ - Do not show 1st tab if hidden when loading (#3464) @Steve-Mcl
+
+Runtime
+
+ - Fix importing external module from node-red module (#3541) @knolleary
+ - Add support for multiple static paths with optional static root (#3542) @Steve-Mcl
+ - Store external token when authenticating if provided (#3460) @ArFe
+ - Support OAuth/OpenID logout (#3388) @mw75
+ - Allow adminAuth to auto-login users when using passport strategy (#3519) @knolleary
+ - Add runtime diagnostics admin endpoint (#3511) @Steve-Mcl
+ - Don't start if user has no home directory (#3540) @hardillb
+ - Error on invalid encrypted credentials (#3498) @sammachin
+
+Nodes
+
+ - Debug: Add message count option to Debug status (#3544 #3551) @rafaelmuynarsk @knolleary
+ - File: Change basic Filename field to a typedInput (#3533) @Steve-Mcl
+ - HTTP Request: Add UI for Http Request node headers (#3488) @Steve-Mcl
+ - Inject: let inject optionally fire at start in only at time mode. (#3385) @dceejay
+ - Link Call: Dynamic link call (#3463) @Steve-Mcl
+ - Link Call: Display link targets of nodes in a regular flow, for Link Call nodes inside a subflow (#3528) @Steve-Mcl
+ - MQTT: MQTT payload auto parsing improvements (#3530) @Steve-Mcl
+ - MQTT: Add client and Runtime MQTT topic validation (#3563) @Steve-Mcl [dev]
+ - MQTT: save and restore v5 config user props (#3562) @Steve-Mcl
+ - MQTT: Fix incorrect MQTT status (#3552) @Steve-Mcl
+ - MQTT: fix reference error of msg.status in debug node (#3526) @HiroyasuNishiyama
+ - MQTT: Add unit tests for MQTT nodes (#3497) @Steve-Mcl
+ - MQTT: fix typo of will properties (#3502) @Steve-Mcl
+ - MQTT: ensure mqtt v5 props can be set false (#3472) @Steve-Mcl
+ - Switch: add check for NaN in is of type number to be false (#3409) @dceejay
+ - TCP: TCP node better split (#3465) @dceejay
+ - Watch: Update Watch node to use node-watch module (#3559 #3569) @knolleary
+ - WebSocket: call done after ws disconnects (#3531) @Steve-Mcl
+
+
 #### 2.2.2: Maintenance Release
 
 Nodes

package/lib/red.js

@@ -229,5 +229,12 @@ module.exports = {
      * @see @node-red/editor-api_auth
      * @memberof node-red
      */
-    auth: api.auth
+    auth: api.auth,
+
+    /**
+     * The editor authentication api.
+     * @see @node-red/editor-api_auth
+     * @memberof node-red
+     */
+    get diagnostics() { return api.diagnostics }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red",
-    "version": "2.2.2",
+    "version": "3.0.0-beta.3",
     "description": "Low-code programming for event-driven applications",
     "homepage": "http://nodered.org",
     "license": "Apache-2.0",
@@ -31,22 +31,22 @@
         "flow"
     ],
     "dependencies": {
-        "@node-red/editor-api": "2.2.2",
-        "@node-red/runtime": "2.2.2",
-        "@node-red/util": "2.2.2",
-        "@node-red/nodes": "2.2.2",
+        "@node-red/editor-api": "3.0.0-beta.3",
+        "@node-red/runtime": "3.0.0-beta.3",
+        "@node-red/util": "3.0.0-beta.3",
+        "@node-red/nodes": "3.0.0-beta.3",
         "basic-auth": "2.0.1",
         "bcryptjs": "2.4.3",
-        "express": "4.17.2",
-        "fs-extra": "10.0.0",
-        "node-red-admin": "^2.2.3",
+        "express": "4.18.1",
+        "fs-extra": "10.1.0",
+        "node-red-admin": "^3.0.0",
         "nopt": "5.0.0",
-        "semver": "7.3.5"
+        "semver": "7.3.7"
     },
     "optionalDependencies": {
         "bcrypt": "5.0.1"
     },
     "engines": {
-        "node": ">=12"
+        "node": ">=14"
     }
 }

package/red.js

@@ -112,6 +112,10 @@ if (parsedArgs.settings) {
         // Consider compatibility for older versions
         settingsFile = path.join(process.env.HOMEPATH,".node-red","settings.js");
     } else {
+        if (!parsedArgs.userDir && !(process.env.HOME || process.env.USERPROFILE || process.env.HOMEPATH)) {
+            console.log("Could not find user directory. Ensure $HOME is set for the current user, or use --userDir option")
+            process.exit(1)
+        }
         var userDir = parsedArgs.userDir || path.join(process.env.HOME || process.env.USERPROFILE || process.env.HOMEPATH,".node-red");
         var userSettingsFile = path.join(userDir,"settings.js");
         if (fs.existsSync(userSettingsFile)) {
@@ -298,6 +302,26 @@ httpsPromise.then(function(startupHttps) {
         settings.httpNodeAuth = settings.httpNodeAuth || settings.httpAuth;
     }
 
+    if(settings.httpStatic) {
+        settings.httpStaticRoot = formatRoot(settings.httpStaticRoot || "/");
+        const statics = Array.isArray(settings.httpStatic) ? settings.httpStatic : [settings.httpStatic];
+        const sanitised = [];
+        for (let si = 0; si < statics.length; si++) {
+            let sp = statics[si];
+            if(typeof sp === "string") {
+                sp = { path: sp, root: "" }
+                sanitised.push(sp);
+            } else if (typeof sp === "object" && sp.path ) {
+                sanitised.push(sp);
+            } else {
+                continue;
+            }
+            sp.subRoot = formatRoot(sp.root);
+            sp.root = formatRoot(path.posix.join(settings.httpStaticRoot,sp.subRoot));
+        }
+        settings.httpStatic = sanitised.length ? sanitised : false;    
+    }
+
     // if we got a port from command line, use it (even if 0)
     // replicate (settings.uiPort = parsedArgs.port||settings.uiPort||1880;) but allow zero
     if (parsedArgs.port !== undefined){
@@ -390,12 +414,28 @@ httpsPromise.then(function(startupHttps) {
     if (settings.httpNodeRoot !== false) {
         app.use(settings.httpNodeRoot,RED.httpNode);
     }
+    // if (settings.httpStatic) {
+    //     settings.httpStaticAuth = settings.httpStaticAuth || settings.httpAuth;
+    //     if (settings.httpStaticAuth) {
+    //         app.use("/",basicAuthMiddleware(settings.httpStaticAuth.user,settings.httpStaticAuth.pass));
+    //     }
+    //     app.use("/",express.static(settings.httpStatic));
+    // }
     if (settings.httpStatic) {
-        settings.httpStaticAuth = settings.httpStaticAuth || settings.httpAuth;
-        if (settings.httpStaticAuth) {
-            app.use("/",basicAuthMiddleware(settings.httpStaticAuth.user,settings.httpStaticAuth.pass));
+        let appUseMem = {};
+        for (let si = 0; si < settings.httpStatic.length; si++) {
+            const sp = settings.httpStatic[si];
+            const filePath = sp.path;
+            const thisRoot = sp.root || "/";
+            if(appUseMem[filePath + "::" + thisRoot]) {
+                continue;// this path and root already registered!
+            }
+            appUseMem[filePath + "::" + thisRoot] = true;
+            if (settings.httpStaticAuth) {
+                app.use(thisRoot, basicAuthMiddleware(settings.httpStaticAuth.user, settings.httpStaticAuth.pass));
+            }
+            app.use(thisRoot, express.static(filePath));
         }
-        app.use("/",express.static(settings.httpStatic));
     }
 
     function getListenPath() {

package/settings.js

@@ -137,6 +137,7 @@ module.exports = {
  *  - httpNodeCors
  *  - httpNodeMiddleware
  *  - httpStatic
+ *  - httpStaticRoot
  ******************************************************************************/
 
     /** the tcp port that the Node-RED web server is listening on */
@@ -218,92 +219,123 @@ module.exports = {
     /** When httpAdminRoot is used to move the UI to a different root path, the
      * following property can be used to identify a directory of static content
      * that should be served at http://localhost:1880/.
+     * When httpStaticRoot is set differently to httpAdminRoot, there is no need 
+     * to move httpAdminRoot
      */
-    //httpStatic: '/home/nol/node-red-static/',
+    //httpStatic: '/home/nol/node-red-static/', //single static source
+    /* OR multiple static sources can be created using an array of objects... */
+    //httpStatic: [
+    //    {path: '/home/nol/pics/',    root: "/img/"}, 
+    //    {path: '/home/nol/reports/', root: "/doc/"}, 
+    //],
+
+    /**  
+     * All static routes will be appended to httpStaticRoot
+     * e.g. if httpStatic = "/home/nol/docs" and  httpStaticRoot = "/static/"
+     *      then "/home/nol/docs" will be served at "/static/"
+     * e.g. if httpStatic = [{path: '/home/nol/pics/', root: "/img/"}]
+     *      and httpStaticRoot = "/static/"
+     *      then "/home/nol/pics/" will be served at "/static/img/"
+     */
+    //httpStaticRoot: '/static/',
 
 /*******************************************************************************
  * Runtime Settings
  *  - lang
+ *  - diagnostics
  *  - logging
  *  - contextStorage
  *  - exportGlobalContextKeys
  *  - externalModules
  ******************************************************************************/
 
-     /** Uncomment the following to run node-red in your preferred language.
-      * Available languages include: en-US (default), ja, de, zh-CN, zh-TW, ru, ko
-      * Some languages are more complete than others.
-      */
-     // lang: "de",
-
-     /** Configure the logging output */
-     logging: {
-         /** Only console logging is currently supported */
-         console: {
-             /** Level of logging to be recorded. Options are:
-              * fatal - only those errors which make the application unusable should be recorded
-              * error - record errors which are deemed fatal for a particular request + fatal errors
-              * warn - record problems which are non fatal + errors + fatal errors
-              * info - record information about the general running of the application + warn + error + fatal errors
-              * debug - record information which is more verbose than info + info + warn + error + fatal errors
-              * trace - record very detailed logging + debug + info + warn + error + fatal errors
-              * off - turn off all logging (doesn't affect metrics or audit)
-              */
-             level: "info",
-             /** Whether or not to include metric events in the log output */
-             metrics: false,
-             /** Whether or not to include audit events in the log output */
-             audit: false
-         }
-     },
-
-     /** Context Storage
-      * The following property can be used to enable context storage. The configuration
-      * provided here will enable file-based context that flushes to disk every 30 seconds.
-      * Refer to the documentation for further options: https://nodered.org/docs/api/context/
-      */
-     //contextStorage: {
-     //    default: {
-     //        module:"localfilesystem"
-     //    },
-     //},
-
-     /** `global.keys()` returns a list of all properties set in global context.
-      * This allows them to be displayed in the Context Sidebar within the editor.
-      * In some circumstances it is not desirable to expose them to the editor. The
-      * following property can be used to hide any property set in `functionGlobalContext`
-      * from being list by `global.keys()`.
-      * By default, the property is set to false to avoid accidental exposure of
-      * their values. Setting this to true will cause the keys to be listed.
-      */
-     exportGlobalContextKeys: false,
-
-     /** Configure how the runtime will handle external npm modules.
-      * This covers:
-      *  - whether the editor will allow new node modules to be installed
-      *  - whether nodes, such as the Function node are allowed to have their
-      * own dynamically configured dependencies.
-      * The allow/denyList options can be used to limit what modules the runtime
-      * will install/load. It can use '*' as a wildcard that matches anything.
-      */
-     externalModules: {
-         // autoInstall: false,   /** Whether the runtime will attempt to automatically install missing modules */
-         // autoInstallRetry: 30, /** Interval, in seconds, between reinstall attempts */
-         // palette: {              /** Configuration for the Palette Manager */
-         //     allowInstall: true, /** Enable the Palette Manager in the editor */
-         //     allowUpdate: true,  /** Allow modules to be updated in the Palette Manager */
-         //     allowUpload: true,  /** Allow module tgz files to be uploaded and installed */
-         //     allowList: ['*'],
-         //     denyList: [],
-         //     allowUpdateList: ['*'],
-         //     denyUpdateList: []
-         // },
-         // modules: {              /** Configuration for node-specified modules */
-         //     allowInstall: true,
-         //     allowList: [],
-         //     denyList: []
-         // }
-     },
+    /** Uncomment the following to run node-red in your preferred language.
+     * Available languages include: en-US (default), ja, de, zh-CN, zh-TW, ru, ko
+     * Some languages are more complete than others.
+     */
+    // lang: "de",
+
+    /** Configure diagnostics options 
+     * - enabled:  When `enabled` is `true` (or unset), diagnostics data will
+     *   be available at http://localhost:1880/diagnostics  
+     * - ui: When `ui` is `true` (or unset), the action `show-system-info` will 
+     *   be available to logged in users of node-red editor  
+     */
+    diagnostics: {
+        /** enable or disable diagnostics endpoint. Must be set to `false` to disable */
+        enabled: true,
+        /** enable or disable diagnostics display in the node-red editor. Must be set to `false` to disable */
+        ui: true,
+    },
+
+    /** Configure the logging output */
+    logging: {
+        /** Only console logging is currently supported */
+        console: {
+            /** Level of logging to be recorded. Options are:
+             * fatal - only those errors which make the application unusable should be recorded
+             * error - record errors which are deemed fatal for a particular request + fatal errors
+             * warn - record problems which are non fatal + errors + fatal errors
+             * info - record information about the general running of the application + warn + error + fatal errors
+             * debug - record information which is more verbose than info + info + warn + error + fatal errors
+             * trace - record very detailed logging + debug + info + warn + error + fatal errors
+             * off - turn off all logging (doesn't affect metrics or audit)
+             */
+            level: "info",
+            /** Whether or not to include metric events in the log output */
+            metrics: false,
+            /** Whether or not to include audit events in the log output */
+            audit: false
+        }
+    },
+
+    /** Context Storage
+     * The following property can be used to enable context storage. The configuration
+     * provided here will enable file-based context that flushes to disk every 30 seconds.
+     * Refer to the documentation for further options: https://nodered.org/docs/api/context/
+     */
+    //contextStorage: {
+    //    default: {
+    //        module:"localfilesystem"
+    //    },
+    //},
+
+    /** `global.keys()` returns a list of all properties set in global context.
+     * This allows them to be displayed in the Context Sidebar within the editor.
+     * In some circumstances it is not desirable to expose them to the editor. The
+     * following property can be used to hide any property set in `functionGlobalContext`
+     * from being list by `global.keys()`.
+     * By default, the property is set to false to avoid accidental exposure of
+     * their values. Setting this to true will cause the keys to be listed.
+     */
+    exportGlobalContextKeys: false,
+
+    /** Configure how the runtime will handle external npm modules.
+     * This covers:
+     *  - whether the editor will allow new node modules to be installed
+     *  - whether nodes, such as the Function node are allowed to have their
+     * own dynamically configured dependencies.
+     * The allow/denyList options can be used to limit what modules the runtime
+     * will install/load. It can use '*' as a wildcard that matches anything.
+     */
+    externalModules: {
+        // autoInstall: false,   /** Whether the runtime will attempt to automatically install missing modules */
+        // autoInstallRetry: 30, /** Interval, in seconds, between reinstall attempts */
+        // palette: {              /** Configuration for the Palette Manager */
+        //     allowInstall: true, /** Enable the Palette Manager in the editor */
+        //     allowUpdate: true,  /** Allow modules to be updated in the Palette Manager */
+        //     allowUpload: true,  /** Allow module tgz files to be uploaded and installed */
+        //     allowList: ['*'],
+        //     denyList: [],
+        //     allowUpdateList: ['*'],
+        //     denyUpdateList: []
+        // },
+        // modules: {              /** Configuration for node-specified modules */
+        //     allowInstall: true,
+        //     allowList: [],
+        //     denyList: []
+        // }
+    },
 
 
 /*******************************************************************************
@@ -359,9 +391,9 @@ module.exports = {
 
         codeEditor: {
             /** Select the text editor component used by the editor.
-             * Defaults to "ace", but can be set to "ace" or "monaco"
+             * As of Node-RED V3, this defaults to "monaco", but can be set to "ace" if desired
              */
-            lib: "ace",
+            lib: "monaco",
             options: {
                 /** The follow options only apply if the editor is set to "monaco"
                  *
@@ -371,7 +403,7 @@ module.exports = {
                  */
                 theme: "vs",
                 /** other overrides can be set e.g. fontSize, fontFamily, fontLigatures etc.
-                 * for the full list, see https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.istandaloneeditorconstructionoptions.html
+                 * for the full list, see https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.IStandaloneEditorConstructionOptions.html
                  */
                 //fontSize: 14,
                 //fontFamily: "Cascadia Code, Fira Code, Consolas, 'Courier New', monospace",