@kemu-io/edge-runtime 0.1.30 → 0.2.0

package/package.json

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

package/runner.d.ts

@@ -110,7 +110,8 @@ declare enum WidgetType {
 	variable = "variable",
 	hubService = "hubService",
 	imageFilter = "imageFilter",
-	recipeLoad = "recipeLoad"
+	recipeLoad = "recipeLoad",
+	note = "note"
 }
 export type VariableDefinition = {
 	/**
@@ -137,6 +138,7 @@ export type VariableDefinition = {
 export type VarValueChangeEvt = Readonly<Pick<VariableDefinition, "type" | "value"> & {
 	varName: string;
 }>;
+export type SendToInputWidgetFn = (inputName: string, data: PartialData | number | string | boolean | Array<any>) => Promise<void>;
 export declare const utils: {
 	/**
 	 * Builds an object that represents an ImageData type. This is useful when services
@@ -172,8 +174,23 @@ declare const _default: {
 		 **/
 		apiKey?: string;
 	}) => Promise<{
-		/** use it to send data to input widgets */
-		sendToInputWidget: (inputName: string, data: PartialData, thingId?: string | undefined) => Promise<void>;
+		/**
+		 * use it to send data to input widgets
+		 * @param inputName the name of the input widget to send data to.
+		 * @param data the data to send to the input widget.
+		 * @example
+		 * ```typescript
+		 * await sendToInputWidget('myInputName', 'this is my value');
+		 * await sendToInputWidget('counter', 1234);
+		 *
+		 * // For non primitive types such as images, you can specify the data type
+		 * await sendToInputWidget('myImageInputName', {
+		 *   type: DataType.ImageData,
+		 *   data: utils.createImageDataLike(image, 100, 200),
+		 * });
+		 * ```
+		 */
+		sendToInputWidget: SendToInputWidgetFn;
 	}>;
 	terminate: () => Promise<void>;
 	/**