@nrutils/node-red-utils 0.0.0-stage → 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## 0.2.0 (2026-11-10)
+
+- `nodeRedWorker`: a throw (or a rejected Promise) in a worker `subscribe` handler goes to the new `worker.handlerError(error, type, data)`, with the data of the message. The default reports it on the node with `node.error`, so a Catch node gets it, instead of `console.error`. The next handlers of the same message still run. A worker file can replace `worker.handlerError`.
+- `nodeRedPopup`: the popup unfurls from its node with a spring animation. The user moves it by its status bar; the position is saved in `nru_popupConfig` (`x`, `y`) and a dashed line ties it to the node. A resize follows the zoom of the canvas. The popup is a rounded card in the editor theme (light or dark), with the color of its node on the top edge and the tether line, dots on the status bar that show it can be moved, and a larger resize corner.
+
+## 0.1.0
+
+First public release.
+
+- `NodeRedNodeBase`: mixin composition.
+- `nodeRedEditorComms`: editor and backend messaging.
+- `nodeRedWorker`: worker threads, with `request()` / `handle()` for one answer per message.
+- `nodeRedResourceEndpoint`: static file serving for the editor, also from `resources` in the `createNode` options.
+- `nodeRedPopup`: a panel that opens when you click the node in the editor. Experimental.
+- `nodeRedSingleton`: one node of a type in the editor. Experimental.
+- `nodeRedPubsubBus`: pub/sub between nodes; consumers pull the current value.
+- `nodeRedGpu`: Vulkan compute. Experimental and optional. Without the native addon, kernels run on the CPU backend.
+- Eight examples (nine nodes) in `examples/`.

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,188 @@
-# Temporary Holding Version
+# node-red-utils
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![npm](https://img.shields.io/npm/v/@nrutils/node-red-utils)](https://www.npmjs.com/package/@nrutils/node-red-utils)
+
+A toolkit for Node-RED custom nodes: worker threads, GPU compute, messages between the editor and the runtime, pub/sub between nodes, editor resources, a popup and singleton nodes.
+
+- [`NodeRedNodeBase`](./node-red-base/README.md): builds a node from a setup function and a list of mixins. A mixin is one feature; you add it by listing it.
+- [`nodeRedWorker`](./node-red-worker/README.md): runs node code in a worker thread. Wired worker nodes talk thread to thread, the same as the wires in the flow.
+- [`nodeRedGpu`](./node-red-gpu/README.md) (experimental): Vulkan compute kernels in worker threads, with a CPU fallback.
+- [`nodeRedEditorComms`](./node-red-editorcomms/README.md): messages between the runtime node and the same node in the editor.
+- [`nodeRedPubsubBus`](./node-red-pubsub-bus/README.md): pub/sub for data that nodes share without wires.
+- [`nodeRedResourceEndpoint`](./node-red-resourceendpoint/README.md): serves scripts, styles and images to the editor.
+- [`nodeRedPopup`](./node-red-popup/README.md) (experimental): a resizable panel that opens when you click the node in the editor.
+- [`nodeRedSingleton`](./node-red-singleton/README.md) (experimental): allows only one node of a type in the editor.
+
+## Install
+
+In your node package:
+
+```bash
+npm install @nrutils/node-red-utils
+```
+
+Works with Node-RED 4 and Node.js 18 or later.
+
+## Building with AI
+
+Use an AI coding assistant to build nodes!  Here's some [AI dreamed up paste-ready prompts](./prompts/README.md).  Not particularly useful nodes though.
+
+## Example: a counter node
+
+A node that counts messages, shows the count as its status, and resets the count when you click its button in the editor.
+
+`counter.js`:
+
+```js
+const { NodeRedNodeBase, nodeRedEditorComms } = require('@nrutils/node-red-utils');
+
+module.exports = NodeRedNodeBase.createNode('counter', [nodeRedEditorComms], (RED, thisNode, config) => {
+    let count = 0;
+    const show = () => thisNode.status({ text: `${count} messages` });
+
+    // Sent by the button in counter.html
+    thisNode.nodeRedEditorComms.subscribe('reset', () => {
+        count = 0;
+        show();
+    });
+
+    thisNode.on('input', (msg, send, done) => {
+        count++;
+        show();
+        send(msg);
+        done();
+    });
+});
+```
+
+`counter.html`:
+
+```html
+<script type="text/javascript" src="node-red-resourceendpoint/node-red-editorcomms/EditorCommsFrontend.js"></script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('counter', {
+        category: 'function',
+        color: '#a6bbcf',
+        defaults: { name: { value: '' } },
+        inputs: 1,
+        outputs: 1,
+        icon: 'function.svg',
+        label: function () { return this.name || 'counter'; },
+        button: {
+            onclick: function () {
+                this.nodeRedEditorComms.publish('reset', {})
+                    .catch((err) => RED.notify(err.status === 404 ? 'Deploy the node first' : err.message, 'warning'));
+            }
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="counter">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+</script>
+```
+
+The first `<script>` line loads the editor side of `nodeRedEditorComms`. Copy this line exactly. The library serves the file; there is nothing to install.
+
+## Example: a worker node
+
+A node that hashes each payload in a worker thread, so the Node-RED event loop does not wait.
+
+`hash-node.js`:
+
+```js
+const path = require('path');
+const { NodeRedNodeBase, nodeRedWorker } = require('@nrutils/node-red-utils');
+
+module.exports = NodeRedNodeBase.createNode('hash-node', [nodeRedWorker], (RED, thisNode, config) => {
+    const worker = thisNode.nodeRedWorker.init(path.join(__dirname, 'hash-worker.js'), { rounds: 1000 });
+
+    thisNode.on('input', (msg, send, done) => {
+        worker.request('hash', String(msg.payload)).then((digest) => {
+            msg.payload = digest;
+            send(msg);
+            done();
+        }, done);
+    });
+});
+```
+
+`hash-worker.js`:
+
+```js
+const crypto = require('crypto');
+
+module.exports = function (worker, data) {
+    worker.handle('hash', (text) => {
+        let digest = text;
+        for (let i = 0; i < data.rounds; i++) digest = crypto.createHash('sha256').update(digest).digest('hex');
+        return digest;
+    });
+};
+```
+
+## package.json
+
+```json
+{
+  "name": "node-red-contrib-counter",
+  "version": "0.1.0",
+  "keywords": ["node-red"],
+  "node-red": {
+    "version": ">=4.0.0",
+    "nodes": { "counter": "counter.js" }
+  },
+  "dependencies": { "@nrutils/node-red-utils": "^0.1.0" }
+}
+```
+
+- The `.html` file sits next to the `.js` file and has the same base name.
+- The type string in the HTML `registerType` equals the type in `createNode`.
+- Put the library under `dependencies`, not `devDependencies`.
+
+To load your node package into Node-RED on your own computer, run `cd ~/.node-red && npm install /path/to/your-package`, then restart Node-RED.
+
+## Reference
+
+Put the features you want in the array of `createNode`; they apply in that order, then `setup(RED, thisNode, config)` runs.
+
+| Mixin | What it adds on `thisNode` | Editor script `<script src=...>` line |
+| --- | --- | --- |
+| `nodeRedWorker` | `nodeRedWorker`; call `init()` to start the worker | none |
+| `nodeRedGpu` | nothing; the GPU API is in the worker, from `nodeRedGpuWorker()` | none |
+| `nodeRedEditorComms` | `nodeRedEditorComms` | `node-red-resourceendpoint/node-red-editorcomms/EditorCommsFrontend.js` |
+| `nodeRedPubsubBus` | `nodeRedPubsubBus` | none |
+| `nodeRedResourceEndpoint` | `nodeRedResourceEndpoint` | none |
+| `nodeRedPopup` | nothing | `node-red-resourceendpoint/node-red-popup/NodeRedPopupFrontend.js` |
+| `nodeRedSingleton` | nothing | `node-red-resourceendpoint/node-red-singleton/NodeRedSingletonFrontend.js` |
+
+A mixin with an editor script must be in the array, or the script answers 404.
+
+Exports: `NodeRedNodeBase` and the lowercase mixins above, plus:
+
+- `getBus()`: the pub/sub bus of the process, for code that is not a node.
+- `NodeRedResourceEndpoint`: serves files without a node instance; `new NodeRedResourceEndpoint(RED).registerResources(nodeType, paths)`.
+
+To write your own mixin, see [node-red-base](./node-red-base/README.md#write-a-mixin).
+
+## Examples
+
+[`examples/basic-examples`](./examples/README.md) has one small node package for each feature. Install one with `cd ~/.node-red && npm install --install-links /path/to/node-red-utils/examples/basic-examples/<name>`, then restart Node-RED.
+
+## Troubleshooting
+
+- The editor script gets a 404 (for example `node-red-resourceendpoint/node-red-editorcomms/EditorCommsFrontend.js`, in the browser's network tab): the mixin is not in the `createNode` array of a node type that Node-RED loaded, or the `src` of the `<script>` tag starts with `/`. Restart Node-RED after you install or change a node package.
+
+## Contributing
+
+Issues and pull requests are welcome on [GitHub](https://github.com/UpDownMe733/node-red-utils/issues). Run `npm test` before you send a pull request.
+
+## License
+
+[Apache-2.0](./LICENSE)
+
+<small>[Sponsor this project](https://github.com/sponsors/UpDownMe733)</small>

package/index.js

@@ -0,0 +1,50 @@
+/**
+ * Copyright 2024 Contributors
+ * Licensed under the Apache License, Version 2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
+ */
+
+'use strict';
+
+const NodeRedNodeBase =             require('./node-red-base/NodeRedNodeBase.js');
+
+const NodeRedEditorComms =          require('./node-red-editorcomms/EditorCommsBackend.js');
+
+const NodeRedResourceEndpoint =     require('./node-red-resourceendpoint/NodeRedResourceEndpoint.js');
+
+const NodeRedWorker =               require('./node-red-worker/NodeRedWorker.js');
+const NodeRedWorkerRuntime =        require('./node-red-worker/NodeRedWorkerRuntime.js');
+
+const NodeRedPopup =                require('./node-red-popup/NodeRedPopupBackend.js');
+const NodeRedSingleton =            require('./node-red-singleton/NodeRedSingletonBackend.js');
+
+const NodeRedPubsubBus =            require('./node-red-pubsub-bus/NodeRedPubsubBus.js');
+
+module.exports = {
+
+    NodeRedNodeBase:                NodeRedNodeBase.NodeRedNodeBase,
+
+    nodeRedEditorComms:             NodeRedEditorComms.nodeRedEditorComms,
+    NodeRedEditorComms:             NodeRedEditorComms.NodeRedEditorComms,
+
+    nodeRedResourceEndpoint:        NodeRedResourceEndpoint.nodeRedResourceEndpoint,
+    NodeRedResourceEndpoint:        NodeRedResourceEndpoint.NodeRedResourceEndpoint,
+    
+    nodeRedWorker:                  NodeRedWorker.nodeRedWorker,
+    NodeRedWorker:                  NodeRedWorker.NodeRedWorker,
+    NodeRedWorkerRuntime:           NodeRedWorkerRuntime.NodeRedWorkerRuntime,
+
+    nodeRedPopup:                   NodeRedPopup.nodeRedPopup,
+    NodeRedPopup:                   NodeRedPopup.NodeRedPopup,
+
+    nodeRedSingleton:               NodeRedSingleton.nodeRedSingleton,
+
+    nodeRedPubsubBus:               NodeRedPubsubBus.nodeRedPubsubBus,
+    getBus:                         NodeRedPubsubBus.getBus,
+    NodeRedPubsubBus:               NodeRedPubsubBus.NodeRedPubsubBus,
+
+    // Loaded on first use, so that nodes without GPU code do not load the GPU module and acorn
+    get nodeRedGpu()                { return require('./node-red-gpu/index.js').nodeRedGpu; },
+    get nodeRedGpuWorker()          { return require('./node-red-gpu/index.js').nodeRedGpuWorker; },
+
+};

package/node-red-base/NodeRedNodeBase.js

@@ -0,0 +1,143 @@
+/**
+ * Copyright 2024 Contributors
+ * Licensed under the Apache License, Version 2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
+ */
+
+'use strict';
+
+/**
+ * Base class for Node-RED nodes that supports mixin composition
+ * 
+ * This class serves as the foundation for creating Node-RED nodes
+ * and provides functionality for applying multiple mixins using
+ * a functional composition pattern.
+ */
+/** Short description of a value for error messages */
+function describe(value) {
+    if (value === null) return 'null';
+    if (Array.isArray(value)) return 'an array';
+    if (typeof value === 'function') return `function ${value.name || '(anonymous)'}`;
+    return typeof value;
+}
+
+/** Throws a TypeError unless mixin is a function that takes a class and returns a subclass of it */
+function checkMixin(mixin, i, where) {
+    const prefix = `${where}: mixins[${i}] must be a mixin function (superclass) => class extends superclass`;
+    if (typeof mixin !== 'function') throw new TypeError(`${prefix}; got ${describe(mixin)}`);
+    if (mixin.toString().startsWith('class ')) throw new TypeError(`${prefix}; got the class ${mixin.name || '(anonymous)'} itself`);
+    const TestClass = function() {};
+    let result;
+    try {
+        result = mixin(TestClass);
+    } catch (e) {
+        throw new TypeError(`${prefix}; calling it threw: ${e.message}`);
+    }
+    if (typeof result !== 'function' || !(result.prototype instanceof TestClass)) {
+        throw new TypeError(`${prefix}; it returned ${describe(result)}, not a subclass of its argument`);
+    }
+}
+
+class NodeRedNodeBase {
+
+    /**
+     * Applies one or more mixin functions to extend the base class
+     * 
+     * This method uses functional composition to progressively apply
+     * each mixin function to the class, allowing multiple behaviors
+     * to be combined without deep inheritance hierarchies.
+     * 
+     * @param {...Function} mixins - One or more mixin functions that transform classes
+     * @returns {Class} - A new class with all mixins applied
+     * @throws {TypeError} - If any of the provided mixins is not a function
+     * 
+     * @example
+     * // Single mixin
+     * class MyNode extends NodeRedNodeBase.with(MixinA) {}
+     * 
+     * @example
+     * // Multiple mixins (applied left to right)
+     * class MyNode extends NodeRedNodeBase.with(MixinA, MixinB, MixinC) {}
+     */
+    static with(...mixins) {
+        mixins.forEach((mixin, i) => checkMixin(mixin, i, 'NodeRedNodeBase.with(...mixins)'));
+        return mixins.reduce((currentClass, mixin) => mixin(currentClass), this);
+    }
+
+    /**
+     * Creates a Node-RED node with specified mixins and custom setup
+     * 
+     * @param {string} nodeType - The type name to register with Node-RED
+     * @param {Array} mixins - Array of mixin functions to apply
+     * @param {Function} setupFn - Function for node setup (receives RED, thisNode, config)
+     * @param {Object} [options] - Third argument of RED.nodes.registerType, for example { credentials, settings }.
+     *   It can also hold `resources`: paths that the nodeRedResourceEndpoint mixin serves from the start.
+     *   createNode does not pass `resources` on to registerType.
+     * @returns {Function} - A function to be exported by the node module
+     */
+    static createNode(nodeType, mixins, setupFn, options) {
+        const where = 'createNode(type, mixins, setup)';
+        if (typeof nodeType !== 'string' || !nodeType) {
+            throw new TypeError(`${where}: type must be a non-empty string; got ${describe(nodeType)}`);
+        }
+        if (!Array.isArray(mixins)) {
+            throw new TypeError(`${where}: mixins must be an array of mixin functions; got ${describe(mixins)}`);
+        }
+        mixins.forEach((mixin, i) => checkMixin(mixin, i, where));
+        if (typeof setupFn !== 'function') {
+            throw new TypeError(`${where}: setup must be a function (RED, thisNode, config); got ${describe(setupFn)}`);
+        }
+        if (options !== undefined && (options === null || typeof options !== 'object' || Array.isArray(options))) {
+            throw new TypeError(`${where}: options must be an object such as { credentials, settings }; got ${describe(options)}`);
+        }
+        const { resources, ...registerOptions } = options || {};
+        return function(RED) {
+            // Create the composed class with mixins
+            const NodeClass = class extends NodeRedNodeBase.with(...mixins) {
+                // Read by onRegisterType of the resource endpoint mixin
+                static _registration = { nodeType, resources };
+
+                constructor(RED, thisNode, config) {
+                    super(RED, thisNode, config);
+
+                    // Run the setup function. It must be synchronous; report the error of an async one.
+                    const result = setupFn(RED, thisNode, config);
+                    if (result && typeof result.then === 'function') {
+                        result.then(undefined, (err) => thisNode.error(`setup of ${nodeType} failed: ${(err && err.message) || err}`));
+                    }
+                }
+            };
+
+            // Let the mixins do their one-time work before any node exists
+            NodeClass.onRegisterType(RED);
+
+            RED.nodes.registerType(nodeType, function(config) {
+                RED.nodes.createNode(this, config);
+                new NodeClass(RED, this, config);
+            }, options && registerOptions);
+        };
+    }
+
+    /**
+     * Called one time when the node type is registered, before any node instance exists.
+     * A mixin that overrides it must call super.onRegisterType(RED).
+     * The editor mixins use it to serve their frontend scripts.
+     *
+     * @param {Object} RED - The Node-RED runtime object
+     */
+    static onRegisterType(RED) {}
+    
+    /**
+     * Creates a new Node-RED node
+     * 
+     * @param {Object} RED - The Node-RED runtime object
+     * @param {Object} thisNode - The node being created
+     * @param {Object} config - Configuration options for the node
+     */
+    constructor(RED, thisNode, config) {
+        // Base implementation to be extended by subclasses
+    }
+
+}
+
+module.exports.NodeRedNodeBase = NodeRedNodeBase;