@bonsae/nrg 0.13.0 → 0.14.0

package/types/test.d.ts

@@ -1,27 +1,392 @@
 // Generated by dts-bundle-generator v9.5.1
 
-export interface MockNodeRedNodeOptions {
-	id?: string;
-	type?: string;
+import { SchemaOptions, Static, TObject, TOptional, TProperties, TSchema, TString } from '@sinclair/typebox';
+import { EventEmitter } from 'events';
+import { Express as Express$1 } from 'express';
+import { Http2ServerRequest } from 'http2';
+
+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 Schema<T extends TProperties = TProperties> = TObject<T>;
+declare const NodeConfigSchema: import("@sinclair/typebox").TObject<{
+	id: import("@sinclair/typebox").TString;
+	type: import("@sinclair/typebox").TString;
+	name: import("@sinclair/typebox").TString;
+	z: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+interface NodeConstructor<T = any, TConfig = any, TCredentials = any> {
+	readonly type: string;
+	readonly category: string;
+	readonly color?: string;
+	readonly align?: "left" | "right";
+	readonly inputs?: number;
+	readonly outputs?: number;
+	readonly configSchema?: Schema;
+	readonly credentialsSchema?: Schema;
+	readonly settingsSchema?: Schema;
+	readonly inputSchema?: Schema;
+	readonly outputsSchema?: Schema | Schema[];
+	readonly validateInput?: boolean;
+	readonly validateOutput?: boolean;
+	readonly name: string;
+	registered?(RED: RED): void | Promise<void>;
+	_registered?(RED: RED): void | Promise<void>;
+	new (RED: RED, node: NodeRedNode, config: NodeConfig<TConfig>, credentials: NodeCredentials<TCredentials>): T;
+}
+type NodeConfig<TConfig = any> = TConfig & Static<typeof NodeConfigSchema>;
+type NodeCredentials<TCredentials = any> = TCredentials;
+interface INode<TConfig = any, TCredentials = any, TSettings = any> {
+	readonly config: NodeConfig<TConfig>;
+	readonly id: string;
+	readonly name: string | undefined;
+	readonly z: string | undefined;
+	readonly credentials: NodeCredentials<TCredentials> | undefined;
+	readonly settings: TSettings;
+	i18n(key: string, substitutions?: Record<string, string>): string;
+	setTimeout(fn: () => void, ms: number): NodeJS.Timeout;
+	setInterval(fn: () => void, ms: number): NodeJS.Timeout;
+	clearTimeout(timer: NodeJS.Timeout): void;
+	clearInterval(interval: NodeJS.Timeout): void;
+	on(event: string, callback: (...args: any[]) => void): void;
+	log(msg: any): void;
+	warn(message: string): void;
+	error(message: string, msg?: any): void;
+	created?(): void | Promise<void>;
+	closed?(removed?: boolean): void | Promise<void>;
+}
+interface NodeRedLog {
+	info(msg: any): void;
+	warn(msg: any): void;
+	error(msg: any, error?: any): void;
+	debug(msg: any): void;
+	trace(msg: any): void;
+	log(msg: {
+		level: number;
+		msg: string;
+	}): void;
+	metric(): boolean;
+	audit(msg: Record<string, any>, req?: any): void;
+	addHandler(handler: (msg: any) => void): void;
+	removeHandler(handler: (msg: any) => void): void;
+	FATAL: 10;
+	ERROR: 20;
+	WARN: 30;
+	INFO: 40;
+	DEBUG: 50;
+	TRACE: 60;
+	AUDIT: 98;
+	METRIC: 99;
+}
+interface NodeRedNode {
+	id: string;
+	type: string;
 	name?: string;
 	z?: string;
-	wires?: string[][];
-	credentials?: Record<string, any>;
+	x: number;
+	y: number;
+	g?: string;
+	wires: string[][];
+	credentials: any;
+	_node?: INode;
+	send(msg: any): void;
+	receive(msg: any): void;
+	status(status: string | {
+		fill?: string;
+		shape?: string;
+		text?: string;
+	}): void;
+	updateWires(wires: string[][]): void;
+	on(event: string, callback: (...args: any[]) => void): void;
+	log(msg: any): void;
+	warn(msg: any): void;
+	error(msg: any, errorMsg?: any): void;
+	context(): NodeRedNodeContext;
 	[key: string]: any;
 }
-export interface CreateNodeOptions {
+interface NodeRedNodeContext extends NodeRedContextStore {
+	flow: NodeRedContextStore;
+	global: NodeRedContextStore;
+}
+interface NodeRedNodes {
+	registerType(type: string, constructor: any, opts?: any): void;
+	getNode(id: string): (NodeRedNode & {
+		_node?: INode;
+	}) | undefined;
+	createNode(node: NodeRedNode, config: Record<string, any>): void;
+	getCredentials(id: string): Record<string, any> | undefined;
+	eachNode(callback: (node: any) => void): void;
+	getType(type: string): any;
+	getNodeInfo(type: string): any;
+	getNodeList(filter?: any): any[];
+	getModuleInfo(module: string): any;
+	installModule(module: string, version?: string): Promise<any>;
+	uninstallModule(module: string): Promise<any>;
+	enableNode(id: string): Promise<any>;
+	disableNode(id: string): Promise<any>;
+}
+interface NodeRedUtil {
+	evaluateNodeProperty(value: any, type: string, node: any, msg: Record<string, any> | undefined, callback: (err: Error | null, result: any) => void): void;
+	generateId(): string;
+	cloneMessage<T = any>(msg: T): T;
+	ensureString(o: any): string;
+	ensureBuffer(o: any): Buffer;
+	compareObjects(obj1: any, obj2: any): boolean;
+	getMessageProperty(msg: any, expr: string): any;
+	setMessageProperty(msg: any, prop: string, value: any, createMissing?: boolean): void;
+	getObjectProperty(obj: any, expr: string): any;
+	setObjectProperty(obj: any, prop: string, value: any, createMissing?: boolean): void;
+	normalisePropertyExpression(str: string, msg?: any, toString?: boolean): string[];
+	normaliseNodeTypeName(name: string): string;
+	prepareJSONataExpression(value: string, node: any): any;
+	evaluateJSONataExpression(expr: any, msg: any, callback: (err: Error | null, result: any) => void): void;
+	parseContextStore(key: string): {
+		store: string | undefined;
+		key: string;
+	};
+	getSetting(node: any, name: string, flow?: any): any;
+	encodeObject(obj: any): any;
+}
+interface NodeRedHooks {
+	add(hookId: string, callback: (event: any) => void | Promise<void>): void;
+	remove(hookId: string): void;
+	trigger(hookId: string, event: any, callback?: (err?: Error) => void): void | Promise<void>;
+	has(hookId: string): boolean;
+	clear(): void;
+}
+type NodeRedExpressApp = Express;
+interface RED {
+	/** Internationalization function */
+	_(key: string, substitutions?: Record<string, string>): string;
+	/** Logging API */
+	log: NodeRedLog;
+	/** Node registry and management */
+	nodes: NodeRedNodes;
+	/** Utility functions */
+	util: NodeRedUtil;
+	/** Hook system for message lifecycle and module events */
+	hooks: NodeRedHooks;
+	/** Runtime event emitter */
+	events: EventEmitter;
+	/** Express app for admin HTTP endpoints */
+	httpAdmin: NodeRedExpressApp;
+	/** Express app for node HTTP endpoints */
+	httpNode: NodeRedExpressApp;
+	/** Runtime settings (user-provided settings plus node-registered settings) */
+	settings: NodeRedRuntimeSettings & Record<string, any>;
+	/** Node-RED version string */
+	version(): string;
+}
+interface NodeRedContextStore {
+	get(key: string, store: string | undefined, callback: (err: Error | null, value: any) => void): void;
+	set(key: string, value: any, store: string | undefined, callback: (err: Error | null) => void): void;
+	keys(store: string | undefined, callback: (err: Error | null, keys: string[]) => void): void;
+}
+interface MockRED extends RED {
+	registerNode(id: string, nodeRedNode: Partial<NodeRedNode>): void;
+	registerNrgNode(id: string, nrgInstance: Partial<INode>): void;
+}
+interface CreateNodeOptions {
 	config?: Record<string, any>;
 	credentials?: Record<string, any>;
 	settings?: Record<string, any>;
-	overrides?: MockNodeRedNodeOptions;
+	overrides?: Partial<NodeRedNode>;
 }
-export type ExtractInput<T> = T extends {
+type ExtractInput<T> = T extends {
 	input(msg: infer I): any;
 } ? I : any;
-export type ExtractOutput<T> = T extends {
+type ExtractOutput<T> = T extends {
 	send(msg: infer O): any;
 } ? O : any;
-export interface TestNodeHelpers<TInput = any, TOutput = any> {
+interface TestNodeHelpers<TInput = any, TOutput = any> {
 	receive(msg: TInput): Promise<void>;
 	close(removed?: boolean): Promise<void>;
 	reset(): void;
@@ -32,18 +397,23 @@ export interface TestNodeHelpers<TInput = any, TOutput = any> {
 	warned(): string[];
 	errored(): string[];
 }
-export interface CreateNodeResult<T> {
+interface CreateNodeResult<T> {
 	node: T & TestNodeHelpers<ExtractInput<T>, ExtractOutput<T>>;
-	RED: any;
-}
-export interface NodeClass {
-	readonly type: string;
-	readonly category?: string;
-	readonly configSchema?: any;
-	registered?(RED: any): void | Promise<void>;
-	_registered?(RED: any): void | Promise<void>;
-	new (...args: any[]): any;
+	RED: MockRED;
 }
-export declare function createNode<T extends NodeClass>(NodeClass: T, options?: CreateNodeOptions): Promise<CreateNodeResult<InstanceType<T>>>;
+/**
+ * Creates a node instance for testing, with helpers for sending messages,
+ * inspecting output, and checking status/log calls.
+ *
+ * @example
+ * ```ts
+ * const { node } = await createNode(MyNode, {
+ *   config: { name: "test" },
+ * });
+ * await node.receive({ payload: "hello" });
+ * expect(node.sent(0)).toEqual([{ payload: "HELLO" }]);
+ * ```
+ */
+export declare function createNode<T extends NodeConstructor>(NodeClass: T, options?: CreateNodeOptions): Promise<CreateNodeResult<InstanceType<T>>>;
 
 export {};

package/types/vite.d.ts

@@ -1,12 +1,169 @@
+// Generated by dts-bundle-generator v9.5.1
 
-import type { Plugin } from "vite";
-
+export interface BuildContext {
+	outDir: string;
+	packageName: string;
+	isDev: boolean;
+}
+export interface BuildPluginOptions {
+	serverBuildOptions: ServerBuildOptions;
+	clientBuildOptions: ClientBuildOptions;
+	extraFilesCopyTargets: CopyTarget[];
+	buildContext: BuildContext;
+}
+export interface ClientBuildOptions {
+	/** Source directory for client code. @default "./src/client" */
+	srcDir?: string;
+	/** Entry filename relative to srcDir. @default "index.ts" */
+	entry?: string;
+	/** Subdirectory name for node definition files. @default "nodes" */
+	nodesSubdir?: string;
+	/** Pattern to match node definition files. */
+	nodeFilePattern?: RegExp;
+	/** Global variable name for the UMD/IIFE bundle. @default "NodeRedNodes" */
+	name?: string;
+	/** Output format for the client bundle. @default "es" */
+	format?: "es" | "iife" | "umd";
+	/** Base public path for serving resources. */
+	base?: string;
+	/** Path to LICENSE file to include in the HTML output. @default "./LICENSE" */
+	licensePath?: string;
+	/** Internationalization options for labels and docs. */
+	locales?: LocalesOptions;
+	/** Directories for static assets (icons, public files). */
+	staticDirs?: {
+		/** Directory containing node icons ({type}.png). @default "./src/icons" */
+		icons?: string;
+		/** Directory for public static files copied to dist/resources/. @default "./src/client/public" */
+		public?: string;
+	};
+	/** Modules to treat as external (not bundled). @default ["jquery", "node-red", "vue", "@bonsae/nrg/client"] */
+	external?: string[];
+	/** Global variable mappings for external modules. */
+	globals?: Record<string, string>;
+	/** Custom chunk splitting function for Rollup. */
+	manualChunks?: (id: string) => string | undefined;
+}
+export interface CopyTarget {
+	/** Source file or directory path. */
+	src: string;
+	/** Destination path relative to the output directory. */
+	dest: string;
+}
+export interface LocalesOptions {
+	/** Directory containing documentation files ({type}/{lang}.md or .html). @default "./src/locales/docs" */
+	docsDir?: string;
+	/** Directory containing label files ({type}/{lang}.json). @default "./src/locales/labels" */
+	labelsDir?: string;
+}
+export interface LoggerOptions {
+	name: string;
+	prefix?: string;
+}
+export interface NodeRedLauncherOptions {
+	runtime?: {
+		/** Port for Node-RED to listen on. @default 1880 */
+		port?: number;
+		/** Path to the Node-RED settings file (TypeScript supported). @default "./node-red.settings.ts" */
+		settingsFilepath?: string;
+		/** Node-RED version to install for the dev server. @default "latest" */
+		version?: string;
+	};
+	/** Delay in ms before restarting Node-RED after a file change. @default 1000 */
+	restartDelay?: number;
+	/** Additional CLI arguments passed to the Node-RED process. */
+	args?: string[];
+}
+/**
+ * Options for the `nodeRed()` Vite plugin.
+ *
+ * All options are optional — defaults work for the standard `src/` directory layout.
+ */
 export interface NodeRedPluginOptions {
-  outDir?: string;
-  serverBuildOptions?: Record<string, any>;
-  clientBuildOptions?: Record<string, any>;
-  nodeRedLauncherOptions?: Record<string, any>;
-  extraFilesCopyTargets?: Array<{ src: string; dest: string }>;
+	/** Output directory for the built Node-RED package. @default "./dist" */
+	outDir?: string;
+	/** Options for building the client-side editor UI. */
+	clientBuildOptions?: ClientBuildOptions;
+	/** Options for building the server-side node runtime. */
+	serverBuildOptions?: ServerBuildOptions;
+	/** Options for the Node-RED dev server launcher. */
+	nodeRedLauncherOptions?: NodeRedLauncherOptions;
+	/** Extra files to copy into the output directory (e.g., LICENSE, README). */
+	extraFilesCopyTargets?: CopyTarget[];
+}
+export interface PackageJson {
+	name: string;
+	version: string;
+	description?: string;
+	type?: "commonjs" | "module";
+	main?: string;
+	types?: string;
+	exports?: Record<string, unknown>;
+	scripts?: Record<string, string>;
+	dependencies?: Record<string, string>;
+	devDependencies?: Record<string, string>;
+	peerDependencies?: Record<string, string>;
+	optionalDependencies?: Record<string, string>;
+	keywords?: string[];
+	author?: string | {
+		name: string;
+		email?: string;
+		url?: string;
+	};
+	license?: string;
+	repository?: string | {
+		type: string;
+		url: string;
+	};
+	bugs?: string | {
+		url: string;
+		email?: string;
+	};
+	homepage?: string;
+	engines?: Record<string, string>;
+	files?: string[];
+	private?: boolean;
+	publishConfig?: Record<string, unknown>;
+	"node-red"?: {
+		nodes?: Record<string, string>;
+		version?: string;
+	};
+	[key: string]: unknown;
+}
+export interface ServerBuildOptions {
+	/** Source directory for server code. @default "./src/server" */
+	srcDir?: string;
+	/** Entry filename relative to srcDir. @default "index.ts" */
+	entry?: string;
+	/** Output format. "esm" builds to .mjs with a CJS bridge for Node-RED. @default "esm" */
+	format?: "cjs" | "esm";
+	/** Packages to keep as external (not bundled). @default [] */
+	external?: string[];
+	/** Dependencies to bundle into the output instead of keeping as external. @default [] */
+	bundled?: string[];
+	/** Generate rolled-up .d.ts type declarations (production only). @default true */
+	types?: boolean;
+	/** esbuild target for the server bundle. @default "node22" */
+	nodeTarget?: string;
+}
+export interface NodeRedLauncher {
+	start(): Promise<number>;
+	stop(skipPortUsageCheck?: boolean): Promise<void>;
+	cleanup(): void;
+	flushLogs(): void;
+	readonly preferredPort: number;
+	readonly restartDelay: number;
+	readonly pid: number | null;
 }
+export interface ServerPluginOptions {
+	nodeRedLauncher: NodeRedLauncher;
+	serverBuildOptions: ServerBuildOptions;
+	clientBuildOptions: ClientBuildOptions;
+	extraFilesCopyTargets: CopyTarget[];
+	buildContext: BuildContext;
+}
+
+export {};
 
+import type { Plugin } from "vite";
 export declare function nodeRed(options?: NodeRedPluginOptions): Plugin[];