refactor(events-web): rename properties for consistency

yordan-st · gjulivan · commit 62ef5b1e7991 · 2025-08-11T22:15:01.000+02:00
diff --git a/packages/pluggableWidgets/events-web/src/Events.editorConfig.ts b/packages/pluggableWidgets/events-web/src/Events.editorConfig.ts
@@ -21,18 +21,18 @@ export function getProperties(
     if (!values.componentLoadRepeat) {
         hidePropertiesIn(defaultProperties, values, [
             "componentLoadRepeatInterval",
-            "componentLoadRepeatExpression",
-            "componentLoadRepeatParameterType"
+            "componentLoadRepeatIntervalExpression",
+            "componentLoadRepeatIntervalParameterType"
         ]);
     } else {
-        if (values.componentLoadRepeatParameterType === "expression") {
+        if (values.componentLoadRepeatIntervalParameterType === "expression") {
             hidePropertiesIn(defaultProperties, values, ["componentLoadRepeatInterval"]);
         } else {
-            hidePropertiesIn(defaultProperties, values, ["componentLoadRepeatExpression"]);
+            hidePropertiesIn(defaultProperties, values, ["componentLoadRepeatIntervalExpression"]);
         }
     }
     if (values.componentLoadDelayParameterType === "expression") {
-        hidePropertiesIn(defaultProperties, values, ["componentLoadDelayInteger"]);
+        hidePropertiesIn(defaultProperties, values, ["componentLoadDelay"]);
     } else {
         hidePropertiesIn(defaultProperties, values, ["componentLoadDelayExpression"]);
     }
diff --git a/packages/pluggableWidgets/events-web/src/Events.tsx b/packages/pluggableWidgets/events-web/src/Events.tsx
@@ -11,13 +11,13 @@ export default function Events(props: EventsContainerProps): ReactElement {
         class: className,
         onComponentLoad,
         componentLoadDelayExpression,
-        componentLoadDelayInteger,
+        componentLoadDelay,
         componentLoadRepeat,
         onEventChangeAttribute,
         onEventChange,
         componentLoadRepeatInterval,
-        componentLoadRepeatParameterType,
-        componentLoadRepeatExpression,
+        componentLoadRepeatIntervalParameterType,
+        componentLoadRepeatIntervalExpression,
         componentLoadDelayParameterType,
         onEventChangeDelayInteger,
         onEventChangeDelayParameterType,
@@ -27,12 +27,12 @@ export default function Events(props: EventsContainerProps): ReactElement {
 
     const [delayValue, intervalValue] = useDelayAndInterval({
         componentLoadDelayParameterType,
-        componentLoadRepeatParameterType,
+        componentLoadRepeatIntervalParameterType,
         onEventChangeDelayParameterType,
-        componentLoadDelayInteger,
+        componentLoadDelay,
         componentLoadRepeatInterval,
         onEventChangeDelayInteger,
-        componentLoadRepeatExpression,
+        componentLoadRepeatIntervalExpression,
         componentLoadDelayExpression,
         onEventChangeDelayExpression
     });
diff --git a/packages/pluggableWidgets/events-web/src/Events.xml b/packages/pluggableWidgets/events-web/src/Events.xml
@@ -21,7 +21,7 @@
                     </enumerationValues>
                 </property>
 
-                <property key="componentLoadDelayInteger" type="integer" required="true" defaultValue="0">
+                <property key="componentLoadDelay" type="integer" required="true" defaultValue="0">
                     <caption>Delay</caption>
                     <description>Timer delay to first action execution. Value is in milliseconds. If set to 0, action will be triggered immediately.</description>
                 </property>
@@ -37,7 +37,7 @@
                     <description />
                 </property>
 
-                <property key="componentLoadRepeatParameterType" type="enumeration" defaultValue="number" required="true">
+                <property key="componentLoadRepeatIntervalParameterType" type="enumeration" defaultValue="number" required="true">
                     <caption>Parameter type</caption>
                     <description />
                     <enumerationValues>
@@ -51,7 +51,7 @@
                     <description>Interval between repeat action execution. Value is in milliseconds.</description>
                 </property>
 
-                <property key="componentLoadRepeatExpression" type="expression" required="false">
+                <property key="componentLoadRepeatIntervalExpression" type="expression" required="false">
                     <caption>Interval</caption>
                     <description>Interval between repeat action execution. Value is in milliseconds.</description>
                     <returnType type="Integer" />
@@ -88,7 +88,7 @@
                     </enumerationValues>
                 </property>
 
-                <property key="onEventChangeDelayInteger" type="integer" required="true" defaultValue="0">
+                <property key="onEventChangeDelay" type="integer" required="true" defaultValue="0">
                     <caption>Delay</caption>
                     <description>Timer delay to first action execution. Value is in milliseconds. If set to 0, action will be triggered immediately.</description>
                 </property>
diff --git a/packages/pluggableWidgets/events-web/src/__tests__/AppEvents.spec.tsx b/packages/pluggableWidgets/events-web/src/__tests__/AppEvents.spec.tsx
@@ -1,8 +1,7 @@
-import { actionValue } from "@mendix/widget-plugin-test-utils";
+import { actionValue, dynamicValue } from "@mendix/widget-plugin-test-utils";
 import "@testing-library/jest-dom";
 import { render } from "@testing-library/react";
 import { createElement } from "react";
-import { ValueStatus } from "mendix";
 import { EventsContainerProps } from "../../typings/EventsProps";
 import Events from "../Events";
 
@@ -14,17 +13,17 @@ describe("App events (load)", () => {
             class: "app-events",
             onComponentLoad: actionValue(),
             componentLoadDelayParameterType: "number",
-            componentLoadDelayInteger: 0,
-            componentLoadDelayExpression: { value: undefined, status: ValueStatus.Unavailable },
+            componentLoadDelay: 0,
+            componentLoadDelayExpression: dynamicValue(),
             componentLoadRepeat: false,
-            componentLoadRepeatParameterType: "number",
+            componentLoadRepeatIntervalParameterType: "number",
             componentLoadRepeatInterval: 0,
-            componentLoadRepeatExpression: { value: undefined, status: ValueStatus.Unavailable },
+            componentLoadRepeatIntervalExpression: dynamicValue(),
             onEventChangeAttribute: undefined,
             onEventChange: undefined,
             onEventChangeDelayParameterType: "number",
             onEventChangeDelayInteger: 0,
-            onEventChangeDelayExpression: { value: undefined, status: ValueStatus.Unavailable }
+            onEventChangeDelayExpression: dynamicValue()
         };
     });
     it("render app events", async () => {
diff --git a/packages/pluggableWidgets/events-web/src/hooks/delayAndInterval.ts b/packages/pluggableWidgets/events-web/src/hooks/delayAndInterval.ts
@@ -1,11 +1,11 @@
 interface ParameterTypeProps {
     componentLoadDelayParameterType: string;
-    componentLoadRepeatParameterType: string;
+    componentLoadRepeatIntervalParameterType: string;
     onEventChangeDelayParameterType: string;
-    componentLoadDelayInteger?: number;
+    componentLoadDelay?: number;
     componentLoadRepeatInterval?: number;
     onEventChangeDelayInteger?: number;
-    componentLoadRepeatExpression?: { status: string; value: { toNumber: () => number } | undefined };
+    componentLoadRepeatIntervalExpression?: { status: string; value: { toNumber: () => number } | undefined };
     componentLoadDelayExpression?: { status: string; value: { toNumber: () => number } | undefined };
     onEventChangeDelayExpression?: { status: string; value: { toNumber: () => number } | undefined };
 }
@@ -15,29 +15,30 @@ export function useDelayAndInterval(props: ParameterTypeProps): [number | undefi
     let intervalValue: number | undefined;
     const {
         componentLoadDelayParameterType,
-        componentLoadRepeatParameterType,
+        componentLoadRepeatIntervalParameterType,
         onEventChangeDelayParameterType,
-        componentLoadDelayInteger,
+        componentLoadDelay,
         componentLoadRepeatInterval,
         onEventChangeDelayInteger,
-        componentLoadRepeatExpression,
+        componentLoadRepeatIntervalExpression,
         componentLoadDelayExpression,
         onEventChangeDelayExpression
     } = props;
     if (componentLoadDelayParameterType === "number") {
-        delayValue = componentLoadDelayInteger;
+        delayValue = componentLoadDelay;
     } else {
         delayValue =
             componentLoadDelayExpression?.status === "available" && componentLoadDelayExpression.value !== undefined
                 ? componentLoadDelayExpression.value.toNumber()
                 : undefined;
     }
-    if (componentLoadRepeatParameterType === "number") {
+    if (componentLoadRepeatIntervalParameterType === "number") {
         intervalValue = componentLoadRepeatInterval;
     } else {
         intervalValue =
-            componentLoadRepeatExpression?.status === "available" && componentLoadRepeatExpression.value !== undefined
-                ? componentLoadRepeatExpression.value.toNumber()
+            componentLoadRepeatIntervalExpression?.status === "available" &&
+            componentLoadRepeatIntervalExpression.value !== undefined
+                ? componentLoadRepeatIntervalExpression.value.toNumber()
                 : undefined;
     }
     if (onEventChangeDelayParameterType === "number") {
diff --git a/packages/pluggableWidgets/events-web/src/hooks/timer.ts b/packages/pluggableWidgets/events-web/src/hooks/timer.ts
@@ -16,7 +16,6 @@ export function useActionTimer(props: ActionTimerProps): void {
     useEffect(() => {
         // If the delay is set to undefined, we should not start a timer.
         if (delay === undefined || delay < 0 || (interval === undefined && repeat)) {
-            console.log("Events: Timer delay or interval is not set, skipping timer execution.");
             return;
         }
         let counter: NodeJS.Timeout;
diff --git a/packages/pluggableWidgets/events-web/typings/EventsProps.d.ts b/packages/pluggableWidgets/events-web/typings/EventsProps.d.ts
@@ -9,7 +9,7 @@ import { Big } from "big.js";
 
 export type ComponentLoadDelayParameterTypeEnum = "number" | "expression";
 
-export type ComponentLoadRepeatParameterTypeEnum = "number" | "expression";
+export type ComponentLoadRepeatIntervalParameterTypeEnum = "number" | "expression";
 
 export type OnEventChangeDelayParameterTypeEnum = "number" | "expression";
 
@@ -20,12 +20,12 @@ export interface EventsContainerProps {
     tabIndex?: number;
     onComponentLoad?: ActionValue;
     componentLoadDelayParameterType: ComponentLoadDelayParameterTypeEnum;
-    componentLoadDelayInteger: number;
+    componentLoadDelay: number;
     componentLoadDelayExpression: DynamicValue<Big>;
     componentLoadRepeat: boolean;
-    componentLoadRepeatParameterType: ComponentLoadRepeatParameterTypeEnum;
+    componentLoadRepeatIntervalParameterType: ComponentLoadRepeatIntervalParameterTypeEnum;
     componentLoadRepeatInterval: number;
-    componentLoadRepeatExpression?: DynamicValue<Big>;
+    componentLoadRepeatIntervalExpression?: DynamicValue<Big>;
     onEventChangeAttribute?: EditableValue<Big | any | boolean | Date | string>;
     onEventChange?: ActionValue;
     onEventChangeDelayParameterType: OnEventChangeDelayParameterTypeEnum;
@@ -46,12 +46,12 @@ export interface EventsPreviewProps {
     translate: (text: string) => string;
     onComponentLoad: {} | null;
     componentLoadDelayParameterType: ComponentLoadDelayParameterTypeEnum;
-    componentLoadDelayInteger: number | null;
+    componentLoadDelay: number | null;
     componentLoadDelayExpression: string;
     componentLoadRepeat: boolean;
-    componentLoadRepeatParameterType: ComponentLoadRepeatParameterTypeEnum;
+    componentLoadRepeatIntervalParameterType: ComponentLoadRepeatIntervalParameterTypeEnum;
     componentLoadRepeatInterval: number | null;
-    componentLoadRepeatExpression: string;
+    componentLoadRepeatIntervalExpression: string;
     onEventChangeAttribute: string;
     onEventChange: {} | null;
     onEventChangeDelayParameterType: OnEventChangeDelayParameterTypeEnum;

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,6 @@ export function useActionTimer(props: ActionTimerProps): void {`
`16`	`16`	`useEffect(() => {`
`17`	`17`	`// If the delay is set to undefined, we should not start a timer.`
`18`	`18`	`if (delay === undefined \|\| delay < 0 \|\| (interval === undefined && repeat)) {`
`19`		`- console.log("Events: Timer delay or interval is not set, skipping timer execution.");`
`20`	`19`	`return;`
`21`	`20`	`}`
`22`	`21`	`let counter: NodeJS.Timeout;`