@bonsae/nrg 0.6.1 → 0.6.3

package/README.md

@@ -14,7 +14,7 @@ Build Node-RED nodes with Vue 3, TypeScript, and JSON Schema validation.
 ## Install
 
 ```bash
-pnpm add @bonsae/nrg @sinclair/typebox vue
+pnpm add @bonsae/nrg vue
 pnpm add -D vite
 ```
 
@@ -22,9 +22,9 @@ pnpm add -D vite
 
 | Export | Description |
 | --- | --- |
-| `@bonsae/nrg/server` | Server node classes (`Node`, `IONode`, `ConfigNode`), schema utilities, validation |
-| `@bonsae/nrg/client` | Vue 3 form components, client-side registration |
-| `@bonsae/nrg/schemas` | TypeBox schema types (`Schema`, `Infer`, `SchemaType`) |
+| `@bonsae/nrg` | Root entry — `defineRuntimeSettings` |
+| `@bonsae/nrg/server` | Server node classes, schema utilities, validation (`IONode`, `ConfigNode`, `defineIONode`, `defineConfigNode`, `defineModule`, `SchemaType`, `defineSchema`, `Infer`) |
+| `@bonsae/nrg/client` | Client-side registration (`registerTypes`, `defineNode`) |
 | `@bonsae/nrg/vite` | Vite plugin for building and developing Node-RED packages |
 | `@bonsae/nrg/tsconfig/*` | Shared TypeScript configurations for consumers |
 
@@ -32,7 +32,7 @@ pnpm add -D vite
 
 ```bash
 # In your Node-RED package project
-pnpm add @bonsae/nrg @sinclair/typebox vue
+pnpm add @bonsae/nrg vue
 pnpm add -D vite
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bonsae/nrg",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "NRG framework — build Node-RED nodes with Vue 3, TypeScript, and JSON Schema",
   "author": "Allan Oricil <allanoricil@duck.com>",
   "license": "MIT",
@@ -16,56 +16,28 @@
     "node": ">=22",
     "pnpm": ">=10.11.0"
   },
-  "scripts": {
-    "test": "vitest run && vitest run --config vitest.e2e.config.ts",
-    "test:unit": "vitest run",
-    "test:unit:watch": "vitest",
-    "test:e2e": "vitest run --config vitest.e2e.config.ts",
-    "build": "node build.mjs",
-    "typecheck": "tsc -p src/core/server/tsconfig.json --noEmit && tsc -p src/core/client/tsconfig.json --noEmit",
-    "lint": "eslint src/",
-    "lint:fix": "eslint src/ --fix",
-    "format": "prettier --write \"src/**/*.{ts,vue,json}\"",
-    "format:check": "prettier --check \"src/**/*.{ts,vue,json}\"",
-    "docs:dev": "pnpm --dir docs dev",
-    "docs:build": "pnpm --dir docs build",
-    "docs:preview": "pnpm --dir docs preview",
-    "prepare": "husky"
-  },
-  "files": [
-    "src/",
-    "build/"
-  ],
   "exports": {
     ".": {
-      "types": "./src/index.ts",
-      "default": "./build/index.js"
+      "types": "./types/index.d.ts",
+      "default": "./index.js"
     },
     "./server": {
-      "types": "./src/core/server/index.ts",
-      "require": "./build/server/index.cjs",
-      "default": "./build/server/index.cjs"
+      "types": "./types/server.d.ts",
+      "require": "./server/index.cjs",
+      "default": "./server/index.cjs"
     },
-    "./server/nodes": {
-      "types": "./src/core/server/nodes/index.ts"
+    "./client": {
+      "types": "./types/client.d.ts"
     },
-    "./client": "./src/core/client/index.ts",
-    "./schemas": "./src/core/server/schemas/index.ts",
-    "./schemas/types": "./src/core/server/schemas/types/index.ts",
     "./vite": {
-      "types": "./src/vite/index.ts",
-      "default": "./build/vite/index.js"
-    },
-    "./vite/utils": {
-      "types": "./src/vite/utils.ts",
-      "default": "./build/vite/utils.js"
+      "types": "./types/vite.d.ts",
+      "default": "./vite/index.js"
     },
-    "./tsconfig/base.json": "./src/tsconfig/base.json",
-    "./tsconfig/client.json": "./src/tsconfig/client.json",
-    "./tsconfig/server.json": "./src/tsconfig/server.json"
+    "./tsconfig/base.json": "./tsconfig/base.json",
+    "./tsconfig/client.json": "./tsconfig/client.json",
+    "./tsconfig/server.json": "./tsconfig/server.json"
   },
   "peerDependencies": {
-    "@sinclair/typebox": "^0.34.33",
     "vite": "^6.0.0",
     "vue": "^3.5.14"
   },
@@ -87,41 +59,5 @@
     "typescript": "^5.8.3",
     "vite-plugin-dts": "^4.5.4",
     "vite-plugin-static-copy": "^3.1.0"
-  },
-  "lint-staged": {
-    "src/**/*.{ts,vue}": [
-      "eslint --fix",
-      "prettier --write"
-    ],
-    "src/**/*.json": [
-      "prettier --write"
-    ]
-  },
-  "devDependencies": {
-    "@commitlint/cli": "^20.5.0",
-    "@commitlint/config-conventional": "^20.5.0",
-    "@eslint/js": "^9.27.0",
-    "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/exec": "^7.1.0",
-    "@semantic-release/git": "^10.0.1",
-    "@types/express": "^5.0.1",
-    "@types/jquery": "^4.0.0",
-    "@types/mime-types": "^2.1.4",
-    "@types/node": "^22.15.18",
-    "@typescript-eslint/eslint-plugin": "^8.32.1",
-    "@typescript-eslint/parser": "^8.32.1",
-    "@vitest/coverage-v8": "^4.1.5",
-    "eslint": "^9.27.0",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-vue": "^10.1.0",
-    "globals": "^16.1.0",
-    "husky": "^9.1.7",
-    "lint-staged": "^16.4.0",
-    "prettier": "^3.5.3",
-    "semantic-release": "^24.2.4",
-    "typescript-eslint": "^8.32.1",
-    "vite": "^6.3.4",
-    "vitest": "^4.1.5",
-    "vue": "^3.5.14"
   }
 }

package/{src/core/client → shims}/components.d.ts

@@ -13,6 +13,8 @@ declare module "vue" {
     NodeRedConfigInput: (typeof import("./components/node-red-config-input.vue"))["default"];
     NodeRedSelectInput: (typeof import("./components/node-red-select-input.vue"))["default"];
     NodeRedEditorInput: (typeof import("./components/node-red-editor-input.vue"))["default"];
+    NodeRedInputLabel: (typeof import("./components/node-red-input-label.vue"))["default"];
+    NodeRedToggle: (typeof import("./components/node-red-toggle.vue"))["default"];
     NodeRedJsonSchemaForm: (typeof import("./components/node-red-json-schema-form.vue"))["default"];
   }
 }

package/{src/tsconfig → tsconfig}/client.json

@@ -4,8 +4,8 @@
     "lib": ["ES2022", "DOM", "DOM.Iterable"]
   },
   "files": [
-    "../core/client/shims-vue.d.ts",
-    "../core/client/components.d.ts",
-    "../core/client/globals.d.ts"
+    "../shims/shims-vue.d.ts",
+    "../shims/components.d.ts",
+    "../shims/globals.d.ts"
   ]
 }

package/types/client.d.ts

@@ -0,0 +1,37 @@
+
+import type { Component } from "vue";
+
+export interface NodeButtonDefinition {
+  toggle: string;
+  onclick: () => void;
+  enabled?: () => boolean;
+  visible?: () => boolean;
+}
+
+export interface NodeFormDefinition {
+  component?: Component;
+}
+
+export interface NodeDefinition {
+  type: string;
+  category?: string;
+  color?: string;
+  icon?: ((this: any) => string) | string;
+  label?: ((this: any) => string) | string;
+  inputs?: number;
+  outputs?: number;
+  paletteLabel?: ((this: any) => string) | string;
+  labelStyle?: ((this: any) => string) | string;
+  inputLabels?: ((this: any) => string) | string;
+  outputLabels?: ((this: any) => string) | string;
+  align?: "left" | "right";
+  button?: NodeButtonDefinition;
+  onEditResize?: (this: any, size: { width: number; height: number }) => void;
+  onPaletteAdd?: (this: any) => void;
+  onPaletteRemove?: (this: any) => void;
+  form?: NodeFormDefinition;
+}
+
+export declare function defineNode<T extends NodeDefinition>(options: T): T;
+export declare function registerType(definition: NodeDefinition): Promise<void>;
+export declare function registerTypes(nodes: NodeDefinition[]): Promise<void>;

package/types/index.d.ts

@@ -0,0 +1,211 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import { Http2ServerRequest } from 'http2';
+
+export interface NodeRedRuntimeSettings {
+	userDir?: string;
+	nodesDir?: string | string[];
+	flowFile?: string;
+	flowFilePretty?: boolean;
+	credentialSecret?: string | false;
+	requireHttps?: boolean;
+	https?: {
+		key: string;
+		cert: string;
+	} | (() => Promise<{
+		key: string;
+		cert: string;
+	}> | {
+		key: string;
+		cert: string;
+	});
+	httpsRefreshInterval?: number;
+	httpAdminRoot?: string;
+	httpNodeRoot?: string;
+	httpNodeCors?: {
+		origin: string;
+		methods: string;
+	};
+	httpStatic?: string | {
+		path: string;
+		root: string;
+	}[];
+	httpStaticRoot?: string;
+	httpAdminMiddleware?: (req: unknown, res: unknown, next: () => void) => void;
+	httpNodeMiddleware?: (req: unknown, res: unknown, next: () => void) => void;
+	httpServerOptions?: Record<string, unknown>;
+	adminAuth?: {
+		type?: "credentials" | "strategy";
+		users?: {
+			username: string;
+			password: string;
+			permissions?: string | string[];
+		}[];
+		default?: {
+			permissions?: string | string[];
+		};
+		tokens?: (token: string) => Promise<{
+			user: string;
+			permissions: string | string[];
+		} | null>;
+		tokenHeader: "string";
+		sessionExpiryTime?: number;
+		[key: string]: unknown;
+	};
+	httpNodeAuth?: {
+		user?: string;
+		pass?: string;
+	};
+	httpStaticAuth?: {
+		user?: string;
+		pass?: string;
+	};
+	lang?: "en-US" | "de" | "es-ES" | "fr" | "ko" | "pt-BR" | "ru" | "ja" | "zh-CN" | "zh-TW";
+	diagnostics?: {
+		enabled?: boolean;
+		ui?: boolean;
+	};
+	runtimeState?: {
+		enabled?: boolean;
+		ui?: boolean;
+	};
+	disableEditor?: boolean;
+	editorTheme?: {
+		page?: {
+			title?: string;
+			favicon?: string;
+			css?: string | string[];
+			scripts?: string | string[];
+		};
+		header?: {
+			title?: string;
+			image?: string;
+			url?: string;
+		};
+		deployButton?: {
+			type?: "simple" | "default";
+			label?: string;
+			icon?: string;
+		};
+		menu?: {
+			"menu-item-import-library"?: boolean;
+			"menu-item-export-library"?: boolean;
+			"menu-item-keyboard-shortcuts"?: boolean;
+			"menu-item-help"?: {
+				label?: string;
+				url?: string;
+			};
+			[menuItem: string]: boolean | {
+				label?: string;
+				url?: string;
+			} | undefined;
+		};
+		userMenu?: boolean;
+		login?: {
+			image?: string;
+		};
+		logout?: {
+			redirect?: string;
+		};
+		palette?: {
+			catalogues?: string[];
+			categories?: string[];
+			theme?: {
+				category: string;
+				type: string;
+				color: string;
+			}[];
+		};
+		projects?: {
+			enabled?: boolean;
+			workflow?: {
+				mode: "manual" | "auto";
+			};
+		};
+		codeEditor?: {
+			lib?: "monaco" | "ace";
+			options?: Record<string, unknown>;
+		};
+		mermaid?: {
+			theme?: string;
+		};
+		tours?: boolean;
+		theme?: string;
+		[key: string]: unknown;
+	};
+	contextStorage?: {
+		default?: {
+			module?: "memory" | "localfilesystem" | object;
+			config?: Record<string, unknown>;
+		};
+		[store: string]: {
+			module?: "memory" | "localfilesystem" | object;
+			config?: Record<string, unknown>;
+		} | undefined;
+	};
+	exportGlobalContextKeys?: boolean;
+	logging?: {
+		console?: {
+			level?: "fatal" | "error" | "warn" | "info" | "debug" | "trace" | "off";
+			metrics?: boolean;
+			audit?: boolean;
+		};
+	};
+	fileWorkingDirectory?: string;
+	functionExternalModules?: boolean;
+	functionGlobalContext?: Record<string, unknown>;
+	nodeMessageBufferMaxLength?: number;
+	functionTimeout?: number;
+	externalModules?: {
+		autoInstall?: boolean;
+		autoInstallRetry?: number;
+		palette?: {
+			allowInstall?: boolean;
+			allowUpdate?: boolean;
+			allowUpload?: boolean;
+			allowList?: string[];
+			denyList?: string[];
+			allowUpdateList?: string[];
+			denyUpdateList?: string[];
+		};
+		modules?: {
+			allowInstall?: boolean;
+			allowList?: string[];
+			denyList?: string[];
+		};
+	};
+	execMaxBufferSize?: number;
+	debugMaxLength?: number;
+	debugUseColors?: boolean;
+	httpRequestTimeout?: number;
+	mqttReconnectTime?: number;
+	serialReconnectTime?: number;
+	socketReconnectTime?: number;
+	socketTimeout?: number;
+	tcpMsgQueueSize?: number;
+	inboundWebSocketTimeout?: number;
+	tlsConfigDisableLocalFiles?: boolean;
+	webSocketNodeVerifyClient?: (info: {
+		origin: string;
+		req: Http2ServerRequest;
+		secure: boolean;
+	}) => boolean;
+	apiMaxLength?: string;
+	[key: string]: unknown;
+}
+/**
+ * Type-safe helper for defining Node-RED runtime settings.
+ *
+ * @example
+ * ```typescript
+ * import { defineRuntimeSettings } from "@bonsae/nrg";
+ *
+ * export default defineRuntimeSettings({
+ *   flowFile: "flows.json",
+ *   flowFilePretty: true,
+ * });
+ * ```
+ */
+export declare function defineRuntimeSettings(settings: NodeRedRuntimeSettings): NodeRedRuntimeSettings;
+
+export {};