@node-red/editor-client 3.1.8 → 4.0.0-beta.2

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

@@ -1,5 +1,5 @@
 
-/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
+/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/node-red/nr-monaco-build */
 
 /**
  * The `worker_threads` module enables the use of threads that execute JavaScript
@@ -42,7 +42,7 @@
  * }
  * ```
  *
- * The above example spawns a Worker thread for each `parse()` call. In actual
+ * The above example spawns a Worker thread for each `parseJSAsync()` call. In
  * practice, use a pool of Workers for these kinds of tasks. Otherwise, the
  * overhead of creating Workers would likely exceed their benefit.
  *
@@ -52,7 +52,7 @@
  *
  * Worker threads inherit non-process-specific options by default. Refer to `Worker constructor options` to know how to customize worker thread options,
  * specifically `argv` and `execArgv` options.
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/worker_threads.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/worker_threads.js)
  */
 declare module 'worker_threads' {
     import { Blob } from 'node:buffer';
@@ -178,7 +178,7 @@ declare module 'worker_threads' {
          */
         postMessage(value: any, transferList?: ReadonlyArray<TransferListItem>): void;
         /**
-         * Opposite of `unref()`. Calling `ref()` on a previously `unref()`ed port does_not_ let the program exit if it's the only active handle left (the default
+         * Opposite of `unref()`. Calling `ref()` on a previously `unref()`ed port does _not_ let the program exit if it's the only active handle left (the default
          * behavior). If the port is `ref()`ed, calling `ref()` again has no effect.
          *
          * If listeners are attached or removed using `.on('message')`, the port
@@ -387,7 +387,7 @@ declare module 'worker_threads' {
         /**
          * An object that can be used to query performance information from a worker
          * instance. Similar to `perf_hooks.performance`.
-         * @since v15.1.0, v12.22.0
+         * @since v15.1.0, v14.17.0, v12.22.0
          */
         readonly performance: WorkerPerformance;
         /**
@@ -403,7 +403,7 @@ declare module 'worker_threads' {
          */
         postMessage(value: any, transferList?: ReadonlyArray<TransferListItem>): void;
         /**
-         * Opposite of `unref()`, calling `ref()` on a previously `unref()`ed worker does_not_ let the program exit if it's the only active handle left (the default
+         * Opposite of `unref()`, calling `ref()` on a previously `unref()`ed worker does _not_ let the program exit if it's the only active handle left (the default
          * behavior). If the worker is `ref()`ed, calling `ref()` again has
          * no effect.
          * @since v10.5.0
@@ -510,7 +510,6 @@ declare module 'worker_threads' {
      * }
      * ```
      * @since v15.4.0
-     * @experimental
      */
     class BroadcastChannel {
         readonly name: string;
@@ -632,20 +631,61 @@ declare module 'worker_threads' {
      *   console.log(getEnvironmentData('Hello'));  // Prints 'World!'.
      * }
      * ```
-     * @since v15.12.0
-     * @experimental
+     * @since v15.12.0, v14.18.0
      * @param key Any arbitrary, cloneable JavaScript value that can be used as a {Map} key.
      */
     function getEnvironmentData(key: Serializable): Serializable;
     /**
      * The `worker.setEnvironmentData()` API sets the content of`worker.getEnvironmentData()` in the current thread and all new `Worker`instances spawned from the current context.
-     * @since v15.12.0
-     * @experimental
+     * @since v15.12.0, v14.18.0
      * @param key Any arbitrary, cloneable JavaScript value that can be used as a {Map} key.
      * @param value Any arbitrary, cloneable JavaScript value that will be cloned and passed automatically to all new `Worker` instances. If `value` is passed as `undefined`, any previously set value
      * for the `key` will be deleted.
      */
     function setEnvironmentData(key: Serializable, value: Serializable): void;
+
+    import {
+        BroadcastChannel as _BroadcastChannel,
+        MessageChannel as _MessageChannel,
+        MessagePort as _MessagePort,
+    } from 'worker_threads';
+    global {
+        /**
+         * `BroadcastChannel` class is a global reference for `require('worker_threads').BroadcastChannel`
+         * https://nodejs.org/api/globals.html#broadcastchannel
+         * @since v18.0.0
+         */
+        var BroadcastChannel: typeof globalThis extends {
+            onmessage: any;
+            BroadcastChannel: infer T;
+        }
+            ? T
+            : typeof _BroadcastChannel;
+
+        /**
+         * `MessageChannel` class is a global reference for `require('worker_threads').MessageChannel`
+         * https://nodejs.org/api/globals.html#messagechannel
+         * @since v15.0.0
+         */
+        var MessageChannel: typeof globalThis extends {
+            onmessage: any;
+            MessageChannel: infer T;
+        }
+            ? T
+            : typeof _MessageChannel;
+
+        /**
+         * `MessagePort` class is a global reference for `require('worker_threads').MessagePort`
+         * https://nodejs.org/api/globals.html#messageport
+         * @since v15.0.0
+         */
+         var MessagePort: typeof globalThis extends {
+            onmessage: any;
+            MessagePort: infer T;
+        }
+            ? T
+            : typeof _MessagePort;
+    }
 }
 declare module 'node:worker_threads' {
     export * from 'worker_threads';

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

@@ -1,5 +1,5 @@
 
-/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
+/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/node-red/nr-monaco-build */
 
 /**
  * The `zlib` module provides compression functionality implemented using Gzip,
@@ -91,7 +91,7 @@
  *   });
  * ```
  * @since v0.5.8
- * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/zlib.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/zlib.js)
  */
 declare module 'zlib' {
     import * as stream from 'node:stream';

package/public/types/node-red/func.d.ts

@@ -1,10 +1,10 @@
 
-/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
+/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/node-red/nr-monaco-build */
 
 interface NodeMessage {
     topic?: string;
     payload?: any;
-    _msgid?: string;
+    /** `_msgid` is generated internally. It not something you typically need to set or modify. */ _msgid?: string;
     [other: string]: any; //permit other properties
 }
 
@@ -19,15 +19,15 @@ declare const promisify:typeof import('util').promisify
 /**
  * @typedef NodeStatus
  * @type {object}
- * @property {string} [fill] The fill property can be: red, green, yellow, blue or grey.
- * @property {string} [shape] The shape property can be: ring or dot.
- * @property {string} [text] The text to display
+ * @property {'red'|'green'|'yellow'|'blue'|'grey'|string} [fill] - The fill property can be: red, green, yellow, blue or grey.
+ * @property {'ring'|'dot'|string} [shape] The shape property can be: ring or dot.
+ * @property {string|boolean|number} [text] The text to display
  */
 interface NodeStatus {
     /** The fill property can be: red, green, yellow, blue or grey */
-    fill?: string,
+    fill?: 'red'|'green'|'yellow'|'blue'|'grey'|string,
     /** The shape property can be: ring or dot */
-    shape?: string,
+    shape?: 'ring'|'dot'|string,
     /** The text to display */
     text?: string|boolean|number
 }
@@ -37,25 +37,24 @@ declare class node {
     * Send 1 or more messages asynchronously
     * @param {object | object[]} msg  The msg object
     * @param {Boolean} [clone=true]  Flag to indicate the `msg` should be cloned. Default = `true`
-    * @see node-red documentation [writing-functions: sending messages asynchronously](https://nodered.org/docs/user-guide/writing-functions#sending-messages-asynchronously)
+    * @see Node-RED documentation [writing-functions: sending messages asynchronously](https://nodered.org/docs/user-guide/writing-functions#sending-messages-asynchronously)
     */
-    static send(msg:object|object[], clone?:Boolean): void;
+    static send(msg:NodeMessage|NodeMessage[], clone?:Boolean): void;
     /** Inform runtime this instance has completed its operation */
     static done();
     /** Send an error to the console and debug side bar. Include `msg` in the 2nd parameter to trigger the catch node.  */
-    static error(err:string|Error, msg?:object);
+    static error(err:string|Error, msg?:NodeMessage);
     /** Log a warn message to the console and debug sidebar */
     static warn(warning:string|object);
     /** Log an info message to the console (not sent to sidebar)' */
     static log(info:string|object);
     /** Sets the status icon and text underneath the node.
     * @param {NodeStatus} status - The status object `{fill, shape, text}`
-    * @see node-red documentation [writing-functions: adding-status](https://nodered.org/docs/user-guide/writing-functions#adding-status)
+    * @see Node-RED documentation [writing-functions: adding-status](https://nodered.org/docs/user-guide/writing-functions#adding-status)
     */
     static status(status:NodeStatus);
     /** Sets the status text underneath the node.
-    * @param {string} status - The status to display
-    * @see node-red documentation [writing-functions: adding-status](https://nodered.org/docs/user-guide/writing-functions#adding-status)
+    * @see Node-RED documentation [writing-functions: adding-status](https://nodered.org/docs/user-guide/writing-functions#adding-status)
     */
     static status(status:string|boolean|number);
     /** the id of this node */
@@ -264,9 +263,12 @@ declare class global {
     /** Get an array of the keys in the context store */
     static keys(store: string, callback: Function);
 }
+
+// (string & {}) is a workaround for offering string type completion without enforcing it. See https://github.com/microsoft/TypeScript/issues/29729#issuecomment-567871939
+type NR_ENV_NAME_STRING = 'NR_NODE_ID'|'NR_NODE_NAME'|'NR_NODE_PATH'|'NR_GROUP_ID'|'NR_GROUP_NAME'|'NR_FLOW_ID'|'NR_FLOW_NAME'|'NR_SUBFLOW_ID'|'NR_SUBFLOW_NAME'|'NR_SUBFLOW_PATH' | (string & {})
 declare class env {
     /** 
-     * Get an environment variable value  
+     * Get an environment variable value defined in the OS, or in the global/flow/subflow/group environment variables.  
      * 
      * Predefined node-red variables...  
      *   * `NR_NODE_ID` - the ID of the node
@@ -276,9 +278,16 @@ declare class env {
      *   * `NR_GROUP_NAME` - the Name of the containing group
      *   * `NR_FLOW_ID` - the ID of the flow the node is on
      *   * `NR_FLOW_NAME` - the Name of the flow the node is on
-     * @param name Name of the environment variable to get
+     *   * `NR_SUBFLOW_ID` - the ID of the subflow the node is in
+     *   * `NR_SUBFLOW_NAME` - the Name of the subflow the node is in
+     *   * `NR_SUBFLOW_PATH` - the Path of the subflow the node is in
+     * @param name - The name of the environment variable
+     * @example 
+     * ```const flowName = env.get("NR_FLOW_NAME") // get the name of the flow```
+     * @example 
+     * ```const systemHomeDir = env.get("HOME") // get the user's home directory```
      * @example 
-     * ```const flowName = env.get("NR_FLOW_NAME");```
+     * ```const systemHomeDir = env.get("LABEL1") // get the value of a global/flow/subflow/group defined variable named "LABEL1"```
      */
-    static get(name:string) :any;
+    static get(name:NR_ENV_NAME_STRING) :any;
 }