@node-red/editor-client 1.3.3 → 1.3.7

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

@@ -0,0 +1,266 @@
+
+/* NOTE: Do not edit directly! This file is generated using \`npm run update-types\` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
+
+
+interface NodeMessage {
+    topic?: string;
+    payload?: any;
+    _msgid?: string;
+    [other: string]: any; //permit other properties
+}
+
+/** @type {NodeMessage} the `msg` object */
+declare var msg: NodeMessage;
+/** @type {string} the id of the incoming `msg` (alias of msg._msgid) */
+declare const __msgid__:string;
+
+/**
+ * @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
+ */
+interface NodeStatus {
+    /** The fill property can be: red, green, yellow, blue or grey */
+    fill?: string,
+    /** The shape property can be: ring or dot */
+    shape?: string,
+    /** The text to display */
+    text?: string|boolean|number
+}
+
+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) 
+    */ 
+    static send(msg:object|object[], 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);
+    /** 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)
+    */
+    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)
+    */
+    static status(status:string|boolean|number);
+    /** the id of this node */
+    public readonly id:string;
+    /** the name of this node */
+    public readonly name:string;
+    /** the number of outputs of this node */
+    public readonly outputCount:number;
+}
+declare class context {
+    /**
+     * Get one or multiple values from context (synchronous).
+     * @param name - Name of context variable
+     */
+    static get(name: string | string[]);
+    /**
+     * Get one or multiple values from context (asynchronous).
+     * @param name - Name (or array of names) to get from context
+     * @param {function} callback - (optional) Callback function (`(err,value) => {}`)
+     */
+    static get(name: string | string[], callback: Function);
+    /**
+     * Get one or multiple values from context (synchronous).
+     * @param name - Name (or array of names) to get from context
+     * @param store - Name of context store
+     */
+    static get(name: string | string[], store: string);
+    /**
+     * Get one or multiple values from context (asynchronous).
+     * @param name - Name (or array of names) to get from context
+     * @param store - Name of context store
+     * @param {function} callback - (optional) Callback function (`(err,value) => {}`)
+     */
+    static get(name: string | string[], store: string, callback: Function);
+
+
+    /**
+     * Set one or multiple values in context (synchronous).
+     * @param name - Name (or array of names) to set in context
+     * @param value - The value (or array of values) to store in context. If the value(s) are null/undefined, the context item(s) will be removed. 
+     */
+    static set(name: string | string[], value?: any | any[]);
+    /**
+     * Set one or multiple values in context (asynchronous).
+     * @param name - Name (or array of names) to set in context
+     * @param value - The value (or array of values) to store in context. If the value(s) are null/undefined, the context item(s) will be removed. 
+     * @param callback - (optional) Callback function (`(err) => {}`)
+     */
+    static set(name: string | string[], value?: any | any[], callback?: Function);
+    /**
+     * Set one or multiple values in context (synchronous).
+     * @param name - Name (or array of names) to set in context
+     * @param value - The value (or array of values) to store in context. If the value(s) are null/undefined, the context item(s) will be removed. 
+     * @param store - (optional) Name of context store
+     */
+    static set(name: string | string[], value?: any | any[], store?: string);
+    /**
+     * Set one or multiple values in context (asynchronous).
+     * @param name - Name (or array of names) to set in context
+     * @param value - The value (or array of values) to store in context. If the value(s) are null/undefined, the context item(s) will be removed. 
+     * @param store - (optional) Name of context store
+     * @param callback - (optional) Callback function (`(err) => {}`)
+     */
+    static set(name: string | string[], value?: any | any[], store?: string, callback?: Function);
+
+    /** Get an array of the keys in the context store */
+    static keys(): Array<string>;
+    /** Get an array of the keys in the context store */
+    static keys(store: string): Array<string>;
+    /** Get an array of the keys in the context store */
+    static keys(callback: Function);
+    /** Get an array of the keys in the context store */
+    static keys(store: string, callback: Function);
+}
+declare class flow {
+    /**
+     * Get one or multiple values from context (synchronous).
+     * @param name - Name of context variable
+     */
+    static get(name: string | string[]);
+    /**
+     * Get one or multiple values from context (asynchronous).
+     * @param name - Name (or array of names) to get from context
+     * @param {function} callback - (optional) Callback function (`(err,value) => {}`)
+     */
+    static get(name: string | string[], callback: Function);
+    /**
+     * Get one or multiple values from context (synchronous).
+     * @param name - Name (or array of names) to get from context
+     * @param store - Name of context store
+     */
+    static get(name: string | string[], store: string);
+    /**
+     * Get one or multiple values from context (asynchronous).
+     * @param name - Name (or array of names) to get from context
+     * @param store - Name of context store
+     * @param {function} callback - (optional) Callback function (`(err,value) => {}`)
+     */
+    static get(name: string | string[], store: string, callback: Function);
+
+
+    /**
+     * Set one or multiple values in context (synchronous).
+     * @param name - Name (or array of names) to set in context
+     * @param value - The value (or array of values) to store in context. If the value(s) are null/undefined, the context item(s) will be removed. 
+     */
+    static set(name: string | string[], value?: any | any[]);
+    /**
+     * Set one or multiple values in context (asynchronous).
+     * @param name - Name (or array of names) to set in context
+     * @param value - The value (or array of values) to store in context. If the value(s) are null/undefined, the context item(s) will be removed. 
+     * @param callback - (optional) Callback function (`(err) => {}`)
+     */
+    static set(name: string | string[], value?: any | any[], callback?: Function);
+    /**
+     * Set one or multiple values in context (synchronous).
+     * @param name - Name (or array of names) to set in context
+     * @param value - The value (or array of values) to store in context. If the value(s) are null/undefined, the context item(s) will be removed. 
+     * @param store - (optional) Name of context store
+     */
+    static set(name: string | string[], value?: any | any[], store?: string);
+    /**
+     * Set one or multiple values in context (asynchronous).
+     * @param name - Name (or array of names) to set in context
+     * @param value - The value (or array of values) to store in context. If the value(s) are null/undefined, the context item(s) will be removed. 
+     * @param store - (optional) Name of context store
+     * @param callback - (optional) Callback function (`(err) => {}`)
+     */
+    static set(name: string | string[], value?: any | any[], store?: string, callback?: Function);
+
+    /** Get an array of the keys in the context store */
+    static keys(): Array<string>;
+    /** Get an array of the keys in the context store */
+    static keys(store: string): Array<string>;
+    /** Get an array of the keys in the context store */
+    static keys(callback: Function);
+    /** Get an array of the keys in the context store */
+    static keys(store: string, callback: Function);
+}
+
+// @ts-ignore
+declare class global {
+    /**
+     * Get one or multiple values from context (synchronous).
+     * @param name - Name of context variable
+     */
+    static get(name: string | string[]);
+    /**
+     * Get one or multiple values from context (asynchronous).
+     * @param name - Name (or array of names) to get from context
+     * @param {function} callback - (optional) Callback function (`(err,value) => {}`)
+     */
+    static get(name: string | string[], callback: Function);
+    /**
+     * Get one or multiple values from context (synchronous).
+     * @param name - Name (or array of names) to get from context
+     * @param store - Name of context store
+     */
+    static get(name: string | string[], store: string);
+    /**
+     * Get one or multiple values from context (asynchronous).
+     * @param name - Name (or array of names) to get from context
+     * @param store - Name of context store
+     * @param {function} callback - (optional) Callback function (`(err,value) => {}`)
+     */
+    static get(name: string | string[], store: string, callback: Function);
+
+
+    /**
+     * Set one or multiple values in context (synchronous).
+     * @param name - Name (or array of names) to set in context
+     * @param value - The value (or array of values) to store in context. If the value(s) are null/undefined, the context item(s) will be removed. 
+     */
+    static set(name: string | string[], value?: any | any[]);
+    /**
+     * Set one or multiple values in context (asynchronous).
+     * @param name - Name (or array of names) to set in context
+     * @param value - The value (or array of values) to store in context. If the value(s) are null/undefined, the context item(s) will be removed. 
+     * @param callback - (optional) Callback function (`(err) => {}`)
+     */
+    static set(name: string | string[], value?: any | any[], callback?: Function);
+    /**
+     * Set one or multiple values in context (synchronous).
+     * @param name - Name (or array of names) to set in context
+     * @param value - The value (or array of values) to store in context. If the value(s) are null/undefined, the context item(s) will be removed. 
+     * @param store - (optional) Name of context store
+     */
+    static set(name: string | string[], value?: any | any[], store?: string);
+    /**
+     * Set one or multiple values in context (asynchronous).
+     * @param name - Name (or array of names) to set in context
+     * @param value - The value (or array of values) to store in context. If the value(s) are null/undefined, the context item(s) will be removed. 
+     * @param store - (optional) Name of context store
+     * @param callback - (optional) Callback function (`(err) => {}`)
+     */
+    static set(name: string | string[], value?: any | any[], store?: string, callback?: Function);
+ 
+    /** Get an array of the keys in the context store */
+    static keys(): Array<string>;
+    /** Get an array of the keys in the context store */
+    static keys(store: string): Array<string>;
+    /** Get an array of the keys in the context store */
+    static keys(callback: Function);
+    /** Get an array of the keys in the context store */
+    static keys(store: string, callback: Function);
+}
+declare class env {
+    /** Get an environment variable value */
+    static get(name:string);
+}

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

@@ -0,0 +1,211 @@
+
+/* NOTE: Do not edit directly! This file is generated using \`npm run update-types\` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
+
+
+/*
+How to generate...
+1. Generate from packages\node_modules\@node-red\util\lib\util.js using `npx typescript` and a tsconfig.json of...
+{
+    "files": ["packages/node_modules/@node-red/util/lib/util.js"],
+    "compilerOptions": {
+      "allowJs": true,
+      "declaration": true,
+      "emitDeclarationOnly": true,
+      "outDir": "types",
+      "strict": false,
+      "moduleResolution": "node"
+    }
+}
+2. remove all the `export ` statements
+3. Wrap the remaining code in  declare namespace RED {  declare namespace util {  ...  } }
+4. check . adjust types like String --> string, Object --> object etc (where appropriate)
+*/
+
+declare namespace RED {
+    /**
+     * Utility functions for the node-red function sandbox
+     */
+    namespace util {
+
+        /**
+         * Encode an object to JSON without losing information about non-JSON types
+         * such as Buffer and Function.
+         *
+         * *This function is closely tied to its reverse within the editor*
+         *
+         * @param {Object} msg
+         * @param {Object} opts
+         * @return {Object} the encoded object
+         * @memberof @node-red/util_util
+         */
+        function encodeObject(msg: any, opts: any): any;
+        /**
+         * Converts the provided argument to a String, using type-dependent
+         * methods.
+         *
+         * @param  {any}    o - the property to convert to a String
+         * @return {string} the stringified version
+         * @memberof @node-red/util_util
+         */
+        function ensureString(o: any): string;
+        /**
+         * Converts the provided argument to a Buffer, using type-dependent
+         * methods.
+         *
+         * @param  {any}    o - the property to convert to a Buffer
+         * @return {string} the Buffer version
+         * @memberof @node-red/util_util
+         */
+        function ensureBuffer(o: any): string;
+        /**
+         * Safely clones a message object. This handles msg.req/msg.res objects that must
+         * not be cloned.
+         *
+         * @param  {object} msg - the message object to clone
+         * @return {object} the cloned message
+         * @memberof @node-red/util_util
+         */
+        function cloneMessage(msg: object): object;
+        /**
+         * Compares two objects, handling various JavaScript types.
+         *
+         * @param  {any}    obj1
+         * @param  {any}    obj2
+         * @return {boolean} whether the two objects are the same
+         * @memberof @node-red/util_util
+         */
+        function compareObjects(obj1: any, obj2: any): boolean;
+        /**
+         * Generates a psuedo-unique-random id.
+         * @return {string} a random-ish id
+         * @memberof @node-red/util_util
+         */
+        function generateId(): string;
+        /**
+         * Gets a property of a message object.
+         *
+         * Unlike {@link @node-red/util-util.getObjectProperty}, this function will strip `msg.` from the
+         * front of the property expression if present.
+         *
+         * @param  {object} msg - the message object
+         * @param  {string} expr - the property expression
+         * @return {any} the message property, or undefined if it does not exist
+         * @throws Will throw an error if the *parent* of the property does not exist
+         * @memberof @node-red/util_util
+         */
+        function getMessageProperty(msg: object, expr: string): any;
+        /**
+         * Sets a property of a message object.
+         *
+         * Unlike {@link @node-red/util-util.setObjectProperty}, this function will strip `msg.` from the
+         * front of the property expression if present.
+         *
+         * @param  {object}  msg           - the message object
+         * @param  {string}  prop          - the property expression
+         * @param  {any}     [value]         - the value to set
+         * @param  {boolean} [createMissing] - whether to create missing parent properties
+         * @memberof @node-red/util_util
+         */
+        function setMessageProperty(msg: object, prop: string, value?: any, createMissing?: boolean): boolean;
+        /**
+         * Gets a property of an object.
+         *
+         * Given the object:
+         *
+         *     {
+         *       "pet": {
+         *           "type": "cat"
+         *       }
+         *     }
+         *
+         * - `pet.type` will return `"cat"`.
+         * - `pet.name` will return `undefined`
+         * - `car` will return `undefined`
+         * - `car.type` will throw an Error (as `car` does not exist)
+         *
+         * @param  {object} msg - the object
+         * @param  {string} expr - the property expression
+         * @return {any} the object property, or undefined if it does not exist
+         * @throws Will throw an error if the *parent* of the property does not exist
+         * @memberof @node-red/util_util
+         */
+        function getObjectProperty(msg: object, expr: string): any;
+        /**
+         * Sets a property of an object.
+         *
+         * @param  {object}  msg           - the object
+         * @param  {string}  prop          - the property expression
+         * @param  {any}     [value]         - the value to set
+         * @param  {boolean} [createMissing] - whether to create missing parent properties
+         * @memberof @node-red/util_util
+         */
+        function setObjectProperty(msg: object, prop: string, value?: any, createMissing?: boolean): boolean;
+        /**
+         * Evaluates a property value according to its type.
+         *
+         * @param  {string}   value    - the raw value
+         * @param  {string}   type     - the type of the value
+         * @param  {Node}     node     - the node evaluating the property
+         * @param  {Object}   msg      - the message object to evaluate against
+         * @param  {Function} callback - (optional) called when the property is evaluated
+         * @return {any} The evaluated property, if no `callback` is provided
+         * @memberof @node-red/util_util
+         */
+        function evaluateNodeProperty(value: string, type: string, node: Node, msg: any, callback: Function): any;
+        /**
+         * Parses a property expression, such as `msg.foo.bar[3]` to validate it
+         * and convert it to a canonical version expressed as an Array of property
+         * names.
+         *
+         * For example, `a["b"].c` returns `['a','b','c']`
+         *
+         * @param  {string} str - the property expression
+         * @return {any[]} the normalised expression
+         * @memberof @node-red/util_util
+         */
+        function normalisePropertyExpression(str: string): any[];
+        /**
+         * Normalise a node type name to camel case.
+         *
+         * For example: `a-random node type` will normalise to `aRandomNodeType`
+         *
+         * @param  {string} name - the node type
+         * @return {string} The normalised name
+         * @memberof @node-red/util_util
+         */
+        function normaliseNodeTypeName(name: string): string;
+        /**
+         * Prepares a JSONata expression for evaluation.
+         * This attaches Node-RED specific functions to the expression.
+         *
+         * @param  {string} value - the JSONata expression
+         * @param  {Node}   node  - the node evaluating the property
+         * @return {any} The JSONata expression that can be evaluated
+         * @memberof @node-red/util_util
+         */
+        function prepareJSONataExpression(value: string, node: Node): any;
+        /**
+         * Evaluates a JSONata expression.
+         * The expression must have been prepared with {@link @node-red/util-util.prepareJSONataExpression}
+         * before passing to this function.
+         *
+         * @param  {Object}   expr     - the prepared JSONata expression
+         * @param  {Object}   msg      - the message object to evaluate against
+         * @param  {Function} callback - (optional) called when the expression is evaluated
+         * @return {any} If no callback was provided, the result of the expression
+         * @memberof @node-red/util_util
+         */
+        function evaluateJSONataExpression(expr: any, msg: any, callback: Function): any;
+        /**
+         * Parses a context property string, as generated by the TypedInput, to extract
+         * the store name if present.
+         *
+         * For example, `#:(file)::foo` results in ` { store: "file", key: "foo" }`.
+         *
+         * @param  {string} key - the context property string to parse
+         * @return {any} The parsed property
+         * @memberof @node-red/util_util
+         */
+        function parseContextStore(key: string): any;
+    }
+}