@node-projects/web-component-designer-visualization-addons 0.1.146 → 0.1.148

package/dist/scripting/ScriptCommands.d.ts

@@ -1,4 +1,5 @@
-export declare type ScriptCommands = RunnableScriptCommands | Comment | Condition | Exit | Label | Goto;
+import { IScriptMultiplexValue } from "../interfaces/IScriptMultiplexValue.js";
+export declare type ScriptCommands = RunnableScriptCommands | Comment | Condition | If | Exit | Label | Goto;
 export declare type RunnableScriptCommands = OpenScreen | OpenUrl | OpenDialog | CloseDialog | ToggleSignalValue | ToggleSignalValueThroughList | SetSignalValue | IncrementSignalValue | DecrementSignalValue | SetBitInSignal | ClearBitInSignal | ToggleBitInSignal | Console | CalculateSignalValue | Javascript | SetElementProperty | Delay | SwitchLanguage | Login | Logout | SubscribeSignal | UnsubscribeSignal | WriteSignalsInGroup | ClearSignalsInGroup | RunScript | CopySignalValuesFromFolder | ShowMessageBox | ShowPrompt | ExportSignalValuesAsJson | ImportSignalValuesFromJson | Repeat;
 /**
  * signal - a signal (the default)
@@ -419,6 +420,38 @@ export interface Condition {
     falseScriptType?: string;
     additionalData?: string;
 }
+export interface IfSignal extends IScriptMultiplexValue {
+    /**
+    * Optional variable name to reference this value in the formula (e.g. "isOn").
+    * If empty, the value is referenced positionally as __0, __1, __2, ... (in listed order).
+    */
+    varName?: string;
+}
+export interface If {
+    type: 'If';
+    /**
+    * Values referenced in the formula, either positionally as __0, __1, __2, ... (in listed
+    * order) or, if varName is set, by that name. Each entry works like Condition.value1
+    * (source: signal/property/elementProperty/signalInProperty/event/parameter/context/
+    * complexString/complexSignal/expression)
+    * @TJS-format signalList
+    */
+    signals: IfSignal[];
+    /**
+    * Boolean formula, e.g. (__0 == true || __1 == true) && __2 == false
+    * @TJS-format formula
+    */
+    formula: string;
+    /**
+    * Commands executed when the formula evaluates to true
+    */
+    trueCommands: ScriptCommands[];
+    /**
+    * Commands executed when the formula evaluates to false
+    */
+    elseCommands: ScriptCommands[];
+    additionalData?: string;
+}
 export interface Exit {
     type: 'Exit';
     additionalData?: string;

package/dist/scripting/ScriptCommandsDescriptions.js

@@ -139,6 +139,11 @@ export const nativeScriptCommandDescriptions = {
         example: '{ "type": "Condition", "value1": {"source":"signal","name":".Is.On"}, "value2": true,\n  "comparisonType": "==", "trueGotoLabel": "lbl_off", "falseGotoLabel": "lbl_on" }',
         note: 'comparisonType: ==null | !=null | ==true | ==false | == | != | > | < | >= | <= | && | ||.',
     },
+    If: {
+        description: 'evaluate a formula and run nested commands depending on the result',
+        example: '{ "type": "If",\n  "signals": [{"source":"signal","name":".Is.On"}, {"varName":"ready","source":"signal","name":".Is.Ready"}],\n  "formula": "__0 == true && ready == false", "trueCommands": [], "elseCommands": [] }',
+        note: 'signals is a list of values (like Condition.value1). Each is referenced in the formula either positionally as __0, __1, ... or, if varName is set, by that name. trueCommands/elseCommands are edited as nested commands in the tree, not as JSON here.',
+    },
     Exit: {
         description: 'stop executing the current script chain',
         example: '{ "type": "Exit" }',

package/dist/scripting/ScriptSystem.d.ts

@@ -1,6 +1,6 @@
 import { VisualisationElementScript } from "../interfaces/VisualisationElementScript.js";
 import { VisualizationHandler } from "../interfaces/VisualizationHandler.js";
-import { ScriptCommands, signalTarget } from "./ScriptCommands.js";
+import { If, ScriptCommands, signalTarget } from "./ScriptCommands.js";
 export declare const cyclicAttributeName = "cyclic";
 export type contextType = {
     event: Event;
@@ -13,7 +13,7 @@ export declare class ScriptSystem {
     _visualizationHandler: VisualizationHandler;
     _subscriptionCallback: () => void;
     constructor(visualizationHandler: VisualizationHandler);
-    execute(scriptCommands: ScriptCommands[], outerContext: contextType): Promise<void>;
+    execute(scriptCommands: ScriptCommands[], outerContext: contextType): Promise<boolean>;
     getValueFromTarget(target: signalTarget, name: string, context: contextType): Promise<any>;
     setValueOnTarget(target: signalTarget, name: string, context: contextType, value: any): Promise<void>;
     runExternalScript(name: string, type: string): Promise<void>;
@@ -23,6 +23,7 @@ export declare class ScriptSystem {
     getValue<T>(value: T, outerContext: contextType): Promise<T>;
     getStateOrFieldOrParameter(name: string, context: contextType): Promise<any>;
     parseStringWithValues(text: string, context: contextType): Promise<string>;
+    evaluateIfFormula(command: If, outerContext: contextType): Promise<boolean>;
     getSignalName(name: string, outerContext: contextType): string;
     createScriptContext(root: HTMLElement, event: Event, element: Element, parameters: Record<string, any>, relativeSignalsPath: string): any;
     assignAllScripts(source: string, javascriptCode: string, shadowRoot: ShadowRoot, instance: HTMLElement, visualizationHandler: VisualizationHandler, contextCreator?: (root: HTMLElement, event: Event, element: Element, parameters: Record<string, any>, relativeSignalsPath: string) => any, assignExternalScript?: (element: Element, event: string, scriptData: any) => void, runInitalization?: (jsObject: VisualisationElementScript) => void): Promise<VisualisationElementScript>;

package/dist/scripting/ScriptSystem.js

@@ -22,6 +22,7 @@ export class ScriptSystem {
     async execute(scriptCommands, outerContext) {
         let repeatCount = -1;
         let eventNotValid = false;
+        let stopped = false;
         const triggerEvent = outerContext.event?.type;
         const cancelEvent = triggerEvent ? eventOpposites[triggerEvent] : null;
         if (cancelEvent) {
@@ -36,8 +37,18 @@ export class ScriptSystem {
         for (let i = 0; i < scriptCommands.length; i++) {
             let c = scriptCommands[i];
             if (c.type == "Exit") {
+                stopped = true;
                 break;
             }
+            else if (c.type == "If") {
+                const res = await this.evaluateIfFormula(c, outerContext);
+                const branchCommands = (res ? c.trueCommands : c.elseCommands) ?? [];
+                const shouldContinue = await this.execute(branchCommands, outerContext);
+                if (!shouldContinue) {
+                    stopped = true;
+                    break;
+                }
+            }
             else if (c.type == "Goto") {
                 const label = await this.getValue(c.label, outerContext);
                 i = scriptCommands.findIndex(x => x.type == "Label" && x.label == label);
@@ -133,10 +144,12 @@ export class ScriptSystem {
             else {
                 const continueScript = await this.runScriptCommand(c, outerContext);
                 if (!continueScript) {
+                    stopped = true;
                     break;
                 }
             }
         }
+        return !stopped;
     }
     async getValueFromTarget(target, name, context) {
         if (target === 'property') {
@@ -168,6 +181,7 @@ export class ScriptSystem {
             case 'Comment':
             case 'Label':
             case 'Condition':
+            case 'If':
             case 'Goto':
             case 'Exit':
             case 'Repeat':
@@ -514,6 +528,17 @@ export class ScriptSystem {
         }
         return nm;
     }
+    async evaluateIfFormula(command, outerContext) {
+        const entries = command.signals ?? [];
+        const varNames = entries.map((e, i) => e.varName?.trim() || '__' + i);
+        const values = await Promise.all(entries.map(e => this.getValue(e, outerContext)));
+        const formula = await this.getValue(command.formula, outerContext);
+        if (!command.compiledFormula || command._compiledFormulaSrc !== formula) {
+            command.compiledFormula = new Function(...varNames, 'return (' + formula + ');');
+            command._compiledFormulaSrc = formula;
+        }
+        return !!command.compiledFormula(...values);
+    }
     getSignalName(name, outerContext) {
         if (name[0] === '.')
             return outerContext.relativeSignalsPath + name;

package/dist/scripting/ScriptUpgrader.d.ts

@@ -1,5 +1,5 @@
 import { ScriptCommands, SetElementProperty } from "./ScriptCommands";
 export declare class ScriptUpgrades {
-    static upgradeScriptCommand(scriptCommand: ScriptCommands): import("./ScriptCommands").OpenScreen | import("./ScriptCommands").OpenUrl | import("./ScriptCommands").OpenDialog | import("./ScriptCommands").CloseDialog | import("./ScriptCommands").ToggleSignalValue | import("./ScriptCommands").ToggleSignalValueThroughList | import("./ScriptCommands").SetSignalValue | import("./ScriptCommands").IncrementSignalValue | import("./ScriptCommands").DecrementSignalValue | import("./ScriptCommands").SetBitInSignal | import("./ScriptCommands").ClearBitInSignal | import("./ScriptCommands").ToggleBitInSignal | import("./ScriptCommands").Console | import("./ScriptCommands").CalculateSignalValue | import("./ScriptCommands").Javascript | SetElementProperty | import("./ScriptCommands").Delay | import("./ScriptCommands").SwitchLanguage | import("./ScriptCommands").Login | import("./ScriptCommands").Logout | import("./ScriptCommands").SubscribeSignal | import("./ScriptCommands").UnsubscribeSignal | import("./ScriptCommands").WriteSignalsInGroup | import("./ScriptCommands").ClearSignalsInGroup | import("./ScriptCommands").RunScript | import("./ScriptCommands").CopySignalValuesFromFolder | import("./ScriptCommands").ShowMessageBox | import("./ScriptCommands").ShowPrompt | import("./ScriptCommands").ExportSignalValuesAsJson | import("./ScriptCommands").ImportSignalValuesFromJson | import("./ScriptCommands").Repeat | import("./ScriptCommands").Comment | import("./ScriptCommands").Condition | import("./ScriptCommands").Exit | import("./ScriptCommands").Label | import("./ScriptCommands").Goto;
+    static upgradeScriptCommand(scriptCommand: ScriptCommands): import("./ScriptCommands").OpenScreen | import("./ScriptCommands").OpenUrl | import("./ScriptCommands").OpenDialog | import("./ScriptCommands").CloseDialog | import("./ScriptCommands").ToggleSignalValue | import("./ScriptCommands").ToggleSignalValueThroughList | import("./ScriptCommands").SetSignalValue | import("./ScriptCommands").IncrementSignalValue | import("./ScriptCommands").DecrementSignalValue | import("./ScriptCommands").SetBitInSignal | import("./ScriptCommands").ClearBitInSignal | import("./ScriptCommands").ToggleBitInSignal | import("./ScriptCommands").Console | import("./ScriptCommands").CalculateSignalValue | import("./ScriptCommands").Javascript | SetElementProperty | import("./ScriptCommands").Delay | import("./ScriptCommands").SwitchLanguage | import("./ScriptCommands").Login | import("./ScriptCommands").Logout | import("./ScriptCommands").SubscribeSignal | import("./ScriptCommands").UnsubscribeSignal | import("./ScriptCommands").WriteSignalsInGroup | import("./ScriptCommands").ClearSignalsInGroup | import("./ScriptCommands").RunScript | import("./ScriptCommands").CopySignalValuesFromFolder | import("./ScriptCommands").ShowMessageBox | import("./ScriptCommands").ShowPrompt | import("./ScriptCommands").ExportSignalValuesAsJson | import("./ScriptCommands").ImportSignalValuesFromJson | import("./ScriptCommands").Repeat | import("./ScriptCommands").Comment | import("./ScriptCommands").Condition | import("./ScriptCommands").If | import("./ScriptCommands").Exit | import("./ScriptCommands").Label | import("./ScriptCommands").Goto;
     static upgradeSetElementProperty(scriptCommand: SetElementProperty): SetElementProperty;
 }

package/dist/scripting/ScriptUpgrader.js

@@ -4,6 +4,10 @@ export class ScriptUpgrades {
         if (scriptCommand.type === 'SetElementProperty') {
             return ScriptUpgrades.upgradeSetElementProperty(scriptCommand);
         }
+        if (scriptCommand.type === 'If') {
+            scriptCommand.trueCommands = (scriptCommand.trueCommands ?? []).map(c => ScriptUpgrades.upgradeScriptCommand(c));
+            scriptCommand.elseCommands = (scriptCommand.elseCommands ?? []).map(c => ScriptUpgrades.upgradeScriptCommand(c));
+        }
         return scriptCommand;
     }
     static upgradeSetElementProperty(scriptCommand) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "description": "web-component-designer addon for visualizations",
   "name": "@node-projects/web-component-designer-visualization-addons",
-  "version": "0.1.146",
+  "version": "0.1.148",
   "type": "module",
   "main": "./dist/index.js",
   "author": "jochen.kuehner@gmx.de",