@bonsae/nrg 0.21.2 → 0.22.1

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

@@ -1,125 +1,13 @@
 // Generated by dts-bundle-generator v9.5.1
 
-import { Static, TSchema } from '@sinclair/typebox';
-import { SchemaObject } from 'ajv';
-import { App } from 'vue';
+import { TSchema } from '@sinclair/typebox';
 
-interface NodeRefResolved<T = any> {
-	readonly __nrg_node_ref: true;
-	readonly __instance: T;
-}
-interface TypedInputResolved {
-	resolve(...args: any[]): any;
-	value: unknown;
-	type: string;
-}
-interface JsonSchemaObjectExtensions {
-	format?: "node-id" | "flow-id" | "topic-path" | (string & {});
-	/** expose this settings property to the editor via RED.settings */
-	exportable?: boolean;
-	/** set by SchemaType.NodeRef — the referenced config node type */
-	"x-nrg-node-type"?: string;
-	/** set by SchemaType.TypedInput — marks a TypedInput value/type pair */
-	"x-nrg-typed-input"?: boolean;
-	/** set by markNonValidatable — ajv skips this property */
-	"x-nrg-skip-validation"?: boolean;
-	/** form rendering hints consumed by the auto-generated editor form */
-	"x-nrg-form"?: {
-		icon?: string;
-		typedInputTypes?: string[];
-		editorLanguage?: string;
-		toggle?: boolean;
-	};
-}
-interface NodeRedNodeButtonDefinition {
-	toggle: string;
-	onclick: () => void;
-	enabled?: () => boolean;
-	visible?: () => boolean;
-}
-interface NodeRedNode {
-	id: string;
-	type: string;
-	name: string;
-	category: string;
-	x: string;
-	y: string;
-	g: string;
-	z: string;
-	credentials: Record<string, any>;
-	_def: {
-		defaults: Record<string, {
-			value: string;
-			type?: string;
-			label?: string;
-			required?: boolean;
-		}>;
-		credentials: Record<string, {
-			value: string;
-			type?: "password" | "text";
-			label?: string;
-			required?: boolean;
-		}>;
-		category: string;
-		color?: string;
-		icon?: string;
-		label?: ((this: NodeRedNode) => string) | string;
-		inputs?: number;
-		outputs?: number;
-		paletteLabel?: ((this: NodeRedNode) => string) | string;
-		labelStyle?: ((this: NodeRedNode) => string) | string;
-		inputLabels?: ((this: NodeRedNode, index: number) => string) | string;
-		outputLabels?: ((this: NodeRedNode, index: number) => string) | string;
-		align?: "left" | "right";
-		button?: NodeRedNodeButtonDefinition;
-	};
-	_newState?: NodeRedNode;
-	_app?: App | null;
-	_: (str: string) => string;
-	/** dynamic port count (base outputs + enabled built-in ports) */
-	outputs?: number;
-	/** injected when the node has an inputSchema */
-	validateInput?: boolean;
-	/** built-in port toggles, present when declared in the configSchema */
-	errorPort?: boolean;
-	completePort?: boolean;
-	statusPort?: boolean;
-	/**
-	 * Per-port output settings, indexed by base-output port. `validateOutputs` is
-	 * injected (empty) when the node has an outputsSchema; `outputReturnProperties`
-	 * and `outputContextModes` are author-declared (SchemaType.*) — present only
-	 * when the node opts into per-port return keys / context modes. Read at
-	 * runtime by IONode.
-	 */
-	validateOutputs?: Record<number, boolean>;
-	outputContextModes?: Record<number, "carry" | "trace" | "reset">;
-	outputReturnProperties?: Record<number, string>;
-	[key: string]: any;
-}
-interface JsonPropertySchema extends JsonSchemaObjectExtensions {
-	type?: string | string[];
-	properties?: Record<string, JsonPropertySchema>;
-	required?: string[];
-	enum?: unknown[];
-	anyOf?: JsonPropertySchema[];
-	const?: unknown;
-	items?: JsonPropertySchema;
-	title?: string;
-	description?: string;
-	default?: unknown;
-}
-interface JsonSchemaObject extends SchemaObject {
-	type: "object";
-	properties?: Record<string, JsonPropertySchema>;
-	required?: string[];
-}
-interface TypedInputValue {
-	value: string;
-	type: string;
-}
-type EditorStatic<T> = T extends NodeRefResolved<any> ? string : T extends TypedInputResolved ? TypedInputValue : T extends (...args: any[]) => any ? T : T extends Array<infer I> ? EditorStatic<I>[] : T extends object ? {
-	[K in keyof T]: EditorStatic<T[K]>;
-} : T;
+export declare function useFormNode<TConfig extends TSchema = TSchema, TCredentials extends TSchema = TSchema>(): {
+	node: Record<string, any>;
+	schema: Record<string, any>;
+	errors: Record<string, string>;
+};
+type JsonSchemaObject = Record<string, any>;
 export interface MockEditor {
 	getValue(): string;
 	setValue(val: string): void;
@@ -216,30 +104,6 @@ export interface MockRED {
 	settings: MockSettings;
 	notify(message: any, options?: Record<string, any>): MockNotification;
 }
-interface FormNode<TConfig extends TSchema = TSchema, TCredentials extends TSchema = TSchema> {
-	node: NodeRedNode & EditorStatic<Static<TConfig>> & {
-		credentials: EditorStatic<Static<TCredentials>> & Record<string, any>;
-	};
-	schema: Record<string, any>;
-	errors: Record<string, string>;
-}
-/**
- * Composable that provides typed access to the form node, schema, and errors.
- * Replaces `defineProps` in custom form components — no props declaration needed.
- *
- * @example
- * ```vue
- * <script setup lang="ts">
- * import { useFormNode } from "@bonsae/nrg/client";
- * import type { ConfigsSchema, CredentialsSchema } from "../../server/schemas/my-node";
- *
- * const { node, errors } = useFormNode<typeof ConfigsSchema, typeof CredentialsSchema>();
- * node.name      // string — typed from ConfigsSchema
- * node.credentials.apiKey  // string — typed from CredentialsSchema
- * </script>
- * ```
- */
-export declare function useFormNode<TConfig extends TSchema = TSchema, TCredentials extends TSchema = TSchema>(): FormNode<TConfig, TCredentials>;
 export interface TestNode {
 	id: string;
 	type: string;

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

@@ -85,12 +85,6 @@ export interface SetupOptions {
 	settingsFile?: string;
 	flow?: Record<string, unknown>[];
 }
-export declare const defaultConfig: {
-	testTimeout: number;
-	hookTimeout: number;
-	globalSetup: string[];
-	include: string[];
-};
 export declare function setup(options?: SetupOptions): Promise<void>;
 export declare function teardown(): Promise<void>;
 export declare class NodeRedEditor {

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

@@ -1,7 +1,6 @@
 // Generated by dts-bundle-generator v9.5.1
 
-import { Static, TSchema } from '@sinclair/typebox';
-import { App } from 'vue';
+import { TSchema } from '@sinclair/typebox';
 
 export interface MockEditor {
 	getValue(): string;
@@ -96,111 +95,18 @@ export interface MockRED {
 	notify(message: any, options?: Record<string, any>): MockNotification;
 }
 export declare function createRED(): MockRED;
-export declare function createJQuery(): (selector: any, attrs?: Record<string, any>) => any;
-interface NodeRefResolved<T = any> {
-	readonly __nrg_node_ref: true;
-	readonly __instance: T;
+interface MockJQueryElement {
+	0: Element | null;
+	length: number;
+	[method: string]: any;
 }
-interface TypedInputResolved {
-	resolve(...args: any[]): any;
-	value: unknown;
-	type: string;
-}
-interface NodeRedNodeButtonDefinition {
-	toggle: string;
-	onclick: () => void;
-	enabled?: () => boolean;
-	visible?: () => boolean;
-}
-interface NodeRedNode {
-	id: string;
-	type: string;
-	name: string;
-	category: string;
-	x: string;
-	y: string;
-	g: string;
-	z: string;
-	credentials: Record<string, any>;
-	_def: {
-		defaults: Record<string, {
-			value: string;
-			type?: string;
-			label?: string;
-			required?: boolean;
-		}>;
-		credentials: Record<string, {
-			value: string;
-			type?: "password" | "text";
-			label?: string;
-			required?: boolean;
-		}>;
-		category: string;
-		color?: string;
-		icon?: string;
-		label?: ((this: NodeRedNode) => string) | string;
-		inputs?: number;
-		outputs?: number;
-		paletteLabel?: ((this: NodeRedNode) => string) | string;
-		labelStyle?: ((this: NodeRedNode) => string) | string;
-		inputLabels?: ((this: NodeRedNode, index: number) => string) | string;
-		outputLabels?: ((this: NodeRedNode, index: number) => string) | string;
-		align?: "left" | "right";
-		button?: NodeRedNodeButtonDefinition;
-	};
-	_newState?: NodeRedNode;
-	_app?: App | null;
-	_: (str: string) => string;
-	/** dynamic port count (base outputs + enabled built-in ports) */
-	outputs?: number;
-	/** injected when the node has an inputSchema */
-	validateInput?: boolean;
-	/** built-in port toggles, present when declared in the configSchema */
-	errorPort?: boolean;
-	completePort?: boolean;
-	statusPort?: boolean;
-	/**
-	 * Per-port output settings, indexed by base-output port. `validateOutputs` is
-	 * injected (empty) when the node has an outputsSchema; `outputReturnProperties`
-	 * and `outputContextModes` are author-declared (SchemaType.*) — present only
-	 * when the node opts into per-port return keys / context modes. Read at
-	 * runtime by IONode.
-	 */
-	validateOutputs?: Record<number, boolean>;
-	outputContextModes?: Record<number, "carry" | "trace" | "reset">;
-	outputReturnProperties?: Record<number, string>;
-	[key: string]: any;
-}
-interface TypedInputValue {
-	value: string;
-	type: string;
-}
-type EditorStatic<T> = T extends NodeRefResolved<any> ? string : T extends TypedInputResolved ? TypedInputValue : T extends (...args: any[]) => any ? T : T extends Array<infer I> ? EditorStatic<I>[] : T extends object ? {
-	[K in keyof T]: EditorStatic<T[K]>;
-} : T;
-interface FormNode<TConfig extends TSchema = TSchema, TCredentials extends TSchema = TSchema> {
-	node: NodeRedNode & EditorStatic<Static<TConfig>> & {
-		credentials: EditorStatic<Static<TCredentials>> & Record<string, any>;
-	};
+type MockJQuery = (selector: any, attrs?: Record<string, any>) => MockJQueryElement;
+/** Build the `$` function the test harness assigns to `window.$`. */
+export declare function createJQuery(): MockJQuery;
+export declare function useFormNode<TConfig extends TSchema = TSchema, TCredentials extends TSchema = TSchema>(): {
+	node: Record<string, any>;
 	schema: Record<string, any>;
 	errors: Record<string, string>;
-}
-/**
- * Composable that provides typed access to the form node, schema, and errors.
- * Replaces `defineProps` in custom form components — no props declaration needed.
- *
- * @example
- * ```vue
- * <script setup lang="ts">
- * import { useFormNode } from "@bonsae/nrg/client";
- * import type { ConfigsSchema, CredentialsSchema } from "../../server/schemas/my-node";
- *
- * const { node, errors } = useFormNode<typeof ConfigsSchema, typeof CredentialsSchema>();
- * node.name      // string — typed from ConfigsSchema
- * node.credentials.apiKey  // string — typed from CredentialsSchema
- * </script>
- * ```
- */
-export declare function useFormNode<TConfig extends TSchema = TSchema, TCredentials extends TSchema = TSchema>(): FormNode<TConfig, TCredentials>;
+};
 
 export {};

package/types/test-server-integration.d.ts

@@ -1,8 +1,7 @@
 // Generated by dts-bundle-generator v9.5.1
 
-import { SchemaOptions, Static, TObject, TOptional, TProperties, TSchema, TString } from '@sinclair/typebox';
+import { 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 {
@@ -202,6 +201,68 @@ declare const NodeConfigSchema: import("@sinclair/typebox").TObject<{
 	name: import("@sinclair/typebox").TString;
 	z: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
 }>;
+type Schema<T extends TProperties = TProperties> = TObject<T>;
+interface NodeContextStore {
+	get<T = any>(key: string): Promise<T>;
+	set<T = any>(key: string, value: T): Promise<void>;
+	keys(): Promise<string[]>;
+	/**
+	 * Atomically add `by` (default 1) to a numeric key and return the new value.
+	 * Prefer this over `get`+`set` for counters: it's atomic across instances when
+	 * the context store supports it (e.g. a DynamoDB `ADD` or Redis `INCR` store),
+	 * and serialized within the process otherwise — so concurrent messages never
+	 * lose updates.
+	 */
+	increment(key: string, by?: number): Promise<number>;
+	/**
+	 * Atomic read-modify-write: `fn(current)` returns the next value, applied
+	 * atomically (a conditional write + retry on a capable store, a per-key lock
+	 * otherwise). `fn` MAY run more than once on a write conflict, so keep it pure
+	 * (no side effects).
+	 */
+	update<T = any>(key: string, fn: (current: T) => T | Promise<T>): Promise<T>;
+}
+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?: TSchema | TSchema[] | Record<string, TSchema>;
+	readonly validateInput?: boolean;
+	readonly validateOutput?: boolean;
+	readonly name: string;
+	registered?(RED: RED): void | Promise<void>;
+	register(RED: RED): void | Promise<void>;
+	validateSettings(RED: RED): 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;
@@ -330,53 +391,16 @@ 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;
-}
-type Schema<T extends TProperties = TProperties> = TObject<T>;
-interface NodeContextStore {
-	get<T = any>(key: string): Promise<T>;
-	set<T = any>(key: string, value: T): Promise<void>;
-	keys(): Promise<string[]>;
-}
-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?: TSchema | TSchema[] | Record<string, TSchema>;
-	readonly validateInput?: boolean;
-	readonly validateOutput?: boolean;
-	readonly name: string;
-	registered?(RED: RED): void | Promise<void>;
-	register(RED: RED): void | Promise<void>;
-	validateSettings(RED: RED): 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>;
+	/**
+	 * Optional atomic add — provided by context stores that support it (e.g.
+	 * DynamoDB `ADD` / Redis `INCR`). When absent, nrg serializes in-process.
+	 */
+	increment?(key: string, by: number, store: string | undefined, callback: (err: Error | null, value: number) => void): void;
+	/**
+	 * Optional atomic read-modify-write — provided by stores that support it
+	 * (e.g. a DynamoDB conditional write). When absent, nrg serializes in-process.
+	 */
+	update?(key: string, fn: (current: any) => any, store: string | undefined, callback: (err: Error | null, value: any) => void): void;
 }
 type Channel = "sent" | "received";
 declare class Recorder {

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

@@ -1,8 +1,7 @@
 // Generated by dts-bundle-generator v9.5.1
 
-import { SchemaOptions, Static, TObject, TOptional, TProperties, TSchema, TString } from '@sinclair/typebox';
+import { 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 {
@@ -207,6 +206,21 @@ interface NodeContextStore {
 	get<T = any>(key: string): Promise<T>;
 	set<T = any>(key: string, value: T): Promise<void>;
 	keys(): Promise<string[]>;
+	/**
+	 * Atomically add `by` (default 1) to a numeric key and return the new value.
+	 * Prefer this over `get`+`set` for counters: it's atomic across instances when
+	 * the context store supports it (e.g. a DynamoDB `ADD` or Redis `INCR` store),
+	 * and serialized within the process otherwise — so concurrent messages never
+	 * lose updates.
+	 */
+	increment(key: string, by?: number): Promise<number>;
+	/**
+	 * Atomic read-modify-write: `fn(current)` returns the next value, applied
+	 * atomically (a conditional write + retry on a capable store, a per-key lock
+	 * otherwise). `fn` MAY run more than once on a write conflict, so keep it pure
+	 * (no side effects).
+	 */
+	update<T = any>(key: string, fn: (current: T) => T | Promise<T>): Promise<T>;
 }
 interface NodeConstructor<T = any, TConfig = any, TCredentials = any> {
 	readonly type: string;
@@ -377,6 +391,16 @@ 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;
+	/**
+	 * Optional atomic add — provided by context stores that support it (e.g.
+	 * DynamoDB `ADD` / Redis `INCR`). When absent, nrg serializes in-process.
+	 */
+	increment?(key: string, by: number, store: string | undefined, callback: (err: Error | null, value: number) => void): void;
+	/**
+	 * Optional atomic read-modify-write — provided by stores that support it
+	 * (e.g. a DynamoDB conditional write). When absent, nrg serializes in-process.
+	 */
+	update?(key: string, fn: (current: any) => any, store: string | undefined, callback: (err: Error | null, value: any) => void): void;
 }
 export interface MockRED extends RED {
 	registerNode(id: string, nodeRedNode: Partial<NodeRedNode>): void;

package/types/vite.d.ts

@@ -4,6 +4,8 @@ export interface BuildContext {
 	outDir: string;
 	packageName: string;
 	isDev: boolean;
+	/** Resolved server source dir, scanned to recover `Unsafe<T>()` types for docs. */
+	serverSrcDir?: string;
 }
 export interface BuildPluginOptions {
 	serverBuildOptions: ServerBuildOptions;