@bonsae/nrg 0.5.4 → 0.6.1

package/README.md

@@ -47,23 +47,53 @@ export default defineConfig({
 });
 ```
 
-**src/server/index.ts**
+**src/server/schemas/my-node.ts**
 
 ```typescript
-import MyNode from "./nodes/my-node";
-
-export default {
-  nodes: [MyNode],
-};
+import { defineSchema, SchemaType } from "@bonsae/nrg/server";
+
+export const ConfigsSchema = defineSchema(
+  {
+    name: SchemaType.String({ default: "" }),
+    prefix: SchemaType.String({ default: "hello" }),
+  },
+  { $id: "my-node:configs" }
+);
 ```
 
 **src/server/nodes/my-node.ts**
 
+NRG supports two ways to define nodes:
+
+<table>
+<tr><th>Functional API</th><th>Class API</th></tr>
+<tr><td>
+
+```typescript
+import { defineIONode } from "@bonsae/nrg/server";
+import { ConfigsSchema } from "../schemas/my-node";
+
+export default defineIONode({
+  type: "my-node",
+  color: "#ffffff",
+  inputs: 1,
+  outputs: 1,
+  configSchema: ConfigsSchema,
+
+  async input(msg) {
+    msg.payload = `${this.config.prefix}: ${msg.payload}`;
+    this.send(msg);
+  },
+});
+```
+
+</td><td>
+
 ```typescript
 import { IONode, type Schema, type Infer } from "@bonsae/nrg/server";
 import { ConfigsSchema } from "../schemas/my-node";
 
-export type Config = Infer<typeof ConfigsSchema>;
+type Config = Infer<typeof ConfigsSchema>;
 
 export default class MyNode extends IONode<Config> {
   static readonly type = "my-node";
@@ -74,11 +104,30 @@ export default class MyNode extends IONode<Config> {
   static readonly configSchema: Schema = ConfigsSchema;
 
   async input(msg: any) {
+    msg.payload = `${this.config.prefix}: ${msg.payload}`;
     this.send(msg);
   }
 }
 ```
 
+</td></tr>
+<tr>
+<td>Automatic type inference, less boilerplate</td>
+<td>Custom methods, inheritance, mixins</td>
+</tr>
+</table>
+
+**src/server/index.ts**
+
+```typescript
+import { defineModule } from "@bonsae/nrg/server";
+import MyNode from "./nodes/my-node";
+
+export default defineModule({
+  nodes: [MyNode],
+});
+```
+
 See the [consumer template](https://github.com/AllanOricil/node-red-vue-template) for a complete example.
 
 ## Project Structure

package/build/server/index.cjs

@@ -35,13 +35,14 @@ __export(index_exports, {
   Node: () => Node,
   NrgError: () => NrgError,
   SchemaType: () => SchemaType,
+  defineConfigNode: () => defineConfigNode,
+  defineIONode: () => defineIONode,
+  defineModule: () => defineModule,
   defineSchema: () => defineSchema,
   registerType: () => registerType,
   registerTypes: () => registerTypes
 });
 module.exports = __toCommonJS(index_exports);
-var import_path = __toESM(require("path"), 1);
-var import_fs = __toESM(require("fs"), 1);
 
 // src/core/server/utils.ts
 function getCredentialsFromSchema(schema) {
@@ -657,6 +658,117 @@ var ConfigNode = class extends Node {
   }
 };
 
+// src/core/server/nodes/factories.ts
+function defineIONode(def) {
+  const NodeClass = class extends IONode {
+    static type = def.type;
+    static category = def.category ?? "function";
+    static color = def.color ?? "#a6bbcf";
+    static inputs = def.inputs ?? 1;
+    static outputs = def.outputs ?? 1;
+    static paletteLabel = def.paletteLabel;
+    static inputLabels = def.inputLabels;
+    static outputLabels = def.outputLabels;
+    static align = def.align;
+    static labelStyle = def.labelStyle;
+    static configSchema = def.configSchema;
+    static credentialsSchema = def.credentialsSchema;
+    static settingsSchema = def.settingsSchema;
+    static inputSchema = def.inputSchema;
+    static outputsSchema = def.outputsSchema;
+    static validateInput = def.validateInput ?? false;
+    static validateOutput = def.validateOutput ?? false;
+    static _registered(RED) {
+      this.validateSettings(RED);
+      return def.registered?.(RED);
+    }
+    async input(msg) {
+      if (def.input) return def.input.call(this, msg);
+    }
+    async created() {
+      if (def.created) return def.created.call(this);
+    }
+    async closed(removed) {
+      if (def.closed) return def.closed.call(this, removed);
+    }
+  };
+  Object.defineProperty(NodeClass, "name", {
+    value: def.type.replace(
+      /(^|-)(\w)/g,
+      (_, __, c) => c.toUpperCase()
+    ),
+    configurable: true
+  });
+  return NodeClass;
+}
+function defineConfigNode(def) {
+  const NodeClass = class extends ConfigNode {
+    static type = def.type;
+    static configSchema = def.configSchema;
+    static credentialsSchema = def.credentialsSchema;
+    static settingsSchema = def.settingsSchema;
+    static _registered(RED) {
+      this.validateSettings(RED);
+      return def.registered?.(RED);
+    }
+    async created() {
+      if (def.created) return def.created.call(this);
+    }
+    async closed(removed) {
+      if (def.closed) return def.closed.call(this, removed);
+    }
+  };
+  Object.defineProperty(NodeClass, "name", {
+    value: def.type.replace(
+      /(^|-)(\w)/g,
+      (_, __, c) => c.toUpperCase()
+    ),
+    configurable: true
+  });
+  return NodeClass;
+}
+
+// src/core/server/api/serve-nrg-resources.ts
+var import_path = __toESM(require("path"), 1);
+var import_fs = __toESM(require("fs"), 1);
+var MIME = {
+  ".js": "application/javascript",
+  ".mjs": "application/javascript",
+  ".css": "text/css",
+  ".json": "application/json",
+  ".map": "application/json",
+  ".png": "image/png",
+  ".svg": "image/svg+xml"
+};
+var _registered = false;
+function serveNrgResources(RED) {
+  if (_registered) return;
+  _registered = true;
+  const clientDir = import_path.default.resolve(__dirname, "./resources");
+  if (!import_fs.default.existsSync(clientDir)) return;
+  const httpAdmin = RED.httpAdmin;
+  if (!httpAdmin) return;
+  httpAdmin.use(function(req, res, next) {
+    const prefix = "/nrg/assets/";
+    if (!req.path.startsWith(prefix)) return next();
+    let reqPath = req.path.slice(prefix.length);
+    if (reqPath === "vue.esm-browser.prod.js" && process.env.NODE_ENV !== "production") {
+      const devPath = import_path.default.resolve(clientDir, "vue.esm-browser.js");
+      if (import_fs.default.existsSync(devPath)) {
+        reqPath = "vue.esm-browser.js";
+      }
+    }
+    const filePath = import_path.default.resolve(clientDir, reqPath);
+    const rel = import_path.default.relative(clientDir, filePath);
+    if (rel.startsWith("..") || import_path.default.isAbsolute(rel)) return next();
+    if (!import_fs.default.existsSync(filePath) || !import_fs.default.statSync(filePath).isFile())
+      return next();
+    const ext = import_path.default.extname(filePath);
+    res.setHeader("Content-Type", MIME[ext] ?? "application/octet-stream");
+    import_fs.default.createReadStream(filePath).pipe(res);
+  });
+}
+
 // src/core/constants.ts
 var TYPED_INPUT_TYPES = [
   "msg",
@@ -790,43 +902,6 @@ var TypedInputSchema = SchemaType.Object(
 );
 
 // src/core/server/index.ts
-var MIME = {
-  ".js": "application/javascript",
-  ".mjs": "application/javascript",
-  ".css": "text/css",
-  ".json": "application/json",
-  ".map": "application/json",
-  ".png": "image/png",
-  ".svg": "image/svg+xml"
-};
-var _nrgResourcesRegistered = false;
-function serveNrgResources(RED) {
-  if (_nrgResourcesRegistered) return;
-  _nrgResourcesRegistered = true;
-  const clientDir = import_path.default.resolve(__dirname, "./resources");
-  if (!import_fs.default.existsSync(clientDir)) return;
-  const httpAdmin = RED.httpAdmin;
-  if (!httpAdmin) return;
-  httpAdmin.use(function(req, res, next) {
-    const prefix = "/nrg/assets/";
-    if (!req.path.startsWith(prefix)) return next();
-    let reqPath = req.path.slice(prefix.length);
-    if (reqPath === "vue.esm-browser.prod.js" && process.env.NODE_ENV !== "production") {
-      const devPath = import_path.default.resolve(clientDir, "vue.esm-browser.js");
-      if (import_fs.default.existsSync(devPath)) {
-        reqPath = "vue.esm-browser.js";
-      }
-    }
-    const filePath = import_path.default.resolve(clientDir, reqPath);
-    const rel = import_path.default.relative(clientDir, filePath);
-    if (rel.startsWith("..") || import_path.default.isAbsolute(rel)) return next();
-    if (!import_fs.default.existsSync(filePath) || !import_fs.default.statSync(filePath).isFile())
-      return next();
-    const ext = import_path.default.extname(filePath);
-    res.setHeader("Content-Type", MIME[ext] ?? "application/octet-stream");
-    import_fs.default.createReadStream(filePath).pipe(res);
-  });
-}
 async function registerType(RED, NodeClass) {
   const NC = NodeClass;
   RED.log.debug(`Registering Type: ${NC.type}`);
@@ -939,6 +1014,9 @@ function registerTypes(nodes) {
   fn.nodes = nodes;
   return fn;
 }
+function defineModule(definition) {
+  return definition;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ConfigNode,
@@ -946,6 +1024,9 @@ function registerTypes(nodes) {
   Node,
   NrgError,
   SchemaType,
+  defineConfigNode,
+  defineIONode,
+  defineModule,
   defineSchema,
   registerType,
   registerTypes