@bonsae/nrg 0.16.0 → 0.18.0

package/types/shims/form/components/node-red-typed-input.vue.d.ts

@@ -1,11 +1,25 @@
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    modelValue: {
+        type: PropType<{
+            value: string;
+            type: string;
+        } | undefined>;
+        default: undefined;
+        validator: (obj: {
+            value: string;
+            type: string;
+        } | undefined) => boolean;
+    };
     value: {
-        type: ObjectConstructor;
-        required: true;
+        type: PropType<{
+            value: string;
+            type: string;
+        } | undefined>;
+        default: undefined;
         validator: (obj: {
             value: string;
             type: string;
-        }) => boolean;
+        } | undefined) => boolean;
     };
     types: {
         type: PropType<(NodeRED.DefaultTypedInputType | NodeRED.TypedInputTypeDefinition)[]>;
@@ -27,18 +41,39 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: StringConstructor;
         default: string;
     };
-}>, {}, {}, {
+}>, {
+    inputWidget: import("vue").ShallowRef<any, any>;
+    mutationObserver: import("vue").ShallowRef<MutationObserver | null, MutationObserver | null>;
+}, {}, {
+    effectiveValue(): {
+        value: string;
+        type: string;
+    };
     isProvidedValueTypeValid(): boolean;
 }, {
     onChange(): void;
-}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:value"[], "update:value", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "update:value")[], "update:modelValue" | "update:value", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    modelValue: {
+        type: PropType<{
+            value: string;
+            type: string;
+        } | undefined>;
+        default: undefined;
+        validator: (obj: {
+            value: string;
+            type: string;
+        } | undefined) => boolean;
+    };
     value: {
-        type: ObjectConstructor;
-        required: true;
+        type: PropType<{
+            value: string;
+            type: string;
+        } | undefined>;
+        default: undefined;
         validator: (obj: {
             value: string;
             type: string;
-        }) => boolean;
+        } | undefined) => boolean;
     };
     types: {
         type: PropType<(NodeRED.DefaultTypedInputType | NodeRED.TypedInputTypeDefinition)[]>;
@@ -61,11 +96,20 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         default: string;
     };
 }>> & Readonly<{
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
     "onUpdate:value"?: ((...args: any[]) => any) | undefined;
 }>, {
     label: string;
     icon: string;
     required: boolean;
+    modelValue: {
+        value: string;
+        type: string;
+    } | undefined;
+    value: {
+        value: string;
+        type: string;
+    } | undefined;
     error: string;
     types: ("msg" | "flow" | "global" | "str" | "num" | "bool" | "json" | "bin" | "re" | "jsonata" | "date" | "env" | "node" | "cred" | NodeRED.TypedInputTypeDefinition)[];
 }, {}, {

package/types/test-client-component.d.ts

@@ -0,0 +1,70 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export interface MockEditor {
+	getValue(): string;
+	setValue(val: string): void;
+	getSession(): {
+		on(event: string, cb: (...args: any[]) => any): void;
+	};
+	focus(): void;
+	destroy(): void;
+	saveView(): void;
+	restoreView(): void;
+}
+export interface MockRED {
+	_(key: string): string;
+	editor: {
+		createEditor(options: any): MockEditor;
+		prepareConfigNodeSelect(...args: any[]): void;
+		validateNode(...args: any[]): boolean;
+	};
+	tray: {
+		show(...args: any[]): void;
+		close(): void;
+	};
+	popover: {
+		tooltip(...args: any[]): {
+			delete(): void;
+			setAction(...args: any[]): void;
+		};
+	};
+	nodes: {
+		registerType(...args: any[]): void;
+		node(...args: any[]): null;
+		dirty(...args: any[]): boolean;
+	};
+	events: {
+		on(...args: any[]): void;
+		off(...args: any[]): void;
+		emit(...args: any[]): void;
+	};
+	settings: Record<string, any>;
+	notify(...args: any[]): void;
+}
+export declare function createRED(): MockRED;
+export declare function createJQuery(): (selector: any, attrs?: Record<string, any>) => any;
+export declare const defaultConfig: {
+	testTimeout: number;
+	setupFiles: string[];
+	browser: {
+		enabled: boolean;
+		instances: {
+			browser: string;
+		}[];
+	};
+};
+export interface TestNode {
+	id: string;
+	type: string;
+	changed: boolean;
+	_def: Record<string, any>;
+	_: (key: string) => string;
+	[key: string]: any;
+}
+interface CreateNodeResult {
+	node: TestNode;
+	RED: MockRED;
+}
+export declare function createNode(overrides?: Record<string, any>): CreateNodeResult;
+
+export {};

package/types/test-client-e2e.d.ts

@@ -0,0 +1,152 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import { Locator, Page } from 'playwright';
+
+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;
+}
+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;
+}
+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 NodeRedTestEnvironmentOptions {
+	projectDir?: string;
+	packageName: string;
+	clientName?: string;
+	port?: number;
+	settingsFile?: string;
+	server?: Partial<ServerBuildOptions>;
+	client?: Partial<ClientBuildOptions>;
+}
+export declare class NodeRedTestEnvironment {
+	private port;
+	private launcher;
+	private originalCwd;
+	private readonly projectDir;
+	private readonly outDir;
+	private readonly nodeRedDir;
+	private readonly installedPkgDir;
+	private readonly options;
+	constructor(options: NodeRedTestEnvironmentOptions);
+	get nodeRedPort(): number | null;
+	setup(): Promise<number>;
+	deployFlow(flow: Record<string, unknown>[]): Promise<void>;
+	teardown(): Promise<void>;
+}
+export interface SetupOptions {
+	settingsFile?: string;
+	flow?: Record<string, unknown>[];
+}
+export declare const defaultConfig: {
+	testTimeout: number;
+	hookTimeout: number;
+	globalSetup: string[];
+};
+export declare function setup(options?: SetupOptions): Promise<void>;
+export declare function teardown(): Promise<void>;
+export declare class NodeRedEditor {
+	readonly page: Page;
+	readonly port: number;
+	readonly errors: string[];
+	private screenshotDir;
+	constructor(page: Page, port: number, options?: {
+		screenshotDir?: string;
+	});
+	screenshot(name: string): Promise<string>;
+	open(): Promise<void>;
+	deployFlow(flow: Record<string, unknown>[]): Promise<void>;
+	editNode(nodeId: string): Promise<void>;
+	clickDone(): Promise<void>;
+	clickCancel(): Promise<void>;
+	field(label: string): NodeRedField;
+	expectNoPageErrors(): void;
+	get tray(): Locator;
+}
+export declare class NodeRedField {
+	private readonly page;
+	readonly label: string;
+	readonly row: Locator;
+	constructor(page: Page, label: string);
+	get input(): Locator;
+	fill(value: string): Promise<void>;
+	clear(): Promise<void>;
+	getValue(): Promise<string>;
+	getInputType(): Promise<string | null>;
+	get toggleSlider(): Locator;
+	toggle(): Promise<void>;
+	get checkbox(): Locator;
+	get typedInputContainer(): Locator;
+	getSelectedType(): Promise<string>;
+	getSelectedValue(): Promise<string>;
+	openTypeMenu(): Promise<Locator>;
+	getTypeMenuValues(): Promise<string[]>;
+	selectType(type: string): Promise<void>;
+	openOptionMenu(): Promise<Locator>;
+	getOptionMenuLabels(): Promise<string[]>;
+	get select(): Locator;
+	get editButton(): Locator;
+	get addButton(): Locator;
+	getSelectedOption(): Promise<string>;
+	getSelectedOptionLabel(): Promise<string>;
+	getOptions(): Promise<string[]>;
+	get editorWrapper(): Locator;
+	get expandButton(): Locator;
+	get textarea(): Locator;
+	get requiredIndicator(): Locator;
+	get errorMessage(): Locator;
+	expectError(containing?: string): Promise<void>;
+	expectNoError(): Promise<void>;
+	scrollIntoView(): Promise<void>;
+	expectVisible(): Promise<void>;
+	expectHidden(): Promise<void>;
+}
+
+export {};

package/types/test-client-unit.d.ts

@@ -0,0 +1,52 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export interface MockEditor {
+	getValue(): string;
+	setValue(val: string): void;
+	getSession(): {
+		on(event: string, cb: (...args: any[]) => any): void;
+	};
+	focus(): void;
+	destroy(): void;
+	saveView(): void;
+	restoreView(): void;
+}
+export interface MockRED {
+	_(key: string): string;
+	editor: {
+		createEditor(options: any): MockEditor;
+		prepareConfigNodeSelect(...args: any[]): void;
+		validateNode(...args: any[]): boolean;
+	};
+	tray: {
+		show(...args: any[]): void;
+		close(): void;
+	};
+	popover: {
+		tooltip(...args: any[]): {
+			delete(): void;
+			setAction(...args: any[]): void;
+		};
+	};
+	nodes: {
+		registerType(...args: any[]): void;
+		node(...args: any[]): null;
+		dirty(...args: any[]): boolean;
+	};
+	events: {
+		on(...args: any[]): void;
+		off(...args: any[]): void;
+		emit(...args: any[]): void;
+	};
+	settings: Record<string, any>;
+	notify(...args: any[]): void;
+}
+export declare function createRED(): MockRED;
+export declare function createJQuery(): (selector: any, attrs?: Record<string, any>) => any;
+export declare const defaultConfig: {
+	testTimeout: number;
+	environment: "happy-dom";
+	setupFiles: string[];
+};
+
+export {};

package/types/{test.d.ts → test-server-unit.d.ts}

@@ -196,13 +196,13 @@ interface NodeRedRuntimeSettings {
 	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>;
 }>;
+type Schema<T extends TProperties = TProperties> = TObject<T>;
 interface NodeConstructor<T = any, TConfig = any, TCredentials = any> {
 	readonly type: string;
 	readonly category: string;
@@ -371,10 +371,13 @@ interface NodeRedContextStore {
 	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 {
+export interface MockRED extends RED {
 	registerNode(id: string, nodeRedNode: Partial<NodeRedNode>): void;
 	registerNrgNode(id: string, nrgInstance: Partial<INode>): void;
 }
+export declare function createRED(options?: {
+	settings?: Record<string, any>;
+}): MockRED;
 interface CreateNodeOptions {
 	config?: Record<string, any>;
 	credentials?: Record<string, any>;
@@ -387,11 +390,18 @@ type ExtractInput<T> = T extends {
 type ExtractOutput<T> = T extends {
 	send(msg: infer O): any;
 } ? O : any;
+type PortNames<T> = [
+	T
+] extends [
+	Record<string, Record<string, any>>
+] ? string extends keyof T ? never : keyof T & string : never;
+type PortMessage<T, P extends string> = T extends Record<string, any> ? (P extends keyof T ? T[P] : never) : never;
 interface TestNodeHelpers<TInput = any, TOutput = any> {
 	receive(msg: TInput): Promise<void>;
 	close(removed?: boolean): Promise<void>;
 	reset(): void;
 	sent(): TOutput[];
+	sent<P extends PortNames<TOutput>>(port: P): PortMessage<TOutput, P>[];
 	sent(port: number): any[];
 	statuses(): any[];
 	logged(level?: "info" | "warn" | "error" | "debug"): string[];

package/vite/index.js

@@ -77,8 +77,12 @@ function copyFiles(targets, outDir) {
 function getPackageName() {
   const pkgPath = path.resolve("./package.json");
   if (fs.existsSync(pkgPath)) {
-    const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
-    return pkg.name;
+    try {
+      const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+      return pkg.name;
+    } catch {
+      return "node-red-nodes";
+    }
   }
   return "node-red-nodes";
 }
@@ -1220,7 +1224,8 @@ async function build(serverOpts, buildContext) {
     esbuild: {
       platform: "node",
       target: nodeTarget,
-      keepNames: true
+      keepNames: true,
+      tsconfigRaw: "{}"
     }
   };
   try {
@@ -2374,7 +2379,7 @@ async function build2(clientBuildOptions, buildContext) {
   const config = {
     configFile: false,
     logLevel: "warn",
-    base: `/${path11.join("resources", buildContext.packageName)}`,
+    base: `/resources/${buildContext.packageName}`,
     publicDir: path11.resolve(srcDir, "public"),
     resolve: {
       alias: {
@@ -2382,6 +2387,9 @@ async function build2(clientBuildOptions, buildContext) {
       }
     },
     plugins,
+    esbuild: {
+      tsconfigRaw: "{}"
+    },
     css: {
       devSourcemap: buildContext.isDev
     },
@@ -2401,9 +2409,9 @@ async function build2(clientBuildOptions, buildContext) {
         external,
         treeshake: false,
         output: {
-          entryFileNames: path11.join("resources", "index.[hash].js"),
-          chunkFileNames: path11.join("resources", "vendor.[hash].js"),
-          assetFileNames: path11.join("resources", "[name].[hash].[ext]"),
+          entryFileNames: "resources/index.[hash].js",
+          chunkFileNames: "resources/vendor.[hash].js",
+          assetFileNames: "resources/[name].[hash].[ext]",
           globals,
           paths: {
             vue: "/nrg/assets/vue.esm-browser.prod.js",

package/tsconfig/client.json

@@ -1,11 +0,0 @@
-{
-  "extends": "./base.json",
-  "compilerOptions": {
-    "lib": ["ES2022", "DOM", "DOM.Iterable"]
-  },
-  "files": [
-    "../types/shims/shims-vue.d.ts",
-    "../types/shims/components.d.ts",
-    "../types/shims/globals.d.ts"
-  ]
-}