Important
The nrg-cli v3 is going to replace the build script in this repo once this template is fully functional.
Build Node-RED nodes using:
- Vue 3
- JSON Schemas (V7 draft)
- Typescript
- ESM module system
| Dependency | Version |
|---|---|
| node | v18.18.0 |
| node-red | v4.0.9 |
| pnpm | v10.11.0 |
pnpm install
pnpm buildAfter building these nodes, install the ./dist folder to your Node-RED instance:
cd ~/.node-red
npm install $PACKAGE_PATH/distAjv is much faster than zod for types and data validations.
.
├── client/
│ ├── assets/
│ │ └── image.png
│ ├── components/
│ │ └── node-type-form.ue
│ ├── nodes/
│ │ └── node-type.ts
│ ├── index.ts
│ └── tsconfig.json
├── examples/
│ └── flow.json
├── icons/
│ └── icon.png
├── locales/
│ ├── docs/
│ │ └── node-type/
│ │ ├── en-US.html
│ │ └── pt-BR.md
│ └── labels/
│ └── node-type/
│ ├── en-US.json
│ └── pt-BR.json
├── public/
│ └── image.png
├── schemas/
│ └── node-type.ts
├── server/
│ ├── nodes/
│ │ └── node-type.ts
│ ├── index.ts
│ └── tsconfig.json
├── package.json
└── tsconfig.jsonclassDiagram
class Node {
<<abstract>>
+id: string
+type: string
+name: string
+z: string
+g: string
+configs: TConfigs
+credentials: TCredentials
+constructor(configs: TConfigs)
+static init(): void | Promise<void>
+static getNode<T>(id: string): T | undefined
+error(logMessage: string, msg: any): void
+debug(msg: any): void
+trace(msg: any): void
+log(msg: any): void
+warn(msg: any): void
}
class IONode {
<<abstract>>
+wires: string[][]
+x: number
+y: number
+constructor(configs: TConfigs)
+onInput(msg, send, done): void | Promise<void>
+onClose(removed, done): void | Promise<void>
+close(removed: boolean): Promise<void>
+context(): Context
+emit(event: string, ...args: any[]): void
+on(event: string, callback: (...args: any[]) => void): void
+receive(msg: TInputMessage): void
+removeAllListeners(name: string): void
+removeListener(name: string): void
+send(msg: TOutputMessage): void
+updateWires(wires: string[][]): void
+metric(eventName: string, msg: Message, metricValue: number): boolean | void
+status(status: object | string): void
-setupEventHandlers()
}
class ConfigNode {
<<abstract>>
+users: string[]
+constructor(configs: TConfigs)
}
IONode --|> Node
ConfigNode --|> Node
I welcome contributions! If you'd like to help improve this template, feel free to open issues or submit pull requests. Your feedback is appreciated.
This project is licensed under the MIT License.
If this template has made your life easier, consider supporting its development by clicking the button below.