@node-red/editor-client 2.0.4 → 2.1.0-beta.2

package/public/red/tours/first-flow.js

@@ -0,0 +1,80 @@
+export default {
+    steps: [
+        {
+            title: "Create your first flow",
+            width: 400,
+            description: 'This tutorial will guide you through creating your first flow',
+            nextButton: 'start'
+        },
+        {
+            element: "#red-ui-workspace .red-ui-tab-button.red-ui-tabs-add",
+            description: 'To add a new tab, click the <i class="fa fa-plus"></i> button',
+            wait: {
+                type: "dom-event",
+                event: "click",
+                element: "#red-ui-workspace .red-ui-tab-button.red-ui-tabs-add a"
+            },
+        },
+        {
+            element: '.red-ui-palette-node[data-palette-type="inject"]',
+            direction: 'right',
+            description: 'The palette lists all of the nodes available to use. Drag a new Inject node into the workspace.',
+            fallback: 'inset-bottom-right',
+            wait: {
+                type: "nr-event",
+                event: "nodes:add",
+                filter: function(event) {
+                    if (event.type === "inject") {
+                        this.injectNode = event;
+                        return true;
+                    }
+                    return false
+                }
+            },
+            complete: function() {
+                $('.red-ui-palette-node[data-palette-type="inject"]').css("z-index","auto");
+            }
+        },
+        {
+            element: '.red-ui-palette-node[data-palette-type="debug"]',
+            direction: 'right',
+            description: 'Next, drag a new Debug node into the workspace.',
+            fallback: 'inset-bottom-right',
+            wait: {
+                type: "nr-event",
+                event: "nodes:add",
+                filter: function(event) {
+                    if (event.type === "debug") {
+                        this.debugNode = event;
+                        return true;
+                    }
+                    return false
+                }
+            },
+            complete: function() {
+                $('.red-ui-palette-node[data-palette-type="debug"]').css("z-index","auto");
+            },
+        },
+        {
+            element: function() { return $("#"+this.injectNode.id+" .red-ui-flow-port") },
+            description: 'Add a wire from the output of the Inject node to the input of the Debug node',
+            fallback: 'inset-bottom-right',
+            wait: {
+                type: "nr-event",
+                event: "links:add",
+                filter: function(event) {
+                    return  event.source.id === this.injectNode.id && event.target.id === this.debugNode.id;
+                }
+            },
+        },
+        {
+            element: "#red-ui-header-button-deploy",
+            description: 'Deploy your changes so the flow is active in the runtime',
+            width: 200,
+            wait: {
+                type: "dom-event",
+                event: "click"
+            },
+        }
+    ]
+}

package/public/red/tours/welcome.js

@@ -0,0 +1,135 @@
+export default {
+    version: "2.1.0",
+    steps: [
+        {
+            titleIcon: "fa fa-map-o",
+            title: { "en-US": "Welcome to Node-RED 2.1!" },
+            description: { "en-US": "Let's take a moment to discover the new features in this release." }
+        },
+        {
+            title: { "en-US": "A new Tour Guide" },
+            description: { "en-US": "<p>First, as you've already found, we now have this tour of new features. We'll only show the tour the first time you open the editor for each new version of Node-RED.</p>"+
+                         "<p>You can choose not to see this tour in the future by disabling it under the View tab of User Settings.</p>" }
+        },
+        {
+            title: { "en-US": "New Edit menu" },
+            prepare() {
+                $("#red-ui-header-button-sidemenu").trigger("click");
+                $("#menu-item-edit-menu").parent().addClass("open")
+            },
+            complete() {
+                $("#menu-item-edit-menu").parent().removeClass("open")
+            },
+            element: "#menu-item-edit-menu-submenu",
+            interactive: false,
+            direction: "left",
+            description: { "en-US": "<p>The main menu has been updated with a new 'Edit' section. This includes all of the familar options, like cut/paste and undo/redo.</p>"+
+                         "<p>The menu now displays keyboard shortcuts for the options.</p>" }
+
+        },
+        {
+            title: { "en-US": "Arranging nodes" },
+            prepare() {
+                $("#red-ui-header-button-sidemenu").trigger("click");
+                $("#menu-item-arrange-menu").parent().addClass("open")
+            },
+            complete() {
+                $("#menu-item-arrange-menu").parent().removeClass("open")
+            },
+            element: "#menu-item-arrange-menu-submenu",
+            interactive: false,
+            direction: "left",
+            description: { "en-US": "<p>The new 'Arrange' section of the menu provides new options to help arrange your nodes. You can align them to a common edge, spread them out evenly or change their order.</p>" },
+        },
+        {
+            title: { "en-US": "Hiding tabs" },
+            element: "#red-ui-workspace-tabs > li.active",
+            description: { "en-US": '<p>Tabs can now be hidden by clicking their <i class="fa fa-times"></i> icon.</p><p>The Info Sidebar will still list all of your tabs, and tell you which ones are currently hidden.' },
+            interactive: false,
+            prepare() {
+                $("#red-ui-workspace-tabs > li.active .red-ui-tab-close").css("display","block");
+            },
+            complete() {
+                $("#red-ui-workspace-tabs > li.active .red-ui-tab-close").css("display","");
+            }
+        },
+        {
+            title: { "en-US": "Tab menu" },
+            element: "#red-ui-workspace-tabs-menu",
+            description: { "en-US": '<p>The new tab menu also provides lots of new options for your tabs.</p>' },
+            interactive: false,
+            direction: "left",
+            prepare() {
+                $("#red-ui-workspace > .red-ui-tabs > .red-ui-tabs-menu a").trigger("click");
+            },
+            complete() {
+                $(document).trigger("click");
+            }
+        },
+        {
+            title: { "en-US": "Flow and Group level environment variables" },
+            element: "#red-ui-workspace-tabs > li.active",
+            interactive: false,
+            description: { "en-US": "<p>Flows and Groups can now have their own environment variables that can be referenced by nodes inside them.</p>" },
+        },
+        {
+            prepare(done) {
+                RED.editor.editFlow(RED.nodes.workspace(RED.workspaces.active()),"editor-tab-envProperties");
+                setTimeout(done,700);
+            },
+            element: "#red-ui-tab-editor-tab-envProperties-link-button",
+            description: { "en-US": "<p>Their edit dialogs have a new Environment Variables section.</p>" },
+        },
+        {
+            element: ".node-input-env-container-row",
+            direction: "left",
+            description: { "en-US": '<p>The environment variables are listed in this table and new ones can be added by clicking the <i class="fa fa-plus"></i> button.</p>' },
+            complete(done) {
+                $("#node-dialog-cancel").trigger("click");
+                setTimeout(done,500);
+            }
+        },
+
+        {
+            title: {"en-US":"Link Call node added"},
+            prepare(done) {
+                $('[data-palette-type="link call"]')[0].scrollIntoView({block:"center"})
+                setTimeout(done,100);
+            },
+            element: '[data-palette-type="link call"]',
+            direction: "right",
+            description: { "en-US": '<p>The <code>Link Call</code> node lets you call another flow that begins with a <code>Link In</code> node and get the result back when the message reaches a <code>Link Out</code> node.</p>' },
+        },
+
+        {
+            title: {"en-US":"File nodes renamed"},
+            prepare(done) {
+                $('[data-palette-type="file"]')[0].scrollIntoView({block:"center"})
+                setTimeout(done,100);
+            },
+            element: '[data-palette-type="file"]',
+            direction: "right",
+            description: { "en-US": '<p>The file nodes have been renamed to make it clearer which node does what.</p>' },
+        },
+        {
+            title: {"en-US":"Deep copy option on Change node"},
+            prepare(done) {
+                var def = RED.nodes.getType('change')
+                RED.editor.edit({id:"test",type:"change",rules:[{t:'set',p:'payload',pt:'msg', tot:'msg',to:"anotherProperty"}],_def:def, _:def._})
+                setTimeout(done,700);
+            },
+            complete(done) {
+                $("#node-dialog-cancel").trigger("click");
+                setTimeout(done,500);
+            },
+            element: function() {
+                return $(".node-input-rule-property-deepCopy").next()
+            },
+            description: { "en-US": '<p>The Set rule has a new option to create a deep copy of the value. This ensures a complete copy is made, rather than using a reference.</p>' },
+        },
+        {
+            title: { "en-US": "And that's not all..." },
+            description: { "en-US": "<p>There are many more smaller changes, including:</p><ul><li>Auto-complete suggestions in the <code>msg</code> TypedInput.</li><li>Support for <code>msg.resetTimeout</code> in the <code>Join</code> node.</li><li>Pushing messages to the front of the queue in the <code>Delay</code> node's rate limiting mode.</li><li>An optional second output on the <code>Delay</code> node for rate limited messages.</li></ul>" }
+        }
+    ]
+}

package/public/tours/first-flow.js

@@ -0,0 +1,82 @@
+export default {
+    steps: [
+        {
+            title: "Create your first flow",
+            fullscreen: true,
+            direction: "inset",
+            width: 400,
+            description: 'This tutorial will guide you through creating your first flow',
+            nextButton: 'start'
+        },
+        {
+            element: "#red-ui-workspace .red-ui-tab-button.red-ui-tabs-add",
+            description: 'To add a new tab, click the <i class="fa fa-plus"></i> button',
+            wait: {
+                type: "dom-event",
+                event: "click",
+                element: "#red-ui-workspace .red-ui-tab-button.red-ui-tabs-add a"
+            },
+        },
+        {
+            element: '.red-ui-palette-node[data-palette-type="inject"]',
+            direction: 'right',
+            description: 'The palette lists all of the nodes available to use. Drag a new Inject node into the workspace.',
+            fallback: 'inset-bottom-right',
+            wait: {
+                type: "nr-event",
+                event: "nodes:add",
+                filter: function(event) {
+                    if (event.type === "inject") {
+                        this.injectNode = event;
+                        return true;
+                    }
+                    return false
+                }
+            },
+            complete: function() {
+                $('.red-ui-palette-node[data-palette-type="inject"]').css("z-index","auto");
+            }
+        },
+        {
+            element: '.red-ui-palette-node[data-palette-type="debug"]',
+            direction: 'right',
+            description: 'Next, drag a new Debug node into the workspace.',
+            fallback: 'inset-bottom-right',
+            wait: {
+                type: "nr-event",
+                event: "nodes:add",
+                filter: function(event) {
+                    if (event.type === "debug") {
+                        this.debugNode = event;
+                        return true;
+                    }
+                    return false
+                }
+            },
+            complete: function() {
+                $('.red-ui-palette-node[data-palette-type="debug"]').css("z-index","auto");
+            },
+        },
+        {
+            element: function() { return $("#"+this.injectNode.id+" .red-ui-flow-port") },
+            description: 'Add a wire from the output of the Inject node to the input of the Debug node',
+            fallback: 'inset-bottom-right',
+            wait: {
+                type: "nr-event",
+                event: "links:add",
+                filter: function(event) {
+                    return  event.source.id === this.injectNode.id && event.target.id === this.debugNode.id;
+                }
+            },
+        },
+        {
+            element: "#red-ui-header-button-deploy",
+            description: 'Deploy your changes so the flow is active in the runtime',
+            width: 200,
+            wait: {
+                type: "dom-event",
+                event: "click"
+            },
+        }
+    ]
+}

package/public/types/node/assert.d.ts

@@ -0,0 +1,127 @@
+
+/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/node-red/nr-monaco-build */
+
+declare module 'assert' {
+    /** An alias of `assert.ok()`. */
+    function assert(value: any, message?: string | Error): asserts value;
+    namespace assert {
+        class AssertionError extends Error {
+            actual: any;
+            expected: any;
+            operator: string;
+            generatedMessage: boolean;
+            code: 'ERR_ASSERTION';
+
+            constructor(options?: {
+                /** If provided, the error message is set to this value. */
+                message?: string | undefined;
+                /** The `actual` property on the error instance. */
+                actual?: any;
+                /** The `expected` property on the error instance. */
+                expected?: any;
+                /** The `operator` property on the error instance. */
+                operator?: string | undefined;
+                /** If provided, the generated stack trace omits frames before this function. */
+                // tslint:disable-next-line:ban-types
+                stackStartFn?: Function | undefined;
+            });
+        }
+
+        class CallTracker {
+            calls(exact?: number): () => void;
+            calls<Func extends (...args: any[]) => any>(fn?: Func, exact?: number): Func;
+            report(): CallTrackerReportInformation[];
+            verify(): void;
+        }
+        interface CallTrackerReportInformation {
+            message: string;
+            /** The actual number of times the function was called. */
+            actual: number;
+            /** The number of times the function was expected to be called. */
+            expected: number;
+            /** The name of the function that is wrapped. */
+            operator: string;
+            /** A stack trace of the function. */
+            stack: object;
+        }
+
+        type AssertPredicate = RegExp | (new () => object) | ((thrown: any) => boolean) | object | Error;
+
+        function fail(message?: string | Error): never;
+        /** @deprecated since v10.0.0 - use fail([message]) or other assert functions instead. */
+        function fail(
+            actual: any,
+            expected: any,
+            message?: string | Error,
+            operator?: string,
+            // tslint:disable-next-line:ban-types
+            stackStartFn?: Function,
+        ): never;
+        function ok(value: any, message?: string | Error): asserts value;
+        /** @deprecated since v9.9.0 - use strictEqual() instead. */
+        function equal(actual: any, expected: any, message?: string | Error): void;
+        /** @deprecated since v9.9.0 - use notStrictEqual() instead. */
+        function notEqual(actual: any, expected: any, message?: string | Error): void;
+        /** @deprecated since v9.9.0 - use deepStrictEqual() instead. */
+        function deepEqual(actual: any, expected: any, message?: string | Error): void;
+        /** @deprecated since v9.9.0 - use notDeepStrictEqual() instead. */
+        function notDeepEqual(actual: any, expected: any, message?: string | Error): void;
+        function strictEqual<T>(actual: any, expected: T, message?: string | Error): asserts actual is T;
+        function notStrictEqual(actual: any, expected: any, message?: string | Error): void;
+        function deepStrictEqual<T>(actual: any, expected: T, message?: string | Error): asserts actual is T;
+        function notDeepStrictEqual(actual: any, expected: any, message?: string | Error): void;
+
+        function throws(block: () => any, message?: string | Error): void;
+        function throws(block: () => any, error: AssertPredicate, message?: string | Error): void;
+        function doesNotThrow(block: () => any, message?: string | Error): void;
+        function doesNotThrow(block: () => any, error: AssertPredicate, message?: string | Error): void;
+
+        function ifError(value: any): asserts value is null | undefined;
+
+        function rejects(block: (() => Promise<any>) | Promise<any>, message?: string | Error): Promise<void>;
+        function rejects(
+            block: (() => Promise<any>) | Promise<any>,
+            error: AssertPredicate,
+            message?: string | Error,
+        ): Promise<void>;
+        function doesNotReject(block: (() => Promise<any>) | Promise<any>, message?: string | Error): Promise<void>;
+        function doesNotReject(
+            block: (() => Promise<any>) | Promise<any>,
+            error: AssertPredicate,
+            message?: string | Error,
+        ): Promise<void>;
+
+        function match(value: string, regExp: RegExp, message?: string | Error): void;
+        function doesNotMatch(value: string, regExp: RegExp, message?: string | Error): void;
+
+        const strict: Omit<
+            typeof assert,
+            | 'equal'
+            | 'notEqual'
+            | 'deepEqual'
+            | 'notDeepEqual'
+            | 'ok'
+            | 'strictEqual'
+            | 'deepStrictEqual'
+            | 'ifError'
+            | 'strict'
+        > & {
+            (value: any, message?: string | Error): asserts value;
+            equal: typeof strictEqual;
+            notEqual: typeof notStrictEqual;
+            deepEqual: typeof deepStrictEqual;
+            notDeepEqual: typeof notDeepStrictEqual;
+
+            // Mapped types and assertion functions are incompatible?
+            // TS2775: Assertions require every name in the call target
+            // to be declared with an explicit type annotation.
+            ok: typeof ok;
+            strictEqual: typeof strictEqual;
+            deepStrictEqual: typeof deepStrictEqual;
+            ifError: typeof ifError;
+            strict: typeof strict;
+        };
+    }
+
+    export = assert;
+}

package/public/types/node/async_hooks.d.ts

@@ -0,0 +1,229 @@
+
+/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/node-red/nr-monaco-build */
+
+/**
+ * Async Hooks module: https://nodejs.org/api/async_hooks.html
+ */
+declare module 'async_hooks' {
+    /**
+     * Returns the asyncId of the current execution context.
+     */
+    function executionAsyncId(): number;
+
+    /**
+     * The resource representing the current execution.
+     *  Useful to store data within the resource.
+     *
+     * Resource objects returned by `executionAsyncResource()` are most often internal
+     * Node.js handle objects with undocumented APIs. Using any functions or properties
+     * on the object is likely to crash your application and should be avoided.
+     *
+     * Using `executionAsyncResource()` in the top-level execution context will
+     * return an empty object as there is no handle or request object to use,
+     * but having an object representing the top-level can be helpful.
+     */
+    function executionAsyncResource(): object;
+
+    /**
+     * Returns the ID of the resource responsible for calling the callback that is currently being executed.
+     */
+    function triggerAsyncId(): number;
+
+    interface HookCallbacks {
+        /**
+         * Called when a class is constructed that has the possibility to emit an asynchronous event.
+         * @param asyncId a unique ID for the async resource
+         * @param type the type of the async resource
+         * @param triggerAsyncId the unique ID of the async resource in whose execution context this async resource was created
+         * @param resource reference to the resource representing the async operation, needs to be released during destroy
+         */
+        init?(asyncId: number, type: string, triggerAsyncId: number, resource: object): void;
+
+        /**
+         * When an asynchronous operation is initiated or completes a callback is called to notify the user.
+         * The before callback is called just before said callback is executed.
+         * @param asyncId the unique identifier assigned to the resource about to execute the callback.
+         */
+        before?(asyncId: number): void;
+
+        /**
+         * Called immediately after the callback specified in before is completed.
+         * @param asyncId the unique identifier assigned to the resource which has executed the callback.
+         */
+        after?(asyncId: number): void;
+
+        /**
+         * Called when a promise has resolve() called. This may not be in the same execution id
+         * as the promise itself.
+         * @param asyncId the unique id for the promise that was resolve()d.
+         */
+        promiseResolve?(asyncId: number): void;
+
+        /**
+         * Called after the resource corresponding to asyncId is destroyed
+         * @param asyncId a unique ID for the async resource
+         */
+        destroy?(asyncId: number): void;
+    }
+
+    interface AsyncHook {
+        /**
+         * Enable the callbacks for a given AsyncHook instance. If no callbacks are provided enabling is a noop.
+         */
+        enable(): this;
+
+        /**
+         * Disable the callbacks for a given AsyncHook instance from the global pool of AsyncHook callbacks to be executed. Once a hook has been disabled it will not be called again until enabled.
+         */
+        disable(): this;
+    }
+
+    /**
+     * Registers functions to be called for different lifetime events of each async operation.
+     * @param options the callbacks to register
+     * @return an AsyncHooks instance used for disabling and enabling hooks
+     */
+    function createHook(options: HookCallbacks): AsyncHook;
+
+    interface AsyncResourceOptions {
+      /**
+       * The ID of the execution context that created this async event.
+       * @default executionAsyncId()
+       */
+      triggerAsyncId?: number | undefined;
+
+      /**
+       * Disables automatic `emitDestroy` when the object is garbage collected.
+       * This usually does not need to be set (even if `emitDestroy` is called
+       * manually), unless the resource's `asyncId` is retrieved and the
+       * sensitive API's `emitDestroy` is called with it.
+       * @default false
+       */
+      requireManualDestroy?: boolean | undefined;
+    }
+
+    /**
+     * The class AsyncResource was designed to be extended by the embedder's async resources.
+     * Using this users can easily trigger the lifetime events of their own resources.
+     */
+    class AsyncResource {
+        /**
+         * AsyncResource() is meant to be extended. Instantiating a
+         * new AsyncResource() also triggers init. If triggerAsyncId is omitted then
+         * async_hook.executionAsyncId() is used.
+         * @param type The type of async event.
+         * @param triggerAsyncId The ID of the execution context that created
+         *   this async event (default: `executionAsyncId()`), or an
+         *   AsyncResourceOptions object (since 9.3)
+         */
+        constructor(type: string, triggerAsyncId?: number|AsyncResourceOptions);
+
+        /**
+         * Binds the given function to the current execution context.
+         * @param fn The function to bind to the current execution context.
+         * @param type An optional name to associate with the underlying `AsyncResource`.
+         */
+        static bind<Func extends (...args: any[]) => any>(fn: Func, type?: string): Func & { asyncResource: AsyncResource };
+
+        /**
+         * Binds the given function to execute to this `AsyncResource`'s scope.
+         * @param fn The function to bind to the current `AsyncResource`.
+         */
+        bind<Func extends (...args: any[]) => any>(fn: Func): Func & { asyncResource: AsyncResource };
+
+        /**
+         * Call the provided function with the provided arguments in the
+         * execution context of the async resource. This will establish the
+         * context, trigger the AsyncHooks before callbacks, call the function,
+         * trigger the AsyncHooks after callbacks, and then restore the original
+         * execution context.
+         * @param fn The function to call in the execution context of this
+         *   async resource.
+         * @param thisArg The receiver to be used for the function call.
+         * @param args Optional arguments to pass to the function.
+         */
+        runInAsyncScope<This, Result>(fn: (this: This, ...args: any[]) => Result, thisArg?: This, ...args: any[]): Result;
+
+        /**
+         * Call AsyncHooks destroy callbacks.
+         */
+        emitDestroy(): this;
+
+        /**
+         * @return the unique ID assigned to this AsyncResource instance.
+         */
+        asyncId(): number;
+
+        /**
+         * @return the trigger ID for this AsyncResource instance.
+         */
+        triggerAsyncId(): number;
+    }
+
+    /**
+     * When having multiple instances of `AsyncLocalStorage`, they are independent
+     * from each other. It is safe to instantiate this class multiple times.
+     */
+    class AsyncLocalStorage<T> {
+        /**
+         * This method disables the instance of `AsyncLocalStorage`. All subsequent calls
+         * to `asyncLocalStorage.getStore()` will return `undefined` until
+         * `asyncLocalStorage.run()` is called again.
+         *
+         * When calling `asyncLocalStorage.disable()`, all current contexts linked to the
+         * instance will be exited.
+         *
+         * Calling `asyncLocalStorage.disable()` is required before the
+         * `asyncLocalStorage` can be garbage collected. This does not apply to stores
+         * provided by the `asyncLocalStorage`, as those objects are garbage collected
+         * along with the corresponding async resources.
+         *
+         * This method is to be used when the `asyncLocalStorage` is not in use anymore
+         * in the current process.
+         */
+        disable(): void;
+
+        /**
+         * This method returns the current store. If this method is called outside of an
+         * asynchronous context initialized by calling `asyncLocalStorage.run`, it will
+         * return `undefined`.
+         */
+        getStore(): T | undefined;
+
+        /**
+         * This methods runs a function synchronously within a context and return its
+         * return value. The store is not accessible outside of the callback function or
+         * the asynchronous operations created within the callback.
+         *
+         * Optionally, arguments can be passed to the function. They will be passed to the
+         * callback function.
+         *
+         * I the callback function throws an error, it will be thrown by `run` too. The
+         * stacktrace will not be impacted by this call and the context will be exited.
+         */
+        // TODO: Apply generic vararg once available
+        run<R>(store: T, callback: (...args: any[]) => R, ...args: any[]): R;
+
+        /**
+         * This methods runs a function synchronously outside of a context and return its
+         * return value. The store is not accessible within the callback function or the
+         * asynchronous operations created within the callback.
+         *
+         * Optionally, arguments can be passed to the function. They will be passed to the
+         * callback function.
+         *
+         * If the callback function throws an error, it will be thrown by `exit` too. The
+         * stacktrace will not be impacted by this call and the context will be
+         * re-entered.
+         */
+        // TODO: Apply generic vararg once available
+        exit<R>(callback: (...args: any[]) => R, ...args: any[]): R;
+
+        /**
+         * Calling `asyncLocalStorage.enterWith(store)` will transition into the context
+         * for the remainder of the current synchronous execution and will persist
+         * through any following asynchronous calls.
+         */
+        enterWith(store: T): void;
+    }
+}