@machhub-dev/node-red-nodes 1.0.5

package/node_modules/@types/node-red/index.d.ts

@@ -0,0 +1,241 @@
+// tslint:disable:no-empty-interface
+
+import { EventEmitter } from "events";
+import { Express } from "express";
+import { Server as HttpServer } from "http";
+
+import * as editorAPI from "@node-red/editor-api";
+import * as editorClient from "@node-red/editor-client";
+import * as registry from "@node-red/registry";
+import * as runtime from "@node-red/runtime";
+import * as util from "@node-red/util";
+
+declare const nodeRed: nodeRed.NodeRedApp;
+
+export = nodeRed;
+
+declare namespace nodeRed {
+    interface NodeRedApp {
+        /**
+         * Initialise the Node-RED application.
+         * @param httpServer - the HTTP server object to use
+         * @param userSettings - an object containing the runtime settings
+         */
+        init: (httpServer: HttpServer, userSettings: runtime.LocalSettings) => void;
+
+        /**
+         * Start the Node-RED application.
+         */
+        start: () => Promise<void>;
+
+        /**
+         * Stop the Node-RED application.
+         */
+        stop: () => Promise<void>;
+
+        /**
+         * Logging utilities
+         */
+        log: util.Log;
+
+        /**
+         * General utilities
+         */
+        util: util.Util;
+
+        /**
+         * This provides access to the internal nodes module of the
+         * runtime. The details of this API remain undocumented as they should not
+         * be used directly.
+         *
+         * Most administrative actions should be performed use the runtime api
+         * under @node-red/runtime.
+         */
+        readonly nodes: runtime.InternalNodesModule;
+
+        /**
+         * This provides access to the internal plugins module of the
+         * runtime. The details of this API remain undocumented as they should not
+         * be used directly.
+         *
+         * Most administrative actions should be performed use the runtime api
+         * under @node-red/runtime.
+         */
+        readonly plugins: runtime.InternalPluginsModule;
+
+        /**
+         * Runtime events emitter
+         */
+        events: EventEmitter;
+
+        /**
+         * Runtime hooks engine
+         */
+        hooks: util.Hooks;
+
+        /**
+         * This provides access to the internal settings module of the
+         * runtime.
+         */
+        readonly settings: runtime.PersistentSettings;
+
+        /**
+         * Get the version of the runtime
+         */
+        readonly version: string;
+
+        /**
+         * The express application for the Editor Admin API
+         */
+        readonly httpAdmin: Express;
+
+        /**
+         * The express application for HTTP Nodes
+         */
+        readonly httpNode: Express;
+
+        /**
+         * The HTTP Server used by the runtime
+         */
+        readonly server: HttpServer;
+
+        /**
+         * The runtime api
+         */
+        runtime: runtime.RuntimeModule;
+
+        /**
+         * The editor authentication api.
+         */
+        auth: editorAPI.Auth;
+    }
+
+    /*******************************************************************
+     * Type shortcuts for writing the runtime side of nodes (.js file)
+     *******************************************************************/
+
+    /**
+     * Type def for the functions that should be exported
+     * by the node .js files.
+     */
+    interface NodeInitializer<TSets extends NodeAPISettingsWithData = NodeAPISettingsWithData>
+        extends registry.NodeInitializer<TSets>
+    {}
+
+    interface NodeConstructor<TNode extends Node<TCreds>, TNodeDef extends NodeDef, TCreds extends {}>
+        extends registry.NodeConstructor<TNode, TNodeDef, TCreds>
+    {}
+
+    interface NodeAPISettingsWithData extends registry.NodeAPISettingsWithData {}
+
+    interface NodeSetting<T> extends registry.NodeSetting<T> {}
+
+    type NodeSettings<TSets> = registry.NodeSettings<TSets>;
+
+    interface NodeCredential extends registry.NodeCredential {}
+
+    type NodeCredentials<TCreds> = registry.NodeCredentials<TCreds>;
+
+    interface NodeMessage extends registry.NodeMessage {}
+
+    interface NodeMessageParts extends registry.NodeMessageParts {}
+
+    interface NodeMessageInFlow extends registry.NodeMessageInFlow {}
+
+    interface NodeAPI<TSets extends NodeAPISettingsWithData = NodeAPISettingsWithData>
+        extends registry.NodeAPI<TSets>
+    {}
+
+    interface Node<TCreds extends {} = {}> extends registry.Node<TCreds> {}
+
+    type NodeStatusFill = registry.NodeStatusFill;
+
+    type NodeStatusShape = registry.NodeStatusShape;
+
+    interface NodeStatus extends registry.NodeStatus {}
+
+    interface NodeDef extends registry.NodeDef {}
+
+    interface NodeContextData extends registry.NodeContextData {}
+
+    interface NodeContext extends registry.NodeContext {}
+
+    /********************************************************************
+     * Type shortcuts for writing the editor side of nodes (.html file)
+     ********************************************************************/
+
+    /**
+     * Property definition
+     * Read more: https://nodered.org/docs/creating-nodes/properties#property-definitions
+     */
+    interface EditorNodePropertyDef<TVal, TInstProps extends EditorNodeProperties = EditorNodeProperties>
+        extends editorClient.NodePropertyDef<TVal, TInstProps>
+    {}
+
+    /**
+     * Properties definitions (`defaults` object)
+     * Read more: https://nodered.org/docs/creating-nodes/properties
+     */
+    type EditorNodePropertiesDef<
+        TProps extends EditorNodeProperties,
+        TInstProps extends TProps = TProps,
+    > = editorClient.NodePropertiesDef<TProps, TInstProps>;
+
+    /**
+     * Node properties
+     * Read more: https://nodered.org/docs/creating-nodes/properties
+     */
+    interface EditorNodeProperties extends editorClient.NodeProperties {}
+
+    type EditorNodeInstance<TProps extends EditorNodeProperties = EditorNodeProperties> = editorClient.NodeInstance<
+        TProps
+    >;
+
+    type EditorNodeCredentials<T> = editorClient.NodeCredentials<T>;
+
+    interface EditorNodeCredential extends editorClient.NodeCredential {}
+
+    /**
+     * Node Definition
+     * Read more: https://nodered.org/docs/creating-nodes/node-html#node-definition
+     */
+    interface EditorNodeDef<
+        TProps extends EditorNodeProperties = EditorNodeProperties,
+        TCreds = undefined,
+        TInstProps extends TProps = TProps,
+    > extends editorClient.NodeDef<TProps, TCreds, TInstProps> {}
+
+    /**
+     * Type def for the global `RED` in the node .html files.
+     * Should be used to access `RED.nodes.registerType` function
+     * registering a node with the editor.
+     *
+     * Example:
+     * ```
+     * declare const RED: EditorRED;
+     *
+     * RED.nodes.registerType<
+     *   MyNodeProps
+     * >("my-node", {
+     *   ...
+     * })
+     * ```
+     */
+    interface EditorRED extends editorClient.RED {}
+
+    /**
+     * WIDGETS
+     */
+
+    interface EditorWidgetEditableListOptions<T> extends editorClient.WidgetEditableListOptions<T> {}
+
+    interface EditorWidgetEditableList extends editorClient.WidgetEditableList {}
+
+    interface EditorWidgetTypedInputOptions extends editorClient.WidgetTypedInputOptions {}
+
+    type EditorWidgetTypedInputType = editorClient.WidgetTypedInputType;
+
+    interface EditorWidgetTypedInputTypeDefinition extends editorClient.WidgetTypedInputTypeDefinition {}
+
+    interface EditorWidgetTypedInput extends editorClient.WidgetTypedInput {}
+}

package/node_modules/@types/node-red/package.json

@@ -0,0 +1,52 @@
+{
+    "name": "@types/node-red",
+    "version": "1.3.5",
+    "description": "TypeScript definitions for node-red",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-red",
+    "license": "MIT",
+    "contributors": [
+        {
+            "name": "Anders E. Andersen",
+            "githubUsername": "andersea",
+            "url": "https://github.com/andersea"
+        },
+        {
+            "name": "Thomas B. Mørch",
+            "githubUsername": "tbowmo",
+            "url": "https://github.com/tbowmo"
+        },
+        {
+            "name": "Bernardo Belchior",
+            "githubUsername": "bernardobelchior",
+            "url": "https://github.com/bernardobelchior"
+        },
+        {
+            "name": "Alex Kaul",
+            "githubUsername": "alexk111",
+            "url": "https://github.com/alexk111"
+        },
+        {
+            "name": "Tadeusz Wyrzykowski",
+            "githubUsername": "Shaquu",
+            "url": "https://github.com/Shaquu"
+        }
+    ],
+    "main": "",
+    "types": "index.d.ts",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/node-red"
+    },
+    "scripts": {},
+    "dependencies": {
+        "@types/express": "*",
+        "@types/node-red__editor-api": "*",
+        "@types/node-red__editor-client": "*",
+        "@types/node-red__registry": "*",
+        "@types/node-red__runtime": "*",
+        "@types/node-red__util": "*"
+    },
+    "typesPublisherContentHash": "cd24b60478af70c1312080044a19637f3a6d3acea0a167cba0a1d4d9949a4817",
+    "typeScriptVersion": "4.7"
+}

package/node_modules/@types/node-red__editor-api/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/node_modules/@types/node-red__editor-api/README.md

@@ -0,0 +1,65 @@
+# Installation
+> `npm install --save @types/node-red__editor-api`
+
+# Summary
+This package contains type definitions for @node-red/editor-api (https://github.com/node-red/node-red/tree/master/packages/node_modules/%40node-red/editor-api).
+
+# Details
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-red__editor-api.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-red__editor-api/index.d.ts)
+````ts
+import { Express, NextFunction, Request, Response } from "express";
+import { Server as HttpsServer } from "https";
+
+import * as runtime from "@node-red/runtime";
+
+declare const editorAPI: editorAPI.EditorAPIModule;
+
+export = editorAPI;
+
+declare namespace editorAPI {
+    interface Auth {
+        needsPermission: (permission: string) => (req: Request, res: Response, next: NextFunction) => void;
+    }
+    interface EditorAPIModule {
+        /**
+         * Initialise the module.
+         * @param  settings   The runtime settings
+         * @param  _server    An instance of HTTP Server
+         * @param  storage    An instance of Node-RED Storage
+         * @param  runtimeAPI An instance of Node-RED Runtime
+         */
+        init: (
+            settings: runtime.LocalSettings,
+            _server: HttpsServer,
+            storage: runtime.StorageModule,
+            runtimeAPI: runtime.RuntimeModule,
+        ) => void;
+
+        /**
+         * Start the module.
+         */
+        start: () => Promise<void>;
+
+        /**
+         * Stop the module.
+         */
+        stop: () => Promise<void>;
+
+        auth: Auth;
+
+        /**
+         * The Express app used to serve the Node-RED Editor
+         */
+        readonly httpAdmin: Express;
+    }
+}
+
+````
+
+### Additional Details
+ * Last updated: Fri, 08 Mar 2024 17:07:21 GMT
+ * Dependencies: [@types/express](https://npmjs.com/package/@types/express), [@types/node-red__runtime](https://npmjs.com/package/@types/node-red__runtime)
+
+# Credits
+These definitions were written by [Alex Kaul](https://github.com/alexk111), and [Tadeusz Wyrzykowski](https://github.com/Shaquu).

package/node_modules/@types/node-red__editor-api/index.d.ts

@@ -0,0 +1,46 @@
+import { Express, NextFunction, Request, Response } from "express";
+import { Server as HttpsServer } from "https";
+
+import * as runtime from "@node-red/runtime";
+
+declare const editorAPI: editorAPI.EditorAPIModule;
+
+export = editorAPI;
+
+declare namespace editorAPI {
+    interface Auth {
+        needsPermission: (permission: string) => (req: Request, res: Response, next: NextFunction) => void;
+    }
+    interface EditorAPIModule {
+        /**
+         * Initialise the module.
+         * @param  settings   The runtime settings
+         * @param  _server    An instance of HTTP Server
+         * @param  storage    An instance of Node-RED Storage
+         * @param  runtimeAPI An instance of Node-RED Runtime
+         */
+        init: (
+            settings: runtime.LocalSettings,
+            _server: HttpsServer,
+            storage: runtime.StorageModule,
+            runtimeAPI: runtime.RuntimeModule,
+        ) => void;
+
+        /**
+         * Start the module.
+         */
+        start: () => Promise<void>;
+
+        /**
+         * Stop the module.
+         */
+        stop: () => Promise<void>;
+
+        auth: Auth;
+
+        /**
+         * The Express app used to serve the Node-RED Editor
+         */
+        readonly httpAdmin: Express;
+    }
+}

package/node_modules/@types/node-red__editor-api/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "@types/node-red__editor-api",
+    "version": "1.3.5",
+    "description": "TypeScript definitions for @node-red/editor-api",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-red__editor-api",
+    "license": "MIT",
+    "contributors": [
+        {
+            "name": "Alex Kaul",
+            "githubUsername": "alexk111",
+            "url": "https://github.com/alexk111"
+        },
+        {
+            "name": "Tadeusz Wyrzykowski",
+            "githubUsername": "Shaquu",
+            "url": "https://github.com/Shaquu"
+        }
+    ],
+    "main": "",
+    "types": "index.d.ts",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/node-red__editor-api"
+    },
+    "scripts": {},
+    "dependencies": {
+        "@types/express": "*",
+        "@types/node-red__runtime": "*"
+    },
+    "typesPublisherContentHash": "48b9d2ad1bbbdc6596ecdd6f9889f943b37102589e5b7aad3d11216211c4dac5",
+    "typeScriptVersion": "4.7"
+}

package/node_modules/@types/node-red__editor-client/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/node_modules/@types/node-red__editor-client/README.md

@@ -0,0 +1,15 @@
+# Installation
+> `npm install --save @types/node-red__editor-client`
+
+# Summary
+This package contains type definitions for @node-red/editor-client (https://github.com/node-red/node-red/tree/master/packages/node_modules/%40node-red/editor-client).
+
+# Details
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-red__editor-client.
+
+### Additional Details
+ * Last updated: Fri, 08 Mar 2024 17:07:21 GMT
+ * Dependencies: [@types/ace](https://npmjs.com/package/@types/ace), [@types/jquery](https://npmjs.com/package/@types/jquery), [@types/node-red__registry](https://npmjs.com/package/@types/node-red__registry), [@types/node-red__runtime](https://npmjs.com/package/@types/node-red__runtime), [@types/node-red__util](https://npmjs.com/package/@types/node-red__util)
+
+# Credits
+These definitions were written by [Alex Kaul](https://github.com/alexk111), and [Tadeusz Wyrzykowski](https://github.com/Shaquu).