@adcops/autocore-react 3.3.8 → 3.3.10

package/src/core/UniqueId.ts

@@ -1,41 +1,41 @@
-  
-
-
-/**
- * Generate a unique UUID in the form of RF4122.
- * @returns string 
- */
-const PrivateUniqueId = (function() 
-{
-    function chr4()
-    {
-        return Math.random().toString(16).slice(-4);
-    }
-
-    return chr4() + chr4() +
-        '-' + chr4() +
-        '-' + chr4() +
-        '-' + chr4() +
-        '-' + chr4() + chr4() + chr4();
-});
-
-
-/**
- * Generates a unique UUID per RFC4122.
- * 8 chars, followed by 3 groups of 4 chars, followed by 12 chars.
- *
- * @returns string UUID
- * 
- * ## Remarks 
- * NOTE: This format of 8 chars, followed by 3 groups of 4 chars, followed by 12 chars
- *       is known as a UUID and is defined in RFC4122 and is a standard for generating unique IDs.
- *       This function DOES NOT implement this standard. It simply outputs a string
- *       that looks similar. The standard is found here: https://www.ietf.org/rfc/rfc4122.txt
- *
- * Should avoid duplicates over 10-millions subsequent calls.
- *
- */
-export function UniqueId() : string {
-    return PrivateUniqueId();
-}
-
+  
+
+
+/**
+ * Generate a unique UUID in the form of RF4122.
+ * @returns string 
+ */
+const PrivateUniqueId = (function() 
+{
+    function chr4()
+    {
+        return Math.random().toString(16).slice(-4);
+    }
+
+    return chr4() + chr4() +
+        '-' + chr4() +
+        '-' + chr4() +
+        '-' + chr4() +
+        '-' + chr4() + chr4() + chr4();
+});
+
+
+/**
+ * Generates a unique UUID per RFC4122.
+ * 8 chars, followed by 3 groups of 4 chars, followed by 12 chars.
+ *
+ * @returns string UUID
+ * 
+ * ## Remarks 
+ * NOTE: This format of 8 chars, followed by 3 groups of 4 chars, followed by 12 chars
+ *       is known as a UUID and is defined in RFC4122 and is a standard for generating unique IDs.
+ *       This function DOES NOT implement this standard. It simply outputs a string
+ *       that looks similar. The standard is found here: https://www.ietf.org/rfc/rfc4122.txt
+ *
+ * Should avoid duplicates over 10-millions subsequent calls.
+ *
+ */
+export function UniqueId() : string {
+    return PrivateUniqueId();
+}
+

package/src/core/ValueSimulator.ts

@@ -1,167 +1,167 @@
-/*
- * Copyright (C) 2024 Automated Design Corp. All Rights Reserved.
- * Created Date: 2024-01-18 12:49:58
- * Author: Thomas C. Bitsky Jr.
- * -----
- * Last Modified: 2025-09-05 14:50:12
- * Modified By: ADC
- * -----
- * 
- */
-
-import type { EmitterDispatchFunction } from "./EventEmitterContext";
-
-
-/**
- * Generates values for simulating data into an HMI.
- * Used for demonstration and development testing.
- */
-export class ValueSimulator {
-
-    protected bBit1: boolean = false;
-    protected bBit2: boolean = true;
-
-    protected iRamp1: number = 0;
-    protected iRamp2: number = 0;
-    protected fRamp1: number = 0;
-    protected fRamp2: number = 0;
-
-    protected iSin1: number = 0;
-    protected iSin2: number = 0;
-    protected fSin1: number = 0;
-    protected fSin2: number = 0;
-
-    protected iRamp1DirectionUp : boolean = true;
-    protected iRamp2DirectionUp : boolean = true;
-    protected fRamp1DirectionUp : boolean = true;
-    protected fRamp2DirectionUp : boolean = true;
-
-    protected iSin1Angle : number = Math.random() * Math.PI * 2;
-    protected iSin2Angle : number = Math.random() * Math.PI * 2;
-    protected fSin1Angle : number = (Math.random() * Math.PI * 2) / 10;
-    protected fSin2Angle : number = (Math.random() * Math.PI * 2) / 10;    
-
-    protected intervalId: number = 0;
-
-    protected dispatch: EmitterDispatchFunction;
-
-    /**
-     * Constructor
-     * @param dispatch EmitterDispatchFunction Dispatch function from the application's EventEmiterContext.
-     */
-    constructor(dispatch: EmitterDispatchFunction) {
-        this.dispatch = dispatch;
-    }
-
-    /**
-     * Start simulating values on a tick
-     */
-    start() {
-        
-        if (this.intervalId === 0) {
-            this.intervalId = setInterval(
-                () => this.update(),
-                1000
-            );
-        }
-    }
-
-
-    /**
-     * Stop simulating values.
-     */
-    stop() {
-        if (this.intervalId !== 0) {
-            clearInterval(this.intervalId);
-            this.intervalId = 0;    
-        }
-    }
-
-
-    /**
-     * Update and dispatch the values.
-     */
-    protected update() {
-
-        this.bBit1 = !this.bBit1;
-        this.bBit2 = !this.bBit2;
-
-        [this.iRamp1, this.iRamp1DirectionUp] = this.updateRamp(this.iRamp1, this.iRamp1DirectionUp, 32767);
-        [this.iRamp2, this.iRamp2DirectionUp] = this.updateRamp(this.iRamp2, this.iRamp2DirectionUp, 32767);
-        [this.fRamp1, this.fRamp1DirectionUp] = this.updateRamp(this.fRamp1, this.fRamp1DirectionUp, 3276.7);
-        [this.fRamp2, this.fRamp2DirectionUp] = this.updateRamp(this.fRamp2, this.fRamp2DirectionUp, 3276.7);
-        
-        [this.iSin1, this.iSin1Angle] = this.updateSin(this.iSin1, this.iSin1Angle, Math.PI / 180, 32767);
-        [this.iSin2, this.iSin2Angle] = this.updateSin(this.iSin2, this.iSin2Angle, Math.PI / 180, 32767);
-        [this.fSin1, this.fSin1Angle] = this.updateSin(this.fSin1, this.fSin1Angle, Math.PI / 180, 3276.7);
-        [this.fSin2, this.fSin2Angle] = this.updateSin(this.fSin2, this.fSin2Angle, Math.PI / 180, 3276.7);
-
-
-        this.updateTopic("value-simulator-bBit1", this.bBit1);
-        this.updateTopic("value-simulator-bBit2", this.bBit2);
-        this.updateTopic("value-simulator-iRamp1", this.iRamp1);
-        this.updateTopic("value-simulator-iRamp2", this.iRamp2);
-        this.updateTopic("value-simulator-fRamp1", this.fRamp1);
-        this.updateTopic("value-simulator-fRamp2", this.fRamp2);
-
-        this.updateTopic("value-simulator-iSin1", this.iSin1);
-        this.updateTopic("value-simulator-iSin2", this.iSin2);
-        this.updateTopic("value-simulator-fSin1", this.fSin1);
-        this.updateTopic("value-simulator-fSin2", this.fSin2);
-
-    }
-
-
-    /**
-     * Updates the value of a ramp variable, changing its direction when limits are reached.
-     * @param {number} value The current value of the ramp variable.
-     * @param {boolean} directionUp Indicates if the ramp variable is currently increasing.
-     * @param {number} max The maximum value for the ramp.
-     * @returns {[number, boolean]} The updated value and direction.
-     */
-    protected updateRamp(value: number, directionUp: boolean, max: number): [number, boolean] {
-        if (directionUp) {
-            value++;
-            if (value >= max) return [value, false];
-        } else {
-            value--;
-            if (value <= 0) return [value, true];
-        }
-        return [value, directionUp];
-    }
-
-
-    /**
-     * Updates a sine wave value based on the given angle and increments, then calculates the new value and angle.
-     * This method is useful for scenarios where a sine wave value needs to be progressively updated, such as in animations
-     * or simulations. The sine of the updated angle is calculated, multiplied by the maximum value to scale it, and both
-     * the new value and the updated angle are returned.
-     * 
-     * @param {number} value The current value of the sine wave. This parameter is not directly used in the calculation of the new value,
-     * but it can be utilized if the method is extended or modified.
-     * @param {number} angle The current angle in radians. This is the phase of the sine wave.
-     * @param {number} increment The value by which the angle is to be incremented, in radians. This controls the progression of the wave.
-     * @param {number} max The maximum value (amplitude) of the sine wave. The calculated sine value will be scaled by this factor.
-     * @returns {[number,number]} A tuple where the first element is the new sine wave value and the second element is the updated angle.
-     */
-    protected updateSin(value: number, angle: number, increment: number, max: number): [number, number] {
-        angle += increment;
-        value = Math.sin(angle) * max;
-        return [value, angle];
-    }
-
-
-    /**
-     * Dispatch the update for a particular topic.
-     */
-    protected updateTopic(topic: string, value: any) {
-        
-        this.dispatch({
-            topic: topic,
-            payload: value
-        });
-        
-    }
-}
-
+/*
+ * Copyright (C) 2024 Automated Design Corp. All Rights Reserved.
+ * Created Date: 2024-01-18 12:49:58
+ * Author: Thomas C. Bitsky Jr.
+ * -----
+ * Last Modified: 2025-09-05 14:50:12
+ * Modified By: ADC
+ * -----
+ * 
+ */
+
+import type { EmitterDispatchFunction } from "./EventEmitterContext";
+
+
+/**
+ * Generates values for simulating data into an HMI.
+ * Used for demonstration and development testing.
+ */
+export class ValueSimulator {
+
+    protected bBit1: boolean = false;
+    protected bBit2: boolean = true;
+
+    protected iRamp1: number = 0;
+    protected iRamp2: number = 0;
+    protected fRamp1: number = 0;
+    protected fRamp2: number = 0;
+
+    protected iSin1: number = 0;
+    protected iSin2: number = 0;
+    protected fSin1: number = 0;
+    protected fSin2: number = 0;
+
+    protected iRamp1DirectionUp : boolean = true;
+    protected iRamp2DirectionUp : boolean = true;
+    protected fRamp1DirectionUp : boolean = true;
+    protected fRamp2DirectionUp : boolean = true;
+
+    protected iSin1Angle : number = Math.random() * Math.PI * 2;
+    protected iSin2Angle : number = Math.random() * Math.PI * 2;
+    protected fSin1Angle : number = (Math.random() * Math.PI * 2) / 10;
+    protected fSin2Angle : number = (Math.random() * Math.PI * 2) / 10;    
+
+    protected intervalId: number = 0;
+
+    protected dispatch: EmitterDispatchFunction;
+
+    /**
+     * Constructor
+     * @param dispatch EmitterDispatchFunction Dispatch function from the application's EventEmiterContext.
+     */
+    constructor(dispatch: EmitterDispatchFunction) {
+        this.dispatch = dispatch;
+    }
+
+    /**
+     * Start simulating values on a tick
+     */
+    start() {
+        
+        if (this.intervalId === 0) {
+            this.intervalId = setInterval(
+                () => this.update(),
+                1000
+            );
+        }
+    }
+
+
+    /**
+     * Stop simulating values.
+     */
+    stop() {
+        if (this.intervalId !== 0) {
+            clearInterval(this.intervalId);
+            this.intervalId = 0;    
+        }
+    }
+
+
+    /**
+     * Update and dispatch the values.
+     */
+    protected update() {
+
+        this.bBit1 = !this.bBit1;
+        this.bBit2 = !this.bBit2;
+
+        [this.iRamp1, this.iRamp1DirectionUp] = this.updateRamp(this.iRamp1, this.iRamp1DirectionUp, 32767);
+        [this.iRamp2, this.iRamp2DirectionUp] = this.updateRamp(this.iRamp2, this.iRamp2DirectionUp, 32767);
+        [this.fRamp1, this.fRamp1DirectionUp] = this.updateRamp(this.fRamp1, this.fRamp1DirectionUp, 3276.7);
+        [this.fRamp2, this.fRamp2DirectionUp] = this.updateRamp(this.fRamp2, this.fRamp2DirectionUp, 3276.7);
+        
+        [this.iSin1, this.iSin1Angle] = this.updateSin(this.iSin1, this.iSin1Angle, Math.PI / 180, 32767);
+        [this.iSin2, this.iSin2Angle] = this.updateSin(this.iSin2, this.iSin2Angle, Math.PI / 180, 32767);
+        [this.fSin1, this.fSin1Angle] = this.updateSin(this.fSin1, this.fSin1Angle, Math.PI / 180, 3276.7);
+        [this.fSin2, this.fSin2Angle] = this.updateSin(this.fSin2, this.fSin2Angle, Math.PI / 180, 3276.7);
+
+
+        this.updateTopic("value-simulator-bBit1", this.bBit1);
+        this.updateTopic("value-simulator-bBit2", this.bBit2);
+        this.updateTopic("value-simulator-iRamp1", this.iRamp1);
+        this.updateTopic("value-simulator-iRamp2", this.iRamp2);
+        this.updateTopic("value-simulator-fRamp1", this.fRamp1);
+        this.updateTopic("value-simulator-fRamp2", this.fRamp2);
+
+        this.updateTopic("value-simulator-iSin1", this.iSin1);
+        this.updateTopic("value-simulator-iSin2", this.iSin2);
+        this.updateTopic("value-simulator-fSin1", this.fSin1);
+        this.updateTopic("value-simulator-fSin2", this.fSin2);
+
+    }
+
+
+    /**
+     * Updates the value of a ramp variable, changing its direction when limits are reached.
+     * @param {number} value The current value of the ramp variable.
+     * @param {boolean} directionUp Indicates if the ramp variable is currently increasing.
+     * @param {number} max The maximum value for the ramp.
+     * @returns {[number, boolean]} The updated value and direction.
+     */
+    protected updateRamp(value: number, directionUp: boolean, max: number): [number, boolean] {
+        if (directionUp) {
+            value++;
+            if (value >= max) return [value, false];
+        } else {
+            value--;
+            if (value <= 0) return [value, true];
+        }
+        return [value, directionUp];
+    }
+
+
+    /**
+     * Updates a sine wave value based on the given angle and increments, then calculates the new value and angle.
+     * This method is useful for scenarios where a sine wave value needs to be progressively updated, such as in animations
+     * or simulations. The sine of the updated angle is calculated, multiplied by the maximum value to scale it, and both
+     * the new value and the updated angle are returned.
+     * 
+     * @param {number} value The current value of the sine wave. This parameter is not directly used in the calculation of the new value,
+     * but it can be utilized if the method is extended or modified.
+     * @param {number} angle The current angle in radians. This is the phase of the sine wave.
+     * @param {number} increment The value by which the angle is to be incremented, in radians. This controls the progression of the wave.
+     * @param {number} max The maximum value (amplitude) of the sine wave. The calculated sine value will be scaled by this factor.
+     * @returns {[number,number]} A tuple where the first element is the new sine wave value and the second element is the updated angle.
+     */
+    protected updateSin(value: number, angle: number, increment: number, max: number): [number, number] {
+        angle += increment;
+        value = Math.sin(angle) * max;
+        return [value, angle];
+    }
+
+
+    /**
+     * Dispatch the update for a particular topic.
+     */
+    protected updateTopic(topic: string, value: any) {
+        
+        this.dispatch({
+            topic: topic,
+            payload: value
+        });
+        
+    }
+}
+
 export default ValueSimulator;

package/src/core/hoc.tsx

@@ -1,65 +1,65 @@
-/*
- * Copyright (C) 2024 Automated Design Corp. All Rights Reserved.
- * Created Date: 2024-01-18 16:14:20
-  * -----
- * Last Modified: 2026-01-29 09:32:17
- * Modified By: ADC
- * -----
- */
-
-/**
- * @fileinfo
- * Explanation:
- * React.ComponentType<P>: This is a generic type that can accept any React component (functional or class) with props of type P.
- * P extends WithSubscriptionProps: Here, P is a generic type parameter that extends WithSubscriptionProps, 
- * meaning it can be any type that includes the properties of WithSubscriptionProps.
- * Omit<P, keyof WithSubscriptionProps>: This utility type creates a new type by omitting properties from 
- * P that are also in WithSubscriptionProps. This is useful to prevent type clashes.
- * useState<any>(): The state is typed as any since the value received from the subscription 
- * can be of any type. You may choose to make this more specific based on your application's needs.
- * 
- */
-
-
-import React, { useState, useEffect, useContext } from 'react';
-import { EventEmitterContext } from './EventEmitterContext';
-
-/**
- * High Order Component Subscription properties.
- */
-export type HocAddSubscriptionProps = {
-    /** The topic to subscribe to. */
-    topic: string;
-    /** The name of the prop through which the subscription data is passed to the WrappedComponent.  */
-    propName?: string;
-};
-
-
-/**
- * Creates a higher-order component that subscribes to a specified topic and passes the data to the wrapped component.
- * 
- * @param WrappedComponent The component to be wrapped and enhanced with subscription data.
- * @param topic The topic to subscribe to.
- * @param propName The name of the prop through which the subscription data is passed to the WrappedComponent. 
- * @returns A component that subscribes to the given topic and updates its specified prop with the received data.
- */
-export function hocAddSubscription<P extends HocAddSubscriptionProps>(
-    WrappedComponent: React.ComponentType<P>,
-    topic: string,
-    propName: keyof P
-) {
-    return function(props: Omit<P, keyof HocAddSubscriptionProps>) {
-        const [value, setValue] = useState<any>();
-        const { subscribe, unsubscribe } = useContext(EventEmitterContext);
-
-        useEffect(() => {
-            const unsubscribeToken = subscribe(topic, setValue);
-            return () => unsubscribe(unsubscribeToken);
-        }, [topic, subscribe, unsubscribe]);
-
-        // Use propName to pass the updated value
-        const additionalProps = { [propName]: value } as Pick<P, keyof P>;
-
-        return <WrappedComponent {...props as P} {...additionalProps} />;
-    };
-}
+/*
+ * Copyright (C) 2024 Automated Design Corp. All Rights Reserved.
+ * Created Date: 2024-01-18 16:14:20
+  * -----
+ * Last Modified: 2026-01-29 09:32:17
+ * Modified By: ADC
+ * -----
+ */
+
+/**
+ * @fileinfo
+ * Explanation:
+ * React.ComponentType<P>: This is a generic type that can accept any React component (functional or class) with props of type P.
+ * P extends WithSubscriptionProps: Here, P is a generic type parameter that extends WithSubscriptionProps, 
+ * meaning it can be any type that includes the properties of WithSubscriptionProps.
+ * Omit<P, keyof WithSubscriptionProps>: This utility type creates a new type by omitting properties from 
+ * P that are also in WithSubscriptionProps. This is useful to prevent type clashes.
+ * useState<any>(): The state is typed as any since the value received from the subscription 
+ * can be of any type. You may choose to make this more specific based on your application's needs.
+ * 
+ */
+
+
+import React, { useState, useEffect, useContext } from 'react';
+import { EventEmitterContext } from './EventEmitterContext';
+
+/**
+ * High Order Component Subscription properties.
+ */
+export type HocAddSubscriptionProps = {
+    /** The topic to subscribe to. */
+    topic: string;
+    /** The name of the prop through which the subscription data is passed to the WrappedComponent.  */
+    propName?: string;
+};
+
+
+/**
+ * Creates a higher-order component that subscribes to a specified topic and passes the data to the wrapped component.
+ * 
+ * @param WrappedComponent The component to be wrapped and enhanced with subscription data.
+ * @param topic The topic to subscribe to.
+ * @param propName The name of the prop through which the subscription data is passed to the WrappedComponent. 
+ * @returns A component that subscribes to the given topic and updates its specified prop with the received data.
+ */
+export function hocAddSubscription<P extends HocAddSubscriptionProps>(
+    WrappedComponent: React.ComponentType<P>,
+    topic: string,
+    propName: keyof P
+) {
+    return function(props: Omit<P, keyof HocAddSubscriptionProps>) {
+        const [value, setValue] = useState<any>();
+        const { subscribe, unsubscribe } = useContext(EventEmitterContext);
+
+        useEffect(() => {
+            const unsubscribeToken = subscribe(topic, setValue);
+            return () => unsubscribe(unsubscribeToken);
+        }, [topic, subscribe, unsubscribe]);
+
+        // Use propName to pass the updated value
+        const additionalProps = { [propName]: value } as Pick<P, keyof P>;
+
+        return <WrappedComponent {...props as P} {...additionalProps} />;
+    };
+}