@kemu-io/edge-runtime 1.5.0 → 1.7.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kemu-io/edge-runtime",
   "type": "module",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "Kemu Edge runtime for running Kemu recipes",
   "author": "Kemu Pty Ltd",
   "main": "runner.js",
@@ -31,6 +31,7 @@
     "axios": "^1.7.2",
     "compare-versions": "^6.1.0",
     "crypto-js": "^4.2.0",
+    "expr-eval": "^2.0.2",
     "jsonp": "^0.2.1",
     "jszip": "^3.10.1",
     "microseconds": "^0.2.0",

package/runner.d.ts

@@ -72,84 +72,64 @@ export type Data = {
 	timestamp: number;
 };
 export type PartialData = Omit<Data, "timestamp">;
-declare enum WidgetType {
-	input = "input",
-	counter = "counter",
-	play = "play",
-	elapsed = "elapsed",
-	ifGate = "ifGate",
-	skipEvent = "skipEvent",
-	between = "between",
-	map = "map",
-	parser = "parser",
-	slider = "slider",
-	suspend = "suspend",
-	display = "display",
-	json = "json",
-	arrayItem = "arrayItem",
-	extractImage = "extractImage",
-	imageConvolution = "imageConvolution",
-	firstEvent = "firstEvent",
-	pixelDraw = "pixelDraw",
-	randomBetween = "randomBetween",
-	arrayCombine = "arrayCombine",
-	clock = "clock",
-	multiplication = "multiplication",
-	object = "object",
-	widgetGroup = "widgetGroup",
-	script = "script",
-	base64ToImageData = "base64ToImageData",
-	jsonParse = "jsonParse",
-	text = "text",
-	imageCrop = "imageCrop",
-	imageResize = "imageResize",
-	value = "value",
-	imageWarp = "imageWarp",
-	sequence = "sequence",
-	variable = "variable",
-	hubService = "hubService",
-	imageFilter = "imageFilter",
-	recipeLoad = "recipeLoad",
-	note = "note",
-	stringify = "stringify",
-	templateString = "templateString",
-	expressionEval = "expressionEval",
-	rescue = "rescue",
-	objectCombine = "objectCombine",
-	loop = "loop",
-	status = "status",
-	secret = "secret",
-	output = "output"
-}
-export type VariableDefinition = {
-	/**
-	 * the type of widget that created the variable, this in
-	 * order to speed up scope resolution of the variable when accessed.
-	 **/
-	ownerType: WidgetType;
-	/**
-	 * The data type held by the variable.
-	 */
-	type: DataType;
-	/**
-	 * indicates if its value should be stored as part of the recipe
-	 * when the recipe is saved
-	 **/
-	storeValueInRecipe: boolean;
-	/** the id of the widget that registered the variable */
-	createdByWidgetId: string;
-	/** indicates if the variable is a reference to a widget's UI element */
-	isUIElement: boolean;
-	/** the current value of the variable */
-	value?: SupportedTypes;
+export type ExecutionContext = {
+	currentPath: string[];
+	eventId: number;
+};
+export type GlobalVariableControlType = "number" | "slider" | "text" | "multilineText" | "dropdown" | "image" | "binaryFile" | "checkbox" | "multiSelect" | "anything";
+export type GlobalVariable<T = any> = {
+	name: string;
+	controlType: GlobalVariableControlType;
+	lastDataType: DataType | null;
+	lastValue: SupportedTypes | null;
+	lastChangedByWidgetId: string | null;
+	lastExecutionContext: ExecutionContext | null;
+	controlSettings: T;
+	/** help text in plain text or markdown format */
+	helpText?: string;
+	order?: number;
+};
+/**
+ * Handler function type for edge function callbacks
+ * @param functionParams - Custom configuration parameters for the function
+ * @param eventId - Unique event identifier
+ * @returns Promise resolving to a SupportedType value
+ */
+export type EdgeFunctionHandler = (functionParams: any, eventId: number) => Promise<SupportedTypes>;
+declare const _default: {
+	registerFunctionHandler: (functionName: string, handler: EdgeFunctionHandler) => void;
+	invokeFunction: (config: {
+		eventId: number;
+		functionName: string;
+		functionParams: any;
+	}) => Promise<SupportedTypes | null | void>;
+	unregisterFunctionHandler: (functionName: string) => void;
+	clearAllHandlers: () => void;
 };
-export type VarValueChangeEvt = Readonly<Pick<VariableDefinition, "type" | "value" | "isUIElement"> & {
-	varName: string;
-	setByWidgetType: WidgetType;
-	setByWidgetId: string;
-}>;
 export type SendToInputWidgetFn = (inputName: string, data: PartialData | number | string | boolean | Array<any>) => Promise<void>;
 export type SendToInputWidgetAndWaitForOutputFn = <T = any>(inputName: string, data: PartialData | number | string | boolean | Array<any>) => Promise<T>;
+declare const onGlobalVariableChange: (varName: string | "*", cb: (config: GlobalVariable) => void) => import("emittery").UnsubscribeFunction;
+declare const setGlobalVariable: (varName: string, value: SupportedTypes, config?: {
+	/** whether to disable change notifications for this variable */
+	disableChangeNotifications?: boolean;
+	/** whether to disable define notifications for this variable */
+	disableDefineNotifications?: boolean;
+	/** whether to not override an existing variable with the same name */
+	doNotOverrideExisting?: boolean;
+}) => Promise<void>;
+declare const deleteGlobalVariable: (varName: string) => void;
+declare const getAllGlobalVariables: () => GlobalVariable<any>[];
+declare const getGlobalVariable: (varName: string) => GlobalVariable | null;
+declare const onStatusValueChange: (cb: (config: {
+	/** the name of the status */
+	name: string;
+	/** the value of the status */
+	value: PartialData;
+	/** the id of the parent widget setting the status value */
+	sourceWidget: string;
+	/** the id of the status widget being set */
+	statusWidgetId: string;
+}) => void) => import("emittery").UnsubscribeFunction;
 export declare const utils: {
 	/**
 	 * Builds an object that represents an ImageData type. This is useful when services
@@ -171,7 +151,7 @@ export declare const utils: {
 	 */
 	encodeImageData: (imageData: ImageData$1, format?: "png" | "jpeg" | "webp", quality?: number) => Promise<Buffer>;
 };
-declare const _default: {
+declare const _default$1: {
 	start: (config?: {
 		/**
 		 * path to the recipe file or containing directory.
@@ -209,19 +189,68 @@ declare const _default: {
 		 * @returns the response from the input widget.
 		 */
 		sendToInputWidgetAndWaitForOutput: SendToInputWidgetAndWaitForOutputFn;
+		/**
+		 * Manage global variables in your recipe.
+		 */
+		globalVariables: {
+			/**
+			 * Sets a listener to changes in the value of a variable.
+			 * @param varName the name of the variable to listen to.
+			 * @param cb the callback function to be invoked.
+			 * @returns a function to remove the listener.
+			 */
+			onChange: typeof onGlobalVariableChange;
+			/**
+			 * Sets the value of a global variable.
+			 * @param varName the name of the variable to set.
+			 * @param value the value to set.
+			 */
+			setValue: typeof setGlobalVariable;
+			/**
+			 * Retrieves a global variable.
+			 * @param varName the name of the variable to retrieve.
+			 * @returns the global variable or null if it does not exist.
+			 */
+			getValue: typeof getGlobalVariable;
+			/**
+			 * Removes a global variable.
+			 * @param varName the name of the variable to delete.
+			 */
+			delete: typeof deleteGlobalVariable;
+			/**
+			 * Retrieves all global variables.
+			 * @returns all global variables.
+			 */
+			getAll: typeof getAllGlobalVariables;
+		};
+		/**
+		 * Access status set by Status widgets.
+		 */
+		status: {
+			/**
+			 * Sets a listener to changes in the value of a status.
+			 * @param cb the callback function to be invoked.
+			 * @returns a function to remove the listener.
+			 */
+			onChange: typeof onStatusValueChange;
+		};
+		/**
+		 * Manage edge functions in your recipe.
+		 */
+		edgeFunctions: {
+			/** Registers a function handler for an edge function */
+			register: (typeof _default)["registerFunctionHandler"];
+			/** Unregisters a function handler for an edge function */
+			unregister: (typeof _default)["unregisterFunctionHandler"];
+			/** Clears all registered function handlers */
+			clearAll: (typeof _default)["clearAllHandlers"];
+		};
 	}>;
 	terminate: () => Promise<void>;
-	/**
-	 * Sets a listener to changes in the value of a variable.
-	 * @param varName the name of the variable to listen to.
-	 * @param cb the callback function to be invoked.
-	 * @returns a function to remove the listener.
-	 */
-	onVariableChange: (varName: string, cb: (evt: Omit<VarValueChangeEvt, "isUIElement">) => void | Promise<void>) => () => void;
 };
 
 export {
-	_default as default,
+	_default$1 as default,
 };
 
 export {};