@kemu-io/edge-runtime 0.1.13 → 0.1.15

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kemu-io/edge-runtime",
   "type": "module",
-  "version": "0.1.13",
+  "version": "0.1.15",
   "description": "Kemu Edge runtime for running Kemu recipes",
   "author": "Kemu Pty Ltd",
   "main": "runner.js",

package/runner.d.ts

@@ -71,6 +71,69 @@ 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",
+	widgetBundle = "widgetBundle",
+	sequence = "sequence",
+	variable = "variable",
+	hubService = "hubService",
+	imageFilter = "imageFilter",
+	recipeLoad = "recipeLoad"
+}
+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 custom field */
+	isCustomFieldVar: boolean;
+	/** the current value of the variable */
+	value?: SupportedTypes;
+};
+export type VarValueChangeEvt = Readonly<Pick<VariableDefinition, "type" | "value">>;
 export declare const utils: {
 	/**
 	 * Builds an object that represents an ImageData type. This is useful when services
@@ -100,6 +163,13 @@ declare const _default: {
 	}) => Promise<{
 		/** use it to send data to input widgets */
 		sendToInputWidget: (inputName: string, data: PartialData, thingId?: string | undefined) => Promise<void>;
+		/**
+		 * Sets a listener to changes in the value of a variable.
+		 * @param varName the name of the variable to listen to. Set it to `*` to listen to all variable changes.
+		 * @param cb the callback function to be invoked.
+		 * @returns a function to remove the listener.
+		 */
+		onVariableChange: (varName: string, cb: (evt: VarValueChangeEvt) => void | Promise<void>) => void;
 	}>;
 	terminate: () => Promise<void>;
 };